babylon.module.d.ts 6.5 MB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903990499059906990799089909991099119912991399149915991699179918991999209921992299239924992599269927992899299930993199329933993499359936993799389939994099419942994399449945994699479948994999509951995299539954995599569957995899599960996199629963996499659966996799689969997099719972997399749975997699779978997999809981998299839984998599869987998899899990999199929993999499959996999799989999100001000110002100031000410005100061000710008100091001010011100121001310014100151001610017100181001910020100211002210023100241002510026100271002810029100301003110032100331003410035100361003710038100391004010041100421004310044100451004610047100481004910050100511005210053100541005510056100571005810059100601006110062100631006410065100661006710068100691007010071100721007310074100751007610077100781007910080100811008210083100841008510086100871008810089100901009110092100931009410095100961009710098100991010010101101021010310104101051010610107101081010910110101111011210113101141011510116101171011810119101201012110122101231012410125101261012710128101291013010131101321013310134101351013610137101381013910140101411014210143101441014510146101471014810149101501015110152101531015410155101561015710158101591016010161101621016310164101651016610167101681016910170101711017210173101741017510176101771017810179101801018110182101831018410185101861018710188101891019010191101921019310194101951019610197101981019910200102011020210203102041020510206102071020810209102101021110212102131021410215102161021710218102191022010221102221022310224102251022610227102281022910230102311023210233102341023510236102371023810239102401024110242102431024410245102461024710248102491025010251102521025310254102551025610257102581025910260102611026210263102641026510266102671026810269102701027110272102731027410275102761027710278102791028010281102821028310284102851028610287102881028910290102911029210293102941029510296102971029810299103001030110302103031030410305103061030710308103091031010311103121031310314103151031610317103181031910320103211032210323103241032510326103271032810329103301033110332103331033410335103361033710338103391034010341103421034310344103451034610347103481034910350103511035210353103541035510356103571035810359103601036110362103631036410365103661036710368103691037010371103721037310374103751037610377103781037910380103811038210383103841038510386103871038810389103901039110392103931039410395103961039710398103991040010401104021040310404104051040610407104081040910410104111041210413104141041510416104171041810419104201042110422104231042410425104261042710428104291043010431104321043310434104351043610437104381043910440104411044210443104441044510446104471044810449104501045110452104531045410455104561045710458104591046010461104621046310464104651046610467104681046910470104711047210473104741047510476104771047810479104801048110482104831048410485104861048710488104891049010491104921049310494104951049610497104981049910500105011050210503105041050510506105071050810509105101051110512105131051410515105161051710518105191052010521105221052310524105251052610527105281052910530105311053210533105341053510536105371053810539105401054110542105431054410545105461054710548105491055010551105521055310554105551055610557105581055910560105611056210563105641056510566105671056810569105701057110572105731057410575105761057710578105791058010581105821058310584105851058610587105881058910590105911059210593105941059510596105971059810599106001060110602106031060410605106061060710608106091061010611106121061310614106151061610617106181061910620106211062210623106241062510626106271062810629106301063110632106331063410635106361063710638106391064010641106421064310644106451064610647106481064910650106511065210653106541065510656106571065810659106601066110662106631066410665106661066710668106691067010671106721067310674106751067610677106781067910680106811068210683106841068510686106871068810689106901069110692106931069410695106961069710698106991070010701107021070310704107051070610707107081070910710107111071210713107141071510716107171071810719107201072110722107231072410725107261072710728107291073010731107321073310734107351073610737107381073910740107411074210743107441074510746107471074810749107501075110752107531075410755107561075710758107591076010761107621076310764107651076610767107681076910770107711077210773107741077510776107771077810779107801078110782107831078410785107861078710788107891079010791107921079310794107951079610797107981079910800108011080210803108041080510806108071080810809108101081110812108131081410815108161081710818108191082010821108221082310824108251082610827108281082910830108311083210833108341083510836108371083810839108401084110842108431084410845108461084710848108491085010851108521085310854108551085610857108581085910860108611086210863108641086510866108671086810869108701087110872108731087410875108761087710878108791088010881108821088310884108851088610887108881088910890108911089210893108941089510896108971089810899109001090110902109031090410905109061090710908109091091010911109121091310914109151091610917109181091910920109211092210923109241092510926109271092810929109301093110932109331093410935109361093710938109391094010941109421094310944109451094610947109481094910950109511095210953109541095510956109571095810959109601096110962109631096410965109661096710968109691097010971109721097310974109751097610977109781097910980109811098210983109841098510986109871098810989109901099110992109931099410995109961099710998109991100011001110021100311004110051100611007110081100911010110111101211013110141101511016110171101811019110201102111022110231102411025110261102711028110291103011031110321103311034110351103611037110381103911040110411104211043110441104511046110471104811049110501105111052110531105411055110561105711058110591106011061110621106311064110651106611067110681106911070110711107211073110741107511076110771107811079110801108111082110831108411085110861108711088110891109011091110921109311094110951109611097110981109911100111011110211103111041110511106111071110811109111101111111112111131111411115111161111711118111191112011121111221112311124111251112611127111281112911130111311113211133111341113511136111371113811139111401114111142111431114411145111461114711148111491115011151111521115311154111551115611157111581115911160111611116211163111641116511166111671116811169111701117111172111731117411175111761117711178111791118011181111821118311184111851118611187111881118911190111911119211193111941119511196111971119811199112001120111202112031120411205112061120711208112091121011211112121121311214112151121611217112181121911220112211122211223112241122511226112271122811229112301123111232112331123411235112361123711238112391124011241112421124311244112451124611247112481124911250112511125211253112541125511256112571125811259112601126111262112631126411265112661126711268112691127011271112721127311274112751127611277112781127911280112811128211283112841128511286112871128811289112901129111292112931129411295112961129711298112991130011301113021130311304113051130611307113081130911310113111131211313113141131511316113171131811319113201132111322113231132411325113261132711328113291133011331113321133311334113351133611337113381133911340113411134211343113441134511346113471134811349113501135111352113531135411355113561135711358113591136011361113621136311364113651136611367113681136911370113711137211373113741137511376113771137811379113801138111382113831138411385113861138711388113891139011391113921139311394113951139611397113981139911400114011140211403114041140511406114071140811409114101141111412114131141411415114161141711418114191142011421114221142311424114251142611427114281142911430114311143211433114341143511436114371143811439114401144111442114431144411445114461144711448114491145011451114521145311454114551145611457114581145911460114611146211463114641146511466114671146811469114701147111472114731147411475114761147711478114791148011481114821148311484114851148611487114881148911490114911149211493114941149511496114971149811499115001150111502115031150411505115061150711508115091151011511115121151311514115151151611517115181151911520115211152211523115241152511526115271152811529115301153111532115331153411535115361153711538115391154011541115421154311544115451154611547115481154911550115511155211553115541155511556115571155811559115601156111562115631156411565115661156711568115691157011571115721157311574115751157611577115781157911580115811158211583115841158511586115871158811589115901159111592115931159411595115961159711598115991160011601116021160311604116051160611607116081160911610116111161211613116141161511616116171161811619116201162111622116231162411625116261162711628116291163011631116321163311634116351163611637116381163911640116411164211643116441164511646116471164811649116501165111652116531165411655116561165711658116591166011661116621166311664116651166611667116681166911670116711167211673116741167511676116771167811679116801168111682116831168411685116861168711688116891169011691116921169311694116951169611697116981169911700117011170211703117041170511706117071170811709117101171111712117131171411715117161171711718117191172011721117221172311724117251172611727117281172911730117311173211733117341173511736117371173811739117401174111742117431174411745117461174711748117491175011751117521175311754117551175611757117581175911760117611176211763117641176511766117671176811769117701177111772117731177411775117761177711778117791178011781117821178311784117851178611787117881178911790117911179211793117941179511796117971179811799118001180111802118031180411805118061180711808118091181011811118121181311814118151181611817118181181911820118211182211823118241182511826118271182811829118301183111832118331183411835118361183711838118391184011841118421184311844118451184611847118481184911850118511185211853118541185511856118571185811859118601186111862118631186411865118661186711868118691187011871118721187311874118751187611877118781187911880118811188211883118841188511886118871188811889118901189111892118931189411895118961189711898118991190011901119021190311904119051190611907119081190911910119111191211913119141191511916119171191811919119201192111922119231192411925119261192711928119291193011931119321193311934119351193611937119381193911940119411194211943119441194511946119471194811949119501195111952119531195411955119561195711958119591196011961119621196311964119651196611967119681196911970119711197211973119741197511976119771197811979119801198111982119831198411985119861198711988119891199011991119921199311994119951199611997119981199912000120011200212003120041200512006120071200812009120101201112012120131201412015120161201712018120191202012021120221202312024120251202612027120281202912030120311203212033120341203512036120371203812039120401204112042120431204412045120461204712048120491205012051120521205312054120551205612057120581205912060120611206212063120641206512066120671206812069120701207112072120731207412075120761207712078120791208012081120821208312084120851208612087120881208912090120911209212093120941209512096120971209812099121001210112102121031210412105121061210712108121091211012111121121211312114121151211612117121181211912120121211212212123121241212512126121271212812129121301213112132121331213412135121361213712138121391214012141121421214312144121451214612147121481214912150121511215212153121541215512156121571215812159121601216112162121631216412165121661216712168121691217012171121721217312174121751217612177121781217912180121811218212183121841218512186121871218812189121901219112192121931219412195121961219712198121991220012201122021220312204122051220612207122081220912210122111221212213122141221512216122171221812219122201222112222122231222412225122261222712228122291223012231122321223312234122351223612237122381223912240122411224212243122441224512246122471224812249122501225112252122531225412255122561225712258122591226012261122621226312264122651226612267122681226912270122711227212273122741227512276122771227812279122801228112282122831228412285122861228712288122891229012291122921229312294122951229612297122981229912300123011230212303123041230512306123071230812309123101231112312123131231412315123161231712318123191232012321123221232312324123251232612327123281232912330123311233212333123341233512336123371233812339123401234112342123431234412345123461234712348123491235012351123521235312354123551235612357123581235912360123611236212363123641236512366123671236812369123701237112372123731237412375123761237712378123791238012381123821238312384123851238612387123881238912390123911239212393123941239512396123971239812399124001240112402124031240412405124061240712408124091241012411124121241312414124151241612417124181241912420124211242212423124241242512426124271242812429124301243112432124331243412435124361243712438124391244012441124421244312444124451244612447124481244912450124511245212453124541245512456124571245812459124601246112462124631246412465124661246712468124691247012471124721247312474124751247612477124781247912480124811248212483124841248512486124871248812489124901249112492124931249412495124961249712498124991250012501125021250312504125051250612507125081250912510125111251212513125141251512516125171251812519125201252112522125231252412525125261252712528125291253012531125321253312534125351253612537125381253912540125411254212543125441254512546125471254812549125501255112552125531255412555125561255712558125591256012561125621256312564125651256612567125681256912570125711257212573125741257512576125771257812579125801258112582125831258412585125861258712588125891259012591125921259312594125951259612597125981259912600126011260212603126041260512606126071260812609126101261112612126131261412615126161261712618126191262012621126221262312624126251262612627126281262912630126311263212633126341263512636126371263812639126401264112642126431264412645126461264712648126491265012651126521265312654126551265612657126581265912660126611266212663126641266512666126671266812669126701267112672126731267412675126761267712678126791268012681126821268312684126851268612687126881268912690126911269212693126941269512696126971269812699127001270112702127031270412705127061270712708127091271012711127121271312714127151271612717127181271912720127211272212723127241272512726127271272812729127301273112732127331273412735127361273712738127391274012741127421274312744127451274612747127481274912750127511275212753127541275512756127571275812759127601276112762127631276412765127661276712768127691277012771127721277312774127751277612777127781277912780127811278212783127841278512786127871278812789127901279112792127931279412795127961279712798127991280012801128021280312804128051280612807128081280912810128111281212813128141281512816128171281812819128201282112822128231282412825128261282712828128291283012831128321283312834128351283612837128381283912840128411284212843128441284512846128471284812849128501285112852128531285412855128561285712858128591286012861128621286312864128651286612867128681286912870128711287212873128741287512876128771287812879128801288112882128831288412885128861288712888128891289012891128921289312894128951289612897128981289912900129011290212903129041290512906129071290812909129101291112912129131291412915129161291712918129191292012921129221292312924129251292612927129281292912930129311293212933129341293512936129371293812939129401294112942129431294412945129461294712948129491295012951129521295312954129551295612957129581295912960129611296212963129641296512966129671296812969129701297112972129731297412975129761297712978129791298012981129821298312984129851298612987129881298912990129911299212993129941299512996129971299812999130001300113002130031300413005130061300713008130091301013011130121301313014130151301613017130181301913020130211302213023130241302513026130271302813029130301303113032130331303413035130361303713038130391304013041130421304313044130451304613047130481304913050130511305213053130541305513056130571305813059130601306113062130631306413065130661306713068130691307013071130721307313074130751307613077130781307913080130811308213083130841308513086130871308813089130901309113092130931309413095130961309713098130991310013101131021310313104131051310613107131081310913110131111311213113131141311513116131171311813119131201312113122131231312413125131261312713128131291313013131131321313313134131351313613137131381313913140131411314213143131441314513146131471314813149131501315113152131531315413155131561315713158131591316013161131621316313164131651316613167131681316913170131711317213173131741317513176131771317813179131801318113182131831318413185131861318713188131891319013191131921319313194131951319613197131981319913200132011320213203132041320513206132071320813209132101321113212132131321413215132161321713218132191322013221132221322313224132251322613227132281322913230132311323213233132341323513236132371323813239132401324113242132431324413245132461324713248132491325013251132521325313254132551325613257132581325913260132611326213263132641326513266132671326813269132701327113272132731327413275132761327713278132791328013281132821328313284132851328613287132881328913290132911329213293132941329513296132971329813299133001330113302133031330413305133061330713308133091331013311133121331313314133151331613317133181331913320133211332213323133241332513326133271332813329133301333113332133331333413335133361333713338133391334013341133421334313344133451334613347133481334913350133511335213353133541335513356133571335813359133601336113362133631336413365133661336713368133691337013371133721337313374133751337613377133781337913380133811338213383133841338513386133871338813389133901339113392133931339413395133961339713398133991340013401134021340313404134051340613407134081340913410134111341213413134141341513416134171341813419134201342113422134231342413425134261342713428134291343013431134321343313434134351343613437134381343913440134411344213443134441344513446134471344813449134501345113452134531345413455134561345713458134591346013461134621346313464134651346613467134681346913470134711347213473134741347513476134771347813479134801348113482134831348413485134861348713488134891349013491134921349313494134951349613497134981349913500135011350213503135041350513506135071350813509135101351113512135131351413515135161351713518135191352013521135221352313524135251352613527135281352913530135311353213533135341353513536135371353813539135401354113542135431354413545135461354713548135491355013551135521355313554135551355613557135581355913560135611356213563135641356513566135671356813569135701357113572135731357413575135761357713578135791358013581135821358313584135851358613587135881358913590135911359213593135941359513596135971359813599136001360113602136031360413605136061360713608136091361013611136121361313614136151361613617136181361913620136211362213623136241362513626136271362813629136301363113632136331363413635136361363713638136391364013641136421364313644136451364613647136481364913650136511365213653136541365513656136571365813659136601366113662136631366413665136661366713668136691367013671136721367313674136751367613677136781367913680136811368213683136841368513686136871368813689136901369113692136931369413695136961369713698136991370013701137021370313704137051370613707137081370913710137111371213713137141371513716137171371813719137201372113722137231372413725137261372713728137291373013731137321373313734137351373613737137381373913740137411374213743137441374513746137471374813749137501375113752137531375413755137561375713758137591376013761137621376313764137651376613767137681376913770137711377213773137741377513776137771377813779137801378113782137831378413785137861378713788137891379013791137921379313794137951379613797137981379913800138011380213803138041380513806138071380813809138101381113812138131381413815138161381713818138191382013821138221382313824138251382613827138281382913830138311383213833138341383513836138371383813839138401384113842138431384413845138461384713848138491385013851138521385313854138551385613857138581385913860138611386213863138641386513866138671386813869138701387113872138731387413875138761387713878138791388013881138821388313884138851388613887138881388913890138911389213893138941389513896138971389813899139001390113902139031390413905139061390713908139091391013911139121391313914139151391613917139181391913920139211392213923139241392513926139271392813929139301393113932139331393413935139361393713938139391394013941139421394313944139451394613947139481394913950139511395213953139541395513956139571395813959139601396113962139631396413965139661396713968139691397013971139721397313974139751397613977139781397913980139811398213983139841398513986139871398813989139901399113992139931399413995139961399713998139991400014001140021400314004140051400614007140081400914010140111401214013140141401514016140171401814019140201402114022140231402414025140261402714028140291403014031140321403314034140351403614037140381403914040140411404214043140441404514046140471404814049140501405114052140531405414055140561405714058140591406014061140621406314064140651406614067140681406914070140711407214073140741407514076140771407814079140801408114082140831408414085140861408714088140891409014091140921409314094140951409614097140981409914100141011410214103141041410514106141071410814109141101411114112141131411414115141161411714118141191412014121141221412314124141251412614127141281412914130141311413214133141341413514136141371413814139141401414114142141431414414145141461414714148141491415014151141521415314154141551415614157141581415914160141611416214163141641416514166141671416814169141701417114172141731417414175141761417714178141791418014181141821418314184141851418614187141881418914190141911419214193141941419514196141971419814199142001420114202142031420414205142061420714208142091421014211142121421314214142151421614217142181421914220142211422214223142241422514226142271422814229142301423114232142331423414235142361423714238142391424014241142421424314244142451424614247142481424914250142511425214253142541425514256142571425814259142601426114262142631426414265142661426714268142691427014271142721427314274142751427614277142781427914280142811428214283142841428514286142871428814289142901429114292142931429414295142961429714298142991430014301143021430314304143051430614307143081430914310143111431214313143141431514316143171431814319143201432114322143231432414325143261432714328143291433014331143321433314334143351433614337143381433914340143411434214343143441434514346143471434814349143501435114352143531435414355143561435714358143591436014361143621436314364143651436614367143681436914370143711437214373143741437514376143771437814379143801438114382143831438414385143861438714388143891439014391143921439314394143951439614397143981439914400144011440214403144041440514406144071440814409144101441114412144131441414415144161441714418144191442014421144221442314424144251442614427144281442914430144311443214433144341443514436144371443814439144401444114442144431444414445144461444714448144491445014451144521445314454144551445614457144581445914460144611446214463144641446514466144671446814469144701447114472144731447414475144761447714478144791448014481144821448314484144851448614487144881448914490144911449214493144941449514496144971449814499145001450114502145031450414505145061450714508145091451014511145121451314514145151451614517145181451914520145211452214523145241452514526145271452814529145301453114532145331453414535145361453714538145391454014541145421454314544145451454614547145481454914550145511455214553145541455514556145571455814559145601456114562145631456414565145661456714568145691457014571145721457314574145751457614577145781457914580145811458214583145841458514586145871458814589145901459114592145931459414595145961459714598145991460014601146021460314604146051460614607146081460914610146111461214613146141461514616146171461814619146201462114622146231462414625146261462714628146291463014631146321463314634146351463614637146381463914640146411464214643146441464514646146471464814649146501465114652146531465414655146561465714658146591466014661146621466314664146651466614667146681466914670146711467214673146741467514676146771467814679146801468114682146831468414685146861468714688146891469014691146921469314694146951469614697146981469914700147011470214703147041470514706147071470814709147101471114712147131471414715147161471714718147191472014721147221472314724147251472614727147281472914730147311473214733147341473514736147371473814739147401474114742147431474414745147461474714748147491475014751147521475314754147551475614757147581475914760147611476214763147641476514766147671476814769147701477114772147731477414775147761477714778147791478014781147821478314784147851478614787147881478914790147911479214793147941479514796147971479814799148001480114802148031480414805148061480714808148091481014811148121481314814148151481614817148181481914820148211482214823148241482514826148271482814829148301483114832148331483414835148361483714838148391484014841148421484314844148451484614847148481484914850148511485214853148541485514856148571485814859148601486114862148631486414865148661486714868148691487014871148721487314874148751487614877148781487914880148811488214883148841488514886148871488814889148901489114892148931489414895148961489714898148991490014901149021490314904149051490614907149081490914910149111491214913149141491514916149171491814919149201492114922149231492414925149261492714928149291493014931149321493314934149351493614937149381493914940149411494214943149441494514946149471494814949149501495114952149531495414955149561495714958149591496014961149621496314964149651496614967149681496914970149711497214973149741497514976149771497814979149801498114982149831498414985149861498714988149891499014991149921499314994149951499614997149981499915000150011500215003150041500515006150071500815009150101501115012150131501415015150161501715018150191502015021150221502315024150251502615027150281502915030150311503215033150341503515036150371503815039150401504115042150431504415045150461504715048150491505015051150521505315054150551505615057150581505915060150611506215063150641506515066150671506815069150701507115072150731507415075150761507715078150791508015081150821508315084150851508615087150881508915090150911509215093150941509515096150971509815099151001510115102151031510415105151061510715108151091511015111151121511315114151151511615117151181511915120151211512215123151241512515126151271512815129151301513115132151331513415135151361513715138151391514015141151421514315144151451514615147151481514915150151511515215153151541515515156151571515815159151601516115162151631516415165151661516715168151691517015171151721517315174151751517615177151781517915180151811518215183151841518515186151871518815189151901519115192151931519415195151961519715198151991520015201152021520315204152051520615207152081520915210152111521215213152141521515216152171521815219152201522115222152231522415225152261522715228152291523015231152321523315234152351523615237152381523915240152411524215243152441524515246152471524815249152501525115252152531525415255152561525715258152591526015261152621526315264152651526615267152681526915270152711527215273152741527515276152771527815279152801528115282152831528415285152861528715288152891529015291152921529315294152951529615297152981529915300153011530215303153041530515306153071530815309153101531115312153131531415315153161531715318153191532015321153221532315324153251532615327153281532915330153311533215333153341533515336153371533815339153401534115342153431534415345153461534715348153491535015351153521535315354153551535615357153581535915360153611536215363153641536515366153671536815369153701537115372153731537415375153761537715378153791538015381153821538315384153851538615387153881538915390153911539215393153941539515396153971539815399154001540115402154031540415405154061540715408154091541015411154121541315414154151541615417154181541915420154211542215423154241542515426154271542815429154301543115432154331543415435154361543715438154391544015441154421544315444154451544615447154481544915450154511545215453154541545515456154571545815459154601546115462154631546415465154661546715468154691547015471154721547315474154751547615477154781547915480154811548215483154841548515486154871548815489154901549115492154931549415495154961549715498154991550015501155021550315504155051550615507155081550915510155111551215513155141551515516155171551815519155201552115522155231552415525155261552715528155291553015531155321553315534155351553615537155381553915540155411554215543155441554515546155471554815549155501555115552155531555415555155561555715558155591556015561155621556315564155651556615567155681556915570155711557215573155741557515576155771557815579155801558115582155831558415585155861558715588155891559015591155921559315594155951559615597155981559915600156011560215603156041560515606156071560815609156101561115612156131561415615156161561715618156191562015621156221562315624156251562615627156281562915630156311563215633156341563515636156371563815639156401564115642156431564415645156461564715648156491565015651156521565315654156551565615657156581565915660156611566215663156641566515666156671566815669156701567115672156731567415675156761567715678156791568015681156821568315684156851568615687156881568915690156911569215693156941569515696156971569815699157001570115702157031570415705157061570715708157091571015711157121571315714157151571615717157181571915720157211572215723157241572515726157271572815729157301573115732157331573415735157361573715738157391574015741157421574315744157451574615747157481574915750157511575215753157541575515756157571575815759157601576115762157631576415765157661576715768157691577015771157721577315774157751577615777157781577915780157811578215783157841578515786157871578815789157901579115792157931579415795157961579715798157991580015801158021580315804158051580615807158081580915810158111581215813158141581515816158171581815819158201582115822158231582415825158261582715828158291583015831158321583315834158351583615837158381583915840158411584215843158441584515846158471584815849158501585115852158531585415855158561585715858158591586015861158621586315864158651586615867158681586915870158711587215873158741587515876158771587815879158801588115882158831588415885158861588715888158891589015891158921589315894158951589615897158981589915900159011590215903159041590515906159071590815909159101591115912159131591415915159161591715918159191592015921159221592315924159251592615927159281592915930159311593215933159341593515936159371593815939159401594115942159431594415945159461594715948159491595015951159521595315954159551595615957159581595915960159611596215963159641596515966159671596815969159701597115972159731597415975159761597715978159791598015981159821598315984159851598615987159881598915990159911599215993159941599515996159971599815999160001600116002160031600416005160061600716008160091601016011160121601316014160151601616017160181601916020160211602216023160241602516026160271602816029160301603116032160331603416035160361603716038160391604016041160421604316044160451604616047160481604916050160511605216053160541605516056160571605816059160601606116062160631606416065160661606716068160691607016071160721607316074160751607616077160781607916080160811608216083160841608516086160871608816089160901609116092160931609416095160961609716098160991610016101161021610316104161051610616107161081610916110161111611216113161141611516116161171611816119161201612116122161231612416125161261612716128161291613016131161321613316134161351613616137161381613916140161411614216143161441614516146161471614816149161501615116152161531615416155161561615716158161591616016161161621616316164161651616616167161681616916170161711617216173161741617516176161771617816179161801618116182161831618416185161861618716188161891619016191161921619316194161951619616197161981619916200162011620216203162041620516206162071620816209162101621116212162131621416215162161621716218162191622016221162221622316224162251622616227162281622916230162311623216233162341623516236162371623816239162401624116242162431624416245162461624716248162491625016251162521625316254162551625616257162581625916260162611626216263162641626516266162671626816269162701627116272162731627416275162761627716278162791628016281162821628316284162851628616287162881628916290162911629216293162941629516296162971629816299163001630116302163031630416305163061630716308163091631016311163121631316314163151631616317163181631916320163211632216323163241632516326163271632816329163301633116332163331633416335163361633716338163391634016341163421634316344163451634616347163481634916350163511635216353163541635516356163571635816359163601636116362163631636416365163661636716368163691637016371163721637316374163751637616377163781637916380163811638216383163841638516386163871638816389163901639116392163931639416395163961639716398163991640016401164021640316404164051640616407164081640916410164111641216413164141641516416164171641816419164201642116422164231642416425164261642716428164291643016431164321643316434164351643616437164381643916440164411644216443164441644516446164471644816449164501645116452164531645416455164561645716458164591646016461164621646316464164651646616467164681646916470164711647216473164741647516476164771647816479164801648116482164831648416485164861648716488164891649016491164921649316494164951649616497164981649916500165011650216503165041650516506165071650816509165101651116512165131651416515165161651716518165191652016521165221652316524165251652616527165281652916530165311653216533165341653516536165371653816539165401654116542165431654416545165461654716548165491655016551165521655316554165551655616557165581655916560165611656216563165641656516566165671656816569165701657116572165731657416575165761657716578165791658016581165821658316584165851658616587165881658916590165911659216593165941659516596165971659816599166001660116602166031660416605166061660716608166091661016611166121661316614166151661616617166181661916620166211662216623166241662516626166271662816629166301663116632166331663416635166361663716638166391664016641166421664316644166451664616647166481664916650166511665216653166541665516656166571665816659166601666116662166631666416665166661666716668166691667016671166721667316674166751667616677166781667916680166811668216683166841668516686166871668816689166901669116692166931669416695166961669716698166991670016701167021670316704167051670616707167081670916710167111671216713167141671516716167171671816719167201672116722167231672416725167261672716728167291673016731167321673316734167351673616737167381673916740167411674216743167441674516746167471674816749167501675116752167531675416755167561675716758167591676016761167621676316764167651676616767167681676916770167711677216773167741677516776167771677816779167801678116782167831678416785167861678716788167891679016791167921679316794167951679616797167981679916800168011680216803168041680516806168071680816809168101681116812168131681416815168161681716818168191682016821168221682316824168251682616827168281682916830168311683216833168341683516836168371683816839168401684116842168431684416845168461684716848168491685016851168521685316854168551685616857168581685916860168611686216863168641686516866168671686816869168701687116872168731687416875168761687716878168791688016881168821688316884168851688616887168881688916890168911689216893168941689516896168971689816899169001690116902169031690416905169061690716908169091691016911169121691316914169151691616917169181691916920169211692216923169241692516926169271692816929169301693116932169331693416935169361693716938169391694016941169421694316944169451694616947169481694916950169511695216953169541695516956169571695816959169601696116962169631696416965169661696716968169691697016971169721697316974169751697616977169781697916980169811698216983169841698516986169871698816989169901699116992169931699416995169961699716998169991700017001170021700317004170051700617007170081700917010170111701217013170141701517016170171701817019170201702117022170231702417025170261702717028170291703017031170321703317034170351703617037170381703917040170411704217043170441704517046170471704817049170501705117052170531705417055170561705717058170591706017061170621706317064170651706617067170681706917070170711707217073170741707517076170771707817079170801708117082170831708417085170861708717088170891709017091170921709317094170951709617097170981709917100171011710217103171041710517106171071710817109171101711117112171131711417115171161711717118171191712017121171221712317124171251712617127171281712917130171311713217133171341713517136171371713817139171401714117142171431714417145171461714717148171491715017151171521715317154171551715617157171581715917160171611716217163171641716517166171671716817169171701717117172171731717417175171761717717178171791718017181171821718317184171851718617187171881718917190171911719217193171941719517196171971719817199172001720117202172031720417205172061720717208172091721017211172121721317214172151721617217172181721917220172211722217223172241722517226172271722817229172301723117232172331723417235172361723717238172391724017241172421724317244172451724617247172481724917250172511725217253172541725517256172571725817259172601726117262172631726417265172661726717268172691727017271172721727317274172751727617277172781727917280172811728217283172841728517286172871728817289172901729117292172931729417295172961729717298172991730017301173021730317304173051730617307173081730917310173111731217313173141731517316173171731817319173201732117322173231732417325173261732717328173291733017331173321733317334173351733617337173381733917340173411734217343173441734517346173471734817349173501735117352173531735417355173561735717358173591736017361173621736317364173651736617367173681736917370173711737217373173741737517376173771737817379173801738117382173831738417385173861738717388173891739017391173921739317394173951739617397173981739917400174011740217403174041740517406174071740817409174101741117412174131741417415174161741717418174191742017421174221742317424174251742617427174281742917430174311743217433174341743517436174371743817439174401744117442174431744417445174461744717448174491745017451174521745317454174551745617457174581745917460174611746217463174641746517466174671746817469174701747117472174731747417475174761747717478174791748017481174821748317484174851748617487174881748917490174911749217493174941749517496174971749817499175001750117502175031750417505175061750717508175091751017511175121751317514175151751617517175181751917520175211752217523175241752517526175271752817529175301753117532175331753417535175361753717538175391754017541175421754317544175451754617547175481754917550175511755217553175541755517556175571755817559175601756117562175631756417565175661756717568175691757017571175721757317574175751757617577175781757917580175811758217583175841758517586175871758817589175901759117592175931759417595175961759717598175991760017601176021760317604176051760617607176081760917610176111761217613176141761517616176171761817619176201762117622176231762417625176261762717628176291763017631176321763317634176351763617637176381763917640176411764217643176441764517646176471764817649176501765117652176531765417655176561765717658176591766017661176621766317664176651766617667176681766917670176711767217673176741767517676176771767817679176801768117682176831768417685176861768717688176891769017691176921769317694176951769617697176981769917700177011770217703177041770517706177071770817709177101771117712177131771417715177161771717718177191772017721177221772317724177251772617727177281772917730177311773217733177341773517736177371773817739177401774117742177431774417745177461774717748177491775017751177521775317754177551775617757177581775917760177611776217763177641776517766177671776817769177701777117772177731777417775177761777717778177791778017781177821778317784177851778617787177881778917790177911779217793177941779517796177971779817799178001780117802178031780417805178061780717808178091781017811178121781317814178151781617817178181781917820178211782217823178241782517826178271782817829178301783117832178331783417835178361783717838178391784017841178421784317844178451784617847178481784917850178511785217853178541785517856178571785817859178601786117862178631786417865178661786717868178691787017871178721787317874178751787617877178781787917880178811788217883178841788517886178871788817889178901789117892178931789417895178961789717898178991790017901179021790317904179051790617907179081790917910179111791217913179141791517916179171791817919179201792117922179231792417925179261792717928179291793017931179321793317934179351793617937179381793917940179411794217943179441794517946179471794817949179501795117952179531795417955179561795717958179591796017961179621796317964179651796617967179681796917970179711797217973179741797517976179771797817979179801798117982179831798417985179861798717988179891799017991179921799317994179951799617997179981799918000180011800218003180041800518006180071800818009180101801118012180131801418015180161801718018180191802018021180221802318024180251802618027180281802918030180311803218033180341803518036180371803818039180401804118042180431804418045180461804718048180491805018051180521805318054180551805618057180581805918060180611806218063180641806518066180671806818069180701807118072180731807418075180761807718078180791808018081180821808318084180851808618087180881808918090180911809218093180941809518096180971809818099181001810118102181031810418105181061810718108181091811018111181121811318114181151811618117181181811918120181211812218123181241812518126181271812818129181301813118132181331813418135181361813718138181391814018141181421814318144181451814618147181481814918150181511815218153181541815518156181571815818159181601816118162181631816418165181661816718168181691817018171181721817318174181751817618177181781817918180181811818218183181841818518186181871818818189181901819118192181931819418195181961819718198181991820018201182021820318204182051820618207182081820918210182111821218213182141821518216182171821818219182201822118222182231822418225182261822718228182291823018231182321823318234182351823618237182381823918240182411824218243182441824518246182471824818249182501825118252182531825418255182561825718258182591826018261182621826318264182651826618267182681826918270182711827218273182741827518276182771827818279182801828118282182831828418285182861828718288182891829018291182921829318294182951829618297182981829918300183011830218303183041830518306183071830818309183101831118312183131831418315183161831718318183191832018321183221832318324183251832618327183281832918330183311833218333183341833518336183371833818339183401834118342183431834418345183461834718348183491835018351183521835318354183551835618357183581835918360183611836218363183641836518366183671836818369183701837118372183731837418375183761837718378183791838018381183821838318384183851838618387183881838918390183911839218393183941839518396183971839818399184001840118402184031840418405184061840718408184091841018411184121841318414184151841618417184181841918420184211842218423184241842518426184271842818429184301843118432184331843418435184361843718438184391844018441184421844318444184451844618447184481844918450184511845218453184541845518456184571845818459184601846118462184631846418465184661846718468184691847018471184721847318474184751847618477184781847918480184811848218483184841848518486184871848818489184901849118492184931849418495184961849718498184991850018501185021850318504185051850618507185081850918510185111851218513185141851518516185171851818519185201852118522185231852418525185261852718528185291853018531185321853318534185351853618537185381853918540185411854218543185441854518546185471854818549185501855118552185531855418555185561855718558185591856018561185621856318564185651856618567185681856918570185711857218573185741857518576185771857818579185801858118582185831858418585185861858718588185891859018591185921859318594185951859618597185981859918600186011860218603186041860518606186071860818609186101861118612186131861418615186161861718618186191862018621186221862318624186251862618627186281862918630186311863218633186341863518636186371863818639186401864118642186431864418645186461864718648186491865018651186521865318654186551865618657186581865918660186611866218663186641866518666186671866818669186701867118672186731867418675186761867718678186791868018681186821868318684186851868618687186881868918690186911869218693186941869518696186971869818699187001870118702187031870418705187061870718708187091871018711187121871318714187151871618717187181871918720187211872218723187241872518726187271872818729187301873118732187331873418735187361873718738187391874018741187421874318744187451874618747187481874918750187511875218753187541875518756187571875818759187601876118762187631876418765187661876718768187691877018771187721877318774187751877618777187781877918780187811878218783187841878518786187871878818789187901879118792187931879418795187961879718798187991880018801188021880318804188051880618807188081880918810188111881218813188141881518816188171881818819188201882118822188231882418825188261882718828188291883018831188321883318834188351883618837188381883918840188411884218843188441884518846188471884818849188501885118852188531885418855188561885718858188591886018861188621886318864188651886618867188681886918870188711887218873188741887518876188771887818879188801888118882188831888418885188861888718888188891889018891188921889318894188951889618897188981889918900189011890218903189041890518906189071890818909189101891118912189131891418915189161891718918189191892018921189221892318924189251892618927189281892918930189311893218933189341893518936189371893818939189401894118942189431894418945189461894718948189491895018951189521895318954189551895618957189581895918960189611896218963189641896518966189671896818969189701897118972189731897418975189761897718978189791898018981189821898318984189851898618987189881898918990189911899218993189941899518996189971899818999190001900119002190031900419005190061900719008190091901019011190121901319014190151901619017190181901919020190211902219023190241902519026190271902819029190301903119032190331903419035190361903719038190391904019041190421904319044190451904619047190481904919050190511905219053190541905519056190571905819059190601906119062190631906419065190661906719068190691907019071190721907319074190751907619077190781907919080190811908219083190841908519086190871908819089190901909119092190931909419095190961909719098190991910019101191021910319104191051910619107191081910919110191111911219113191141911519116191171911819119191201912119122191231912419125191261912719128191291913019131191321913319134191351913619137191381913919140191411914219143191441914519146191471914819149191501915119152191531915419155191561915719158191591916019161191621916319164191651916619167191681916919170191711917219173191741917519176191771917819179191801918119182191831918419185191861918719188191891919019191191921919319194191951919619197191981919919200192011920219203192041920519206192071920819209192101921119212192131921419215192161921719218192191922019221192221922319224192251922619227192281922919230192311923219233192341923519236192371923819239192401924119242192431924419245192461924719248192491925019251192521925319254192551925619257192581925919260192611926219263192641926519266192671926819269192701927119272192731927419275192761927719278192791928019281192821928319284192851928619287192881928919290192911929219293192941929519296192971929819299193001930119302193031930419305193061930719308193091931019311193121931319314193151931619317193181931919320193211932219323193241932519326193271932819329193301933119332193331933419335193361933719338193391934019341193421934319344193451934619347193481934919350193511935219353193541935519356193571935819359193601936119362193631936419365193661936719368193691937019371193721937319374193751937619377193781937919380193811938219383193841938519386193871938819389193901939119392193931939419395193961939719398193991940019401194021940319404194051940619407194081940919410194111941219413194141941519416194171941819419194201942119422194231942419425194261942719428194291943019431194321943319434194351943619437194381943919440194411944219443194441944519446194471944819449194501945119452194531945419455194561945719458194591946019461194621946319464194651946619467194681946919470194711947219473194741947519476194771947819479194801948119482194831948419485194861948719488194891949019491194921949319494194951949619497194981949919500195011950219503195041950519506195071950819509195101951119512195131951419515195161951719518195191952019521195221952319524195251952619527195281952919530195311953219533195341953519536195371953819539195401954119542195431954419545195461954719548195491955019551195521955319554195551955619557195581955919560195611956219563195641956519566195671956819569195701957119572195731957419575195761957719578195791958019581195821958319584195851958619587195881958919590195911959219593195941959519596195971959819599196001960119602196031960419605196061960719608196091961019611196121961319614196151961619617196181961919620196211962219623196241962519626196271962819629196301963119632196331963419635196361963719638196391964019641196421964319644196451964619647196481964919650196511965219653196541965519656196571965819659196601966119662196631966419665196661966719668196691967019671196721967319674196751967619677196781967919680196811968219683196841968519686196871968819689196901969119692196931969419695196961969719698196991970019701197021970319704197051970619707197081970919710197111971219713197141971519716197171971819719197201972119722197231972419725197261972719728197291973019731197321973319734197351973619737197381973919740197411974219743197441974519746197471974819749197501975119752197531975419755197561975719758197591976019761197621976319764197651976619767197681976919770197711977219773197741977519776197771977819779197801978119782197831978419785197861978719788197891979019791197921979319794197951979619797197981979919800198011980219803198041980519806198071980819809198101981119812198131981419815198161981719818198191982019821198221982319824198251982619827198281982919830198311983219833198341983519836198371983819839198401984119842198431984419845198461984719848198491985019851198521985319854198551985619857198581985919860198611986219863198641986519866198671986819869198701987119872198731987419875198761987719878198791988019881198821988319884198851988619887198881988919890198911989219893198941989519896198971989819899199001990119902199031990419905199061990719908199091991019911199121991319914199151991619917199181991919920199211992219923199241992519926199271992819929199301993119932199331993419935199361993719938199391994019941199421994319944199451994619947199481994919950199511995219953199541995519956199571995819959199601996119962199631996419965199661996719968199691997019971199721997319974199751997619977199781997919980199811998219983199841998519986199871998819989199901999119992199931999419995199961999719998199992000020001200022000320004200052000620007200082000920010200112001220013200142001520016200172001820019200202002120022200232002420025200262002720028200292003020031200322003320034200352003620037200382003920040200412004220043200442004520046200472004820049200502005120052200532005420055200562005720058200592006020061200622006320064200652006620067200682006920070200712007220073200742007520076200772007820079200802008120082200832008420085200862008720088200892009020091200922009320094200952009620097200982009920100201012010220103201042010520106201072010820109201102011120112201132011420115201162011720118201192012020121201222012320124201252012620127201282012920130201312013220133201342013520136201372013820139201402014120142201432014420145201462014720148201492015020151201522015320154201552015620157201582015920160201612016220163201642016520166201672016820169201702017120172201732017420175201762017720178201792018020181201822018320184201852018620187201882018920190201912019220193201942019520196201972019820199202002020120202202032020420205202062020720208202092021020211202122021320214202152021620217202182021920220202212022220223202242022520226202272022820229202302023120232202332023420235202362023720238202392024020241202422024320244202452024620247202482024920250202512025220253202542025520256202572025820259202602026120262202632026420265202662026720268202692027020271202722027320274202752027620277202782027920280202812028220283202842028520286202872028820289202902029120292202932029420295202962029720298202992030020301203022030320304203052030620307203082030920310203112031220313203142031520316203172031820319203202032120322203232032420325203262032720328203292033020331203322033320334203352033620337203382033920340203412034220343203442034520346203472034820349203502035120352203532035420355203562035720358203592036020361203622036320364203652036620367203682036920370203712037220373203742037520376203772037820379203802038120382203832038420385203862038720388203892039020391203922039320394203952039620397203982039920400204012040220403204042040520406204072040820409204102041120412204132041420415204162041720418204192042020421204222042320424204252042620427204282042920430204312043220433204342043520436204372043820439204402044120442204432044420445204462044720448204492045020451204522045320454204552045620457204582045920460204612046220463204642046520466204672046820469204702047120472204732047420475204762047720478204792048020481204822048320484204852048620487204882048920490204912049220493204942049520496204972049820499205002050120502205032050420505205062050720508205092051020511205122051320514205152051620517205182051920520205212052220523205242052520526205272052820529205302053120532205332053420535205362053720538205392054020541205422054320544205452054620547205482054920550205512055220553205542055520556205572055820559205602056120562205632056420565205662056720568205692057020571205722057320574205752057620577205782057920580205812058220583205842058520586205872058820589205902059120592205932059420595205962059720598205992060020601206022060320604206052060620607206082060920610206112061220613206142061520616206172061820619206202062120622206232062420625206262062720628206292063020631206322063320634206352063620637206382063920640206412064220643206442064520646206472064820649206502065120652206532065420655206562065720658206592066020661206622066320664206652066620667206682066920670206712067220673206742067520676206772067820679206802068120682206832068420685206862068720688206892069020691206922069320694206952069620697206982069920700207012070220703207042070520706207072070820709207102071120712207132071420715207162071720718207192072020721207222072320724207252072620727207282072920730207312073220733207342073520736207372073820739207402074120742207432074420745207462074720748207492075020751207522075320754207552075620757207582075920760207612076220763207642076520766207672076820769207702077120772207732077420775207762077720778207792078020781207822078320784207852078620787207882078920790207912079220793207942079520796207972079820799208002080120802208032080420805208062080720808208092081020811208122081320814208152081620817208182081920820208212082220823208242082520826208272082820829208302083120832208332083420835208362083720838208392084020841208422084320844208452084620847208482084920850208512085220853208542085520856208572085820859208602086120862208632086420865208662086720868208692087020871208722087320874208752087620877208782087920880208812088220883208842088520886208872088820889208902089120892208932089420895208962089720898208992090020901209022090320904209052090620907209082090920910209112091220913209142091520916209172091820919209202092120922209232092420925209262092720928209292093020931209322093320934209352093620937209382093920940209412094220943209442094520946209472094820949209502095120952209532095420955209562095720958209592096020961209622096320964209652096620967209682096920970209712097220973209742097520976209772097820979209802098120982209832098420985209862098720988209892099020991209922099320994209952099620997209982099921000210012100221003210042100521006210072100821009210102101121012210132101421015210162101721018210192102021021210222102321024210252102621027210282102921030210312103221033210342103521036210372103821039210402104121042210432104421045210462104721048210492105021051210522105321054210552105621057210582105921060210612106221063210642106521066210672106821069210702107121072210732107421075210762107721078210792108021081210822108321084210852108621087210882108921090210912109221093210942109521096210972109821099211002110121102211032110421105211062110721108211092111021111211122111321114211152111621117211182111921120211212112221123211242112521126211272112821129211302113121132211332113421135211362113721138211392114021141211422114321144211452114621147211482114921150211512115221153211542115521156211572115821159211602116121162211632116421165211662116721168211692117021171211722117321174211752117621177211782117921180211812118221183211842118521186211872118821189211902119121192211932119421195211962119721198211992120021201212022120321204212052120621207212082120921210212112121221213212142121521216212172121821219212202122121222212232122421225212262122721228212292123021231212322123321234212352123621237212382123921240212412124221243212442124521246212472124821249212502125121252212532125421255212562125721258212592126021261212622126321264212652126621267212682126921270212712127221273212742127521276212772127821279212802128121282212832128421285212862128721288212892129021291212922129321294212952129621297212982129921300213012130221303213042130521306213072130821309213102131121312213132131421315213162131721318213192132021321213222132321324213252132621327213282132921330213312133221333213342133521336213372133821339213402134121342213432134421345213462134721348213492135021351213522135321354213552135621357213582135921360213612136221363213642136521366213672136821369213702137121372213732137421375213762137721378213792138021381213822138321384213852138621387213882138921390213912139221393213942139521396213972139821399214002140121402214032140421405214062140721408214092141021411214122141321414214152141621417214182141921420214212142221423214242142521426214272142821429214302143121432214332143421435214362143721438214392144021441214422144321444214452144621447214482144921450214512145221453214542145521456214572145821459214602146121462214632146421465214662146721468214692147021471214722147321474214752147621477214782147921480214812148221483214842148521486214872148821489214902149121492214932149421495214962149721498214992150021501215022150321504215052150621507215082150921510215112151221513215142151521516215172151821519215202152121522215232152421525215262152721528215292153021531215322153321534215352153621537215382153921540215412154221543215442154521546215472154821549215502155121552215532155421555215562155721558215592156021561215622156321564215652156621567215682156921570215712157221573215742157521576215772157821579215802158121582215832158421585215862158721588215892159021591215922159321594215952159621597215982159921600216012160221603216042160521606216072160821609216102161121612216132161421615216162161721618216192162021621216222162321624216252162621627216282162921630216312163221633216342163521636216372163821639216402164121642216432164421645216462164721648216492165021651216522165321654216552165621657216582165921660216612166221663216642166521666216672166821669216702167121672216732167421675216762167721678216792168021681216822168321684216852168621687216882168921690216912169221693216942169521696216972169821699217002170121702217032170421705217062170721708217092171021711217122171321714217152171621717217182171921720217212172221723217242172521726217272172821729217302173121732217332173421735217362173721738217392174021741217422174321744217452174621747217482174921750217512175221753217542175521756217572175821759217602176121762217632176421765217662176721768217692177021771217722177321774217752177621777217782177921780217812178221783217842178521786217872178821789217902179121792217932179421795217962179721798217992180021801218022180321804218052180621807218082180921810218112181221813218142181521816218172181821819218202182121822218232182421825218262182721828218292183021831218322183321834218352183621837218382183921840218412184221843218442184521846218472184821849218502185121852218532185421855218562185721858218592186021861218622186321864218652186621867218682186921870218712187221873218742187521876218772187821879218802188121882218832188421885218862188721888218892189021891218922189321894218952189621897218982189921900219012190221903219042190521906219072190821909219102191121912219132191421915219162191721918219192192021921219222192321924219252192621927219282192921930219312193221933219342193521936219372193821939219402194121942219432194421945219462194721948219492195021951219522195321954219552195621957219582195921960219612196221963219642196521966219672196821969219702197121972219732197421975219762197721978219792198021981219822198321984219852198621987219882198921990219912199221993219942199521996219972199821999220002200122002220032200422005220062200722008220092201022011220122201322014220152201622017220182201922020220212202222023220242202522026220272202822029220302203122032220332203422035220362203722038220392204022041220422204322044220452204622047220482204922050220512205222053220542205522056220572205822059220602206122062220632206422065220662206722068220692207022071220722207322074220752207622077220782207922080220812208222083220842208522086220872208822089220902209122092220932209422095220962209722098220992210022101221022210322104221052210622107221082210922110221112211222113221142211522116221172211822119221202212122122221232212422125221262212722128221292213022131221322213322134221352213622137221382213922140221412214222143221442214522146221472214822149221502215122152221532215422155221562215722158221592216022161221622216322164221652216622167221682216922170221712217222173221742217522176221772217822179221802218122182221832218422185221862218722188221892219022191221922219322194221952219622197221982219922200222012220222203222042220522206222072220822209222102221122212222132221422215222162221722218222192222022221222222222322224222252222622227222282222922230222312223222233222342223522236222372223822239222402224122242222432224422245222462224722248222492225022251222522225322254222552225622257222582225922260222612226222263222642226522266222672226822269222702227122272222732227422275222762227722278222792228022281222822228322284222852228622287222882228922290222912229222293222942229522296222972229822299223002230122302223032230422305223062230722308223092231022311223122231322314223152231622317223182231922320223212232222323223242232522326223272232822329223302233122332223332233422335223362233722338223392234022341223422234322344223452234622347223482234922350223512235222353223542235522356223572235822359223602236122362223632236422365223662236722368223692237022371223722237322374223752237622377223782237922380223812238222383223842238522386223872238822389223902239122392223932239422395223962239722398223992240022401224022240322404224052240622407224082240922410224112241222413224142241522416224172241822419224202242122422224232242422425224262242722428224292243022431224322243322434224352243622437224382243922440224412244222443224442244522446224472244822449224502245122452224532245422455224562245722458224592246022461224622246322464224652246622467224682246922470224712247222473224742247522476224772247822479224802248122482224832248422485224862248722488224892249022491224922249322494224952249622497224982249922500225012250222503225042250522506225072250822509225102251122512225132251422515225162251722518225192252022521225222252322524225252252622527225282252922530225312253222533225342253522536225372253822539225402254122542225432254422545225462254722548225492255022551225522255322554225552255622557225582255922560225612256222563225642256522566225672256822569225702257122572225732257422575225762257722578225792258022581225822258322584225852258622587225882258922590225912259222593225942259522596225972259822599226002260122602226032260422605226062260722608226092261022611226122261322614226152261622617226182261922620226212262222623226242262522626226272262822629226302263122632226332263422635226362263722638226392264022641226422264322644226452264622647226482264922650226512265222653226542265522656226572265822659226602266122662226632266422665226662266722668226692267022671226722267322674226752267622677226782267922680226812268222683226842268522686226872268822689226902269122692226932269422695226962269722698226992270022701227022270322704227052270622707227082270922710227112271222713227142271522716227172271822719227202272122722227232272422725227262272722728227292273022731227322273322734227352273622737227382273922740227412274222743227442274522746227472274822749227502275122752227532275422755227562275722758227592276022761227622276322764227652276622767227682276922770227712277222773227742277522776227772277822779227802278122782227832278422785227862278722788227892279022791227922279322794227952279622797227982279922800228012280222803228042280522806228072280822809228102281122812228132281422815228162281722818228192282022821228222282322824228252282622827228282282922830228312283222833228342283522836228372283822839228402284122842228432284422845228462284722848228492285022851228522285322854228552285622857228582285922860228612286222863228642286522866228672286822869228702287122872228732287422875228762287722878228792288022881228822288322884228852288622887228882288922890228912289222893228942289522896228972289822899229002290122902229032290422905229062290722908229092291022911229122291322914229152291622917229182291922920229212292222923229242292522926229272292822929229302293122932229332293422935229362293722938229392294022941229422294322944229452294622947229482294922950229512295222953229542295522956229572295822959229602296122962229632296422965229662296722968229692297022971229722297322974229752297622977229782297922980229812298222983229842298522986229872298822989229902299122992229932299422995229962299722998229992300023001230022300323004230052300623007230082300923010230112301223013230142301523016230172301823019230202302123022230232302423025230262302723028230292303023031230322303323034230352303623037230382303923040230412304223043230442304523046230472304823049230502305123052230532305423055230562305723058230592306023061230622306323064230652306623067230682306923070230712307223073230742307523076230772307823079230802308123082230832308423085230862308723088230892309023091230922309323094230952309623097230982309923100231012310223103231042310523106231072310823109231102311123112231132311423115231162311723118231192312023121231222312323124231252312623127231282312923130231312313223133231342313523136231372313823139231402314123142231432314423145231462314723148231492315023151231522315323154231552315623157231582315923160231612316223163231642316523166231672316823169231702317123172231732317423175231762317723178231792318023181231822318323184231852318623187231882318923190231912319223193231942319523196231972319823199232002320123202232032320423205232062320723208232092321023211232122321323214232152321623217232182321923220232212322223223232242322523226232272322823229232302323123232232332323423235232362323723238232392324023241232422324323244232452324623247232482324923250232512325223253232542325523256232572325823259232602326123262232632326423265232662326723268232692327023271232722327323274232752327623277232782327923280232812328223283232842328523286232872328823289232902329123292232932329423295232962329723298232992330023301233022330323304233052330623307233082330923310233112331223313233142331523316233172331823319233202332123322233232332423325233262332723328233292333023331233322333323334233352333623337233382333923340233412334223343233442334523346233472334823349233502335123352233532335423355233562335723358233592336023361233622336323364233652336623367233682336923370233712337223373233742337523376233772337823379233802338123382233832338423385233862338723388233892339023391233922339323394233952339623397233982339923400234012340223403234042340523406234072340823409234102341123412234132341423415234162341723418234192342023421234222342323424234252342623427234282342923430234312343223433234342343523436234372343823439234402344123442234432344423445234462344723448234492345023451234522345323454234552345623457234582345923460234612346223463234642346523466234672346823469234702347123472234732347423475234762347723478234792348023481234822348323484234852348623487234882348923490234912349223493234942349523496234972349823499235002350123502235032350423505235062350723508235092351023511235122351323514235152351623517235182351923520235212352223523235242352523526235272352823529235302353123532235332353423535235362353723538235392354023541235422354323544235452354623547235482354923550235512355223553235542355523556235572355823559235602356123562235632356423565235662356723568235692357023571235722357323574235752357623577235782357923580235812358223583235842358523586235872358823589235902359123592235932359423595235962359723598235992360023601236022360323604236052360623607236082360923610236112361223613236142361523616236172361823619236202362123622236232362423625236262362723628236292363023631236322363323634236352363623637236382363923640236412364223643236442364523646236472364823649236502365123652236532365423655236562365723658236592366023661236622366323664236652366623667236682366923670236712367223673236742367523676236772367823679236802368123682236832368423685236862368723688236892369023691236922369323694236952369623697236982369923700237012370223703237042370523706237072370823709237102371123712237132371423715237162371723718237192372023721237222372323724237252372623727237282372923730237312373223733237342373523736237372373823739237402374123742237432374423745237462374723748237492375023751237522375323754237552375623757237582375923760237612376223763237642376523766237672376823769237702377123772237732377423775237762377723778237792378023781237822378323784237852378623787237882378923790237912379223793237942379523796237972379823799238002380123802238032380423805238062380723808238092381023811238122381323814238152381623817238182381923820238212382223823238242382523826238272382823829238302383123832238332383423835238362383723838238392384023841238422384323844238452384623847238482384923850238512385223853238542385523856238572385823859238602386123862238632386423865238662386723868238692387023871238722387323874238752387623877238782387923880238812388223883238842388523886238872388823889238902389123892238932389423895238962389723898238992390023901239022390323904239052390623907239082390923910239112391223913239142391523916239172391823919239202392123922239232392423925239262392723928239292393023931239322393323934239352393623937239382393923940239412394223943239442394523946239472394823949239502395123952239532395423955239562395723958239592396023961239622396323964239652396623967239682396923970239712397223973239742397523976239772397823979239802398123982239832398423985239862398723988239892399023991239922399323994239952399623997239982399924000240012400224003240042400524006240072400824009240102401124012240132401424015240162401724018240192402024021240222402324024240252402624027240282402924030240312403224033240342403524036240372403824039240402404124042240432404424045240462404724048240492405024051240522405324054240552405624057240582405924060240612406224063240642406524066240672406824069240702407124072240732407424075240762407724078240792408024081240822408324084240852408624087240882408924090240912409224093240942409524096240972409824099241002410124102241032410424105241062410724108241092411024111241122411324114241152411624117241182411924120241212412224123241242412524126241272412824129241302413124132241332413424135241362413724138241392414024141241422414324144241452414624147241482414924150241512415224153241542415524156241572415824159241602416124162241632416424165241662416724168241692417024171241722417324174241752417624177241782417924180241812418224183241842418524186241872418824189241902419124192241932419424195241962419724198241992420024201242022420324204242052420624207242082420924210242112421224213242142421524216242172421824219242202422124222242232422424225242262422724228242292423024231242322423324234242352423624237242382423924240242412424224243242442424524246242472424824249242502425124252242532425424255242562425724258242592426024261242622426324264242652426624267242682426924270242712427224273242742427524276242772427824279242802428124282242832428424285242862428724288242892429024291242922429324294242952429624297242982429924300243012430224303243042430524306243072430824309243102431124312243132431424315243162431724318243192432024321243222432324324243252432624327243282432924330243312433224333243342433524336243372433824339243402434124342243432434424345243462434724348243492435024351243522435324354243552435624357243582435924360243612436224363243642436524366243672436824369243702437124372243732437424375243762437724378243792438024381243822438324384243852438624387243882438924390243912439224393243942439524396243972439824399244002440124402244032440424405244062440724408244092441024411244122441324414244152441624417244182441924420244212442224423244242442524426244272442824429244302443124432244332443424435244362443724438244392444024441244422444324444244452444624447244482444924450244512445224453244542445524456244572445824459244602446124462244632446424465244662446724468244692447024471244722447324474244752447624477244782447924480244812448224483244842448524486244872448824489244902449124492244932449424495244962449724498244992450024501245022450324504245052450624507245082450924510245112451224513245142451524516245172451824519245202452124522245232452424525245262452724528245292453024531245322453324534245352453624537245382453924540245412454224543245442454524546245472454824549245502455124552245532455424555245562455724558245592456024561245622456324564245652456624567245682456924570245712457224573245742457524576245772457824579245802458124582245832458424585245862458724588245892459024591245922459324594245952459624597245982459924600246012460224603246042460524606246072460824609246102461124612246132461424615246162461724618246192462024621246222462324624246252462624627246282462924630246312463224633246342463524636246372463824639246402464124642246432464424645246462464724648246492465024651246522465324654246552465624657246582465924660246612466224663246642466524666246672466824669246702467124672246732467424675246762467724678246792468024681246822468324684246852468624687246882468924690246912469224693246942469524696246972469824699247002470124702247032470424705247062470724708247092471024711247122471324714247152471624717247182471924720247212472224723247242472524726247272472824729247302473124732247332473424735247362473724738247392474024741247422474324744247452474624747247482474924750247512475224753247542475524756247572475824759247602476124762247632476424765247662476724768247692477024771247722477324774247752477624777247782477924780247812478224783247842478524786247872478824789247902479124792247932479424795247962479724798247992480024801248022480324804248052480624807248082480924810248112481224813248142481524816248172481824819248202482124822248232482424825248262482724828248292483024831248322483324834248352483624837248382483924840248412484224843248442484524846248472484824849248502485124852248532485424855248562485724858248592486024861248622486324864248652486624867248682486924870248712487224873248742487524876248772487824879248802488124882248832488424885248862488724888248892489024891248922489324894248952489624897248982489924900249012490224903249042490524906249072490824909249102491124912249132491424915249162491724918249192492024921249222492324924249252492624927249282492924930249312493224933249342493524936249372493824939249402494124942249432494424945249462494724948249492495024951249522495324954249552495624957249582495924960249612496224963249642496524966249672496824969249702497124972249732497424975249762497724978249792498024981249822498324984249852498624987249882498924990249912499224993249942499524996249972499824999250002500125002250032500425005250062500725008250092501025011250122501325014250152501625017250182501925020250212502225023250242502525026250272502825029250302503125032250332503425035250362503725038250392504025041250422504325044250452504625047250482504925050250512505225053250542505525056250572505825059250602506125062250632506425065250662506725068250692507025071250722507325074250752507625077250782507925080250812508225083250842508525086250872508825089250902509125092250932509425095250962509725098250992510025101251022510325104251052510625107251082510925110251112511225113251142511525116251172511825119251202512125122251232512425125251262512725128251292513025131251322513325134251352513625137251382513925140251412514225143251442514525146251472514825149251502515125152251532515425155251562515725158251592516025161251622516325164251652516625167251682516925170251712517225173251742517525176251772517825179251802518125182251832518425185251862518725188251892519025191251922519325194251952519625197251982519925200252012520225203252042520525206252072520825209252102521125212252132521425215252162521725218252192522025221252222522325224252252522625227252282522925230252312523225233252342523525236252372523825239252402524125242252432524425245252462524725248252492525025251252522525325254252552525625257252582525925260252612526225263252642526525266252672526825269252702527125272252732527425275252762527725278252792528025281252822528325284252852528625287252882528925290252912529225293252942529525296252972529825299253002530125302253032530425305253062530725308253092531025311253122531325314253152531625317253182531925320253212532225323253242532525326253272532825329253302533125332253332533425335253362533725338253392534025341253422534325344253452534625347253482534925350253512535225353253542535525356253572535825359253602536125362253632536425365253662536725368253692537025371253722537325374253752537625377253782537925380253812538225383253842538525386253872538825389253902539125392253932539425395253962539725398253992540025401254022540325404254052540625407254082540925410254112541225413254142541525416254172541825419254202542125422254232542425425254262542725428254292543025431254322543325434254352543625437254382543925440254412544225443254442544525446254472544825449254502545125452254532545425455254562545725458254592546025461254622546325464254652546625467254682546925470254712547225473254742547525476254772547825479254802548125482254832548425485254862548725488254892549025491254922549325494254952549625497254982549925500255012550225503255042550525506255072550825509255102551125512255132551425515255162551725518255192552025521255222552325524255252552625527255282552925530255312553225533255342553525536255372553825539255402554125542255432554425545255462554725548255492555025551255522555325554255552555625557255582555925560255612556225563255642556525566255672556825569255702557125572255732557425575255762557725578255792558025581255822558325584255852558625587255882558925590255912559225593255942559525596255972559825599256002560125602256032560425605256062560725608256092561025611256122561325614256152561625617256182561925620256212562225623256242562525626256272562825629256302563125632256332563425635256362563725638256392564025641256422564325644256452564625647256482564925650256512565225653256542565525656256572565825659256602566125662256632566425665256662566725668256692567025671256722567325674256752567625677256782567925680256812568225683256842568525686256872568825689256902569125692256932569425695256962569725698256992570025701257022570325704257052570625707257082570925710257112571225713257142571525716257172571825719257202572125722257232572425725257262572725728257292573025731257322573325734257352573625737257382573925740257412574225743257442574525746257472574825749257502575125752257532575425755257562575725758257592576025761257622576325764257652576625767257682576925770257712577225773257742577525776257772577825779257802578125782257832578425785257862578725788257892579025791257922579325794257952579625797257982579925800258012580225803258042580525806258072580825809258102581125812258132581425815258162581725818258192582025821258222582325824258252582625827258282582925830258312583225833258342583525836258372583825839258402584125842258432584425845258462584725848258492585025851258522585325854258552585625857258582585925860258612586225863258642586525866258672586825869258702587125872258732587425875258762587725878258792588025881258822588325884258852588625887258882588925890258912589225893258942589525896258972589825899259002590125902259032590425905259062590725908259092591025911259122591325914259152591625917259182591925920259212592225923259242592525926259272592825929259302593125932259332593425935259362593725938259392594025941259422594325944259452594625947259482594925950259512595225953259542595525956259572595825959259602596125962259632596425965259662596725968259692597025971259722597325974259752597625977259782597925980259812598225983259842598525986259872598825989259902599125992259932599425995259962599725998259992600026001260022600326004260052600626007260082600926010260112601226013260142601526016260172601826019260202602126022260232602426025260262602726028260292603026031260322603326034260352603626037260382603926040260412604226043260442604526046260472604826049260502605126052260532605426055260562605726058260592606026061260622606326064260652606626067260682606926070260712607226073260742607526076260772607826079260802608126082260832608426085260862608726088260892609026091260922609326094260952609626097260982609926100261012610226103261042610526106261072610826109261102611126112261132611426115261162611726118261192612026121261222612326124261252612626127261282612926130261312613226133261342613526136261372613826139261402614126142261432614426145261462614726148261492615026151261522615326154261552615626157261582615926160261612616226163261642616526166261672616826169261702617126172261732617426175261762617726178261792618026181261822618326184261852618626187261882618926190261912619226193261942619526196261972619826199262002620126202262032620426205262062620726208262092621026211262122621326214262152621626217262182621926220262212622226223262242622526226262272622826229262302623126232262332623426235262362623726238262392624026241262422624326244262452624626247262482624926250262512625226253262542625526256262572625826259262602626126262262632626426265262662626726268262692627026271262722627326274262752627626277262782627926280262812628226283262842628526286262872628826289262902629126292262932629426295262962629726298262992630026301263022630326304263052630626307263082630926310263112631226313263142631526316263172631826319263202632126322263232632426325263262632726328263292633026331263322633326334263352633626337263382633926340263412634226343263442634526346263472634826349263502635126352263532635426355263562635726358263592636026361263622636326364263652636626367263682636926370263712637226373263742637526376263772637826379263802638126382263832638426385263862638726388263892639026391263922639326394263952639626397263982639926400264012640226403264042640526406264072640826409264102641126412264132641426415264162641726418264192642026421264222642326424264252642626427264282642926430264312643226433264342643526436264372643826439264402644126442264432644426445264462644726448264492645026451264522645326454264552645626457264582645926460264612646226463264642646526466264672646826469264702647126472264732647426475264762647726478264792648026481264822648326484264852648626487264882648926490264912649226493264942649526496264972649826499265002650126502265032650426505265062650726508265092651026511265122651326514265152651626517265182651926520265212652226523265242652526526265272652826529265302653126532265332653426535265362653726538265392654026541265422654326544265452654626547265482654926550265512655226553265542655526556265572655826559265602656126562265632656426565265662656726568265692657026571265722657326574265752657626577265782657926580265812658226583265842658526586265872658826589265902659126592265932659426595265962659726598265992660026601266022660326604266052660626607266082660926610266112661226613266142661526616266172661826619266202662126622266232662426625266262662726628266292663026631266322663326634266352663626637266382663926640266412664226643266442664526646266472664826649266502665126652266532665426655266562665726658266592666026661266622666326664266652666626667266682666926670266712667226673266742667526676266772667826679266802668126682266832668426685266862668726688266892669026691266922669326694266952669626697266982669926700267012670226703267042670526706267072670826709267102671126712267132671426715267162671726718267192672026721267222672326724267252672626727267282672926730267312673226733267342673526736267372673826739267402674126742267432674426745267462674726748267492675026751267522675326754267552675626757267582675926760267612676226763267642676526766267672676826769267702677126772267732677426775267762677726778267792678026781267822678326784267852678626787267882678926790267912679226793267942679526796267972679826799268002680126802268032680426805268062680726808268092681026811268122681326814268152681626817268182681926820268212682226823268242682526826268272682826829268302683126832268332683426835268362683726838268392684026841268422684326844268452684626847268482684926850268512685226853268542685526856268572685826859268602686126862268632686426865268662686726868268692687026871268722687326874268752687626877268782687926880268812688226883268842688526886268872688826889268902689126892268932689426895268962689726898268992690026901269022690326904269052690626907269082690926910269112691226913269142691526916269172691826919269202692126922269232692426925269262692726928269292693026931269322693326934269352693626937269382693926940269412694226943269442694526946269472694826949269502695126952269532695426955269562695726958269592696026961269622696326964269652696626967269682696926970269712697226973269742697526976269772697826979269802698126982269832698426985269862698726988269892699026991269922699326994269952699626997269982699927000270012700227003270042700527006270072700827009270102701127012270132701427015270162701727018270192702027021270222702327024270252702627027270282702927030270312703227033270342703527036270372703827039270402704127042270432704427045270462704727048270492705027051270522705327054270552705627057270582705927060270612706227063270642706527066270672706827069270702707127072270732707427075270762707727078270792708027081270822708327084270852708627087270882708927090270912709227093270942709527096270972709827099271002710127102271032710427105271062710727108271092711027111271122711327114271152711627117271182711927120271212712227123271242712527126271272712827129271302713127132271332713427135271362713727138271392714027141271422714327144271452714627147271482714927150271512715227153271542715527156271572715827159271602716127162271632716427165271662716727168271692717027171271722717327174271752717627177271782717927180271812718227183271842718527186271872718827189271902719127192271932719427195271962719727198271992720027201272022720327204272052720627207272082720927210272112721227213272142721527216272172721827219272202722127222272232722427225272262722727228272292723027231272322723327234272352723627237272382723927240272412724227243272442724527246272472724827249272502725127252272532725427255272562725727258272592726027261272622726327264272652726627267272682726927270272712727227273272742727527276272772727827279272802728127282272832728427285272862728727288272892729027291272922729327294272952729627297272982729927300273012730227303273042730527306273072730827309273102731127312273132731427315273162731727318273192732027321273222732327324273252732627327273282732927330273312733227333273342733527336273372733827339273402734127342273432734427345273462734727348273492735027351273522735327354273552735627357273582735927360273612736227363273642736527366273672736827369273702737127372273732737427375273762737727378273792738027381273822738327384273852738627387273882738927390273912739227393273942739527396273972739827399274002740127402274032740427405274062740727408274092741027411274122741327414274152741627417274182741927420274212742227423274242742527426274272742827429274302743127432274332743427435274362743727438274392744027441274422744327444274452744627447274482744927450274512745227453274542745527456274572745827459274602746127462274632746427465274662746727468274692747027471274722747327474274752747627477274782747927480274812748227483274842748527486274872748827489274902749127492274932749427495274962749727498274992750027501275022750327504275052750627507275082750927510275112751227513275142751527516275172751827519275202752127522275232752427525275262752727528275292753027531275322753327534275352753627537275382753927540275412754227543275442754527546275472754827549275502755127552275532755427555275562755727558275592756027561275622756327564275652756627567275682756927570275712757227573275742757527576275772757827579275802758127582275832758427585275862758727588275892759027591275922759327594275952759627597275982759927600276012760227603276042760527606276072760827609276102761127612276132761427615276162761727618276192762027621276222762327624276252762627627276282762927630276312763227633276342763527636276372763827639276402764127642276432764427645276462764727648276492765027651276522765327654276552765627657276582765927660276612766227663276642766527666276672766827669276702767127672276732767427675276762767727678276792768027681276822768327684276852768627687276882768927690276912769227693276942769527696276972769827699277002770127702277032770427705277062770727708277092771027711277122771327714277152771627717277182771927720277212772227723277242772527726277272772827729277302773127732277332773427735277362773727738277392774027741277422774327744277452774627747277482774927750277512775227753277542775527756277572775827759277602776127762277632776427765277662776727768277692777027771277722777327774277752777627777277782777927780277812778227783277842778527786277872778827789277902779127792277932779427795277962779727798277992780027801278022780327804278052780627807278082780927810278112781227813278142781527816278172781827819278202782127822278232782427825278262782727828278292783027831278322783327834278352783627837278382783927840278412784227843278442784527846278472784827849278502785127852278532785427855278562785727858278592786027861278622786327864278652786627867278682786927870278712787227873278742787527876278772787827879278802788127882278832788427885278862788727888278892789027891278922789327894278952789627897278982789927900279012790227903279042790527906279072790827909279102791127912279132791427915279162791727918279192792027921279222792327924279252792627927279282792927930279312793227933279342793527936279372793827939279402794127942279432794427945279462794727948279492795027951279522795327954279552795627957279582795927960279612796227963279642796527966279672796827969279702797127972279732797427975279762797727978279792798027981279822798327984279852798627987279882798927990279912799227993279942799527996279972799827999280002800128002280032800428005280062800728008280092801028011280122801328014280152801628017280182801928020280212802228023280242802528026280272802828029280302803128032280332803428035280362803728038280392804028041280422804328044280452804628047280482804928050280512805228053280542805528056280572805828059280602806128062280632806428065280662806728068280692807028071280722807328074280752807628077280782807928080280812808228083280842808528086280872808828089280902809128092280932809428095280962809728098280992810028101281022810328104281052810628107281082810928110281112811228113281142811528116281172811828119281202812128122281232812428125281262812728128281292813028131281322813328134281352813628137281382813928140281412814228143281442814528146281472814828149281502815128152281532815428155281562815728158281592816028161281622816328164281652816628167281682816928170281712817228173281742817528176281772817828179281802818128182281832818428185281862818728188281892819028191281922819328194281952819628197281982819928200282012820228203282042820528206282072820828209282102821128212282132821428215282162821728218282192822028221282222822328224282252822628227282282822928230282312823228233282342823528236282372823828239282402824128242282432824428245282462824728248282492825028251282522825328254282552825628257282582825928260282612826228263282642826528266282672826828269282702827128272282732827428275282762827728278282792828028281282822828328284282852828628287282882828928290282912829228293282942829528296282972829828299283002830128302283032830428305283062830728308283092831028311283122831328314283152831628317283182831928320283212832228323283242832528326283272832828329283302833128332283332833428335283362833728338283392834028341283422834328344283452834628347283482834928350283512835228353283542835528356283572835828359283602836128362283632836428365283662836728368283692837028371283722837328374283752837628377283782837928380283812838228383283842838528386283872838828389283902839128392283932839428395283962839728398283992840028401284022840328404284052840628407284082840928410284112841228413284142841528416284172841828419284202842128422284232842428425284262842728428284292843028431284322843328434284352843628437284382843928440284412844228443284442844528446284472844828449284502845128452284532845428455284562845728458284592846028461284622846328464284652846628467284682846928470284712847228473284742847528476284772847828479284802848128482284832848428485284862848728488284892849028491284922849328494284952849628497284982849928500285012850228503285042850528506285072850828509285102851128512285132851428515285162851728518285192852028521285222852328524285252852628527285282852928530285312853228533285342853528536285372853828539285402854128542285432854428545285462854728548285492855028551285522855328554285552855628557285582855928560285612856228563285642856528566285672856828569285702857128572285732857428575285762857728578285792858028581285822858328584285852858628587285882858928590285912859228593285942859528596285972859828599286002860128602286032860428605286062860728608286092861028611286122861328614286152861628617286182861928620286212862228623286242862528626286272862828629286302863128632286332863428635286362863728638286392864028641286422864328644286452864628647286482864928650286512865228653286542865528656286572865828659286602866128662286632866428665286662866728668286692867028671286722867328674286752867628677286782867928680286812868228683286842868528686286872868828689286902869128692286932869428695286962869728698286992870028701287022870328704287052870628707287082870928710287112871228713287142871528716287172871828719287202872128722287232872428725287262872728728287292873028731287322873328734287352873628737287382873928740287412874228743287442874528746287472874828749287502875128752287532875428755287562875728758287592876028761287622876328764287652876628767287682876928770287712877228773287742877528776287772877828779287802878128782287832878428785287862878728788287892879028791287922879328794287952879628797287982879928800288012880228803288042880528806288072880828809288102881128812288132881428815288162881728818288192882028821288222882328824288252882628827288282882928830288312883228833288342883528836288372883828839288402884128842288432884428845288462884728848288492885028851288522885328854288552885628857288582885928860288612886228863288642886528866288672886828869288702887128872288732887428875288762887728878288792888028881288822888328884288852888628887288882888928890288912889228893288942889528896288972889828899289002890128902289032890428905289062890728908289092891028911289122891328914289152891628917289182891928920289212892228923289242892528926289272892828929289302893128932289332893428935289362893728938289392894028941289422894328944289452894628947289482894928950289512895228953289542895528956289572895828959289602896128962289632896428965289662896728968289692897028971289722897328974289752897628977289782897928980289812898228983289842898528986289872898828989289902899128992289932899428995289962899728998289992900029001290022900329004290052900629007290082900929010290112901229013290142901529016290172901829019290202902129022290232902429025290262902729028290292903029031290322903329034290352903629037290382903929040290412904229043290442904529046290472904829049290502905129052290532905429055290562905729058290592906029061290622906329064290652906629067290682906929070290712907229073290742907529076290772907829079290802908129082290832908429085290862908729088290892909029091290922909329094290952909629097290982909929100291012910229103291042910529106291072910829109291102911129112291132911429115291162911729118291192912029121291222912329124291252912629127291282912929130291312913229133291342913529136291372913829139291402914129142291432914429145291462914729148291492915029151291522915329154291552915629157291582915929160291612916229163291642916529166291672916829169291702917129172291732917429175291762917729178291792918029181291822918329184291852918629187291882918929190291912919229193291942919529196291972919829199292002920129202292032920429205292062920729208292092921029211292122921329214292152921629217292182921929220292212922229223292242922529226292272922829229292302923129232292332923429235292362923729238292392924029241292422924329244292452924629247292482924929250292512925229253292542925529256292572925829259292602926129262292632926429265292662926729268292692927029271292722927329274292752927629277292782927929280292812928229283292842928529286292872928829289292902929129292292932929429295292962929729298292992930029301293022930329304293052930629307293082930929310293112931229313293142931529316293172931829319293202932129322293232932429325293262932729328293292933029331293322933329334293352933629337293382933929340293412934229343293442934529346293472934829349293502935129352293532935429355293562935729358293592936029361293622936329364293652936629367293682936929370293712937229373293742937529376293772937829379293802938129382293832938429385293862938729388293892939029391293922939329394293952939629397293982939929400294012940229403294042940529406294072940829409294102941129412294132941429415294162941729418294192942029421294222942329424294252942629427294282942929430294312943229433294342943529436294372943829439294402944129442294432944429445294462944729448294492945029451294522945329454294552945629457294582945929460294612946229463294642946529466294672946829469294702947129472294732947429475294762947729478294792948029481294822948329484294852948629487294882948929490294912949229493294942949529496294972949829499295002950129502295032950429505295062950729508295092951029511295122951329514295152951629517295182951929520295212952229523295242952529526295272952829529295302953129532295332953429535295362953729538295392954029541295422954329544295452954629547295482954929550295512955229553295542955529556295572955829559295602956129562295632956429565295662956729568295692957029571295722957329574295752957629577295782957929580295812958229583295842958529586295872958829589295902959129592295932959429595295962959729598295992960029601296022960329604296052960629607296082960929610296112961229613296142961529616296172961829619296202962129622296232962429625296262962729628296292963029631296322963329634296352963629637296382963929640296412964229643296442964529646296472964829649296502965129652296532965429655296562965729658296592966029661296622966329664296652966629667296682966929670296712967229673296742967529676296772967829679296802968129682296832968429685296862968729688296892969029691296922969329694296952969629697296982969929700297012970229703297042970529706297072970829709297102971129712297132971429715297162971729718297192972029721297222972329724297252972629727297282972929730297312973229733297342973529736297372973829739297402974129742297432974429745297462974729748297492975029751297522975329754297552975629757297582975929760297612976229763297642976529766297672976829769297702977129772297732977429775297762977729778297792978029781297822978329784297852978629787297882978929790297912979229793297942979529796297972979829799298002980129802298032980429805298062980729808298092981029811298122981329814298152981629817298182981929820298212982229823298242982529826298272982829829298302983129832298332983429835298362983729838298392984029841298422984329844298452984629847298482984929850298512985229853298542985529856298572985829859298602986129862298632986429865298662986729868298692987029871298722987329874298752987629877298782987929880298812988229883298842988529886298872988829889298902989129892298932989429895298962989729898298992990029901299022990329904299052990629907299082990929910299112991229913299142991529916299172991829919299202992129922299232992429925299262992729928299292993029931299322993329934299352993629937299382993929940299412994229943299442994529946299472994829949299502995129952299532995429955299562995729958299592996029961299622996329964299652996629967299682996929970299712997229973299742997529976299772997829979299802998129982299832998429985299862998729988299892999029991299922999329994299952999629997299982999930000300013000230003300043000530006300073000830009300103001130012300133001430015300163001730018300193002030021300223002330024300253002630027300283002930030300313003230033300343003530036300373003830039300403004130042300433004430045300463004730048300493005030051300523005330054300553005630057300583005930060300613006230063300643006530066300673006830069300703007130072300733007430075300763007730078300793008030081300823008330084300853008630087300883008930090300913009230093300943009530096300973009830099301003010130102301033010430105301063010730108301093011030111301123011330114301153011630117301183011930120301213012230123301243012530126301273012830129301303013130132301333013430135301363013730138301393014030141301423014330144301453014630147301483014930150301513015230153301543015530156301573015830159301603016130162301633016430165301663016730168301693017030171301723017330174301753017630177301783017930180301813018230183301843018530186301873018830189301903019130192301933019430195301963019730198301993020030201302023020330204302053020630207302083020930210302113021230213302143021530216302173021830219302203022130222302233022430225302263022730228302293023030231302323023330234302353023630237302383023930240302413024230243302443024530246302473024830249302503025130252302533025430255302563025730258302593026030261302623026330264302653026630267302683026930270302713027230273302743027530276302773027830279302803028130282302833028430285302863028730288302893029030291302923029330294302953029630297302983029930300303013030230303303043030530306303073030830309303103031130312303133031430315303163031730318303193032030321303223032330324303253032630327303283032930330303313033230333303343033530336303373033830339303403034130342303433034430345303463034730348303493035030351303523035330354303553035630357303583035930360303613036230363303643036530366303673036830369303703037130372303733037430375303763037730378303793038030381303823038330384303853038630387303883038930390303913039230393303943039530396303973039830399304003040130402304033040430405304063040730408304093041030411304123041330414304153041630417304183041930420304213042230423304243042530426304273042830429304303043130432304333043430435304363043730438304393044030441304423044330444304453044630447304483044930450304513045230453304543045530456304573045830459304603046130462304633046430465304663046730468304693047030471304723047330474304753047630477304783047930480304813048230483304843048530486304873048830489304903049130492304933049430495304963049730498304993050030501305023050330504305053050630507305083050930510305113051230513305143051530516305173051830519305203052130522305233052430525305263052730528305293053030531305323053330534305353053630537305383053930540305413054230543305443054530546305473054830549305503055130552305533055430555305563055730558305593056030561305623056330564305653056630567305683056930570305713057230573305743057530576305773057830579305803058130582305833058430585305863058730588305893059030591305923059330594305953059630597305983059930600306013060230603306043060530606306073060830609306103061130612306133061430615306163061730618306193062030621306223062330624306253062630627306283062930630306313063230633306343063530636306373063830639306403064130642306433064430645306463064730648306493065030651306523065330654306553065630657306583065930660306613066230663306643066530666306673066830669306703067130672306733067430675306763067730678306793068030681306823068330684306853068630687306883068930690306913069230693306943069530696306973069830699307003070130702307033070430705307063070730708307093071030711307123071330714307153071630717307183071930720307213072230723307243072530726307273072830729307303073130732307333073430735307363073730738307393074030741307423074330744307453074630747307483074930750307513075230753307543075530756307573075830759307603076130762307633076430765307663076730768307693077030771307723077330774307753077630777307783077930780307813078230783307843078530786307873078830789307903079130792307933079430795307963079730798307993080030801308023080330804308053080630807308083080930810308113081230813308143081530816308173081830819308203082130822308233082430825308263082730828308293083030831308323083330834308353083630837308383083930840308413084230843308443084530846308473084830849308503085130852308533085430855308563085730858308593086030861308623086330864308653086630867308683086930870308713087230873308743087530876308773087830879308803088130882308833088430885308863088730888308893089030891308923089330894308953089630897308983089930900309013090230903309043090530906309073090830909309103091130912309133091430915309163091730918309193092030921309223092330924309253092630927309283092930930309313093230933309343093530936309373093830939309403094130942309433094430945309463094730948309493095030951309523095330954309553095630957309583095930960309613096230963309643096530966309673096830969309703097130972309733097430975309763097730978309793098030981309823098330984309853098630987309883098930990309913099230993309943099530996309973099830999310003100131002310033100431005310063100731008310093101031011310123101331014310153101631017310183101931020310213102231023310243102531026310273102831029310303103131032310333103431035310363103731038310393104031041310423104331044310453104631047310483104931050310513105231053310543105531056310573105831059310603106131062310633106431065310663106731068310693107031071310723107331074310753107631077310783107931080310813108231083310843108531086310873108831089310903109131092310933109431095310963109731098310993110031101311023110331104311053110631107311083110931110311113111231113311143111531116311173111831119311203112131122311233112431125311263112731128311293113031131311323113331134311353113631137311383113931140311413114231143311443114531146311473114831149311503115131152311533115431155311563115731158311593116031161311623116331164311653116631167311683116931170311713117231173311743117531176311773117831179311803118131182311833118431185311863118731188311893119031191311923119331194311953119631197311983119931200312013120231203312043120531206312073120831209312103121131212312133121431215312163121731218312193122031221312223122331224312253122631227312283122931230312313123231233312343123531236312373123831239312403124131242312433124431245312463124731248312493125031251312523125331254312553125631257312583125931260312613126231263312643126531266312673126831269312703127131272312733127431275312763127731278312793128031281312823128331284312853128631287312883128931290312913129231293312943129531296312973129831299313003130131302313033130431305313063130731308313093131031311313123131331314313153131631317313183131931320313213132231323313243132531326313273132831329313303133131332313333133431335313363133731338313393134031341313423134331344313453134631347313483134931350313513135231353313543135531356313573135831359313603136131362313633136431365313663136731368313693137031371313723137331374313753137631377313783137931380313813138231383313843138531386313873138831389313903139131392313933139431395313963139731398313993140031401314023140331404314053140631407314083140931410314113141231413314143141531416314173141831419314203142131422314233142431425314263142731428314293143031431314323143331434314353143631437314383143931440314413144231443314443144531446314473144831449314503145131452314533145431455314563145731458314593146031461314623146331464314653146631467314683146931470314713147231473314743147531476314773147831479314803148131482314833148431485314863148731488314893149031491314923149331494314953149631497314983149931500315013150231503315043150531506315073150831509315103151131512315133151431515315163151731518315193152031521315223152331524315253152631527315283152931530315313153231533315343153531536315373153831539315403154131542315433154431545315463154731548315493155031551315523155331554315553155631557315583155931560315613156231563315643156531566315673156831569315703157131572315733157431575315763157731578315793158031581315823158331584315853158631587315883158931590315913159231593315943159531596315973159831599316003160131602316033160431605316063160731608316093161031611316123161331614316153161631617316183161931620316213162231623316243162531626316273162831629316303163131632316333163431635316363163731638316393164031641316423164331644316453164631647316483164931650316513165231653316543165531656316573165831659316603166131662316633166431665316663166731668316693167031671316723167331674316753167631677316783167931680316813168231683316843168531686316873168831689316903169131692316933169431695316963169731698316993170031701317023170331704317053170631707317083170931710317113171231713317143171531716317173171831719317203172131722317233172431725317263172731728317293173031731317323173331734317353173631737317383173931740317413174231743317443174531746317473174831749317503175131752317533175431755317563175731758317593176031761317623176331764317653176631767317683176931770317713177231773317743177531776317773177831779317803178131782317833178431785317863178731788317893179031791317923179331794317953179631797317983179931800318013180231803318043180531806318073180831809318103181131812318133181431815318163181731818318193182031821318223182331824318253182631827318283182931830318313183231833318343183531836318373183831839318403184131842318433184431845318463184731848318493185031851318523185331854318553185631857318583185931860318613186231863318643186531866318673186831869318703187131872318733187431875318763187731878318793188031881318823188331884318853188631887318883188931890318913189231893318943189531896318973189831899319003190131902319033190431905319063190731908319093191031911319123191331914319153191631917319183191931920319213192231923319243192531926319273192831929319303193131932319333193431935319363193731938319393194031941319423194331944319453194631947319483194931950319513195231953319543195531956319573195831959319603196131962319633196431965319663196731968319693197031971319723197331974319753197631977319783197931980319813198231983319843198531986319873198831989319903199131992319933199431995319963199731998319993200032001320023200332004320053200632007320083200932010320113201232013320143201532016320173201832019320203202132022320233202432025320263202732028320293203032031320323203332034320353203632037320383203932040320413204232043320443204532046320473204832049320503205132052320533205432055320563205732058320593206032061320623206332064320653206632067320683206932070320713207232073320743207532076320773207832079320803208132082320833208432085320863208732088320893209032091320923209332094320953209632097320983209932100321013210232103321043210532106321073210832109321103211132112321133211432115321163211732118321193212032121321223212332124321253212632127321283212932130321313213232133321343213532136321373213832139321403214132142321433214432145321463214732148321493215032151321523215332154321553215632157321583215932160321613216232163321643216532166321673216832169321703217132172321733217432175321763217732178321793218032181321823218332184321853218632187321883218932190321913219232193321943219532196321973219832199322003220132202322033220432205322063220732208322093221032211322123221332214322153221632217322183221932220322213222232223322243222532226322273222832229322303223132232322333223432235322363223732238322393224032241322423224332244322453224632247322483224932250322513225232253322543225532256322573225832259322603226132262322633226432265322663226732268322693227032271322723227332274322753227632277322783227932280322813228232283322843228532286322873228832289322903229132292322933229432295322963229732298322993230032301323023230332304323053230632307323083230932310323113231232313323143231532316323173231832319323203232132322323233232432325323263232732328323293233032331323323233332334323353233632337323383233932340323413234232343323443234532346323473234832349323503235132352323533235432355323563235732358323593236032361323623236332364323653236632367323683236932370323713237232373323743237532376323773237832379323803238132382323833238432385323863238732388323893239032391323923239332394323953239632397323983239932400324013240232403324043240532406324073240832409324103241132412324133241432415324163241732418324193242032421324223242332424324253242632427324283242932430324313243232433324343243532436324373243832439324403244132442324433244432445324463244732448324493245032451324523245332454324553245632457324583245932460324613246232463324643246532466324673246832469324703247132472324733247432475324763247732478324793248032481324823248332484324853248632487324883248932490324913249232493324943249532496324973249832499325003250132502325033250432505325063250732508325093251032511325123251332514325153251632517325183251932520325213252232523325243252532526325273252832529325303253132532325333253432535325363253732538325393254032541325423254332544325453254632547325483254932550325513255232553325543255532556325573255832559325603256132562325633256432565325663256732568325693257032571325723257332574325753257632577325783257932580325813258232583325843258532586325873258832589325903259132592325933259432595325963259732598325993260032601326023260332604326053260632607326083260932610326113261232613326143261532616326173261832619326203262132622326233262432625326263262732628326293263032631326323263332634326353263632637326383263932640326413264232643326443264532646326473264832649326503265132652326533265432655326563265732658326593266032661326623266332664326653266632667326683266932670326713267232673326743267532676326773267832679326803268132682326833268432685326863268732688326893269032691326923269332694326953269632697326983269932700327013270232703327043270532706327073270832709327103271132712327133271432715327163271732718327193272032721327223272332724327253272632727327283272932730327313273232733327343273532736327373273832739327403274132742327433274432745327463274732748327493275032751327523275332754327553275632757327583275932760327613276232763327643276532766327673276832769327703277132772327733277432775327763277732778327793278032781327823278332784327853278632787327883278932790327913279232793327943279532796327973279832799328003280132802328033280432805328063280732808328093281032811328123281332814328153281632817328183281932820328213282232823328243282532826328273282832829328303283132832328333283432835328363283732838328393284032841328423284332844328453284632847328483284932850328513285232853328543285532856328573285832859328603286132862328633286432865328663286732868328693287032871328723287332874328753287632877328783287932880328813288232883328843288532886328873288832889328903289132892328933289432895328963289732898328993290032901329023290332904329053290632907329083290932910329113291232913329143291532916329173291832919329203292132922329233292432925329263292732928329293293032931329323293332934329353293632937329383293932940329413294232943329443294532946329473294832949329503295132952329533295432955329563295732958329593296032961329623296332964329653296632967329683296932970329713297232973329743297532976329773297832979329803298132982329833298432985329863298732988329893299032991329923299332994329953299632997329983299933000330013300233003330043300533006330073300833009330103301133012330133301433015330163301733018330193302033021330223302333024330253302633027330283302933030330313303233033330343303533036330373303833039330403304133042330433304433045330463304733048330493305033051330523305333054330553305633057330583305933060330613306233063330643306533066330673306833069330703307133072330733307433075330763307733078330793308033081330823308333084330853308633087330883308933090330913309233093330943309533096330973309833099331003310133102331033310433105331063310733108331093311033111331123311333114331153311633117331183311933120331213312233123331243312533126331273312833129331303313133132331333313433135331363313733138331393314033141331423314333144331453314633147331483314933150331513315233153331543315533156331573315833159331603316133162331633316433165331663316733168331693317033171331723317333174331753317633177331783317933180331813318233183331843318533186331873318833189331903319133192331933319433195331963319733198331993320033201332023320333204332053320633207332083320933210332113321233213332143321533216332173321833219332203322133222332233322433225332263322733228332293323033231332323323333234332353323633237332383323933240332413324233243332443324533246332473324833249332503325133252332533325433255332563325733258332593326033261332623326333264332653326633267332683326933270332713327233273332743327533276332773327833279332803328133282332833328433285332863328733288332893329033291332923329333294332953329633297332983329933300333013330233303333043330533306333073330833309333103331133312333133331433315333163331733318333193332033321333223332333324333253332633327333283332933330333313333233333333343333533336333373333833339333403334133342333433334433345333463334733348333493335033351333523335333354333553335633357333583335933360333613336233363333643336533366333673336833369333703337133372333733337433375333763337733378333793338033381333823338333384333853338633387333883338933390333913339233393333943339533396333973339833399334003340133402334033340433405334063340733408334093341033411334123341333414334153341633417334183341933420334213342233423334243342533426334273342833429334303343133432334333343433435334363343733438334393344033441334423344333444334453344633447334483344933450334513345233453334543345533456334573345833459334603346133462334633346433465334663346733468334693347033471334723347333474334753347633477334783347933480334813348233483334843348533486334873348833489334903349133492334933349433495334963349733498334993350033501335023350333504335053350633507335083350933510335113351233513335143351533516335173351833519335203352133522335233352433525335263352733528335293353033531335323353333534335353353633537335383353933540335413354233543335443354533546335473354833549335503355133552335533355433555335563355733558335593356033561335623356333564335653356633567335683356933570335713357233573335743357533576335773357833579335803358133582335833358433585335863358733588335893359033591335923359333594335953359633597335983359933600336013360233603336043360533606336073360833609336103361133612336133361433615336163361733618336193362033621336223362333624336253362633627336283362933630336313363233633336343363533636336373363833639336403364133642336433364433645336463364733648336493365033651336523365333654336553365633657336583365933660336613366233663336643366533666336673366833669336703367133672336733367433675336763367733678336793368033681336823368333684336853368633687336883368933690336913369233693336943369533696336973369833699337003370133702337033370433705337063370733708337093371033711337123371333714337153371633717337183371933720337213372233723337243372533726337273372833729337303373133732337333373433735337363373733738337393374033741337423374333744337453374633747337483374933750337513375233753337543375533756337573375833759337603376133762337633376433765337663376733768337693377033771337723377333774337753377633777337783377933780337813378233783337843378533786337873378833789337903379133792337933379433795337963379733798337993380033801338023380333804338053380633807338083380933810338113381233813338143381533816338173381833819338203382133822338233382433825338263382733828338293383033831338323383333834338353383633837338383383933840338413384233843338443384533846338473384833849338503385133852338533385433855338563385733858338593386033861338623386333864338653386633867338683386933870338713387233873338743387533876338773387833879338803388133882338833388433885338863388733888338893389033891338923389333894338953389633897338983389933900339013390233903339043390533906339073390833909339103391133912339133391433915339163391733918339193392033921339223392333924339253392633927339283392933930339313393233933339343393533936339373393833939339403394133942339433394433945339463394733948339493395033951339523395333954339553395633957339583395933960339613396233963339643396533966339673396833969339703397133972339733397433975339763397733978339793398033981339823398333984339853398633987339883398933990339913399233993339943399533996339973399833999340003400134002340033400434005340063400734008340093401034011340123401334014340153401634017340183401934020340213402234023340243402534026340273402834029340303403134032340333403434035340363403734038340393404034041340423404334044340453404634047340483404934050340513405234053340543405534056340573405834059340603406134062340633406434065340663406734068340693407034071340723407334074340753407634077340783407934080340813408234083340843408534086340873408834089340903409134092340933409434095340963409734098340993410034101341023410334104341053410634107341083410934110341113411234113341143411534116341173411834119341203412134122341233412434125341263412734128341293413034131341323413334134341353413634137341383413934140341413414234143341443414534146341473414834149341503415134152341533415434155341563415734158341593416034161341623416334164341653416634167341683416934170341713417234173341743417534176341773417834179341803418134182341833418434185341863418734188341893419034191341923419334194341953419634197341983419934200342013420234203342043420534206342073420834209342103421134212342133421434215342163421734218342193422034221342223422334224342253422634227342283422934230342313423234233342343423534236342373423834239342403424134242342433424434245342463424734248342493425034251342523425334254342553425634257342583425934260342613426234263342643426534266342673426834269342703427134272342733427434275342763427734278342793428034281342823428334284342853428634287342883428934290342913429234293342943429534296342973429834299343003430134302343033430434305343063430734308343093431034311343123431334314343153431634317343183431934320343213432234323343243432534326343273432834329343303433134332343333433434335343363433734338343393434034341343423434334344343453434634347343483434934350343513435234353343543435534356343573435834359343603436134362343633436434365343663436734368343693437034371343723437334374343753437634377343783437934380343813438234383343843438534386343873438834389343903439134392343933439434395343963439734398343993440034401344023440334404344053440634407344083440934410344113441234413344143441534416344173441834419344203442134422344233442434425344263442734428344293443034431344323443334434344353443634437344383443934440344413444234443344443444534446344473444834449344503445134452344533445434455344563445734458344593446034461344623446334464344653446634467344683446934470344713447234473344743447534476344773447834479344803448134482344833448434485344863448734488344893449034491344923449334494344953449634497344983449934500345013450234503345043450534506345073450834509345103451134512345133451434515345163451734518345193452034521345223452334524345253452634527345283452934530345313453234533345343453534536345373453834539345403454134542345433454434545345463454734548345493455034551345523455334554345553455634557345583455934560345613456234563345643456534566345673456834569345703457134572345733457434575345763457734578345793458034581345823458334584345853458634587345883458934590345913459234593345943459534596345973459834599346003460134602346033460434605346063460734608346093461034611346123461334614346153461634617346183461934620346213462234623346243462534626346273462834629346303463134632346333463434635346363463734638346393464034641346423464334644346453464634647346483464934650346513465234653346543465534656346573465834659346603466134662346633466434665346663466734668346693467034671346723467334674346753467634677346783467934680346813468234683346843468534686346873468834689346903469134692346933469434695346963469734698346993470034701347023470334704347053470634707347083470934710347113471234713347143471534716347173471834719347203472134722347233472434725347263472734728347293473034731347323473334734347353473634737347383473934740347413474234743347443474534746347473474834749347503475134752347533475434755347563475734758347593476034761347623476334764347653476634767347683476934770347713477234773347743477534776347773477834779347803478134782347833478434785347863478734788347893479034791347923479334794347953479634797347983479934800348013480234803348043480534806348073480834809348103481134812348133481434815348163481734818348193482034821348223482334824348253482634827348283482934830348313483234833348343483534836348373483834839348403484134842348433484434845348463484734848348493485034851348523485334854348553485634857348583485934860348613486234863348643486534866348673486834869348703487134872348733487434875348763487734878348793488034881348823488334884348853488634887348883488934890348913489234893348943489534896348973489834899349003490134902349033490434905349063490734908349093491034911349123491334914349153491634917349183491934920349213492234923349243492534926349273492834929349303493134932349333493434935349363493734938349393494034941349423494334944349453494634947349483494934950349513495234953349543495534956349573495834959349603496134962349633496434965349663496734968349693497034971349723497334974349753497634977349783497934980349813498234983349843498534986349873498834989349903499134992349933499434995349963499734998349993500035001350023500335004350053500635007350083500935010350113501235013350143501535016350173501835019350203502135022350233502435025350263502735028350293503035031350323503335034350353503635037350383503935040350413504235043350443504535046350473504835049350503505135052350533505435055350563505735058350593506035061350623506335064350653506635067350683506935070350713507235073350743507535076350773507835079350803508135082350833508435085350863508735088350893509035091350923509335094350953509635097350983509935100351013510235103351043510535106351073510835109351103511135112351133511435115351163511735118351193512035121351223512335124351253512635127351283512935130351313513235133351343513535136351373513835139351403514135142351433514435145351463514735148351493515035151351523515335154351553515635157351583515935160351613516235163351643516535166351673516835169351703517135172351733517435175351763517735178351793518035181351823518335184351853518635187351883518935190351913519235193351943519535196351973519835199352003520135202352033520435205352063520735208352093521035211352123521335214352153521635217352183521935220352213522235223352243522535226352273522835229352303523135232352333523435235352363523735238352393524035241352423524335244352453524635247352483524935250352513525235253352543525535256352573525835259352603526135262352633526435265352663526735268352693527035271352723527335274352753527635277352783527935280352813528235283352843528535286352873528835289352903529135292352933529435295352963529735298352993530035301353023530335304353053530635307353083530935310353113531235313353143531535316353173531835319353203532135322353233532435325353263532735328353293533035331353323533335334353353533635337353383533935340353413534235343353443534535346353473534835349353503535135352353533535435355353563535735358353593536035361353623536335364353653536635367353683536935370353713537235373353743537535376353773537835379353803538135382353833538435385353863538735388353893539035391353923539335394353953539635397353983539935400354013540235403354043540535406354073540835409354103541135412354133541435415354163541735418354193542035421354223542335424354253542635427354283542935430354313543235433354343543535436354373543835439354403544135442354433544435445354463544735448354493545035451354523545335454354553545635457354583545935460354613546235463354643546535466354673546835469354703547135472354733547435475354763547735478354793548035481354823548335484354853548635487354883548935490354913549235493354943549535496354973549835499355003550135502355033550435505355063550735508355093551035511355123551335514355153551635517355183551935520355213552235523355243552535526355273552835529355303553135532355333553435535355363553735538355393554035541355423554335544355453554635547355483554935550355513555235553355543555535556355573555835559355603556135562355633556435565355663556735568355693557035571355723557335574355753557635577355783557935580355813558235583355843558535586355873558835589355903559135592355933559435595355963559735598355993560035601356023560335604356053560635607356083560935610356113561235613356143561535616356173561835619356203562135622356233562435625356263562735628356293563035631356323563335634356353563635637356383563935640356413564235643356443564535646356473564835649356503565135652356533565435655356563565735658356593566035661356623566335664356653566635667356683566935670356713567235673356743567535676356773567835679356803568135682356833568435685356863568735688356893569035691356923569335694356953569635697356983569935700357013570235703357043570535706357073570835709357103571135712357133571435715357163571735718357193572035721357223572335724357253572635727357283572935730357313573235733357343573535736357373573835739357403574135742357433574435745357463574735748357493575035751357523575335754357553575635757357583575935760357613576235763357643576535766357673576835769357703577135772357733577435775357763577735778357793578035781357823578335784357853578635787357883578935790357913579235793357943579535796357973579835799358003580135802358033580435805358063580735808358093581035811358123581335814358153581635817358183581935820358213582235823358243582535826358273582835829358303583135832358333583435835358363583735838358393584035841358423584335844358453584635847358483584935850358513585235853358543585535856358573585835859358603586135862358633586435865358663586735868358693587035871358723587335874358753587635877358783587935880358813588235883358843588535886358873588835889358903589135892358933589435895358963589735898358993590035901359023590335904359053590635907359083590935910359113591235913359143591535916359173591835919359203592135922359233592435925359263592735928359293593035931359323593335934359353593635937359383593935940359413594235943359443594535946359473594835949359503595135952359533595435955359563595735958359593596035961359623596335964359653596635967359683596935970359713597235973359743597535976359773597835979359803598135982359833598435985359863598735988359893599035991359923599335994359953599635997359983599936000360013600236003360043600536006360073600836009360103601136012360133601436015360163601736018360193602036021360223602336024360253602636027360283602936030360313603236033360343603536036360373603836039360403604136042360433604436045360463604736048360493605036051360523605336054360553605636057360583605936060360613606236063360643606536066360673606836069360703607136072360733607436075360763607736078360793608036081360823608336084360853608636087360883608936090360913609236093360943609536096360973609836099361003610136102361033610436105361063610736108361093611036111361123611336114361153611636117361183611936120361213612236123361243612536126361273612836129361303613136132361333613436135361363613736138361393614036141361423614336144361453614636147361483614936150361513615236153361543615536156361573615836159361603616136162361633616436165361663616736168361693617036171361723617336174361753617636177361783617936180361813618236183361843618536186361873618836189361903619136192361933619436195361963619736198361993620036201362023620336204362053620636207362083620936210362113621236213362143621536216362173621836219362203622136222362233622436225362263622736228362293623036231362323623336234362353623636237362383623936240362413624236243362443624536246362473624836249362503625136252362533625436255362563625736258362593626036261362623626336264362653626636267362683626936270362713627236273362743627536276362773627836279362803628136282362833628436285362863628736288362893629036291362923629336294362953629636297362983629936300363013630236303363043630536306363073630836309363103631136312363133631436315363163631736318363193632036321363223632336324363253632636327363283632936330363313633236333363343633536336363373633836339363403634136342363433634436345363463634736348363493635036351363523635336354363553635636357363583635936360363613636236363363643636536366363673636836369363703637136372363733637436375363763637736378363793638036381363823638336384363853638636387363883638936390363913639236393363943639536396363973639836399364003640136402364033640436405364063640736408364093641036411364123641336414364153641636417364183641936420364213642236423364243642536426364273642836429364303643136432364333643436435364363643736438364393644036441364423644336444364453644636447364483644936450364513645236453364543645536456364573645836459364603646136462364633646436465364663646736468364693647036471364723647336474364753647636477364783647936480364813648236483364843648536486364873648836489364903649136492364933649436495364963649736498364993650036501365023650336504365053650636507365083650936510365113651236513365143651536516365173651836519365203652136522365233652436525365263652736528365293653036531365323653336534365353653636537365383653936540365413654236543365443654536546365473654836549365503655136552365533655436555365563655736558365593656036561365623656336564365653656636567365683656936570365713657236573365743657536576365773657836579365803658136582365833658436585365863658736588365893659036591365923659336594365953659636597365983659936600366013660236603366043660536606366073660836609366103661136612366133661436615366163661736618366193662036621366223662336624366253662636627366283662936630366313663236633366343663536636366373663836639366403664136642366433664436645366463664736648366493665036651366523665336654366553665636657366583665936660366613666236663366643666536666366673666836669366703667136672366733667436675366763667736678366793668036681366823668336684366853668636687366883668936690366913669236693366943669536696366973669836699367003670136702367033670436705367063670736708367093671036711367123671336714367153671636717367183671936720367213672236723367243672536726367273672836729367303673136732367333673436735367363673736738367393674036741367423674336744367453674636747367483674936750367513675236753367543675536756367573675836759367603676136762367633676436765367663676736768367693677036771367723677336774367753677636777367783677936780367813678236783367843678536786367873678836789367903679136792367933679436795367963679736798367993680036801368023680336804368053680636807368083680936810368113681236813368143681536816368173681836819368203682136822368233682436825368263682736828368293683036831368323683336834368353683636837368383683936840368413684236843368443684536846368473684836849368503685136852368533685436855368563685736858368593686036861368623686336864368653686636867368683686936870368713687236873368743687536876368773687836879368803688136882368833688436885368863688736888368893689036891368923689336894368953689636897368983689936900369013690236903369043690536906369073690836909369103691136912369133691436915369163691736918369193692036921369223692336924369253692636927369283692936930369313693236933369343693536936369373693836939369403694136942369433694436945369463694736948369493695036951369523695336954369553695636957369583695936960369613696236963369643696536966369673696836969369703697136972369733697436975369763697736978369793698036981369823698336984369853698636987369883698936990369913699236993369943699536996369973699836999370003700137002370033700437005370063700737008370093701037011370123701337014370153701637017370183701937020370213702237023370243702537026370273702837029370303703137032370333703437035370363703737038370393704037041370423704337044370453704637047370483704937050370513705237053370543705537056370573705837059370603706137062370633706437065370663706737068370693707037071370723707337074370753707637077370783707937080370813708237083370843708537086370873708837089370903709137092370933709437095370963709737098370993710037101371023710337104371053710637107371083710937110371113711237113371143711537116371173711837119371203712137122371233712437125371263712737128371293713037131371323713337134371353713637137371383713937140371413714237143371443714537146371473714837149371503715137152371533715437155371563715737158371593716037161371623716337164371653716637167371683716937170371713717237173371743717537176371773717837179371803718137182371833718437185371863718737188371893719037191371923719337194371953719637197371983719937200372013720237203372043720537206372073720837209372103721137212372133721437215372163721737218372193722037221372223722337224372253722637227372283722937230372313723237233372343723537236372373723837239372403724137242372433724437245372463724737248372493725037251372523725337254372553725637257372583725937260372613726237263372643726537266372673726837269372703727137272372733727437275372763727737278372793728037281372823728337284372853728637287372883728937290372913729237293372943729537296372973729837299373003730137302373033730437305373063730737308373093731037311373123731337314373153731637317373183731937320373213732237323373243732537326373273732837329373303733137332373333733437335373363733737338373393734037341373423734337344373453734637347373483734937350373513735237353373543735537356373573735837359373603736137362373633736437365373663736737368373693737037371373723737337374373753737637377373783737937380373813738237383373843738537386373873738837389373903739137392373933739437395373963739737398373993740037401374023740337404374053740637407374083740937410374113741237413374143741537416374173741837419374203742137422374233742437425374263742737428374293743037431374323743337434374353743637437374383743937440374413744237443374443744537446374473744837449374503745137452374533745437455374563745737458374593746037461374623746337464374653746637467374683746937470374713747237473374743747537476374773747837479374803748137482374833748437485374863748737488374893749037491374923749337494374953749637497374983749937500375013750237503375043750537506375073750837509375103751137512375133751437515375163751737518375193752037521375223752337524375253752637527375283752937530375313753237533375343753537536375373753837539375403754137542375433754437545375463754737548375493755037551375523755337554375553755637557375583755937560375613756237563375643756537566375673756837569375703757137572375733757437575375763757737578375793758037581375823758337584375853758637587375883758937590375913759237593375943759537596375973759837599376003760137602376033760437605376063760737608376093761037611376123761337614376153761637617376183761937620376213762237623376243762537626376273762837629376303763137632376333763437635376363763737638376393764037641376423764337644376453764637647376483764937650376513765237653376543765537656376573765837659376603766137662376633766437665376663766737668376693767037671376723767337674376753767637677376783767937680376813768237683376843768537686376873768837689376903769137692376933769437695376963769737698376993770037701377023770337704377053770637707377083770937710377113771237713377143771537716377173771837719377203772137722377233772437725377263772737728377293773037731377323773337734377353773637737377383773937740377413774237743377443774537746377473774837749377503775137752377533775437755377563775737758377593776037761377623776337764377653776637767377683776937770377713777237773377743777537776377773777837779377803778137782377833778437785377863778737788377893779037791377923779337794377953779637797377983779937800378013780237803378043780537806378073780837809378103781137812378133781437815378163781737818378193782037821378223782337824378253782637827378283782937830378313783237833378343783537836378373783837839378403784137842378433784437845378463784737848378493785037851378523785337854378553785637857378583785937860378613786237863378643786537866378673786837869378703787137872378733787437875378763787737878378793788037881378823788337884378853788637887378883788937890378913789237893378943789537896378973789837899379003790137902379033790437905379063790737908379093791037911379123791337914379153791637917379183791937920379213792237923379243792537926379273792837929379303793137932379333793437935379363793737938379393794037941379423794337944379453794637947379483794937950379513795237953379543795537956379573795837959379603796137962379633796437965379663796737968379693797037971379723797337974379753797637977379783797937980379813798237983379843798537986379873798837989379903799137992379933799437995379963799737998379993800038001380023800338004380053800638007380083800938010380113801238013380143801538016380173801838019380203802138022380233802438025380263802738028380293803038031380323803338034380353803638037380383803938040380413804238043380443804538046380473804838049380503805138052380533805438055380563805738058380593806038061380623806338064380653806638067380683806938070380713807238073380743807538076380773807838079380803808138082380833808438085380863808738088380893809038091380923809338094380953809638097380983809938100381013810238103381043810538106381073810838109381103811138112381133811438115381163811738118381193812038121381223812338124381253812638127381283812938130381313813238133381343813538136381373813838139381403814138142381433814438145381463814738148381493815038151381523815338154381553815638157381583815938160381613816238163381643816538166381673816838169381703817138172381733817438175381763817738178381793818038181381823818338184381853818638187381883818938190381913819238193381943819538196381973819838199382003820138202382033820438205382063820738208382093821038211382123821338214382153821638217382183821938220382213822238223382243822538226382273822838229382303823138232382333823438235382363823738238382393824038241382423824338244382453824638247382483824938250382513825238253382543825538256382573825838259382603826138262382633826438265382663826738268382693827038271382723827338274382753827638277382783827938280382813828238283382843828538286382873828838289382903829138292382933829438295382963829738298382993830038301383023830338304383053830638307383083830938310383113831238313383143831538316383173831838319383203832138322383233832438325383263832738328383293833038331383323833338334383353833638337383383833938340383413834238343383443834538346383473834838349383503835138352383533835438355383563835738358383593836038361383623836338364383653836638367383683836938370383713837238373383743837538376383773837838379383803838138382383833838438385383863838738388383893839038391383923839338394383953839638397383983839938400384013840238403384043840538406384073840838409384103841138412384133841438415384163841738418384193842038421384223842338424384253842638427384283842938430384313843238433384343843538436384373843838439384403844138442384433844438445384463844738448384493845038451384523845338454384553845638457384583845938460384613846238463384643846538466384673846838469384703847138472384733847438475384763847738478384793848038481384823848338484384853848638487384883848938490384913849238493384943849538496384973849838499385003850138502385033850438505385063850738508385093851038511385123851338514385153851638517385183851938520385213852238523385243852538526385273852838529385303853138532385333853438535385363853738538385393854038541385423854338544385453854638547385483854938550385513855238553385543855538556385573855838559385603856138562385633856438565385663856738568385693857038571385723857338574385753857638577385783857938580385813858238583385843858538586385873858838589385903859138592385933859438595385963859738598385993860038601386023860338604386053860638607386083860938610386113861238613386143861538616386173861838619386203862138622386233862438625386263862738628386293863038631386323863338634386353863638637386383863938640386413864238643386443864538646386473864838649386503865138652386533865438655386563865738658386593866038661386623866338664386653866638667386683866938670386713867238673386743867538676386773867838679386803868138682386833868438685386863868738688386893869038691386923869338694386953869638697386983869938700387013870238703387043870538706387073870838709387103871138712387133871438715387163871738718387193872038721387223872338724387253872638727387283872938730387313873238733387343873538736387373873838739387403874138742387433874438745387463874738748387493875038751387523875338754387553875638757387583875938760387613876238763387643876538766387673876838769387703877138772387733877438775387763877738778387793878038781387823878338784387853878638787387883878938790387913879238793387943879538796387973879838799388003880138802388033880438805388063880738808388093881038811388123881338814388153881638817388183881938820388213882238823388243882538826388273882838829388303883138832388333883438835388363883738838388393884038841388423884338844388453884638847388483884938850388513885238853388543885538856388573885838859388603886138862388633886438865388663886738868388693887038871388723887338874388753887638877388783887938880388813888238883388843888538886388873888838889388903889138892388933889438895388963889738898388993890038901389023890338904389053890638907389083890938910389113891238913389143891538916389173891838919389203892138922389233892438925389263892738928389293893038931389323893338934389353893638937389383893938940389413894238943389443894538946389473894838949389503895138952389533895438955389563895738958389593896038961389623896338964389653896638967389683896938970389713897238973389743897538976389773897838979389803898138982389833898438985389863898738988389893899038991389923899338994389953899638997389983899939000390013900239003390043900539006390073900839009390103901139012390133901439015390163901739018390193902039021390223902339024390253902639027390283902939030390313903239033390343903539036390373903839039390403904139042390433904439045390463904739048390493905039051390523905339054390553905639057390583905939060390613906239063390643906539066390673906839069390703907139072390733907439075390763907739078390793908039081390823908339084390853908639087390883908939090390913909239093390943909539096390973909839099391003910139102391033910439105391063910739108391093911039111391123911339114391153911639117391183911939120391213912239123391243912539126391273912839129391303913139132391333913439135391363913739138391393914039141391423914339144391453914639147391483914939150391513915239153391543915539156391573915839159391603916139162391633916439165391663916739168391693917039171391723917339174391753917639177391783917939180391813918239183391843918539186391873918839189391903919139192391933919439195391963919739198391993920039201392023920339204392053920639207392083920939210392113921239213392143921539216392173921839219392203922139222392233922439225392263922739228392293923039231392323923339234392353923639237392383923939240392413924239243392443924539246392473924839249392503925139252392533925439255392563925739258392593926039261392623926339264392653926639267392683926939270392713927239273392743927539276392773927839279392803928139282392833928439285392863928739288392893929039291392923929339294392953929639297392983929939300393013930239303393043930539306393073930839309393103931139312393133931439315393163931739318393193932039321393223932339324393253932639327393283932939330393313933239333393343933539336393373933839339393403934139342393433934439345393463934739348393493935039351393523935339354393553935639357393583935939360393613936239363393643936539366393673936839369393703937139372393733937439375393763937739378393793938039381393823938339384393853938639387393883938939390393913939239393393943939539396393973939839399394003940139402394033940439405394063940739408394093941039411394123941339414394153941639417394183941939420394213942239423394243942539426394273942839429394303943139432394333943439435394363943739438394393944039441394423944339444394453944639447394483944939450394513945239453394543945539456394573945839459394603946139462394633946439465394663946739468394693947039471394723947339474394753947639477394783947939480394813948239483394843948539486394873948839489394903949139492394933949439495394963949739498394993950039501395023950339504395053950639507395083950939510395113951239513395143951539516395173951839519395203952139522395233952439525395263952739528395293953039531395323953339534395353953639537395383953939540395413954239543395443954539546395473954839549395503955139552395533955439555395563955739558395593956039561395623956339564395653956639567395683956939570395713957239573395743957539576395773957839579395803958139582395833958439585395863958739588395893959039591395923959339594395953959639597395983959939600396013960239603396043960539606396073960839609396103961139612396133961439615396163961739618396193962039621396223962339624396253962639627396283962939630396313963239633396343963539636396373963839639396403964139642396433964439645396463964739648396493965039651396523965339654396553965639657396583965939660396613966239663396643966539666396673966839669396703967139672396733967439675396763967739678396793968039681396823968339684396853968639687396883968939690396913969239693396943969539696396973969839699397003970139702397033970439705397063970739708397093971039711397123971339714397153971639717397183971939720397213972239723397243972539726397273972839729397303973139732397333973439735397363973739738397393974039741397423974339744397453974639747397483974939750397513975239753397543975539756397573975839759397603976139762397633976439765397663976739768397693977039771397723977339774397753977639777397783977939780397813978239783397843978539786397873978839789397903979139792397933979439795397963979739798397993980039801398023980339804398053980639807398083980939810398113981239813398143981539816398173981839819398203982139822398233982439825398263982739828398293983039831398323983339834398353983639837398383983939840398413984239843398443984539846398473984839849398503985139852398533985439855398563985739858398593986039861398623986339864398653986639867398683986939870398713987239873398743987539876398773987839879398803988139882398833988439885398863988739888398893989039891398923989339894398953989639897398983989939900399013990239903399043990539906399073990839909399103991139912399133991439915399163991739918399193992039921399223992339924399253992639927399283992939930399313993239933399343993539936399373993839939399403994139942399433994439945399463994739948399493995039951399523995339954399553995639957399583995939960399613996239963399643996539966399673996839969399703997139972399733997439975399763997739978399793998039981399823998339984399853998639987399883998939990399913999239993399943999539996399973999839999400004000140002400034000440005400064000740008400094001040011400124001340014400154001640017400184001940020400214002240023400244002540026400274002840029400304003140032400334003440035400364003740038400394004040041400424004340044400454004640047400484004940050400514005240053400544005540056400574005840059400604006140062400634006440065400664006740068400694007040071400724007340074400754007640077400784007940080400814008240083400844008540086400874008840089400904009140092400934009440095400964009740098400994010040101401024010340104401054010640107401084010940110401114011240113401144011540116401174011840119401204012140122401234012440125401264012740128401294013040131401324013340134401354013640137401384013940140401414014240143401444014540146401474014840149401504015140152401534015440155401564015740158401594016040161401624016340164401654016640167401684016940170401714017240173401744017540176401774017840179401804018140182401834018440185401864018740188401894019040191401924019340194401954019640197401984019940200402014020240203402044020540206402074020840209402104021140212402134021440215402164021740218402194022040221402224022340224402254022640227402284022940230402314023240233402344023540236402374023840239402404024140242402434024440245402464024740248402494025040251402524025340254402554025640257402584025940260402614026240263402644026540266402674026840269402704027140272402734027440275402764027740278402794028040281402824028340284402854028640287402884028940290402914029240293402944029540296402974029840299403004030140302403034030440305403064030740308403094031040311403124031340314403154031640317403184031940320403214032240323403244032540326403274032840329403304033140332403334033440335403364033740338403394034040341403424034340344403454034640347403484034940350403514035240353403544035540356403574035840359403604036140362403634036440365403664036740368403694037040371403724037340374403754037640377403784037940380403814038240383403844038540386403874038840389403904039140392403934039440395403964039740398403994040040401404024040340404404054040640407404084040940410404114041240413404144041540416404174041840419404204042140422404234042440425404264042740428404294043040431404324043340434404354043640437404384043940440404414044240443404444044540446404474044840449404504045140452404534045440455404564045740458404594046040461404624046340464404654046640467404684046940470404714047240473404744047540476404774047840479404804048140482404834048440485404864048740488404894049040491404924049340494404954049640497404984049940500405014050240503405044050540506405074050840509405104051140512405134051440515405164051740518405194052040521405224052340524405254052640527405284052940530405314053240533405344053540536405374053840539405404054140542405434054440545405464054740548405494055040551405524055340554405554055640557405584055940560405614056240563405644056540566405674056840569405704057140572405734057440575405764057740578405794058040581405824058340584405854058640587405884058940590405914059240593405944059540596405974059840599406004060140602406034060440605406064060740608406094061040611406124061340614406154061640617406184061940620406214062240623406244062540626406274062840629406304063140632406334063440635406364063740638406394064040641406424064340644406454064640647406484064940650406514065240653406544065540656406574065840659406604066140662406634066440665406664066740668406694067040671406724067340674406754067640677406784067940680406814068240683406844068540686406874068840689406904069140692406934069440695406964069740698406994070040701407024070340704407054070640707407084070940710407114071240713407144071540716407174071840719407204072140722407234072440725407264072740728407294073040731407324073340734407354073640737407384073940740407414074240743407444074540746407474074840749407504075140752407534075440755407564075740758407594076040761407624076340764407654076640767407684076940770407714077240773407744077540776407774077840779407804078140782407834078440785407864078740788407894079040791407924079340794407954079640797407984079940800408014080240803408044080540806408074080840809408104081140812408134081440815408164081740818408194082040821408224082340824408254082640827408284082940830408314083240833408344083540836408374083840839408404084140842408434084440845408464084740848408494085040851408524085340854408554085640857408584085940860408614086240863408644086540866408674086840869408704087140872408734087440875408764087740878408794088040881408824088340884408854088640887408884088940890408914089240893408944089540896408974089840899409004090140902409034090440905409064090740908409094091040911409124091340914409154091640917409184091940920409214092240923409244092540926409274092840929409304093140932409334093440935409364093740938409394094040941409424094340944409454094640947409484094940950409514095240953409544095540956409574095840959409604096140962409634096440965409664096740968409694097040971409724097340974409754097640977409784097940980409814098240983409844098540986409874098840989409904099140992409934099440995409964099740998409994100041001410024100341004410054100641007410084100941010410114101241013410144101541016410174101841019410204102141022410234102441025410264102741028410294103041031410324103341034410354103641037410384103941040410414104241043410444104541046410474104841049410504105141052410534105441055410564105741058410594106041061410624106341064410654106641067410684106941070410714107241073410744107541076410774107841079410804108141082410834108441085410864108741088410894109041091410924109341094410954109641097410984109941100411014110241103411044110541106411074110841109411104111141112411134111441115411164111741118411194112041121411224112341124411254112641127411284112941130411314113241133411344113541136411374113841139411404114141142411434114441145411464114741148411494115041151411524115341154411554115641157411584115941160411614116241163411644116541166411674116841169411704117141172411734117441175411764117741178411794118041181411824118341184411854118641187411884118941190411914119241193411944119541196411974119841199412004120141202412034120441205412064120741208412094121041211412124121341214412154121641217412184121941220412214122241223412244122541226412274122841229412304123141232412334123441235412364123741238412394124041241412424124341244412454124641247412484124941250412514125241253412544125541256412574125841259412604126141262412634126441265412664126741268412694127041271412724127341274412754127641277412784127941280412814128241283412844128541286412874128841289412904129141292412934129441295412964129741298412994130041301413024130341304413054130641307413084130941310413114131241313413144131541316413174131841319413204132141322413234132441325413264132741328413294133041331413324133341334413354133641337413384133941340413414134241343413444134541346413474134841349413504135141352413534135441355413564135741358413594136041361413624136341364413654136641367413684136941370413714137241373413744137541376413774137841379413804138141382413834138441385413864138741388413894139041391413924139341394413954139641397413984139941400414014140241403414044140541406414074140841409414104141141412414134141441415414164141741418414194142041421414224142341424414254142641427414284142941430414314143241433414344143541436414374143841439414404144141442414434144441445414464144741448414494145041451414524145341454414554145641457414584145941460414614146241463414644146541466414674146841469414704147141472414734147441475414764147741478414794148041481414824148341484414854148641487414884148941490414914149241493414944149541496414974149841499415004150141502415034150441505415064150741508415094151041511415124151341514415154151641517415184151941520415214152241523415244152541526415274152841529415304153141532415334153441535415364153741538415394154041541415424154341544415454154641547415484154941550415514155241553415544155541556415574155841559415604156141562415634156441565415664156741568415694157041571415724157341574415754157641577415784157941580415814158241583415844158541586415874158841589415904159141592415934159441595415964159741598415994160041601416024160341604416054160641607416084160941610416114161241613416144161541616416174161841619416204162141622416234162441625416264162741628416294163041631416324163341634416354163641637416384163941640416414164241643416444164541646416474164841649416504165141652416534165441655416564165741658416594166041661416624166341664416654166641667416684166941670416714167241673416744167541676416774167841679416804168141682416834168441685416864168741688416894169041691416924169341694416954169641697416984169941700417014170241703417044170541706417074170841709417104171141712417134171441715417164171741718417194172041721417224172341724417254172641727417284172941730417314173241733417344173541736417374173841739417404174141742417434174441745417464174741748417494175041751417524175341754417554175641757417584175941760417614176241763417644176541766417674176841769417704177141772417734177441775417764177741778417794178041781417824178341784417854178641787417884178941790417914179241793417944179541796417974179841799418004180141802418034180441805418064180741808418094181041811418124181341814418154181641817418184181941820418214182241823418244182541826418274182841829418304183141832418334183441835418364183741838418394184041841418424184341844418454184641847418484184941850418514185241853418544185541856418574185841859418604186141862418634186441865418664186741868418694187041871418724187341874418754187641877418784187941880418814188241883418844188541886418874188841889418904189141892418934189441895418964189741898418994190041901419024190341904419054190641907419084190941910419114191241913419144191541916419174191841919419204192141922419234192441925419264192741928419294193041931419324193341934419354193641937419384193941940419414194241943419444194541946419474194841949419504195141952419534195441955419564195741958419594196041961419624196341964419654196641967419684196941970419714197241973419744197541976419774197841979419804198141982419834198441985419864198741988419894199041991419924199341994419954199641997419984199942000420014200242003420044200542006420074200842009420104201142012420134201442015420164201742018420194202042021420224202342024420254202642027420284202942030420314203242033420344203542036420374203842039420404204142042420434204442045420464204742048420494205042051420524205342054420554205642057420584205942060420614206242063420644206542066420674206842069420704207142072420734207442075420764207742078420794208042081420824208342084420854208642087420884208942090420914209242093420944209542096420974209842099421004210142102421034210442105421064210742108421094211042111421124211342114421154211642117421184211942120421214212242123421244212542126421274212842129421304213142132421334213442135421364213742138421394214042141421424214342144421454214642147421484214942150421514215242153421544215542156421574215842159421604216142162421634216442165421664216742168421694217042171421724217342174421754217642177421784217942180421814218242183421844218542186421874218842189421904219142192421934219442195421964219742198421994220042201422024220342204422054220642207422084220942210422114221242213422144221542216422174221842219422204222142222422234222442225422264222742228422294223042231422324223342234422354223642237422384223942240422414224242243422444224542246422474224842249422504225142252422534225442255422564225742258422594226042261422624226342264422654226642267422684226942270422714227242273422744227542276422774227842279422804228142282422834228442285422864228742288422894229042291422924229342294422954229642297422984229942300423014230242303423044230542306423074230842309423104231142312423134231442315423164231742318423194232042321423224232342324423254232642327423284232942330423314233242333423344233542336423374233842339423404234142342423434234442345423464234742348423494235042351423524235342354423554235642357423584235942360423614236242363423644236542366423674236842369423704237142372423734237442375423764237742378423794238042381423824238342384423854238642387423884238942390423914239242393423944239542396423974239842399424004240142402424034240442405424064240742408424094241042411424124241342414424154241642417424184241942420424214242242423424244242542426424274242842429424304243142432424334243442435424364243742438424394244042441424424244342444424454244642447424484244942450424514245242453424544245542456424574245842459424604246142462424634246442465424664246742468424694247042471424724247342474424754247642477424784247942480424814248242483424844248542486424874248842489424904249142492424934249442495424964249742498424994250042501425024250342504425054250642507425084250942510425114251242513425144251542516425174251842519425204252142522425234252442525425264252742528425294253042531425324253342534425354253642537425384253942540425414254242543425444254542546425474254842549425504255142552425534255442555425564255742558425594256042561425624256342564425654256642567425684256942570425714257242573425744257542576425774257842579425804258142582425834258442585425864258742588425894259042591425924259342594425954259642597425984259942600426014260242603426044260542606426074260842609426104261142612426134261442615426164261742618426194262042621426224262342624426254262642627426284262942630426314263242633426344263542636426374263842639426404264142642426434264442645426464264742648426494265042651426524265342654426554265642657426584265942660426614266242663426644266542666426674266842669426704267142672426734267442675426764267742678426794268042681426824268342684426854268642687426884268942690426914269242693426944269542696426974269842699427004270142702427034270442705427064270742708427094271042711427124271342714427154271642717427184271942720427214272242723427244272542726427274272842729427304273142732427334273442735427364273742738427394274042741427424274342744427454274642747427484274942750427514275242753427544275542756427574275842759427604276142762427634276442765427664276742768427694277042771427724277342774427754277642777427784277942780427814278242783427844278542786427874278842789427904279142792427934279442795427964279742798427994280042801428024280342804428054280642807428084280942810428114281242813428144281542816428174281842819428204282142822428234282442825428264282742828428294283042831428324283342834428354283642837428384283942840428414284242843428444284542846428474284842849428504285142852428534285442855428564285742858428594286042861428624286342864428654286642867428684286942870428714287242873428744287542876428774287842879428804288142882428834288442885428864288742888428894289042891428924289342894428954289642897428984289942900429014290242903429044290542906429074290842909429104291142912429134291442915429164291742918429194292042921429224292342924429254292642927429284292942930429314293242933429344293542936429374293842939429404294142942429434294442945429464294742948429494295042951429524295342954429554295642957429584295942960429614296242963429644296542966429674296842969429704297142972429734297442975429764297742978429794298042981429824298342984429854298642987429884298942990429914299242993429944299542996429974299842999430004300143002430034300443005430064300743008430094301043011430124301343014430154301643017430184301943020430214302243023430244302543026430274302843029430304303143032430334303443035430364303743038430394304043041430424304343044430454304643047430484304943050430514305243053430544305543056430574305843059430604306143062430634306443065430664306743068430694307043071430724307343074430754307643077430784307943080430814308243083430844308543086430874308843089430904309143092430934309443095430964309743098430994310043101431024310343104431054310643107431084310943110431114311243113431144311543116431174311843119431204312143122431234312443125431264312743128431294313043131431324313343134431354313643137431384313943140431414314243143431444314543146431474314843149431504315143152431534315443155431564315743158431594316043161431624316343164431654316643167431684316943170431714317243173431744317543176431774317843179431804318143182431834318443185431864318743188431894319043191431924319343194431954319643197431984319943200432014320243203432044320543206432074320843209432104321143212432134321443215432164321743218432194322043221432224322343224432254322643227432284322943230432314323243233432344323543236432374323843239432404324143242432434324443245432464324743248432494325043251432524325343254432554325643257432584325943260432614326243263432644326543266432674326843269432704327143272432734327443275432764327743278432794328043281432824328343284432854328643287432884328943290432914329243293432944329543296432974329843299433004330143302433034330443305433064330743308433094331043311433124331343314433154331643317433184331943320433214332243323433244332543326433274332843329433304333143332433334333443335433364333743338433394334043341433424334343344433454334643347433484334943350433514335243353433544335543356433574335843359433604336143362433634336443365433664336743368433694337043371433724337343374433754337643377433784337943380433814338243383433844338543386433874338843389433904339143392433934339443395433964339743398433994340043401434024340343404434054340643407434084340943410434114341243413434144341543416434174341843419434204342143422434234342443425434264342743428434294343043431434324343343434434354343643437434384343943440434414344243443434444344543446434474344843449434504345143452434534345443455434564345743458434594346043461434624346343464434654346643467434684346943470434714347243473434744347543476434774347843479434804348143482434834348443485434864348743488434894349043491434924349343494434954349643497434984349943500435014350243503435044350543506435074350843509435104351143512435134351443515435164351743518435194352043521435224352343524435254352643527435284352943530435314353243533435344353543536435374353843539435404354143542435434354443545435464354743548435494355043551435524355343554435554355643557435584355943560435614356243563435644356543566435674356843569435704357143572435734357443575435764357743578435794358043581435824358343584435854358643587435884358943590435914359243593435944359543596435974359843599436004360143602436034360443605436064360743608436094361043611436124361343614436154361643617436184361943620436214362243623436244362543626436274362843629436304363143632436334363443635436364363743638436394364043641436424364343644436454364643647436484364943650436514365243653436544365543656436574365843659436604366143662436634366443665436664366743668436694367043671436724367343674436754367643677436784367943680436814368243683436844368543686436874368843689436904369143692436934369443695436964369743698436994370043701437024370343704437054370643707437084370943710437114371243713437144371543716437174371843719437204372143722437234372443725437264372743728437294373043731437324373343734437354373643737437384373943740437414374243743437444374543746437474374843749437504375143752437534375443755437564375743758437594376043761437624376343764437654376643767437684376943770437714377243773437744377543776437774377843779437804378143782437834378443785437864378743788437894379043791437924379343794437954379643797437984379943800438014380243803438044380543806438074380843809438104381143812438134381443815438164381743818438194382043821438224382343824438254382643827438284382943830438314383243833438344383543836438374383843839438404384143842438434384443845438464384743848438494385043851438524385343854438554385643857438584385943860438614386243863438644386543866438674386843869438704387143872438734387443875438764387743878438794388043881438824388343884438854388643887438884388943890438914389243893438944389543896438974389843899439004390143902439034390443905439064390743908439094391043911439124391343914439154391643917439184391943920439214392243923439244392543926439274392843929439304393143932439334393443935439364393743938439394394043941439424394343944439454394643947439484394943950439514395243953439544395543956439574395843959439604396143962439634396443965439664396743968439694397043971439724397343974439754397643977439784397943980439814398243983439844398543986439874398843989439904399143992439934399443995439964399743998439994400044001440024400344004440054400644007440084400944010440114401244013440144401544016440174401844019440204402144022440234402444025440264402744028440294403044031440324403344034440354403644037440384403944040440414404244043440444404544046440474404844049440504405144052440534405444055440564405744058440594406044061440624406344064440654406644067440684406944070440714407244073440744407544076440774407844079440804408144082440834408444085440864408744088440894409044091440924409344094440954409644097440984409944100441014410244103441044410544106441074410844109441104411144112441134411444115441164411744118441194412044121441224412344124441254412644127441284412944130441314413244133441344413544136441374413844139441404414144142441434414444145441464414744148441494415044151441524415344154441554415644157441584415944160441614416244163441644416544166441674416844169441704417144172441734417444175441764417744178441794418044181441824418344184441854418644187441884418944190441914419244193441944419544196441974419844199442004420144202442034420444205442064420744208442094421044211442124421344214442154421644217442184421944220442214422244223442244422544226442274422844229442304423144232442334423444235442364423744238442394424044241442424424344244442454424644247442484424944250442514425244253442544425544256442574425844259442604426144262442634426444265442664426744268442694427044271442724427344274442754427644277442784427944280442814428244283442844428544286442874428844289442904429144292442934429444295442964429744298442994430044301443024430344304443054430644307443084430944310443114431244313443144431544316443174431844319443204432144322443234432444325443264432744328443294433044331443324433344334443354433644337443384433944340443414434244343443444434544346443474434844349443504435144352443534435444355443564435744358443594436044361443624436344364443654436644367443684436944370443714437244373443744437544376443774437844379443804438144382443834438444385443864438744388443894439044391443924439344394443954439644397443984439944400444014440244403444044440544406444074440844409444104441144412444134441444415444164441744418444194442044421444224442344424444254442644427444284442944430444314443244433444344443544436444374443844439444404444144442444434444444445444464444744448444494445044451444524445344454444554445644457444584445944460444614446244463444644446544466444674446844469444704447144472444734447444475444764447744478444794448044481444824448344484444854448644487444884448944490444914449244493444944449544496444974449844499445004450144502445034450444505445064450744508445094451044511445124451344514445154451644517445184451944520445214452244523445244452544526445274452844529445304453144532445334453444535445364453744538445394454044541445424454344544445454454644547445484454944550445514455244553445544455544556445574455844559445604456144562445634456444565445664456744568445694457044571445724457344574445754457644577445784457944580445814458244583445844458544586445874458844589445904459144592445934459444595445964459744598445994460044601446024460344604446054460644607446084460944610446114461244613446144461544616446174461844619446204462144622446234462444625446264462744628446294463044631446324463344634446354463644637446384463944640446414464244643446444464544646446474464844649446504465144652446534465444655446564465744658446594466044661446624466344664446654466644667446684466944670446714467244673446744467544676446774467844679446804468144682446834468444685446864468744688446894469044691446924469344694446954469644697446984469944700447014470244703447044470544706447074470844709447104471144712447134471444715447164471744718447194472044721447224472344724447254472644727447284472944730447314473244733447344473544736447374473844739447404474144742447434474444745447464474744748447494475044751447524475344754447554475644757447584475944760447614476244763447644476544766447674476844769447704477144772447734477444775447764477744778447794478044781447824478344784447854478644787447884478944790447914479244793447944479544796447974479844799448004480144802448034480444805448064480744808448094481044811448124481344814448154481644817448184481944820448214482244823448244482544826448274482844829448304483144832448334483444835448364483744838448394484044841448424484344844448454484644847448484484944850448514485244853448544485544856448574485844859448604486144862448634486444865448664486744868448694487044871448724487344874448754487644877448784487944880448814488244883448844488544886448874488844889448904489144892448934489444895448964489744898448994490044901449024490344904449054490644907449084490944910449114491244913449144491544916449174491844919449204492144922449234492444925449264492744928449294493044931449324493344934449354493644937449384493944940449414494244943449444494544946449474494844949449504495144952449534495444955449564495744958449594496044961449624496344964449654496644967449684496944970449714497244973449744497544976449774497844979449804498144982449834498444985449864498744988449894499044991449924499344994449954499644997449984499945000450014500245003450044500545006450074500845009450104501145012450134501445015450164501745018450194502045021450224502345024450254502645027450284502945030450314503245033450344503545036450374503845039450404504145042450434504445045450464504745048450494505045051450524505345054450554505645057450584505945060450614506245063450644506545066450674506845069450704507145072450734507445075450764507745078450794508045081450824508345084450854508645087450884508945090450914509245093450944509545096450974509845099451004510145102451034510445105451064510745108451094511045111451124511345114451154511645117451184511945120451214512245123451244512545126451274512845129451304513145132451334513445135451364513745138451394514045141451424514345144451454514645147451484514945150451514515245153451544515545156451574515845159451604516145162451634516445165451664516745168451694517045171451724517345174451754517645177451784517945180451814518245183451844518545186451874518845189451904519145192451934519445195451964519745198451994520045201452024520345204452054520645207452084520945210452114521245213452144521545216452174521845219452204522145222452234522445225452264522745228452294523045231452324523345234452354523645237452384523945240452414524245243452444524545246452474524845249452504525145252452534525445255452564525745258452594526045261452624526345264452654526645267452684526945270452714527245273452744527545276452774527845279452804528145282452834528445285452864528745288452894529045291452924529345294452954529645297452984529945300453014530245303453044530545306453074530845309453104531145312453134531445315453164531745318453194532045321453224532345324453254532645327453284532945330453314533245333453344533545336453374533845339453404534145342453434534445345453464534745348453494535045351453524535345354453554535645357453584535945360453614536245363453644536545366453674536845369453704537145372453734537445375453764537745378453794538045381453824538345384453854538645387453884538945390453914539245393453944539545396453974539845399454004540145402454034540445405454064540745408454094541045411454124541345414454154541645417454184541945420454214542245423454244542545426454274542845429454304543145432454334543445435454364543745438454394544045441454424544345444454454544645447454484544945450454514545245453454544545545456454574545845459454604546145462454634546445465454664546745468454694547045471454724547345474454754547645477454784547945480454814548245483454844548545486454874548845489454904549145492454934549445495454964549745498454994550045501455024550345504455054550645507455084550945510455114551245513455144551545516455174551845519455204552145522455234552445525455264552745528455294553045531455324553345534455354553645537455384553945540455414554245543455444554545546455474554845549455504555145552455534555445555455564555745558455594556045561455624556345564455654556645567455684556945570455714557245573455744557545576455774557845579455804558145582455834558445585455864558745588455894559045591455924559345594455954559645597455984559945600456014560245603456044560545606456074560845609456104561145612456134561445615456164561745618456194562045621456224562345624456254562645627456284562945630456314563245633456344563545636456374563845639456404564145642456434564445645456464564745648456494565045651456524565345654456554565645657456584565945660456614566245663456644566545666456674566845669456704567145672456734567445675456764567745678456794568045681456824568345684456854568645687456884568945690456914569245693456944569545696456974569845699457004570145702457034570445705457064570745708457094571045711457124571345714457154571645717457184571945720457214572245723457244572545726457274572845729457304573145732457334573445735457364573745738457394574045741457424574345744457454574645747457484574945750457514575245753457544575545756457574575845759457604576145762457634576445765457664576745768457694577045771457724577345774457754577645777457784577945780457814578245783457844578545786457874578845789457904579145792457934579445795457964579745798457994580045801458024580345804458054580645807458084580945810458114581245813458144581545816458174581845819458204582145822458234582445825458264582745828458294583045831458324583345834458354583645837458384583945840458414584245843458444584545846458474584845849458504585145852458534585445855458564585745858458594586045861458624586345864458654586645867458684586945870458714587245873458744587545876458774587845879458804588145882458834588445885458864588745888458894589045891458924589345894458954589645897458984589945900459014590245903459044590545906459074590845909459104591145912459134591445915459164591745918459194592045921459224592345924459254592645927459284592945930459314593245933459344593545936459374593845939459404594145942459434594445945459464594745948459494595045951459524595345954459554595645957459584595945960459614596245963459644596545966459674596845969459704597145972459734597445975459764597745978459794598045981459824598345984459854598645987459884598945990459914599245993459944599545996459974599845999460004600146002460034600446005460064600746008460094601046011460124601346014460154601646017460184601946020460214602246023460244602546026460274602846029460304603146032460334603446035460364603746038460394604046041460424604346044460454604646047460484604946050460514605246053460544605546056460574605846059460604606146062460634606446065460664606746068460694607046071460724607346074460754607646077460784607946080460814608246083460844608546086460874608846089460904609146092460934609446095460964609746098460994610046101461024610346104461054610646107461084610946110461114611246113461144611546116461174611846119461204612146122461234612446125461264612746128461294613046131461324613346134461354613646137461384613946140461414614246143461444614546146461474614846149461504615146152461534615446155461564615746158461594616046161461624616346164461654616646167461684616946170461714617246173461744617546176461774617846179461804618146182461834618446185461864618746188461894619046191461924619346194461954619646197461984619946200462014620246203462044620546206462074620846209462104621146212462134621446215462164621746218462194622046221462224622346224462254622646227462284622946230462314623246233462344623546236462374623846239462404624146242462434624446245462464624746248462494625046251462524625346254462554625646257462584625946260462614626246263462644626546266462674626846269462704627146272462734627446275462764627746278462794628046281462824628346284462854628646287462884628946290462914629246293462944629546296462974629846299463004630146302463034630446305463064630746308463094631046311463124631346314463154631646317463184631946320463214632246323463244632546326463274632846329463304633146332463334633446335463364633746338463394634046341463424634346344463454634646347463484634946350463514635246353463544635546356463574635846359463604636146362463634636446365463664636746368463694637046371463724637346374463754637646377463784637946380463814638246383463844638546386463874638846389463904639146392463934639446395463964639746398463994640046401464024640346404464054640646407464084640946410464114641246413464144641546416464174641846419464204642146422464234642446425464264642746428464294643046431464324643346434464354643646437464384643946440464414644246443464444644546446464474644846449464504645146452464534645446455464564645746458464594646046461464624646346464464654646646467464684646946470464714647246473464744647546476464774647846479464804648146482464834648446485464864648746488464894649046491464924649346494464954649646497464984649946500465014650246503465044650546506465074650846509465104651146512465134651446515465164651746518465194652046521465224652346524465254652646527465284652946530465314653246533465344653546536465374653846539465404654146542465434654446545465464654746548465494655046551465524655346554465554655646557465584655946560465614656246563465644656546566465674656846569465704657146572465734657446575465764657746578465794658046581465824658346584465854658646587465884658946590465914659246593465944659546596465974659846599466004660146602466034660446605466064660746608466094661046611466124661346614466154661646617466184661946620466214662246623466244662546626466274662846629466304663146632466334663446635466364663746638466394664046641466424664346644466454664646647466484664946650466514665246653466544665546656466574665846659466604666146662466634666446665466664666746668466694667046671466724667346674466754667646677466784667946680466814668246683466844668546686466874668846689466904669146692466934669446695466964669746698466994670046701467024670346704467054670646707467084670946710467114671246713467144671546716467174671846719467204672146722467234672446725467264672746728467294673046731467324673346734467354673646737467384673946740467414674246743467444674546746467474674846749467504675146752467534675446755467564675746758467594676046761467624676346764467654676646767467684676946770467714677246773467744677546776467774677846779467804678146782467834678446785467864678746788467894679046791467924679346794467954679646797467984679946800468014680246803468044680546806468074680846809468104681146812468134681446815468164681746818468194682046821468224682346824468254682646827468284682946830468314683246833468344683546836468374683846839468404684146842468434684446845468464684746848468494685046851468524685346854468554685646857468584685946860468614686246863468644686546866468674686846869468704687146872468734687446875468764687746878468794688046881468824688346884468854688646887468884688946890468914689246893468944689546896468974689846899469004690146902469034690446905469064690746908469094691046911469124691346914469154691646917469184691946920469214692246923469244692546926469274692846929469304693146932469334693446935469364693746938469394694046941469424694346944469454694646947469484694946950469514695246953469544695546956469574695846959469604696146962469634696446965469664696746968469694697046971469724697346974469754697646977469784697946980469814698246983469844698546986469874698846989469904699146992469934699446995469964699746998469994700047001470024700347004470054700647007470084700947010470114701247013470144701547016470174701847019470204702147022470234702447025470264702747028470294703047031470324703347034470354703647037470384703947040470414704247043470444704547046470474704847049470504705147052470534705447055470564705747058470594706047061470624706347064470654706647067470684706947070470714707247073470744707547076470774707847079470804708147082470834708447085470864708747088470894709047091470924709347094470954709647097470984709947100471014710247103471044710547106471074710847109471104711147112471134711447115471164711747118471194712047121471224712347124471254712647127471284712947130471314713247133471344713547136471374713847139471404714147142471434714447145471464714747148471494715047151471524715347154471554715647157471584715947160471614716247163471644716547166471674716847169471704717147172471734717447175471764717747178471794718047181471824718347184471854718647187471884718947190471914719247193471944719547196471974719847199472004720147202472034720447205472064720747208472094721047211472124721347214472154721647217472184721947220472214722247223472244722547226472274722847229472304723147232472334723447235472364723747238472394724047241472424724347244472454724647247472484724947250472514725247253472544725547256472574725847259472604726147262472634726447265472664726747268472694727047271472724727347274472754727647277472784727947280472814728247283472844728547286472874728847289472904729147292472934729447295472964729747298472994730047301473024730347304473054730647307473084730947310473114731247313473144731547316473174731847319473204732147322473234732447325473264732747328473294733047331473324733347334473354733647337473384733947340473414734247343473444734547346473474734847349473504735147352473534735447355473564735747358473594736047361473624736347364473654736647367473684736947370473714737247373473744737547376473774737847379473804738147382473834738447385473864738747388473894739047391473924739347394473954739647397473984739947400474014740247403474044740547406474074740847409474104741147412474134741447415474164741747418474194742047421474224742347424474254742647427474284742947430474314743247433474344743547436474374743847439474404744147442474434744447445474464744747448474494745047451474524745347454474554745647457474584745947460474614746247463474644746547466474674746847469474704747147472474734747447475474764747747478474794748047481474824748347484474854748647487474884748947490474914749247493474944749547496474974749847499475004750147502475034750447505475064750747508475094751047511475124751347514475154751647517475184751947520475214752247523475244752547526475274752847529475304753147532475334753447535475364753747538475394754047541475424754347544475454754647547475484754947550475514755247553475544755547556475574755847559475604756147562475634756447565475664756747568475694757047571475724757347574475754757647577475784757947580475814758247583475844758547586475874758847589475904759147592475934759447595475964759747598475994760047601476024760347604476054760647607476084760947610476114761247613476144761547616476174761847619476204762147622476234762447625476264762747628476294763047631476324763347634476354763647637476384763947640476414764247643476444764547646476474764847649476504765147652476534765447655476564765747658476594766047661476624766347664476654766647667476684766947670476714767247673476744767547676476774767847679476804768147682476834768447685476864768747688476894769047691476924769347694476954769647697476984769947700477014770247703477044770547706477074770847709477104771147712477134771447715477164771747718477194772047721477224772347724477254772647727477284772947730477314773247733477344773547736477374773847739477404774147742477434774447745477464774747748477494775047751477524775347754477554775647757477584775947760477614776247763477644776547766477674776847769477704777147772477734777447775477764777747778477794778047781477824778347784477854778647787477884778947790477914779247793477944779547796477974779847799478004780147802478034780447805478064780747808478094781047811478124781347814478154781647817478184781947820478214782247823478244782547826478274782847829478304783147832478334783447835478364783747838478394784047841478424784347844478454784647847478484784947850478514785247853478544785547856478574785847859478604786147862478634786447865478664786747868478694787047871478724787347874478754787647877478784787947880478814788247883478844788547886478874788847889478904789147892478934789447895478964789747898478994790047901479024790347904479054790647907479084790947910479114791247913479144791547916479174791847919479204792147922479234792447925479264792747928479294793047931479324793347934479354793647937479384793947940479414794247943479444794547946479474794847949479504795147952479534795447955479564795747958479594796047961479624796347964479654796647967479684796947970479714797247973479744797547976479774797847979479804798147982479834798447985479864798747988479894799047991479924799347994479954799647997479984799948000480014800248003480044800548006480074800848009480104801148012480134801448015480164801748018480194802048021480224802348024480254802648027480284802948030480314803248033480344803548036480374803848039480404804148042480434804448045480464804748048480494805048051480524805348054480554805648057480584805948060480614806248063480644806548066480674806848069480704807148072480734807448075480764807748078480794808048081480824808348084480854808648087480884808948090480914809248093480944809548096480974809848099481004810148102481034810448105481064810748108481094811048111481124811348114481154811648117481184811948120481214812248123481244812548126481274812848129481304813148132481334813448135481364813748138481394814048141481424814348144481454814648147481484814948150481514815248153481544815548156481574815848159481604816148162481634816448165481664816748168481694817048171481724817348174481754817648177481784817948180481814818248183481844818548186481874818848189481904819148192481934819448195481964819748198481994820048201482024820348204482054820648207482084820948210482114821248213482144821548216482174821848219482204822148222482234822448225482264822748228482294823048231482324823348234482354823648237482384823948240482414824248243482444824548246482474824848249482504825148252482534825448255482564825748258482594826048261482624826348264482654826648267482684826948270482714827248273482744827548276482774827848279482804828148282482834828448285482864828748288482894829048291482924829348294482954829648297482984829948300483014830248303483044830548306483074830848309483104831148312483134831448315483164831748318483194832048321483224832348324483254832648327483284832948330483314833248333483344833548336483374833848339483404834148342483434834448345483464834748348483494835048351483524835348354483554835648357483584835948360483614836248363483644836548366483674836848369483704837148372483734837448375483764837748378483794838048381483824838348384483854838648387483884838948390483914839248393483944839548396483974839848399484004840148402484034840448405484064840748408484094841048411484124841348414484154841648417484184841948420484214842248423484244842548426484274842848429484304843148432484334843448435484364843748438484394844048441484424844348444484454844648447484484844948450484514845248453484544845548456484574845848459484604846148462484634846448465484664846748468484694847048471484724847348474484754847648477484784847948480484814848248483484844848548486484874848848489484904849148492484934849448495484964849748498484994850048501485024850348504485054850648507485084850948510485114851248513485144851548516485174851848519485204852148522485234852448525485264852748528485294853048531485324853348534485354853648537485384853948540485414854248543485444854548546485474854848549485504855148552485534855448555485564855748558485594856048561485624856348564485654856648567485684856948570485714857248573485744857548576485774857848579485804858148582485834858448585485864858748588485894859048591485924859348594485954859648597485984859948600486014860248603486044860548606486074860848609486104861148612486134861448615486164861748618486194862048621486224862348624486254862648627486284862948630486314863248633486344863548636486374863848639486404864148642486434864448645486464864748648486494865048651486524865348654486554865648657486584865948660486614866248663486644866548666486674866848669486704867148672486734867448675486764867748678486794868048681486824868348684486854868648687486884868948690486914869248693486944869548696486974869848699487004870148702487034870448705487064870748708487094871048711487124871348714487154871648717487184871948720487214872248723487244872548726487274872848729487304873148732487334873448735487364873748738487394874048741487424874348744487454874648747487484874948750487514875248753487544875548756487574875848759487604876148762487634876448765487664876748768487694877048771487724877348774487754877648777487784877948780487814878248783487844878548786487874878848789487904879148792487934879448795487964879748798487994880048801488024880348804488054880648807488084880948810488114881248813488144881548816488174881848819488204882148822488234882448825488264882748828488294883048831488324883348834488354883648837488384883948840488414884248843488444884548846488474884848849488504885148852488534885448855488564885748858488594886048861488624886348864488654886648867488684886948870488714887248873488744887548876488774887848879488804888148882488834888448885488864888748888488894889048891488924889348894488954889648897488984889948900489014890248903489044890548906489074890848909489104891148912489134891448915489164891748918489194892048921489224892348924489254892648927489284892948930489314893248933489344893548936489374893848939489404894148942489434894448945489464894748948489494895048951489524895348954489554895648957489584895948960489614896248963489644896548966489674896848969489704897148972489734897448975489764897748978489794898048981489824898348984489854898648987489884898948990489914899248993489944899548996489974899848999490004900149002490034900449005490064900749008490094901049011490124901349014490154901649017490184901949020490214902249023490244902549026490274902849029490304903149032490334903449035490364903749038490394904049041490424904349044490454904649047490484904949050490514905249053490544905549056490574905849059490604906149062490634906449065490664906749068490694907049071490724907349074490754907649077490784907949080490814908249083490844908549086490874908849089490904909149092490934909449095490964909749098490994910049101491024910349104491054910649107491084910949110491114911249113491144911549116491174911849119491204912149122491234912449125491264912749128491294913049131491324913349134491354913649137491384913949140491414914249143491444914549146491474914849149491504915149152491534915449155491564915749158491594916049161491624916349164491654916649167491684916949170491714917249173491744917549176491774917849179491804918149182491834918449185491864918749188491894919049191491924919349194491954919649197491984919949200492014920249203492044920549206492074920849209492104921149212492134921449215492164921749218492194922049221492224922349224492254922649227492284922949230492314923249233492344923549236492374923849239492404924149242492434924449245492464924749248492494925049251492524925349254492554925649257492584925949260492614926249263492644926549266492674926849269492704927149272492734927449275492764927749278492794928049281492824928349284492854928649287492884928949290492914929249293492944929549296492974929849299493004930149302493034930449305493064930749308493094931049311493124931349314493154931649317493184931949320493214932249323493244932549326493274932849329493304933149332493334933449335493364933749338493394934049341493424934349344493454934649347493484934949350493514935249353493544935549356493574935849359493604936149362493634936449365493664936749368493694937049371493724937349374493754937649377493784937949380493814938249383493844938549386493874938849389493904939149392493934939449395493964939749398493994940049401494024940349404494054940649407494084940949410494114941249413494144941549416494174941849419494204942149422494234942449425494264942749428494294943049431494324943349434494354943649437494384943949440494414944249443494444944549446494474944849449494504945149452494534945449455494564945749458494594946049461494624946349464494654946649467494684946949470494714947249473494744947549476494774947849479494804948149482494834948449485494864948749488494894949049491494924949349494494954949649497494984949949500495014950249503495044950549506495074950849509495104951149512495134951449515495164951749518495194952049521495224952349524495254952649527495284952949530495314953249533495344953549536495374953849539495404954149542495434954449545495464954749548495494955049551495524955349554495554955649557495584955949560495614956249563495644956549566495674956849569495704957149572495734957449575495764957749578495794958049581495824958349584495854958649587495884958949590495914959249593495944959549596495974959849599496004960149602496034960449605496064960749608496094961049611496124961349614496154961649617496184961949620496214962249623496244962549626496274962849629496304963149632496334963449635496364963749638496394964049641496424964349644496454964649647496484964949650496514965249653496544965549656496574965849659496604966149662496634966449665496664966749668496694967049671496724967349674496754967649677496784967949680496814968249683496844968549686496874968849689496904969149692496934969449695496964969749698496994970049701497024970349704497054970649707497084970949710497114971249713497144971549716497174971849719497204972149722497234972449725497264972749728497294973049731497324973349734497354973649737497384973949740497414974249743497444974549746497474974849749497504975149752497534975449755497564975749758497594976049761497624976349764497654976649767497684976949770497714977249773497744977549776497774977849779497804978149782497834978449785497864978749788497894979049791497924979349794497954979649797497984979949800498014980249803498044980549806498074980849809498104981149812498134981449815498164981749818498194982049821498224982349824498254982649827498284982949830498314983249833498344983549836498374983849839498404984149842498434984449845498464984749848498494985049851498524985349854498554985649857498584985949860498614986249863498644986549866498674986849869498704987149872498734987449875498764987749878498794988049881498824988349884498854988649887498884988949890498914989249893498944989549896498974989849899499004990149902499034990449905499064990749908499094991049911499124991349914499154991649917499184991949920499214992249923499244992549926499274992849929499304993149932499334993449935499364993749938499394994049941499424994349944499454994649947499484994949950499514995249953499544995549956499574995849959499604996149962499634996449965499664996749968499694997049971499724997349974499754997649977499784997949980499814998249983499844998549986499874998849989499904999149992499934999449995499964999749998499995000050001500025000350004500055000650007500085000950010500115001250013500145001550016500175001850019500205002150022500235002450025500265002750028500295003050031500325003350034500355003650037500385003950040500415004250043500445004550046500475004850049500505005150052500535005450055500565005750058500595006050061500625006350064500655006650067500685006950070500715007250073500745007550076500775007850079500805008150082500835008450085500865008750088500895009050091500925009350094500955009650097500985009950100501015010250103501045010550106501075010850109501105011150112501135011450115501165011750118501195012050121501225012350124501255012650127501285012950130501315013250133501345013550136501375013850139501405014150142501435014450145501465014750148501495015050151501525015350154501555015650157501585015950160501615016250163501645016550166501675016850169501705017150172501735017450175501765017750178501795018050181501825018350184501855018650187501885018950190501915019250193501945019550196501975019850199502005020150202502035020450205502065020750208502095021050211502125021350214502155021650217502185021950220502215022250223502245022550226502275022850229502305023150232502335023450235502365023750238502395024050241502425024350244502455024650247502485024950250502515025250253502545025550256502575025850259502605026150262502635026450265502665026750268502695027050271502725027350274502755027650277502785027950280502815028250283502845028550286502875028850289502905029150292502935029450295502965029750298502995030050301503025030350304503055030650307503085030950310503115031250313503145031550316503175031850319503205032150322503235032450325503265032750328503295033050331503325033350334503355033650337503385033950340503415034250343503445034550346503475034850349503505035150352503535035450355503565035750358503595036050361503625036350364503655036650367503685036950370503715037250373503745037550376503775037850379503805038150382503835038450385503865038750388503895039050391503925039350394503955039650397503985039950400504015040250403504045040550406504075040850409504105041150412504135041450415504165041750418504195042050421504225042350424504255042650427504285042950430504315043250433504345043550436504375043850439504405044150442504435044450445504465044750448504495045050451504525045350454504555045650457504585045950460504615046250463504645046550466504675046850469504705047150472504735047450475504765047750478504795048050481504825048350484504855048650487504885048950490504915049250493504945049550496504975049850499505005050150502505035050450505505065050750508505095051050511505125051350514505155051650517505185051950520505215052250523505245052550526505275052850529505305053150532505335053450535505365053750538505395054050541505425054350544505455054650547505485054950550505515055250553505545055550556505575055850559505605056150562505635056450565505665056750568505695057050571505725057350574505755057650577505785057950580505815058250583505845058550586505875058850589505905059150592505935059450595505965059750598505995060050601506025060350604506055060650607506085060950610506115061250613506145061550616506175061850619506205062150622506235062450625506265062750628506295063050631506325063350634506355063650637506385063950640506415064250643506445064550646506475064850649506505065150652506535065450655506565065750658506595066050661506625066350664506655066650667506685066950670506715067250673506745067550676506775067850679506805068150682506835068450685506865068750688506895069050691506925069350694506955069650697506985069950700507015070250703507045070550706507075070850709507105071150712507135071450715507165071750718507195072050721507225072350724507255072650727507285072950730507315073250733507345073550736507375073850739507405074150742507435074450745507465074750748507495075050751507525075350754507555075650757507585075950760507615076250763507645076550766507675076850769507705077150772507735077450775507765077750778507795078050781507825078350784507855078650787507885078950790507915079250793507945079550796507975079850799508005080150802508035080450805508065080750808508095081050811508125081350814508155081650817508185081950820508215082250823508245082550826508275082850829508305083150832508335083450835508365083750838508395084050841508425084350844508455084650847508485084950850508515085250853508545085550856508575085850859508605086150862508635086450865508665086750868508695087050871508725087350874508755087650877508785087950880508815088250883508845088550886508875088850889508905089150892508935089450895508965089750898508995090050901509025090350904509055090650907509085090950910509115091250913509145091550916509175091850919509205092150922509235092450925509265092750928509295093050931509325093350934509355093650937509385093950940509415094250943509445094550946509475094850949509505095150952509535095450955509565095750958509595096050961509625096350964509655096650967509685096950970509715097250973509745097550976509775097850979509805098150982509835098450985509865098750988509895099050991509925099350994509955099650997509985099951000510015100251003510045100551006510075100851009510105101151012510135101451015510165101751018510195102051021510225102351024510255102651027510285102951030510315103251033510345103551036510375103851039510405104151042510435104451045510465104751048510495105051051510525105351054510555105651057510585105951060510615106251063510645106551066510675106851069510705107151072510735107451075510765107751078510795108051081510825108351084510855108651087510885108951090510915109251093510945109551096510975109851099511005110151102511035110451105511065110751108511095111051111511125111351114511155111651117511185111951120511215112251123511245112551126511275112851129511305113151132511335113451135511365113751138511395114051141511425114351144511455114651147511485114951150511515115251153511545115551156511575115851159511605116151162511635116451165511665116751168511695117051171511725117351174511755117651177511785117951180511815118251183511845118551186511875118851189511905119151192511935119451195511965119751198511995120051201512025120351204512055120651207512085120951210512115121251213512145121551216512175121851219512205122151222512235122451225512265122751228512295123051231512325123351234512355123651237512385123951240512415124251243512445124551246512475124851249512505125151252512535125451255512565125751258512595126051261512625126351264512655126651267512685126951270512715127251273512745127551276512775127851279512805128151282512835128451285512865128751288512895129051291512925129351294512955129651297512985129951300513015130251303513045130551306513075130851309513105131151312513135131451315513165131751318513195132051321513225132351324513255132651327513285132951330513315133251333513345133551336513375133851339513405134151342513435134451345513465134751348513495135051351513525135351354513555135651357513585135951360513615136251363513645136551366513675136851369513705137151372513735137451375513765137751378513795138051381513825138351384513855138651387513885138951390513915139251393513945139551396513975139851399514005140151402514035140451405514065140751408514095141051411514125141351414514155141651417514185141951420514215142251423514245142551426514275142851429514305143151432514335143451435514365143751438514395144051441514425144351444514455144651447514485144951450514515145251453514545145551456514575145851459514605146151462514635146451465514665146751468514695147051471514725147351474514755147651477514785147951480514815148251483514845148551486514875148851489514905149151492514935149451495514965149751498514995150051501515025150351504515055150651507515085150951510515115151251513515145151551516515175151851519515205152151522515235152451525515265152751528515295153051531515325153351534515355153651537515385153951540515415154251543515445154551546515475154851549515505155151552515535155451555515565155751558515595156051561515625156351564515655156651567515685156951570515715157251573515745157551576515775157851579515805158151582515835158451585515865158751588515895159051591515925159351594515955159651597515985159951600516015160251603516045160551606516075160851609516105161151612516135161451615516165161751618516195162051621516225162351624516255162651627516285162951630516315163251633516345163551636516375163851639516405164151642516435164451645516465164751648516495165051651516525165351654516555165651657516585165951660516615166251663516645166551666516675166851669516705167151672516735167451675516765167751678516795168051681516825168351684516855168651687516885168951690516915169251693516945169551696516975169851699517005170151702517035170451705517065170751708517095171051711517125171351714517155171651717517185171951720517215172251723517245172551726517275172851729517305173151732517335173451735517365173751738517395174051741517425174351744517455174651747517485174951750517515175251753517545175551756517575175851759517605176151762517635176451765517665176751768517695177051771517725177351774517755177651777517785177951780517815178251783517845178551786517875178851789517905179151792517935179451795517965179751798517995180051801518025180351804518055180651807518085180951810518115181251813518145181551816518175181851819518205182151822518235182451825518265182751828518295183051831518325183351834518355183651837518385183951840518415184251843518445184551846518475184851849518505185151852518535185451855518565185751858518595186051861518625186351864518655186651867518685186951870518715187251873518745187551876518775187851879518805188151882518835188451885518865188751888518895189051891518925189351894518955189651897518985189951900519015190251903519045190551906519075190851909519105191151912519135191451915519165191751918519195192051921519225192351924519255192651927519285192951930519315193251933519345193551936519375193851939519405194151942519435194451945519465194751948519495195051951519525195351954519555195651957519585195951960519615196251963519645196551966519675196851969519705197151972519735197451975519765197751978519795198051981519825198351984519855198651987519885198951990519915199251993519945199551996519975199851999520005200152002520035200452005520065200752008520095201052011520125201352014520155201652017520185201952020520215202252023520245202552026520275202852029520305203152032520335203452035520365203752038520395204052041520425204352044520455204652047520485204952050520515205252053520545205552056520575205852059520605206152062520635206452065520665206752068520695207052071520725207352074520755207652077520785207952080520815208252083520845208552086520875208852089520905209152092520935209452095520965209752098520995210052101521025210352104521055210652107521085210952110521115211252113521145211552116521175211852119521205212152122521235212452125521265212752128521295213052131521325213352134521355213652137521385213952140521415214252143521445214552146521475214852149521505215152152521535215452155521565215752158521595216052161521625216352164521655216652167521685216952170521715217252173521745217552176521775217852179521805218152182521835218452185521865218752188521895219052191521925219352194521955219652197521985219952200522015220252203522045220552206522075220852209522105221152212522135221452215522165221752218522195222052221522225222352224522255222652227522285222952230522315223252233522345223552236522375223852239522405224152242522435224452245522465224752248522495225052251522525225352254522555225652257522585225952260522615226252263522645226552266522675226852269522705227152272522735227452275522765227752278522795228052281522825228352284522855228652287522885228952290522915229252293522945229552296522975229852299523005230152302523035230452305523065230752308523095231052311523125231352314523155231652317523185231952320523215232252323523245232552326523275232852329523305233152332523335233452335523365233752338523395234052341523425234352344523455234652347523485234952350523515235252353523545235552356523575235852359523605236152362523635236452365523665236752368523695237052371523725237352374523755237652377523785237952380523815238252383523845238552386523875238852389523905239152392523935239452395523965239752398523995240052401524025240352404524055240652407524085240952410524115241252413524145241552416524175241852419524205242152422524235242452425524265242752428524295243052431524325243352434524355243652437524385243952440524415244252443524445244552446524475244852449524505245152452524535245452455524565245752458524595246052461524625246352464524655246652467524685246952470524715247252473524745247552476524775247852479524805248152482524835248452485524865248752488524895249052491524925249352494524955249652497524985249952500525015250252503525045250552506525075250852509525105251152512525135251452515525165251752518525195252052521525225252352524525255252652527525285252952530525315253252533525345253552536525375253852539525405254152542525435254452545525465254752548525495255052551525525255352554525555255652557525585255952560525615256252563525645256552566525675256852569525705257152572525735257452575525765257752578525795258052581525825258352584525855258652587525885258952590525915259252593525945259552596525975259852599526005260152602526035260452605526065260752608526095261052611526125261352614526155261652617526185261952620526215262252623526245262552626526275262852629526305263152632526335263452635526365263752638526395264052641526425264352644526455264652647526485264952650526515265252653526545265552656526575265852659526605266152662526635266452665526665266752668526695267052671526725267352674526755267652677526785267952680526815268252683526845268552686526875268852689526905269152692526935269452695526965269752698526995270052701527025270352704527055270652707527085270952710527115271252713527145271552716527175271852719527205272152722527235272452725527265272752728527295273052731527325273352734527355273652737527385273952740527415274252743527445274552746527475274852749527505275152752527535275452755527565275752758527595276052761527625276352764527655276652767527685276952770527715277252773527745277552776527775277852779527805278152782527835278452785527865278752788527895279052791527925279352794527955279652797527985279952800528015280252803528045280552806528075280852809528105281152812528135281452815528165281752818528195282052821528225282352824528255282652827528285282952830528315283252833528345283552836528375283852839528405284152842528435284452845528465284752848528495285052851528525285352854528555285652857528585285952860528615286252863528645286552866528675286852869528705287152872528735287452875528765287752878528795288052881528825288352884528855288652887528885288952890528915289252893528945289552896528975289852899529005290152902529035290452905529065290752908529095291052911529125291352914529155291652917529185291952920529215292252923529245292552926529275292852929529305293152932529335293452935529365293752938529395294052941529425294352944529455294652947529485294952950529515295252953529545295552956529575295852959529605296152962529635296452965529665296752968529695297052971529725297352974529755297652977529785297952980529815298252983529845298552986529875298852989529905299152992529935299452995529965299752998529995300053001530025300353004530055300653007530085300953010530115301253013530145301553016530175301853019530205302153022530235302453025530265302753028530295303053031530325303353034530355303653037530385303953040530415304253043530445304553046530475304853049530505305153052530535305453055530565305753058530595306053061530625306353064530655306653067530685306953070530715307253073530745307553076530775307853079530805308153082530835308453085530865308753088530895309053091530925309353094530955309653097530985309953100531015310253103531045310553106531075310853109531105311153112531135311453115531165311753118531195312053121531225312353124531255312653127531285312953130531315313253133531345313553136531375313853139531405314153142531435314453145531465314753148531495315053151531525315353154531555315653157531585315953160531615316253163531645316553166531675316853169531705317153172531735317453175531765317753178531795318053181531825318353184531855318653187531885318953190531915319253193531945319553196531975319853199532005320153202532035320453205532065320753208532095321053211532125321353214532155321653217532185321953220532215322253223532245322553226532275322853229532305323153232532335323453235532365323753238532395324053241532425324353244532455324653247532485324953250532515325253253532545325553256532575325853259532605326153262532635326453265532665326753268532695327053271532725327353274532755327653277532785327953280532815328253283532845328553286532875328853289532905329153292532935329453295532965329753298532995330053301533025330353304533055330653307533085330953310533115331253313533145331553316533175331853319533205332153322533235332453325533265332753328533295333053331533325333353334533355333653337533385333953340533415334253343533445334553346533475334853349533505335153352533535335453355533565335753358533595336053361533625336353364533655336653367533685336953370533715337253373533745337553376533775337853379533805338153382533835338453385533865338753388533895339053391533925339353394533955339653397533985339953400534015340253403534045340553406534075340853409534105341153412534135341453415534165341753418534195342053421534225342353424534255342653427534285342953430534315343253433534345343553436534375343853439534405344153442534435344453445534465344753448534495345053451534525345353454534555345653457534585345953460534615346253463534645346553466534675346853469534705347153472534735347453475534765347753478534795348053481534825348353484534855348653487534885348953490534915349253493534945349553496534975349853499535005350153502535035350453505535065350753508535095351053511535125351353514535155351653517535185351953520535215352253523535245352553526535275352853529535305353153532535335353453535535365353753538535395354053541535425354353544535455354653547535485354953550535515355253553535545355553556535575355853559535605356153562535635356453565535665356753568535695357053571535725357353574535755357653577535785357953580535815358253583535845358553586535875358853589535905359153592535935359453595535965359753598535995360053601536025360353604536055360653607536085360953610536115361253613536145361553616536175361853619536205362153622536235362453625536265362753628536295363053631536325363353634536355363653637536385363953640536415364253643536445364553646536475364853649536505365153652536535365453655536565365753658536595366053661536625366353664536655366653667536685366953670536715367253673536745367553676536775367853679536805368153682536835368453685536865368753688536895369053691536925369353694536955369653697536985369953700537015370253703537045370553706537075370853709537105371153712537135371453715537165371753718537195372053721537225372353724537255372653727537285372953730537315373253733537345373553736537375373853739537405374153742537435374453745537465374753748537495375053751537525375353754537555375653757537585375953760537615376253763537645376553766537675376853769537705377153772537735377453775537765377753778537795378053781537825378353784537855378653787537885378953790537915379253793537945379553796537975379853799538005380153802538035380453805538065380753808538095381053811538125381353814538155381653817538185381953820538215382253823538245382553826538275382853829538305383153832538335383453835538365383753838538395384053841538425384353844538455384653847538485384953850538515385253853538545385553856538575385853859538605386153862538635386453865538665386753868538695387053871538725387353874538755387653877538785387953880538815388253883538845388553886538875388853889538905389153892538935389453895538965389753898538995390053901539025390353904539055390653907539085390953910539115391253913539145391553916539175391853919539205392153922539235392453925539265392753928539295393053931539325393353934539355393653937539385393953940539415394253943539445394553946539475394853949539505395153952539535395453955539565395753958539595396053961539625396353964539655396653967539685396953970539715397253973539745397553976539775397853979539805398153982539835398453985539865398753988539895399053991539925399353994539955399653997539985399954000540015400254003540045400554006540075400854009540105401154012540135401454015540165401754018540195402054021540225402354024540255402654027540285402954030540315403254033540345403554036540375403854039540405404154042540435404454045540465404754048540495405054051540525405354054540555405654057540585405954060540615406254063540645406554066540675406854069540705407154072540735407454075540765407754078540795408054081540825408354084540855408654087540885408954090540915409254093540945409554096540975409854099541005410154102541035410454105541065410754108541095411054111541125411354114541155411654117541185411954120541215412254123541245412554126541275412854129541305413154132541335413454135541365413754138541395414054141541425414354144541455414654147541485414954150541515415254153541545415554156541575415854159541605416154162541635416454165541665416754168541695417054171541725417354174541755417654177541785417954180541815418254183541845418554186541875418854189541905419154192541935419454195541965419754198541995420054201542025420354204542055420654207542085420954210542115421254213542145421554216542175421854219542205422154222542235422454225542265422754228542295423054231542325423354234542355423654237542385423954240542415424254243542445424554246542475424854249542505425154252542535425454255542565425754258542595426054261542625426354264542655426654267542685426954270542715427254273542745427554276542775427854279542805428154282542835428454285542865428754288542895429054291542925429354294542955429654297542985429954300543015430254303543045430554306543075430854309543105431154312543135431454315543165431754318543195432054321543225432354324543255432654327543285432954330543315433254333543345433554336543375433854339543405434154342543435434454345543465434754348543495435054351543525435354354543555435654357543585435954360543615436254363543645436554366543675436854369543705437154372543735437454375543765437754378543795438054381543825438354384543855438654387543885438954390543915439254393543945439554396543975439854399544005440154402544035440454405544065440754408544095441054411544125441354414544155441654417544185441954420544215442254423544245442554426544275442854429544305443154432544335443454435544365443754438544395444054441544425444354444544455444654447544485444954450544515445254453544545445554456544575445854459544605446154462544635446454465544665446754468544695447054471544725447354474544755447654477544785447954480544815448254483544845448554486544875448854489544905449154492544935449454495544965449754498544995450054501545025450354504545055450654507545085450954510545115451254513545145451554516545175451854519545205452154522545235452454525545265452754528545295453054531545325453354534545355453654537545385453954540545415454254543545445454554546545475454854549545505455154552545535455454555545565455754558545595456054561545625456354564545655456654567545685456954570545715457254573545745457554576545775457854579545805458154582545835458454585545865458754588545895459054591545925459354594545955459654597545985459954600546015460254603546045460554606546075460854609546105461154612546135461454615546165461754618546195462054621546225462354624546255462654627546285462954630546315463254633546345463554636546375463854639546405464154642546435464454645546465464754648546495465054651546525465354654546555465654657546585465954660546615466254663546645466554666546675466854669546705467154672546735467454675546765467754678546795468054681546825468354684546855468654687546885468954690546915469254693546945469554696546975469854699547005470154702547035470454705547065470754708547095471054711547125471354714547155471654717547185471954720547215472254723547245472554726547275472854729547305473154732547335473454735547365473754738547395474054741547425474354744547455474654747547485474954750547515475254753547545475554756547575475854759547605476154762547635476454765547665476754768547695477054771547725477354774547755477654777547785477954780547815478254783547845478554786547875478854789547905479154792547935479454795547965479754798547995480054801548025480354804548055480654807548085480954810548115481254813548145481554816548175481854819548205482154822548235482454825548265482754828548295483054831548325483354834548355483654837548385483954840548415484254843548445484554846548475484854849548505485154852548535485454855548565485754858548595486054861548625486354864548655486654867548685486954870548715487254873548745487554876548775487854879548805488154882548835488454885548865488754888548895489054891548925489354894548955489654897548985489954900549015490254903549045490554906549075490854909549105491154912549135491454915549165491754918549195492054921549225492354924549255492654927549285492954930549315493254933549345493554936549375493854939549405494154942549435494454945549465494754948549495495054951549525495354954549555495654957549585495954960549615496254963549645496554966549675496854969549705497154972549735497454975549765497754978549795498054981549825498354984549855498654987549885498954990549915499254993549945499554996549975499854999550005500155002550035500455005550065500755008550095501055011550125501355014550155501655017550185501955020550215502255023550245502555026550275502855029550305503155032550335503455035550365503755038550395504055041550425504355044550455504655047550485504955050550515505255053550545505555056550575505855059550605506155062550635506455065550665506755068550695507055071550725507355074550755507655077550785507955080550815508255083550845508555086550875508855089550905509155092550935509455095550965509755098550995510055101551025510355104551055510655107551085510955110551115511255113551145511555116551175511855119551205512155122551235512455125551265512755128551295513055131551325513355134551355513655137551385513955140551415514255143551445514555146551475514855149551505515155152551535515455155551565515755158551595516055161551625516355164551655516655167551685516955170551715517255173551745517555176551775517855179551805518155182551835518455185551865518755188551895519055191551925519355194551955519655197551985519955200552015520255203552045520555206552075520855209552105521155212552135521455215552165521755218552195522055221552225522355224552255522655227552285522955230552315523255233552345523555236552375523855239552405524155242552435524455245552465524755248552495525055251552525525355254552555525655257552585525955260552615526255263552645526555266552675526855269552705527155272552735527455275552765527755278552795528055281552825528355284552855528655287552885528955290552915529255293552945529555296552975529855299553005530155302553035530455305553065530755308553095531055311553125531355314553155531655317553185531955320553215532255323553245532555326553275532855329553305533155332553335533455335553365533755338553395534055341553425534355344553455534655347553485534955350553515535255353553545535555356553575535855359553605536155362553635536455365553665536755368553695537055371553725537355374553755537655377553785537955380553815538255383553845538555386553875538855389553905539155392553935539455395553965539755398553995540055401554025540355404554055540655407554085540955410554115541255413554145541555416554175541855419554205542155422554235542455425554265542755428554295543055431554325543355434554355543655437554385543955440554415544255443554445544555446554475544855449554505545155452554535545455455554565545755458554595546055461554625546355464554655546655467554685546955470554715547255473554745547555476554775547855479554805548155482554835548455485554865548755488554895549055491554925549355494554955549655497554985549955500555015550255503555045550555506555075550855509555105551155512555135551455515555165551755518555195552055521555225552355524555255552655527555285552955530555315553255533555345553555536555375553855539555405554155542555435554455545555465554755548555495555055551555525555355554555555555655557555585555955560555615556255563555645556555566555675556855569555705557155572555735557455575555765557755578555795558055581555825558355584555855558655587555885558955590555915559255593555945559555596555975559855599556005560155602556035560455605556065560755608556095561055611556125561355614556155561655617556185561955620556215562255623556245562555626556275562855629556305563155632556335563455635556365563755638556395564055641556425564355644556455564655647556485564955650556515565255653556545565555656556575565855659556605566155662556635566455665556665566755668556695567055671556725567355674556755567655677556785567955680556815568255683556845568555686556875568855689556905569155692556935569455695556965569755698556995570055701557025570355704557055570655707557085570955710557115571255713557145571555716557175571855719557205572155722557235572455725557265572755728557295573055731557325573355734557355573655737557385573955740557415574255743557445574555746557475574855749557505575155752557535575455755557565575755758557595576055761557625576355764557655576655767557685576955770557715577255773557745577555776557775577855779557805578155782557835578455785557865578755788557895579055791557925579355794557955579655797557985579955800558015580255803558045580555806558075580855809558105581155812558135581455815558165581755818558195582055821558225582355824558255582655827558285582955830558315583255833558345583555836558375583855839558405584155842558435584455845558465584755848558495585055851558525585355854558555585655857558585585955860558615586255863558645586555866558675586855869558705587155872558735587455875558765587755878558795588055881558825588355884558855588655887558885588955890558915589255893558945589555896558975589855899559005590155902559035590455905559065590755908559095591055911559125591355914559155591655917559185591955920559215592255923559245592555926559275592855929559305593155932559335593455935559365593755938559395594055941559425594355944559455594655947559485594955950559515595255953559545595555956559575595855959559605596155962559635596455965559665596755968559695597055971559725597355974559755597655977559785597955980559815598255983559845598555986559875598855989559905599155992559935599455995559965599755998559995600056001560025600356004560055600656007560085600956010560115601256013560145601556016560175601856019560205602156022560235602456025560265602756028560295603056031560325603356034560355603656037560385603956040560415604256043560445604556046560475604856049560505605156052560535605456055560565605756058560595606056061560625606356064560655606656067560685606956070560715607256073560745607556076560775607856079560805608156082560835608456085560865608756088560895609056091560925609356094560955609656097560985609956100561015610256103561045610556106561075610856109561105611156112561135611456115561165611756118561195612056121561225612356124561255612656127561285612956130561315613256133561345613556136561375613856139561405614156142561435614456145561465614756148561495615056151561525615356154561555615656157561585615956160561615616256163561645616556166561675616856169561705617156172561735617456175561765617756178561795618056181561825618356184561855618656187561885618956190561915619256193561945619556196561975619856199562005620156202562035620456205562065620756208562095621056211562125621356214562155621656217562185621956220562215622256223562245622556226562275622856229562305623156232562335623456235562365623756238562395624056241562425624356244562455624656247562485624956250562515625256253562545625556256562575625856259562605626156262562635626456265562665626756268562695627056271562725627356274562755627656277562785627956280562815628256283562845628556286562875628856289562905629156292562935629456295562965629756298562995630056301563025630356304563055630656307563085630956310563115631256313563145631556316563175631856319563205632156322563235632456325563265632756328563295633056331563325633356334563355633656337563385633956340563415634256343563445634556346563475634856349563505635156352563535635456355563565635756358563595636056361563625636356364563655636656367563685636956370563715637256373563745637556376563775637856379563805638156382563835638456385563865638756388563895639056391563925639356394563955639656397563985639956400564015640256403564045640556406564075640856409564105641156412564135641456415564165641756418564195642056421564225642356424564255642656427564285642956430564315643256433564345643556436564375643856439564405644156442564435644456445564465644756448564495645056451564525645356454564555645656457564585645956460564615646256463564645646556466564675646856469564705647156472564735647456475564765647756478564795648056481564825648356484564855648656487564885648956490564915649256493564945649556496564975649856499565005650156502565035650456505565065650756508565095651056511565125651356514565155651656517565185651956520565215652256523565245652556526565275652856529565305653156532565335653456535565365653756538565395654056541565425654356544565455654656547565485654956550565515655256553565545655556556565575655856559565605656156562565635656456565565665656756568565695657056571565725657356574565755657656577565785657956580565815658256583565845658556586565875658856589565905659156592565935659456595565965659756598565995660056601566025660356604566055660656607566085660956610566115661256613566145661556616566175661856619566205662156622566235662456625566265662756628566295663056631566325663356634566355663656637566385663956640566415664256643566445664556646566475664856649566505665156652566535665456655566565665756658566595666056661566625666356664566655666656667566685666956670566715667256673566745667556676566775667856679566805668156682566835668456685566865668756688566895669056691566925669356694566955669656697566985669956700567015670256703567045670556706567075670856709567105671156712567135671456715567165671756718567195672056721567225672356724567255672656727567285672956730567315673256733567345673556736567375673856739567405674156742567435674456745567465674756748567495675056751567525675356754567555675656757567585675956760567615676256763567645676556766567675676856769567705677156772567735677456775567765677756778567795678056781567825678356784567855678656787567885678956790567915679256793567945679556796567975679856799568005680156802568035680456805568065680756808568095681056811568125681356814568155681656817568185681956820568215682256823568245682556826568275682856829568305683156832568335683456835568365683756838568395684056841568425684356844568455684656847568485684956850568515685256853568545685556856568575685856859568605686156862568635686456865568665686756868568695687056871568725687356874568755687656877568785687956880568815688256883568845688556886568875688856889568905689156892568935689456895568965689756898568995690056901569025690356904569055690656907569085690956910569115691256913569145691556916569175691856919569205692156922569235692456925569265692756928569295693056931569325693356934569355693656937569385693956940569415694256943569445694556946569475694856949569505695156952569535695456955569565695756958569595696056961569625696356964569655696656967569685696956970569715697256973569745697556976569775697856979569805698156982569835698456985569865698756988569895699056991569925699356994569955699656997569985699957000570015700257003570045700557006570075700857009570105701157012570135701457015570165701757018570195702057021570225702357024570255702657027570285702957030570315703257033570345703557036570375703857039570405704157042570435704457045570465704757048570495705057051570525705357054570555705657057570585705957060570615706257063570645706557066570675706857069570705707157072570735707457075570765707757078570795708057081570825708357084570855708657087570885708957090570915709257093570945709557096570975709857099571005710157102571035710457105571065710757108571095711057111571125711357114571155711657117571185711957120571215712257123571245712557126571275712857129571305713157132571335713457135571365713757138571395714057141571425714357144571455714657147571485714957150571515715257153571545715557156571575715857159571605716157162571635716457165571665716757168571695717057171571725717357174571755717657177571785717957180571815718257183571845718557186571875718857189571905719157192571935719457195571965719757198571995720057201572025720357204572055720657207572085720957210572115721257213572145721557216572175721857219572205722157222572235722457225572265722757228572295723057231572325723357234572355723657237572385723957240572415724257243572445724557246572475724857249572505725157252572535725457255572565725757258572595726057261572625726357264572655726657267572685726957270572715727257273572745727557276572775727857279572805728157282572835728457285572865728757288572895729057291572925729357294572955729657297572985729957300573015730257303573045730557306573075730857309573105731157312573135731457315573165731757318573195732057321573225732357324573255732657327573285732957330573315733257333573345733557336573375733857339573405734157342573435734457345573465734757348573495735057351573525735357354573555735657357573585735957360573615736257363573645736557366573675736857369573705737157372573735737457375573765737757378573795738057381573825738357384573855738657387573885738957390573915739257393573945739557396573975739857399574005740157402574035740457405574065740757408574095741057411574125741357414574155741657417574185741957420574215742257423574245742557426574275742857429574305743157432574335743457435574365743757438574395744057441574425744357444574455744657447574485744957450574515745257453574545745557456574575745857459574605746157462574635746457465574665746757468574695747057471574725747357474574755747657477574785747957480574815748257483574845748557486574875748857489574905749157492574935749457495574965749757498574995750057501575025750357504575055750657507575085750957510575115751257513575145751557516575175751857519575205752157522575235752457525575265752757528575295753057531575325753357534575355753657537575385753957540575415754257543575445754557546575475754857549575505755157552575535755457555575565755757558575595756057561575625756357564575655756657567575685756957570575715757257573575745757557576575775757857579575805758157582575835758457585575865758757588575895759057591575925759357594575955759657597575985759957600576015760257603576045760557606576075760857609576105761157612576135761457615576165761757618576195762057621576225762357624576255762657627576285762957630576315763257633576345763557636576375763857639576405764157642576435764457645576465764757648576495765057651576525765357654576555765657657576585765957660576615766257663576645766557666576675766857669576705767157672576735767457675576765767757678576795768057681576825768357684576855768657687576885768957690576915769257693576945769557696576975769857699577005770157702577035770457705577065770757708577095771057711577125771357714577155771657717577185771957720577215772257723577245772557726577275772857729577305773157732577335773457735577365773757738577395774057741577425774357744577455774657747577485774957750577515775257753577545775557756577575775857759577605776157762577635776457765577665776757768577695777057771577725777357774577755777657777577785777957780577815778257783577845778557786577875778857789577905779157792577935779457795577965779757798577995780057801578025780357804578055780657807578085780957810578115781257813578145781557816578175781857819578205782157822578235782457825578265782757828578295783057831578325783357834578355783657837578385783957840578415784257843578445784557846578475784857849578505785157852578535785457855578565785757858578595786057861578625786357864578655786657867578685786957870578715787257873578745787557876578775787857879578805788157882578835788457885578865788757888578895789057891578925789357894578955789657897578985789957900579015790257903579045790557906579075790857909579105791157912579135791457915579165791757918579195792057921579225792357924579255792657927579285792957930579315793257933579345793557936579375793857939579405794157942579435794457945579465794757948579495795057951579525795357954579555795657957579585795957960579615796257963579645796557966579675796857969579705797157972579735797457975579765797757978579795798057981579825798357984579855798657987579885798957990579915799257993579945799557996579975799857999580005800158002580035800458005580065800758008580095801058011580125801358014580155801658017580185801958020580215802258023580245802558026580275802858029580305803158032580335803458035580365803758038580395804058041580425804358044580455804658047580485804958050580515805258053580545805558056580575805858059580605806158062580635806458065580665806758068580695807058071580725807358074580755807658077580785807958080580815808258083580845808558086580875808858089580905809158092580935809458095580965809758098580995810058101581025810358104581055810658107581085810958110581115811258113581145811558116581175811858119581205812158122581235812458125581265812758128581295813058131581325813358134581355813658137581385813958140581415814258143581445814558146581475814858149581505815158152581535815458155581565815758158581595816058161581625816358164581655816658167581685816958170581715817258173581745817558176581775817858179581805818158182581835818458185581865818758188581895819058191581925819358194581955819658197581985819958200582015820258203582045820558206582075820858209582105821158212582135821458215582165821758218582195822058221582225822358224582255822658227582285822958230582315823258233582345823558236582375823858239582405824158242582435824458245582465824758248582495825058251582525825358254582555825658257582585825958260582615826258263582645826558266582675826858269582705827158272582735827458275582765827758278582795828058281582825828358284582855828658287582885828958290582915829258293582945829558296582975829858299583005830158302583035830458305583065830758308583095831058311583125831358314583155831658317583185831958320583215832258323583245832558326583275832858329583305833158332583335833458335583365833758338583395834058341583425834358344583455834658347583485834958350583515835258353583545835558356583575835858359583605836158362583635836458365583665836758368583695837058371583725837358374583755837658377583785837958380583815838258383583845838558386583875838858389583905839158392583935839458395583965839758398583995840058401584025840358404584055840658407584085840958410584115841258413584145841558416584175841858419584205842158422584235842458425584265842758428584295843058431584325843358434584355843658437584385843958440584415844258443584445844558446584475844858449584505845158452584535845458455584565845758458584595846058461584625846358464584655846658467584685846958470584715847258473584745847558476584775847858479584805848158482584835848458485584865848758488584895849058491584925849358494584955849658497584985849958500585015850258503585045850558506585075850858509585105851158512585135851458515585165851758518585195852058521585225852358524585255852658527585285852958530585315853258533585345853558536585375853858539585405854158542585435854458545585465854758548585495855058551585525855358554585555855658557585585855958560585615856258563585645856558566585675856858569585705857158572585735857458575585765857758578585795858058581585825858358584585855858658587585885858958590585915859258593585945859558596585975859858599586005860158602586035860458605586065860758608586095861058611586125861358614586155861658617586185861958620586215862258623586245862558626586275862858629586305863158632586335863458635586365863758638586395864058641586425864358644586455864658647586485864958650586515865258653586545865558656586575865858659586605866158662586635866458665586665866758668586695867058671586725867358674586755867658677586785867958680586815868258683586845868558686586875868858689586905869158692586935869458695586965869758698586995870058701587025870358704587055870658707587085870958710587115871258713587145871558716587175871858719587205872158722587235872458725587265872758728587295873058731587325873358734587355873658737587385873958740587415874258743587445874558746587475874858749587505875158752587535875458755587565875758758587595876058761587625876358764587655876658767587685876958770587715877258773587745877558776587775877858779587805878158782587835878458785587865878758788587895879058791587925879358794587955879658797587985879958800588015880258803588045880558806588075880858809588105881158812588135881458815588165881758818588195882058821588225882358824588255882658827588285882958830588315883258833588345883558836588375883858839588405884158842588435884458845588465884758848588495885058851588525885358854588555885658857588585885958860588615886258863588645886558866588675886858869588705887158872588735887458875588765887758878588795888058881588825888358884588855888658887588885888958890588915889258893588945889558896588975889858899589005890158902589035890458905589065890758908589095891058911589125891358914589155891658917589185891958920589215892258923589245892558926589275892858929589305893158932589335893458935589365893758938589395894058941589425894358944589455894658947589485894958950589515895258953589545895558956589575895858959589605896158962589635896458965589665896758968589695897058971589725897358974589755897658977589785897958980589815898258983589845898558986589875898858989589905899158992589935899458995589965899758998589995900059001590025900359004590055900659007590085900959010590115901259013590145901559016590175901859019590205902159022590235902459025590265902759028590295903059031590325903359034590355903659037590385903959040590415904259043590445904559046590475904859049590505905159052590535905459055590565905759058590595906059061590625906359064590655906659067590685906959070590715907259073590745907559076590775907859079590805908159082590835908459085590865908759088590895909059091590925909359094590955909659097590985909959100591015910259103591045910559106591075910859109591105911159112591135911459115591165911759118591195912059121591225912359124591255912659127591285912959130591315913259133591345913559136591375913859139591405914159142591435914459145591465914759148591495915059151591525915359154591555915659157591585915959160591615916259163591645916559166591675916859169591705917159172591735917459175591765917759178591795918059181591825918359184591855918659187591885918959190591915919259193591945919559196591975919859199592005920159202592035920459205592065920759208592095921059211592125921359214592155921659217592185921959220592215922259223592245922559226592275922859229592305923159232592335923459235592365923759238592395924059241592425924359244592455924659247592485924959250592515925259253592545925559256592575925859259592605926159262592635926459265592665926759268592695927059271592725927359274592755927659277592785927959280592815928259283592845928559286592875928859289592905929159292592935929459295592965929759298592995930059301593025930359304593055930659307593085930959310593115931259313593145931559316593175931859319593205932159322593235932459325593265932759328593295933059331593325933359334593355933659337593385933959340593415934259343593445934559346593475934859349593505935159352593535935459355593565935759358593595936059361593625936359364593655936659367593685936959370593715937259373593745937559376593775937859379593805938159382593835938459385593865938759388593895939059391593925939359394593955939659397593985939959400594015940259403594045940559406594075940859409594105941159412594135941459415594165941759418594195942059421594225942359424594255942659427594285942959430594315943259433594345943559436594375943859439594405944159442594435944459445594465944759448594495945059451594525945359454594555945659457594585945959460594615946259463594645946559466594675946859469594705947159472594735947459475594765947759478594795948059481594825948359484594855948659487594885948959490594915949259493594945949559496594975949859499595005950159502595035950459505595065950759508595095951059511595125951359514595155951659517595185951959520595215952259523595245952559526595275952859529595305953159532595335953459535595365953759538595395954059541595425954359544595455954659547595485954959550595515955259553595545955559556595575955859559595605956159562595635956459565595665956759568595695957059571595725957359574595755957659577595785957959580595815958259583595845958559586595875958859589595905959159592595935959459595595965959759598595995960059601596025960359604596055960659607596085960959610596115961259613596145961559616596175961859619596205962159622596235962459625596265962759628596295963059631596325963359634596355963659637596385963959640596415964259643596445964559646596475964859649596505965159652596535965459655596565965759658596595966059661596625966359664596655966659667596685966959670596715967259673596745967559676596775967859679596805968159682596835968459685596865968759688596895969059691596925969359694596955969659697596985969959700597015970259703597045970559706597075970859709597105971159712597135971459715597165971759718597195972059721597225972359724597255972659727597285972959730597315973259733597345973559736597375973859739597405974159742597435974459745597465974759748597495975059751597525975359754597555975659757597585975959760597615976259763597645976559766597675976859769597705977159772597735977459775597765977759778597795978059781597825978359784597855978659787597885978959790597915979259793597945979559796597975979859799598005980159802598035980459805598065980759808598095981059811598125981359814598155981659817598185981959820598215982259823598245982559826598275982859829598305983159832598335983459835598365983759838598395984059841598425984359844598455984659847598485984959850598515985259853598545985559856598575985859859598605986159862598635986459865598665986759868598695987059871598725987359874598755987659877598785987959880598815988259883598845988559886598875988859889598905989159892598935989459895598965989759898598995990059901599025990359904599055990659907599085990959910599115991259913599145991559916599175991859919599205992159922599235992459925599265992759928599295993059931599325993359934599355993659937599385993959940599415994259943599445994559946599475994859949599505995159952599535995459955599565995759958599595996059961599625996359964599655996659967599685996959970599715997259973599745997559976599775997859979599805998159982599835998459985599865998759988599895999059991599925999359994599955999659997599985999960000600016000260003600046000560006600076000860009600106001160012600136001460015600166001760018600196002060021600226002360024600256002660027600286002960030600316003260033600346003560036600376003860039600406004160042600436004460045600466004760048600496005060051600526005360054600556005660057600586005960060600616006260063600646006560066600676006860069600706007160072600736007460075600766007760078600796008060081600826008360084600856008660087600886008960090600916009260093600946009560096600976009860099601006010160102601036010460105601066010760108601096011060111601126011360114601156011660117601186011960120601216012260123601246012560126601276012860129601306013160132601336013460135601366013760138601396014060141601426014360144601456014660147601486014960150601516015260153601546015560156601576015860159601606016160162601636016460165601666016760168601696017060171601726017360174601756017660177601786017960180601816018260183601846018560186601876018860189601906019160192601936019460195601966019760198601996020060201602026020360204602056020660207602086020960210602116021260213602146021560216602176021860219602206022160222602236022460225602266022760228602296023060231602326023360234602356023660237602386023960240602416024260243602446024560246602476024860249602506025160252602536025460255602566025760258602596026060261602626026360264602656026660267602686026960270602716027260273602746027560276602776027860279602806028160282602836028460285602866028760288602896029060291602926029360294602956029660297602986029960300603016030260303603046030560306603076030860309603106031160312603136031460315603166031760318603196032060321603226032360324603256032660327603286032960330603316033260333603346033560336603376033860339603406034160342603436034460345603466034760348603496035060351603526035360354603556035660357603586035960360603616036260363603646036560366603676036860369603706037160372603736037460375603766037760378603796038060381603826038360384603856038660387603886038960390603916039260393603946039560396603976039860399604006040160402604036040460405604066040760408604096041060411604126041360414604156041660417604186041960420604216042260423604246042560426604276042860429604306043160432604336043460435604366043760438604396044060441604426044360444604456044660447604486044960450604516045260453604546045560456604576045860459604606046160462604636046460465604666046760468604696047060471604726047360474604756047660477604786047960480604816048260483604846048560486604876048860489604906049160492604936049460495604966049760498604996050060501605026050360504605056050660507605086050960510605116051260513605146051560516605176051860519605206052160522605236052460525605266052760528605296053060531605326053360534605356053660537605386053960540605416054260543605446054560546605476054860549605506055160552605536055460555605566055760558605596056060561605626056360564605656056660567605686056960570605716057260573605746057560576605776057860579605806058160582605836058460585605866058760588605896059060591605926059360594605956059660597605986059960600606016060260603606046060560606606076060860609606106061160612606136061460615606166061760618606196062060621606226062360624606256062660627606286062960630606316063260633606346063560636606376063860639606406064160642606436064460645606466064760648606496065060651606526065360654606556065660657606586065960660606616066260663606646066560666606676066860669606706067160672606736067460675606766067760678606796068060681606826068360684606856068660687606886068960690606916069260693606946069560696606976069860699607006070160702607036070460705607066070760708607096071060711607126071360714607156071660717607186071960720607216072260723607246072560726607276072860729607306073160732607336073460735607366073760738607396074060741607426074360744607456074660747607486074960750607516075260753607546075560756607576075860759607606076160762607636076460765607666076760768607696077060771607726077360774607756077660777607786077960780607816078260783607846078560786607876078860789607906079160792607936079460795607966079760798607996080060801608026080360804608056080660807608086080960810608116081260813608146081560816608176081860819608206082160822608236082460825608266082760828608296083060831608326083360834608356083660837608386083960840608416084260843608446084560846608476084860849608506085160852608536085460855608566085760858608596086060861608626086360864608656086660867608686086960870608716087260873608746087560876608776087860879608806088160882608836088460885608866088760888608896089060891608926089360894608956089660897608986089960900609016090260903609046090560906609076090860909609106091160912609136091460915609166091760918609196092060921609226092360924609256092660927609286092960930609316093260933609346093560936609376093860939609406094160942609436094460945609466094760948609496095060951609526095360954609556095660957609586095960960609616096260963609646096560966609676096860969609706097160972609736097460975609766097760978609796098060981609826098360984609856098660987609886098960990609916099260993609946099560996609976099860999610006100161002610036100461005610066100761008610096101061011610126101361014610156101661017610186101961020610216102261023610246102561026610276102861029610306103161032610336103461035610366103761038610396104061041610426104361044610456104661047610486104961050610516105261053610546105561056610576105861059610606106161062610636106461065610666106761068610696107061071610726107361074610756107661077610786107961080610816108261083610846108561086610876108861089610906109161092610936109461095610966109761098610996110061101611026110361104611056110661107611086110961110611116111261113611146111561116611176111861119611206112161122611236112461125611266112761128611296113061131611326113361134611356113661137611386113961140611416114261143611446114561146611476114861149611506115161152611536115461155611566115761158611596116061161611626116361164611656116661167611686116961170611716117261173611746117561176611776117861179611806118161182611836118461185611866118761188611896119061191611926119361194611956119661197611986119961200612016120261203612046120561206612076120861209612106121161212612136121461215612166121761218612196122061221612226122361224612256122661227612286122961230612316123261233612346123561236612376123861239612406124161242612436124461245612466124761248612496125061251612526125361254612556125661257612586125961260612616126261263612646126561266612676126861269612706127161272612736127461275612766127761278612796128061281612826128361284612856128661287612886128961290612916129261293612946129561296612976129861299613006130161302613036130461305613066130761308613096131061311613126131361314613156131661317613186131961320613216132261323613246132561326613276132861329613306133161332613336133461335613366133761338613396134061341613426134361344613456134661347613486134961350613516135261353613546135561356613576135861359613606136161362613636136461365613666136761368613696137061371613726137361374613756137661377613786137961380613816138261383613846138561386613876138861389613906139161392613936139461395613966139761398613996140061401614026140361404614056140661407614086140961410614116141261413614146141561416614176141861419614206142161422614236142461425614266142761428614296143061431614326143361434614356143661437614386143961440614416144261443614446144561446614476144861449614506145161452614536145461455614566145761458614596146061461614626146361464614656146661467614686146961470614716147261473614746147561476614776147861479614806148161482614836148461485614866148761488614896149061491614926149361494614956149661497614986149961500615016150261503615046150561506615076150861509615106151161512615136151461515615166151761518615196152061521615226152361524615256152661527615286152961530615316153261533615346153561536615376153861539615406154161542615436154461545615466154761548615496155061551615526155361554615556155661557615586155961560615616156261563615646156561566615676156861569615706157161572615736157461575615766157761578615796158061581615826158361584615856158661587615886158961590615916159261593615946159561596615976159861599616006160161602616036160461605616066160761608616096161061611616126161361614616156161661617616186161961620616216162261623616246162561626616276162861629616306163161632616336163461635616366163761638616396164061641616426164361644616456164661647616486164961650616516165261653616546165561656616576165861659616606166161662616636166461665616666166761668616696167061671616726167361674616756167661677616786167961680616816168261683616846168561686616876168861689616906169161692616936169461695616966169761698616996170061701617026170361704617056170661707617086170961710617116171261713617146171561716617176171861719617206172161722617236172461725617266172761728617296173061731617326173361734617356173661737617386173961740617416174261743617446174561746617476174861749617506175161752617536175461755617566175761758617596176061761617626176361764617656176661767617686176961770617716177261773617746177561776617776177861779617806178161782617836178461785617866178761788617896179061791617926179361794617956179661797617986179961800618016180261803618046180561806618076180861809618106181161812618136181461815618166181761818618196182061821618226182361824618256182661827618286182961830618316183261833618346183561836618376183861839618406184161842618436184461845618466184761848618496185061851618526185361854618556185661857618586185961860618616186261863618646186561866618676186861869618706187161872618736187461875618766187761878618796188061881618826188361884618856188661887618886188961890618916189261893618946189561896618976189861899619006190161902619036190461905619066190761908619096191061911619126191361914619156191661917619186191961920619216192261923619246192561926619276192861929619306193161932619336193461935619366193761938619396194061941619426194361944619456194661947619486194961950619516195261953619546195561956619576195861959619606196161962619636196461965619666196761968619696197061971619726197361974619756197661977619786197961980619816198261983619846198561986619876198861989619906199161992619936199461995619966199761998619996200062001620026200362004620056200662007620086200962010620116201262013620146201562016620176201862019620206202162022620236202462025620266202762028620296203062031620326203362034620356203662037620386203962040620416204262043620446204562046620476204862049620506205162052620536205462055620566205762058620596206062061620626206362064620656206662067620686206962070620716207262073620746207562076620776207862079620806208162082620836208462085620866208762088620896209062091620926209362094620956209662097620986209962100621016210262103621046210562106621076210862109621106211162112621136211462115621166211762118621196212062121621226212362124621256212662127621286212962130621316213262133621346213562136621376213862139621406214162142621436214462145621466214762148621496215062151621526215362154621556215662157621586215962160621616216262163621646216562166621676216862169621706217162172621736217462175621766217762178621796218062181621826218362184621856218662187621886218962190621916219262193621946219562196621976219862199622006220162202622036220462205622066220762208622096221062211622126221362214622156221662217622186221962220622216222262223622246222562226622276222862229622306223162232622336223462235622366223762238622396224062241622426224362244622456224662247622486224962250622516225262253622546225562256622576225862259622606226162262622636226462265622666226762268622696227062271622726227362274622756227662277622786227962280622816228262283622846228562286622876228862289622906229162292622936229462295622966229762298622996230062301623026230362304623056230662307623086230962310623116231262313623146231562316623176231862319623206232162322623236232462325623266232762328623296233062331623326233362334623356233662337623386233962340623416234262343623446234562346623476234862349623506235162352623536235462355623566235762358623596236062361623626236362364623656236662367623686236962370623716237262373623746237562376623776237862379623806238162382623836238462385623866238762388623896239062391623926239362394623956239662397623986239962400624016240262403624046240562406624076240862409624106241162412624136241462415624166241762418624196242062421624226242362424624256242662427624286242962430624316243262433624346243562436624376243862439624406244162442624436244462445624466244762448624496245062451624526245362454624556245662457624586245962460624616246262463624646246562466624676246862469624706247162472624736247462475624766247762478624796248062481624826248362484624856248662487624886248962490624916249262493624946249562496624976249862499625006250162502625036250462505625066250762508625096251062511625126251362514625156251662517625186251962520625216252262523625246252562526625276252862529625306253162532625336253462535625366253762538625396254062541625426254362544625456254662547625486254962550625516255262553625546255562556625576255862559625606256162562625636256462565625666256762568625696257062571625726257362574625756257662577625786257962580625816258262583625846258562586625876258862589625906259162592625936259462595625966259762598625996260062601626026260362604626056260662607626086260962610626116261262613626146261562616626176261862619626206262162622626236262462625626266262762628626296263062631626326263362634626356263662637626386263962640626416264262643626446264562646626476264862649626506265162652626536265462655626566265762658626596266062661626626266362664626656266662667626686266962670626716267262673626746267562676626776267862679626806268162682626836268462685626866268762688626896269062691626926269362694626956269662697626986269962700627016270262703627046270562706627076270862709627106271162712627136271462715627166271762718627196272062721627226272362724627256272662727627286272962730627316273262733627346273562736627376273862739627406274162742627436274462745627466274762748627496275062751627526275362754627556275662757627586275962760627616276262763627646276562766627676276862769627706277162772627736277462775627766277762778627796278062781627826278362784627856278662787627886278962790627916279262793627946279562796627976279862799628006280162802628036280462805628066280762808628096281062811628126281362814628156281662817628186281962820628216282262823628246282562826628276282862829628306283162832628336283462835628366283762838628396284062841628426284362844628456284662847628486284962850628516285262853628546285562856628576285862859628606286162862628636286462865628666286762868628696287062871628726287362874628756287662877628786287962880628816288262883628846288562886628876288862889628906289162892628936289462895628966289762898628996290062901629026290362904629056290662907629086290962910629116291262913629146291562916629176291862919629206292162922629236292462925629266292762928629296293062931629326293362934629356293662937629386293962940629416294262943629446294562946629476294862949629506295162952629536295462955629566295762958629596296062961629626296362964629656296662967629686296962970629716297262973629746297562976629776297862979629806298162982629836298462985629866298762988629896299062991629926299362994629956299662997629986299963000630016300263003630046300563006630076300863009630106301163012630136301463015630166301763018630196302063021630226302363024630256302663027630286302963030630316303263033630346303563036630376303863039630406304163042630436304463045630466304763048630496305063051630526305363054630556305663057630586305963060630616306263063630646306563066630676306863069630706307163072630736307463075630766307763078630796308063081630826308363084630856308663087630886308963090630916309263093630946309563096630976309863099631006310163102631036310463105631066310763108631096311063111631126311363114631156311663117631186311963120631216312263123631246312563126631276312863129631306313163132631336313463135631366313763138631396314063141631426314363144631456314663147631486314963150631516315263153631546315563156631576315863159631606316163162631636316463165631666316763168631696317063171631726317363174631756317663177631786317963180631816318263183631846318563186631876318863189631906319163192631936319463195631966319763198631996320063201632026320363204632056320663207632086320963210632116321263213632146321563216632176321863219632206322163222632236322463225632266322763228632296323063231632326323363234632356323663237632386323963240632416324263243632446324563246632476324863249632506325163252632536325463255632566325763258632596326063261632626326363264632656326663267632686326963270632716327263273632746327563276632776327863279632806328163282632836328463285632866328763288632896329063291632926329363294632956329663297632986329963300633016330263303633046330563306633076330863309633106331163312633136331463315633166331763318633196332063321633226332363324633256332663327633286332963330633316333263333633346333563336633376333863339633406334163342633436334463345633466334763348633496335063351633526335363354633556335663357633586335963360633616336263363633646336563366633676336863369633706337163372633736337463375633766337763378633796338063381633826338363384633856338663387633886338963390633916339263393633946339563396633976339863399634006340163402634036340463405634066340763408634096341063411634126341363414634156341663417634186341963420634216342263423634246342563426634276342863429634306343163432634336343463435634366343763438634396344063441634426344363444634456344663447634486344963450634516345263453634546345563456634576345863459634606346163462634636346463465634666346763468634696347063471634726347363474634756347663477634786347963480634816348263483634846348563486634876348863489634906349163492634936349463495634966349763498634996350063501635026350363504635056350663507635086350963510635116351263513635146351563516635176351863519635206352163522635236352463525635266352763528635296353063531635326353363534635356353663537635386353963540635416354263543635446354563546635476354863549635506355163552635536355463555635566355763558635596356063561635626356363564635656356663567635686356963570635716357263573635746357563576635776357863579635806358163582635836358463585635866358763588635896359063591635926359363594635956359663597635986359963600636016360263603636046360563606636076360863609636106361163612636136361463615636166361763618636196362063621636226362363624636256362663627636286362963630636316363263633636346363563636636376363863639636406364163642636436364463645636466364763648636496365063651636526365363654636556365663657636586365963660636616366263663636646366563666636676366863669636706367163672636736367463675636766367763678636796368063681636826368363684636856368663687636886368963690636916369263693636946369563696636976369863699637006370163702637036370463705637066370763708637096371063711637126371363714637156371663717637186371963720637216372263723637246372563726637276372863729637306373163732637336373463735637366373763738637396374063741637426374363744637456374663747637486374963750637516375263753637546375563756637576375863759637606376163762637636376463765637666376763768637696377063771637726377363774637756377663777637786377963780637816378263783637846378563786637876378863789637906379163792637936379463795637966379763798637996380063801638026380363804638056380663807638086380963810638116381263813638146381563816638176381863819638206382163822638236382463825638266382763828638296383063831638326383363834638356383663837638386383963840638416384263843638446384563846638476384863849638506385163852638536385463855638566385763858638596386063861638626386363864638656386663867638686386963870638716387263873638746387563876638776387863879638806388163882638836388463885638866388763888638896389063891638926389363894638956389663897638986389963900639016390263903639046390563906639076390863909639106391163912639136391463915639166391763918639196392063921639226392363924639256392663927639286392963930639316393263933639346393563936639376393863939639406394163942639436394463945639466394763948639496395063951639526395363954639556395663957639586395963960639616396263963639646396563966639676396863969639706397163972639736397463975639766397763978639796398063981639826398363984639856398663987639886398963990639916399263993639946399563996639976399863999640006400164002640036400464005640066400764008640096401064011640126401364014640156401664017640186401964020640216402264023640246402564026640276402864029640306403164032640336403464035640366403764038640396404064041640426404364044640456404664047640486404964050640516405264053640546405564056640576405864059640606406164062640636406464065640666406764068640696407064071640726407364074640756407664077640786407964080640816408264083640846408564086640876408864089640906409164092640936409464095640966409764098640996410064101641026410364104641056410664107641086410964110641116411264113641146411564116641176411864119641206412164122641236412464125641266412764128641296413064131641326413364134641356413664137641386413964140641416414264143641446414564146641476414864149641506415164152641536415464155641566415764158641596416064161641626416364164641656416664167641686416964170641716417264173641746417564176641776417864179641806418164182641836418464185641866418764188641896419064191641926419364194641956419664197641986419964200642016420264203642046420564206642076420864209642106421164212642136421464215642166421764218642196422064221642226422364224642256422664227642286422964230642316423264233642346423564236642376423864239642406424164242642436424464245642466424764248642496425064251642526425364254642556425664257642586425964260642616426264263642646426564266642676426864269642706427164272642736427464275642766427764278642796428064281642826428364284642856428664287642886428964290642916429264293642946429564296642976429864299643006430164302643036430464305643066430764308643096431064311643126431364314643156431664317643186431964320643216432264323643246432564326643276432864329643306433164332643336433464335643366433764338643396434064341643426434364344643456434664347643486434964350643516435264353643546435564356643576435864359643606436164362643636436464365643666436764368643696437064371643726437364374643756437664377643786437964380643816438264383643846438564386643876438864389643906439164392643936439464395643966439764398643996440064401644026440364404644056440664407644086440964410644116441264413644146441564416644176441864419644206442164422644236442464425644266442764428644296443064431644326443364434644356443664437644386443964440644416444264443644446444564446644476444864449644506445164452644536445464455644566445764458644596446064461644626446364464644656446664467644686446964470644716447264473644746447564476644776447864479644806448164482644836448464485644866448764488644896449064491644926449364494644956449664497644986449964500645016450264503645046450564506645076450864509645106451164512645136451464515645166451764518645196452064521645226452364524645256452664527645286452964530645316453264533645346453564536645376453864539645406454164542645436454464545645466454764548645496455064551645526455364554645556455664557645586455964560645616456264563645646456564566645676456864569645706457164572645736457464575645766457764578645796458064581645826458364584645856458664587645886458964590645916459264593645946459564596645976459864599646006460164602646036460464605646066460764608646096461064611646126461364614646156461664617646186461964620646216462264623646246462564626646276462864629646306463164632646336463464635646366463764638646396464064641646426464364644646456464664647646486464964650646516465264653646546465564656646576465864659646606466164662646636466464665646666466764668646696467064671646726467364674646756467664677646786467964680646816468264683646846468564686646876468864689646906469164692646936469464695646966469764698646996470064701647026470364704647056470664707647086470964710647116471264713647146471564716647176471864719647206472164722647236472464725647266472764728647296473064731647326473364734647356473664737647386473964740647416474264743647446474564746647476474864749647506475164752647536475464755647566475764758647596476064761647626476364764647656476664767647686476964770647716477264773647746477564776647776477864779647806478164782647836478464785647866478764788647896479064791647926479364794647956479664797647986479964800648016480264803648046480564806648076480864809648106481164812648136481464815648166481764818648196482064821648226482364824648256482664827648286482964830648316483264833648346483564836648376483864839648406484164842648436484464845648466484764848648496485064851648526485364854648556485664857648586485964860648616486264863648646486564866648676486864869648706487164872648736487464875648766487764878648796488064881648826488364884648856488664887648886488964890648916489264893648946489564896648976489864899649006490164902649036490464905649066490764908649096491064911649126491364914649156491664917649186491964920649216492264923649246492564926649276492864929649306493164932649336493464935649366493764938649396494064941649426494364944649456494664947649486494964950649516495264953649546495564956649576495864959649606496164962649636496464965649666496764968649696497064971649726497364974649756497664977649786497964980649816498264983649846498564986649876498864989649906499164992649936499464995649966499764998649996500065001650026500365004650056500665007650086500965010650116501265013650146501565016650176501865019650206502165022650236502465025650266502765028650296503065031650326503365034650356503665037650386503965040650416504265043650446504565046650476504865049650506505165052650536505465055650566505765058650596506065061650626506365064650656506665067650686506965070650716507265073650746507565076650776507865079650806508165082650836508465085650866508765088650896509065091650926509365094650956509665097650986509965100651016510265103651046510565106651076510865109651106511165112651136511465115651166511765118651196512065121651226512365124651256512665127651286512965130651316513265133651346513565136651376513865139651406514165142651436514465145651466514765148651496515065151651526515365154651556515665157651586515965160651616516265163651646516565166651676516865169651706517165172651736517465175651766517765178651796518065181651826518365184651856518665187651886518965190651916519265193651946519565196651976519865199652006520165202652036520465205652066520765208652096521065211652126521365214652156521665217652186521965220652216522265223652246522565226652276522865229652306523165232652336523465235652366523765238652396524065241652426524365244652456524665247652486524965250652516525265253652546525565256652576525865259652606526165262652636526465265652666526765268652696527065271652726527365274652756527665277652786527965280652816528265283652846528565286652876528865289652906529165292652936529465295652966529765298652996530065301653026530365304653056530665307653086530965310653116531265313653146531565316653176531865319653206532165322653236532465325653266532765328653296533065331653326533365334653356533665337653386533965340653416534265343653446534565346653476534865349653506535165352653536535465355653566535765358653596536065361653626536365364653656536665367653686536965370653716537265373653746537565376653776537865379653806538165382653836538465385653866538765388653896539065391653926539365394653956539665397653986539965400654016540265403654046540565406654076540865409654106541165412654136541465415654166541765418654196542065421654226542365424654256542665427654286542965430654316543265433654346543565436654376543865439654406544165442654436544465445654466544765448654496545065451654526545365454654556545665457654586545965460654616546265463654646546565466654676546865469654706547165472654736547465475654766547765478654796548065481654826548365484654856548665487654886548965490654916549265493654946549565496654976549865499655006550165502655036550465505655066550765508655096551065511655126551365514655156551665517655186551965520655216552265523655246552565526655276552865529655306553165532655336553465535655366553765538655396554065541655426554365544655456554665547655486554965550655516555265553655546555565556655576555865559655606556165562655636556465565655666556765568655696557065571655726557365574655756557665577655786557965580655816558265583655846558565586655876558865589655906559165592655936559465595655966559765598655996560065601656026560365604656056560665607656086560965610656116561265613656146561565616656176561865619656206562165622656236562465625656266562765628656296563065631656326563365634656356563665637656386563965640656416564265643656446564565646656476564865649656506565165652656536565465655656566565765658656596566065661656626566365664656656566665667656686566965670656716567265673656746567565676656776567865679656806568165682656836568465685656866568765688656896569065691656926569365694656956569665697656986569965700657016570265703657046570565706657076570865709657106571165712657136571465715657166571765718657196572065721657226572365724657256572665727657286572965730657316573265733657346573565736657376573865739657406574165742657436574465745657466574765748657496575065751657526575365754657556575665757657586575965760657616576265763657646576565766657676576865769657706577165772657736577465775657766577765778657796578065781657826578365784657856578665787657886578965790657916579265793657946579565796657976579865799658006580165802658036580465805658066580765808658096581065811658126581365814658156581665817658186581965820658216582265823658246582565826658276582865829658306583165832658336583465835658366583765838658396584065841658426584365844658456584665847658486584965850658516585265853658546585565856658576585865859658606586165862658636586465865658666586765868658696587065871658726587365874658756587665877658786587965880658816588265883658846588565886658876588865889658906589165892658936589465895658966589765898658996590065901659026590365904659056590665907659086590965910659116591265913659146591565916659176591865919659206592165922659236592465925659266592765928659296593065931659326593365934659356593665937659386593965940659416594265943659446594565946659476594865949659506595165952659536595465955659566595765958659596596065961659626596365964659656596665967659686596965970659716597265973659746597565976659776597865979659806598165982659836598465985659866598765988659896599065991659926599365994659956599665997659986599966000660016600266003660046600566006660076600866009660106601166012660136601466015660166601766018660196602066021660226602366024660256602666027660286602966030660316603266033660346603566036660376603866039660406604166042660436604466045660466604766048660496605066051660526605366054660556605666057660586605966060660616606266063660646606566066660676606866069660706607166072660736607466075660766607766078660796608066081660826608366084660856608666087660886608966090660916609266093660946609566096660976609866099661006610166102661036610466105661066610766108661096611066111661126611366114661156611666117661186611966120661216612266123661246612566126661276612866129661306613166132661336613466135661366613766138661396614066141661426614366144661456614666147661486614966150661516615266153661546615566156661576615866159661606616166162661636616466165661666616766168661696617066171661726617366174661756617666177661786617966180661816618266183661846618566186661876618866189661906619166192661936619466195661966619766198661996620066201662026620366204662056620666207662086620966210662116621266213662146621566216662176621866219662206622166222662236622466225662266622766228662296623066231662326623366234662356623666237662386623966240662416624266243662446624566246662476624866249662506625166252662536625466255662566625766258662596626066261662626626366264662656626666267662686626966270662716627266273662746627566276662776627866279662806628166282662836628466285662866628766288662896629066291662926629366294662956629666297662986629966300663016630266303663046630566306663076630866309663106631166312663136631466315663166631766318663196632066321663226632366324663256632666327663286632966330663316633266333663346633566336663376633866339663406634166342663436634466345663466634766348663496635066351663526635366354663556635666357663586635966360663616636266363663646636566366663676636866369663706637166372663736637466375663766637766378663796638066381663826638366384663856638666387663886638966390663916639266393663946639566396663976639866399664006640166402664036640466405664066640766408664096641066411664126641366414664156641666417664186641966420664216642266423664246642566426664276642866429664306643166432664336643466435664366643766438664396644066441664426644366444664456644666447664486644966450664516645266453664546645566456664576645866459664606646166462664636646466465664666646766468664696647066471664726647366474664756647666477664786647966480664816648266483664846648566486664876648866489664906649166492664936649466495664966649766498664996650066501665026650366504665056650666507665086650966510665116651266513665146651566516665176651866519665206652166522665236652466525665266652766528665296653066531665326653366534665356653666537665386653966540665416654266543665446654566546665476654866549665506655166552665536655466555665566655766558665596656066561665626656366564665656656666567665686656966570665716657266573665746657566576665776657866579665806658166582665836658466585665866658766588665896659066591665926659366594665956659666597665986659966600666016660266603666046660566606666076660866609666106661166612666136661466615666166661766618666196662066621666226662366624666256662666627666286662966630666316663266633666346663566636666376663866639666406664166642666436664466645666466664766648666496665066651666526665366654666556665666657666586665966660666616666266663666646666566666666676666866669666706667166672666736667466675666766667766678666796668066681666826668366684666856668666687666886668966690666916669266693666946669566696666976669866699667006670166702667036670466705667066670766708667096671066711667126671366714667156671666717667186671966720667216672266723667246672566726667276672866729667306673166732667336673466735667366673766738667396674066741667426674366744667456674666747667486674966750667516675266753667546675566756667576675866759667606676166762667636676466765667666676766768667696677066771667726677366774667756677666777667786677966780667816678266783667846678566786667876678866789667906679166792667936679466795667966679766798667996680066801668026680366804668056680666807668086680966810668116681266813668146681566816668176681866819668206682166822668236682466825668266682766828668296683066831668326683366834668356683666837668386683966840668416684266843668446684566846668476684866849668506685166852668536685466855668566685766858668596686066861668626686366864668656686666867668686686966870668716687266873668746687566876668776687866879668806688166882668836688466885668866688766888668896689066891668926689366894668956689666897668986689966900669016690266903669046690566906669076690866909669106691166912669136691466915669166691766918669196692066921669226692366924669256692666927669286692966930669316693266933669346693566936669376693866939669406694166942669436694466945669466694766948669496695066951669526695366954669556695666957669586695966960669616696266963669646696566966669676696866969669706697166972669736697466975669766697766978669796698066981669826698366984669856698666987669886698966990669916699266993669946699566996669976699866999670006700167002670036700467005670066700767008670096701067011670126701367014670156701667017670186701967020670216702267023670246702567026670276702867029670306703167032670336703467035670366703767038670396704067041670426704367044670456704667047670486704967050670516705267053670546705567056670576705867059670606706167062670636706467065670666706767068670696707067071670726707367074670756707667077670786707967080670816708267083670846708567086670876708867089670906709167092670936709467095670966709767098670996710067101671026710367104671056710667107671086710967110671116711267113671146711567116671176711867119671206712167122671236712467125671266712767128671296713067131671326713367134671356713667137671386713967140671416714267143671446714567146671476714867149671506715167152671536715467155671566715767158671596716067161671626716367164671656716667167671686716967170671716717267173671746717567176671776717867179671806718167182671836718467185671866718767188671896719067191671926719367194671956719667197671986719967200672016720267203672046720567206672076720867209672106721167212672136721467215672166721767218672196722067221672226722367224672256722667227672286722967230672316723267233672346723567236672376723867239672406724167242672436724467245672466724767248672496725067251672526725367254672556725667257672586725967260672616726267263672646726567266672676726867269672706727167272672736727467275672766727767278672796728067281672826728367284672856728667287672886728967290672916729267293672946729567296672976729867299673006730167302673036730467305673066730767308673096731067311673126731367314673156731667317673186731967320673216732267323673246732567326673276732867329673306733167332673336733467335673366733767338673396734067341673426734367344673456734667347673486734967350673516735267353673546735567356673576735867359673606736167362673636736467365673666736767368673696737067371673726737367374673756737667377673786737967380673816738267383673846738567386673876738867389673906739167392673936739467395673966739767398673996740067401674026740367404674056740667407674086740967410674116741267413674146741567416674176741867419674206742167422674236742467425674266742767428674296743067431674326743367434674356743667437674386743967440674416744267443674446744567446674476744867449674506745167452674536745467455674566745767458674596746067461674626746367464674656746667467674686746967470674716747267473674746747567476674776747867479674806748167482674836748467485674866748767488674896749067491674926749367494674956749667497674986749967500675016750267503675046750567506675076750867509675106751167512675136751467515675166751767518675196752067521675226752367524675256752667527675286752967530675316753267533675346753567536675376753867539675406754167542675436754467545675466754767548675496755067551675526755367554675556755667557675586755967560675616756267563675646756567566675676756867569675706757167572675736757467575675766757767578675796758067581675826758367584675856758667587675886758967590675916759267593675946759567596675976759867599676006760167602676036760467605676066760767608676096761067611676126761367614676156761667617676186761967620676216762267623676246762567626676276762867629676306763167632676336763467635676366763767638676396764067641676426764367644676456764667647676486764967650676516765267653676546765567656676576765867659676606766167662676636766467665676666766767668676696767067671676726767367674676756767667677676786767967680676816768267683676846768567686676876768867689676906769167692676936769467695676966769767698676996770067701677026770367704677056770667707677086770967710677116771267713677146771567716677176771867719677206772167722677236772467725677266772767728677296773067731677326773367734677356773667737677386773967740677416774267743677446774567746677476774867749677506775167752677536775467755677566775767758677596776067761677626776367764677656776667767677686776967770677716777267773677746777567776677776777867779677806778167782677836778467785677866778767788677896779067791677926779367794677956779667797677986779967800678016780267803678046780567806678076780867809678106781167812678136781467815678166781767818678196782067821678226782367824678256782667827678286782967830678316783267833678346783567836678376783867839678406784167842678436784467845678466784767848678496785067851678526785367854678556785667857678586785967860678616786267863678646786567866678676786867869678706787167872678736787467875678766787767878678796788067881678826788367884678856788667887678886788967890678916789267893678946789567896678976789867899679006790167902679036790467905679066790767908679096791067911679126791367914679156791667917679186791967920679216792267923679246792567926679276792867929679306793167932679336793467935679366793767938679396794067941679426794367944679456794667947679486794967950679516795267953679546795567956679576795867959679606796167962679636796467965679666796767968679696797067971679726797367974679756797667977679786797967980679816798267983679846798567986679876798867989679906799167992679936799467995679966799767998679996800068001680026800368004680056800668007680086800968010680116801268013680146801568016680176801868019680206802168022680236802468025680266802768028680296803068031680326803368034680356803668037680386803968040680416804268043680446804568046680476804868049680506805168052680536805468055680566805768058680596806068061680626806368064680656806668067680686806968070680716807268073680746807568076680776807868079680806808168082680836808468085680866808768088680896809068091680926809368094680956809668097680986809968100681016810268103681046810568106681076810868109681106811168112681136811468115681166811768118681196812068121681226812368124681256812668127681286812968130681316813268133681346813568136681376813868139681406814168142681436814468145681466814768148681496815068151681526815368154681556815668157681586815968160681616816268163681646816568166681676816868169681706817168172681736817468175681766817768178681796818068181681826818368184681856818668187681886818968190681916819268193681946819568196681976819868199682006820168202682036820468205682066820768208682096821068211682126821368214682156821668217682186821968220682216822268223682246822568226682276822868229682306823168232682336823468235682366823768238682396824068241682426824368244682456824668247682486824968250682516825268253682546825568256682576825868259682606826168262682636826468265682666826768268682696827068271682726827368274682756827668277682786827968280682816828268283682846828568286682876828868289682906829168292682936829468295682966829768298682996830068301683026830368304683056830668307683086830968310683116831268313683146831568316683176831868319683206832168322683236832468325683266832768328683296833068331683326833368334683356833668337683386833968340683416834268343683446834568346683476834868349683506835168352683536835468355683566835768358683596836068361683626836368364683656836668367683686836968370683716837268373683746837568376683776837868379683806838168382683836838468385683866838768388683896839068391683926839368394683956839668397683986839968400684016840268403684046840568406684076840868409684106841168412684136841468415684166841768418684196842068421684226842368424684256842668427684286842968430684316843268433684346843568436684376843868439684406844168442684436844468445684466844768448684496845068451684526845368454684556845668457684586845968460684616846268463684646846568466684676846868469684706847168472684736847468475684766847768478684796848068481684826848368484684856848668487684886848968490684916849268493684946849568496684976849868499685006850168502685036850468505685066850768508685096851068511685126851368514685156851668517685186851968520685216852268523685246852568526685276852868529685306853168532685336853468535685366853768538685396854068541685426854368544685456854668547685486854968550685516855268553685546855568556685576855868559685606856168562685636856468565685666856768568685696857068571685726857368574685756857668577685786857968580685816858268583685846858568586685876858868589685906859168592685936859468595685966859768598685996860068601686026860368604686056860668607686086860968610686116861268613686146861568616686176861868619686206862168622686236862468625686266862768628686296863068631686326863368634686356863668637686386863968640686416864268643686446864568646686476864868649686506865168652686536865468655686566865768658686596866068661686626866368664686656866668667686686866968670686716867268673686746867568676686776867868679686806868168682686836868468685686866868768688686896869068691686926869368694686956869668697686986869968700687016870268703687046870568706687076870868709687106871168712687136871468715687166871768718687196872068721687226872368724687256872668727687286872968730687316873268733687346873568736687376873868739687406874168742687436874468745687466874768748687496875068751687526875368754687556875668757687586875968760687616876268763687646876568766687676876868769687706877168772687736877468775687766877768778687796878068781687826878368784687856878668787687886878968790687916879268793687946879568796687976879868799688006880168802688036880468805688066880768808688096881068811688126881368814688156881668817688186881968820688216882268823688246882568826688276882868829688306883168832688336883468835688366883768838688396884068841688426884368844688456884668847688486884968850688516885268853688546885568856688576885868859688606886168862688636886468865688666886768868688696887068871688726887368874688756887668877688786887968880688816888268883688846888568886688876888868889688906889168892688936889468895688966889768898688996890068901689026890368904689056890668907689086890968910689116891268913689146891568916689176891868919689206892168922689236892468925689266892768928689296893068931689326893368934689356893668937689386893968940689416894268943689446894568946689476894868949689506895168952689536895468955689566895768958689596896068961689626896368964689656896668967689686896968970689716897268973689746897568976689776897868979689806898168982689836898468985689866898768988689896899068991689926899368994689956899668997689986899969000690016900269003690046900569006690076900869009690106901169012690136901469015690166901769018690196902069021690226902369024690256902669027690286902969030690316903269033690346903569036690376903869039690406904169042690436904469045690466904769048690496905069051690526905369054690556905669057690586905969060690616906269063690646906569066690676906869069690706907169072690736907469075690766907769078690796908069081690826908369084690856908669087690886908969090690916909269093690946909569096690976909869099691006910169102691036910469105691066910769108691096911069111691126911369114691156911669117691186911969120691216912269123691246912569126691276912869129691306913169132691336913469135691366913769138691396914069141691426914369144691456914669147691486914969150691516915269153691546915569156691576915869159691606916169162691636916469165691666916769168691696917069171691726917369174691756917669177691786917969180691816918269183691846918569186691876918869189691906919169192691936919469195691966919769198691996920069201692026920369204692056920669207692086920969210692116921269213692146921569216692176921869219692206922169222692236922469225692266922769228692296923069231692326923369234692356923669237692386923969240692416924269243692446924569246692476924869249692506925169252692536925469255692566925769258692596926069261692626926369264692656926669267692686926969270692716927269273692746927569276692776927869279692806928169282692836928469285692866928769288692896929069291692926929369294692956929669297692986929969300693016930269303693046930569306693076930869309693106931169312693136931469315693166931769318693196932069321693226932369324693256932669327693286932969330693316933269333693346933569336693376933869339693406934169342693436934469345693466934769348693496935069351693526935369354693556935669357693586935969360693616936269363693646936569366693676936869369693706937169372693736937469375693766937769378693796938069381693826938369384693856938669387693886938969390693916939269393693946939569396693976939869399694006940169402694036940469405694066940769408694096941069411694126941369414694156941669417694186941969420694216942269423694246942569426694276942869429694306943169432694336943469435694366943769438694396944069441694426944369444694456944669447694486944969450694516945269453694546945569456694576945869459694606946169462694636946469465694666946769468694696947069471694726947369474694756947669477694786947969480694816948269483694846948569486694876948869489694906949169492694936949469495694966949769498694996950069501695026950369504695056950669507695086950969510695116951269513695146951569516695176951869519695206952169522695236952469525695266952769528695296953069531695326953369534695356953669537695386953969540695416954269543695446954569546695476954869549695506955169552695536955469555695566955769558695596956069561695626956369564695656956669567695686956969570695716957269573695746957569576695776957869579695806958169582695836958469585695866958769588695896959069591695926959369594695956959669597695986959969600696016960269603696046960569606696076960869609696106961169612696136961469615696166961769618696196962069621696226962369624696256962669627696286962969630696316963269633696346963569636696376963869639696406964169642696436964469645696466964769648696496965069651696526965369654696556965669657696586965969660696616966269663696646966569666696676966869669696706967169672696736967469675696766967769678696796968069681696826968369684696856968669687696886968969690696916969269693696946969569696696976969869699697006970169702697036970469705697066970769708697096971069711697126971369714697156971669717697186971969720697216972269723697246972569726697276972869729697306973169732697336973469735697366973769738697396974069741697426974369744697456974669747697486974969750697516975269753697546975569756697576975869759697606976169762697636976469765697666976769768697696977069771697726977369774697756977669777697786977969780697816978269783697846978569786697876978869789697906979169792697936979469795697966979769798697996980069801698026980369804698056980669807698086980969810698116981269813698146981569816698176981869819698206982169822698236982469825698266982769828698296983069831698326983369834698356983669837698386983969840698416984269843698446984569846698476984869849698506985169852698536985469855698566985769858698596986069861698626986369864698656986669867698686986969870698716987269873698746987569876698776987869879698806988169882698836988469885698866988769888698896989069891698926989369894698956989669897698986989969900699016990269903699046990569906699076990869909699106991169912699136991469915699166991769918699196992069921699226992369924699256992669927699286992969930699316993269933699346993569936699376993869939699406994169942699436994469945699466994769948699496995069951699526995369954699556995669957699586995969960699616996269963699646996569966699676996869969699706997169972699736997469975699766997769978699796998069981699826998369984699856998669987699886998969990699916999269993699946999569996699976999869999700007000170002700037000470005700067000770008700097001070011700127001370014700157001670017700187001970020700217002270023700247002570026700277002870029700307003170032700337003470035700367003770038700397004070041700427004370044700457004670047700487004970050700517005270053700547005570056700577005870059700607006170062700637006470065700667006770068700697007070071700727007370074700757007670077700787007970080700817008270083700847008570086700877008870089700907009170092700937009470095700967009770098700997010070101701027010370104701057010670107701087010970110701117011270113701147011570116701177011870119701207012170122701237012470125701267012770128701297013070131701327013370134701357013670137701387013970140701417014270143701447014570146701477014870149701507015170152701537015470155701567015770158701597016070161701627016370164701657016670167701687016970170701717017270173701747017570176701777017870179701807018170182701837018470185701867018770188701897019070191701927019370194701957019670197701987019970200702017020270203702047020570206702077020870209702107021170212702137021470215702167021770218702197022070221702227022370224702257022670227702287022970230702317023270233702347023570236702377023870239702407024170242702437024470245702467024770248702497025070251702527025370254702557025670257702587025970260702617026270263702647026570266702677026870269702707027170272702737027470275702767027770278702797028070281702827028370284702857028670287702887028970290702917029270293702947029570296702977029870299703007030170302703037030470305703067030770308703097031070311703127031370314703157031670317703187031970320703217032270323703247032570326703277032870329703307033170332703337033470335703367033770338703397034070341703427034370344703457034670347703487034970350703517035270353703547035570356703577035870359703607036170362703637036470365703667036770368703697037070371703727037370374703757037670377703787037970380703817038270383703847038570386703877038870389703907039170392703937039470395703967039770398703997040070401704027040370404704057040670407704087040970410704117041270413704147041570416704177041870419704207042170422704237042470425704267042770428704297043070431704327043370434704357043670437704387043970440704417044270443704447044570446704477044870449704507045170452704537045470455704567045770458704597046070461704627046370464704657046670467704687046970470704717047270473704747047570476704777047870479704807048170482704837048470485704867048770488704897049070491704927049370494704957049670497704987049970500705017050270503705047050570506705077050870509705107051170512705137051470515705167051770518705197052070521705227052370524705257052670527705287052970530705317053270533705347053570536705377053870539705407054170542705437054470545705467054770548705497055070551705527055370554705557055670557705587055970560705617056270563705647056570566705677056870569705707057170572705737057470575705767057770578705797058070581705827058370584705857058670587705887058970590705917059270593705947059570596705977059870599706007060170602706037060470605706067060770608706097061070611706127061370614706157061670617706187061970620706217062270623706247062570626706277062870629706307063170632706337063470635706367063770638706397064070641706427064370644706457064670647706487064970650706517065270653706547065570656706577065870659706607066170662706637066470665706667066770668706697067070671706727067370674706757067670677706787067970680706817068270683706847068570686706877068870689706907069170692706937069470695706967069770698706997070070701707027070370704707057070670707707087070970710707117071270713707147071570716707177071870719707207072170722707237072470725707267072770728707297073070731707327073370734707357073670737707387073970740707417074270743707447074570746707477074870749707507075170752707537075470755707567075770758707597076070761707627076370764707657076670767707687076970770707717077270773707747077570776707777077870779707807078170782707837078470785707867078770788707897079070791707927079370794707957079670797707987079970800708017080270803708047080570806708077080870809708107081170812708137081470815708167081770818708197082070821708227082370824708257082670827708287082970830708317083270833708347083570836708377083870839708407084170842708437084470845708467084770848708497085070851708527085370854708557085670857708587085970860708617086270863708647086570866708677086870869708707087170872708737087470875708767087770878708797088070881708827088370884708857088670887708887088970890708917089270893708947089570896708977089870899709007090170902709037090470905709067090770908709097091070911709127091370914709157091670917709187091970920709217092270923709247092570926709277092870929709307093170932709337093470935709367093770938709397094070941709427094370944709457094670947709487094970950709517095270953709547095570956709577095870959709607096170962709637096470965709667096770968709697097070971709727097370974709757097670977709787097970980709817098270983709847098570986709877098870989709907099170992709937099470995709967099770998709997100071001710027100371004710057100671007710087100971010710117101271013710147101571016710177101871019710207102171022710237102471025710267102771028710297103071031710327103371034710357103671037710387103971040710417104271043710447104571046710477104871049710507105171052710537105471055710567105771058710597106071061710627106371064710657106671067710687106971070710717107271073710747107571076710777107871079710807108171082710837108471085710867108771088710897109071091710927109371094710957109671097710987109971100711017110271103711047110571106711077110871109711107111171112711137111471115711167111771118711197112071121711227112371124711257112671127711287112971130711317113271133711347113571136711377113871139711407114171142711437114471145711467114771148711497115071151711527115371154711557115671157711587115971160711617116271163711647116571166711677116871169711707117171172711737117471175711767117771178711797118071181711827118371184711857118671187711887118971190711917119271193711947119571196711977119871199712007120171202712037120471205712067120771208712097121071211712127121371214712157121671217712187121971220712217122271223712247122571226712277122871229712307123171232712337123471235712367123771238712397124071241712427124371244712457124671247712487124971250712517125271253712547125571256712577125871259712607126171262712637126471265712667126771268712697127071271712727127371274712757127671277712787127971280712817128271283712847128571286712877128871289712907129171292712937129471295712967129771298712997130071301713027130371304713057130671307713087130971310713117131271313713147131571316713177131871319713207132171322713237132471325713267132771328713297133071331713327133371334713357133671337713387133971340713417134271343713447134571346713477134871349713507135171352713537135471355713567135771358713597136071361713627136371364713657136671367713687136971370713717137271373713747137571376713777137871379713807138171382713837138471385713867138771388713897139071391713927139371394713957139671397713987139971400714017140271403714047140571406714077140871409714107141171412714137141471415714167141771418714197142071421714227142371424714257142671427714287142971430714317143271433714347143571436714377143871439714407144171442714437144471445714467144771448714497145071451714527145371454714557145671457714587145971460714617146271463714647146571466714677146871469714707147171472714737147471475714767147771478714797148071481714827148371484714857148671487714887148971490714917149271493714947149571496714977149871499715007150171502715037150471505715067150771508715097151071511715127151371514715157151671517715187151971520715217152271523715247152571526715277152871529715307153171532715337153471535715367153771538715397154071541715427154371544715457154671547715487154971550715517155271553715547155571556715577155871559715607156171562715637156471565715667156771568715697157071571715727157371574715757157671577715787157971580715817158271583715847158571586715877158871589715907159171592715937159471595715967159771598715997160071601716027160371604716057160671607716087160971610716117161271613716147161571616716177161871619716207162171622716237162471625716267162771628716297163071631716327163371634716357163671637716387163971640716417164271643716447164571646716477164871649716507165171652716537165471655716567165771658716597166071661716627166371664716657166671667716687166971670716717167271673716747167571676716777167871679716807168171682716837168471685716867168771688716897169071691716927169371694716957169671697716987169971700717017170271703717047170571706717077170871709717107171171712717137171471715717167171771718717197172071721717227172371724717257172671727717287172971730717317173271733717347173571736717377173871739717407174171742717437174471745717467174771748717497175071751717527175371754717557175671757717587175971760717617176271763717647176571766717677176871769717707177171772717737177471775717767177771778717797178071781717827178371784717857178671787717887178971790717917179271793717947179571796717977179871799718007180171802718037180471805718067180771808718097181071811718127181371814718157181671817718187181971820718217182271823718247182571826718277182871829718307183171832718337183471835718367183771838718397184071841718427184371844718457184671847718487184971850718517185271853718547185571856718577185871859718607186171862718637186471865718667186771868718697187071871718727187371874718757187671877718787187971880718817188271883718847188571886718877188871889718907189171892718937189471895718967189771898718997190071901719027190371904719057190671907719087190971910719117191271913719147191571916719177191871919719207192171922719237192471925719267192771928719297193071931719327193371934719357193671937719387193971940719417194271943719447194571946719477194871949719507195171952719537195471955719567195771958719597196071961719627196371964719657196671967719687196971970719717197271973719747197571976719777197871979719807198171982719837198471985719867198771988719897199071991719927199371994719957199671997719987199972000720017200272003720047200572006720077200872009720107201172012720137201472015720167201772018720197202072021720227202372024720257202672027720287202972030720317203272033720347203572036720377203872039720407204172042720437204472045720467204772048720497205072051720527205372054720557205672057720587205972060720617206272063720647206572066720677206872069720707207172072720737207472075720767207772078720797208072081720827208372084720857208672087720887208972090720917209272093720947209572096720977209872099721007210172102721037210472105721067210772108721097211072111721127211372114721157211672117721187211972120721217212272123721247212572126721277212872129721307213172132721337213472135721367213772138721397214072141721427214372144721457214672147721487214972150721517215272153721547215572156721577215872159721607216172162721637216472165721667216772168721697217072171721727217372174721757217672177721787217972180721817218272183721847218572186721877218872189721907219172192721937219472195721967219772198721997220072201722027220372204722057220672207722087220972210722117221272213722147221572216722177221872219722207222172222722237222472225722267222772228722297223072231722327223372234722357223672237722387223972240722417224272243722447224572246722477224872249722507225172252722537225472255722567225772258722597226072261722627226372264722657226672267722687226972270722717227272273722747227572276722777227872279722807228172282722837228472285722867228772288722897229072291722927229372294722957229672297722987229972300723017230272303723047230572306723077230872309723107231172312723137231472315723167231772318723197232072321723227232372324723257232672327723287232972330723317233272333723347233572336723377233872339723407234172342723437234472345723467234772348723497235072351723527235372354723557235672357723587235972360723617236272363723647236572366723677236872369723707237172372723737237472375723767237772378723797238072381723827238372384723857238672387723887238972390723917239272393723947239572396723977239872399724007240172402724037240472405724067240772408724097241072411724127241372414724157241672417724187241972420724217242272423724247242572426724277242872429724307243172432724337243472435724367243772438724397244072441724427244372444724457244672447724487244972450724517245272453724547245572456724577245872459724607246172462724637246472465724667246772468724697247072471724727247372474724757247672477724787247972480724817248272483724847248572486724877248872489724907249172492724937249472495724967249772498724997250072501725027250372504725057250672507725087250972510725117251272513725147251572516725177251872519725207252172522725237252472525725267252772528725297253072531725327253372534725357253672537725387253972540725417254272543725447254572546725477254872549725507255172552725537255472555725567255772558725597256072561725627256372564725657256672567725687256972570725717257272573725747257572576725777257872579725807258172582725837258472585725867258772588725897259072591725927259372594725957259672597725987259972600726017260272603726047260572606726077260872609726107261172612726137261472615726167261772618726197262072621726227262372624726257262672627726287262972630726317263272633726347263572636726377263872639726407264172642726437264472645726467264772648726497265072651726527265372654726557265672657726587265972660726617266272663726647266572666726677266872669726707267172672726737267472675726767267772678726797268072681726827268372684726857268672687726887268972690726917269272693726947269572696726977269872699727007270172702727037270472705727067270772708727097271072711727127271372714727157271672717727187271972720727217272272723727247272572726727277272872729727307273172732727337273472735727367273772738727397274072741727427274372744727457274672747727487274972750727517275272753727547275572756727577275872759727607276172762727637276472765727667276772768727697277072771727727277372774727757277672777727787277972780727817278272783727847278572786727877278872789727907279172792727937279472795727967279772798727997280072801728027280372804728057280672807728087280972810728117281272813728147281572816728177281872819728207282172822728237282472825728267282772828728297283072831728327283372834728357283672837728387283972840728417284272843728447284572846728477284872849728507285172852728537285472855728567285772858728597286072861728627286372864728657286672867728687286972870728717287272873728747287572876728777287872879728807288172882728837288472885728867288772888728897289072891728927289372894728957289672897728987289972900729017290272903729047290572906729077290872909729107291172912729137291472915729167291772918729197292072921729227292372924729257292672927729287292972930729317293272933729347293572936729377293872939729407294172942729437294472945729467294772948729497295072951729527295372954729557295672957729587295972960729617296272963729647296572966729677296872969729707297172972729737297472975729767297772978729797298072981729827298372984729857298672987729887298972990729917299272993729947299572996729977299872999730007300173002730037300473005730067300773008730097301073011730127301373014730157301673017730187301973020730217302273023730247302573026730277302873029730307303173032730337303473035730367303773038730397304073041730427304373044730457304673047730487304973050730517305273053730547305573056730577305873059730607306173062730637306473065730667306773068730697307073071730727307373074730757307673077730787307973080730817308273083730847308573086730877308873089730907309173092730937309473095730967309773098730997310073101731027310373104731057310673107731087310973110731117311273113731147311573116731177311873119731207312173122731237312473125731267312773128731297313073131731327313373134731357313673137731387313973140731417314273143731447314573146731477314873149731507315173152731537315473155731567315773158731597316073161731627316373164731657316673167731687316973170731717317273173731747317573176731777317873179731807318173182731837318473185731867318773188731897319073191731927319373194731957319673197731987319973200732017320273203732047320573206732077320873209732107321173212732137321473215732167321773218732197322073221732227322373224732257322673227732287322973230732317323273233732347323573236732377323873239732407324173242732437324473245732467324773248732497325073251732527325373254732557325673257732587325973260732617326273263732647326573266732677326873269732707327173272732737327473275732767327773278732797328073281732827328373284732857328673287732887328973290732917329273293732947329573296732977329873299733007330173302733037330473305733067330773308733097331073311733127331373314733157331673317733187331973320733217332273323733247332573326733277332873329733307333173332733337333473335733367333773338733397334073341733427334373344733457334673347733487334973350733517335273353733547335573356733577335873359733607336173362733637336473365733667336773368733697337073371733727337373374733757337673377733787337973380733817338273383733847338573386733877338873389733907339173392733937339473395733967339773398733997340073401734027340373404734057340673407734087340973410734117341273413734147341573416734177341873419734207342173422734237342473425734267342773428734297343073431734327343373434734357343673437734387343973440734417344273443734447344573446734477344873449734507345173452734537345473455734567345773458734597346073461734627346373464734657346673467734687346973470734717347273473734747347573476734777347873479734807348173482734837348473485734867348773488734897349073491734927349373494734957349673497734987349973500735017350273503735047350573506735077350873509735107351173512735137351473515735167351773518735197352073521735227352373524735257352673527735287352973530735317353273533735347353573536735377353873539735407354173542735437354473545735467354773548735497355073551735527355373554735557355673557735587355973560735617356273563735647356573566735677356873569735707357173572735737357473575735767357773578735797358073581735827358373584735857358673587735887358973590735917359273593735947359573596735977359873599736007360173602736037360473605736067360773608736097361073611736127361373614736157361673617736187361973620736217362273623736247362573626736277362873629736307363173632736337363473635736367363773638736397364073641736427364373644736457364673647736487364973650736517365273653736547365573656736577365873659736607366173662736637366473665736667366773668736697367073671736727367373674736757367673677736787367973680736817368273683736847368573686736877368873689736907369173692736937369473695736967369773698736997370073701737027370373704737057370673707737087370973710737117371273713737147371573716737177371873719737207372173722737237372473725737267372773728737297373073731737327373373734737357373673737737387373973740737417374273743737447374573746737477374873749737507375173752737537375473755737567375773758737597376073761737627376373764737657376673767737687376973770737717377273773737747377573776737777377873779737807378173782737837378473785737867378773788737897379073791737927379373794737957379673797737987379973800738017380273803738047380573806738077380873809738107381173812738137381473815738167381773818738197382073821738227382373824738257382673827738287382973830738317383273833738347383573836738377383873839738407384173842738437384473845738467384773848738497385073851738527385373854738557385673857738587385973860738617386273863738647386573866738677386873869738707387173872738737387473875738767387773878738797388073881738827388373884738857388673887738887388973890738917389273893738947389573896738977389873899739007390173902739037390473905739067390773908739097391073911739127391373914739157391673917739187391973920739217392273923739247392573926739277392873929739307393173932739337393473935739367393773938739397394073941739427394373944739457394673947739487394973950739517395273953739547395573956739577395873959739607396173962739637396473965739667396773968739697397073971739727397373974739757397673977739787397973980739817398273983739847398573986739877398873989739907399173992739937399473995739967399773998739997400074001740027400374004740057400674007740087400974010740117401274013740147401574016740177401874019740207402174022740237402474025740267402774028740297403074031740327403374034740357403674037740387403974040740417404274043740447404574046740477404874049740507405174052740537405474055740567405774058740597406074061740627406374064740657406674067740687406974070740717407274073740747407574076740777407874079740807408174082740837408474085740867408774088740897409074091740927409374094740957409674097740987409974100741017410274103741047410574106741077410874109741107411174112741137411474115741167411774118741197412074121741227412374124741257412674127741287412974130741317413274133741347413574136741377413874139741407414174142741437414474145741467414774148741497415074151741527415374154741557415674157741587415974160741617416274163741647416574166741677416874169741707417174172741737417474175741767417774178741797418074181741827418374184741857418674187741887418974190741917419274193741947419574196741977419874199742007420174202742037420474205742067420774208742097421074211742127421374214742157421674217742187421974220742217422274223742247422574226742277422874229742307423174232742337423474235742367423774238742397424074241742427424374244742457424674247742487424974250742517425274253742547425574256742577425874259742607426174262742637426474265742667426774268742697427074271742727427374274742757427674277742787427974280742817428274283742847428574286742877428874289742907429174292742937429474295742967429774298742997430074301743027430374304743057430674307743087430974310743117431274313743147431574316743177431874319743207432174322743237432474325743267432774328743297433074331743327433374334743357433674337743387433974340743417434274343743447434574346743477434874349743507435174352743537435474355743567435774358743597436074361743627436374364743657436674367743687436974370743717437274373743747437574376743777437874379743807438174382743837438474385743867438774388743897439074391743927439374394743957439674397743987439974400744017440274403744047440574406744077440874409744107441174412744137441474415744167441774418744197442074421744227442374424744257442674427744287442974430744317443274433744347443574436744377443874439744407444174442744437444474445744467444774448744497445074451744527445374454744557445674457744587445974460744617446274463744647446574466744677446874469744707447174472744737447474475744767447774478744797448074481744827448374484744857448674487744887448974490744917449274493744947449574496744977449874499745007450174502745037450474505745067450774508745097451074511745127451374514745157451674517745187451974520745217452274523745247452574526745277452874529745307453174532745337453474535745367453774538745397454074541745427454374544745457454674547745487454974550745517455274553745547455574556745577455874559745607456174562745637456474565745667456774568745697457074571745727457374574745757457674577745787457974580745817458274583745847458574586745877458874589745907459174592745937459474595745967459774598745997460074601746027460374604746057460674607746087460974610746117461274613746147461574616746177461874619746207462174622746237462474625746267462774628746297463074631746327463374634746357463674637746387463974640746417464274643746447464574646746477464874649746507465174652746537465474655746567465774658746597466074661746627466374664746657466674667746687466974670746717467274673746747467574676746777467874679746807468174682746837468474685746867468774688746897469074691746927469374694746957469674697746987469974700747017470274703747047470574706747077470874709747107471174712747137471474715747167471774718747197472074721747227472374724747257472674727747287472974730747317473274733747347473574736747377473874739747407474174742747437474474745747467474774748747497475074751747527475374754747557475674757747587475974760747617476274763747647476574766747677476874769747707477174772747737477474775747767477774778747797478074781747827478374784747857478674787747887478974790747917479274793747947479574796747977479874799748007480174802748037480474805748067480774808748097481074811748127481374814748157481674817748187481974820748217482274823748247482574826748277482874829748307483174832748337483474835748367483774838748397484074841748427484374844748457484674847748487484974850748517485274853748547485574856748577485874859748607486174862748637486474865748667486774868748697487074871748727487374874748757487674877748787487974880748817488274883748847488574886748877488874889748907489174892748937489474895748967489774898748997490074901749027490374904749057490674907749087490974910749117491274913749147491574916749177491874919749207492174922749237492474925749267492774928749297493074931749327493374934749357493674937749387493974940749417494274943749447494574946749477494874949749507495174952749537495474955749567495774958749597496074961749627496374964749657496674967749687496974970749717497274973749747497574976749777497874979749807498174982749837498474985749867498774988749897499074991749927499374994749957499674997749987499975000750017500275003750047500575006750077500875009750107501175012750137501475015750167501775018750197502075021750227502375024750257502675027750287502975030750317503275033750347503575036750377503875039750407504175042750437504475045750467504775048750497505075051750527505375054750557505675057750587505975060750617506275063750647506575066750677506875069750707507175072750737507475075750767507775078750797508075081750827508375084750857508675087750887508975090750917509275093750947509575096750977509875099751007510175102751037510475105751067510775108751097511075111751127511375114751157511675117751187511975120751217512275123751247512575126751277512875129751307513175132751337513475135751367513775138751397514075141751427514375144751457514675147751487514975150751517515275153751547515575156751577515875159751607516175162751637516475165751667516775168751697517075171751727517375174751757517675177751787517975180751817518275183751847518575186751877518875189751907519175192751937519475195751967519775198751997520075201752027520375204752057520675207752087520975210752117521275213752147521575216752177521875219752207522175222752237522475225752267522775228752297523075231752327523375234752357523675237752387523975240752417524275243752447524575246752477524875249752507525175252752537525475255752567525775258752597526075261752627526375264752657526675267752687526975270752717527275273752747527575276752777527875279752807528175282752837528475285752867528775288752897529075291752927529375294752957529675297752987529975300753017530275303753047530575306753077530875309753107531175312753137531475315753167531775318753197532075321753227532375324753257532675327753287532975330753317533275333753347533575336753377533875339753407534175342753437534475345753467534775348753497535075351753527535375354753557535675357753587535975360753617536275363753647536575366753677536875369753707537175372753737537475375753767537775378753797538075381753827538375384753857538675387753887538975390753917539275393753947539575396753977539875399754007540175402754037540475405754067540775408754097541075411754127541375414754157541675417754187541975420754217542275423754247542575426754277542875429754307543175432754337543475435754367543775438754397544075441754427544375444754457544675447754487544975450754517545275453754547545575456754577545875459754607546175462754637546475465754667546775468754697547075471754727547375474754757547675477754787547975480754817548275483754847548575486754877548875489754907549175492754937549475495754967549775498754997550075501755027550375504755057550675507755087550975510755117551275513755147551575516755177551875519755207552175522755237552475525755267552775528755297553075531755327553375534755357553675537755387553975540755417554275543755447554575546755477554875549755507555175552755537555475555755567555775558755597556075561755627556375564755657556675567755687556975570755717557275573755747557575576755777557875579755807558175582755837558475585755867558775588755897559075591755927559375594755957559675597755987559975600756017560275603756047560575606756077560875609756107561175612756137561475615756167561775618756197562075621756227562375624756257562675627756287562975630756317563275633756347563575636756377563875639756407564175642756437564475645756467564775648756497565075651756527565375654756557565675657756587565975660756617566275663756647566575666756677566875669756707567175672756737567475675756767567775678756797568075681756827568375684756857568675687756887568975690756917569275693756947569575696756977569875699757007570175702757037570475705757067570775708757097571075711757127571375714757157571675717757187571975720757217572275723757247572575726757277572875729757307573175732757337573475735757367573775738757397574075741757427574375744757457574675747757487574975750757517575275753757547575575756757577575875759757607576175762757637576475765757667576775768757697577075771757727577375774757757577675777757787577975780757817578275783757847578575786757877578875789757907579175792757937579475795757967579775798757997580075801758027580375804758057580675807758087580975810758117581275813758147581575816758177581875819758207582175822758237582475825758267582775828758297583075831758327583375834758357583675837758387583975840758417584275843758447584575846758477584875849758507585175852758537585475855758567585775858758597586075861758627586375864758657586675867758687586975870758717587275873758747587575876758777587875879758807588175882758837588475885758867588775888758897589075891758927589375894758957589675897758987589975900759017590275903759047590575906759077590875909759107591175912759137591475915759167591775918759197592075921759227592375924759257592675927759287592975930759317593275933759347593575936759377593875939759407594175942759437594475945759467594775948759497595075951759527595375954759557595675957759587595975960759617596275963759647596575966759677596875969759707597175972759737597475975759767597775978759797598075981759827598375984759857598675987759887598975990759917599275993759947599575996759977599875999760007600176002760037600476005760067600776008760097601076011760127601376014760157601676017760187601976020760217602276023760247602576026760277602876029760307603176032760337603476035760367603776038760397604076041760427604376044760457604676047760487604976050760517605276053760547605576056760577605876059760607606176062760637606476065760667606776068760697607076071760727607376074760757607676077760787607976080760817608276083760847608576086760877608876089760907609176092760937609476095760967609776098760997610076101761027610376104761057610676107761087610976110761117611276113761147611576116761177611876119761207612176122761237612476125761267612776128761297613076131761327613376134761357613676137761387613976140761417614276143761447614576146761477614876149761507615176152761537615476155761567615776158761597616076161761627616376164761657616676167761687616976170761717617276173761747617576176761777617876179761807618176182761837618476185761867618776188761897619076191761927619376194761957619676197761987619976200762017620276203762047620576206762077620876209762107621176212762137621476215762167621776218762197622076221762227622376224762257622676227762287622976230762317623276233762347623576236762377623876239762407624176242762437624476245762467624776248762497625076251762527625376254762557625676257762587625976260762617626276263762647626576266762677626876269762707627176272762737627476275762767627776278762797628076281762827628376284762857628676287762887628976290762917629276293762947629576296762977629876299763007630176302763037630476305763067630776308763097631076311763127631376314763157631676317763187631976320763217632276323763247632576326763277632876329763307633176332763337633476335763367633776338763397634076341763427634376344763457634676347763487634976350763517635276353763547635576356763577635876359763607636176362763637636476365763667636776368763697637076371763727637376374763757637676377763787637976380763817638276383763847638576386763877638876389763907639176392763937639476395763967639776398763997640076401764027640376404764057640676407764087640976410764117641276413764147641576416764177641876419764207642176422764237642476425764267642776428764297643076431764327643376434764357643676437764387643976440764417644276443764447644576446764477644876449764507645176452764537645476455764567645776458764597646076461764627646376464764657646676467764687646976470764717647276473764747647576476764777647876479764807648176482764837648476485764867648776488764897649076491764927649376494764957649676497764987649976500765017650276503765047650576506765077650876509765107651176512765137651476515765167651776518765197652076521765227652376524765257652676527765287652976530765317653276533765347653576536765377653876539765407654176542765437654476545765467654776548765497655076551765527655376554765557655676557765587655976560765617656276563765647656576566765677656876569765707657176572765737657476575765767657776578765797658076581765827658376584765857658676587765887658976590765917659276593765947659576596765977659876599766007660176602766037660476605766067660776608766097661076611766127661376614766157661676617766187661976620766217662276623766247662576626766277662876629766307663176632766337663476635766367663776638766397664076641766427664376644766457664676647766487664976650766517665276653766547665576656766577665876659766607666176662766637666476665766667666776668766697667076671766727667376674766757667676677766787667976680766817668276683766847668576686766877668876689766907669176692766937669476695766967669776698766997670076701767027670376704767057670676707767087670976710767117671276713767147671576716767177671876719767207672176722767237672476725767267672776728767297673076731767327673376734767357673676737767387673976740767417674276743767447674576746767477674876749767507675176752767537675476755767567675776758767597676076761767627676376764767657676676767767687676976770767717677276773767747677576776767777677876779767807678176782767837678476785767867678776788767897679076791767927679376794767957679676797767987679976800768017680276803768047680576806768077680876809768107681176812768137681476815768167681776818768197682076821768227682376824768257682676827768287682976830768317683276833768347683576836768377683876839768407684176842768437684476845768467684776848768497685076851768527685376854768557685676857768587685976860768617686276863768647686576866768677686876869768707687176872768737687476875768767687776878768797688076881768827688376884768857688676887768887688976890768917689276893768947689576896768977689876899769007690176902769037690476905769067690776908769097691076911769127691376914769157691676917769187691976920769217692276923769247692576926769277692876929769307693176932769337693476935769367693776938769397694076941769427694376944769457694676947769487694976950769517695276953769547695576956769577695876959769607696176962769637696476965769667696776968769697697076971769727697376974769757697676977769787697976980769817698276983769847698576986769877698876989769907699176992769937699476995769967699776998769997700077001770027700377004770057700677007770087700977010770117701277013770147701577016770177701877019770207702177022770237702477025770267702777028770297703077031770327703377034770357703677037770387703977040770417704277043770447704577046770477704877049770507705177052770537705477055770567705777058770597706077061770627706377064770657706677067770687706977070770717707277073770747707577076770777707877079770807708177082770837708477085770867708777088770897709077091770927709377094770957709677097770987709977100771017710277103771047710577106771077710877109771107711177112771137711477115771167711777118771197712077121771227712377124771257712677127771287712977130771317713277133771347713577136771377713877139771407714177142771437714477145771467714777148771497715077151771527715377154771557715677157771587715977160771617716277163771647716577166771677716877169771707717177172771737717477175771767717777178771797718077181771827718377184771857718677187771887718977190771917719277193771947719577196771977719877199772007720177202772037720477205772067720777208772097721077211772127721377214772157721677217772187721977220772217722277223772247722577226772277722877229772307723177232772337723477235772367723777238772397724077241772427724377244772457724677247772487724977250772517725277253772547725577256772577725877259772607726177262772637726477265772667726777268772697727077271772727727377274772757727677277772787727977280772817728277283772847728577286772877728877289772907729177292772937729477295772967729777298772997730077301773027730377304773057730677307773087730977310773117731277313773147731577316773177731877319773207732177322773237732477325773267732777328773297733077331773327733377334773357733677337773387733977340773417734277343773447734577346773477734877349773507735177352773537735477355773567735777358773597736077361773627736377364773657736677367773687736977370773717737277373773747737577376773777737877379773807738177382773837738477385773867738777388773897739077391773927739377394773957739677397773987739977400774017740277403774047740577406774077740877409774107741177412774137741477415774167741777418774197742077421774227742377424774257742677427774287742977430774317743277433774347743577436774377743877439774407744177442774437744477445774467744777448774497745077451774527745377454774557745677457774587745977460774617746277463774647746577466774677746877469774707747177472774737747477475774767747777478774797748077481774827748377484774857748677487774887748977490774917749277493774947749577496774977749877499775007750177502775037750477505775067750777508775097751077511775127751377514775157751677517775187751977520775217752277523775247752577526775277752877529775307753177532775337753477535775367753777538775397754077541775427754377544775457754677547775487754977550775517755277553775547755577556775577755877559775607756177562775637756477565775667756777568775697757077571775727757377574775757757677577775787757977580775817758277583775847758577586775877758877589775907759177592775937759477595775967759777598775997760077601776027760377604776057760677607776087760977610776117761277613776147761577616776177761877619776207762177622776237762477625776267762777628776297763077631776327763377634776357763677637776387763977640776417764277643776447764577646776477764877649776507765177652776537765477655776567765777658776597766077661776627766377664776657766677667776687766977670776717767277673776747767577676776777767877679776807768177682776837768477685776867768777688776897769077691776927769377694776957769677697776987769977700777017770277703777047770577706777077770877709777107771177712777137771477715777167771777718777197772077721777227772377724777257772677727777287772977730777317773277733777347773577736777377773877739777407774177742777437774477745777467774777748777497775077751777527775377754777557775677757777587775977760777617776277763777647776577766777677776877769777707777177772777737777477775777767777777778777797778077781777827778377784777857778677787777887778977790777917779277793777947779577796777977779877799778007780177802778037780477805778067780777808778097781077811778127781377814778157781677817778187781977820778217782277823778247782577826778277782877829778307783177832778337783477835778367783777838778397784077841778427784377844778457784677847778487784977850778517785277853778547785577856778577785877859778607786177862778637786477865778667786777868778697787077871778727787377874778757787677877778787787977880778817788277883778847788577886778877788877889778907789177892778937789477895778967789777898778997790077901779027790377904779057790677907779087790977910779117791277913779147791577916779177791877919779207792177922779237792477925779267792777928779297793077931779327793377934779357793677937779387793977940779417794277943779447794577946779477794877949779507795177952779537795477955779567795777958779597796077961779627796377964779657796677967779687796977970779717797277973779747797577976779777797877979779807798177982779837798477985779867798777988779897799077991779927799377994779957799677997779987799978000780017800278003780047800578006780077800878009780107801178012780137801478015780167801778018780197802078021780227802378024780257802678027780287802978030780317803278033780347803578036780377803878039780407804178042780437804478045780467804778048780497805078051780527805378054780557805678057780587805978060780617806278063780647806578066780677806878069780707807178072780737807478075780767807778078780797808078081780827808378084780857808678087780887808978090780917809278093780947809578096780977809878099781007810178102781037810478105781067810778108781097811078111781127811378114781157811678117781187811978120781217812278123781247812578126781277812878129781307813178132781337813478135781367813778138781397814078141781427814378144781457814678147781487814978150781517815278153781547815578156781577815878159781607816178162781637816478165781667816778168781697817078171781727817378174781757817678177781787817978180781817818278183781847818578186781877818878189781907819178192781937819478195781967819778198781997820078201782027820378204782057820678207782087820978210782117821278213782147821578216782177821878219782207822178222782237822478225782267822778228782297823078231782327823378234782357823678237782387823978240782417824278243782447824578246782477824878249782507825178252782537825478255782567825778258782597826078261782627826378264782657826678267782687826978270782717827278273782747827578276782777827878279782807828178282782837828478285782867828778288782897829078291782927829378294782957829678297782987829978300783017830278303783047830578306783077830878309783107831178312783137831478315783167831778318783197832078321783227832378324783257832678327783287832978330783317833278333783347833578336783377833878339783407834178342783437834478345783467834778348783497835078351783527835378354783557835678357783587835978360783617836278363783647836578366783677836878369783707837178372783737837478375783767837778378783797838078381783827838378384783857838678387783887838978390783917839278393783947839578396783977839878399784007840178402784037840478405784067840778408784097841078411784127841378414784157841678417784187841978420784217842278423784247842578426784277842878429784307843178432784337843478435784367843778438784397844078441784427844378444784457844678447784487844978450784517845278453784547845578456784577845878459784607846178462784637846478465784667846778468784697847078471784727847378474784757847678477784787847978480784817848278483784847848578486784877848878489784907849178492784937849478495784967849778498784997850078501785027850378504785057850678507785087850978510785117851278513785147851578516785177851878519785207852178522785237852478525785267852778528785297853078531785327853378534785357853678537785387853978540785417854278543785447854578546785477854878549785507855178552785537855478555785567855778558785597856078561785627856378564785657856678567785687856978570785717857278573785747857578576785777857878579785807858178582785837858478585785867858778588785897859078591785927859378594785957859678597785987859978600786017860278603786047860578606786077860878609786107861178612786137861478615786167861778618786197862078621786227862378624786257862678627786287862978630786317863278633786347863578636786377863878639786407864178642786437864478645786467864778648786497865078651786527865378654786557865678657786587865978660786617866278663786647866578666786677866878669786707867178672786737867478675786767867778678786797868078681786827868378684786857868678687786887868978690786917869278693786947869578696786977869878699787007870178702787037870478705787067870778708787097871078711787127871378714787157871678717787187871978720787217872278723787247872578726787277872878729787307873178732787337873478735787367873778738787397874078741787427874378744787457874678747787487874978750787517875278753787547875578756787577875878759787607876178762787637876478765787667876778768787697877078771787727877378774787757877678777787787877978780787817878278783787847878578786787877878878789787907879178792787937879478795787967879778798787997880078801788027880378804788057880678807788087880978810788117881278813788147881578816788177881878819788207882178822788237882478825788267882778828788297883078831788327883378834788357883678837788387883978840788417884278843788447884578846788477884878849788507885178852788537885478855788567885778858788597886078861788627886378864788657886678867788687886978870788717887278873788747887578876788777887878879788807888178882788837888478885788867888778888788897889078891788927889378894788957889678897788987889978900789017890278903789047890578906789077890878909789107891178912789137891478915789167891778918789197892078921789227892378924789257892678927789287892978930789317893278933789347893578936789377893878939789407894178942789437894478945789467894778948789497895078951789527895378954789557895678957789587895978960789617896278963789647896578966789677896878969789707897178972789737897478975789767897778978789797898078981789827898378984789857898678987789887898978990789917899278993789947899578996789977899878999790007900179002790037900479005790067900779008790097901079011790127901379014790157901679017790187901979020790217902279023790247902579026790277902879029790307903179032790337903479035790367903779038790397904079041790427904379044790457904679047790487904979050790517905279053790547905579056790577905879059790607906179062790637906479065790667906779068790697907079071790727907379074790757907679077790787907979080790817908279083790847908579086790877908879089790907909179092790937909479095790967909779098790997910079101791027910379104791057910679107791087910979110791117911279113791147911579116791177911879119791207912179122791237912479125791267912779128791297913079131791327913379134791357913679137791387913979140791417914279143791447914579146791477914879149791507915179152791537915479155791567915779158791597916079161791627916379164791657916679167791687916979170791717917279173791747917579176791777917879179791807918179182791837918479185791867918779188791897919079191791927919379194791957919679197791987919979200792017920279203792047920579206792077920879209792107921179212792137921479215792167921779218792197922079221792227922379224792257922679227792287922979230792317923279233792347923579236792377923879239792407924179242792437924479245792467924779248792497925079251792527925379254792557925679257792587925979260792617926279263792647926579266792677926879269792707927179272792737927479275792767927779278792797928079281792827928379284792857928679287792887928979290792917929279293792947929579296792977929879299793007930179302793037930479305793067930779308793097931079311793127931379314793157931679317793187931979320793217932279323793247932579326793277932879329793307933179332793337933479335793367933779338793397934079341793427934379344793457934679347793487934979350793517935279353793547935579356793577935879359793607936179362793637936479365793667936779368793697937079371793727937379374793757937679377793787937979380793817938279383793847938579386793877938879389793907939179392793937939479395793967939779398793997940079401794027940379404794057940679407794087940979410794117941279413794147941579416794177941879419794207942179422794237942479425794267942779428794297943079431794327943379434794357943679437794387943979440794417944279443794447944579446794477944879449794507945179452794537945479455794567945779458794597946079461794627946379464794657946679467794687946979470794717947279473794747947579476794777947879479794807948179482794837948479485794867948779488794897949079491794927949379494794957949679497794987949979500795017950279503795047950579506795077950879509795107951179512795137951479515795167951779518795197952079521795227952379524795257952679527795287952979530795317953279533795347953579536795377953879539795407954179542795437954479545795467954779548795497955079551795527955379554795557955679557795587955979560795617956279563795647956579566795677956879569795707957179572795737957479575795767957779578795797958079581795827958379584795857958679587795887958979590795917959279593795947959579596795977959879599796007960179602796037960479605796067960779608796097961079611796127961379614796157961679617796187961979620796217962279623796247962579626796277962879629796307963179632796337963479635796367963779638796397964079641796427964379644796457964679647796487964979650796517965279653796547965579656796577965879659796607966179662796637966479665796667966779668796697967079671796727967379674796757967679677796787967979680796817968279683796847968579686796877968879689796907969179692796937969479695796967969779698796997970079701797027970379704797057970679707797087970979710797117971279713797147971579716797177971879719797207972179722797237972479725797267972779728797297973079731797327973379734797357973679737797387973979740797417974279743797447974579746797477974879749797507975179752797537975479755797567975779758797597976079761797627976379764797657976679767797687976979770797717977279773797747977579776797777977879779797807978179782797837978479785797867978779788797897979079791797927979379794797957979679797797987979979800798017980279803798047980579806798077980879809798107981179812798137981479815798167981779818798197982079821798227982379824798257982679827798287982979830798317983279833798347983579836798377983879839798407984179842798437984479845798467984779848798497985079851798527985379854798557985679857798587985979860798617986279863798647986579866798677986879869798707987179872798737987479875798767987779878798797988079881798827988379884798857988679887798887988979890798917989279893798947989579896798977989879899799007990179902799037990479905799067990779908799097991079911799127991379914799157991679917799187991979920799217992279923799247992579926799277992879929799307993179932799337993479935799367993779938799397994079941799427994379944799457994679947799487994979950799517995279953799547995579956799577995879959799607996179962799637996479965799667996779968799697997079971799727997379974799757997679977799787997979980799817998279983799847998579986799877998879989799907999179992799937999479995799967999779998799998000080001800028000380004800058000680007800088000980010800118001280013800148001580016800178001880019800208002180022800238002480025800268002780028800298003080031800328003380034800358003680037800388003980040800418004280043800448004580046800478004880049800508005180052800538005480055800568005780058800598006080061800628006380064800658006680067800688006980070800718007280073800748007580076800778007880079800808008180082800838008480085800868008780088800898009080091800928009380094800958009680097800988009980100801018010280103801048010580106801078010880109801108011180112801138011480115801168011780118801198012080121801228012380124801258012680127801288012980130801318013280133801348013580136801378013880139801408014180142801438014480145801468014780148801498015080151801528015380154801558015680157801588015980160801618016280163801648016580166801678016880169801708017180172801738017480175801768017780178801798018080181801828018380184801858018680187801888018980190801918019280193801948019580196801978019880199802008020180202802038020480205802068020780208802098021080211802128021380214802158021680217802188021980220802218022280223802248022580226802278022880229802308023180232802338023480235802368023780238802398024080241802428024380244802458024680247802488024980250802518025280253802548025580256802578025880259802608026180262802638026480265802668026780268802698027080271802728027380274802758027680277802788027980280802818028280283802848028580286802878028880289802908029180292802938029480295802968029780298802998030080301803028030380304803058030680307803088030980310803118031280313803148031580316803178031880319803208032180322803238032480325803268032780328803298033080331803328033380334803358033680337803388033980340803418034280343803448034580346803478034880349803508035180352803538035480355803568035780358803598036080361803628036380364803658036680367803688036980370803718037280373803748037580376803778037880379803808038180382803838038480385803868038780388803898039080391803928039380394803958039680397803988039980400804018040280403804048040580406804078040880409804108041180412804138041480415804168041780418804198042080421804228042380424804258042680427804288042980430804318043280433804348043580436804378043880439804408044180442804438044480445804468044780448804498045080451804528045380454804558045680457804588045980460804618046280463804648046580466804678046880469804708047180472804738047480475804768047780478804798048080481804828048380484804858048680487804888048980490804918049280493804948049580496804978049880499805008050180502805038050480505805068050780508805098051080511805128051380514805158051680517805188051980520805218052280523805248052580526805278052880529805308053180532805338053480535805368053780538805398054080541805428054380544805458054680547805488054980550805518055280553805548055580556805578055880559805608056180562805638056480565805668056780568805698057080571805728057380574805758057680577805788057980580805818058280583805848058580586805878058880589805908059180592805938059480595805968059780598805998060080601806028060380604806058060680607806088060980610806118061280613806148061580616806178061880619806208062180622806238062480625806268062780628806298063080631806328063380634806358063680637806388063980640806418064280643806448064580646806478064880649806508065180652806538065480655806568065780658806598066080661806628066380664806658066680667806688066980670806718067280673806748067580676806778067880679806808068180682806838068480685806868068780688806898069080691806928069380694806958069680697806988069980700807018070280703807048070580706807078070880709807108071180712807138071480715807168071780718807198072080721807228072380724807258072680727807288072980730807318073280733807348073580736807378073880739807408074180742807438074480745807468074780748807498075080751807528075380754807558075680757807588075980760807618076280763807648076580766807678076880769807708077180772807738077480775807768077780778807798078080781807828078380784807858078680787807888078980790807918079280793807948079580796807978079880799808008080180802808038080480805808068080780808808098081080811808128081380814808158081680817808188081980820808218082280823808248082580826808278082880829808308083180832808338083480835808368083780838808398084080841808428084380844808458084680847808488084980850808518085280853808548085580856808578085880859808608086180862808638086480865808668086780868808698087080871808728087380874808758087680877808788087980880808818088280883808848088580886808878088880889808908089180892808938089480895808968089780898808998090080901809028090380904809058090680907809088090980910809118091280913809148091580916809178091880919809208092180922809238092480925809268092780928809298093080931809328093380934809358093680937809388093980940809418094280943809448094580946809478094880949809508095180952809538095480955809568095780958809598096080961809628096380964809658096680967809688096980970809718097280973809748097580976809778097880979809808098180982809838098480985809868098780988809898099080991809928099380994809958099680997809988099981000810018100281003810048100581006810078100881009810108101181012810138101481015810168101781018810198102081021810228102381024810258102681027810288102981030810318103281033810348103581036810378103881039810408104181042810438104481045810468104781048810498105081051810528105381054810558105681057810588105981060810618106281063810648106581066810678106881069810708107181072810738107481075810768107781078810798108081081810828108381084810858108681087810888108981090810918109281093810948109581096810978109881099811008110181102811038110481105811068110781108811098111081111811128111381114811158111681117811188111981120811218112281123811248112581126811278112881129811308113181132811338113481135811368113781138811398114081141811428114381144811458114681147811488114981150811518115281153811548115581156811578115881159811608116181162811638116481165811668116781168811698117081171811728117381174811758117681177811788117981180811818118281183811848118581186811878118881189811908119181192811938119481195811968119781198811998120081201812028120381204812058120681207812088120981210812118121281213812148121581216812178121881219812208122181222812238122481225812268122781228812298123081231812328123381234812358123681237812388123981240812418124281243812448124581246812478124881249812508125181252812538125481255812568125781258812598126081261812628126381264812658126681267812688126981270812718127281273812748127581276812778127881279812808128181282812838128481285812868128781288812898129081291812928129381294812958129681297812988129981300813018130281303813048130581306813078130881309813108131181312813138131481315813168131781318813198132081321813228132381324813258132681327813288132981330813318133281333813348133581336813378133881339813408134181342813438134481345813468134781348813498135081351813528135381354813558135681357813588135981360813618136281363813648136581366813678136881369813708137181372813738137481375813768137781378813798138081381813828138381384813858138681387813888138981390813918139281393813948139581396813978139881399814008140181402814038140481405814068140781408814098141081411814128141381414814158141681417814188141981420814218142281423814248142581426814278142881429814308143181432814338143481435814368143781438814398144081441814428144381444814458144681447814488144981450814518145281453814548145581456814578145881459814608146181462814638146481465814668146781468814698147081471814728147381474814758147681477814788147981480814818148281483814848148581486814878148881489814908149181492814938149481495814968149781498814998150081501815028150381504815058150681507815088150981510815118151281513815148151581516815178151881519815208152181522815238152481525815268152781528815298153081531815328153381534815358153681537815388153981540815418154281543815448154581546815478154881549815508155181552815538155481555815568155781558815598156081561815628156381564815658156681567815688156981570815718157281573815748157581576815778157881579815808158181582815838158481585815868158781588815898159081591815928159381594815958159681597815988159981600816018160281603816048160581606816078160881609816108161181612816138161481615816168161781618816198162081621816228162381624816258162681627816288162981630816318163281633816348163581636816378163881639816408164181642816438164481645816468164781648816498165081651816528165381654816558165681657816588165981660816618166281663816648166581666816678166881669816708167181672816738167481675816768167781678816798168081681816828168381684816858168681687816888168981690816918169281693816948169581696816978169881699817008170181702817038170481705817068170781708817098171081711817128171381714817158171681717817188171981720817218172281723817248172581726817278172881729817308173181732817338173481735817368173781738817398174081741817428174381744817458174681747817488174981750817518175281753817548175581756817578175881759817608176181762817638176481765817668176781768817698177081771817728177381774817758177681777817788177981780817818178281783817848178581786817878178881789817908179181792817938179481795817968179781798817998180081801818028180381804818058180681807818088180981810818118181281813818148181581816818178181881819818208182181822818238182481825818268182781828818298183081831818328183381834818358183681837818388183981840818418184281843818448184581846818478184881849818508185181852818538185481855818568185781858818598186081861818628186381864818658186681867818688186981870818718187281873818748187581876818778187881879818808188181882818838188481885818868188781888818898189081891818928189381894818958189681897818988189981900819018190281903819048190581906819078190881909819108191181912819138191481915819168191781918819198192081921819228192381924819258192681927819288192981930819318193281933819348193581936819378193881939819408194181942819438194481945819468194781948819498195081951819528195381954819558195681957819588195981960819618196281963819648196581966819678196881969819708197181972819738197481975819768197781978819798198081981819828198381984819858198681987819888198981990819918199281993819948199581996819978199881999820008200182002820038200482005820068200782008820098201082011820128201382014820158201682017820188201982020820218202282023820248202582026820278202882029820308203182032820338203482035820368203782038820398204082041820428204382044820458204682047820488204982050820518205282053820548205582056820578205882059820608206182062820638206482065820668206782068820698207082071820728207382074820758207682077820788207982080820818208282083820848208582086820878208882089820908209182092820938209482095820968209782098820998210082101821028210382104821058210682107821088210982110821118211282113821148211582116821178211882119821208212182122821238212482125821268212782128821298213082131821328213382134821358213682137821388213982140821418214282143821448214582146821478214882149821508215182152821538215482155821568215782158821598216082161821628216382164821658216682167821688216982170821718217282173821748217582176821778217882179821808218182182821838218482185821868218782188821898219082191821928219382194821958219682197821988219982200822018220282203822048220582206822078220882209822108221182212822138221482215822168221782218822198222082221822228222382224822258222682227822288222982230822318223282233822348223582236822378223882239822408224182242822438224482245822468224782248822498225082251822528225382254822558225682257822588225982260822618226282263822648226582266822678226882269822708227182272822738227482275822768227782278822798228082281822828228382284822858228682287822888228982290822918229282293822948229582296822978229882299823008230182302823038230482305823068230782308823098231082311823128231382314823158231682317823188231982320823218232282323823248232582326823278232882329823308233182332823338233482335823368233782338823398234082341823428234382344823458234682347823488234982350823518235282353823548235582356823578235882359823608236182362823638236482365823668236782368823698237082371823728237382374823758237682377823788237982380823818238282383823848238582386823878238882389823908239182392823938239482395823968239782398823998240082401824028240382404824058240682407824088240982410824118241282413824148241582416824178241882419824208242182422824238242482425824268242782428824298243082431824328243382434824358243682437824388243982440824418244282443824448244582446824478244882449824508245182452824538245482455824568245782458824598246082461824628246382464824658246682467824688246982470824718247282473824748247582476824778247882479824808248182482824838248482485824868248782488824898249082491824928249382494824958249682497824988249982500825018250282503825048250582506825078250882509825108251182512825138251482515825168251782518825198252082521825228252382524825258252682527825288252982530825318253282533825348253582536825378253882539825408254182542825438254482545825468254782548825498255082551825528255382554825558255682557825588255982560825618256282563825648256582566825678256882569825708257182572825738257482575825768257782578825798258082581825828258382584825858258682587825888258982590825918259282593825948259582596825978259882599826008260182602826038260482605826068260782608826098261082611826128261382614826158261682617826188261982620826218262282623826248262582626826278262882629826308263182632826338263482635826368263782638826398264082641826428264382644826458264682647826488264982650826518265282653826548265582656826578265882659826608266182662826638266482665826668266782668826698267082671826728267382674826758267682677826788267982680826818268282683826848268582686826878268882689826908269182692826938269482695826968269782698826998270082701827028270382704827058270682707827088270982710827118271282713827148271582716827178271882719827208272182722827238272482725827268272782728827298273082731827328273382734827358273682737827388273982740827418274282743827448274582746827478274882749827508275182752827538275482755827568275782758827598276082761827628276382764827658276682767827688276982770827718277282773827748277582776827778277882779827808278182782827838278482785827868278782788827898279082791827928279382794827958279682797827988279982800828018280282803828048280582806828078280882809828108281182812828138281482815828168281782818828198282082821828228282382824828258282682827828288282982830828318283282833828348283582836828378283882839828408284182842828438284482845828468284782848828498285082851828528285382854828558285682857828588285982860828618286282863828648286582866828678286882869828708287182872828738287482875828768287782878828798288082881828828288382884828858288682887828888288982890828918289282893828948289582896828978289882899829008290182902829038290482905829068290782908829098291082911829128291382914829158291682917829188291982920829218292282923829248292582926829278292882929829308293182932829338293482935829368293782938829398294082941829428294382944829458294682947829488294982950829518295282953829548295582956829578295882959829608296182962829638296482965829668296782968829698297082971829728297382974829758297682977829788297982980829818298282983829848298582986829878298882989829908299182992829938299482995829968299782998829998300083001830028300383004830058300683007830088300983010830118301283013830148301583016830178301883019830208302183022830238302483025830268302783028830298303083031830328303383034830358303683037830388303983040830418304283043830448304583046830478304883049830508305183052830538305483055830568305783058830598306083061830628306383064830658306683067830688306983070830718307283073830748307583076830778307883079830808308183082830838308483085830868308783088830898309083091830928309383094830958309683097830988309983100831018310283103831048310583106831078310883109831108311183112831138311483115831168311783118831198312083121831228312383124831258312683127831288312983130831318313283133831348313583136831378313883139831408314183142831438314483145831468314783148831498315083151831528315383154831558315683157831588315983160831618316283163831648316583166831678316883169831708317183172831738317483175831768317783178831798318083181831828318383184831858318683187831888318983190831918319283193831948319583196831978319883199832008320183202832038320483205832068320783208832098321083211832128321383214832158321683217832188321983220832218322283223832248322583226832278322883229832308323183232832338323483235832368323783238832398324083241832428324383244832458324683247832488324983250832518325283253832548325583256832578325883259832608326183262832638326483265832668326783268832698327083271832728327383274832758327683277832788327983280832818328283283832848328583286832878328883289832908329183292832938329483295832968329783298832998330083301833028330383304833058330683307833088330983310833118331283313833148331583316833178331883319833208332183322833238332483325833268332783328833298333083331833328333383334833358333683337833388333983340833418334283343833448334583346833478334883349833508335183352833538335483355833568335783358833598336083361833628336383364833658336683367833688336983370833718337283373833748337583376833778337883379833808338183382833838338483385833868338783388833898339083391833928339383394833958339683397833988339983400834018340283403834048340583406834078340883409834108341183412834138341483415834168341783418834198342083421834228342383424834258342683427834288342983430834318343283433834348343583436834378343883439834408344183442834438344483445834468344783448834498345083451834528345383454834558345683457834588345983460834618346283463834648346583466834678346883469834708347183472834738347483475834768347783478834798348083481834828348383484834858348683487834888348983490834918349283493834948349583496834978349883499835008350183502835038350483505835068350783508835098351083511835128351383514835158351683517835188351983520835218352283523835248352583526835278352883529835308353183532835338353483535835368353783538835398354083541835428354383544835458354683547835488354983550835518355283553835548355583556835578355883559835608356183562835638356483565835668356783568835698357083571835728357383574835758357683577835788357983580835818358283583835848358583586835878358883589835908359183592835938359483595835968359783598835998360083601836028360383604836058360683607836088360983610836118361283613836148361583616836178361883619836208362183622836238362483625836268362783628836298363083631836328363383634836358363683637836388363983640836418364283643836448364583646836478364883649836508365183652836538365483655836568365783658836598366083661836628366383664836658366683667836688366983670836718367283673836748367583676836778367883679836808368183682836838368483685836868368783688836898369083691836928369383694836958369683697836988369983700837018370283703837048370583706837078370883709837108371183712837138371483715837168371783718837198372083721837228372383724837258372683727837288372983730837318373283733837348373583736837378373883739837408374183742837438374483745837468374783748837498375083751837528375383754837558375683757837588375983760837618376283763837648376583766837678376883769837708377183772837738377483775837768377783778837798378083781837828378383784837858378683787837888378983790837918379283793837948379583796837978379883799838008380183802838038380483805838068380783808838098381083811838128381383814838158381683817838188381983820838218382283823838248382583826838278382883829838308383183832838338383483835838368383783838838398384083841838428384383844838458384683847838488384983850838518385283853838548385583856838578385883859838608386183862838638386483865838668386783868838698387083871838728387383874838758387683877838788387983880838818388283883838848388583886838878388883889838908389183892838938389483895838968389783898838998390083901839028390383904839058390683907839088390983910839118391283913839148391583916839178391883919839208392183922839238392483925839268392783928839298393083931839328393383934839358393683937839388393983940839418394283943839448394583946839478394883949839508395183952839538395483955839568395783958839598396083961839628396383964839658396683967839688396983970839718397283973839748397583976839778397883979839808398183982839838398483985839868398783988839898399083991839928399383994839958399683997839988399984000840018400284003840048400584006840078400884009840108401184012840138401484015840168401784018840198402084021840228402384024840258402684027840288402984030840318403284033840348403584036840378403884039840408404184042840438404484045840468404784048840498405084051840528405384054840558405684057840588405984060840618406284063840648406584066840678406884069840708407184072840738407484075840768407784078840798408084081840828408384084840858408684087840888408984090840918409284093840948409584096840978409884099841008410184102841038410484105841068410784108841098411084111841128411384114841158411684117841188411984120841218412284123841248412584126841278412884129841308413184132841338413484135841368413784138841398414084141841428414384144841458414684147841488414984150841518415284153841548415584156841578415884159841608416184162841638416484165841668416784168841698417084171841728417384174841758417684177841788417984180841818418284183841848418584186841878418884189841908419184192841938419484195841968419784198841998420084201842028420384204842058420684207842088420984210842118421284213842148421584216842178421884219842208422184222842238422484225842268422784228842298423084231842328423384234842358423684237842388423984240842418424284243842448424584246842478424884249842508425184252842538425484255842568425784258842598426084261842628426384264842658426684267842688426984270842718427284273842748427584276842778427884279842808428184282842838428484285842868428784288842898429084291842928429384294842958429684297842988429984300843018430284303843048430584306843078430884309843108431184312843138431484315843168431784318843198432084321843228432384324843258432684327843288432984330843318433284333843348433584336843378433884339843408434184342843438434484345843468434784348843498435084351843528435384354843558435684357843588435984360843618436284363843648436584366843678436884369843708437184372843738437484375843768437784378843798438084381843828438384384843858438684387843888438984390843918439284393843948439584396843978439884399844008440184402844038440484405844068440784408844098441084411844128441384414844158441684417844188441984420844218442284423844248442584426844278442884429844308443184432844338443484435844368443784438844398444084441844428444384444844458444684447844488444984450844518445284453844548445584456844578445884459844608446184462844638446484465844668446784468844698447084471844728447384474844758447684477844788447984480844818448284483844848448584486844878448884489844908449184492844938449484495844968449784498844998450084501845028450384504845058450684507845088450984510845118451284513845148451584516845178451884519845208452184522845238452484525845268452784528845298453084531845328453384534845358453684537845388453984540845418454284543845448454584546845478454884549845508455184552845538455484555845568455784558845598456084561845628456384564845658456684567845688456984570845718457284573845748457584576845778457884579845808458184582845838458484585845868458784588845898459084591845928459384594845958459684597845988459984600846018460284603846048460584606846078460884609846108461184612846138461484615846168461784618846198462084621846228462384624846258462684627846288462984630846318463284633846348463584636846378463884639846408464184642846438464484645846468464784648846498465084651846528465384654846558465684657846588465984660846618466284663846648466584666846678466884669846708467184672846738467484675846768467784678846798468084681846828468384684846858468684687846888468984690846918469284693846948469584696846978469884699847008470184702847038470484705847068470784708847098471084711847128471384714847158471684717847188471984720847218472284723847248472584726847278472884729847308473184732847338473484735847368473784738847398474084741847428474384744847458474684747847488474984750847518475284753847548475584756847578475884759847608476184762847638476484765847668476784768847698477084771847728477384774847758477684777847788477984780847818478284783847848478584786847878478884789847908479184792847938479484795847968479784798847998480084801848028480384804848058480684807848088480984810848118481284813848148481584816848178481884819848208482184822848238482484825848268482784828848298483084831848328483384834848358483684837848388483984840848418484284843848448484584846848478484884849848508485184852848538485484855848568485784858848598486084861848628486384864848658486684867848688486984870848718487284873848748487584876848778487884879848808488184882848838488484885848868488784888848898489084891848928489384894848958489684897848988489984900849018490284903849048490584906849078490884909849108491184912849138491484915849168491784918849198492084921849228492384924849258492684927849288492984930849318493284933849348493584936849378493884939849408494184942849438494484945849468494784948849498495084951849528495384954849558495684957849588495984960849618496284963849648496584966849678496884969849708497184972849738497484975849768497784978849798498084981849828498384984849858498684987849888498984990849918499284993849948499584996849978499884999850008500185002850038500485005850068500785008850098501085011850128501385014850158501685017850188501985020850218502285023850248502585026850278502885029850308503185032850338503485035850368503785038850398504085041850428504385044850458504685047850488504985050850518505285053850548505585056850578505885059850608506185062850638506485065850668506785068850698507085071850728507385074850758507685077850788507985080850818508285083850848508585086850878508885089850908509185092850938509485095850968509785098850998510085101851028510385104851058510685107851088510985110851118511285113851148511585116851178511885119851208512185122851238512485125851268512785128851298513085131851328513385134851358513685137851388513985140851418514285143851448514585146851478514885149851508515185152851538515485155851568515785158851598516085161851628516385164851658516685167851688516985170851718517285173851748517585176851778517885179851808518185182851838518485185851868518785188851898519085191851928519385194851958519685197851988519985200852018520285203852048520585206852078520885209852108521185212852138521485215852168521785218852198522085221852228522385224852258522685227852288522985230852318523285233852348523585236852378523885239852408524185242852438524485245852468524785248852498525085251852528525385254852558525685257852588525985260852618526285263852648526585266852678526885269852708527185272852738527485275852768527785278852798528085281852828528385284852858528685287852888528985290852918529285293852948529585296852978529885299853008530185302853038530485305853068530785308853098531085311853128531385314853158531685317853188531985320853218532285323853248532585326853278532885329853308533185332853338533485335853368533785338853398534085341853428534385344853458534685347853488534985350853518535285353853548535585356853578535885359853608536185362853638536485365853668536785368853698537085371853728537385374853758537685377853788537985380853818538285383853848538585386853878538885389853908539185392853938539485395853968539785398853998540085401854028540385404854058540685407854088540985410854118541285413854148541585416854178541885419854208542185422854238542485425854268542785428854298543085431854328543385434854358543685437854388543985440854418544285443854448544585446854478544885449854508545185452854538545485455854568545785458854598546085461854628546385464854658546685467854688546985470854718547285473854748547585476854778547885479854808548185482854838548485485854868548785488854898549085491854928549385494854958549685497854988549985500855018550285503855048550585506855078550885509855108551185512855138551485515855168551785518855198552085521855228552385524855258552685527855288552985530855318553285533855348553585536855378553885539855408554185542855438554485545855468554785548855498555085551855528555385554855558555685557855588555985560855618556285563855648556585566855678556885569855708557185572855738557485575855768557785578855798558085581855828558385584855858558685587855888558985590855918559285593855948559585596855978559885599856008560185602856038560485605856068560785608856098561085611856128561385614856158561685617856188561985620856218562285623856248562585626856278562885629856308563185632856338563485635856368563785638856398564085641856428564385644856458564685647856488564985650856518565285653856548565585656856578565885659856608566185662856638566485665856668566785668856698567085671856728567385674856758567685677856788567985680856818568285683856848568585686856878568885689856908569185692856938569485695856968569785698856998570085701857028570385704857058570685707857088570985710857118571285713857148571585716857178571885719857208572185722857238572485725857268572785728857298573085731857328573385734857358573685737857388573985740857418574285743857448574585746857478574885749857508575185752857538575485755857568575785758857598576085761857628576385764857658576685767857688576985770857718577285773857748577585776857778577885779857808578185782857838578485785857868578785788857898579085791857928579385794857958579685797857988579985800858018580285803858048580585806858078580885809858108581185812858138581485815858168581785818858198582085821858228582385824858258582685827858288582985830858318583285833858348583585836858378583885839858408584185842858438584485845858468584785848858498585085851858528585385854858558585685857858588585985860858618586285863858648586585866858678586885869858708587185872858738587485875858768587785878858798588085881858828588385884858858588685887858888588985890858918589285893858948589585896858978589885899859008590185902859038590485905859068590785908859098591085911859128591385914859158591685917859188591985920859218592285923859248592585926859278592885929859308593185932859338593485935859368593785938859398594085941859428594385944859458594685947859488594985950859518595285953859548595585956859578595885959859608596185962859638596485965859668596785968859698597085971859728597385974859758597685977859788597985980859818598285983859848598585986859878598885989859908599185992859938599485995859968599785998859998600086001860028600386004860058600686007860088600986010860118601286013860148601586016860178601886019860208602186022860238602486025860268602786028860298603086031860328603386034860358603686037860388603986040860418604286043860448604586046860478604886049860508605186052860538605486055860568605786058860598606086061860628606386064860658606686067860688606986070860718607286073860748607586076860778607886079860808608186082860838608486085860868608786088860898609086091860928609386094860958609686097860988609986100861018610286103861048610586106861078610886109861108611186112861138611486115861168611786118861198612086121861228612386124861258612686127861288612986130861318613286133861348613586136861378613886139861408614186142861438614486145861468614786148861498615086151861528615386154861558615686157861588615986160861618616286163861648616586166861678616886169861708617186172861738617486175861768617786178861798618086181861828618386184861858618686187861888618986190861918619286193861948619586196861978619886199862008620186202862038620486205862068620786208862098621086211862128621386214862158621686217862188621986220862218622286223862248622586226862278622886229862308623186232862338623486235862368623786238862398624086241862428624386244862458624686247862488624986250862518625286253862548625586256862578625886259862608626186262862638626486265862668626786268862698627086271862728627386274862758627686277862788627986280862818628286283862848628586286862878628886289862908629186292862938629486295862968629786298862998630086301863028630386304863058630686307863088630986310863118631286313863148631586316863178631886319863208632186322863238632486325863268632786328863298633086331863328633386334863358633686337863388633986340863418634286343863448634586346863478634886349863508635186352863538635486355863568635786358863598636086361863628636386364863658636686367863688636986370863718637286373863748637586376863778637886379863808638186382863838638486385863868638786388863898639086391863928639386394863958639686397863988639986400864018640286403864048640586406864078640886409864108641186412864138641486415864168641786418864198642086421864228642386424864258642686427864288642986430864318643286433864348643586436864378643886439864408644186442864438644486445864468644786448864498645086451864528645386454864558645686457864588645986460864618646286463864648646586466864678646886469864708647186472864738647486475864768647786478864798648086481864828648386484864858648686487864888648986490864918649286493864948649586496864978649886499865008650186502865038650486505865068650786508865098651086511865128651386514865158651686517865188651986520865218652286523865248652586526865278652886529865308653186532865338653486535865368653786538865398654086541865428654386544865458654686547865488654986550865518655286553865548655586556865578655886559865608656186562865638656486565865668656786568865698657086571865728657386574865758657686577865788657986580865818658286583865848658586586865878658886589865908659186592865938659486595865968659786598865998660086601866028660386604866058660686607866088660986610866118661286613866148661586616866178661886619866208662186622866238662486625866268662786628866298663086631866328663386634866358663686637866388663986640866418664286643866448664586646866478664886649866508665186652866538665486655866568665786658866598666086661866628666386664866658666686667866688666986670866718667286673866748667586676866778667886679866808668186682866838668486685866868668786688866898669086691866928669386694866958669686697866988669986700867018670286703867048670586706867078670886709867108671186712867138671486715867168671786718867198672086721867228672386724867258672686727867288672986730867318673286733867348673586736867378673886739867408674186742867438674486745867468674786748867498675086751867528675386754867558675686757867588675986760867618676286763867648676586766867678676886769867708677186772867738677486775867768677786778867798678086781867828678386784867858678686787867888678986790867918679286793867948679586796867978679886799868008680186802868038680486805868068680786808868098681086811868128681386814868158681686817868188681986820868218682286823868248682586826868278682886829868308683186832868338683486835868368683786838868398684086841868428684386844868458684686847868488684986850868518685286853868548685586856868578685886859868608686186862868638686486865868668686786868868698687086871868728687386874868758687686877868788687986880868818688286883868848688586886868878688886889868908689186892868938689486895868968689786898868998690086901869028690386904869058690686907869088690986910869118691286913869148691586916869178691886919869208692186922869238692486925869268692786928869298693086931869328693386934869358693686937869388693986940869418694286943869448694586946869478694886949869508695186952869538695486955869568695786958869598696086961869628696386964869658696686967869688696986970869718697286973869748697586976869778697886979869808698186982869838698486985869868698786988869898699086991869928699386994869958699686997869988699987000870018700287003870048700587006870078700887009870108701187012870138701487015870168701787018870198702087021870228702387024870258702687027870288702987030870318703287033870348703587036870378703887039870408704187042870438704487045870468704787048870498705087051870528705387054870558705687057870588705987060870618706287063870648706587066870678706887069870708707187072870738707487075870768707787078870798708087081870828708387084870858708687087870888708987090870918709287093870948709587096870978709887099871008710187102871038710487105871068710787108871098711087111871128711387114871158711687117871188711987120871218712287123871248712587126871278712887129871308713187132871338713487135871368713787138871398714087141871428714387144871458714687147871488714987150871518715287153871548715587156871578715887159871608716187162871638716487165871668716787168871698717087171871728717387174871758717687177871788717987180871818718287183871848718587186871878718887189871908719187192871938719487195871968719787198871998720087201872028720387204872058720687207872088720987210872118721287213872148721587216872178721887219872208722187222872238722487225872268722787228872298723087231872328723387234872358723687237872388723987240872418724287243872448724587246872478724887249872508725187252872538725487255872568725787258872598726087261872628726387264872658726687267872688726987270872718727287273872748727587276872778727887279872808728187282872838728487285872868728787288872898729087291872928729387294872958729687297872988729987300873018730287303873048730587306873078730887309873108731187312873138731487315873168731787318873198732087321873228732387324873258732687327873288732987330873318733287333873348733587336873378733887339873408734187342873438734487345873468734787348873498735087351873528735387354873558735687357873588735987360873618736287363873648736587366873678736887369873708737187372873738737487375873768737787378873798738087381873828738387384873858738687387873888738987390873918739287393873948739587396873978739887399874008740187402874038740487405874068740787408874098741087411874128741387414874158741687417874188741987420874218742287423874248742587426874278742887429874308743187432874338743487435874368743787438874398744087441874428744387444874458744687447874488744987450874518745287453874548745587456874578745887459874608746187462874638746487465874668746787468874698747087471874728747387474874758747687477874788747987480874818748287483874848748587486874878748887489874908749187492874938749487495874968749787498874998750087501875028750387504875058750687507875088750987510875118751287513875148751587516875178751887519875208752187522875238752487525875268752787528875298753087531875328753387534875358753687537875388753987540875418754287543875448754587546875478754887549875508755187552875538755487555875568755787558875598756087561875628756387564875658756687567875688756987570875718757287573875748757587576875778757887579875808758187582875838758487585875868758787588875898759087591875928759387594875958759687597875988759987600876018760287603876048760587606876078760887609876108761187612876138761487615876168761787618876198762087621876228762387624876258762687627876288762987630876318763287633876348763587636876378763887639876408764187642876438764487645876468764787648876498765087651876528765387654876558765687657876588765987660876618766287663876648766587666876678766887669876708767187672876738767487675876768767787678876798768087681876828768387684876858768687687876888768987690876918769287693876948769587696876978769887699877008770187702877038770487705877068770787708877098771087711877128771387714877158771687717877188771987720877218772287723877248772587726877278772887729877308773187732877338773487735877368773787738877398774087741877428774387744877458774687747877488774987750877518775287753877548775587756877578775887759877608776187762877638776487765877668776787768877698777087771877728777387774877758777687777877788777987780877818778287783877848778587786877878778887789877908779187792877938779487795877968779787798877998780087801878028780387804878058780687807878088780987810878118781287813878148781587816878178781887819878208782187822878238782487825878268782787828878298783087831878328783387834878358783687837878388783987840878418784287843878448784587846878478784887849878508785187852878538785487855878568785787858878598786087861878628786387864878658786687867878688786987870878718787287873878748787587876878778787887879878808788187882878838788487885878868788787888878898789087891878928789387894878958789687897878988789987900879018790287903879048790587906879078790887909879108791187912879138791487915879168791787918879198792087921879228792387924879258792687927879288792987930879318793287933879348793587936879378793887939879408794187942879438794487945879468794787948879498795087951879528795387954879558795687957879588795987960879618796287963879648796587966879678796887969879708797187972879738797487975879768797787978879798798087981879828798387984879858798687987879888798987990879918799287993879948799587996879978799887999880008800188002880038800488005880068800788008880098801088011880128801388014880158801688017880188801988020880218802288023880248802588026880278802888029880308803188032880338803488035880368803788038880398804088041880428804388044880458804688047880488804988050880518805288053880548805588056880578805888059880608806188062880638806488065880668806788068880698807088071880728807388074880758807688077880788807988080880818808288083880848808588086880878808888089880908809188092880938809488095880968809788098880998810088101881028810388104881058810688107881088810988110881118811288113881148811588116881178811888119881208812188122881238812488125881268812788128881298813088131881328813388134881358813688137881388813988140881418814288143881448814588146881478814888149881508815188152881538815488155881568815788158881598816088161881628816388164881658816688167881688816988170881718817288173881748817588176881778817888179881808818188182881838818488185881868818788188881898819088191881928819388194881958819688197881988819988200882018820288203882048820588206882078820888209882108821188212882138821488215882168821788218882198822088221882228822388224882258822688227882288822988230882318823288233882348823588236882378823888239882408824188242882438824488245882468824788248882498825088251882528825388254882558825688257882588825988260882618826288263882648826588266882678826888269882708827188272882738827488275882768827788278882798828088281882828828388284882858828688287882888828988290882918829288293882948829588296882978829888299883008830188302883038830488305883068830788308883098831088311883128831388314883158831688317883188831988320883218832288323883248832588326883278832888329883308833188332883338833488335883368833788338883398834088341883428834388344883458834688347883488834988350883518835288353883548835588356883578835888359883608836188362883638836488365883668836788368883698837088371883728837388374883758837688377883788837988380883818838288383883848838588386883878838888389883908839188392883938839488395883968839788398883998840088401884028840388404884058840688407884088840988410884118841288413884148841588416884178841888419884208842188422884238842488425884268842788428884298843088431884328843388434884358843688437884388843988440884418844288443884448844588446884478844888449884508845188452884538845488455884568845788458884598846088461884628846388464884658846688467884688846988470884718847288473884748847588476884778847888479884808848188482884838848488485884868848788488884898849088491884928849388494884958849688497884988849988500885018850288503885048850588506885078850888509885108851188512885138851488515885168851788518885198852088521885228852388524885258852688527885288852988530885318853288533885348853588536885378853888539885408854188542885438854488545885468854788548885498855088551885528855388554885558855688557885588855988560885618856288563885648856588566885678856888569885708857188572885738857488575885768857788578885798858088581885828858388584885858858688587885888858988590885918859288593885948859588596885978859888599886008860188602886038860488605886068860788608886098861088611886128861388614886158861688617886188861988620886218862288623886248862588626886278862888629886308863188632886338863488635886368863788638886398864088641886428864388644886458864688647886488864988650886518865288653886548865588656886578865888659886608866188662886638866488665886668866788668886698867088671886728867388674886758867688677886788867988680886818868288683886848868588686886878868888689886908869188692886938869488695886968869788698886998870088701887028870388704887058870688707887088870988710887118871288713887148871588716887178871888719887208872188722887238872488725887268872788728887298873088731887328873388734887358873688737887388873988740887418874288743887448874588746887478874888749887508875188752887538875488755887568875788758887598876088761887628876388764887658876688767887688876988770887718877288773887748877588776887778877888779887808878188782887838878488785887868878788788887898879088791887928879388794887958879688797887988879988800888018880288803888048880588806888078880888809888108881188812888138881488815888168881788818888198882088821888228882388824888258882688827888288882988830888318883288833888348883588836888378883888839888408884188842888438884488845888468884788848888498885088851888528885388854888558885688857888588885988860888618886288863888648886588866888678886888869888708887188872888738887488875888768887788878888798888088881888828888388884888858888688887888888888988890888918889288893888948889588896888978889888899889008890188902889038890488905889068890788908889098891088911889128891388914889158891688917889188891988920889218892288923889248892588926889278892888929889308893188932889338893488935889368893788938889398894088941889428894388944889458894688947889488894988950889518895288953889548895588956889578895888959889608896188962889638896488965889668896788968889698897088971889728897388974889758897688977889788897988980889818898288983889848898588986889878898888989889908899188992889938899488995889968899788998889998900089001890028900389004890058900689007890088900989010890118901289013890148901589016890178901889019890208902189022890238902489025890268902789028890298903089031890328903389034890358903689037890388903989040890418904289043890448904589046890478904889049890508905189052890538905489055890568905789058890598906089061890628906389064890658906689067890688906989070890718907289073890748907589076890778907889079890808908189082890838908489085890868908789088890898909089091890928909389094890958909689097890988909989100891018910289103891048910589106891078910889109891108911189112891138911489115891168911789118891198912089121891228912389124891258912689127891288912989130891318913289133891348913589136891378913889139891408914189142891438914489145891468914789148891498915089151891528915389154891558915689157891588915989160891618916289163891648916589166891678916889169891708917189172891738917489175891768917789178891798918089181891828918389184891858918689187891888918989190891918919289193891948919589196891978919889199892008920189202892038920489205892068920789208892098921089211892128921389214892158921689217892188921989220892218922289223892248922589226892278922889229892308923189232892338923489235892368923789238892398924089241892428924389244892458924689247892488924989250892518925289253892548925589256892578925889259892608926189262892638926489265892668926789268892698927089271892728927389274892758927689277892788927989280892818928289283892848928589286892878928889289892908929189292892938929489295892968929789298892998930089301893028930389304893058930689307893088930989310893118931289313893148931589316893178931889319893208932189322893238932489325893268932789328893298933089331893328933389334893358933689337893388933989340893418934289343893448934589346893478934889349893508935189352893538935489355893568935789358893598936089361893628936389364893658936689367893688936989370893718937289373893748937589376893778937889379893808938189382893838938489385893868938789388893898939089391893928939389394893958939689397893988939989400894018940289403894048940589406894078940889409894108941189412894138941489415894168941789418894198942089421894228942389424894258942689427894288942989430894318943289433894348943589436894378943889439894408944189442894438944489445894468944789448894498945089451894528945389454894558945689457894588945989460894618946289463894648946589466894678946889469894708947189472894738947489475894768947789478894798948089481894828948389484894858948689487894888948989490894918949289493894948949589496894978949889499895008950189502895038950489505895068950789508895098951089511895128951389514895158951689517895188951989520895218952289523895248952589526895278952889529895308953189532895338953489535895368953789538895398954089541895428954389544895458954689547895488954989550895518955289553895548955589556895578955889559895608956189562895638956489565895668956789568895698957089571895728957389574895758957689577895788957989580895818958289583895848958589586895878958889589895908959189592895938959489595895968959789598895998960089601896028960389604896058960689607896088960989610896118961289613896148961589616896178961889619896208962189622896238962489625896268962789628896298963089631896328963389634896358963689637896388963989640896418964289643896448964589646896478964889649896508965189652896538965489655896568965789658896598966089661896628966389664896658966689667896688966989670896718967289673896748967589676896778967889679896808968189682896838968489685896868968789688896898969089691896928969389694896958969689697896988969989700897018970289703897048970589706897078970889709897108971189712897138971489715897168971789718897198972089721897228972389724897258972689727897288972989730897318973289733897348973589736897378973889739897408974189742897438974489745897468974789748897498975089751897528975389754897558975689757897588975989760897618976289763897648976589766897678976889769897708977189772897738977489775897768977789778897798978089781897828978389784897858978689787897888978989790897918979289793897948979589796897978979889799898008980189802898038980489805898068980789808898098981089811898128981389814898158981689817898188981989820898218982289823898248982589826898278982889829898308983189832898338983489835898368983789838898398984089841898428984389844898458984689847898488984989850898518985289853898548985589856898578985889859898608986189862898638986489865898668986789868898698987089871898728987389874898758987689877898788987989880898818988289883898848988589886898878988889889898908989189892898938989489895898968989789898898998990089901899028990389904899058990689907899088990989910899118991289913899148991589916899178991889919899208992189922899238992489925899268992789928899298993089931899328993389934899358993689937899388993989940899418994289943899448994589946899478994889949899508995189952899538995489955899568995789958899598996089961899628996389964899658996689967899688996989970899718997289973899748997589976899778997889979899808998189982899838998489985899868998789988899898999089991899928999389994899958999689997899988999990000900019000290003900049000590006900079000890009900109001190012900139001490015900169001790018900199002090021900229002390024900259002690027900289002990030900319003290033900349003590036900379003890039900409004190042900439004490045900469004790048900499005090051900529005390054900559005690057900589005990060900619006290063900649006590066900679006890069900709007190072900739007490075900769007790078900799008090081900829008390084900859008690087900889008990090900919009290093900949009590096900979009890099901009010190102901039010490105901069010790108901099011090111901129011390114901159011690117901189011990120901219012290123901249012590126901279012890129901309013190132901339013490135901369013790138901399014090141901429014390144901459014690147901489014990150901519015290153901549015590156901579015890159901609016190162901639016490165901669016790168901699017090171901729017390174901759017690177901789017990180901819018290183901849018590186901879018890189901909019190192901939019490195901969019790198901999020090201902029020390204902059020690207902089020990210902119021290213902149021590216902179021890219902209022190222902239022490225902269022790228902299023090231902329023390234902359023690237902389023990240902419024290243902449024590246902479024890249902509025190252902539025490255902569025790258902599026090261902629026390264902659026690267902689026990270902719027290273902749027590276902779027890279902809028190282902839028490285902869028790288902899029090291902929029390294902959029690297902989029990300903019030290303903049030590306903079030890309903109031190312903139031490315903169031790318903199032090321903229032390324903259032690327903289032990330903319033290333903349033590336903379033890339903409034190342903439034490345903469034790348903499035090351903529035390354903559035690357903589035990360903619036290363903649036590366903679036890369903709037190372903739037490375903769037790378903799038090381903829038390384903859038690387903889038990390903919039290393903949039590396903979039890399904009040190402904039040490405904069040790408904099041090411904129041390414904159041690417904189041990420904219042290423904249042590426904279042890429904309043190432904339043490435904369043790438904399044090441904429044390444904459044690447904489044990450904519045290453904549045590456904579045890459904609046190462904639046490465904669046790468904699047090471904729047390474904759047690477904789047990480904819048290483904849048590486904879048890489904909049190492904939049490495904969049790498904999050090501905029050390504905059050690507905089050990510905119051290513905149051590516905179051890519905209052190522905239052490525905269052790528905299053090531905329053390534905359053690537905389053990540905419054290543905449054590546905479054890549905509055190552905539055490555905569055790558905599056090561905629056390564905659056690567905689056990570905719057290573905749057590576905779057890579905809058190582905839058490585905869058790588905899059090591905929059390594905959059690597905989059990600906019060290603906049060590606906079060890609906109061190612906139061490615906169061790618906199062090621906229062390624906259062690627906289062990630906319063290633906349063590636906379063890639906409064190642906439064490645906469064790648906499065090651906529065390654906559065690657906589065990660906619066290663906649066590666906679066890669906709067190672906739067490675906769067790678906799068090681906829068390684906859068690687906889068990690906919069290693906949069590696906979069890699907009070190702907039070490705907069070790708907099071090711907129071390714907159071690717907189071990720907219072290723907249072590726907279072890729907309073190732907339073490735907369073790738907399074090741907429074390744907459074690747907489074990750907519075290753907549075590756907579075890759907609076190762907639076490765907669076790768907699077090771907729077390774907759077690777907789077990780907819078290783907849078590786907879078890789907909079190792907939079490795907969079790798907999080090801908029080390804908059080690807908089080990810908119081290813908149081590816908179081890819908209082190822908239082490825908269082790828908299083090831908329083390834908359083690837908389083990840908419084290843908449084590846908479084890849908509085190852908539085490855908569085790858908599086090861908629086390864908659086690867908689086990870908719087290873908749087590876908779087890879908809088190882908839088490885908869088790888908899089090891908929089390894908959089690897908989089990900909019090290903909049090590906909079090890909909109091190912909139091490915909169091790918909199092090921909229092390924909259092690927909289092990930909319093290933909349093590936909379093890939909409094190942909439094490945909469094790948909499095090951909529095390954909559095690957909589095990960909619096290963909649096590966909679096890969909709097190972909739097490975909769097790978909799098090981909829098390984909859098690987909889098990990909919099290993909949099590996909979099890999910009100191002910039100491005910069100791008910099101091011910129101391014910159101691017910189101991020910219102291023910249102591026910279102891029910309103191032910339103491035910369103791038910399104091041910429104391044910459104691047910489104991050910519105291053910549105591056910579105891059910609106191062910639106491065910669106791068910699107091071910729107391074910759107691077910789107991080910819108291083910849108591086910879108891089910909109191092910939109491095910969109791098910999110091101911029110391104911059110691107911089110991110911119111291113911149111591116911179111891119911209112191122911239112491125911269112791128911299113091131911329113391134911359113691137911389113991140911419114291143911449114591146911479114891149911509115191152911539115491155911569115791158911599116091161911629116391164911659116691167911689116991170911719117291173911749117591176911779117891179911809118191182911839118491185911869118791188911899119091191911929119391194911959119691197911989119991200912019120291203912049120591206912079120891209912109121191212912139121491215912169121791218912199122091221912229122391224912259122691227912289122991230912319123291233912349123591236912379123891239912409124191242912439124491245912469124791248912499125091251912529125391254912559125691257912589125991260912619126291263912649126591266912679126891269912709127191272912739127491275912769127791278912799128091281912829128391284912859128691287912889128991290912919129291293912949129591296912979129891299913009130191302913039130491305913069130791308913099131091311913129131391314913159131691317913189131991320913219132291323913249132591326913279132891329913309133191332913339133491335913369133791338913399134091341913429134391344913459134691347913489134991350913519135291353913549135591356913579135891359913609136191362913639136491365913669136791368913699137091371913729137391374913759137691377913789137991380913819138291383913849138591386913879138891389913909139191392913939139491395913969139791398913999140091401914029140391404914059140691407914089140991410914119141291413914149141591416914179141891419914209142191422914239142491425914269142791428914299143091431914329143391434914359143691437914389143991440914419144291443914449144591446914479144891449914509145191452914539145491455914569145791458914599146091461914629146391464914659146691467914689146991470914719147291473914749147591476914779147891479914809148191482914839148491485914869148791488914899149091491914929149391494914959149691497914989149991500915019150291503915049150591506915079150891509915109151191512915139151491515915169151791518915199152091521915229152391524915259152691527915289152991530915319153291533915349153591536915379153891539915409154191542915439154491545915469154791548915499155091551915529155391554915559155691557915589155991560915619156291563915649156591566915679156891569915709157191572915739157491575915769157791578915799158091581915829158391584915859158691587915889158991590915919159291593915949159591596915979159891599916009160191602916039160491605916069160791608916099161091611916129161391614916159161691617916189161991620916219162291623916249162591626916279162891629916309163191632916339163491635916369163791638916399164091641916429164391644916459164691647916489164991650916519165291653916549165591656916579165891659916609166191662916639166491665916669166791668916699167091671916729167391674916759167691677916789167991680916819168291683916849168591686916879168891689916909169191692916939169491695916969169791698916999170091701917029170391704917059170691707917089170991710917119171291713917149171591716917179171891719917209172191722917239172491725917269172791728917299173091731917329173391734917359173691737917389173991740917419174291743917449174591746917479174891749917509175191752917539175491755917569175791758917599176091761917629176391764917659176691767917689176991770917719177291773917749177591776917779177891779917809178191782917839178491785917869178791788917899179091791917929179391794917959179691797917989179991800918019180291803918049180591806918079180891809918109181191812918139181491815918169181791818918199182091821918229182391824918259182691827918289182991830918319183291833918349183591836918379183891839918409184191842918439184491845918469184791848918499185091851918529185391854918559185691857918589185991860918619186291863918649186591866918679186891869918709187191872918739187491875918769187791878918799188091881918829188391884918859188691887918889188991890918919189291893918949189591896918979189891899919009190191902919039190491905919069190791908919099191091911919129191391914919159191691917919189191991920919219192291923919249192591926919279192891929919309193191932919339193491935919369193791938919399194091941919429194391944919459194691947919489194991950919519195291953919549195591956919579195891959919609196191962919639196491965919669196791968919699197091971919729197391974919759197691977919789197991980919819198291983919849198591986919879198891989919909199191992919939199491995919969199791998919999200092001920029200392004920059200692007920089200992010920119201292013920149201592016920179201892019920209202192022920239202492025920269202792028920299203092031920329203392034920359203692037920389203992040920419204292043920449204592046920479204892049920509205192052920539205492055920569205792058920599206092061920629206392064920659206692067920689206992070920719207292073920749207592076920779207892079920809208192082920839208492085920869208792088920899209092091920929209392094920959209692097920989209992100921019210292103921049210592106921079210892109921109211192112921139211492115921169211792118921199212092121921229212392124921259212692127921289212992130921319213292133921349213592136921379213892139921409214192142921439214492145921469214792148921499215092151921529215392154921559215692157921589215992160921619216292163921649216592166921679216892169921709217192172921739217492175921769217792178921799218092181921829218392184921859218692187921889218992190921919219292193921949219592196921979219892199922009220192202922039220492205922069220792208922099221092211922129221392214922159221692217922189221992220922219222292223922249222592226922279222892229922309223192232922339223492235922369223792238922399224092241922429224392244922459224692247922489224992250922519225292253922549225592256922579225892259922609226192262922639226492265922669226792268922699227092271922729227392274922759227692277922789227992280922819228292283922849228592286922879228892289922909229192292922939229492295922969229792298922999230092301923029230392304923059230692307923089230992310923119231292313923149231592316923179231892319923209232192322923239232492325923269232792328923299233092331923329233392334923359233692337923389233992340923419234292343923449234592346923479234892349923509235192352923539235492355923569235792358923599236092361923629236392364923659236692367923689236992370923719237292373923749237592376923779237892379923809238192382923839238492385923869238792388923899239092391923929239392394923959239692397923989239992400924019240292403924049240592406924079240892409924109241192412924139241492415924169241792418924199242092421924229242392424924259242692427924289242992430924319243292433924349243592436924379243892439924409244192442924439244492445924469244792448924499245092451924529245392454924559245692457924589245992460924619246292463924649246592466924679246892469924709247192472924739247492475924769247792478924799248092481924829248392484924859248692487924889248992490924919249292493924949249592496924979249892499925009250192502925039250492505925069250792508925099251092511925129251392514925159251692517925189251992520925219252292523925249252592526925279252892529925309253192532925339253492535925369253792538925399254092541925429254392544925459254692547925489254992550925519255292553925549255592556925579255892559925609256192562925639256492565925669256792568925699257092571925729257392574925759257692577925789257992580925819258292583925849258592586925879258892589925909259192592925939259492595925969259792598925999260092601926029260392604926059260692607926089260992610926119261292613926149261592616926179261892619926209262192622926239262492625926269262792628926299263092631926329263392634926359263692637926389263992640926419264292643926449264592646926479264892649926509265192652926539265492655926569265792658926599266092661926629266392664926659266692667926689266992670926719267292673926749267592676926779267892679926809268192682926839268492685926869268792688926899269092691926929269392694926959269692697926989269992700927019270292703927049270592706927079270892709927109271192712927139271492715927169271792718927199272092721927229272392724927259272692727927289272992730927319273292733927349273592736927379273892739927409274192742927439274492745927469274792748927499275092751927529275392754927559275692757927589275992760927619276292763927649276592766927679276892769927709277192772927739277492775927769277792778927799278092781927829278392784927859278692787927889278992790927919279292793927949279592796927979279892799928009280192802928039280492805928069280792808928099281092811928129281392814928159281692817928189281992820928219282292823928249282592826928279282892829928309283192832928339283492835928369283792838928399284092841928429284392844928459284692847928489284992850928519285292853928549285592856928579285892859928609286192862928639286492865928669286792868928699287092871928729287392874928759287692877928789287992880928819288292883928849288592886928879288892889928909289192892928939289492895928969289792898928999290092901929029290392904929059290692907929089290992910929119291292913929149291592916929179291892919929209292192922929239292492925929269292792928929299293092931929329293392934929359293692937929389293992940929419294292943929449294592946929479294892949929509295192952929539295492955929569295792958929599296092961929629296392964929659296692967929689296992970929719297292973929749297592976929779297892979929809298192982929839298492985929869298792988929899299092991929929299392994929959299692997929989299993000930019300293003930049300593006930079300893009930109301193012930139301493015930169301793018930199302093021930229302393024930259302693027930289302993030930319303293033930349303593036930379303893039930409304193042930439304493045930469304793048930499305093051930529305393054930559305693057930589305993060930619306293063930649306593066930679306893069930709307193072930739307493075930769307793078930799308093081930829308393084930859308693087930889308993090930919309293093930949309593096930979309893099931009310193102931039310493105931069310793108931099311093111931129311393114931159311693117931189311993120931219312293123931249312593126931279312893129931309313193132931339313493135931369313793138931399314093141931429314393144931459314693147931489314993150931519315293153931549315593156931579315893159931609316193162931639316493165931669316793168931699317093171931729317393174931759317693177931789317993180931819318293183931849318593186931879318893189931909319193192931939319493195931969319793198931999320093201932029320393204932059320693207932089320993210932119321293213932149321593216932179321893219932209322193222932239322493225932269322793228932299323093231932329323393234932359323693237932389323993240932419324293243932449324593246932479324893249932509325193252932539325493255932569325793258932599326093261932629326393264932659326693267932689326993270932719327293273932749327593276932779327893279932809328193282932839328493285932869328793288932899329093291932929329393294932959329693297932989329993300933019330293303933049330593306933079330893309933109331193312933139331493315933169331793318933199332093321933229332393324933259332693327933289332993330933319333293333933349333593336933379333893339933409334193342933439334493345933469334793348933499335093351933529335393354933559335693357933589335993360933619336293363933649336593366933679336893369933709337193372933739337493375933769337793378933799338093381933829338393384933859338693387933889338993390933919339293393933949339593396933979339893399934009340193402934039340493405934069340793408934099341093411934129341393414934159341693417934189341993420934219342293423934249342593426934279342893429934309343193432934339343493435934369343793438934399344093441934429344393444934459344693447934489344993450934519345293453934549345593456934579345893459934609346193462934639346493465934669346793468934699347093471934729347393474934759347693477934789347993480934819348293483934849348593486934879348893489934909349193492934939349493495934969349793498934999350093501935029350393504935059350693507935089350993510935119351293513935149351593516935179351893519935209352193522935239352493525935269352793528935299353093531935329353393534935359353693537935389353993540935419354293543935449354593546935479354893549935509355193552935539355493555935569355793558935599356093561935629356393564935659356693567935689356993570935719357293573935749357593576935779357893579935809358193582935839358493585935869358793588935899359093591935929359393594935959359693597935989359993600936019360293603936049360593606936079360893609936109361193612936139361493615936169361793618936199362093621936229362393624936259362693627936289362993630936319363293633936349363593636936379363893639936409364193642936439364493645936469364793648936499365093651936529365393654936559365693657936589365993660936619366293663936649366593666936679366893669936709367193672936739367493675936769367793678936799368093681936829368393684936859368693687936889368993690936919369293693936949369593696936979369893699937009370193702937039370493705937069370793708937099371093711937129371393714937159371693717937189371993720937219372293723937249372593726937279372893729937309373193732937339373493735937369373793738937399374093741937429374393744937459374693747937489374993750937519375293753937549375593756937579375893759937609376193762937639376493765937669376793768937699377093771937729377393774937759377693777937789377993780937819378293783937849378593786937879378893789937909379193792937939379493795937969379793798937999380093801938029380393804938059380693807938089380993810938119381293813938149381593816938179381893819938209382193822938239382493825938269382793828938299383093831938329383393834938359383693837938389383993840938419384293843938449384593846938479384893849938509385193852938539385493855938569385793858938599386093861938629386393864938659386693867938689386993870938719387293873938749387593876938779387893879938809388193882938839388493885938869388793888938899389093891938929389393894938959389693897938989389993900939019390293903939049390593906939079390893909939109391193912939139391493915939169391793918939199392093921939229392393924939259392693927939289392993930939319393293933939349393593936939379393893939939409394193942939439394493945939469394793948939499395093951939529395393954939559395693957939589395993960939619396293963939649396593966939679396893969939709397193972939739397493975939769397793978939799398093981939829398393984939859398693987939889398993990939919399293993939949399593996939979399893999940009400194002940039400494005940069400794008940099401094011940129401394014940159401694017940189401994020940219402294023940249402594026940279402894029940309403194032940339403494035940369403794038940399404094041940429404394044940459404694047940489404994050940519405294053940549405594056940579405894059940609406194062940639406494065940669406794068940699407094071940729407394074940759407694077940789407994080940819408294083940849408594086940879408894089940909409194092940939409494095940969409794098940999410094101941029410394104941059410694107941089410994110941119411294113941149411594116941179411894119941209412194122941239412494125941269412794128941299413094131941329413394134941359413694137941389413994140941419414294143941449414594146941479414894149941509415194152941539415494155941569415794158941599416094161941629416394164941659416694167941689416994170941719417294173941749417594176941779417894179941809418194182941839418494185941869418794188941899419094191941929419394194941959419694197941989419994200942019420294203942049420594206942079420894209942109421194212942139421494215942169421794218942199422094221942229422394224942259422694227942289422994230942319423294233942349423594236942379423894239942409424194242942439424494245942469424794248942499425094251942529425394254942559425694257942589425994260942619426294263942649426594266942679426894269942709427194272942739427494275942769427794278942799428094281942829428394284942859428694287942889428994290942919429294293942949429594296942979429894299943009430194302943039430494305943069430794308943099431094311943129431394314943159431694317943189431994320943219432294323943249432594326943279432894329943309433194332943339433494335943369433794338943399434094341943429434394344943459434694347943489434994350943519435294353943549435594356943579435894359943609436194362943639436494365943669436794368943699437094371943729437394374943759437694377943789437994380943819438294383943849438594386943879438894389943909439194392943939439494395943969439794398943999440094401944029440394404944059440694407944089440994410944119441294413944149441594416944179441894419944209442194422944239442494425944269442794428944299443094431944329443394434944359443694437944389443994440944419444294443944449444594446944479444894449944509445194452944539445494455944569445794458944599446094461944629446394464944659446694467944689446994470944719447294473944749447594476944779447894479944809448194482944839448494485944869448794488944899449094491944929449394494944959449694497944989449994500945019450294503945049450594506945079450894509945109451194512945139451494515945169451794518945199452094521945229452394524945259452694527945289452994530945319453294533945349453594536945379453894539945409454194542945439454494545945469454794548945499455094551945529455394554945559455694557945589455994560945619456294563945649456594566945679456894569945709457194572945739457494575945769457794578945799458094581945829458394584945859458694587945889458994590945919459294593945949459594596945979459894599946009460194602946039460494605946069460794608946099461094611946129461394614946159461694617946189461994620946219462294623946249462594626946279462894629946309463194632946339463494635946369463794638946399464094641946429464394644946459464694647946489464994650946519465294653946549465594656946579465894659946609466194662946639466494665946669466794668946699467094671946729467394674946759467694677946789467994680946819468294683946849468594686946879468894689946909469194692946939469494695946969469794698946999470094701947029470394704947059470694707947089470994710947119471294713947149471594716947179471894719947209472194722947239472494725947269472794728947299473094731947329473394734947359473694737947389473994740947419474294743947449474594746947479474894749947509475194752947539475494755947569475794758947599476094761947629476394764947659476694767947689476994770947719477294773947749477594776947779477894779947809478194782947839478494785947869478794788947899479094791947929479394794947959479694797947989479994800948019480294803948049480594806948079480894809948109481194812948139481494815948169481794818948199482094821948229482394824948259482694827948289482994830948319483294833948349483594836948379483894839948409484194842948439484494845948469484794848948499485094851948529485394854948559485694857948589485994860948619486294863948649486594866948679486894869948709487194872948739487494875948769487794878948799488094881948829488394884948859488694887948889488994890948919489294893948949489594896948979489894899949009490194902949039490494905949069490794908949099491094911949129491394914949159491694917949189491994920949219492294923949249492594926949279492894929949309493194932949339493494935949369493794938949399494094941949429494394944949459494694947949489494994950949519495294953949549495594956949579495894959949609496194962949639496494965949669496794968949699497094971949729497394974949759497694977949789497994980949819498294983949849498594986949879498894989949909499194992949939499494995949969499794998949999500095001950029500395004950059500695007950089500995010950119501295013950149501595016950179501895019950209502195022950239502495025950269502795028950299503095031950329503395034950359503695037950389503995040950419504295043950449504595046950479504895049950509505195052950539505495055950569505795058950599506095061950629506395064950659506695067950689506995070950719507295073950749507595076950779507895079950809508195082950839508495085950869508795088950899509095091950929509395094950959509695097950989509995100951019510295103951049510595106951079510895109951109511195112951139511495115951169511795118951199512095121951229512395124951259512695127951289512995130951319513295133951349513595136951379513895139951409514195142951439514495145951469514795148951499515095151951529515395154951559515695157951589515995160951619516295163951649516595166951679516895169951709517195172951739517495175951769517795178951799518095181951829518395184951859518695187951889518995190951919519295193951949519595196951979519895199952009520195202952039520495205952069520795208952099521095211952129521395214952159521695217952189521995220952219522295223952249522595226952279522895229952309523195232952339523495235952369523795238952399524095241952429524395244952459524695247952489524995250952519525295253952549525595256952579525895259952609526195262952639526495265952669526795268952699527095271952729527395274952759527695277952789527995280952819528295283952849528595286952879528895289952909529195292952939529495295952969529795298952999530095301953029530395304953059530695307953089530995310953119531295313953149531595316953179531895319953209532195322953239532495325953269532795328953299533095331953329533395334953359533695337953389533995340953419534295343953449534595346953479534895349953509535195352953539535495355953569535795358953599536095361953629536395364953659536695367953689536995370953719537295373953749537595376953779537895379953809538195382953839538495385953869538795388953899539095391953929539395394953959539695397953989539995400954019540295403954049540595406954079540895409954109541195412954139541495415954169541795418954199542095421954229542395424954259542695427954289542995430954319543295433954349543595436954379543895439954409544195442954439544495445954469544795448954499545095451954529545395454954559545695457954589545995460954619546295463954649546595466954679546895469954709547195472954739547495475954769547795478954799548095481954829548395484954859548695487954889548995490954919549295493954949549595496954979549895499955009550195502955039550495505955069550795508955099551095511955129551395514955159551695517955189551995520955219552295523955249552595526955279552895529955309553195532955339553495535955369553795538955399554095541955429554395544955459554695547955489554995550955519555295553955549555595556955579555895559955609556195562955639556495565955669556795568955699557095571955729557395574955759557695577955789557995580955819558295583955849558595586955879558895589955909559195592955939559495595955969559795598955999560095601956029560395604956059560695607956089560995610956119561295613956149561595616956179561895619956209562195622956239562495625956269562795628956299563095631956329563395634956359563695637956389563995640956419564295643956449564595646956479564895649956509565195652956539565495655956569565795658956599566095661956629566395664956659566695667956689566995670956719567295673956749567595676956779567895679956809568195682956839568495685956869568795688956899569095691956929569395694956959569695697956989569995700957019570295703957049570595706957079570895709957109571195712957139571495715957169571795718957199572095721957229572395724957259572695727957289572995730957319573295733957349573595736957379573895739957409574195742957439574495745957469574795748957499575095751957529575395754957559575695757957589575995760957619576295763957649576595766957679576895769957709577195772957739577495775957769577795778957799578095781957829578395784957859578695787957889578995790957919579295793957949579595796957979579895799958009580195802958039580495805958069580795808958099581095811958129581395814958159581695817958189581995820958219582295823958249582595826958279582895829958309583195832958339583495835958369583795838958399584095841958429584395844958459584695847958489584995850958519585295853958549585595856958579585895859958609586195862958639586495865958669586795868958699587095871958729587395874958759587695877958789587995880958819588295883958849588595886958879588895889958909589195892958939589495895958969589795898958999590095901959029590395904959059590695907959089590995910959119591295913959149591595916959179591895919959209592195922959239592495925959269592795928959299593095931959329593395934959359593695937959389593995940959419594295943959449594595946959479594895949959509595195952959539595495955959569595795958959599596095961959629596395964959659596695967959689596995970959719597295973959749597595976959779597895979959809598195982959839598495985959869598795988959899599095991959929599395994959959599695997959989599996000960019600296003960049600596006960079600896009960109601196012960139601496015960169601796018960199602096021960229602396024960259602696027960289602996030960319603296033960349603596036960379603896039960409604196042960439604496045960469604796048960499605096051960529605396054960559605696057960589605996060960619606296063960649606596066960679606896069960709607196072960739607496075960769607796078960799608096081960829608396084960859608696087960889608996090960919609296093960949609596096960979609896099961009610196102961039610496105961069610796108961099611096111961129611396114961159611696117961189611996120961219612296123961249612596126961279612896129961309613196132961339613496135961369613796138961399614096141961429614396144961459614696147961489614996150961519615296153961549615596156961579615896159961609616196162961639616496165961669616796168961699617096171961729617396174961759617696177961789617996180961819618296183961849618596186961879618896189961909619196192961939619496195961969619796198961999620096201962029620396204962059620696207962089620996210962119621296213962149621596216962179621896219962209622196222962239622496225962269622796228962299623096231962329623396234962359623696237962389623996240962419624296243962449624596246962479624896249962509625196252962539625496255962569625796258962599626096261962629626396264962659626696267962689626996270962719627296273962749627596276962779627896279962809628196282962839628496285962869628796288962899629096291962929629396294962959629696297962989629996300963019630296303963049630596306963079630896309963109631196312963139631496315963169631796318963199632096321963229632396324963259632696327963289632996330963319633296333963349633596336963379633896339963409634196342963439634496345963469634796348963499635096351963529635396354963559635696357963589635996360963619636296363963649636596366963679636896369963709637196372963739637496375963769637796378963799638096381963829638396384963859638696387963889638996390963919639296393963949639596396963979639896399964009640196402964039640496405964069640796408964099641096411964129641396414964159641696417964189641996420964219642296423964249642596426964279642896429964309643196432964339643496435964369643796438964399644096441964429644396444964459644696447964489644996450964519645296453964549645596456964579645896459964609646196462964639646496465964669646796468964699647096471964729647396474964759647696477964789647996480964819648296483964849648596486964879648896489964909649196492964939649496495964969649796498964999650096501965029650396504965059650696507965089650996510965119651296513965149651596516965179651896519965209652196522965239652496525965269652796528965299653096531965329653396534965359653696537965389653996540965419654296543965449654596546965479654896549965509655196552965539655496555965569655796558965599656096561965629656396564965659656696567965689656996570965719657296573965749657596576965779657896579965809658196582965839658496585965869658796588965899659096591965929659396594965959659696597965989659996600966019660296603966049660596606966079660896609966109661196612966139661496615966169661796618966199662096621966229662396624966259662696627966289662996630966319663296633966349663596636966379663896639966409664196642966439664496645966469664796648966499665096651966529665396654966559665696657966589665996660966619666296663966649666596666966679666896669966709667196672966739667496675966769667796678966799668096681966829668396684966859668696687966889668996690966919669296693966949669596696966979669896699967009670196702967039670496705967069670796708967099671096711967129671396714967159671696717967189671996720967219672296723967249672596726967279672896729967309673196732967339673496735967369673796738967399674096741967429674396744967459674696747967489674996750967519675296753967549675596756967579675896759967609676196762967639676496765967669676796768967699677096771967729677396774967759677696777967789677996780967819678296783967849678596786967879678896789967909679196792967939679496795967969679796798967999680096801968029680396804968059680696807968089680996810968119681296813968149681596816968179681896819968209682196822968239682496825968269682796828968299683096831968329683396834968359683696837968389683996840968419684296843968449684596846968479684896849968509685196852968539685496855968569685796858968599686096861968629686396864968659686696867968689686996870968719687296873968749687596876968779687896879968809688196882968839688496885968869688796888968899689096891968929689396894968959689696897968989689996900969019690296903969049690596906969079690896909969109691196912969139691496915969169691796918969199692096921969229692396924969259692696927969289692996930969319693296933969349693596936969379693896939969409694196942969439694496945969469694796948969499695096951969529695396954969559695696957969589695996960969619696296963969649696596966969679696896969969709697196972969739697496975969769697796978969799698096981969829698396984969859698696987969889698996990969919699296993969949699596996969979699896999970009700197002970039700497005970069700797008970099701097011970129701397014970159701697017970189701997020970219702297023970249702597026970279702897029970309703197032970339703497035970369703797038970399704097041970429704397044970459704697047970489704997050970519705297053970549705597056970579705897059970609706197062970639706497065970669706797068970699707097071970729707397074970759707697077970789707997080970819708297083970849708597086970879708897089970909709197092970939709497095970969709797098970999710097101971029710397104971059710697107971089710997110971119711297113971149711597116971179711897119971209712197122971239712497125971269712797128971299713097131971329713397134971359713697137971389713997140971419714297143971449714597146971479714897149971509715197152971539715497155971569715797158971599716097161971629716397164971659716697167971689716997170971719717297173971749717597176971779717897179971809718197182971839718497185971869718797188971899719097191971929719397194971959719697197971989719997200972019720297203972049720597206972079720897209972109721197212972139721497215972169721797218972199722097221972229722397224972259722697227972289722997230972319723297233972349723597236972379723897239972409724197242972439724497245972469724797248972499725097251972529725397254972559725697257972589725997260972619726297263972649726597266972679726897269972709727197272972739727497275972769727797278972799728097281972829728397284972859728697287972889728997290972919729297293972949729597296972979729897299973009730197302973039730497305973069730797308973099731097311973129731397314973159731697317973189731997320973219732297323973249732597326973279732897329973309733197332973339733497335973369733797338973399734097341973429734397344973459734697347973489734997350973519735297353973549735597356973579735897359973609736197362973639736497365973669736797368973699737097371973729737397374973759737697377973789737997380973819738297383973849738597386973879738897389973909739197392973939739497395973969739797398973999740097401974029740397404974059740697407974089740997410974119741297413974149741597416974179741897419974209742197422974239742497425974269742797428974299743097431974329743397434974359743697437974389743997440974419744297443974449744597446974479744897449974509745197452974539745497455974569745797458974599746097461974629746397464974659746697467974689746997470974719747297473974749747597476974779747897479974809748197482974839748497485974869748797488974899749097491974929749397494974959749697497974989749997500975019750297503975049750597506975079750897509975109751197512975139751497515975169751797518975199752097521975229752397524975259752697527975289752997530975319753297533975349753597536975379753897539975409754197542975439754497545975469754797548975499755097551975529755397554975559755697557975589755997560975619756297563975649756597566975679756897569975709757197572975739757497575975769757797578975799758097581975829758397584975859758697587975889758997590975919759297593975949759597596975979759897599976009760197602976039760497605976069760797608976099761097611976129761397614976159761697617976189761997620976219762297623976249762597626976279762897629976309763197632976339763497635976369763797638976399764097641976429764397644976459764697647976489764997650976519765297653976549765597656976579765897659976609766197662976639766497665976669766797668976699767097671976729767397674976759767697677976789767997680976819768297683976849768597686976879768897689976909769197692976939769497695976969769797698976999770097701977029770397704977059770697707977089770997710977119771297713977149771597716977179771897719977209772197722977239772497725977269772797728977299773097731977329773397734977359773697737977389773997740977419774297743977449774597746977479774897749977509775197752977539775497755977569775797758977599776097761977629776397764977659776697767977689776997770977719777297773977749777597776977779777897779977809778197782977839778497785977869778797788977899779097791977929779397794977959779697797977989779997800978019780297803978049780597806978079780897809978109781197812978139781497815978169781797818978199782097821978229782397824978259782697827978289782997830978319783297833978349783597836978379783897839978409784197842978439784497845978469784797848978499785097851978529785397854978559785697857978589785997860978619786297863978649786597866978679786897869978709787197872978739787497875978769787797878978799788097881978829788397884978859788697887978889788997890978919789297893978949789597896978979789897899979009790197902979039790497905979069790797908979099791097911979129791397914979159791697917979189791997920979219792297923979249792597926979279792897929979309793197932979339793497935979369793797938979399794097941979429794397944979459794697947979489794997950979519795297953979549795597956979579795897959979609796197962979639796497965979669796797968979699797097971979729797397974979759797697977979789797997980979819798297983979849798597986979879798897989979909799197992979939799497995979969799797998979999800098001980029800398004980059800698007980089800998010980119801298013980149801598016980179801898019980209802198022980239802498025980269802798028980299803098031980329803398034980359803698037980389803998040980419804298043980449804598046980479804898049980509805198052980539805498055980569805798058980599806098061980629806398064980659806698067980689806998070980719807298073980749807598076980779807898079980809808198082980839808498085980869808798088980899809098091980929809398094980959809698097980989809998100981019810298103981049810598106981079810898109981109811198112981139811498115981169811798118981199812098121981229812398124981259812698127981289812998130981319813298133981349813598136981379813898139981409814198142981439814498145981469814798148981499815098151981529815398154981559815698157981589815998160981619816298163981649816598166981679816898169981709817198172981739817498175981769817798178981799818098181981829818398184981859818698187981889818998190981919819298193981949819598196981979819898199982009820198202982039820498205982069820798208982099821098211982129821398214982159821698217982189821998220982219822298223982249822598226982279822898229982309823198232982339823498235982369823798238982399824098241982429824398244982459824698247982489824998250982519825298253982549825598256982579825898259982609826198262982639826498265982669826798268982699827098271982729827398274982759827698277982789827998280982819828298283982849828598286982879828898289982909829198292982939829498295982969829798298982999830098301983029830398304983059830698307983089830998310983119831298313983149831598316983179831898319983209832198322983239832498325983269832798328983299833098331983329833398334983359833698337983389833998340983419834298343983449834598346983479834898349983509835198352983539835498355983569835798358983599836098361983629836398364983659836698367983689836998370983719837298373983749837598376983779837898379983809838198382983839838498385983869838798388983899839098391983929839398394983959839698397983989839998400984019840298403984049840598406984079840898409984109841198412984139841498415984169841798418984199842098421984229842398424984259842698427984289842998430984319843298433984349843598436984379843898439984409844198442984439844498445984469844798448984499845098451984529845398454984559845698457984589845998460984619846298463984649846598466984679846898469984709847198472984739847498475984769847798478984799848098481984829848398484984859848698487984889848998490984919849298493984949849598496984979849898499985009850198502985039850498505985069850798508985099851098511985129851398514985159851698517985189851998520985219852298523985249852598526985279852898529985309853198532985339853498535985369853798538985399854098541985429854398544985459854698547985489854998550985519855298553985549855598556985579855898559985609856198562985639856498565985669856798568985699857098571985729857398574985759857698577985789857998580985819858298583985849858598586985879858898589985909859198592985939859498595985969859798598985999860098601986029860398604986059860698607986089860998610986119861298613986149861598616986179861898619986209862198622986239862498625986269862798628986299863098631986329863398634986359863698637986389863998640986419864298643986449864598646986479864898649986509865198652986539865498655986569865798658986599866098661986629866398664986659866698667986689866998670986719867298673986749867598676986779867898679986809868198682986839868498685986869868798688986899869098691986929869398694986959869698697986989869998700987019870298703987049870598706987079870898709987109871198712987139871498715987169871798718987199872098721987229872398724987259872698727987289872998730987319873298733987349873598736987379873898739987409874198742987439874498745987469874798748987499875098751987529875398754987559875698757987589875998760987619876298763987649876598766987679876898769987709877198772987739877498775987769877798778987799878098781987829878398784987859878698787987889878998790987919879298793987949879598796987979879898799988009880198802988039880498805988069880798808988099881098811988129881398814988159881698817988189881998820988219882298823988249882598826988279882898829988309883198832988339883498835988369883798838988399884098841988429884398844988459884698847988489884998850988519885298853988549885598856988579885898859988609886198862988639886498865988669886798868988699887098871988729887398874988759887698877988789887998880988819888298883988849888598886988879888898889988909889198892988939889498895988969889798898988999890098901989029890398904989059890698907989089890998910989119891298913989149891598916989179891898919989209892198922989239892498925989269892798928989299893098931989329893398934989359893698937989389893998940989419894298943989449894598946989479894898949989509895198952989539895498955989569895798958989599896098961989629896398964989659896698967989689896998970989719897298973989749897598976989779897898979989809898198982989839898498985989869898798988989899899098991989929899398994989959899698997989989899999000990019900299003990049900599006990079900899009990109901199012990139901499015990169901799018990199902099021990229902399024990259902699027990289902999030990319903299033990349903599036990379903899039990409904199042990439904499045990469904799048990499905099051990529905399054990559905699057990589905999060990619906299063990649906599066990679906899069990709907199072990739907499075990769907799078990799908099081990829908399084990859908699087990889908999090990919909299093990949909599096990979909899099991009910199102991039910499105991069910799108991099911099111991129911399114991159911699117991189911999120991219912299123991249912599126991279912899129991309913199132991339913499135991369913799138991399914099141991429914399144991459914699147991489914999150991519915299153991549915599156991579915899159991609916199162991639916499165991669916799168991699917099171991729917399174991759917699177991789917999180991819918299183991849918599186991879918899189991909919199192991939919499195991969919799198991999920099201992029920399204992059920699207992089920999210992119921299213992149921599216992179921899219992209922199222992239922499225992269922799228992299923099231992329923399234992359923699237992389923999240992419924299243992449924599246992479924899249992509925199252992539925499255992569925799258992599926099261992629926399264992659926699267992689926999270992719927299273992749927599276992779927899279992809928199282992839928499285992869928799288992899929099291992929929399294992959929699297992989929999300993019930299303993049930599306993079930899309993109931199312993139931499315993169931799318993199932099321993229932399324993259932699327993289932999330993319933299333993349933599336993379933899339993409934199342993439934499345993469934799348993499935099351993529935399354993559935699357993589935999360993619936299363993649936599366993679936899369993709937199372993739937499375993769937799378993799938099381993829938399384993859938699387993889938999390993919939299393993949939599396993979939899399994009940199402994039940499405994069940799408994099941099411994129941399414994159941699417994189941999420994219942299423994249942599426994279942899429994309943199432994339943499435994369943799438994399944099441994429944399444994459944699447994489944999450994519945299453994549945599456994579945899459994609946199462994639946499465994669946799468994699947099471994729947399474994759947699477994789947999480994819948299483994849948599486994879948899489994909949199492994939949499495994969949799498994999950099501995029950399504995059950699507995089950999510995119951299513995149951599516995179951899519995209952199522995239952499525995269952799528995299953099531995329953399534995359953699537995389953999540995419954299543995449954599546995479954899549995509955199552995539955499555995569955799558995599956099561995629956399564995659956699567995689956999570995719957299573995749957599576995779957899579995809958199582995839958499585995869958799588995899959099591995929959399594995959959699597995989959999600996019960299603996049960599606996079960899609996109961199612996139961499615996169961799618996199962099621996229962399624996259962699627996289962999630996319963299633996349963599636996379963899639996409964199642996439964499645996469964799648996499965099651996529965399654996559965699657996589965999660996619966299663996649966599666996679966899669996709967199672996739967499675996769967799678996799968099681996829968399684996859968699687996889968999690996919969299693996949969599696996979969899699997009970199702997039970499705997069970799708997099971099711997129971399714997159971699717997189971999720997219972299723997249972599726997279972899729997309973199732997339973499735997369973799738997399974099741997429974399744997459974699747997489974999750997519975299753997549975599756997579975899759997609976199762997639976499765997669976799768997699977099771997729977399774997759977699777997789977999780997819978299783997849978599786997879978899789997909979199792997939979499795997969979799798997999980099801998029980399804998059980699807998089980999810998119981299813998149981599816998179981899819998209982199822998239982499825998269982799828998299983099831998329983399834998359983699837998389983999840998419984299843998449984599846998479984899849998509985199852998539985499855998569985799858998599986099861998629986399864998659986699867998689986999870998719987299873998749987599876998779987899879998809988199882998839988499885998869988799888998899989099891998929989399894998959989699897998989989999900999019990299903999049990599906999079990899909999109991199912999139991499915999169991799918999199992099921999229992399924999259992699927999289992999930999319993299933999349993599936999379993899939999409994199942999439994499945999469994799948999499995099951999529995399954999559995699957999589995999960999619996299963999649996599966999679996899969999709997199972999739997499975999769997799978999799998099981999829998399984999859998699987999889998999990999919999299993999949999599996999979999899999100000100001100002100003100004100005100006100007100008100009100010100011100012100013100014100015100016100017100018100019100020100021100022100023100024100025100026100027100028100029100030100031100032100033100034100035100036100037100038100039100040100041100042100043100044100045100046100047100048100049100050100051100052100053100054100055100056100057100058100059100060100061100062100063100064100065100066100067100068100069100070100071100072100073100074100075100076100077100078100079100080100081100082100083100084100085100086100087100088100089100090100091100092100093100094100095100096100097100098100099100100100101100102100103100104100105100106100107100108100109100110100111100112100113100114100115100116100117100118100119100120100121100122100123100124100125100126100127100128100129100130100131100132100133100134100135100136100137100138100139100140100141100142100143100144100145100146100147100148100149100150100151100152100153100154100155100156100157100158100159100160100161100162100163100164100165100166100167100168100169100170100171100172100173100174100175100176100177100178100179100180100181100182100183100184100185100186100187100188100189100190100191100192100193100194100195100196100197100198100199100200100201100202100203100204100205100206100207100208100209100210100211100212100213100214100215100216100217100218100219100220100221100222100223100224100225100226100227100228100229100230100231100232100233100234100235100236100237100238100239100240100241100242100243100244100245100246100247100248100249100250100251100252100253100254100255100256100257100258100259100260100261100262100263100264100265100266100267100268100269100270100271100272100273100274100275100276100277100278100279100280100281100282100283100284100285100286100287100288100289100290100291100292100293100294100295100296100297100298100299100300100301100302100303100304100305100306100307100308100309100310100311100312100313100314100315100316100317100318100319100320100321100322100323100324100325100326100327100328100329100330100331100332100333100334100335100336100337100338100339100340100341100342100343100344100345100346100347100348100349100350100351100352100353100354100355100356100357100358100359100360100361100362100363100364100365100366100367100368100369100370100371100372100373100374100375100376100377100378100379100380100381100382100383100384100385100386100387100388100389100390100391100392100393100394100395100396100397100398100399100400100401100402100403100404100405100406100407100408100409100410100411100412100413100414100415100416100417100418100419100420100421100422100423100424100425100426100427100428100429100430100431100432100433100434100435100436100437100438100439100440100441100442100443100444100445100446100447100448100449100450100451100452100453100454100455100456100457100458100459100460100461100462100463100464100465100466100467100468100469100470100471100472100473100474100475100476100477100478100479100480100481100482100483100484100485100486100487100488100489100490100491100492100493100494100495100496100497100498100499100500100501100502100503100504100505100506100507100508100509100510100511100512100513100514100515100516100517100518100519100520100521100522100523100524100525100526100527100528100529100530100531100532100533100534100535100536100537100538100539100540100541100542100543100544100545100546100547100548100549100550100551100552100553100554100555100556100557100558100559100560100561100562100563100564100565100566100567100568100569100570100571100572100573100574100575100576100577100578100579100580100581100582100583100584100585100586100587100588100589100590100591100592100593100594100595100596100597100598100599100600100601100602100603100604100605100606100607100608100609100610100611100612100613100614100615100616100617100618100619100620100621100622100623100624100625100626100627100628100629100630100631100632100633100634100635100636100637100638100639100640100641100642100643100644100645100646100647100648100649100650100651100652100653100654100655100656100657100658100659100660100661100662100663100664100665100666100667100668100669100670100671100672100673100674100675100676100677100678100679100680100681100682100683100684100685100686100687100688100689100690100691100692100693100694100695100696100697100698100699100700100701100702100703100704100705100706100707100708100709100710100711100712100713100714100715100716100717100718100719100720100721100722100723100724100725100726100727100728100729100730100731100732100733100734100735100736100737100738100739100740100741100742100743100744100745100746100747100748100749100750100751100752100753100754100755100756100757100758100759100760100761100762100763100764100765100766100767100768100769100770100771100772100773100774100775100776100777100778100779100780100781100782100783100784100785100786100787100788100789100790100791100792100793100794100795100796100797100798100799100800100801100802100803100804100805100806100807100808100809100810100811100812100813100814100815100816100817100818100819100820100821100822100823100824100825100826100827100828100829100830100831100832100833100834100835100836100837100838100839100840100841100842100843100844100845100846100847100848100849100850100851100852100853100854100855100856100857100858100859100860100861100862100863100864100865100866100867100868100869100870100871100872100873100874100875100876100877100878100879100880100881100882100883100884100885100886100887100888100889100890100891100892100893100894100895100896100897100898100899100900100901100902100903100904100905100906100907100908100909100910100911100912100913100914100915100916100917100918100919100920100921100922100923100924100925100926100927100928100929100930100931100932100933100934100935100936100937100938100939100940100941100942100943100944100945100946100947100948100949100950100951100952100953100954100955100956100957100958100959100960100961100962100963100964100965100966100967100968100969100970100971100972100973100974100975100976100977100978100979100980100981100982100983100984100985100986100987100988100989100990100991100992100993100994100995100996100997100998100999101000101001101002101003101004101005101006101007101008101009101010101011101012101013101014101015101016101017101018101019101020101021101022101023101024101025101026101027101028101029101030101031101032101033101034101035101036101037101038101039101040101041101042101043101044101045101046101047101048101049101050101051101052101053101054101055101056101057101058101059101060101061101062101063101064101065101066101067101068101069101070101071101072101073101074101075101076101077101078101079101080101081101082101083101084101085101086101087101088101089101090101091101092101093101094101095101096101097101098101099101100101101101102101103101104101105101106101107101108101109101110101111101112101113101114101115101116101117101118101119101120101121101122101123101124101125101126101127101128101129101130101131101132101133101134101135101136101137101138101139101140101141101142101143101144101145101146101147101148101149101150101151101152101153101154101155101156101157101158101159101160101161101162101163101164101165101166101167101168101169101170101171101172101173101174101175101176101177101178101179101180101181101182101183101184101185101186101187101188101189101190101191101192101193101194101195101196101197101198101199101200101201101202101203101204101205101206101207101208101209101210101211101212101213101214101215101216101217101218101219101220101221101222101223101224101225101226101227101228101229101230101231101232101233101234101235101236101237101238101239101240101241101242101243101244101245101246101247101248101249101250101251101252101253101254101255101256101257101258101259101260101261101262101263101264101265101266101267101268101269101270101271101272101273101274101275101276101277101278101279101280101281101282101283101284101285101286101287101288101289101290101291101292101293101294101295101296101297101298101299101300101301101302101303101304101305101306101307101308101309101310101311101312101313101314101315101316101317101318101319101320101321101322101323101324101325101326101327101328101329101330101331101332101333101334101335101336101337101338101339101340101341101342101343101344101345101346101347101348101349101350101351101352101353101354101355101356101357101358101359101360101361101362101363101364101365101366101367101368101369101370101371101372101373101374101375101376101377101378101379101380101381101382101383101384101385101386101387101388101389101390101391101392101393101394101395101396101397101398101399101400101401101402101403101404101405101406101407101408101409101410101411101412101413101414101415101416101417101418101419101420101421101422101423101424101425101426101427101428101429101430101431101432101433101434101435101436101437101438101439101440101441101442101443101444101445101446101447101448101449101450101451101452101453101454101455101456101457101458101459101460101461101462101463101464101465101466101467101468101469101470101471101472101473101474101475101476101477101478101479101480101481101482101483101484101485101486101487101488101489101490101491101492101493101494101495101496101497101498101499101500101501101502101503101504101505101506101507101508101509101510101511101512101513101514101515101516101517101518101519101520101521101522101523101524101525101526101527101528101529101530101531101532101533101534101535101536101537101538101539101540101541101542101543101544101545101546101547101548101549101550101551101552101553101554101555101556101557101558101559101560101561101562101563101564101565101566101567101568101569101570101571101572101573101574101575101576101577101578101579101580101581101582101583101584101585101586101587101588101589101590101591101592101593101594101595101596101597101598101599101600101601101602101603101604101605101606101607101608101609101610101611101612101613101614101615101616101617101618101619101620101621101622101623101624101625101626101627101628101629101630101631101632101633101634101635101636101637101638101639101640101641101642101643101644101645101646101647101648101649101650101651101652101653101654101655101656101657101658101659101660101661101662101663101664101665101666101667101668101669101670101671101672101673101674101675101676101677101678101679101680101681101682101683101684101685101686101687101688101689101690101691101692101693101694101695101696101697101698101699101700101701101702101703101704101705101706101707101708101709101710101711101712101713101714101715101716101717101718101719101720101721101722101723101724101725101726101727101728101729101730101731101732101733101734101735101736101737101738101739101740101741101742101743101744101745101746101747101748101749101750101751101752101753101754101755101756101757101758101759101760101761101762101763101764101765101766101767101768101769101770101771101772101773101774101775101776101777101778101779101780101781101782101783101784101785101786101787101788101789101790101791101792101793101794101795101796101797101798101799101800101801101802101803101804101805101806101807101808101809101810101811101812101813101814101815101816101817101818101819101820101821101822101823101824101825101826101827101828101829101830101831101832101833101834101835101836101837101838101839101840101841101842101843101844101845101846101847101848101849101850101851101852101853101854101855101856101857101858101859101860101861101862101863101864101865101866101867101868101869101870101871101872101873101874101875101876101877101878101879101880101881101882101883101884101885101886101887101888101889101890101891101892101893101894101895101896101897101898101899101900101901101902101903101904101905101906101907101908101909101910101911101912101913101914101915101916101917101918101919101920101921101922101923101924101925101926101927101928101929101930101931101932101933101934101935101936101937101938101939101940101941101942101943101944101945101946101947101948101949101950101951101952101953101954101955101956101957101958101959101960101961101962101963101964101965101966101967101968101969101970101971101972101973101974101975101976101977101978101979101980101981101982101983101984101985101986101987101988101989101990101991101992101993101994101995101996101997101998101999102000102001102002102003102004102005102006102007102008102009102010102011102012102013102014102015102016102017102018102019102020102021102022102023102024102025102026102027102028102029102030102031102032102033102034102035102036102037102038102039102040102041102042102043102044102045102046102047102048102049102050102051102052102053102054102055102056102057102058102059102060102061102062102063102064102065102066102067102068102069102070102071102072102073102074102075102076102077102078102079102080102081102082102083102084102085102086102087102088102089102090102091102092102093102094102095102096102097102098102099102100102101102102102103102104102105102106102107102108102109102110102111102112102113102114102115102116102117102118102119102120102121102122102123102124102125102126102127102128102129102130102131102132102133102134102135102136102137102138102139102140102141102142102143102144102145102146102147102148102149102150102151102152102153102154102155102156102157102158102159102160102161102162102163102164102165102166102167102168102169102170102171102172102173102174102175102176102177102178102179102180102181102182102183102184102185102186102187102188102189102190102191102192102193102194102195102196102197102198102199102200102201102202102203102204102205102206102207102208102209102210102211102212102213102214102215102216102217102218102219102220102221102222102223102224102225102226102227102228102229102230102231102232102233102234102235102236102237102238102239102240102241102242102243102244102245102246102247102248102249102250102251102252102253102254102255102256102257102258102259102260102261102262102263102264102265102266102267102268102269102270102271102272102273102274102275102276102277102278102279102280102281102282102283102284102285102286102287102288102289102290102291102292102293102294102295102296102297102298102299102300102301102302102303102304102305102306102307102308102309102310102311102312102313102314102315102316102317102318102319102320102321102322102323102324102325102326102327102328102329102330102331102332102333102334102335102336102337102338102339102340102341102342102343102344102345102346102347102348102349102350102351102352102353102354102355102356102357102358102359102360102361102362102363102364102365102366102367102368102369102370102371102372102373102374102375102376102377102378102379102380102381102382102383102384102385102386102387102388102389102390102391102392102393102394102395102396102397102398102399102400102401102402102403102404102405102406102407102408102409102410102411102412102413102414102415102416102417102418102419102420102421102422102423102424102425102426102427102428102429102430102431102432102433102434102435102436102437102438102439102440102441102442102443102444102445102446102447102448102449102450102451102452102453102454102455102456102457102458102459102460102461102462102463102464102465102466102467102468102469102470102471102472102473102474102475102476102477102478102479102480102481102482102483102484102485102486102487102488102489102490102491102492102493102494102495102496102497102498102499102500102501102502102503102504102505102506102507102508102509102510102511102512102513102514102515102516102517102518102519102520102521102522102523102524102525102526102527102528102529102530102531102532102533102534102535102536102537102538102539102540102541102542102543102544102545102546102547102548102549102550102551102552102553102554102555102556102557102558102559102560102561102562102563102564102565102566102567102568102569102570102571102572102573102574102575102576102577102578102579102580102581102582102583102584102585102586102587102588102589102590102591102592102593102594102595102596102597102598102599102600102601102602102603102604102605102606102607102608102609102610102611102612102613102614102615102616102617102618102619102620102621102622102623102624102625102626102627102628102629102630102631102632102633102634102635102636102637102638102639102640102641102642102643102644102645102646102647102648102649102650102651102652102653102654102655102656102657102658102659102660102661102662102663102664102665102666102667102668102669102670102671102672102673102674102675102676102677102678102679102680102681102682102683102684102685102686102687102688102689102690102691102692102693102694102695102696102697102698102699102700102701102702102703102704102705102706102707102708102709102710102711102712102713102714102715102716102717102718102719102720102721102722102723102724102725102726102727102728102729102730102731102732102733102734102735102736102737102738102739102740102741102742102743102744102745102746102747102748102749102750102751102752102753102754102755102756102757102758102759102760102761102762102763102764102765102766102767102768102769102770102771102772102773102774102775102776102777102778102779102780102781102782102783102784102785102786102787102788102789102790102791102792102793102794102795102796102797102798102799102800102801102802102803102804102805102806102807102808102809102810102811102812102813102814102815102816102817102818102819102820102821102822102823102824102825102826102827102828102829102830102831102832102833102834102835102836102837102838102839102840102841102842102843102844102845102846102847102848102849102850102851102852102853102854102855102856102857102858102859102860102861102862102863102864102865102866102867102868102869102870102871102872102873102874102875102876102877102878102879102880102881102882102883102884102885102886102887102888102889102890102891102892102893102894102895102896102897102898102899102900102901102902102903102904102905102906102907102908102909102910102911102912102913102914102915102916102917102918102919102920102921102922102923102924102925102926102927102928102929102930102931102932102933102934102935102936102937102938102939102940102941102942102943102944102945102946102947102948102949102950102951102952102953102954102955102956102957102958102959102960102961102962102963102964102965102966102967102968102969102970102971102972102973102974102975102976102977102978102979102980102981102982102983102984102985102986102987102988102989102990102991102992102993102994102995102996102997102998102999103000103001103002103003103004103005103006103007103008103009103010103011103012103013103014103015103016103017103018103019103020103021103022103023103024103025103026103027103028103029103030103031103032103033103034103035103036103037103038103039103040103041103042103043103044103045103046103047103048103049103050103051103052103053103054103055103056103057103058103059103060103061103062103063103064103065103066103067103068103069103070103071103072103073103074103075103076103077103078103079103080103081103082103083103084103085103086103087103088103089103090103091103092103093103094103095103096103097103098103099103100103101103102103103103104103105103106103107103108103109103110103111103112103113103114103115103116103117103118103119103120103121103122103123103124103125103126103127103128103129103130103131103132103133103134103135103136103137103138103139103140103141103142103143103144103145103146103147103148103149103150103151103152103153103154103155103156103157103158103159103160103161103162103163103164103165103166103167103168103169103170103171103172103173103174103175103176103177103178103179103180103181103182103183103184103185103186103187103188103189103190103191103192103193103194103195103196103197103198103199103200103201103202103203103204103205103206103207103208103209103210103211103212103213103214103215103216103217103218103219103220103221103222103223103224103225103226103227103228103229103230103231103232103233103234103235103236103237103238103239103240103241103242103243103244103245103246103247103248103249103250103251103252103253103254103255103256103257103258103259103260103261103262103263103264103265103266103267103268103269103270103271103272103273103274103275103276103277103278103279103280103281103282103283103284103285103286103287103288103289103290103291103292103293103294103295103296103297103298103299103300103301103302103303103304103305103306103307103308103309103310103311103312103313103314103315103316103317103318103319103320103321103322103323103324103325103326103327103328103329103330103331103332103333103334103335103336103337103338103339103340103341103342103343103344103345103346103347103348103349103350103351103352103353103354103355103356103357103358103359103360103361103362103363103364103365103366103367103368103369103370103371103372103373103374103375103376103377103378103379103380103381103382103383103384103385103386103387103388103389103390103391103392103393103394103395103396103397103398103399103400103401103402103403103404103405103406103407103408103409103410103411103412103413103414103415103416103417103418103419103420103421103422103423103424103425103426103427103428103429103430103431103432103433103434103435103436103437103438103439103440103441103442103443103444103445103446103447103448103449103450103451103452103453103454103455103456103457103458103459103460103461103462103463103464103465103466103467103468103469103470103471103472103473103474103475103476103477103478103479103480103481103482103483103484103485103486103487103488103489103490103491103492103493103494103495103496103497103498103499103500103501103502103503103504103505103506103507103508103509103510103511103512103513103514103515103516103517103518103519103520103521103522103523103524103525103526103527103528103529103530103531103532103533103534103535103536103537103538103539103540103541103542103543103544103545103546103547103548103549103550103551103552103553103554103555103556103557103558103559103560103561103562103563103564103565103566103567103568103569103570103571103572103573103574103575103576103577103578103579103580103581103582103583103584103585103586103587103588103589103590103591103592103593103594103595103596103597103598103599103600103601103602103603103604103605103606103607103608103609103610103611103612103613103614103615103616103617103618103619103620103621103622103623103624103625103626103627103628103629103630103631103632103633103634103635103636103637103638103639103640103641103642103643103644103645103646103647103648103649103650103651103652103653103654103655103656103657103658103659103660103661103662103663103664103665103666103667103668103669103670103671103672103673103674103675103676103677103678103679103680103681103682103683103684103685103686103687103688103689103690103691103692103693103694103695103696103697103698103699103700103701103702103703103704103705103706103707103708103709103710103711103712103713103714103715103716103717103718103719103720103721103722103723103724103725103726103727103728103729103730103731103732103733103734103735103736103737103738103739103740103741103742103743103744103745103746103747103748103749103750103751103752103753103754103755103756103757103758103759103760103761103762103763103764103765103766103767103768103769103770103771103772103773103774103775103776103777103778103779103780103781103782103783103784103785103786103787103788103789103790103791103792103793103794103795103796103797103798103799103800103801103802103803103804103805103806103807103808103809103810103811103812103813103814103815103816103817103818103819103820103821103822103823103824103825103826103827103828103829103830103831103832103833103834103835103836103837103838103839103840103841103842103843103844103845103846103847103848103849103850103851103852103853103854103855103856103857103858103859103860103861103862103863103864103865103866103867103868103869103870103871103872103873103874103875103876103877103878103879103880103881103882103883103884103885103886103887103888103889103890103891103892103893103894103895103896103897103898103899103900103901103902103903103904103905103906103907103908103909103910103911103912103913103914103915103916103917103918103919103920103921103922103923103924103925103926103927103928103929103930103931103932103933103934103935103936103937103938103939103940103941103942103943103944103945103946103947103948103949103950103951103952103953103954103955103956103957103958103959103960103961103962103963103964103965103966103967103968103969103970103971103972103973103974103975103976103977103978103979103980103981103982103983103984103985103986103987103988103989103990103991103992103993103994103995103996103997103998103999104000104001104002104003104004104005104006104007104008104009104010104011104012104013104014104015104016104017104018104019104020104021104022104023104024104025104026104027104028104029104030104031104032104033104034104035104036104037104038104039104040104041104042104043104044104045104046104047104048104049104050104051104052104053104054104055104056104057104058104059104060104061104062104063104064104065104066104067104068104069104070104071104072104073104074104075104076104077104078104079104080104081104082104083104084104085104086104087104088104089104090104091104092104093104094104095104096104097104098104099104100104101104102104103104104104105104106104107104108104109104110104111104112104113104114104115104116104117104118104119104120104121104122104123104124104125104126104127104128104129104130104131104132104133104134104135104136104137104138104139104140104141104142104143104144104145104146104147104148104149104150104151104152104153104154104155104156104157104158104159104160104161104162104163104164104165104166104167104168104169104170104171104172104173104174104175104176104177104178104179104180104181104182104183104184104185104186104187104188104189104190104191104192104193104194104195104196104197104198104199104200104201104202104203104204104205104206104207104208104209104210104211104212104213104214104215104216104217104218104219104220104221104222104223104224104225104226104227104228104229104230104231104232104233104234104235104236104237104238104239104240104241104242104243104244104245104246104247104248104249104250104251104252104253104254104255104256104257104258104259104260104261104262104263104264104265104266104267104268104269104270104271104272104273104274104275104276104277104278104279104280104281104282104283104284104285104286104287104288104289104290104291104292104293104294104295104296104297104298104299104300104301104302104303104304104305104306104307104308104309104310104311104312104313104314104315104316104317104318104319104320104321104322104323104324104325104326104327104328104329104330104331104332104333104334104335104336104337104338104339104340104341104342104343104344104345104346104347104348104349104350104351104352104353104354104355104356104357104358104359104360104361104362104363104364104365104366104367104368104369104370104371104372104373104374104375104376104377104378104379104380104381104382104383104384104385104386104387104388104389104390104391104392104393104394104395104396104397104398104399104400104401104402104403104404104405104406104407104408104409104410104411104412104413104414104415104416104417104418104419104420104421104422104423104424104425104426104427104428104429104430104431104432104433104434104435104436104437104438104439104440104441104442104443104444104445104446104447104448104449104450104451104452104453104454104455104456104457104458104459104460104461104462104463104464104465104466104467104468104469104470104471104472104473104474104475104476104477104478104479104480104481104482104483104484104485104486104487104488104489104490104491104492104493104494104495104496104497104498104499104500104501104502104503104504104505104506104507104508104509104510104511104512104513104514104515104516104517104518104519104520104521104522104523104524104525104526104527104528104529104530104531104532104533104534104535104536104537104538104539104540104541104542104543104544104545104546104547104548104549104550104551104552104553104554104555104556104557104558104559104560104561104562104563104564104565104566104567104568104569104570104571104572104573104574104575104576104577104578104579104580104581104582104583104584104585104586104587104588104589104590104591104592104593104594104595104596104597104598104599104600104601104602104603104604104605104606104607104608104609104610104611104612104613104614104615104616104617104618104619104620104621104622104623104624104625104626104627104628104629104630104631104632104633104634104635104636104637104638104639104640104641104642104643104644104645104646104647104648104649104650104651104652104653104654104655104656104657104658104659104660104661104662104663104664104665104666104667104668104669104670104671104672104673104674104675104676104677104678104679104680104681104682104683104684104685104686104687104688104689104690104691104692104693104694104695104696104697104698104699104700104701104702104703104704104705104706104707104708104709104710104711104712104713104714104715104716104717104718104719104720104721104722104723104724104725104726104727104728104729104730104731104732104733104734104735104736104737104738104739104740104741104742104743104744104745104746104747104748104749104750104751104752104753104754104755104756104757104758104759104760104761104762104763104764104765104766104767104768104769104770104771104772104773104774104775104776104777104778104779104780104781104782104783104784104785104786104787104788104789104790104791104792104793104794104795104796104797104798104799104800104801104802104803104804104805104806104807104808104809104810104811104812104813104814104815104816104817104818104819104820104821104822104823104824104825104826104827104828104829104830104831104832104833104834104835104836104837104838104839104840104841104842104843104844104845104846104847104848104849104850104851104852104853104854104855104856104857104858104859104860104861104862104863104864104865104866104867104868104869104870104871104872104873104874104875104876104877104878104879104880104881104882104883104884104885104886104887104888104889104890104891104892104893104894104895104896104897104898104899104900104901104902104903104904104905104906104907104908104909104910104911104912104913104914104915104916104917104918104919104920104921104922104923104924104925104926104927104928104929104930104931104932104933104934104935104936104937104938104939104940104941104942104943104944104945104946104947104948104949104950104951104952104953104954104955104956104957104958104959104960104961104962104963104964104965104966104967104968104969104970104971104972104973104974104975104976104977104978104979104980104981104982104983104984104985104986104987104988104989104990104991104992104993104994104995104996104997104998104999105000105001105002105003105004105005105006105007105008105009105010105011105012105013105014105015105016105017105018105019105020105021105022105023105024105025105026105027105028105029105030105031105032105033105034105035105036105037105038105039105040105041105042105043105044105045105046105047105048105049105050105051105052105053105054105055105056105057105058105059105060105061105062105063105064105065105066105067105068105069105070105071105072105073105074105075105076105077105078105079105080105081105082105083105084105085105086105087105088105089105090105091105092105093105094105095105096105097105098105099105100105101105102105103105104105105105106105107105108105109105110105111105112105113105114105115105116105117105118105119105120105121105122105123105124105125105126105127105128105129105130105131105132105133105134105135105136105137105138105139105140105141105142105143105144105145105146105147105148105149105150105151105152105153105154105155105156105157105158105159105160105161105162105163105164105165105166105167105168105169105170105171105172105173105174105175105176105177105178105179105180105181105182105183105184105185105186105187105188105189105190105191105192105193105194105195105196105197105198105199105200105201105202105203105204105205105206105207105208105209105210105211105212105213105214105215105216105217105218105219105220105221105222105223105224105225105226105227105228105229105230105231105232105233105234105235105236105237105238105239105240105241105242105243105244105245105246105247105248105249105250105251105252105253105254105255105256105257105258105259105260105261105262105263105264105265105266105267105268105269105270105271105272105273105274105275105276105277105278105279105280105281105282105283105284105285105286105287105288105289105290105291105292105293105294105295105296105297105298105299105300105301105302105303105304105305105306105307105308105309105310105311105312105313105314105315105316105317105318105319105320105321105322105323105324105325105326105327105328105329105330105331105332105333105334105335105336105337105338105339105340105341105342105343105344105345105346105347105348105349105350105351105352105353105354105355105356105357105358105359105360105361105362105363105364105365105366105367105368105369105370105371105372105373105374105375105376105377105378105379105380105381105382105383105384105385105386105387105388105389105390105391105392105393105394105395105396105397105398105399105400105401105402105403105404105405105406105407105408105409105410105411105412105413105414105415105416105417105418105419105420105421105422105423105424105425105426105427105428105429105430105431105432105433105434105435105436105437105438105439105440105441105442105443105444105445105446105447105448105449105450105451105452105453105454105455105456105457105458105459105460105461105462105463105464105465105466105467105468105469105470105471105472105473105474105475105476105477105478105479105480105481105482105483105484105485105486105487105488105489105490105491105492105493105494105495105496105497105498105499105500105501105502105503105504105505105506105507105508105509105510105511105512105513105514105515105516105517105518105519105520105521105522105523105524105525105526105527105528105529105530105531105532105533105534105535105536105537105538105539105540105541105542105543105544105545105546105547105548105549105550105551105552105553105554105555105556105557105558105559105560105561105562105563105564105565105566105567105568105569105570105571105572105573105574105575105576105577105578105579105580105581105582105583105584105585105586105587105588105589105590105591105592105593105594105595105596105597105598105599105600105601105602105603105604105605105606105607105608105609105610105611105612105613105614105615105616105617105618105619105620105621105622105623105624105625105626105627105628105629105630105631105632105633105634105635105636105637105638105639105640105641105642105643105644105645105646105647105648105649105650105651105652105653105654105655105656105657105658105659105660105661105662105663105664105665105666105667105668105669105670105671105672105673105674105675105676105677105678105679105680105681105682105683105684105685105686105687105688105689105690105691105692105693105694105695105696105697105698105699105700105701105702105703105704105705105706105707105708105709105710105711105712105713105714105715105716105717105718105719105720105721105722105723105724105725105726105727105728105729105730105731105732105733105734105735105736105737105738105739105740105741105742105743105744105745105746105747105748105749105750105751105752105753105754105755105756105757105758105759105760105761105762105763105764105765105766105767105768105769105770105771105772105773105774105775105776105777105778105779105780105781105782105783105784105785105786105787105788105789105790105791105792105793105794105795105796105797105798105799105800105801105802105803105804105805105806105807105808105809105810105811105812105813105814105815105816105817105818105819105820105821105822105823105824105825105826105827105828105829105830105831105832105833105834105835105836105837105838105839105840105841105842105843105844105845105846105847105848105849105850105851105852105853105854105855105856105857105858105859105860105861105862105863105864105865105866105867105868105869105870105871105872105873105874105875105876105877105878105879105880105881105882105883105884105885105886105887105888105889105890105891105892105893105894105895105896105897105898105899105900105901105902105903105904105905105906105907105908105909105910105911105912105913105914105915105916105917105918105919105920105921105922105923105924105925105926105927105928105929105930105931105932105933105934105935105936105937105938105939105940105941105942105943105944105945105946105947105948105949105950105951105952105953105954105955105956105957105958105959105960105961105962105963105964105965105966105967105968105969105970105971105972105973105974105975105976105977105978105979105980105981105982105983105984105985105986105987105988105989105990105991105992105993105994105995105996105997105998105999106000106001106002106003106004106005106006106007106008106009106010106011106012106013106014106015106016106017106018106019106020106021106022106023106024106025106026106027106028106029106030106031106032106033106034106035106036106037106038106039106040106041106042106043106044106045106046106047106048106049106050106051106052106053106054106055106056106057106058106059106060106061106062106063106064106065106066106067106068106069106070106071106072106073106074106075106076106077106078106079106080106081106082106083106084106085106086106087106088106089106090106091106092106093106094106095106096106097106098106099106100106101106102106103106104106105106106106107106108106109106110106111106112106113106114106115106116106117106118106119106120106121106122106123106124106125106126106127106128106129106130106131106132106133106134106135106136106137106138106139106140106141106142106143106144106145106146106147106148106149106150106151106152106153106154106155106156106157106158106159106160106161106162106163106164106165106166106167106168106169106170106171106172106173106174106175106176106177106178106179106180106181106182106183106184106185106186106187106188106189106190106191106192106193106194106195106196106197106198106199106200106201106202106203106204106205106206106207106208106209106210106211106212106213106214106215106216106217106218106219106220106221106222106223106224106225106226106227106228106229106230106231106232106233106234106235106236106237106238106239106240106241106242106243106244106245106246106247106248106249106250106251106252106253106254106255106256106257106258106259106260106261106262106263106264106265106266106267106268106269106270106271106272106273106274106275106276106277106278106279106280106281106282106283106284106285106286106287106288106289106290106291106292106293106294106295106296106297106298106299106300106301106302106303106304106305106306106307106308106309106310106311106312106313106314106315106316106317106318106319106320106321106322106323106324106325106326106327106328106329106330106331106332106333106334106335106336106337106338106339106340106341106342106343106344106345106346106347106348106349106350106351106352106353106354106355106356106357106358106359106360106361106362106363106364106365106366106367106368106369106370106371106372106373106374106375106376106377106378106379106380106381106382106383106384106385106386106387106388106389106390106391106392106393106394106395106396106397106398106399106400106401106402106403106404106405106406106407106408106409106410106411106412106413106414106415106416106417106418106419106420106421106422106423106424106425106426106427106428106429106430106431106432106433106434106435106436106437106438106439106440106441106442106443106444106445106446106447106448106449106450106451106452106453106454106455106456106457106458106459106460106461106462106463106464106465106466106467106468106469106470106471106472106473106474106475106476106477106478106479106480106481106482106483106484106485106486106487106488106489106490106491106492106493106494106495106496106497106498106499106500106501106502106503106504106505106506106507106508106509106510106511106512106513106514106515106516106517106518106519106520106521106522106523106524106525106526106527106528106529106530106531106532106533106534106535106536106537106538106539106540106541106542106543106544106545106546106547106548106549106550106551106552106553106554106555106556106557106558106559106560106561106562106563106564106565106566106567106568106569106570106571106572106573106574106575106576106577106578106579106580106581106582106583106584106585106586106587106588106589106590106591106592106593106594106595106596106597106598106599106600106601106602106603106604106605106606106607106608106609106610106611106612106613106614106615106616106617106618106619106620106621106622106623106624106625106626106627106628106629106630106631106632106633106634106635106636106637106638106639106640106641106642106643106644106645106646106647106648106649106650106651106652106653106654106655106656106657106658106659106660106661106662106663106664106665106666106667106668106669106670106671106672106673106674106675106676106677106678106679106680106681106682106683106684106685106686106687106688106689106690106691106692106693106694106695106696106697106698106699106700106701106702106703106704106705106706106707106708106709106710106711106712106713106714106715106716106717106718106719106720106721106722106723106724106725106726106727106728106729106730106731106732106733106734106735106736106737106738106739106740106741106742106743106744106745106746106747106748106749106750106751106752106753106754106755106756106757106758106759106760106761106762106763106764106765106766106767106768106769106770106771106772106773106774106775106776106777106778106779106780106781106782106783106784106785106786106787106788106789106790106791106792106793106794106795106796106797106798106799106800106801106802106803106804106805106806106807106808106809106810106811106812106813106814106815106816106817106818106819106820106821106822106823106824106825106826106827106828106829106830106831106832106833106834106835106836106837106838106839106840106841106842106843106844106845106846106847106848106849106850106851106852106853106854106855106856106857106858106859106860106861106862106863106864106865106866106867106868106869106870106871106872106873106874106875106876106877106878106879106880106881106882106883106884106885106886106887106888106889106890106891106892106893106894106895106896106897106898106899106900106901106902106903106904106905106906106907106908106909106910106911106912106913106914106915106916106917106918106919106920106921106922106923106924106925106926106927106928106929106930106931106932106933106934106935106936106937106938106939106940106941106942106943106944106945106946106947106948106949106950106951106952106953106954106955106956106957106958106959106960106961106962106963106964106965106966106967106968106969106970106971106972106973106974106975106976106977106978106979106980106981106982106983106984106985106986106987106988106989106990106991106992106993106994106995106996106997106998106999107000107001107002107003107004107005107006107007107008107009107010107011107012107013107014107015107016107017107018107019107020107021107022107023107024107025107026107027107028107029107030107031107032107033107034107035107036107037107038107039107040107041107042107043107044107045107046107047107048107049107050107051107052107053107054107055107056107057107058107059107060107061107062107063107064107065107066107067107068107069107070107071107072107073107074107075107076107077107078107079107080107081107082107083107084107085107086107087107088107089107090107091107092107093107094107095107096107097107098107099107100107101107102107103107104107105107106107107107108107109107110107111107112107113107114107115107116107117107118107119107120107121107122107123107124107125107126107127107128107129107130107131107132107133107134107135107136107137107138107139107140107141107142107143107144107145107146107147107148107149107150107151107152107153107154107155107156107157107158107159107160107161107162107163107164107165107166107167107168107169107170107171107172107173107174107175107176107177107178107179107180107181107182107183107184107185107186107187107188107189107190107191107192107193107194107195107196107197107198107199107200107201107202107203107204107205107206107207107208107209107210107211107212107213107214107215107216107217107218107219107220107221107222107223107224107225107226107227107228107229107230107231107232107233107234107235107236107237107238107239107240107241107242107243107244107245107246107247107248107249107250107251107252107253107254107255107256107257107258107259107260107261107262107263107264107265107266107267107268107269107270107271107272107273107274107275107276107277107278107279107280107281107282107283107284107285107286107287107288107289107290107291107292107293107294107295107296107297107298107299107300107301107302107303107304107305107306107307107308107309107310107311107312107313107314107315107316107317107318107319107320107321107322107323107324107325107326107327107328107329107330107331107332107333107334107335107336107337107338107339107340107341107342107343107344107345107346107347107348107349107350107351107352107353107354107355107356107357107358107359107360107361107362107363107364107365107366107367107368107369107370107371107372107373107374107375107376107377107378107379107380107381107382107383107384107385107386107387107388107389107390107391107392107393107394107395107396107397107398107399107400107401107402107403107404107405107406107407107408107409107410107411107412107413107414107415107416107417107418107419107420107421107422107423107424107425107426107427107428107429107430107431107432107433107434107435107436107437107438107439107440107441107442107443107444107445107446107447107448107449107450107451107452107453107454107455107456107457107458107459107460107461107462107463107464107465107466107467107468107469107470107471107472107473107474107475107476107477107478107479107480107481107482107483107484107485107486107487107488107489107490107491107492107493107494107495107496107497107498107499107500107501107502107503107504107505107506107507107508107509107510107511107512107513107514107515107516107517107518107519107520107521107522107523107524107525107526107527107528107529107530107531107532107533107534107535107536107537107538107539107540107541107542107543107544107545107546107547107548107549107550107551107552107553107554107555107556107557107558107559107560107561107562107563107564107565107566107567107568107569107570107571107572107573107574107575107576107577107578107579107580107581107582107583107584107585107586107587107588107589107590107591107592107593107594107595107596107597107598107599107600107601107602107603107604107605107606107607107608107609107610107611107612107613107614107615107616107617107618107619107620107621107622107623107624107625107626107627107628107629107630107631107632107633107634107635107636107637107638107639107640107641107642107643107644107645107646107647107648107649107650107651107652107653107654107655107656107657107658107659107660107661107662107663107664107665107666107667107668107669107670107671107672107673107674107675107676107677107678107679107680107681107682107683107684107685107686107687107688107689107690107691107692107693107694107695107696107697107698107699107700107701107702107703107704107705107706107707107708107709107710107711107712107713107714107715107716107717107718107719107720107721107722107723107724107725107726107727107728107729107730107731107732107733107734107735107736107737107738107739107740107741107742107743107744107745107746107747107748107749107750107751107752107753107754107755107756107757107758107759107760107761107762107763107764107765107766107767107768107769107770107771107772107773107774107775107776107777107778107779107780107781107782107783107784107785107786107787107788107789107790107791107792107793107794107795107796107797107798107799107800107801107802107803107804107805107806107807107808107809107810107811107812107813107814107815107816107817107818107819107820107821107822107823107824107825107826107827107828107829107830107831107832107833107834107835107836107837107838107839107840107841107842107843107844107845107846107847107848107849107850107851107852107853107854107855107856107857107858107859107860107861107862107863107864107865107866107867107868107869107870107871107872107873107874107875107876107877107878107879107880107881107882107883107884107885107886107887107888107889107890107891107892107893107894107895107896107897107898107899107900107901107902107903107904107905107906107907107908107909107910107911107912107913107914107915107916107917107918107919107920107921107922107923107924107925107926107927107928107929107930107931107932107933107934107935107936107937107938107939107940107941107942107943107944107945107946107947107948107949107950107951107952107953107954107955107956107957107958107959107960107961107962107963107964107965107966107967107968107969107970107971107972107973107974107975107976107977107978107979107980107981107982107983107984107985107986107987107988107989107990107991107992107993107994107995107996107997107998107999108000108001108002108003108004108005108006108007108008108009108010108011108012108013108014108015108016108017108018108019108020108021108022108023108024108025108026108027108028108029108030108031108032108033108034108035108036108037108038108039108040108041108042108043108044108045108046108047108048108049108050108051108052108053108054108055108056108057108058108059108060108061108062108063108064108065108066108067108068108069108070108071108072108073108074108075108076108077108078108079108080108081108082108083108084108085108086108087108088108089108090108091108092108093108094108095108096108097108098108099108100108101108102108103108104108105108106108107108108108109108110108111108112108113108114108115108116108117108118108119108120108121108122108123108124108125108126108127108128108129108130108131108132108133108134108135108136108137108138108139108140108141108142108143108144108145108146108147108148108149108150108151108152108153108154108155108156108157108158108159108160108161108162108163108164108165108166108167108168108169108170108171108172108173108174108175108176108177108178108179108180108181108182108183108184108185108186108187108188108189108190108191108192108193108194108195108196108197108198108199108200108201108202108203108204108205108206108207108208108209108210108211108212108213108214108215108216108217108218108219108220108221108222108223108224108225108226108227108228108229108230108231108232108233108234108235108236108237108238108239108240108241108242108243108244108245108246108247108248108249108250108251108252108253108254108255108256108257108258108259108260108261108262108263108264108265108266108267108268108269108270108271108272108273108274108275108276108277108278108279108280108281108282108283108284108285108286108287108288108289108290108291108292108293108294108295108296108297108298108299108300108301108302108303108304108305108306108307108308108309108310108311108312108313108314108315108316108317108318108319108320108321108322108323108324108325108326108327108328108329108330108331108332108333108334108335108336108337108338108339108340108341108342108343108344108345108346108347108348108349108350108351108352108353108354108355108356108357108358108359108360108361108362108363108364108365108366108367108368108369108370108371108372108373108374108375108376108377108378108379108380108381108382108383108384108385108386108387108388108389108390108391108392108393108394108395108396108397108398108399108400108401108402108403108404108405108406108407108408108409108410108411108412108413108414108415108416108417108418108419108420108421108422108423108424108425108426108427108428108429108430108431108432108433108434108435108436108437108438108439108440108441108442108443108444108445108446108447108448108449108450108451108452108453108454108455108456108457108458108459108460108461108462108463108464108465108466108467108468108469108470108471108472108473108474108475108476108477108478108479108480108481108482108483108484108485108486108487108488108489108490108491108492108493108494108495108496108497108498108499108500108501108502108503108504108505108506108507108508108509108510108511108512108513108514108515108516108517108518108519108520108521108522108523108524108525108526108527108528108529108530108531108532108533108534108535108536108537108538108539108540108541108542108543108544108545108546108547108548108549108550108551108552108553108554108555108556108557108558108559108560108561108562108563108564108565108566108567108568108569108570108571108572108573108574108575108576108577108578108579108580108581108582108583108584108585108586108587108588108589108590108591108592108593108594108595108596108597108598108599108600108601108602108603108604108605108606108607108608108609108610108611108612108613108614108615108616108617108618108619108620108621108622108623108624108625108626108627108628108629108630108631108632108633108634108635108636108637108638108639108640108641108642108643108644108645108646108647108648108649108650108651108652108653108654108655108656108657108658108659108660108661108662108663108664108665108666108667108668108669108670108671108672108673108674108675108676108677108678108679108680108681108682108683108684108685108686108687108688108689108690108691108692108693108694108695108696108697108698108699108700108701108702108703108704108705108706108707108708108709108710108711108712108713108714108715108716108717108718108719108720108721108722108723108724108725108726108727108728108729108730108731108732108733108734108735108736108737108738108739108740108741108742108743108744108745108746108747108748108749108750108751108752108753108754108755108756108757108758108759108760108761108762108763108764108765108766108767108768108769108770108771108772108773108774108775108776108777108778108779108780108781108782108783108784108785108786108787108788108789108790108791108792108793108794108795108796108797108798108799108800108801108802108803108804108805108806108807108808108809108810108811108812108813108814108815108816108817108818108819108820108821108822108823108824108825108826108827108828108829108830108831108832108833108834108835108836108837108838108839108840108841108842108843108844108845108846108847108848108849108850108851108852108853108854108855108856108857108858108859108860108861108862108863108864108865108866108867108868108869108870108871108872108873108874108875108876108877108878108879108880108881108882108883108884108885108886108887108888108889108890108891108892108893108894108895108896108897108898108899108900108901108902108903108904108905108906108907108908108909108910108911108912108913108914108915108916108917108918108919108920108921108922108923108924108925108926108927108928108929108930108931108932108933108934108935108936108937108938108939108940108941108942108943108944108945108946108947108948108949108950108951108952108953108954108955108956108957108958108959108960108961108962108963108964108965108966108967108968108969108970108971108972108973108974108975108976108977108978108979108980108981108982108983108984108985108986108987108988108989108990108991108992108993108994108995108996108997108998108999109000109001109002109003109004109005109006109007109008109009109010109011109012109013109014109015109016109017109018109019109020109021109022109023109024109025109026109027109028109029109030109031109032109033109034109035109036109037109038109039109040109041109042109043109044109045109046109047109048109049109050109051109052109053109054109055109056109057109058109059109060109061109062109063109064109065109066109067109068109069109070109071109072109073109074109075109076109077109078109079109080109081109082109083109084109085109086109087109088109089109090109091109092109093109094109095109096109097109098109099109100109101109102109103109104109105109106109107109108109109109110109111109112109113109114109115109116109117109118109119109120109121109122109123109124109125109126109127109128109129109130109131109132109133109134109135109136109137109138109139109140109141109142109143109144109145109146109147109148109149109150109151109152109153109154109155109156109157109158109159109160109161109162109163109164109165109166109167109168109169109170109171109172109173109174109175109176109177109178109179109180109181109182109183109184109185109186109187109188109189109190109191109192109193109194109195109196109197109198109199109200109201109202109203109204109205109206109207109208109209109210109211109212109213109214109215109216109217109218109219109220109221109222109223109224109225109226109227109228109229109230109231109232109233109234109235109236109237109238109239109240109241109242109243109244109245109246109247109248109249109250109251109252109253109254109255109256109257109258109259109260109261109262109263109264109265109266109267109268109269109270109271109272109273109274109275109276109277109278109279109280109281109282109283109284109285109286109287109288109289109290109291109292109293109294109295109296109297109298109299109300109301109302109303109304109305109306109307109308109309109310109311109312109313109314109315109316109317109318109319109320109321109322109323109324109325109326109327109328109329109330109331109332109333109334109335109336109337109338109339109340109341109342109343109344109345109346109347109348109349109350109351109352109353109354109355109356109357109358109359109360109361109362109363109364109365109366109367109368109369109370109371109372109373109374109375109376109377109378109379109380109381109382109383109384109385109386109387109388109389109390109391109392109393109394109395109396109397109398109399109400109401109402109403109404109405109406109407109408109409109410109411109412109413109414109415109416109417109418109419109420109421109422109423109424109425109426109427109428109429109430109431109432109433109434109435109436109437109438109439109440109441109442109443109444109445109446109447109448109449109450109451109452109453109454109455109456109457109458109459109460109461109462109463109464109465109466109467109468109469109470109471109472109473109474109475109476109477109478109479109480109481109482109483109484109485109486109487109488109489109490109491109492109493109494109495109496109497109498109499109500109501109502109503109504109505109506109507109508109509109510109511109512109513109514109515109516109517109518109519109520109521109522109523109524109525109526109527109528109529109530109531109532109533109534109535109536109537109538109539109540109541109542109543109544109545109546109547109548109549109550109551109552109553109554109555109556109557109558109559109560109561109562109563109564109565109566109567109568109569109570109571109572109573109574109575109576109577109578109579109580109581109582109583109584109585109586109587109588109589109590109591109592109593109594109595109596109597109598109599109600109601109602109603109604109605109606109607109608109609109610109611109612109613109614109615109616109617109618109619109620109621109622109623109624109625109626109627109628109629109630109631109632109633109634109635109636109637109638109639109640109641109642109643109644109645109646109647109648109649109650109651109652109653109654109655109656109657109658109659109660109661109662109663109664109665109666109667109668109669109670109671109672109673109674109675109676109677109678109679109680109681109682109683109684109685109686109687109688109689109690109691109692109693109694109695109696109697109698109699109700109701109702109703109704109705109706109707109708109709109710109711109712109713109714109715109716109717109718109719109720109721109722109723109724109725109726109727109728109729109730109731109732109733109734109735109736109737109738109739109740109741109742109743109744109745109746109747109748109749109750109751109752109753109754109755109756109757109758109759109760109761109762109763109764109765109766109767109768109769109770109771109772109773109774109775109776109777109778109779109780109781109782109783109784109785109786109787109788109789109790109791109792109793109794109795109796109797109798109799109800109801109802109803109804109805109806109807109808109809109810109811109812109813109814109815109816109817109818109819109820109821109822109823109824109825109826109827109828109829109830109831109832109833109834109835109836109837109838109839109840109841109842109843109844109845109846109847109848109849109850109851109852109853109854109855109856109857109858109859109860109861109862109863109864109865109866109867109868109869109870109871109872109873109874109875109876109877109878109879109880109881109882109883109884109885109886109887109888109889109890109891109892109893109894109895109896109897109898109899109900109901109902109903109904109905109906109907109908109909109910109911109912109913109914109915109916109917109918109919109920109921109922109923109924109925109926109927109928109929109930109931109932109933109934109935109936109937109938109939109940109941109942109943109944109945109946109947109948109949109950109951109952109953109954109955109956109957109958109959109960109961109962109963109964109965109966109967109968109969109970109971109972109973109974109975109976109977109978109979109980109981109982109983109984109985109986109987109988109989109990109991109992109993109994109995109996109997109998109999110000110001110002110003110004110005110006110007110008110009110010110011110012110013110014110015110016110017110018110019110020110021110022110023110024110025110026110027110028110029110030110031110032110033110034110035110036110037110038110039110040110041110042110043110044110045110046110047110048110049110050110051110052110053110054110055110056110057110058110059110060110061110062110063110064110065110066110067110068110069110070110071110072110073110074110075110076110077110078110079110080110081110082110083110084110085110086110087110088110089110090110091110092110093110094110095110096110097110098110099110100110101110102110103110104110105110106110107110108110109110110110111110112110113110114110115110116110117110118110119110120110121110122110123110124110125110126110127110128110129110130110131110132110133110134110135110136110137110138110139110140110141110142110143110144110145110146110147110148110149110150110151110152110153110154110155110156110157110158110159110160110161110162110163110164110165110166110167110168110169110170110171110172110173110174110175110176110177110178110179110180110181110182110183110184110185110186110187110188110189110190110191110192110193110194110195110196110197110198110199110200110201110202110203110204110205110206110207110208110209110210110211110212110213110214110215110216110217110218110219110220110221110222110223110224110225110226110227110228110229110230110231110232110233110234110235110236110237110238110239110240110241110242110243110244110245110246110247110248110249110250110251110252110253110254110255110256110257110258110259110260110261110262110263110264110265110266110267110268110269110270110271110272110273110274110275110276110277110278110279110280110281110282110283110284110285110286110287110288110289110290110291110292110293110294110295110296110297110298110299110300110301110302110303110304110305110306110307110308110309110310110311110312110313110314110315110316110317110318110319110320110321110322110323110324110325110326110327110328110329110330110331110332110333110334110335110336110337110338110339110340110341110342110343110344110345110346110347110348110349110350110351110352110353110354110355110356110357110358110359110360110361110362110363110364110365110366110367110368110369110370110371110372110373110374110375110376110377110378110379110380110381110382110383110384110385110386110387110388110389110390110391110392110393110394110395110396110397110398110399110400110401110402110403110404110405110406110407110408110409110410110411110412110413110414110415110416110417110418110419110420110421110422110423110424110425110426110427110428110429110430110431110432110433110434110435110436110437110438110439110440110441110442110443110444110445110446110447110448110449110450110451110452110453110454110455110456110457110458110459110460110461110462110463110464110465110466110467110468110469110470110471110472110473110474110475110476110477110478110479110480110481110482110483110484110485110486110487110488110489110490110491110492110493110494110495110496110497110498110499110500110501110502110503110504110505110506110507110508110509110510110511110512110513110514110515110516110517110518110519110520110521110522110523110524110525110526110527110528110529110530110531110532110533110534110535110536110537110538110539110540110541110542110543110544110545110546110547110548110549110550110551110552110553110554110555110556110557110558110559110560110561110562110563110564110565110566110567110568110569110570110571110572110573110574110575110576110577110578110579110580110581110582110583110584110585110586110587110588110589110590110591110592110593110594110595110596110597110598110599110600110601110602110603110604110605110606110607110608110609110610110611110612110613110614110615110616110617110618110619110620110621110622110623110624110625110626110627110628110629110630110631110632110633110634110635110636110637110638110639110640110641110642110643110644110645110646110647110648110649110650110651110652110653110654110655110656110657110658110659110660110661110662110663110664110665110666110667110668110669110670110671110672110673110674110675110676110677110678110679110680110681110682110683110684110685110686110687110688110689110690110691110692110693110694110695110696110697110698110699110700110701110702110703110704110705110706110707110708110709110710110711110712110713110714110715110716110717110718110719110720110721110722110723110724110725110726110727110728110729110730110731110732110733110734110735110736110737110738110739110740110741110742110743110744110745110746110747110748110749110750110751110752110753110754110755110756110757110758110759110760110761110762110763110764110765110766110767110768110769110770110771110772110773110774110775110776110777110778110779110780110781110782110783110784110785110786110787110788110789110790110791110792110793110794110795110796110797110798110799110800110801110802110803110804110805110806110807110808110809110810110811110812110813110814110815110816110817110818110819110820110821110822110823110824110825110826110827110828110829110830110831110832110833110834110835110836110837110838110839110840110841110842110843110844110845110846110847110848110849110850110851110852110853110854110855110856110857110858110859110860110861110862110863110864110865110866110867110868110869110870110871110872110873110874110875110876110877110878110879110880110881110882110883110884110885110886110887110888110889110890110891110892110893110894110895110896110897110898110899110900110901110902110903110904110905110906110907110908110909110910110911110912110913110914110915110916110917110918110919110920110921110922110923110924110925110926110927110928110929110930110931110932110933110934110935110936110937110938110939110940110941110942110943110944110945110946110947110948110949110950110951110952110953110954110955110956110957110958110959110960110961110962110963110964110965110966110967110968110969110970110971110972110973110974110975110976110977110978110979110980110981110982110983110984110985110986110987110988110989110990110991110992110993110994110995110996110997110998110999111000111001111002111003111004111005111006111007111008111009111010111011111012111013111014111015111016111017111018111019111020111021111022111023111024111025111026111027111028111029111030111031111032111033111034111035111036111037111038111039111040111041111042111043111044111045111046111047111048111049111050111051111052111053111054111055111056111057111058111059111060111061111062111063111064111065111066111067111068111069111070111071111072111073111074111075111076111077111078111079111080111081111082111083111084111085111086111087111088111089111090111091111092111093111094111095111096111097111098111099111100111101111102111103111104111105111106111107111108111109111110111111111112111113111114111115111116111117111118111119111120111121111122111123111124111125111126111127111128111129111130111131111132111133111134111135111136111137111138111139111140111141111142111143111144111145111146111147111148111149111150111151111152111153111154111155111156111157111158111159111160111161111162111163111164111165111166111167111168111169111170111171111172111173111174111175111176111177111178111179111180111181111182111183111184111185111186111187111188111189111190111191111192111193111194111195111196111197111198111199111200111201111202111203111204111205111206111207111208111209111210111211111212111213111214111215111216111217111218111219111220111221111222111223111224111225111226111227111228111229111230111231111232111233111234111235111236111237111238111239111240111241111242111243111244111245111246111247111248111249111250111251111252111253111254111255111256111257111258111259111260111261111262111263111264111265111266111267111268111269111270111271111272111273111274111275111276111277111278111279111280111281111282111283111284111285111286111287111288111289111290111291111292111293111294111295111296111297111298111299111300111301111302111303111304111305111306111307111308111309111310111311111312111313111314111315111316111317111318111319111320111321111322111323111324111325111326111327111328111329111330111331111332111333111334111335111336111337111338111339111340111341111342111343111344111345111346111347111348111349111350111351111352111353111354111355111356111357111358111359111360111361111362111363111364111365111366111367111368111369111370111371111372111373111374111375111376111377111378111379111380111381111382111383111384111385111386111387111388111389111390111391111392111393111394111395111396111397111398111399111400111401111402111403111404111405111406111407111408111409111410111411111412111413111414111415111416111417111418111419111420111421111422111423111424111425111426111427111428111429111430111431111432111433111434111435111436111437111438111439111440111441111442111443111444111445111446111447111448111449111450111451111452111453111454111455111456111457111458111459111460111461111462111463111464111465111466111467111468111469111470111471111472111473111474111475111476111477111478111479111480111481111482111483111484111485111486111487111488111489111490111491111492111493111494111495111496111497111498111499111500111501111502111503111504111505111506111507111508111509111510111511111512111513111514111515111516111517111518111519111520111521111522111523111524111525111526111527111528111529111530111531111532111533111534111535111536111537111538111539111540111541111542111543111544111545111546111547111548111549111550111551111552111553111554111555111556111557111558111559111560111561111562111563111564111565111566111567111568111569111570111571111572111573111574111575111576111577111578111579111580111581111582111583111584111585111586111587111588111589111590111591111592111593111594111595111596111597111598111599111600111601111602111603111604111605111606111607111608111609111610111611111612111613111614111615111616111617111618111619111620111621111622111623111624111625111626111627111628111629111630111631111632111633111634111635111636111637111638111639111640111641111642111643111644111645111646111647111648111649111650111651111652111653111654111655111656111657111658111659111660111661111662111663111664111665111666111667111668111669111670111671111672111673111674111675111676111677111678111679111680111681111682111683111684111685111686111687111688111689111690111691111692111693111694111695111696111697111698111699111700111701111702111703111704111705111706111707111708111709111710111711111712111713111714111715111716111717111718111719111720111721111722111723111724111725111726111727111728111729111730111731111732111733111734111735111736111737111738111739111740111741111742111743111744111745111746111747111748111749111750111751111752111753111754111755111756111757111758111759111760111761111762111763111764111765111766111767111768111769111770111771111772111773111774111775111776111777111778111779111780111781111782111783111784111785111786111787111788111789111790111791111792111793111794111795111796111797111798111799111800111801111802111803111804111805111806111807111808111809111810111811111812111813111814111815111816111817111818111819111820111821111822111823111824111825111826111827111828111829111830111831111832111833111834111835111836111837111838111839111840111841111842111843111844111845111846111847111848111849111850111851111852111853111854111855111856111857111858111859111860111861111862111863111864111865111866111867111868111869111870111871111872111873111874111875111876111877111878111879111880111881111882111883111884111885111886111887111888111889111890111891111892111893111894111895111896111897111898111899111900111901111902111903111904111905111906111907111908111909111910111911111912111913111914111915111916111917111918111919111920111921111922111923111924111925111926111927111928111929111930111931111932111933111934111935111936111937111938111939111940111941111942111943111944111945111946111947111948111949111950111951111952111953111954111955111956111957111958111959111960111961111962111963111964111965111966111967111968111969111970111971111972111973111974111975111976111977111978111979111980111981111982111983111984111985111986111987111988111989111990111991111992111993111994111995111996111997111998111999112000112001112002112003112004112005112006112007112008112009112010112011112012112013112014112015112016112017112018112019112020112021112022112023112024112025112026112027112028112029112030112031112032112033112034112035112036112037112038112039112040112041112042112043112044112045112046112047112048112049112050112051112052112053112054112055112056112057112058112059112060112061112062112063112064112065112066112067112068112069112070112071112072112073112074112075112076112077112078112079112080112081112082112083112084112085112086112087112088112089112090112091112092112093112094112095112096112097112098112099112100112101112102112103112104112105112106112107112108112109112110112111112112112113112114112115112116112117112118112119112120112121112122112123112124112125112126112127112128112129112130112131112132112133112134112135112136112137112138112139112140112141112142112143112144112145112146112147112148112149112150112151112152112153112154112155112156112157112158112159112160112161112162112163112164112165112166112167112168112169112170112171112172112173112174112175112176112177112178112179112180112181112182112183112184112185112186112187112188112189112190112191112192112193112194112195112196112197112198112199112200112201112202112203112204112205112206112207112208112209112210112211112212112213112214112215112216112217112218112219112220112221112222112223112224112225112226112227112228112229112230112231112232112233112234112235112236112237112238112239112240112241112242112243112244112245112246112247112248112249112250112251112252112253112254112255112256112257112258112259112260112261112262112263112264112265112266112267112268112269112270112271112272112273112274112275112276112277112278112279112280112281112282112283112284112285112286112287112288112289112290112291112292112293112294112295112296112297112298112299112300112301112302112303112304112305112306112307112308112309112310112311112312112313112314112315112316112317112318112319112320112321112322112323112324112325112326112327112328112329112330112331112332112333112334112335112336112337112338112339112340112341112342112343112344112345112346112347112348112349112350112351112352112353112354112355112356112357112358112359112360112361112362112363112364112365112366112367112368112369112370112371112372112373112374112375112376112377112378112379112380112381112382112383112384112385112386112387112388112389112390112391112392112393112394112395112396112397112398112399112400112401112402112403112404112405112406112407112408112409112410112411112412112413112414112415112416112417112418112419112420112421112422112423112424112425112426112427112428112429112430112431112432112433112434112435112436112437112438112439112440112441112442112443112444112445112446112447112448112449112450112451112452112453112454112455112456112457112458112459112460112461112462112463112464112465112466112467112468112469112470112471112472112473112474112475112476112477112478112479112480112481112482112483112484112485112486112487112488112489112490112491112492112493112494112495112496112497112498112499112500112501112502112503112504112505112506112507112508112509112510112511112512112513112514112515112516112517112518112519112520112521112522112523112524112525112526112527112528112529112530112531112532112533112534112535112536112537112538112539112540112541112542112543112544112545112546112547112548112549112550112551112552112553112554112555112556112557112558112559112560112561112562112563112564112565112566112567112568112569112570112571112572112573112574112575112576112577112578112579112580112581112582112583112584112585112586112587112588112589112590112591112592112593112594112595112596112597112598112599112600112601112602112603112604112605112606112607112608112609112610112611112612112613112614112615112616112617112618112619112620112621112622112623112624112625112626112627112628112629112630112631112632112633112634112635112636112637112638112639112640112641112642112643112644112645112646112647112648112649112650112651112652112653112654112655112656112657112658112659112660112661112662112663112664112665112666112667112668112669112670112671112672112673112674112675112676112677112678112679112680112681112682112683112684112685112686112687112688112689112690112691112692112693112694112695112696112697112698112699112700112701112702112703112704112705112706112707112708112709112710112711112712112713112714112715112716112717112718112719112720112721112722112723112724112725112726112727112728112729112730112731112732112733112734112735112736112737112738112739112740112741112742112743112744112745112746112747112748112749112750112751112752112753112754112755112756112757112758112759112760112761112762112763112764112765112766112767112768112769112770112771112772112773112774112775112776112777112778112779112780112781112782112783112784112785112786112787112788112789112790112791112792112793112794112795112796112797112798112799112800112801112802112803112804112805112806112807112808112809112810112811112812112813112814112815112816112817112818112819112820112821112822112823112824112825112826112827112828112829112830112831112832112833112834112835112836112837112838112839112840112841112842112843112844112845112846112847112848112849112850112851112852112853112854112855112856112857112858112859112860112861112862112863112864112865112866112867112868112869112870112871112872112873112874112875112876112877112878112879112880112881112882112883112884112885112886112887112888112889112890112891112892112893112894112895112896112897112898112899112900112901112902112903112904112905112906112907112908112909112910112911112912112913112914112915112916112917112918112919112920112921112922112923112924112925112926112927112928112929112930112931112932112933112934112935112936112937112938112939112940112941112942112943112944112945112946112947112948112949112950112951112952112953112954112955112956112957112958112959112960112961112962112963112964112965112966112967112968112969112970112971112972112973112974112975112976112977112978112979112980112981112982112983112984112985112986112987112988112989112990112991112992112993112994112995112996112997112998112999113000113001113002113003113004113005113006113007113008113009113010113011113012113013113014113015113016113017113018113019113020113021113022113023113024113025113026113027113028113029113030113031113032113033113034113035113036113037113038113039113040113041113042113043113044113045113046113047113048113049113050113051113052113053113054113055113056113057113058113059113060113061113062113063113064113065113066113067113068113069113070113071113072113073113074113075113076113077113078113079113080113081113082113083113084113085113086113087113088113089113090113091113092113093113094113095113096113097113098113099113100113101113102113103113104113105113106113107113108113109113110113111113112113113113114113115113116113117113118113119113120113121113122113123113124113125113126113127113128113129113130113131113132113133113134113135113136113137113138113139113140113141113142113143113144113145113146113147113148113149113150113151113152113153113154113155113156113157113158113159113160113161113162113163113164113165113166113167113168113169113170113171113172113173113174113175113176113177113178113179113180113181113182113183113184113185113186113187113188113189113190113191113192113193113194113195113196113197113198113199113200113201113202113203113204113205113206113207113208113209113210113211113212113213113214113215113216113217113218113219113220113221113222113223113224113225113226113227113228113229113230113231113232113233113234113235113236113237113238113239113240113241113242113243113244113245113246113247113248113249113250113251113252113253113254113255113256113257113258113259113260113261113262113263113264113265113266113267113268113269113270113271113272113273113274113275113276113277113278113279113280113281113282113283113284113285113286113287113288113289113290113291113292113293113294113295113296113297113298113299113300113301113302113303113304113305113306113307113308113309113310113311113312113313113314113315113316113317113318113319113320113321113322113323113324113325113326113327113328113329113330113331113332113333113334113335113336113337113338113339113340113341113342113343113344113345113346113347113348113349113350113351113352113353113354113355113356113357113358113359113360113361113362113363113364113365113366113367113368113369113370113371113372113373113374113375113376113377113378113379113380113381113382113383113384113385113386113387113388113389113390113391113392113393113394113395113396113397113398113399113400113401113402113403113404113405113406113407113408113409113410113411113412113413113414113415113416113417113418113419113420113421113422113423113424113425113426113427113428113429113430113431113432113433113434113435113436113437113438113439113440113441113442113443113444113445113446113447113448113449113450113451113452113453113454113455113456113457113458113459113460113461113462113463113464113465113466113467113468113469113470113471113472113473113474113475113476113477113478113479113480113481113482113483113484113485113486113487113488113489113490113491113492113493113494113495113496113497113498113499113500113501113502113503113504113505113506113507113508113509113510113511113512113513113514113515113516113517113518113519113520113521113522113523113524113525113526113527113528113529113530113531113532113533113534113535113536113537113538113539113540113541113542113543113544113545113546113547113548113549113550113551113552113553113554113555113556113557113558113559113560113561113562113563113564113565113566113567113568113569113570113571113572113573113574113575113576113577113578113579113580113581113582113583113584113585113586113587113588113589113590113591113592113593113594113595113596113597113598113599113600113601113602113603113604113605113606113607113608113609113610113611113612113613113614113615113616113617113618113619113620113621113622113623113624113625113626113627113628113629113630113631113632113633113634113635113636113637113638113639113640113641113642113643113644113645113646113647113648113649113650113651113652113653113654113655113656113657113658113659113660113661113662113663113664113665113666113667113668113669113670113671113672113673113674113675113676113677113678113679113680113681113682113683113684113685113686113687113688113689113690113691113692113693113694113695113696113697113698113699113700113701113702113703113704113705113706113707113708113709113710113711113712113713113714113715113716113717113718113719113720113721113722113723113724113725113726113727113728113729113730113731113732113733113734113735113736113737113738113739113740113741113742113743113744113745113746113747113748113749113750113751113752113753113754113755113756113757113758113759113760113761113762113763113764113765113766113767113768113769113770113771113772113773113774113775113776113777113778113779113780113781113782113783113784113785113786113787113788113789113790113791113792113793113794113795113796113797113798113799113800113801113802113803113804113805113806113807113808113809113810113811113812113813113814113815113816113817113818113819113820113821113822113823113824113825113826113827113828113829113830113831113832113833113834113835113836113837113838113839113840113841113842113843113844113845113846113847113848113849113850113851113852113853113854113855113856113857113858113859113860113861113862113863113864113865113866113867113868113869113870113871113872113873113874113875113876113877113878113879113880113881113882113883113884113885113886113887113888113889113890113891113892113893113894113895113896113897113898113899113900113901113902113903113904113905113906113907113908113909113910113911113912113913113914113915113916113917113918113919113920113921113922113923113924113925113926113927113928113929113930113931113932113933113934113935113936113937113938113939113940113941113942113943113944113945113946113947113948113949113950113951113952113953113954113955113956113957113958113959113960113961113962113963113964113965113966113967113968113969113970113971113972113973113974113975113976113977113978113979113980113981113982113983113984113985113986113987113988113989113990113991113992113993113994113995113996113997113998113999114000114001114002114003114004114005114006114007114008114009114010114011114012114013114014114015114016114017114018114019114020114021114022114023114024114025114026114027114028114029114030114031114032114033114034114035114036114037114038114039114040114041114042114043114044114045114046114047114048114049114050114051114052114053114054114055114056114057114058114059114060114061114062114063114064114065114066114067114068114069114070114071114072114073114074114075114076114077114078114079114080114081114082114083114084114085114086114087114088114089114090114091114092114093114094114095114096114097114098114099114100114101114102114103114104114105114106114107114108114109114110114111114112114113114114114115114116114117114118114119114120114121114122114123114124114125114126114127114128114129114130114131114132114133114134114135114136114137114138114139114140114141114142114143114144114145114146114147114148114149114150114151114152114153114154114155114156114157114158114159114160114161114162114163114164114165114166114167114168114169114170114171114172114173114174114175114176114177114178114179114180114181114182114183114184114185114186114187114188114189114190114191114192114193114194114195114196114197114198114199114200114201114202114203114204114205114206114207114208114209114210114211114212114213114214114215114216114217114218114219114220114221114222114223114224114225114226114227114228114229114230114231114232114233114234114235114236114237114238114239114240114241114242114243114244114245114246114247114248114249114250114251114252114253114254114255114256114257114258114259114260114261114262114263114264114265114266114267114268114269114270114271114272114273114274114275114276114277114278114279114280114281114282114283114284114285114286114287114288114289114290114291114292114293114294114295114296114297114298114299114300114301114302114303114304114305114306114307114308114309114310114311114312114313114314114315114316114317114318114319114320114321114322114323114324114325114326114327114328114329114330114331114332114333114334114335114336114337114338114339114340114341114342114343114344114345114346114347114348114349114350114351114352114353114354114355114356114357114358114359114360114361114362114363114364114365114366114367114368114369114370114371114372114373114374114375114376114377114378114379114380114381114382114383114384114385114386114387114388114389114390114391114392114393114394114395114396114397114398114399114400114401114402114403114404114405114406114407114408114409114410114411114412114413114414114415114416114417114418114419114420114421114422114423114424114425114426114427114428114429114430114431114432114433114434114435114436114437114438114439114440114441114442114443114444114445114446114447114448114449114450114451114452114453114454114455114456114457114458114459114460114461114462114463114464114465114466114467114468114469114470114471114472114473114474114475114476114477114478114479114480114481114482114483114484114485114486114487114488114489114490114491114492114493114494114495114496114497114498114499114500114501114502114503114504114505114506114507114508114509114510114511114512114513114514114515114516114517114518114519114520114521114522114523114524114525114526114527114528114529114530114531114532114533114534114535114536114537114538114539114540114541114542114543114544114545114546114547114548114549114550114551114552114553114554114555114556114557114558114559114560114561114562114563114564114565114566114567114568114569114570114571114572114573114574114575114576114577114578114579114580114581114582114583114584114585114586114587114588114589114590114591114592114593114594114595114596114597114598114599114600114601114602114603114604114605114606114607114608114609114610114611114612114613114614114615114616114617114618114619114620114621114622114623114624114625114626114627114628114629114630114631114632114633114634114635114636114637114638114639114640114641114642114643114644114645114646114647114648114649114650114651114652114653114654114655114656114657114658114659114660114661114662114663114664114665114666114667114668114669114670114671114672114673114674114675114676114677114678114679114680114681114682114683114684114685114686114687114688114689114690114691114692114693114694114695114696114697114698114699114700114701114702114703114704114705114706114707114708114709114710114711114712114713114714114715114716114717114718114719114720114721114722114723114724114725114726114727114728114729114730114731114732114733114734114735114736114737114738114739114740114741114742114743114744114745114746114747114748114749114750114751114752114753114754114755114756114757114758114759114760114761114762114763114764114765114766114767114768114769114770114771114772114773114774114775114776114777114778114779114780114781114782114783114784114785114786114787114788114789114790114791114792114793114794114795114796114797114798114799114800114801114802114803114804114805114806114807114808114809114810114811114812114813114814114815114816114817114818114819114820114821114822114823114824114825114826114827114828114829114830114831114832114833114834114835114836114837114838114839114840114841114842114843114844114845114846114847114848114849114850114851114852114853114854114855114856114857114858114859114860114861114862114863114864114865114866114867114868114869114870114871114872114873114874114875114876114877114878114879114880114881114882114883114884114885114886114887114888114889114890114891114892114893114894114895114896114897114898114899114900114901114902114903114904114905114906114907114908114909114910114911114912114913114914114915114916114917114918114919114920114921114922114923114924114925114926114927114928114929114930114931114932114933114934114935114936114937114938114939114940114941114942114943114944114945114946114947114948114949114950114951114952114953114954114955114956114957114958114959114960114961114962114963114964114965114966114967114968114969114970114971114972114973114974114975114976114977114978114979114980114981114982114983114984114985114986114987114988114989114990114991114992114993114994114995114996114997114998114999115000115001115002115003115004115005115006115007115008115009115010115011115012115013115014115015115016115017115018115019115020115021115022115023115024115025115026115027115028115029115030115031115032115033115034115035115036115037115038115039115040115041115042115043115044115045115046115047115048115049115050115051115052115053115054115055115056115057115058115059115060115061115062115063115064115065115066115067115068115069115070115071115072115073115074115075115076115077115078115079115080115081115082115083115084115085115086115087115088115089115090115091115092115093115094115095115096115097115098115099115100115101115102115103115104115105115106115107115108115109115110115111115112115113115114115115115116115117115118115119115120115121115122115123115124115125115126115127115128115129115130115131115132115133115134115135115136115137115138115139115140115141115142115143115144115145115146115147115148115149115150115151115152115153115154115155115156115157115158115159115160115161115162115163115164115165115166115167115168115169115170115171115172115173115174115175115176115177115178115179115180115181115182115183115184115185115186115187115188115189115190115191115192115193115194115195115196115197115198115199115200115201115202115203115204115205115206115207115208115209115210115211115212115213115214115215115216115217115218115219115220115221115222115223115224115225115226115227115228115229115230115231115232115233115234115235115236115237115238115239115240115241115242115243115244115245115246115247115248115249115250115251115252115253115254115255115256115257115258115259115260115261115262115263115264115265115266115267115268115269115270115271115272115273115274115275115276115277115278115279115280115281115282115283115284115285115286115287115288115289115290115291115292115293115294115295115296115297115298115299115300115301115302115303115304115305115306115307115308115309115310115311115312115313115314115315115316115317115318115319115320115321115322115323115324115325115326115327115328115329115330115331115332115333115334115335115336115337115338115339115340115341115342115343115344115345115346115347115348115349115350115351115352115353115354115355115356115357115358115359115360115361115362115363115364115365115366115367115368115369115370115371115372115373115374115375115376115377115378115379115380115381115382115383115384115385115386115387115388115389115390115391115392115393115394115395115396115397115398115399115400115401115402115403115404115405115406115407115408115409115410115411115412115413115414115415115416115417115418115419115420115421115422115423115424115425115426115427115428115429115430115431115432115433115434115435115436115437115438115439115440115441115442115443115444115445115446115447115448115449115450115451115452115453115454115455115456115457115458115459115460115461115462115463115464115465115466115467115468115469115470115471115472115473115474115475115476115477115478115479115480115481115482115483115484115485115486115487115488115489115490115491115492115493115494115495115496115497115498115499115500115501115502115503115504115505115506115507115508115509115510115511115512115513115514115515115516115517115518115519115520115521115522115523115524115525115526115527115528115529115530115531115532115533115534115535115536115537115538115539115540115541115542115543115544115545115546115547115548115549115550115551115552115553115554115555115556115557115558115559115560115561115562115563115564115565115566115567115568115569115570115571115572115573115574115575115576115577115578115579115580115581115582115583115584115585115586115587115588115589115590115591115592115593115594115595115596115597115598115599115600115601115602115603115604115605115606115607115608115609115610115611115612115613115614115615115616115617115618115619115620115621115622115623115624115625115626115627115628115629115630115631115632115633115634115635115636115637115638115639115640115641115642115643115644115645115646115647115648115649115650115651115652115653115654115655115656115657115658115659115660115661115662115663115664115665115666115667115668115669115670115671115672115673115674115675115676115677115678115679115680115681115682115683115684115685115686115687115688115689115690115691115692115693115694115695115696115697115698115699115700115701115702115703115704115705115706115707115708115709115710115711115712115713115714115715115716115717115718115719115720115721115722115723115724115725115726115727115728115729115730115731115732115733115734115735115736115737115738115739115740115741115742115743115744115745115746115747115748115749115750115751115752115753115754115755115756115757115758115759115760115761115762115763115764115765115766115767115768115769115770115771115772115773115774115775115776115777115778115779115780115781115782115783115784115785115786115787115788115789115790115791115792115793115794115795115796115797115798115799115800115801115802115803115804115805115806115807115808115809115810115811115812115813115814115815115816115817115818115819115820115821115822115823115824115825115826115827115828115829115830115831115832115833115834115835115836115837115838115839115840115841115842115843115844115845115846115847115848115849115850115851115852115853115854115855115856115857115858115859115860115861115862115863115864115865115866115867115868115869115870115871115872115873115874115875115876115877115878115879115880115881115882115883115884115885115886115887115888115889115890115891115892115893115894115895115896115897115898115899115900115901115902115903115904115905115906115907115908115909115910115911115912115913115914115915115916115917115918115919115920115921115922115923115924115925115926115927115928115929115930115931115932115933115934115935115936115937115938115939115940115941115942115943115944115945115946115947115948115949115950115951115952115953115954115955115956115957115958115959115960115961115962115963115964115965115966115967115968115969115970115971115972115973115974115975115976115977115978115979115980115981115982115983115984115985115986115987115988115989115990115991115992115993115994115995115996115997115998115999116000116001116002116003116004116005116006116007116008116009116010116011116012116013116014116015116016116017116018116019116020116021116022116023116024116025116026116027116028116029116030116031116032116033116034116035116036116037116038116039116040116041116042116043116044116045116046116047116048116049116050116051116052116053116054116055116056116057116058116059116060116061116062116063116064116065116066116067116068116069116070116071116072116073116074116075116076116077116078116079116080116081116082116083116084116085116086116087116088116089116090116091116092116093116094116095116096116097116098116099116100116101116102116103116104116105116106116107116108116109116110116111116112116113116114116115116116116117116118116119116120116121116122116123116124116125116126116127116128116129116130116131116132116133116134116135116136116137116138116139116140116141116142116143116144116145116146116147116148116149116150116151116152116153116154116155116156116157116158116159116160116161116162116163116164116165116166116167116168116169116170116171116172116173116174116175116176116177116178116179116180116181116182116183116184116185116186116187116188116189116190116191116192116193116194116195116196116197116198116199116200116201116202116203116204116205116206116207116208116209116210116211116212116213116214116215116216116217116218116219116220116221116222116223116224116225116226116227116228116229116230116231116232116233116234116235116236116237116238116239116240116241116242116243116244116245116246116247116248116249116250116251116252116253116254116255116256116257116258116259116260116261116262116263116264116265116266116267116268116269116270116271116272116273116274116275116276116277116278116279116280116281116282116283116284116285116286116287116288116289116290116291116292116293116294116295116296116297116298116299116300116301116302116303116304116305116306116307116308116309116310116311116312116313116314116315116316116317116318116319116320116321116322116323116324116325116326116327116328116329116330116331116332116333116334116335116336116337116338116339116340116341116342116343116344116345116346116347116348116349116350116351116352116353116354116355116356116357116358116359116360116361116362116363116364116365116366116367116368116369116370116371116372116373116374116375116376116377116378116379116380116381116382116383116384116385116386116387116388116389116390116391116392116393116394116395116396116397116398116399116400116401116402116403116404116405116406116407116408116409116410116411116412116413116414116415116416116417116418116419116420116421116422116423116424116425116426116427116428116429116430116431116432116433116434116435116436116437116438116439116440116441116442116443116444116445116446116447116448116449116450116451116452116453116454116455116456116457116458116459116460116461116462116463116464116465116466116467116468116469116470116471116472116473116474116475116476116477116478116479116480116481116482116483116484116485116486116487116488116489116490116491116492116493116494116495116496116497116498116499116500116501116502116503116504116505116506116507116508116509116510116511116512116513116514116515116516116517116518116519116520116521116522116523116524116525116526116527116528116529116530116531116532116533116534116535116536116537116538116539116540116541116542116543116544116545116546116547116548116549116550116551116552116553116554116555116556116557116558116559116560116561116562116563116564116565116566116567116568116569116570116571116572116573116574116575116576116577116578116579116580116581116582116583116584116585116586116587116588116589116590116591116592116593116594116595116596116597116598116599116600116601116602116603116604116605116606116607116608116609116610116611116612116613116614116615116616116617116618116619116620116621116622116623116624116625116626116627116628116629116630116631116632116633116634116635116636116637116638116639116640116641116642116643116644116645116646116647116648116649116650116651116652116653116654116655116656116657116658116659116660116661116662116663116664116665116666116667116668116669116670116671116672116673116674116675116676116677116678116679116680116681116682116683116684116685116686116687116688116689116690116691116692116693116694116695116696116697116698116699116700116701116702116703116704116705116706116707116708116709116710116711116712116713116714116715116716116717116718116719116720116721116722116723116724116725116726116727116728116729116730116731116732116733116734116735116736116737116738116739116740116741116742116743116744116745116746116747116748116749116750116751116752116753116754116755116756116757116758116759116760116761116762116763116764116765116766116767116768116769116770116771116772116773116774116775116776116777116778116779116780116781116782116783116784116785116786116787116788116789116790116791116792116793116794116795116796116797116798116799116800116801116802116803116804116805116806116807116808116809116810116811116812116813116814116815116816116817116818116819116820116821116822116823116824116825116826116827116828116829116830116831116832116833116834116835116836116837116838116839116840116841116842116843116844116845116846116847116848116849116850116851116852116853116854116855116856116857116858116859116860116861116862116863116864116865116866116867116868116869116870116871116872116873116874116875116876116877116878116879116880116881116882116883116884116885116886116887116888116889116890116891116892116893116894116895116896116897116898116899116900116901116902116903116904116905116906116907116908116909116910116911116912116913116914116915116916116917116918116919116920116921116922116923116924116925116926116927116928116929116930116931116932116933116934116935116936116937116938116939116940116941116942116943116944116945116946116947116948116949116950116951116952116953116954116955116956116957116958116959116960116961116962116963116964116965116966116967116968116969116970116971116972116973116974116975116976116977116978116979116980116981116982116983116984116985116986116987116988116989116990116991116992116993116994116995116996116997116998116999117000117001117002117003117004117005117006117007117008117009117010117011117012117013117014117015117016117017117018117019117020117021117022117023117024117025117026117027117028117029117030117031117032117033117034117035117036117037117038117039117040117041117042117043117044117045117046117047117048117049117050117051117052117053117054117055117056117057117058117059117060117061117062117063117064117065117066117067117068117069117070117071117072117073117074117075117076117077117078117079117080117081117082117083117084117085117086117087117088117089117090117091117092117093117094117095117096117097117098117099117100117101117102117103117104117105117106117107117108117109117110117111117112117113117114117115117116117117117118117119117120117121117122117123117124117125117126117127117128117129117130117131117132117133117134117135117136117137117138117139117140117141117142117143117144117145117146117147117148117149117150117151117152117153117154117155117156117157117158117159117160117161117162117163117164117165117166117167117168117169117170117171117172117173117174117175117176117177117178117179117180117181117182117183117184117185117186117187117188117189117190117191117192117193117194117195117196117197117198117199117200117201117202117203117204117205117206117207117208117209117210117211117212117213117214117215117216117217117218117219117220117221117222117223117224117225117226117227117228117229117230117231117232117233117234117235117236117237117238117239117240117241117242117243117244117245117246117247117248117249117250117251117252117253117254117255117256117257117258117259117260117261117262117263117264117265117266117267117268117269117270117271117272117273117274117275117276117277117278117279117280117281117282117283117284117285117286117287117288117289117290117291117292117293117294117295117296117297117298117299117300117301117302117303117304117305117306117307117308117309117310117311117312117313117314117315117316117317117318117319117320117321117322117323117324117325117326117327117328117329117330117331117332117333117334117335117336117337117338117339117340117341117342117343117344117345117346117347117348117349117350117351117352117353117354117355117356117357117358117359117360117361117362117363117364117365117366117367117368117369117370117371117372117373117374117375117376117377117378117379117380117381117382117383117384117385117386117387117388117389117390117391117392117393117394117395117396117397117398117399117400117401117402117403117404117405117406117407117408117409117410117411117412117413117414117415117416117417117418117419117420117421117422117423117424117425117426117427117428117429117430117431117432117433117434117435117436117437117438117439117440117441117442117443117444117445117446117447117448117449117450117451117452117453117454117455117456117457117458117459117460117461117462117463117464117465117466117467117468117469117470117471117472117473117474117475117476117477117478117479117480117481117482117483117484117485117486117487117488117489117490117491117492117493117494117495117496117497117498117499117500117501117502117503117504117505117506117507117508117509117510117511117512117513117514117515117516117517117518117519117520117521117522117523117524117525117526117527117528117529117530117531117532117533117534117535117536117537117538117539117540117541117542117543117544117545117546117547117548117549117550117551117552117553117554117555117556117557117558117559117560117561117562117563117564117565117566117567117568117569117570117571117572117573117574117575117576117577117578117579117580117581117582117583117584117585117586117587117588117589117590117591117592117593117594117595117596117597117598117599117600117601117602117603117604117605117606117607117608117609117610117611117612117613117614117615117616117617117618117619117620117621117622117623117624117625117626117627117628117629117630117631117632117633117634117635117636117637117638117639117640117641117642117643117644117645117646117647117648117649117650117651117652117653117654117655117656117657117658117659117660117661117662117663117664117665117666117667117668117669117670117671117672117673117674117675117676117677117678117679117680117681117682117683117684117685117686117687117688117689117690117691117692117693117694117695117696117697117698117699117700117701117702117703117704117705117706117707117708117709117710117711117712117713117714117715117716117717117718117719117720117721117722117723117724117725117726117727117728117729117730117731117732117733117734117735117736117737117738117739117740117741117742117743117744117745117746117747117748117749117750117751117752117753117754117755117756117757117758117759117760117761117762117763117764117765117766117767117768117769117770117771117772117773117774117775117776117777117778117779117780117781117782117783117784117785117786117787117788117789117790117791117792117793117794117795117796117797117798117799117800117801117802117803117804117805117806117807117808117809117810117811117812117813117814117815117816117817117818117819117820117821117822117823117824117825117826117827117828117829117830117831117832117833117834117835117836117837117838117839117840117841117842117843117844117845117846117847117848117849117850117851117852117853117854117855117856117857117858117859117860117861117862117863117864117865117866117867117868117869117870117871117872117873117874117875117876117877117878117879117880117881117882117883117884117885117886117887117888117889117890117891117892117893117894117895117896117897117898117899117900117901117902117903117904117905117906117907117908117909117910117911117912117913117914117915117916117917117918117919117920117921117922117923117924117925117926117927117928117929117930117931117932117933117934117935117936117937117938117939117940117941117942117943117944117945117946117947117948117949117950117951117952117953117954117955117956117957117958117959117960117961117962117963117964117965117966117967117968117969117970117971117972117973117974117975117976117977117978117979117980117981117982117983117984117985117986117987117988117989117990117991117992117993117994117995117996117997117998117999118000118001118002118003118004118005118006118007118008118009118010118011118012118013118014118015118016118017118018118019118020118021118022118023118024118025118026118027118028118029118030118031118032118033118034118035118036118037118038118039118040118041118042118043118044118045118046118047118048118049118050118051118052118053118054118055118056118057118058118059118060118061118062118063118064118065118066118067118068118069118070118071118072118073118074118075118076118077118078118079118080118081118082118083118084118085118086118087118088118089118090118091118092118093118094118095118096118097118098118099118100118101118102118103118104118105118106118107118108118109118110118111118112118113118114118115118116118117118118118119118120118121118122118123118124118125118126118127118128118129118130118131118132118133118134118135118136118137118138118139118140118141118142118143118144118145118146118147118148118149118150118151118152118153118154118155118156118157118158118159118160118161118162118163118164118165118166118167118168118169118170118171118172118173118174118175118176118177118178118179118180118181118182118183118184118185118186118187118188118189118190118191118192118193118194118195118196118197118198118199118200118201118202118203118204118205118206118207118208118209118210118211118212118213118214118215118216118217118218118219118220118221118222118223118224118225118226118227118228118229118230118231118232118233118234118235118236118237118238118239118240118241118242118243118244118245118246118247118248118249118250118251118252118253118254118255118256118257118258118259118260118261118262118263118264118265118266118267118268118269118270118271118272118273118274118275118276118277118278118279118280118281118282118283118284118285118286118287118288118289118290118291118292118293118294118295118296118297118298118299118300118301118302118303118304118305118306118307118308118309118310118311118312118313118314118315118316118317118318118319118320118321118322118323118324118325118326118327118328118329118330118331118332118333118334118335118336118337118338118339118340118341118342118343118344118345118346118347118348118349118350118351118352118353118354118355118356118357118358118359118360118361118362118363118364118365118366118367118368118369118370118371118372118373118374118375118376118377118378118379118380118381118382118383118384118385118386118387118388118389118390118391118392118393118394118395118396118397118398118399118400118401118402118403118404118405118406118407118408118409118410118411118412118413118414118415118416118417118418118419118420118421118422118423118424118425118426118427118428118429118430118431118432118433118434118435118436118437118438118439118440118441118442118443118444118445118446118447118448118449118450118451118452118453118454118455118456118457118458118459118460118461118462118463118464118465118466118467118468118469118470118471118472118473118474118475118476118477118478118479118480118481118482118483118484118485118486118487118488118489118490118491118492118493118494118495118496118497118498118499118500118501118502118503118504118505118506118507118508118509118510118511118512118513118514118515118516118517118518118519118520118521118522118523118524118525118526118527118528118529118530118531118532118533118534118535118536118537118538118539118540118541118542118543118544118545118546118547118548118549118550118551118552118553118554118555118556118557118558118559118560118561118562118563118564118565118566118567118568118569118570118571118572118573118574118575118576118577118578118579118580118581118582118583118584118585118586118587118588118589118590118591118592118593118594118595118596118597118598118599118600118601118602118603118604118605118606118607118608118609118610118611118612118613118614118615118616118617118618118619118620118621118622118623118624118625118626118627118628118629118630118631118632118633118634118635118636118637118638118639118640118641118642118643118644118645118646118647118648118649118650118651118652118653118654118655118656118657118658118659118660118661118662118663118664118665118666118667118668118669118670118671118672118673118674118675118676118677118678118679118680118681118682118683118684118685118686118687118688118689118690118691118692118693118694118695118696118697118698118699118700118701118702118703118704118705118706118707118708118709118710118711118712118713118714118715118716118717118718118719118720118721118722118723118724118725118726118727118728118729118730118731118732118733118734118735118736118737118738118739118740118741118742118743118744118745118746118747118748118749118750118751118752118753118754118755118756118757118758118759118760118761118762118763118764118765118766118767118768118769118770118771118772118773118774118775118776118777118778118779118780118781118782118783118784118785118786118787118788118789118790118791118792118793118794118795118796118797118798118799118800118801118802118803118804118805118806118807118808118809118810118811118812118813118814118815118816118817118818118819118820118821118822118823118824118825118826118827118828118829118830118831118832118833118834118835118836118837118838118839118840118841118842118843118844118845118846118847118848118849118850118851118852118853118854118855118856118857118858118859118860118861118862118863118864118865118866118867118868118869118870118871118872118873118874118875118876118877118878118879118880118881118882118883118884118885118886118887118888118889118890118891118892118893118894118895118896118897118898118899118900118901118902118903118904118905118906118907118908118909118910118911118912118913118914118915118916118917118918118919118920118921118922118923118924118925118926118927118928118929118930118931118932118933118934118935118936118937118938118939118940118941118942118943118944118945118946118947118948118949118950118951118952118953118954118955118956118957118958118959118960118961118962118963118964118965118966118967118968118969118970118971118972118973118974118975118976118977118978118979118980118981118982118983118984118985118986118987118988118989118990118991118992118993118994118995118996118997118998118999119000119001119002119003119004119005119006119007119008119009119010119011119012119013119014119015119016119017119018119019119020119021119022119023119024119025119026119027119028119029119030119031119032119033119034119035119036119037119038119039119040119041119042119043119044119045119046119047119048119049119050119051119052119053119054119055119056119057119058119059119060119061119062119063119064119065119066119067119068119069119070119071119072119073119074119075119076119077119078119079119080119081119082119083119084119085119086119087119088119089119090119091119092119093119094119095119096119097119098119099119100119101119102119103119104119105119106119107119108119109119110119111119112119113119114119115119116119117119118119119119120119121119122119123119124119125119126119127119128119129119130119131119132119133119134119135119136119137119138119139119140119141119142119143119144119145119146119147119148119149119150119151119152119153119154119155119156119157119158119159119160119161119162119163119164119165119166119167119168119169119170119171119172119173119174119175119176119177119178119179119180119181119182119183119184119185119186119187119188119189119190119191119192119193119194119195119196119197119198119199119200119201119202119203119204119205119206119207119208119209119210119211119212119213119214119215119216119217119218119219119220119221119222119223119224119225119226119227119228119229119230119231119232119233119234119235119236119237119238119239119240119241119242119243119244119245119246119247119248119249119250119251119252119253119254119255119256119257119258119259119260119261119262119263119264119265119266119267119268119269119270119271119272119273119274119275119276119277119278119279119280119281119282119283119284119285119286119287119288119289119290119291119292119293119294119295119296119297119298119299119300119301119302119303119304119305119306119307119308119309119310119311119312119313119314119315119316119317119318119319119320119321119322119323119324119325119326119327119328119329119330119331119332119333119334119335119336119337119338119339119340119341119342119343119344119345119346119347119348119349119350119351119352119353119354119355119356119357119358119359119360119361119362119363119364119365119366119367119368119369119370119371119372119373119374119375119376119377119378119379119380119381119382119383119384119385119386119387119388119389119390119391119392119393119394119395119396119397119398119399119400119401119402119403119404119405119406119407119408119409119410119411119412119413119414119415119416119417119418119419119420119421119422119423119424119425119426119427119428119429119430119431119432119433119434119435119436119437119438119439119440119441119442119443119444119445119446119447119448119449119450119451119452119453119454119455119456119457119458119459119460119461119462119463119464119465119466119467119468119469119470119471119472119473119474119475119476119477119478119479119480119481119482119483119484119485119486119487119488119489119490119491119492119493119494119495119496119497119498119499119500119501119502119503119504119505119506119507119508119509119510119511119512119513119514119515119516119517119518119519119520119521119522119523119524119525119526119527119528119529119530119531119532119533119534119535119536119537119538119539119540119541119542119543119544119545119546119547119548119549119550119551119552119553119554119555119556119557119558119559119560119561119562119563119564119565119566119567119568119569119570119571119572119573119574119575119576119577119578119579119580119581119582119583119584119585119586119587119588119589119590119591119592119593119594119595119596119597119598119599119600119601119602119603119604119605119606119607119608119609119610119611119612119613119614119615119616119617119618119619119620119621119622119623119624119625119626119627119628119629119630119631119632119633119634119635119636119637119638119639119640119641119642119643119644119645119646119647119648119649119650119651119652119653119654119655119656119657119658119659119660119661119662119663119664119665119666119667119668119669119670119671119672119673119674119675119676119677119678119679119680119681119682119683119684119685119686119687119688119689119690119691119692119693119694119695119696119697119698119699119700119701119702119703119704119705119706119707119708119709119710119711119712119713119714119715119716119717119718119719119720119721119722119723119724119725119726119727119728119729119730119731119732119733119734119735119736119737119738119739119740119741119742119743119744119745119746119747119748119749119750119751119752119753119754119755119756119757119758119759119760119761119762119763119764119765119766119767119768119769119770119771119772119773119774119775119776119777119778119779119780119781119782119783119784119785119786119787119788119789119790119791119792119793119794119795119796119797119798119799119800119801119802119803119804119805119806119807119808119809119810119811119812119813119814119815119816119817119818119819119820119821119822119823119824119825119826119827119828119829119830119831119832119833119834119835119836119837119838119839119840119841119842119843119844119845119846119847119848119849119850119851119852119853119854119855119856119857119858119859119860119861119862119863119864119865119866119867119868119869119870119871119872119873119874119875119876119877119878119879119880119881119882119883119884119885119886119887119888119889119890119891119892119893119894119895119896119897119898119899119900119901119902119903119904119905119906119907119908119909119910119911119912119913119914119915119916119917119918119919119920119921119922119923119924119925119926119927119928119929119930119931119932119933119934119935119936119937119938119939119940119941119942119943119944119945119946119947119948119949119950119951119952119953119954119955119956119957119958119959119960119961119962119963119964119965119966119967119968119969119970119971119972119973119974119975119976119977119978119979119980119981119982119983119984119985119986119987119988119989119990119991119992119993119994119995119996119997119998119999120000120001120002120003120004120005120006120007120008120009120010120011120012120013120014120015120016120017120018120019120020120021120022120023120024120025120026120027120028120029120030120031120032120033120034120035120036120037120038120039120040120041120042120043120044120045120046120047120048120049120050120051120052120053120054120055120056120057120058120059120060120061120062120063120064120065120066120067120068120069120070120071120072120073120074120075120076120077120078120079120080120081120082120083120084120085120086120087120088120089120090120091120092120093120094120095120096120097120098120099120100120101120102120103120104120105120106120107120108120109120110120111120112120113120114120115120116120117120118120119120120120121120122120123120124120125120126120127120128120129120130120131120132120133120134120135120136120137120138120139120140120141120142120143120144120145120146120147120148120149120150120151120152120153120154120155120156120157120158120159120160120161120162120163120164120165120166120167120168120169120170120171120172120173120174120175120176120177120178120179120180120181120182120183120184120185120186120187120188120189120190120191120192120193120194120195120196120197120198120199120200120201120202120203120204120205120206120207120208120209120210120211120212120213120214120215120216120217120218120219120220120221120222120223120224120225120226120227120228120229120230120231120232120233120234120235120236120237120238120239120240120241120242120243120244120245120246120247120248120249120250120251120252120253120254120255120256120257120258120259120260120261120262120263120264120265120266120267120268120269120270120271120272120273120274120275120276120277120278120279120280120281120282120283120284120285120286120287120288120289120290120291120292120293120294120295120296120297120298120299120300120301120302120303120304120305120306120307120308120309120310120311120312120313120314120315120316120317120318120319120320120321120322120323120324120325120326120327120328120329120330120331120332120333120334120335120336120337120338120339120340120341120342120343120344120345120346120347120348120349120350120351120352120353120354120355120356120357120358120359120360120361120362120363120364120365120366120367120368120369120370120371120372120373120374120375120376120377120378120379120380120381120382120383120384120385120386120387120388120389120390120391120392120393120394120395120396120397120398120399120400120401120402120403120404120405120406120407120408120409120410120411120412120413120414120415120416120417120418120419120420120421120422120423120424120425120426120427120428120429120430120431120432120433120434120435120436120437120438120439120440120441120442120443120444120445120446120447120448120449120450120451120452120453120454120455120456120457120458120459120460120461120462120463120464120465120466120467120468120469120470120471120472120473120474120475120476120477120478120479120480120481120482120483120484120485120486120487120488120489120490120491120492120493120494120495120496120497120498120499120500120501120502120503120504120505120506120507120508120509120510120511120512120513120514120515120516120517120518120519120520120521120522120523120524120525120526120527120528120529120530120531120532120533120534120535120536120537120538120539120540120541120542120543120544120545120546120547120548120549120550120551120552120553120554120555120556120557120558120559120560120561120562120563120564120565120566120567120568120569120570120571120572120573120574120575120576120577120578120579120580120581120582120583120584120585120586120587120588120589120590120591120592120593120594120595120596120597120598120599120600120601120602120603120604120605120606120607120608120609120610120611120612120613120614120615120616120617120618120619120620120621120622120623120624120625120626120627120628120629120630120631120632120633120634120635120636120637120638120639120640120641120642120643120644120645120646120647120648120649120650120651120652120653120654120655120656120657120658120659120660120661120662120663120664120665120666120667120668120669120670120671120672120673120674120675120676120677120678120679120680120681120682120683120684120685120686120687120688120689120690120691120692120693120694120695120696120697120698120699120700120701120702120703120704120705120706120707120708120709120710120711120712120713120714120715120716120717120718120719120720120721120722120723120724120725120726120727120728120729120730120731120732120733120734120735120736120737120738120739120740120741120742120743120744120745120746120747120748120749120750120751120752120753120754120755120756120757120758120759120760120761120762120763120764120765120766120767120768120769120770120771120772120773120774120775120776120777120778120779120780120781120782120783120784120785120786120787120788120789120790120791120792120793120794120795120796120797120798120799120800120801120802120803120804120805120806120807120808120809120810120811120812120813120814120815120816120817120818120819120820120821120822120823120824120825120826120827120828120829120830120831120832120833120834120835120836120837120838120839120840120841120842120843120844120845120846120847120848120849120850120851120852120853120854120855120856120857120858120859120860120861120862120863120864120865120866120867120868120869120870120871120872120873120874120875120876120877120878120879120880120881120882120883120884120885120886120887120888120889120890120891120892120893120894120895120896120897120898120899120900120901120902120903120904120905120906120907120908120909120910120911120912120913120914120915120916120917120918120919120920120921120922120923120924120925120926120927120928120929120930120931120932120933120934120935120936120937120938120939120940120941120942120943120944120945120946120947120948120949120950120951120952120953120954120955120956120957120958120959120960120961120962120963120964120965120966120967120968120969120970120971120972120973120974120975120976120977120978120979120980120981120982120983120984120985120986120987120988120989120990120991120992120993120994120995120996120997120998120999121000121001121002121003121004121005121006121007121008121009121010121011121012121013121014121015121016121017121018121019121020121021121022121023121024121025121026121027121028121029121030121031121032121033121034121035121036121037121038121039121040121041121042121043121044121045121046121047121048121049121050121051121052121053121054121055121056121057121058121059121060121061121062121063121064121065121066121067121068121069121070121071121072121073121074121075121076121077121078121079121080121081121082121083121084121085121086121087121088121089121090121091121092121093121094121095121096121097121098121099121100121101121102121103121104121105121106121107121108121109121110121111121112121113121114121115121116121117121118121119121120121121121122121123121124121125121126121127121128121129121130121131121132121133121134121135121136121137121138121139121140121141121142121143121144121145121146121147121148121149121150121151121152121153121154121155121156121157121158121159121160121161121162121163121164121165121166121167121168121169121170121171121172121173121174121175121176121177121178121179121180121181121182121183121184121185121186121187121188121189121190121191121192121193121194121195121196121197121198121199121200121201121202121203121204121205121206121207121208121209121210121211121212121213121214121215121216121217121218121219121220121221121222121223121224121225121226121227121228121229121230121231121232121233121234121235121236121237121238121239121240121241121242121243121244121245121246121247121248121249121250121251121252121253121254121255121256121257121258121259121260121261121262121263121264121265121266121267121268121269121270121271121272121273121274121275121276121277121278121279121280121281121282121283121284121285121286121287121288121289121290121291121292121293121294121295121296121297121298121299121300121301121302121303121304121305121306121307121308121309121310121311121312121313121314121315121316121317121318121319121320121321121322121323121324121325121326121327121328121329121330121331121332121333121334121335121336121337121338121339121340121341121342121343121344121345121346121347121348121349121350121351121352121353121354121355121356121357121358121359121360121361121362121363121364121365121366121367121368121369121370121371121372121373121374121375121376121377121378121379121380121381121382121383121384121385121386121387121388121389121390121391121392121393121394121395121396121397121398121399121400121401121402121403121404121405121406121407121408121409121410121411121412121413121414121415121416121417121418121419121420121421121422121423121424121425121426121427121428121429121430121431121432121433121434121435121436121437121438121439121440121441121442121443121444121445121446121447121448121449121450121451121452121453121454121455121456121457121458121459121460121461121462121463121464121465121466121467121468121469121470121471121472121473121474121475121476121477121478121479121480121481121482121483121484121485121486121487121488121489121490121491121492121493121494121495121496121497121498121499121500121501121502121503121504121505121506121507121508121509121510121511121512121513121514121515121516121517121518121519121520121521121522121523121524121525121526121527121528121529121530121531121532121533121534121535121536121537121538121539121540121541121542121543121544121545121546121547121548121549121550121551121552121553121554121555121556121557121558121559121560121561121562121563121564121565121566121567121568121569121570121571121572121573121574121575121576121577121578121579121580121581121582121583121584121585121586121587121588121589121590121591121592121593121594121595121596121597121598121599121600121601121602121603121604121605121606121607121608121609121610121611121612121613121614121615121616121617121618121619121620121621121622121623121624121625121626121627121628121629121630121631121632121633121634121635121636121637121638121639121640121641121642121643121644121645121646121647121648121649121650121651121652121653121654121655121656121657121658121659121660121661121662121663121664121665121666121667121668121669121670121671121672121673121674121675121676121677121678121679121680121681121682121683121684121685121686121687121688121689121690121691121692121693121694121695121696121697121698121699121700121701121702121703121704121705121706121707121708121709121710121711121712121713121714121715121716121717121718121719121720121721121722121723121724121725121726121727121728121729121730121731121732121733121734121735121736121737121738121739121740121741121742121743121744121745121746121747121748121749121750121751121752121753121754121755121756121757121758121759121760121761121762121763121764121765121766121767121768121769121770121771121772121773121774121775121776121777121778121779121780121781121782121783121784121785121786121787121788121789121790121791121792121793121794121795121796121797121798121799121800121801121802121803121804121805121806121807121808121809121810121811121812121813121814121815121816121817121818121819121820121821121822121823121824121825121826121827121828121829121830121831121832121833121834121835121836121837121838121839121840121841121842121843121844121845121846121847121848121849121850121851121852121853121854121855121856121857121858121859121860121861121862121863121864121865121866121867121868121869121870121871121872121873121874121875121876121877121878121879121880121881121882121883121884121885121886121887121888121889121890121891121892121893121894121895121896121897121898121899121900121901121902121903121904121905121906121907121908121909121910121911121912121913121914121915121916121917121918121919121920121921121922121923121924121925121926121927121928121929121930121931121932121933121934121935121936121937121938121939121940121941121942121943121944121945121946121947121948121949121950121951121952121953121954121955121956121957121958121959121960121961121962121963121964121965121966121967121968121969121970121971121972121973121974121975121976121977121978121979121980121981121982121983121984121985121986121987121988121989121990121991121992121993121994121995121996121997121998121999122000122001122002122003122004122005122006122007122008122009122010122011122012122013122014122015122016122017122018122019122020122021122022122023122024122025122026122027122028122029122030122031122032122033122034122035122036122037122038122039122040122041122042122043122044122045122046122047122048122049122050122051122052122053122054122055122056122057122058122059122060122061122062122063122064122065122066122067122068122069122070122071122072122073122074122075122076122077122078122079122080122081122082122083122084122085122086122087122088122089122090122091122092122093122094122095122096122097122098122099122100122101122102122103122104122105122106122107122108122109122110122111122112122113122114122115122116122117122118122119122120122121122122122123122124122125122126122127122128122129122130122131122132122133122134122135122136122137122138122139122140122141122142122143122144122145122146122147122148122149122150122151122152122153122154122155122156122157122158122159122160122161122162122163122164122165122166122167122168122169122170122171122172122173122174122175122176122177122178122179122180122181122182122183122184122185122186122187122188122189122190122191122192122193122194122195122196122197122198122199122200122201122202122203122204122205122206122207122208122209122210122211122212122213122214122215122216122217122218122219122220122221122222122223122224122225122226122227122228122229122230122231122232122233122234122235122236122237122238122239122240122241122242122243122244122245122246122247122248122249122250122251122252122253122254122255122256122257122258122259122260122261122262122263122264122265122266122267122268122269122270122271122272122273122274122275122276122277122278122279122280122281122282122283122284122285122286122287122288122289122290122291122292122293122294122295122296122297122298122299122300122301122302122303122304122305122306122307122308122309122310122311122312122313122314122315122316122317122318122319122320122321122322122323122324122325122326122327122328122329122330122331122332122333122334122335122336122337122338122339122340122341122342122343122344122345122346122347122348122349122350122351122352122353122354122355122356122357122358122359122360122361122362122363122364122365122366122367122368122369122370122371122372122373122374122375122376122377122378122379122380122381122382122383122384122385122386122387122388122389122390122391122392122393122394122395122396122397122398122399122400122401122402122403122404122405122406122407122408122409122410122411122412122413122414122415122416122417122418122419122420122421122422122423122424122425122426122427122428122429122430122431122432122433122434122435122436122437122438122439122440122441122442122443122444122445122446122447122448122449122450122451122452122453122454122455122456122457122458122459122460122461122462122463122464122465122466122467122468122469122470122471122472122473122474122475122476122477122478122479122480122481122482122483122484122485122486122487122488122489122490122491122492122493122494122495122496122497122498122499122500122501122502122503122504122505122506122507122508122509122510122511122512122513122514122515122516122517122518122519122520122521122522122523122524122525122526122527122528122529122530122531122532122533122534122535122536122537122538122539122540122541122542122543122544122545122546122547122548122549122550122551122552122553122554122555122556122557122558122559122560122561122562122563122564122565122566122567122568122569122570122571122572122573122574122575122576122577122578122579122580122581122582122583122584122585122586122587122588122589122590122591122592122593122594122595122596122597122598122599122600122601122602122603122604122605122606122607122608122609122610122611122612122613122614122615122616122617122618122619122620122621122622122623122624122625122626122627122628122629122630122631122632122633122634122635122636122637122638122639122640122641122642122643122644122645122646122647122648122649122650122651122652122653122654122655122656122657122658122659122660122661122662122663122664122665122666122667122668122669122670122671122672122673122674122675122676122677122678122679122680122681122682122683122684122685122686122687122688122689122690122691122692122693122694122695122696122697122698122699122700122701122702122703122704122705122706122707122708122709122710122711122712122713122714122715122716122717122718122719122720122721122722122723122724122725122726122727122728122729122730122731122732122733122734122735122736122737122738122739122740122741122742122743122744122745122746122747122748122749122750122751122752122753122754122755122756122757122758122759122760122761122762122763122764122765122766122767122768122769122770122771122772122773122774122775122776122777122778122779122780122781122782122783122784122785122786122787122788122789122790122791122792122793122794122795122796122797122798122799122800122801122802122803122804122805122806122807122808122809122810122811122812122813122814122815122816122817122818122819122820122821122822122823122824122825122826122827122828122829122830122831122832122833122834122835122836122837122838122839122840122841122842122843122844122845122846122847122848122849122850122851122852122853122854122855122856122857122858122859122860122861122862122863122864122865122866122867122868122869122870122871122872122873122874122875122876122877122878122879122880122881122882122883122884122885122886122887122888122889122890122891122892122893122894122895122896122897122898122899122900122901122902122903122904122905122906122907122908122909122910122911122912122913122914122915122916122917122918122919122920122921122922122923122924122925122926122927122928122929122930122931122932122933122934122935122936122937122938122939122940122941122942122943122944122945122946122947122948122949122950122951122952122953122954122955122956122957122958122959122960122961122962122963122964122965122966122967122968122969122970122971122972122973122974122975122976122977122978122979122980122981122982122983122984122985122986122987122988122989122990122991122992122993122994122995122996122997122998122999123000123001123002123003123004123005123006123007123008123009123010123011123012123013123014123015123016123017123018123019123020123021123022123023123024123025123026123027123028123029123030123031123032123033123034123035123036123037123038123039123040123041123042123043123044123045123046123047123048123049123050123051123052123053123054123055123056123057123058123059123060123061123062123063123064123065123066123067123068123069123070123071123072123073123074123075123076123077123078123079123080123081123082123083123084123085123086123087123088123089123090123091123092123093123094123095123096123097123098123099123100123101123102123103123104123105123106123107123108123109123110123111123112123113123114123115123116123117123118123119123120123121123122123123123124123125123126123127123128123129123130123131123132123133123134123135123136123137123138123139123140123141123142123143123144123145123146123147123148123149123150123151123152123153123154123155123156123157123158123159123160123161123162123163123164123165123166123167123168123169123170123171123172123173123174123175123176123177123178123179123180123181123182123183123184123185123186123187123188123189123190123191123192123193123194123195123196123197123198123199123200123201123202123203123204123205123206123207123208123209123210123211123212123213123214123215123216123217123218123219123220123221123222123223123224123225123226123227123228123229123230123231123232123233123234123235123236123237123238123239123240123241123242123243123244123245123246123247123248123249123250123251123252123253123254123255123256123257123258123259123260123261123262123263123264123265123266123267123268123269123270123271123272123273123274123275123276123277123278123279123280123281123282123283123284123285123286123287123288123289123290123291123292123293123294123295123296123297123298123299123300123301123302123303123304123305123306123307123308123309123310123311123312123313123314123315123316123317123318123319123320123321123322123323123324123325123326123327123328123329123330123331123332123333123334123335123336123337123338123339123340123341123342123343123344123345123346123347123348123349123350123351123352123353123354123355123356123357123358123359123360123361123362123363123364123365123366123367123368123369123370123371123372123373123374123375123376123377123378123379123380123381123382123383123384123385123386123387123388123389123390123391123392123393123394123395123396123397123398123399123400123401123402123403123404123405123406123407123408123409123410123411123412123413123414123415123416123417123418123419123420123421123422123423123424123425123426123427123428123429123430123431123432123433123434123435123436123437123438123439123440123441123442123443123444123445123446123447123448123449123450123451123452123453123454123455123456123457123458123459123460123461123462123463123464123465123466123467123468123469123470123471123472123473123474123475123476123477123478123479123480123481123482123483123484123485123486123487123488123489123490123491123492123493123494123495123496123497123498123499123500123501123502123503123504123505123506123507123508123509123510123511123512123513123514123515123516123517123518123519123520123521123522123523123524123525123526123527123528123529123530123531123532123533123534123535123536123537123538123539123540123541123542123543123544123545123546123547123548123549123550123551123552123553123554123555123556123557123558123559123560123561123562123563123564123565123566123567123568123569123570123571123572123573123574123575123576123577123578123579123580123581123582123583123584123585123586123587123588123589123590123591123592123593123594123595123596123597123598123599123600123601123602123603123604123605123606123607123608123609123610123611123612123613123614123615123616123617123618123619123620123621123622123623123624123625123626123627123628123629123630123631123632123633123634123635123636123637123638123639123640123641123642123643123644123645123646123647123648123649123650123651123652123653123654123655123656123657123658123659123660123661123662123663123664123665123666123667123668123669123670123671123672123673123674123675123676123677123678123679123680123681123682123683123684123685123686123687123688123689123690123691123692123693123694123695123696123697123698123699123700123701123702123703123704123705123706123707123708123709123710123711123712123713123714123715123716123717123718123719123720123721123722123723123724123725123726123727123728123729123730123731123732123733123734123735123736123737123738123739123740123741123742123743123744123745123746123747123748123749123750123751123752123753123754123755123756123757123758123759123760123761123762123763123764123765123766123767123768123769123770123771123772123773123774123775123776123777123778123779123780123781123782123783123784123785123786123787123788123789123790123791123792123793123794123795123796123797123798123799123800123801123802123803123804123805123806123807123808123809123810123811123812123813123814123815123816123817123818123819123820123821123822123823123824123825123826123827123828123829123830123831123832123833123834123835123836123837123838123839123840123841123842123843123844123845123846123847123848123849123850123851123852123853123854123855123856123857123858123859123860123861123862123863123864123865123866123867123868123869123870123871123872123873123874123875123876123877123878123879123880123881123882123883123884123885123886123887123888123889123890123891123892123893123894123895123896123897123898123899123900123901123902123903123904123905123906123907123908123909123910123911123912123913123914123915123916123917123918123919123920123921123922123923123924123925123926123927123928123929123930123931123932123933123934123935123936123937123938123939123940123941123942123943123944123945123946123947123948123949123950123951123952123953123954123955123956123957123958123959123960123961123962123963123964123965123966123967123968123969123970123971123972123973123974123975123976123977123978123979123980123981123982123983123984123985123986123987123988123989123990123991123992123993123994123995123996123997123998123999124000124001124002124003124004124005124006124007124008124009124010124011124012124013124014124015124016124017124018124019124020124021124022124023124024124025124026124027124028124029124030124031124032124033124034124035124036124037124038124039124040124041124042124043124044124045124046124047124048124049124050124051124052124053124054124055124056124057124058124059124060124061124062124063124064124065124066124067124068124069124070124071124072124073124074124075124076124077124078124079124080124081124082124083124084124085124086124087124088124089124090124091124092124093124094124095124096124097124098124099124100124101124102124103124104124105124106124107124108124109124110124111124112124113124114124115124116124117124118124119124120124121124122124123124124124125124126124127124128124129124130124131124132124133124134124135124136124137124138124139124140124141124142124143124144124145124146124147124148124149124150124151124152124153124154124155124156124157124158124159124160124161124162124163124164124165124166124167124168124169124170124171124172124173124174124175124176124177124178124179124180124181124182124183124184124185124186124187124188124189124190124191124192124193124194124195124196124197124198124199124200124201124202124203124204124205124206124207124208124209124210124211124212124213124214124215124216124217124218124219124220124221124222124223124224124225124226124227124228124229124230124231124232124233124234124235124236124237124238124239124240124241124242124243124244124245124246124247124248124249124250124251124252124253124254124255124256124257124258124259124260124261124262124263124264124265124266124267124268124269124270124271124272124273124274124275124276124277124278124279124280124281124282124283124284124285124286124287124288124289124290124291124292124293124294124295124296124297124298124299124300124301124302124303124304124305124306124307124308124309124310124311124312124313124314124315124316124317124318124319124320124321124322124323124324124325124326124327124328124329124330124331124332124333124334124335124336124337124338124339124340124341124342124343124344124345124346124347124348124349124350124351124352124353124354124355124356124357124358124359124360124361124362124363124364124365124366124367124368124369124370124371124372124373124374124375124376124377124378124379124380124381124382124383124384124385124386124387124388124389124390124391124392124393124394124395124396124397124398124399124400124401124402124403124404124405124406124407124408124409124410124411124412124413124414124415124416124417124418124419124420124421124422124423124424124425124426124427124428124429124430124431124432124433124434124435124436124437124438124439124440124441124442124443124444124445124446124447124448124449124450124451124452124453124454124455124456124457124458124459124460124461124462124463124464124465124466124467124468124469124470124471124472124473124474124475124476124477124478124479124480124481124482124483124484124485124486124487124488124489124490124491124492124493124494124495124496124497124498124499124500124501124502124503124504124505124506124507124508124509124510124511124512124513124514124515124516124517124518124519124520124521124522124523124524124525124526124527124528124529124530124531124532124533124534124535124536124537124538124539124540124541124542124543124544124545124546124547124548124549124550124551124552124553124554124555124556124557124558124559124560124561124562124563124564124565124566124567124568124569124570124571124572124573124574124575124576124577124578124579124580124581124582124583124584124585124586124587124588124589124590124591124592124593124594124595124596124597124598124599124600124601124602124603124604124605124606124607124608124609124610124611124612124613124614124615124616124617124618124619124620124621124622124623124624124625124626124627124628124629124630124631124632124633124634124635124636124637124638124639124640124641124642124643124644124645124646124647124648124649124650124651124652124653124654124655124656124657124658124659124660124661124662124663124664124665124666124667124668124669124670124671124672124673124674124675124676124677124678124679124680124681124682124683124684124685124686124687124688124689124690124691124692124693124694124695124696124697124698124699124700124701124702124703124704124705124706124707124708124709124710124711124712124713124714124715124716124717124718124719124720124721124722124723124724124725124726124727124728124729124730124731124732124733124734124735124736124737124738124739124740124741124742124743124744124745124746124747124748124749124750124751124752124753124754124755124756124757124758124759124760124761124762124763124764124765124766124767124768124769124770124771124772124773124774124775124776124777124778124779124780124781124782124783124784124785124786124787124788124789124790124791124792124793124794124795124796124797124798124799124800124801124802124803124804124805124806124807124808124809124810124811124812124813124814124815124816124817124818124819124820124821124822124823124824124825124826124827124828124829124830124831124832124833124834124835124836124837124838124839124840124841124842124843124844124845124846124847124848124849124850124851124852124853124854124855124856124857124858124859124860124861124862124863124864124865124866124867124868124869124870124871124872124873124874124875124876124877124878124879124880124881124882124883124884124885124886124887124888124889124890124891124892124893124894124895124896124897124898124899124900124901124902124903124904124905124906124907124908124909124910124911124912124913124914124915124916124917124918124919124920124921124922124923124924124925124926124927124928124929124930124931124932124933124934124935124936124937124938124939124940124941124942124943124944124945124946124947124948124949124950124951124952124953124954124955124956124957124958124959124960124961124962124963124964124965124966124967124968124969124970124971124972124973124974124975124976124977124978124979124980124981124982124983124984124985124986124987124988124989124990124991124992124993124994124995124996124997124998124999125000125001125002125003125004125005125006125007125008125009125010125011125012125013125014125015125016125017125018125019125020125021125022125023125024125025125026125027125028125029125030125031125032125033125034125035125036125037125038125039125040125041125042125043125044125045125046125047125048125049125050125051125052125053125054125055125056125057125058125059125060125061125062125063125064125065125066125067125068125069125070125071125072125073125074125075125076125077125078125079125080125081125082125083125084125085125086125087125088125089125090125091125092125093125094125095125096125097125098125099125100125101125102125103125104125105125106125107125108125109125110125111125112125113125114125115125116125117125118125119125120125121125122125123125124125125125126125127125128125129125130125131125132125133125134125135125136125137125138125139125140125141125142125143125144125145125146125147125148125149125150125151125152125153125154125155125156125157125158125159125160125161125162125163125164125165125166125167125168125169125170125171125172125173125174125175125176125177125178125179125180125181125182125183125184125185125186125187125188125189125190125191125192125193125194125195125196125197125198125199125200125201125202125203125204125205125206125207125208125209125210125211125212125213125214125215125216125217125218125219125220125221125222125223125224125225125226125227125228125229125230125231125232125233125234125235125236125237125238125239125240125241125242125243125244125245125246125247125248125249125250125251125252125253125254125255125256125257125258125259125260125261125262125263125264125265125266125267125268125269125270125271125272125273125274125275125276125277125278125279125280125281125282125283125284125285125286125287125288125289125290125291125292125293125294125295125296125297125298125299125300125301125302125303125304125305125306125307125308125309125310125311125312125313125314125315125316125317125318125319125320125321125322125323125324125325125326125327125328125329125330125331125332125333125334125335125336125337125338125339125340125341125342125343125344125345125346125347125348125349125350125351125352125353125354125355125356125357125358125359125360125361125362125363125364125365125366125367125368125369125370125371125372125373125374125375125376125377125378125379125380125381125382125383125384125385125386125387125388125389125390125391125392125393125394125395125396125397125398125399125400125401125402125403125404125405125406125407125408125409125410125411125412125413125414125415125416125417125418125419125420125421125422125423125424125425125426125427125428125429125430125431125432125433125434125435125436125437125438125439125440125441125442125443125444125445125446125447125448125449125450125451125452125453125454125455125456125457125458125459125460125461125462125463125464125465125466125467125468125469125470125471125472125473125474125475125476125477125478125479125480125481125482125483125484125485125486125487125488125489125490125491125492125493125494125495125496125497125498125499125500125501125502125503125504125505125506125507125508125509125510125511125512125513125514125515125516125517125518125519125520125521125522125523125524125525125526125527125528125529125530125531125532125533125534125535125536125537125538125539125540125541125542125543125544125545125546125547125548125549125550125551125552125553125554125555125556125557125558125559125560125561125562125563125564125565125566125567125568125569125570125571125572125573125574125575125576125577125578125579125580125581125582125583125584125585125586125587125588125589125590125591125592125593125594125595125596125597125598125599125600125601125602125603125604125605125606125607125608125609125610125611125612125613125614125615125616125617125618125619125620125621125622125623125624125625125626125627125628125629125630125631125632125633125634125635125636125637125638125639125640125641125642125643125644125645125646125647125648125649125650125651125652125653125654125655125656125657125658125659125660125661125662125663125664125665125666125667125668125669125670125671125672125673125674125675125676125677125678125679125680125681125682125683125684125685125686125687125688125689125690125691125692125693125694125695125696125697125698125699125700125701125702125703125704125705125706125707125708125709125710125711125712125713125714125715125716125717125718125719125720125721125722125723125724125725125726125727125728125729125730125731125732125733125734125735125736125737125738125739125740125741125742125743125744125745125746125747125748125749125750125751125752125753125754125755125756125757125758125759125760125761125762125763125764125765125766125767125768125769125770125771125772125773125774125775125776125777125778125779125780125781125782125783125784125785125786125787125788125789125790125791125792125793125794125795125796125797125798125799125800125801125802125803125804125805125806125807125808125809125810125811125812125813125814125815125816125817125818125819125820125821125822125823125824125825125826125827125828125829125830125831125832125833125834125835125836125837125838125839125840125841125842125843125844125845125846125847125848125849125850125851125852125853125854125855125856125857125858125859125860125861125862125863125864125865125866125867125868125869125870125871125872125873125874125875125876125877125878125879125880125881125882125883125884125885125886125887125888125889125890125891125892125893125894125895125896125897125898125899125900125901125902125903125904125905125906125907125908125909125910125911125912125913125914125915125916125917125918125919125920125921125922125923125924125925125926125927125928125929125930125931125932125933125934125935125936125937125938125939125940125941125942125943125944125945125946125947125948125949125950125951125952125953125954125955125956125957125958125959125960125961125962125963125964125965125966125967125968125969125970125971125972125973125974125975125976125977125978125979125980125981125982125983125984125985125986125987125988125989125990125991125992125993125994125995125996125997125998125999126000126001126002126003126004126005126006126007126008126009126010126011126012126013126014126015126016126017126018126019126020126021126022126023126024126025126026126027126028126029126030126031126032126033126034126035126036126037126038126039126040126041126042126043126044126045126046126047126048126049126050126051126052126053126054126055126056126057126058126059126060126061126062126063126064126065126066126067126068126069126070126071126072126073126074126075126076126077126078126079126080126081126082126083126084126085126086126087126088126089126090126091126092126093126094126095126096126097126098126099126100126101126102126103126104126105126106126107126108126109126110126111126112126113126114126115126116126117126118126119126120126121126122126123126124126125126126126127126128126129126130126131126132126133126134126135126136126137126138126139126140126141126142126143126144126145126146126147126148126149126150126151126152126153126154126155126156126157126158126159126160126161126162126163126164126165126166126167126168126169126170126171126172126173126174126175126176126177126178126179126180126181126182126183126184126185126186126187126188126189126190126191126192126193126194126195126196126197126198126199126200126201126202126203126204126205126206126207126208126209126210126211126212126213126214126215126216126217126218126219126220126221126222126223126224126225126226126227126228126229126230126231126232126233126234126235126236126237126238126239126240126241126242126243126244126245126246126247126248126249126250126251126252126253126254126255126256126257126258126259126260126261126262126263126264126265126266126267126268126269126270126271126272126273126274126275126276126277126278126279126280126281126282126283126284126285126286126287126288126289126290126291126292126293126294126295126296126297126298126299126300126301126302126303126304126305126306126307126308126309126310126311126312126313126314126315126316126317126318126319126320126321126322126323126324126325126326126327126328126329126330126331126332126333126334126335126336126337126338126339126340126341126342126343126344126345126346126347126348126349126350126351126352126353126354126355126356126357126358126359126360126361126362126363126364126365126366126367126368126369126370126371126372126373126374126375126376126377126378126379126380126381126382126383126384126385126386126387126388126389126390126391126392126393126394126395126396126397126398126399126400126401126402126403126404126405126406126407126408126409126410126411126412126413126414126415126416126417126418126419126420126421126422126423126424126425126426126427126428126429126430126431126432126433126434126435126436126437126438126439126440126441126442126443126444126445126446126447126448126449126450126451126452126453126454126455126456126457126458126459126460126461126462126463126464126465126466126467126468126469126470126471126472126473126474126475126476126477126478126479126480126481126482126483126484126485126486126487126488126489126490126491126492126493126494126495126496126497126498126499126500126501126502126503126504126505126506126507126508126509126510126511126512126513126514126515126516126517126518126519126520126521126522126523126524126525126526126527126528126529126530126531126532126533126534126535126536126537126538126539126540126541126542126543126544126545126546126547126548126549126550126551126552126553126554126555126556126557126558126559126560126561126562126563126564126565126566126567126568126569126570126571126572126573126574126575126576126577126578126579126580126581126582126583126584126585126586126587126588126589126590126591126592126593126594126595126596126597126598126599126600126601126602126603126604126605126606126607126608126609126610126611126612126613126614126615126616126617126618126619126620126621126622126623126624126625126626126627126628126629126630126631126632126633126634126635126636126637126638126639126640126641126642126643126644126645126646126647126648126649126650126651126652126653126654126655126656126657126658126659126660126661126662126663126664126665126666126667126668126669126670126671126672126673126674126675126676126677126678126679126680126681126682126683126684126685126686126687126688126689126690126691126692126693126694126695126696126697126698126699126700126701126702126703126704126705126706126707126708126709126710126711126712126713126714126715126716126717126718126719126720126721126722126723126724126725126726126727126728126729126730126731126732126733126734126735126736126737126738126739126740126741126742126743126744126745126746126747126748126749126750126751126752126753126754126755126756126757126758126759126760126761126762126763126764126765126766126767126768126769126770126771126772126773126774126775126776126777126778126779126780126781126782126783126784126785126786126787126788126789126790126791126792126793126794126795126796126797126798126799126800126801126802126803126804126805126806126807126808126809126810126811126812126813126814126815126816126817126818126819126820126821126822126823126824126825126826126827126828126829126830126831126832126833126834126835126836126837126838126839126840126841126842126843126844126845126846126847126848126849126850126851126852126853126854126855126856126857126858126859126860126861126862126863126864126865126866126867126868126869126870126871126872126873126874126875126876126877126878126879126880126881126882126883126884126885126886126887126888126889126890126891126892126893126894126895126896126897126898126899126900126901126902126903126904126905126906126907126908126909126910126911126912126913126914126915126916126917126918126919126920126921126922126923126924126925126926126927126928126929126930126931126932126933126934126935126936126937126938126939126940126941126942126943126944126945126946126947126948126949126950126951126952126953126954126955126956126957126958126959126960126961126962126963126964126965126966126967126968126969126970126971126972126973126974126975126976126977126978126979126980126981126982126983126984126985126986126987126988126989126990126991126992126993126994126995126996126997126998126999127000127001127002127003127004127005127006127007127008127009127010127011127012127013127014127015127016127017127018127019127020127021127022127023127024127025127026127027127028127029127030127031127032127033127034127035127036127037127038127039127040127041127042127043127044127045127046127047127048127049127050127051127052127053127054127055127056127057127058127059127060127061127062127063127064127065127066127067127068127069127070127071127072127073127074127075127076127077127078127079127080127081127082127083127084127085127086127087127088127089127090127091127092127093127094127095127096127097127098127099127100127101127102127103127104127105127106127107127108127109127110127111127112127113127114127115127116127117127118127119127120127121127122127123127124127125127126127127127128127129127130127131127132127133127134127135127136127137127138127139127140127141127142127143127144127145127146127147127148127149127150127151127152127153127154127155127156127157127158127159127160127161127162127163127164127165127166127167127168127169127170127171127172127173127174127175127176127177127178127179127180127181127182127183127184127185127186127187127188127189127190127191127192127193127194127195127196127197127198127199127200127201127202127203127204127205127206127207127208127209127210127211127212127213127214127215127216127217127218127219127220127221127222127223127224127225127226127227127228127229127230127231127232127233127234127235127236127237127238127239127240127241127242127243127244127245127246127247127248127249127250127251127252127253127254127255127256127257127258127259127260127261127262127263127264127265127266127267127268127269127270127271127272127273127274127275127276127277127278127279127280127281127282127283127284127285127286127287127288127289127290127291127292127293127294127295127296127297127298127299127300127301127302127303127304127305127306127307127308127309127310127311127312127313127314127315127316127317127318127319127320127321127322127323127324127325127326127327127328127329127330127331127332127333127334127335127336127337127338127339127340127341127342127343127344127345127346127347127348127349127350127351127352127353127354127355127356127357127358127359127360127361127362127363127364127365127366127367127368127369127370127371127372127373127374127375127376127377127378127379127380127381127382127383127384127385127386127387127388127389127390127391127392127393127394127395127396127397127398127399127400127401127402127403127404127405127406127407127408127409127410127411127412127413127414127415127416127417127418127419127420127421127422127423127424127425127426127427127428127429127430127431127432127433127434127435127436127437127438127439127440127441127442127443127444127445127446127447127448127449127450127451127452127453127454127455127456127457127458127459127460127461127462127463127464127465127466127467127468127469127470127471127472127473127474127475127476127477127478127479127480127481127482127483127484127485127486127487127488127489127490127491127492127493127494127495127496127497127498127499127500127501127502127503127504127505127506127507127508127509127510127511127512127513127514127515127516127517127518127519127520127521127522127523127524127525127526127527127528127529127530127531127532127533127534127535127536127537127538127539127540127541127542127543127544127545127546127547127548127549127550127551127552127553127554127555127556127557127558127559127560127561127562127563127564127565127566127567127568127569127570127571127572127573127574127575127576127577127578127579127580127581127582127583127584127585127586127587127588127589127590127591127592127593127594127595127596127597127598127599127600127601127602127603127604127605127606127607127608127609127610127611127612127613127614127615127616127617127618127619127620127621127622127623127624127625127626127627127628127629127630127631127632127633127634127635127636127637127638127639127640127641127642127643127644127645127646127647127648127649127650127651127652127653127654127655127656127657127658127659127660127661127662127663127664127665127666127667127668127669127670127671127672127673127674127675127676127677127678127679127680127681127682127683127684127685127686127687127688127689127690127691127692127693127694127695127696127697127698127699127700127701127702127703127704127705127706127707127708127709127710127711127712127713127714127715127716127717127718127719127720127721127722127723127724127725127726127727127728127729127730127731127732127733127734127735127736127737127738127739127740127741127742127743127744127745127746127747127748127749127750127751127752127753127754127755127756127757127758127759127760127761127762127763127764127765127766127767127768127769127770127771127772127773127774127775127776127777127778127779127780127781127782127783127784127785127786127787127788127789127790127791127792127793127794127795127796127797127798127799127800127801127802127803127804127805127806127807127808127809127810127811127812127813127814127815127816127817127818127819127820127821127822127823127824127825127826127827127828127829127830127831127832127833127834127835127836127837127838127839127840127841127842127843127844127845127846127847127848127849127850127851127852127853127854127855127856127857127858127859127860127861127862127863127864127865127866127867127868127869127870127871127872127873127874127875127876127877127878127879127880127881127882127883127884127885127886127887127888127889127890127891127892127893127894127895127896127897127898127899127900127901127902127903127904127905127906127907127908127909127910127911127912127913127914127915127916127917127918127919127920127921127922127923127924127925127926127927127928127929127930127931127932127933127934127935127936127937127938127939127940127941127942127943127944127945127946127947127948127949127950127951127952127953127954127955127956127957127958127959127960127961127962127963127964127965127966127967127968127969127970127971127972127973127974127975127976127977127978127979127980127981127982127983127984127985127986127987127988127989127990127991127992127993127994127995127996127997127998127999128000128001128002128003128004128005128006128007128008128009128010128011128012128013128014128015128016128017128018128019128020128021128022128023128024128025128026128027128028128029128030128031128032128033128034128035128036128037128038128039128040128041128042128043128044128045128046128047128048128049128050128051128052128053128054128055128056128057128058128059128060128061128062128063128064128065128066128067128068128069128070128071128072128073128074128075128076128077128078128079128080128081128082128083128084128085128086128087128088128089128090128091128092128093128094128095128096128097128098128099128100128101128102128103128104128105128106128107128108128109128110128111128112128113128114128115128116128117128118128119128120128121128122128123128124128125128126128127128128128129128130128131128132128133128134128135128136128137128138128139128140128141128142128143128144128145128146128147128148128149128150128151128152128153128154128155128156128157128158128159128160128161128162128163128164128165128166128167128168128169128170128171128172128173128174128175128176128177128178128179128180128181128182128183128184128185128186128187128188128189128190128191128192128193128194128195128196128197128198128199128200128201128202128203128204128205128206128207128208128209128210128211128212128213128214128215128216128217128218128219128220128221128222128223128224128225128226128227128228128229128230128231128232128233128234128235128236128237128238128239128240128241128242128243128244128245128246128247128248128249128250128251128252128253128254128255128256128257128258128259128260128261128262128263128264128265128266128267128268128269128270128271128272128273128274128275128276128277128278128279128280128281128282128283128284128285128286128287128288128289128290128291128292128293128294128295128296128297128298128299128300128301128302128303128304128305128306128307128308128309128310128311128312128313128314128315128316128317128318128319128320128321128322128323128324128325128326128327128328128329128330128331128332128333128334128335128336128337128338128339128340128341128342128343128344128345128346128347128348128349128350128351128352128353128354128355128356128357128358128359128360128361128362128363128364128365128366128367128368128369128370128371128372128373128374128375128376128377128378128379128380128381128382128383128384128385128386128387128388128389128390128391128392128393128394128395128396128397128398128399128400128401128402128403128404128405128406128407128408128409128410128411128412128413128414128415128416128417128418128419128420128421128422128423128424128425128426128427128428128429128430128431128432128433128434128435128436128437128438128439128440128441128442128443128444128445128446128447128448128449128450128451128452128453128454128455128456128457128458128459128460128461128462128463128464128465128466128467128468128469128470128471128472128473128474128475128476128477128478128479128480128481128482128483128484128485128486128487128488128489128490128491128492128493128494128495128496128497128498128499128500128501128502128503128504128505128506128507128508128509128510128511128512128513128514128515128516128517128518128519128520128521128522128523128524128525128526128527128528128529128530128531128532128533128534128535128536128537128538128539128540128541128542128543128544128545128546128547128548128549128550128551128552128553128554128555128556128557128558128559128560128561128562128563128564128565128566128567128568128569128570128571128572128573128574128575128576128577128578128579128580128581128582128583128584128585128586128587128588128589128590128591128592128593128594128595128596128597128598128599128600128601128602128603128604128605128606128607128608128609128610128611128612128613128614128615128616128617128618128619128620128621128622128623128624128625128626128627128628128629128630128631128632128633128634128635128636128637128638128639128640128641128642128643128644128645128646128647128648128649128650128651128652128653128654128655128656128657128658128659128660128661128662128663128664128665128666128667128668128669128670128671128672128673128674128675128676128677128678128679128680128681128682128683128684128685128686128687128688128689128690128691128692128693128694128695128696128697128698128699128700128701128702128703128704128705128706128707128708128709128710128711128712128713128714128715128716128717128718128719128720128721128722128723128724128725128726128727128728128729128730128731128732128733128734128735128736128737128738128739128740128741128742128743128744128745128746128747128748128749128750128751128752128753128754128755128756128757128758128759128760128761128762128763128764128765128766128767128768128769128770128771128772128773128774128775128776128777128778128779128780128781128782128783128784128785128786128787128788128789128790128791128792128793128794128795128796128797128798128799128800128801128802128803128804128805128806128807128808128809128810128811128812128813128814128815128816128817128818128819128820128821128822128823128824128825128826128827128828128829128830128831128832128833128834128835128836128837128838128839128840128841128842128843128844128845128846128847128848128849128850128851128852128853128854128855128856128857128858128859128860128861128862128863128864128865128866128867128868128869128870128871128872128873128874128875128876128877128878128879128880128881128882128883128884128885128886128887128888128889128890128891128892128893128894128895128896128897128898128899128900128901128902128903128904128905128906128907128908128909128910128911128912128913128914128915128916128917128918128919128920128921128922128923128924128925128926128927128928128929128930128931128932128933128934128935128936128937128938128939128940128941128942128943128944128945128946128947128948128949128950128951128952128953128954128955128956128957128958128959128960128961128962128963128964128965128966128967128968128969128970128971128972128973128974128975128976128977128978128979128980128981128982128983128984128985128986128987128988128989128990128991128992128993128994128995128996128997128998128999129000129001129002129003129004129005129006129007129008129009129010129011129012129013129014129015129016129017129018129019129020129021129022129023129024129025129026129027129028129029129030129031129032129033129034129035129036129037129038129039129040129041129042129043129044129045129046129047129048129049129050129051129052129053129054129055129056129057129058129059129060129061129062129063129064129065129066129067129068129069129070129071129072129073129074129075129076129077129078129079129080129081129082129083129084129085129086129087129088129089129090129091129092129093129094129095129096129097129098129099129100129101129102129103129104129105129106129107129108129109129110129111129112129113129114129115129116129117129118129119129120129121129122129123129124129125129126129127129128129129129130129131129132129133129134129135129136129137129138129139129140129141129142129143129144129145129146129147129148129149129150129151129152129153129154129155129156129157129158129159129160129161129162129163129164129165129166129167129168129169129170129171129172129173129174129175129176129177129178129179129180129181129182129183129184129185129186129187129188129189129190129191129192129193129194129195129196129197129198129199129200129201129202129203129204129205129206129207129208129209129210129211129212129213129214129215129216129217129218129219129220129221129222129223129224129225129226129227129228129229129230129231129232129233129234129235129236129237129238129239129240129241129242129243129244129245129246129247129248129249129250129251129252129253129254129255129256129257129258129259129260129261129262129263129264129265129266129267129268129269129270129271129272129273129274129275129276129277129278129279129280129281129282129283129284129285129286129287129288129289129290129291129292129293129294129295129296129297129298129299129300129301129302129303129304129305129306129307129308129309129310129311129312129313129314129315129316129317129318129319129320129321129322129323129324129325129326129327129328129329129330129331129332129333129334129335129336129337129338129339129340129341129342129343129344129345129346129347129348129349129350129351129352129353129354129355129356129357129358129359129360129361129362129363129364129365129366129367129368129369129370129371129372129373129374129375129376129377129378129379129380129381129382129383129384129385129386129387129388129389129390129391129392129393129394129395129396129397129398129399129400129401129402129403129404129405129406129407129408129409129410129411129412129413129414129415129416129417129418129419129420129421129422129423129424129425129426129427129428129429129430129431129432129433129434129435129436129437129438129439129440129441129442129443129444129445129446129447129448129449129450129451129452129453129454129455129456129457129458129459129460129461129462129463129464129465129466129467129468129469129470129471129472129473129474129475129476129477129478129479129480129481129482129483129484129485129486129487129488129489129490129491129492129493129494129495129496129497129498129499129500129501129502129503129504129505129506129507129508129509129510129511129512129513129514129515129516129517129518129519129520129521129522129523129524129525129526129527129528129529129530129531129532129533129534129535129536129537129538129539129540129541129542129543129544129545129546129547129548129549129550129551129552129553129554129555129556129557129558129559129560129561129562129563129564129565129566129567129568129569129570129571129572129573129574129575129576129577129578129579129580129581129582129583129584129585129586129587129588129589129590129591129592129593129594129595129596129597129598129599129600129601129602129603129604129605129606129607129608129609129610129611129612129613129614129615129616129617129618129619129620129621129622129623129624129625129626129627129628129629129630129631129632129633129634129635129636129637129638129639129640129641129642129643129644129645129646129647129648129649129650129651129652129653129654129655129656129657129658129659129660129661129662129663129664129665129666129667129668129669129670129671129672129673129674129675129676129677129678129679129680129681129682129683129684129685129686129687129688129689129690129691129692129693129694129695129696129697129698129699129700129701129702129703129704129705129706129707129708129709129710129711129712129713129714129715129716129717129718129719129720129721129722129723129724129725129726129727129728129729129730129731129732129733129734129735129736129737129738129739129740129741129742129743129744129745129746129747129748129749129750129751129752129753129754129755129756129757129758129759129760129761129762129763129764129765129766129767129768129769129770129771129772129773129774129775129776129777129778129779129780129781129782129783129784129785129786129787129788129789129790129791129792129793129794129795129796129797129798129799129800129801129802129803129804129805129806129807129808129809129810129811129812129813129814129815129816129817129818129819129820129821129822129823129824129825129826129827129828129829129830129831129832129833129834129835129836129837129838129839129840129841129842129843129844129845129846129847129848129849129850129851129852129853129854129855129856129857129858129859129860129861129862129863129864129865129866129867129868129869129870129871129872129873129874129875129876129877129878129879129880129881129882129883129884129885129886129887129888129889129890129891129892129893129894129895129896129897129898129899129900129901129902129903129904129905129906129907129908129909129910129911129912129913129914129915129916129917129918129919129920129921129922129923129924129925129926129927129928129929129930129931129932129933129934129935129936129937129938129939129940129941129942129943129944129945129946129947129948129949129950129951129952129953129954129955129956129957129958129959129960129961129962129963129964129965129966129967129968129969129970129971129972129973129974129975129976129977129978129979129980129981129982129983129984129985129986129987129988129989129990129991129992129993129994129995129996129997129998129999130000130001130002130003130004130005130006130007130008130009130010130011130012130013130014130015130016130017130018130019130020130021130022130023130024130025130026130027130028130029130030130031130032130033130034130035130036130037130038130039130040130041130042130043130044130045130046130047130048130049130050130051130052130053130054130055130056130057130058130059130060130061130062130063130064130065130066130067130068130069130070130071130072130073130074130075130076130077130078130079130080130081130082130083130084130085130086130087130088130089130090130091130092130093130094130095130096130097130098130099130100130101130102130103130104130105130106130107130108130109130110130111130112130113130114130115130116130117130118130119130120130121130122130123130124130125130126130127130128130129130130130131130132130133130134130135130136130137130138130139130140130141130142130143130144130145130146130147130148130149130150130151130152130153130154130155130156130157130158130159130160130161130162130163130164130165130166130167130168130169130170130171130172130173130174130175130176130177130178130179130180130181130182130183130184130185130186130187130188130189130190130191130192130193130194130195130196130197130198130199130200130201130202130203130204130205130206130207130208130209130210130211130212130213130214130215130216130217130218130219130220130221130222130223130224130225130226130227130228130229130230130231130232130233130234130235130236130237130238130239130240130241130242130243130244130245130246130247130248130249130250130251130252130253130254130255130256130257130258130259130260130261130262130263130264130265130266130267130268130269130270130271130272130273130274130275130276130277130278130279130280130281130282130283130284130285130286130287130288130289130290130291130292130293130294130295130296130297130298130299130300130301130302130303130304130305130306130307130308130309130310130311130312130313130314130315130316130317130318130319130320130321130322130323130324130325130326130327130328130329130330130331130332130333130334130335130336130337130338130339130340130341130342130343130344130345130346130347130348130349130350130351130352130353130354130355130356130357130358130359130360130361130362130363130364130365130366130367130368130369130370130371130372130373130374130375130376130377130378130379130380130381130382130383130384130385130386130387130388130389130390130391130392130393130394130395130396130397130398130399130400130401130402130403130404130405130406130407130408130409130410130411130412130413130414130415130416130417130418130419130420130421130422130423130424130425130426130427130428130429130430130431130432130433130434130435130436130437130438130439130440130441130442130443130444130445130446130447130448130449130450130451130452130453130454130455130456130457130458130459130460130461130462130463130464130465130466130467130468130469130470130471130472130473130474130475130476130477130478130479130480130481130482130483130484130485130486130487130488130489130490130491130492130493130494130495130496130497130498130499130500130501130502130503130504130505130506130507130508130509130510130511130512130513130514130515130516130517130518130519130520130521130522130523130524130525130526130527130528130529130530130531130532130533130534130535130536130537130538130539130540130541130542130543130544130545130546130547130548130549130550130551130552130553130554130555130556130557130558130559130560130561130562130563130564130565130566130567130568130569130570130571130572130573130574130575130576130577130578130579130580130581130582130583130584130585130586130587130588130589130590130591130592130593130594130595130596130597130598130599130600130601130602130603130604130605130606130607130608130609130610130611130612130613130614130615130616130617130618130619130620130621130622130623130624130625130626130627130628130629130630130631130632130633130634130635130636130637130638130639130640130641130642130643130644130645130646130647130648130649130650130651130652130653130654130655130656130657130658130659130660130661130662130663130664130665130666130667130668130669130670130671130672130673130674130675130676130677130678130679130680130681130682130683130684130685130686130687130688130689130690130691130692130693130694130695130696130697130698130699130700130701130702130703130704130705130706130707130708130709130710130711130712130713130714130715130716130717130718130719130720130721130722130723130724130725130726130727130728130729130730130731130732130733130734130735130736130737130738130739130740130741130742130743130744130745130746130747130748130749130750130751130752130753130754130755130756130757130758130759130760130761130762130763130764130765130766130767130768130769130770130771130772130773130774130775130776130777130778130779130780130781130782130783130784130785130786130787130788130789130790130791130792130793130794130795130796130797130798130799130800130801130802130803130804130805130806130807130808130809130810130811130812130813130814130815130816130817130818130819130820130821130822130823130824130825130826130827130828130829130830130831130832130833130834130835130836130837130838130839130840130841130842130843130844130845130846130847130848130849130850130851130852130853130854130855130856130857130858130859130860130861130862130863130864130865130866130867130868130869130870130871130872130873130874130875130876130877130878130879130880130881130882130883130884130885130886130887130888130889130890130891130892130893130894130895130896130897130898130899130900130901130902130903130904130905130906130907130908130909130910130911130912130913130914130915130916130917130918130919130920130921130922130923130924130925130926130927130928130929130930130931130932130933130934130935130936130937130938130939130940130941130942130943130944130945130946130947130948130949130950130951130952130953130954130955130956130957130958130959130960130961130962130963130964130965130966130967130968130969130970130971130972130973130974130975130976130977130978130979130980130981130982130983130984130985130986130987130988130989130990130991130992130993130994130995130996130997130998130999131000131001131002131003131004131005131006131007131008131009131010131011131012131013131014131015131016131017131018131019131020131021131022131023131024131025131026131027131028131029131030131031131032131033131034131035131036131037131038131039131040131041131042131043131044131045131046131047131048131049131050131051131052131053131054131055131056131057131058131059131060131061131062131063131064131065131066131067131068131069131070131071131072131073131074131075131076131077131078131079131080131081131082131083131084131085131086131087131088131089131090131091131092131093131094131095131096131097131098131099131100131101131102131103131104131105131106131107131108131109131110131111131112131113131114131115131116131117131118131119131120131121131122131123131124131125131126131127131128131129131130131131131132131133131134131135131136131137131138131139131140131141131142131143131144131145131146131147131148131149131150131151131152131153131154131155131156131157131158131159131160131161131162131163131164131165131166131167131168131169131170131171131172131173131174131175131176131177131178131179131180131181131182131183131184131185131186131187131188131189131190131191131192131193131194131195131196131197131198131199131200131201131202131203131204131205131206131207131208131209131210131211131212131213131214131215131216131217131218131219131220131221131222131223131224131225131226131227131228131229131230131231131232131233131234131235131236131237131238131239131240131241131242131243131244131245131246131247131248131249131250131251131252131253131254131255131256131257131258131259131260131261131262131263131264131265131266131267131268131269131270131271131272131273131274131275131276131277131278131279131280131281131282131283131284131285131286131287131288131289131290131291131292131293131294131295131296131297131298131299131300131301131302131303131304131305131306131307131308131309131310131311131312131313131314131315131316131317131318131319131320131321131322131323131324131325131326131327131328131329131330131331131332131333131334131335131336131337131338131339131340131341131342131343131344131345131346131347131348131349131350131351131352131353131354131355131356131357131358131359131360131361131362131363131364131365131366131367131368131369131370131371131372131373131374131375131376131377131378131379131380131381131382131383131384131385131386131387131388131389131390131391131392131393131394131395131396131397131398131399131400131401131402131403131404131405131406131407131408131409131410131411131412131413131414131415131416131417131418131419131420131421131422131423131424131425131426131427131428131429131430131431131432131433131434131435131436131437131438131439131440131441131442131443131444131445131446131447131448131449131450131451131452131453131454131455131456131457131458131459131460131461131462131463131464131465131466131467131468131469131470131471131472131473131474131475131476131477131478131479131480131481131482131483131484131485131486131487131488131489131490131491131492131493131494131495131496131497131498131499131500131501131502131503131504131505131506131507131508131509131510131511131512131513131514131515131516131517131518131519131520131521131522131523131524131525131526131527131528131529131530131531131532131533131534131535131536131537131538131539131540131541131542131543131544131545131546131547131548131549131550131551131552131553131554131555131556131557131558131559131560131561131562131563131564131565131566131567131568131569131570131571131572131573131574131575131576131577131578131579131580131581131582131583131584131585131586131587131588131589131590131591131592131593131594131595131596131597131598131599131600131601131602131603131604131605131606131607131608131609131610131611131612131613131614131615131616131617131618131619131620131621131622131623131624131625131626131627131628131629131630131631131632131633131634131635131636131637131638131639131640131641131642131643131644131645131646131647131648131649131650131651131652131653131654131655131656131657131658131659131660131661131662131663131664131665131666131667131668131669131670131671131672131673131674131675131676131677131678131679131680131681131682131683131684131685131686131687131688131689131690131691131692131693131694131695131696131697131698131699131700131701131702131703131704131705131706131707131708131709131710131711131712131713131714131715131716131717131718131719131720131721131722131723131724131725131726131727131728131729131730131731131732131733131734131735131736131737131738131739131740131741131742131743131744131745131746131747131748131749131750131751131752131753131754131755131756131757131758131759131760131761131762131763131764131765131766131767131768131769131770131771131772131773131774131775131776131777131778131779131780131781131782131783131784131785131786131787131788131789131790131791131792131793131794131795131796131797131798131799131800131801131802131803131804131805131806131807131808131809131810131811131812131813131814131815131816131817131818131819131820131821131822131823131824131825131826131827131828131829131830131831131832131833131834131835131836131837131838131839131840131841131842131843131844131845131846131847131848131849131850131851131852131853131854131855131856131857131858131859131860131861131862131863131864131865131866131867131868131869131870131871131872131873131874131875131876131877131878131879131880131881131882131883131884131885131886131887131888131889131890131891131892131893131894131895131896131897131898131899131900131901131902131903131904131905131906131907131908131909131910131911131912131913131914131915131916131917131918131919131920131921131922131923131924131925131926131927131928131929131930131931131932131933131934131935131936131937131938131939131940131941131942131943131944131945131946131947131948131949131950131951131952131953131954131955131956131957131958131959131960131961131962131963131964131965131966131967131968131969131970131971131972131973131974131975131976131977131978131979131980131981131982131983131984131985131986131987131988131989131990131991131992131993131994131995131996131997131998131999132000132001132002132003132004132005132006132007132008132009132010132011132012132013132014132015132016132017132018132019132020132021132022132023132024132025132026132027132028132029132030132031132032132033132034132035132036132037132038132039132040132041132042132043132044132045132046132047132048132049132050132051132052132053132054132055132056132057132058132059132060132061132062132063132064132065132066132067132068132069132070132071132072132073132074132075132076132077132078132079132080132081132082132083132084132085132086132087132088132089132090132091132092132093132094132095132096132097132098132099132100132101132102132103132104132105132106132107132108132109132110132111132112132113132114132115132116132117132118132119132120132121132122132123132124132125132126132127132128132129132130132131132132132133132134132135132136132137132138132139132140132141132142132143132144132145132146132147132148132149132150132151132152132153132154132155132156132157132158132159132160132161132162132163132164132165132166132167132168132169132170132171132172132173132174132175132176132177132178132179132180132181132182132183132184132185132186132187132188132189132190132191132192132193132194132195132196132197132198132199132200132201132202132203132204132205132206132207132208132209132210132211132212132213132214132215132216132217132218132219132220132221132222132223132224132225132226132227132228132229132230132231132232132233132234132235132236132237132238132239132240132241132242132243132244132245132246132247132248132249132250132251132252132253132254132255132256132257132258132259132260132261132262132263132264132265132266132267132268132269132270132271132272132273132274132275132276132277132278132279132280132281132282132283132284132285132286132287132288132289132290132291132292132293132294132295132296132297132298132299132300132301132302132303132304132305132306132307132308132309132310132311132312132313132314132315132316132317132318132319132320132321132322132323132324132325132326132327132328132329132330132331132332132333132334132335132336132337132338132339132340132341132342132343132344132345132346132347132348132349132350132351132352132353132354132355132356132357132358132359132360132361132362132363132364132365132366132367132368132369132370132371132372132373132374132375132376132377132378132379132380132381132382132383132384132385132386132387132388132389132390132391132392132393132394132395132396132397132398132399132400132401132402132403132404132405132406132407132408132409132410132411132412132413132414132415132416132417132418132419132420132421132422132423132424132425132426132427132428132429132430132431132432132433132434132435132436132437132438132439132440132441132442132443132444132445132446132447132448132449132450132451132452132453132454132455132456132457132458132459132460132461132462132463132464132465132466132467132468132469132470132471132472132473132474132475132476132477132478132479132480132481132482132483132484132485132486132487132488132489132490132491132492132493132494132495132496132497132498132499132500132501132502132503132504132505132506132507132508132509132510132511132512132513132514132515132516132517132518132519132520132521132522132523132524132525132526132527132528132529132530132531132532132533132534132535132536132537132538132539132540132541132542132543132544132545132546132547132548132549132550132551132552132553132554132555132556132557132558132559132560132561132562132563132564132565132566132567132568132569132570132571132572132573132574132575132576132577132578132579132580132581132582132583132584132585132586132587132588132589132590132591132592132593132594132595132596132597132598132599132600132601132602132603132604132605132606132607132608132609132610132611132612132613132614132615132616132617132618132619132620132621132622132623132624132625132626132627132628132629132630132631132632132633132634132635132636132637132638132639132640132641132642132643132644132645132646132647132648132649132650132651132652132653132654132655132656132657132658132659132660132661132662132663132664132665132666132667132668132669132670132671132672132673132674132675132676132677132678132679132680132681132682132683132684132685132686132687132688132689132690132691132692132693132694132695132696132697132698132699132700132701132702132703132704132705132706132707132708132709132710132711132712132713132714132715132716132717132718132719132720132721132722132723132724132725132726132727132728132729132730132731132732132733132734132735132736132737132738132739132740132741132742132743132744132745132746132747132748132749132750132751132752132753132754132755132756132757132758132759132760132761132762132763132764132765132766132767132768132769132770132771132772132773132774132775132776132777132778132779132780132781132782132783132784132785132786132787132788132789132790132791132792132793132794132795132796132797132798132799132800132801132802132803132804132805132806132807132808132809132810132811132812132813132814132815132816132817132818132819132820132821132822132823132824132825132826132827132828132829132830132831132832132833132834132835132836132837132838132839132840132841132842132843132844132845132846132847132848132849132850132851132852132853132854132855132856132857132858132859132860132861132862132863132864132865132866132867132868132869132870132871132872132873132874132875132876132877132878132879132880132881132882132883132884132885132886132887132888132889132890132891132892132893132894132895132896132897132898132899132900132901132902132903132904132905132906132907132908132909132910132911132912132913132914132915132916132917132918132919132920132921132922132923132924132925132926132927132928132929132930132931132932132933132934132935132936132937132938132939132940132941132942132943132944132945132946132947132948132949132950132951132952132953132954132955132956132957132958132959132960132961132962132963132964132965132966132967132968132969132970132971132972132973132974132975132976132977132978132979132980132981132982132983132984132985132986132987132988132989132990132991132992132993132994132995132996132997132998132999133000133001133002133003133004133005133006133007133008133009133010133011133012133013133014133015133016133017133018133019133020133021133022133023133024133025133026133027133028133029133030133031133032133033133034133035133036133037133038133039133040133041133042133043133044133045133046133047133048133049133050133051133052133053133054133055133056133057133058133059133060133061133062133063133064133065133066133067133068133069133070133071133072133073133074133075133076133077133078133079133080133081133082133083133084133085133086133087133088133089133090133091133092133093133094133095133096133097133098133099133100133101133102133103133104133105133106133107133108133109133110133111133112133113133114133115133116133117133118133119133120133121133122133123133124133125133126133127133128133129133130133131133132133133133134133135133136133137133138133139133140133141133142133143133144133145133146133147133148133149133150133151133152133153133154133155133156133157133158133159133160133161133162133163133164133165133166133167133168133169133170133171133172133173133174133175133176133177133178133179133180133181133182133183133184133185133186133187133188133189133190133191133192133193133194133195133196133197133198133199133200133201133202133203133204133205133206133207133208133209133210133211133212133213133214133215133216133217133218133219133220133221133222133223133224133225133226133227133228133229133230133231133232133233133234133235133236133237133238133239133240133241133242133243133244133245133246133247133248133249133250133251133252133253133254133255133256133257133258133259133260133261133262133263133264133265133266133267133268133269133270133271133272133273133274133275133276133277133278133279133280133281133282133283133284133285133286133287133288133289133290133291133292133293133294133295133296133297133298133299133300133301133302133303133304133305133306133307133308133309133310133311133312133313133314133315133316133317133318133319133320133321133322133323133324133325133326133327133328133329133330133331133332133333133334133335133336133337133338133339133340133341133342133343133344133345133346133347133348133349133350133351133352133353133354133355133356133357133358133359133360133361133362133363133364133365133366133367133368133369133370133371133372133373133374133375133376133377133378133379133380133381133382133383133384133385133386133387133388133389133390133391133392133393133394133395133396133397133398133399133400133401133402133403133404133405133406133407133408133409133410133411133412133413133414133415133416133417133418133419133420133421133422133423133424133425133426133427133428133429133430133431133432133433133434133435133436133437133438133439133440133441133442133443133444133445133446133447133448133449133450133451133452133453133454133455133456133457133458133459133460133461133462133463133464133465133466133467133468133469133470133471133472133473133474133475133476133477133478133479133480133481133482133483133484133485133486133487133488133489133490133491133492133493133494133495133496133497133498133499133500133501133502133503133504133505133506133507133508133509133510133511133512133513133514133515133516133517133518133519133520133521133522133523133524133525133526133527133528133529133530133531133532133533133534133535133536133537133538133539133540133541133542133543133544133545133546133547133548133549133550133551133552133553133554133555133556133557133558133559133560133561133562133563133564133565133566133567133568133569133570133571133572133573133574133575133576133577133578133579133580133581133582133583133584133585133586133587133588133589133590133591133592133593133594133595133596133597133598133599133600133601133602133603133604133605133606133607133608133609133610133611133612133613133614133615133616133617133618133619133620133621133622133623133624133625133626133627133628133629133630133631133632133633133634133635133636133637133638133639133640133641133642133643133644133645133646133647133648133649133650133651133652133653133654133655133656133657133658133659133660133661133662133663133664133665133666133667133668133669133670133671133672133673133674133675133676133677133678133679133680133681133682133683133684133685133686133687133688133689133690133691133692133693133694133695133696133697133698133699133700133701133702133703133704133705133706133707133708133709133710133711133712133713133714133715133716133717133718133719133720133721133722133723133724133725133726133727133728133729133730133731133732133733133734133735133736133737133738133739133740133741133742133743133744133745133746133747133748133749133750133751133752133753133754133755133756133757133758133759133760133761133762133763133764133765133766133767133768133769133770133771133772133773133774133775133776133777133778133779133780133781133782133783133784133785133786133787133788133789133790133791133792133793133794133795133796133797133798133799133800133801133802133803133804133805133806133807133808133809133810133811133812133813133814133815133816133817133818133819133820133821133822133823133824133825133826133827133828133829133830133831133832133833133834133835133836133837133838133839133840133841133842133843133844133845133846133847133848133849133850133851133852133853133854133855133856133857133858133859133860133861133862133863133864133865133866133867133868133869133870133871133872133873133874133875133876133877133878133879133880133881133882133883133884133885133886133887133888133889133890133891133892133893133894133895133896133897133898133899133900133901133902133903133904133905133906133907133908133909133910133911133912133913133914133915133916133917133918133919133920133921133922133923133924133925133926133927133928133929133930133931133932133933133934133935133936133937133938133939133940133941133942133943133944133945133946133947133948133949133950133951133952133953133954133955133956133957133958133959133960133961133962133963133964133965133966133967133968133969133970133971133972133973133974133975133976133977133978133979133980133981133982133983133984133985133986133987133988133989133990133991133992133993133994133995133996133997133998133999134000134001134002134003134004134005134006134007134008134009134010134011134012134013134014134015134016134017134018134019134020134021134022134023134024134025134026134027134028134029134030134031134032134033134034134035134036134037134038134039134040134041134042134043134044134045134046134047134048134049134050134051134052134053134054134055134056134057134058134059134060134061134062134063134064134065134066134067134068134069134070134071134072134073134074134075134076134077134078134079134080134081134082134083134084134085134086134087134088134089134090134091134092134093134094134095134096134097134098134099134100134101134102134103134104134105134106134107134108134109134110134111134112134113134114134115134116134117134118134119134120134121134122134123134124134125134126134127134128134129134130134131134132134133134134134135134136134137134138134139134140134141134142134143134144134145134146134147134148134149134150134151134152134153134154134155134156134157134158134159134160134161134162134163134164134165134166134167134168134169134170134171134172134173134174134175134176134177134178134179134180134181134182134183134184134185134186134187134188134189134190134191134192134193134194134195134196134197134198134199134200134201134202134203134204134205134206134207134208134209134210134211134212134213134214134215134216134217134218134219134220134221134222134223134224134225134226134227134228134229134230134231134232134233134234134235134236134237134238134239134240134241134242134243134244134245134246134247134248134249134250134251134252134253134254134255134256134257134258134259134260134261134262134263134264134265134266134267134268134269134270134271134272134273134274134275134276134277134278134279134280134281134282134283134284134285134286134287134288134289134290134291134292134293134294134295134296134297134298134299134300134301134302134303134304134305134306134307134308134309134310134311134312134313134314134315134316134317134318134319134320134321134322134323134324134325134326134327134328134329134330134331134332134333134334134335134336134337134338134339134340134341134342134343134344134345134346134347134348134349134350134351134352134353134354134355134356134357134358134359134360134361134362134363134364134365134366134367134368134369134370134371134372134373134374134375134376134377134378134379134380134381134382134383134384134385134386134387134388134389134390134391134392134393134394134395134396134397134398134399134400134401134402134403134404134405134406134407134408134409134410134411134412134413134414134415134416134417134418134419134420134421134422134423134424134425134426134427134428134429134430134431134432134433134434134435134436134437134438134439134440134441134442134443134444134445134446134447134448134449134450134451134452134453134454134455134456134457134458134459134460134461134462134463134464134465134466134467134468134469134470134471134472134473134474134475134476134477134478134479134480134481134482134483134484134485134486134487134488134489134490134491134492134493134494134495134496134497134498134499134500134501134502134503134504134505134506134507134508134509134510134511134512134513134514134515134516134517134518134519134520134521134522134523134524134525134526134527134528134529134530134531134532134533134534134535134536134537134538134539134540134541134542134543134544134545134546134547134548134549134550134551134552134553134554134555134556134557134558134559134560134561134562134563134564134565134566134567134568134569134570134571134572134573134574134575134576134577134578134579134580134581134582134583134584134585134586134587134588134589134590134591134592134593134594134595134596134597134598134599134600134601134602134603134604134605134606134607134608134609134610134611134612134613134614134615134616134617134618134619134620134621134622134623134624134625134626134627134628134629134630134631134632134633134634134635134636134637134638134639134640134641134642134643134644134645134646134647134648134649134650134651134652134653134654134655134656134657134658134659134660134661134662134663134664134665134666134667134668134669134670134671134672134673134674134675134676134677134678134679134680134681134682134683134684134685134686134687134688134689134690134691134692134693134694134695134696134697134698134699134700134701134702134703134704134705134706134707134708134709134710134711134712134713134714134715134716134717134718134719134720134721134722134723134724134725134726134727134728134729134730134731134732134733134734134735134736134737134738134739134740134741134742134743134744134745134746134747134748134749134750134751134752134753134754134755134756134757134758134759134760134761134762134763134764134765134766134767134768134769134770134771134772134773134774134775134776134777134778134779134780134781134782134783134784134785134786134787134788134789134790134791134792134793134794134795134796134797134798134799134800134801134802134803134804134805134806134807134808134809134810134811134812134813134814134815134816134817134818134819134820134821134822134823134824134825134826134827134828134829134830134831134832134833134834134835134836134837134838134839134840134841134842134843134844134845134846134847134848134849134850134851134852134853134854134855134856134857134858134859134860134861134862134863134864134865134866134867134868134869134870134871134872134873134874134875134876134877134878134879134880134881134882134883134884134885134886134887134888134889134890134891134892134893134894134895134896134897134898134899134900134901134902134903134904134905134906134907134908134909134910134911134912134913134914134915134916134917134918134919134920134921134922134923134924134925134926134927134928134929134930134931134932134933134934134935134936134937134938134939134940134941134942134943134944134945134946134947134948134949134950134951134952134953134954134955134956134957134958134959134960134961134962134963134964134965134966134967134968134969134970134971134972134973134974134975134976134977134978134979134980134981134982134983134984134985134986134987134988134989134990134991134992134993134994134995134996134997134998134999135000135001135002135003135004135005135006135007135008135009135010135011135012135013135014135015135016135017135018135019135020135021135022135023135024135025135026135027135028135029135030135031135032135033135034135035135036135037135038135039135040135041135042135043135044135045135046135047135048135049135050135051135052135053135054135055135056135057135058135059135060135061135062135063135064135065135066135067135068135069135070135071135072135073135074135075135076135077135078135079135080135081135082135083135084135085135086135087135088135089135090135091135092135093135094135095135096135097135098135099135100135101135102135103135104135105135106135107135108135109135110135111135112135113135114135115135116135117135118135119135120135121135122135123135124135125135126135127135128135129135130135131135132135133135134135135135136135137135138135139135140135141135142135143135144135145135146135147135148135149135150135151135152135153135154135155135156135157135158135159135160135161135162135163135164135165135166135167135168135169135170135171135172135173135174135175135176135177135178135179135180135181135182135183135184135185135186135187135188135189135190135191135192135193135194135195135196135197135198135199135200135201135202135203135204135205135206135207135208135209135210135211135212135213135214135215135216135217135218135219135220135221135222135223135224135225135226135227135228135229135230135231135232135233135234135235135236135237135238135239135240135241135242135243135244135245135246135247135248135249135250135251135252135253135254135255135256135257135258135259135260135261135262135263135264135265135266135267135268135269135270135271135272135273135274135275135276135277135278135279135280135281135282135283135284135285135286135287135288135289135290135291135292135293135294135295135296135297135298135299135300135301135302135303135304135305135306135307135308135309135310135311135312135313135314135315135316135317135318135319135320135321135322135323135324135325135326135327135328135329135330135331135332135333135334135335135336135337135338135339135340135341135342135343135344135345135346135347135348135349135350135351135352135353135354135355135356135357135358135359135360135361135362135363135364135365135366135367135368135369135370135371135372135373135374135375135376135377135378135379135380135381135382135383135384135385135386135387135388135389135390135391135392135393135394135395135396135397135398135399135400135401135402135403135404135405135406135407135408135409135410135411135412135413135414135415135416135417135418135419135420135421135422135423135424135425135426135427135428135429135430135431135432135433135434135435135436135437135438135439135440135441135442135443135444135445135446135447135448135449135450135451135452135453135454135455135456135457135458135459135460135461135462135463135464135465135466135467135468135469135470135471135472135473135474135475135476135477135478135479135480135481135482135483135484135485135486135487135488135489135490135491135492135493135494135495135496135497135498135499135500135501135502135503135504135505135506135507135508135509135510135511135512135513135514135515135516135517135518135519135520135521135522135523135524135525135526135527135528135529135530135531135532135533135534135535135536135537135538135539135540135541135542135543135544135545135546135547135548135549135550135551135552135553135554135555135556135557135558135559135560135561135562135563135564135565135566135567135568135569135570135571135572135573135574135575135576135577135578135579135580135581135582135583135584135585135586135587135588135589135590135591135592135593135594135595135596135597135598135599135600135601135602135603135604135605135606135607135608135609135610135611135612135613135614135615135616135617135618135619135620135621135622135623135624135625135626135627135628135629135630135631135632135633135634135635135636135637135638135639135640135641135642135643135644135645135646135647135648135649135650135651135652135653135654135655135656135657135658135659135660135661135662135663135664135665135666135667135668135669135670135671135672135673135674135675135676135677135678135679135680135681135682135683135684135685135686135687135688135689135690135691135692135693135694135695135696135697135698135699135700135701135702135703135704135705135706135707135708135709135710135711135712135713135714135715135716135717135718135719135720135721135722135723135724135725135726135727135728135729135730135731135732135733135734135735135736135737135738135739135740135741135742135743135744135745135746135747135748135749135750135751135752135753135754135755135756135757135758135759135760135761135762135763135764135765135766135767135768135769135770135771135772135773135774135775135776135777135778135779135780135781135782135783135784135785135786135787135788135789135790135791135792135793135794135795135796135797135798135799135800135801135802135803135804135805135806135807135808135809135810135811135812135813135814135815135816135817135818135819135820135821135822135823135824135825135826135827135828135829135830135831135832135833135834135835135836135837135838135839135840135841135842135843135844135845135846135847135848135849135850135851135852135853135854135855135856135857135858135859135860135861135862135863135864135865135866135867135868135869135870135871135872135873135874135875135876135877135878135879135880135881135882135883135884135885135886135887135888135889135890135891135892135893135894135895135896135897135898135899135900135901135902135903135904135905135906135907135908135909135910135911135912135913135914135915135916135917135918135919135920135921135922135923135924135925135926135927135928135929135930135931135932135933135934135935135936135937135938135939135940135941135942135943135944135945135946135947135948135949135950135951135952135953135954135955135956135957135958135959135960135961135962135963135964135965135966135967135968135969135970135971135972135973135974135975135976135977135978135979135980135981135982135983135984135985135986135987135988135989135990135991135992135993135994135995135996135997135998135999136000136001136002136003136004136005136006136007136008136009136010136011136012136013136014136015136016136017136018136019136020136021136022136023136024136025136026136027136028136029136030136031136032136033136034136035136036136037136038136039136040136041136042136043136044136045136046136047136048136049136050136051136052136053136054136055136056136057136058136059136060136061136062136063136064136065136066136067136068136069136070136071136072136073136074136075136076136077136078136079136080136081136082136083136084136085136086136087136088136089136090136091136092136093136094136095136096136097136098136099136100136101136102136103136104136105136106136107136108136109136110136111136112136113136114136115136116136117136118136119136120136121136122136123136124136125136126136127136128136129136130136131136132136133136134136135136136136137136138136139136140136141136142136143136144136145136146136147136148136149136150136151136152136153136154136155136156136157136158136159136160136161136162136163136164136165136166136167136168136169136170136171136172136173136174136175136176136177136178136179136180136181136182136183136184136185136186136187136188136189136190136191136192136193136194136195136196136197136198136199136200136201136202136203136204136205136206136207136208136209136210136211136212136213136214136215136216136217136218136219136220136221136222136223136224136225136226136227136228136229136230136231136232136233136234136235136236136237136238136239136240136241136242136243136244136245136246136247136248136249136250136251136252136253136254136255136256136257136258136259136260136261136262136263136264136265136266136267136268136269136270136271136272136273136274136275136276136277136278136279136280136281136282136283136284136285136286136287136288136289136290136291136292136293136294136295136296136297136298136299136300136301136302136303136304136305136306136307136308136309136310136311136312136313136314136315136316136317136318136319136320136321136322136323136324136325136326136327136328136329136330136331136332136333136334136335136336136337136338136339136340136341136342136343136344136345136346136347136348136349136350136351136352136353136354136355136356136357136358136359136360136361136362136363136364136365136366136367136368136369136370136371136372136373136374136375136376136377136378136379136380136381136382136383136384136385136386136387136388136389136390136391136392136393136394136395136396136397136398136399136400136401136402136403136404136405136406136407136408136409136410136411136412136413136414136415136416136417136418136419136420136421136422136423136424136425136426136427136428136429136430136431136432136433136434136435136436136437136438136439136440136441136442136443136444136445136446136447136448136449136450136451136452136453136454136455136456136457136458136459136460136461136462136463136464136465136466136467136468136469136470136471136472136473136474136475136476136477136478136479136480136481136482136483136484136485136486136487136488136489136490136491136492136493136494136495136496136497136498136499136500136501136502136503136504136505136506136507136508136509136510136511136512136513136514136515136516136517136518136519136520136521136522136523136524136525136526136527136528136529136530136531136532136533136534136535136536136537136538136539136540136541136542136543136544136545136546136547136548136549136550136551136552136553136554136555136556136557136558136559136560136561136562136563136564136565136566136567136568136569136570136571136572136573136574136575136576136577136578136579136580136581136582136583136584136585136586136587136588136589136590136591136592136593136594136595136596136597136598136599136600136601136602136603136604136605136606136607136608136609136610136611136612136613136614136615136616136617136618136619136620136621136622136623136624136625136626136627136628136629136630136631136632136633136634136635136636136637136638136639136640136641136642136643136644136645136646136647136648136649136650136651136652136653136654136655136656136657136658136659136660136661136662136663136664136665136666136667136668136669136670136671136672136673136674136675136676136677136678136679136680136681136682136683136684136685136686136687136688136689136690136691136692136693136694136695136696136697136698136699136700136701136702136703136704136705136706136707136708136709136710136711136712136713136714136715136716136717136718136719136720136721136722136723136724136725136726136727136728136729136730136731136732136733136734136735136736136737136738136739136740136741136742136743136744136745136746136747136748136749136750136751136752136753136754136755136756136757136758136759136760136761136762136763136764136765136766136767136768136769136770136771136772136773136774136775136776136777136778136779136780136781136782136783136784136785136786136787136788136789136790136791136792136793136794136795136796136797136798136799136800136801136802136803136804136805136806136807136808136809136810136811136812136813136814136815136816136817136818136819136820136821136822136823136824136825136826136827136828136829136830136831136832136833136834136835136836136837136838136839136840136841136842136843136844136845136846136847136848136849136850136851136852136853136854136855136856136857136858136859136860136861136862136863136864136865136866136867136868136869136870136871136872136873136874136875136876136877136878136879136880136881136882136883136884136885136886136887136888136889136890136891136892136893136894136895136896136897136898136899136900136901136902136903136904136905136906136907136908136909136910136911136912136913136914136915136916136917136918136919136920136921136922136923136924136925136926136927136928136929136930136931136932136933136934136935136936136937136938136939136940136941136942136943136944136945136946136947136948136949136950136951136952136953136954136955136956136957136958136959136960136961136962136963136964136965136966136967136968136969136970136971136972136973136974136975136976136977136978136979136980136981136982136983136984136985136986136987136988136989136990136991136992136993136994136995136996136997136998136999137000137001137002137003137004137005137006137007137008137009137010137011137012137013137014137015137016137017137018137019137020137021137022137023137024137025137026137027137028137029137030137031137032137033137034137035137036137037137038137039137040137041137042137043137044137045137046137047137048137049137050137051137052137053137054137055137056137057137058137059137060137061137062137063137064137065137066137067137068137069137070137071137072137073137074137075137076137077137078137079137080137081137082137083137084137085137086137087137088137089137090137091137092137093137094137095137096137097137098137099137100137101137102137103137104137105137106137107137108137109137110137111137112137113137114137115137116137117137118137119137120137121137122137123137124137125137126137127137128137129137130137131137132137133137134137135137136137137137138137139137140137141137142137143137144137145137146137147137148137149137150137151137152137153137154137155137156137157137158137159137160137161137162137163137164137165137166137167137168137169137170137171137172137173137174137175137176137177137178137179137180137181137182137183137184137185137186137187137188137189137190137191137192137193137194137195137196137197137198137199137200137201137202137203137204137205137206137207137208137209137210137211137212137213137214137215137216137217137218137219137220137221137222137223137224137225137226137227137228137229137230137231137232137233137234137235137236137237137238137239137240137241137242137243137244137245137246137247137248137249137250137251137252137253137254137255137256137257137258137259137260137261137262137263137264137265137266137267137268137269137270137271137272137273137274137275137276137277137278137279137280137281137282137283137284137285137286137287137288137289137290137291137292137293137294137295137296137297137298137299137300137301137302137303137304137305137306137307137308137309137310137311137312137313137314137315137316137317137318137319137320137321137322137323137324137325137326137327137328137329137330137331137332137333137334137335137336137337137338137339137340137341137342137343137344137345137346137347137348137349137350137351137352137353137354137355137356137357137358137359137360137361137362137363137364137365137366137367137368137369137370137371137372137373137374137375137376137377137378137379137380137381137382137383137384137385137386137387137388137389137390137391137392137393137394137395137396137397137398137399137400137401137402137403137404137405137406137407137408137409137410137411137412137413137414137415137416137417137418137419137420137421137422137423137424137425137426137427137428137429137430137431137432137433137434137435137436137437137438137439137440137441137442137443137444137445137446137447137448137449137450137451137452137453137454137455137456137457137458137459137460137461137462137463137464137465137466137467137468137469137470137471137472137473137474137475137476137477137478137479137480137481137482137483137484137485137486137487137488137489137490137491137492137493137494137495137496137497137498137499137500137501137502137503137504137505137506137507137508137509137510137511137512137513137514137515137516137517137518137519137520137521137522137523137524137525137526137527137528137529137530137531137532137533137534137535137536137537137538137539137540137541137542137543137544137545137546137547137548137549137550137551137552137553137554137555137556137557137558137559137560137561137562137563137564137565137566137567137568137569137570137571137572137573137574137575137576137577137578137579137580137581137582137583137584137585137586137587137588137589137590137591137592137593137594137595137596137597137598137599137600137601137602137603137604137605137606137607137608137609137610137611137612137613137614137615137616137617137618137619137620137621137622137623137624137625137626137627137628137629137630137631137632137633137634137635137636137637137638137639137640137641137642137643137644137645137646137647137648137649137650137651137652137653137654137655137656137657137658137659137660137661137662137663137664137665137666137667137668137669137670137671137672137673137674137675137676137677137678137679137680137681137682137683137684137685137686137687137688137689137690137691137692137693137694137695137696137697137698137699137700137701137702137703137704137705137706137707137708137709137710137711137712137713137714137715137716137717137718137719137720137721137722137723137724137725137726137727137728137729137730137731137732137733137734137735137736137737137738137739137740137741137742137743137744137745137746137747137748137749137750137751137752137753137754137755137756137757137758137759137760137761137762137763137764137765137766137767137768137769137770137771137772137773137774137775137776137777137778137779137780137781137782137783137784137785137786137787137788137789137790137791137792137793137794137795137796137797137798137799137800137801137802137803137804137805137806137807137808137809137810137811137812137813137814137815137816137817137818137819137820137821137822137823137824137825137826137827137828137829137830137831137832137833137834137835137836137837137838137839137840137841137842137843137844137845137846137847137848137849137850137851137852137853137854137855137856137857137858137859137860137861137862137863137864137865137866137867137868137869137870137871137872137873137874137875137876137877137878137879137880137881137882137883137884137885137886137887137888137889137890137891137892137893137894137895137896137897137898137899137900137901137902137903137904137905137906137907137908137909137910137911137912137913137914137915137916137917137918137919137920137921137922137923137924137925137926137927137928137929137930137931137932137933137934137935137936137937137938137939137940137941137942137943137944137945137946137947137948137949137950137951137952137953137954137955137956137957137958137959137960137961137962137963137964137965137966137967137968137969137970137971137972137973137974137975137976137977137978137979137980137981137982137983137984137985137986137987137988137989137990137991137992137993137994137995137996137997137998137999138000138001138002138003138004138005138006138007138008138009138010138011138012138013138014138015138016138017138018138019138020138021138022138023138024138025138026138027138028138029138030138031138032138033138034138035138036138037138038138039138040138041138042138043138044138045138046138047138048138049138050138051138052138053138054138055138056138057138058138059138060138061138062138063138064138065138066138067138068138069138070138071138072138073138074138075138076138077138078138079138080138081138082138083138084138085138086138087138088138089138090138091138092138093138094138095138096138097138098138099138100138101138102138103138104138105138106138107138108138109138110138111138112138113138114138115138116138117138118138119138120138121138122138123138124138125138126138127138128138129138130138131138132138133138134138135138136138137138138138139138140138141138142138143138144138145138146138147138148138149138150138151138152138153138154138155138156138157138158138159138160138161138162138163138164138165138166138167138168138169138170138171138172138173138174138175138176138177138178138179138180138181138182138183138184138185138186138187138188138189138190138191138192138193138194138195138196138197138198138199138200138201138202138203138204138205138206138207138208138209138210138211138212138213138214138215138216138217138218138219138220138221138222138223138224138225138226138227138228138229138230138231138232138233138234138235138236138237138238138239138240138241138242138243138244138245138246138247138248138249138250138251138252138253138254138255138256138257138258138259138260138261138262138263138264138265138266138267138268138269138270138271138272138273138274138275138276138277138278138279138280138281138282138283138284138285138286138287138288138289138290138291138292138293138294138295138296138297138298138299138300138301138302138303138304138305138306138307138308138309138310138311138312138313138314138315138316138317138318138319138320138321138322138323138324138325138326138327138328138329138330138331138332138333138334138335138336138337138338138339138340138341138342138343138344138345138346138347138348138349138350138351138352138353138354138355138356138357138358138359138360138361138362138363138364138365138366138367138368138369138370138371138372138373138374138375138376138377138378138379138380138381138382138383138384138385138386138387138388138389138390138391138392138393138394138395138396138397138398138399138400138401138402138403138404138405138406138407138408138409138410138411138412138413138414138415138416138417138418138419138420138421138422138423138424138425138426138427138428138429138430138431138432138433138434138435138436138437138438138439138440138441138442138443138444138445138446138447138448138449138450138451138452138453138454138455138456138457138458138459138460138461138462138463138464138465138466138467138468138469138470138471138472138473138474138475138476138477138478138479138480138481138482138483138484138485138486138487138488138489138490138491138492138493138494138495138496138497138498138499138500138501138502138503138504138505138506138507138508138509138510138511138512138513138514138515138516138517138518138519138520138521138522138523138524138525138526138527138528138529138530138531138532138533138534138535138536138537138538138539138540138541138542138543138544138545138546138547138548138549138550138551138552138553138554138555138556138557138558138559138560138561138562138563138564138565138566138567138568138569138570138571138572138573138574138575138576138577138578138579138580138581138582138583138584138585138586138587138588138589138590138591138592138593138594138595138596138597138598138599138600138601138602138603138604138605138606138607138608138609138610138611138612138613138614138615138616138617138618138619138620138621138622138623138624138625138626138627138628138629138630138631138632138633138634138635138636138637138638138639138640138641138642138643138644138645138646138647138648138649138650138651138652138653138654138655138656138657138658138659138660138661138662138663138664138665138666138667138668138669138670138671138672138673138674138675138676138677138678138679138680138681138682138683138684138685138686138687138688138689138690138691138692138693138694138695138696138697138698138699138700138701138702138703138704138705138706138707138708138709138710138711138712138713138714138715138716138717138718138719138720138721138722138723138724138725138726138727138728138729138730138731138732138733138734138735138736138737138738138739138740138741138742138743138744138745138746138747138748138749138750138751138752138753138754138755138756138757138758138759138760138761138762138763138764138765138766138767138768138769138770138771138772138773138774138775138776138777138778138779138780138781138782138783138784138785138786138787138788138789138790138791138792138793138794138795138796138797138798138799138800138801138802138803138804138805138806138807138808138809138810138811138812138813138814138815138816138817138818138819138820138821138822138823138824138825138826138827138828138829138830138831138832138833138834138835138836138837138838138839138840138841138842138843138844138845138846138847138848138849138850138851138852138853138854138855138856138857138858138859138860138861138862138863138864138865138866138867138868138869138870138871138872138873138874138875138876138877138878138879138880138881138882138883138884138885138886138887138888138889138890138891138892138893138894138895138896138897138898138899138900138901138902138903138904138905138906138907138908138909138910138911138912138913138914138915138916138917138918138919138920138921138922138923138924138925138926138927138928138929138930138931138932138933138934138935138936138937138938138939138940138941138942138943138944138945138946138947138948138949138950138951138952138953138954138955138956138957138958138959138960138961138962138963138964138965138966138967138968138969138970138971138972138973138974138975138976138977138978138979138980138981138982138983138984138985138986138987138988138989138990138991138992138993138994138995138996138997138998138999139000139001139002139003139004139005139006139007139008139009139010139011139012139013139014139015139016139017139018139019139020139021139022139023139024139025139026139027139028139029139030139031139032139033139034139035139036139037139038139039139040139041139042139043139044139045139046139047139048139049139050139051139052139053139054139055139056139057139058139059139060139061139062139063139064139065139066139067139068139069139070139071139072139073139074139075139076139077139078139079139080139081139082139083139084139085139086139087139088139089139090139091139092139093139094139095139096139097139098139099139100139101139102139103139104139105139106139107139108139109139110139111139112139113139114139115139116139117139118139119139120139121139122139123139124139125139126139127139128139129139130139131139132139133139134139135139136139137139138139139139140139141139142139143139144139145139146139147139148139149139150139151139152139153139154139155139156139157139158139159139160139161139162139163139164139165139166139167139168139169139170139171139172139173139174139175139176139177139178139179139180139181139182139183139184139185139186139187139188139189139190139191139192139193139194139195139196139197139198139199139200139201139202139203139204139205139206139207139208139209139210139211139212139213139214139215139216139217139218139219139220139221139222139223139224139225139226139227139228139229139230139231139232139233139234139235139236139237139238139239139240139241139242139243139244139245139246139247139248139249139250139251139252139253139254139255139256139257139258139259139260139261139262139263139264139265139266139267139268139269139270139271139272139273139274139275139276139277139278139279139280139281139282139283139284139285139286139287139288139289139290139291139292139293139294139295139296139297139298139299139300139301139302139303139304139305139306139307139308139309139310139311139312139313139314139315139316139317139318139319139320139321139322139323139324139325139326139327139328139329139330139331139332139333139334139335139336139337139338139339139340139341139342139343139344139345139346139347139348139349139350139351139352139353139354139355139356139357139358139359139360139361139362139363139364139365139366139367139368139369139370139371139372139373139374139375139376139377139378139379139380139381139382139383139384139385139386139387139388139389139390139391139392139393139394139395139396139397139398139399139400139401139402139403139404139405139406139407139408139409139410139411139412139413139414139415139416139417139418139419139420139421139422139423139424139425139426139427139428139429139430139431139432139433139434139435139436139437139438139439139440139441139442139443139444139445139446139447139448139449139450139451139452139453139454139455139456139457139458139459139460139461139462139463139464139465139466139467139468139469139470139471139472139473139474139475139476139477139478139479139480139481139482139483139484139485139486139487139488139489139490139491139492139493139494139495139496139497139498139499139500139501139502139503139504139505139506139507139508139509139510139511139512139513139514139515139516139517139518139519139520139521139522139523139524139525139526139527139528139529139530139531139532139533139534139535139536139537139538139539139540139541139542139543139544139545139546139547139548139549139550139551139552139553139554139555139556139557139558139559139560139561139562139563139564139565139566139567139568139569139570139571139572139573139574139575139576139577139578139579139580139581139582139583139584139585139586139587139588139589139590139591139592139593139594139595139596139597139598139599139600139601139602139603139604139605139606139607139608139609139610139611139612139613139614139615139616139617139618139619139620139621139622139623139624139625139626139627139628139629139630139631139632139633139634139635139636139637139638139639139640139641139642139643139644139645139646139647139648139649139650139651139652139653139654139655139656139657139658139659139660139661139662139663139664139665139666139667139668139669139670139671139672139673139674139675139676139677139678139679139680139681139682139683139684139685139686139687139688139689139690139691139692139693139694139695139696139697139698139699139700139701139702139703139704139705139706139707139708139709139710139711139712139713139714139715139716139717139718139719139720139721139722139723139724139725139726139727139728139729139730139731139732139733139734139735139736139737139738139739139740139741139742139743139744139745139746139747139748139749139750139751139752139753139754139755139756139757139758139759139760139761139762139763139764139765139766139767139768139769139770139771139772139773139774139775139776139777139778139779139780139781139782139783139784139785139786139787139788139789139790139791139792139793139794139795139796139797139798139799139800139801139802139803139804139805139806139807139808139809139810139811139812139813139814139815139816139817139818139819139820139821139822139823139824139825139826139827139828139829139830139831139832139833139834139835139836139837139838139839139840139841139842139843139844139845139846139847139848139849139850139851139852139853139854139855139856139857139858139859139860139861139862139863139864139865139866139867139868139869139870139871139872139873139874139875139876139877139878139879139880139881139882139883139884139885139886139887139888139889139890139891139892139893139894139895139896139897139898139899139900139901139902139903139904139905139906139907139908139909139910139911139912139913139914139915139916139917139918139919139920139921139922139923139924139925139926139927139928139929139930139931139932139933139934139935139936139937139938139939139940139941139942139943139944139945139946139947139948139949139950139951139952139953139954139955139956139957139958139959139960139961139962139963139964139965139966139967139968139969139970139971139972139973139974139975139976139977139978139979139980139981139982139983139984139985139986139987139988139989139990139991139992139993139994139995139996139997139998139999140000140001140002140003140004140005140006140007140008140009140010140011140012140013140014140015140016140017140018140019140020140021140022140023140024140025140026140027140028140029140030140031140032140033140034140035140036140037140038140039140040140041140042140043140044140045140046140047140048140049140050140051140052140053140054140055140056140057140058140059140060140061140062140063140064140065140066140067140068140069140070140071140072140073140074140075140076140077140078140079140080140081140082140083140084140085140086140087140088140089140090140091140092140093140094140095140096140097140098140099140100140101140102140103140104140105140106140107140108140109140110140111140112140113140114140115140116140117140118140119140120140121140122140123140124140125140126140127140128140129140130140131140132140133140134140135140136140137140138140139140140140141140142140143140144140145140146140147140148140149140150140151140152140153140154140155140156140157140158140159140160140161140162140163140164140165140166140167140168140169140170140171140172140173140174140175140176140177140178140179140180140181140182140183140184140185140186140187140188140189140190140191140192140193140194140195140196140197140198140199140200140201140202140203140204140205140206140207140208140209140210140211140212140213140214140215140216140217140218140219140220140221140222140223140224140225140226140227140228140229140230140231140232140233140234140235140236140237140238140239140240140241140242140243140244140245140246140247140248140249140250140251140252140253140254140255140256140257140258140259140260140261140262140263140264140265140266140267140268140269140270140271140272140273140274140275140276140277140278140279140280140281140282140283140284140285140286140287140288140289140290140291140292140293140294140295140296140297140298140299140300140301140302140303140304140305140306140307140308140309140310140311140312140313140314140315140316140317140318140319140320140321140322140323140324140325140326140327140328140329140330140331140332140333140334140335140336140337140338140339140340140341140342140343140344140345140346140347140348140349140350140351140352140353140354140355140356140357140358140359140360140361140362140363140364140365140366140367140368140369140370140371140372140373140374140375140376140377140378140379140380140381140382140383140384140385140386140387140388140389140390140391140392140393140394140395140396140397140398140399140400140401140402140403140404140405140406140407140408140409140410140411140412140413140414140415140416140417140418140419140420140421140422140423140424140425140426140427140428140429140430140431140432140433140434140435140436140437140438140439140440140441140442140443140444140445140446140447140448140449140450140451140452140453140454140455140456140457140458140459140460140461140462140463140464140465140466140467140468140469140470140471140472140473140474140475140476140477140478140479140480140481140482140483140484140485140486140487140488140489140490140491140492140493140494140495140496140497140498140499140500140501140502140503140504140505140506140507140508140509140510140511140512140513140514140515140516140517140518140519140520140521140522140523140524140525140526140527140528140529140530140531140532140533140534140535140536140537140538140539140540140541140542140543140544140545140546140547140548140549140550140551140552140553140554140555140556140557140558140559140560140561140562140563140564140565140566140567140568140569140570140571140572140573140574140575140576140577140578140579140580140581140582140583140584140585140586140587140588140589140590140591140592140593140594140595140596140597140598140599140600140601140602140603140604140605140606140607140608140609140610140611140612140613140614140615140616140617140618140619140620140621140622140623140624140625140626140627140628140629140630140631140632140633140634140635140636140637140638140639140640140641140642140643140644140645140646140647140648140649140650140651140652140653140654140655140656140657140658140659140660140661140662140663140664140665140666140667140668140669140670140671140672140673140674140675140676140677140678140679140680140681140682140683140684140685140686140687140688140689140690140691140692140693140694140695140696140697140698140699140700140701140702140703140704140705140706140707140708140709140710140711140712140713140714140715140716140717140718140719140720140721140722140723140724140725140726140727140728140729140730140731140732140733140734140735140736140737140738140739140740140741140742140743140744140745140746140747140748140749140750140751140752140753140754140755140756140757140758140759140760140761140762140763140764140765140766140767140768140769140770140771140772140773140774140775140776140777140778140779140780140781140782140783140784140785140786140787140788140789140790140791140792140793140794140795140796140797140798140799140800140801140802140803140804140805140806140807140808140809140810140811140812140813140814140815140816140817140818140819140820140821140822140823140824140825140826140827140828140829140830140831140832140833140834140835140836140837140838140839140840140841140842140843140844140845140846140847140848140849140850140851140852140853140854140855140856140857140858140859140860140861140862140863140864140865140866140867140868140869140870140871140872140873140874140875140876140877140878140879140880140881140882140883140884140885140886140887140888140889140890140891140892140893140894140895140896140897140898140899140900140901140902140903140904140905140906140907140908140909140910140911140912140913140914140915140916140917140918140919140920140921140922140923140924140925140926140927140928140929140930140931140932140933140934140935140936140937140938140939140940140941140942140943140944140945140946140947140948140949140950140951140952140953140954140955140956140957140958140959140960140961140962140963140964140965140966140967140968140969140970140971140972140973140974140975140976140977140978140979140980140981140982140983140984140985140986140987140988140989140990140991140992140993140994140995140996140997140998140999141000141001141002141003141004141005141006141007141008141009141010141011141012141013141014141015141016141017141018141019141020141021141022141023141024141025141026141027141028141029141030141031141032141033141034141035141036141037141038141039141040141041141042141043141044141045141046141047141048141049141050141051141052141053141054141055141056141057141058141059141060141061141062141063141064141065141066141067141068141069141070141071141072141073141074141075141076141077141078141079141080141081141082141083141084141085141086141087141088141089141090141091141092141093141094141095141096141097141098141099141100141101141102141103141104141105141106141107141108141109141110141111141112141113141114141115141116141117141118141119141120141121141122141123141124141125141126141127141128141129141130141131141132141133141134141135141136141137141138141139141140141141141142141143141144141145141146141147141148141149141150141151141152141153141154141155141156141157141158141159141160141161141162141163141164141165141166141167141168141169141170141171141172141173141174141175141176141177141178141179141180141181141182141183141184141185141186141187141188141189141190141191141192141193141194141195141196141197141198141199141200141201141202141203141204141205141206141207141208141209141210141211141212141213141214141215141216141217141218141219141220141221141222141223141224141225141226141227141228141229141230141231141232141233141234141235141236141237141238141239141240141241141242141243141244141245141246141247141248141249141250141251141252141253141254141255141256141257141258141259141260141261141262141263141264141265141266141267141268141269141270141271141272141273141274141275141276141277141278141279141280141281141282141283141284141285141286141287141288141289141290141291141292141293141294141295141296141297141298141299141300141301141302141303141304141305141306141307141308141309141310141311141312141313141314141315141316141317141318141319141320141321141322141323141324141325141326141327141328141329141330141331141332141333141334141335141336141337141338141339141340141341141342141343141344141345141346141347141348141349141350141351141352141353141354141355141356141357141358141359141360141361141362141363141364141365141366141367141368141369141370141371141372141373141374141375141376141377141378141379141380141381141382141383141384141385141386141387141388141389141390141391141392141393141394141395141396141397141398141399141400141401141402141403141404141405141406141407141408141409141410141411141412141413141414141415141416141417141418141419141420141421141422141423141424141425141426141427141428141429141430141431141432141433141434141435141436141437141438141439141440141441141442141443141444141445141446141447141448141449141450141451141452141453141454141455141456141457141458141459141460141461141462141463141464141465141466141467141468141469141470141471141472141473141474141475141476141477141478141479141480141481141482141483141484141485141486141487141488141489141490141491141492141493141494141495141496141497141498141499141500141501141502141503141504141505141506141507141508141509141510141511141512141513141514141515141516141517141518141519141520141521141522141523141524141525141526141527141528141529141530141531141532141533141534141535141536141537141538141539141540141541141542141543141544141545141546141547141548141549141550141551141552141553141554141555141556141557141558141559141560141561141562141563141564141565141566141567141568141569141570141571141572141573141574141575141576141577141578141579141580141581141582141583141584141585141586141587141588141589141590141591141592141593141594141595141596141597141598141599141600141601141602141603141604141605141606141607141608141609141610141611141612141613141614141615141616141617141618141619141620141621141622141623141624141625141626141627141628141629141630141631141632141633141634141635141636141637141638141639141640141641141642141643141644141645141646141647141648141649141650141651141652141653141654141655141656141657141658141659141660141661141662141663141664141665141666141667141668141669141670141671141672141673141674141675141676141677141678141679141680141681141682141683141684141685141686141687141688141689141690141691141692141693141694141695141696141697141698141699141700141701141702141703141704141705141706141707141708141709141710141711141712141713141714141715141716141717141718141719141720141721141722141723141724141725141726141727141728141729141730141731141732141733141734141735141736141737141738141739141740141741141742141743141744141745141746141747141748141749141750141751141752141753141754141755141756141757141758141759141760141761141762141763141764141765141766141767141768141769141770141771141772141773141774141775141776141777141778141779141780141781141782141783141784141785141786141787141788141789141790141791141792141793141794141795141796141797141798141799141800141801141802141803141804141805141806141807141808141809141810141811141812141813141814141815141816141817141818141819141820141821141822141823141824141825141826141827141828141829141830141831141832141833141834141835141836141837141838141839141840141841141842141843141844141845141846141847141848141849141850141851141852141853141854141855141856141857141858141859141860141861141862141863141864141865141866141867141868141869141870141871141872141873141874141875141876141877141878141879141880141881141882141883141884141885141886141887141888141889141890141891141892141893141894141895141896141897141898141899141900141901141902141903141904141905141906141907141908141909141910141911141912141913141914141915141916141917141918141919141920141921141922141923141924141925141926141927141928141929141930141931141932141933141934141935141936141937141938141939141940141941141942141943141944141945141946141947141948141949141950141951141952141953141954141955141956141957141958141959141960141961141962141963141964141965141966141967141968141969141970141971141972141973141974141975141976141977141978141979141980141981141982141983141984141985141986141987141988141989141990141991141992141993141994141995141996141997141998141999142000142001142002142003142004142005142006142007142008142009142010142011142012142013142014142015142016142017142018142019142020142021142022142023142024142025142026142027142028142029142030142031142032142033142034142035142036142037142038142039142040142041142042142043142044142045142046142047142048142049142050142051142052142053142054142055142056142057142058142059142060142061142062142063142064142065142066142067142068142069142070142071142072142073142074142075142076142077142078142079142080142081142082142083142084142085142086142087142088142089142090142091142092142093142094142095142096142097142098142099142100142101142102142103142104142105142106142107142108142109142110142111142112142113142114142115142116142117142118142119142120142121142122142123142124142125142126142127142128142129142130142131142132142133142134142135142136142137142138142139142140142141142142142143142144142145142146142147142148142149142150142151142152142153142154142155142156142157142158142159142160142161142162142163142164142165142166142167142168142169142170142171142172142173142174142175142176142177142178142179142180142181142182142183142184142185142186142187142188142189142190142191142192142193142194142195142196142197142198142199142200142201142202142203142204142205142206142207142208142209142210142211142212142213142214142215142216142217142218142219142220142221142222142223142224142225142226142227142228142229142230142231142232142233142234142235142236142237142238142239142240142241142242142243142244142245142246142247142248142249142250142251142252142253142254142255142256142257142258142259142260142261142262142263142264142265142266142267142268142269142270142271142272142273142274142275142276142277142278142279142280142281142282142283142284142285142286142287142288142289142290142291142292142293142294142295142296142297142298142299142300142301142302142303142304142305142306142307142308142309142310142311142312142313142314142315142316142317142318142319142320142321142322142323142324142325142326142327142328142329142330142331142332142333142334142335142336142337142338142339142340142341142342142343142344142345142346142347142348142349142350142351142352142353142354142355142356142357142358142359142360142361142362142363142364142365142366142367142368142369142370142371142372142373142374142375142376142377142378142379142380142381142382142383142384142385142386142387142388142389142390142391142392142393142394142395142396142397142398142399142400142401142402142403142404142405142406142407142408142409142410142411142412142413142414142415142416142417142418142419142420142421142422142423142424142425142426142427142428142429142430142431142432142433142434142435142436142437142438142439142440142441142442142443142444142445142446142447142448142449142450142451142452142453142454142455142456142457142458142459142460142461142462142463142464142465142466142467142468142469142470142471142472142473142474142475142476142477142478142479142480142481142482142483142484142485142486142487142488142489142490142491142492142493142494142495142496142497142498142499142500142501142502142503142504142505142506142507142508142509142510142511142512142513142514142515142516142517142518142519142520142521142522142523142524142525142526142527142528142529142530142531142532142533142534142535142536142537142538142539142540142541142542142543142544142545142546142547142548142549142550142551142552142553142554142555142556142557142558142559142560142561142562142563142564142565142566142567142568142569142570142571142572142573142574142575142576142577142578142579142580142581142582142583142584142585142586142587142588142589142590142591142592142593142594142595142596142597142598142599142600142601142602142603142604142605142606142607142608142609142610142611142612142613142614142615142616142617142618142619142620142621142622142623142624142625142626142627142628142629142630142631142632142633142634142635142636142637142638142639142640142641142642142643142644142645142646142647142648142649142650142651142652142653142654142655142656142657142658142659142660142661142662142663142664142665142666142667142668142669142670142671142672142673142674142675142676142677142678142679142680142681142682142683142684142685142686142687142688142689142690142691142692142693142694142695142696142697142698142699142700142701142702142703142704142705142706142707142708142709142710142711142712142713142714142715142716142717142718142719142720142721142722142723142724142725142726142727142728142729142730142731142732142733142734142735142736142737142738142739142740142741142742142743142744142745142746142747142748142749142750142751142752142753142754142755142756142757142758142759142760142761142762142763142764142765142766142767142768142769142770142771142772142773142774142775142776142777142778142779142780142781142782142783142784142785142786142787142788142789142790142791142792142793142794142795142796142797142798142799142800142801142802142803142804142805142806142807142808142809142810142811142812142813142814142815142816142817142818142819142820142821142822142823142824142825142826142827142828142829142830142831142832142833142834142835142836142837142838142839142840142841142842142843142844142845142846142847142848142849142850142851142852142853142854142855142856142857142858142859142860142861142862142863142864142865142866142867142868142869142870142871142872142873142874142875142876142877142878142879142880142881142882142883142884142885142886142887142888142889142890142891142892142893142894142895142896142897142898142899142900142901142902142903142904142905142906142907142908142909142910142911142912142913142914142915142916142917142918142919142920142921142922142923142924142925142926142927142928142929142930142931142932142933142934142935142936142937142938142939142940142941142942142943142944142945142946142947142948142949142950142951142952142953142954142955142956142957142958142959142960142961142962142963142964142965142966142967142968142969142970142971142972142973142974142975142976142977142978142979142980142981142982142983142984142985142986142987142988142989142990142991142992142993142994142995142996142997142998142999143000143001143002143003143004143005143006143007143008143009143010143011143012143013143014143015143016143017143018143019143020143021143022143023143024143025143026143027143028143029143030143031143032143033143034143035143036143037143038143039143040143041143042143043143044143045143046143047143048143049143050143051143052143053143054143055143056143057143058143059143060143061143062143063143064143065143066143067143068143069143070143071143072143073143074143075143076143077143078143079143080143081143082143083143084143085143086143087143088143089143090143091143092143093143094143095143096143097143098143099143100143101143102143103143104143105143106143107143108143109143110143111143112143113143114143115143116143117143118143119143120143121143122143123143124143125143126143127143128143129143130143131143132143133143134143135143136143137143138143139143140143141143142143143143144143145143146143147143148143149143150143151143152143153143154143155143156143157143158143159143160143161143162143163143164143165143166143167143168143169143170143171143172143173143174143175143176143177143178143179143180143181143182143183143184143185143186143187143188143189143190143191143192143193143194143195143196143197143198143199143200143201143202143203143204143205143206143207143208143209143210143211143212143213143214143215143216143217143218143219143220143221143222143223143224143225143226143227143228143229143230143231143232143233143234143235143236143237143238143239143240143241143242143243143244143245143246143247143248143249143250143251143252143253143254143255143256143257143258143259143260143261143262143263143264143265143266143267143268143269143270143271143272143273143274143275143276143277143278143279143280143281143282143283143284143285143286143287143288143289143290143291143292143293143294143295143296143297143298143299143300143301143302143303143304143305143306143307143308143309143310143311143312143313143314143315143316143317143318143319143320143321143322143323143324143325143326143327143328143329143330143331143332143333143334143335143336143337143338143339143340143341143342143343143344143345143346143347143348143349143350143351143352143353143354143355143356143357143358143359143360143361143362143363143364143365143366143367143368143369143370143371143372143373143374143375143376143377143378143379143380143381143382143383143384143385143386143387143388143389143390143391143392143393143394143395143396143397143398143399143400143401143402143403143404143405143406143407143408143409143410143411143412143413143414143415143416143417143418143419143420143421143422143423143424143425143426143427143428143429143430143431143432143433143434143435143436143437143438143439143440143441143442143443143444143445143446143447143448143449143450143451143452143453143454143455143456143457143458143459143460143461143462143463143464143465143466143467143468143469143470143471143472143473143474143475143476143477143478143479143480143481143482143483143484143485143486143487143488143489143490143491143492143493143494143495143496143497143498143499143500143501143502143503143504143505143506143507143508143509143510143511143512143513143514143515143516143517143518143519143520143521143522143523143524143525143526143527143528143529143530143531143532143533143534143535143536143537143538143539143540143541143542143543143544143545143546143547143548143549143550143551143552143553143554143555143556143557143558143559143560143561143562143563143564143565143566143567143568143569143570143571143572143573143574143575143576143577143578143579143580143581143582143583143584143585143586143587143588143589143590143591143592143593143594143595143596143597143598143599143600143601143602143603143604143605143606143607143608143609143610143611143612143613143614143615143616143617143618143619143620143621143622143623143624143625143626143627143628143629143630143631143632143633143634143635143636143637143638143639143640143641143642143643143644143645143646143647143648143649143650143651143652143653143654143655143656143657143658143659143660143661143662143663143664143665143666143667143668143669143670143671143672143673143674143675143676143677143678143679143680143681143682143683143684143685143686143687143688143689143690143691143692143693143694143695143696143697143698143699143700143701143702143703143704143705143706143707143708143709143710143711143712143713143714143715143716143717143718143719143720143721143722143723143724143725143726143727143728143729143730143731143732143733143734143735143736143737143738143739143740143741143742143743143744143745143746143747143748143749143750143751143752143753143754143755143756143757143758143759143760143761143762143763143764143765143766143767143768143769143770143771143772143773143774143775143776143777143778143779143780143781143782143783143784143785143786143787143788143789143790143791143792143793143794143795143796143797143798143799143800143801143802143803143804143805143806143807143808143809143810143811143812143813143814143815143816143817143818143819143820143821143822143823143824143825143826143827143828143829143830143831143832143833143834143835143836143837143838143839143840143841143842143843143844143845143846143847143848143849143850143851143852143853143854143855143856143857143858143859143860143861143862143863143864143865143866143867143868143869143870143871143872143873143874143875143876143877143878143879143880143881143882143883143884143885143886143887143888143889143890143891143892143893143894143895143896143897143898143899143900143901143902143903143904143905143906143907143908143909143910143911143912143913143914143915143916143917143918143919143920143921143922143923143924143925143926143927143928143929143930143931143932143933143934143935143936143937143938143939143940143941143942143943143944143945143946143947143948143949143950143951143952143953143954143955143956143957143958143959143960143961143962143963143964143965143966143967143968143969143970143971143972143973143974143975143976143977143978143979143980143981143982143983143984143985143986143987143988143989143990143991143992143993143994143995143996143997143998143999144000144001144002144003144004144005144006144007144008144009144010144011144012144013144014144015144016144017144018144019144020144021144022144023144024144025144026144027144028144029144030144031144032144033144034144035144036144037144038144039144040144041144042144043144044144045144046144047144048144049144050144051144052144053144054144055144056144057144058144059144060144061144062144063144064144065144066144067144068144069144070144071144072144073144074144075144076144077144078144079144080144081144082144083144084144085144086144087144088144089144090144091144092144093144094144095144096144097144098144099144100144101144102144103144104144105144106144107144108144109144110144111144112144113144114144115144116144117144118144119144120144121144122144123144124144125144126144127144128144129144130144131144132144133144134144135144136144137144138144139144140144141144142144143144144144145144146144147144148144149144150144151144152144153144154144155144156144157144158144159144160144161144162144163144164144165144166144167144168144169144170144171144172144173144174144175144176144177144178144179144180144181144182144183144184144185144186144187144188144189144190144191144192144193144194144195144196144197144198144199144200144201144202144203144204144205144206144207144208144209144210144211144212144213144214144215144216144217144218144219144220144221144222144223144224144225144226144227144228144229144230144231144232144233144234144235144236144237144238144239144240144241144242144243144244144245144246144247144248144249144250144251144252144253144254144255144256144257144258144259144260144261144262144263144264144265144266144267144268144269144270144271144272144273144274144275144276144277144278144279144280144281144282144283144284144285144286144287144288144289144290144291144292144293144294144295144296144297144298144299144300144301144302144303144304144305144306144307144308144309144310144311144312144313144314144315144316144317144318144319144320144321144322144323144324144325144326144327144328144329144330144331144332144333144334144335144336144337144338144339144340144341144342144343144344144345144346144347144348144349144350144351144352144353144354144355144356144357144358144359144360144361144362144363144364144365144366144367144368144369144370144371144372144373144374144375144376144377144378144379144380144381144382144383144384144385144386144387144388144389144390144391144392144393144394144395144396144397144398144399144400144401144402144403144404144405144406144407144408144409144410144411144412144413144414144415144416144417144418144419144420144421144422144423144424144425144426144427144428144429144430144431144432144433144434144435144436144437144438144439144440144441144442144443144444144445144446144447144448144449144450144451144452144453144454144455144456144457144458144459144460144461144462144463144464144465144466144467144468144469144470144471144472144473144474144475144476144477144478144479144480144481144482144483144484144485144486144487144488144489144490144491144492144493144494144495144496144497144498144499144500144501144502144503144504144505144506144507144508144509144510144511144512144513144514144515144516144517144518144519144520144521144522144523144524144525144526144527144528144529144530144531144532144533144534144535144536144537144538144539144540144541144542144543144544144545144546144547144548144549144550144551144552144553144554144555144556144557144558144559144560144561144562144563144564144565144566144567144568144569144570144571144572144573144574144575144576144577144578144579144580144581144582144583144584144585144586144587144588144589144590144591144592144593144594144595144596144597144598144599144600144601144602144603144604144605144606144607144608144609144610144611144612144613144614144615144616144617144618144619144620144621144622144623144624144625144626144627144628144629144630144631144632144633144634144635144636144637144638144639144640144641144642144643144644144645144646144647144648144649144650144651144652144653144654144655144656144657144658144659144660144661144662144663144664144665144666144667144668144669144670144671144672144673144674144675144676144677144678144679144680144681144682144683144684144685144686144687144688144689144690144691144692144693144694144695144696144697144698144699144700144701144702144703144704144705144706144707144708144709144710144711144712144713144714144715144716144717144718144719144720144721144722144723144724144725144726144727144728144729144730144731144732144733144734144735144736144737144738144739144740144741144742144743144744144745144746144747144748144749144750144751144752144753144754144755144756144757144758144759144760144761144762144763144764144765144766144767144768144769144770144771144772144773144774144775144776144777144778144779144780144781144782144783144784144785144786144787144788144789144790144791144792144793144794144795144796144797144798144799144800144801144802144803144804144805144806144807144808144809144810144811144812144813144814144815144816144817144818144819144820144821144822144823144824144825144826144827144828144829144830144831144832144833144834144835144836144837144838144839144840144841144842144843144844144845144846144847144848144849144850144851144852144853144854144855144856144857144858144859144860144861144862144863144864144865144866144867144868144869144870144871144872144873144874144875144876144877144878144879144880144881144882144883144884144885144886144887144888144889144890144891144892144893144894144895144896144897144898144899144900144901144902144903144904144905144906144907144908144909144910144911144912144913144914144915144916144917144918144919144920144921144922144923144924144925144926144927144928144929144930144931144932144933144934144935144936144937144938144939144940144941144942144943144944144945144946144947144948144949144950144951144952144953144954144955144956144957144958144959144960144961144962144963144964144965144966144967144968144969144970144971144972144973144974144975144976144977144978144979144980144981144982144983144984144985144986144987144988144989144990144991144992144993144994144995144996144997144998144999145000145001145002145003145004145005145006145007145008145009145010145011145012145013145014145015145016145017145018145019145020145021145022145023145024145025145026145027145028145029145030145031145032145033145034145035145036145037145038145039145040145041145042145043145044145045145046145047145048145049145050145051145052145053145054145055145056145057145058145059145060145061145062145063145064145065145066145067145068145069145070145071145072145073145074145075145076145077145078145079145080145081145082145083145084145085145086145087145088145089145090145091145092145093145094145095145096145097145098145099145100145101145102145103145104145105145106145107145108145109145110145111145112145113145114145115145116145117145118145119145120145121145122145123145124145125145126145127145128145129145130145131145132145133145134145135145136145137145138145139145140145141145142145143145144145145145146145147145148145149145150145151145152145153145154145155145156145157145158145159145160145161145162145163145164145165145166145167145168145169145170145171145172145173145174145175145176145177145178145179145180145181145182145183145184145185145186145187145188145189145190145191145192145193145194145195145196145197145198145199145200145201145202145203145204145205145206145207145208145209145210145211145212145213145214145215145216145217145218145219145220145221145222145223145224145225145226145227145228145229145230145231145232145233145234145235145236145237145238145239145240145241145242145243145244145245145246145247145248145249145250145251145252145253145254145255145256145257145258145259145260145261145262145263145264145265145266145267145268145269145270145271145272145273145274145275145276145277145278145279145280145281145282145283145284145285145286145287145288145289145290145291145292145293145294145295145296145297145298145299145300145301145302145303145304145305145306145307145308145309145310145311145312145313145314145315145316145317145318145319145320145321145322145323145324145325145326145327145328145329145330145331145332145333145334145335145336145337145338145339145340145341145342145343145344145345145346145347145348145349145350145351145352145353145354145355145356145357145358145359145360145361145362145363145364145365145366145367145368145369145370145371145372145373145374145375145376145377145378145379145380145381145382145383145384145385145386145387145388145389145390145391145392145393145394145395145396145397145398145399145400145401145402145403145404145405145406145407145408145409145410145411145412145413145414145415145416145417145418145419145420145421145422145423145424145425145426145427145428145429145430145431145432145433145434145435145436145437145438145439145440145441145442145443145444145445145446145447145448145449145450145451145452145453145454145455145456145457145458145459145460145461145462145463145464145465145466145467145468145469145470145471145472145473145474145475145476145477145478145479145480145481145482145483145484145485145486145487145488145489145490145491145492145493145494145495145496145497145498145499145500145501145502145503145504145505145506145507145508145509145510145511145512145513145514145515145516145517145518145519145520145521145522145523145524145525145526145527145528145529145530145531145532145533145534145535145536145537145538145539145540145541145542145543145544145545145546145547145548145549145550145551145552145553145554145555145556145557145558145559145560145561145562145563145564145565145566145567145568145569145570145571145572145573145574145575145576145577145578145579145580145581145582145583145584145585145586145587145588145589145590145591145592145593145594145595145596145597145598145599145600145601145602145603145604145605145606145607145608145609145610145611145612145613145614145615145616145617145618145619145620145621145622145623145624145625145626145627145628145629145630145631145632145633145634145635145636145637145638145639145640145641145642145643145644145645145646145647145648145649145650145651145652145653145654145655145656145657145658145659145660145661145662145663145664145665145666145667145668145669145670145671145672145673145674145675145676145677145678145679145680145681145682145683145684145685145686145687145688145689145690145691145692145693145694145695145696145697145698145699145700145701145702145703145704145705145706145707145708145709145710145711145712145713145714145715145716145717145718145719145720145721145722145723145724145725145726145727145728145729145730145731145732145733145734145735145736145737145738145739145740145741145742145743145744145745145746145747145748145749145750145751145752145753145754145755145756145757145758145759145760145761145762145763145764145765145766145767145768145769145770145771145772145773145774145775145776145777145778145779145780145781145782145783145784145785145786145787145788145789145790145791145792145793145794145795145796145797145798145799145800145801145802145803145804145805145806145807145808145809145810145811145812145813145814145815145816145817145818145819145820145821145822145823145824145825145826145827145828145829145830145831145832145833145834145835145836145837145838145839145840145841145842145843145844145845145846145847145848145849145850145851145852145853145854145855145856145857145858145859145860145861145862145863145864145865145866145867145868145869145870145871145872145873145874145875145876145877145878145879145880145881145882145883145884145885145886145887145888145889145890145891145892145893145894145895145896145897145898145899145900145901145902145903145904145905145906145907145908145909145910145911145912145913145914145915145916145917145918145919145920145921145922145923145924145925145926145927145928145929145930145931145932145933145934145935145936145937145938145939145940145941145942145943145944145945145946145947145948145949145950145951145952145953145954145955145956145957145958145959145960145961145962145963145964145965145966145967145968145969145970145971145972145973145974145975145976145977145978145979145980145981145982145983145984145985145986145987145988145989145990145991145992145993145994145995145996145997145998145999146000146001146002146003146004146005146006146007146008146009146010146011146012146013146014146015146016146017146018146019146020146021146022146023146024146025146026146027146028146029146030146031146032146033146034146035146036146037146038146039146040146041146042146043146044146045146046146047146048146049146050146051146052146053146054146055146056146057146058146059146060146061146062146063146064146065146066146067146068146069146070146071146072146073146074146075146076146077146078146079146080146081146082146083146084146085146086146087146088146089146090146091146092146093146094146095146096146097146098146099146100146101146102146103146104146105146106146107146108146109146110146111146112146113146114146115146116146117146118146119146120146121146122146123146124146125146126146127146128146129146130146131146132146133146134146135146136146137146138146139146140146141146142146143146144146145146146146147146148146149146150146151146152146153146154146155146156146157146158146159146160146161146162146163146164146165146166146167146168146169146170146171146172146173146174146175146176146177146178146179146180146181146182146183146184146185146186146187146188146189146190146191146192146193146194146195146196146197146198146199146200146201146202146203146204146205146206146207146208146209146210146211146212146213146214146215146216146217146218146219146220146221146222146223146224146225146226146227146228146229146230146231146232146233146234146235146236146237146238146239146240146241146242146243146244146245146246146247146248146249146250146251146252146253146254146255146256146257146258146259146260146261146262146263146264146265146266146267146268146269146270146271146272146273146274146275146276146277146278146279146280146281146282146283146284146285146286146287146288146289146290146291146292146293146294146295146296146297146298146299146300146301146302146303146304146305146306146307146308146309146310146311146312146313146314146315146316146317146318146319146320146321146322146323146324146325146326146327146328146329146330146331146332146333146334146335146336146337146338146339146340146341146342146343146344146345146346146347146348146349146350146351146352146353146354146355146356146357146358146359146360146361146362146363146364146365146366146367146368146369146370146371146372146373146374146375146376146377146378146379146380146381146382146383146384146385146386146387146388146389146390146391146392146393146394146395146396146397146398146399146400146401146402146403146404146405146406146407146408146409146410146411146412146413146414146415146416146417146418146419146420146421146422146423146424146425146426146427146428146429146430146431146432146433146434146435146436146437146438146439146440146441146442146443146444146445146446146447146448146449146450146451146452146453146454146455146456146457146458146459146460146461146462146463146464146465146466146467146468146469146470146471146472146473146474146475146476146477146478146479146480146481146482146483146484146485146486146487146488146489146490146491146492146493146494146495146496146497146498146499146500146501146502146503146504146505146506146507146508146509146510146511146512146513146514146515146516146517146518146519146520146521146522146523146524146525146526146527146528146529146530146531146532146533146534146535146536146537146538146539146540146541146542146543146544146545146546146547146548146549146550146551146552146553146554146555146556146557146558146559146560146561146562146563146564146565146566146567146568146569146570146571146572146573146574146575146576146577146578146579146580146581146582146583146584146585146586146587146588146589146590146591146592146593146594146595146596146597146598146599146600146601146602146603146604146605146606146607146608146609146610146611146612146613146614146615146616146617146618146619146620146621146622146623146624146625146626146627146628146629146630146631146632146633146634146635146636146637146638146639146640146641146642146643146644146645146646146647146648146649146650146651146652146653146654146655146656146657146658146659146660146661146662146663146664146665146666146667146668146669146670146671146672146673146674146675146676146677146678146679146680146681146682146683146684146685146686146687146688146689146690146691146692146693146694146695146696146697146698146699146700146701146702146703146704146705146706146707146708146709146710146711146712146713146714146715146716146717146718146719146720146721146722146723146724146725146726146727146728146729146730146731146732146733146734146735146736146737146738146739146740146741146742146743146744146745146746146747146748146749146750146751146752146753146754146755146756146757146758146759146760146761146762146763146764146765146766146767146768146769146770146771146772146773146774146775146776146777146778146779146780146781146782146783146784146785146786146787146788146789146790146791146792146793146794146795146796146797146798146799146800146801146802146803146804146805146806146807146808146809146810146811146812146813146814146815146816146817146818146819146820146821146822146823146824146825146826146827146828146829146830146831146832146833146834146835146836146837146838146839146840146841146842146843146844146845146846146847146848146849146850146851146852146853146854146855146856146857146858146859146860146861146862146863146864146865146866146867146868146869146870146871146872146873146874146875146876146877146878146879146880146881146882146883146884146885146886146887146888146889146890146891146892146893146894146895146896146897146898146899146900146901146902146903146904146905146906146907146908146909146910146911146912146913146914146915146916146917146918146919146920146921146922146923146924146925146926146927146928146929146930146931146932146933146934146935146936146937146938146939146940146941146942146943146944146945146946146947146948146949146950146951146952146953146954146955146956146957146958146959146960146961146962146963146964146965146966146967146968146969146970146971146972146973146974146975146976146977146978146979146980146981146982146983146984146985146986146987146988146989146990146991146992146993146994146995146996146997146998146999147000147001147002147003147004147005147006147007147008147009147010147011147012147013147014147015147016147017147018147019147020147021147022147023147024147025147026147027147028147029147030147031147032147033147034147035147036147037147038147039147040147041147042147043147044147045147046147047147048147049147050147051147052147053147054147055147056147057147058147059147060147061147062147063147064147065147066147067147068147069147070147071147072147073147074147075147076147077147078147079147080147081147082147083147084147085147086147087147088147089147090147091147092147093147094147095147096147097147098147099147100147101147102147103147104147105147106147107147108147109147110147111147112147113147114147115147116147117147118147119147120147121147122147123147124147125147126147127147128147129147130147131147132147133147134147135147136147137147138147139147140147141147142147143147144147145147146147147147148147149147150147151147152147153147154147155147156147157147158147159147160147161147162147163147164147165147166147167147168147169147170147171147172147173147174147175147176147177147178147179147180147181147182147183147184147185147186147187147188147189147190147191147192147193147194147195147196147197147198147199147200147201147202147203147204147205147206147207147208147209147210147211147212147213147214147215147216147217147218147219147220147221147222147223147224147225147226147227147228147229147230147231147232147233147234147235147236147237147238147239147240147241147242147243147244147245147246147247147248147249147250147251147252147253147254147255147256147257147258147259147260147261147262147263147264147265147266147267147268147269147270147271147272147273147274147275147276147277147278147279147280147281147282147283147284147285147286147287147288147289147290147291147292147293147294147295147296147297147298147299147300147301147302147303147304147305147306147307147308147309147310147311147312147313147314147315147316147317147318147319147320147321147322147323147324147325147326147327147328147329147330147331147332147333147334147335147336147337147338147339147340147341147342147343147344147345147346147347147348147349147350147351147352147353147354147355147356147357147358147359147360147361147362147363147364147365147366147367147368147369147370147371147372147373147374147375147376147377147378147379147380147381147382147383147384147385147386147387147388147389147390147391147392147393147394147395147396147397147398147399147400147401147402147403147404147405147406147407147408147409147410147411147412147413147414147415147416147417147418147419147420147421147422147423147424147425147426147427147428147429147430147431147432147433147434147435147436147437147438147439147440147441147442147443147444147445147446147447147448147449147450147451147452147453147454147455147456147457147458147459147460147461147462147463147464147465147466147467147468147469147470147471147472147473147474147475147476147477147478147479147480147481147482147483147484147485147486147487147488147489147490147491147492147493147494147495147496147497147498147499147500147501147502147503147504147505147506147507147508147509147510147511147512147513147514147515147516147517147518147519147520147521147522147523147524147525147526147527147528147529147530147531147532147533147534147535147536147537147538147539147540147541147542147543147544147545147546147547147548147549147550147551147552147553147554147555147556147557147558147559147560147561147562147563147564147565147566147567147568147569147570147571147572147573147574147575147576147577147578147579147580147581147582147583147584147585147586147587147588147589147590147591147592147593147594147595147596147597147598147599147600147601147602147603147604147605147606147607147608147609147610147611147612147613147614147615147616147617147618147619147620147621147622147623147624147625147626147627147628147629147630147631147632147633147634147635147636147637147638147639147640147641147642147643147644147645147646147647147648147649147650147651147652147653147654147655147656147657147658147659147660147661147662147663147664147665147666147667147668147669147670147671147672147673147674147675147676147677147678147679147680147681147682147683147684147685147686147687147688147689147690147691147692147693147694147695147696147697147698147699147700147701147702147703147704147705147706147707147708147709147710147711147712147713147714147715147716147717147718147719147720147721147722147723147724147725147726147727147728147729147730147731147732147733147734147735147736147737147738147739147740147741147742147743147744147745147746147747147748147749147750147751147752147753147754147755147756147757147758147759147760147761147762147763147764147765147766147767147768147769147770147771147772147773147774147775147776147777147778147779147780147781147782147783147784147785147786147787147788147789147790147791147792147793147794147795147796147797147798147799147800147801147802147803147804147805147806147807147808147809147810147811147812147813147814147815147816147817147818147819147820147821147822147823147824147825147826147827147828147829147830147831147832147833147834147835147836147837147838147839147840147841147842147843147844147845147846147847147848147849147850147851147852147853147854147855147856147857147858147859147860147861147862147863147864147865147866147867147868147869147870147871147872147873147874147875147876147877147878147879147880147881147882147883147884147885147886147887147888147889147890147891147892147893147894147895147896147897147898147899147900147901147902147903147904147905147906147907147908147909147910147911147912147913147914147915147916147917147918147919147920147921147922147923147924147925147926147927147928147929147930147931147932147933147934147935147936147937147938147939147940147941147942147943147944147945147946147947147948147949147950147951147952147953147954147955147956147957147958147959147960147961147962147963147964147965147966147967147968147969147970147971147972147973147974147975147976147977147978147979147980147981147982147983147984147985147986147987147988147989147990147991147992147993147994147995147996147997147998147999148000148001148002148003148004148005148006148007148008148009148010148011148012148013148014148015148016148017148018148019148020148021148022148023148024148025148026148027148028148029148030148031148032148033148034148035148036148037148038148039148040148041148042148043148044148045148046148047148048148049148050148051148052148053148054148055148056148057148058148059148060148061148062148063148064148065148066148067148068148069148070148071148072148073148074148075148076148077148078148079148080148081148082148083148084148085148086148087148088148089148090148091148092148093148094148095148096148097148098148099148100148101148102148103148104148105148106148107148108148109148110148111148112148113148114148115148116148117148118148119148120148121148122148123148124148125148126148127148128148129148130148131148132148133148134148135148136148137148138148139148140148141148142148143148144148145148146148147148148148149148150148151148152148153148154148155148156148157148158148159148160148161148162148163148164148165148166148167148168148169148170148171148172148173148174148175148176148177148178148179148180148181148182148183148184148185148186148187148188148189148190148191148192148193148194148195148196148197148198148199148200148201148202148203148204148205148206148207148208148209148210148211148212148213148214148215148216148217148218148219148220148221148222148223148224148225148226148227148228148229148230148231148232148233148234148235148236148237148238148239148240148241148242148243148244148245148246148247148248148249148250148251148252148253148254148255148256148257148258148259148260148261148262148263148264148265148266148267148268148269148270148271148272148273148274148275148276148277148278148279148280148281148282148283148284148285148286148287148288148289148290148291148292148293148294148295148296148297148298148299148300148301148302148303148304148305148306148307148308148309148310148311148312148313148314148315148316148317148318148319148320148321148322148323148324148325148326148327148328148329148330148331148332148333148334148335148336148337148338148339148340148341148342148343148344148345148346148347148348148349148350148351148352148353148354148355148356148357148358148359148360148361148362148363148364148365148366148367148368148369148370148371148372148373148374148375148376148377148378148379148380148381148382148383148384148385148386148387148388148389148390148391148392148393148394148395148396148397148398148399148400148401148402148403148404148405148406148407148408148409148410148411148412148413148414148415148416148417148418148419148420148421148422148423148424148425148426148427148428148429148430148431148432148433148434148435148436148437148438148439148440148441148442148443148444148445148446148447148448148449148450148451148452148453148454148455148456148457148458148459148460148461148462148463148464148465148466148467148468148469148470148471148472148473148474148475148476148477148478148479148480148481148482148483148484148485148486148487148488148489148490148491148492148493148494148495148496148497148498148499148500148501148502148503148504148505148506148507148508148509148510148511148512148513148514148515148516148517148518148519148520148521148522148523148524148525148526148527148528148529148530148531148532148533148534148535148536148537148538148539148540148541148542148543148544148545148546148547148548148549148550148551148552148553148554148555148556148557148558148559148560148561148562148563148564148565148566148567148568148569148570148571148572148573148574148575148576148577148578148579148580148581148582148583148584148585148586148587148588148589148590148591148592148593148594148595148596148597148598148599148600148601148602148603148604148605148606148607148608148609148610148611148612148613148614148615148616148617148618148619148620148621148622148623148624148625148626148627148628148629148630148631148632148633148634148635148636148637148638148639148640148641148642148643148644148645148646148647148648148649148650148651148652148653148654148655148656148657148658148659148660148661148662148663148664148665148666148667148668148669148670148671148672148673148674148675148676148677148678148679148680148681148682148683148684148685148686148687148688148689148690148691148692148693148694148695148696148697148698148699148700148701148702148703148704148705148706148707148708148709148710148711148712148713148714148715148716148717148718148719148720148721148722148723148724148725148726148727148728148729148730148731148732148733148734148735148736148737148738148739148740148741148742148743148744148745148746148747148748148749148750148751148752148753148754148755148756148757148758148759148760148761148762148763148764148765148766148767148768148769148770148771148772148773148774148775148776148777148778148779148780148781148782148783148784148785148786148787148788148789148790148791148792148793148794148795148796148797148798148799148800148801148802148803148804148805148806148807148808148809148810148811148812148813148814148815148816148817148818148819148820148821148822148823148824148825148826148827148828148829148830148831148832148833148834148835148836148837148838148839148840148841148842148843148844148845148846148847148848148849148850148851148852148853148854148855148856148857148858148859148860148861148862148863148864148865148866148867148868148869148870148871148872148873148874148875148876148877148878148879148880148881148882148883148884148885148886148887148888148889148890148891148892148893148894148895148896148897148898148899148900148901148902148903148904148905148906148907148908148909148910148911148912148913148914148915148916148917148918148919148920148921148922148923148924148925148926148927148928148929148930148931148932148933148934148935148936148937148938148939148940148941148942148943148944148945148946148947148948148949148950148951148952148953148954148955148956148957148958148959148960148961148962148963148964148965148966148967148968148969148970148971148972148973148974148975148976148977148978148979148980148981148982148983148984148985148986148987148988148989148990148991148992148993148994148995148996148997148998148999149000149001149002149003149004149005149006149007149008149009149010149011149012149013149014149015149016149017149018149019149020149021149022149023149024149025149026149027149028149029149030149031149032149033149034149035149036149037149038149039149040149041149042149043149044149045149046149047149048149049149050149051149052149053149054149055149056149057149058149059149060149061149062149063149064149065149066149067149068149069149070149071149072149073149074149075149076149077149078149079149080149081149082149083149084149085149086149087149088149089149090149091149092149093149094149095149096149097149098149099149100149101149102149103149104149105149106149107149108149109149110149111149112149113149114149115149116149117149118149119149120149121149122149123149124149125149126149127149128149129149130149131149132149133149134149135149136149137149138149139149140149141149142149143149144149145149146149147149148149149149150149151149152149153149154149155149156149157149158149159149160149161149162149163149164149165149166149167149168149169149170149171149172149173149174149175149176149177149178149179149180149181149182149183149184149185149186149187149188149189149190149191149192149193149194149195149196149197149198149199149200149201149202149203149204149205149206149207149208149209149210149211149212149213149214149215149216149217149218149219149220149221149222149223149224149225149226149227149228149229149230149231149232149233149234149235149236149237149238149239149240149241149242149243149244149245149246149247149248149249149250149251149252149253149254149255149256149257149258149259149260149261149262149263149264149265149266149267149268149269149270149271149272149273149274149275149276149277149278149279149280149281149282149283149284149285149286149287149288149289149290149291149292149293149294149295149296149297149298149299149300149301149302149303149304149305149306149307149308149309149310149311149312149313149314149315149316149317149318149319149320149321149322149323149324149325149326149327149328149329149330149331149332149333149334149335149336149337149338149339149340149341149342149343149344149345149346149347149348149349149350149351149352149353149354149355149356149357149358149359149360149361149362149363149364149365149366149367149368149369149370149371149372149373149374149375149376149377149378149379149380149381149382149383149384149385149386149387149388149389149390149391149392149393149394149395149396149397149398149399149400149401149402149403149404149405149406149407149408149409149410149411149412149413149414149415149416149417149418149419149420149421149422149423149424149425149426149427149428149429149430149431149432149433149434149435149436149437149438149439149440149441149442149443149444149445149446149447149448149449149450149451149452149453149454149455149456149457149458149459149460149461149462149463149464149465149466149467149468149469149470149471149472149473149474149475149476149477149478149479149480149481149482149483149484149485149486149487149488149489149490149491149492149493149494149495149496149497149498149499149500149501149502149503149504149505149506149507149508149509149510149511149512149513149514149515149516149517149518149519149520149521149522149523149524149525149526149527149528149529149530149531149532149533149534149535149536149537149538149539149540149541149542149543149544149545149546149547149548149549149550149551149552149553149554149555149556149557149558149559149560149561149562149563149564149565149566149567149568149569149570149571149572149573149574149575149576149577149578149579149580149581149582149583149584149585149586149587149588149589149590149591149592149593149594149595149596149597149598149599149600149601149602149603149604149605149606149607149608149609149610149611149612149613149614149615149616149617149618149619149620149621149622149623149624149625149626149627149628149629149630149631149632149633149634149635149636149637149638149639149640149641149642149643149644149645149646149647149648149649149650149651149652149653149654149655149656149657149658149659149660149661149662149663149664149665149666149667149668149669149670149671149672149673149674149675149676149677149678149679149680149681149682149683149684149685149686149687149688149689149690149691149692149693149694149695149696149697149698149699149700149701149702149703149704149705149706149707149708149709149710149711149712149713149714149715149716149717149718149719149720149721149722149723149724149725149726149727149728149729149730149731149732149733149734149735149736149737149738149739149740149741149742149743149744149745149746149747149748149749149750149751149752149753149754149755149756149757149758149759149760149761149762149763149764149765149766149767149768149769149770149771149772149773149774149775149776149777149778149779149780149781149782149783149784149785149786149787149788149789149790149791149792149793149794149795149796149797149798149799149800149801149802149803149804149805149806149807149808149809149810149811149812149813149814149815149816149817149818149819149820149821149822149823149824149825149826149827149828149829149830149831149832149833149834149835149836149837149838149839149840149841149842149843149844149845149846149847149848149849149850149851149852149853149854149855149856149857149858149859149860149861149862149863149864149865149866149867149868149869149870149871149872149873149874149875149876149877149878149879149880149881149882149883149884149885149886149887149888149889149890149891149892149893149894149895149896149897149898149899149900149901149902149903149904149905149906149907149908149909149910149911149912149913149914149915149916149917149918149919149920149921149922149923149924149925149926149927149928149929149930149931149932149933149934149935149936149937149938149939149940149941149942149943149944149945149946149947149948149949149950149951149952149953149954149955149956149957149958149959149960149961149962149963149964149965149966149967149968149969149970149971149972149973149974149975149976149977149978149979149980149981149982149983149984149985149986149987149988149989149990149991149992149993149994149995149996149997149998149999150000150001150002150003150004150005150006150007150008150009150010150011150012150013150014150015150016150017150018150019150020150021150022150023150024150025150026150027150028150029150030150031150032150033150034150035150036150037150038150039150040150041150042150043150044150045150046150047150048150049150050150051150052150053150054150055150056150057150058150059150060150061150062150063150064150065150066150067150068150069150070150071150072150073150074150075150076150077150078150079150080150081150082150083150084150085150086150087150088150089150090150091150092150093150094150095150096150097150098150099150100150101150102150103150104150105150106150107150108150109150110150111150112150113150114150115150116150117150118150119150120150121150122150123150124150125150126150127150128150129150130150131150132150133150134150135150136150137150138150139150140150141150142150143150144150145150146150147150148150149150150150151150152150153150154150155150156150157150158150159150160150161150162150163150164150165150166150167150168150169150170150171150172150173150174150175150176150177150178150179150180150181150182150183150184150185150186150187150188150189150190150191150192150193150194150195150196150197150198150199150200150201150202150203150204150205150206150207150208150209150210150211150212150213150214150215150216150217150218150219150220150221150222150223150224150225150226150227150228150229150230150231150232150233150234150235150236150237150238150239150240150241150242150243150244150245150246150247150248150249150250150251150252150253150254150255150256150257150258150259150260150261150262150263150264150265150266150267150268150269150270150271150272150273150274150275150276150277150278150279150280150281150282150283150284150285150286150287150288150289150290150291150292150293150294150295150296150297150298150299150300150301150302150303150304150305150306150307150308150309150310150311150312150313150314150315150316150317150318150319150320150321150322150323150324150325150326150327150328150329150330150331150332150333150334150335150336150337150338150339150340150341150342150343150344150345150346150347150348150349150350150351150352150353150354150355150356150357150358150359150360150361150362150363150364150365150366150367150368150369150370150371150372150373150374150375150376150377150378150379150380150381150382150383150384150385150386150387150388150389150390150391150392150393150394150395150396150397150398150399150400150401150402150403150404150405150406150407150408150409150410150411150412150413150414150415150416150417150418150419150420150421150422150423150424150425150426150427150428150429150430150431150432150433150434150435150436150437150438150439150440150441150442150443150444150445150446150447150448150449150450150451150452150453150454150455150456150457150458150459150460150461150462150463150464150465150466150467150468150469150470150471150472150473150474150475150476150477150478150479150480150481150482150483150484150485150486150487150488150489150490150491150492150493150494150495150496150497150498150499150500150501150502150503150504150505150506150507150508150509150510150511150512150513150514150515150516150517150518150519150520150521150522150523150524150525150526150527150528150529150530150531150532150533150534150535150536150537150538150539150540150541150542150543150544150545150546150547150548150549150550150551150552150553150554150555150556150557150558150559150560150561150562150563150564150565150566150567150568150569150570150571150572150573150574150575150576150577150578150579150580150581150582150583150584150585150586150587150588150589150590150591150592150593150594150595150596150597150598150599150600150601150602150603150604150605150606150607150608150609150610150611150612150613150614150615150616150617150618150619150620150621150622150623150624150625150626150627150628150629150630150631150632150633150634150635150636150637150638150639150640150641150642150643150644150645150646150647150648150649150650150651150652150653150654150655150656150657150658150659150660150661150662150663150664150665150666150667150668150669150670150671150672150673150674150675150676150677150678150679150680150681150682150683150684150685150686150687150688150689150690150691150692150693150694150695150696150697150698150699150700150701150702150703150704150705150706150707150708150709150710150711150712150713150714150715150716150717150718150719150720150721150722150723150724150725150726150727150728150729150730150731150732150733150734150735150736150737150738150739150740150741150742150743150744150745150746150747150748150749150750150751150752150753150754150755150756150757150758150759150760150761150762150763150764150765150766150767150768150769150770150771150772150773150774150775150776150777150778150779150780150781150782150783150784150785150786150787150788150789150790150791150792150793150794150795150796150797150798150799150800150801150802150803150804150805150806150807150808150809150810150811150812150813150814150815150816150817150818150819150820150821150822150823150824150825150826150827150828150829150830150831150832150833150834150835150836150837150838150839150840150841150842150843150844150845150846150847150848150849150850150851150852150853150854150855150856150857150858150859150860150861150862150863150864150865150866150867150868150869150870150871150872150873150874150875150876150877150878150879150880150881150882150883150884150885150886150887150888150889150890150891150892150893150894150895150896150897150898150899150900150901150902150903150904150905150906150907150908150909150910150911150912150913150914150915150916150917150918150919150920150921150922150923150924150925150926150927150928150929150930150931150932150933150934150935150936150937150938150939150940150941150942150943150944150945150946150947150948150949150950150951150952150953150954150955150956150957150958150959150960150961150962150963150964150965150966150967150968150969150970150971150972150973150974150975150976150977150978150979150980150981150982150983150984150985150986150987150988150989150990150991150992150993150994150995150996150997150998150999151000151001151002151003151004151005151006151007151008151009151010151011151012151013151014151015151016151017151018151019151020151021151022151023151024151025151026151027151028151029151030151031151032151033151034151035151036151037151038151039151040151041151042151043151044151045151046151047151048151049151050151051151052151053151054151055151056151057151058151059151060151061151062151063151064151065151066151067151068151069151070151071151072151073151074151075151076151077151078151079151080151081151082151083151084151085151086151087151088151089151090151091151092151093151094151095151096151097151098151099151100151101151102151103151104151105151106151107151108151109151110151111151112151113151114151115151116151117151118151119151120151121151122151123151124151125151126151127151128151129151130151131151132151133151134151135151136151137151138151139151140151141151142151143151144151145151146151147151148151149151150151151151152151153151154151155151156151157151158151159151160151161151162151163151164151165151166151167151168151169151170151171151172151173151174151175151176151177151178151179151180151181151182151183151184151185151186151187151188151189151190151191151192151193151194151195151196151197151198151199151200151201151202151203151204151205151206151207151208151209151210151211151212151213151214151215151216151217151218151219151220151221151222151223151224151225151226151227151228151229151230151231151232151233151234151235151236151237151238151239151240151241151242151243151244151245151246151247151248151249151250151251151252151253151254151255151256151257151258151259151260151261151262151263151264151265151266151267151268151269151270151271151272151273151274151275151276151277151278151279151280151281151282151283151284151285151286151287151288151289151290151291151292151293151294151295151296151297151298151299151300151301151302151303151304151305151306151307151308151309151310151311151312151313151314151315151316151317151318151319151320151321151322151323151324151325151326151327151328151329151330151331151332151333151334151335151336151337151338151339151340151341151342151343151344151345151346151347151348151349151350151351151352151353151354151355151356151357151358151359151360151361151362151363151364151365151366151367151368151369151370151371151372151373151374151375151376151377151378151379151380151381151382151383151384151385151386151387151388151389151390151391151392151393151394151395151396151397151398151399151400151401151402151403151404151405151406151407151408151409151410151411151412151413151414151415151416151417151418151419151420151421151422151423151424151425151426151427151428151429151430151431151432151433151434151435151436151437151438151439151440151441151442151443151444151445151446151447151448151449151450151451151452151453151454151455151456151457151458151459151460151461151462151463151464151465151466151467151468151469151470151471151472151473151474151475151476151477151478151479151480151481151482151483151484151485151486151487151488151489151490151491151492151493151494151495151496151497151498151499151500151501151502151503151504151505151506151507151508151509151510151511151512151513151514151515151516151517151518151519151520151521151522151523151524151525151526151527151528151529151530151531151532151533151534151535151536151537151538151539151540151541151542151543151544151545151546151547151548151549151550151551151552151553151554151555151556151557151558151559151560151561151562151563151564151565151566151567151568151569151570151571151572151573151574151575151576151577151578151579151580151581151582151583151584151585151586151587151588151589151590151591151592151593151594151595151596151597151598151599151600151601151602151603151604151605151606151607151608151609151610151611151612151613151614151615151616151617151618151619151620151621151622151623151624151625151626151627151628151629151630151631151632151633151634151635151636151637151638151639151640151641151642151643151644151645151646151647151648151649151650151651151652151653151654151655151656151657151658151659151660151661151662151663151664151665151666151667151668151669151670151671151672151673151674151675151676151677151678151679151680151681151682151683151684151685151686151687151688151689151690151691151692151693151694151695151696151697151698151699151700151701151702151703151704151705151706151707151708151709151710151711151712151713151714151715151716151717151718151719151720151721151722151723151724151725151726151727151728151729151730151731151732151733151734151735151736151737151738151739151740151741151742151743151744151745151746151747151748151749151750151751151752151753151754151755151756151757151758151759151760151761151762151763151764151765151766151767151768151769151770151771151772151773151774151775151776151777151778151779151780151781151782151783151784151785151786151787151788151789151790151791151792151793151794151795151796151797151798151799151800151801151802151803151804151805151806151807151808151809151810151811151812151813151814151815151816151817151818151819151820151821151822151823151824151825151826151827151828151829151830151831151832151833151834151835151836151837151838151839151840151841151842151843151844151845151846151847151848151849151850151851151852151853151854151855151856151857151858151859151860151861151862151863151864151865151866151867151868151869151870151871151872151873151874151875151876151877151878151879151880151881151882151883151884151885151886151887151888151889151890151891151892151893151894151895151896151897151898151899151900151901151902151903151904151905151906151907151908151909151910151911151912151913151914151915151916151917151918151919151920151921151922151923151924151925151926151927151928151929151930151931151932151933151934151935151936151937151938151939151940151941151942151943151944151945151946151947151948151949151950151951151952151953151954151955151956151957151958151959151960151961151962151963151964151965151966151967151968151969151970151971151972151973151974151975151976151977151978151979151980151981151982151983151984151985151986151987151988151989151990151991151992151993151994151995151996151997151998151999152000152001152002152003152004152005152006152007152008152009152010152011152012152013152014152015152016152017152018152019152020152021152022152023152024152025152026152027152028152029152030152031152032152033152034152035152036152037152038152039152040152041152042152043152044152045152046152047152048152049152050152051152052152053152054152055152056152057152058152059152060152061152062152063152064152065152066152067152068152069152070152071152072152073152074152075152076152077152078152079152080152081152082152083152084152085152086152087152088152089152090152091152092152093152094152095152096152097152098152099152100152101152102152103152104152105152106152107152108152109152110152111152112152113152114152115152116152117152118152119152120152121152122152123152124152125152126152127152128152129152130152131152132152133152134152135152136152137152138152139152140152141152142152143152144152145152146152147152148152149152150152151152152152153152154152155152156152157152158152159152160152161152162152163152164152165152166152167152168152169152170152171152172152173152174152175152176152177152178152179152180152181152182152183152184152185152186152187152188152189152190152191152192152193152194152195152196152197152198152199152200152201152202152203152204152205152206152207152208152209152210152211152212152213152214152215152216152217152218152219152220152221152222152223152224152225152226152227152228152229152230152231152232152233152234152235152236152237152238152239152240152241152242152243152244152245152246152247152248152249152250152251152252152253152254152255152256152257152258152259152260152261152262152263152264152265152266152267152268152269152270152271152272152273152274152275152276152277152278152279152280152281152282152283152284152285152286152287152288152289152290152291152292152293152294152295152296152297152298152299152300152301152302152303152304152305152306152307152308152309152310152311152312152313152314152315152316152317152318152319152320152321152322152323152324152325152326152327152328152329152330152331152332152333152334152335152336152337152338152339152340152341152342152343152344152345152346152347152348152349152350152351152352152353152354152355152356152357152358152359152360152361152362152363152364152365152366152367152368152369152370152371152372152373152374152375152376152377152378152379152380152381152382152383152384152385152386152387152388152389152390152391152392152393152394152395152396152397152398152399152400152401152402152403152404152405152406152407152408152409152410152411152412152413152414152415152416152417152418152419152420152421152422152423152424152425152426152427152428152429152430152431152432152433152434152435152436152437152438152439152440152441152442152443152444152445152446152447152448152449152450152451152452152453152454152455152456152457152458152459152460152461152462152463152464152465152466152467152468152469152470152471152472152473152474152475152476152477152478152479152480152481152482152483152484152485152486152487152488152489152490152491152492152493152494152495152496152497152498152499152500152501152502152503152504152505152506152507152508152509152510152511152512152513152514152515152516152517152518152519152520152521152522152523152524152525152526152527152528152529152530152531152532152533152534152535152536152537152538152539152540152541152542152543152544152545152546152547152548152549152550152551152552152553152554152555152556152557152558152559152560152561152562152563152564152565152566152567152568152569152570152571152572152573152574152575152576152577152578152579152580152581152582152583152584152585152586152587152588152589152590152591152592152593152594152595152596152597152598152599152600152601152602152603152604152605152606152607152608152609152610152611152612152613152614152615152616152617152618152619152620152621152622152623152624152625152626152627152628152629152630152631152632152633152634152635152636152637152638152639152640152641152642152643152644152645152646152647152648152649152650152651152652152653152654152655152656152657152658152659152660152661152662152663152664152665152666152667152668152669152670152671152672152673152674152675152676152677152678152679152680152681152682152683152684152685152686152687152688152689152690152691152692152693152694152695152696152697152698152699152700152701152702152703152704152705152706152707152708152709152710152711152712152713152714152715152716152717152718152719152720152721152722152723152724152725152726152727152728152729152730152731152732152733152734152735152736152737152738152739152740152741152742152743152744152745152746152747152748152749152750152751152752152753152754152755152756152757152758152759152760152761152762152763152764152765152766152767152768152769152770152771152772152773152774152775152776152777152778152779152780152781152782152783152784152785152786152787152788152789152790152791152792152793152794152795152796152797152798152799152800152801152802152803152804152805152806152807152808152809152810152811152812152813152814152815152816152817152818152819152820152821152822152823152824152825152826152827152828152829152830152831152832152833152834152835152836152837152838152839152840152841152842152843152844152845152846152847152848152849152850152851152852152853152854152855152856152857152858152859152860152861152862152863152864152865152866152867152868152869152870152871152872152873152874152875152876152877152878152879152880152881152882152883152884152885152886152887152888152889152890152891152892152893152894152895152896152897152898152899152900152901152902152903152904152905152906152907152908152909152910152911152912152913152914152915152916152917152918152919152920152921152922152923152924152925152926152927152928152929152930152931152932152933152934152935152936152937152938152939152940152941152942152943152944152945152946152947152948152949152950152951152952152953152954152955152956152957152958152959152960152961152962152963152964152965152966152967152968152969152970152971152972152973152974152975152976152977152978152979152980152981152982152983152984152985152986152987152988152989152990152991152992152993152994152995152996152997152998152999153000153001153002153003153004153005153006153007153008153009153010153011153012153013153014153015153016153017153018153019153020153021153022153023153024153025153026153027153028153029153030153031153032153033153034153035153036153037153038153039153040153041153042153043153044153045153046153047153048153049153050153051153052153053153054153055153056153057153058153059153060153061153062153063153064153065153066153067153068153069153070153071153072153073153074153075153076153077153078153079153080153081153082153083153084153085153086153087153088153089153090153091153092153093153094153095153096153097153098153099153100153101153102153103153104153105153106153107153108153109153110153111153112153113153114153115153116153117153118153119153120153121153122153123153124153125153126153127153128153129153130153131153132153133153134153135153136153137153138153139153140153141153142153143153144153145153146153147153148153149153150153151153152153153153154153155153156153157153158153159153160153161153162153163153164153165153166153167153168153169153170153171153172153173153174153175153176153177153178153179153180153181153182153183153184153185153186153187153188153189153190153191153192153193153194153195153196153197153198153199153200153201153202153203153204153205153206153207153208153209153210153211153212153213153214153215153216153217153218153219153220153221153222153223153224153225153226153227153228153229153230153231153232153233153234153235153236153237153238153239153240153241153242153243153244153245153246153247153248153249153250153251153252153253153254153255153256153257153258153259153260153261153262153263153264153265153266153267153268153269153270153271153272153273153274153275153276153277153278153279153280153281153282153283153284153285153286153287153288153289153290153291153292153293153294153295153296153297153298153299153300153301153302153303153304153305153306153307153308153309153310153311153312153313153314153315153316153317153318153319153320153321153322153323153324153325153326153327153328153329153330153331153332153333153334153335153336153337153338153339153340153341153342153343153344153345153346153347153348153349153350153351153352153353153354153355153356153357153358153359153360153361153362153363153364153365153366153367153368153369153370153371153372153373153374153375153376153377153378153379153380153381153382153383153384153385153386153387153388153389153390153391153392153393153394153395153396153397153398153399153400153401153402153403153404153405153406153407153408153409153410153411153412153413153414153415153416153417153418153419153420153421153422153423153424153425153426153427153428153429153430153431153432153433153434153435153436153437153438153439153440153441153442153443153444153445153446153447153448153449153450153451153452153453153454153455153456153457153458153459153460153461153462153463153464153465153466153467153468153469153470153471153472153473153474153475153476153477153478153479153480153481153482153483153484153485153486153487153488153489153490153491153492153493153494153495153496153497153498153499153500153501153502153503153504153505153506153507153508153509153510153511153512153513153514153515153516153517153518153519153520153521153522153523153524153525153526153527153528153529153530153531153532153533153534153535153536153537153538153539153540153541153542153543153544153545153546153547153548153549153550153551153552153553153554153555153556153557153558153559
  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. * Copy the current vector to an array
  2133. * @returns a new array with 2 elements: the Vector2 coordinates.
  2134. */
  2135. asArray(): number[];
  2136. /**
  2137. * Sets the Vector2 coordinates with the given Vector2 coordinates
  2138. * @param source defines the source Vector2
  2139. * @returns the current updated Vector2
  2140. */
  2141. copyFrom(source: DeepImmutable<Vector2>): Vector2;
  2142. /**
  2143. * Sets the Vector2 coordinates with the given floats
  2144. * @param x defines the first coordinate
  2145. * @param y defines the second coordinate
  2146. * @returns the current updated Vector2
  2147. */
  2148. copyFromFloats(x: number, y: number): 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. set(x: number, y: number): Vector2;
  2156. /**
  2157. * Add another vector with the current one
  2158. * @param otherVector defines the other vector
  2159. * @returns a new Vector2 set with the addition of the current Vector2 and the given one coordinates
  2160. */
  2161. add(otherVector: DeepImmutable<Vector2>): Vector2;
  2162. /**
  2163. * Sets the "result" coordinates with the addition of the current Vector2 and the given one coordinates
  2164. * @param otherVector defines the other vector
  2165. * @param result defines the target vector
  2166. * @returns the unmodified current Vector2
  2167. */
  2168. addToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  2169. /**
  2170. * Set the Vector2 coordinates by adding the given Vector2 coordinates
  2171. * @param otherVector defines the other vector
  2172. * @returns the current updated Vector2
  2173. */
  2174. addInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  2175. /**
  2176. * Gets a new Vector2 by adding the current Vector2 coordinates to the given Vector3 x, y coordinates
  2177. * @param otherVector defines the other vector
  2178. * @returns a new Vector2
  2179. */
  2180. addVector3(otherVector: Vector3): Vector2;
  2181. /**
  2182. * Gets a new Vector2 set with the subtracted coordinates of the given one from the current Vector2
  2183. * @param otherVector defines the other vector
  2184. * @returns a new Vector2
  2185. */
  2186. subtract(otherVector: Vector2): Vector2;
  2187. /**
  2188. * Sets the "result" coordinates with the subtraction of the given one from the current Vector2 coordinates.
  2189. * @param otherVector defines the other vector
  2190. * @param result defines the target vector
  2191. * @returns the unmodified current Vector2
  2192. */
  2193. subtractToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  2194. /**
  2195. * Sets the current Vector2 coordinates by subtracting from it the given one coordinates
  2196. * @param otherVector defines the other vector
  2197. * @returns the current updated Vector2
  2198. */
  2199. subtractInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  2200. /**
  2201. * Multiplies in place the current Vector2 coordinates by the given ones
  2202. * @param otherVector defines the other vector
  2203. * @returns the current updated Vector2
  2204. */
  2205. multiplyInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  2206. /**
  2207. * Returns a new Vector2 set with the multiplication of the current Vector2 and the given one coordinates
  2208. * @param otherVector defines the other vector
  2209. * @returns a new Vector2
  2210. */
  2211. multiply(otherVector: DeepImmutable<Vector2>): Vector2;
  2212. /**
  2213. * Sets "result" coordinates with the multiplication of the current Vector2 and the given one coordinates
  2214. * @param otherVector defines the other vector
  2215. * @param result defines the target vector
  2216. * @returns the unmodified current Vector2
  2217. */
  2218. multiplyToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  2219. /**
  2220. * Gets a new Vector2 set with the Vector2 coordinates multiplied by the given floats
  2221. * @param x defines the first coordinate
  2222. * @param y defines the second coordinate
  2223. * @returns a new Vector2
  2224. */
  2225. multiplyByFloats(x: number, y: number): Vector2;
  2226. /**
  2227. * Returns a new Vector2 set with the Vector2 coordinates divided by the given one coordinates
  2228. * @param otherVector defines the other vector
  2229. * @returns a new Vector2
  2230. */
  2231. divide(otherVector: Vector2): Vector2;
  2232. /**
  2233. * Sets the "result" coordinates with the Vector2 divided by the given one coordinates
  2234. * @param otherVector defines the other vector
  2235. * @param result defines the target vector
  2236. * @returns the unmodified current Vector2
  2237. */
  2238. divideToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  2239. /**
  2240. * Divides the current Vector2 coordinates by the given ones
  2241. * @param otherVector defines the other vector
  2242. * @returns the current updated Vector2
  2243. */
  2244. divideInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  2245. /**
  2246. * Gets a new Vector2 with current Vector2 negated coordinates
  2247. * @returns a new Vector2
  2248. */
  2249. negate(): Vector2;
  2250. /**
  2251. * Negate this vector in place
  2252. * @returns this
  2253. */
  2254. negateInPlace(): Vector2;
  2255. /**
  2256. * Negate the current Vector2 and stores the result in the given vector "result" coordinates
  2257. * @param result defines the Vector3 object where to store the result
  2258. * @returns the current Vector2
  2259. */
  2260. negateToRef(result: Vector2): Vector2;
  2261. /**
  2262. * Multiply the Vector2 coordinates by scale
  2263. * @param scale defines the scaling factor
  2264. * @returns the current updated Vector2
  2265. */
  2266. scaleInPlace(scale: number): Vector2;
  2267. /**
  2268. * Returns a new Vector2 scaled by "scale" from the current Vector2
  2269. * @param scale defines the scaling factor
  2270. * @returns a new Vector2
  2271. */
  2272. scale(scale: number): Vector2;
  2273. /**
  2274. * Scale the current Vector2 values by a factor to a given Vector2
  2275. * @param scale defines the scale factor
  2276. * @param result defines the Vector2 object where to store the result
  2277. * @returns the unmodified current Vector2
  2278. */
  2279. scaleToRef(scale: number, result: Vector2): Vector2;
  2280. /**
  2281. * Scale the current Vector2 values by a factor and add the result 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. scaleAndAddToRef(scale: number, result: Vector2): Vector2;
  2287. /**
  2288. * Gets a boolean if two vectors are equals
  2289. * @param otherVector defines the other vector
  2290. * @returns true if the given vector coordinates strictly equal the current Vector2 ones
  2291. */
  2292. equals(otherVector: DeepImmutable<Vector2>): boolean;
  2293. /**
  2294. * Gets a boolean if two vectors are equals (using an epsilon value)
  2295. * @param otherVector defines the other vector
  2296. * @param epsilon defines the minimal distance to consider equality
  2297. * @returns true if the given vector coordinates are close to the current ones by a distance of epsilon.
  2298. */
  2299. equalsWithEpsilon(otherVector: DeepImmutable<Vector2>, epsilon?: number): boolean;
  2300. /**
  2301. * Gets a new Vector2 from current Vector2 floored values
  2302. * @returns a new Vector2
  2303. */
  2304. floor(): Vector2;
  2305. /**
  2306. * Gets a new Vector2 from current Vector2 floored values
  2307. * @returns a new Vector2
  2308. */
  2309. fract(): Vector2;
  2310. /**
  2311. * Gets the length of the vector
  2312. * @returns the vector length (float)
  2313. */
  2314. length(): number;
  2315. /**
  2316. * Gets the vector squared length
  2317. * @returns the vector squared length (float)
  2318. */
  2319. lengthSquared(): number;
  2320. /**
  2321. * Normalize the vector
  2322. * @returns the current updated Vector2
  2323. */
  2324. normalize(): Vector2;
  2325. /**
  2326. * Gets a new Vector2 copied from the Vector2
  2327. * @returns a new Vector2
  2328. */
  2329. clone(): Vector2;
  2330. /**
  2331. * Gets a new Vector2(0, 0)
  2332. * @returns a new Vector2
  2333. */
  2334. static Zero(): Vector2;
  2335. /**
  2336. * Gets a new Vector2(1, 1)
  2337. * @returns a new Vector2
  2338. */
  2339. static One(): Vector2;
  2340. /**
  2341. * Gets a new Vector2 set from the given index element of the given array
  2342. * @param array defines the data source
  2343. * @param offset defines the offset in the data source
  2344. * @returns a new Vector2
  2345. */
  2346. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector2;
  2347. /**
  2348. * Sets "result" 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. * @param result defines the target vector
  2352. */
  2353. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector2): void;
  2354. /**
  2355. * Gets a new Vector2 located for "amount" (float) on the CatmullRom spline defined by the given four Vector2
  2356. * @param value1 defines 1st point of control
  2357. * @param value2 defines 2nd point of control
  2358. * @param value3 defines 3rd point of control
  2359. * @param value4 defines 4th point of control
  2360. * @param amount defines the interpolation factor
  2361. * @returns a new Vector2
  2362. */
  2363. static CatmullRom(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>, value3: DeepImmutable<Vector2>, value4: DeepImmutable<Vector2>, amount: number): Vector2;
  2364. /**
  2365. * 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".
  2366. * If a coordinate of "value" is lower than "min" coordinates, the returned Vector2 is given this "min" coordinate.
  2367. * If a coordinate of "value" is greater than "max" coordinates, the returned Vector2 is given this "max" coordinate
  2368. * @param value defines the value to clamp
  2369. * @param min defines the lower limit
  2370. * @param max defines the upper limit
  2371. * @returns a new Vector2
  2372. */
  2373. static Clamp(value: DeepImmutable<Vector2>, min: DeepImmutable<Vector2>, max: DeepImmutable<Vector2>): Vector2;
  2374. /**
  2375. * Returns a new Vector2 located for "amount" (float) on the Hermite spline defined by the vectors "value1", "value3", "tangent1", "tangent2"
  2376. * @param value1 defines the 1st control point
  2377. * @param tangent1 defines the outgoing tangent
  2378. * @param value2 defines the 2nd control point
  2379. * @param tangent2 defines the incoming tangent
  2380. * @param amount defines the interpolation factor
  2381. * @returns a new Vector2
  2382. */
  2383. static Hermite(value1: DeepImmutable<Vector2>, tangent1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>, tangent2: DeepImmutable<Vector2>, amount: number): Vector2;
  2384. /**
  2385. * Returns a new Vector2 located for "amount" (float) on the linear interpolation between the vector "start" adn the vector "end".
  2386. * @param start defines the start vector
  2387. * @param end defines the end vector
  2388. * @param amount defines the interpolation factor
  2389. * @returns a new Vector2
  2390. */
  2391. static Lerp(start: DeepImmutable<Vector2>, end: DeepImmutable<Vector2>, amount: number): Vector2;
  2392. /**
  2393. * Gets the dot product of the vector "left" and the vector "right"
  2394. * @param left defines first vector
  2395. * @param right defines second vector
  2396. * @returns the dot product (float)
  2397. */
  2398. static Dot(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): number;
  2399. /**
  2400. * Returns a new Vector2 equal to the normalized given vector
  2401. * @param vector defines the vector to normalize
  2402. * @returns a new Vector2
  2403. */
  2404. static Normalize(vector: DeepImmutable<Vector2>): Vector2;
  2405. /**
  2406. * Gets a new Vector2 set with the minimal coordinate values from the "left" and "right" vectors
  2407. * @param left defines 1st vector
  2408. * @param right defines 2nd vector
  2409. * @returns a new Vector2
  2410. */
  2411. static Minimize(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): Vector2;
  2412. /**
  2413. * Gets a new Vecto2 set with the maximal 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 Maximize(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): Vector2;
  2419. /**
  2420. * Gets a new Vector2 set with the transformed coordinates of the given vector by the given transformation matrix
  2421. * @param vector defines the vector to transform
  2422. * @param transformation defines the matrix to apply
  2423. * @returns a new Vector2
  2424. */
  2425. static Transform(vector: DeepImmutable<Vector2>, transformation: DeepImmutable<Matrix>): Vector2;
  2426. /**
  2427. * Transforms the given vector coordinates by the given transformation matrix and stores the result in the vector "result" coordinates
  2428. * @param vector defines the vector to transform
  2429. * @param transformation defines the matrix to apply
  2430. * @param result defines the target vector
  2431. */
  2432. static TransformToRef(vector: DeepImmutable<Vector2>, transformation: DeepImmutable<Matrix>, result: Vector2): void;
  2433. /**
  2434. * Determines if a given vector is included in a triangle
  2435. * @param p defines the vector to test
  2436. * @param p0 defines 1st triangle point
  2437. * @param p1 defines 2nd triangle point
  2438. * @param p2 defines 3rd triangle point
  2439. * @returns true if the point "p" is in the triangle defined by the vertors "p0", "p1", "p2"
  2440. */
  2441. static PointInTriangle(p: DeepImmutable<Vector2>, p0: DeepImmutable<Vector2>, p1: DeepImmutable<Vector2>, p2: DeepImmutable<Vector2>): boolean;
  2442. /**
  2443. * Gets the distance between the vectors "value1" and "value2"
  2444. * @param value1 defines first vector
  2445. * @param value2 defines second vector
  2446. * @returns the distance between vectors
  2447. */
  2448. static Distance(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): number;
  2449. /**
  2450. * Returns the squared distance between the vectors "value1" and "value2"
  2451. * @param value1 defines first vector
  2452. * @param value2 defines second vector
  2453. * @returns the squared distance between vectors
  2454. */
  2455. static DistanceSquared(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): number;
  2456. /**
  2457. * Gets a new Vector2 located at the center of the vectors "value1" and "value2"
  2458. * @param value1 defines first vector
  2459. * @param value2 defines second vector
  2460. * @returns a new Vector2
  2461. */
  2462. static Center(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): Vector2;
  2463. /**
  2464. * Gets the shortest distance (float) between the point "p" and the segment defined by the two points "segA" and "segB".
  2465. * @param p defines the middle point
  2466. * @param segA defines one point of the segment
  2467. * @param segB defines the other point of the segment
  2468. * @returns the shortest distance
  2469. */
  2470. static DistanceOfPointFromSegment(p: DeepImmutable<Vector2>, segA: DeepImmutable<Vector2>, segB: DeepImmutable<Vector2>): number;
  2471. }
  2472. /**
  2473. * Class used to store (x,y,z) vector representation
  2474. * A Vector3 is the main object used in 3D geometry
  2475. * It can represent etiher the coordinates of a point the space, either a direction
  2476. * Reminder: js uses a left handed forward facing system
  2477. */
  2478. export class Vector3 {
  2479. private static _UpReadOnly;
  2480. private static _ZeroReadOnly;
  2481. /** @hidden */
  2482. _x: number;
  2483. /** @hidden */
  2484. _y: number;
  2485. /** @hidden */
  2486. _z: number;
  2487. /** @hidden */
  2488. _isDirty: boolean;
  2489. /** Gets or sets the x coordinate */
  2490. get x(): number;
  2491. set x(value: number);
  2492. /** Gets or sets the y coordinate */
  2493. get y(): number;
  2494. set y(value: number);
  2495. /** Gets or sets the z coordinate */
  2496. get z(): number;
  2497. set z(value: number);
  2498. /**
  2499. * Creates a new Vector3 object from the given x, y, z (floats) coordinates.
  2500. * @param x defines the first coordinates (on X axis)
  2501. * @param y defines the second coordinates (on Y axis)
  2502. * @param z defines the third coordinates (on Z axis)
  2503. */
  2504. constructor(x?: number, y?: number, z?: number);
  2505. /**
  2506. * Creates a string representation of the Vector3
  2507. * @returns a string with the Vector3 coordinates.
  2508. */
  2509. toString(): string;
  2510. /**
  2511. * Gets the class name
  2512. * @returns the string "Vector3"
  2513. */
  2514. getClassName(): string;
  2515. /**
  2516. * Creates the Vector3 hash code
  2517. * @returns a number which tends to be unique between Vector3 instances
  2518. */
  2519. getHashCode(): number;
  2520. /**
  2521. * Creates an array containing three elements : the coordinates of the Vector3
  2522. * @returns a new array of numbers
  2523. */
  2524. asArray(): number[];
  2525. /**
  2526. * Populates the given array or Float32Array from the given index with the successive coordinates of the Vector3
  2527. * @param array defines the destination array
  2528. * @param index defines the offset in the destination array
  2529. * @returns the current Vector3
  2530. */
  2531. toArray(array: FloatArray, index?: number): Vector3;
  2532. /**
  2533. * Converts the current Vector3 into a quaternion (considering that the Vector3 contains Euler angles representation of a rotation)
  2534. * @returns a new Quaternion object, computed from the Vector3 coordinates
  2535. */
  2536. toQuaternion(): Quaternion;
  2537. /**
  2538. * Adds the given vector to the current Vector3
  2539. * @param otherVector defines the second operand
  2540. * @returns the current updated Vector3
  2541. */
  2542. addInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  2543. /**
  2544. * Adds the given coordinates to the current Vector3
  2545. * @param x defines the x coordinate of the operand
  2546. * @param y defines the y coordinate of the operand
  2547. * @param z defines the z coordinate of the operand
  2548. * @returns the current updated Vector3
  2549. */
  2550. addInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  2551. /**
  2552. * Gets a new Vector3, result of the addition the current Vector3 and the given vector
  2553. * @param otherVector defines the second operand
  2554. * @returns the resulting Vector3
  2555. */
  2556. add(otherVector: DeepImmutable<Vector3>): Vector3;
  2557. /**
  2558. * Adds the current Vector3 to the given one and stores the result in the vector "result"
  2559. * @param otherVector defines the second operand
  2560. * @param result defines the Vector3 object where to store the result
  2561. * @returns the current Vector3
  2562. */
  2563. addToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  2564. /**
  2565. * Subtract the given vector from the current Vector3
  2566. * @param otherVector defines the second operand
  2567. * @returns the current updated Vector3
  2568. */
  2569. subtractInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  2570. /**
  2571. * Returns a new Vector3, result of the subtraction of the given vector from the current Vector3
  2572. * @param otherVector defines the second operand
  2573. * @returns the resulting Vector3
  2574. */
  2575. subtract(otherVector: DeepImmutable<Vector3>): Vector3;
  2576. /**
  2577. * Subtracts the given vector from the current Vector3 and stores the result in the vector "result".
  2578. * @param otherVector defines the second operand
  2579. * @param result defines the Vector3 object where to store the result
  2580. * @returns the current Vector3
  2581. */
  2582. subtractToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  2583. /**
  2584. * Returns a new Vector3 set with the subtraction of the given floats from the current Vector3 coordinates
  2585. * @param x defines the x coordinate of the operand
  2586. * @param y defines the y coordinate of the operand
  2587. * @param z defines the z coordinate of the operand
  2588. * @returns the resulting Vector3
  2589. */
  2590. subtractFromFloats(x: number, y: number, z: number): Vector3;
  2591. /**
  2592. * Subtracts the given floats from the current Vector3 coordinates and set the given vector "result" with this result
  2593. * @param x defines the x coordinate of the operand
  2594. * @param y defines the y coordinate of the operand
  2595. * @param z defines the z coordinate of the operand
  2596. * @param result defines the Vector3 object where to store the result
  2597. * @returns the current Vector3
  2598. */
  2599. subtractFromFloatsToRef(x: number, y: number, z: number, result: Vector3): Vector3;
  2600. /**
  2601. * Gets a new Vector3 set with the current Vector3 negated coordinates
  2602. * @returns a new Vector3
  2603. */
  2604. negate(): Vector3;
  2605. /**
  2606. * Negate this vector in place
  2607. * @returns this
  2608. */
  2609. negateInPlace(): Vector3;
  2610. /**
  2611. * Negate the current Vector3 and stores the result in the given vector "result" coordinates
  2612. * @param result defines the Vector3 object where to store the result
  2613. * @returns the current Vector3
  2614. */
  2615. negateToRef(result: Vector3): Vector3;
  2616. /**
  2617. * Multiplies the Vector3 coordinates by the float "scale"
  2618. * @param scale defines the multiplier factor
  2619. * @returns the current updated Vector3
  2620. */
  2621. scaleInPlace(scale: number): Vector3;
  2622. /**
  2623. * Returns a new Vector3 set with the current Vector3 coordinates multiplied by the float "scale"
  2624. * @param scale defines the multiplier factor
  2625. * @returns a new Vector3
  2626. */
  2627. scale(scale: number): Vector3;
  2628. /**
  2629. * Multiplies the current Vector3 coordinates by the float "scale" and stores the result in the given vector "result" coordinates
  2630. * @param scale defines the multiplier factor
  2631. * @param result defines the Vector3 object where to store the result
  2632. * @returns the current Vector3
  2633. */
  2634. scaleToRef(scale: number, result: Vector3): Vector3;
  2635. /**
  2636. * Scale the current Vector3 values by a factor and add the result to a given Vector3
  2637. * @param scale defines the scale factor
  2638. * @param result defines the Vector3 object where to store the result
  2639. * @returns the unmodified current Vector3
  2640. */
  2641. scaleAndAddToRef(scale: number, result: Vector3): Vector3;
  2642. /**
  2643. * Projects the current vector3 to a plane along a ray starting from a specified origin and directed towards the point.
  2644. * @param origin defines the origin of the projection ray
  2645. * @param plane defines the plane to project to
  2646. * @returns the projected vector3
  2647. */
  2648. projectOnPlane(plane: Plane, origin: Vector3): Vector3;
  2649. /**
  2650. * Projects the current vector3 to a plane along a ray starting from a specified origin and directed towards the point.
  2651. * @param origin defines the origin of the projection ray
  2652. * @param plane defines the plane to project to
  2653. * @param result defines the Vector3 where to store the result
  2654. */
  2655. projectOnPlaneToRef(plane: Plane, origin: Vector3, result: Vector3): void;
  2656. /**
  2657. * Returns true if the current Vector3 and the given vector coordinates are strictly equal
  2658. * @param otherVector defines the second operand
  2659. * @returns true if both vectors are equals
  2660. */
  2661. equals(otherVector: DeepImmutable<Vector3>): boolean;
  2662. /**
  2663. * Returns true if the current Vector3 and the given vector coordinates are distant less than epsilon
  2664. * @param otherVector defines the second operand
  2665. * @param epsilon defines the minimal distance to define values as equals
  2666. * @returns true if both vectors are distant less than epsilon
  2667. */
  2668. equalsWithEpsilon(otherVector: DeepImmutable<Vector3>, epsilon?: number): boolean;
  2669. /**
  2670. * Returns true if the current Vector3 coordinates equals the given floats
  2671. * @param x defines the x coordinate of the operand
  2672. * @param y defines the y coordinate of the operand
  2673. * @param z defines the z coordinate of the operand
  2674. * @returns true if both vectors are equals
  2675. */
  2676. equalsToFloats(x: number, y: number, z: number): boolean;
  2677. /**
  2678. * Multiplies the current Vector3 coordinates by the given ones
  2679. * @param otherVector defines the second operand
  2680. * @returns the current updated Vector3
  2681. */
  2682. multiplyInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  2683. /**
  2684. * Returns a new Vector3, result of the multiplication of the current Vector3 by the given vector
  2685. * @param otherVector defines the second operand
  2686. * @returns the new Vector3
  2687. */
  2688. multiply(otherVector: DeepImmutable<Vector3>): Vector3;
  2689. /**
  2690. * Multiplies the current Vector3 by the given one and stores the result in the given vector "result"
  2691. * @param otherVector defines the second operand
  2692. * @param result defines the Vector3 object where to store the result
  2693. * @returns the current Vector3
  2694. */
  2695. multiplyToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  2696. /**
  2697. * Returns a new Vector3 set with the result of the mulliplication of the current Vector3 coordinates by the given floats
  2698. * @param x defines the x coordinate of the operand
  2699. * @param y defines the y coordinate of the operand
  2700. * @param z defines the z coordinate of the operand
  2701. * @returns the new Vector3
  2702. */
  2703. multiplyByFloats(x: number, y: number, z: number): Vector3;
  2704. /**
  2705. * Returns a new Vector3 set with the result of the division of the current Vector3 coordinates by the given ones
  2706. * @param otherVector defines the second operand
  2707. * @returns the new Vector3
  2708. */
  2709. divide(otherVector: DeepImmutable<Vector3>): Vector3;
  2710. /**
  2711. * Divides the current Vector3 coordinates by the given ones and stores the result in the given vector "result"
  2712. * @param otherVector defines the second operand
  2713. * @param result defines the Vector3 object where to store the result
  2714. * @returns the current Vector3
  2715. */
  2716. divideToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  2717. /**
  2718. * Divides the current Vector3 coordinates by the given ones.
  2719. * @param otherVector defines the second operand
  2720. * @returns the current updated Vector3
  2721. */
  2722. divideInPlace(otherVector: Vector3): Vector3;
  2723. /**
  2724. * Updates the current Vector3 with the minimal coordinate values between its and the given vector ones
  2725. * @param other defines the second operand
  2726. * @returns the current updated Vector3
  2727. */
  2728. minimizeInPlace(other: DeepImmutable<Vector3>): Vector3;
  2729. /**
  2730. * Updates the current Vector3 with the maximal coordinate values between its and the given vector ones.
  2731. * @param other defines the second operand
  2732. * @returns the current updated Vector3
  2733. */
  2734. maximizeInPlace(other: DeepImmutable<Vector3>): Vector3;
  2735. /**
  2736. * Updates the current Vector3 with the minimal coordinate values between its and the given coordinates
  2737. * @param x defines the x coordinate of the operand
  2738. * @param y defines the y coordinate of the operand
  2739. * @param z defines the z coordinate of the operand
  2740. * @returns the current updated Vector3
  2741. */
  2742. minimizeInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  2743. /**
  2744. * Updates the current Vector3 with the maximal coordinate values between its and the given coordinates.
  2745. * @param x defines the x coordinate of the operand
  2746. * @param y defines the y coordinate of the operand
  2747. * @param z defines the z coordinate of the operand
  2748. * @returns the current updated Vector3
  2749. */
  2750. maximizeInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  2751. /**
  2752. * Due to float precision, scale of a mesh could be uniform but float values are off by a small fraction
  2753. * Check if is non uniform within a certain amount of decimal places to account for this
  2754. * @param epsilon the amount the values can differ
  2755. * @returns if the the vector is non uniform to a certain number of decimal places
  2756. */
  2757. isNonUniformWithinEpsilon(epsilon: number): boolean;
  2758. /**
  2759. * Gets a boolean indicating that the vector is non uniform meaning x, y or z are not all the same
  2760. */
  2761. get isNonUniform(): boolean;
  2762. /**
  2763. * Gets a new Vector3 from current Vector3 floored values
  2764. * @returns a new Vector3
  2765. */
  2766. floor(): Vector3;
  2767. /**
  2768. * Gets a new Vector3 from current Vector3 floored values
  2769. * @returns a new Vector3
  2770. */
  2771. fract(): Vector3;
  2772. /**
  2773. * Gets the length of the Vector3
  2774. * @returns the length of the Vector3
  2775. */
  2776. length(): number;
  2777. /**
  2778. * Gets the squared length of the Vector3
  2779. * @returns squared length of the Vector3
  2780. */
  2781. lengthSquared(): number;
  2782. /**
  2783. * Normalize the current Vector3.
  2784. * Please note that this is an in place operation.
  2785. * @returns the current updated Vector3
  2786. */
  2787. normalize(): Vector3;
  2788. /**
  2789. * Reorders the x y z properties of the vector in place
  2790. * @param order new ordering of the properties (eg. for vector 1,2,3 with "ZYX" will produce 3,2,1)
  2791. * @returns the current updated vector
  2792. */
  2793. reorderInPlace(order: string): this;
  2794. /**
  2795. * Rotates the vector around 0,0,0 by a quaternion
  2796. * @param quaternion the rotation quaternion
  2797. * @param result vector to store the result
  2798. * @returns the resulting vector
  2799. */
  2800. rotateByQuaternionToRef(quaternion: Quaternion, result: Vector3): Vector3;
  2801. /**
  2802. * Rotates a vector around a given point
  2803. * @param quaternion the rotation quaternion
  2804. * @param point the point to rotate around
  2805. * @param result vector to store the result
  2806. * @returns the resulting vector
  2807. */
  2808. rotateByQuaternionAroundPointToRef(quaternion: Quaternion, point: Vector3, result: Vector3): Vector3;
  2809. /**
  2810. * Returns a new Vector3 as the cross product of the current vector and the "other" one
  2811. * The cross product is then orthogonal to both current and "other"
  2812. * @param other defines the right operand
  2813. * @returns the cross product
  2814. */
  2815. cross(other: Vector3): Vector3;
  2816. /**
  2817. * Normalize the current Vector3 with the given input length.
  2818. * Please note that this is an in place operation.
  2819. * @param len the length of the vector
  2820. * @returns the current updated Vector3
  2821. */
  2822. normalizeFromLength(len: number): Vector3;
  2823. /**
  2824. * Normalize the current Vector3 to a new vector
  2825. * @returns the new Vector3
  2826. */
  2827. normalizeToNew(): Vector3;
  2828. /**
  2829. * Normalize the current Vector3 to the reference
  2830. * @param reference define the Vector3 to update
  2831. * @returns the updated Vector3
  2832. */
  2833. normalizeToRef(reference: Vector3): Vector3;
  2834. /**
  2835. * Creates a new Vector3 copied from the current Vector3
  2836. * @returns the new Vector3
  2837. */
  2838. clone(): Vector3;
  2839. /**
  2840. * Copies the given vector coordinates to the current Vector3 ones
  2841. * @param source defines the source Vector3
  2842. * @returns the current updated Vector3
  2843. */
  2844. copyFrom(source: DeepImmutable<Vector3>): Vector3;
  2845. /**
  2846. * Copies the given floats to the current Vector3 coordinates
  2847. * @param x defines the x coordinate of the operand
  2848. * @param y defines the y coordinate of the operand
  2849. * @param z defines the z coordinate of the operand
  2850. * @returns the current updated Vector3
  2851. */
  2852. copyFromFloats(x: number, y: number, z: number): Vector3;
  2853. /**
  2854. * Copies the given floats to the current Vector3 coordinates
  2855. * @param x defines the x coordinate of the operand
  2856. * @param y defines the y coordinate of the operand
  2857. * @param z defines the z coordinate of the operand
  2858. * @returns the current updated Vector3
  2859. */
  2860. set(x: number, y: number, z: number): Vector3;
  2861. /**
  2862. * Copies the given float to the current Vector3 coordinates
  2863. * @param v defines the x, y and z coordinates of the operand
  2864. * @returns the current updated Vector3
  2865. */
  2866. setAll(v: number): Vector3;
  2867. /**
  2868. * Get the clip factor between two vectors
  2869. * @param vector0 defines the first operand
  2870. * @param vector1 defines the second operand
  2871. * @param axis defines the axis to use
  2872. * @param size defines the size along the axis
  2873. * @returns the clip factor
  2874. */
  2875. static GetClipFactor(vector0: DeepImmutable<Vector3>, vector1: DeepImmutable<Vector3>, axis: DeepImmutable<Vector3>, size: number): number;
  2876. /**
  2877. * Get angle between two vectors
  2878. * @param vector0 angle between vector0 and vector1
  2879. * @param vector1 angle between vector0 and vector1
  2880. * @param normal direction of the normal
  2881. * @return the angle between vector0 and vector1
  2882. */
  2883. static GetAngleBetweenVectors(vector0: DeepImmutable<Vector3>, vector1: DeepImmutable<Vector3>, normal: DeepImmutable<Vector3>): number;
  2884. /**
  2885. * Returns a new Vector3 set from the index "offset" of the given array
  2886. * @param array defines the source array
  2887. * @param offset defines the offset in the source array
  2888. * @returns the new Vector3
  2889. */
  2890. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector3;
  2891. /**
  2892. * Returns a new Vector3 set from the index "offset" of the given Float32Array
  2893. * @param array defines the source array
  2894. * @param offset defines the offset in the source array
  2895. * @returns the new Vector3
  2896. * @deprecated Please use FromArray instead.
  2897. */
  2898. static FromFloatArray(array: DeepImmutable<Float32Array>, offset?: number): Vector3;
  2899. /**
  2900. * Sets the given vector "result" with the element values from the index "offset" of the given array
  2901. * @param array defines the source array
  2902. * @param offset defines the offset in the source array
  2903. * @param result defines the Vector3 where to store the result
  2904. */
  2905. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector3): void;
  2906. /**
  2907. * Sets the given vector "result" with the element values from the index "offset" of the given Float32Array
  2908. * @param array defines the source array
  2909. * @param offset defines the offset in the source array
  2910. * @param result defines the Vector3 where to store the result
  2911. * @deprecated Please use FromArrayToRef instead.
  2912. */
  2913. static FromFloatArrayToRef(array: DeepImmutable<Float32Array>, offset: number, result: Vector3): void;
  2914. /**
  2915. * Sets the given vector "result" with the given floats.
  2916. * @param x defines the x coordinate of the source
  2917. * @param y defines the y coordinate of the source
  2918. * @param z defines the z coordinate of the source
  2919. * @param result defines the Vector3 where to store the result
  2920. */
  2921. static FromFloatsToRef(x: number, y: number, z: number, result: Vector3): void;
  2922. /**
  2923. * Returns a new Vector3 set to (0.0, 0.0, 0.0)
  2924. * @returns a new empty Vector3
  2925. */
  2926. static Zero(): Vector3;
  2927. /**
  2928. * Returns a new Vector3 set to (1.0, 1.0, 1.0)
  2929. * @returns a new unit Vector3
  2930. */
  2931. static One(): Vector3;
  2932. /**
  2933. * Returns a new Vector3 set to (0.0, 1.0, 0.0)
  2934. * @returns a new up Vector3
  2935. */
  2936. static Up(): Vector3;
  2937. /**
  2938. * Gets a up Vector3 that must not be updated
  2939. */
  2940. static get UpReadOnly(): DeepImmutable<Vector3>;
  2941. /**
  2942. * Gets a zero Vector3 that must not be updated
  2943. */
  2944. static get ZeroReadOnly(): DeepImmutable<Vector3>;
  2945. /**
  2946. * Returns a new Vector3 set to (0.0, -1.0, 0.0)
  2947. * @returns a new down Vector3
  2948. */
  2949. static Down(): Vector3;
  2950. /**
  2951. * Returns a new Vector3 set to (0.0, 0.0, 1.0)
  2952. * @param rightHandedSystem is the scene right-handed (negative z)
  2953. * @returns a new forward Vector3
  2954. */
  2955. static Forward(rightHandedSystem?: boolean): Vector3;
  2956. /**
  2957. * Returns a new Vector3 set to (0.0, 0.0, -1.0)
  2958. * @param rightHandedSystem is the scene right-handed (negative-z)
  2959. * @returns a new forward Vector3
  2960. */
  2961. static Backward(rightHandedSystem?: boolean): Vector3;
  2962. /**
  2963. * Returns a new Vector3 set to (1.0, 0.0, 0.0)
  2964. * @returns a new right Vector3
  2965. */
  2966. static Right(): Vector3;
  2967. /**
  2968. * Returns a new Vector3 set to (-1.0, 0.0, 0.0)
  2969. * @returns a new left Vector3
  2970. */
  2971. static Left(): Vector3;
  2972. /**
  2973. * Returns a new Vector3 set with the result of the transformation by the given matrix of the given vector.
  2974. * This method computes tranformed coordinates only, not transformed direction vectors (ie. it takes translation in account)
  2975. * @param vector defines the Vector3 to transform
  2976. * @param transformation defines the transformation matrix
  2977. * @returns the transformed Vector3
  2978. */
  2979. static TransformCoordinates(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>): Vector3;
  2980. /**
  2981. * Sets the given vector "result" coordinates with the result of the transformation by the given matrix of the given vector
  2982. * This method computes tranformed coordinates only, not transformed direction vectors (ie. it takes translation in account)
  2983. * @param vector defines the Vector3 to transform
  2984. * @param transformation defines the transformation matrix
  2985. * @param result defines the Vector3 where to store the result
  2986. */
  2987. static TransformCoordinatesToRef(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  2988. /**
  2989. * Sets the given vector "result" coordinates with the result of the transformation by the given matrix of the given floats (x, y, z)
  2990. * This method computes tranformed coordinates only, not transformed direction vectors
  2991. * @param x define the x coordinate of the source vector
  2992. * @param y define the y coordinate of the source vector
  2993. * @param z define the z coordinate of the source vector
  2994. * @param transformation defines the transformation matrix
  2995. * @param result defines the Vector3 where to store the result
  2996. */
  2997. static TransformCoordinatesFromFloatsToRef(x: number, y: number, z: number, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  2998. /**
  2999. * Returns a new Vector3 set with the result of the normal transformation by the given matrix of the given vector
  3000. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  3001. * @param vector defines the Vector3 to transform
  3002. * @param transformation defines the transformation matrix
  3003. * @returns the new Vector3
  3004. */
  3005. static TransformNormal(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>): Vector3;
  3006. /**
  3007. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given vector
  3008. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  3009. * @param vector defines the Vector3 to transform
  3010. * @param transformation defines the transformation matrix
  3011. * @param result defines the Vector3 where to store the result
  3012. */
  3013. static TransformNormalToRef(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  3014. /**
  3015. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given floats (x, y, z)
  3016. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  3017. * @param x define the x coordinate of the source vector
  3018. * @param y define the y coordinate of the source vector
  3019. * @param z define the z coordinate of the source vector
  3020. * @param transformation defines the transformation matrix
  3021. * @param result defines the Vector3 where to store the result
  3022. */
  3023. static TransformNormalFromFloatsToRef(x: number, y: number, z: number, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  3024. /**
  3025. * Returns a new Vector3 located for "amount" on the CatmullRom interpolation spline defined by the vectors "value1", "value2", "value3", "value4"
  3026. * @param value1 defines the first control point
  3027. * @param value2 defines the second control point
  3028. * @param value3 defines the third control point
  3029. * @param value4 defines the fourth control point
  3030. * @param amount defines the amount on the spline to use
  3031. * @returns the new Vector3
  3032. */
  3033. static CatmullRom(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>, value3: DeepImmutable<Vector3>, value4: DeepImmutable<Vector3>, amount: number): Vector3;
  3034. /**
  3035. * 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"
  3036. * If a coordinate value of "value" is lower than one of the "min" coordinate, then this "value" coordinate is set with the "min" one
  3037. * If a coordinate value of "value" is greater than one of the "max" coordinate, then this "value" coordinate is set with the "max" one
  3038. * @param value defines the current value
  3039. * @param min defines the lower range value
  3040. * @param max defines the upper range value
  3041. * @returns the new Vector3
  3042. */
  3043. static Clamp(value: DeepImmutable<Vector3>, min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>): Vector3;
  3044. /**
  3045. * 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"
  3046. * If a coordinate value of "value" is lower than one of the "min" coordinate, then this "value" coordinate is set with the "min" one
  3047. * If a coordinate value of "value" is greater than one of the "max" coordinate, then this "value" coordinate is set with the "max" one
  3048. * @param value defines the current value
  3049. * @param min defines the lower range value
  3050. * @param max defines the upper range value
  3051. * @param result defines the Vector3 where to store the result
  3052. */
  3053. static ClampToRef(value: DeepImmutable<Vector3>, min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, result: Vector3): void;
  3054. /**
  3055. * Checks if a given vector is inside a specific range
  3056. * @param v defines the vector to test
  3057. * @param min defines the minimum range
  3058. * @param max defines the maximum range
  3059. */
  3060. static CheckExtends(v: Vector3, min: Vector3, max: Vector3): void;
  3061. /**
  3062. * Returns a new Vector3 located for "amount" (float) on the Hermite interpolation spline defined by the vectors "value1", "tangent1", "value2", "tangent2"
  3063. * @param value1 defines the first control point
  3064. * @param tangent1 defines the first tangent vector
  3065. * @param value2 defines the second control point
  3066. * @param tangent2 defines the second tangent vector
  3067. * @param amount defines the amount on the interpolation spline (between 0 and 1)
  3068. * @returns the new Vector3
  3069. */
  3070. static Hermite(value1: DeepImmutable<Vector3>, tangent1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>, tangent2: DeepImmutable<Vector3>, amount: number): Vector3;
  3071. /**
  3072. * Returns a new Vector3 located for "amount" (float) on the linear interpolation between the vectors "start" and "end"
  3073. * @param start defines the start value
  3074. * @param end defines the end value
  3075. * @param amount max defines amount between both (between 0 and 1)
  3076. * @returns the new Vector3
  3077. */
  3078. static Lerp(start: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, amount: number): Vector3;
  3079. /**
  3080. * Sets the given vector "result" with the result of the linear interpolation from the vector "start" for "amount" to the vector "end"
  3081. * @param start defines the start value
  3082. * @param end defines the end value
  3083. * @param amount max defines amount between both (between 0 and 1)
  3084. * @param result defines the Vector3 where to store the result
  3085. */
  3086. static LerpToRef(start: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, amount: number, result: Vector3): void;
  3087. /**
  3088. * Returns the dot product (float) between the vectors "left" and "right"
  3089. * @param left defines the left operand
  3090. * @param right defines the right operand
  3091. * @returns the dot product
  3092. */
  3093. static Dot(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): number;
  3094. /**
  3095. * Returns a new Vector3 as the cross product of the vectors "left" and "right"
  3096. * The cross product is then orthogonal to both "left" and "right"
  3097. * @param left defines the left operand
  3098. * @param right defines the right operand
  3099. * @returns the cross product
  3100. */
  3101. static Cross(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  3102. /**
  3103. * Sets the given vector "result" with the cross product of "left" and "right"
  3104. * The cross product is then orthogonal to both "left" and "right"
  3105. * @param left defines the left operand
  3106. * @param right defines the right operand
  3107. * @param result defines the Vector3 where to store the result
  3108. */
  3109. static CrossToRef(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>, result: Vector3): void;
  3110. /**
  3111. * Returns a new Vector3 as the normalization of the given vector
  3112. * @param vector defines the Vector3 to normalize
  3113. * @returns the new Vector3
  3114. */
  3115. static Normalize(vector: DeepImmutable<Vector3>): Vector3;
  3116. /**
  3117. * Sets the given vector "result" with the normalization of the given first vector
  3118. * @param vector defines the Vector3 to normalize
  3119. * @param result defines the Vector3 where to store the result
  3120. */
  3121. static NormalizeToRef(vector: DeepImmutable<Vector3>, result: Vector3): void;
  3122. /**
  3123. * Project a Vector3 onto screen space
  3124. * @param vector defines the Vector3 to project
  3125. * @param world defines the world matrix to use
  3126. * @param transform defines the transform (view x projection) matrix to use
  3127. * @param viewport defines the screen viewport to use
  3128. * @returns the new Vector3
  3129. */
  3130. static Project(vector: DeepImmutable<Vector3>, world: DeepImmutable<Matrix>, transform: DeepImmutable<Matrix>, viewport: DeepImmutable<Viewport>): Vector3;
  3131. /** @hidden */
  3132. static _UnprojectFromInvertedMatrixToRef(source: DeepImmutable<Vector3>, matrix: DeepImmutable<Matrix>, result: Vector3): void;
  3133. /**
  3134. * Unproject from screen space to object space
  3135. * @param source defines the screen space Vector3 to use
  3136. * @param viewportWidth defines the current width of the viewport
  3137. * @param viewportHeight defines the current height of the viewport
  3138. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  3139. * @param transform defines the transform (view x projection) matrix to use
  3140. * @returns the new Vector3
  3141. */
  3142. static UnprojectFromTransform(source: Vector3, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, transform: DeepImmutable<Matrix>): Vector3;
  3143. /**
  3144. * Unproject from screen space to object space
  3145. * @param source defines the screen space Vector3 to use
  3146. * @param viewportWidth defines the current width of the viewport
  3147. * @param viewportHeight defines the current height of the viewport
  3148. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  3149. * @param view defines the view matrix to use
  3150. * @param projection defines the projection matrix to use
  3151. * @returns the new Vector3
  3152. */
  3153. static Unproject(source: DeepImmutable<Vector3>, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Vector3;
  3154. /**
  3155. * Unproject from screen space to object space
  3156. * @param source defines the screen space Vector3 to use
  3157. * @param viewportWidth defines the current width of the viewport
  3158. * @param viewportHeight defines the current height of the viewport
  3159. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  3160. * @param view defines the view matrix to use
  3161. * @param projection defines the projection matrix to use
  3162. * @param result defines the Vector3 where to store the result
  3163. */
  3164. static UnprojectToRef(source: DeepImmutable<Vector3>, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, result: Vector3): void;
  3165. /**
  3166. * Unproject from screen space to object space
  3167. * @param sourceX defines the screen space x coordinate to use
  3168. * @param sourceY defines the screen space y coordinate to use
  3169. * @param sourceZ defines the screen space z coordinate to use
  3170. * @param viewportWidth defines the current width of the viewport
  3171. * @param viewportHeight defines the current height of the viewport
  3172. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  3173. * @param view defines the view matrix to use
  3174. * @param projection defines the projection matrix to use
  3175. * @param result defines the Vector3 where to store the result
  3176. */
  3177. static UnprojectFloatsToRef(sourceX: float, sourceY: float, sourceZ: float, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, result: Vector3): void;
  3178. /**
  3179. * Gets the minimal coordinate values between two Vector3
  3180. * @param left defines the first operand
  3181. * @param right defines the second operand
  3182. * @returns the new Vector3
  3183. */
  3184. static Minimize(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  3185. /**
  3186. * Gets the maximal coordinate values between two Vector3
  3187. * @param left defines the first operand
  3188. * @param right defines the second operand
  3189. * @returns the new Vector3
  3190. */
  3191. static Maximize(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  3192. /**
  3193. * Returns the distance between the vectors "value1" and "value2"
  3194. * @param value1 defines the first operand
  3195. * @param value2 defines the second operand
  3196. * @returns the distance
  3197. */
  3198. static Distance(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): number;
  3199. /**
  3200. * Returns the squared distance between the vectors "value1" and "value2"
  3201. * @param value1 defines the first operand
  3202. * @param value2 defines the second operand
  3203. * @returns the squared distance
  3204. */
  3205. static DistanceSquared(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): number;
  3206. /**
  3207. * Returns a new Vector3 located at the center between "value1" and "value2"
  3208. * @param value1 defines the first operand
  3209. * @param value2 defines the second operand
  3210. * @returns the new Vector3
  3211. */
  3212. static Center(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): Vector3;
  3213. /**
  3214. * Given three orthogonal normalized left-handed oriented Vector3 axis in space (target system),
  3215. * RotationFromAxis() returns the rotation Euler angles (ex : rotation.x, rotation.y, rotation.z) to apply
  3216. * to something in order to rotate it from its local system to the given target system
  3217. * Note: axis1, axis2 and axis3 are normalized during this operation
  3218. * @param axis1 defines the first axis
  3219. * @param axis2 defines the second axis
  3220. * @param axis3 defines the third axis
  3221. * @returns a new Vector3
  3222. */
  3223. static RotationFromAxis(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>): Vector3;
  3224. /**
  3225. * The same than RotationFromAxis but updates the given ref Vector3 parameter instead of returning a new Vector3
  3226. * @param axis1 defines the first axis
  3227. * @param axis2 defines the second axis
  3228. * @param axis3 defines the third axis
  3229. * @param ref defines the Vector3 where to store the result
  3230. */
  3231. static RotationFromAxisToRef(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>, ref: Vector3): void;
  3232. }
  3233. /**
  3234. * Vector4 class created for EulerAngle class conversion to Quaternion
  3235. */
  3236. export class Vector4 {
  3237. /** x value of the vector */
  3238. x: number;
  3239. /** y value of the vector */
  3240. y: number;
  3241. /** z value of the vector */
  3242. z: number;
  3243. /** w value of the vector */
  3244. w: number;
  3245. /**
  3246. * Creates a Vector4 object from the given floats.
  3247. * @param x x value of the vector
  3248. * @param y y value of the vector
  3249. * @param z z value of the vector
  3250. * @param w w value of the vector
  3251. */
  3252. constructor(
  3253. /** x value of the vector */
  3254. x: number,
  3255. /** y value of the vector */
  3256. y: number,
  3257. /** z value of the vector */
  3258. z: number,
  3259. /** w value of the vector */
  3260. w: number);
  3261. /**
  3262. * Returns the string with the Vector4 coordinates.
  3263. * @returns a string containing all the vector values
  3264. */
  3265. toString(): string;
  3266. /**
  3267. * Returns the string "Vector4".
  3268. * @returns "Vector4"
  3269. */
  3270. getClassName(): string;
  3271. /**
  3272. * Returns the Vector4 hash code.
  3273. * @returns a unique hash code
  3274. */
  3275. getHashCode(): number;
  3276. /**
  3277. * Returns a new array populated with 4 elements : the Vector4 coordinates.
  3278. * @returns the resulting array
  3279. */
  3280. asArray(): number[];
  3281. /**
  3282. * Populates the given array from the given index with the Vector4 coordinates.
  3283. * @param array array to populate
  3284. * @param index index of the array to start at (default: 0)
  3285. * @returns the Vector4.
  3286. */
  3287. toArray(array: FloatArray, index?: number): Vector4;
  3288. /**
  3289. * Adds the given vector to the current Vector4.
  3290. * @param otherVector the vector to add
  3291. * @returns the updated Vector4.
  3292. */
  3293. addInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  3294. /**
  3295. * Returns a new Vector4 as the result of the addition of the current Vector4 and the given one.
  3296. * @param otherVector the vector to add
  3297. * @returns the resulting vector
  3298. */
  3299. add(otherVector: DeepImmutable<Vector4>): Vector4;
  3300. /**
  3301. * Updates the given vector "result" with the result of the addition of the current Vector4 and the given one.
  3302. * @param otherVector the vector to add
  3303. * @param result the vector to store the result
  3304. * @returns the current Vector4.
  3305. */
  3306. addToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  3307. /**
  3308. * Subtract in place the given vector from the current Vector4.
  3309. * @param otherVector the vector to subtract
  3310. * @returns the updated Vector4.
  3311. */
  3312. subtractInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  3313. /**
  3314. * Returns a new Vector4 with the result of the subtraction of the given vector from the current Vector4.
  3315. * @param otherVector the vector to add
  3316. * @returns the new vector with the result
  3317. */
  3318. subtract(otherVector: DeepImmutable<Vector4>): Vector4;
  3319. /**
  3320. * Sets the given vector "result" with the result of the subtraction of the given vector from the current Vector4.
  3321. * @param otherVector the vector to subtract
  3322. * @param result the vector to store the result
  3323. * @returns the current Vector4.
  3324. */
  3325. subtractToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  3326. /**
  3327. * Returns a new Vector4 set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  3328. */
  3329. /**
  3330. * Returns a new Vector4 set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  3331. * @param x value to subtract
  3332. * @param y value to subtract
  3333. * @param z value to subtract
  3334. * @param w value to subtract
  3335. * @returns new vector containing the result
  3336. */
  3337. subtractFromFloats(x: number, y: number, z: number, w: number): Vector4;
  3338. /**
  3339. * Sets the given vector "result" set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  3340. * @param x value to subtract
  3341. * @param y value to subtract
  3342. * @param z value to subtract
  3343. * @param w value to subtract
  3344. * @param result the vector to store the result in
  3345. * @returns the current Vector4.
  3346. */
  3347. subtractFromFloatsToRef(x: number, y: number, z: number, w: number, result: Vector4): Vector4;
  3348. /**
  3349. * Returns a new Vector4 set with the current Vector4 negated coordinates.
  3350. * @returns a new vector with the negated values
  3351. */
  3352. negate(): Vector4;
  3353. /**
  3354. * Negate this vector in place
  3355. * @returns this
  3356. */
  3357. negateInPlace(): Vector4;
  3358. /**
  3359. * Negate the current Vector4 and stores the result in the given vector "result" coordinates
  3360. * @param result defines the Vector3 object where to store the result
  3361. * @returns the current Vector4
  3362. */
  3363. negateToRef(result: Vector4): Vector4;
  3364. /**
  3365. * Multiplies the current Vector4 coordinates by scale (float).
  3366. * @param scale the number to scale with
  3367. * @returns the updated Vector4.
  3368. */
  3369. scaleInPlace(scale: number): Vector4;
  3370. /**
  3371. * Returns a new Vector4 set with the current Vector4 coordinates multiplied by scale (float).
  3372. * @param scale the number to scale with
  3373. * @returns a new vector with the result
  3374. */
  3375. scale(scale: number): Vector4;
  3376. /**
  3377. * Sets the given vector "result" with the current Vector4 coordinates multiplied by scale (float).
  3378. * @param scale the number to scale with
  3379. * @param result a vector to store the result in
  3380. * @returns the current Vector4.
  3381. */
  3382. scaleToRef(scale: number, result: Vector4): Vector4;
  3383. /**
  3384. * Scale the current Vector4 values by a factor and add the result to a given Vector4
  3385. * @param scale defines the scale factor
  3386. * @param result defines the Vector4 object where to store the result
  3387. * @returns the unmodified current Vector4
  3388. */
  3389. scaleAndAddToRef(scale: number, result: Vector4): Vector4;
  3390. /**
  3391. * Boolean : True if the current Vector4 coordinates are stricly equal to the given ones.
  3392. * @param otherVector the vector to compare against
  3393. * @returns true if they are equal
  3394. */
  3395. equals(otherVector: DeepImmutable<Vector4>): boolean;
  3396. /**
  3397. * Boolean : True if the current Vector4 coordinates are each beneath the distance "epsilon" from the given vector ones.
  3398. * @param otherVector vector to compare against
  3399. * @param epsilon (Default: very small number)
  3400. * @returns true if they are equal
  3401. */
  3402. equalsWithEpsilon(otherVector: DeepImmutable<Vector4>, epsilon?: number): boolean;
  3403. /**
  3404. * Boolean : True if the given floats are strictly equal to the current Vector4 coordinates.
  3405. * @param x x value to compare against
  3406. * @param y y value to compare against
  3407. * @param z z value to compare against
  3408. * @param w w value to compare against
  3409. * @returns true if equal
  3410. */
  3411. equalsToFloats(x: number, y: number, z: number, w: number): boolean;
  3412. /**
  3413. * Multiplies in place the current Vector4 by the given one.
  3414. * @param otherVector vector to multiple with
  3415. * @returns the updated Vector4.
  3416. */
  3417. multiplyInPlace(otherVector: Vector4): Vector4;
  3418. /**
  3419. * Returns a new Vector4 set with the multiplication result of the current Vector4 and the given one.
  3420. * @param otherVector vector to multiple with
  3421. * @returns resulting new vector
  3422. */
  3423. multiply(otherVector: DeepImmutable<Vector4>): Vector4;
  3424. /**
  3425. * Updates the given vector "result" with the multiplication result of the current Vector4 and the given one.
  3426. * @param otherVector vector to multiple with
  3427. * @param result vector to store the result
  3428. * @returns the current Vector4.
  3429. */
  3430. multiplyToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  3431. /**
  3432. * Returns a new Vector4 set with the multiplication result of the given floats and the current Vector4 coordinates.
  3433. * @param x x value multiply with
  3434. * @param y y value multiply with
  3435. * @param z z value multiply with
  3436. * @param w w value multiply with
  3437. * @returns resulting new vector
  3438. */
  3439. multiplyByFloats(x: number, y: number, z: number, w: number): Vector4;
  3440. /**
  3441. * Returns a new Vector4 set with the division result of the current Vector4 by the given one.
  3442. * @param otherVector vector to devide with
  3443. * @returns resulting new vector
  3444. */
  3445. divide(otherVector: DeepImmutable<Vector4>): Vector4;
  3446. /**
  3447. * Updates the given vector "result" with the division result of the current Vector4 by the given one.
  3448. * @param otherVector vector to devide with
  3449. * @param result vector to store the result
  3450. * @returns the current Vector4.
  3451. */
  3452. divideToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  3453. /**
  3454. * Divides the current Vector3 coordinates by the given ones.
  3455. * @param otherVector vector to devide with
  3456. * @returns the updated Vector3.
  3457. */
  3458. divideInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  3459. /**
  3460. * Updates the Vector4 coordinates with the minimum values between its own and the given vector ones
  3461. * @param other defines the second operand
  3462. * @returns the current updated Vector4
  3463. */
  3464. minimizeInPlace(other: DeepImmutable<Vector4>): Vector4;
  3465. /**
  3466. * Updates the Vector4 coordinates with the maximum values between its own and the given vector ones
  3467. * @param other defines the second operand
  3468. * @returns the current updated Vector4
  3469. */
  3470. maximizeInPlace(other: DeepImmutable<Vector4>): Vector4;
  3471. /**
  3472. * Gets a new Vector4 from current Vector4 floored values
  3473. * @returns a new Vector4
  3474. */
  3475. floor(): Vector4;
  3476. /**
  3477. * Gets a new Vector4 from current Vector3 floored values
  3478. * @returns a new Vector4
  3479. */
  3480. fract(): Vector4;
  3481. /**
  3482. * Returns the Vector4 length (float).
  3483. * @returns the length
  3484. */
  3485. length(): number;
  3486. /**
  3487. * Returns the Vector4 squared length (float).
  3488. * @returns the length squared
  3489. */
  3490. lengthSquared(): number;
  3491. /**
  3492. * Normalizes in place the Vector4.
  3493. * @returns the updated Vector4.
  3494. */
  3495. normalize(): Vector4;
  3496. /**
  3497. * Returns a new Vector3 from the Vector4 (x, y, z) coordinates.
  3498. * @returns this converted to a new vector3
  3499. */
  3500. toVector3(): Vector3;
  3501. /**
  3502. * Returns a new Vector4 copied from the current one.
  3503. * @returns the new cloned vector
  3504. */
  3505. clone(): Vector4;
  3506. /**
  3507. * Updates the current Vector4 with the given one coordinates.
  3508. * @param source the source vector to copy from
  3509. * @returns the updated Vector4.
  3510. */
  3511. copyFrom(source: DeepImmutable<Vector4>): Vector4;
  3512. /**
  3513. * Updates the current Vector4 coordinates with the given floats.
  3514. * @param x float to copy from
  3515. * @param y float to copy from
  3516. * @param z float to copy from
  3517. * @param w float to copy from
  3518. * @returns the updated Vector4.
  3519. */
  3520. copyFromFloats(x: number, y: number, z: number, w: number): Vector4;
  3521. /**
  3522. * Updates the current Vector4 coordinates with the given floats.
  3523. * @param x float to set from
  3524. * @param y float to set from
  3525. * @param z float to set from
  3526. * @param w float to set from
  3527. * @returns the updated Vector4.
  3528. */
  3529. set(x: number, y: number, z: number, w: number): Vector4;
  3530. /**
  3531. * Copies the given float to the current Vector3 coordinates
  3532. * @param v defines the x, y, z and w coordinates of the operand
  3533. * @returns the current updated Vector3
  3534. */
  3535. setAll(v: number): Vector4;
  3536. /**
  3537. * Returns a new Vector4 set from the starting index of the given array.
  3538. * @param array the array to pull values from
  3539. * @param offset the offset into the array to start at
  3540. * @returns the new vector
  3541. */
  3542. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector4;
  3543. /**
  3544. * Updates the given vector "result" from the starting index of the given array.
  3545. * @param array the array to pull values from
  3546. * @param offset the offset into the array to start at
  3547. * @param result the vector to store the result in
  3548. */
  3549. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector4): void;
  3550. /**
  3551. * Updates the given vector "result" from the starting index of the given Float32Array.
  3552. * @param array the array to pull values from
  3553. * @param offset the offset into the array to start at
  3554. * @param result the vector to store the result in
  3555. */
  3556. static FromFloatArrayToRef(array: DeepImmutable<Float32Array>, offset: number, result: Vector4): void;
  3557. /**
  3558. * Updates the given vector "result" coordinates from the given floats.
  3559. * @param x float to set from
  3560. * @param y float to set from
  3561. * @param z float to set from
  3562. * @param w float to set from
  3563. * @param result the vector to the floats in
  3564. */
  3565. static FromFloatsToRef(x: number, y: number, z: number, w: number, result: Vector4): void;
  3566. /**
  3567. * Returns a new Vector4 set to (0.0, 0.0, 0.0, 0.0)
  3568. * @returns the new vector
  3569. */
  3570. static Zero(): Vector4;
  3571. /**
  3572. * Returns a new Vector4 set to (1.0, 1.0, 1.0, 1.0)
  3573. * @returns the new vector
  3574. */
  3575. static One(): Vector4;
  3576. /**
  3577. * Returns a new normalized Vector4 from the given one.
  3578. * @param vector the vector to normalize
  3579. * @returns the vector
  3580. */
  3581. static Normalize(vector: DeepImmutable<Vector4>): Vector4;
  3582. /**
  3583. * Updates the given vector "result" from the normalization of the given one.
  3584. * @param vector the vector to normalize
  3585. * @param result the vector to store the result in
  3586. */
  3587. static NormalizeToRef(vector: DeepImmutable<Vector4>, result: Vector4): void;
  3588. /**
  3589. * Returns a vector with the minimum values from the left and right vectors
  3590. * @param left left vector to minimize
  3591. * @param right right vector to minimize
  3592. * @returns a new vector with the minimum of the left and right vector values
  3593. */
  3594. static Minimize(left: DeepImmutable<Vector4>, right: DeepImmutable<Vector4>): Vector4;
  3595. /**
  3596. * Returns a vector with the maximum values from the left and right vectors
  3597. * @param left left vector to maximize
  3598. * @param right right vector to maximize
  3599. * @returns a new vector with the maximum of the left and right vector values
  3600. */
  3601. static Maximize(left: DeepImmutable<Vector4>, right: DeepImmutable<Vector4>): Vector4;
  3602. /**
  3603. * Returns the distance (float) between the vectors "value1" and "value2".
  3604. * @param value1 value to calulate the distance between
  3605. * @param value2 value to calulate the distance between
  3606. * @return the distance between the two vectors
  3607. */
  3608. static Distance(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): number;
  3609. /**
  3610. * Returns the squared distance (float) between the vectors "value1" and "value2".
  3611. * @param value1 value to calulate the distance between
  3612. * @param value2 value to calulate the distance between
  3613. * @return the distance between the two vectors squared
  3614. */
  3615. static DistanceSquared(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): number;
  3616. /**
  3617. * Returns a new Vector4 located at the center between the vectors "value1" and "value2".
  3618. * @param value1 value to calulate the center between
  3619. * @param value2 value to calulate the center between
  3620. * @return the center between the two vectors
  3621. */
  3622. static Center(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): Vector4;
  3623. /**
  3624. * Returns a new Vector4 set with the result of the normal transformation by the given matrix of the given vector.
  3625. * This methods computes transformed normalized direction vectors only.
  3626. * @param vector the vector to transform
  3627. * @param transformation the transformation matrix to apply
  3628. * @returns the new vector
  3629. */
  3630. static TransformNormal(vector: DeepImmutable<Vector4>, transformation: DeepImmutable<Matrix>): Vector4;
  3631. /**
  3632. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given vector.
  3633. * This methods computes transformed normalized direction vectors only.
  3634. * @param vector the vector to transform
  3635. * @param transformation the transformation matrix to apply
  3636. * @param result the vector to store the result in
  3637. */
  3638. static TransformNormalToRef(vector: DeepImmutable<Vector4>, transformation: DeepImmutable<Matrix>, result: Vector4): void;
  3639. /**
  3640. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given floats (x, y, z, w).
  3641. * This methods computes transformed normalized direction vectors only.
  3642. * @param x value to transform
  3643. * @param y value to transform
  3644. * @param z value to transform
  3645. * @param w value to transform
  3646. * @param transformation the transformation matrix to apply
  3647. * @param result the vector to store the results in
  3648. */
  3649. static TransformNormalFromFloatsToRef(x: number, y: number, z: number, w: number, transformation: DeepImmutable<Matrix>, result: Vector4): void;
  3650. /**
  3651. * Creates a new Vector4 from a Vector3
  3652. * @param source defines the source data
  3653. * @param w defines the 4th component (default is 0)
  3654. * @returns a new Vector4
  3655. */
  3656. static FromVector3(source: Vector3, w?: number): Vector4;
  3657. }
  3658. /**
  3659. * Class used to store quaternion data
  3660. * @see https://en.wikipedia.org/wiki/Quaternion
  3661. * @see https://doc.babylonjs.com/features/position,_rotation,_scaling
  3662. */
  3663. export class Quaternion {
  3664. /** @hidden */
  3665. _x: number;
  3666. /** @hidden */
  3667. _y: number;
  3668. /** @hidden */
  3669. _z: number;
  3670. /** @hidden */
  3671. _w: number;
  3672. /** @hidden */
  3673. _isDirty: boolean;
  3674. /** Gets or sets the x coordinate */
  3675. get x(): number;
  3676. set x(value: number);
  3677. /** Gets or sets the y coordinate */
  3678. get y(): number;
  3679. set y(value: number);
  3680. /** Gets or sets the z coordinate */
  3681. get z(): number;
  3682. set z(value: number);
  3683. /** Gets or sets the w coordinate */
  3684. get w(): number;
  3685. set w(value: number);
  3686. /**
  3687. * Creates a new Quaternion from the given floats
  3688. * @param x defines the first component (0 by default)
  3689. * @param y defines the second component (0 by default)
  3690. * @param z defines the third component (0 by default)
  3691. * @param w defines the fourth component (1.0 by default)
  3692. */
  3693. constructor(x?: number, y?: number, z?: number, w?: number);
  3694. /**
  3695. * Gets a string representation for the current quaternion
  3696. * @returns a string with the Quaternion coordinates
  3697. */
  3698. toString(): string;
  3699. /**
  3700. * Gets the class name of the quaternion
  3701. * @returns the string "Quaternion"
  3702. */
  3703. getClassName(): string;
  3704. /**
  3705. * Gets a hash code for this quaternion
  3706. * @returns the quaternion hash code
  3707. */
  3708. getHashCode(): number;
  3709. /**
  3710. * Copy the quaternion to an array
  3711. * @returns a new array populated with 4 elements from the quaternion coordinates
  3712. */
  3713. asArray(): number[];
  3714. /**
  3715. * Check if two quaternions are equals
  3716. * @param otherQuaternion defines the second operand
  3717. * @return true if the current quaternion and the given one coordinates are strictly equals
  3718. */
  3719. equals(otherQuaternion: DeepImmutable<Quaternion>): boolean;
  3720. /**
  3721. * Gets a boolean if two quaternions are equals (using an epsilon value)
  3722. * @param otherQuaternion defines the other quaternion
  3723. * @param epsilon defines the minimal distance to consider equality
  3724. * @returns true if the given quaternion coordinates are close to the current ones by a distance of epsilon.
  3725. */
  3726. equalsWithEpsilon(otherQuaternion: DeepImmutable<Quaternion>, epsilon?: number): boolean;
  3727. /**
  3728. * Clone the current quaternion
  3729. * @returns a new quaternion copied from the current one
  3730. */
  3731. clone(): Quaternion;
  3732. /**
  3733. * Copy a quaternion to the current one
  3734. * @param other defines the other quaternion
  3735. * @returns the updated current quaternion
  3736. */
  3737. copyFrom(other: DeepImmutable<Quaternion>): Quaternion;
  3738. /**
  3739. * Updates the current quaternion with the given float coordinates
  3740. * @param x defines the x coordinate
  3741. * @param y defines the y coordinate
  3742. * @param z defines the z coordinate
  3743. * @param w defines the w coordinate
  3744. * @returns the updated current quaternion
  3745. */
  3746. copyFromFloats(x: number, y: number, z: number, w: number): Quaternion;
  3747. /**
  3748. * Updates the current quaternion from the given float coordinates
  3749. * @param x defines the x coordinate
  3750. * @param y defines the y coordinate
  3751. * @param z defines the z coordinate
  3752. * @param w defines the w coordinate
  3753. * @returns the updated current quaternion
  3754. */
  3755. set(x: number, y: number, z: number, w: number): Quaternion;
  3756. /**
  3757. * Adds two quaternions
  3758. * @param other defines the second operand
  3759. * @returns a new quaternion as the addition result of the given one and the current quaternion
  3760. */
  3761. add(other: DeepImmutable<Quaternion>): Quaternion;
  3762. /**
  3763. * Add a quaternion to the current one
  3764. * @param other defines the quaternion to add
  3765. * @returns the current quaternion
  3766. */
  3767. addInPlace(other: DeepImmutable<Quaternion>): Quaternion;
  3768. /**
  3769. * Subtract two quaternions
  3770. * @param other defines the second operand
  3771. * @returns a new quaternion as the subtraction result of the given one from the current one
  3772. */
  3773. subtract(other: Quaternion): Quaternion;
  3774. /**
  3775. * Multiplies the current quaternion by a scale factor
  3776. * @param value defines the scale factor
  3777. * @returns a new quaternion set by multiplying the current quaternion coordinates by the float "scale"
  3778. */
  3779. scale(value: number): Quaternion;
  3780. /**
  3781. * Scale the current quaternion values by a factor and stores the result to a given quaternion
  3782. * @param scale defines the scale factor
  3783. * @param result defines the Quaternion object where to store the result
  3784. * @returns the unmodified current quaternion
  3785. */
  3786. scaleToRef(scale: number, result: Quaternion): Quaternion;
  3787. /**
  3788. * Multiplies in place the current quaternion by a scale factor
  3789. * @param value defines the scale factor
  3790. * @returns the current modified quaternion
  3791. */
  3792. scaleInPlace(value: number): Quaternion;
  3793. /**
  3794. * Scale the current quaternion values by a factor and add the result to a given quaternion
  3795. * @param scale defines the scale factor
  3796. * @param result defines the Quaternion object where to store the result
  3797. * @returns the unmodified current quaternion
  3798. */
  3799. scaleAndAddToRef(scale: number, result: Quaternion): Quaternion;
  3800. /**
  3801. * Multiplies two quaternions
  3802. * @param q1 defines the second operand
  3803. * @returns a new quaternion set as the multiplication result of the current one with the given one "q1"
  3804. */
  3805. multiply(q1: DeepImmutable<Quaternion>): Quaternion;
  3806. /**
  3807. * Sets the given "result" as the the multiplication result of the current one with the given one "q1"
  3808. * @param q1 defines the second operand
  3809. * @param result defines the target quaternion
  3810. * @returns the current quaternion
  3811. */
  3812. multiplyToRef(q1: DeepImmutable<Quaternion>, result: Quaternion): Quaternion;
  3813. /**
  3814. * Updates the current quaternion with the multiplication of itself with the given one "q1"
  3815. * @param q1 defines the second operand
  3816. * @returns the currentupdated quaternion
  3817. */
  3818. multiplyInPlace(q1: DeepImmutable<Quaternion>): Quaternion;
  3819. /**
  3820. * Conjugates (1-q) the current quaternion and stores the result in the given quaternion
  3821. * @param ref defines the target quaternion
  3822. * @returns the current quaternion
  3823. */
  3824. conjugateToRef(ref: Quaternion): Quaternion;
  3825. /**
  3826. * Conjugates in place (1-q) the current quaternion
  3827. * @returns the current updated quaternion
  3828. */
  3829. conjugateInPlace(): Quaternion;
  3830. /**
  3831. * Conjugates in place (1-q) the current quaternion
  3832. * @returns a new quaternion
  3833. */
  3834. conjugate(): Quaternion;
  3835. /**
  3836. * Gets length of current quaternion
  3837. * @returns the quaternion length (float)
  3838. */
  3839. length(): number;
  3840. /**
  3841. * Normalize in place the current quaternion
  3842. * @returns the current updated quaternion
  3843. */
  3844. normalize(): Quaternion;
  3845. /**
  3846. * Returns a new Vector3 set with the Euler angles translated from the current quaternion
  3847. * @param order is a reserved parameter and is ignore for now
  3848. * @returns a new Vector3 containing the Euler angles
  3849. */
  3850. toEulerAngles(order?: string): Vector3;
  3851. /**
  3852. * Sets the given vector3 "result" with the Euler angles translated from the current quaternion
  3853. * @param result defines the vector which will be filled with the Euler angles
  3854. * @param order is a reserved parameter and is ignore for now
  3855. * @returns the current unchanged quaternion
  3856. */
  3857. toEulerAnglesToRef(result: Vector3): Quaternion;
  3858. /**
  3859. * Updates the given rotation matrix with the current quaternion values
  3860. * @param result defines the target matrix
  3861. * @returns the current unchanged quaternion
  3862. */
  3863. toRotationMatrix(result: Matrix): Quaternion;
  3864. /**
  3865. * Updates the current quaternion from the given rotation matrix values
  3866. * @param matrix defines the source matrix
  3867. * @returns the current updated quaternion
  3868. */
  3869. fromRotationMatrix(matrix: DeepImmutable<Matrix>): Quaternion;
  3870. /**
  3871. * Creates a new quaternion from a rotation matrix
  3872. * @param matrix defines the source matrix
  3873. * @returns a new quaternion created from the given rotation matrix values
  3874. */
  3875. static FromRotationMatrix(matrix: DeepImmutable<Matrix>): Quaternion;
  3876. /**
  3877. * Updates the given quaternion with the given rotation matrix values
  3878. * @param matrix defines the source matrix
  3879. * @param result defines the target quaternion
  3880. */
  3881. static FromRotationMatrixToRef(matrix: DeepImmutable<Matrix>, result: Quaternion): void;
  3882. /**
  3883. * Returns the dot product (float) between the quaternions "left" and "right"
  3884. * @param left defines the left operand
  3885. * @param right defines the right operand
  3886. * @returns the dot product
  3887. */
  3888. static Dot(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>): number;
  3889. /**
  3890. * Checks if the two quaternions are close to each other
  3891. * @param quat0 defines the first quaternion to check
  3892. * @param quat1 defines the second quaternion to check
  3893. * @returns true if the two quaternions are close to each other
  3894. */
  3895. static AreClose(quat0: DeepImmutable<Quaternion>, quat1: DeepImmutable<Quaternion>): boolean;
  3896. /**
  3897. * Creates an empty quaternion
  3898. * @returns a new quaternion set to (0.0, 0.0, 0.0)
  3899. */
  3900. static Zero(): Quaternion;
  3901. /**
  3902. * Inverse a given quaternion
  3903. * @param q defines the source quaternion
  3904. * @returns a new quaternion as the inverted current quaternion
  3905. */
  3906. static Inverse(q: DeepImmutable<Quaternion>): Quaternion;
  3907. /**
  3908. * Inverse a given quaternion
  3909. * @param q defines the source quaternion
  3910. * @param result the quaternion the result will be stored in
  3911. * @returns the result quaternion
  3912. */
  3913. static InverseToRef(q: Quaternion, result: Quaternion): Quaternion;
  3914. /**
  3915. * Creates an identity quaternion
  3916. * @returns the identity quaternion
  3917. */
  3918. static Identity(): Quaternion;
  3919. /**
  3920. * Gets a boolean indicating if the given quaternion is identity
  3921. * @param quaternion defines the quaternion to check
  3922. * @returns true if the quaternion is identity
  3923. */
  3924. static IsIdentity(quaternion: DeepImmutable<Quaternion>): boolean;
  3925. /**
  3926. * Creates a quaternion from a rotation around an axis
  3927. * @param axis defines the axis to use
  3928. * @param angle defines the angle to use
  3929. * @returns a new quaternion created from the given axis (Vector3) and angle in radians (float)
  3930. */
  3931. static RotationAxis(axis: DeepImmutable<Vector3>, angle: number): Quaternion;
  3932. /**
  3933. * Creates a rotation around an axis and stores it into the given quaternion
  3934. * @param axis defines the axis to use
  3935. * @param angle defines the angle to use
  3936. * @param result defines the target quaternion
  3937. * @returns the target quaternion
  3938. */
  3939. static RotationAxisToRef(axis: DeepImmutable<Vector3>, angle: number, result: Quaternion): Quaternion;
  3940. /**
  3941. * Creates a new quaternion from data stored into an array
  3942. * @param array defines the data source
  3943. * @param offset defines the offset in the source array where the data starts
  3944. * @returns a new quaternion
  3945. */
  3946. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Quaternion;
  3947. /**
  3948. * Updates the given quaternion "result" from the starting index of the given array.
  3949. * @param array the array to pull values from
  3950. * @param offset the offset into the array to start at
  3951. * @param result the quaternion to store the result in
  3952. */
  3953. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Quaternion): void;
  3954. /**
  3955. * Create a quaternion from Euler rotation angles
  3956. * @param x Pitch
  3957. * @param y Yaw
  3958. * @param z Roll
  3959. * @returns the new Quaternion
  3960. */
  3961. static FromEulerAngles(x: number, y: number, z: number): Quaternion;
  3962. /**
  3963. * Updates a quaternion from Euler rotation angles
  3964. * @param x Pitch
  3965. * @param y Yaw
  3966. * @param z Roll
  3967. * @param result the quaternion to store the result
  3968. * @returns the updated quaternion
  3969. */
  3970. static FromEulerAnglesToRef(x: number, y: number, z: number, result: Quaternion): Quaternion;
  3971. /**
  3972. * Create a quaternion from Euler rotation vector
  3973. * @param vec the Euler vector (x Pitch, y Yaw, z Roll)
  3974. * @returns the new Quaternion
  3975. */
  3976. static FromEulerVector(vec: DeepImmutable<Vector3>): Quaternion;
  3977. /**
  3978. * Updates a quaternion from Euler rotation vector
  3979. * @param vec the Euler vector (x Pitch, y Yaw, z Roll)
  3980. * @param result the quaternion to store the result
  3981. * @returns the updated quaternion
  3982. */
  3983. static FromEulerVectorToRef(vec: DeepImmutable<Vector3>, result: Quaternion): Quaternion;
  3984. /**
  3985. * Creates a new quaternion from the given Euler float angles (y, x, z)
  3986. * @param yaw defines the rotation around Y axis
  3987. * @param pitch defines the rotation around X axis
  3988. * @param roll defines the rotation around Z axis
  3989. * @returns the new quaternion
  3990. */
  3991. static RotationYawPitchRoll(yaw: number, pitch: number, roll: number): Quaternion;
  3992. /**
  3993. * Creates a new rotation from the given Euler float angles (y, x, z) and stores it in the target quaternion
  3994. * @param yaw defines the rotation around Y axis
  3995. * @param pitch defines the rotation around X axis
  3996. * @param roll defines the rotation around Z axis
  3997. * @param result defines the target quaternion
  3998. */
  3999. static RotationYawPitchRollToRef(yaw: number, pitch: number, roll: number, result: Quaternion): void;
  4000. /**
  4001. * Creates a new quaternion from the given Euler float angles expressed in z-x-z orientation
  4002. * @param alpha defines the rotation around first axis
  4003. * @param beta defines the rotation around second axis
  4004. * @param gamma defines the rotation around third axis
  4005. * @returns the new quaternion
  4006. */
  4007. static RotationAlphaBetaGamma(alpha: number, beta: number, gamma: number): Quaternion;
  4008. /**
  4009. * Creates a new quaternion from the given Euler float angles expressed in z-x-z orientation and stores it in the target quaternion
  4010. * @param alpha defines the rotation around first axis
  4011. * @param beta defines the rotation around second axis
  4012. * @param gamma defines the rotation around third axis
  4013. * @param result defines the target quaternion
  4014. */
  4015. static RotationAlphaBetaGammaToRef(alpha: number, beta: number, gamma: number, result: Quaternion): void;
  4016. /**
  4017. * 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)
  4018. * @param axis1 defines the first axis
  4019. * @param axis2 defines the second axis
  4020. * @param axis3 defines the third axis
  4021. * @returns the new quaternion
  4022. */
  4023. static RotationQuaternionFromAxis(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>): Quaternion;
  4024. /**
  4025. * 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
  4026. * @param axis1 defines the first axis
  4027. * @param axis2 defines the second axis
  4028. * @param axis3 defines the third axis
  4029. * @param ref defines the target quaternion
  4030. */
  4031. static RotationQuaternionFromAxisToRef(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>, ref: Quaternion): void;
  4032. /**
  4033. * Interpolates between two quaternions
  4034. * @param left defines first quaternion
  4035. * @param right defines second quaternion
  4036. * @param amount defines the gradient to use
  4037. * @returns the new interpolated quaternion
  4038. */
  4039. static Slerp(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>, amount: number): Quaternion;
  4040. /**
  4041. * Interpolates between two quaternions and stores it into a target quaternion
  4042. * @param left defines first quaternion
  4043. * @param right defines second quaternion
  4044. * @param amount defines the gradient to use
  4045. * @param result defines the target quaternion
  4046. */
  4047. static SlerpToRef(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>, amount: number, result: Quaternion): void;
  4048. /**
  4049. * Interpolate between two quaternions using Hermite interpolation
  4050. * @param value1 defines first quaternion
  4051. * @param tangent1 defines the incoming tangent
  4052. * @param value2 defines second quaternion
  4053. * @param tangent2 defines the outgoing tangent
  4054. * @param amount defines the target quaternion
  4055. * @returns the new interpolated quaternion
  4056. */
  4057. static Hermite(value1: DeepImmutable<Quaternion>, tangent1: DeepImmutable<Quaternion>, value2: DeepImmutable<Quaternion>, tangent2: DeepImmutable<Quaternion>, amount: number): Quaternion;
  4058. }
  4059. /**
  4060. * Class used to store matrix data (4x4)
  4061. */
  4062. export class Matrix {
  4063. /**
  4064. * Gets the precision of matrix computations
  4065. */
  4066. static get Use64Bits(): boolean;
  4067. private static _updateFlagSeed;
  4068. private static _identityReadOnly;
  4069. private _isIdentity;
  4070. private _isIdentityDirty;
  4071. private _isIdentity3x2;
  4072. private _isIdentity3x2Dirty;
  4073. /**
  4074. * Gets the update flag of the matrix which is an unique number for the matrix.
  4075. * It will be incremented every time the matrix data change.
  4076. * You can use it to speed the comparison between two versions of the same matrix.
  4077. */
  4078. updateFlag: number;
  4079. private readonly _m;
  4080. /**
  4081. * Gets the internal data of the matrix
  4082. */
  4083. get m(): DeepImmutable<Float32Array | Array<number>>;
  4084. /** @hidden */
  4085. _markAsUpdated(): void;
  4086. /** @hidden */
  4087. private _updateIdentityStatus;
  4088. /**
  4089. * Creates an empty matrix (filled with zeros)
  4090. */
  4091. constructor();
  4092. /**
  4093. * Check if the current matrix is identity
  4094. * @returns true is the matrix is the identity matrix
  4095. */
  4096. isIdentity(): boolean;
  4097. /**
  4098. * Check if the current matrix is identity as a texture matrix (3x2 store in 4x4)
  4099. * @returns true is the matrix is the identity matrix
  4100. */
  4101. isIdentityAs3x2(): boolean;
  4102. /**
  4103. * Gets the determinant of the matrix
  4104. * @returns the matrix determinant
  4105. */
  4106. determinant(): number;
  4107. /**
  4108. * Returns the matrix as a Float32Array or Array<number>
  4109. * @returns the matrix underlying array
  4110. */
  4111. toArray(): DeepImmutable<Float32Array | Array<number>>;
  4112. /**
  4113. * Returns the matrix as a Float32Array or Array<number>
  4114. * @returns the matrix underlying array.
  4115. */
  4116. asArray(): DeepImmutable<Float32Array | Array<number>>;
  4117. /**
  4118. * Inverts the current matrix in place
  4119. * @returns the current inverted matrix
  4120. */
  4121. invert(): Matrix;
  4122. /**
  4123. * Sets all the matrix elements to zero
  4124. * @returns the current matrix
  4125. */
  4126. reset(): Matrix;
  4127. /**
  4128. * Adds the current matrix with a second one
  4129. * @param other defines the matrix to add
  4130. * @returns a new matrix as the addition of the current matrix and the given one
  4131. */
  4132. add(other: DeepImmutable<Matrix>): Matrix;
  4133. /**
  4134. * Sets the given matrix "result" to the addition of the current matrix and the given one
  4135. * @param other defines the matrix to add
  4136. * @param result defines the target matrix
  4137. * @returns the current matrix
  4138. */
  4139. addToRef(other: DeepImmutable<Matrix>, result: Matrix): Matrix;
  4140. /**
  4141. * Adds in place the given matrix to the current matrix
  4142. * @param other defines the second operand
  4143. * @returns the current updated matrix
  4144. */
  4145. addToSelf(other: DeepImmutable<Matrix>): Matrix;
  4146. /**
  4147. * Sets the given matrix to the current inverted Matrix
  4148. * @param other defines the target matrix
  4149. * @returns the unmodified current matrix
  4150. */
  4151. invertToRef(other: Matrix): Matrix;
  4152. /**
  4153. * add a value at the specified position in the current Matrix
  4154. * @param index the index of the value within the matrix. between 0 and 15.
  4155. * @param value the value to be added
  4156. * @returns the current updated matrix
  4157. */
  4158. addAtIndex(index: number, value: number): Matrix;
  4159. /**
  4160. * mutiply the specified position in the current Matrix by a value
  4161. * @param index the index of the value within the matrix. between 0 and 15.
  4162. * @param value the value to be added
  4163. * @returns the current updated matrix
  4164. */
  4165. multiplyAtIndex(index: number, value: number): Matrix;
  4166. /**
  4167. * Inserts the translation vector (using 3 floats) in the current matrix
  4168. * @param x defines the 1st component of the translation
  4169. * @param y defines the 2nd component of the translation
  4170. * @param z defines the 3rd component of the translation
  4171. * @returns the current updated matrix
  4172. */
  4173. setTranslationFromFloats(x: number, y: number, z: number): Matrix;
  4174. /**
  4175. * Adds the translation vector (using 3 floats) in the current matrix
  4176. * @param x defines the 1st component of the translation
  4177. * @param y defines the 2nd component of the translation
  4178. * @param z defines the 3rd component of the translation
  4179. * @returns the current updated matrix
  4180. */
  4181. addTranslationFromFloats(x: number, y: number, z: number): Matrix;
  4182. /**
  4183. * Inserts the translation vector in the current matrix
  4184. * @param vector3 defines the translation to insert
  4185. * @returns the current updated matrix
  4186. */
  4187. setTranslation(vector3: DeepImmutable<Vector3>): Matrix;
  4188. /**
  4189. * Gets the translation value of the current matrix
  4190. * @returns a new Vector3 as the extracted translation from the matrix
  4191. */
  4192. getTranslation(): Vector3;
  4193. /**
  4194. * Fill a Vector3 with the extracted translation from the matrix
  4195. * @param result defines the Vector3 where to store the translation
  4196. * @returns the current matrix
  4197. */
  4198. getTranslationToRef(result: Vector3): Matrix;
  4199. /**
  4200. * Remove rotation and scaling part from the matrix
  4201. * @returns the updated matrix
  4202. */
  4203. removeRotationAndScaling(): Matrix;
  4204. /**
  4205. * Multiply two matrices
  4206. * @param other defines the second operand
  4207. * @returns a new matrix set with the multiplication result of the current Matrix and the given one
  4208. */
  4209. multiply(other: DeepImmutable<Matrix>): Matrix;
  4210. /**
  4211. * Copy the current matrix from the given one
  4212. * @param other defines the source matrix
  4213. * @returns the current updated matrix
  4214. */
  4215. copyFrom(other: DeepImmutable<Matrix>): Matrix;
  4216. /**
  4217. * Populates the given array from the starting index with the current matrix values
  4218. * @param array defines the target array
  4219. * @param offset defines the offset in the target array where to start storing values
  4220. * @returns the current matrix
  4221. */
  4222. copyToArray(array: Float32Array | Array<number>, offset?: number): Matrix;
  4223. /**
  4224. * Sets the given matrix "result" with the multiplication result of the current Matrix and the given one
  4225. * @param other defines the second operand
  4226. * @param result defines the matrix where to store the multiplication
  4227. * @returns the current matrix
  4228. */
  4229. multiplyToRef(other: DeepImmutable<Matrix>, result: Matrix): Matrix;
  4230. /**
  4231. * Sets the Float32Array "result" from the given index "offset" with the multiplication of the current matrix and the given one
  4232. * @param other defines the second operand
  4233. * @param result defines the array where to store the multiplication
  4234. * @param offset defines the offset in the target array where to start storing values
  4235. * @returns the current matrix
  4236. */
  4237. multiplyToArray(other: DeepImmutable<Matrix>, result: Float32Array | Array<number>, offset: number): Matrix;
  4238. /**
  4239. * Check equality between this matrix and a second one
  4240. * @param value defines the second matrix to compare
  4241. * @returns true is the current matrix and the given one values are strictly equal
  4242. */
  4243. equals(value: DeepImmutable<Matrix>): boolean;
  4244. /**
  4245. * Clone the current matrix
  4246. * @returns a new matrix from the current matrix
  4247. */
  4248. clone(): Matrix;
  4249. /**
  4250. * Returns the name of the current matrix class
  4251. * @returns the string "Matrix"
  4252. */
  4253. getClassName(): string;
  4254. /**
  4255. * Gets the hash code of the current matrix
  4256. * @returns the hash code
  4257. */
  4258. getHashCode(): number;
  4259. /**
  4260. * Decomposes the current Matrix into a translation, rotation and scaling components
  4261. * @param scale defines the scale vector3 given as a reference to update
  4262. * @param rotation defines the rotation quaternion given as a reference to update
  4263. * @param translation defines the translation vector3 given as a reference to update
  4264. * @returns true if operation was successful
  4265. */
  4266. decompose(scale?: Vector3, rotation?: Quaternion, translation?: Vector3): boolean;
  4267. /**
  4268. * Gets specific row of the matrix
  4269. * @param index defines the number of the row to get
  4270. * @returns the index-th row of the current matrix as a new Vector4
  4271. */
  4272. getRow(index: number): Nullable<Vector4>;
  4273. /**
  4274. * Sets the index-th row of the current matrix to the vector4 values
  4275. * @param index defines the number of the row to set
  4276. * @param row defines the target vector4
  4277. * @returns the updated current matrix
  4278. */
  4279. setRow(index: number, row: Vector4): Matrix;
  4280. /**
  4281. * Compute the transpose of the matrix
  4282. * @returns the new transposed matrix
  4283. */
  4284. transpose(): Matrix;
  4285. /**
  4286. * Compute the transpose of the matrix and store it in a given matrix
  4287. * @param result defines the target matrix
  4288. * @returns the current matrix
  4289. */
  4290. transposeToRef(result: Matrix): Matrix;
  4291. /**
  4292. * Sets the index-th row of the current matrix with the given 4 x float values
  4293. * @param index defines the row index
  4294. * @param x defines the x component to set
  4295. * @param y defines the y component to set
  4296. * @param z defines the z component to set
  4297. * @param w defines the w component to set
  4298. * @returns the updated current matrix
  4299. */
  4300. setRowFromFloats(index: number, x: number, y: number, z: number, w: number): Matrix;
  4301. /**
  4302. * Compute a new matrix set with the current matrix values multiplied by scale (float)
  4303. * @param scale defines the scale factor
  4304. * @returns a new matrix
  4305. */
  4306. scale(scale: number): Matrix;
  4307. /**
  4308. * Scale the current matrix values by a factor to a given result matrix
  4309. * @param scale defines the scale factor
  4310. * @param result defines the matrix to store the result
  4311. * @returns the current matrix
  4312. */
  4313. scaleToRef(scale: number, result: Matrix): Matrix;
  4314. /**
  4315. * Scale the current matrix values by a factor and add the result to a given matrix
  4316. * @param scale defines the scale factor
  4317. * @param result defines the Matrix to store the result
  4318. * @returns the current matrix
  4319. */
  4320. scaleAndAddToRef(scale: number, result: Matrix): Matrix;
  4321. /**
  4322. * Writes to the given matrix a normal matrix, computed from this one (using values from identity matrix for fourth row and column).
  4323. * @param ref matrix to store the result
  4324. */
  4325. toNormalMatrix(ref: Matrix): void;
  4326. /**
  4327. * Gets only rotation part of the current matrix
  4328. * @returns a new matrix sets to the extracted rotation matrix from the current one
  4329. */
  4330. getRotationMatrix(): Matrix;
  4331. /**
  4332. * Extracts the rotation matrix from the current one and sets it as the given "result"
  4333. * @param result defines the target matrix to store data to
  4334. * @returns the current matrix
  4335. */
  4336. getRotationMatrixToRef(result: Matrix): Matrix;
  4337. /**
  4338. * Toggles model matrix from being right handed to left handed in place and vice versa
  4339. */
  4340. toggleModelMatrixHandInPlace(): void;
  4341. /**
  4342. * Toggles projection matrix from being right handed to left handed in place and vice versa
  4343. */
  4344. toggleProjectionMatrixHandInPlace(): void;
  4345. /**
  4346. * Creates a matrix from an array
  4347. * @param array defines the source array
  4348. * @param offset defines an offset in the source array
  4349. * @returns a new Matrix set from the starting index of the given array
  4350. */
  4351. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Matrix;
  4352. /**
  4353. * Copy the content of an array into a given matrix
  4354. * @param array defines the source array
  4355. * @param offset defines an offset in the source array
  4356. * @param result defines the target matrix
  4357. */
  4358. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Matrix): void;
  4359. /**
  4360. * Stores an array into a matrix after having multiplied each component by a given factor
  4361. * @param array defines the source array
  4362. * @param offset defines the offset in the source array
  4363. * @param scale defines the scaling factor
  4364. * @param result defines the target matrix
  4365. */
  4366. static FromFloat32ArrayToRefScaled(array: DeepImmutable<Float32Array | Array<number>>, offset: number, scale: number, result: Matrix): void;
  4367. /**
  4368. * Gets an identity matrix that must not be updated
  4369. */
  4370. static get IdentityReadOnly(): DeepImmutable<Matrix>;
  4371. /**
  4372. * Stores a list of values (16) inside a given matrix
  4373. * @param initialM11 defines 1st value of 1st row
  4374. * @param initialM12 defines 2nd value of 1st row
  4375. * @param initialM13 defines 3rd value of 1st row
  4376. * @param initialM14 defines 4th value of 1st row
  4377. * @param initialM21 defines 1st value of 2nd row
  4378. * @param initialM22 defines 2nd value of 2nd row
  4379. * @param initialM23 defines 3rd value of 2nd row
  4380. * @param initialM24 defines 4th value of 2nd row
  4381. * @param initialM31 defines 1st value of 3rd row
  4382. * @param initialM32 defines 2nd value of 3rd row
  4383. * @param initialM33 defines 3rd value of 3rd row
  4384. * @param initialM34 defines 4th value of 3rd row
  4385. * @param initialM41 defines 1st value of 4th row
  4386. * @param initialM42 defines 2nd value of 4th row
  4387. * @param initialM43 defines 3rd value of 4th row
  4388. * @param initialM44 defines 4th value of 4th row
  4389. * @param result defines the target matrix
  4390. */
  4391. 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;
  4392. /**
  4393. * Creates new matrix from a list of values (16)
  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. * @returns the new matrix
  4411. */
  4412. 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;
  4413. /**
  4414. * Creates a new matrix composed by merging scale (vector3), rotation (quaternion) and translation (vector3)
  4415. * @param scale defines the scale vector3
  4416. * @param rotation defines the rotation quaternion
  4417. * @param translation defines the translation vector3
  4418. * @returns a new matrix
  4419. */
  4420. static Compose(scale: DeepImmutable<Vector3>, rotation: DeepImmutable<Quaternion>, translation: DeepImmutable<Vector3>): Matrix;
  4421. /**
  4422. * Sets a matrix to a value composed by merging scale (vector3), rotation (quaternion) and translation (vector3)
  4423. * @param scale defines the scale vector3
  4424. * @param rotation defines the rotation quaternion
  4425. * @param translation defines the translation vector3
  4426. * @param result defines the target matrix
  4427. */
  4428. static ComposeToRef(scale: DeepImmutable<Vector3>, rotation: DeepImmutable<Quaternion>, translation: DeepImmutable<Vector3>, result: Matrix): void;
  4429. /**
  4430. * Creates a new identity matrix
  4431. * @returns a new identity matrix
  4432. */
  4433. static Identity(): Matrix;
  4434. /**
  4435. * Creates a new identity matrix and stores the result in a given matrix
  4436. * @param result defines the target matrix
  4437. */
  4438. static IdentityToRef(result: Matrix): void;
  4439. /**
  4440. * Creates a new zero matrix
  4441. * @returns a new zero matrix
  4442. */
  4443. static Zero(): Matrix;
  4444. /**
  4445. * Creates a new rotation matrix for "angle" radians around the X axis
  4446. * @param angle defines the angle (in radians) to use
  4447. * @return the new matrix
  4448. */
  4449. static RotationX(angle: number): Matrix;
  4450. /**
  4451. * Creates a new matrix as the invert of a given matrix
  4452. * @param source defines the source matrix
  4453. * @returns the new matrix
  4454. */
  4455. static Invert(source: DeepImmutable<Matrix>): Matrix;
  4456. /**
  4457. * Creates a new rotation matrix for "angle" radians around the X axis and stores it in a given matrix
  4458. * @param angle defines the angle (in radians) to use
  4459. * @param result defines the target matrix
  4460. */
  4461. static RotationXToRef(angle: number, result: Matrix): void;
  4462. /**
  4463. * Creates a new rotation matrix for "angle" radians around the Y axis
  4464. * @param angle defines the angle (in radians) to use
  4465. * @return the new matrix
  4466. */
  4467. static RotationY(angle: number): Matrix;
  4468. /**
  4469. * Creates a new rotation matrix for "angle" radians around the Y axis and stores it in a given matrix
  4470. * @param angle defines the angle (in radians) to use
  4471. * @param result defines the target matrix
  4472. */
  4473. static RotationYToRef(angle: number, result: Matrix): void;
  4474. /**
  4475. * Creates a new rotation matrix for "angle" radians around the Z axis
  4476. * @param angle defines the angle (in radians) to use
  4477. * @return the new matrix
  4478. */
  4479. static RotationZ(angle: number): Matrix;
  4480. /**
  4481. * Creates a new rotation matrix for "angle" radians around the Z axis and stores it in a given matrix
  4482. * @param angle defines the angle (in radians) to use
  4483. * @param result defines the target matrix
  4484. */
  4485. static RotationZToRef(angle: number, result: Matrix): void;
  4486. /**
  4487. * Creates a new rotation matrix for "angle" radians around the given axis
  4488. * @param axis defines the axis to use
  4489. * @param angle defines the angle (in radians) to use
  4490. * @return the new matrix
  4491. */
  4492. static RotationAxis(axis: DeepImmutable<Vector3>, angle: number): Matrix;
  4493. /**
  4494. * Creates a new rotation matrix for "angle" radians around the given axis and stores it in a given matrix
  4495. * @param axis defines the axis to use
  4496. * @param angle defines the angle (in radians) to use
  4497. * @param result defines the target matrix
  4498. */
  4499. static RotationAxisToRef(axis: DeepImmutable<Vector3>, angle: number, result: Matrix): void;
  4500. /**
  4501. * Takes normalised vectors and returns a rotation matrix to align "from" with "to".
  4502. * Taken from http://www.iquilezles.org/www/articles/noacos/noacos.htm
  4503. * @param from defines the vector to align
  4504. * @param to defines the vector to align to
  4505. * @param result defines the target matrix
  4506. */
  4507. static RotationAlignToRef(from: DeepImmutable<Vector3>, to: DeepImmutable<Vector3>, result: Matrix): void;
  4508. /**
  4509. * Creates a rotation matrix
  4510. * @param yaw defines the yaw angle in radians (Y axis)
  4511. * @param pitch defines the pitch angle in radians (X axis)
  4512. * @param roll defines the roll angle in radians (Z axis)
  4513. * @returns the new rotation matrix
  4514. */
  4515. static RotationYawPitchRoll(yaw: number, pitch: number, roll: number): Matrix;
  4516. /**
  4517. * Creates a rotation matrix and stores it in a given matrix
  4518. * @param yaw defines the yaw angle in radians (Y axis)
  4519. * @param pitch defines the pitch angle in radians (X axis)
  4520. * @param roll defines the roll angle in radians (Z axis)
  4521. * @param result defines the target matrix
  4522. */
  4523. static RotationYawPitchRollToRef(yaw: number, pitch: number, roll: number, result: Matrix): void;
  4524. /**
  4525. * Creates a scaling matrix
  4526. * @param x defines the scale factor on X axis
  4527. * @param y defines the scale factor on Y axis
  4528. * @param z defines the scale factor on Z axis
  4529. * @returns the new matrix
  4530. */
  4531. static Scaling(x: number, y: number, z: number): Matrix;
  4532. /**
  4533. * Creates a scaling matrix and stores it in a given matrix
  4534. * @param x defines the scale factor on X axis
  4535. * @param y defines the scale factor on Y axis
  4536. * @param z defines the scale factor on Z axis
  4537. * @param result defines the target matrix
  4538. */
  4539. static ScalingToRef(x: number, y: number, z: number, result: Matrix): void;
  4540. /**
  4541. * Creates a translation matrix
  4542. * @param x defines the translation on X axis
  4543. * @param y defines the translation on Y axis
  4544. * @param z defines the translationon Z axis
  4545. * @returns the new matrix
  4546. */
  4547. static Translation(x: number, y: number, z: number): Matrix;
  4548. /**
  4549. * Creates a translation matrix and stores it in a given matrix
  4550. * @param x defines the translation on X axis
  4551. * @param y defines the translation on Y axis
  4552. * @param z defines the translationon Z axis
  4553. * @param result defines the target matrix
  4554. */
  4555. static TranslationToRef(x: number, y: number, z: number, result: Matrix): void;
  4556. /**
  4557. * Returns a new Matrix whose values are the interpolated values for "gradient" (float) between the ones of the matrices "startValue" and "endValue".
  4558. * @param startValue defines the start value
  4559. * @param endValue defines the end value
  4560. * @param gradient defines the gradient factor
  4561. * @returns the new matrix
  4562. */
  4563. static Lerp(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number): Matrix;
  4564. /**
  4565. * Set the given matrix "result" as the interpolated values for "gradient" (float) between the ones of the matrices "startValue" and "endValue".
  4566. * @param startValue defines the start value
  4567. * @param endValue defines the end value
  4568. * @param gradient defines the gradient factor
  4569. * @param result defines the Matrix object where to store data
  4570. */
  4571. static LerpToRef(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number, result: Matrix): void;
  4572. /**
  4573. * Builds a new matrix whose values are computed by:
  4574. * * decomposing the the "startValue" and "endValue" matrices into their respective scale, rotation and translation matrices
  4575. * * interpolating for "gradient" (float) the values between each of these decomposed matrices between the start and the end
  4576. * * recomposing a new matrix from these 3 interpolated scale, rotation and translation matrices
  4577. * @param startValue defines the first matrix
  4578. * @param endValue defines the second matrix
  4579. * @param gradient defines the gradient between the two matrices
  4580. * @returns the new matrix
  4581. */
  4582. static DecomposeLerp(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number): Matrix;
  4583. /**
  4584. * Update a matrix to values which are computed by:
  4585. * * decomposing the the "startValue" and "endValue" matrices into their respective scale, rotation and translation matrices
  4586. * * interpolating for "gradient" (float) the values between each of these decomposed matrices between the start and the end
  4587. * * recomposing a new matrix from these 3 interpolated scale, rotation and translation matrices
  4588. * @param startValue defines the first matrix
  4589. * @param endValue defines the second matrix
  4590. * @param gradient defines the gradient between the two matrices
  4591. * @param result defines the target matrix
  4592. */
  4593. static DecomposeLerpToRef(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number, result: Matrix): void;
  4594. /**
  4595. * 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"
  4596. * This function works in left handed mode
  4597. * @param eye defines the final position of the entity
  4598. * @param target defines where the entity should look at
  4599. * @param up defines the up vector for the entity
  4600. * @returns the new matrix
  4601. */
  4602. static LookAtLH(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>): Matrix;
  4603. /**
  4604. * 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".
  4605. * This function works in left handed mode
  4606. * @param eye defines the final position of the entity
  4607. * @param target defines where the entity should look at
  4608. * @param up defines the up vector for the entity
  4609. * @param result defines the target matrix
  4610. */
  4611. static LookAtLHToRef(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>, result: Matrix): void;
  4612. /**
  4613. * 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"
  4614. * This function works in right handed mode
  4615. * @param eye defines the final position of the entity
  4616. * @param target defines where the entity should look at
  4617. * @param up defines the up vector for the entity
  4618. * @returns the new matrix
  4619. */
  4620. static LookAtRH(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>): Matrix;
  4621. /**
  4622. * 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".
  4623. * This function works in right handed mode
  4624. * @param eye defines the final position of the entity
  4625. * @param target defines where the entity should look at
  4626. * @param up defines the up vector for the entity
  4627. * @param result defines the target matrix
  4628. */
  4629. static LookAtRHToRef(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>, result: Matrix): void;
  4630. /**
  4631. * Create a left-handed orthographic projection matrix
  4632. * @param width defines the viewport width
  4633. * @param height defines the viewport height
  4634. * @param znear defines the near clip plane
  4635. * @param zfar defines the far clip plane
  4636. * @returns a new matrix as a left-handed orthographic projection matrix
  4637. */
  4638. static OrthoLH(width: number, height: number, znear: number, zfar: number): Matrix;
  4639. /**
  4640. * Store a left-handed orthographic projection to a given matrix
  4641. * @param width defines the viewport width
  4642. * @param height defines the viewport height
  4643. * @param znear defines the near clip plane
  4644. * @param zfar defines the far clip plane
  4645. * @param result defines the target matrix
  4646. */
  4647. static OrthoLHToRef(width: number, height: number, znear: number, zfar: number, result: Matrix): void;
  4648. /**
  4649. * Create a left-handed orthographic projection matrix
  4650. * @param left defines the viewport left coordinate
  4651. * @param right defines the viewport right coordinate
  4652. * @param bottom defines the viewport bottom coordinate
  4653. * @param top defines the viewport top coordinate
  4654. * @param znear defines the near clip plane
  4655. * @param zfar defines the far clip plane
  4656. * @returns a new matrix as a left-handed orthographic projection matrix
  4657. */
  4658. static OrthoOffCenterLH(left: number, right: number, bottom: number, top: number, znear: number, zfar: number): Matrix;
  4659. /**
  4660. * Stores a left-handed orthographic projection into a given matrix
  4661. * @param left defines the viewport left coordinate
  4662. * @param right defines the viewport right coordinate
  4663. * @param bottom defines the viewport bottom coordinate
  4664. * @param top defines the viewport top coordinate
  4665. * @param znear defines the near clip plane
  4666. * @param zfar defines the far clip plane
  4667. * @param result defines the target matrix
  4668. */
  4669. static OrthoOffCenterLHToRef(left: number, right: number, bottom: number, top: number, znear: number, zfar: number, result: Matrix): void;
  4670. /**
  4671. * Creates a right-handed orthographic projection matrix
  4672. * @param left defines the viewport left coordinate
  4673. * @param right defines the viewport right coordinate
  4674. * @param bottom defines the viewport bottom coordinate
  4675. * @param top defines the viewport top coordinate
  4676. * @param znear defines the near clip plane
  4677. * @param zfar defines the far clip plane
  4678. * @returns a new matrix as a right-handed orthographic projection matrix
  4679. */
  4680. static OrthoOffCenterRH(left: number, right: number, bottom: number, top: number, znear: number, zfar: number): Matrix;
  4681. /**
  4682. * Stores a right-handed orthographic projection into a given matrix
  4683. * @param left defines the viewport left coordinate
  4684. * @param right defines the viewport right coordinate
  4685. * @param bottom defines the viewport bottom coordinate
  4686. * @param top defines the viewport top coordinate
  4687. * @param znear defines the near clip plane
  4688. * @param zfar defines the far clip plane
  4689. * @param result defines the target matrix
  4690. */
  4691. static OrthoOffCenterRHToRef(left: number, right: number, bottom: number, top: number, znear: number, zfar: number, result: Matrix): void;
  4692. /**
  4693. * Creates a left-handed perspective projection matrix
  4694. * @param width defines the viewport width
  4695. * @param height defines the viewport height
  4696. * @param znear defines the near clip plane
  4697. * @param zfar defines the far clip plane
  4698. * @returns a new matrix as a left-handed perspective projection matrix
  4699. */
  4700. static PerspectiveLH(width: number, height: number, znear: number, zfar: number): Matrix;
  4701. /**
  4702. * Creates a left-handed perspective projection matrix
  4703. * @param fov defines the horizontal field of view
  4704. * @param aspect defines the aspect ratio
  4705. * @param znear defines the near clip plane
  4706. * @param zfar defines the far clip plane
  4707. * @returns a new matrix as a left-handed perspective projection matrix
  4708. */
  4709. static PerspectiveFovLH(fov: number, aspect: number, znear: number, zfar: number): Matrix;
  4710. /**
  4711. * Stores a left-handed perspective projection into a given matrix
  4712. * @param fov defines the horizontal field of view
  4713. * @param aspect defines the aspect ratio
  4714. * @param znear defines the near clip plane
  4715. * @param zfar defines the far clip plane
  4716. * @param result defines the target matrix
  4717. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  4718. */
  4719. static PerspectiveFovLHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  4720. /**
  4721. * Stores a left-handed perspective projection into a given matrix with depth reversed
  4722. * @param fov defines the horizontal field of view
  4723. * @param aspect defines the aspect ratio
  4724. * @param znear defines the near clip plane
  4725. * @param zfar not used as infinity is used as far clip
  4726. * @param result defines the target matrix
  4727. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  4728. */
  4729. static PerspectiveFovReverseLHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  4730. /**
  4731. * Creates a right-handed perspective projection matrix
  4732. * @param fov defines the horizontal field of view
  4733. * @param aspect defines the aspect ratio
  4734. * @param znear defines the near clip plane
  4735. * @param zfar defines the far clip plane
  4736. * @returns a new matrix as a right-handed perspective projection matrix
  4737. */
  4738. static PerspectiveFovRH(fov: number, aspect: number, znear: number, zfar: number): Matrix;
  4739. /**
  4740. * Stores a right-handed perspective projection into a given matrix
  4741. * @param fov defines the horizontal field of view
  4742. * @param aspect defines the aspect ratio
  4743. * @param znear defines the near clip plane
  4744. * @param zfar defines the far clip plane
  4745. * @param result defines the target matrix
  4746. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  4747. */
  4748. static PerspectiveFovRHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  4749. /**
  4750. * Stores a right-handed perspective projection into a given matrix
  4751. * @param fov defines the horizontal field of view
  4752. * @param aspect defines the aspect ratio
  4753. * @param znear defines the near clip plane
  4754. * @param zfar not used as infinity is used as far clip
  4755. * @param result defines the target matrix
  4756. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  4757. */
  4758. static PerspectiveFovReverseRHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  4759. /**
  4760. * Stores a perspective projection for WebVR info a given matrix
  4761. * @param fov defines the field of view
  4762. * @param znear defines the near clip plane
  4763. * @param zfar defines the far clip plane
  4764. * @param result defines the target matrix
  4765. * @param rightHanded defines if the matrix must be in right-handed mode (false by default)
  4766. */
  4767. static PerspectiveFovWebVRToRef(fov: {
  4768. upDegrees: number;
  4769. downDegrees: number;
  4770. leftDegrees: number;
  4771. rightDegrees: number;
  4772. }, znear: number, zfar: number, result: Matrix, rightHanded?: boolean): void;
  4773. /**
  4774. * Computes a complete transformation matrix
  4775. * @param viewport defines the viewport to use
  4776. * @param world defines the world matrix
  4777. * @param view defines the view matrix
  4778. * @param projection defines the projection matrix
  4779. * @param zmin defines the near clip plane
  4780. * @param zmax defines the far clip plane
  4781. * @returns the transformation matrix
  4782. */
  4783. static GetFinalMatrix(viewport: DeepImmutable<Viewport>, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, zmin: number, zmax: number): Matrix;
  4784. /**
  4785. * Extracts a 2x2 matrix from a given matrix and store the result in a Float32Array
  4786. * @param matrix defines the matrix to use
  4787. * @returns a new Float32Array array with 4 elements : the 2x2 matrix extracted from the given matrix
  4788. */
  4789. static GetAsMatrix2x2(matrix: DeepImmutable<Matrix>): Float32Array | Array<number>;
  4790. /**
  4791. * Extracts a 3x3 matrix from a given matrix and store the result in a Float32Array
  4792. * @param matrix defines the matrix to use
  4793. * @returns a new Float32Array array with 9 elements : the 3x3 matrix extracted from the given matrix
  4794. */
  4795. static GetAsMatrix3x3(matrix: DeepImmutable<Matrix>): Float32Array | Array<number>;
  4796. /**
  4797. * Compute the transpose of a given matrix
  4798. * @param matrix defines the matrix to transpose
  4799. * @returns the new matrix
  4800. */
  4801. static Transpose(matrix: DeepImmutable<Matrix>): Matrix;
  4802. /**
  4803. * Compute the transpose of a matrix and store it in a target matrix
  4804. * @param matrix defines the matrix to transpose
  4805. * @param result defines the target matrix
  4806. */
  4807. static TransposeToRef(matrix: DeepImmutable<Matrix>, result: Matrix): void;
  4808. /**
  4809. * Computes a reflection matrix from a plane
  4810. * @param plane defines the reflection plane
  4811. * @returns a new matrix
  4812. */
  4813. static Reflection(plane: DeepImmutable<IPlaneLike>): Matrix;
  4814. /**
  4815. * Computes a reflection matrix from a plane
  4816. * @param plane defines the reflection plane
  4817. * @param result defines the target matrix
  4818. */
  4819. static ReflectionToRef(plane: DeepImmutable<IPlaneLike>, result: Matrix): void;
  4820. /**
  4821. * Sets the given matrix as a rotation matrix composed from the 3 left handed axes
  4822. * @param xaxis defines the value of the 1st axis
  4823. * @param yaxis defines the value of the 2nd axis
  4824. * @param zaxis defines the value of the 3rd axis
  4825. * @param result defines the target matrix
  4826. */
  4827. static FromXYZAxesToRef(xaxis: DeepImmutable<Vector3>, yaxis: DeepImmutable<Vector3>, zaxis: DeepImmutable<Vector3>, result: Matrix): void;
  4828. /**
  4829. * Creates a rotation matrix from a quaternion and stores it in a target matrix
  4830. * @param quat defines the quaternion to use
  4831. * @param result defines the target matrix
  4832. */
  4833. static FromQuaternionToRef(quat: DeepImmutable<Quaternion>, result: Matrix): void;
  4834. }
  4835. /**
  4836. * @hidden
  4837. */
  4838. export class TmpVectors {
  4839. static Vector2: Vector2[];
  4840. static Vector3: Vector3[];
  4841. static Vector4: Vector4[];
  4842. static Quaternion: Quaternion[];
  4843. static Matrix: Matrix[];
  4844. }
  4845. }
  4846. declare module "babylonjs/Maths/math.path" {
  4847. import { DeepImmutable, Nullable } from "babylonjs/types";
  4848. import { Vector2, Vector3 } from "babylonjs/Maths/math.vector";
  4849. /**
  4850. * Defines potential orientation for back face culling
  4851. */
  4852. export enum Orientation {
  4853. /**
  4854. * Clockwise
  4855. */
  4856. CW = 0,
  4857. /** Counter clockwise */
  4858. CCW = 1
  4859. }
  4860. /** Class used to represent a Bezier curve */
  4861. export class BezierCurve {
  4862. /**
  4863. * Returns the cubic Bezier interpolated value (float) at "t" (float) from the given x1, y1, x2, y2 floats
  4864. * @param t defines the time
  4865. * @param x1 defines the left coordinate on X axis
  4866. * @param y1 defines the left coordinate on Y axis
  4867. * @param x2 defines the right coordinate on X axis
  4868. * @param y2 defines the right coordinate on Y axis
  4869. * @returns the interpolated value
  4870. */
  4871. static Interpolate(t: number, x1: number, y1: number, x2: number, y2: number): number;
  4872. }
  4873. /**
  4874. * Defines angle representation
  4875. */
  4876. export class Angle {
  4877. private _radians;
  4878. /**
  4879. * Creates an Angle object of "radians" radians (float).
  4880. * @param radians the angle in radians
  4881. */
  4882. constructor(radians: number);
  4883. /**
  4884. * Get value in degrees
  4885. * @returns the Angle value in degrees (float)
  4886. */
  4887. degrees(): number;
  4888. /**
  4889. * Get value in radians
  4890. * @returns the Angle value in radians (float)
  4891. */
  4892. radians(): number;
  4893. /**
  4894. * Gets a new Angle object valued with the gradient angle, in radians, of the line joining two points
  4895. * @param a defines first point as the origin
  4896. * @param b defines point
  4897. * @returns a new Angle
  4898. */
  4899. static BetweenTwoPoints(a: DeepImmutable<Vector2>, b: DeepImmutable<Vector2>): Angle;
  4900. /**
  4901. * Gets a new Angle object from the given float in radians
  4902. * @param radians defines the angle value in radians
  4903. * @returns a new Angle
  4904. */
  4905. static FromRadians(radians: number): Angle;
  4906. /**
  4907. * Gets a new Angle object from the given float in degrees
  4908. * @param degrees defines the angle value in degrees
  4909. * @returns a new Angle
  4910. */
  4911. static FromDegrees(degrees: number): Angle;
  4912. }
  4913. /**
  4914. * This represents an arc in a 2d space.
  4915. */
  4916. export class Arc2 {
  4917. /** Defines the start point of the arc */
  4918. startPoint: Vector2;
  4919. /** Defines the mid point of the arc */
  4920. midPoint: Vector2;
  4921. /** Defines the end point of the arc */
  4922. endPoint: Vector2;
  4923. /**
  4924. * Defines the center point of the arc.
  4925. */
  4926. centerPoint: Vector2;
  4927. /**
  4928. * Defines the radius of the arc.
  4929. */
  4930. radius: number;
  4931. /**
  4932. * Defines the angle of the arc (from mid point to end point).
  4933. */
  4934. angle: Angle;
  4935. /**
  4936. * Defines the start angle of the arc (from start point to middle point).
  4937. */
  4938. startAngle: Angle;
  4939. /**
  4940. * Defines the orientation of the arc (clock wise/counter clock wise).
  4941. */
  4942. orientation: Orientation;
  4943. /**
  4944. * Creates an Arc object from the three given points : start, middle and end.
  4945. * @param startPoint Defines the start point of the arc
  4946. * @param midPoint Defines the midlle point of the arc
  4947. * @param endPoint Defines the end point of the arc
  4948. */
  4949. constructor(
  4950. /** Defines the start point of the arc */
  4951. startPoint: Vector2,
  4952. /** Defines the mid point of the arc */
  4953. midPoint: Vector2,
  4954. /** Defines the end point of the arc */
  4955. endPoint: Vector2);
  4956. }
  4957. /**
  4958. * Represents a 2D path made up of multiple 2D points
  4959. */
  4960. export class Path2 {
  4961. private _points;
  4962. private _length;
  4963. /**
  4964. * If the path start and end point are the same
  4965. */
  4966. closed: boolean;
  4967. /**
  4968. * Creates a Path2 object from the starting 2D coordinates x and y.
  4969. * @param x the starting points x value
  4970. * @param y the starting points y value
  4971. */
  4972. constructor(x: number, y: number);
  4973. /**
  4974. * Adds a new segment until the given coordinates (x, y) to the current Path2.
  4975. * @param x the added points x value
  4976. * @param y the added points y value
  4977. * @returns the updated Path2.
  4978. */
  4979. addLineTo(x: number, y: number): Path2;
  4980. /**
  4981. * 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.
  4982. * @param midX middle point x value
  4983. * @param midY middle point y value
  4984. * @param endX end point x value
  4985. * @param endY end point y value
  4986. * @param numberOfSegments (default: 36)
  4987. * @returns the updated Path2.
  4988. */
  4989. addArcTo(midX: number, midY: number, endX: number, endY: number, numberOfSegments?: number): Path2;
  4990. /**
  4991. * Closes the Path2.
  4992. * @returns the Path2.
  4993. */
  4994. close(): Path2;
  4995. /**
  4996. * Gets the sum of the distance between each sequential point in the path
  4997. * @returns the Path2 total length (float).
  4998. */
  4999. length(): number;
  5000. /**
  5001. * Gets the points which construct the path
  5002. * @returns the Path2 internal array of points.
  5003. */
  5004. getPoints(): Vector2[];
  5005. /**
  5006. * Retreives the point at the distance aways from the starting point
  5007. * @param normalizedLengthPosition the length along the path to retreive the point from
  5008. * @returns a new Vector2 located at a percentage of the Path2 total length on this path.
  5009. */
  5010. getPointAtLengthPosition(normalizedLengthPosition: number): Vector2;
  5011. /**
  5012. * Creates a new path starting from an x and y position
  5013. * @param x starting x value
  5014. * @param y starting y value
  5015. * @returns a new Path2 starting at the coordinates (x, y).
  5016. */
  5017. static StartingAt(x: number, y: number): Path2;
  5018. }
  5019. /**
  5020. * Represents a 3D path made up of multiple 3D points
  5021. */
  5022. export class Path3D {
  5023. /**
  5024. * an array of Vector3, the curve axis of the Path3D
  5025. */
  5026. path: Vector3[];
  5027. private _curve;
  5028. private _distances;
  5029. private _tangents;
  5030. private _normals;
  5031. private _binormals;
  5032. private _raw;
  5033. private _alignTangentsWithPath;
  5034. private readonly _pointAtData;
  5035. /**
  5036. * new Path3D(path, normal, raw)
  5037. * Creates a Path3D. A Path3D is a logical math object, so not a mesh.
  5038. * please read the description in the tutorial : https://doc.babylonjs.com/how_to/how_to_use_path3d
  5039. * @param path an array of Vector3, the curve axis of the Path3D
  5040. * @param firstNormal (options) Vector3, the first wanted normal to the curve. Ex (0, 1, 0) for a vertical normal.
  5041. * @param raw (optional, default false) : boolean, if true the returned Path3D isn't normalized. Useful to depict path acceleration or speed.
  5042. * @param alignTangentsWithPath (optional, default false) : boolean, if true the tangents will be aligned with the path.
  5043. */
  5044. constructor(
  5045. /**
  5046. * an array of Vector3, the curve axis of the Path3D
  5047. */
  5048. path: Vector3[], firstNormal?: Nullable<Vector3>, raw?: boolean, alignTangentsWithPath?: boolean);
  5049. /**
  5050. * Returns the Path3D array of successive Vector3 designing its curve.
  5051. * @returns the Path3D array of successive Vector3 designing its curve.
  5052. */
  5053. getCurve(): Vector3[];
  5054. /**
  5055. * Returns the Path3D array of successive Vector3 designing its curve.
  5056. * @returns the Path3D array of successive Vector3 designing its curve.
  5057. */
  5058. getPoints(): Vector3[];
  5059. /**
  5060. * @returns the computed length (float) of the path.
  5061. */
  5062. length(): number;
  5063. /**
  5064. * Returns an array populated with tangent vectors on each Path3D curve point.
  5065. * @returns an array populated with tangent vectors on each Path3D curve point.
  5066. */
  5067. getTangents(): Vector3[];
  5068. /**
  5069. * Returns an array populated with normal vectors on each Path3D curve point.
  5070. * @returns an array populated with normal vectors on each Path3D curve point.
  5071. */
  5072. getNormals(): Vector3[];
  5073. /**
  5074. * Returns an array populated with binormal vectors on each Path3D curve point.
  5075. * @returns an array populated with binormal vectors on each Path3D curve point.
  5076. */
  5077. getBinormals(): Vector3[];
  5078. /**
  5079. * Returns an array populated with distances (float) of the i-th point from the first curve point.
  5080. * @returns an array populated with distances (float) of the i-th point from the first curve point.
  5081. */
  5082. getDistances(): number[];
  5083. /**
  5084. * Returns an interpolated point along this path
  5085. * @param position the position of the point along this path, from 0.0 to 1.0
  5086. * @returns a new Vector3 as the point
  5087. */
  5088. getPointAt(position: number): Vector3;
  5089. /**
  5090. * Returns the tangent vector of an interpolated Path3D curve point at the specified position along this path.
  5091. * @param position the position of the point along this path, from 0.0 to 1.0
  5092. * @param interpolated (optional, default false) : boolean, if true returns an interpolated tangent instead of the tangent of the previous path point.
  5093. * @returns a tangent vector corresponding to the interpolated Path3D curve point, if not interpolated, the tangent is taken from the precomputed tangents array.
  5094. */
  5095. getTangentAt(position: number, interpolated?: boolean): Vector3;
  5096. /**
  5097. * Returns the tangent vector of an interpolated Path3D curve point at the specified position along this path.
  5098. * @param position the position of the point along this path, from 0.0 to 1.0
  5099. * @param interpolated (optional, default false) : boolean, if true returns an interpolated normal instead of the normal of the previous path point.
  5100. * @returns a normal vector corresponding to the interpolated Path3D curve point, if not interpolated, the normal is taken from the precomputed normals array.
  5101. */
  5102. getNormalAt(position: number, interpolated?: boolean): Vector3;
  5103. /**
  5104. * Returns the binormal vector of an interpolated Path3D curve point at the specified position along this path.
  5105. * @param position the position of the point along this path, from 0.0 to 1.0
  5106. * @param interpolated (optional, default false) : boolean, if true returns an interpolated binormal instead of the binormal of the previous path point.
  5107. * @returns a binormal vector corresponding to the interpolated Path3D curve point, if not interpolated, the binormal is taken from the precomputed binormals array.
  5108. */
  5109. getBinormalAt(position: number, interpolated?: boolean): Vector3;
  5110. /**
  5111. * Returns the distance (float) 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. * @returns the distance of the interpolated Path3D curve point at the specified position along this path.
  5114. */
  5115. getDistanceAt(position: number): number;
  5116. /**
  5117. * Returns the array index of the previous point of an interpolated point along this path
  5118. * @param position the position of the point to interpolate along this path, from 0.0 to 1.0
  5119. * @returns the array index
  5120. */
  5121. getPreviousPointIndexAt(position: number): number;
  5122. /**
  5123. * 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)
  5124. * @param position the position of the point to interpolate along this path, from 0.0 to 1.0
  5125. * @returns the sub position
  5126. */
  5127. getSubPositionAt(position: number): number;
  5128. /**
  5129. * Returns the position of the closest virtual point on this path to an arbitrary Vector3, from 0.0 to 1.0
  5130. * @param target the vector of which to get the closest position to
  5131. * @returns the position of the closest virtual point on this path to the target vector
  5132. */
  5133. getClosestPositionTo(target: Vector3): number;
  5134. /**
  5135. * Returns a sub path (slice) of this path
  5136. * @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
  5137. * @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
  5138. * @returns a sub path (slice) of this path
  5139. */
  5140. slice(start?: number, end?: number): Path3D;
  5141. /**
  5142. * Forces the Path3D tangent, normal, binormal and distance recomputation.
  5143. * @param path path which all values are copied into the curves points
  5144. * @param firstNormal which should be projected onto the curve
  5145. * @param alignTangentsWithPath (optional, default false) : boolean, if true the tangents will be aligned with the path
  5146. * @returns the same object updated.
  5147. */
  5148. update(path: Vector3[], firstNormal?: Nullable<Vector3>, alignTangentsWithPath?: boolean): Path3D;
  5149. private _compute;
  5150. private _getFirstNonNullVector;
  5151. private _getLastNonNullVector;
  5152. private _normalVector;
  5153. /**
  5154. * Updates the point at data for an interpolated point along this curve
  5155. * @param position the position of the point along this curve, from 0.0 to 1.0
  5156. * @interpolateTNB wether to compute the interpolated tangent, normal and binormal
  5157. * @returns the (updated) point at data
  5158. */
  5159. private _updatePointAtData;
  5160. /**
  5161. * Updates the point at data from the specified parameters
  5162. * @param position where along the path the interpolated point is, from 0.0 to 1.0
  5163. * @param point the interpolated point
  5164. * @param parentIndex the index of an existing curve point that is on, or else positionally the first behind, the interpolated point
  5165. */
  5166. private _setPointAtData;
  5167. /**
  5168. * Updates the point at interpolation matrix for the tangents, normals and binormals
  5169. */
  5170. private _updateInterpolationMatrix;
  5171. }
  5172. /**
  5173. * A Curve3 object is a logical object, so not a mesh, to handle curves in the 3D geometric space.
  5174. * A Curve3 is designed from a series of successive Vector3.
  5175. * @see https://doc.babylonjs.com/how_to/how_to_use_curve3
  5176. */
  5177. export class Curve3 {
  5178. private _points;
  5179. private _length;
  5180. /**
  5181. * Returns a Curve3 object along a Quadratic Bezier curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#quadratic-bezier-curve
  5182. * @param v0 (Vector3) the origin point of the Quadratic Bezier
  5183. * @param v1 (Vector3) the control point
  5184. * @param v2 (Vector3) the end point of the Quadratic Bezier
  5185. * @param nbPoints (integer) the wanted number of points in the curve
  5186. * @returns the created Curve3
  5187. */
  5188. static CreateQuadraticBezier(v0: DeepImmutable<Vector3>, v1: DeepImmutable<Vector3>, v2: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  5189. /**
  5190. * Returns a Curve3 object along a Cubic Bezier curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#cubic-bezier-curve
  5191. * @param v0 (Vector3) the origin point of the Cubic Bezier
  5192. * @param v1 (Vector3) the first control point
  5193. * @param v2 (Vector3) the second control point
  5194. * @param v3 (Vector3) the end point of the Cubic Bezier
  5195. * @param nbPoints (integer) the wanted number of points in the curve
  5196. * @returns the created Curve3
  5197. */
  5198. static CreateCubicBezier(v0: DeepImmutable<Vector3>, v1: DeepImmutable<Vector3>, v2: DeepImmutable<Vector3>, v3: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  5199. /**
  5200. * Returns a Curve3 object along a Hermite Spline curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#hermite-spline
  5201. * @param p1 (Vector3) the origin point of the Hermite Spline
  5202. * @param t1 (Vector3) the tangent vector at the origin point
  5203. * @param p2 (Vector3) the end point of the Hermite Spline
  5204. * @param t2 (Vector3) the tangent vector at the end point
  5205. * @param nbPoints (integer) the wanted number of points in the curve
  5206. * @returns the created Curve3
  5207. */
  5208. static CreateHermiteSpline(p1: DeepImmutable<Vector3>, t1: DeepImmutable<Vector3>, p2: DeepImmutable<Vector3>, t2: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  5209. /**
  5210. * Returns a Curve3 object along a CatmullRom Spline curve :
  5211. * @param points (array of Vector3) the points the spline must pass through. At least, four points required
  5212. * @param nbPoints (integer) the wanted number of points between each curve control points
  5213. * @param closed (boolean) optional with default false, when true forms a closed loop from the points
  5214. * @returns the created Curve3
  5215. */
  5216. static CreateCatmullRomSpline(points: DeepImmutable<Vector3[]>, nbPoints: number, closed?: boolean): Curve3;
  5217. /**
  5218. * A Curve3 object is a logical object, so not a mesh, to handle curves in the 3D geometric space.
  5219. * A Curve3 is designed from a series of successive Vector3.
  5220. * Tuto : https://doc.babylonjs.com/how_to/how_to_use_curve3#curve3-object
  5221. * @param points points which make up the curve
  5222. */
  5223. constructor(points: Vector3[]);
  5224. /**
  5225. * @returns the Curve3 stored array of successive Vector3
  5226. */
  5227. getPoints(): Vector3[];
  5228. /**
  5229. * @returns the computed length (float) of the curve.
  5230. */
  5231. length(): number;
  5232. /**
  5233. * Returns a new instance of Curve3 object : var curve = curveA.continue(curveB);
  5234. * This new Curve3 is built by translating and sticking the curveB at the end of the curveA.
  5235. * curveA and curveB keep unchanged.
  5236. * @param curve the curve to continue from this curve
  5237. * @returns the newly constructed curve
  5238. */
  5239. continue(curve: DeepImmutable<Curve3>): Curve3;
  5240. private _computeLength;
  5241. }
  5242. }
  5243. declare module "babylonjs/Animations/easing" {
  5244. /**
  5245. * This represents the main contract an easing function should follow.
  5246. * Easing functions are used throughout the animation system.
  5247. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5248. */
  5249. export interface IEasingFunction {
  5250. /**
  5251. * Given an input gradient between 0 and 1, this returns the corrseponding value
  5252. * of the easing function.
  5253. * The link below provides some of the most common examples of easing functions.
  5254. * @see https://easings.net/
  5255. * @param gradient Defines the value between 0 and 1 we want the easing value for
  5256. * @returns the corresponding value on the curve defined by the easing function
  5257. */
  5258. ease(gradient: number): number;
  5259. }
  5260. /**
  5261. * Base class used for every default easing function.
  5262. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5263. */
  5264. export class EasingFunction implements IEasingFunction {
  5265. /**
  5266. * Interpolation follows the mathematical formula associated with the easing function.
  5267. */
  5268. static readonly EASINGMODE_EASEIN: number;
  5269. /**
  5270. * Interpolation follows 100% interpolation minus the output of the formula associated with the easing function.
  5271. */
  5272. static readonly EASINGMODE_EASEOUT: number;
  5273. /**
  5274. * Interpolation uses EaseIn for the first half of the animation and EaseOut for the second half.
  5275. */
  5276. static readonly EASINGMODE_EASEINOUT: number;
  5277. private _easingMode;
  5278. /**
  5279. * Sets the easing mode of the current function.
  5280. * @param easingMode Defines the willing mode (EASINGMODE_EASEIN, EASINGMODE_EASEOUT or EASINGMODE_EASEINOUT)
  5281. */
  5282. setEasingMode(easingMode: number): void;
  5283. /**
  5284. * Gets the current easing mode.
  5285. * @returns the easing mode
  5286. */
  5287. getEasingMode(): number;
  5288. /**
  5289. * @hidden
  5290. */
  5291. easeInCore(gradient: number): number;
  5292. /**
  5293. * Given an input gradient between 0 and 1, this returns the corresponding value
  5294. * of the easing function.
  5295. * @param gradient Defines the value between 0 and 1 we want the easing value for
  5296. * @returns the corresponding value on the curve defined by the easing function
  5297. */
  5298. ease(gradient: number): number;
  5299. }
  5300. /**
  5301. * Easing function with a circle shape (see link below).
  5302. * @see https://easings.net/#easeInCirc
  5303. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5304. */
  5305. export class CircleEase extends EasingFunction implements IEasingFunction {
  5306. /** @hidden */
  5307. easeInCore(gradient: number): number;
  5308. }
  5309. /**
  5310. * Easing function with a ease back shape (see link below).
  5311. * @see https://easings.net/#easeInBack
  5312. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5313. */
  5314. export class BackEase extends EasingFunction implements IEasingFunction {
  5315. /** Defines the amplitude of the function */
  5316. amplitude: number;
  5317. /**
  5318. * Instantiates a back ease easing
  5319. * @see https://easings.net/#easeInBack
  5320. * @param amplitude Defines the amplitude of the function
  5321. */
  5322. constructor(
  5323. /** Defines the amplitude of the function */
  5324. amplitude?: number);
  5325. /** @hidden */
  5326. easeInCore(gradient: number): number;
  5327. }
  5328. /**
  5329. * Easing function with a bouncing shape (see link below).
  5330. * @see https://easings.net/#easeInBounce
  5331. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5332. */
  5333. export class BounceEase extends EasingFunction implements IEasingFunction {
  5334. /** Defines the number of bounces */
  5335. bounces: number;
  5336. /** Defines the amplitude of the bounce */
  5337. bounciness: number;
  5338. /**
  5339. * Instantiates a bounce easing
  5340. * @see https://easings.net/#easeInBounce
  5341. * @param bounces Defines the number of bounces
  5342. * @param bounciness Defines the amplitude of the bounce
  5343. */
  5344. constructor(
  5345. /** Defines the number of bounces */
  5346. bounces?: number,
  5347. /** Defines the amplitude of the bounce */
  5348. bounciness?: number);
  5349. /** @hidden */
  5350. easeInCore(gradient: number): number;
  5351. }
  5352. /**
  5353. * Easing function with a power of 3 shape (see link below).
  5354. * @see https://easings.net/#easeInCubic
  5355. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5356. */
  5357. export class CubicEase extends EasingFunction implements IEasingFunction {
  5358. /** @hidden */
  5359. easeInCore(gradient: number): number;
  5360. }
  5361. /**
  5362. * Easing function with an elastic shape (see link below).
  5363. * @see https://easings.net/#easeInElastic
  5364. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5365. */
  5366. export class ElasticEase extends EasingFunction implements IEasingFunction {
  5367. /** Defines the number of oscillations*/
  5368. oscillations: number;
  5369. /** Defines the amplitude of the oscillations*/
  5370. springiness: number;
  5371. /**
  5372. * Instantiates an elastic easing function
  5373. * @see https://easings.net/#easeInElastic
  5374. * @param oscillations Defines the number of oscillations
  5375. * @param springiness Defines the amplitude of the oscillations
  5376. */
  5377. constructor(
  5378. /** Defines the number of oscillations*/
  5379. oscillations?: number,
  5380. /** Defines the amplitude of the oscillations*/
  5381. springiness?: number);
  5382. /** @hidden */
  5383. easeInCore(gradient: number): number;
  5384. }
  5385. /**
  5386. * Easing function with an exponential shape (see link below).
  5387. * @see https://easings.net/#easeInExpo
  5388. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5389. */
  5390. export class ExponentialEase extends EasingFunction implements IEasingFunction {
  5391. /** Defines the exponent of the function */
  5392. exponent: number;
  5393. /**
  5394. * Instantiates an exponential easing function
  5395. * @see https://easings.net/#easeInExpo
  5396. * @param exponent Defines the exponent of the function
  5397. */
  5398. constructor(
  5399. /** Defines the exponent of the function */
  5400. exponent?: number);
  5401. /** @hidden */
  5402. easeInCore(gradient: number): number;
  5403. }
  5404. /**
  5405. * Easing function with a power shape (see link below).
  5406. * @see https://easings.net/#easeInQuad
  5407. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5408. */
  5409. export class PowerEase extends EasingFunction implements IEasingFunction {
  5410. /** Defines the power of the function */
  5411. power: number;
  5412. /**
  5413. * Instantiates an power base easing function
  5414. * @see https://easings.net/#easeInQuad
  5415. * @param power Defines the power of the function
  5416. */
  5417. constructor(
  5418. /** Defines the power of the function */
  5419. power?: number);
  5420. /** @hidden */
  5421. easeInCore(gradient: number): number;
  5422. }
  5423. /**
  5424. * Easing function with a power of 2 shape (see link below).
  5425. * @see https://easings.net/#easeInQuad
  5426. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5427. */
  5428. export class QuadraticEase extends EasingFunction implements IEasingFunction {
  5429. /** @hidden */
  5430. easeInCore(gradient: number): number;
  5431. }
  5432. /**
  5433. * Easing function with a power of 4 shape (see link below).
  5434. * @see https://easings.net/#easeInQuart
  5435. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5436. */
  5437. export class QuarticEase extends EasingFunction implements IEasingFunction {
  5438. /** @hidden */
  5439. easeInCore(gradient: number): number;
  5440. }
  5441. /**
  5442. * Easing function with a power of 5 shape (see link below).
  5443. * @see https://easings.net/#easeInQuint
  5444. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5445. */
  5446. export class QuinticEase extends EasingFunction implements IEasingFunction {
  5447. /** @hidden */
  5448. easeInCore(gradient: number): number;
  5449. }
  5450. /**
  5451. * Easing function with a sin shape (see link below).
  5452. * @see https://easings.net/#easeInSine
  5453. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5454. */
  5455. export class SineEase extends EasingFunction implements IEasingFunction {
  5456. /** @hidden */
  5457. easeInCore(gradient: number): number;
  5458. }
  5459. /**
  5460. * Easing function with a bezier shape (see link below).
  5461. * @see http://cubic-bezier.com/#.17,.67,.83,.67
  5462. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5463. */
  5464. export class BezierCurveEase extends EasingFunction implements IEasingFunction {
  5465. /** Defines the x component of the start tangent in the bezier curve */
  5466. x1: number;
  5467. /** Defines the y component of the start tangent in the bezier curve */
  5468. y1: number;
  5469. /** Defines the x component of the end tangent in the bezier curve */
  5470. x2: number;
  5471. /** Defines the y component of the end tangent in the bezier curve */
  5472. y2: number;
  5473. /**
  5474. * Instantiates a bezier function
  5475. * @see http://cubic-bezier.com/#.17,.67,.83,.67
  5476. * @param x1 Defines the x component of the start tangent in the bezier curve
  5477. * @param y1 Defines the y component of the start tangent in the bezier curve
  5478. * @param x2 Defines the x component of the end tangent in the bezier curve
  5479. * @param y2 Defines the y component of the end tangent in the bezier curve
  5480. */
  5481. constructor(
  5482. /** Defines the x component of the start tangent in the bezier curve */
  5483. x1?: number,
  5484. /** Defines the y component of the start tangent in the bezier curve */
  5485. y1?: number,
  5486. /** Defines the x component of the end tangent in the bezier curve */
  5487. x2?: number,
  5488. /** Defines the y component of the end tangent in the bezier curve */
  5489. y2?: number);
  5490. /** @hidden */
  5491. easeInCore(gradient: number): number;
  5492. }
  5493. }
  5494. declare module "babylonjs/Maths/math.color" {
  5495. import { DeepImmutable, FloatArray } from "babylonjs/types";
  5496. /**
  5497. * Class used to hold a RBG color
  5498. */
  5499. export class Color3 {
  5500. /**
  5501. * Defines the red component (between 0 and 1, default is 0)
  5502. */
  5503. r: number;
  5504. /**
  5505. * Defines the green component (between 0 and 1, default is 0)
  5506. */
  5507. g: number;
  5508. /**
  5509. * Defines the blue component (between 0 and 1, default is 0)
  5510. */
  5511. b: number;
  5512. /**
  5513. * Creates a new Color3 object from red, green, blue values, all between 0 and 1
  5514. * @param r defines the red component (between 0 and 1, default is 0)
  5515. * @param g defines the green component (between 0 and 1, default is 0)
  5516. * @param b defines the blue component (between 0 and 1, default is 0)
  5517. */
  5518. constructor(
  5519. /**
  5520. * Defines the red component (between 0 and 1, default is 0)
  5521. */
  5522. r?: number,
  5523. /**
  5524. * Defines the green component (between 0 and 1, default is 0)
  5525. */
  5526. g?: number,
  5527. /**
  5528. * Defines the blue component (between 0 and 1, default is 0)
  5529. */
  5530. b?: number);
  5531. /**
  5532. * Creates a string with the Color3 current values
  5533. * @returns the string representation of the Color3 object
  5534. */
  5535. toString(): string;
  5536. /**
  5537. * Returns the string "Color3"
  5538. * @returns "Color3"
  5539. */
  5540. getClassName(): string;
  5541. /**
  5542. * Compute the Color3 hash code
  5543. * @returns an unique number that can be used to hash Color3 objects
  5544. */
  5545. getHashCode(): number;
  5546. /**
  5547. * Stores in the given array from the given starting index the red, green, blue values as successive elements
  5548. * @param array defines the array where to store the r,g,b components
  5549. * @param index defines an optional index in the target array to define where to start storing values
  5550. * @returns the current Color3 object
  5551. */
  5552. toArray(array: FloatArray, index?: number): Color3;
  5553. /**
  5554. * Returns a new Color4 object from the current Color3 and the given alpha
  5555. * @param alpha defines the alpha component on the new Color4 object (default is 1)
  5556. * @returns a new Color4 object
  5557. */
  5558. toColor4(alpha?: number): Color4;
  5559. /**
  5560. * Returns a new array populated with 3 numeric elements : red, green and blue values
  5561. * @returns the new array
  5562. */
  5563. asArray(): number[];
  5564. /**
  5565. * Returns the luminance value
  5566. * @returns a float value
  5567. */
  5568. toLuminance(): number;
  5569. /**
  5570. * Multiply each Color3 rgb values by the given Color3 rgb values in a new Color3 object
  5571. * @param otherColor defines the second operand
  5572. * @returns the new Color3 object
  5573. */
  5574. multiply(otherColor: DeepImmutable<Color3>): Color3;
  5575. /**
  5576. * Multiply the rgb values of the Color3 and the given Color3 and stores the result in the object "result"
  5577. * @param otherColor defines the second operand
  5578. * @param result defines the Color3 object where to store the result
  5579. * @returns the current Color3
  5580. */
  5581. multiplyToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  5582. /**
  5583. * Determines equality between Color3 objects
  5584. * @param otherColor defines the second operand
  5585. * @returns true if the rgb values are equal to the given ones
  5586. */
  5587. equals(otherColor: DeepImmutable<Color3>): boolean;
  5588. /**
  5589. * Determines equality between the current Color3 object and a set of r,b,g values
  5590. * @param r defines the red component to check
  5591. * @param g defines the green component to check
  5592. * @param b defines the blue component to check
  5593. * @returns true if the rgb values are equal to the given ones
  5594. */
  5595. equalsFloats(r: number, g: number, b: number): boolean;
  5596. /**
  5597. * Multiplies in place each rgb value by scale
  5598. * @param scale defines the scaling factor
  5599. * @returns the updated Color3
  5600. */
  5601. scale(scale: number): Color3;
  5602. /**
  5603. * Multiplies the rgb values by scale and stores the result into "result"
  5604. * @param scale defines the scaling factor
  5605. * @param result defines the Color3 object where to store the result
  5606. * @returns the unmodified current Color3
  5607. */
  5608. scaleToRef(scale: number, result: Color3): Color3;
  5609. /**
  5610. * Scale the current Color3 values by a factor and add the result to a given Color3
  5611. * @param scale defines the scale factor
  5612. * @param result defines color to store the result into
  5613. * @returns the unmodified current Color3
  5614. */
  5615. scaleAndAddToRef(scale: number, result: Color3): Color3;
  5616. /**
  5617. * Clamps the rgb values by the min and max values and stores the result into "result"
  5618. * @param min defines minimum clamping value (default is 0)
  5619. * @param max defines maximum clamping value (default is 1)
  5620. * @param result defines color to store the result into
  5621. * @returns the original Color3
  5622. */
  5623. clampToRef(min: number | undefined, max: number | undefined, result: Color3): Color3;
  5624. /**
  5625. * Creates a new Color3 set with the added values of the current Color3 and of the given one
  5626. * @param otherColor defines the second operand
  5627. * @returns the new Color3
  5628. */
  5629. add(otherColor: DeepImmutable<Color3>): Color3;
  5630. /**
  5631. * Stores the result of the addition of the current Color3 and given one rgb values into "result"
  5632. * @param otherColor defines the second operand
  5633. * @param result defines Color3 object to store the result into
  5634. * @returns the unmodified current Color3
  5635. */
  5636. addToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  5637. /**
  5638. * Returns a new Color3 set with the subtracted values of the given one from the current Color3
  5639. * @param otherColor defines the second operand
  5640. * @returns the new Color3
  5641. */
  5642. subtract(otherColor: DeepImmutable<Color3>): Color3;
  5643. /**
  5644. * Stores the result of the subtraction of given one from the current Color3 rgb values into "result"
  5645. * @param otherColor defines the second operand
  5646. * @param result defines Color3 object to store the result into
  5647. * @returns the unmodified current Color3
  5648. */
  5649. subtractToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  5650. /**
  5651. * Copy the current object
  5652. * @returns a new Color3 copied the current one
  5653. */
  5654. clone(): Color3;
  5655. /**
  5656. * Copies the rgb values from the source in the current Color3
  5657. * @param source defines the source Color3 object
  5658. * @returns the updated Color3 object
  5659. */
  5660. copyFrom(source: DeepImmutable<Color3>): Color3;
  5661. /**
  5662. * Updates the Color3 rgb values from the given floats
  5663. * @param r defines the red component to read from
  5664. * @param g defines the green component to read from
  5665. * @param b defines the blue component to read from
  5666. * @returns the current Color3 object
  5667. */
  5668. copyFromFloats(r: number, g: number, b: number): Color3;
  5669. /**
  5670. * Updates the Color3 rgb values from the given floats
  5671. * @param r defines the red component to read from
  5672. * @param g defines the green component to read from
  5673. * @param b defines the blue component to read from
  5674. * @returns the current Color3 object
  5675. */
  5676. set(r: number, g: number, b: number): Color3;
  5677. /**
  5678. * Compute the Color3 hexadecimal code as a string
  5679. * @returns a string containing the hexadecimal representation of the Color3 object
  5680. */
  5681. toHexString(): string;
  5682. /**
  5683. * Computes a new Color3 converted from the current one to linear space
  5684. * @returns a new Color3 object
  5685. */
  5686. toLinearSpace(): Color3;
  5687. /**
  5688. * Converts current color in rgb space to HSV values
  5689. * @returns a new color3 representing the HSV values
  5690. */
  5691. toHSV(): Color3;
  5692. /**
  5693. * Converts current color in rgb space to HSV values
  5694. * @param result defines the Color3 where to store the HSV values
  5695. */
  5696. toHSVToRef(result: Color3): void;
  5697. /**
  5698. * Converts the Color3 values to linear space and stores the result in "convertedColor"
  5699. * @param convertedColor defines the Color3 object where to store the linear space version
  5700. * @returns the unmodified Color3
  5701. */
  5702. toLinearSpaceToRef(convertedColor: Color3): Color3;
  5703. /**
  5704. * Computes a new Color3 converted from the current one to gamma space
  5705. * @returns a new Color3 object
  5706. */
  5707. toGammaSpace(): Color3;
  5708. /**
  5709. * Converts the Color3 values to gamma space and stores the result in "convertedColor"
  5710. * @param convertedColor defines the Color3 object where to store the gamma space version
  5711. * @returns the unmodified Color3
  5712. */
  5713. toGammaSpaceToRef(convertedColor: Color3): Color3;
  5714. private static _BlackReadOnly;
  5715. /**
  5716. * Convert Hue, saturation and value to a Color3 (RGB)
  5717. * @param hue defines the hue
  5718. * @param saturation defines the saturation
  5719. * @param value defines the value
  5720. * @param result defines the Color3 where to store the RGB values
  5721. */
  5722. static HSVtoRGBToRef(hue: number, saturation: number, value: number, result: Color3): void;
  5723. /**
  5724. * Creates a new Color3 from the string containing valid hexadecimal values
  5725. * @param hex defines a string containing valid hexadecimal values
  5726. * @returns a new Color3 object
  5727. */
  5728. static FromHexString(hex: string): Color3;
  5729. /**
  5730. * Creates a new Color3 from the starting index of the given array
  5731. * @param array defines the source array
  5732. * @param offset defines an offset in the source array
  5733. * @returns a new Color3 object
  5734. */
  5735. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color3;
  5736. /**
  5737. * Creates a new Color3 from integer values (< 256)
  5738. * @param r defines the red component to read from (value between 0 and 255)
  5739. * @param g defines the green component to read from (value between 0 and 255)
  5740. * @param b defines the blue component to read from (value between 0 and 255)
  5741. * @returns a new Color3 object
  5742. */
  5743. static FromInts(r: number, g: number, b: number): Color3;
  5744. /**
  5745. * Creates a new Color3 with values linearly interpolated of "amount" between the start Color3 and the end Color3
  5746. * @param start defines the start Color3 value
  5747. * @param end defines the end Color3 value
  5748. * @param amount defines the gradient value between start and end
  5749. * @returns a new Color3 object
  5750. */
  5751. static Lerp(start: DeepImmutable<Color3>, end: DeepImmutable<Color3>, amount: number): Color3;
  5752. /**
  5753. * Creates a new Color3 with values linearly interpolated of "amount" between the start Color3 and the end Color3
  5754. * @param left defines the start value
  5755. * @param right defines the end value
  5756. * @param amount defines the gradient factor
  5757. * @param result defines the Color3 object where to store the result
  5758. */
  5759. static LerpToRef(left: DeepImmutable<Color3>, right: DeepImmutable<Color3>, amount: number, result: Color3): void;
  5760. /**
  5761. * Returns a Color3 value containing a red color
  5762. * @returns a new Color3 object
  5763. */
  5764. static Red(): Color3;
  5765. /**
  5766. * Returns a Color3 value containing a green color
  5767. * @returns a new Color3 object
  5768. */
  5769. static Green(): Color3;
  5770. /**
  5771. * Returns a Color3 value containing a blue color
  5772. * @returns a new Color3 object
  5773. */
  5774. static Blue(): Color3;
  5775. /**
  5776. * Returns a Color3 value containing a black color
  5777. * @returns a new Color3 object
  5778. */
  5779. static Black(): Color3;
  5780. /**
  5781. * Gets a Color3 value containing a black color that must not be updated
  5782. */
  5783. static get BlackReadOnly(): DeepImmutable<Color3>;
  5784. /**
  5785. * Returns a Color3 value containing a white color
  5786. * @returns a new Color3 object
  5787. */
  5788. static White(): Color3;
  5789. /**
  5790. * Returns a Color3 value containing a purple color
  5791. * @returns a new Color3 object
  5792. */
  5793. static Purple(): Color3;
  5794. /**
  5795. * Returns a Color3 value containing a magenta color
  5796. * @returns a new Color3 object
  5797. */
  5798. static Magenta(): Color3;
  5799. /**
  5800. * Returns a Color3 value containing a yellow color
  5801. * @returns a new Color3 object
  5802. */
  5803. static Yellow(): Color3;
  5804. /**
  5805. * Returns a Color3 value containing a gray color
  5806. * @returns a new Color3 object
  5807. */
  5808. static Gray(): Color3;
  5809. /**
  5810. * Returns a Color3 value containing a teal color
  5811. * @returns a new Color3 object
  5812. */
  5813. static Teal(): Color3;
  5814. /**
  5815. * Returns a Color3 value containing a random color
  5816. * @returns a new Color3 object
  5817. */
  5818. static Random(): Color3;
  5819. }
  5820. /**
  5821. * Class used to hold a RBGA color
  5822. */
  5823. export class Color4 {
  5824. /**
  5825. * Defines the red component (between 0 and 1, default is 0)
  5826. */
  5827. r: number;
  5828. /**
  5829. * Defines the green component (between 0 and 1, default is 0)
  5830. */
  5831. g: number;
  5832. /**
  5833. * Defines the blue component (between 0 and 1, default is 0)
  5834. */
  5835. b: number;
  5836. /**
  5837. * Defines the alpha component (between 0 and 1, default is 1)
  5838. */
  5839. a: number;
  5840. /**
  5841. * Creates a new Color4 object from red, green, blue values, all between 0 and 1
  5842. * @param r defines the red component (between 0 and 1, default is 0)
  5843. * @param g defines the green component (between 0 and 1, default is 0)
  5844. * @param b defines the blue component (between 0 and 1, default is 0)
  5845. * @param a defines the alpha component (between 0 and 1, default is 1)
  5846. */
  5847. constructor(
  5848. /**
  5849. * Defines the red component (between 0 and 1, default is 0)
  5850. */
  5851. r?: number,
  5852. /**
  5853. * Defines the green component (between 0 and 1, default is 0)
  5854. */
  5855. g?: number,
  5856. /**
  5857. * Defines the blue component (between 0 and 1, default is 0)
  5858. */
  5859. b?: number,
  5860. /**
  5861. * Defines the alpha component (between 0 and 1, default is 1)
  5862. */
  5863. a?: number);
  5864. /**
  5865. * Adds in place the given Color4 values to the current Color4 object
  5866. * @param right defines the second operand
  5867. * @returns the current updated Color4 object
  5868. */
  5869. addInPlace(right: DeepImmutable<Color4>): Color4;
  5870. /**
  5871. * Creates a new array populated with 4 numeric elements : red, green, blue, alpha values
  5872. * @returns the new array
  5873. */
  5874. asArray(): number[];
  5875. /**
  5876. * Stores from the starting index in the given array the Color4 successive values
  5877. * @param array defines the array where to store the r,g,b components
  5878. * @param index defines an optional index in the target array to define where to start storing values
  5879. * @returns the current Color4 object
  5880. */
  5881. toArray(array: number[], index?: number): Color4;
  5882. /**
  5883. * Determines equality between Color4 objects
  5884. * @param otherColor defines the second operand
  5885. * @returns true if the rgba values are equal to the given ones
  5886. */
  5887. equals(otherColor: DeepImmutable<Color4>): boolean;
  5888. /**
  5889. * Creates a new Color4 set with the added values of the current Color4 and of the given one
  5890. * @param right defines the second operand
  5891. * @returns a new Color4 object
  5892. */
  5893. add(right: DeepImmutable<Color4>): Color4;
  5894. /**
  5895. * Creates a new Color4 set with the subtracted values of the given one from the current Color4
  5896. * @param right defines the second operand
  5897. * @returns a new Color4 object
  5898. */
  5899. subtract(right: DeepImmutable<Color4>): Color4;
  5900. /**
  5901. * Subtracts the given ones from the current Color4 values and stores the results in "result"
  5902. * @param right defines the second operand
  5903. * @param result defines the Color4 object where to store the result
  5904. * @returns the current Color4 object
  5905. */
  5906. subtractToRef(right: DeepImmutable<Color4>, result: Color4): Color4;
  5907. /**
  5908. * Creates a new Color4 with the current Color4 values multiplied by scale
  5909. * @param scale defines the scaling factor to apply
  5910. * @returns a new Color4 object
  5911. */
  5912. scale(scale: number): Color4;
  5913. /**
  5914. * Multiplies the current Color4 values by scale and stores the result in "result"
  5915. * @param scale defines the scaling factor to apply
  5916. * @param result defines the Color4 object where to store the result
  5917. * @returns the current unmodified Color4
  5918. */
  5919. scaleToRef(scale: number, result: Color4): Color4;
  5920. /**
  5921. * Scale the current Color4 values by a factor and add the result to a given Color4
  5922. * @param scale defines the scale factor
  5923. * @param result defines the Color4 object where to store the result
  5924. * @returns the unmodified current Color4
  5925. */
  5926. scaleAndAddToRef(scale: number, result: Color4): Color4;
  5927. /**
  5928. * Clamps the rgb values by the min and max values and stores the result into "result"
  5929. * @param min defines minimum clamping value (default is 0)
  5930. * @param max defines maximum clamping value (default is 1)
  5931. * @param result defines color to store the result into.
  5932. * @returns the cuurent Color4
  5933. */
  5934. clampToRef(min: number | undefined, max: number | undefined, result: Color4): Color4;
  5935. /**
  5936. * Multipy an Color4 value by another and return a new Color4 object
  5937. * @param color defines the Color4 value to multiply by
  5938. * @returns a new Color4 object
  5939. */
  5940. multiply(color: Color4): Color4;
  5941. /**
  5942. * Multipy a Color4 value by another and push the result in a reference value
  5943. * @param color defines the Color4 value to multiply by
  5944. * @param result defines the Color4 to fill the result in
  5945. * @returns the result Color4
  5946. */
  5947. multiplyToRef(color: Color4, result: Color4): Color4;
  5948. /**
  5949. * Creates a string with the Color4 current values
  5950. * @returns the string representation of the Color4 object
  5951. */
  5952. toString(): string;
  5953. /**
  5954. * Returns the string "Color4"
  5955. * @returns "Color4"
  5956. */
  5957. getClassName(): string;
  5958. /**
  5959. * Compute the Color4 hash code
  5960. * @returns an unique number that can be used to hash Color4 objects
  5961. */
  5962. getHashCode(): number;
  5963. /**
  5964. * Creates a new Color4 copied from the current one
  5965. * @returns a new Color4 object
  5966. */
  5967. clone(): Color4;
  5968. /**
  5969. * Copies the given Color4 values into the current one
  5970. * @param source defines the source Color4 object
  5971. * @returns the current updated Color4 object
  5972. */
  5973. copyFrom(source: Color4): Color4;
  5974. /**
  5975. * Copies the given float values into the current one
  5976. * @param r defines the red component to read from
  5977. * @param g defines the green component to read from
  5978. * @param b defines the blue component to read from
  5979. * @param a defines the alpha component to read from
  5980. * @returns the current updated Color4 object
  5981. */
  5982. copyFromFloats(r: number, g: number, b: number, a: number): Color4;
  5983. /**
  5984. * Copies the given float values into the current one
  5985. * @param r defines the red component to read from
  5986. * @param g defines the green component to read from
  5987. * @param b defines the blue component to read from
  5988. * @param a defines the alpha component to read from
  5989. * @returns the current updated Color4 object
  5990. */
  5991. set(r: number, g: number, b: number, a: number): Color4;
  5992. /**
  5993. * Compute the Color4 hexadecimal code as a string
  5994. * @param returnAsColor3 defines if the string should only contains RGB values (off by default)
  5995. * @returns a string containing the hexadecimal representation of the Color4 object
  5996. */
  5997. toHexString(returnAsColor3?: boolean): string;
  5998. /**
  5999. * Computes a new Color4 converted from the current one to linear space
  6000. * @returns a new Color4 object
  6001. */
  6002. toLinearSpace(): Color4;
  6003. /**
  6004. * Converts the Color4 values to linear space and stores the result in "convertedColor"
  6005. * @param convertedColor defines the Color4 object where to store the linear space version
  6006. * @returns the unmodified Color4
  6007. */
  6008. toLinearSpaceToRef(convertedColor: Color4): Color4;
  6009. /**
  6010. * Computes a new Color4 converted from the current one to gamma space
  6011. * @returns a new Color4 object
  6012. */
  6013. toGammaSpace(): Color4;
  6014. /**
  6015. * Converts the Color4 values to gamma space and stores the result in "convertedColor"
  6016. * @param convertedColor defines the Color4 object where to store the gamma space version
  6017. * @returns the unmodified Color4
  6018. */
  6019. toGammaSpaceToRef(convertedColor: Color4): Color4;
  6020. /**
  6021. * Creates a new Color4 from the string containing valid hexadecimal values
  6022. * @param hex defines a string containing valid hexadecimal values
  6023. * @returns a new Color4 object
  6024. */
  6025. static FromHexString(hex: string): Color4;
  6026. /**
  6027. * Creates a new Color4 object set with the linearly interpolated values of "amount" between the left Color4 object and the right Color4 object
  6028. * @param left defines the start value
  6029. * @param right defines the end value
  6030. * @param amount defines the gradient factor
  6031. * @returns a new Color4 object
  6032. */
  6033. static Lerp(left: DeepImmutable<Color4>, right: DeepImmutable<Color4>, amount: number): Color4;
  6034. /**
  6035. * Set the given "result" with the linearly interpolated values of "amount" between the left Color4 object and the right Color4 object
  6036. * @param left defines the start value
  6037. * @param right defines the end value
  6038. * @param amount defines the gradient factor
  6039. * @param result defines the Color4 object where to store data
  6040. */
  6041. static LerpToRef(left: DeepImmutable<Color4>, right: DeepImmutable<Color4>, amount: number, result: Color4): void;
  6042. /**
  6043. * Creates a new Color4 from a Color3 and an alpha value
  6044. * @param color3 defines the source Color3 to read from
  6045. * @param alpha defines the alpha component (1.0 by default)
  6046. * @returns a new Color4 object
  6047. */
  6048. static FromColor3(color3: DeepImmutable<Color3>, alpha?: number): Color4;
  6049. /**
  6050. * Creates a new Color4 from the starting index element of the given array
  6051. * @param array defines the source array to read from
  6052. * @param offset defines the offset in the source array
  6053. * @returns a new Color4 object
  6054. */
  6055. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color4;
  6056. /**
  6057. * Creates a new Color3 from integer values (< 256)
  6058. * @param r defines the red component to read from (value between 0 and 255)
  6059. * @param g defines the green component to read from (value between 0 and 255)
  6060. * @param b defines the blue component to read from (value between 0 and 255)
  6061. * @param a defines the alpha component to read from (value between 0 and 255)
  6062. * @returns a new Color3 object
  6063. */
  6064. static FromInts(r: number, g: number, b: number, a: number): Color4;
  6065. /**
  6066. * Check the content of a given array and convert it to an array containing RGBA data
  6067. * If the original array was already containing count * 4 values then it is returned directly
  6068. * @param colors defines the array to check
  6069. * @param count defines the number of RGBA data to expect
  6070. * @returns an array containing count * 4 values (RGBA)
  6071. */
  6072. static CheckColors4(colors: number[], count: number): number[];
  6073. }
  6074. /**
  6075. * @hidden
  6076. */
  6077. export class TmpColors {
  6078. static Color3: Color3[];
  6079. static Color4: Color4[];
  6080. }
  6081. }
  6082. declare module "babylonjs/Animations/animationKey" {
  6083. /**
  6084. * Defines an interface which represents an animation key frame
  6085. */
  6086. export interface IAnimationKey {
  6087. /**
  6088. * Frame of the key frame
  6089. */
  6090. frame: number;
  6091. /**
  6092. * Value at the specifies key frame
  6093. */
  6094. value: any;
  6095. /**
  6096. * The input tangent for the cubic hermite spline
  6097. */
  6098. inTangent?: any;
  6099. /**
  6100. * The output tangent for the cubic hermite spline
  6101. */
  6102. outTangent?: any;
  6103. /**
  6104. * The animation interpolation type
  6105. */
  6106. interpolation?: AnimationKeyInterpolation;
  6107. }
  6108. /**
  6109. * Enum for the animation key frame interpolation type
  6110. */
  6111. export enum AnimationKeyInterpolation {
  6112. /**
  6113. * Do not interpolate between keys and use the start key value only. Tangents are ignored
  6114. */
  6115. STEP = 1
  6116. }
  6117. }
  6118. declare module "babylonjs/Animations/animationRange" {
  6119. /**
  6120. * Represents the range of an animation
  6121. */
  6122. export class AnimationRange {
  6123. /**The name of the animation range**/
  6124. name: string;
  6125. /**The starting frame of the animation */
  6126. from: number;
  6127. /**The ending frame of the animation*/
  6128. to: number;
  6129. /**
  6130. * Initializes the range of an animation
  6131. * @param name The name of the animation range
  6132. * @param from The starting frame of the animation
  6133. * @param to The ending frame of the animation
  6134. */
  6135. constructor(
  6136. /**The name of the animation range**/
  6137. name: string,
  6138. /**The starting frame of the animation */
  6139. from: number,
  6140. /**The ending frame of the animation*/
  6141. to: number);
  6142. /**
  6143. * Makes a copy of the animation range
  6144. * @returns A copy of the animation range
  6145. */
  6146. clone(): AnimationRange;
  6147. }
  6148. }
  6149. declare module "babylonjs/Animations/animationEvent" {
  6150. /**
  6151. * Composed of a frame, and an action function
  6152. */
  6153. export class AnimationEvent {
  6154. /** The frame for which the event is triggered **/
  6155. frame: number;
  6156. /** The event to perform when triggered **/
  6157. action: (currentFrame: number) => void;
  6158. /** Specifies if the event should be triggered only once**/
  6159. onlyOnce?: boolean | undefined;
  6160. /**
  6161. * Specifies if the animation event is done
  6162. */
  6163. isDone: boolean;
  6164. /**
  6165. * Initializes the animation event
  6166. * @param frame The frame for which the event is triggered
  6167. * @param action The event to perform when triggered
  6168. * @param onlyOnce Specifies if the event should be triggered only once
  6169. */
  6170. constructor(
  6171. /** The frame for which the event is triggered **/
  6172. frame: number,
  6173. /** The event to perform when triggered **/
  6174. action: (currentFrame: number) => void,
  6175. /** Specifies if the event should be triggered only once**/
  6176. onlyOnce?: boolean | undefined);
  6177. /** @hidden */
  6178. _clone(): AnimationEvent;
  6179. }
  6180. }
  6181. declare module "babylonjs/Behaviors/behavior" {
  6182. import { Nullable } from "babylonjs/types";
  6183. /**
  6184. * Interface used to define a behavior
  6185. */
  6186. export interface Behavior<T> {
  6187. /** gets or sets behavior's name */
  6188. name: string;
  6189. /**
  6190. * Function called when the behavior needs to be initialized (after attaching it to a target)
  6191. */
  6192. init(): void;
  6193. /**
  6194. * Called when the behavior is attached to a target
  6195. * @param target defines the target where the behavior is attached to
  6196. */
  6197. attach(target: T): void;
  6198. /**
  6199. * Called when the behavior is detached from its target
  6200. */
  6201. detach(): void;
  6202. }
  6203. /**
  6204. * Interface implemented by classes supporting behaviors
  6205. */
  6206. export interface IBehaviorAware<T> {
  6207. /**
  6208. * Attach a behavior
  6209. * @param behavior defines the behavior to attach
  6210. * @returns the current host
  6211. */
  6212. addBehavior(behavior: Behavior<T>): T;
  6213. /**
  6214. * Remove a behavior from the current object
  6215. * @param behavior defines the behavior to detach
  6216. * @returns the current host
  6217. */
  6218. removeBehavior(behavior: Behavior<T>): T;
  6219. /**
  6220. * Gets a behavior using its name to search
  6221. * @param name defines the name to search
  6222. * @returns the behavior or null if not found
  6223. */
  6224. getBehaviorByName(name: string): Nullable<Behavior<T>>;
  6225. }
  6226. }
  6227. declare module "babylonjs/Misc/smartArray" {
  6228. /**
  6229. * Defines an array and its length.
  6230. * It can be helpfull to group result from both Arrays and smart arrays in one structure.
  6231. */
  6232. export interface ISmartArrayLike<T> {
  6233. /**
  6234. * The data of the array.
  6235. */
  6236. data: Array<T>;
  6237. /**
  6238. * The active length of the array.
  6239. */
  6240. length: number;
  6241. }
  6242. /**
  6243. * Defines an GC Friendly array where the backfield array do not shrink to prevent over allocations.
  6244. */
  6245. export class SmartArray<T> implements ISmartArrayLike<T> {
  6246. /**
  6247. * The full set of data from the array.
  6248. */
  6249. data: Array<T>;
  6250. /**
  6251. * The active length of the array.
  6252. */
  6253. length: number;
  6254. protected _id: number;
  6255. /**
  6256. * Instantiates a Smart Array.
  6257. * @param capacity defines the default capacity of the array.
  6258. */
  6259. constructor(capacity: number);
  6260. /**
  6261. * Pushes a value at the end of the active data.
  6262. * @param value defines the object to push in the array.
  6263. */
  6264. push(value: T): void;
  6265. /**
  6266. * Iterates over the active data and apply the lambda to them.
  6267. * @param func defines the action to apply on each value.
  6268. */
  6269. forEach(func: (content: T) => void): void;
  6270. /**
  6271. * Sorts the full sets of data.
  6272. * @param compareFn defines the comparison function to apply.
  6273. */
  6274. sort(compareFn: (a: T, b: T) => number): void;
  6275. /**
  6276. * Resets the active data to an empty array.
  6277. */
  6278. reset(): void;
  6279. /**
  6280. * Releases all the data from the array as well as the array.
  6281. */
  6282. dispose(): void;
  6283. /**
  6284. * Concats the active data with a given array.
  6285. * @param array defines the data to concatenate with.
  6286. */
  6287. concat(array: any): void;
  6288. /**
  6289. * Returns the position of a value in the active data.
  6290. * @param value defines the value to find the index for
  6291. * @returns the index if found in the active data otherwise -1
  6292. */
  6293. indexOf(value: T): number;
  6294. /**
  6295. * Returns whether an element is part of the active data.
  6296. * @param value defines the value to look for
  6297. * @returns true if found in the active data otherwise false
  6298. */
  6299. contains(value: T): boolean;
  6300. private static _GlobalId;
  6301. }
  6302. /**
  6303. * Defines an GC Friendly array where the backfield array do not shrink to prevent over allocations.
  6304. * The data in this array can only be present once
  6305. */
  6306. export class SmartArrayNoDuplicate<T> extends SmartArray<T> {
  6307. private _duplicateId;
  6308. /**
  6309. * Pushes a value at the end of the active data.
  6310. * THIS DOES NOT PREVENT DUPPLICATE DATA
  6311. * @param value defines the object to push in the array.
  6312. */
  6313. push(value: T): void;
  6314. /**
  6315. * Pushes a value at the end of the active data.
  6316. * If the data is already present, it won t be added again
  6317. * @param value defines the object to push in the array.
  6318. * @returns true if added false if it was already present
  6319. */
  6320. pushNoDuplicate(value: T): boolean;
  6321. /**
  6322. * Resets the active data to an empty array.
  6323. */
  6324. reset(): void;
  6325. /**
  6326. * Concats the active data with a given array.
  6327. * This ensures no dupplicate will be present in the result.
  6328. * @param array defines the data to concatenate with.
  6329. */
  6330. concatWithNoDuplicate(array: any): void;
  6331. }
  6332. }
  6333. declare module "babylonjs/Cameras/cameraInputsManager" {
  6334. import { Nullable } from "babylonjs/types";
  6335. import { Camera } from "babylonjs/Cameras/camera";
  6336. /**
  6337. * @ignore
  6338. * This is a list of all the different input types that are available in the application.
  6339. * Fo instance: ArcRotateCameraGamepadInput...
  6340. */
  6341. export var CameraInputTypes: {};
  6342. /**
  6343. * This is the contract to implement in order to create a new input class.
  6344. * Inputs are dealing with listening to user actions and moving the camera accordingly.
  6345. */
  6346. export interface ICameraInput<TCamera extends Camera> {
  6347. /**
  6348. * Defines the camera the input is attached to.
  6349. */
  6350. camera: Nullable<TCamera>;
  6351. /**
  6352. * Gets the class name of the current intput.
  6353. * @returns the class name
  6354. */
  6355. getClassName(): string;
  6356. /**
  6357. * Get the friendly name associated with the input class.
  6358. * @returns the input friendly name
  6359. */
  6360. getSimpleName(): string;
  6361. /**
  6362. * Attach the input controls to a specific dom element to get the input from.
  6363. * @param element Defines the element the controls should be listened from
  6364. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  6365. */
  6366. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  6367. /**
  6368. * Detach the current controls from the specified dom element.
  6369. * @param element Defines the element to stop listening the inputs from
  6370. */
  6371. detachControl(element: Nullable<HTMLElement>): void;
  6372. /**
  6373. * Update the current camera state depending on the inputs that have been used this frame.
  6374. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  6375. */
  6376. checkInputs?: () => void;
  6377. }
  6378. /**
  6379. * Represents a map of input types to input instance or input index to input instance.
  6380. */
  6381. export interface CameraInputsMap<TCamera extends Camera> {
  6382. /**
  6383. * Accessor to the input by input type.
  6384. */
  6385. [name: string]: ICameraInput<TCamera>;
  6386. /**
  6387. * Accessor to the input by input index.
  6388. */
  6389. [idx: number]: ICameraInput<TCamera>;
  6390. }
  6391. /**
  6392. * This represents the input manager used within a camera.
  6393. * It helps dealing with all the different kind of input attached to a camera.
  6394. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  6395. */
  6396. export class CameraInputsManager<TCamera extends Camera> {
  6397. /**
  6398. * Defines the list of inputs attahed to the camera.
  6399. */
  6400. attached: CameraInputsMap<TCamera>;
  6401. /**
  6402. * Defines the dom element the camera is collecting inputs from.
  6403. * This is null if the controls have not been attached.
  6404. */
  6405. attachedElement: Nullable<HTMLElement>;
  6406. /**
  6407. * Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  6408. */
  6409. noPreventDefault: boolean;
  6410. /**
  6411. * Defined the camera the input manager belongs to.
  6412. */
  6413. camera: TCamera;
  6414. /**
  6415. * Update the current camera state depending on the inputs that have been used this frame.
  6416. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  6417. */
  6418. checkInputs: () => void;
  6419. /**
  6420. * Instantiate a new Camera Input Manager.
  6421. * @param camera Defines the camera the input manager blongs to
  6422. */
  6423. constructor(camera: TCamera);
  6424. /**
  6425. * Add an input method to a camera
  6426. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  6427. * @param input camera input method
  6428. */
  6429. add(input: ICameraInput<TCamera>): void;
  6430. /**
  6431. * Remove a specific input method from a camera
  6432. * example: camera.inputs.remove(camera.inputs.attached.mouse);
  6433. * @param inputToRemove camera input method
  6434. */
  6435. remove(inputToRemove: ICameraInput<TCamera>): void;
  6436. /**
  6437. * Remove a specific input type from a camera
  6438. * example: camera.inputs.remove("ArcRotateCameraGamepadInput");
  6439. * @param inputType the type of the input to remove
  6440. */
  6441. removeByType(inputType: string): void;
  6442. private _addCheckInputs;
  6443. /**
  6444. * Attach the input controls to the currently attached dom element to listen the events from.
  6445. * @param input Defines the input to attach
  6446. */
  6447. attachInput(input: ICameraInput<TCamera>): void;
  6448. /**
  6449. * Attach the current manager inputs controls to a specific dom element to listen the events from.
  6450. * @param element Defines the dom element to collect the events from
  6451. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  6452. */
  6453. attachElement(element: HTMLElement, noPreventDefault?: boolean): void;
  6454. /**
  6455. * Detach the current manager inputs controls from a specific dom element.
  6456. * @param element Defines the dom element to collect the events from
  6457. * @param disconnect Defines whether the input should be removed from the current list of attached inputs
  6458. */
  6459. detachElement(element: HTMLElement, disconnect?: boolean): void;
  6460. /**
  6461. * Rebuild the dynamic inputCheck function from the current list of
  6462. * defined inputs in the manager.
  6463. */
  6464. rebuildInputCheck(): void;
  6465. /**
  6466. * Remove all attached input methods from a camera
  6467. */
  6468. clear(): void;
  6469. /**
  6470. * Serialize the current input manager attached to a camera.
  6471. * This ensures than once parsed,
  6472. * the input associated to the camera will be identical to the current ones
  6473. * @param serializedCamera Defines the camera serialization JSON the input serialization should write to
  6474. */
  6475. serialize(serializedCamera: any): void;
  6476. /**
  6477. * Parses an input manager serialized JSON to restore the previous list of inputs
  6478. * and states associated to a camera.
  6479. * @param parsedCamera Defines the JSON to parse
  6480. */
  6481. parse(parsedCamera: any): void;
  6482. }
  6483. }
  6484. declare module "babylonjs/Meshes/buffer" {
  6485. import { Nullable, DataArray } from "babylonjs/types";
  6486. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  6487. /**
  6488. * Class used to store data that will be store in GPU memory
  6489. */
  6490. export class Buffer {
  6491. private _engine;
  6492. private _buffer;
  6493. /** @hidden */
  6494. _data: Nullable<DataArray>;
  6495. private _updatable;
  6496. private _instanced;
  6497. private _divisor;
  6498. /**
  6499. * Gets the byte stride.
  6500. */
  6501. readonly byteStride: number;
  6502. /**
  6503. * Constructor
  6504. * @param engine the engine
  6505. * @param data the data to use for this buffer
  6506. * @param updatable whether the data is updatable
  6507. * @param stride the stride (optional)
  6508. * @param postponeInternalCreation whether to postpone creating the internal WebGL buffer (optional)
  6509. * @param instanced whether the buffer is instanced (optional)
  6510. * @param useBytes set to true if the stride in in bytes (optional)
  6511. * @param divisor sets an optional divisor for instances (1 by default)
  6512. */
  6513. constructor(engine: any, data: DataArray, updatable: boolean, stride?: number, postponeInternalCreation?: boolean, instanced?: boolean, useBytes?: boolean, divisor?: number);
  6514. /**
  6515. * Create a new VertexBuffer based on the current buffer
  6516. * @param kind defines the vertex buffer kind (position, normal, etc.)
  6517. * @param offset defines offset in the buffer (0 by default)
  6518. * @param size defines the size in floats of attributes (position is 3 for instance)
  6519. * @param stride defines the stride size in floats in the buffer (the offset to apply to reach next value when data is interleaved)
  6520. * @param instanced defines if the vertex buffer contains indexed data
  6521. * @param useBytes defines if the offset and stride are in bytes *
  6522. * @param divisor sets an optional divisor for instances (1 by default)
  6523. * @returns the new vertex buffer
  6524. */
  6525. createVertexBuffer(kind: string, offset: number, size: number, stride?: number, instanced?: boolean, useBytes?: boolean, divisor?: number): VertexBuffer;
  6526. /**
  6527. * Gets a boolean indicating if the Buffer is updatable?
  6528. * @returns true if the buffer is updatable
  6529. */
  6530. isUpdatable(): boolean;
  6531. /**
  6532. * Gets current buffer's data
  6533. * @returns a DataArray or null
  6534. */
  6535. getData(): Nullable<DataArray>;
  6536. /**
  6537. * Gets underlying native buffer
  6538. * @returns underlying native buffer
  6539. */
  6540. getBuffer(): Nullable<DataBuffer>;
  6541. /**
  6542. * Gets the stride in float32 units (i.e. byte stride / 4).
  6543. * May not be an integer if the byte stride is not divisible by 4.
  6544. * @returns the stride in float32 units
  6545. * @deprecated Please use byteStride instead.
  6546. */
  6547. getStrideSize(): number;
  6548. /**
  6549. * Store data into the buffer. If the buffer was already used it will be either recreated or updated depending on isUpdatable property
  6550. * @param data defines the data to store
  6551. */
  6552. create(data?: Nullable<DataArray>): void;
  6553. /** @hidden */
  6554. _rebuild(): void;
  6555. /**
  6556. * Update current buffer data
  6557. * @param data defines the data to store
  6558. */
  6559. update(data: DataArray): void;
  6560. /**
  6561. * Updates the data directly.
  6562. * @param data the new data
  6563. * @param offset the new offset
  6564. * @param vertexCount the vertex count (optional)
  6565. * @param useBytes set to true if the offset is in bytes
  6566. */
  6567. updateDirectly(data: DataArray, offset: number, vertexCount?: number, useBytes?: boolean): void;
  6568. /**
  6569. * Release all resources
  6570. */
  6571. dispose(): void;
  6572. }
  6573. /**
  6574. * Specialized buffer used to store vertex data
  6575. */
  6576. export class VertexBuffer {
  6577. /** @hidden */
  6578. _buffer: Buffer;
  6579. private _kind;
  6580. private _size;
  6581. private _ownsBuffer;
  6582. private _instanced;
  6583. private _instanceDivisor;
  6584. /**
  6585. * The byte type.
  6586. */
  6587. static readonly BYTE: number;
  6588. /**
  6589. * The unsigned byte type.
  6590. */
  6591. static readonly UNSIGNED_BYTE: number;
  6592. /**
  6593. * The short type.
  6594. */
  6595. static readonly SHORT: number;
  6596. /**
  6597. * The unsigned short type.
  6598. */
  6599. static readonly UNSIGNED_SHORT: number;
  6600. /**
  6601. * The integer type.
  6602. */
  6603. static readonly INT: number;
  6604. /**
  6605. * The unsigned integer type.
  6606. */
  6607. static readonly UNSIGNED_INT: number;
  6608. /**
  6609. * The float type.
  6610. */
  6611. static readonly FLOAT: number;
  6612. /**
  6613. * Gets or sets the instance divisor when in instanced mode
  6614. */
  6615. get instanceDivisor(): number;
  6616. set instanceDivisor(value: number);
  6617. /**
  6618. * Gets the byte stride.
  6619. */
  6620. readonly byteStride: number;
  6621. /**
  6622. * Gets the byte offset.
  6623. */
  6624. readonly byteOffset: number;
  6625. /**
  6626. * Gets whether integer data values should be normalized into a certain range when being casted to a float.
  6627. */
  6628. readonly normalized: boolean;
  6629. /**
  6630. * Gets the data type of each component in the array.
  6631. */
  6632. readonly type: number;
  6633. /**
  6634. * Constructor
  6635. * @param engine the engine
  6636. * @param data the data to use for this vertex buffer
  6637. * @param kind the vertex buffer kind
  6638. * @param updatable whether the data is updatable
  6639. * @param postponeInternalCreation whether to postpone creating the internal WebGL buffer (optional)
  6640. * @param stride the stride (optional)
  6641. * @param instanced whether the buffer is instanced (optional)
  6642. * @param offset the offset of the data (optional)
  6643. * @param size the number of components (optional)
  6644. * @param type the type of the component (optional)
  6645. * @param normalized whether the data contains normalized data (optional)
  6646. * @param useBytes set to true if stride and offset are in bytes (optional)
  6647. * @param divisor defines the instance divisor to use (1 by default)
  6648. */
  6649. 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);
  6650. /** @hidden */
  6651. _rebuild(): void;
  6652. /**
  6653. * Returns the kind of the VertexBuffer (string)
  6654. * @returns a string
  6655. */
  6656. getKind(): string;
  6657. /**
  6658. * Gets a boolean indicating if the VertexBuffer is updatable?
  6659. * @returns true if the buffer is updatable
  6660. */
  6661. isUpdatable(): boolean;
  6662. /**
  6663. * Gets current buffer's data
  6664. * @returns a DataArray or null
  6665. */
  6666. getData(): Nullable<DataArray>;
  6667. /**
  6668. * Gets underlying native buffer
  6669. * @returns underlying native buffer
  6670. */
  6671. getBuffer(): Nullable<DataBuffer>;
  6672. /**
  6673. * Gets the stride in float32 units (i.e. byte stride / 4).
  6674. * May not be an integer if the byte stride is not divisible by 4.
  6675. * @returns the stride in float32 units
  6676. * @deprecated Please use byteStride instead.
  6677. */
  6678. getStrideSize(): number;
  6679. /**
  6680. * Returns the offset as a multiple of the type byte length.
  6681. * @returns the offset in bytes
  6682. * @deprecated Please use byteOffset instead.
  6683. */
  6684. getOffset(): number;
  6685. /**
  6686. * Returns the number of components per vertex attribute (integer)
  6687. * @returns the size in float
  6688. */
  6689. getSize(): number;
  6690. /**
  6691. * Gets a boolean indicating is the internal buffer of the VertexBuffer is instanced
  6692. * @returns true if this buffer is instanced
  6693. */
  6694. getIsInstanced(): boolean;
  6695. /**
  6696. * Returns the instancing divisor, zero for non-instanced (integer).
  6697. * @returns a number
  6698. */
  6699. getInstanceDivisor(): number;
  6700. /**
  6701. * Store data into the buffer. If the buffer was already used it will be either recreated or updated depending on isUpdatable property
  6702. * @param data defines the data to store
  6703. */
  6704. create(data?: DataArray): void;
  6705. /**
  6706. * Updates the underlying buffer according to the passed numeric array or Float32Array.
  6707. * This function will create a new buffer if the current one is not updatable
  6708. * @param data defines the data to store
  6709. */
  6710. update(data: DataArray): void;
  6711. /**
  6712. * Updates directly the underlying WebGLBuffer according to the passed numeric array or Float32Array.
  6713. * Returns the directly updated WebGLBuffer.
  6714. * @param data the new data
  6715. * @param offset the new offset
  6716. * @param useBytes set to true if the offset is in bytes
  6717. */
  6718. updateDirectly(data: DataArray, offset: number, useBytes?: boolean): void;
  6719. /**
  6720. * Disposes the VertexBuffer and the underlying WebGLBuffer.
  6721. */
  6722. dispose(): void;
  6723. /**
  6724. * Enumerates each value of this vertex buffer as numbers.
  6725. * @param count the number of values to enumerate
  6726. * @param callback the callback function called for each value
  6727. */
  6728. forEach(count: number, callback: (value: number, index: number) => void): void;
  6729. /**
  6730. * Positions
  6731. */
  6732. static readonly PositionKind: string;
  6733. /**
  6734. * Normals
  6735. */
  6736. static readonly NormalKind: string;
  6737. /**
  6738. * Tangents
  6739. */
  6740. static readonly TangentKind: string;
  6741. /**
  6742. * Texture coordinates
  6743. */
  6744. static readonly UVKind: string;
  6745. /**
  6746. * Texture coordinates 2
  6747. */
  6748. static readonly UV2Kind: string;
  6749. /**
  6750. * Texture coordinates 3
  6751. */
  6752. static readonly UV3Kind: string;
  6753. /**
  6754. * Texture coordinates 4
  6755. */
  6756. static readonly UV4Kind: string;
  6757. /**
  6758. * Texture coordinates 5
  6759. */
  6760. static readonly UV5Kind: string;
  6761. /**
  6762. * Texture coordinates 6
  6763. */
  6764. static readonly UV6Kind: string;
  6765. /**
  6766. * Colors
  6767. */
  6768. static readonly ColorKind: string;
  6769. /**
  6770. * Matrix indices (for bones)
  6771. */
  6772. static readonly MatricesIndicesKind: string;
  6773. /**
  6774. * Matrix weights (for bones)
  6775. */
  6776. static readonly MatricesWeightsKind: string;
  6777. /**
  6778. * Additional matrix indices (for bones)
  6779. */
  6780. static readonly MatricesIndicesExtraKind: string;
  6781. /**
  6782. * Additional matrix weights (for bones)
  6783. */
  6784. static readonly MatricesWeightsExtraKind: string;
  6785. /**
  6786. * Deduces the stride given a kind.
  6787. * @param kind The kind string to deduce
  6788. * @returns The deduced stride
  6789. */
  6790. static DeduceStride(kind: string): number;
  6791. /**
  6792. * Gets the byte length of the given type.
  6793. * @param type the type
  6794. * @returns the number of bytes
  6795. */
  6796. static GetTypeByteLength(type: number): number;
  6797. /**
  6798. * Enumerates each value of the given parameters as numbers.
  6799. * @param data the data to enumerate
  6800. * @param byteOffset the byte offset of the data
  6801. * @param byteStride the byte stride of the data
  6802. * @param componentCount the number of components per element
  6803. * @param componentType the type of the component
  6804. * @param count the number of values to enumerate
  6805. * @param normalized whether the data is normalized
  6806. * @param callback the callback function called for each value
  6807. */
  6808. static ForEach(data: DataArray, byteOffset: number, byteStride: number, componentCount: number, componentType: number, count: number, normalized: boolean, callback: (value: number, index: number) => void): void;
  6809. private static _GetFloatValue;
  6810. }
  6811. }
  6812. declare module "babylonjs/Collisions/intersectionInfo" {
  6813. import { Nullable } from "babylonjs/types";
  6814. /**
  6815. * @hidden
  6816. */
  6817. export class IntersectionInfo {
  6818. bu: Nullable<number>;
  6819. bv: Nullable<number>;
  6820. distance: number;
  6821. faceId: number;
  6822. subMeshId: number;
  6823. constructor(bu: Nullable<number>, bv: Nullable<number>, distance: number);
  6824. }
  6825. }
  6826. declare module "babylonjs/Culling/boundingSphere" {
  6827. import { DeepImmutable } from "babylonjs/types";
  6828. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  6829. import { Plane } from "babylonjs/Maths/math.plane";
  6830. /**
  6831. * Class used to store bounding sphere information
  6832. */
  6833. export class BoundingSphere {
  6834. /**
  6835. * Gets the center of the bounding sphere in local space
  6836. */
  6837. readonly center: Vector3;
  6838. /**
  6839. * Radius of the bounding sphere in local space
  6840. */
  6841. radius: number;
  6842. /**
  6843. * Gets the center of the bounding sphere in world space
  6844. */
  6845. readonly centerWorld: Vector3;
  6846. /**
  6847. * Radius of the bounding sphere in world space
  6848. */
  6849. radiusWorld: number;
  6850. /**
  6851. * Gets the minimum vector in local space
  6852. */
  6853. readonly minimum: Vector3;
  6854. /**
  6855. * Gets the maximum vector in local space
  6856. */
  6857. readonly maximum: Vector3;
  6858. private _worldMatrix;
  6859. private static readonly TmpVector3;
  6860. /**
  6861. * Creates a new bounding sphere
  6862. * @param min defines the minimum vector (in local space)
  6863. * @param max defines the maximum vector (in local space)
  6864. * @param worldMatrix defines the new world matrix
  6865. */
  6866. constructor(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  6867. /**
  6868. * Recreates the entire bounding sphere from scratch as if we call the constructor in place
  6869. * @param min defines the new minimum vector (in local space)
  6870. * @param max defines the new maximum vector (in local space)
  6871. * @param worldMatrix defines the new world matrix
  6872. */
  6873. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  6874. /**
  6875. * Scale the current bounding sphere by applying a scale factor
  6876. * @param factor defines the scale factor to apply
  6877. * @returns the current bounding box
  6878. */
  6879. scale(factor: number): BoundingSphere;
  6880. /**
  6881. * Gets the world matrix of the bounding box
  6882. * @returns a matrix
  6883. */
  6884. getWorldMatrix(): DeepImmutable<Matrix>;
  6885. /** @hidden */
  6886. _update(worldMatrix: DeepImmutable<Matrix>): void;
  6887. /**
  6888. * Tests if the bounding sphere is intersecting the frustum planes
  6889. * @param frustumPlanes defines the frustum planes to test
  6890. * @returns true if there is an intersection
  6891. */
  6892. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  6893. /**
  6894. * Tests if the bounding sphere center is in between the frustum planes.
  6895. * Used for optimistic fast inclusion.
  6896. * @param frustumPlanes defines the frustum planes to test
  6897. * @returns true if the sphere center is in between the frustum planes
  6898. */
  6899. isCenterInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  6900. /**
  6901. * Tests if a point is inside the bounding sphere
  6902. * @param point defines the point to test
  6903. * @returns true if the point is inside the bounding sphere
  6904. */
  6905. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  6906. /**
  6907. * Checks if two sphere intersct
  6908. * @param sphere0 sphere 0
  6909. * @param sphere1 sphere 1
  6910. * @returns true if the speres intersect
  6911. */
  6912. static Intersects(sphere0: DeepImmutable<BoundingSphere>, sphere1: DeepImmutable<BoundingSphere>): boolean;
  6913. }
  6914. }
  6915. declare module "babylonjs/Culling/boundingBox" {
  6916. import { DeepImmutable } from "babylonjs/types";
  6917. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  6918. import { BoundingSphere } from "babylonjs/Culling/boundingSphere";
  6919. import { ICullable } from "babylonjs/Culling/boundingInfo";
  6920. import { Plane } from "babylonjs/Maths/math.plane";
  6921. /**
  6922. * Class used to store bounding box information
  6923. */
  6924. export class BoundingBox implements ICullable {
  6925. /**
  6926. * Gets the 8 vectors representing the bounding box in local space
  6927. */
  6928. readonly vectors: Vector3[];
  6929. /**
  6930. * Gets the center of the bounding box in local space
  6931. */
  6932. readonly center: Vector3;
  6933. /**
  6934. * Gets the center of the bounding box in world space
  6935. */
  6936. readonly centerWorld: Vector3;
  6937. /**
  6938. * Gets the extend size in local space
  6939. */
  6940. readonly extendSize: Vector3;
  6941. /**
  6942. * Gets the extend size in world space
  6943. */
  6944. readonly extendSizeWorld: Vector3;
  6945. /**
  6946. * Gets the OBB (object bounding box) directions
  6947. */
  6948. readonly directions: Vector3[];
  6949. /**
  6950. * Gets the 8 vectors representing the bounding box in world space
  6951. */
  6952. readonly vectorsWorld: Vector3[];
  6953. /**
  6954. * Gets the minimum vector in world space
  6955. */
  6956. readonly minimumWorld: Vector3;
  6957. /**
  6958. * Gets the maximum vector in world space
  6959. */
  6960. readonly maximumWorld: Vector3;
  6961. /**
  6962. * Gets the minimum vector in local space
  6963. */
  6964. readonly minimum: Vector3;
  6965. /**
  6966. * Gets the maximum vector in local space
  6967. */
  6968. readonly maximum: Vector3;
  6969. private _worldMatrix;
  6970. private static readonly TmpVector3;
  6971. /**
  6972. * @hidden
  6973. */
  6974. _tag: number;
  6975. /**
  6976. * Creates a new bounding box
  6977. * @param min defines the minimum vector (in local space)
  6978. * @param max defines the maximum vector (in local space)
  6979. * @param worldMatrix defines the new world matrix
  6980. */
  6981. constructor(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  6982. /**
  6983. * Recreates the entire bounding box from scratch as if we call the constructor in place
  6984. * @param min defines the new minimum vector (in local space)
  6985. * @param max defines the new maximum vector (in local space)
  6986. * @param worldMatrix defines the new world matrix
  6987. */
  6988. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  6989. /**
  6990. * Scale the current bounding box by applying a scale factor
  6991. * @param factor defines the scale factor to apply
  6992. * @returns the current bounding box
  6993. */
  6994. scale(factor: number): BoundingBox;
  6995. /**
  6996. * Gets the world matrix of the bounding box
  6997. * @returns a matrix
  6998. */
  6999. getWorldMatrix(): DeepImmutable<Matrix>;
  7000. /** @hidden */
  7001. _update(world: DeepImmutable<Matrix>): void;
  7002. /**
  7003. * Tests if the bounding box is intersecting the frustum planes
  7004. * @param frustumPlanes defines the frustum planes to test
  7005. * @returns true if there is an intersection
  7006. */
  7007. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  7008. /**
  7009. * Tests if the bounding box is entirely inside the frustum planes
  7010. * @param frustumPlanes defines the frustum planes to test
  7011. * @returns true if there is an inclusion
  7012. */
  7013. isCompletelyInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  7014. /**
  7015. * Tests if a point is inside the bounding box
  7016. * @param point defines the point to test
  7017. * @returns true if the point is inside the bounding box
  7018. */
  7019. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  7020. /**
  7021. * Tests if the bounding box intersects with a bounding sphere
  7022. * @param sphere defines the sphere to test
  7023. * @returns true if there is an intersection
  7024. */
  7025. intersectsSphere(sphere: DeepImmutable<BoundingSphere>): boolean;
  7026. /**
  7027. * Tests if the bounding box intersects with a box defined by a min and max vectors
  7028. * @param min defines the min vector to use
  7029. * @param max defines the max vector to use
  7030. * @returns true if there is an intersection
  7031. */
  7032. intersectsMinMax(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>): boolean;
  7033. /**
  7034. * Tests if two bounding boxes are intersections
  7035. * @param box0 defines the first box to test
  7036. * @param box1 defines the second box to test
  7037. * @returns true if there is an intersection
  7038. */
  7039. static Intersects(box0: DeepImmutable<BoundingBox>, box1: DeepImmutable<BoundingBox>): boolean;
  7040. /**
  7041. * Tests if a bounding box defines by a min/max vectors intersects a sphere
  7042. * @param minPoint defines the minimum vector of the bounding box
  7043. * @param maxPoint defines the maximum vector of the bounding box
  7044. * @param sphereCenter defines the sphere center
  7045. * @param sphereRadius defines the sphere radius
  7046. * @returns true if there is an intersection
  7047. */
  7048. static IntersectsSphere(minPoint: DeepImmutable<Vector3>, maxPoint: DeepImmutable<Vector3>, sphereCenter: DeepImmutable<Vector3>, sphereRadius: number): boolean;
  7049. /**
  7050. * Tests if a bounding box defined with 8 vectors is entirely inside frustum planes
  7051. * @param boundingVectors defines an array of 8 vectors representing a bounding box
  7052. * @param frustumPlanes defines the frustum planes to test
  7053. * @return true if there is an inclusion
  7054. */
  7055. static IsCompletelyInFrustum(boundingVectors: Array<DeepImmutable<Vector3>>, frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  7056. /**
  7057. * Tests if a bounding box defined with 8 vectors intersects frustum planes
  7058. * @param boundingVectors defines an array of 8 vectors representing a bounding box
  7059. * @param frustumPlanes defines the frustum planes to test
  7060. * @return true if there is an intersection
  7061. */
  7062. static IsInFrustum(boundingVectors: Array<DeepImmutable<Vector3>>, frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  7063. }
  7064. }
  7065. declare module "babylonjs/Collisions/collider" {
  7066. import { Nullable, IndicesArray } from "babylonjs/types";
  7067. import { Vector3 } from "babylonjs/Maths/math.vector";
  7068. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  7069. import { Plane } from "babylonjs/Maths/math.plane";
  7070. /** @hidden */
  7071. export class Collider {
  7072. /** Define if a collision was found */
  7073. collisionFound: boolean;
  7074. /**
  7075. * Define last intersection point in local space
  7076. */
  7077. intersectionPoint: Vector3;
  7078. /**
  7079. * Define last collided mesh
  7080. */
  7081. collidedMesh: Nullable<AbstractMesh>;
  7082. private _collisionPoint;
  7083. private _planeIntersectionPoint;
  7084. private _tempVector;
  7085. private _tempVector2;
  7086. private _tempVector3;
  7087. private _tempVector4;
  7088. private _edge;
  7089. private _baseToVertex;
  7090. private _destinationPoint;
  7091. private _slidePlaneNormal;
  7092. private _displacementVector;
  7093. /** @hidden */
  7094. _radius: Vector3;
  7095. /** @hidden */
  7096. _retry: number;
  7097. private _velocity;
  7098. private _basePoint;
  7099. private _epsilon;
  7100. /** @hidden */
  7101. _velocityWorldLength: number;
  7102. /** @hidden */
  7103. _basePointWorld: Vector3;
  7104. private _velocityWorld;
  7105. private _normalizedVelocity;
  7106. /** @hidden */
  7107. _initialVelocity: Vector3;
  7108. /** @hidden */
  7109. _initialPosition: Vector3;
  7110. private _nearestDistance;
  7111. private _collisionMask;
  7112. get collisionMask(): number;
  7113. set collisionMask(mask: number);
  7114. /**
  7115. * Gets the plane normal used to compute the sliding response (in local space)
  7116. */
  7117. get slidePlaneNormal(): Vector3;
  7118. /** @hidden */
  7119. _initialize(source: Vector3, dir: Vector3, e: number): void;
  7120. /** @hidden */
  7121. _checkPointInTriangle(point: Vector3, pa: Vector3, pb: Vector3, pc: Vector3, n: Vector3): boolean;
  7122. /** @hidden */
  7123. _canDoCollision(sphereCenter: Vector3, sphereRadius: number, vecMin: Vector3, vecMax: Vector3): boolean;
  7124. /** @hidden */
  7125. _testTriangle(faceIndex: number, trianglePlaneArray: Array<Plane>, p1: Vector3, p2: Vector3, p3: Vector3, hasMaterial: boolean, hostMesh: AbstractMesh): void;
  7126. /** @hidden */
  7127. _collide(trianglePlaneArray: Array<Plane>, pts: Vector3[], indices: IndicesArray, indexStart: number, indexEnd: number, decal: number, hasMaterial: boolean, hostMesh: AbstractMesh): void;
  7128. /** @hidden */
  7129. _getResponse(pos: Vector3, vel: Vector3): void;
  7130. }
  7131. }
  7132. declare module "babylonjs/Culling/boundingInfo" {
  7133. import { DeepImmutable } from "babylonjs/types";
  7134. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  7135. import { BoundingBox } from "babylonjs/Culling/boundingBox";
  7136. import { BoundingSphere } from "babylonjs/Culling/boundingSphere";
  7137. import { Plane } from "babylonjs/Maths/math.plane";
  7138. import { Collider } from "babylonjs/Collisions/collider";
  7139. /**
  7140. * Interface for cullable objects
  7141. * @see https://doc.babylonjs.com/babylon101/materials#back-face-culling
  7142. */
  7143. export interface ICullable {
  7144. /**
  7145. * Checks if the object or part of the object is in the frustum
  7146. * @param frustumPlanes Camera near/planes
  7147. * @returns true if the object is in frustum otherwise false
  7148. */
  7149. isInFrustum(frustumPlanes: Plane[]): boolean;
  7150. /**
  7151. * Checks if a cullable object (mesh...) is in the camera frustum
  7152. * Unlike isInFrustum this cheks the full bounding box
  7153. * @param frustumPlanes Camera near/planes
  7154. * @returns true if the object is in frustum otherwise false
  7155. */
  7156. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  7157. }
  7158. /**
  7159. * Info for a bounding data of a mesh
  7160. */
  7161. export class BoundingInfo implements ICullable {
  7162. /**
  7163. * Bounding box for the mesh
  7164. */
  7165. readonly boundingBox: BoundingBox;
  7166. /**
  7167. * Bounding sphere for the mesh
  7168. */
  7169. readonly boundingSphere: BoundingSphere;
  7170. private _isLocked;
  7171. private static readonly TmpVector3;
  7172. /**
  7173. * Constructs bounding info
  7174. * @param minimum min vector of the bounding box/sphere
  7175. * @param maximum max vector of the bounding box/sphere
  7176. * @param worldMatrix defines the new world matrix
  7177. */
  7178. constructor(minimum: DeepImmutable<Vector3>, maximum: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  7179. /**
  7180. * Recreates the entire bounding info from scratch as if we call the constructor in place
  7181. * @param min defines the new minimum vector (in local space)
  7182. * @param max defines the new maximum vector (in local space)
  7183. * @param worldMatrix defines the new world matrix
  7184. */
  7185. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  7186. /**
  7187. * min vector of the bounding box/sphere
  7188. */
  7189. get minimum(): Vector3;
  7190. /**
  7191. * max vector of the bounding box/sphere
  7192. */
  7193. get maximum(): Vector3;
  7194. /**
  7195. * If the info is locked and won't be updated to avoid perf overhead
  7196. */
  7197. get isLocked(): boolean;
  7198. set isLocked(value: boolean);
  7199. /**
  7200. * Updates the bounding sphere and box
  7201. * @param world world matrix to be used to update
  7202. */
  7203. update(world: DeepImmutable<Matrix>): void;
  7204. /**
  7205. * Recreate the bounding info to be centered around a specific point given a specific extend.
  7206. * @param center New center of the bounding info
  7207. * @param extend New extend of the bounding info
  7208. * @returns the current bounding info
  7209. */
  7210. centerOn(center: DeepImmutable<Vector3>, extend: DeepImmutable<Vector3>): BoundingInfo;
  7211. /**
  7212. * Scale the current bounding info by applying a scale factor
  7213. * @param factor defines the scale factor to apply
  7214. * @returns the current bounding info
  7215. */
  7216. scale(factor: number): BoundingInfo;
  7217. /**
  7218. * Returns `true` if the bounding info is within the frustum defined by the passed array of planes.
  7219. * @param frustumPlanes defines the frustum to test
  7220. * @param strategy defines the strategy to use for the culling (default is BABYLON.AbstractMesh.CULLINGSTRATEGY_STANDARD)
  7221. * @returns true if the bounding info is in the frustum planes
  7222. */
  7223. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>, strategy?: number): boolean;
  7224. /**
  7225. * Gets the world distance between the min and max points of the bounding box
  7226. */
  7227. get diagonalLength(): number;
  7228. /**
  7229. * Checks if a cullable object (mesh...) is in the camera frustum
  7230. * Unlike isInFrustum this cheks the full bounding box
  7231. * @param frustumPlanes Camera near/planes
  7232. * @returns true if the object is in frustum otherwise false
  7233. */
  7234. isCompletelyInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  7235. /** @hidden */
  7236. _checkCollision(collider: Collider): boolean;
  7237. /**
  7238. * Checks if a point is inside the bounding box and bounding sphere or the mesh
  7239. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  7240. * @param point the point to check intersection with
  7241. * @returns if the point intersects
  7242. */
  7243. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  7244. /**
  7245. * Checks if another bounding info intersects the bounding box and bounding sphere or the mesh
  7246. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  7247. * @param boundingInfo the bounding info to check intersection with
  7248. * @param precise if the intersection should be done using OBB
  7249. * @returns if the bounding info intersects
  7250. */
  7251. intersects(boundingInfo: DeepImmutable<BoundingInfo>, precise: boolean): boolean;
  7252. }
  7253. }
  7254. declare module "babylonjs/Maths/math.functions" {
  7255. import { FloatArray, Nullable, IndicesArray } from "babylonjs/types";
  7256. import { Vector2, Vector3 } from "babylonjs/Maths/math.vector";
  7257. /**
  7258. * Extracts minimum and maximum values from a list of indexed positions
  7259. * @param positions defines the positions to use
  7260. * @param indices defines the indices to the positions
  7261. * @param indexStart defines the start index
  7262. * @param indexCount defines the end index
  7263. * @param bias defines bias value to add to the result
  7264. * @return minimum and maximum values
  7265. */
  7266. export function extractMinAndMaxIndexed(positions: FloatArray, indices: IndicesArray, indexStart: number, indexCount: number, bias?: Nullable<Vector2>): {
  7267. minimum: Vector3;
  7268. maximum: Vector3;
  7269. };
  7270. /**
  7271. * Extracts minimum and maximum values from a list of positions
  7272. * @param positions defines the positions to use
  7273. * @param start defines the start index in the positions array
  7274. * @param count defines the number of positions to handle
  7275. * @param bias defines bias value to add to the result
  7276. * @param stride defines the stride size to use (distance between two positions in the positions array)
  7277. * @return minimum and maximum values
  7278. */
  7279. export function extractMinAndMax(positions: FloatArray, start: number, count: number, bias?: Nullable<Vector2>, stride?: number): {
  7280. minimum: Vector3;
  7281. maximum: Vector3;
  7282. };
  7283. }
  7284. declare module "babylonjs/Meshes/WebGL/webGLDataBuffer" {
  7285. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  7286. /** @hidden */
  7287. export class WebGLDataBuffer extends DataBuffer {
  7288. private _buffer;
  7289. constructor(resource: WebGLBuffer);
  7290. get underlyingResource(): any;
  7291. }
  7292. }
  7293. declare module "babylonjs/Engines/WebGL/webGLPipelineContext" {
  7294. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  7295. import { Nullable } from "babylonjs/types";
  7296. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  7297. /** @hidden */
  7298. export class WebGLPipelineContext implements IPipelineContext {
  7299. engine: ThinEngine;
  7300. program: Nullable<WebGLProgram>;
  7301. context?: WebGLRenderingContext;
  7302. vertexShader?: WebGLShader;
  7303. fragmentShader?: WebGLShader;
  7304. isParallelCompiled: boolean;
  7305. onCompiled?: () => void;
  7306. transformFeedback?: WebGLTransformFeedback | null;
  7307. vertexCompilationError: Nullable<string>;
  7308. fragmentCompilationError: Nullable<string>;
  7309. programLinkError: Nullable<string>;
  7310. programValidationError: Nullable<string>;
  7311. get isAsync(): boolean;
  7312. get isReady(): boolean;
  7313. _handlesSpectorRebuildCallback(onCompiled: (program: WebGLProgram) => void): void;
  7314. _getVertexShaderCode(): string | null;
  7315. _getFragmentShaderCode(): string | null;
  7316. }
  7317. }
  7318. declare module "babylonjs/Engines/Extensions/engine.uniformBuffer" {
  7319. import { FloatArray, Nullable } from "babylonjs/types";
  7320. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  7321. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  7322. module "babylonjs/Engines/thinEngine" {
  7323. interface ThinEngine {
  7324. /**
  7325. * Create an uniform buffer
  7326. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  7327. * @param elements defines the content of the uniform buffer
  7328. * @returns the webGL uniform buffer
  7329. */
  7330. createUniformBuffer(elements: FloatArray): DataBuffer;
  7331. /**
  7332. * Create a dynamic uniform buffer
  7333. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  7334. * @param elements defines the content of the uniform buffer
  7335. * @returns the webGL uniform buffer
  7336. */
  7337. createDynamicUniformBuffer(elements: FloatArray): DataBuffer;
  7338. /**
  7339. * Update an existing uniform buffer
  7340. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  7341. * @param uniformBuffer defines the target uniform buffer
  7342. * @param elements defines the content to update
  7343. * @param offset defines the offset in the uniform buffer where update should start
  7344. * @param count defines the size of the data to update
  7345. */
  7346. updateUniformBuffer(uniformBuffer: DataBuffer, elements: FloatArray, offset?: number, count?: number): void;
  7347. /**
  7348. * Bind an uniform buffer to the current webGL context
  7349. * @param buffer defines the buffer to bind
  7350. */
  7351. bindUniformBuffer(buffer: Nullable<DataBuffer>): void;
  7352. /**
  7353. * Bind a buffer to the current webGL context at a given location
  7354. * @param buffer defines the buffer to bind
  7355. * @param location defines the index where to bind the buffer
  7356. */
  7357. bindUniformBufferBase(buffer: DataBuffer, location: number): void;
  7358. /**
  7359. * Bind a specific block at a given index in a specific shader program
  7360. * @param pipelineContext defines the pipeline context to use
  7361. * @param blockName defines the block name
  7362. * @param index defines the index where to bind the block
  7363. */
  7364. bindUniformBlock(pipelineContext: IPipelineContext, blockName: string, index: number): void;
  7365. }
  7366. }
  7367. }
  7368. declare module "babylonjs/Materials/uniformBuffer" {
  7369. import { Nullable, FloatArray } from "babylonjs/types";
  7370. import { Matrix, Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  7371. import { Engine } from "babylonjs/Engines/engine";
  7372. import { Effect } from "babylonjs/Materials/effect";
  7373. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  7374. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  7375. import { Color3 } from "babylonjs/Maths/math.color";
  7376. import "babylonjs/Engines/Extensions/engine.uniformBuffer";
  7377. /**
  7378. * Uniform buffer objects.
  7379. *
  7380. * Handles blocks of uniform on the GPU.
  7381. *
  7382. * If WebGL 2 is not available, this class falls back on traditionnal setUniformXXX calls.
  7383. *
  7384. * For more information, please refer to :
  7385. * https://www.khronos.org/opengl/wiki/Uniform_Buffer_Object
  7386. */
  7387. export class UniformBuffer {
  7388. private _engine;
  7389. private _buffer;
  7390. private _data;
  7391. private _bufferData;
  7392. private _dynamic?;
  7393. private _uniformLocations;
  7394. private _uniformSizes;
  7395. private _uniformLocationPointer;
  7396. private _needSync;
  7397. private _noUBO;
  7398. private _currentEffect;
  7399. /** @hidden */
  7400. _alreadyBound: boolean;
  7401. private static _MAX_UNIFORM_SIZE;
  7402. private static _tempBuffer;
  7403. /**
  7404. * Lambda to Update a 3x3 Matrix in a uniform buffer.
  7405. * This is dynamic to allow compat with webgl 1 and 2.
  7406. * You will need to pass the name of the uniform as well as the value.
  7407. */
  7408. updateMatrix3x3: (name: string, matrix: Float32Array) => void;
  7409. /**
  7410. * Lambda to Update a 2x2 Matrix in a uniform buffer.
  7411. * This is dynamic to allow compat with webgl 1 and 2.
  7412. * You will need to pass the name of the uniform as well as the value.
  7413. */
  7414. updateMatrix2x2: (name: string, matrix: Float32Array) => void;
  7415. /**
  7416. * Lambda to Update a single float in a uniform buffer.
  7417. * This is dynamic to allow compat with webgl 1 and 2.
  7418. * You will need to pass the name of the uniform as well as the value.
  7419. */
  7420. updateFloat: (name: string, x: number) => void;
  7421. /**
  7422. * Lambda to Update a vec2 of float in a uniform buffer.
  7423. * This is dynamic to allow compat with webgl 1 and 2.
  7424. * You will need to pass the name of the uniform as well as the value.
  7425. */
  7426. updateFloat2: (name: string, x: number, y: number, suffix?: string) => void;
  7427. /**
  7428. * Lambda to Update a vec3 of float in a uniform buffer.
  7429. * This is dynamic to allow compat with webgl 1 and 2.
  7430. * You will need to pass the name of the uniform as well as the value.
  7431. */
  7432. updateFloat3: (name: string, x: number, y: number, z: number, suffix?: string) => void;
  7433. /**
  7434. * Lambda to Update a vec4 of float in a uniform buffer.
  7435. * This is dynamic to allow compat with webgl 1 and 2.
  7436. * You will need to pass the name of the uniform as well as the value.
  7437. */
  7438. updateFloat4: (name: string, x: number, y: number, z: number, w: number, suffix?: string) => void;
  7439. /**
  7440. * Lambda to Update a 4x4 Matrix in a uniform buffer.
  7441. * This is dynamic to allow compat with webgl 1 and 2.
  7442. * You will need to pass the name of the uniform as well as the value.
  7443. */
  7444. updateMatrix: (name: string, mat: Matrix) => void;
  7445. /**
  7446. * Lambda to Update vec3 of float from a Vector in a uniform buffer.
  7447. * This is dynamic to allow compat with webgl 1 and 2.
  7448. * You will need to pass the name of the uniform as well as the value.
  7449. */
  7450. updateVector3: (name: string, vector: Vector3) => void;
  7451. /**
  7452. * Lambda to Update vec4 of float from a Vector in a uniform buffer.
  7453. * This is dynamic to allow compat with webgl 1 and 2.
  7454. * You will need to pass the name of the uniform as well as the value.
  7455. */
  7456. updateVector4: (name: string, vector: Vector4) => void;
  7457. /**
  7458. * Lambda to Update vec3 of float from a Color in a uniform buffer.
  7459. * This is dynamic to allow compat with webgl 1 and 2.
  7460. * You will need to pass the name of the uniform as well as the value.
  7461. */
  7462. updateColor3: (name: string, color: Color3, suffix?: string) => void;
  7463. /**
  7464. * Lambda to Update vec4 of float from a Color in a uniform buffer.
  7465. * This is dynamic to allow compat with webgl 1 and 2.
  7466. * You will need to pass the name of the uniform as well as the value.
  7467. */
  7468. updateColor4: (name: string, color: Color3, alpha: number, suffix?: string) => void;
  7469. /**
  7470. * Instantiates a new Uniform buffer objects.
  7471. *
  7472. * Handles blocks of uniform on the GPU.
  7473. *
  7474. * If WebGL 2 is not available, this class falls back on traditionnal setUniformXXX calls.
  7475. *
  7476. * For more information, please refer to :
  7477. * @see https://www.khronos.org/opengl/wiki/Uniform_Buffer_Object
  7478. * @param engine Define the engine the buffer is associated with
  7479. * @param data Define the data contained in the buffer
  7480. * @param dynamic Define if the buffer is updatable
  7481. */
  7482. constructor(engine: Engine, data?: number[], dynamic?: boolean);
  7483. /**
  7484. * Indicates if the buffer is using the WebGL2 UBO implementation,
  7485. * or just falling back on setUniformXXX calls.
  7486. */
  7487. get useUbo(): boolean;
  7488. /**
  7489. * Indicates if the WebGL underlying uniform buffer is in sync
  7490. * with the javascript cache data.
  7491. */
  7492. get isSync(): boolean;
  7493. /**
  7494. * Indicates if the WebGL underlying uniform buffer is dynamic.
  7495. * Also, a dynamic UniformBuffer will disable cache verification and always
  7496. * update the underlying WebGL uniform buffer to the GPU.
  7497. * @returns if Dynamic, otherwise false
  7498. */
  7499. isDynamic(): boolean;
  7500. /**
  7501. * The data cache on JS side.
  7502. * @returns the underlying data as a float array
  7503. */
  7504. getData(): Float32Array;
  7505. /**
  7506. * The underlying WebGL Uniform buffer.
  7507. * @returns the webgl buffer
  7508. */
  7509. getBuffer(): Nullable<DataBuffer>;
  7510. /**
  7511. * std140 layout specifies how to align data within an UBO structure.
  7512. * See https://khronos.org/registry/OpenGL/specs/gl/glspec45.core.pdf#page=159
  7513. * for specs.
  7514. */
  7515. private _fillAlignment;
  7516. /**
  7517. * Adds an uniform in the buffer.
  7518. * Warning : the subsequents calls of this function must be in the same order as declared in the shader
  7519. * for the layout to be correct !
  7520. * @param name Name of the uniform, as used in the uniform block in the shader.
  7521. * @param size Data size, or data directly.
  7522. */
  7523. addUniform(name: string, size: number | number[]): void;
  7524. /**
  7525. * Adds a Matrix 4x4 to the uniform buffer.
  7526. * @param name Name of the uniform, as used in the uniform block in the shader.
  7527. * @param mat A 4x4 matrix.
  7528. */
  7529. addMatrix(name: string, mat: Matrix): void;
  7530. /**
  7531. * Adds a vec2 to the uniform buffer.
  7532. * @param name Name of the uniform, as used in the uniform block in the shader.
  7533. * @param x Define the x component value of the vec2
  7534. * @param y Define the y component value of the vec2
  7535. */
  7536. addFloat2(name: string, x: number, y: number): void;
  7537. /**
  7538. * Adds a vec3 to the uniform buffer.
  7539. * @param name Name of the uniform, as used in the uniform block in the shader.
  7540. * @param x Define the x component value of the vec3
  7541. * @param y Define the y component value of the vec3
  7542. * @param z Define the z component value of the vec3
  7543. */
  7544. addFloat3(name: string, x: number, y: number, z: number): void;
  7545. /**
  7546. * Adds a vec3 to the uniform buffer.
  7547. * @param name Name of the uniform, as used in the uniform block in the shader.
  7548. * @param color Define the vec3 from a Color
  7549. */
  7550. addColor3(name: string, color: Color3): void;
  7551. /**
  7552. * Adds a vec4 to the uniform buffer.
  7553. * @param name Name of the uniform, as used in the uniform block in the shader.
  7554. * @param color Define the rgb components from a Color
  7555. * @param alpha Define the a component of the vec4
  7556. */
  7557. addColor4(name: string, color: Color3, alpha: number): void;
  7558. /**
  7559. * Adds a vec3 to the uniform buffer.
  7560. * @param name Name of the uniform, as used in the uniform block in the shader.
  7561. * @param vector Define the vec3 components from a Vector
  7562. */
  7563. addVector3(name: string, vector: Vector3): void;
  7564. /**
  7565. * Adds a Matrix 3x3 to the uniform buffer.
  7566. * @param name Name of the uniform, as used in the uniform block in the shader.
  7567. */
  7568. addMatrix3x3(name: string): void;
  7569. /**
  7570. * Adds a Matrix 2x2 to the uniform buffer.
  7571. * @param name Name of the uniform, as used in the uniform block in the shader.
  7572. */
  7573. addMatrix2x2(name: string): void;
  7574. /**
  7575. * Effectively creates the WebGL Uniform Buffer, once layout is completed with `addUniform`.
  7576. */
  7577. create(): void;
  7578. /** @hidden */
  7579. _rebuild(): void;
  7580. /**
  7581. * Updates the WebGL Uniform Buffer on the GPU.
  7582. * If the `dynamic` flag is set to true, no cache comparison is done.
  7583. * Otherwise, the buffer will be updated only if the cache differs.
  7584. */
  7585. update(): void;
  7586. /**
  7587. * Updates the value of an uniform. The `update` method must be called afterwards to make it effective in the GPU.
  7588. * @param uniformName Define the name of the uniform, as used in the uniform block in the shader.
  7589. * @param data Define the flattened data
  7590. * @param size Define the size of the data.
  7591. */
  7592. updateUniform(uniformName: string, data: FloatArray, size: number): void;
  7593. private _valueCache;
  7594. private _cacheMatrix;
  7595. private _updateMatrix3x3ForUniform;
  7596. private _updateMatrix3x3ForEffect;
  7597. private _updateMatrix2x2ForEffect;
  7598. private _updateMatrix2x2ForUniform;
  7599. private _updateFloatForEffect;
  7600. private _updateFloatForUniform;
  7601. private _updateFloat2ForEffect;
  7602. private _updateFloat2ForUniform;
  7603. private _updateFloat3ForEffect;
  7604. private _updateFloat3ForUniform;
  7605. private _updateFloat4ForEffect;
  7606. private _updateFloat4ForUniform;
  7607. private _updateMatrixForEffect;
  7608. private _updateMatrixForUniform;
  7609. private _updateVector3ForEffect;
  7610. private _updateVector3ForUniform;
  7611. private _updateVector4ForEffect;
  7612. private _updateVector4ForUniform;
  7613. private _updateColor3ForEffect;
  7614. private _updateColor3ForUniform;
  7615. private _updateColor4ForEffect;
  7616. private _updateColor4ForUniform;
  7617. /**
  7618. * Sets a sampler uniform on the effect.
  7619. * @param name Define the name of the sampler.
  7620. * @param texture Define the texture to set in the sampler
  7621. */
  7622. setTexture(name: string, texture: Nullable<BaseTexture>): void;
  7623. /**
  7624. * Directly updates the value of the uniform in the cache AND on the GPU.
  7625. * @param uniformName Define the name of the uniform, as used in the uniform block in the shader.
  7626. * @param data Define the flattened data
  7627. */
  7628. updateUniformDirectly(uniformName: string, data: FloatArray): void;
  7629. /**
  7630. * Binds this uniform buffer to an effect.
  7631. * @param effect Define the effect to bind the buffer to
  7632. * @param name Name of the uniform block in the shader.
  7633. */
  7634. bindToEffect(effect: Effect, name: string): void;
  7635. /**
  7636. * Disposes the uniform buffer.
  7637. */
  7638. dispose(): void;
  7639. }
  7640. }
  7641. declare module "babylonjs/Misc/iInspectable" {
  7642. /**
  7643. * Enum that determines the text-wrapping mode to use.
  7644. */
  7645. export enum InspectableType {
  7646. /**
  7647. * Checkbox for booleans
  7648. */
  7649. Checkbox = 0,
  7650. /**
  7651. * Sliders for numbers
  7652. */
  7653. Slider = 1,
  7654. /**
  7655. * Vector3
  7656. */
  7657. Vector3 = 2,
  7658. /**
  7659. * Quaternions
  7660. */
  7661. Quaternion = 3,
  7662. /**
  7663. * Color3
  7664. */
  7665. Color3 = 4,
  7666. /**
  7667. * String
  7668. */
  7669. String = 5
  7670. }
  7671. /**
  7672. * Interface used to define custom inspectable properties.
  7673. * This interface is used by the inspector to display custom property grids
  7674. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  7675. */
  7676. export interface IInspectable {
  7677. /**
  7678. * Gets the label to display
  7679. */
  7680. label: string;
  7681. /**
  7682. * Gets the name of the property to edit
  7683. */
  7684. propertyName: string;
  7685. /**
  7686. * Gets the type of the editor to use
  7687. */
  7688. type: InspectableType;
  7689. /**
  7690. * Gets the minimum value of the property when using in "slider" mode
  7691. */
  7692. min?: number;
  7693. /**
  7694. * Gets the maximum value of the property when using in "slider" mode
  7695. */
  7696. max?: number;
  7697. /**
  7698. * Gets the setp to use when using in "slider" mode
  7699. */
  7700. step?: number;
  7701. }
  7702. }
  7703. declare module "babylonjs/Misc/timingTools" {
  7704. /**
  7705. * Class used to provide helper for timing
  7706. */
  7707. export class TimingTools {
  7708. /**
  7709. * Polyfill for setImmediate
  7710. * @param action defines the action to execute after the current execution block
  7711. */
  7712. static SetImmediate(action: () => void): void;
  7713. }
  7714. }
  7715. declare module "babylonjs/Misc/instantiationTools" {
  7716. /**
  7717. * Class used to enable instatition of objects by class name
  7718. */
  7719. export class InstantiationTools {
  7720. /**
  7721. * Use this object to register external classes like custom textures or material
  7722. * to allow the laoders to instantiate them
  7723. */
  7724. static RegisteredExternalClasses: {
  7725. [key: string]: Object;
  7726. };
  7727. /**
  7728. * Tries to instantiate a new object from a given class name
  7729. * @param className defines the class name to instantiate
  7730. * @returns the new object or null if the system was not able to do the instantiation
  7731. */
  7732. static Instantiate(className: string): any;
  7733. }
  7734. }
  7735. declare module "babylonjs/Engines/depthTextureCreationOptions" {
  7736. /**
  7737. * Define options used to create a depth texture
  7738. */
  7739. export class DepthTextureCreationOptions {
  7740. /** Specifies whether or not a stencil should be allocated in the texture */
  7741. generateStencil?: boolean;
  7742. /** Specifies whether or not bilinear filtering is enable on the texture */
  7743. bilinearFiltering?: boolean;
  7744. /** Specifies the comparison function to set on the texture. If 0 or undefined, the texture is not in comparison mode */
  7745. comparisonFunction?: number;
  7746. /** Specifies if the created texture is a cube texture */
  7747. isCube?: boolean;
  7748. }
  7749. }
  7750. declare module "babylonjs/Engines/Extensions/engine.cubeTexture" {
  7751. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  7752. import { Nullable } from "babylonjs/types";
  7753. import { Scene } from "babylonjs/scene";
  7754. import { DepthTextureCreationOptions } from "babylonjs/Engines/depthTextureCreationOptions";
  7755. module "babylonjs/Engines/thinEngine" {
  7756. interface ThinEngine {
  7757. /**
  7758. * Creates a depth stencil cube texture.
  7759. * This is only available in WebGL 2.
  7760. * @param size The size of face edge in the cube texture.
  7761. * @param options The options defining the cube texture.
  7762. * @returns The cube texture
  7763. */
  7764. _createDepthStencilCubeTexture(size: number, options: DepthTextureCreationOptions): InternalTexture;
  7765. /**
  7766. * Creates a cube texture
  7767. * @param rootUrl defines the url where the files to load is located
  7768. * @param scene defines the current scene
  7769. * @param files defines the list of files to load (1 per face)
  7770. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  7771. * @param onLoad defines an optional callback raised when the texture is loaded
  7772. * @param onError defines an optional callback raised if there is an issue to load the texture
  7773. * @param format defines the format of the data
  7774. * @param forcedExtension defines the extension to use to pick the right loader
  7775. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  7776. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  7777. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  7778. * @param fallback defines texture to use while falling back when (compressed) texture file not found.
  7779. * @returns the cube texture as an InternalTexture
  7780. */
  7781. 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;
  7782. /**
  7783. * Creates a cube texture
  7784. * @param rootUrl defines the url where the files to load is located
  7785. * @param scene defines the current scene
  7786. * @param files defines the list of files to load (1 per face)
  7787. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  7788. * @param onLoad defines an optional callback raised when the texture is loaded
  7789. * @param onError defines an optional callback raised if there is an issue to load the texture
  7790. * @param format defines the format of the data
  7791. * @param forcedExtension defines the extension to use to pick the right loader
  7792. * @returns the cube texture as an InternalTexture
  7793. */
  7794. 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;
  7795. /**
  7796. * Creates a cube texture
  7797. * @param rootUrl defines the url where the files to load is located
  7798. * @param scene defines the current scene
  7799. * @param files defines the list of files to load (1 per face)
  7800. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  7801. * @param onLoad defines an optional callback raised when the texture is loaded
  7802. * @param onError defines an optional callback raised if there is an issue to load the texture
  7803. * @param format defines the format of the data
  7804. * @param forcedExtension defines the extension to use to pick the right loader
  7805. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  7806. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  7807. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  7808. * @returns the cube texture as an InternalTexture
  7809. */
  7810. 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;
  7811. /** @hidden */
  7812. _partialLoadFile(url: string, index: number, loadedFiles: ArrayBuffer[], onfinish: (files: ArrayBuffer[]) => void, onErrorCallBack: Nullable<(message?: string, exception?: any) => void>): void;
  7813. /** @hidden */
  7814. _cascadeLoadFiles(scene: Nullable<Scene>, onfinish: (images: ArrayBuffer[]) => void, files: string[], onError: Nullable<(message?: string, exception?: any) => void>): void;
  7815. /** @hidden */
  7816. _cascadeLoadImgs(scene: Nullable<Scene>, onfinish: (images: HTMLImageElement[]) => void, files: string[], onError: Nullable<(message?: string, exception?: any) => void>, mimeType?: string): void;
  7817. /** @hidden */
  7818. _partialLoadImg(url: string, index: number, loadedImages: HTMLImageElement[], scene: Nullable<Scene>, onfinish: (images: HTMLImageElement[]) => void, onErrorCallBack: Nullable<(message?: string, exception?: any) => void>, mimeType?: string): void;
  7819. /**
  7820. * @hidden
  7821. */
  7822. _setCubeMapTextureParams(loadMipmap: boolean): void;
  7823. }
  7824. }
  7825. }
  7826. declare module "babylonjs/Materials/Textures/cubeTexture" {
  7827. import { Nullable } from "babylonjs/types";
  7828. import { Scene } from "babylonjs/scene";
  7829. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  7830. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  7831. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  7832. import "babylonjs/Engines/Extensions/engine.cubeTexture";
  7833. import { Observable } from "babylonjs/Misc/observable";
  7834. /**
  7835. * Class for creating a cube texture
  7836. */
  7837. export class CubeTexture extends BaseTexture {
  7838. private _delayedOnLoad;
  7839. /**
  7840. * Observable triggered once the texture has been loaded.
  7841. */
  7842. onLoadObservable: Observable<CubeTexture>;
  7843. /**
  7844. * The url of the texture
  7845. */
  7846. url: string;
  7847. /**
  7848. * Gets or sets the center of the bounding box associated with the cube texture.
  7849. * It must define where the camera used to render the texture was set
  7850. * @see https://doc.babylonjs.com/how_to/reflect#using-local-cubemap-mode
  7851. */
  7852. boundingBoxPosition: Vector3;
  7853. private _boundingBoxSize;
  7854. /**
  7855. * Gets or sets the size of the bounding box associated with the cube texture
  7856. * When defined, the cubemap will switch to local mode
  7857. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  7858. * @example https://www.babylonjs-playground.com/#RNASML
  7859. */
  7860. set boundingBoxSize(value: Vector3);
  7861. /**
  7862. * Returns the bounding box size
  7863. * @see https://doc.babylonjs.com/how_to/reflect#using-local-cubemap-mode
  7864. */
  7865. get boundingBoxSize(): Vector3;
  7866. protected _rotationY: number;
  7867. /**
  7868. * Sets texture matrix rotation angle around Y axis in radians.
  7869. */
  7870. set rotationY(value: number);
  7871. /**
  7872. * Gets texture matrix rotation angle around Y axis radians.
  7873. */
  7874. get rotationY(): number;
  7875. /**
  7876. * Are mip maps generated for this texture or not.
  7877. */
  7878. get noMipmap(): boolean;
  7879. private _noMipmap;
  7880. private _files;
  7881. protected _forcedExtension: Nullable<string>;
  7882. private _extensions;
  7883. private _textureMatrix;
  7884. private _format;
  7885. private _createPolynomials;
  7886. /**
  7887. * Creates a cube texture from an array of image urls
  7888. * @param files defines an array of image urls
  7889. * @param scene defines the hosting scene
  7890. * @param noMipmap specifies if mip maps are not used
  7891. * @returns a cube texture
  7892. */
  7893. static CreateFromImages(files: string[], scene: Scene, noMipmap?: boolean): CubeTexture;
  7894. /**
  7895. * Creates and return a texture created from prefilterd data by tools like IBL Baker or Lys.
  7896. * @param url defines the url of the prefiltered texture
  7897. * @param scene defines the scene the texture is attached to
  7898. * @param forcedExtension defines the extension of the file if different from the url
  7899. * @param createPolynomials defines whether or not to create polynomial harmonics from the texture data if necessary
  7900. * @return the prefiltered texture
  7901. */
  7902. static CreateFromPrefilteredData(url: string, scene: Scene, forcedExtension?: any, createPolynomials?: boolean): CubeTexture;
  7903. /**
  7904. * Creates a cube texture to use with reflection for instance. It can be based upon dds or six images as well
  7905. * as prefiltered data.
  7906. * @param rootUrl defines the url of the texture or the root name of the six images
  7907. * @param null defines the scene or engine the texture is attached to
  7908. * @param extensions defines the suffixes add to the picture name in case six images are in use like _px.jpg...
  7909. * @param noMipmap defines if mipmaps should be created or not
  7910. * @param files defines the six files to load for the different faces in that order: px, py, pz, nx, ny, nz
  7911. * @param onLoad defines a callback triggered at the end of the file load if no errors occured
  7912. * @param onError defines a callback triggered in case of error during load
  7913. * @param format defines the internal format to use for the texture once loaded
  7914. * @param prefiltered defines whether or not the texture is created from prefiltered data
  7915. * @param forcedExtension defines the extensions to use (force a special type of file to load) in case it is different from the file name
  7916. * @param createPolynomials defines whether or not to create polynomial harmonics from the texture data if necessary
  7917. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  7918. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  7919. * @return the cube texture
  7920. */
  7921. 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);
  7922. /**
  7923. * Get the current class name of the texture useful for serialization or dynamic coding.
  7924. * @returns "CubeTexture"
  7925. */
  7926. getClassName(): string;
  7927. /**
  7928. * Update the url (and optional buffer) of this texture if url was null during construction.
  7929. * @param url the url of the texture
  7930. * @param forcedExtension defines the extension to use
  7931. * @param onLoad callback called when the texture is loaded (defaults to null)
  7932. * @param prefiltered Defines whether the updated texture is prefiltered or not
  7933. */
  7934. updateURL(url: string, forcedExtension?: string, onLoad?: () => void, prefiltered?: boolean): void;
  7935. /**
  7936. * Delays loading of the cube texture
  7937. * @param forcedExtension defines the extension to use
  7938. */
  7939. delayLoad(forcedExtension?: string): void;
  7940. /**
  7941. * Returns the reflection texture matrix
  7942. * @returns the reflection texture matrix
  7943. */
  7944. getReflectionTextureMatrix(): Matrix;
  7945. /**
  7946. * Sets the reflection texture matrix
  7947. * @param value Reflection texture matrix
  7948. */
  7949. setReflectionTextureMatrix(value: Matrix): void;
  7950. /**
  7951. * Parses text to create a cube texture
  7952. * @param parsedTexture define the serialized text to read from
  7953. * @param scene defines the hosting scene
  7954. * @param rootUrl defines the root url of the cube texture
  7955. * @returns a cube texture
  7956. */
  7957. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): CubeTexture;
  7958. /**
  7959. * Makes a clone, or deep copy, of the cube texture
  7960. * @returns a new cube texture
  7961. */
  7962. clone(): CubeTexture;
  7963. }
  7964. }
  7965. declare module "babylonjs/Materials/materialDefines" {
  7966. /**
  7967. * Manages the defines for the Material
  7968. */
  7969. export class MaterialDefines {
  7970. /** @hidden */
  7971. protected _keys: string[];
  7972. private _isDirty;
  7973. /** @hidden */
  7974. _renderId: number;
  7975. /** @hidden */
  7976. _areLightsDirty: boolean;
  7977. /** @hidden */
  7978. _areLightsDisposed: boolean;
  7979. /** @hidden */
  7980. _areAttributesDirty: boolean;
  7981. /** @hidden */
  7982. _areTexturesDirty: boolean;
  7983. /** @hidden */
  7984. _areFresnelDirty: boolean;
  7985. /** @hidden */
  7986. _areMiscDirty: boolean;
  7987. /** @hidden */
  7988. _areImageProcessingDirty: boolean;
  7989. /** @hidden */
  7990. _normals: boolean;
  7991. /** @hidden */
  7992. _uvs: boolean;
  7993. /** @hidden */
  7994. _needNormals: boolean;
  7995. /** @hidden */
  7996. _needUVs: boolean;
  7997. [id: string]: any;
  7998. /**
  7999. * Specifies if the material needs to be re-calculated
  8000. */
  8001. get isDirty(): boolean;
  8002. /**
  8003. * Marks the material to indicate that it has been re-calculated
  8004. */
  8005. markAsProcessed(): void;
  8006. /**
  8007. * Marks the material to indicate that it needs to be re-calculated
  8008. */
  8009. markAsUnprocessed(): void;
  8010. /**
  8011. * Marks the material to indicate all of its defines need to be re-calculated
  8012. */
  8013. markAllAsDirty(): void;
  8014. /**
  8015. * Marks the material to indicate that image processing needs to be re-calculated
  8016. */
  8017. markAsImageProcessingDirty(): void;
  8018. /**
  8019. * Marks the material to indicate the lights need to be re-calculated
  8020. * @param disposed Defines whether the light is dirty due to dispose or not
  8021. */
  8022. markAsLightDirty(disposed?: boolean): void;
  8023. /**
  8024. * Marks the attribute state as changed
  8025. */
  8026. markAsAttributesDirty(): void;
  8027. /**
  8028. * Marks the texture state as changed
  8029. */
  8030. markAsTexturesDirty(): void;
  8031. /**
  8032. * Marks the fresnel state as changed
  8033. */
  8034. markAsFresnelDirty(): void;
  8035. /**
  8036. * Marks the misc state as changed
  8037. */
  8038. markAsMiscDirty(): void;
  8039. /**
  8040. * Rebuilds the material defines
  8041. */
  8042. rebuild(): void;
  8043. /**
  8044. * Specifies if two material defines are equal
  8045. * @param other - A material define instance to compare to
  8046. * @returns - Boolean indicating if the material defines are equal (true) or not (false)
  8047. */
  8048. isEqual(other: MaterialDefines): boolean;
  8049. /**
  8050. * Clones this instance's defines to another instance
  8051. * @param other - material defines to clone values to
  8052. */
  8053. cloneTo(other: MaterialDefines): void;
  8054. /**
  8055. * Resets the material define values
  8056. */
  8057. reset(): void;
  8058. /**
  8059. * Converts the material define values to a string
  8060. * @returns - String of material define information
  8061. */
  8062. toString(): string;
  8063. }
  8064. }
  8065. declare module "babylonjs/Materials/colorCurves" {
  8066. import { Effect } from "babylonjs/Materials/effect";
  8067. /**
  8068. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  8069. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  8070. * 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;
  8071. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  8072. */
  8073. export class ColorCurves {
  8074. private _dirty;
  8075. private _tempColor;
  8076. private _globalCurve;
  8077. private _highlightsCurve;
  8078. private _midtonesCurve;
  8079. private _shadowsCurve;
  8080. private _positiveCurve;
  8081. private _negativeCurve;
  8082. private _globalHue;
  8083. private _globalDensity;
  8084. private _globalSaturation;
  8085. private _globalExposure;
  8086. /**
  8087. * Gets the global Hue value.
  8088. * 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).
  8089. */
  8090. get globalHue(): number;
  8091. /**
  8092. * Sets the global Hue value.
  8093. * 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).
  8094. */
  8095. set globalHue(value: number);
  8096. /**
  8097. * Gets the global Density value.
  8098. * 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.
  8099. * Values less than zero provide a filter of opposite hue.
  8100. */
  8101. get globalDensity(): number;
  8102. /**
  8103. * Sets the global Density value.
  8104. * 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.
  8105. * Values less than zero provide a filter of opposite hue.
  8106. */
  8107. set globalDensity(value: number);
  8108. /**
  8109. * Gets the global Saturation value.
  8110. * 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.
  8111. */
  8112. get globalSaturation(): number;
  8113. /**
  8114. * Sets the global Saturation value.
  8115. * 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.
  8116. */
  8117. set globalSaturation(value: number);
  8118. /**
  8119. * Gets the global Exposure value.
  8120. * 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.
  8121. */
  8122. get globalExposure(): number;
  8123. /**
  8124. * Sets the global Exposure value.
  8125. * 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.
  8126. */
  8127. set globalExposure(value: number);
  8128. private _highlightsHue;
  8129. private _highlightsDensity;
  8130. private _highlightsSaturation;
  8131. private _highlightsExposure;
  8132. /**
  8133. * Gets the highlights Hue value.
  8134. * 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).
  8135. */
  8136. get highlightsHue(): number;
  8137. /**
  8138. * Sets the highlights Hue value.
  8139. * 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).
  8140. */
  8141. set highlightsHue(value: number);
  8142. /**
  8143. * Gets the highlights Density value.
  8144. * 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.
  8145. * Values less than zero provide a filter of opposite hue.
  8146. */
  8147. get highlightsDensity(): number;
  8148. /**
  8149. * Sets the highlights Density value.
  8150. * 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.
  8151. * Values less than zero provide a filter of opposite hue.
  8152. */
  8153. set highlightsDensity(value: number);
  8154. /**
  8155. * Gets the highlights Saturation value.
  8156. * 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.
  8157. */
  8158. get highlightsSaturation(): number;
  8159. /**
  8160. * Sets the highlights Saturation value.
  8161. * 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.
  8162. */
  8163. set highlightsSaturation(value: number);
  8164. /**
  8165. * Gets the highlights Exposure value.
  8166. * 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.
  8167. */
  8168. get highlightsExposure(): number;
  8169. /**
  8170. * Sets the highlights Exposure value.
  8171. * 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.
  8172. */
  8173. set highlightsExposure(value: number);
  8174. private _midtonesHue;
  8175. private _midtonesDensity;
  8176. private _midtonesSaturation;
  8177. private _midtonesExposure;
  8178. /**
  8179. * Gets the midtones Hue value.
  8180. * 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).
  8181. */
  8182. get midtonesHue(): number;
  8183. /**
  8184. * Sets the midtones Hue value.
  8185. * 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).
  8186. */
  8187. set midtonesHue(value: number);
  8188. /**
  8189. * Gets the midtones Density value.
  8190. * 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.
  8191. * Values less than zero provide a filter of opposite hue.
  8192. */
  8193. get midtonesDensity(): number;
  8194. /**
  8195. * Sets the midtones Density value.
  8196. * 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.
  8197. * Values less than zero provide a filter of opposite hue.
  8198. */
  8199. set midtonesDensity(value: number);
  8200. /**
  8201. * Gets the midtones Saturation value.
  8202. * 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.
  8203. */
  8204. get midtonesSaturation(): number;
  8205. /**
  8206. * Sets the midtones Saturation value.
  8207. * 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.
  8208. */
  8209. set midtonesSaturation(value: number);
  8210. /**
  8211. * Gets the midtones Exposure value.
  8212. * 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.
  8213. */
  8214. get midtonesExposure(): number;
  8215. /**
  8216. * Sets the midtones Exposure value.
  8217. * 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.
  8218. */
  8219. set midtonesExposure(value: number);
  8220. private _shadowsHue;
  8221. private _shadowsDensity;
  8222. private _shadowsSaturation;
  8223. private _shadowsExposure;
  8224. /**
  8225. * Gets the shadows Hue value.
  8226. * 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).
  8227. */
  8228. get shadowsHue(): number;
  8229. /**
  8230. * Sets the shadows Hue value.
  8231. * 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).
  8232. */
  8233. set shadowsHue(value: number);
  8234. /**
  8235. * Gets the shadows Density value.
  8236. * 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.
  8237. * Values less than zero provide a filter of opposite hue.
  8238. */
  8239. get shadowsDensity(): number;
  8240. /**
  8241. * Sets the shadows Density value.
  8242. * 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.
  8243. * Values less than zero provide a filter of opposite hue.
  8244. */
  8245. set shadowsDensity(value: number);
  8246. /**
  8247. * Gets the shadows Saturation value.
  8248. * 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.
  8249. */
  8250. get shadowsSaturation(): number;
  8251. /**
  8252. * Sets the shadows Saturation value.
  8253. * 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.
  8254. */
  8255. set shadowsSaturation(value: number);
  8256. /**
  8257. * Gets the shadows Exposure value.
  8258. * 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.
  8259. */
  8260. get shadowsExposure(): number;
  8261. /**
  8262. * Sets the shadows Exposure value.
  8263. * 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.
  8264. */
  8265. set shadowsExposure(value: number);
  8266. /**
  8267. * Returns the class name
  8268. * @returns The class name
  8269. */
  8270. getClassName(): string;
  8271. /**
  8272. * Binds the color curves to the shader.
  8273. * @param colorCurves The color curve to bind
  8274. * @param effect The effect to bind to
  8275. * @param positiveUniform The positive uniform shader parameter
  8276. * @param neutralUniform The neutral uniform shader parameter
  8277. * @param negativeUniform The negative uniform shader parameter
  8278. */
  8279. static Bind(colorCurves: ColorCurves, effect: Effect, positiveUniform?: string, neutralUniform?: string, negativeUniform?: string): void;
  8280. /**
  8281. * Prepare the list of uniforms associated with the ColorCurves effects.
  8282. * @param uniformsList The list of uniforms used in the effect
  8283. */
  8284. static PrepareUniforms(uniformsList: string[]): void;
  8285. /**
  8286. * Returns color grading data based on a hue, density, saturation and exposure value.
  8287. * @param filterHue The hue of the color filter.
  8288. * @param filterDensity The density of the color filter.
  8289. * @param saturation The saturation.
  8290. * @param exposure The exposure.
  8291. * @param result The result data container.
  8292. */
  8293. private getColorGradingDataToRef;
  8294. /**
  8295. * Takes an input slider value and returns an adjusted value that provides extra control near the centre.
  8296. * @param value The input slider value in range [-100,100].
  8297. * @returns Adjusted value.
  8298. */
  8299. private static applyColorGradingSliderNonlinear;
  8300. /**
  8301. * Returns an RGBA Color4 based on Hue, Saturation and Brightness (also referred to as value, HSV).
  8302. * @param hue The hue (H) input.
  8303. * @param saturation The saturation (S) input.
  8304. * @param brightness The brightness (B) input.
  8305. * @result An RGBA color represented as Vector4.
  8306. */
  8307. private static fromHSBToRef;
  8308. /**
  8309. * Returns a value clamped between min and max
  8310. * @param value The value to clamp
  8311. * @param min The minimum of value
  8312. * @param max The maximum of value
  8313. * @returns The clamped value.
  8314. */
  8315. private static clamp;
  8316. /**
  8317. * Clones the current color curve instance.
  8318. * @return The cloned curves
  8319. */
  8320. clone(): ColorCurves;
  8321. /**
  8322. * Serializes the current color curve instance to a json representation.
  8323. * @return a JSON representation
  8324. */
  8325. serialize(): any;
  8326. /**
  8327. * Parses the color curve from a json representation.
  8328. * @param source the JSON source to parse
  8329. * @return The parsed curves
  8330. */
  8331. static Parse(source: any): ColorCurves;
  8332. }
  8333. }
  8334. declare module "babylonjs/Materials/imageProcessingConfiguration" {
  8335. import { Observable } from "babylonjs/Misc/observable";
  8336. import { Nullable } from "babylonjs/types";
  8337. import { Color4 } from "babylonjs/Maths/math.color";
  8338. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  8339. import { Effect } from "babylonjs/Materials/effect";
  8340. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  8341. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  8342. /**
  8343. * Interface to follow in your material defines to integrate easily the
  8344. * Image proccessing functions.
  8345. * @hidden
  8346. */
  8347. export interface IImageProcessingConfigurationDefines {
  8348. IMAGEPROCESSING: boolean;
  8349. VIGNETTE: boolean;
  8350. VIGNETTEBLENDMODEMULTIPLY: boolean;
  8351. VIGNETTEBLENDMODEOPAQUE: boolean;
  8352. TONEMAPPING: boolean;
  8353. TONEMAPPING_ACES: boolean;
  8354. CONTRAST: boolean;
  8355. EXPOSURE: boolean;
  8356. COLORCURVES: boolean;
  8357. COLORGRADING: boolean;
  8358. COLORGRADING3D: boolean;
  8359. SAMPLER3DGREENDEPTH: boolean;
  8360. SAMPLER3DBGRMAP: boolean;
  8361. IMAGEPROCESSINGPOSTPROCESS: boolean;
  8362. }
  8363. /**
  8364. * @hidden
  8365. */
  8366. export class ImageProcessingConfigurationDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  8367. IMAGEPROCESSING: boolean;
  8368. VIGNETTE: boolean;
  8369. VIGNETTEBLENDMODEMULTIPLY: boolean;
  8370. VIGNETTEBLENDMODEOPAQUE: boolean;
  8371. TONEMAPPING: boolean;
  8372. TONEMAPPING_ACES: boolean;
  8373. CONTRAST: boolean;
  8374. COLORCURVES: boolean;
  8375. COLORGRADING: boolean;
  8376. COLORGRADING3D: boolean;
  8377. SAMPLER3DGREENDEPTH: boolean;
  8378. SAMPLER3DBGRMAP: boolean;
  8379. IMAGEPROCESSINGPOSTPROCESS: boolean;
  8380. EXPOSURE: boolean;
  8381. constructor();
  8382. }
  8383. /**
  8384. * This groups together the common properties used for image processing either in direct forward pass
  8385. * or through post processing effect depending on the use of the image processing pipeline in your scene
  8386. * or not.
  8387. */
  8388. export class ImageProcessingConfiguration {
  8389. /**
  8390. * Default tone mapping applied in BabylonJS.
  8391. */
  8392. static readonly TONEMAPPING_STANDARD: number;
  8393. /**
  8394. * ACES Tone mapping (used by default in unreal and unity). This can help getting closer
  8395. * to other engines rendering to increase portability.
  8396. */
  8397. static readonly TONEMAPPING_ACES: number;
  8398. /**
  8399. * Color curves setup used in the effect if colorCurvesEnabled is set to true
  8400. */
  8401. colorCurves: Nullable<ColorCurves>;
  8402. private _colorCurvesEnabled;
  8403. /**
  8404. * Gets wether the color curves effect is enabled.
  8405. */
  8406. get colorCurvesEnabled(): boolean;
  8407. /**
  8408. * Sets wether the color curves effect is enabled.
  8409. */
  8410. set colorCurvesEnabled(value: boolean);
  8411. private _colorGradingTexture;
  8412. /**
  8413. * Color grading LUT texture used in the effect if colorGradingEnabled is set to true
  8414. */
  8415. get colorGradingTexture(): Nullable<BaseTexture>;
  8416. /**
  8417. * Color grading LUT texture used in the effect if colorGradingEnabled is set to true
  8418. */
  8419. set colorGradingTexture(value: Nullable<BaseTexture>);
  8420. private _colorGradingEnabled;
  8421. /**
  8422. * Gets wether the color grading effect is enabled.
  8423. */
  8424. get colorGradingEnabled(): boolean;
  8425. /**
  8426. * Sets wether the color grading effect is enabled.
  8427. */
  8428. set colorGradingEnabled(value: boolean);
  8429. private _colorGradingWithGreenDepth;
  8430. /**
  8431. * Gets wether the color grading effect is using a green depth for the 3d Texture.
  8432. */
  8433. get colorGradingWithGreenDepth(): boolean;
  8434. /**
  8435. * Sets wether the color grading effect is using a green depth for the 3d Texture.
  8436. */
  8437. set colorGradingWithGreenDepth(value: boolean);
  8438. private _colorGradingBGR;
  8439. /**
  8440. * Gets wether the color grading texture contains BGR values.
  8441. */
  8442. get colorGradingBGR(): boolean;
  8443. /**
  8444. * Sets wether the color grading texture contains BGR values.
  8445. */
  8446. set colorGradingBGR(value: boolean);
  8447. /** @hidden */
  8448. _exposure: number;
  8449. /**
  8450. * Gets the Exposure used in the effect.
  8451. */
  8452. get exposure(): number;
  8453. /**
  8454. * Sets the Exposure used in the effect.
  8455. */
  8456. set exposure(value: number);
  8457. private _toneMappingEnabled;
  8458. /**
  8459. * Gets wether the tone mapping effect is enabled.
  8460. */
  8461. get toneMappingEnabled(): boolean;
  8462. /**
  8463. * Sets wether the tone mapping effect is enabled.
  8464. */
  8465. set toneMappingEnabled(value: boolean);
  8466. private _toneMappingType;
  8467. /**
  8468. * Gets the type of tone mapping effect.
  8469. */
  8470. get toneMappingType(): number;
  8471. /**
  8472. * Sets the type of tone mapping effect used in BabylonJS.
  8473. */
  8474. set toneMappingType(value: number);
  8475. protected _contrast: number;
  8476. /**
  8477. * Gets the contrast used in the effect.
  8478. */
  8479. get contrast(): number;
  8480. /**
  8481. * Sets the contrast used in the effect.
  8482. */
  8483. set contrast(value: number);
  8484. /**
  8485. * Vignette stretch size.
  8486. */
  8487. vignetteStretch: number;
  8488. /**
  8489. * Vignette centre X Offset.
  8490. */
  8491. vignetteCentreX: number;
  8492. /**
  8493. * Vignette centre Y Offset.
  8494. */
  8495. vignetteCentreY: number;
  8496. /**
  8497. * Vignette weight or intensity of the vignette effect.
  8498. */
  8499. vignetteWeight: number;
  8500. /**
  8501. * Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  8502. * if vignetteEnabled is set to true.
  8503. */
  8504. vignetteColor: Color4;
  8505. /**
  8506. * Camera field of view used by the Vignette effect.
  8507. */
  8508. vignetteCameraFov: number;
  8509. private _vignetteBlendMode;
  8510. /**
  8511. * Gets the vignette blend mode allowing different kind of effect.
  8512. */
  8513. get vignetteBlendMode(): number;
  8514. /**
  8515. * Sets the vignette blend mode allowing different kind of effect.
  8516. */
  8517. set vignetteBlendMode(value: number);
  8518. private _vignetteEnabled;
  8519. /**
  8520. * Gets wether the vignette effect is enabled.
  8521. */
  8522. get vignetteEnabled(): boolean;
  8523. /**
  8524. * Sets wether the vignette effect is enabled.
  8525. */
  8526. set vignetteEnabled(value: boolean);
  8527. private _applyByPostProcess;
  8528. /**
  8529. * Gets wether the image processing is applied through a post process or not.
  8530. */
  8531. get applyByPostProcess(): boolean;
  8532. /**
  8533. * Sets wether the image processing is applied through a post process or not.
  8534. */
  8535. set applyByPostProcess(value: boolean);
  8536. private _isEnabled;
  8537. /**
  8538. * Gets wether the image processing is enabled or not.
  8539. */
  8540. get isEnabled(): boolean;
  8541. /**
  8542. * Sets wether the image processing is enabled or not.
  8543. */
  8544. set isEnabled(value: boolean);
  8545. /**
  8546. * An event triggered when the configuration changes and requires Shader to Update some parameters.
  8547. */
  8548. onUpdateParameters: Observable<ImageProcessingConfiguration>;
  8549. /**
  8550. * Method called each time the image processing information changes requires to recompile the effect.
  8551. */
  8552. protected _updateParameters(): void;
  8553. /**
  8554. * Gets the current class name.
  8555. * @return "ImageProcessingConfiguration"
  8556. */
  8557. getClassName(): string;
  8558. /**
  8559. * Prepare the list of uniforms associated with the Image Processing effects.
  8560. * @param uniforms The list of uniforms used in the effect
  8561. * @param defines the list of defines currently in use
  8562. */
  8563. static PrepareUniforms(uniforms: string[], defines: IImageProcessingConfigurationDefines): void;
  8564. /**
  8565. * Prepare the list of samplers associated with the Image Processing effects.
  8566. * @param samplersList The list of uniforms used in the effect
  8567. * @param defines the list of defines currently in use
  8568. */
  8569. static PrepareSamplers(samplersList: string[], defines: IImageProcessingConfigurationDefines): void;
  8570. /**
  8571. * Prepare the list of defines associated to the shader.
  8572. * @param defines the list of defines to complete
  8573. * @param forPostProcess Define if we are currently in post process mode or not
  8574. */
  8575. prepareDefines(defines: IImageProcessingConfigurationDefines, forPostProcess?: boolean): void;
  8576. /**
  8577. * Returns true if all the image processing information are ready.
  8578. * @returns True if ready, otherwise, false
  8579. */
  8580. isReady(): boolean;
  8581. /**
  8582. * Binds the image processing to the shader.
  8583. * @param effect The effect to bind to
  8584. * @param overrideAspectRatio Override the aspect ratio of the effect
  8585. */
  8586. bind(effect: Effect, overrideAspectRatio?: number): void;
  8587. /**
  8588. * Clones the current image processing instance.
  8589. * @return The cloned image processing
  8590. */
  8591. clone(): ImageProcessingConfiguration;
  8592. /**
  8593. * Serializes the current image processing instance to a json representation.
  8594. * @return a JSON representation
  8595. */
  8596. serialize(): any;
  8597. /**
  8598. * Parses the image processing from a json representation.
  8599. * @param source the JSON source to parse
  8600. * @return The parsed image processing
  8601. */
  8602. static Parse(source: any): ImageProcessingConfiguration;
  8603. private static _VIGNETTEMODE_MULTIPLY;
  8604. private static _VIGNETTEMODE_OPAQUE;
  8605. /**
  8606. * Used to apply the vignette as a mix with the pixel color.
  8607. */
  8608. static get VIGNETTEMODE_MULTIPLY(): number;
  8609. /**
  8610. * Used to apply the vignette as a replacement of the pixel color.
  8611. */
  8612. static get VIGNETTEMODE_OPAQUE(): number;
  8613. }
  8614. }
  8615. declare module "babylonjs/Shaders/postprocess.vertex" {
  8616. /** @hidden */
  8617. export var postprocessVertexShader: {
  8618. name: string;
  8619. shader: string;
  8620. };
  8621. }
  8622. declare module "babylonjs/Engines/Extensions/engine.renderTarget" {
  8623. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  8624. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  8625. import { DepthTextureCreationOptions } from "babylonjs/Engines/depthTextureCreationOptions";
  8626. module "babylonjs/Engines/thinEngine" {
  8627. interface ThinEngine {
  8628. /**
  8629. * Creates a new render target texture
  8630. * @param size defines the size of the texture
  8631. * @param options defines the options used to create the texture
  8632. * @returns a new render target texture stored in an InternalTexture
  8633. */
  8634. createRenderTargetTexture(size: number | {
  8635. width: number;
  8636. height: number;
  8637. layers?: number;
  8638. }, options: boolean | RenderTargetCreationOptions): InternalTexture;
  8639. /**
  8640. * Creates a depth stencil texture.
  8641. * This is only available in WebGL 2 or with the depth texture extension available.
  8642. * @param size The size of face edge in the texture.
  8643. * @param options The options defining the texture.
  8644. * @returns The texture
  8645. */
  8646. createDepthStencilTexture(size: number | {
  8647. width: number;
  8648. height: number;
  8649. layers?: number;
  8650. }, options: DepthTextureCreationOptions): InternalTexture;
  8651. /** @hidden */
  8652. _createDepthStencilTexture(size: number | {
  8653. width: number;
  8654. height: number;
  8655. layers?: number;
  8656. }, options: DepthTextureCreationOptions): InternalTexture;
  8657. }
  8658. }
  8659. }
  8660. declare module "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes" {
  8661. /**
  8662. * Defines the kind of connection point for node based material
  8663. */
  8664. export enum NodeMaterialBlockConnectionPointTypes {
  8665. /** Float */
  8666. Float = 1,
  8667. /** Int */
  8668. Int = 2,
  8669. /** Vector2 */
  8670. Vector2 = 4,
  8671. /** Vector3 */
  8672. Vector3 = 8,
  8673. /** Vector4 */
  8674. Vector4 = 16,
  8675. /** Color3 */
  8676. Color3 = 32,
  8677. /** Color4 */
  8678. Color4 = 64,
  8679. /** Matrix */
  8680. Matrix = 128,
  8681. /** Custom object */
  8682. Object = 256,
  8683. /** Detect type based on connection */
  8684. AutoDetect = 1024,
  8685. /** Output type that will be defined by input type */
  8686. BasedOnInput = 2048
  8687. }
  8688. }
  8689. declare module "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets" {
  8690. /**
  8691. * Enum used to define the target of a block
  8692. */
  8693. export enum NodeMaterialBlockTargets {
  8694. /** Vertex shader */
  8695. Vertex = 1,
  8696. /** Fragment shader */
  8697. Fragment = 2,
  8698. /** Neutral */
  8699. Neutral = 4,
  8700. /** Vertex and Fragment */
  8701. VertexAndFragment = 3
  8702. }
  8703. }
  8704. declare module "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointMode" {
  8705. /**
  8706. * Enum defining the mode of a NodeMaterialBlockConnectionPoint
  8707. */
  8708. export enum NodeMaterialBlockConnectionPointMode {
  8709. /** Value is an uniform */
  8710. Uniform = 0,
  8711. /** Value is a mesh attribute */
  8712. Attribute = 1,
  8713. /** Value is a varying between vertex and fragment shaders */
  8714. Varying = 2,
  8715. /** Mode is undefined */
  8716. Undefined = 3
  8717. }
  8718. }
  8719. declare module "babylonjs/Materials/Node/Enums/nodeMaterialSystemValues" {
  8720. /**
  8721. * Enum used to define system values e.g. values automatically provided by the system
  8722. */
  8723. export enum NodeMaterialSystemValues {
  8724. /** World */
  8725. World = 1,
  8726. /** View */
  8727. View = 2,
  8728. /** Projection */
  8729. Projection = 3,
  8730. /** ViewProjection */
  8731. ViewProjection = 4,
  8732. /** WorldView */
  8733. WorldView = 5,
  8734. /** WorldViewProjection */
  8735. WorldViewProjection = 6,
  8736. /** CameraPosition */
  8737. CameraPosition = 7,
  8738. /** Fog Color */
  8739. FogColor = 8,
  8740. /** Delta time */
  8741. DeltaTime = 9
  8742. }
  8743. }
  8744. declare module "babylonjs/Maths/math.axis" {
  8745. import { Vector3 } from "babylonjs/Maths/math.vector";
  8746. /** Defines supported spaces */
  8747. export enum Space {
  8748. /** Local (object) space */
  8749. LOCAL = 0,
  8750. /** World space */
  8751. WORLD = 1,
  8752. /** Bone space */
  8753. BONE = 2
  8754. }
  8755. /** Defines the 3 main axes */
  8756. export class Axis {
  8757. /** X axis */
  8758. static X: Vector3;
  8759. /** Y axis */
  8760. static Y: Vector3;
  8761. /** Z axis */
  8762. static Z: Vector3;
  8763. }
  8764. }
  8765. declare module "babylonjs/Maths/math.frustum" {
  8766. import { Matrix } from "babylonjs/Maths/math.vector";
  8767. import { DeepImmutable } from "babylonjs/types";
  8768. import { Plane } from "babylonjs/Maths/math.plane";
  8769. /**
  8770. * Represents a camera frustum
  8771. */
  8772. export class Frustum {
  8773. /**
  8774. * Gets the planes representing the frustum
  8775. * @param transform matrix to be applied to the returned planes
  8776. * @returns a new array of 6 Frustum planes computed by the given transformation matrix.
  8777. */
  8778. static GetPlanes(transform: DeepImmutable<Matrix>): Plane[];
  8779. /**
  8780. * Gets the near frustum plane transformed by the transform matrix
  8781. * @param transform transformation matrix to be applied to the resulting frustum plane
  8782. * @param frustumPlane the resuling frustum plane
  8783. */
  8784. static GetNearPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  8785. /**
  8786. * Gets the far frustum plane transformed by the transform matrix
  8787. * @param transform transformation matrix to be applied to the resulting frustum plane
  8788. * @param frustumPlane the resuling frustum plane
  8789. */
  8790. static GetFarPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  8791. /**
  8792. * Gets the left frustum plane transformed by the transform matrix
  8793. * @param transform transformation matrix to be applied to the resulting frustum plane
  8794. * @param frustumPlane the resuling frustum plane
  8795. */
  8796. static GetLeftPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  8797. /**
  8798. * Gets the right frustum plane transformed by the transform matrix
  8799. * @param transform transformation matrix to be applied to the resulting frustum plane
  8800. * @param frustumPlane the resuling frustum plane
  8801. */
  8802. static GetRightPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  8803. /**
  8804. * Gets the top frustum plane transformed by the transform matrix
  8805. * @param transform transformation matrix to be applied to the resulting frustum plane
  8806. * @param frustumPlane the resuling frustum plane
  8807. */
  8808. static GetTopPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  8809. /**
  8810. * Gets the bottom frustum plane transformed by the transform matrix
  8811. * @param transform transformation matrix to be applied to the resulting frustum plane
  8812. * @param frustumPlane the resuling frustum plane
  8813. */
  8814. static GetBottomPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  8815. /**
  8816. * Sets the given array "frustumPlanes" with the 6 Frustum planes computed by the given transformation matrix.
  8817. * @param transform transformation matrix to be applied to the resulting frustum planes
  8818. * @param frustumPlanes the resuling frustum planes
  8819. */
  8820. static GetPlanesToRef(transform: DeepImmutable<Matrix>, frustumPlanes: Plane[]): void;
  8821. }
  8822. }
  8823. declare module "babylonjs/Maths/math.size" {
  8824. /**
  8825. * Interface for the size containing width and height
  8826. */
  8827. export interface ISize {
  8828. /**
  8829. * Width
  8830. */
  8831. width: number;
  8832. /**
  8833. * Heighht
  8834. */
  8835. height: number;
  8836. }
  8837. /**
  8838. * Size containing widht and height
  8839. */
  8840. export class Size implements ISize {
  8841. /**
  8842. * Width
  8843. */
  8844. width: number;
  8845. /**
  8846. * Height
  8847. */
  8848. height: number;
  8849. /**
  8850. * Creates a Size object from the given width and height (floats).
  8851. * @param width width of the new size
  8852. * @param height height of the new size
  8853. */
  8854. constructor(width: number, height: number);
  8855. /**
  8856. * Returns a string with the Size width and height
  8857. * @returns a string with the Size width and height
  8858. */
  8859. toString(): string;
  8860. /**
  8861. * "Size"
  8862. * @returns the string "Size"
  8863. */
  8864. getClassName(): string;
  8865. /**
  8866. * Returns the Size hash code.
  8867. * @returns a hash code for a unique width and height
  8868. */
  8869. getHashCode(): number;
  8870. /**
  8871. * Updates the current size from the given one.
  8872. * @param src the given size
  8873. */
  8874. copyFrom(src: Size): void;
  8875. /**
  8876. * Updates in place the current Size from the given floats.
  8877. * @param width width of the new size
  8878. * @param height height of the new size
  8879. * @returns the updated Size.
  8880. */
  8881. copyFromFloats(width: number, height: number): Size;
  8882. /**
  8883. * Updates in place the current Size from the given floats.
  8884. * @param width width to set
  8885. * @param height height to set
  8886. * @returns the updated Size.
  8887. */
  8888. set(width: number, height: number): Size;
  8889. /**
  8890. * Multiplies the width and height by numbers
  8891. * @param w factor to multiple the width by
  8892. * @param h factor to multiple the height by
  8893. * @returns a new Size set with the multiplication result of the current Size and the given floats.
  8894. */
  8895. multiplyByFloats(w: number, h: number): Size;
  8896. /**
  8897. * Clones the size
  8898. * @returns a new Size copied from the given one.
  8899. */
  8900. clone(): Size;
  8901. /**
  8902. * True if the current Size and the given one width and height are strictly equal.
  8903. * @param other the other size to compare against
  8904. * @returns True if the current Size and the given one width and height are strictly equal.
  8905. */
  8906. equals(other: Size): boolean;
  8907. /**
  8908. * The surface of the Size : width * height (float).
  8909. */
  8910. get surface(): number;
  8911. /**
  8912. * Create a new size of zero
  8913. * @returns a new Size set to (0.0, 0.0)
  8914. */
  8915. static Zero(): Size;
  8916. /**
  8917. * Sums the width and height of two sizes
  8918. * @param otherSize size to add to this size
  8919. * @returns a new Size set as the addition result of the current Size and the given one.
  8920. */
  8921. add(otherSize: Size): Size;
  8922. /**
  8923. * Subtracts the width and height of two
  8924. * @param otherSize size to subtract to this size
  8925. * @returns a new Size set as the subtraction result of the given one from the current Size.
  8926. */
  8927. subtract(otherSize: Size): Size;
  8928. /**
  8929. * Creates a new Size set at the linear interpolation "amount" between "start" and "end"
  8930. * @param start starting size to lerp between
  8931. * @param end end size to lerp between
  8932. * @param amount amount to lerp between the start and end values
  8933. * @returns a new Size set at the linear interpolation "amount" between "start" and "end"
  8934. */
  8935. static Lerp(start: Size, end: Size, amount: number): Size;
  8936. }
  8937. }
  8938. declare module "babylonjs/Maths/math.vertexFormat" {
  8939. import { Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  8940. /**
  8941. * Contains position and normal vectors for a vertex
  8942. */
  8943. export class PositionNormalVertex {
  8944. /** the position of the vertex (defaut: 0,0,0) */
  8945. position: Vector3;
  8946. /** the normal of the vertex (defaut: 0,1,0) */
  8947. normal: Vector3;
  8948. /**
  8949. * Creates a PositionNormalVertex
  8950. * @param position the position of the vertex (defaut: 0,0,0)
  8951. * @param normal the normal of the vertex (defaut: 0,1,0)
  8952. */
  8953. constructor(
  8954. /** the position of the vertex (defaut: 0,0,0) */
  8955. position?: Vector3,
  8956. /** the normal of the vertex (defaut: 0,1,0) */
  8957. normal?: Vector3);
  8958. /**
  8959. * Clones the PositionNormalVertex
  8960. * @returns the cloned PositionNormalVertex
  8961. */
  8962. clone(): PositionNormalVertex;
  8963. }
  8964. /**
  8965. * Contains position, normal and uv vectors for a vertex
  8966. */
  8967. export class PositionNormalTextureVertex {
  8968. /** the position of the vertex (defaut: 0,0,0) */
  8969. position: Vector3;
  8970. /** the normal of the vertex (defaut: 0,1,0) */
  8971. normal: Vector3;
  8972. /** the uv of the vertex (default: 0,0) */
  8973. uv: Vector2;
  8974. /**
  8975. * Creates a PositionNormalTextureVertex
  8976. * @param position the position of the vertex (defaut: 0,0,0)
  8977. * @param normal the normal of the vertex (defaut: 0,1,0)
  8978. * @param uv the uv of the vertex (default: 0,0)
  8979. */
  8980. constructor(
  8981. /** the position of the vertex (defaut: 0,0,0) */
  8982. position?: Vector3,
  8983. /** the normal of the vertex (defaut: 0,1,0) */
  8984. normal?: Vector3,
  8985. /** the uv of the vertex (default: 0,0) */
  8986. uv?: Vector2);
  8987. /**
  8988. * Clones the PositionNormalTextureVertex
  8989. * @returns the cloned PositionNormalTextureVertex
  8990. */
  8991. clone(): PositionNormalTextureVertex;
  8992. }
  8993. }
  8994. declare module "babylonjs/Maths/math" {
  8995. export * from "babylonjs/Maths/math.axis";
  8996. export * from "babylonjs/Maths/math.color";
  8997. export * from "babylonjs/Maths/math.constants";
  8998. export * from "babylonjs/Maths/math.frustum";
  8999. export * from "babylonjs/Maths/math.path";
  9000. export * from "babylonjs/Maths/math.plane";
  9001. export * from "babylonjs/Maths/math.size";
  9002. export * from "babylonjs/Maths/math.vector";
  9003. export * from "babylonjs/Maths/math.vertexFormat";
  9004. export * from "babylonjs/Maths/math.viewport";
  9005. }
  9006. declare module "babylonjs/Materials/Node/Blocks/Input/animatedInputBlockTypes" {
  9007. /**
  9008. * Enum defining the type of animations supported by InputBlock
  9009. */
  9010. export enum AnimatedInputBlockTypes {
  9011. /** No animation */
  9012. None = 0,
  9013. /** Time based animation. Will only work for floats */
  9014. Time = 1
  9015. }
  9016. }
  9017. declare module "babylonjs/Lights/shadowLight" {
  9018. import { Camera } from "babylonjs/Cameras/camera";
  9019. import { Scene } from "babylonjs/scene";
  9020. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  9021. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  9022. import { Light } from "babylonjs/Lights/light";
  9023. /**
  9024. * Interface describing all the common properties and methods a shadow light needs to implement.
  9025. * This helps both the shadow generator and materials to genrate the corresponding shadow maps
  9026. * as well as binding the different shadow properties to the effects.
  9027. */
  9028. export interface IShadowLight extends Light {
  9029. /**
  9030. * The light id in the scene (used in scene.findLighById for instance)
  9031. */
  9032. id: string;
  9033. /**
  9034. * The position the shdow will be casted from.
  9035. */
  9036. position: Vector3;
  9037. /**
  9038. * In 2d mode (needCube being false), the direction used to cast the shadow.
  9039. */
  9040. direction: Vector3;
  9041. /**
  9042. * The transformed position. Position of the light in world space taking parenting in account.
  9043. */
  9044. transformedPosition: Vector3;
  9045. /**
  9046. * The transformed direction. Direction of the light in world space taking parenting in account.
  9047. */
  9048. transformedDirection: Vector3;
  9049. /**
  9050. * The friendly name of the light in the scene.
  9051. */
  9052. name: string;
  9053. /**
  9054. * Defines the shadow projection clipping minimum z value.
  9055. */
  9056. shadowMinZ: number;
  9057. /**
  9058. * Defines the shadow projection clipping maximum z value.
  9059. */
  9060. shadowMaxZ: number;
  9061. /**
  9062. * Computes the transformed information (transformedPosition and transformedDirection in World space) of the current light
  9063. * @returns true if the information has been computed, false if it does not need to (no parenting)
  9064. */
  9065. computeTransformedInformation(): boolean;
  9066. /**
  9067. * Gets the scene the light belongs to.
  9068. * @returns The scene
  9069. */
  9070. getScene(): Scene;
  9071. /**
  9072. * Callback defining a custom Projection Matrix Builder.
  9073. * This can be used to override the default projection matrix computation.
  9074. */
  9075. customProjectionMatrixBuilder: (viewMatrix: Matrix, renderList: Array<AbstractMesh>, result: Matrix) => void;
  9076. /**
  9077. * Sets the shadow projection matrix in parameter to the generated projection matrix.
  9078. * @param matrix The materix to updated with the projection information
  9079. * @param viewMatrix The transform matrix of the light
  9080. * @param renderList The list of mesh to render in the map
  9081. * @returns The current light
  9082. */
  9083. setShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): IShadowLight;
  9084. /**
  9085. * Gets the current depth scale used in ESM.
  9086. * @returns The scale
  9087. */
  9088. getDepthScale(): number;
  9089. /**
  9090. * Returns whether or not the shadow generation require a cube texture or a 2d texture.
  9091. * @returns true if a cube texture needs to be use
  9092. */
  9093. needCube(): boolean;
  9094. /**
  9095. * Detects if the projection matrix requires to be recomputed this frame.
  9096. * @returns true if it requires to be recomputed otherwise, false.
  9097. */
  9098. needProjectionMatrixCompute(): boolean;
  9099. /**
  9100. * Forces the shadow generator to recompute the projection matrix even if position and direction did not changed.
  9101. */
  9102. forceProjectionMatrixCompute(): void;
  9103. /**
  9104. * Get the direction to use to render the shadow map. In case of cube texture, the face index can be passed.
  9105. * @param faceIndex The index of the face we are computed the direction to generate shadow
  9106. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  9107. */
  9108. getShadowDirection(faceIndex?: number): Vector3;
  9109. /**
  9110. * Gets the minZ used for shadow according to both the scene and the light.
  9111. * @param activeCamera The camera we are returning the min for
  9112. * @returns the depth min z
  9113. */
  9114. getDepthMinZ(activeCamera: Camera): number;
  9115. /**
  9116. * Gets the maxZ used for shadow according to both the scene and the light.
  9117. * @param activeCamera The camera we are returning the max for
  9118. * @returns the depth max z
  9119. */
  9120. getDepthMaxZ(activeCamera: Camera): number;
  9121. }
  9122. /**
  9123. * Base implementation IShadowLight
  9124. * It groups all the common behaviour in order to reduce dupplication and better follow the DRY pattern.
  9125. */
  9126. export abstract class ShadowLight extends Light implements IShadowLight {
  9127. protected abstract _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  9128. protected _position: Vector3;
  9129. protected _setPosition(value: Vector3): void;
  9130. /**
  9131. * Sets the position the shadow will be casted from. Also use as the light position for both
  9132. * point and spot lights.
  9133. */
  9134. get position(): Vector3;
  9135. /**
  9136. * Sets the position the shadow will be casted from. Also use as the light position for both
  9137. * point and spot lights.
  9138. */
  9139. set position(value: Vector3);
  9140. protected _direction: Vector3;
  9141. protected _setDirection(value: Vector3): void;
  9142. /**
  9143. * In 2d mode (needCube being false), gets the direction used to cast the shadow.
  9144. * Also use as the light direction on spot and directional lights.
  9145. */
  9146. get direction(): Vector3;
  9147. /**
  9148. * In 2d mode (needCube being false), sets the direction used to cast the shadow.
  9149. * Also use as the light direction on spot and directional lights.
  9150. */
  9151. set direction(value: Vector3);
  9152. protected _shadowMinZ: number;
  9153. /**
  9154. * Gets the shadow projection clipping minimum z value.
  9155. */
  9156. get shadowMinZ(): number;
  9157. /**
  9158. * Sets the shadow projection clipping minimum z value.
  9159. */
  9160. set shadowMinZ(value: number);
  9161. protected _shadowMaxZ: number;
  9162. /**
  9163. * Sets the shadow projection clipping maximum z value.
  9164. */
  9165. get shadowMaxZ(): number;
  9166. /**
  9167. * Gets the shadow projection clipping maximum z value.
  9168. */
  9169. set shadowMaxZ(value: number);
  9170. /**
  9171. * Callback defining a custom Projection Matrix Builder.
  9172. * This can be used to override the default projection matrix computation.
  9173. */
  9174. customProjectionMatrixBuilder: (viewMatrix: Matrix, renderList: Array<AbstractMesh>, result: Matrix) => void;
  9175. /**
  9176. * The transformed position. Position of the light in world space taking parenting in account.
  9177. */
  9178. transformedPosition: Vector3;
  9179. /**
  9180. * The transformed direction. Direction of the light in world space taking parenting in account.
  9181. */
  9182. transformedDirection: Vector3;
  9183. private _needProjectionMatrixCompute;
  9184. /**
  9185. * Computes the transformed information (transformedPosition and transformedDirection in World space) of the current light
  9186. * @returns true if the information has been computed, false if it does not need to (no parenting)
  9187. */
  9188. computeTransformedInformation(): boolean;
  9189. /**
  9190. * Return the depth scale used for the shadow map.
  9191. * @returns the depth scale.
  9192. */
  9193. getDepthScale(): number;
  9194. /**
  9195. * Get the direction to use to render the shadow map. In case of cube texture, the face index can be passed.
  9196. * @param faceIndex The index of the face we are computed the direction to generate shadow
  9197. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  9198. */
  9199. getShadowDirection(faceIndex?: number): Vector3;
  9200. /**
  9201. * Returns the ShadowLight absolute position in the World.
  9202. * @returns the position vector in world space
  9203. */
  9204. getAbsolutePosition(): Vector3;
  9205. /**
  9206. * Sets the ShadowLight direction toward the passed target.
  9207. * @param target The point to target in local space
  9208. * @returns the updated ShadowLight direction
  9209. */
  9210. setDirectionToTarget(target: Vector3): Vector3;
  9211. /**
  9212. * Returns the light rotation in euler definition.
  9213. * @returns the x y z rotation in local space.
  9214. */
  9215. getRotation(): Vector3;
  9216. /**
  9217. * Returns whether or not the shadow generation require a cube texture or a 2d texture.
  9218. * @returns true if a cube texture needs to be use
  9219. */
  9220. needCube(): boolean;
  9221. /**
  9222. * Detects if the projection matrix requires to be recomputed this frame.
  9223. * @returns true if it requires to be recomputed otherwise, false.
  9224. */
  9225. needProjectionMatrixCompute(): boolean;
  9226. /**
  9227. * Forces the shadow generator to recompute the projection matrix even if position and direction did not changed.
  9228. */
  9229. forceProjectionMatrixCompute(): void;
  9230. /** @hidden */
  9231. _initCache(): void;
  9232. /** @hidden */
  9233. _isSynchronized(): boolean;
  9234. /**
  9235. * Computes the world matrix of the node
  9236. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  9237. * @returns the world matrix
  9238. */
  9239. computeWorldMatrix(force?: boolean): Matrix;
  9240. /**
  9241. * Gets the minZ used for shadow according to both the scene and the light.
  9242. * @param activeCamera The camera we are returning the min for
  9243. * @returns the depth min z
  9244. */
  9245. getDepthMinZ(activeCamera: Camera): number;
  9246. /**
  9247. * Gets the maxZ used for shadow according to both the scene and the light.
  9248. * @param activeCamera The camera we are returning the max for
  9249. * @returns the depth max z
  9250. */
  9251. getDepthMaxZ(activeCamera: Camera): number;
  9252. /**
  9253. * Sets the shadow projection matrix in parameter to the generated projection matrix.
  9254. * @param matrix The materix to updated with the projection information
  9255. * @param viewMatrix The transform matrix of the light
  9256. * @param renderList The list of mesh to render in the map
  9257. * @returns The current light
  9258. */
  9259. setShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): IShadowLight;
  9260. }
  9261. }
  9262. declare module "babylonjs/Shaders/ShadersInclude/packingFunctions" {
  9263. /** @hidden */
  9264. export var packingFunctions: {
  9265. name: string;
  9266. shader: string;
  9267. };
  9268. }
  9269. declare module "babylonjs/Shaders/ShadersInclude/bayerDitherFunctions" {
  9270. /** @hidden */
  9271. export var bayerDitherFunctions: {
  9272. name: string;
  9273. shader: string;
  9274. };
  9275. }
  9276. declare module "babylonjs/Shaders/ShadersInclude/shadowMapFragmentDeclaration" {
  9277. import "babylonjs/Shaders/ShadersInclude/packingFunctions";
  9278. import "babylonjs/Shaders/ShadersInclude/bayerDitherFunctions";
  9279. /** @hidden */
  9280. export var shadowMapFragmentDeclaration: {
  9281. name: string;
  9282. shader: string;
  9283. };
  9284. }
  9285. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration" {
  9286. /** @hidden */
  9287. export var clipPlaneFragmentDeclaration: {
  9288. name: string;
  9289. shader: string;
  9290. };
  9291. }
  9292. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneFragment" {
  9293. /** @hidden */
  9294. export var clipPlaneFragment: {
  9295. name: string;
  9296. shader: string;
  9297. };
  9298. }
  9299. declare module "babylonjs/Shaders/ShadersInclude/shadowMapFragment" {
  9300. /** @hidden */
  9301. export var shadowMapFragment: {
  9302. name: string;
  9303. shader: string;
  9304. };
  9305. }
  9306. declare module "babylonjs/Shaders/shadowMap.fragment" {
  9307. import "babylonjs/Shaders/ShadersInclude/shadowMapFragmentDeclaration";
  9308. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  9309. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  9310. import "babylonjs/Shaders/ShadersInclude/shadowMapFragment";
  9311. /** @hidden */
  9312. export var shadowMapPixelShader: {
  9313. name: string;
  9314. shader: string;
  9315. };
  9316. }
  9317. declare module "babylonjs/Shaders/ShadersInclude/bonesDeclaration" {
  9318. /** @hidden */
  9319. export var bonesDeclaration: {
  9320. name: string;
  9321. shader: string;
  9322. };
  9323. }
  9324. declare module "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration" {
  9325. /** @hidden */
  9326. export var morphTargetsVertexGlobalDeclaration: {
  9327. name: string;
  9328. shader: string;
  9329. };
  9330. }
  9331. declare module "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration" {
  9332. /** @hidden */
  9333. export var morphTargetsVertexDeclaration: {
  9334. name: string;
  9335. shader: string;
  9336. };
  9337. }
  9338. declare module "babylonjs/Shaders/ShadersInclude/instancesDeclaration" {
  9339. /** @hidden */
  9340. export var instancesDeclaration: {
  9341. name: string;
  9342. shader: string;
  9343. };
  9344. }
  9345. declare module "babylonjs/Shaders/ShadersInclude/helperFunctions" {
  9346. /** @hidden */
  9347. export var helperFunctions: {
  9348. name: string;
  9349. shader: string;
  9350. };
  9351. }
  9352. declare module "babylonjs/Shaders/ShadersInclude/shadowMapVertexDeclaration" {
  9353. /** @hidden */
  9354. export var shadowMapVertexDeclaration: {
  9355. name: string;
  9356. shader: string;
  9357. };
  9358. }
  9359. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration" {
  9360. /** @hidden */
  9361. export var clipPlaneVertexDeclaration: {
  9362. name: string;
  9363. shader: string;
  9364. };
  9365. }
  9366. declare module "babylonjs/Shaders/ShadersInclude/morphTargetsVertex" {
  9367. /** @hidden */
  9368. export var morphTargetsVertex: {
  9369. name: string;
  9370. shader: string;
  9371. };
  9372. }
  9373. declare module "babylonjs/Shaders/ShadersInclude/instancesVertex" {
  9374. /** @hidden */
  9375. export var instancesVertex: {
  9376. name: string;
  9377. shader: string;
  9378. };
  9379. }
  9380. declare module "babylonjs/Shaders/ShadersInclude/bonesVertex" {
  9381. /** @hidden */
  9382. export var bonesVertex: {
  9383. name: string;
  9384. shader: string;
  9385. };
  9386. }
  9387. declare module "babylonjs/Shaders/ShadersInclude/shadowMapVertexNormalBias" {
  9388. /** @hidden */
  9389. export var shadowMapVertexNormalBias: {
  9390. name: string;
  9391. shader: string;
  9392. };
  9393. }
  9394. declare module "babylonjs/Shaders/ShadersInclude/shadowMapVertexMetric" {
  9395. /** @hidden */
  9396. export var shadowMapVertexMetric: {
  9397. name: string;
  9398. shader: string;
  9399. };
  9400. }
  9401. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneVertex" {
  9402. /** @hidden */
  9403. export var clipPlaneVertex: {
  9404. name: string;
  9405. shader: string;
  9406. };
  9407. }
  9408. declare module "babylonjs/Shaders/shadowMap.vertex" {
  9409. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  9410. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  9411. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  9412. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  9413. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  9414. import "babylonjs/Shaders/ShadersInclude/shadowMapVertexDeclaration";
  9415. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  9416. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  9417. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  9418. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  9419. import "babylonjs/Shaders/ShadersInclude/shadowMapVertexNormalBias";
  9420. import "babylonjs/Shaders/ShadersInclude/shadowMapVertexMetric";
  9421. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  9422. /** @hidden */
  9423. export var shadowMapVertexShader: {
  9424. name: string;
  9425. shader: string;
  9426. };
  9427. }
  9428. declare module "babylonjs/Shaders/depthBoxBlur.fragment" {
  9429. /** @hidden */
  9430. export var depthBoxBlurPixelShader: {
  9431. name: string;
  9432. shader: string;
  9433. };
  9434. }
  9435. declare module "babylonjs/Shaders/ShadersInclude/shadowMapFragmentSoftTransparentShadow" {
  9436. /** @hidden */
  9437. export var shadowMapFragmentSoftTransparentShadow: {
  9438. name: string;
  9439. shader: string;
  9440. };
  9441. }
  9442. declare module "babylonjs/Materials/effectFallbacks" {
  9443. import { IEffectFallbacks } from "babylonjs/Materials/iEffectFallbacks";
  9444. import { Effect } from "babylonjs/Materials/effect";
  9445. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  9446. /**
  9447. * EffectFallbacks can be used to add fallbacks (properties to disable) to certain properties when desired to improve performance.
  9448. * (Eg. Start at high quality with reflection and fog, if fps is low, remove reflection, if still low remove fog)
  9449. */
  9450. export class EffectFallbacks implements IEffectFallbacks {
  9451. private _defines;
  9452. private _currentRank;
  9453. private _maxRank;
  9454. private _mesh;
  9455. /**
  9456. * Removes the fallback from the bound mesh.
  9457. */
  9458. unBindMesh(): void;
  9459. /**
  9460. * Adds a fallback on the specified property.
  9461. * @param rank The rank of the fallback (Lower ranks will be fallbacked to first)
  9462. * @param define The name of the define in the shader
  9463. */
  9464. addFallback(rank: number, define: string): void;
  9465. /**
  9466. * Sets the mesh to use CPU skinning when needing to fallback.
  9467. * @param rank The rank of the fallback (Lower ranks will be fallbacked to first)
  9468. * @param mesh The mesh to use the fallbacks.
  9469. */
  9470. addCPUSkinningFallback(rank: number, mesh: AbstractMesh): void;
  9471. /**
  9472. * Checks to see if more fallbacks are still availible.
  9473. */
  9474. get hasMoreFallbacks(): boolean;
  9475. /**
  9476. * Removes the defines that should be removed when falling back.
  9477. * @param currentDefines defines the current define statements for the shader.
  9478. * @param effect defines the current effect we try to compile
  9479. * @returns The resulting defines with defines of the current rank removed.
  9480. */
  9481. reduce(currentDefines: string, effect: Effect): string;
  9482. }
  9483. }
  9484. declare module "babylonjs/Actions/action" {
  9485. import { Observable } from "babylonjs/Misc/observable";
  9486. import { Condition } from "babylonjs/Actions/condition";
  9487. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  9488. import { Scene } from "babylonjs/scene";
  9489. import { ActionManager } from "babylonjs/Actions/actionManager";
  9490. import { ActionEvent } from "babylonjs/Actions/actionEvent";
  9491. import { Node } from "babylonjs/node";
  9492. /**
  9493. * Interface used to define Action
  9494. */
  9495. export interface IAction {
  9496. /**
  9497. * Trigger for the action
  9498. */
  9499. trigger: number;
  9500. /** Options of the trigger */
  9501. triggerOptions: any;
  9502. /**
  9503. * Gets the trigger parameters
  9504. * @returns the trigger parameters
  9505. */
  9506. getTriggerParameter(): any;
  9507. /**
  9508. * Internal only - executes current action event
  9509. * @hidden
  9510. */
  9511. _executeCurrent(evt?: ActionEvent): void;
  9512. /**
  9513. * Serialize placeholder for child classes
  9514. * @param parent of child
  9515. * @returns the serialized object
  9516. */
  9517. serialize(parent: any): any;
  9518. /**
  9519. * Internal only
  9520. * @hidden
  9521. */
  9522. _prepare(): void;
  9523. /**
  9524. * Internal only - manager for action
  9525. * @hidden
  9526. */
  9527. _actionManager: AbstractActionManager;
  9528. /**
  9529. * Adds action to chain of actions, may be a DoNothingAction
  9530. * @param action defines the next action to execute
  9531. * @returns The action passed in
  9532. * @see https://www.babylonjs-playground.com/#1T30HR#0
  9533. */
  9534. then(action: IAction): IAction;
  9535. }
  9536. /**
  9537. * The action to be carried out following a trigger
  9538. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#available-actions
  9539. */
  9540. export class Action implements IAction {
  9541. /** the trigger, with or without parameters, for the action */
  9542. triggerOptions: any;
  9543. /**
  9544. * Trigger for the action
  9545. */
  9546. trigger: number;
  9547. /**
  9548. * Internal only - manager for action
  9549. * @hidden
  9550. */
  9551. _actionManager: ActionManager;
  9552. private _nextActiveAction;
  9553. private _child;
  9554. private _condition?;
  9555. private _triggerParameter;
  9556. /**
  9557. * An event triggered prior to action being executed.
  9558. */
  9559. onBeforeExecuteObservable: Observable<Action>;
  9560. /**
  9561. * Creates a new Action
  9562. * @param triggerOptions the trigger, with or without parameters, for the action
  9563. * @param condition an optional determinant of action
  9564. */
  9565. constructor(
  9566. /** the trigger, with or without parameters, for the action */
  9567. triggerOptions: any, condition?: Condition);
  9568. /**
  9569. * Internal only
  9570. * @hidden
  9571. */
  9572. _prepare(): void;
  9573. /**
  9574. * Gets the trigger parameters
  9575. * @returns the trigger parameters
  9576. */
  9577. getTriggerParameter(): any;
  9578. /**
  9579. * Internal only - executes current action event
  9580. * @hidden
  9581. */
  9582. _executeCurrent(evt?: ActionEvent): void;
  9583. /**
  9584. * Execute placeholder for child classes
  9585. * @param evt optional action event
  9586. */
  9587. execute(evt?: ActionEvent): void;
  9588. /**
  9589. * Skips to next active action
  9590. */
  9591. skipToNextActiveAction(): void;
  9592. /**
  9593. * Adds action to chain of actions, may be a DoNothingAction
  9594. * @param action defines the next action to execute
  9595. * @returns The action passed in
  9596. * @see https://www.babylonjs-playground.com/#1T30HR#0
  9597. */
  9598. then(action: Action): Action;
  9599. /**
  9600. * Internal only
  9601. * @hidden
  9602. */
  9603. _getProperty(propertyPath: string): string;
  9604. /**
  9605. * Internal only
  9606. * @hidden
  9607. */
  9608. _getEffectiveTarget(target: any, propertyPath: string): any;
  9609. /**
  9610. * Serialize placeholder for child classes
  9611. * @param parent of child
  9612. * @returns the serialized object
  9613. */
  9614. serialize(parent: any): any;
  9615. /**
  9616. * Internal only called by serialize
  9617. * @hidden
  9618. */
  9619. protected _serialize(serializedAction: any, parent?: any): any;
  9620. /**
  9621. * Internal only
  9622. * @hidden
  9623. */
  9624. static _SerializeValueAsString: (value: any) => string;
  9625. /**
  9626. * Internal only
  9627. * @hidden
  9628. */
  9629. static _GetTargetProperty: (target: Scene | Node) => {
  9630. name: string;
  9631. targetType: string;
  9632. value: string;
  9633. };
  9634. }
  9635. }
  9636. declare module "babylonjs/Actions/condition" {
  9637. import { ActionManager } from "babylonjs/Actions/actionManager";
  9638. /**
  9639. * A Condition applied to an Action
  9640. */
  9641. export class Condition {
  9642. /**
  9643. * Internal only - manager for action
  9644. * @hidden
  9645. */
  9646. _actionManager: ActionManager;
  9647. /**
  9648. * Internal only
  9649. * @hidden
  9650. */
  9651. _evaluationId: number;
  9652. /**
  9653. * Internal only
  9654. * @hidden
  9655. */
  9656. _currentResult: boolean;
  9657. /**
  9658. * Creates a new Condition
  9659. * @param actionManager the manager of the action the condition is applied to
  9660. */
  9661. constructor(actionManager: ActionManager);
  9662. /**
  9663. * Check if the current condition is valid
  9664. * @returns a boolean
  9665. */
  9666. isValid(): boolean;
  9667. /**
  9668. * Internal only
  9669. * @hidden
  9670. */
  9671. _getProperty(propertyPath: string): string;
  9672. /**
  9673. * Internal only
  9674. * @hidden
  9675. */
  9676. _getEffectiveTarget(target: any, propertyPath: string): any;
  9677. /**
  9678. * Serialize placeholder for child classes
  9679. * @returns the serialized object
  9680. */
  9681. serialize(): any;
  9682. /**
  9683. * Internal only
  9684. * @hidden
  9685. */
  9686. protected _serialize(serializedCondition: any): any;
  9687. }
  9688. /**
  9689. * Defines specific conditional operators as extensions of Condition
  9690. */
  9691. export class ValueCondition extends Condition {
  9692. /** path to specify the property of the target the conditional operator uses */
  9693. propertyPath: string;
  9694. /** the value compared by the conditional operator against the current value of the property */
  9695. value: any;
  9696. /** the conditional operator, default ValueCondition.IsEqual */
  9697. operator: number;
  9698. /**
  9699. * Internal only
  9700. * @hidden
  9701. */
  9702. private static _IsEqual;
  9703. /**
  9704. * Internal only
  9705. * @hidden
  9706. */
  9707. private static _IsDifferent;
  9708. /**
  9709. * Internal only
  9710. * @hidden
  9711. */
  9712. private static _IsGreater;
  9713. /**
  9714. * Internal only
  9715. * @hidden
  9716. */
  9717. private static _IsLesser;
  9718. /**
  9719. * returns the number for IsEqual
  9720. */
  9721. static get IsEqual(): number;
  9722. /**
  9723. * Returns the number for IsDifferent
  9724. */
  9725. static get IsDifferent(): number;
  9726. /**
  9727. * Returns the number for IsGreater
  9728. */
  9729. static get IsGreater(): number;
  9730. /**
  9731. * Returns the number for IsLesser
  9732. */
  9733. static get IsLesser(): number;
  9734. /**
  9735. * Internal only The action manager for the condition
  9736. * @hidden
  9737. */
  9738. _actionManager: ActionManager;
  9739. /**
  9740. * Internal only
  9741. * @hidden
  9742. */
  9743. private _target;
  9744. /**
  9745. * Internal only
  9746. * @hidden
  9747. */
  9748. private _effectiveTarget;
  9749. /**
  9750. * Internal only
  9751. * @hidden
  9752. */
  9753. private _property;
  9754. /**
  9755. * Creates a new ValueCondition
  9756. * @param actionManager manager for the action the condition applies to
  9757. * @param target for the action
  9758. * @param propertyPath path to specify the property of the target the conditional operator uses
  9759. * @param value the value compared by the conditional operator against the current value of the property
  9760. * @param operator the conditional operator, default ValueCondition.IsEqual
  9761. */
  9762. constructor(actionManager: ActionManager, target: any,
  9763. /** path to specify the property of the target the conditional operator uses */
  9764. propertyPath: string,
  9765. /** the value compared by the conditional operator against the current value of the property */
  9766. value: any,
  9767. /** the conditional operator, default ValueCondition.IsEqual */
  9768. operator?: number);
  9769. /**
  9770. * Compares the given value with the property value for the specified conditional operator
  9771. * @returns the result of the comparison
  9772. */
  9773. isValid(): boolean;
  9774. /**
  9775. * Serialize the ValueCondition into a JSON compatible object
  9776. * @returns serialization object
  9777. */
  9778. serialize(): any;
  9779. /**
  9780. * Gets the name of the conditional operator for the ValueCondition
  9781. * @param operator the conditional operator
  9782. * @returns the name
  9783. */
  9784. static GetOperatorName(operator: number): string;
  9785. }
  9786. /**
  9787. * Defines a predicate condition as an extension of Condition
  9788. */
  9789. export class PredicateCondition extends Condition {
  9790. /** defines the predicate function used to validate the condition */
  9791. predicate: () => boolean;
  9792. /**
  9793. * Internal only - manager for action
  9794. * @hidden
  9795. */
  9796. _actionManager: ActionManager;
  9797. /**
  9798. * Creates a new PredicateCondition
  9799. * @param actionManager manager for the action the condition applies to
  9800. * @param predicate defines the predicate function used to validate the condition
  9801. */
  9802. constructor(actionManager: ActionManager,
  9803. /** defines the predicate function used to validate the condition */
  9804. predicate: () => boolean);
  9805. /**
  9806. * @returns the validity of the predicate condition
  9807. */
  9808. isValid(): boolean;
  9809. }
  9810. /**
  9811. * Defines a state condition as an extension of Condition
  9812. */
  9813. export class StateCondition extends Condition {
  9814. /** Value to compare with target state */
  9815. value: string;
  9816. /**
  9817. * Internal only - manager for action
  9818. * @hidden
  9819. */
  9820. _actionManager: ActionManager;
  9821. /**
  9822. * Internal only
  9823. * @hidden
  9824. */
  9825. private _target;
  9826. /**
  9827. * Creates a new StateCondition
  9828. * @param actionManager manager for the action the condition applies to
  9829. * @param target of the condition
  9830. * @param value to compare with target state
  9831. */
  9832. constructor(actionManager: ActionManager, target: any,
  9833. /** Value to compare with target state */
  9834. value: string);
  9835. /**
  9836. * Gets a boolean indicating if the current condition is met
  9837. * @returns the validity of the state
  9838. */
  9839. isValid(): boolean;
  9840. /**
  9841. * Serialize the StateCondition into a JSON compatible object
  9842. * @returns serialization object
  9843. */
  9844. serialize(): any;
  9845. }
  9846. }
  9847. declare module "babylonjs/Actions/directActions" {
  9848. import { Action } from "babylonjs/Actions/action";
  9849. import { Condition } from "babylonjs/Actions/condition";
  9850. import { ActionEvent } from "babylonjs/Actions/actionEvent";
  9851. /**
  9852. * This defines an action responsible to toggle a boolean once triggered.
  9853. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  9854. */
  9855. export class SwitchBooleanAction extends Action {
  9856. /**
  9857. * The path to the boolean property in the target object
  9858. */
  9859. propertyPath: string;
  9860. private _target;
  9861. private _effectiveTarget;
  9862. private _property;
  9863. /**
  9864. * Instantiate the action
  9865. * @param triggerOptions defines the trigger options
  9866. * @param target defines the object containing the boolean
  9867. * @param propertyPath defines the path to the boolean property in the target object
  9868. * @param condition defines the trigger related conditions
  9869. */
  9870. constructor(triggerOptions: any, target: any, propertyPath: string, condition?: Condition);
  9871. /** @hidden */
  9872. _prepare(): void;
  9873. /**
  9874. * Execute the action toggle the boolean value.
  9875. */
  9876. execute(): void;
  9877. /**
  9878. * Serializes the actions and its related information.
  9879. * @param parent defines the object to serialize in
  9880. * @returns the serialized object
  9881. */
  9882. serialize(parent: any): any;
  9883. }
  9884. /**
  9885. * This defines an action responsible to set a the state field of the target
  9886. * to a desired value once triggered.
  9887. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  9888. */
  9889. export class SetStateAction extends Action {
  9890. /**
  9891. * The value to store in the state field.
  9892. */
  9893. value: string;
  9894. private _target;
  9895. /**
  9896. * Instantiate the action
  9897. * @param triggerOptions defines the trigger options
  9898. * @param target defines the object containing the state property
  9899. * @param value defines the value to store in the state field
  9900. * @param condition defines the trigger related conditions
  9901. */
  9902. constructor(triggerOptions: any, target: any, value: string, condition?: Condition);
  9903. /**
  9904. * Execute the action and store the value on the target state property.
  9905. */
  9906. execute(): void;
  9907. /**
  9908. * Serializes the actions and its related information.
  9909. * @param parent defines the object to serialize in
  9910. * @returns the serialized object
  9911. */
  9912. serialize(parent: any): any;
  9913. }
  9914. /**
  9915. * This defines an action responsible to set a property of the target
  9916. * to a desired value once triggered.
  9917. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  9918. */
  9919. export class SetValueAction extends Action {
  9920. /**
  9921. * The path of the property to set in the target.
  9922. */
  9923. propertyPath: string;
  9924. /**
  9925. * The value to set in the property
  9926. */
  9927. value: any;
  9928. private _target;
  9929. private _effectiveTarget;
  9930. private _property;
  9931. /**
  9932. * Instantiate the action
  9933. * @param triggerOptions defines the trigger options
  9934. * @param target defines the object containing the property
  9935. * @param propertyPath defines the path of the property to set in the target
  9936. * @param value defines the value to set in the property
  9937. * @param condition defines the trigger related conditions
  9938. */
  9939. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, condition?: Condition);
  9940. /** @hidden */
  9941. _prepare(): void;
  9942. /**
  9943. * Execute the action and set the targetted property to the desired value.
  9944. */
  9945. execute(): void;
  9946. /**
  9947. * Serializes the actions and its related information.
  9948. * @param parent defines the object to serialize in
  9949. * @returns the serialized object
  9950. */
  9951. serialize(parent: any): any;
  9952. }
  9953. /**
  9954. * This defines an action responsible to increment the target value
  9955. * to a desired value once triggered.
  9956. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  9957. */
  9958. export class IncrementValueAction extends Action {
  9959. /**
  9960. * The path of the property to increment in the target.
  9961. */
  9962. propertyPath: string;
  9963. /**
  9964. * The value we should increment the property by.
  9965. */
  9966. value: any;
  9967. private _target;
  9968. private _effectiveTarget;
  9969. private _property;
  9970. /**
  9971. * Instantiate the action
  9972. * @param triggerOptions defines the trigger options
  9973. * @param target defines the object containing the property
  9974. * @param propertyPath defines the path of the property to increment in the target
  9975. * @param value defines the value value we should increment the property by
  9976. * @param condition defines the trigger related conditions
  9977. */
  9978. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, condition?: Condition);
  9979. /** @hidden */
  9980. _prepare(): void;
  9981. /**
  9982. * Execute the action and increment the target of the value amount.
  9983. */
  9984. execute(): void;
  9985. /**
  9986. * Serializes the actions and its related information.
  9987. * @param parent defines the object to serialize in
  9988. * @returns the serialized object
  9989. */
  9990. serialize(parent: any): any;
  9991. }
  9992. /**
  9993. * This defines an action responsible to start an animation once triggered.
  9994. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  9995. */
  9996. export class PlayAnimationAction extends Action {
  9997. /**
  9998. * Where the animation should start (animation frame)
  9999. */
  10000. from: number;
  10001. /**
  10002. * Where the animation should stop (animation frame)
  10003. */
  10004. to: number;
  10005. /**
  10006. * Define if the animation should loop or stop after the first play.
  10007. */
  10008. loop?: boolean;
  10009. private _target;
  10010. /**
  10011. * Instantiate the action
  10012. * @param triggerOptions defines the trigger options
  10013. * @param target defines the target animation or animation name
  10014. * @param from defines from where the animation should start (animation frame)
  10015. * @param end defines where the animation should stop (animation frame)
  10016. * @param loop defines if the animation should loop or stop after the first play
  10017. * @param condition defines the trigger related conditions
  10018. */
  10019. constructor(triggerOptions: any, target: any, from: number, to: number, loop?: boolean, condition?: Condition);
  10020. /** @hidden */
  10021. _prepare(): void;
  10022. /**
  10023. * Execute the action and play the animation.
  10024. */
  10025. execute(): void;
  10026. /**
  10027. * Serializes the actions and its related information.
  10028. * @param parent defines the object to serialize in
  10029. * @returns the serialized object
  10030. */
  10031. serialize(parent: any): any;
  10032. }
  10033. /**
  10034. * This defines an action responsible to stop an animation once triggered.
  10035. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10036. */
  10037. export class StopAnimationAction extends Action {
  10038. private _target;
  10039. /**
  10040. * Instantiate the action
  10041. * @param triggerOptions defines the trigger options
  10042. * @param target defines the target animation or animation name
  10043. * @param condition defines the trigger related conditions
  10044. */
  10045. constructor(triggerOptions: any, target: any, condition?: Condition);
  10046. /** @hidden */
  10047. _prepare(): void;
  10048. /**
  10049. * Execute the action and stop the animation.
  10050. */
  10051. execute(): void;
  10052. /**
  10053. * Serializes the actions and its related information.
  10054. * @param parent defines the object to serialize in
  10055. * @returns the serialized object
  10056. */
  10057. serialize(parent: any): any;
  10058. }
  10059. /**
  10060. * This defines an action responsible that does nothing once triggered.
  10061. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10062. */
  10063. export class DoNothingAction extends Action {
  10064. /**
  10065. * Instantiate the action
  10066. * @param triggerOptions defines the trigger options
  10067. * @param condition defines the trigger related conditions
  10068. */
  10069. constructor(triggerOptions?: any, condition?: Condition);
  10070. /**
  10071. * Execute the action and do nothing.
  10072. */
  10073. execute(): void;
  10074. /**
  10075. * Serializes the actions and its related information.
  10076. * @param parent defines the object to serialize in
  10077. * @returns the serialized object
  10078. */
  10079. serialize(parent: any): any;
  10080. }
  10081. /**
  10082. * This defines an action responsible to trigger several actions once triggered.
  10083. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10084. */
  10085. export class CombineAction extends Action {
  10086. /**
  10087. * The list of aggregated animations to run.
  10088. */
  10089. children: Action[];
  10090. /**
  10091. * Instantiate the action
  10092. * @param triggerOptions defines the trigger options
  10093. * @param children defines the list of aggregated animations to run
  10094. * @param condition defines the trigger related conditions
  10095. */
  10096. constructor(triggerOptions: any, children: Action[], condition?: Condition);
  10097. /** @hidden */
  10098. _prepare(): void;
  10099. /**
  10100. * Execute the action and executes all the aggregated actions.
  10101. */
  10102. execute(evt: ActionEvent): void;
  10103. /**
  10104. * Serializes the actions and its related information.
  10105. * @param parent defines the object to serialize in
  10106. * @returns the serialized object
  10107. */
  10108. serialize(parent: any): any;
  10109. }
  10110. /**
  10111. * This defines an action responsible to run code (external event) once triggered.
  10112. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10113. */
  10114. export class ExecuteCodeAction extends Action {
  10115. /**
  10116. * The callback function to run.
  10117. */
  10118. func: (evt: ActionEvent) => void;
  10119. /**
  10120. * Instantiate the action
  10121. * @param triggerOptions defines the trigger options
  10122. * @param func defines the callback function to run
  10123. * @param condition defines the trigger related conditions
  10124. */
  10125. constructor(triggerOptions: any, func: (evt: ActionEvent) => void, condition?: Condition);
  10126. /**
  10127. * Execute the action and run the attached code.
  10128. */
  10129. execute(evt: ActionEvent): void;
  10130. }
  10131. /**
  10132. * This defines an action responsible to set the parent property of the target once triggered.
  10133. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10134. */
  10135. export class SetParentAction extends Action {
  10136. private _parent;
  10137. private _target;
  10138. /**
  10139. * Instantiate the action
  10140. * @param triggerOptions defines the trigger options
  10141. * @param target defines the target containing the parent property
  10142. * @param parent defines from where the animation should start (animation frame)
  10143. * @param condition defines the trigger related conditions
  10144. */
  10145. constructor(triggerOptions: any, target: any, parent: any, condition?: Condition);
  10146. /** @hidden */
  10147. _prepare(): void;
  10148. /**
  10149. * Execute the action and set the parent property.
  10150. */
  10151. execute(): void;
  10152. /**
  10153. * Serializes the actions and its related information.
  10154. * @param parent defines the object to serialize in
  10155. * @returns the serialized object
  10156. */
  10157. serialize(parent: any): any;
  10158. }
  10159. }
  10160. declare module "babylonjs/Actions/actionManager" {
  10161. import { Nullable } from "babylonjs/types";
  10162. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  10163. import { Scene } from "babylonjs/scene";
  10164. import { IAction } from "babylonjs/Actions/action";
  10165. import { IActionEvent } from "babylonjs/Actions/actionEvent";
  10166. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  10167. /**
  10168. * Action Manager manages all events to be triggered on a given mesh or the global scene.
  10169. * A single scene can have many Action Managers to handle predefined actions on specific meshes.
  10170. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10171. */
  10172. export class ActionManager extends AbstractActionManager {
  10173. /**
  10174. * Nothing
  10175. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10176. */
  10177. static readonly NothingTrigger: number;
  10178. /**
  10179. * On pick
  10180. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10181. */
  10182. static readonly OnPickTrigger: number;
  10183. /**
  10184. * On left pick
  10185. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10186. */
  10187. static readonly OnLeftPickTrigger: number;
  10188. /**
  10189. * On right pick
  10190. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10191. */
  10192. static readonly OnRightPickTrigger: number;
  10193. /**
  10194. * On center pick
  10195. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10196. */
  10197. static readonly OnCenterPickTrigger: number;
  10198. /**
  10199. * On pick down
  10200. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10201. */
  10202. static readonly OnPickDownTrigger: number;
  10203. /**
  10204. * On double pick
  10205. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10206. */
  10207. static readonly OnDoublePickTrigger: number;
  10208. /**
  10209. * On pick up
  10210. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10211. */
  10212. static readonly OnPickUpTrigger: number;
  10213. /**
  10214. * On pick out.
  10215. * This trigger will only be raised if you also declared a OnPickDown
  10216. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10217. */
  10218. static readonly OnPickOutTrigger: number;
  10219. /**
  10220. * On long press
  10221. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10222. */
  10223. static readonly OnLongPressTrigger: number;
  10224. /**
  10225. * On pointer over
  10226. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10227. */
  10228. static readonly OnPointerOverTrigger: number;
  10229. /**
  10230. * On pointer out
  10231. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10232. */
  10233. static readonly OnPointerOutTrigger: number;
  10234. /**
  10235. * On every frame
  10236. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10237. */
  10238. static readonly OnEveryFrameTrigger: number;
  10239. /**
  10240. * On intersection enter
  10241. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10242. */
  10243. static readonly OnIntersectionEnterTrigger: number;
  10244. /**
  10245. * On intersection exit
  10246. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10247. */
  10248. static readonly OnIntersectionExitTrigger: number;
  10249. /**
  10250. * On key down
  10251. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10252. */
  10253. static readonly OnKeyDownTrigger: number;
  10254. /**
  10255. * On key up
  10256. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10257. */
  10258. static readonly OnKeyUpTrigger: number;
  10259. private _scene;
  10260. /**
  10261. * Creates a new action manager
  10262. * @param scene defines the hosting scene
  10263. */
  10264. constructor(scene: Scene);
  10265. /**
  10266. * Releases all associated resources
  10267. */
  10268. dispose(): void;
  10269. /**
  10270. * Gets hosting scene
  10271. * @returns the hosting scene
  10272. */
  10273. getScene(): Scene;
  10274. /**
  10275. * Does this action manager handles actions of any of the given triggers
  10276. * @param triggers defines the triggers to be tested
  10277. * @return a boolean indicating whether one (or more) of the triggers is handled
  10278. */
  10279. hasSpecificTriggers(triggers: number[]): boolean;
  10280. /**
  10281. * Does this action manager handles actions of any of the given triggers. This function takes two arguments for
  10282. * speed.
  10283. * @param triggerA defines the trigger to be tested
  10284. * @param triggerB defines the trigger to be tested
  10285. * @return a boolean indicating whether one (or more) of the triggers is handled
  10286. */
  10287. hasSpecificTriggers2(triggerA: number, triggerB: number): boolean;
  10288. /**
  10289. * Does this action manager handles actions of a given trigger
  10290. * @param trigger defines the trigger to be tested
  10291. * @param parameterPredicate defines an optional predicate to filter triggers by parameter
  10292. * @return whether the trigger is handled
  10293. */
  10294. hasSpecificTrigger(trigger: number, parameterPredicate?: (parameter: any) => boolean): boolean;
  10295. /**
  10296. * Does this action manager has pointer triggers
  10297. */
  10298. get hasPointerTriggers(): boolean;
  10299. /**
  10300. * Does this action manager has pick triggers
  10301. */
  10302. get hasPickTriggers(): boolean;
  10303. /**
  10304. * Registers an action to this action manager
  10305. * @param action defines the action to be registered
  10306. * @return the action amended (prepared) after registration
  10307. */
  10308. registerAction(action: IAction): Nullable<IAction>;
  10309. /**
  10310. * Unregisters an action to this action manager
  10311. * @param action defines the action to be unregistered
  10312. * @return a boolean indicating whether the action has been unregistered
  10313. */
  10314. unregisterAction(action: IAction): Boolean;
  10315. /**
  10316. * Process a specific trigger
  10317. * @param trigger defines the trigger to process
  10318. * @param evt defines the event details to be processed
  10319. */
  10320. processTrigger(trigger: number, evt?: IActionEvent): void;
  10321. /** @hidden */
  10322. _getEffectiveTarget(target: any, propertyPath: string): any;
  10323. /** @hidden */
  10324. _getProperty(propertyPath: string): string;
  10325. /**
  10326. * Serialize this manager to a JSON object
  10327. * @param name defines the property name to store this manager
  10328. * @returns a JSON representation of this manager
  10329. */
  10330. serialize(name: string): any;
  10331. /**
  10332. * Creates a new ActionManager from a JSON data
  10333. * @param parsedActions defines the JSON data to read from
  10334. * @param object defines the hosting mesh
  10335. * @param scene defines the hosting scene
  10336. */
  10337. static Parse(parsedActions: any, object: Nullable<AbstractMesh>, scene: Scene): void;
  10338. /**
  10339. * Get a trigger name by index
  10340. * @param trigger defines the trigger index
  10341. * @returns a trigger name
  10342. */
  10343. static GetTriggerName(trigger: number): string;
  10344. }
  10345. }
  10346. declare module "babylonjs/Sprites/sprite" {
  10347. import { Vector3 } from "babylonjs/Maths/math.vector";
  10348. import { Nullable } from "babylonjs/types";
  10349. import { ActionManager } from "babylonjs/Actions/actionManager";
  10350. import { ISpriteManager, SpriteManager } from "babylonjs/Sprites/spriteManager";
  10351. import { Color4 } from "babylonjs/Maths/math.color";
  10352. import { Observable } from "babylonjs/Misc/observable";
  10353. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  10354. import { Animation } from "babylonjs/Animations/animation";
  10355. /**
  10356. * Class used to represent a sprite
  10357. * @see https://doc.babylonjs.com/babylon101/sprites
  10358. */
  10359. export class Sprite implements IAnimatable {
  10360. /** defines the name */
  10361. name: string;
  10362. /** Gets or sets the current world position */
  10363. position: Vector3;
  10364. /** Gets or sets the main color */
  10365. color: Color4;
  10366. /** Gets or sets the width */
  10367. width: number;
  10368. /** Gets or sets the height */
  10369. height: number;
  10370. /** Gets or sets rotation angle */
  10371. angle: number;
  10372. /** Gets or sets the cell index in the sprite sheet */
  10373. cellIndex: number;
  10374. /** Gets or sets the cell reference in the sprite sheet, uses sprite's filename when added to sprite sheet */
  10375. cellRef: string;
  10376. /** Gets or sets a boolean indicating if UV coordinates should be inverted in U axis */
  10377. invertU: boolean;
  10378. /** Gets or sets a boolean indicating if UV coordinates should be inverted in B axis */
  10379. invertV: boolean;
  10380. /** Gets or sets a boolean indicating that this sprite should be disposed after animation ends */
  10381. disposeWhenFinishedAnimating: boolean;
  10382. /** Gets the list of attached animations */
  10383. animations: Nullable<Array<Animation>>;
  10384. /** Gets or sets a boolean indicating if the sprite can be picked */
  10385. isPickable: boolean;
  10386. /** Gets or sets a boolean indicating that sprite texture alpha will be used for precise picking (false by default) */
  10387. useAlphaForPicking: boolean;
  10388. /** @hidden */
  10389. _xOffset: number;
  10390. /** @hidden */
  10391. _yOffset: number;
  10392. /** @hidden */
  10393. _xSize: number;
  10394. /** @hidden */
  10395. _ySize: number;
  10396. /**
  10397. * Gets or sets the associated action manager
  10398. */
  10399. actionManager: Nullable<ActionManager>;
  10400. /**
  10401. * An event triggered when the control has been disposed
  10402. */
  10403. onDisposeObservable: Observable<Sprite>;
  10404. private _animationStarted;
  10405. private _loopAnimation;
  10406. private _fromIndex;
  10407. private _toIndex;
  10408. private _delay;
  10409. private _direction;
  10410. private _manager;
  10411. private _time;
  10412. private _onAnimationEnd;
  10413. /**
  10414. * Gets or sets a boolean indicating if the sprite is visible (renderable). Default is true
  10415. */
  10416. isVisible: boolean;
  10417. /**
  10418. * Gets or sets the sprite size
  10419. */
  10420. get size(): number;
  10421. set size(value: number);
  10422. /**
  10423. * Returns a boolean indicating if the animation is started
  10424. */
  10425. get animationStarted(): boolean;
  10426. /**
  10427. * Gets or sets the unique id of the sprite
  10428. */
  10429. uniqueId: number;
  10430. /**
  10431. * Gets the manager of this sprite
  10432. */
  10433. get manager(): ISpriteManager;
  10434. /**
  10435. * Creates a new Sprite
  10436. * @param name defines the name
  10437. * @param manager defines the manager
  10438. */
  10439. constructor(
  10440. /** defines the name */
  10441. name: string, manager: ISpriteManager);
  10442. /**
  10443. * Returns the string "Sprite"
  10444. * @returns "Sprite"
  10445. */
  10446. getClassName(): string;
  10447. /** Gets or sets the initial key for the animation (setting it will restart the animation) */
  10448. get fromIndex(): number;
  10449. set fromIndex(value: number);
  10450. /** Gets or sets the end key for the animation (setting it will restart the animation) */
  10451. get toIndex(): number;
  10452. set toIndex(value: number);
  10453. /** Gets or sets a boolean indicating if the animation is looping (setting it will restart the animation) */
  10454. get loopAnimation(): boolean;
  10455. set loopAnimation(value: boolean);
  10456. /** Gets or sets the delay between cell changes (setting it will restart the animation) */
  10457. get delay(): number;
  10458. set delay(value: number);
  10459. /**
  10460. * Starts an animation
  10461. * @param from defines the initial key
  10462. * @param to defines the end key
  10463. * @param loop defines if the animation must loop
  10464. * @param delay defines the start delay (in ms)
  10465. * @param onAnimationEnd defines a callback to call when animation ends
  10466. */
  10467. playAnimation(from: number, to: number, loop: boolean, delay: number, onAnimationEnd?: Nullable<() => void>): void;
  10468. /** Stops current animation (if any) */
  10469. stopAnimation(): void;
  10470. /** @hidden */
  10471. _animate(deltaTime: number): void;
  10472. /** Release associated resources */
  10473. dispose(): void;
  10474. /**
  10475. * Serializes the sprite to a JSON object
  10476. * @returns the JSON object
  10477. */
  10478. serialize(): any;
  10479. /**
  10480. * Parses a JSON object to create a new sprite
  10481. * @param parsedSprite The JSON object to parse
  10482. * @param manager defines the hosting manager
  10483. * @returns the new sprite
  10484. */
  10485. static Parse(parsedSprite: any, manager: SpriteManager): Sprite;
  10486. }
  10487. }
  10488. declare module "babylonjs/Collisions/pickingInfo" {
  10489. import { Nullable } from "babylonjs/types";
  10490. import { Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  10491. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  10492. import { Sprite } from "babylonjs/Sprites/sprite";
  10493. import { Ray } from "babylonjs/Culling/ray";
  10494. /**
  10495. * Information about the result of picking within a scene
  10496. * @see https://doc.babylonjs.com/babylon101/picking_collisions
  10497. */
  10498. export class PickingInfo {
  10499. /** @hidden */
  10500. _pickingUnavailable: boolean;
  10501. /**
  10502. * If the pick collided with an object
  10503. */
  10504. hit: boolean;
  10505. /**
  10506. * Distance away where the pick collided
  10507. */
  10508. distance: number;
  10509. /**
  10510. * The location of pick collision
  10511. */
  10512. pickedPoint: Nullable<Vector3>;
  10513. /**
  10514. * The mesh corresponding the the pick collision
  10515. */
  10516. pickedMesh: Nullable<AbstractMesh>;
  10517. /** (See getTextureCoordinates) The barycentric U coordinate that is used when calculating the texture coordinates of the collision.*/
  10518. bu: number;
  10519. /** (See getTextureCoordinates) The barycentric V coordinate that is used when calculating the texture coordinates of the collision.*/
  10520. bv: number;
  10521. /** The index of the face on the mesh that was picked, or the index of the Line if the picked Mesh is a LinesMesh */
  10522. faceId: number;
  10523. /** The index of the face on the subMesh that was picked, or the index of the Line if the picked Mesh is a LinesMesh */
  10524. subMeshFaceId: number;
  10525. /** Id of the the submesh that was picked */
  10526. subMeshId: number;
  10527. /** If a sprite was picked, this will be the sprite the pick collided with */
  10528. pickedSprite: Nullable<Sprite>;
  10529. /**
  10530. * If a mesh was used to do the picking (eg. 6dof controller) this will be populated.
  10531. */
  10532. originMesh: Nullable<AbstractMesh>;
  10533. /**
  10534. * The ray that was used to perform the picking.
  10535. */
  10536. ray: Nullable<Ray>;
  10537. /**
  10538. * Gets the normal correspodning to the face the pick collided with
  10539. * @param useWorldCoordinates If the resulting normal should be relative to the world (default: false)
  10540. * @param useVerticesNormals If the vertices normals should be used to calculate the normal instead of the normal map
  10541. * @returns The normal correspodning to the face the pick collided with
  10542. */
  10543. getNormal(useWorldCoordinates?: boolean, useVerticesNormals?: boolean): Nullable<Vector3>;
  10544. /**
  10545. * Gets the texture coordinates of where the pick occured
  10546. * @returns the vector containing the coordnates of the texture
  10547. */
  10548. getTextureCoordinates(): Nullable<Vector2>;
  10549. }
  10550. }
  10551. declare module "babylonjs/Culling/ray" {
  10552. import { DeepImmutable, Nullable, float } from "babylonjs/types";
  10553. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  10554. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  10555. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  10556. import { IntersectionInfo } from "babylonjs/Collisions/intersectionInfo";
  10557. import { BoundingBox } from "babylonjs/Culling/boundingBox";
  10558. import { BoundingSphere } from "babylonjs/Culling/boundingSphere";
  10559. import { Plane } from "babylonjs/Maths/math.plane";
  10560. /**
  10561. * Class representing a ray with position and direction
  10562. */
  10563. export class Ray {
  10564. /** origin point */
  10565. origin: Vector3;
  10566. /** direction */
  10567. direction: Vector3;
  10568. /** length of the ray */
  10569. length: number;
  10570. private static readonly TmpVector3;
  10571. private _tmpRay;
  10572. /**
  10573. * Creates a new ray
  10574. * @param origin origin point
  10575. * @param direction direction
  10576. * @param length length of the ray
  10577. */
  10578. constructor(
  10579. /** origin point */
  10580. origin: Vector3,
  10581. /** direction */
  10582. direction: Vector3,
  10583. /** length of the ray */
  10584. length?: number);
  10585. /**
  10586. * Checks if the ray intersects a box
  10587. * This does not account for the ray lenght by design to improve perfs.
  10588. * @param minimum bound of the box
  10589. * @param maximum bound of the box
  10590. * @param intersectionTreshold extra extend to be added to the box in all direction
  10591. * @returns if the box was hit
  10592. */
  10593. intersectsBoxMinMax(minimum: DeepImmutable<Vector3>, maximum: DeepImmutable<Vector3>, intersectionTreshold?: number): boolean;
  10594. /**
  10595. * Checks if the ray intersects a box
  10596. * This does not account for the ray lenght by design to improve perfs.
  10597. * @param box the bounding box to check
  10598. * @param intersectionTreshold extra extend to be added to the BoundingBox in all direction
  10599. * @returns if the box was hit
  10600. */
  10601. intersectsBox(box: DeepImmutable<BoundingBox>, intersectionTreshold?: number): boolean;
  10602. /**
  10603. * If the ray hits a sphere
  10604. * @param sphere the bounding sphere to check
  10605. * @param intersectionTreshold extra extend to be added to the BoundingSphere in all direction
  10606. * @returns true if it hits the sphere
  10607. */
  10608. intersectsSphere(sphere: DeepImmutable<BoundingSphere>, intersectionTreshold?: number): boolean;
  10609. /**
  10610. * If the ray hits a triange
  10611. * @param vertex0 triangle vertex
  10612. * @param vertex1 triangle vertex
  10613. * @param vertex2 triangle vertex
  10614. * @returns intersection information if hit
  10615. */
  10616. intersectsTriangle(vertex0: DeepImmutable<Vector3>, vertex1: DeepImmutable<Vector3>, vertex2: DeepImmutable<Vector3>): Nullable<IntersectionInfo>;
  10617. /**
  10618. * Checks if ray intersects a plane
  10619. * @param plane the plane to check
  10620. * @returns the distance away it was hit
  10621. */
  10622. intersectsPlane(plane: DeepImmutable<Plane>): Nullable<number>;
  10623. /**
  10624. * Calculate the intercept of a ray on a given axis
  10625. * @param axis to check 'x' | 'y' | 'z'
  10626. * @param offset from axis interception (i.e. an offset of 1y is intercepted above ground)
  10627. * @returns a vector containing the coordinates where 'axis' is equal to zero (else offset), or null if there is no intercept.
  10628. */
  10629. intersectsAxis(axis: string, offset?: number): Nullable<Vector3>;
  10630. /**
  10631. * Checks if ray intersects a mesh
  10632. * @param mesh the mesh to check
  10633. * @param fastCheck defines if the first intersection will be used (and not the closest)
  10634. * @returns picking info of the intersecton
  10635. */
  10636. intersectsMesh(mesh: DeepImmutable<AbstractMesh>, fastCheck?: boolean): PickingInfo;
  10637. /**
  10638. * Checks if ray intersects a mesh
  10639. * @param meshes the meshes to check
  10640. * @param fastCheck defines if the first intersection will be used (and not the closest)
  10641. * @param results array to store result in
  10642. * @returns Array of picking infos
  10643. */
  10644. intersectsMeshes(meshes: Array<DeepImmutable<AbstractMesh>>, fastCheck?: boolean, results?: Array<PickingInfo>): Array<PickingInfo>;
  10645. private _comparePickingInfo;
  10646. private static smallnum;
  10647. private static rayl;
  10648. /**
  10649. * Intersection test between the ray and a given segment whithin a given tolerance (threshold)
  10650. * @param sega the first point of the segment to test the intersection against
  10651. * @param segb the second point of the segment to test the intersection against
  10652. * @param threshold the tolerance margin, if the ray doesn't intersect the segment but is close to the given threshold, the intersection is successful
  10653. * @return the distance from the ray origin to the intersection point if there's intersection, or -1 if there's no intersection
  10654. */
  10655. intersectionSegment(sega: DeepImmutable<Vector3>, segb: DeepImmutable<Vector3>, threshold: number): number;
  10656. /**
  10657. * Update the ray from viewport position
  10658. * @param x position
  10659. * @param y y position
  10660. * @param viewportWidth viewport width
  10661. * @param viewportHeight viewport height
  10662. * @param world world matrix
  10663. * @param view view matrix
  10664. * @param projection projection matrix
  10665. * @returns this ray updated
  10666. */
  10667. update(x: number, y: number, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Ray;
  10668. /**
  10669. * Creates a ray with origin and direction of 0,0,0
  10670. * @returns the new ray
  10671. */
  10672. static Zero(): Ray;
  10673. /**
  10674. * Creates a new ray from screen space and viewport
  10675. * @param x position
  10676. * @param y y position
  10677. * @param viewportWidth viewport width
  10678. * @param viewportHeight viewport height
  10679. * @param world world matrix
  10680. * @param view view matrix
  10681. * @param projection projection matrix
  10682. * @returns new ray
  10683. */
  10684. static CreateNew(x: number, y: number, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Ray;
  10685. /**
  10686. * 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
  10687. * transformed to the given world matrix.
  10688. * @param origin The origin point
  10689. * @param end The end point
  10690. * @param world a matrix to transform the ray to. Default is the identity matrix.
  10691. * @returns the new ray
  10692. */
  10693. static CreateNewFromTo(origin: Vector3, end: Vector3, world?: DeepImmutable<Matrix>): Ray;
  10694. /**
  10695. * Transforms a ray by a matrix
  10696. * @param ray ray to transform
  10697. * @param matrix matrix to apply
  10698. * @returns the resulting new ray
  10699. */
  10700. static Transform(ray: DeepImmutable<Ray>, matrix: DeepImmutable<Matrix>): Ray;
  10701. /**
  10702. * Transforms a ray by a matrix
  10703. * @param ray ray to transform
  10704. * @param matrix matrix to apply
  10705. * @param result ray to store result in
  10706. */
  10707. static TransformToRef(ray: DeepImmutable<Ray>, matrix: DeepImmutable<Matrix>, result: Ray): void;
  10708. /**
  10709. * Unproject a ray from screen space to object space
  10710. * @param sourceX defines the screen space x coordinate to use
  10711. * @param sourceY defines the screen space y coordinate to use
  10712. * @param viewportWidth defines the current width of the viewport
  10713. * @param viewportHeight defines the current height of the viewport
  10714. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  10715. * @param view defines the view matrix to use
  10716. * @param projection defines the projection matrix to use
  10717. */
  10718. unprojectRayToRef(sourceX: float, sourceY: float, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): void;
  10719. }
  10720. /**
  10721. * Type used to define predicate used to select faces when a mesh intersection is detected
  10722. */
  10723. export type TrianglePickingPredicate = (p0: Vector3, p1: Vector3, p2: Vector3, ray: Ray) => boolean;
  10724. module "babylonjs/scene" {
  10725. interface Scene {
  10726. /** @hidden */
  10727. _tempPickingRay: Nullable<Ray>;
  10728. /** @hidden */
  10729. _cachedRayForTransform: Ray;
  10730. /** @hidden */
  10731. _pickWithRayInverseMatrix: Matrix;
  10732. /** @hidden */
  10733. _internalPick(rayFunction: (world: Matrix) => Ray, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, onlyBoundingInfo?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  10734. /** @hidden */
  10735. _internalMultiPick(rayFunction: (world: Matrix) => Ray, predicate?: (mesh: AbstractMesh) => boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  10736. }
  10737. }
  10738. }
  10739. declare module "babylonjs/sceneComponent" {
  10740. import { Scene } from "babylonjs/scene";
  10741. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  10742. import { SubMesh } from "babylonjs/Meshes/subMesh";
  10743. import { _InstancesBatch } from "babylonjs/Meshes/mesh";
  10744. import { SmartArrayNoDuplicate } from "babylonjs/Misc/smartArray";
  10745. import { Nullable } from "babylonjs/types";
  10746. import { Camera } from "babylonjs/Cameras/camera";
  10747. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  10748. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  10749. import { AbstractScene } from "babylonjs/abstractScene";
  10750. import { Mesh } from "babylonjs/Meshes/mesh";
  10751. /**
  10752. * Groups all the scene component constants in one place to ease maintenance.
  10753. * @hidden
  10754. */
  10755. export class SceneComponentConstants {
  10756. static readonly NAME_EFFECTLAYER: string;
  10757. static readonly NAME_LAYER: string;
  10758. static readonly NAME_LENSFLARESYSTEM: string;
  10759. static readonly NAME_BOUNDINGBOXRENDERER: string;
  10760. static readonly NAME_PARTICLESYSTEM: string;
  10761. static readonly NAME_GAMEPAD: string;
  10762. static readonly NAME_SIMPLIFICATIONQUEUE: string;
  10763. static readonly NAME_GEOMETRYBUFFERRENDERER: string;
  10764. static readonly NAME_PREPASSRENDERER: string;
  10765. static readonly NAME_DEPTHRENDERER: string;
  10766. static readonly NAME_POSTPROCESSRENDERPIPELINEMANAGER: string;
  10767. static readonly NAME_SPRITE: string;
  10768. static readonly NAME_OUTLINERENDERER: string;
  10769. static readonly NAME_PROCEDURALTEXTURE: string;
  10770. static readonly NAME_SHADOWGENERATOR: string;
  10771. static readonly NAME_OCTREE: string;
  10772. static readonly NAME_PHYSICSENGINE: string;
  10773. static readonly NAME_AUDIO: string;
  10774. static readonly STEP_ISREADYFORMESH_EFFECTLAYER: number;
  10775. static readonly STEP_BEFOREEVALUATEACTIVEMESH_BOUNDINGBOXRENDERER: number;
  10776. static readonly STEP_EVALUATESUBMESH_BOUNDINGBOXRENDERER: number;
  10777. static readonly STEP_ACTIVEMESH_BOUNDINGBOXRENDERER: number;
  10778. static readonly STEP_CAMERADRAWRENDERTARGET_EFFECTLAYER: number;
  10779. static readonly STEP_BEFORECAMERADRAW_EFFECTLAYER: number;
  10780. static readonly STEP_BEFORECAMERADRAW_LAYER: number;
  10781. static readonly STEP_BEFORECAMERADRAW_PREPASS: number;
  10782. static readonly STEP_BEFORERENDERTARGETDRAW_LAYER: number;
  10783. static readonly STEP_BEFORERENDERINGMESH_OUTLINE: number;
  10784. static readonly STEP_AFTERRENDERINGMESH_OUTLINE: number;
  10785. static readonly STEP_AFTERRENDERINGGROUPDRAW_EFFECTLAYER_DRAW: number;
  10786. static readonly STEP_AFTERRENDERINGGROUPDRAW_BOUNDINGBOXRENDERER: number;
  10787. static readonly STEP_BEFORECAMERAUPDATE_SIMPLIFICATIONQUEUE: number;
  10788. static readonly STEP_BEFORECAMERAUPDATE_GAMEPAD: number;
  10789. static readonly STEP_BEFORECLEAR_PROCEDURALTEXTURE: number;
  10790. static readonly STEP_AFTERRENDERTARGETDRAW_LAYER: number;
  10791. static readonly STEP_AFTERCAMERADRAW_EFFECTLAYER: number;
  10792. static readonly STEP_AFTERCAMERADRAW_LENSFLARESYSTEM: number;
  10793. static readonly STEP_AFTERCAMERADRAW_EFFECTLAYER_DRAW: number;
  10794. static readonly STEP_AFTERCAMERADRAW_LAYER: number;
  10795. static readonly STEP_AFTERCAMERADRAW_PREPASS: number;
  10796. static readonly STEP_AFTERRENDER_AUDIO: number;
  10797. static readonly STEP_GATHERRENDERTARGETS_DEPTHRENDERER: number;
  10798. static readonly STEP_GATHERRENDERTARGETS_GEOMETRYBUFFERRENDERER: number;
  10799. static readonly STEP_GATHERRENDERTARGETS_SHADOWGENERATOR: number;
  10800. static readonly STEP_GATHERRENDERTARGETS_POSTPROCESSRENDERPIPELINEMANAGER: number;
  10801. static readonly STEP_GATHERACTIVECAMERARENDERTARGETS_DEPTHRENDERER: number;
  10802. static readonly STEP_BEFORECLEARSTAGE_PREPASS: number;
  10803. static readonly STEP_POINTERMOVE_SPRITE: number;
  10804. static readonly STEP_POINTERDOWN_SPRITE: number;
  10805. static readonly STEP_POINTERUP_SPRITE: number;
  10806. }
  10807. /**
  10808. * This represents a scene component.
  10809. *
  10810. * This is used to decouple the dependency the scene is having on the different workloads like
  10811. * layers, post processes...
  10812. */
  10813. export interface ISceneComponent {
  10814. /**
  10815. * The name of the component. Each component must have a unique name.
  10816. */
  10817. name: string;
  10818. /**
  10819. * The scene the component belongs to.
  10820. */
  10821. scene: Scene;
  10822. /**
  10823. * Register the component to one instance of a scene.
  10824. */
  10825. register(): void;
  10826. /**
  10827. * Rebuilds the elements related to this component in case of
  10828. * context lost for instance.
  10829. */
  10830. rebuild(): void;
  10831. /**
  10832. * Disposes the component and the associated ressources.
  10833. */
  10834. dispose(): void;
  10835. }
  10836. /**
  10837. * This represents a SERIALIZABLE scene component.
  10838. *
  10839. * This extends Scene Component to add Serialization methods on top.
  10840. */
  10841. export interface ISceneSerializableComponent extends ISceneComponent {
  10842. /**
  10843. * Adds all the elements from the container to the scene
  10844. * @param container the container holding the elements
  10845. */
  10846. addFromContainer(container: AbstractScene): void;
  10847. /**
  10848. * Removes all the elements in the container from the scene
  10849. * @param container contains the elements to remove
  10850. * @param dispose if the removed element should be disposed (default: false)
  10851. */
  10852. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  10853. /**
  10854. * Serializes the component data to the specified json object
  10855. * @param serializationObject The object to serialize to
  10856. */
  10857. serialize(serializationObject: any): void;
  10858. }
  10859. /**
  10860. * Strong typing of a Mesh related stage step action
  10861. */
  10862. export type MeshStageAction = (mesh: AbstractMesh, hardwareInstancedRendering: boolean) => boolean;
  10863. /**
  10864. * Strong typing of a Evaluate Sub Mesh related stage step action
  10865. */
  10866. export type EvaluateSubMeshStageAction = (mesh: AbstractMesh, subMesh: SubMesh) => void;
  10867. /**
  10868. * Strong typing of a Active Mesh related stage step action
  10869. */
  10870. export type ActiveMeshStageAction = (sourceMesh: AbstractMesh, mesh: AbstractMesh) => void;
  10871. /**
  10872. * Strong typing of a Camera related stage step action
  10873. */
  10874. export type CameraStageAction = (camera: Camera) => void;
  10875. /**
  10876. * Strong typing of a Camera Frame buffer related stage step action
  10877. */
  10878. export type CameraStageFrameBufferAction = (camera: Camera) => boolean;
  10879. /**
  10880. * Strong typing of a Render Target related stage step action
  10881. */
  10882. export type RenderTargetStageAction = (renderTarget: RenderTargetTexture) => void;
  10883. /**
  10884. * Strong typing of a RenderingGroup related stage step action
  10885. */
  10886. export type RenderingGroupStageAction = (renderingGroupId: number) => void;
  10887. /**
  10888. * Strong typing of a Mesh Render related stage step action
  10889. */
  10890. export type RenderingMeshStageAction = (mesh: Mesh, subMesh: SubMesh, batch: _InstancesBatch) => void;
  10891. /**
  10892. * Strong typing of a simple stage step action
  10893. */
  10894. export type SimpleStageAction = () => void;
  10895. /**
  10896. * Strong typing of a render target action.
  10897. */
  10898. export type RenderTargetsStageAction = (renderTargets: SmartArrayNoDuplicate<RenderTargetTexture>) => void;
  10899. /**
  10900. * Strong typing of a pointer move action.
  10901. */
  10902. export type PointerMoveStageAction = (unTranslatedPointerX: number, unTranslatedPointerY: number, pickResult: Nullable<PickingInfo>, isMeshPicked: boolean, element: HTMLElement) => Nullable<PickingInfo>;
  10903. /**
  10904. * Strong typing of a pointer up/down action.
  10905. */
  10906. export type PointerUpDownStageAction = (unTranslatedPointerX: number, unTranslatedPointerY: number, pickResult: Nullable<PickingInfo>, evt: PointerEvent) => Nullable<PickingInfo>;
  10907. /**
  10908. * Representation of a stage in the scene (Basically a list of ordered steps)
  10909. * @hidden
  10910. */
  10911. export class Stage<T extends Function> extends Array<{
  10912. index: number;
  10913. component: ISceneComponent;
  10914. action: T;
  10915. }> {
  10916. /**
  10917. * Hide ctor from the rest of the world.
  10918. * @param items The items to add.
  10919. */
  10920. private constructor();
  10921. /**
  10922. * Creates a new Stage.
  10923. * @returns A new instance of a Stage
  10924. */
  10925. static Create<T extends Function>(): Stage<T>;
  10926. /**
  10927. * Registers a step in an ordered way in the targeted stage.
  10928. * @param index Defines the position to register the step in
  10929. * @param component Defines the component attached to the step
  10930. * @param action Defines the action to launch during the step
  10931. */
  10932. registerStep(index: number, component: ISceneComponent, action: T): void;
  10933. /**
  10934. * Clears all the steps from the stage.
  10935. */
  10936. clear(): void;
  10937. }
  10938. }
  10939. declare module "babylonjs/Sprites/spriteSceneComponent" {
  10940. import { Nullable } from "babylonjs/types";
  10941. import { Observable } from "babylonjs/Misc/observable";
  10942. import { Scene } from "babylonjs/scene";
  10943. import { Sprite } from "babylonjs/Sprites/sprite";
  10944. import { ISpriteManager } from "babylonjs/Sprites/spriteManager";
  10945. import { Ray } from "babylonjs/Culling/ray";
  10946. import { Camera } from "babylonjs/Cameras/camera";
  10947. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  10948. import { ISceneComponent } from "babylonjs/sceneComponent";
  10949. module "babylonjs/scene" {
  10950. interface Scene {
  10951. /** @hidden */
  10952. _pointerOverSprite: Nullable<Sprite>;
  10953. /** @hidden */
  10954. _pickedDownSprite: Nullable<Sprite>;
  10955. /** @hidden */
  10956. _tempSpritePickingRay: Nullable<Ray>;
  10957. /**
  10958. * All of the sprite managers added to this scene
  10959. * @see https://doc.babylonjs.com/babylon101/sprites
  10960. */
  10961. spriteManagers: Array<ISpriteManager>;
  10962. /**
  10963. * An event triggered when sprites rendering is about to start
  10964. * Note: This event can be trigger more than once per frame (because sprites can be rendered by render target textures as well)
  10965. */
  10966. onBeforeSpritesRenderingObservable: Observable<Scene>;
  10967. /**
  10968. * An event triggered when sprites rendering is done
  10969. * Note: This event can be trigger more than once per frame (because sprites can be rendered by render target textures as well)
  10970. */
  10971. onAfterSpritesRenderingObservable: Observable<Scene>;
  10972. /** @hidden */
  10973. _internalPickSprites(ray: Ray, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  10974. /** Launch a ray to try to pick a sprite in the scene
  10975. * @param x position on screen
  10976. * @param y position on screen
  10977. * @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
  10978. * @param fastCheck defines if the first intersection will be used (and not the closest)
  10979. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  10980. * @returns a PickingInfo
  10981. */
  10982. pickSprite(x: number, y: number, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  10983. /** Use the given ray to pick a sprite in the scene
  10984. * @param ray The ray (in world space) to use to pick meshes
  10985. * @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
  10986. * @param fastCheck defines if the first intersection will be used (and not the closest)
  10987. * @param camera camera to use. Can be set to null. In this case, the scene.activeCamera will be used
  10988. * @returns a PickingInfo
  10989. */
  10990. pickSpriteWithRay(ray: Ray, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  10991. /** @hidden */
  10992. _internalMultiPickSprites(ray: Ray, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  10993. /** Launch a ray to try to pick sprites in the scene
  10994. * @param x position on screen
  10995. * @param y position on screen
  10996. * @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
  10997. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  10998. * @returns a PickingInfo array
  10999. */
  11000. multiPickSprite(x: number, y: number, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  11001. /** Use the given ray to pick sprites in the scene
  11002. * @param ray The ray (in world space) to use to pick meshes
  11003. * @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
  11004. * @param camera camera to use. Can be set to null. In this case, the scene.activeCamera will be used
  11005. * @returns a PickingInfo array
  11006. */
  11007. multiPickSpriteWithRay(ray: Ray, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  11008. /**
  11009. * Force the sprite under the pointer
  11010. * @param sprite defines the sprite to use
  11011. */
  11012. setPointerOverSprite(sprite: Nullable<Sprite>): void;
  11013. /**
  11014. * Gets the sprite under the pointer
  11015. * @returns a Sprite or null if no sprite is under the pointer
  11016. */
  11017. getPointerOverSprite(): Nullable<Sprite>;
  11018. }
  11019. }
  11020. /**
  11021. * Defines the sprite scene component responsible to manage sprites
  11022. * in a given scene.
  11023. */
  11024. export class SpriteSceneComponent implements ISceneComponent {
  11025. /**
  11026. * The component name helpfull to identify the component in the list of scene components.
  11027. */
  11028. readonly name: string;
  11029. /**
  11030. * The scene the component belongs to.
  11031. */
  11032. scene: Scene;
  11033. /** @hidden */
  11034. private _spritePredicate;
  11035. /**
  11036. * Creates a new instance of the component for the given scene
  11037. * @param scene Defines the scene to register the component in
  11038. */
  11039. constructor(scene: Scene);
  11040. /**
  11041. * Registers the component in a given scene
  11042. */
  11043. register(): void;
  11044. /**
  11045. * Rebuilds the elements related to this component in case of
  11046. * context lost for instance.
  11047. */
  11048. rebuild(): void;
  11049. /**
  11050. * Disposes the component and the associated ressources.
  11051. */
  11052. dispose(): void;
  11053. private _pickSpriteButKeepRay;
  11054. private _pointerMove;
  11055. private _pointerDown;
  11056. private _pointerUp;
  11057. }
  11058. }
  11059. declare module "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration" {
  11060. /** @hidden */
  11061. export var fogFragmentDeclaration: {
  11062. name: string;
  11063. shader: string;
  11064. };
  11065. }
  11066. declare module "babylonjs/Shaders/ShadersInclude/fogFragment" {
  11067. /** @hidden */
  11068. export var fogFragment: {
  11069. name: string;
  11070. shader: string;
  11071. };
  11072. }
  11073. declare module "babylonjs/Shaders/sprites.fragment" {
  11074. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  11075. import "babylonjs/Shaders/ShadersInclude/fogFragment";
  11076. /** @hidden */
  11077. export var spritesPixelShader: {
  11078. name: string;
  11079. shader: string;
  11080. };
  11081. }
  11082. declare module "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration" {
  11083. /** @hidden */
  11084. export var fogVertexDeclaration: {
  11085. name: string;
  11086. shader: string;
  11087. };
  11088. }
  11089. declare module "babylonjs/Shaders/sprites.vertex" {
  11090. import "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration";
  11091. /** @hidden */
  11092. export var spritesVertexShader: {
  11093. name: string;
  11094. shader: string;
  11095. };
  11096. }
  11097. declare module "babylonjs/Sprites/spriteManager" {
  11098. import { IDisposable, Scene } from "babylonjs/scene";
  11099. import { Nullable } from "babylonjs/types";
  11100. import { Observable } from "babylonjs/Misc/observable";
  11101. import { Sprite } from "babylonjs/Sprites/sprite";
  11102. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  11103. import { Camera } from "babylonjs/Cameras/camera";
  11104. import { Texture } from "babylonjs/Materials/Textures/texture";
  11105. import "babylonjs/Shaders/sprites.fragment";
  11106. import "babylonjs/Shaders/sprites.vertex";
  11107. import { Ray } from "babylonjs/Culling/ray";
  11108. /**
  11109. * Defines the minimum interface to fullfil in order to be a sprite manager.
  11110. */
  11111. export interface ISpriteManager extends IDisposable {
  11112. /**
  11113. * Gets manager's name
  11114. */
  11115. name: string;
  11116. /**
  11117. * Restricts the camera to viewing objects with the same layerMask.
  11118. * A camera with a layerMask of 1 will render spriteManager.layerMask & camera.layerMask!== 0
  11119. */
  11120. layerMask: number;
  11121. /**
  11122. * Gets or sets a boolean indicating if the mesh can be picked (by scene.pick for instance or through actions). Default is true
  11123. */
  11124. isPickable: boolean;
  11125. /**
  11126. * Gets the hosting scene
  11127. */
  11128. scene: Scene;
  11129. /**
  11130. * Specifies the rendering group id for this mesh (0 by default)
  11131. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#rendering-groups
  11132. */
  11133. renderingGroupId: number;
  11134. /**
  11135. * Defines the list of sprites managed by the manager.
  11136. */
  11137. sprites: Array<Sprite>;
  11138. /**
  11139. * Gets or sets the spritesheet texture
  11140. */
  11141. texture: Texture;
  11142. /** Defines the default width of a cell in the spritesheet */
  11143. cellWidth: number;
  11144. /** Defines the default height of a cell in the spritesheet */
  11145. cellHeight: number;
  11146. /**
  11147. * Tests the intersection of a sprite with a specific ray.
  11148. * @param ray The ray we are sending to test the collision
  11149. * @param camera The camera space we are sending rays in
  11150. * @param predicate A predicate allowing excluding sprites from the list of object to test
  11151. * @param fastCheck defines if the first intersection will be used (and not the closest)
  11152. * @returns picking info or null.
  11153. */
  11154. intersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean): Nullable<PickingInfo>;
  11155. /**
  11156. * Intersects the sprites with a ray
  11157. * @param ray defines the ray to intersect with
  11158. * @param camera defines the current active camera
  11159. * @param predicate defines a predicate used to select candidate sprites
  11160. * @returns null if no hit or a PickingInfo array
  11161. */
  11162. multiIntersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean): Nullable<PickingInfo[]>;
  11163. /**
  11164. * Renders the list of sprites on screen.
  11165. */
  11166. render(): void;
  11167. }
  11168. /**
  11169. * Class used to manage multiple sprites on the same spritesheet
  11170. * @see https://doc.babylonjs.com/babylon101/sprites
  11171. */
  11172. export class SpriteManager implements ISpriteManager {
  11173. /** defines the manager's name */
  11174. name: string;
  11175. /** Define the Url to load snippets */
  11176. static SnippetUrl: string;
  11177. /** Snippet ID if the manager was created from the snippet server */
  11178. snippetId: string;
  11179. /** Gets the list of sprites */
  11180. sprites: Sprite[];
  11181. /** Gets or sets the rendering group id (0 by default) */
  11182. renderingGroupId: number;
  11183. /** Gets or sets camera layer mask */
  11184. layerMask: number;
  11185. /** Gets or sets a boolean indicating if the manager must consider scene fog when rendering */
  11186. fogEnabled: boolean;
  11187. /** Gets or sets a boolean indicating if the sprites are pickable */
  11188. isPickable: boolean;
  11189. /** Defines the default width of a cell in the spritesheet */
  11190. cellWidth: number;
  11191. /** Defines the default height of a cell in the spritesheet */
  11192. cellHeight: number;
  11193. /** Associative array from JSON sprite data file */
  11194. private _cellData;
  11195. /** Array of sprite names from JSON sprite data file */
  11196. private _spriteMap;
  11197. /** True when packed cell data from JSON file is ready*/
  11198. private _packedAndReady;
  11199. private _textureContent;
  11200. /**
  11201. * An event triggered when the manager is disposed.
  11202. */
  11203. onDisposeObservable: Observable<SpriteManager>;
  11204. private _onDisposeObserver;
  11205. /**
  11206. * Callback called when the manager is disposed
  11207. */
  11208. set onDispose(callback: () => void);
  11209. private _capacity;
  11210. private _fromPacked;
  11211. private _spriteTexture;
  11212. private _epsilon;
  11213. private _scene;
  11214. private _vertexData;
  11215. private _buffer;
  11216. private _vertexBuffers;
  11217. private _indexBuffer;
  11218. private _effectBase;
  11219. private _effectFog;
  11220. /**
  11221. * Gets or sets the unique id of the sprite
  11222. */
  11223. uniqueId: number;
  11224. /**
  11225. * Gets the array of sprites
  11226. */
  11227. get children(): Sprite[];
  11228. /**
  11229. * Gets the hosting scene
  11230. */
  11231. get scene(): Scene;
  11232. /**
  11233. * Gets the capacity of the manager
  11234. */
  11235. get capacity(): number;
  11236. /**
  11237. * Gets or sets the spritesheet texture
  11238. */
  11239. get texture(): Texture;
  11240. set texture(value: Texture);
  11241. private _blendMode;
  11242. /**
  11243. * Blend mode use to render the particle, it can be any of
  11244. * the static Constants.ALPHA_x properties provided in this class.
  11245. * Default value is Constants.ALPHA_COMBINE
  11246. */
  11247. get blendMode(): number;
  11248. set blendMode(blendMode: number);
  11249. /** Disables writing to the depth buffer when rendering the sprites.
  11250. * It can be handy to disable depth writing when using textures without alpha channel
  11251. * and setting some specific blend modes.
  11252. */
  11253. disableDepthWrite: boolean;
  11254. /**
  11255. * Creates a new sprite manager
  11256. * @param name defines the manager's name
  11257. * @param imgUrl defines the sprite sheet url
  11258. * @param capacity defines the maximum allowed number of sprites
  11259. * @param cellSize defines the size of a sprite cell
  11260. * @param scene defines the hosting scene
  11261. * @param epsilon defines the epsilon value to align texture (0.01 by default)
  11262. * @param samplingMode defines the smapling mode to use with spritesheet
  11263. * @param fromPacked set to false; do not alter
  11264. * @param spriteJSON null otherwise a JSON object defining sprite sheet data; do not alter
  11265. */
  11266. constructor(
  11267. /** defines the manager's name */
  11268. name: string, imgUrl: string, capacity: number, cellSize: any, scene: Scene, epsilon?: number, samplingMode?: number, fromPacked?: boolean, spriteJSON?: any | null);
  11269. /**
  11270. * Returns the string "SpriteManager"
  11271. * @returns "SpriteManager"
  11272. */
  11273. getClassName(): string;
  11274. private _makePacked;
  11275. private _appendSpriteVertex;
  11276. private _checkTextureAlpha;
  11277. /**
  11278. * Intersects the sprites with a ray
  11279. * @param ray defines the ray to intersect with
  11280. * @param camera defines the current active camera
  11281. * @param predicate defines a predicate used to select candidate sprites
  11282. * @param fastCheck defines if a fast check only must be done (the first potential sprite is will be used and not the closer)
  11283. * @returns null if no hit or a PickingInfo
  11284. */
  11285. intersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean): Nullable<PickingInfo>;
  11286. /**
  11287. * Intersects the sprites with a ray
  11288. * @param ray defines the ray to intersect with
  11289. * @param camera defines the current active camera
  11290. * @param predicate defines a predicate used to select candidate sprites
  11291. * @returns null if no hit or a PickingInfo array
  11292. */
  11293. multiIntersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean): Nullable<PickingInfo[]>;
  11294. /**
  11295. * Render all child sprites
  11296. */
  11297. render(): void;
  11298. /**
  11299. * Release associated resources
  11300. */
  11301. dispose(): void;
  11302. /**
  11303. * Serializes the sprite manager to a JSON object
  11304. * @param serializeTexture defines if the texture must be serialized as well
  11305. * @returns the JSON object
  11306. */
  11307. serialize(serializeTexture?: boolean): any;
  11308. /**
  11309. * Parses a JSON object to create a new sprite manager.
  11310. * @param parsedManager The JSON object to parse
  11311. * @param scene The scene to create the sprite managerin
  11312. * @param rootUrl The root url to use to load external dependencies like texture
  11313. * @returns the new sprite manager
  11314. */
  11315. static Parse(parsedManager: any, scene: Scene, rootUrl: string): SpriteManager;
  11316. /**
  11317. * Creates a sprite manager from a snippet saved in a remote file
  11318. * @param name defines the name of the sprite manager to create (can be null or empty to use the one from the json data)
  11319. * @param url defines the url to load from
  11320. * @param scene defines the hosting scene
  11321. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  11322. * @returns a promise that will resolve to the new sprite manager
  11323. */
  11324. static ParseFromFileAsync(name: Nullable<string>, url: string, scene: Scene, rootUrl?: string): Promise<SpriteManager>;
  11325. /**
  11326. * Creates a sprite manager from a snippet saved by the sprite editor
  11327. * @param snippetId defines the snippet to load (can be set to _BLANK to create a default one)
  11328. * @param scene defines the hosting scene
  11329. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  11330. * @returns a promise that will resolve to the new sprite manager
  11331. */
  11332. static CreateFromSnippetAsync(snippetId: string, scene: Scene, rootUrl?: string): Promise<SpriteManager>;
  11333. }
  11334. }
  11335. declare module "babylonjs/Misc/gradients" {
  11336. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  11337. /** Interface used by value gradients (color, factor, ...) */
  11338. export interface IValueGradient {
  11339. /**
  11340. * Gets or sets the gradient value (between 0 and 1)
  11341. */
  11342. gradient: number;
  11343. }
  11344. /** Class used to store color4 gradient */
  11345. export class ColorGradient implements IValueGradient {
  11346. /**
  11347. * Gets or sets the gradient value (between 0 and 1)
  11348. */
  11349. gradient: number;
  11350. /**
  11351. * Gets or sets first associated color
  11352. */
  11353. color1: Color4;
  11354. /**
  11355. * Gets or sets second associated color
  11356. */
  11357. color2?: Color4 | undefined;
  11358. /**
  11359. * Creates a new color4 gradient
  11360. * @param gradient gets or sets the gradient value (between 0 and 1)
  11361. * @param color1 gets or sets first associated color
  11362. * @param color2 gets or sets first second color
  11363. */
  11364. constructor(
  11365. /**
  11366. * Gets or sets the gradient value (between 0 and 1)
  11367. */
  11368. gradient: number,
  11369. /**
  11370. * Gets or sets first associated color
  11371. */
  11372. color1: Color4,
  11373. /**
  11374. * Gets or sets second associated color
  11375. */
  11376. color2?: Color4 | undefined);
  11377. /**
  11378. * Will get a color picked randomly between color1 and color2.
  11379. * If color2 is undefined then color1 will be used
  11380. * @param result defines the target Color4 to store the result in
  11381. */
  11382. getColorToRef(result: Color4): void;
  11383. }
  11384. /** Class used to store color 3 gradient */
  11385. export class Color3Gradient implements IValueGradient {
  11386. /**
  11387. * Gets or sets the gradient value (between 0 and 1)
  11388. */
  11389. gradient: number;
  11390. /**
  11391. * Gets or sets the associated color
  11392. */
  11393. color: Color3;
  11394. /**
  11395. * Creates a new color3 gradient
  11396. * @param gradient gets or sets the gradient value (between 0 and 1)
  11397. * @param color gets or sets associated color
  11398. */
  11399. constructor(
  11400. /**
  11401. * Gets or sets the gradient value (between 0 and 1)
  11402. */
  11403. gradient: number,
  11404. /**
  11405. * Gets or sets the associated color
  11406. */
  11407. color: Color3);
  11408. }
  11409. /** Class used to store factor gradient */
  11410. export class FactorGradient implements IValueGradient {
  11411. /**
  11412. * Gets or sets the gradient value (between 0 and 1)
  11413. */
  11414. gradient: number;
  11415. /**
  11416. * Gets or sets first associated factor
  11417. */
  11418. factor1: number;
  11419. /**
  11420. * Gets or sets second associated factor
  11421. */
  11422. factor2?: number | undefined;
  11423. /**
  11424. * Creates a new factor gradient
  11425. * @param gradient gets or sets the gradient value (between 0 and 1)
  11426. * @param factor1 gets or sets first associated factor
  11427. * @param factor2 gets or sets second associated factor
  11428. */
  11429. constructor(
  11430. /**
  11431. * Gets or sets the gradient value (between 0 and 1)
  11432. */
  11433. gradient: number,
  11434. /**
  11435. * Gets or sets first associated factor
  11436. */
  11437. factor1: number,
  11438. /**
  11439. * Gets or sets second associated factor
  11440. */
  11441. factor2?: number | undefined);
  11442. /**
  11443. * Will get a number picked randomly between factor1 and factor2.
  11444. * If factor2 is undefined then factor1 will be used
  11445. * @returns the picked number
  11446. */
  11447. getFactor(): number;
  11448. }
  11449. /**
  11450. * Helper used to simplify some generic gradient tasks
  11451. */
  11452. export class GradientHelper {
  11453. /**
  11454. * Gets the current gradient from an array of IValueGradient
  11455. * @param ratio defines the current ratio to get
  11456. * @param gradients defines the array of IValueGradient
  11457. * @param updateFunc defines the callback function used to get the final value from the selected gradients
  11458. */
  11459. static GetCurrentGradient(ratio: number, gradients: IValueGradient[], updateFunc: (current: IValueGradient, next: IValueGradient, scale: number) => void): void;
  11460. }
  11461. }
  11462. declare module "babylonjs/Engines/Extensions/engine.rawTexture" {
  11463. import { Nullable } from "babylonjs/types";
  11464. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  11465. import { Scene } from "babylonjs/scene";
  11466. module "babylonjs/Engines/thinEngine" {
  11467. interface ThinEngine {
  11468. /**
  11469. * Creates a raw texture
  11470. * @param data defines the data to store in the texture
  11471. * @param width defines the width of the texture
  11472. * @param height defines the height of the texture
  11473. * @param format defines the format of the data
  11474. * @param generateMipMaps defines if the engine should generate the mip levels
  11475. * @param invertY defines if data must be stored with Y axis inverted
  11476. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  11477. * @param compression defines the compression used (null by default)
  11478. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  11479. * @returns the raw texture inside an InternalTexture
  11480. */
  11481. createRawTexture(data: Nullable<ArrayBufferView>, width: number, height: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, type: number): InternalTexture;
  11482. /**
  11483. * Update a raw texture
  11484. * @param texture defines the texture to update
  11485. * @param data defines the data to store in the texture
  11486. * @param format defines the format of the data
  11487. * @param invertY defines if data must be stored with Y axis inverted
  11488. */
  11489. updateRawTexture(texture: Nullable<InternalTexture>, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  11490. /**
  11491. * Update a raw texture
  11492. * @param texture defines the texture to update
  11493. * @param data defines the data to store in the texture
  11494. * @param format defines the format of the data
  11495. * @param invertY defines if data must be stored with Y axis inverted
  11496. * @param compression defines the compression used (null by default)
  11497. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  11498. */
  11499. updateRawTexture(texture: Nullable<InternalTexture>, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, type: number): void;
  11500. /**
  11501. * Creates a new raw cube texture
  11502. * @param data defines the array of data to use to create each face
  11503. * @param size defines the size of the textures
  11504. * @param format defines the format of the data
  11505. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  11506. * @param generateMipMaps defines if the engine should generate the mip levels
  11507. * @param invertY defines if data must be stored with Y axis inverted
  11508. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  11509. * @param compression defines the compression used (null by default)
  11510. * @returns the cube texture as an InternalTexture
  11511. */
  11512. createRawCubeTexture(data: Nullable<ArrayBufferView[]>, size: number, format: number, type: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>): InternalTexture;
  11513. /**
  11514. * Update a raw cube texture
  11515. * @param texture defines the texture to udpdate
  11516. * @param data defines the data to store
  11517. * @param format defines the data format
  11518. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  11519. * @param invertY defines if data must be stored with Y axis inverted
  11520. */
  11521. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean): void;
  11522. /**
  11523. * Update a raw cube texture
  11524. * @param texture defines the texture to udpdate
  11525. * @param data defines the data to store
  11526. * @param format defines the data format
  11527. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  11528. * @param invertY defines if data must be stored with Y axis inverted
  11529. * @param compression defines the compression used (null by default)
  11530. */
  11531. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression: Nullable<string>): void;
  11532. /**
  11533. * Update a raw cube texture
  11534. * @param texture defines the texture to udpdate
  11535. * @param data defines the data to store
  11536. * @param format defines the data format
  11537. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  11538. * @param invertY defines if data must be stored with Y axis inverted
  11539. * @param compression defines the compression used (null by default)
  11540. * @param level defines which level of the texture to update
  11541. */
  11542. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression: Nullable<string>, level: number): void;
  11543. /**
  11544. * Creates a new raw cube texture from a specified url
  11545. * @param url defines the url where the data is located
  11546. * @param scene defines the current scene
  11547. * @param size defines the size of the textures
  11548. * @param format defines the format of the data
  11549. * @param type defines the type fo the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  11550. * @param noMipmap defines if the engine should avoid generating the mip levels
  11551. * @param callback defines a callback used to extract texture data from loaded data
  11552. * @param mipmapGenerator defines to provide an optional tool to generate mip levels
  11553. * @param onLoad defines a callback called when texture is loaded
  11554. * @param onError defines a callback called if there is an error
  11555. * @returns the cube texture as an InternalTexture
  11556. */
  11557. 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;
  11558. /**
  11559. * Creates a new raw cube texture from a specified url
  11560. * @param url defines the url where the data is located
  11561. * @param scene defines the current scene
  11562. * @param size defines the size of the textures
  11563. * @param format defines the format of the data
  11564. * @param type defines the type fo the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  11565. * @param noMipmap defines if the engine should avoid generating the mip levels
  11566. * @param callback defines a callback used to extract texture data from loaded data
  11567. * @param mipmapGenerator defines to provide an optional tool to generate mip levels
  11568. * @param onLoad defines a callback called when texture is loaded
  11569. * @param onError defines a callback called if there is an error
  11570. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  11571. * @param invertY defines if data must be stored with Y axis inverted
  11572. * @returns the cube texture as an InternalTexture
  11573. */
  11574. 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;
  11575. /**
  11576. * Creates a new raw 3D texture
  11577. * @param data defines the data used to create the texture
  11578. * @param width defines the width of the texture
  11579. * @param height defines the height of the texture
  11580. * @param depth defines the depth of the texture
  11581. * @param format defines the format of the texture
  11582. * @param generateMipMaps defines if the engine must generate mip levels
  11583. * @param invertY defines if data must be stored with Y axis inverted
  11584. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  11585. * @param compression defines the compressed used (can be null)
  11586. * @param textureType defines the compressed used (can be null)
  11587. * @returns a new raw 3D texture (stored in an InternalTexture)
  11588. */
  11589. createRawTexture3D(data: Nullable<ArrayBufferView>, width: number, height: number, depth: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, textureType: number): InternalTexture;
  11590. /**
  11591. * Update a raw 3D texture
  11592. * @param texture defines the texture to update
  11593. * @param data defines the data to store
  11594. * @param format defines the data format
  11595. * @param invertY defines if data must be stored with Y axis inverted
  11596. */
  11597. updateRawTexture3D(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  11598. /**
  11599. * Update a raw 3D texture
  11600. * @param texture defines the texture to update
  11601. * @param data defines the data to store
  11602. * @param format defines the data format
  11603. * @param invertY defines if data must be stored with Y axis inverted
  11604. * @param compression defines the used compression (can be null)
  11605. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  11606. */
  11607. updateRawTexture3D(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, textureType: number): void;
  11608. /**
  11609. * Creates a new raw 2D array texture
  11610. * @param data defines the data used to create the texture
  11611. * @param width defines the width of the texture
  11612. * @param height defines the height of the texture
  11613. * @param depth defines the number of layers of the texture
  11614. * @param format defines the format of the texture
  11615. * @param generateMipMaps defines if the engine must generate mip levels
  11616. * @param invertY defines if data must be stored with Y axis inverted
  11617. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  11618. * @param compression defines the compressed used (can be null)
  11619. * @param textureType defines the compressed used (can be null)
  11620. * @returns a new raw 2D array texture (stored in an InternalTexture)
  11621. */
  11622. createRawTexture2DArray(data: Nullable<ArrayBufferView>, width: number, height: number, depth: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, textureType: number): InternalTexture;
  11623. /**
  11624. * Update a raw 2D array texture
  11625. * @param texture defines the texture to update
  11626. * @param data defines the data to store
  11627. * @param format defines the data format
  11628. * @param invertY defines if data must be stored with Y axis inverted
  11629. */
  11630. updateRawTexture2DArray(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  11631. /**
  11632. * Update a raw 2D array texture
  11633. * @param texture defines the texture to update
  11634. * @param data defines the data to store
  11635. * @param format defines the data format
  11636. * @param invertY defines if data must be stored with Y axis inverted
  11637. * @param compression defines the used compression (can be null)
  11638. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  11639. */
  11640. updateRawTexture2DArray(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, textureType: number): void;
  11641. }
  11642. }
  11643. }
  11644. declare module "babylonjs/Materials/Textures/rawTexture" {
  11645. import { Scene } from "babylonjs/scene";
  11646. import { Texture } from "babylonjs/Materials/Textures/texture";
  11647. import "babylonjs/Engines/Extensions/engine.rawTexture";
  11648. /**
  11649. * Raw texture can help creating a texture directly from an array of data.
  11650. * This can be super useful if you either get the data from an uncompressed source or
  11651. * if you wish to create your texture pixel by pixel.
  11652. */
  11653. export class RawTexture extends Texture {
  11654. /**
  11655. * Define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  11656. */
  11657. format: number;
  11658. /**
  11659. * Instantiates a new RawTexture.
  11660. * Raw texture can help creating a texture directly from an array of data.
  11661. * This can be super useful if you either get the data from an uncompressed source or
  11662. * if you wish to create your texture pixel by pixel.
  11663. * @param data define the array of data to use to create the texture
  11664. * @param width define the width of the texture
  11665. * @param height define the height of the texture
  11666. * @param format define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  11667. * @param scene define the scene the texture belongs to
  11668. * @param generateMipMaps define whether mip maps should be generated or not
  11669. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  11670. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  11671. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  11672. */
  11673. constructor(data: ArrayBufferView, width: number, height: number,
  11674. /**
  11675. * Define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  11676. */
  11677. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number);
  11678. /**
  11679. * Updates the texture underlying data.
  11680. * @param data Define the new data of the texture
  11681. */
  11682. update(data: ArrayBufferView): void;
  11683. /**
  11684. * Creates a luminance texture from some data.
  11685. * @param data Define the texture data
  11686. * @param width Define the width of the texture
  11687. * @param height Define the height of the texture
  11688. * @param scene Define the scene the texture belongs to
  11689. * @param generateMipMaps Define whether or not to create mip maps for the texture
  11690. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  11691. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  11692. * @returns the luminance texture
  11693. */
  11694. static CreateLuminanceTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  11695. /**
  11696. * Creates a luminance alpha texture from some data.
  11697. * @param data Define the texture data
  11698. * @param width Define the width of the texture
  11699. * @param height Define the height of the texture
  11700. * @param scene Define the scene the texture belongs to
  11701. * @param generateMipMaps Define whether or not to create mip maps for the texture
  11702. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  11703. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  11704. * @returns the luminance alpha texture
  11705. */
  11706. static CreateLuminanceAlphaTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  11707. /**
  11708. * Creates an alpha texture from some data.
  11709. * @param data Define the texture data
  11710. * @param width Define the width of the texture
  11711. * @param height Define the height of the texture
  11712. * @param scene Define the scene the texture belongs to
  11713. * @param generateMipMaps Define whether or not to create mip maps for the texture
  11714. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  11715. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  11716. * @returns the alpha texture
  11717. */
  11718. static CreateAlphaTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  11719. /**
  11720. * Creates a RGB texture from some data.
  11721. * @param data Define the texture data
  11722. * @param width Define the width of the texture
  11723. * @param height Define the height of the texture
  11724. * @param scene Define the scene the texture belongs to
  11725. * @param generateMipMaps Define whether or not to create mip maps for the texture
  11726. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  11727. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  11728. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  11729. * @returns the RGB alpha texture
  11730. */
  11731. static CreateRGBTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  11732. /**
  11733. * Creates a RGBA texture from some data.
  11734. * @param data Define the texture data
  11735. * @param width Define the width of the texture
  11736. * @param height Define the height of the texture
  11737. * @param scene Define the scene the texture belongs to
  11738. * @param generateMipMaps Define whether or not to create mip maps for the texture
  11739. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  11740. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  11741. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  11742. * @returns the RGBA texture
  11743. */
  11744. static CreateRGBATexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  11745. /**
  11746. * Creates a R texture from some data.
  11747. * @param data Define the texture data
  11748. * @param width Define the width of the texture
  11749. * @param height Define the height of the texture
  11750. * @param scene Define the scene the texture belongs to
  11751. * @param generateMipMaps Define whether or not to create mip maps for the texture
  11752. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  11753. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  11754. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  11755. * @returns the R texture
  11756. */
  11757. static CreateRTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  11758. }
  11759. }
  11760. declare module "babylonjs/Materials/Textures/Procedurals/proceduralTextureSceneComponent" {
  11761. import { Scene } from "babylonjs/scene";
  11762. import { ISceneComponent } from "babylonjs/sceneComponent";
  11763. import { ProceduralTexture } from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  11764. module "babylonjs/abstractScene" {
  11765. interface AbstractScene {
  11766. /**
  11767. * The list of procedural textures added to the scene
  11768. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  11769. */
  11770. proceduralTextures: Array<ProceduralTexture>;
  11771. }
  11772. }
  11773. /**
  11774. * Defines the Procedural Texture scene component responsible to manage any Procedural Texture
  11775. * in a given scene.
  11776. */
  11777. export class ProceduralTextureSceneComponent implements ISceneComponent {
  11778. /**
  11779. * The component name helpfull to identify the component in the list of scene components.
  11780. */
  11781. readonly name: string;
  11782. /**
  11783. * The scene the component belongs to.
  11784. */
  11785. scene: Scene;
  11786. /**
  11787. * Creates a new instance of the component for the given scene
  11788. * @param scene Defines the scene to register the component in
  11789. */
  11790. constructor(scene: Scene);
  11791. /**
  11792. * Registers the component in a given scene
  11793. */
  11794. register(): void;
  11795. /**
  11796. * Rebuilds the elements related to this component in case of
  11797. * context lost for instance.
  11798. */
  11799. rebuild(): void;
  11800. /**
  11801. * Disposes the component and the associated ressources.
  11802. */
  11803. dispose(): void;
  11804. private _beforeClear;
  11805. }
  11806. }
  11807. declare module "babylonjs/Engines/Extensions/engine.renderTargetCube" {
  11808. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  11809. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  11810. module "babylonjs/Engines/thinEngine" {
  11811. interface ThinEngine {
  11812. /**
  11813. * Creates a new render target cube texture
  11814. * @param size defines the size of the texture
  11815. * @param options defines the options used to create the texture
  11816. * @returns a new render target cube texture stored in an InternalTexture
  11817. */
  11818. createRenderTargetCubeTexture(size: number, options?: Partial<RenderTargetCreationOptions>): InternalTexture;
  11819. }
  11820. }
  11821. }
  11822. declare module "babylonjs/Shaders/procedural.vertex" {
  11823. /** @hidden */
  11824. export var proceduralVertexShader: {
  11825. name: string;
  11826. shader: string;
  11827. };
  11828. }
  11829. declare module "babylonjs/Materials/Textures/Procedurals/proceduralTexture" {
  11830. import { Observable } from "babylonjs/Misc/observable";
  11831. import { Nullable } from "babylonjs/types";
  11832. import { Scene } from "babylonjs/scene";
  11833. import { Matrix, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  11834. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  11835. import { Effect } from "babylonjs/Materials/effect";
  11836. import { Texture } from "babylonjs/Materials/Textures/texture";
  11837. import "babylonjs/Engines/Extensions/engine.renderTarget";
  11838. import "babylonjs/Engines/Extensions/engine.renderTargetCube";
  11839. import "babylonjs/Shaders/procedural.vertex";
  11840. /**
  11841. * 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.
  11842. * This is the base class of any Procedural texture and contains most of the shareable code.
  11843. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  11844. */
  11845. export class ProceduralTexture extends Texture {
  11846. isCube: boolean;
  11847. /**
  11848. * Define if the texture is enabled or not (disabled texture will not render)
  11849. */
  11850. isEnabled: boolean;
  11851. /**
  11852. * Define if the texture must be cleared before rendering (default is true)
  11853. */
  11854. autoClear: boolean;
  11855. /**
  11856. * Callback called when the texture is generated
  11857. */
  11858. onGenerated: () => void;
  11859. /**
  11860. * Event raised when the texture is generated
  11861. */
  11862. onGeneratedObservable: Observable<ProceduralTexture>;
  11863. /** @hidden */
  11864. _generateMipMaps: boolean;
  11865. /** @hidden **/
  11866. _effect: Effect;
  11867. /** @hidden */
  11868. _textures: {
  11869. [key: string]: Texture;
  11870. };
  11871. /** @hidden */
  11872. protected _fallbackTexture: Nullable<Texture>;
  11873. private _size;
  11874. private _currentRefreshId;
  11875. private _frameId;
  11876. private _refreshRate;
  11877. private _vertexBuffers;
  11878. private _indexBuffer;
  11879. private _uniforms;
  11880. private _samplers;
  11881. private _fragment;
  11882. private _floats;
  11883. private _ints;
  11884. private _floatsArrays;
  11885. private _colors3;
  11886. private _colors4;
  11887. private _vectors2;
  11888. private _vectors3;
  11889. private _matrices;
  11890. private _fallbackTextureUsed;
  11891. private _fullEngine;
  11892. private _cachedDefines;
  11893. private _contentUpdateId;
  11894. private _contentData;
  11895. /**
  11896. * Instantiates a new procedural texture.
  11897. * 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.
  11898. * This is the base class of any Procedural texture and contains most of the shareable code.
  11899. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  11900. * @param name Define the name of the texture
  11901. * @param size Define the size of the texture to create
  11902. * @param fragment Define the fragment shader to use to generate the texture or null if it is defined later
  11903. * @param scene Define the scene the texture belongs to
  11904. * @param fallbackTexture Define a fallback texture in case there were issues to create the custom texture
  11905. * @param generateMipMaps Define if the texture should creates mip maps or not
  11906. * @param isCube Define if the texture is a cube texture or not (this will render each faces of the cube)
  11907. */
  11908. constructor(name: string, size: any, fragment: any, scene: Nullable<Scene>, fallbackTexture?: Nullable<Texture>, generateMipMaps?: boolean, isCube?: boolean);
  11909. /**
  11910. * The effect that is created when initializing the post process.
  11911. * @returns The created effect corresponding the the postprocess.
  11912. */
  11913. getEffect(): Effect;
  11914. /**
  11915. * Gets texture content (Use this function wisely as reading from a texture can be slow)
  11916. * @returns an ArrayBufferView (Uint8Array or Float32Array)
  11917. */
  11918. getContent(): Nullable<ArrayBufferView>;
  11919. private _createIndexBuffer;
  11920. /** @hidden */
  11921. _rebuild(): void;
  11922. /**
  11923. * Resets the texture in order to recreate its associated resources.
  11924. * This can be called in case of context loss
  11925. */
  11926. reset(): void;
  11927. protected _getDefines(): string;
  11928. /**
  11929. * Is the texture ready to be used ? (rendered at least once)
  11930. * @returns true if ready, otherwise, false.
  11931. */
  11932. isReady(): boolean;
  11933. /**
  11934. * Resets the refresh counter of the texture and start bak from scratch.
  11935. * Could be useful to regenerate the texture if it is setup to render only once.
  11936. */
  11937. resetRefreshCounter(): void;
  11938. /**
  11939. * Set the fragment shader to use in order to render the texture.
  11940. * @param fragment This can be set to a path (into the shader store) or to a json object containing a fragmentElement property.
  11941. */
  11942. setFragment(fragment: any): void;
  11943. /**
  11944. * Define the refresh rate of the texture or the rendering frequency.
  11945. * Use 0 to render just once, 1 to render on every frame, 2 to render every two frames and so on...
  11946. */
  11947. get refreshRate(): number;
  11948. set refreshRate(value: number);
  11949. /** @hidden */
  11950. _shouldRender(): boolean;
  11951. /**
  11952. * Get the size the texture is rendering at.
  11953. * @returns the size (texture is always squared)
  11954. */
  11955. getRenderSize(): number;
  11956. /**
  11957. * Resize the texture to new value.
  11958. * @param size Define the new size the texture should have
  11959. * @param generateMipMaps Define whether the new texture should create mip maps
  11960. */
  11961. resize(size: number, generateMipMaps: boolean): void;
  11962. private _checkUniform;
  11963. /**
  11964. * Set a texture in the shader program used to render.
  11965. * @param name Define the name of the uniform samplers as defined in the shader
  11966. * @param texture Define the texture to bind to this sampler
  11967. * @return the texture itself allowing "fluent" like uniform updates
  11968. */
  11969. setTexture(name: string, texture: Texture): ProceduralTexture;
  11970. /**
  11971. * Set a float in the shader.
  11972. * @param name Define the name of the uniform as defined in the shader
  11973. * @param value Define the value to give to the uniform
  11974. * @return the texture itself allowing "fluent" like uniform updates
  11975. */
  11976. setFloat(name: string, value: number): ProceduralTexture;
  11977. /**
  11978. * Set a int in the shader.
  11979. * @param name Define the name of the uniform as defined in the shader
  11980. * @param value Define the value to give to the uniform
  11981. * @return the texture itself allowing "fluent" like uniform updates
  11982. */
  11983. setInt(name: string, value: number): ProceduralTexture;
  11984. /**
  11985. * Set an array of floats in the shader.
  11986. * @param name Define the name of the uniform as defined in the shader
  11987. * @param value Define the value to give to the uniform
  11988. * @return the texture itself allowing "fluent" like uniform updates
  11989. */
  11990. setFloats(name: string, value: number[]): ProceduralTexture;
  11991. /**
  11992. * Set a vec3 in the shader from a Color3.
  11993. * @param name Define the name of the uniform as defined in the shader
  11994. * @param value Define the value to give to the uniform
  11995. * @return the texture itself allowing "fluent" like uniform updates
  11996. */
  11997. setColor3(name: string, value: Color3): ProceduralTexture;
  11998. /**
  11999. * Set a vec4 in the shader from a Color4.
  12000. * @param name Define the name of the uniform as defined in the shader
  12001. * @param value Define the value to give to the uniform
  12002. * @return the texture itself allowing "fluent" like uniform updates
  12003. */
  12004. setColor4(name: string, value: Color4): ProceduralTexture;
  12005. /**
  12006. * Set a vec2 in the shader from a Vector2.
  12007. * @param name Define the name of the uniform as defined in the shader
  12008. * @param value Define the value to give to the uniform
  12009. * @return the texture itself allowing "fluent" like uniform updates
  12010. */
  12011. setVector2(name: string, value: Vector2): ProceduralTexture;
  12012. /**
  12013. * Set a vec3 in the shader from a Vector3.
  12014. * @param name Define the name of the uniform as defined in the shader
  12015. * @param value Define the value to give to the uniform
  12016. * @return the texture itself allowing "fluent" like uniform updates
  12017. */
  12018. setVector3(name: string, value: Vector3): ProceduralTexture;
  12019. /**
  12020. * Set a mat4 in the shader from a MAtrix.
  12021. * @param name Define the name of the uniform as defined in the shader
  12022. * @param value Define the value to give to the uniform
  12023. * @return the texture itself allowing "fluent" like uniform updates
  12024. */
  12025. setMatrix(name: string, value: Matrix): ProceduralTexture;
  12026. /**
  12027. * Render the texture to its associated render target.
  12028. * @param useCameraPostProcess Define if camera post process should be applied to the texture
  12029. */
  12030. render(useCameraPostProcess?: boolean): void;
  12031. /**
  12032. * Clone the texture.
  12033. * @returns the cloned texture
  12034. */
  12035. clone(): ProceduralTexture;
  12036. /**
  12037. * Dispose the texture and release its asoociated resources.
  12038. */
  12039. dispose(): void;
  12040. }
  12041. }
  12042. declare module "babylonjs/Particles/baseParticleSystem" {
  12043. import { Nullable } from "babylonjs/types";
  12044. import { Vector2, Vector3 } from "babylonjs/Maths/math.vector";
  12045. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  12046. import { ImageProcessingConfiguration, ImageProcessingConfigurationDefines } from "babylonjs/Materials/imageProcessingConfiguration";
  12047. import { ProceduralTexture } from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  12048. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  12049. import { Scene } from "babylonjs/scene";
  12050. import { ColorGradient, FactorGradient, Color3Gradient, IValueGradient } from "babylonjs/Misc/gradients";
  12051. import { BoxParticleEmitter, IParticleEmitterType, PointParticleEmitter, HemisphericParticleEmitter, SphereParticleEmitter, SphereDirectedParticleEmitter, CylinderParticleEmitter, CylinderDirectedParticleEmitter, ConeParticleEmitter } from "babylonjs/Particles/EmitterTypes/index";
  12052. import { Texture } from "babylonjs/Materials/Textures/texture";
  12053. import { Color4 } from "babylonjs/Maths/math.color";
  12054. import { Animation } from "babylonjs/Animations/animation";
  12055. /**
  12056. * This represents the base class for particle system in Babylon.
  12057. * 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.
  12058. * Particles can take different shapes while emitted like box, sphere, cone or you can write your custom function.
  12059. * @example https://doc.babylonjs.com/babylon101/particles
  12060. */
  12061. export class BaseParticleSystem {
  12062. /**
  12063. * Source color is added to the destination color without alpha affecting the result
  12064. */
  12065. static BLENDMODE_ONEONE: number;
  12066. /**
  12067. * Blend current color and particle color using particle’s alpha
  12068. */
  12069. static BLENDMODE_STANDARD: number;
  12070. /**
  12071. * Add current color and particle color multiplied by particle’s alpha
  12072. */
  12073. static BLENDMODE_ADD: number;
  12074. /**
  12075. * Multiply current color with particle color
  12076. */
  12077. static BLENDMODE_MULTIPLY: number;
  12078. /**
  12079. * Multiply current color with particle color then add current color and particle color multiplied by particle’s alpha
  12080. */
  12081. static BLENDMODE_MULTIPLYADD: number;
  12082. /**
  12083. * List of animations used by the particle system.
  12084. */
  12085. animations: Animation[];
  12086. /**
  12087. * Gets or sets the unique id of the particle system
  12088. */
  12089. uniqueId: number;
  12090. /**
  12091. * The id of the Particle system.
  12092. */
  12093. id: string;
  12094. /**
  12095. * The friendly name of the Particle system.
  12096. */
  12097. name: string;
  12098. /**
  12099. * Snippet ID if the particle system was created from the snippet server
  12100. */
  12101. snippetId: string;
  12102. /**
  12103. * The rendering group used by the Particle system to chose when to render.
  12104. */
  12105. renderingGroupId: number;
  12106. /**
  12107. * The emitter represents the Mesh or position we are attaching the particle system to.
  12108. */
  12109. emitter: Nullable<AbstractMesh | Vector3>;
  12110. /**
  12111. * The maximum number of particles to emit per frame
  12112. */
  12113. emitRate: number;
  12114. /**
  12115. * If you want to launch only a few particles at once, that can be done, as well.
  12116. */
  12117. manualEmitCount: number;
  12118. /**
  12119. * The overall motion speed (0.01 is default update speed, faster updates = faster animation)
  12120. */
  12121. updateSpeed: number;
  12122. /**
  12123. * The amount of time the particle system is running (depends of the overall update speed).
  12124. */
  12125. targetStopDuration: number;
  12126. /**
  12127. * Specifies whether the particle system will be disposed once it reaches the end of the animation.
  12128. */
  12129. disposeOnStop: boolean;
  12130. /**
  12131. * Minimum power of emitting particles.
  12132. */
  12133. minEmitPower: number;
  12134. /**
  12135. * Maximum power of emitting particles.
  12136. */
  12137. maxEmitPower: number;
  12138. /**
  12139. * Minimum life time of emitting particles.
  12140. */
  12141. minLifeTime: number;
  12142. /**
  12143. * Maximum life time of emitting particles.
  12144. */
  12145. maxLifeTime: number;
  12146. /**
  12147. * Minimum Size of emitting particles.
  12148. */
  12149. minSize: number;
  12150. /**
  12151. * Maximum Size of emitting particles.
  12152. */
  12153. maxSize: number;
  12154. /**
  12155. * Minimum scale of emitting particles on X axis.
  12156. */
  12157. minScaleX: number;
  12158. /**
  12159. * Maximum scale of emitting particles on X axis.
  12160. */
  12161. maxScaleX: number;
  12162. /**
  12163. * Minimum scale of emitting particles on Y axis.
  12164. */
  12165. minScaleY: number;
  12166. /**
  12167. * Maximum scale of emitting particles on Y axis.
  12168. */
  12169. maxScaleY: number;
  12170. /**
  12171. * Gets or sets the minimal initial rotation in radians.
  12172. */
  12173. minInitialRotation: number;
  12174. /**
  12175. * Gets or sets the maximal initial rotation in radians.
  12176. */
  12177. maxInitialRotation: number;
  12178. /**
  12179. * Minimum angular speed of emitting particles (Z-axis rotation for each particle).
  12180. */
  12181. minAngularSpeed: number;
  12182. /**
  12183. * Maximum angular speed of emitting particles (Z-axis rotation for each particle).
  12184. */
  12185. maxAngularSpeed: number;
  12186. /**
  12187. * The texture used to render each particle. (this can be a spritesheet)
  12188. */
  12189. particleTexture: Nullable<Texture>;
  12190. /**
  12191. * The layer mask we are rendering the particles through.
  12192. */
  12193. layerMask: number;
  12194. /**
  12195. * This can help using your own shader to render the particle system.
  12196. * The according effect will be created
  12197. */
  12198. customShader: any;
  12199. /**
  12200. * By default particle system starts as soon as they are created. This prevents the
  12201. * automatic start to happen and let you decide when to start emitting particles.
  12202. */
  12203. preventAutoStart: boolean;
  12204. private _noiseTexture;
  12205. /**
  12206. * Gets or sets a texture used to add random noise to particle positions
  12207. */
  12208. get noiseTexture(): Nullable<ProceduralTexture>;
  12209. set noiseTexture(value: Nullable<ProceduralTexture>);
  12210. /** Gets or sets the strength to apply to the noise value (default is (10, 10, 10)) */
  12211. noiseStrength: Vector3;
  12212. /**
  12213. * Callback triggered when the particle animation is ending.
  12214. */
  12215. onAnimationEnd: Nullable<() => void>;
  12216. /**
  12217. * Blend mode use to render the particle, it can be either ParticleSystem.BLENDMODE_ONEONE or ParticleSystem.BLENDMODE_STANDARD.
  12218. */
  12219. blendMode: number;
  12220. /**
  12221. * Forces the particle to write their depth information to the depth buffer. This can help preventing other draw calls
  12222. * to override the particles.
  12223. */
  12224. forceDepthWrite: boolean;
  12225. /** 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 */
  12226. preWarmCycles: number;
  12227. /** Gets or sets a value indicating the time step multiplier to use in pre-warm mode (default is 1) */
  12228. preWarmStepOffset: number;
  12229. /**
  12230. * 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)
  12231. */
  12232. spriteCellChangeSpeed: number;
  12233. /**
  12234. * If using a spritesheet (isAnimationSheetEnabled) defines the first sprite cell to display
  12235. */
  12236. startSpriteCellID: number;
  12237. /**
  12238. * If using a spritesheet (isAnimationSheetEnabled) defines the last sprite cell to display
  12239. */
  12240. endSpriteCellID: number;
  12241. /**
  12242. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell width to use
  12243. */
  12244. spriteCellWidth: number;
  12245. /**
  12246. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell height to use
  12247. */
  12248. spriteCellHeight: number;
  12249. /**
  12250. * This allows the system to random pick the start cell ID between startSpriteCellID and endSpriteCellID
  12251. */
  12252. spriteRandomStartCell: boolean;
  12253. /** Gets or sets a Vector2 used to move the pivot (by default (0,0)) */
  12254. translationPivot: Vector2;
  12255. /** @hidden */
  12256. protected _isAnimationSheetEnabled: boolean;
  12257. /**
  12258. * Gets or sets a boolean indicating that hosted animations (in the system.animations array) must be started when system.start() is called
  12259. */
  12260. beginAnimationOnStart: boolean;
  12261. /**
  12262. * Gets or sets the frame to start the animation from when beginAnimationOnStart is true
  12263. */
  12264. beginAnimationFrom: number;
  12265. /**
  12266. * Gets or sets the frame to end the animation on when beginAnimationOnStart is true
  12267. */
  12268. beginAnimationTo: number;
  12269. /**
  12270. * Gets or sets a boolean indicating if animations must loop when beginAnimationOnStart is true
  12271. */
  12272. beginAnimationLoop: boolean;
  12273. /**
  12274. * Gets or sets a world offset applied to all particles
  12275. */
  12276. worldOffset: Vector3;
  12277. /**
  12278. * Gets or sets whether an animation sprite sheet is enabled or not on the particle system
  12279. */
  12280. get isAnimationSheetEnabled(): boolean;
  12281. set isAnimationSheetEnabled(value: boolean);
  12282. /**
  12283. * Get hosting scene
  12284. * @returns the scene
  12285. */
  12286. getScene(): Scene;
  12287. /**
  12288. * You can use gravity if you want to give an orientation to your particles.
  12289. */
  12290. gravity: Vector3;
  12291. protected _colorGradients: Nullable<Array<ColorGradient>>;
  12292. protected _sizeGradients: Nullable<Array<FactorGradient>>;
  12293. protected _lifeTimeGradients: Nullable<Array<FactorGradient>>;
  12294. protected _angularSpeedGradients: Nullable<Array<FactorGradient>>;
  12295. protected _velocityGradients: Nullable<Array<FactorGradient>>;
  12296. protected _limitVelocityGradients: Nullable<Array<FactorGradient>>;
  12297. protected _dragGradients: Nullable<Array<FactorGradient>>;
  12298. protected _emitRateGradients: Nullable<Array<FactorGradient>>;
  12299. protected _startSizeGradients: Nullable<Array<FactorGradient>>;
  12300. protected _rampGradients: Nullable<Array<Color3Gradient>>;
  12301. protected _colorRemapGradients: Nullable<Array<FactorGradient>>;
  12302. protected _alphaRemapGradients: Nullable<Array<FactorGradient>>;
  12303. protected _hasTargetStopDurationDependantGradient(): boolean | null;
  12304. /**
  12305. * Defines the delay in milliseconds before starting the system (0 by default)
  12306. */
  12307. startDelay: number;
  12308. /**
  12309. * Gets the current list of drag gradients.
  12310. * You must use addDragGradient and removeDragGradient to udpate this list
  12311. * @returns the list of drag gradients
  12312. */
  12313. getDragGradients(): Nullable<Array<FactorGradient>>;
  12314. /** Gets or sets a value indicating the damping to apply if the limit velocity factor is reached */
  12315. limitVelocityDamping: number;
  12316. /**
  12317. * Gets the current list of limit velocity gradients.
  12318. * You must use addLimitVelocityGradient and removeLimitVelocityGradient to udpate this list
  12319. * @returns the list of limit velocity gradients
  12320. */
  12321. getLimitVelocityGradients(): Nullable<Array<FactorGradient>>;
  12322. /**
  12323. * Gets the current list of color gradients.
  12324. * You must use addColorGradient and removeColorGradient to udpate this list
  12325. * @returns the list of color gradients
  12326. */
  12327. getColorGradients(): Nullable<Array<ColorGradient>>;
  12328. /**
  12329. * Gets the current list of size gradients.
  12330. * You must use addSizeGradient and removeSizeGradient to udpate this list
  12331. * @returns the list of size gradients
  12332. */
  12333. getSizeGradients(): Nullable<Array<FactorGradient>>;
  12334. /**
  12335. * Gets the current list of color remap gradients.
  12336. * You must use addColorRemapGradient and removeColorRemapGradient to udpate this list
  12337. * @returns the list of color remap gradients
  12338. */
  12339. getColorRemapGradients(): Nullable<Array<FactorGradient>>;
  12340. /**
  12341. * Gets the current list of alpha remap gradients.
  12342. * You must use addAlphaRemapGradient and removeAlphaRemapGradient to udpate this list
  12343. * @returns the list of alpha remap gradients
  12344. */
  12345. getAlphaRemapGradients(): Nullable<Array<FactorGradient>>;
  12346. /**
  12347. * Gets the current list of life time gradients.
  12348. * You must use addLifeTimeGradient and removeLifeTimeGradient to udpate this list
  12349. * @returns the list of life time gradients
  12350. */
  12351. getLifeTimeGradients(): Nullable<Array<FactorGradient>>;
  12352. /**
  12353. * Gets the current list of angular speed gradients.
  12354. * You must use addAngularSpeedGradient and removeAngularSpeedGradient to udpate this list
  12355. * @returns the list of angular speed gradients
  12356. */
  12357. getAngularSpeedGradients(): Nullable<Array<FactorGradient>>;
  12358. /**
  12359. * Gets the current list of velocity gradients.
  12360. * You must use addVelocityGradient and removeVelocityGradient to udpate this list
  12361. * @returns the list of velocity gradients
  12362. */
  12363. getVelocityGradients(): Nullable<Array<FactorGradient>>;
  12364. /**
  12365. * Gets the current list of start size gradients.
  12366. * You must use addStartSizeGradient and removeStartSizeGradient to udpate this list
  12367. * @returns the list of start size gradients
  12368. */
  12369. getStartSizeGradients(): Nullable<Array<FactorGradient>>;
  12370. /**
  12371. * Gets the current list of emit rate gradients.
  12372. * You must use addEmitRateGradient and removeEmitRateGradient to udpate this list
  12373. * @returns the list of emit rate gradients
  12374. */
  12375. getEmitRateGradients(): Nullable<Array<FactorGradient>>;
  12376. /**
  12377. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  12378. * This only works when particleEmitterTyps is a BoxParticleEmitter
  12379. */
  12380. get direction1(): Vector3;
  12381. set direction1(value: Vector3);
  12382. /**
  12383. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  12384. * This only works when particleEmitterTyps is a BoxParticleEmitter
  12385. */
  12386. get direction2(): Vector3;
  12387. set direction2(value: Vector3);
  12388. /**
  12389. * 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.
  12390. * This only works when particleEmitterTyps is a BoxParticleEmitter
  12391. */
  12392. get minEmitBox(): Vector3;
  12393. set minEmitBox(value: Vector3);
  12394. /**
  12395. * 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.
  12396. * This only works when particleEmitterTyps is a BoxParticleEmitter
  12397. */
  12398. get maxEmitBox(): Vector3;
  12399. set maxEmitBox(value: Vector3);
  12400. /**
  12401. * Random color of each particle after it has been emitted, between color1 and color2 vectors
  12402. */
  12403. color1: Color4;
  12404. /**
  12405. * Random color of each particle after it has been emitted, between color1 and color2 vectors
  12406. */
  12407. color2: Color4;
  12408. /**
  12409. * Color the particle will have at the end of its lifetime
  12410. */
  12411. colorDead: Color4;
  12412. /**
  12413. * An optional mask to filter some colors out of the texture, or filter a part of the alpha channel
  12414. */
  12415. textureMask: Color4;
  12416. /**
  12417. * The particle emitter type defines the emitter used by the particle system.
  12418. * It can be for example box, sphere, or cone...
  12419. */
  12420. particleEmitterType: IParticleEmitterType;
  12421. /** @hidden */
  12422. _isSubEmitter: boolean;
  12423. /**
  12424. * Gets or sets the billboard mode to use when isBillboardBased = true.
  12425. * Value can be: ParticleSystem.BILLBOARDMODE_ALL, ParticleSystem.BILLBOARDMODE_Y, ParticleSystem.BILLBOARDMODE_STRETCHED
  12426. */
  12427. billboardMode: number;
  12428. protected _isBillboardBased: boolean;
  12429. /**
  12430. * Gets or sets a boolean indicating if the particles must be rendered as billboard or aligned with the direction
  12431. */
  12432. get isBillboardBased(): boolean;
  12433. set isBillboardBased(value: boolean);
  12434. /**
  12435. * The scene the particle system belongs to.
  12436. */
  12437. protected _scene: Scene;
  12438. /**
  12439. * Local cache of defines for image processing.
  12440. */
  12441. protected _imageProcessingConfigurationDefines: ImageProcessingConfigurationDefines;
  12442. /**
  12443. * Default configuration related to image processing available in the standard Material.
  12444. */
  12445. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  12446. /**
  12447. * Gets the image processing configuration used either in this material.
  12448. */
  12449. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  12450. /**
  12451. * Sets the Default image processing configuration used either in the this material.
  12452. *
  12453. * If sets to null, the scene one is in use.
  12454. */
  12455. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  12456. /**
  12457. * Attaches a new image processing configuration to the Standard Material.
  12458. * @param configuration
  12459. */
  12460. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  12461. /** @hidden */
  12462. protected _reset(): void;
  12463. /** @hidden */
  12464. protected _removeGradientAndTexture(gradient: number, gradients: Nullable<IValueGradient[]>, texture: Nullable<RawTexture>): BaseParticleSystem;
  12465. /**
  12466. * Instantiates a particle system.
  12467. * 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.
  12468. * @param name The name of the particle system
  12469. */
  12470. constructor(name: string);
  12471. /**
  12472. * Creates a Point Emitter for the particle system (emits directly from the emitter position)
  12473. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  12474. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  12475. * @returns the emitter
  12476. */
  12477. createPointEmitter(direction1: Vector3, direction2: Vector3): PointParticleEmitter;
  12478. /**
  12479. * Creates a Hemisphere Emitter for the particle system (emits along the hemisphere radius)
  12480. * @param radius The radius of the hemisphere to emit from
  12481. * @param radiusRange The range of the hemisphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  12482. * @returns the emitter
  12483. */
  12484. createHemisphericEmitter(radius?: number, radiusRange?: number): HemisphericParticleEmitter;
  12485. /**
  12486. * Creates a Sphere Emitter for the particle system (emits along the sphere radius)
  12487. * @param radius The radius of the sphere to emit from
  12488. * @param radiusRange The range of the sphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  12489. * @returns the emitter
  12490. */
  12491. createSphereEmitter(radius?: number, radiusRange?: number): SphereParticleEmitter;
  12492. /**
  12493. * Creates a Directed Sphere Emitter for the particle system (emits between direction1 and direction2)
  12494. * @param radius The radius of the sphere to emit from
  12495. * @param direction1 Particles are emitted between the direction1 and direction2 from within the sphere
  12496. * @param direction2 Particles are emitted between the direction1 and direction2 from within the sphere
  12497. * @returns the emitter
  12498. */
  12499. createDirectedSphereEmitter(radius?: number, direction1?: Vector3, direction2?: Vector3): SphereDirectedParticleEmitter;
  12500. /**
  12501. * Creates a Cylinder Emitter for the particle system (emits from the cylinder to the particle position)
  12502. * @param radius The radius of the emission cylinder
  12503. * @param height The height of the emission cylinder
  12504. * @param radiusRange The range of emission [0-1] 0 Surface only, 1 Entire Radius
  12505. * @param directionRandomizer How much to randomize the particle direction [0-1]
  12506. * @returns the emitter
  12507. */
  12508. createCylinderEmitter(radius?: number, height?: number, radiusRange?: number, directionRandomizer?: number): CylinderParticleEmitter;
  12509. /**
  12510. * Creates a Directed Cylinder Emitter for the particle system (emits between direction1 and direction2)
  12511. * @param radius The radius of the cylinder to emit from
  12512. * @param height The height of the emission cylinder
  12513. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  12514. * @param direction1 Particles are emitted between the direction1 and direction2 from within the cylinder
  12515. * @param direction2 Particles are emitted between the direction1 and direction2 from within the cylinder
  12516. * @returns the emitter
  12517. */
  12518. createDirectedCylinderEmitter(radius?: number, height?: number, radiusRange?: number, direction1?: Vector3, direction2?: Vector3): CylinderDirectedParticleEmitter;
  12519. /**
  12520. * Creates a Cone Emitter for the particle system (emits from the cone to the particle position)
  12521. * @param radius The radius of the cone to emit from
  12522. * @param angle The base angle of the cone
  12523. * @returns the emitter
  12524. */
  12525. createConeEmitter(radius?: number, angle?: number): ConeParticleEmitter;
  12526. /**
  12527. * Creates a Box Emitter for the particle system. (emits between direction1 and direction2 from withing the box defined by minEmitBox and maxEmitBox)
  12528. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  12529. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  12530. * @param minEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  12531. * @param maxEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  12532. * @returns the emitter
  12533. */
  12534. createBoxEmitter(direction1: Vector3, direction2: Vector3, minEmitBox: Vector3, maxEmitBox: Vector3): BoxParticleEmitter;
  12535. }
  12536. }
  12537. declare module "babylonjs/Particles/subEmitter" {
  12538. import { Scene } from "babylonjs/scene";
  12539. import { ParticleSystem } from "babylonjs/Particles/particleSystem";
  12540. /**
  12541. * Type of sub emitter
  12542. */
  12543. export enum SubEmitterType {
  12544. /**
  12545. * Attached to the particle over it's lifetime
  12546. */
  12547. ATTACHED = 0,
  12548. /**
  12549. * Created when the particle dies
  12550. */
  12551. END = 1
  12552. }
  12553. /**
  12554. * Sub emitter class used to emit particles from an existing particle
  12555. */
  12556. export class SubEmitter {
  12557. /**
  12558. * the particle system to be used by the sub emitter
  12559. */
  12560. particleSystem: ParticleSystem;
  12561. /**
  12562. * Type of the submitter (Default: END)
  12563. */
  12564. type: SubEmitterType;
  12565. /**
  12566. * 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)
  12567. * Note: This only is supported when using an emitter of type Mesh
  12568. */
  12569. inheritDirection: boolean;
  12570. /**
  12571. * How much of the attached particles speed should be added to the sub emitted particle (default: 0)
  12572. */
  12573. inheritedVelocityAmount: number;
  12574. /**
  12575. * Creates a sub emitter
  12576. * @param particleSystem the particle system to be used by the sub emitter
  12577. */
  12578. constructor(
  12579. /**
  12580. * the particle system to be used by the sub emitter
  12581. */
  12582. particleSystem: ParticleSystem);
  12583. /**
  12584. * Clones the sub emitter
  12585. * @returns the cloned sub emitter
  12586. */
  12587. clone(): SubEmitter;
  12588. /**
  12589. * Serialize current object to a JSON object
  12590. * @returns the serialized object
  12591. */
  12592. serialize(): any;
  12593. /** @hidden */
  12594. static _ParseParticleSystem(system: any, scene: Scene, rootUrl: string): ParticleSystem;
  12595. /**
  12596. * Creates a new SubEmitter from a serialized JSON version
  12597. * @param serializationObject defines the JSON object to read from
  12598. * @param scene defines the hosting scene
  12599. * @param rootUrl defines the rootUrl for data loading
  12600. * @returns a new SubEmitter
  12601. */
  12602. static Parse(serializationObject: any, scene: Scene, rootUrl: string): SubEmitter;
  12603. /** Release associated resources */
  12604. dispose(): void;
  12605. }
  12606. }
  12607. declare module "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration" {
  12608. /** @hidden */
  12609. export var imageProcessingDeclaration: {
  12610. name: string;
  12611. shader: string;
  12612. };
  12613. }
  12614. declare module "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions" {
  12615. /** @hidden */
  12616. export var imageProcessingFunctions: {
  12617. name: string;
  12618. shader: string;
  12619. };
  12620. }
  12621. declare module "babylonjs/Shaders/particles.fragment" {
  12622. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  12623. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  12624. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  12625. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  12626. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  12627. /** @hidden */
  12628. export var particlesPixelShader: {
  12629. name: string;
  12630. shader: string;
  12631. };
  12632. }
  12633. declare module "babylonjs/Shaders/particles.vertex" {
  12634. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  12635. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  12636. /** @hidden */
  12637. export var particlesVertexShader: {
  12638. name: string;
  12639. shader: string;
  12640. };
  12641. }
  12642. declare module "babylonjs/Particles/particleSystem" {
  12643. import { Nullable } from "babylonjs/types";
  12644. import { FactorGradient, Color3Gradient } from "babylonjs/Misc/gradients";
  12645. import { Observable } from "babylonjs/Misc/observable";
  12646. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  12647. import { Effect } from "babylonjs/Materials/effect";
  12648. import { Scene, IDisposable } from "babylonjs/scene";
  12649. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  12650. import { BaseParticleSystem } from "babylonjs/Particles/baseParticleSystem";
  12651. import { Particle } from "babylonjs/Particles/particle";
  12652. import { SubEmitter } from "babylonjs/Particles/subEmitter";
  12653. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  12654. import "babylonjs/Shaders/particles.fragment";
  12655. import "babylonjs/Shaders/particles.vertex";
  12656. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  12657. /**
  12658. * This represents a particle system in Babylon.
  12659. * 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.
  12660. * Particles can take different shapes while emitted like box, sphere, cone or you can write your custom function.
  12661. * @example https://doc.babylonjs.com/babylon101/particles
  12662. */
  12663. export class ParticleSystem extends BaseParticleSystem implements IDisposable, IAnimatable, IParticleSystem {
  12664. /**
  12665. * Billboard mode will only apply to Y axis
  12666. */
  12667. static readonly BILLBOARDMODE_Y: number;
  12668. /**
  12669. * Billboard mode will apply to all axes
  12670. */
  12671. static readonly BILLBOARDMODE_ALL: number;
  12672. /**
  12673. * Special billboard mode where the particle will be biilboard to the camera but rotated to align with direction
  12674. */
  12675. static readonly BILLBOARDMODE_STRETCHED: number;
  12676. /**
  12677. * This function can be defined to provide custom update for active particles.
  12678. * This function will be called instead of regular update (age, position, color, etc.).
  12679. * Do not forget that this function will be called on every frame so try to keep it simple and fast :)
  12680. */
  12681. updateFunction: (particles: Particle[]) => void;
  12682. private _emitterWorldMatrix;
  12683. /**
  12684. * This function can be defined to specify initial direction for every new particle.
  12685. * It by default use the emitterType defined function
  12686. */
  12687. startDirectionFunction: (worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean) => void;
  12688. /**
  12689. * This function can be defined to specify initial position for every new particle.
  12690. * It by default use the emitterType defined function
  12691. */
  12692. startPositionFunction: (worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean) => void;
  12693. /**
  12694. * @hidden
  12695. */
  12696. _inheritedVelocityOffset: Vector3;
  12697. /**
  12698. * An event triggered when the system is disposed
  12699. */
  12700. onDisposeObservable: Observable<IParticleSystem>;
  12701. private _onDisposeObserver;
  12702. /**
  12703. * Sets a callback that will be triggered when the system is disposed
  12704. */
  12705. set onDispose(callback: () => void);
  12706. private _particles;
  12707. private _epsilon;
  12708. private _capacity;
  12709. private _stockParticles;
  12710. private _newPartsExcess;
  12711. private _vertexData;
  12712. private _vertexBuffer;
  12713. private _vertexBuffers;
  12714. private _spriteBuffer;
  12715. private _indexBuffer;
  12716. private _effect;
  12717. private _customEffect;
  12718. private _cachedDefines;
  12719. private _scaledColorStep;
  12720. private _colorDiff;
  12721. private _scaledDirection;
  12722. private _scaledGravity;
  12723. private _currentRenderId;
  12724. private _alive;
  12725. private _useInstancing;
  12726. private _started;
  12727. private _stopped;
  12728. private _actualFrame;
  12729. private _scaledUpdateSpeed;
  12730. private _vertexBufferSize;
  12731. /** @hidden */
  12732. _currentEmitRateGradient: Nullable<FactorGradient>;
  12733. /** @hidden */
  12734. _currentEmitRate1: number;
  12735. /** @hidden */
  12736. _currentEmitRate2: number;
  12737. /** @hidden */
  12738. _currentStartSizeGradient: Nullable<FactorGradient>;
  12739. /** @hidden */
  12740. _currentStartSize1: number;
  12741. /** @hidden */
  12742. _currentStartSize2: number;
  12743. private readonly _rawTextureWidth;
  12744. private _rampGradientsTexture;
  12745. private _useRampGradients;
  12746. /** Gets or sets a boolean indicating that ramp gradients must be used
  12747. * @see https://doc.babylonjs.com/babylon101/particles#ramp-gradients
  12748. */
  12749. get useRampGradients(): boolean;
  12750. set useRampGradients(value: boolean);
  12751. /**
  12752. * 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.
  12753. * 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: [])
  12754. */
  12755. subEmitters: Array<ParticleSystem | SubEmitter | Array<SubEmitter>>;
  12756. private _subEmitters;
  12757. /**
  12758. * @hidden
  12759. * If the particle systems emitter should be disposed when the particle system is disposed
  12760. */
  12761. _disposeEmitterOnDispose: boolean;
  12762. /**
  12763. * The current active Sub-systems, this property is used by the root particle system only.
  12764. */
  12765. activeSubSystems: Array<ParticleSystem>;
  12766. /**
  12767. * Specifies if the particles are updated in emitter local space or world space
  12768. */
  12769. isLocal: boolean;
  12770. private _rootParticleSystem;
  12771. /**
  12772. * Gets the current list of active particles
  12773. */
  12774. get particles(): Particle[];
  12775. /**
  12776. * Gets the number of particles active at the same time.
  12777. * @returns The number of active particles.
  12778. */
  12779. getActiveCount(): number;
  12780. /**
  12781. * Returns the string "ParticleSystem"
  12782. * @returns a string containing the class name
  12783. */
  12784. getClassName(): string;
  12785. /**
  12786. * Gets a boolean indicating that the system is stopping
  12787. * @returns true if the system is currently stopping
  12788. */
  12789. isStopping(): boolean;
  12790. /**
  12791. * Gets the custom effect used to render the particles
  12792. * @param blendMode Blend mode for which the effect should be retrieved
  12793. * @returns The effect
  12794. */
  12795. getCustomEffect(blendMode?: number): Nullable<Effect>;
  12796. /**
  12797. * Sets the custom effect used to render the particles
  12798. * @param effect The effect to set
  12799. * @param blendMode Blend mode for which the effect should be set
  12800. */
  12801. setCustomEffect(effect: Nullable<Effect>, blendMode?: number): void;
  12802. /** @hidden */
  12803. private _onBeforeDrawParticlesObservable;
  12804. /**
  12805. * Observable that will be called just before the particles are drawn
  12806. */
  12807. get onBeforeDrawParticlesObservable(): Observable<Nullable<Effect>>;
  12808. /**
  12809. * Gets the name of the particle vertex shader
  12810. */
  12811. get vertexShaderName(): string;
  12812. /**
  12813. * Instantiates a particle system.
  12814. * 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.
  12815. * @param name The name of the particle system
  12816. * @param capacity The max number of particles alive at the same time
  12817. * @param scene The scene the particle system belongs to
  12818. * @param customEffect a custom effect used to change the way particles are rendered by default
  12819. * @param isAnimationSheetEnabled Must be true if using a spritesheet to animate the particles texture
  12820. * @param epsilon Offset used to render the particles
  12821. */
  12822. constructor(name: string, capacity: number, scene: Scene, customEffect?: Nullable<Effect>, isAnimationSheetEnabled?: boolean, epsilon?: number);
  12823. private _addFactorGradient;
  12824. private _removeFactorGradient;
  12825. /**
  12826. * Adds a new life time gradient
  12827. * @param gradient defines the gradient to use (between 0 and 1)
  12828. * @param factor defines the life time factor to affect to the specified gradient
  12829. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  12830. * @returns the current particle system
  12831. */
  12832. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  12833. /**
  12834. * Remove a specific life time gradient
  12835. * @param gradient defines the gradient to remove
  12836. * @returns the current particle system
  12837. */
  12838. removeLifeTimeGradient(gradient: number): IParticleSystem;
  12839. /**
  12840. * Adds a new size gradient
  12841. * @param gradient defines the gradient to use (between 0 and 1)
  12842. * @param factor defines the size factor to affect to the specified gradient
  12843. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  12844. * @returns the current particle system
  12845. */
  12846. addSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  12847. /**
  12848. * Remove a specific size gradient
  12849. * @param gradient defines the gradient to remove
  12850. * @returns the current particle system
  12851. */
  12852. removeSizeGradient(gradient: number): IParticleSystem;
  12853. /**
  12854. * Adds a new color remap gradient
  12855. * @param gradient defines the gradient to use (between 0 and 1)
  12856. * @param min defines the color remap minimal range
  12857. * @param max defines the color remap maximal range
  12858. * @returns the current particle system
  12859. */
  12860. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  12861. /**
  12862. * Remove a specific color remap gradient
  12863. * @param gradient defines the gradient to remove
  12864. * @returns the current particle system
  12865. */
  12866. removeColorRemapGradient(gradient: number): IParticleSystem;
  12867. /**
  12868. * Adds a new alpha remap gradient
  12869. * @param gradient defines the gradient to use (between 0 and 1)
  12870. * @param min defines the alpha remap minimal range
  12871. * @param max defines the alpha remap maximal range
  12872. * @returns the current particle system
  12873. */
  12874. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  12875. /**
  12876. * Remove a specific alpha remap gradient
  12877. * @param gradient defines the gradient to remove
  12878. * @returns the current particle system
  12879. */
  12880. removeAlphaRemapGradient(gradient: number): IParticleSystem;
  12881. /**
  12882. * Adds a new angular speed gradient
  12883. * @param gradient defines the gradient to use (between 0 and 1)
  12884. * @param factor defines the angular speed to affect to the specified gradient
  12885. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  12886. * @returns the current particle system
  12887. */
  12888. addAngularSpeedGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  12889. /**
  12890. * Remove a specific angular speed gradient
  12891. * @param gradient defines the gradient to remove
  12892. * @returns the current particle system
  12893. */
  12894. removeAngularSpeedGradient(gradient: number): IParticleSystem;
  12895. /**
  12896. * Adds a new velocity gradient
  12897. * @param gradient defines the gradient to use (between 0 and 1)
  12898. * @param factor defines the velocity to affect to the specified gradient
  12899. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  12900. * @returns the current particle system
  12901. */
  12902. addVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  12903. /**
  12904. * Remove a specific velocity gradient
  12905. * @param gradient defines the gradient to remove
  12906. * @returns the current particle system
  12907. */
  12908. removeVelocityGradient(gradient: number): IParticleSystem;
  12909. /**
  12910. * Adds a new limit velocity gradient
  12911. * @param gradient defines the gradient to use (between 0 and 1)
  12912. * @param factor defines the limit velocity value to affect to the specified gradient
  12913. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  12914. * @returns the current particle system
  12915. */
  12916. addLimitVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  12917. /**
  12918. * Remove a specific limit velocity gradient
  12919. * @param gradient defines the gradient to remove
  12920. * @returns the current particle system
  12921. */
  12922. removeLimitVelocityGradient(gradient: number): IParticleSystem;
  12923. /**
  12924. * Adds a new drag gradient
  12925. * @param gradient defines the gradient to use (between 0 and 1)
  12926. * @param factor defines the drag value to affect to the specified gradient
  12927. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  12928. * @returns the current particle system
  12929. */
  12930. addDragGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  12931. /**
  12932. * Remove a specific drag gradient
  12933. * @param gradient defines the gradient to remove
  12934. * @returns the current particle system
  12935. */
  12936. removeDragGradient(gradient: number): IParticleSystem;
  12937. /**
  12938. * Adds a new emit rate gradient (please note that this will only work if you set the targetStopDuration property)
  12939. * @param gradient defines the gradient to use (between 0 and 1)
  12940. * @param factor defines the emit rate value to affect to the specified gradient
  12941. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  12942. * @returns the current particle system
  12943. */
  12944. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  12945. /**
  12946. * Remove a specific emit rate gradient
  12947. * @param gradient defines the gradient to remove
  12948. * @returns the current particle system
  12949. */
  12950. removeEmitRateGradient(gradient: number): IParticleSystem;
  12951. /**
  12952. * Adds a new start size gradient (please note that this will only work if you set the targetStopDuration property)
  12953. * @param gradient defines the gradient to use (between 0 and 1)
  12954. * @param factor defines the start size value to affect to the specified gradient
  12955. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  12956. * @returns the current particle system
  12957. */
  12958. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  12959. /**
  12960. * Remove a specific start size gradient
  12961. * @param gradient defines the gradient to remove
  12962. * @returns the current particle system
  12963. */
  12964. removeStartSizeGradient(gradient: number): IParticleSystem;
  12965. private _createRampGradientTexture;
  12966. /**
  12967. * Gets the current list of ramp gradients.
  12968. * You must use addRampGradient and removeRampGradient to udpate this list
  12969. * @returns the list of ramp gradients
  12970. */
  12971. getRampGradients(): Nullable<Array<Color3Gradient>>;
  12972. /** Force the system to rebuild all gradients that need to be resync */
  12973. forceRefreshGradients(): void;
  12974. private _syncRampGradientTexture;
  12975. /**
  12976. * Adds a new ramp gradient used to remap particle colors
  12977. * @param gradient defines the gradient to use (between 0 and 1)
  12978. * @param color defines the color to affect to the specified gradient
  12979. * @returns the current particle system
  12980. */
  12981. addRampGradient(gradient: number, color: Color3): ParticleSystem;
  12982. /**
  12983. * Remove a specific ramp gradient
  12984. * @param gradient defines the gradient to remove
  12985. * @returns the current particle system
  12986. */
  12987. removeRampGradient(gradient: number): ParticleSystem;
  12988. /**
  12989. * Adds a new color gradient
  12990. * @param gradient defines the gradient to use (between 0 and 1)
  12991. * @param color1 defines the color to affect to the specified gradient
  12992. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  12993. * @returns this particle system
  12994. */
  12995. addColorGradient(gradient: number, color1: Color4, color2?: Color4): IParticleSystem;
  12996. /**
  12997. * Remove a specific color gradient
  12998. * @param gradient defines the gradient to remove
  12999. * @returns this particle system
  13000. */
  13001. removeColorGradient(gradient: number): IParticleSystem;
  13002. private _fetchR;
  13003. protected _reset(): void;
  13004. private _resetEffect;
  13005. private _createVertexBuffers;
  13006. private _createIndexBuffer;
  13007. /**
  13008. * Gets the maximum number of particles active at the same time.
  13009. * @returns The max number of active particles.
  13010. */
  13011. getCapacity(): number;
  13012. /**
  13013. * Gets whether there are still active particles in the system.
  13014. * @returns True if it is alive, otherwise false.
  13015. */
  13016. isAlive(): boolean;
  13017. /**
  13018. * Gets if the system has been started. (Note: this will still be true after stop is called)
  13019. * @returns True if it has been started, otherwise false.
  13020. */
  13021. isStarted(): boolean;
  13022. private _prepareSubEmitterInternalArray;
  13023. /**
  13024. * Starts the particle system and begins to emit
  13025. * @param delay defines the delay in milliseconds before starting the system (this.startDelay by default)
  13026. */
  13027. start(delay?: number): void;
  13028. /**
  13029. * Stops the particle system.
  13030. * @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.
  13031. */
  13032. stop(stopSubEmitters?: boolean): void;
  13033. /**
  13034. * Remove all active particles
  13035. */
  13036. reset(): void;
  13037. /**
  13038. * @hidden (for internal use only)
  13039. */
  13040. _appendParticleVertex(index: number, particle: Particle, offsetX: number, offsetY: number): void;
  13041. /**
  13042. * "Recycles" one of the particle by copying it back to the "stock" of particles and removing it from the active list.
  13043. * Its lifetime will start back at 0.
  13044. */
  13045. recycleParticle: (particle: Particle) => void;
  13046. private _stopSubEmitters;
  13047. private _createParticle;
  13048. private _removeFromRoot;
  13049. private _emitFromParticle;
  13050. private _update;
  13051. /** @hidden */
  13052. static _GetAttributeNamesOrOptions(isAnimationSheetEnabled?: boolean, isBillboardBased?: boolean, useRampGradients?: boolean): string[];
  13053. /** @hidden */
  13054. static _GetEffectCreationOptions(isAnimationSheetEnabled?: boolean): string[];
  13055. /**
  13056. * Fill the defines array according to the current settings of the particle system
  13057. * @param defines Array to be updated
  13058. * @param blendMode blend mode to take into account when updating the array
  13059. */
  13060. fillDefines(defines: Array<string>, blendMode: number): void;
  13061. /**
  13062. * Fill the uniforms, attributes and samplers arrays according to the current settings of the particle system
  13063. * @param uniforms Uniforms array to fill
  13064. * @param attributes Attributes array to fill
  13065. * @param samplers Samplers array to fill
  13066. */
  13067. fillUniformsAttributesAndSamplerNames(uniforms: Array<string>, attributes: Array<string>, samplers: Array<string>): void;
  13068. /** @hidden */
  13069. private _getEffect;
  13070. /**
  13071. * Animates the particle system for the current frame by emitting new particles and or animating the living ones.
  13072. * @param preWarmOnly will prevent the system from updating the vertex buffer (default is false)
  13073. */
  13074. animate(preWarmOnly?: boolean): void;
  13075. private _appendParticleVertices;
  13076. /**
  13077. * Rebuilds the particle system.
  13078. */
  13079. rebuild(): void;
  13080. /**
  13081. * Is this system ready to be used/rendered
  13082. * @return true if the system is ready
  13083. */
  13084. isReady(): boolean;
  13085. private _render;
  13086. /**
  13087. * Renders the particle system in its current state.
  13088. * @returns the current number of particles
  13089. */
  13090. render(): number;
  13091. /**
  13092. * Disposes the particle system and free the associated resources
  13093. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  13094. */
  13095. dispose(disposeTexture?: boolean): void;
  13096. /**
  13097. * Clones the particle system.
  13098. * @param name The name of the cloned object
  13099. * @param newEmitter The new emitter to use
  13100. * @returns the cloned particle system
  13101. */
  13102. clone(name: string, newEmitter: any): ParticleSystem;
  13103. /**
  13104. * Serializes the particle system to a JSON object
  13105. * @param serializeTexture defines if the texture must be serialized as well
  13106. * @returns the JSON object
  13107. */
  13108. serialize(serializeTexture?: boolean): any;
  13109. /** @hidden */
  13110. static _Serialize(serializationObject: any, particleSystem: IParticleSystem, serializeTexture: boolean): void;
  13111. /** @hidden */
  13112. static _Parse(parsedParticleSystem: any, particleSystem: IParticleSystem, scene: Scene, rootUrl: string): void;
  13113. /**
  13114. * Parses a JSON object to create a particle system.
  13115. * @param parsedParticleSystem The JSON object to parse
  13116. * @param scene The scene to create the particle system in
  13117. * @param rootUrl The root url to use to load external dependencies like texture
  13118. * @param doNotStart Ignore the preventAutoStart attribute and does not start
  13119. * @returns the Parsed particle system
  13120. */
  13121. static Parse(parsedParticleSystem: any, scene: Scene, rootUrl: string, doNotStart?: boolean): ParticleSystem;
  13122. }
  13123. }
  13124. declare module "babylonjs/Particles/particle" {
  13125. import { Nullable } from "babylonjs/types";
  13126. import { Vector2, Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  13127. import { Color4 } from "babylonjs/Maths/math.color";
  13128. import { ParticleSystem } from "babylonjs/Particles/particleSystem";
  13129. import { SubEmitter } from "babylonjs/Particles/subEmitter";
  13130. import { ColorGradient, FactorGradient } from "babylonjs/Misc/gradients";
  13131. /**
  13132. * A particle represents one of the element emitted by a particle system.
  13133. * This is mainly define by its coordinates, direction, velocity and age.
  13134. */
  13135. export class Particle {
  13136. /**
  13137. * The particle system the particle belongs to.
  13138. */
  13139. particleSystem: ParticleSystem;
  13140. private static _Count;
  13141. /**
  13142. * Unique ID of the particle
  13143. */
  13144. id: number;
  13145. /**
  13146. * The world position of the particle in the scene.
  13147. */
  13148. position: Vector3;
  13149. /**
  13150. * The world direction of the particle in the scene.
  13151. */
  13152. direction: Vector3;
  13153. /**
  13154. * The color of the particle.
  13155. */
  13156. color: Color4;
  13157. /**
  13158. * The color change of the particle per step.
  13159. */
  13160. colorStep: Color4;
  13161. /**
  13162. * Defines how long will the life of the particle be.
  13163. */
  13164. lifeTime: number;
  13165. /**
  13166. * The current age of the particle.
  13167. */
  13168. age: number;
  13169. /**
  13170. * The current size of the particle.
  13171. */
  13172. size: number;
  13173. /**
  13174. * The current scale of the particle.
  13175. */
  13176. scale: Vector2;
  13177. /**
  13178. * The current angle of the particle.
  13179. */
  13180. angle: number;
  13181. /**
  13182. * Defines how fast is the angle changing.
  13183. */
  13184. angularSpeed: number;
  13185. /**
  13186. * Defines the cell index used by the particle to be rendered from a sprite.
  13187. */
  13188. cellIndex: number;
  13189. /**
  13190. * The information required to support color remapping
  13191. */
  13192. remapData: Vector4;
  13193. /** @hidden */
  13194. _randomCellOffset?: number;
  13195. /** @hidden */
  13196. _initialDirection: Nullable<Vector3>;
  13197. /** @hidden */
  13198. _attachedSubEmitters: Nullable<Array<SubEmitter>>;
  13199. /** @hidden */
  13200. _initialStartSpriteCellID: number;
  13201. /** @hidden */
  13202. _initialEndSpriteCellID: number;
  13203. /** @hidden */
  13204. _currentColorGradient: Nullable<ColorGradient>;
  13205. /** @hidden */
  13206. _currentColor1: Color4;
  13207. /** @hidden */
  13208. _currentColor2: Color4;
  13209. /** @hidden */
  13210. _currentSizeGradient: Nullable<FactorGradient>;
  13211. /** @hidden */
  13212. _currentSize1: number;
  13213. /** @hidden */
  13214. _currentSize2: number;
  13215. /** @hidden */
  13216. _currentAngularSpeedGradient: Nullable<FactorGradient>;
  13217. /** @hidden */
  13218. _currentAngularSpeed1: number;
  13219. /** @hidden */
  13220. _currentAngularSpeed2: number;
  13221. /** @hidden */
  13222. _currentVelocityGradient: Nullable<FactorGradient>;
  13223. /** @hidden */
  13224. _currentVelocity1: number;
  13225. /** @hidden */
  13226. _currentVelocity2: number;
  13227. /** @hidden */
  13228. _currentLimitVelocityGradient: Nullable<FactorGradient>;
  13229. /** @hidden */
  13230. _currentLimitVelocity1: number;
  13231. /** @hidden */
  13232. _currentLimitVelocity2: number;
  13233. /** @hidden */
  13234. _currentDragGradient: Nullable<FactorGradient>;
  13235. /** @hidden */
  13236. _currentDrag1: number;
  13237. /** @hidden */
  13238. _currentDrag2: number;
  13239. /** @hidden */
  13240. _randomNoiseCoordinates1: Vector3;
  13241. /** @hidden */
  13242. _randomNoiseCoordinates2: Vector3;
  13243. /** @hidden */
  13244. _localPosition?: Vector3;
  13245. /**
  13246. * Creates a new instance Particle
  13247. * @param particleSystem the particle system the particle belongs to
  13248. */
  13249. constructor(
  13250. /**
  13251. * The particle system the particle belongs to.
  13252. */
  13253. particleSystem: ParticleSystem);
  13254. private updateCellInfoFromSystem;
  13255. /**
  13256. * Defines how the sprite cell index is updated for the particle
  13257. */
  13258. updateCellIndex(): void;
  13259. /** @hidden */
  13260. _inheritParticleInfoToSubEmitter(subEmitter: SubEmitter): void;
  13261. /** @hidden */
  13262. _inheritParticleInfoToSubEmitters(): void;
  13263. /** @hidden */
  13264. _reset(): void;
  13265. /**
  13266. * Copy the properties of particle to another one.
  13267. * @param other the particle to copy the information to.
  13268. */
  13269. copyTo(other: Particle): void;
  13270. }
  13271. }
  13272. declare module "babylonjs/Particles/EmitterTypes/IParticleEmitterType" {
  13273. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  13274. import { Effect } from "babylonjs/Materials/effect";
  13275. import { Particle } from "babylonjs/Particles/particle";
  13276. import { Scene } from "babylonjs/scene";
  13277. /**
  13278. * Particle emitter represents a volume emitting particles.
  13279. * This is the responsibility of the implementation to define the volume shape like cone/sphere/box.
  13280. */
  13281. export interface IParticleEmitterType {
  13282. /**
  13283. * Called by the particle System when the direction is computed for the created particle.
  13284. * @param worldMatrix is the world matrix of the particle system
  13285. * @param directionToUpdate is the direction vector to update with the result
  13286. * @param particle is the particle we are computed the direction for
  13287. * @param isLocal defines if the direction should be set in local space
  13288. */
  13289. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13290. /**
  13291. * Called by the particle System when the position is computed for the created particle.
  13292. * @param worldMatrix is the world matrix of the particle system
  13293. * @param positionToUpdate is the position vector to update with the result
  13294. * @param particle is the particle we are computed the position for
  13295. * @param isLocal defines if the position should be set in local space
  13296. */
  13297. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13298. /**
  13299. * Clones the current emitter and returns a copy of it
  13300. * @returns the new emitter
  13301. */
  13302. clone(): IParticleEmitterType;
  13303. /**
  13304. * Called by the GPUParticleSystem to setup the update shader
  13305. * @param effect defines the update shader
  13306. */
  13307. applyToShader(effect: Effect): void;
  13308. /**
  13309. * Returns a string to use to update the GPU particles update shader
  13310. * @returns the effect defines string
  13311. */
  13312. getEffectDefines(): string;
  13313. /**
  13314. * Returns a string representing the class name
  13315. * @returns a string containing the class name
  13316. */
  13317. getClassName(): string;
  13318. /**
  13319. * Serializes the particle system to a JSON object.
  13320. * @returns the JSON object
  13321. */
  13322. serialize(): any;
  13323. /**
  13324. * Parse properties from a JSON object
  13325. * @param serializationObject defines the JSON object
  13326. * @param scene defines the hosting scene
  13327. */
  13328. parse(serializationObject: any, scene: Scene): void;
  13329. }
  13330. }
  13331. declare module "babylonjs/Particles/EmitterTypes/boxParticleEmitter" {
  13332. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  13333. import { Effect } from "babylonjs/Materials/effect";
  13334. import { Particle } from "babylonjs/Particles/particle";
  13335. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  13336. /**
  13337. * Particle emitter emitting particles from the inside of a box.
  13338. * It emits the particles randomly between 2 given directions.
  13339. */
  13340. export class BoxParticleEmitter implements IParticleEmitterType {
  13341. /**
  13342. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  13343. */
  13344. direction1: Vector3;
  13345. /**
  13346. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  13347. */
  13348. direction2: Vector3;
  13349. /**
  13350. * 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.
  13351. */
  13352. minEmitBox: Vector3;
  13353. /**
  13354. * 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.
  13355. */
  13356. maxEmitBox: Vector3;
  13357. /**
  13358. * Creates a new instance BoxParticleEmitter
  13359. */
  13360. constructor();
  13361. /**
  13362. * Called by the particle System when the direction is computed for the created particle.
  13363. * @param worldMatrix is the world matrix of the particle system
  13364. * @param directionToUpdate is the direction vector to update with the result
  13365. * @param particle is the particle we are computed the direction for
  13366. * @param isLocal defines if the direction should be set in local space
  13367. */
  13368. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13369. /**
  13370. * Called by the particle System when the position is computed for the created particle.
  13371. * @param worldMatrix is the world matrix of the particle system
  13372. * @param positionToUpdate is the position vector to update with the result
  13373. * @param particle is the particle we are computed the position for
  13374. * @param isLocal defines if the position should be set in local space
  13375. */
  13376. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13377. /**
  13378. * Clones the current emitter and returns a copy of it
  13379. * @returns the new emitter
  13380. */
  13381. clone(): BoxParticleEmitter;
  13382. /**
  13383. * Called by the GPUParticleSystem to setup the update shader
  13384. * @param effect defines the update shader
  13385. */
  13386. applyToShader(effect: Effect): void;
  13387. /**
  13388. * Returns a string to use to update the GPU particles update shader
  13389. * @returns a string containng the defines string
  13390. */
  13391. getEffectDefines(): string;
  13392. /**
  13393. * Returns the string "BoxParticleEmitter"
  13394. * @returns a string containing the class name
  13395. */
  13396. getClassName(): string;
  13397. /**
  13398. * Serializes the particle system to a JSON object.
  13399. * @returns the JSON object
  13400. */
  13401. serialize(): any;
  13402. /**
  13403. * Parse properties from a JSON object
  13404. * @param serializationObject defines the JSON object
  13405. */
  13406. parse(serializationObject: any): void;
  13407. }
  13408. }
  13409. declare module "babylonjs/Particles/EmitterTypes/coneParticleEmitter" {
  13410. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  13411. import { Effect } from "babylonjs/Materials/effect";
  13412. import { Particle } from "babylonjs/Particles/particle";
  13413. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  13414. /**
  13415. * Particle emitter emitting particles from the inside of a cone.
  13416. * It emits the particles alongside the cone volume from the base to the particle.
  13417. * The emission direction might be randomized.
  13418. */
  13419. export class ConeParticleEmitter implements IParticleEmitterType {
  13420. /** defines how much to randomize the particle direction [0-1] (default is 0) */
  13421. directionRandomizer: number;
  13422. private _radius;
  13423. private _angle;
  13424. private _height;
  13425. /**
  13426. * Gets or sets a value indicating where on the radius the start position should be picked (1 = everywhere, 0 = only surface)
  13427. */
  13428. radiusRange: number;
  13429. /**
  13430. * Gets or sets a value indicating where on the height the start position should be picked (1 = everywhere, 0 = only surface)
  13431. */
  13432. heightRange: number;
  13433. /**
  13434. * Gets or sets a value indicating if all the particles should be emitted from the spawn point only (the base of the cone)
  13435. */
  13436. emitFromSpawnPointOnly: boolean;
  13437. /**
  13438. * Gets or sets the radius of the emission cone
  13439. */
  13440. get radius(): number;
  13441. set radius(value: number);
  13442. /**
  13443. * Gets or sets the angle of the emission cone
  13444. */
  13445. get angle(): number;
  13446. set angle(value: number);
  13447. private _buildHeight;
  13448. /**
  13449. * Creates a new instance ConeParticleEmitter
  13450. * @param radius the radius of the emission cone (1 by default)
  13451. * @param angle the cone base angle (PI by default)
  13452. * @param directionRandomizer defines how much to randomize the particle direction [0-1] (default is 0)
  13453. */
  13454. constructor(radius?: number, angle?: number,
  13455. /** defines how much to randomize the particle direction [0-1] (default is 0) */
  13456. directionRandomizer?: number);
  13457. /**
  13458. * Called by the particle System when the direction is computed for the created particle.
  13459. * @param worldMatrix is the world matrix of the particle system
  13460. * @param directionToUpdate is the direction vector to update with the result
  13461. * @param particle is the particle we are computed the direction for
  13462. * @param isLocal defines if the direction should be set in local space
  13463. */
  13464. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13465. /**
  13466. * Called by the particle System when the position is computed for the created particle.
  13467. * @param worldMatrix is the world matrix of the particle system
  13468. * @param positionToUpdate is the position vector to update with the result
  13469. * @param particle is the particle we are computed the position for
  13470. * @param isLocal defines if the position should be set in local space
  13471. */
  13472. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13473. /**
  13474. * Clones the current emitter and returns a copy of it
  13475. * @returns the new emitter
  13476. */
  13477. clone(): ConeParticleEmitter;
  13478. /**
  13479. * Called by the GPUParticleSystem to setup the update shader
  13480. * @param effect defines the update shader
  13481. */
  13482. applyToShader(effect: Effect): void;
  13483. /**
  13484. * Returns a string to use to update the GPU particles update shader
  13485. * @returns a string containng the defines string
  13486. */
  13487. getEffectDefines(): string;
  13488. /**
  13489. * Returns the string "ConeParticleEmitter"
  13490. * @returns a string containing the class name
  13491. */
  13492. getClassName(): string;
  13493. /**
  13494. * Serializes the particle system to a JSON object.
  13495. * @returns the JSON object
  13496. */
  13497. serialize(): any;
  13498. /**
  13499. * Parse properties from a JSON object
  13500. * @param serializationObject defines the JSON object
  13501. */
  13502. parse(serializationObject: any): void;
  13503. }
  13504. }
  13505. declare module "babylonjs/Particles/EmitterTypes/cylinderParticleEmitter" {
  13506. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  13507. import { Effect } from "babylonjs/Materials/effect";
  13508. import { Particle } from "babylonjs/Particles/particle";
  13509. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  13510. /**
  13511. * Particle emitter emitting particles from the inside of a cylinder.
  13512. * It emits the particles alongside the cylinder radius. The emission direction might be randomized.
  13513. */
  13514. export class CylinderParticleEmitter implements IParticleEmitterType {
  13515. /**
  13516. * The radius of the emission cylinder.
  13517. */
  13518. radius: number;
  13519. /**
  13520. * The height of the emission cylinder.
  13521. */
  13522. height: number;
  13523. /**
  13524. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  13525. */
  13526. radiusRange: number;
  13527. /**
  13528. * How much to randomize the particle direction [0-1].
  13529. */
  13530. directionRandomizer: number;
  13531. /**
  13532. * Creates a new instance CylinderParticleEmitter
  13533. * @param radius the radius of the emission cylinder (1 by default)
  13534. * @param height the height of the emission cylinder (1 by default)
  13535. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  13536. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  13537. */
  13538. constructor(
  13539. /**
  13540. * The radius of the emission cylinder.
  13541. */
  13542. radius?: number,
  13543. /**
  13544. * The height of the emission cylinder.
  13545. */
  13546. height?: number,
  13547. /**
  13548. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  13549. */
  13550. radiusRange?: number,
  13551. /**
  13552. * How much to randomize the particle direction [0-1].
  13553. */
  13554. directionRandomizer?: number);
  13555. /**
  13556. * Called by the particle System when the direction is computed for the created particle.
  13557. * @param worldMatrix is the world matrix of the particle system
  13558. * @param directionToUpdate is the direction vector to update with the result
  13559. * @param particle is the particle we are computed the direction for
  13560. * @param isLocal defines if the direction should be set in local space
  13561. */
  13562. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13563. /**
  13564. * Called by the particle System when the position is computed for the created particle.
  13565. * @param worldMatrix is the world matrix of the particle system
  13566. * @param positionToUpdate is the position vector to update with the result
  13567. * @param particle is the particle we are computed the position for
  13568. * @param isLocal defines if the position should be set in local space
  13569. */
  13570. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13571. /**
  13572. * Clones the current emitter and returns a copy of it
  13573. * @returns the new emitter
  13574. */
  13575. clone(): CylinderParticleEmitter;
  13576. /**
  13577. * Called by the GPUParticleSystem to setup the update shader
  13578. * @param effect defines the update shader
  13579. */
  13580. applyToShader(effect: Effect): void;
  13581. /**
  13582. * Returns a string to use to update the GPU particles update shader
  13583. * @returns a string containng the defines string
  13584. */
  13585. getEffectDefines(): string;
  13586. /**
  13587. * Returns the string "CylinderParticleEmitter"
  13588. * @returns a string containing the class name
  13589. */
  13590. getClassName(): string;
  13591. /**
  13592. * Serializes the particle system to a JSON object.
  13593. * @returns the JSON object
  13594. */
  13595. serialize(): any;
  13596. /**
  13597. * Parse properties from a JSON object
  13598. * @param serializationObject defines the JSON object
  13599. */
  13600. parse(serializationObject: any): void;
  13601. }
  13602. /**
  13603. * Particle emitter emitting particles from the inside of a cylinder.
  13604. * It emits the particles randomly between two vectors.
  13605. */
  13606. export class CylinderDirectedParticleEmitter extends CylinderParticleEmitter {
  13607. /**
  13608. * The min limit of the emission direction.
  13609. */
  13610. direction1: Vector3;
  13611. /**
  13612. * The max limit of the emission direction.
  13613. */
  13614. direction2: Vector3;
  13615. /**
  13616. * Creates a new instance CylinderDirectedParticleEmitter
  13617. * @param radius the radius of the emission cylinder (1 by default)
  13618. * @param height the height of the emission cylinder (1 by default)
  13619. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  13620. * @param direction1 the min limit of the emission direction (up vector by default)
  13621. * @param direction2 the max limit of the emission direction (up vector by default)
  13622. */
  13623. constructor(radius?: number, height?: number, radiusRange?: number,
  13624. /**
  13625. * The min limit of the emission direction.
  13626. */
  13627. direction1?: Vector3,
  13628. /**
  13629. * The max limit of the emission direction.
  13630. */
  13631. direction2?: Vector3);
  13632. /**
  13633. * Called by the particle System when the direction is computed for the created particle.
  13634. * @param worldMatrix is the world matrix of the particle system
  13635. * @param directionToUpdate is the direction vector to update with the result
  13636. * @param particle is the particle we are computed the direction for
  13637. */
  13638. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  13639. /**
  13640. * Clones the current emitter and returns a copy of it
  13641. * @returns the new emitter
  13642. */
  13643. clone(): CylinderDirectedParticleEmitter;
  13644. /**
  13645. * Called by the GPUParticleSystem to setup the update shader
  13646. * @param effect defines the update shader
  13647. */
  13648. applyToShader(effect: Effect): void;
  13649. /**
  13650. * Returns a string to use to update the GPU particles update shader
  13651. * @returns a string containng the defines string
  13652. */
  13653. getEffectDefines(): string;
  13654. /**
  13655. * Returns the string "CylinderDirectedParticleEmitter"
  13656. * @returns a string containing the class name
  13657. */
  13658. getClassName(): string;
  13659. /**
  13660. * Serializes the particle system to a JSON object.
  13661. * @returns the JSON object
  13662. */
  13663. serialize(): any;
  13664. /**
  13665. * Parse properties from a JSON object
  13666. * @param serializationObject defines the JSON object
  13667. */
  13668. parse(serializationObject: any): void;
  13669. }
  13670. }
  13671. declare module "babylonjs/Particles/EmitterTypes/hemisphericParticleEmitter" {
  13672. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  13673. import { Effect } from "babylonjs/Materials/effect";
  13674. import { Particle } from "babylonjs/Particles/particle";
  13675. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  13676. /**
  13677. * Particle emitter emitting particles from the inside of a hemisphere.
  13678. * It emits the particles alongside the hemisphere radius. The emission direction might be randomized.
  13679. */
  13680. export class HemisphericParticleEmitter implements IParticleEmitterType {
  13681. /**
  13682. * The radius of the emission hemisphere.
  13683. */
  13684. radius: number;
  13685. /**
  13686. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  13687. */
  13688. radiusRange: number;
  13689. /**
  13690. * How much to randomize the particle direction [0-1].
  13691. */
  13692. directionRandomizer: number;
  13693. /**
  13694. * Creates a new instance HemisphericParticleEmitter
  13695. * @param radius the radius of the emission hemisphere (1 by default)
  13696. * @param radiusRange the range of the emission hemisphere [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  13697. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  13698. */
  13699. constructor(
  13700. /**
  13701. * The radius of the emission hemisphere.
  13702. */
  13703. radius?: number,
  13704. /**
  13705. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  13706. */
  13707. radiusRange?: number,
  13708. /**
  13709. * How much to randomize the particle direction [0-1].
  13710. */
  13711. directionRandomizer?: number);
  13712. /**
  13713. * Called by the particle System when the direction is computed for the created particle.
  13714. * @param worldMatrix is the world matrix of the particle system
  13715. * @param directionToUpdate is the direction vector to update with the result
  13716. * @param particle is the particle we are computed the direction for
  13717. * @param isLocal defines if the direction should be set in local space
  13718. */
  13719. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13720. /**
  13721. * Called by the particle System when the position is computed for the created particle.
  13722. * @param worldMatrix is the world matrix of the particle system
  13723. * @param positionToUpdate is the position vector to update with the result
  13724. * @param particle is the particle we are computed the position for
  13725. * @param isLocal defines if the position should be set in local space
  13726. */
  13727. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13728. /**
  13729. * Clones the current emitter and returns a copy of it
  13730. * @returns the new emitter
  13731. */
  13732. clone(): HemisphericParticleEmitter;
  13733. /**
  13734. * Called by the GPUParticleSystem to setup the update shader
  13735. * @param effect defines the update shader
  13736. */
  13737. applyToShader(effect: Effect): void;
  13738. /**
  13739. * Returns a string to use to update the GPU particles update shader
  13740. * @returns a string containng the defines string
  13741. */
  13742. getEffectDefines(): string;
  13743. /**
  13744. * Returns the string "HemisphericParticleEmitter"
  13745. * @returns a string containing the class name
  13746. */
  13747. getClassName(): string;
  13748. /**
  13749. * Serializes the particle system to a JSON object.
  13750. * @returns the JSON object
  13751. */
  13752. serialize(): any;
  13753. /**
  13754. * Parse properties from a JSON object
  13755. * @param serializationObject defines the JSON object
  13756. */
  13757. parse(serializationObject: any): void;
  13758. }
  13759. }
  13760. declare module "babylonjs/Particles/EmitterTypes/pointParticleEmitter" {
  13761. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  13762. import { Effect } from "babylonjs/Materials/effect";
  13763. import { Particle } from "babylonjs/Particles/particle";
  13764. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  13765. /**
  13766. * Particle emitter emitting particles from a point.
  13767. * It emits the particles randomly between 2 given directions.
  13768. */
  13769. export class PointParticleEmitter implements IParticleEmitterType {
  13770. /**
  13771. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  13772. */
  13773. direction1: Vector3;
  13774. /**
  13775. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  13776. */
  13777. direction2: Vector3;
  13778. /**
  13779. * Creates a new instance PointParticleEmitter
  13780. */
  13781. constructor();
  13782. /**
  13783. * Called by the particle System when the direction is computed for the created particle.
  13784. * @param worldMatrix is the world matrix of the particle system
  13785. * @param directionToUpdate is the direction vector to update with the result
  13786. * @param particle is the particle we are computed the direction for
  13787. * @param isLocal defines if the direction should be set in local space
  13788. */
  13789. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13790. /**
  13791. * Called by the particle System when the position is computed for the created particle.
  13792. * @param worldMatrix is the world matrix of the particle system
  13793. * @param positionToUpdate is the position vector to update with the result
  13794. * @param particle is the particle we are computed the position for
  13795. * @param isLocal defines if the position should be set in local space
  13796. */
  13797. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13798. /**
  13799. * Clones the current emitter and returns a copy of it
  13800. * @returns the new emitter
  13801. */
  13802. clone(): PointParticleEmitter;
  13803. /**
  13804. * Called by the GPUParticleSystem to setup the update shader
  13805. * @param effect defines the update shader
  13806. */
  13807. applyToShader(effect: Effect): void;
  13808. /**
  13809. * Returns a string to use to update the GPU particles update shader
  13810. * @returns a string containng the defines string
  13811. */
  13812. getEffectDefines(): string;
  13813. /**
  13814. * Returns the string "PointParticleEmitter"
  13815. * @returns a string containing the class name
  13816. */
  13817. getClassName(): string;
  13818. /**
  13819. * Serializes the particle system to a JSON object.
  13820. * @returns the JSON object
  13821. */
  13822. serialize(): any;
  13823. /**
  13824. * Parse properties from a JSON object
  13825. * @param serializationObject defines the JSON object
  13826. */
  13827. parse(serializationObject: any): void;
  13828. }
  13829. }
  13830. declare module "babylonjs/Particles/EmitterTypes/sphereParticleEmitter" {
  13831. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  13832. import { Effect } from "babylonjs/Materials/effect";
  13833. import { Particle } from "babylonjs/Particles/particle";
  13834. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  13835. /**
  13836. * Particle emitter emitting particles from the inside of a sphere.
  13837. * It emits the particles alongside the sphere radius. The emission direction might be randomized.
  13838. */
  13839. export class SphereParticleEmitter implements IParticleEmitterType {
  13840. /**
  13841. * The radius of the emission sphere.
  13842. */
  13843. radius: number;
  13844. /**
  13845. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  13846. */
  13847. radiusRange: number;
  13848. /**
  13849. * How much to randomize the particle direction [0-1].
  13850. */
  13851. directionRandomizer: number;
  13852. /**
  13853. * Creates a new instance SphereParticleEmitter
  13854. * @param radius the radius of the emission sphere (1 by default)
  13855. * @param radiusRange the range of the emission sphere [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  13856. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  13857. */
  13858. constructor(
  13859. /**
  13860. * The radius of the emission sphere.
  13861. */
  13862. radius?: number,
  13863. /**
  13864. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  13865. */
  13866. radiusRange?: number,
  13867. /**
  13868. * How much to randomize the particle direction [0-1].
  13869. */
  13870. directionRandomizer?: number);
  13871. /**
  13872. * Called by the particle System when the direction is computed for the created particle.
  13873. * @param worldMatrix is the world matrix of the particle system
  13874. * @param directionToUpdate is the direction vector to update with the result
  13875. * @param particle is the particle we are computed the direction for
  13876. * @param isLocal defines if the direction should be set in local space
  13877. */
  13878. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13879. /**
  13880. * Called by the particle System when the position is computed for the created particle.
  13881. * @param worldMatrix is the world matrix of the particle system
  13882. * @param positionToUpdate is the position vector to update with the result
  13883. * @param particle is the particle we are computed the position for
  13884. * @param isLocal defines if the position should be set in local space
  13885. */
  13886. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13887. /**
  13888. * Clones the current emitter and returns a copy of it
  13889. * @returns the new emitter
  13890. */
  13891. clone(): SphereParticleEmitter;
  13892. /**
  13893. * Called by the GPUParticleSystem to setup the update shader
  13894. * @param effect defines the update shader
  13895. */
  13896. applyToShader(effect: Effect): void;
  13897. /**
  13898. * Returns a string to use to update the GPU particles update shader
  13899. * @returns a string containng the defines string
  13900. */
  13901. getEffectDefines(): string;
  13902. /**
  13903. * Returns the string "SphereParticleEmitter"
  13904. * @returns a string containing the class name
  13905. */
  13906. getClassName(): string;
  13907. /**
  13908. * Serializes the particle system to a JSON object.
  13909. * @returns the JSON object
  13910. */
  13911. serialize(): any;
  13912. /**
  13913. * Parse properties from a JSON object
  13914. * @param serializationObject defines the JSON object
  13915. */
  13916. parse(serializationObject: any): void;
  13917. }
  13918. /**
  13919. * Particle emitter emitting particles from the inside of a sphere.
  13920. * It emits the particles randomly between two vectors.
  13921. */
  13922. export class SphereDirectedParticleEmitter extends SphereParticleEmitter {
  13923. /**
  13924. * The min limit of the emission direction.
  13925. */
  13926. direction1: Vector3;
  13927. /**
  13928. * The max limit of the emission direction.
  13929. */
  13930. direction2: Vector3;
  13931. /**
  13932. * Creates a new instance SphereDirectedParticleEmitter
  13933. * @param radius the radius of the emission sphere (1 by default)
  13934. * @param direction1 the min limit of the emission direction (up vector by default)
  13935. * @param direction2 the max limit of the emission direction (up vector by default)
  13936. */
  13937. constructor(radius?: number,
  13938. /**
  13939. * The min limit of the emission direction.
  13940. */
  13941. direction1?: Vector3,
  13942. /**
  13943. * The max limit of the emission direction.
  13944. */
  13945. direction2?: Vector3);
  13946. /**
  13947. * Called by the particle System when the direction is computed for the created particle.
  13948. * @param worldMatrix is the world matrix of the particle system
  13949. * @param directionToUpdate is the direction vector to update with the result
  13950. * @param particle is the particle we are computed the direction for
  13951. */
  13952. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  13953. /**
  13954. * Clones the current emitter and returns a copy of it
  13955. * @returns the new emitter
  13956. */
  13957. clone(): SphereDirectedParticleEmitter;
  13958. /**
  13959. * Called by the GPUParticleSystem to setup the update shader
  13960. * @param effect defines the update shader
  13961. */
  13962. applyToShader(effect: Effect): void;
  13963. /**
  13964. * Returns a string to use to update the GPU particles update shader
  13965. * @returns a string containng the defines string
  13966. */
  13967. getEffectDefines(): string;
  13968. /**
  13969. * Returns the string "SphereDirectedParticleEmitter"
  13970. * @returns a string containing the class name
  13971. */
  13972. getClassName(): string;
  13973. /**
  13974. * Serializes the particle system to a JSON object.
  13975. * @returns the JSON object
  13976. */
  13977. serialize(): any;
  13978. /**
  13979. * Parse properties from a JSON object
  13980. * @param serializationObject defines the JSON object
  13981. */
  13982. parse(serializationObject: any): void;
  13983. }
  13984. }
  13985. declare module "babylonjs/Particles/EmitterTypes/customParticleEmitter" {
  13986. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  13987. import { Effect } from "babylonjs/Materials/effect";
  13988. import { Particle } from "babylonjs/Particles/particle";
  13989. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  13990. import { Nullable } from "babylonjs/types";
  13991. /**
  13992. * Particle emitter emitting particles from a custom list of positions.
  13993. */
  13994. export class CustomParticleEmitter implements IParticleEmitterType {
  13995. /**
  13996. * Gets or sets the position generator that will create the inital position of each particle.
  13997. * Index will be provided when used with GPU particle. Particle will be provided when used with CPU particles
  13998. */
  13999. particlePositionGenerator: (index: number, particle: Nullable<Particle>, outPosition: Vector3) => void;
  14000. /**
  14001. * Gets or sets the destination generator that will create the final destination of each particle.
  14002. * * Index will be provided when used with GPU particle. Particle will be provided when used with CPU particles
  14003. */
  14004. particleDestinationGenerator: (index: number, particle: Nullable<Particle>, outDestination: Vector3) => void;
  14005. /**
  14006. * Creates a new instance CustomParticleEmitter
  14007. */
  14008. constructor();
  14009. /**
  14010. * Called by the particle System when the direction is computed for the created particle.
  14011. * @param worldMatrix is the world matrix of the particle system
  14012. * @param directionToUpdate is the direction vector to update with the result
  14013. * @param particle is the particle we are computed the direction for
  14014. * @param isLocal defines if the direction should be set in local space
  14015. */
  14016. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  14017. /**
  14018. * Called by the particle System when the position is computed for the created particle.
  14019. * @param worldMatrix is the world matrix of the particle system
  14020. * @param positionToUpdate is the position vector to update with the result
  14021. * @param particle is the particle we are computed the position for
  14022. * @param isLocal defines if the position should be set in local space
  14023. */
  14024. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  14025. /**
  14026. * Clones the current emitter and returns a copy of it
  14027. * @returns the new emitter
  14028. */
  14029. clone(): CustomParticleEmitter;
  14030. /**
  14031. * Called by the GPUParticleSystem to setup the update shader
  14032. * @param effect defines the update shader
  14033. */
  14034. applyToShader(effect: Effect): void;
  14035. /**
  14036. * Returns a string to use to update the GPU particles update shader
  14037. * @returns a string containng the defines string
  14038. */
  14039. getEffectDefines(): string;
  14040. /**
  14041. * Returns the string "PointParticleEmitter"
  14042. * @returns a string containing the class name
  14043. */
  14044. getClassName(): string;
  14045. /**
  14046. * Serializes the particle system to a JSON object.
  14047. * @returns the JSON object
  14048. */
  14049. serialize(): any;
  14050. /**
  14051. * Parse properties from a JSON object
  14052. * @param serializationObject defines the JSON object
  14053. */
  14054. parse(serializationObject: any): void;
  14055. }
  14056. }
  14057. declare module "babylonjs/Particles/EmitterTypes/meshParticleEmitter" {
  14058. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  14059. import { Effect } from "babylonjs/Materials/effect";
  14060. import { Particle } from "babylonjs/Particles/particle";
  14061. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  14062. import { Nullable } from "babylonjs/types";
  14063. import { Scene } from "babylonjs/scene";
  14064. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  14065. /**
  14066. * Particle emitter emitting particles from the inside of a box.
  14067. * It emits the particles randomly between 2 given directions.
  14068. */
  14069. export class MeshParticleEmitter implements IParticleEmitterType {
  14070. private _indices;
  14071. private _positions;
  14072. private _normals;
  14073. private _storedNormal;
  14074. private _mesh;
  14075. /**
  14076. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  14077. */
  14078. direction1: Vector3;
  14079. /**
  14080. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  14081. */
  14082. direction2: Vector3;
  14083. /**
  14084. * Gets or sets a boolean indicating that particle directions must be built from mesh face normals
  14085. */
  14086. useMeshNormalsForDirection: boolean;
  14087. /** Defines the mesh to use as source */
  14088. get mesh(): Nullable<AbstractMesh>;
  14089. set mesh(value: Nullable<AbstractMesh>);
  14090. /**
  14091. * Creates a new instance MeshParticleEmitter
  14092. * @param mesh defines the mesh to use as source
  14093. */
  14094. constructor(mesh?: Nullable<AbstractMesh>);
  14095. /**
  14096. * Called by the particle System when the direction is computed for the created particle.
  14097. * @param worldMatrix is the world matrix of the particle system
  14098. * @param directionToUpdate is the direction vector to update with the result
  14099. * @param particle is the particle we are computed the direction for
  14100. * @param isLocal defines if the direction should be set in local space
  14101. */
  14102. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  14103. /**
  14104. * Called by the particle System when the position is computed for the created particle.
  14105. * @param worldMatrix is the world matrix of the particle system
  14106. * @param positionToUpdate is the position vector to update with the result
  14107. * @param particle is the particle we are computed the position for
  14108. * @param isLocal defines if the position should be set in local space
  14109. */
  14110. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  14111. /**
  14112. * Clones the current emitter and returns a copy of it
  14113. * @returns the new emitter
  14114. */
  14115. clone(): MeshParticleEmitter;
  14116. /**
  14117. * Called by the GPUParticleSystem to setup the update shader
  14118. * @param effect defines the update shader
  14119. */
  14120. applyToShader(effect: Effect): void;
  14121. /**
  14122. * Returns a string to use to update the GPU particles update shader
  14123. * @returns a string containng the defines string
  14124. */
  14125. getEffectDefines(): string;
  14126. /**
  14127. * Returns the string "BoxParticleEmitter"
  14128. * @returns a string containing the class name
  14129. */
  14130. getClassName(): string;
  14131. /**
  14132. * Serializes the particle system to a JSON object.
  14133. * @returns the JSON object
  14134. */
  14135. serialize(): any;
  14136. /**
  14137. * Parse properties from a JSON object
  14138. * @param serializationObject defines the JSON object
  14139. * @param scene defines the hosting scene
  14140. */
  14141. parse(serializationObject: any, scene: Scene): void;
  14142. }
  14143. }
  14144. declare module "babylonjs/Particles/EmitterTypes/index" {
  14145. export * from "babylonjs/Particles/EmitterTypes/boxParticleEmitter";
  14146. export * from "babylonjs/Particles/EmitterTypes/coneParticleEmitter";
  14147. export * from "babylonjs/Particles/EmitterTypes/cylinderParticleEmitter";
  14148. export * from "babylonjs/Particles/EmitterTypes/hemisphericParticleEmitter";
  14149. export * from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  14150. export * from "babylonjs/Particles/EmitterTypes/pointParticleEmitter";
  14151. export * from "babylonjs/Particles/EmitterTypes/sphereParticleEmitter";
  14152. export * from "babylonjs/Particles/EmitterTypes/customParticleEmitter";
  14153. export * from "babylonjs/Particles/EmitterTypes/meshParticleEmitter";
  14154. }
  14155. declare module "babylonjs/Particles/IParticleSystem" {
  14156. import { Nullable } from "babylonjs/types";
  14157. import { Vector2, Vector3 } from "babylonjs/Maths/math.vector";
  14158. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  14159. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  14160. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  14161. import { Texture } from "babylonjs/Materials/Textures/texture";
  14162. import { BoxParticleEmitter, IParticleEmitterType, PointParticleEmitter, HemisphericParticleEmitter, SphereParticleEmitter, SphereDirectedParticleEmitter, CylinderParticleEmitter, ConeParticleEmitter } from "babylonjs/Particles/EmitterTypes/index";
  14163. import { Scene } from "babylonjs/scene";
  14164. import { ColorGradient, FactorGradient, Color3Gradient } from "babylonjs/Misc/gradients";
  14165. import { Effect } from "babylonjs/Materials/effect";
  14166. import { Observable } from "babylonjs/Misc/observable";
  14167. import { Animation } from "babylonjs/Animations/animation";
  14168. /**
  14169. * Interface representing a particle system in Babylon.js.
  14170. * This groups the common functionalities that needs to be implemented in order to create a particle system.
  14171. * A particle system represents a way to manage particles from their emission to their animation and rendering.
  14172. */
  14173. export interface IParticleSystem {
  14174. /**
  14175. * List of animations used by the particle system.
  14176. */
  14177. animations: Animation[];
  14178. /**
  14179. * The id of the Particle system.
  14180. */
  14181. id: string;
  14182. /**
  14183. * The name of the Particle system.
  14184. */
  14185. name: string;
  14186. /**
  14187. * The emitter represents the Mesh or position we are attaching the particle system to.
  14188. */
  14189. emitter: Nullable<AbstractMesh | Vector3>;
  14190. /**
  14191. * Gets or sets a boolean indicating if the particles must be rendered as billboard or aligned with the direction
  14192. */
  14193. isBillboardBased: boolean;
  14194. /**
  14195. * The rendering group used by the Particle system to chose when to render.
  14196. */
  14197. renderingGroupId: number;
  14198. /**
  14199. * The layer mask we are rendering the particles through.
  14200. */
  14201. layerMask: number;
  14202. /**
  14203. * The overall motion speed (0.01 is default update speed, faster updates = faster animation)
  14204. */
  14205. updateSpeed: number;
  14206. /**
  14207. * The amount of time the particle system is running (depends of the overall update speed).
  14208. */
  14209. targetStopDuration: number;
  14210. /**
  14211. * The texture used to render each particle. (this can be a spritesheet)
  14212. */
  14213. particleTexture: Nullable<Texture>;
  14214. /**
  14215. * Blend mode use to render the particle, it can be either ParticleSystem.BLENDMODE_ONEONE, ParticleSystem.BLENDMODE_STANDARD or ParticleSystem.BLENDMODE_ADD.
  14216. */
  14217. blendMode: number;
  14218. /**
  14219. * Minimum life time of emitting particles.
  14220. */
  14221. minLifeTime: number;
  14222. /**
  14223. * Maximum life time of emitting particles.
  14224. */
  14225. maxLifeTime: number;
  14226. /**
  14227. * Minimum Size of emitting particles.
  14228. */
  14229. minSize: number;
  14230. /**
  14231. * Maximum Size of emitting particles.
  14232. */
  14233. maxSize: number;
  14234. /**
  14235. * Minimum scale of emitting particles on X axis.
  14236. */
  14237. minScaleX: number;
  14238. /**
  14239. * Maximum scale of emitting particles on X axis.
  14240. */
  14241. maxScaleX: number;
  14242. /**
  14243. * Minimum scale of emitting particles on Y axis.
  14244. */
  14245. minScaleY: number;
  14246. /**
  14247. * Maximum scale of emitting particles on Y axis.
  14248. */
  14249. maxScaleY: number;
  14250. /**
  14251. * Random color of each particle after it has been emitted, between color1 and color2 vectors.
  14252. */
  14253. color1: Color4;
  14254. /**
  14255. * Random color of each particle after it has been emitted, between color1 and color2 vectors.
  14256. */
  14257. color2: Color4;
  14258. /**
  14259. * Color the particle will have at the end of its lifetime.
  14260. */
  14261. colorDead: Color4;
  14262. /**
  14263. * The maximum number of particles to emit per frame until we reach the activeParticleCount value
  14264. */
  14265. emitRate: number;
  14266. /**
  14267. * You can use gravity if you want to give an orientation to your particles.
  14268. */
  14269. gravity: Vector3;
  14270. /**
  14271. * Minimum power of emitting particles.
  14272. */
  14273. minEmitPower: number;
  14274. /**
  14275. * Maximum power of emitting particles.
  14276. */
  14277. maxEmitPower: number;
  14278. /**
  14279. * Minimum angular speed of emitting particles (Z-axis rotation for each particle).
  14280. */
  14281. minAngularSpeed: number;
  14282. /**
  14283. * Maximum angular speed of emitting particles (Z-axis rotation for each particle).
  14284. */
  14285. maxAngularSpeed: number;
  14286. /**
  14287. * Gets or sets the minimal initial rotation in radians.
  14288. */
  14289. minInitialRotation: number;
  14290. /**
  14291. * Gets or sets the maximal initial rotation in radians.
  14292. */
  14293. maxInitialRotation: number;
  14294. /**
  14295. * The particle emitter type defines the emitter used by the particle system.
  14296. * It can be for example box, sphere, or cone...
  14297. */
  14298. particleEmitterType: Nullable<IParticleEmitterType>;
  14299. /**
  14300. * Defines the delay in milliseconds before starting the system (0 by default)
  14301. */
  14302. startDelay: number;
  14303. /**
  14304. * 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
  14305. */
  14306. preWarmCycles: number;
  14307. /**
  14308. * Gets or sets a value indicating the time step multiplier to use in pre-warm mode (default is 1)
  14309. */
  14310. preWarmStepOffset: number;
  14311. /**
  14312. * 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)
  14313. */
  14314. spriteCellChangeSpeed: number;
  14315. /**
  14316. * If using a spritesheet (isAnimationSheetEnabled) defines the first sprite cell to display
  14317. */
  14318. startSpriteCellID: number;
  14319. /**
  14320. * If using a spritesheet (isAnimationSheetEnabled) defines the last sprite cell to display
  14321. */
  14322. endSpriteCellID: number;
  14323. /**
  14324. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell width to use
  14325. */
  14326. spriteCellWidth: number;
  14327. /**
  14328. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell height to use
  14329. */
  14330. spriteCellHeight: number;
  14331. /**
  14332. * This allows the system to random pick the start cell ID between startSpriteCellID and endSpriteCellID
  14333. */
  14334. spriteRandomStartCell: boolean;
  14335. /**
  14336. * Gets or sets a boolean indicating if a spritesheet is used to animate the particles texture
  14337. */
  14338. isAnimationSheetEnabled: boolean;
  14339. /** Gets or sets a Vector2 used to move the pivot (by default (0,0)) */
  14340. translationPivot: Vector2;
  14341. /**
  14342. * Gets or sets a texture used to add random noise to particle positions
  14343. */
  14344. noiseTexture: Nullable<BaseTexture>;
  14345. /** Gets or sets the strength to apply to the noise value (default is (10, 10, 10)) */
  14346. noiseStrength: Vector3;
  14347. /**
  14348. * Gets or sets the billboard mode to use when isBillboardBased = true.
  14349. * Value can be: ParticleSystem.BILLBOARDMODE_ALL, ParticleSystem.BILLBOARDMODE_Y, ParticleSystem.BILLBOARDMODE_STRETCHED
  14350. */
  14351. billboardMode: number;
  14352. /** Gets or sets a value indicating the damping to apply if the limit velocity factor is reached */
  14353. limitVelocityDamping: number;
  14354. /**
  14355. * Gets or sets a boolean indicating that hosted animations (in the system.animations array) must be started when system.start() is called
  14356. */
  14357. beginAnimationOnStart: boolean;
  14358. /**
  14359. * Gets or sets the frame to start the animation from when beginAnimationOnStart is true
  14360. */
  14361. beginAnimationFrom: number;
  14362. /**
  14363. * Gets or sets the frame to end the animation on when beginAnimationOnStart is true
  14364. */
  14365. beginAnimationTo: number;
  14366. /**
  14367. * Gets or sets a boolean indicating if animations must loop when beginAnimationOnStart is true
  14368. */
  14369. beginAnimationLoop: boolean;
  14370. /**
  14371. * Specifies whether the particle system will be disposed once it reaches the end of the animation.
  14372. */
  14373. disposeOnStop: boolean;
  14374. /**
  14375. * Specifies if the particles are updated in emitter local space or world space
  14376. */
  14377. isLocal: boolean;
  14378. /** Snippet ID if the particle system was created from the snippet server */
  14379. snippetId: string;
  14380. /**
  14381. * Gets the maximum number of particles active at the same time.
  14382. * @returns The max number of active particles.
  14383. */
  14384. getCapacity(): number;
  14385. /**
  14386. * Gets the number of particles active at the same time.
  14387. * @returns The number of active particles.
  14388. */
  14389. getActiveCount(): number;
  14390. /**
  14391. * Gets if the system has been started. (Note: this will still be true after stop is called)
  14392. * @returns True if it has been started, otherwise false.
  14393. */
  14394. isStarted(): boolean;
  14395. /**
  14396. * Animates the particle system for this frame.
  14397. */
  14398. animate(): void;
  14399. /**
  14400. * Renders the particle system in its current state.
  14401. * @returns the current number of particles
  14402. */
  14403. render(): number;
  14404. /**
  14405. * Dispose the particle system and frees its associated resources.
  14406. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  14407. */
  14408. dispose(disposeTexture?: boolean): void;
  14409. /**
  14410. * An event triggered when the system is disposed
  14411. */
  14412. onDisposeObservable: Observable<IParticleSystem>;
  14413. /**
  14414. * Clones the particle system.
  14415. * @param name The name of the cloned object
  14416. * @param newEmitter The new emitter to use
  14417. * @returns the cloned particle system
  14418. */
  14419. clone(name: string, newEmitter: any): Nullable<IParticleSystem>;
  14420. /**
  14421. * Serializes the particle system to a JSON object
  14422. * @param serializeTexture defines if the texture must be serialized as well
  14423. * @returns the JSON object
  14424. */
  14425. serialize(serializeTexture: boolean): any;
  14426. /**
  14427. * Rebuild the particle system
  14428. */
  14429. rebuild(): void;
  14430. /** Force the system to rebuild all gradients that need to be resync */
  14431. forceRefreshGradients(): void;
  14432. /**
  14433. * Starts the particle system and begins to emit
  14434. * @param delay defines the delay in milliseconds before starting the system (0 by default)
  14435. */
  14436. start(delay?: number): void;
  14437. /**
  14438. * Stops the particle system.
  14439. */
  14440. stop(): void;
  14441. /**
  14442. * Remove all active particles
  14443. */
  14444. reset(): void;
  14445. /**
  14446. * Gets a boolean indicating that the system is stopping
  14447. * @returns true if the system is currently stopping
  14448. */
  14449. isStopping(): boolean;
  14450. /**
  14451. * Is this system ready to be used/rendered
  14452. * @return true if the system is ready
  14453. */
  14454. isReady(): boolean;
  14455. /**
  14456. * Returns the string "ParticleSystem"
  14457. * @returns a string containing the class name
  14458. */
  14459. getClassName(): string;
  14460. /**
  14461. * Gets the custom effect used to render the particles
  14462. * @param blendMode Blend mode for which the effect should be retrieved
  14463. * @returns The effect
  14464. */
  14465. getCustomEffect(blendMode: number): Nullable<Effect>;
  14466. /**
  14467. * Sets the custom effect used to render the particles
  14468. * @param effect The effect to set
  14469. * @param blendMode Blend mode for which the effect should be set
  14470. */
  14471. setCustomEffect(effect: Nullable<Effect>, blendMode: number): void;
  14472. /**
  14473. * Fill the defines array according to the current settings of the particle system
  14474. * @param defines Array to be updated
  14475. * @param blendMode blend mode to take into account when updating the array
  14476. */
  14477. fillDefines(defines: Array<string>, blendMode: number): void;
  14478. /**
  14479. * Fill the uniforms, attributes and samplers arrays according to the current settings of the particle system
  14480. * @param uniforms Uniforms array to fill
  14481. * @param attributes Attributes array to fill
  14482. * @param samplers Samplers array to fill
  14483. */
  14484. fillUniformsAttributesAndSamplerNames(uniforms: Array<string>, attributes: Array<string>, samplers: Array<string>): void;
  14485. /**
  14486. * Observable that will be called just before the particles are drawn
  14487. */
  14488. onBeforeDrawParticlesObservable: Observable<Nullable<Effect>>;
  14489. /**
  14490. * Gets the name of the particle vertex shader
  14491. */
  14492. vertexShaderName: string;
  14493. /**
  14494. * Adds a new color gradient
  14495. * @param gradient defines the gradient to use (between 0 and 1)
  14496. * @param color1 defines the color to affect to the specified gradient
  14497. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  14498. * @returns the current particle system
  14499. */
  14500. addColorGradient(gradient: number, color1: Color4, color2?: Color4): IParticleSystem;
  14501. /**
  14502. * Remove a specific color gradient
  14503. * @param gradient defines the gradient to remove
  14504. * @returns the current particle system
  14505. */
  14506. removeColorGradient(gradient: number): IParticleSystem;
  14507. /**
  14508. * Adds a new size gradient
  14509. * @param gradient defines the gradient to use (between 0 and 1)
  14510. * @param factor defines the size factor to affect to the specified gradient
  14511. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14512. * @returns the current particle system
  14513. */
  14514. addSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14515. /**
  14516. * Remove a specific size gradient
  14517. * @param gradient defines the gradient to remove
  14518. * @returns the current particle system
  14519. */
  14520. removeSizeGradient(gradient: number): IParticleSystem;
  14521. /**
  14522. * Gets the current list of color gradients.
  14523. * You must use addColorGradient and removeColorGradient to udpate this list
  14524. * @returns the list of color gradients
  14525. */
  14526. getColorGradients(): Nullable<Array<ColorGradient>>;
  14527. /**
  14528. * Gets the current list of size gradients.
  14529. * You must use addSizeGradient and removeSizeGradient to udpate this list
  14530. * @returns the list of size gradients
  14531. */
  14532. getSizeGradients(): Nullable<Array<FactorGradient>>;
  14533. /**
  14534. * Gets the current list of angular speed gradients.
  14535. * You must use addAngularSpeedGradient and removeAngularSpeedGradient to udpate this list
  14536. * @returns the list of angular speed gradients
  14537. */
  14538. getAngularSpeedGradients(): Nullable<Array<FactorGradient>>;
  14539. /**
  14540. * Adds a new angular speed gradient
  14541. * @param gradient defines the gradient to use (between 0 and 1)
  14542. * @param factor defines the angular speed to affect to the specified gradient
  14543. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14544. * @returns the current particle system
  14545. */
  14546. addAngularSpeedGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14547. /**
  14548. * Remove a specific angular speed gradient
  14549. * @param gradient defines the gradient to remove
  14550. * @returns the current particle system
  14551. */
  14552. removeAngularSpeedGradient(gradient: number): IParticleSystem;
  14553. /**
  14554. * Gets the current list of velocity gradients.
  14555. * You must use addVelocityGradient and removeVelocityGradient to udpate this list
  14556. * @returns the list of velocity gradients
  14557. */
  14558. getVelocityGradients(): Nullable<Array<FactorGradient>>;
  14559. /**
  14560. * Adds a new velocity gradient
  14561. * @param gradient defines the gradient to use (between 0 and 1)
  14562. * @param factor defines the velocity to affect to the specified gradient
  14563. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14564. * @returns the current particle system
  14565. */
  14566. addVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14567. /**
  14568. * Remove a specific velocity gradient
  14569. * @param gradient defines the gradient to remove
  14570. * @returns the current particle system
  14571. */
  14572. removeVelocityGradient(gradient: number): IParticleSystem;
  14573. /**
  14574. * Gets the current list of limit velocity gradients.
  14575. * You must use addLimitVelocityGradient and removeLimitVelocityGradient to udpate this list
  14576. * @returns the list of limit velocity gradients
  14577. */
  14578. getLimitVelocityGradients(): Nullable<Array<FactorGradient>>;
  14579. /**
  14580. * Adds a new limit velocity gradient
  14581. * @param gradient defines the gradient to use (between 0 and 1)
  14582. * @param factor defines the limit velocity to affect to the specified gradient
  14583. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14584. * @returns the current particle system
  14585. */
  14586. addLimitVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14587. /**
  14588. * Remove a specific limit velocity gradient
  14589. * @param gradient defines the gradient to remove
  14590. * @returns the current particle system
  14591. */
  14592. removeLimitVelocityGradient(gradient: number): IParticleSystem;
  14593. /**
  14594. * Adds a new drag gradient
  14595. * @param gradient defines the gradient to use (between 0 and 1)
  14596. * @param factor defines the drag to affect to the specified gradient
  14597. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14598. * @returns the current particle system
  14599. */
  14600. addDragGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14601. /**
  14602. * Remove a specific drag gradient
  14603. * @param gradient defines the gradient to remove
  14604. * @returns the current particle system
  14605. */
  14606. removeDragGradient(gradient: number): IParticleSystem;
  14607. /**
  14608. * Gets the current list of drag gradients.
  14609. * You must use addDragGradient and removeDragGradient to udpate this list
  14610. * @returns the list of drag gradients
  14611. */
  14612. getDragGradients(): Nullable<Array<FactorGradient>>;
  14613. /**
  14614. * Adds a new emit rate gradient (please note that this will only work if you set the targetStopDuration property)
  14615. * @param gradient defines the gradient to use (between 0 and 1)
  14616. * @param factor defines the emit rate to affect to the specified gradient
  14617. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14618. * @returns the current particle system
  14619. */
  14620. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14621. /**
  14622. * Remove a specific emit rate gradient
  14623. * @param gradient defines the gradient to remove
  14624. * @returns the current particle system
  14625. */
  14626. removeEmitRateGradient(gradient: number): IParticleSystem;
  14627. /**
  14628. * Gets the current list of emit rate gradients.
  14629. * You must use addEmitRateGradient and removeEmitRateGradient to udpate this list
  14630. * @returns the list of emit rate gradients
  14631. */
  14632. getEmitRateGradients(): Nullable<Array<FactorGradient>>;
  14633. /**
  14634. * Adds a new start size gradient (please note that this will only work if you set the targetStopDuration property)
  14635. * @param gradient defines the gradient to use (between 0 and 1)
  14636. * @param factor defines the start size to affect to the specified gradient
  14637. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14638. * @returns the current particle system
  14639. */
  14640. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14641. /**
  14642. * Remove a specific start size gradient
  14643. * @param gradient defines the gradient to remove
  14644. * @returns the current particle system
  14645. */
  14646. removeStartSizeGradient(gradient: number): IParticleSystem;
  14647. /**
  14648. * Gets the current list of start size gradients.
  14649. * You must use addStartSizeGradient and removeStartSizeGradient to udpate this list
  14650. * @returns the list of start size gradients
  14651. */
  14652. getStartSizeGradients(): Nullable<Array<FactorGradient>>;
  14653. /**
  14654. * Adds a new life time gradient
  14655. * @param gradient defines the gradient to use (between 0 and 1)
  14656. * @param factor defines the life time factor to affect to the specified gradient
  14657. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14658. * @returns the current particle system
  14659. */
  14660. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14661. /**
  14662. * Remove a specific life time gradient
  14663. * @param gradient defines the gradient to remove
  14664. * @returns the current particle system
  14665. */
  14666. removeLifeTimeGradient(gradient: number): IParticleSystem;
  14667. /**
  14668. * Gets the current list of life time gradients.
  14669. * You must use addLifeTimeGradient and removeLifeTimeGradient to udpate this list
  14670. * @returns the list of life time gradients
  14671. */
  14672. getLifeTimeGradients(): Nullable<Array<FactorGradient>>;
  14673. /**
  14674. * Gets the current list of color gradients.
  14675. * You must use addColorGradient and removeColorGradient to udpate this list
  14676. * @returns the list of color gradients
  14677. */
  14678. getColorGradients(): Nullable<Array<ColorGradient>>;
  14679. /**
  14680. * Adds a new ramp gradient used to remap particle colors
  14681. * @param gradient defines the gradient to use (between 0 and 1)
  14682. * @param color defines the color to affect to the specified gradient
  14683. * @returns the current particle system
  14684. */
  14685. addRampGradient(gradient: number, color: Color3): IParticleSystem;
  14686. /**
  14687. * Gets the current list of ramp gradients.
  14688. * You must use addRampGradient and removeRampGradient to udpate this list
  14689. * @returns the list of ramp gradients
  14690. */
  14691. getRampGradients(): Nullable<Array<Color3Gradient>>;
  14692. /** Gets or sets a boolean indicating that ramp gradients must be used
  14693. * @see https://doc.babylonjs.com/babylon101/particles#ramp-gradients
  14694. */
  14695. useRampGradients: boolean;
  14696. /**
  14697. * Adds a new color remap gradient
  14698. * @param gradient defines the gradient to use (between 0 and 1)
  14699. * @param min defines the color remap minimal range
  14700. * @param max defines the color remap maximal range
  14701. * @returns the current particle system
  14702. */
  14703. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  14704. /**
  14705. * Gets the current list of color remap gradients.
  14706. * You must use addColorRemapGradient and removeColorRemapGradient to udpate this list
  14707. * @returns the list of color remap gradients
  14708. */
  14709. getColorRemapGradients(): Nullable<Array<FactorGradient>>;
  14710. /**
  14711. * Adds a new alpha remap gradient
  14712. * @param gradient defines the gradient to use (between 0 and 1)
  14713. * @param min defines the alpha remap minimal range
  14714. * @param max defines the alpha remap maximal range
  14715. * @returns the current particle system
  14716. */
  14717. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  14718. /**
  14719. * Gets the current list of alpha remap gradients.
  14720. * You must use addAlphaRemapGradient and removeAlphaRemapGradient to udpate this list
  14721. * @returns the list of alpha remap gradients
  14722. */
  14723. getAlphaRemapGradients(): Nullable<Array<FactorGradient>>;
  14724. /**
  14725. * Creates a Point Emitter for the particle system (emits directly from the emitter position)
  14726. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  14727. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  14728. * @returns the emitter
  14729. */
  14730. createPointEmitter(direction1: Vector3, direction2: Vector3): PointParticleEmitter;
  14731. /**
  14732. * Creates a Hemisphere Emitter for the particle system (emits along the hemisphere radius)
  14733. * @param radius The radius of the hemisphere to emit from
  14734. * @param radiusRange The range of the hemisphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  14735. * @returns the emitter
  14736. */
  14737. createHemisphericEmitter(radius: number, radiusRange: number): HemisphericParticleEmitter;
  14738. /**
  14739. * Creates a Sphere Emitter for the particle system (emits along the sphere radius)
  14740. * @param radius The radius of the sphere to emit from
  14741. * @param radiusRange The range of the sphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  14742. * @returns the emitter
  14743. */
  14744. createSphereEmitter(radius: number, radiusRange: number): SphereParticleEmitter;
  14745. /**
  14746. * Creates a Directed Sphere Emitter for the particle system (emits between direction1 and direction2)
  14747. * @param radius The radius of the sphere to emit from
  14748. * @param direction1 Particles are emitted between the direction1 and direction2 from within the sphere
  14749. * @param direction2 Particles are emitted between the direction1 and direction2 from within the sphere
  14750. * @returns the emitter
  14751. */
  14752. createDirectedSphereEmitter(radius: number, direction1: Vector3, direction2: Vector3): SphereDirectedParticleEmitter;
  14753. /**
  14754. * Creates a Cylinder Emitter for the particle system (emits from the cylinder to the particle position)
  14755. * @param radius The radius of the emission cylinder
  14756. * @param height The height of the emission cylinder
  14757. * @param radiusRange The range of emission [0-1] 0 Surface only, 1 Entire Radius
  14758. * @param directionRandomizer How much to randomize the particle direction [0-1]
  14759. * @returns the emitter
  14760. */
  14761. createCylinderEmitter(radius: number, height: number, radiusRange: number, directionRandomizer: number): CylinderParticleEmitter;
  14762. /**
  14763. * Creates a Directed Cylinder Emitter for the particle system (emits between direction1 and direction2)
  14764. * @param radius The radius of the cylinder to emit from
  14765. * @param height The height of the emission cylinder
  14766. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  14767. * @param direction1 Particles are emitted between the direction1 and direction2 from within the cylinder
  14768. * @param direction2 Particles are emitted between the direction1 and direction2 from within the cylinder
  14769. * @returns the emitter
  14770. */
  14771. createDirectedCylinderEmitter(radius: number, height: number, radiusRange: number, direction1: Vector3, direction2: Vector3): SphereDirectedParticleEmitter;
  14772. /**
  14773. * Creates a Cone Emitter for the particle system (emits from the cone to the particle position)
  14774. * @param radius The radius of the cone to emit from
  14775. * @param angle The base angle of the cone
  14776. * @returns the emitter
  14777. */
  14778. createConeEmitter(radius: number, angle: number): ConeParticleEmitter;
  14779. /**
  14780. * Creates a Box Emitter for the particle system. (emits between direction1 and direction2 from withing the box defined by minEmitBox and maxEmitBox)
  14781. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  14782. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  14783. * @param minEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  14784. * @param maxEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  14785. * @returns the emitter
  14786. */
  14787. createBoxEmitter(direction1: Vector3, direction2: Vector3, minEmitBox: Vector3, maxEmitBox: Vector3): BoxParticleEmitter;
  14788. /**
  14789. * Get hosting scene
  14790. * @returns the scene
  14791. */
  14792. getScene(): Scene;
  14793. }
  14794. }
  14795. declare module "babylonjs/Meshes/transformNode" {
  14796. import { DeepImmutable } from "babylonjs/types";
  14797. import { Observable } from "babylonjs/Misc/observable";
  14798. import { Nullable } from "babylonjs/types";
  14799. import { Camera } from "babylonjs/Cameras/camera";
  14800. import { Scene } from "babylonjs/scene";
  14801. import { Quaternion, Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  14802. import { Node } from "babylonjs/node";
  14803. import { Bone } from "babylonjs/Bones/bone";
  14804. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  14805. import { Space } from "babylonjs/Maths/math.axis";
  14806. /**
  14807. * 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.
  14808. * @see https://doc.babylonjs.com/how_to/transformnode
  14809. */
  14810. export class TransformNode extends Node {
  14811. /**
  14812. * Object will not rotate to face the camera
  14813. */
  14814. static BILLBOARDMODE_NONE: number;
  14815. /**
  14816. * Object will rotate to face the camera but only on the x axis
  14817. */
  14818. static BILLBOARDMODE_X: number;
  14819. /**
  14820. * Object will rotate to face the camera but only on the y axis
  14821. */
  14822. static BILLBOARDMODE_Y: number;
  14823. /**
  14824. * Object will rotate to face the camera but only on the z axis
  14825. */
  14826. static BILLBOARDMODE_Z: number;
  14827. /**
  14828. * Object will rotate to face the camera
  14829. */
  14830. static BILLBOARDMODE_ALL: number;
  14831. /**
  14832. * Object will rotate to face the camera's position instead of orientation
  14833. */
  14834. static BILLBOARDMODE_USE_POSITION: number;
  14835. private static _TmpRotation;
  14836. private static _TmpScaling;
  14837. private static _TmpTranslation;
  14838. private _forward;
  14839. private _forwardInverted;
  14840. private _up;
  14841. private _right;
  14842. private _rightInverted;
  14843. private _position;
  14844. private _rotation;
  14845. private _rotationQuaternion;
  14846. protected _scaling: Vector3;
  14847. protected _isDirty: boolean;
  14848. private _transformToBoneReferal;
  14849. private _isAbsoluteSynced;
  14850. private _billboardMode;
  14851. /**
  14852. * Gets or sets the billboard mode. Default is 0.
  14853. *
  14854. * | Value | Type | Description |
  14855. * | --- | --- | --- |
  14856. * | 0 | BILLBOARDMODE_NONE | |
  14857. * | 1 | BILLBOARDMODE_X | |
  14858. * | 2 | BILLBOARDMODE_Y | |
  14859. * | 4 | BILLBOARDMODE_Z | |
  14860. * | 7 | BILLBOARDMODE_ALL | |
  14861. *
  14862. */
  14863. get billboardMode(): number;
  14864. set billboardMode(value: number);
  14865. private _preserveParentRotationForBillboard;
  14866. /**
  14867. * Gets or sets a boolean indicating that parent rotation should be preserved when using billboards.
  14868. * This could be useful for glTF objects where parent rotation helps converting from right handed to left handed
  14869. */
  14870. get preserveParentRotationForBillboard(): boolean;
  14871. set preserveParentRotationForBillboard(value: boolean);
  14872. /**
  14873. * 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
  14874. */
  14875. scalingDeterminant: number;
  14876. private _infiniteDistance;
  14877. /**
  14878. * Gets or sets the distance of the object to max, often used by skybox
  14879. */
  14880. get infiniteDistance(): boolean;
  14881. set infiniteDistance(value: boolean);
  14882. /**
  14883. * Gets or sets a boolean indicating that non uniform scaling (when at least one component is different from others) should be ignored.
  14884. * By default the system will update normals to compensate
  14885. */
  14886. ignoreNonUniformScaling: boolean;
  14887. /**
  14888. * 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
  14889. */
  14890. reIntegrateRotationIntoRotationQuaternion: boolean;
  14891. /** @hidden */
  14892. _poseMatrix: Nullable<Matrix>;
  14893. /** @hidden */
  14894. _localMatrix: Matrix;
  14895. private _usePivotMatrix;
  14896. private _absolutePosition;
  14897. private _absoluteScaling;
  14898. private _absoluteRotationQuaternion;
  14899. private _pivotMatrix;
  14900. private _pivotMatrixInverse;
  14901. protected _postMultiplyPivotMatrix: boolean;
  14902. protected _isWorldMatrixFrozen: boolean;
  14903. /** @hidden */
  14904. _indexInSceneTransformNodesArray: number;
  14905. /**
  14906. * An event triggered after the world matrix is updated
  14907. */
  14908. onAfterWorldMatrixUpdateObservable: Observable<TransformNode>;
  14909. constructor(name: string, scene?: Nullable<Scene>, isPure?: boolean);
  14910. /**
  14911. * Gets a string identifying the name of the class
  14912. * @returns "TransformNode" string
  14913. */
  14914. getClassName(): string;
  14915. /**
  14916. * Gets or set the node position (default is (0.0, 0.0, 0.0))
  14917. */
  14918. get position(): Vector3;
  14919. set position(newPosition: Vector3);
  14920. /**
  14921. * 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)).
  14922. * If rotation quaternion is set, this Vector3 will be ignored and copy from the quaternion
  14923. */
  14924. get rotation(): Vector3;
  14925. set rotation(newRotation: Vector3);
  14926. /**
  14927. * 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)).
  14928. */
  14929. get scaling(): Vector3;
  14930. set scaling(newScaling: Vector3);
  14931. /**
  14932. * 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).
  14933. * If set, only the rotationQuaternion is then used to compute the node rotation (ie. node.rotation will be ignored)
  14934. */
  14935. get rotationQuaternion(): Nullable<Quaternion>;
  14936. set rotationQuaternion(quaternion: Nullable<Quaternion>);
  14937. /**
  14938. * The forward direction of that transform in world space.
  14939. */
  14940. get forward(): Vector3;
  14941. /**
  14942. * The up direction of that transform in world space.
  14943. */
  14944. get up(): Vector3;
  14945. /**
  14946. * The right direction of that transform in world space.
  14947. */
  14948. get right(): Vector3;
  14949. /**
  14950. * Copies the parameter passed Matrix into the mesh Pose matrix.
  14951. * @param matrix the matrix to copy the pose from
  14952. * @returns this TransformNode.
  14953. */
  14954. updatePoseMatrix(matrix: Matrix): TransformNode;
  14955. /**
  14956. * Returns the mesh Pose matrix.
  14957. * @returns the pose matrix
  14958. */
  14959. getPoseMatrix(): Matrix;
  14960. /** @hidden */
  14961. _isSynchronized(): boolean;
  14962. /** @hidden */
  14963. _initCache(): void;
  14964. /**
  14965. * Flag the transform node as dirty (Forcing it to update everything)
  14966. * @param property if set to "rotation" the objects rotationQuaternion will be set to null
  14967. * @returns this transform node
  14968. */
  14969. markAsDirty(property: string): TransformNode;
  14970. /**
  14971. * Returns the current mesh absolute position.
  14972. * Returns a Vector3.
  14973. */
  14974. get absolutePosition(): Vector3;
  14975. /**
  14976. * Returns the current mesh absolute scaling.
  14977. * Returns a Vector3.
  14978. */
  14979. get absoluteScaling(): Vector3;
  14980. /**
  14981. * Returns the current mesh absolute rotation.
  14982. * Returns a Quaternion.
  14983. */
  14984. get absoluteRotationQuaternion(): Quaternion;
  14985. /**
  14986. * Sets a new matrix to apply before all other transformation
  14987. * @param matrix defines the transform matrix
  14988. * @returns the current TransformNode
  14989. */
  14990. setPreTransformMatrix(matrix: Matrix): TransformNode;
  14991. /**
  14992. * Sets a new pivot matrix to the current node
  14993. * @param matrix defines the new pivot matrix to use
  14994. * @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
  14995. * @returns the current TransformNode
  14996. */
  14997. setPivotMatrix(matrix: DeepImmutable<Matrix>, postMultiplyPivotMatrix?: boolean): TransformNode;
  14998. /**
  14999. * Returns the mesh pivot matrix.
  15000. * Default : Identity.
  15001. * @returns the matrix
  15002. */
  15003. getPivotMatrix(): Matrix;
  15004. /**
  15005. * Instantiate (when possible) or clone that node with its hierarchy
  15006. * @param newParent defines the new parent to use for the instance (or clone)
  15007. * @param options defines options to configure how copy is done
  15008. * @param onNewNodeCreated defines an option callback to call when a clone or an instance is created
  15009. * @returns an instance (or a clone) of the current node with its hiearchy
  15010. */
  15011. instantiateHierarchy(newParent?: Nullable<TransformNode>, options?: {
  15012. doNotInstantiate: boolean;
  15013. }, onNewNodeCreated?: (source: TransformNode, clone: TransformNode) => void): Nullable<TransformNode>;
  15014. /**
  15015. * Prevents the World matrix to be computed any longer
  15016. * @param newWorldMatrix defines an optional matrix to use as world matrix
  15017. * @returns the TransformNode.
  15018. */
  15019. freezeWorldMatrix(newWorldMatrix?: Nullable<Matrix>): TransformNode;
  15020. /**
  15021. * Allows back the World matrix computation.
  15022. * @returns the TransformNode.
  15023. */
  15024. unfreezeWorldMatrix(): this;
  15025. /**
  15026. * True if the World matrix has been frozen.
  15027. */
  15028. get isWorldMatrixFrozen(): boolean;
  15029. /**
  15030. * Retuns the mesh absolute position in the World.
  15031. * @returns a Vector3.
  15032. */
  15033. getAbsolutePosition(): Vector3;
  15034. /**
  15035. * Sets the mesh absolute position in the World from a Vector3 or an Array(3).
  15036. * @param absolutePosition the absolute position to set
  15037. * @returns the TransformNode.
  15038. */
  15039. setAbsolutePosition(absolutePosition: Vector3): TransformNode;
  15040. /**
  15041. * Sets the mesh position in its local space.
  15042. * @param vector3 the position to set in localspace
  15043. * @returns the TransformNode.
  15044. */
  15045. setPositionWithLocalVector(vector3: Vector3): TransformNode;
  15046. /**
  15047. * Returns the mesh position in the local space from the current World matrix values.
  15048. * @returns a new Vector3.
  15049. */
  15050. getPositionExpressedInLocalSpace(): Vector3;
  15051. /**
  15052. * Translates the mesh along the passed Vector3 in its local space.
  15053. * @param vector3 the distance to translate in localspace
  15054. * @returns the TransformNode.
  15055. */
  15056. locallyTranslate(vector3: Vector3): TransformNode;
  15057. private static _lookAtVectorCache;
  15058. /**
  15059. * Orients a mesh towards a target point. Mesh must be drawn facing user.
  15060. * @param targetPoint the position (must be in same space as current mesh) to look at
  15061. * @param yawCor optional yaw (y-axis) correction in radians
  15062. * @param pitchCor optional pitch (x-axis) correction in radians
  15063. * @param rollCor optional roll (z-axis) correction in radians
  15064. * @param space the choosen space of the target
  15065. * @returns the TransformNode.
  15066. */
  15067. lookAt(targetPoint: Vector3, yawCor?: number, pitchCor?: number, rollCor?: number, space?: Space): TransformNode;
  15068. /**
  15069. * Returns a new Vector3 that is the localAxis, expressed in the mesh local space, rotated like the mesh.
  15070. * This Vector3 is expressed in the World space.
  15071. * @param localAxis axis to rotate
  15072. * @returns a new Vector3 that is the localAxis, expressed in the mesh local space, rotated like the mesh.
  15073. */
  15074. getDirection(localAxis: Vector3): Vector3;
  15075. /**
  15076. * Sets the Vector3 "result" as the rotated Vector3 "localAxis" in the same rotation than the mesh.
  15077. * localAxis is expressed in the mesh local space.
  15078. * result is computed in the Wordl space from the mesh World matrix.
  15079. * @param localAxis axis to rotate
  15080. * @param result the resulting transformnode
  15081. * @returns this TransformNode.
  15082. */
  15083. getDirectionToRef(localAxis: Vector3, result: Vector3): TransformNode;
  15084. /**
  15085. * Sets this transform node rotation to the given local axis.
  15086. * @param localAxis the axis in local space
  15087. * @param yawCor optional yaw (y-axis) correction in radians
  15088. * @param pitchCor optional pitch (x-axis) correction in radians
  15089. * @param rollCor optional roll (z-axis) correction in radians
  15090. * @returns this TransformNode
  15091. */
  15092. setDirection(localAxis: Vector3, yawCor?: number, pitchCor?: number, rollCor?: number): TransformNode;
  15093. /**
  15094. * Sets a new pivot point to the current node
  15095. * @param point defines the new pivot point to use
  15096. * @param space defines if the point is in world or local space (local by default)
  15097. * @returns the current TransformNode
  15098. */
  15099. setPivotPoint(point: Vector3, space?: Space): TransformNode;
  15100. /**
  15101. * Returns a new Vector3 set with the mesh pivot point coordinates in the local space.
  15102. * @returns the pivot point
  15103. */
  15104. getPivotPoint(): Vector3;
  15105. /**
  15106. * Sets the passed Vector3 "result" with the coordinates of the mesh pivot point in the local space.
  15107. * @param result the vector3 to store the result
  15108. * @returns this TransformNode.
  15109. */
  15110. getPivotPointToRef(result: Vector3): TransformNode;
  15111. /**
  15112. * Returns a new Vector3 set with the mesh pivot point World coordinates.
  15113. * @returns a new Vector3 set with the mesh pivot point World coordinates.
  15114. */
  15115. getAbsolutePivotPoint(): Vector3;
  15116. /**
  15117. * Sets the Vector3 "result" coordinates with the mesh pivot point World coordinates.
  15118. * @param result vector3 to store the result
  15119. * @returns this TransformNode.
  15120. */
  15121. getAbsolutePivotPointToRef(result: Vector3): TransformNode;
  15122. /**
  15123. * Defines the passed node as the parent of the current node.
  15124. * The node will remain exactly where it is and its position / rotation will be updated accordingly
  15125. * @see https://doc.babylonjs.com/how_to/parenting
  15126. * @param node the node ot set as the parent
  15127. * @returns this TransformNode.
  15128. */
  15129. setParent(node: Nullable<Node>): TransformNode;
  15130. private _nonUniformScaling;
  15131. /**
  15132. * True if the scaling property of this object is non uniform eg. (1,2,1)
  15133. */
  15134. get nonUniformScaling(): boolean;
  15135. /** @hidden */
  15136. _updateNonUniformScalingState(value: boolean): boolean;
  15137. /**
  15138. * Attach the current TransformNode to another TransformNode associated with a bone
  15139. * @param bone Bone affecting the TransformNode
  15140. * @param affectedTransformNode TransformNode associated with the bone
  15141. * @returns this object
  15142. */
  15143. attachToBone(bone: Bone, affectedTransformNode: TransformNode): TransformNode;
  15144. /**
  15145. * Detach the transform node if its associated with a bone
  15146. * @returns this object
  15147. */
  15148. detachFromBone(): TransformNode;
  15149. private static _rotationAxisCache;
  15150. /**
  15151. * Rotates the mesh around the axis vector for the passed angle (amount) expressed in radians, in the given space.
  15152. * space (default LOCAL) can be either Space.LOCAL, either Space.WORLD.
  15153. * Note that the property `rotationQuaternion` is then automatically updated and the property `rotation` is set to (0,0,0) and no longer used.
  15154. * The passed axis is also normalized.
  15155. * @param axis the axis to rotate around
  15156. * @param amount the amount to rotate in radians
  15157. * @param space Space to rotate in (Default: local)
  15158. * @returns the TransformNode.
  15159. */
  15160. rotate(axis: Vector3, amount: number, space?: Space): TransformNode;
  15161. /**
  15162. * Rotates the mesh around the axis vector for the passed angle (amount) expressed in radians, in world space.
  15163. * Note that the property `rotationQuaternion` is then automatically updated and the property `rotation` is set to (0,0,0) and no longer used.
  15164. * The passed axis is also normalized. .
  15165. * Method is based on http://www.euclideanspace.com/maths/geometry/affine/aroundPoint/index.htm
  15166. * @param point the point to rotate around
  15167. * @param axis the axis to rotate around
  15168. * @param amount the amount to rotate in radians
  15169. * @returns the TransformNode
  15170. */
  15171. rotateAround(point: Vector3, axis: Vector3, amount: number): TransformNode;
  15172. /**
  15173. * Translates the mesh along the axis vector for the passed distance in the given space.
  15174. * space (default LOCAL) can be either Space.LOCAL, either Space.WORLD.
  15175. * @param axis the axis to translate in
  15176. * @param distance the distance to translate
  15177. * @param space Space to rotate in (Default: local)
  15178. * @returns the TransformNode.
  15179. */
  15180. translate(axis: Vector3, distance: number, space?: Space): TransformNode;
  15181. /**
  15182. * Adds a rotation step to the mesh current rotation.
  15183. * x, y, z are Euler angles expressed in radians.
  15184. * This methods updates the current mesh rotation, either mesh.rotation, either mesh.rotationQuaternion if it's set.
  15185. * This means this rotation is made in the mesh local space only.
  15186. * It's useful to set a custom rotation order different from the BJS standard one YXZ.
  15187. * Example : this rotates the mesh first around its local X axis, then around its local Z axis, finally around its local Y axis.
  15188. * ```javascript
  15189. * mesh.addRotation(x1, 0, 0).addRotation(0, 0, z2).addRotation(0, 0, y3);
  15190. * ```
  15191. * Note that `addRotation()` accumulates the passed rotation values to the current ones and computes the .rotation or .rotationQuaternion updated values.
  15192. * 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.
  15193. * @param x Rotation to add
  15194. * @param y Rotation to add
  15195. * @param z Rotation to add
  15196. * @returns the TransformNode.
  15197. */
  15198. addRotation(x: number, y: number, z: number): TransformNode;
  15199. /**
  15200. * @hidden
  15201. */
  15202. protected _getEffectiveParent(): Nullable<Node>;
  15203. /**
  15204. * Computes the world matrix of the node
  15205. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  15206. * @returns the world matrix
  15207. */
  15208. computeWorldMatrix(force?: boolean): Matrix;
  15209. /**
  15210. * Resets this nodeTransform's local matrix to Matrix.Identity().
  15211. * @param independentOfChildren indicates if all child nodeTransform's world-space transform should be preserved.
  15212. */
  15213. resetLocalMatrix(independentOfChildren?: boolean): void;
  15214. protected _afterComputeWorldMatrix(): void;
  15215. /**
  15216. * If you'd like to be called back after the mesh position, rotation or scaling has been updated.
  15217. * @param func callback function to add
  15218. *
  15219. * @returns the TransformNode.
  15220. */
  15221. registerAfterWorldMatrixUpdate(func: (mesh: TransformNode) => void): TransformNode;
  15222. /**
  15223. * Removes a registered callback function.
  15224. * @param func callback function to remove
  15225. * @returns the TransformNode.
  15226. */
  15227. unregisterAfterWorldMatrixUpdate(func: (mesh: TransformNode) => void): TransformNode;
  15228. /**
  15229. * Gets the position of the current mesh in camera space
  15230. * @param camera defines the camera to use
  15231. * @returns a position
  15232. */
  15233. getPositionInCameraSpace(camera?: Nullable<Camera>): Vector3;
  15234. /**
  15235. * Returns the distance from the mesh to the active camera
  15236. * @param camera defines the camera to use
  15237. * @returns the distance
  15238. */
  15239. getDistanceToCamera(camera?: Nullable<Camera>): number;
  15240. /**
  15241. * Clone the current transform node
  15242. * @param name Name of the new clone
  15243. * @param newParent New parent for the clone
  15244. * @param doNotCloneChildren Do not clone children hierarchy
  15245. * @returns the new transform node
  15246. */
  15247. clone(name: string, newParent: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<TransformNode>;
  15248. /**
  15249. * Serializes the objects information.
  15250. * @param currentSerializationObject defines the object to serialize in
  15251. * @returns the serialized object
  15252. */
  15253. serialize(currentSerializationObject?: any): any;
  15254. /**
  15255. * Returns a new TransformNode object parsed from the source provided.
  15256. * @param parsedTransformNode is the source.
  15257. * @param scene the scne the object belongs to
  15258. * @param rootUrl is a string, it's the root URL to prefix the `delayLoadingFile` property with
  15259. * @returns a new TransformNode object parsed from the source provided.
  15260. */
  15261. static Parse(parsedTransformNode: any, scene: Scene, rootUrl: string): TransformNode;
  15262. /**
  15263. * Get all child-transformNodes of this node
  15264. * @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
  15265. * @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
  15266. * @returns an array of TransformNode
  15267. */
  15268. getChildTransformNodes(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): TransformNode[];
  15269. /**
  15270. * Releases resources associated with this transform node.
  15271. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  15272. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  15273. */
  15274. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  15275. /**
  15276. * Uniformly scales the mesh to fit inside of a unit cube (1 X 1 X 1 units)
  15277. * @param includeDescendants Use the hierarchy's bounding box instead of the mesh's bounding box. Default is false
  15278. * @param ignoreRotation ignore rotation when computing the scale (ie. object will be axis aligned). Default is false
  15279. * @param predicate predicate that is passed in to getHierarchyBoundingVectors when selecting which object should be included when scaling
  15280. * @returns the current mesh
  15281. */
  15282. normalizeToUnitCube(includeDescendants?: boolean, ignoreRotation?: boolean, predicate?: Nullable<(node: AbstractMesh) => boolean>): TransformNode;
  15283. private _syncAbsoluteScalingAndRotation;
  15284. }
  15285. }
  15286. declare module "babylonjs/Animations/animationPropertiesOverride" {
  15287. /**
  15288. * Class used to override all child animations of a given target
  15289. */
  15290. export class AnimationPropertiesOverride {
  15291. /**
  15292. * Gets or sets a value indicating if animation blending must be used
  15293. */
  15294. enableBlending: boolean;
  15295. /**
  15296. * Gets or sets the blending speed to use when enableBlending is true
  15297. */
  15298. blendingSpeed: number;
  15299. /**
  15300. * Gets or sets the default loop mode to use
  15301. */
  15302. loopMode: number;
  15303. }
  15304. }
  15305. declare module "babylonjs/Bones/bone" {
  15306. import { Skeleton } from "babylonjs/Bones/skeleton";
  15307. import { Vector3, Quaternion, Matrix } from "babylonjs/Maths/math.vector";
  15308. import { Nullable } from "babylonjs/types";
  15309. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  15310. import { TransformNode } from "babylonjs/Meshes/transformNode";
  15311. import { Node } from "babylonjs/node";
  15312. import { Space } from "babylonjs/Maths/math.axis";
  15313. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  15314. /**
  15315. * Class used to store bone information
  15316. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  15317. */
  15318. export class Bone extends Node {
  15319. /**
  15320. * defines the bone name
  15321. */
  15322. name: string;
  15323. private static _tmpVecs;
  15324. private static _tmpQuat;
  15325. private static _tmpMats;
  15326. /**
  15327. * Gets the list of child bones
  15328. */
  15329. children: Bone[];
  15330. /** Gets the animations associated with this bone */
  15331. animations: import("babylonjs/Animations/animation").Animation[];
  15332. /**
  15333. * Gets or sets bone length
  15334. */
  15335. length: number;
  15336. /**
  15337. * @hidden Internal only
  15338. * Set this value to map this bone to a different index in the transform matrices
  15339. * Set this value to -1 to exclude the bone from the transform matrices
  15340. */
  15341. _index: Nullable<number>;
  15342. private _skeleton;
  15343. private _localMatrix;
  15344. private _restPose;
  15345. private _baseMatrix;
  15346. private _absoluteTransform;
  15347. private _invertedAbsoluteTransform;
  15348. private _parent;
  15349. private _scalingDeterminant;
  15350. private _worldTransform;
  15351. private _localScaling;
  15352. private _localRotation;
  15353. private _localPosition;
  15354. private _needToDecompose;
  15355. private _needToCompose;
  15356. /** @hidden */
  15357. _linkedTransformNode: Nullable<TransformNode>;
  15358. /** @hidden */
  15359. _waitingTransformNodeId: Nullable<string>;
  15360. /** @hidden */
  15361. get _matrix(): Matrix;
  15362. /** @hidden */
  15363. set _matrix(value: Matrix);
  15364. /**
  15365. * Create a new bone
  15366. * @param name defines the bone name
  15367. * @param skeleton defines the parent skeleton
  15368. * @param parentBone defines the parent (can be null if the bone is the root)
  15369. * @param localMatrix defines the local matrix
  15370. * @param restPose defines the rest pose matrix
  15371. * @param baseMatrix defines the base matrix
  15372. * @param index defines index of the bone in the hiearchy
  15373. */
  15374. constructor(
  15375. /**
  15376. * defines the bone name
  15377. */
  15378. name: string, skeleton: Skeleton, parentBone?: Nullable<Bone>, localMatrix?: Nullable<Matrix>, restPose?: Nullable<Matrix>, baseMatrix?: Nullable<Matrix>, index?: Nullable<number>);
  15379. /**
  15380. * Gets the current object class name.
  15381. * @return the class name
  15382. */
  15383. getClassName(): string;
  15384. /**
  15385. * Gets the parent skeleton
  15386. * @returns a skeleton
  15387. */
  15388. getSkeleton(): Skeleton;
  15389. /**
  15390. * Gets parent bone
  15391. * @returns a bone or null if the bone is the root of the bone hierarchy
  15392. */
  15393. getParent(): Nullable<Bone>;
  15394. /**
  15395. * Returns an array containing the root bones
  15396. * @returns an array containing the root bones
  15397. */
  15398. getChildren(): Array<Bone>;
  15399. /**
  15400. * Gets the node index in matrix array generated for rendering
  15401. * @returns the node index
  15402. */
  15403. getIndex(): number;
  15404. /**
  15405. * Sets the parent bone
  15406. * @param parent defines the parent (can be null if the bone is the root)
  15407. * @param updateDifferenceMatrix defines if the difference matrix must be updated
  15408. */
  15409. setParent(parent: Nullable<Bone>, updateDifferenceMatrix?: boolean): void;
  15410. /**
  15411. * Gets the local matrix
  15412. * @returns a matrix
  15413. */
  15414. getLocalMatrix(): Matrix;
  15415. /**
  15416. * Gets the base matrix (initial matrix which remains unchanged)
  15417. * @returns a matrix
  15418. */
  15419. getBaseMatrix(): Matrix;
  15420. /**
  15421. * Gets the rest pose matrix
  15422. * @returns a matrix
  15423. */
  15424. getRestPose(): Matrix;
  15425. /**
  15426. * Gets a matrix used to store world matrix (ie. the matrix sent to shaders)
  15427. */
  15428. getWorldMatrix(): Matrix;
  15429. /**
  15430. * Sets the local matrix to rest pose matrix
  15431. */
  15432. returnToRest(): void;
  15433. /**
  15434. * Gets the inverse of the absolute transform matrix.
  15435. * This matrix will be multiplied by local matrix to get the difference matrix (ie. the difference between original state and current state)
  15436. * @returns a matrix
  15437. */
  15438. getInvertedAbsoluteTransform(): Matrix;
  15439. /**
  15440. * Gets the absolute transform matrix (ie base matrix * parent world matrix)
  15441. * @returns a matrix
  15442. */
  15443. getAbsoluteTransform(): Matrix;
  15444. /**
  15445. * Links with the given transform node.
  15446. * The local matrix of this bone is copied from the transform node every frame.
  15447. * @param transformNode defines the transform node to link to
  15448. */
  15449. linkTransformNode(transformNode: Nullable<TransformNode>): void;
  15450. /**
  15451. * Gets the node used to drive the bone's transformation
  15452. * @returns a transform node or null
  15453. */
  15454. getTransformNode(): Nullable<TransformNode>;
  15455. /** Gets or sets current position (in local space) */
  15456. get position(): Vector3;
  15457. set position(newPosition: Vector3);
  15458. /** Gets or sets current rotation (in local space) */
  15459. get rotation(): Vector3;
  15460. set rotation(newRotation: Vector3);
  15461. /** Gets or sets current rotation quaternion (in local space) */
  15462. get rotationQuaternion(): Quaternion;
  15463. set rotationQuaternion(newRotation: Quaternion);
  15464. /** Gets or sets current scaling (in local space) */
  15465. get scaling(): Vector3;
  15466. set scaling(newScaling: Vector3);
  15467. /**
  15468. * Gets the animation properties override
  15469. */
  15470. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  15471. private _decompose;
  15472. private _compose;
  15473. /**
  15474. * Update the base and local matrices
  15475. * @param matrix defines the new base or local matrix
  15476. * @param updateDifferenceMatrix defines if the difference matrix must be updated
  15477. * @param updateLocalMatrix defines if the local matrix should be updated
  15478. */
  15479. updateMatrix(matrix: Matrix, updateDifferenceMatrix?: boolean, updateLocalMatrix?: boolean): void;
  15480. /** @hidden */
  15481. _updateDifferenceMatrix(rootMatrix?: Matrix, updateChildren?: boolean): void;
  15482. /**
  15483. * Flag the bone as dirty (Forcing it to update everything)
  15484. */
  15485. markAsDirty(): void;
  15486. /** @hidden */
  15487. _markAsDirtyAndCompose(): void;
  15488. private _markAsDirtyAndDecompose;
  15489. /**
  15490. * Translate the bone in local or world space
  15491. * @param vec The amount to translate the bone
  15492. * @param space The space that the translation is in
  15493. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15494. */
  15495. translate(vec: Vector3, space?: Space, mesh?: AbstractMesh): void;
  15496. /**
  15497. * Set the postion of the bone in local or world space
  15498. * @param position The position to set the bone
  15499. * @param space The space that the position is in
  15500. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15501. */
  15502. setPosition(position: Vector3, space?: Space, mesh?: AbstractMesh): void;
  15503. /**
  15504. * Set the absolute position of the bone (world space)
  15505. * @param position The position to set the bone
  15506. * @param mesh The mesh that this bone is attached to
  15507. */
  15508. setAbsolutePosition(position: Vector3, mesh?: AbstractMesh): void;
  15509. /**
  15510. * Scale the bone on the x, y and z axes (in local space)
  15511. * @param x The amount to scale the bone on the x axis
  15512. * @param y The amount to scale the bone on the y axis
  15513. * @param z The amount to scale the bone on the z axis
  15514. * @param scaleChildren sets this to true if children of the bone should be scaled as well (false by default)
  15515. */
  15516. scale(x: number, y: number, z: number, scaleChildren?: boolean): void;
  15517. /**
  15518. * Set the bone scaling in local space
  15519. * @param scale defines the scaling vector
  15520. */
  15521. setScale(scale: Vector3): void;
  15522. /**
  15523. * Gets the current scaling in local space
  15524. * @returns the current scaling vector
  15525. */
  15526. getScale(): Vector3;
  15527. /**
  15528. * Gets the current scaling in local space and stores it in a target vector
  15529. * @param result defines the target vector
  15530. */
  15531. getScaleToRef(result: Vector3): void;
  15532. /**
  15533. * Set the yaw, pitch, and roll of the bone in local or world space
  15534. * @param yaw The rotation of the bone on the y axis
  15535. * @param pitch The rotation of the bone on the x axis
  15536. * @param roll The rotation of the bone on the z axis
  15537. * @param space The space that the axes of rotation are in
  15538. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15539. */
  15540. setYawPitchRoll(yaw: number, pitch: number, roll: number, space?: Space, mesh?: AbstractMesh): void;
  15541. /**
  15542. * Add a rotation to the bone on an axis in local or world space
  15543. * @param axis The axis to rotate the bone on
  15544. * @param amount The amount to rotate the bone
  15545. * @param space The space that the axis is in
  15546. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15547. */
  15548. rotate(axis: Vector3, amount: number, space?: Space, mesh?: AbstractMesh): void;
  15549. /**
  15550. * Set the rotation of the bone to a particular axis angle in local or world space
  15551. * @param axis The axis to rotate the bone on
  15552. * @param angle The angle that the bone should be rotated to
  15553. * @param space The space that the axis is in
  15554. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15555. */
  15556. setAxisAngle(axis: Vector3, angle: number, space?: Space, mesh?: AbstractMesh): void;
  15557. /**
  15558. * Set the euler rotation of the bone in local of world space
  15559. * @param rotation The euler rotation that the bone should be set to
  15560. * @param space The space that the rotation is in
  15561. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15562. */
  15563. setRotation(rotation: Vector3, space?: Space, mesh?: AbstractMesh): void;
  15564. /**
  15565. * Set the quaternion rotation of the bone in local of world space
  15566. * @param quat The quaternion rotation that the bone should be set to
  15567. * @param space The space that the rotation is in
  15568. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15569. */
  15570. setRotationQuaternion(quat: Quaternion, space?: Space, mesh?: AbstractMesh): void;
  15571. /**
  15572. * Set the rotation matrix of the bone in local of world space
  15573. * @param rotMat The rotation matrix that the bone should be set to
  15574. * @param space The space that the rotation is in
  15575. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15576. */
  15577. setRotationMatrix(rotMat: Matrix, space?: Space, mesh?: AbstractMesh): void;
  15578. private _rotateWithMatrix;
  15579. private _getNegativeRotationToRef;
  15580. /**
  15581. * Get the position of the bone in local or world space
  15582. * @param space The space that the returned position is in
  15583. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15584. * @returns The position of the bone
  15585. */
  15586. getPosition(space?: Space, mesh?: Nullable<AbstractMesh>): Vector3;
  15587. /**
  15588. * Copy the position of the bone to a vector3 in local or world space
  15589. * @param space The space that the returned position is in
  15590. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15591. * @param result The vector3 to copy the position to
  15592. */
  15593. getPositionToRef(space: Space | undefined, mesh: Nullable<AbstractMesh>, result: Vector3): void;
  15594. /**
  15595. * Get the absolute position of the bone (world space)
  15596. * @param mesh The mesh that this bone is attached to
  15597. * @returns The absolute position of the bone
  15598. */
  15599. getAbsolutePosition(mesh?: Nullable<AbstractMesh>): Vector3;
  15600. /**
  15601. * Copy the absolute position of the bone (world space) to the result param
  15602. * @param mesh The mesh that this bone is attached to
  15603. * @param result The vector3 to copy the absolute position to
  15604. */
  15605. getAbsolutePositionToRef(mesh: AbstractMesh, result: Vector3): void;
  15606. /**
  15607. * Compute the absolute transforms of this bone and its children
  15608. */
  15609. computeAbsoluteTransforms(): void;
  15610. /**
  15611. * Get the world direction from an axis that is in the local space of the bone
  15612. * @param localAxis The local direction that is used to compute the world direction
  15613. * @param mesh The mesh that this bone is attached to
  15614. * @returns The world direction
  15615. */
  15616. getDirection(localAxis: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  15617. /**
  15618. * Copy the world direction to a vector3 from an axis that is in the local space of the bone
  15619. * @param localAxis The local direction that is used to compute the world direction
  15620. * @param mesh The mesh that this bone is attached to
  15621. * @param result The vector3 that the world direction will be copied to
  15622. */
  15623. getDirectionToRef(localAxis: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  15624. /**
  15625. * Get the euler rotation of the bone in local or world space
  15626. * @param space The space that the rotation should be in
  15627. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15628. * @returns The euler rotation
  15629. */
  15630. getRotation(space?: Space, mesh?: Nullable<AbstractMesh>): Vector3;
  15631. /**
  15632. * Copy the euler rotation of the bone to a vector3. The rotation can be in either local or world space
  15633. * @param space The space that the rotation should be in
  15634. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15635. * @param result The vector3 that the rotation should be copied to
  15636. */
  15637. getRotationToRef(space: Space | undefined, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  15638. /**
  15639. * Get the quaternion rotation of the bone in either local or world space
  15640. * @param space The space that the rotation should be in
  15641. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15642. * @returns The quaternion rotation
  15643. */
  15644. getRotationQuaternion(space?: Space, mesh?: Nullable<AbstractMesh>): Quaternion;
  15645. /**
  15646. * Copy the quaternion rotation of the bone to a quaternion. The rotation can be in either local or world space
  15647. * @param space The space that the rotation should be in
  15648. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15649. * @param result The quaternion that the rotation should be copied to
  15650. */
  15651. getRotationQuaternionToRef(space: Space | undefined, mesh: AbstractMesh | null | undefined, result: Quaternion): void;
  15652. /**
  15653. * Get the rotation matrix of the bone in local or world space
  15654. * @param space The space that the rotation should be in
  15655. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15656. * @returns The rotation matrix
  15657. */
  15658. getRotationMatrix(space: Space | undefined, mesh: AbstractMesh): Matrix;
  15659. /**
  15660. * Copy the rotation matrix of the bone to a matrix. The rotation can be in either local or world space
  15661. * @param space The space that the rotation should be in
  15662. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15663. * @param result The quaternion that the rotation should be copied to
  15664. */
  15665. getRotationMatrixToRef(space: Space | undefined, mesh: AbstractMesh, result: Matrix): void;
  15666. /**
  15667. * Get the world position of a point that is in the local space of the bone
  15668. * @param position The local position
  15669. * @param mesh The mesh that this bone is attached to
  15670. * @returns The world position
  15671. */
  15672. getAbsolutePositionFromLocal(position: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  15673. /**
  15674. * Get the world position of a point that is in the local space of the bone and copy it to the result param
  15675. * @param position The local position
  15676. * @param mesh The mesh that this bone is attached to
  15677. * @param result The vector3 that the world position should be copied to
  15678. */
  15679. getAbsolutePositionFromLocalToRef(position: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  15680. /**
  15681. * Get the local position of a point that is in world space
  15682. * @param position The world position
  15683. * @param mesh The mesh that this bone is attached to
  15684. * @returns The local position
  15685. */
  15686. getLocalPositionFromAbsolute(position: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  15687. /**
  15688. * Get the local position of a point that is in world space and copy it to the result param
  15689. * @param position The world position
  15690. * @param mesh The mesh that this bone is attached to
  15691. * @param result The vector3 that the local position should be copied to
  15692. */
  15693. getLocalPositionFromAbsoluteToRef(position: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  15694. }
  15695. }
  15696. declare module "babylonjs/Animations/runtimeAnimation" {
  15697. import { Animation, _IAnimationState } from "babylonjs/Animations/animation";
  15698. import { Animatable } from "babylonjs/Animations/animatable";
  15699. import { Scene } from "babylonjs/scene";
  15700. /**
  15701. * Defines a runtime animation
  15702. */
  15703. export class RuntimeAnimation {
  15704. private _events;
  15705. /**
  15706. * The current frame of the runtime animation
  15707. */
  15708. private _currentFrame;
  15709. /**
  15710. * The animation used by the runtime animation
  15711. */
  15712. private _animation;
  15713. /**
  15714. * The target of the runtime animation
  15715. */
  15716. private _target;
  15717. /**
  15718. * The initiating animatable
  15719. */
  15720. private _host;
  15721. /**
  15722. * The original value of the runtime animation
  15723. */
  15724. private _originalValue;
  15725. /**
  15726. * The original blend value of the runtime animation
  15727. */
  15728. private _originalBlendValue;
  15729. /**
  15730. * The offsets cache of the runtime animation
  15731. */
  15732. private _offsetsCache;
  15733. /**
  15734. * The high limits cache of the runtime animation
  15735. */
  15736. private _highLimitsCache;
  15737. /**
  15738. * Specifies if the runtime animation has been stopped
  15739. */
  15740. private _stopped;
  15741. /**
  15742. * The blending factor of the runtime animation
  15743. */
  15744. private _blendingFactor;
  15745. /**
  15746. * The BabylonJS scene
  15747. */
  15748. private _scene;
  15749. /**
  15750. * The current value of the runtime animation
  15751. */
  15752. private _currentValue;
  15753. /** @hidden */
  15754. _animationState: _IAnimationState;
  15755. /**
  15756. * The active target of the runtime animation
  15757. */
  15758. private _activeTargets;
  15759. private _currentActiveTarget;
  15760. private _directTarget;
  15761. /**
  15762. * The target path of the runtime animation
  15763. */
  15764. private _targetPath;
  15765. /**
  15766. * The weight of the runtime animation
  15767. */
  15768. private _weight;
  15769. /**
  15770. * The ratio offset of the runtime animation
  15771. */
  15772. private _ratioOffset;
  15773. /**
  15774. * The previous delay of the runtime animation
  15775. */
  15776. private _previousDelay;
  15777. /**
  15778. * The previous ratio of the runtime animation
  15779. */
  15780. private _previousRatio;
  15781. private _enableBlending;
  15782. private _keys;
  15783. private _minFrame;
  15784. private _maxFrame;
  15785. private _minValue;
  15786. private _maxValue;
  15787. private _targetIsArray;
  15788. /**
  15789. * Gets the current frame of the runtime animation
  15790. */
  15791. get currentFrame(): number;
  15792. /**
  15793. * Gets the weight of the runtime animation
  15794. */
  15795. get weight(): number;
  15796. /**
  15797. * Gets the current value of the runtime animation
  15798. */
  15799. get currentValue(): any;
  15800. /**
  15801. * Gets the target path of the runtime animation
  15802. */
  15803. get targetPath(): string;
  15804. /**
  15805. * Gets the actual target of the runtime animation
  15806. */
  15807. get target(): any;
  15808. /**
  15809. * Gets the additive state of the runtime animation
  15810. */
  15811. get isAdditive(): boolean;
  15812. /** @hidden */
  15813. _onLoop: () => void;
  15814. /**
  15815. * Create a new RuntimeAnimation object
  15816. * @param target defines the target of the animation
  15817. * @param animation defines the source animation object
  15818. * @param scene defines the hosting scene
  15819. * @param host defines the initiating Animatable
  15820. */
  15821. constructor(target: any, animation: Animation, scene: Scene, host: Animatable);
  15822. private _preparePath;
  15823. /**
  15824. * Gets the animation from the runtime animation
  15825. */
  15826. get animation(): Animation;
  15827. /**
  15828. * Resets the runtime animation to the beginning
  15829. * @param restoreOriginal defines whether to restore the target property to the original value
  15830. */
  15831. reset(restoreOriginal?: boolean): void;
  15832. /**
  15833. * Specifies if the runtime animation is stopped
  15834. * @returns Boolean specifying if the runtime animation is stopped
  15835. */
  15836. isStopped(): boolean;
  15837. /**
  15838. * Disposes of the runtime animation
  15839. */
  15840. dispose(): void;
  15841. /**
  15842. * Apply the interpolated value to the target
  15843. * @param currentValue defines the value computed by the animation
  15844. * @param weight defines the weight to apply to this value (Defaults to 1.0)
  15845. */
  15846. setValue(currentValue: any, weight: number): void;
  15847. private _getOriginalValues;
  15848. private _setValue;
  15849. /**
  15850. * Gets the loop pmode of the runtime animation
  15851. * @returns Loop Mode
  15852. */
  15853. private _getCorrectLoopMode;
  15854. /**
  15855. * Move the current animation to a given frame
  15856. * @param frame defines the frame to move to
  15857. */
  15858. goToFrame(frame: number): void;
  15859. /**
  15860. * @hidden Internal use only
  15861. */
  15862. _prepareForSpeedRatioChange(newSpeedRatio: number): void;
  15863. /**
  15864. * Execute the current animation
  15865. * @param delay defines the delay to add to the current frame
  15866. * @param from defines the lower bound of the animation range
  15867. * @param to defines the upper bound of the animation range
  15868. * @param loop defines if the current animation must loop
  15869. * @param speedRatio defines the current speed ratio
  15870. * @param weight defines the weight of the animation (default is -1 so no weight)
  15871. * @param onLoop optional callback called when animation loops
  15872. * @returns a boolean indicating if the animation is running
  15873. */
  15874. animate(delay: number, from: number, to: number, loop: boolean, speedRatio: number, weight?: number): boolean;
  15875. }
  15876. }
  15877. declare module "babylonjs/Animations/animatable" {
  15878. import { Animation } from "babylonjs/Animations/animation";
  15879. import { RuntimeAnimation } from "babylonjs/Animations/runtimeAnimation";
  15880. import { Nullable } from "babylonjs/types";
  15881. import { Observable } from "babylonjs/Misc/observable";
  15882. import { Scene } from "babylonjs/scene";
  15883. import { Matrix, Quaternion, Vector3 } from "babylonjs/Maths/math.vector";
  15884. import { Node } from "babylonjs/node";
  15885. /**
  15886. * Class used to store an actual running animation
  15887. */
  15888. export class Animatable {
  15889. /** defines the target object */
  15890. target: any;
  15891. /** defines the starting frame number (default is 0) */
  15892. fromFrame: number;
  15893. /** defines the ending frame number (default is 100) */
  15894. toFrame: number;
  15895. /** defines if the animation must loop (default is false) */
  15896. loopAnimation: boolean;
  15897. /** defines a callback to call when animation ends if it is not looping */
  15898. onAnimationEnd?: (() => void) | null | undefined;
  15899. /** defines a callback to call when animation loops */
  15900. onAnimationLoop?: (() => void) | null | undefined;
  15901. /** defines whether the animation should be evaluated additively */
  15902. isAdditive: boolean;
  15903. private _localDelayOffset;
  15904. private _pausedDelay;
  15905. private _runtimeAnimations;
  15906. private _paused;
  15907. private _scene;
  15908. private _speedRatio;
  15909. private _weight;
  15910. private _syncRoot;
  15911. /**
  15912. * Gets or sets a boolean indicating if the animatable must be disposed and removed at the end of the animation.
  15913. * This will only apply for non looping animation (default is true)
  15914. */
  15915. disposeOnEnd: boolean;
  15916. /**
  15917. * Gets a boolean indicating if the animation has started
  15918. */
  15919. animationStarted: boolean;
  15920. /**
  15921. * Observer raised when the animation ends
  15922. */
  15923. onAnimationEndObservable: Observable<Animatable>;
  15924. /**
  15925. * Observer raised when the animation loops
  15926. */
  15927. onAnimationLoopObservable: Observable<Animatable>;
  15928. /**
  15929. * Gets the root Animatable used to synchronize and normalize animations
  15930. */
  15931. get syncRoot(): Nullable<Animatable>;
  15932. /**
  15933. * Gets the current frame of the first RuntimeAnimation
  15934. * Used to synchronize Animatables
  15935. */
  15936. get masterFrame(): number;
  15937. /**
  15938. * Gets or sets the animatable weight (-1.0 by default meaning not weighted)
  15939. */
  15940. get weight(): number;
  15941. set weight(value: number);
  15942. /**
  15943. * Gets or sets the speed ratio to apply to the animatable (1.0 by default)
  15944. */
  15945. get speedRatio(): number;
  15946. set speedRatio(value: number);
  15947. /**
  15948. * Creates a new Animatable
  15949. * @param scene defines the hosting scene
  15950. * @param target defines the target object
  15951. * @param fromFrame defines the starting frame number (default is 0)
  15952. * @param toFrame defines the ending frame number (default is 100)
  15953. * @param loopAnimation defines if the animation must loop (default is false)
  15954. * @param speedRatio defines the factor to apply to animation speed (default is 1)
  15955. * @param onAnimationEnd defines a callback to call when animation ends if it is not looping
  15956. * @param animations defines a group of animation to add to the new Animatable
  15957. * @param onAnimationLoop defines a callback to call when animation loops
  15958. * @param isAdditive defines whether the animation should be evaluated additively
  15959. */
  15960. constructor(scene: Scene,
  15961. /** defines the target object */
  15962. target: any,
  15963. /** defines the starting frame number (default is 0) */
  15964. fromFrame?: number,
  15965. /** defines the ending frame number (default is 100) */
  15966. toFrame?: number,
  15967. /** defines if the animation must loop (default is false) */
  15968. loopAnimation?: boolean, speedRatio?: number,
  15969. /** defines a callback to call when animation ends if it is not looping */
  15970. onAnimationEnd?: (() => void) | null | undefined, animations?: Animation[],
  15971. /** defines a callback to call when animation loops */
  15972. onAnimationLoop?: (() => void) | null | undefined,
  15973. /** defines whether the animation should be evaluated additively */
  15974. isAdditive?: boolean);
  15975. /**
  15976. * Synchronize and normalize current Animatable with a source Animatable
  15977. * This is useful when using animation weights and when animations are not of the same length
  15978. * @param root defines the root Animatable to synchronize with
  15979. * @returns the current Animatable
  15980. */
  15981. syncWith(root: Animatable): Animatable;
  15982. /**
  15983. * Gets the list of runtime animations
  15984. * @returns an array of RuntimeAnimation
  15985. */
  15986. getAnimations(): RuntimeAnimation[];
  15987. /**
  15988. * Adds more animations to the current animatable
  15989. * @param target defines the target of the animations
  15990. * @param animations defines the new animations to add
  15991. */
  15992. appendAnimations(target: any, animations: Animation[]): void;
  15993. /**
  15994. * Gets the source animation for a specific property
  15995. * @param property defines the propertyu to look for
  15996. * @returns null or the source animation for the given property
  15997. */
  15998. getAnimationByTargetProperty(property: string): Nullable<Animation>;
  15999. /**
  16000. * Gets the runtime animation for a specific property
  16001. * @param property defines the propertyu to look for
  16002. * @returns null or the runtime animation for the given property
  16003. */
  16004. getRuntimeAnimationByTargetProperty(property: string): Nullable<RuntimeAnimation>;
  16005. /**
  16006. * Resets the animatable to its original state
  16007. */
  16008. reset(): void;
  16009. /**
  16010. * Allows the animatable to blend with current running animations
  16011. * @see https://doc.babylonjs.com/babylon101/animations#animation-blending
  16012. * @param blendingSpeed defines the blending speed to use
  16013. */
  16014. enableBlending(blendingSpeed: number): void;
  16015. /**
  16016. * Disable animation blending
  16017. * @see https://doc.babylonjs.com/babylon101/animations#animation-blending
  16018. */
  16019. disableBlending(): void;
  16020. /**
  16021. * Jump directly to a given frame
  16022. * @param frame defines the frame to jump to
  16023. */
  16024. goToFrame(frame: number): void;
  16025. /**
  16026. * Pause the animation
  16027. */
  16028. pause(): void;
  16029. /**
  16030. * Restart the animation
  16031. */
  16032. restart(): void;
  16033. private _raiseOnAnimationEnd;
  16034. /**
  16035. * Stop and delete the current animation
  16036. * @param animationName defines a string used to only stop some of the runtime animations instead of all
  16037. * @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)
  16038. */
  16039. stop(animationName?: string, targetMask?: (target: any) => boolean): void;
  16040. /**
  16041. * Wait asynchronously for the animation to end
  16042. * @returns a promise which will be fullfilled when the animation ends
  16043. */
  16044. waitAsync(): Promise<Animatable>;
  16045. /** @hidden */
  16046. _animate(delay: number): boolean;
  16047. }
  16048. module "babylonjs/scene" {
  16049. interface Scene {
  16050. /** @hidden */
  16051. _registerTargetForLateAnimationBinding(runtimeAnimation: RuntimeAnimation, originalValue: any): void;
  16052. /** @hidden */
  16053. _processLateAnimationBindingsForMatrices(holder: {
  16054. totalWeight: number;
  16055. totalAdditiveWeight: number;
  16056. animations: RuntimeAnimation[];
  16057. additiveAnimations: RuntimeAnimation[];
  16058. originalValue: Matrix;
  16059. }): any;
  16060. /** @hidden */
  16061. _processLateAnimationBindingsForQuaternions(holder: {
  16062. totalWeight: number;
  16063. totalAdditiveWeight: number;
  16064. animations: RuntimeAnimation[];
  16065. additiveAnimations: RuntimeAnimation[];
  16066. originalValue: Quaternion;
  16067. }, refQuaternion: Quaternion): Quaternion;
  16068. /** @hidden */
  16069. _processLateAnimationBindings(): void;
  16070. /**
  16071. * Will start the animation sequence of a given target
  16072. * @param target defines the target
  16073. * @param from defines from which frame should animation start
  16074. * @param to defines until which frame should animation run.
  16075. * @param weight defines the weight to apply to the animation (1.0 by default)
  16076. * @param loop defines if the animation loops
  16077. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  16078. * @param onAnimationEnd defines the function to be executed when the animation ends
  16079. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  16080. * @param targetMask defines if the target should be animated if animations are present (this is called recursively on descendant animatables regardless of return value)
  16081. * @param onAnimationLoop defines the callback to call when an animation loops
  16082. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  16083. * @returns the animatable object created for this animation
  16084. */
  16085. 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;
  16086. /**
  16087. * Will start the animation sequence of a given target
  16088. * @param target defines the target
  16089. * @param from defines from which frame should animation start
  16090. * @param to defines until which frame should animation run.
  16091. * @param loop defines if the animation loops
  16092. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  16093. * @param onAnimationEnd defines the function to be executed when the animation ends
  16094. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  16095. * @param stopCurrent defines if the current animations must be stopped first (true by default)
  16096. * @param targetMask defines if the target should be animate if animations are present (this is called recursively on descendant animatables regardless of return value)
  16097. * @param onAnimationLoop defines the callback to call when an animation loops
  16098. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  16099. * @returns the animatable object created for this animation
  16100. */
  16101. 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;
  16102. /**
  16103. * Will start the animation sequence of a given target and its hierarchy
  16104. * @param target defines the target
  16105. * @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.
  16106. * @param from defines from which frame should animation start
  16107. * @param to defines until which frame should animation run.
  16108. * @param loop defines if the animation loops
  16109. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  16110. * @param onAnimationEnd defines the function to be executed when the animation ends
  16111. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  16112. * @param stopCurrent defines if the current animations must be stopped first (true by default)
  16113. * @param targetMask defines if the target should be animated if animations are present (this is called recursively on descendant animatables regardless of return value)
  16114. * @param onAnimationLoop defines the callback to call when an animation loops
  16115. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  16116. * @returns the list of created animatables
  16117. */
  16118. 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[];
  16119. /**
  16120. * Begin a new animation on a given node
  16121. * @param target defines the target where the animation will take place
  16122. * @param animations defines the list of animations to start
  16123. * @param from defines the initial value
  16124. * @param to defines the final value
  16125. * @param loop defines if you want animation to loop (off by default)
  16126. * @param speedRatio defines the speed ratio to apply to all animations
  16127. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  16128. * @param onAnimationLoop defines the callback to call when an animation loops
  16129. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  16130. * @returns the list of created animatables
  16131. */
  16132. beginDirectAnimation(target: any, animations: Animation[], from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, onAnimationLoop?: () => void, isAdditive?: boolean): Animatable;
  16133. /**
  16134. * Begin a new animation on a given node and its hierarchy
  16135. * @param target defines the root node where the animation will take place
  16136. * @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.
  16137. * @param animations defines the list of animations to start
  16138. * @param from defines the initial value
  16139. * @param to defines the final value
  16140. * @param loop defines if you want animation to loop (off by default)
  16141. * @param speedRatio defines the speed ratio to apply to all animations
  16142. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  16143. * @param onAnimationLoop defines the callback to call when an animation loops
  16144. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  16145. * @returns the list of animatables created for all nodes
  16146. */
  16147. beginDirectHierarchyAnimation(target: Node, directDescendantsOnly: boolean, animations: Animation[], from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, onAnimationLoop?: () => void, isAdditive?: boolean): Animatable[];
  16148. /**
  16149. * Gets the animatable associated with a specific target
  16150. * @param target defines the target of the animatable
  16151. * @returns the required animatable if found
  16152. */
  16153. getAnimatableByTarget(target: any): Nullable<Animatable>;
  16154. /**
  16155. * Gets all animatables associated with a given target
  16156. * @param target defines the target to look animatables for
  16157. * @returns an array of Animatables
  16158. */
  16159. getAllAnimatablesByTarget(target: any): Array<Animatable>;
  16160. /**
  16161. * Stops and removes all animations that have been applied to the scene
  16162. */
  16163. stopAllAnimations(): void;
  16164. /**
  16165. * Gets the current delta time used by animation engine
  16166. */
  16167. deltaTime: number;
  16168. }
  16169. }
  16170. module "babylonjs/Bones/bone" {
  16171. interface Bone {
  16172. /**
  16173. * Copy an animation range from another bone
  16174. * @param source defines the source bone
  16175. * @param rangeName defines the range name to copy
  16176. * @param frameOffset defines the frame offset
  16177. * @param rescaleAsRequired defines if rescaling must be applied if required
  16178. * @param skelDimensionsRatio defines the scaling ratio
  16179. * @returns true if operation was successful
  16180. */
  16181. copyAnimationRange(source: Bone, rangeName: string, frameOffset: number, rescaleAsRequired: boolean, skelDimensionsRatio: Nullable<Vector3>): boolean;
  16182. }
  16183. }
  16184. }
  16185. declare module "babylonjs/Bones/skeleton" {
  16186. import { Bone } from "babylonjs/Bones/bone";
  16187. import { Observable } from "babylonjs/Misc/observable";
  16188. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  16189. import { Scene } from "babylonjs/scene";
  16190. import { Nullable } from "babylonjs/types";
  16191. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  16192. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  16193. import { Animatable } from "babylonjs/Animations/animatable";
  16194. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  16195. import { Animation } from "babylonjs/Animations/animation";
  16196. import { AnimationRange } from "babylonjs/Animations/animationRange";
  16197. import { IInspectable } from "babylonjs/Misc/iInspectable";
  16198. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  16199. /**
  16200. * Class used to handle skinning animations
  16201. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  16202. */
  16203. export class Skeleton implements IAnimatable {
  16204. /** defines the skeleton name */
  16205. name: string;
  16206. /** defines the skeleton Id */
  16207. id: string;
  16208. /**
  16209. * Defines the list of child bones
  16210. */
  16211. bones: Bone[];
  16212. /**
  16213. * Defines an estimate of the dimension of the skeleton at rest
  16214. */
  16215. dimensionsAtRest: Vector3;
  16216. /**
  16217. * Defines a boolean indicating if the root matrix is provided by meshes or by the current skeleton (this is the default value)
  16218. */
  16219. needInitialSkinMatrix: boolean;
  16220. /**
  16221. * Defines a mesh that override the matrix used to get the world matrix (null by default).
  16222. */
  16223. overrideMesh: Nullable<AbstractMesh>;
  16224. /**
  16225. * Gets the list of animations attached to this skeleton
  16226. */
  16227. animations: Array<Animation>;
  16228. private _scene;
  16229. private _isDirty;
  16230. private _transformMatrices;
  16231. private _transformMatrixTexture;
  16232. private _meshesWithPoseMatrix;
  16233. private _animatables;
  16234. private _identity;
  16235. private _synchronizedWithMesh;
  16236. private _ranges;
  16237. private _lastAbsoluteTransformsUpdateId;
  16238. private _canUseTextureForBones;
  16239. private _uniqueId;
  16240. /** @hidden */
  16241. _numBonesWithLinkedTransformNode: number;
  16242. /** @hidden */
  16243. _hasWaitingData: Nullable<boolean>;
  16244. /**
  16245. * Specifies if the skeleton should be serialized
  16246. */
  16247. doNotSerialize: boolean;
  16248. private _useTextureToStoreBoneMatrices;
  16249. /**
  16250. * Gets or sets a boolean indicating that bone matrices should be stored as a texture instead of using shader uniforms (default is true).
  16251. * Please note that this option is not available if the hardware does not support it
  16252. */
  16253. get useTextureToStoreBoneMatrices(): boolean;
  16254. set useTextureToStoreBoneMatrices(value: boolean);
  16255. private _animationPropertiesOverride;
  16256. /**
  16257. * Gets or sets the animation properties override
  16258. */
  16259. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  16260. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  16261. /**
  16262. * List of inspectable custom properties (used by the Inspector)
  16263. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  16264. */
  16265. inspectableCustomProperties: IInspectable[];
  16266. /**
  16267. * An observable triggered before computing the skeleton's matrices
  16268. */
  16269. onBeforeComputeObservable: Observable<Skeleton>;
  16270. /**
  16271. * Gets a boolean indicating that the skeleton effectively stores matrices into a texture
  16272. */
  16273. get isUsingTextureForMatrices(): boolean;
  16274. /**
  16275. * Gets the unique ID of this skeleton
  16276. */
  16277. get uniqueId(): number;
  16278. /**
  16279. * Creates a new skeleton
  16280. * @param name defines the skeleton name
  16281. * @param id defines the skeleton Id
  16282. * @param scene defines the hosting scene
  16283. */
  16284. constructor(
  16285. /** defines the skeleton name */
  16286. name: string,
  16287. /** defines the skeleton Id */
  16288. id: string, scene: Scene);
  16289. /**
  16290. * Gets the current object class name.
  16291. * @return the class name
  16292. */
  16293. getClassName(): string;
  16294. /**
  16295. * Returns an array containing the root bones
  16296. * @returns an array containing the root bones
  16297. */
  16298. getChildren(): Array<Bone>;
  16299. /**
  16300. * Gets the list of transform matrices to send to shaders (one matrix per bone)
  16301. * @param mesh defines the mesh to use to get the root matrix (if needInitialSkinMatrix === true)
  16302. * @returns a Float32Array containing matrices data
  16303. */
  16304. getTransformMatrices(mesh: AbstractMesh): Float32Array;
  16305. /**
  16306. * Gets the list of transform matrices to send to shaders inside a texture (one matrix per bone)
  16307. * @param mesh defines the mesh to use to get the root matrix (if needInitialSkinMatrix === true)
  16308. * @returns a raw texture containing the data
  16309. */
  16310. getTransformMatrixTexture(mesh: AbstractMesh): Nullable<RawTexture>;
  16311. /**
  16312. * Gets the current hosting scene
  16313. * @returns a scene object
  16314. */
  16315. getScene(): Scene;
  16316. /**
  16317. * Gets a string representing the current skeleton data
  16318. * @param fullDetails defines a boolean indicating if we want a verbose version
  16319. * @returns a string representing the current skeleton data
  16320. */
  16321. toString(fullDetails?: boolean): string;
  16322. /**
  16323. * Get bone's index searching by name
  16324. * @param name defines bone's name to search for
  16325. * @return the indice of the bone. Returns -1 if not found
  16326. */
  16327. getBoneIndexByName(name: string): number;
  16328. /**
  16329. * Creater a new animation range
  16330. * @param name defines the name of the range
  16331. * @param from defines the start key
  16332. * @param to defines the end key
  16333. */
  16334. createAnimationRange(name: string, from: number, to: number): void;
  16335. /**
  16336. * Delete a specific animation range
  16337. * @param name defines the name of the range
  16338. * @param deleteFrames defines if frames must be removed as well
  16339. */
  16340. deleteAnimationRange(name: string, deleteFrames?: boolean): void;
  16341. /**
  16342. * Gets a specific animation range
  16343. * @param name defines the name of the range to look for
  16344. * @returns the requested animation range or null if not found
  16345. */
  16346. getAnimationRange(name: string): Nullable<AnimationRange>;
  16347. /**
  16348. * Gets the list of all animation ranges defined on this skeleton
  16349. * @returns an array
  16350. */
  16351. getAnimationRanges(): Nullable<AnimationRange>[];
  16352. /**
  16353. * Copy animation range from a source skeleton.
  16354. * This is not for a complete retargeting, only between very similar skeleton's with only possible bone length differences
  16355. * @param source defines the source skeleton
  16356. * @param name defines the name of the range to copy
  16357. * @param rescaleAsRequired defines if rescaling must be applied if required
  16358. * @returns true if operation was successful
  16359. */
  16360. copyAnimationRange(source: Skeleton, name: string, rescaleAsRequired?: boolean): boolean;
  16361. /**
  16362. * Forces the skeleton to go to rest pose
  16363. */
  16364. returnToRest(): void;
  16365. private _getHighestAnimationFrame;
  16366. /**
  16367. * Begin a specific animation range
  16368. * @param name defines the name of the range to start
  16369. * @param loop defines if looping must be turned on (false by default)
  16370. * @param speedRatio defines the speed ratio to apply (1 by default)
  16371. * @param onAnimationEnd defines a callback which will be called when animation will end
  16372. * @returns a new animatable
  16373. */
  16374. beginAnimation(name: string, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void): Nullable<Animatable>;
  16375. /**
  16376. * Convert the keyframes for a range of animation on a skeleton to be relative to a given reference frame.
  16377. * @param skeleton defines the Skeleton containing the animation range to convert
  16378. * @param referenceFrame defines the frame that keyframes in the range will be relative to
  16379. * @param range defines the name of the AnimationRange belonging to the Skeleton to convert
  16380. * @returns the original skeleton
  16381. */
  16382. static MakeAnimationAdditive(skeleton: Skeleton, referenceFrame: number | undefined, range: string): Nullable<Skeleton>;
  16383. /** @hidden */
  16384. _markAsDirty(): void;
  16385. /** @hidden */
  16386. _registerMeshWithPoseMatrix(mesh: AbstractMesh): void;
  16387. /** @hidden */
  16388. _unregisterMeshWithPoseMatrix(mesh: AbstractMesh): void;
  16389. private _computeTransformMatrices;
  16390. /**
  16391. * Build all resources required to render a skeleton
  16392. */
  16393. prepare(): void;
  16394. /**
  16395. * Gets the list of animatables currently running for this skeleton
  16396. * @returns an array of animatables
  16397. */
  16398. getAnimatables(): IAnimatable[];
  16399. /**
  16400. * Clone the current skeleton
  16401. * @param name defines the name of the new skeleton
  16402. * @param id defines the id of the new skeleton
  16403. * @returns the new skeleton
  16404. */
  16405. clone(name: string, id?: string): Skeleton;
  16406. /**
  16407. * Enable animation blending for this skeleton
  16408. * @param blendingSpeed defines the blending speed to apply
  16409. * @see https://doc.babylonjs.com/babylon101/animations#animation-blending
  16410. */
  16411. enableBlending(blendingSpeed?: number): void;
  16412. /**
  16413. * Releases all resources associated with the current skeleton
  16414. */
  16415. dispose(): void;
  16416. /**
  16417. * Serialize the skeleton in a JSON object
  16418. * @returns a JSON object
  16419. */
  16420. serialize(): any;
  16421. /**
  16422. * Creates a new skeleton from serialized data
  16423. * @param parsedSkeleton defines the serialized data
  16424. * @param scene defines the hosting scene
  16425. * @returns a new skeleton
  16426. */
  16427. static Parse(parsedSkeleton: any, scene: Scene): Skeleton;
  16428. /**
  16429. * Compute all node absolute transforms
  16430. * @param forceUpdate defines if computation must be done even if cache is up to date
  16431. */
  16432. computeAbsoluteTransforms(forceUpdate?: boolean): void;
  16433. /**
  16434. * Gets the root pose matrix
  16435. * @returns a matrix
  16436. */
  16437. getPoseMatrix(): Nullable<Matrix>;
  16438. /**
  16439. * Sorts bones per internal index
  16440. */
  16441. sortBones(): void;
  16442. private _sortBones;
  16443. }
  16444. }
  16445. declare module "babylonjs/Meshes/instancedMesh" {
  16446. import { Nullable, FloatArray, IndicesArray } from "babylonjs/types";
  16447. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  16448. import { Camera } from "babylonjs/Cameras/camera";
  16449. import { Node } from "babylonjs/node";
  16450. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  16451. import { Mesh } from "babylonjs/Meshes/mesh";
  16452. import { Material } from "babylonjs/Materials/material";
  16453. import { Skeleton } from "babylonjs/Bones/skeleton";
  16454. import { Light } from "babylonjs/Lights/light";
  16455. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  16456. /**
  16457. * Creates an instance based on a source mesh.
  16458. */
  16459. export class InstancedMesh extends AbstractMesh {
  16460. private _sourceMesh;
  16461. private _currentLOD;
  16462. /** @hidden */
  16463. _indexInSourceMeshInstanceArray: number;
  16464. constructor(name: string, source: Mesh);
  16465. /**
  16466. * Returns the string "InstancedMesh".
  16467. */
  16468. getClassName(): string;
  16469. /** Gets the list of lights affecting that mesh */
  16470. get lightSources(): Light[];
  16471. _resyncLightSources(): void;
  16472. _resyncLightSource(light: Light): void;
  16473. _removeLightSource(light: Light, dispose: boolean): void;
  16474. /**
  16475. * If the source mesh receives shadows
  16476. */
  16477. get receiveShadows(): boolean;
  16478. /**
  16479. * The material of the source mesh
  16480. */
  16481. get material(): Nullable<Material>;
  16482. /**
  16483. * Visibility of the source mesh
  16484. */
  16485. get visibility(): number;
  16486. /**
  16487. * Skeleton of the source mesh
  16488. */
  16489. get skeleton(): Nullable<Skeleton>;
  16490. /**
  16491. * Rendering ground id of the source mesh
  16492. */
  16493. get renderingGroupId(): number;
  16494. set renderingGroupId(value: number);
  16495. /**
  16496. * Returns the total number of vertices (integer).
  16497. */
  16498. getTotalVertices(): number;
  16499. /**
  16500. * Returns a positive integer : the total number of indices in this mesh geometry.
  16501. * @returns the numner of indices or zero if the mesh has no geometry.
  16502. */
  16503. getTotalIndices(): number;
  16504. /**
  16505. * The source mesh of the instance
  16506. */
  16507. get sourceMesh(): Mesh;
  16508. /**
  16509. * Creates a new InstancedMesh object from the mesh model.
  16510. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  16511. * @param name defines the name of the new instance
  16512. * @returns a new InstancedMesh
  16513. */
  16514. createInstance(name: string): InstancedMesh;
  16515. /**
  16516. * Is this node ready to be used/rendered
  16517. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  16518. * @return {boolean} is it ready
  16519. */
  16520. isReady(completeCheck?: boolean): boolean;
  16521. /**
  16522. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  16523. * @param kind kind of verticies to retreive (eg. positons, normals, uvs, etc.)
  16524. * @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.
  16525. * @returns a float array or a Float32Array of the requested kind of data : positons, normals, uvs, etc.
  16526. */
  16527. getVerticesData(kind: string, copyWhenShared?: boolean): Nullable<FloatArray>;
  16528. /**
  16529. * Sets the vertex data of the mesh geometry for the requested `kind`.
  16530. * If the mesh has no geometry, a new Geometry object is set to the mesh and then passed this vertex data.
  16531. * The `data` are either a numeric array either a Float32Array.
  16532. * The parameter `updatable` is passed as is to the underlying Geometry object constructor (if initianilly none) or updater.
  16533. * 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).
  16534. * Note that a new underlying VertexBuffer object is created each call.
  16535. * If the `kind` is the `PositionKind`, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  16536. *
  16537. * Possible `kind` values :
  16538. * - VertexBuffer.PositionKind
  16539. * - VertexBuffer.UVKind
  16540. * - VertexBuffer.UV2Kind
  16541. * - VertexBuffer.UV3Kind
  16542. * - VertexBuffer.UV4Kind
  16543. * - VertexBuffer.UV5Kind
  16544. * - VertexBuffer.UV6Kind
  16545. * - VertexBuffer.ColorKind
  16546. * - VertexBuffer.MatricesIndicesKind
  16547. * - VertexBuffer.MatricesIndicesExtraKind
  16548. * - VertexBuffer.MatricesWeightsKind
  16549. * - VertexBuffer.MatricesWeightsExtraKind
  16550. *
  16551. * Returns the Mesh.
  16552. */
  16553. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  16554. /**
  16555. * Updates the existing vertex data of the mesh geometry for the requested `kind`.
  16556. * If the mesh has no geometry, it is simply returned as it is.
  16557. * The `data` are either a numeric array either a Float32Array.
  16558. * No new underlying VertexBuffer object is created.
  16559. * 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.
  16560. * If the parameter `makeItUnique` is true, a new global geometry is created from this positions and is set to the mesh.
  16561. *
  16562. * Possible `kind` values :
  16563. * - VertexBuffer.PositionKind
  16564. * - VertexBuffer.UVKind
  16565. * - VertexBuffer.UV2Kind
  16566. * - VertexBuffer.UV3Kind
  16567. * - VertexBuffer.UV4Kind
  16568. * - VertexBuffer.UV5Kind
  16569. * - VertexBuffer.UV6Kind
  16570. * - VertexBuffer.ColorKind
  16571. * - VertexBuffer.MatricesIndicesKind
  16572. * - VertexBuffer.MatricesIndicesExtraKind
  16573. * - VertexBuffer.MatricesWeightsKind
  16574. * - VertexBuffer.MatricesWeightsExtraKind
  16575. *
  16576. * Returns the Mesh.
  16577. */
  16578. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): Mesh;
  16579. /**
  16580. * Sets the mesh indices.
  16581. * Expects an array populated with integers or a typed array (Int32Array, Uint32Array, Uint16Array).
  16582. * If the mesh has no geometry, a new Geometry object is created and set to the mesh.
  16583. * This method creates a new index buffer each call.
  16584. * Returns the Mesh.
  16585. */
  16586. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>): Mesh;
  16587. /**
  16588. * Boolean : True if the mesh owns the requested kind of data.
  16589. */
  16590. isVerticesDataPresent(kind: string): boolean;
  16591. /**
  16592. * Returns an array of indices (IndicesArray).
  16593. */
  16594. getIndices(): Nullable<IndicesArray>;
  16595. get _positions(): Nullable<Vector3[]>;
  16596. /**
  16597. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  16598. * This means the mesh underlying bounding box and sphere are recomputed.
  16599. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  16600. * @returns the current mesh
  16601. */
  16602. refreshBoundingInfo(applySkeleton?: boolean): InstancedMesh;
  16603. /** @hidden */
  16604. _preActivate(): InstancedMesh;
  16605. /** @hidden */
  16606. _activate(renderId: number, intermediateRendering: boolean): boolean;
  16607. /** @hidden */
  16608. _postActivate(): void;
  16609. getWorldMatrix(): Matrix;
  16610. get isAnInstance(): boolean;
  16611. /**
  16612. * Returns the current associated LOD AbstractMesh.
  16613. */
  16614. getLOD(camera: Camera): AbstractMesh;
  16615. /** @hidden */
  16616. _preActivateForIntermediateRendering(renderId: number): Mesh;
  16617. /** @hidden */
  16618. _syncSubMeshes(): InstancedMesh;
  16619. /** @hidden */
  16620. _generatePointsArray(): boolean;
  16621. /**
  16622. * Creates a new InstancedMesh from the current mesh.
  16623. * - name (string) : the cloned mesh name
  16624. * - newParent (optional Node) : the optional Node to parent the clone to.
  16625. * - doNotCloneChildren (optional boolean, default `false`) : if `true` the model children aren't cloned.
  16626. *
  16627. * Returns the clone.
  16628. */
  16629. clone(name: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean): InstancedMesh;
  16630. /**
  16631. * Disposes the InstancedMesh.
  16632. * Returns nothing.
  16633. */
  16634. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  16635. }
  16636. module "babylonjs/Meshes/mesh" {
  16637. interface Mesh {
  16638. /**
  16639. * Register a custom buffer that will be instanced
  16640. * @see https://doc.babylonjs.com/how_to/how_to_use_instances#custom-buffers
  16641. * @param kind defines the buffer kind
  16642. * @param stride defines the stride in floats
  16643. */
  16644. registerInstancedBuffer(kind: string, stride: number): void;
  16645. /**
  16646. * true to use the edge renderer for all instances of this mesh
  16647. */
  16648. edgesShareWithInstances: boolean;
  16649. /** @hidden */
  16650. _userInstancedBuffersStorage: {
  16651. data: {
  16652. [key: string]: Float32Array;
  16653. };
  16654. sizes: {
  16655. [key: string]: number;
  16656. };
  16657. vertexBuffers: {
  16658. [key: string]: Nullable<VertexBuffer>;
  16659. };
  16660. strides: {
  16661. [key: string]: number;
  16662. };
  16663. };
  16664. }
  16665. }
  16666. module "babylonjs/Meshes/abstractMesh" {
  16667. interface AbstractMesh {
  16668. /**
  16669. * Object used to store instanced buffers defined by user
  16670. * @see https://doc.babylonjs.com/how_to/how_to_use_instances#custom-buffers
  16671. */
  16672. instancedBuffers: {
  16673. [key: string]: any;
  16674. };
  16675. }
  16676. }
  16677. }
  16678. declare module "babylonjs/Materials/shaderMaterial" {
  16679. import { Nullable } from "babylonjs/types";
  16680. import { Scene } from "babylonjs/scene";
  16681. import { Matrix, Vector3, Vector2, Vector4 } from "babylonjs/Maths/math.vector";
  16682. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  16683. import { Mesh } from "babylonjs/Meshes/mesh";
  16684. import { SubMesh } from "babylonjs/Meshes/subMesh";
  16685. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  16686. import { Effect } from "babylonjs/Materials/effect";
  16687. import { Material } from "babylonjs/Materials/material";
  16688. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  16689. /**
  16690. * Defines the options associated with the creation of a shader material.
  16691. */
  16692. export interface IShaderMaterialOptions {
  16693. /**
  16694. * Does the material work in alpha blend mode
  16695. */
  16696. needAlphaBlending: boolean;
  16697. /**
  16698. * Does the material work in alpha test mode
  16699. */
  16700. needAlphaTesting: boolean;
  16701. /**
  16702. * The list of attribute names used in the shader
  16703. */
  16704. attributes: string[];
  16705. /**
  16706. * The list of unifrom names used in the shader
  16707. */
  16708. uniforms: string[];
  16709. /**
  16710. * The list of UBO names used in the shader
  16711. */
  16712. uniformBuffers: string[];
  16713. /**
  16714. * The list of sampler names used in the shader
  16715. */
  16716. samplers: string[];
  16717. /**
  16718. * The list of defines used in the shader
  16719. */
  16720. defines: string[];
  16721. }
  16722. /**
  16723. * 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.
  16724. *
  16725. * This returned material effects how the mesh will look based on the code in the shaders.
  16726. *
  16727. * @see https://doc.babylonjs.com/how_to/shader_material
  16728. */
  16729. export class ShaderMaterial extends Material {
  16730. private _shaderPath;
  16731. private _options;
  16732. private _textures;
  16733. private _textureArrays;
  16734. private _floats;
  16735. private _ints;
  16736. private _floatsArrays;
  16737. private _colors3;
  16738. private _colors3Arrays;
  16739. private _colors4;
  16740. private _colors4Arrays;
  16741. private _vectors2;
  16742. private _vectors3;
  16743. private _vectors4;
  16744. private _matrices;
  16745. private _matrixArrays;
  16746. private _matrices3x3;
  16747. private _matrices2x2;
  16748. private _vectors2Arrays;
  16749. private _vectors3Arrays;
  16750. private _vectors4Arrays;
  16751. private _cachedWorldViewMatrix;
  16752. private _cachedWorldViewProjectionMatrix;
  16753. private _renderId;
  16754. private _multiview;
  16755. private _cachedDefines;
  16756. /** Define the Url to load snippets */
  16757. static SnippetUrl: string;
  16758. /** Snippet ID if the material was created from the snippet server */
  16759. snippetId: string;
  16760. /**
  16761. * Instantiate a new shader material.
  16762. * 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.
  16763. * This returned material effects how the mesh will look based on the code in the shaders.
  16764. * @see https://doc.babylonjs.com/how_to/shader_material
  16765. * @param name Define the name of the material in the scene
  16766. * @param scene Define the scene the material belongs to
  16767. * @param shaderPath Defines the route to the shader code in one of three ways:
  16768. * * object: { vertex: "custom", fragment: "custom" }, used with Effect.ShadersStore["customVertexShader"] and Effect.ShadersStore["customFragmentShader"]
  16769. * * object: { vertexElement: "vertexShaderCode", fragmentElement: "fragmentShaderCode" }, used with shader code in script tags
  16770. * * object: { vertexSource: "vertex shader code string", fragmentSource: "fragment shader code string" } using with strings containing the shaders code
  16771. * * string: "./COMMON_NAME", used with external files COMMON_NAME.vertex.fx and COMMON_NAME.fragment.fx in index.html folder.
  16772. * @param options Define the options used to create the shader
  16773. */
  16774. constructor(name: string, scene: Scene, shaderPath: any, options?: Partial<IShaderMaterialOptions>);
  16775. /**
  16776. * Gets the shader path used to define the shader code
  16777. * It can be modified to trigger a new compilation
  16778. */
  16779. get shaderPath(): any;
  16780. /**
  16781. * Sets the shader path used to define the shader code
  16782. * It can be modified to trigger a new compilation
  16783. */
  16784. set shaderPath(shaderPath: any);
  16785. /**
  16786. * Gets the options used to compile the shader.
  16787. * They can be modified to trigger a new compilation
  16788. */
  16789. get options(): IShaderMaterialOptions;
  16790. /**
  16791. * Gets the current class name of the material e.g. "ShaderMaterial"
  16792. * Mainly use in serialization.
  16793. * @returns the class name
  16794. */
  16795. getClassName(): string;
  16796. /**
  16797. * Specifies if the material will require alpha blending
  16798. * @returns a boolean specifying if alpha blending is needed
  16799. */
  16800. needAlphaBlending(): boolean;
  16801. /**
  16802. * Specifies if this material should be rendered in alpha test mode
  16803. * @returns a boolean specifying if an alpha test is needed.
  16804. */
  16805. needAlphaTesting(): boolean;
  16806. private _checkUniform;
  16807. /**
  16808. * Set a texture in the shader.
  16809. * @param name Define the name of the uniform samplers as defined in the shader
  16810. * @param texture Define the texture to bind to this sampler
  16811. * @return the material itself allowing "fluent" like uniform updates
  16812. */
  16813. setTexture(name: string, texture: BaseTexture): ShaderMaterial;
  16814. /**
  16815. * Set a texture array in the shader.
  16816. * @param name Define the name of the uniform sampler array as defined in the shader
  16817. * @param textures Define the list of textures to bind to this sampler
  16818. * @return the material itself allowing "fluent" like uniform updates
  16819. */
  16820. setTextureArray(name: string, textures: BaseTexture[]): ShaderMaterial;
  16821. /**
  16822. * Set a float in the shader.
  16823. * @param name Define the name of the uniform as defined in the shader
  16824. * @param value Define the value to give to the uniform
  16825. * @return the material itself allowing "fluent" like uniform updates
  16826. */
  16827. setFloat(name: string, value: number): ShaderMaterial;
  16828. /**
  16829. * Set a int in the shader.
  16830. * @param name Define the name of the uniform as defined in the shader
  16831. * @param value Define the value to give to the uniform
  16832. * @return the material itself allowing "fluent" like uniform updates
  16833. */
  16834. setInt(name: string, value: number): ShaderMaterial;
  16835. /**
  16836. * Set an array of floats in the shader.
  16837. * @param name Define the name of the uniform as defined in the shader
  16838. * @param value Define the value to give to the uniform
  16839. * @return the material itself allowing "fluent" like uniform updates
  16840. */
  16841. setFloats(name: string, value: number[]): ShaderMaterial;
  16842. /**
  16843. * Set a vec3 in the shader from a Color3.
  16844. * @param name Define the name of the uniform as defined in the shader
  16845. * @param value Define the value to give to the uniform
  16846. * @return the material itself allowing "fluent" like uniform updates
  16847. */
  16848. setColor3(name: string, value: Color3): ShaderMaterial;
  16849. /**
  16850. * Set a vec3 array in the shader from a Color3 array.
  16851. * @param name Define the name of the uniform as defined in the shader
  16852. * @param value Define the value to give to the uniform
  16853. * @return the material itself allowing "fluent" like uniform updates
  16854. */
  16855. setColor3Array(name: string, value: Color3[]): ShaderMaterial;
  16856. /**
  16857. * Set a vec4 in the shader from a Color4.
  16858. * @param name Define the name of the uniform as defined in the shader
  16859. * @param value Define the value to give to the uniform
  16860. * @return the material itself allowing "fluent" like uniform updates
  16861. */
  16862. setColor4(name: string, value: Color4): ShaderMaterial;
  16863. /**
  16864. * Set a vec4 array in the shader from a Color4 array.
  16865. * @param name Define the name of the uniform as defined in the shader
  16866. * @param value Define the value to give to the uniform
  16867. * @return the material itself allowing "fluent" like uniform updates
  16868. */
  16869. setColor4Array(name: string, value: Color4[]): ShaderMaterial;
  16870. /**
  16871. * Set a vec2 in the shader from a Vector2.
  16872. * @param name Define the name of the uniform as defined in the shader
  16873. * @param value Define the value to give to the uniform
  16874. * @return the material itself allowing "fluent" like uniform updates
  16875. */
  16876. setVector2(name: string, value: Vector2): ShaderMaterial;
  16877. /**
  16878. * Set a vec3 in the shader from a Vector3.
  16879. * @param name Define the name of the uniform as defined in the shader
  16880. * @param value Define the value to give to the uniform
  16881. * @return the material itself allowing "fluent" like uniform updates
  16882. */
  16883. setVector3(name: string, value: Vector3): ShaderMaterial;
  16884. /**
  16885. * Set a vec4 in the shader from a Vector4.
  16886. * @param name Define the name of the uniform as defined in the shader
  16887. * @param value Define the value to give to the uniform
  16888. * @return the material itself allowing "fluent" like uniform updates
  16889. */
  16890. setVector4(name: string, value: Vector4): ShaderMaterial;
  16891. /**
  16892. * Set a mat4 in the shader from a Matrix.
  16893. * @param name Define the name of the uniform as defined in the shader
  16894. * @param value Define the value to give to the uniform
  16895. * @return the material itself allowing "fluent" like uniform updates
  16896. */
  16897. setMatrix(name: string, value: Matrix): ShaderMaterial;
  16898. /**
  16899. * Set a float32Array in the shader from a matrix array.
  16900. * @param name Define the name of the uniform as defined in the shader
  16901. * @param value Define the value to give to the uniform
  16902. * @return the material itself allowing "fluent" like uniform updates
  16903. */
  16904. setMatrices(name: string, value: Matrix[]): ShaderMaterial;
  16905. /**
  16906. * Set a mat3 in the shader from a Float32Array.
  16907. * @param name Define the name of the uniform as defined in the shader
  16908. * @param value Define the value to give to the uniform
  16909. * @return the material itself allowing "fluent" like uniform updates
  16910. */
  16911. setMatrix3x3(name: string, value: Float32Array | Array<number>): ShaderMaterial;
  16912. /**
  16913. * Set a mat2 in the shader from a Float32Array.
  16914. * @param name Define the name of the uniform as defined in the shader
  16915. * @param value Define the value to give to the uniform
  16916. * @return the material itself allowing "fluent" like uniform updates
  16917. */
  16918. setMatrix2x2(name: string, value: Float32Array | Array<number>): ShaderMaterial;
  16919. /**
  16920. * Set a vec2 array in the shader from a number array.
  16921. * @param name Define the name of the uniform as defined in the shader
  16922. * @param value Define the value to give to the uniform
  16923. * @return the material itself allowing "fluent" like uniform updates
  16924. */
  16925. setArray2(name: string, value: number[]): ShaderMaterial;
  16926. /**
  16927. * Set a vec3 array in the shader from a number array.
  16928. * @param name Define the name of the uniform as defined in the shader
  16929. * @param value Define the value to give to the uniform
  16930. * @return the material itself allowing "fluent" like uniform updates
  16931. */
  16932. setArray3(name: string, value: number[]): ShaderMaterial;
  16933. /**
  16934. * Set a vec4 array in the shader from a number array.
  16935. * @param name Define the name of the uniform as defined in the shader
  16936. * @param value Define the value to give to the uniform
  16937. * @return the material itself allowing "fluent" like uniform updates
  16938. */
  16939. setArray4(name: string, value: number[]): ShaderMaterial;
  16940. private _checkCache;
  16941. /**
  16942. * Specifies that the submesh is ready to be used
  16943. * @param mesh defines the mesh to check
  16944. * @param subMesh defines which submesh to check
  16945. * @param useInstances specifies that instances should be used
  16946. * @returns a boolean indicating that the submesh is ready or not
  16947. */
  16948. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  16949. /**
  16950. * Checks if the material is ready to render the requested mesh
  16951. * @param mesh Define the mesh to render
  16952. * @param useInstances Define whether or not the material is used with instances
  16953. * @returns true if ready, otherwise false
  16954. */
  16955. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  16956. /**
  16957. * Binds the world matrix to the material
  16958. * @param world defines the world transformation matrix
  16959. * @param effectOverride - If provided, use this effect instead of internal effect
  16960. */
  16961. bindOnlyWorldMatrix(world: Matrix, effectOverride?: Nullable<Effect>): void;
  16962. /**
  16963. * Binds the submesh to this material by preparing the effect and shader to draw
  16964. * @param world defines the world transformation matrix
  16965. * @param mesh defines the mesh containing the submesh
  16966. * @param subMesh defines the submesh to bind the material to
  16967. */
  16968. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  16969. /**
  16970. * Binds the material to the mesh
  16971. * @param world defines the world transformation matrix
  16972. * @param mesh defines the mesh to bind the material to
  16973. * @param effectOverride - If provided, use this effect instead of internal effect
  16974. */
  16975. bind(world: Matrix, mesh?: Mesh, effectOverride?: Nullable<Effect>): void;
  16976. protected _afterBind(mesh?: Mesh): void;
  16977. /**
  16978. * Gets the active textures from the material
  16979. * @returns an array of textures
  16980. */
  16981. getActiveTextures(): BaseTexture[];
  16982. /**
  16983. * Specifies if the material uses a texture
  16984. * @param texture defines the texture to check against the material
  16985. * @returns a boolean specifying if the material uses the texture
  16986. */
  16987. hasTexture(texture: BaseTexture): boolean;
  16988. /**
  16989. * Makes a duplicate of the material, and gives it a new name
  16990. * @param name defines the new name for the duplicated material
  16991. * @returns the cloned material
  16992. */
  16993. clone(name: string): ShaderMaterial;
  16994. /**
  16995. * Disposes the material
  16996. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  16997. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  16998. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  16999. */
  17000. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  17001. /**
  17002. * Serializes this material in a JSON representation
  17003. * @returns the serialized material object
  17004. */
  17005. serialize(): any;
  17006. /**
  17007. * Creates a shader material from parsed shader material data
  17008. * @param source defines the JSON represnetation of the material
  17009. * @param scene defines the hosting scene
  17010. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  17011. * @returns a new material
  17012. */
  17013. static Parse(source: any, scene: Scene, rootUrl: string): ShaderMaterial;
  17014. /**
  17015. * Creates a new ShaderMaterial from a snippet saved in a remote file
  17016. * @param name defines the name of the ShaderMaterial to create (can be null or empty to use the one from the json data)
  17017. * @param url defines the url to load from
  17018. * @param scene defines the hosting scene
  17019. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  17020. * @returns a promise that will resolve to the new ShaderMaterial
  17021. */
  17022. static ParseFromFileAsync(name: Nullable<string>, url: string, scene: Scene, rootUrl?: string): Promise<ShaderMaterial>;
  17023. /**
  17024. * Creates a ShaderMaterial from a snippet saved by the Inspector
  17025. * @param snippetId defines the snippet to load
  17026. * @param scene defines the hosting scene
  17027. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  17028. * @returns a promise that will resolve to the new ShaderMaterial
  17029. */
  17030. static CreateFromSnippetAsync(snippetId: string, scene: Scene, rootUrl?: string): Promise<ShaderMaterial>;
  17031. }
  17032. }
  17033. declare module "babylonjs/Shaders/color.fragment" {
  17034. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  17035. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  17036. /** @hidden */
  17037. export var colorPixelShader: {
  17038. name: string;
  17039. shader: string;
  17040. };
  17041. }
  17042. declare module "babylonjs/Shaders/color.vertex" {
  17043. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  17044. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  17045. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  17046. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  17047. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  17048. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  17049. /** @hidden */
  17050. export var colorVertexShader: {
  17051. name: string;
  17052. shader: string;
  17053. };
  17054. }
  17055. declare module "babylonjs/Meshes/linesMesh" {
  17056. import { Nullable } from "babylonjs/types";
  17057. import { Scene } from "babylonjs/scene";
  17058. import { Color3 } from "babylonjs/Maths/math.color";
  17059. import { Node } from "babylonjs/node";
  17060. import { SubMesh } from "babylonjs/Meshes/subMesh";
  17061. import { Mesh } from "babylonjs/Meshes/mesh";
  17062. import { InstancedMesh } from "babylonjs/Meshes/instancedMesh";
  17063. import { Effect } from "babylonjs/Materials/effect";
  17064. import { Material } from "babylonjs/Materials/material";
  17065. import "babylonjs/Shaders/color.fragment";
  17066. import "babylonjs/Shaders/color.vertex";
  17067. /**
  17068. * Line mesh
  17069. * @see https://doc.babylonjs.com/babylon101/parametric_shapes
  17070. */
  17071. export class LinesMesh extends Mesh {
  17072. /**
  17073. * If vertex color should be applied to the mesh
  17074. */
  17075. readonly useVertexColor?: boolean | undefined;
  17076. /**
  17077. * If vertex alpha should be applied to the mesh
  17078. */
  17079. readonly useVertexAlpha?: boolean | undefined;
  17080. /**
  17081. * Color of the line (Default: White)
  17082. */
  17083. color: Color3;
  17084. /**
  17085. * Alpha of the line (Default: 1)
  17086. */
  17087. alpha: number;
  17088. /**
  17089. * The intersection Threshold is the margin applied when intersection a segment of the LinesMesh with a Ray.
  17090. * This margin is expressed in world space coordinates, so its value may vary.
  17091. * Default value is 0.1
  17092. */
  17093. intersectionThreshold: number;
  17094. private _colorShader;
  17095. private color4;
  17096. /**
  17097. * Creates a new LinesMesh
  17098. * @param name defines the name
  17099. * @param scene defines the hosting scene
  17100. * @param parent defines the parent mesh if any
  17101. * @param source defines the optional source LinesMesh used to clone data from
  17102. * @param doNotCloneChildren When cloning, skip cloning child meshes of source, default False.
  17103. * When false, achieved by calling a clone(), also passing False.
  17104. * This will make creation of children, recursive.
  17105. * @param useVertexColor defines if this LinesMesh supports vertex color
  17106. * @param useVertexAlpha defines if this LinesMesh supports vertex alpha
  17107. */
  17108. constructor(name: string, scene?: Nullable<Scene>, parent?: Nullable<Node>, source?: Nullable<LinesMesh>, doNotCloneChildren?: boolean,
  17109. /**
  17110. * If vertex color should be applied to the mesh
  17111. */
  17112. useVertexColor?: boolean | undefined,
  17113. /**
  17114. * If vertex alpha should be applied to the mesh
  17115. */
  17116. useVertexAlpha?: boolean | undefined);
  17117. private _addClipPlaneDefine;
  17118. private _removeClipPlaneDefine;
  17119. isReady(): boolean;
  17120. /**
  17121. * Returns the string "LineMesh"
  17122. */
  17123. getClassName(): string;
  17124. /**
  17125. * @hidden
  17126. */
  17127. get material(): Material;
  17128. /**
  17129. * @hidden
  17130. */
  17131. set material(value: Material);
  17132. /**
  17133. * @hidden
  17134. */
  17135. get checkCollisions(): boolean;
  17136. /** @hidden */
  17137. _bind(subMesh: SubMesh, effect: Effect, fillMode: number): Mesh;
  17138. /** @hidden */
  17139. _draw(subMesh: SubMesh, fillMode: number, instancesCount?: number): Mesh;
  17140. /**
  17141. * Disposes of the line mesh
  17142. * @param doNotRecurse If children should be disposed
  17143. */
  17144. dispose(doNotRecurse?: boolean): void;
  17145. /**
  17146. * Returns a new LineMesh object cloned from the current one.
  17147. */
  17148. clone(name: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean): LinesMesh;
  17149. /**
  17150. * Creates a new InstancedLinesMesh object from the mesh model.
  17151. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  17152. * @param name defines the name of the new instance
  17153. * @returns a new InstancedLinesMesh
  17154. */
  17155. createInstance(name: string): InstancedLinesMesh;
  17156. }
  17157. /**
  17158. * Creates an instance based on a source LinesMesh
  17159. */
  17160. export class InstancedLinesMesh extends InstancedMesh {
  17161. /**
  17162. * The intersection Threshold is the margin applied when intersection a segment of the LinesMesh with a Ray.
  17163. * This margin is expressed in world space coordinates, so its value may vary.
  17164. * Initilized with the intersectionThreshold value of the source LinesMesh
  17165. */
  17166. intersectionThreshold: number;
  17167. constructor(name: string, source: LinesMesh);
  17168. /**
  17169. * Returns the string "InstancedLinesMesh".
  17170. */
  17171. getClassName(): string;
  17172. }
  17173. }
  17174. declare module "babylonjs/Shaders/line.fragment" {
  17175. /** @hidden */
  17176. export var linePixelShader: {
  17177. name: string;
  17178. shader: string;
  17179. };
  17180. }
  17181. declare module "babylonjs/Shaders/line.vertex" {
  17182. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  17183. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  17184. /** @hidden */
  17185. export var lineVertexShader: {
  17186. name: string;
  17187. shader: string;
  17188. };
  17189. }
  17190. declare module "babylonjs/Rendering/edgesRenderer" {
  17191. import { Nullable } from "babylonjs/types";
  17192. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  17193. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  17194. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  17195. import { IDisposable } from "babylonjs/scene";
  17196. import { ShaderMaterial } from "babylonjs/Materials/shaderMaterial";
  17197. import "babylonjs/Shaders/line.fragment";
  17198. import "babylonjs/Shaders/line.vertex";
  17199. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  17200. import { SmartArray } from "babylonjs/Misc/smartArray";
  17201. module "babylonjs/scene" {
  17202. interface Scene {
  17203. /** @hidden */
  17204. _edgeRenderLineShader: Nullable<ShaderMaterial>;
  17205. }
  17206. }
  17207. module "babylonjs/Meshes/abstractMesh" {
  17208. interface AbstractMesh {
  17209. /**
  17210. * Gets the edgesRenderer associated with the mesh
  17211. */
  17212. edgesRenderer: Nullable<EdgesRenderer>;
  17213. }
  17214. }
  17215. module "babylonjs/Meshes/linesMesh" {
  17216. interface LinesMesh {
  17217. /**
  17218. * Enables the edge rendering mode on the mesh.
  17219. * This mode makes the mesh edges visible
  17220. * @param epsilon defines the maximal distance between two angles to detect a face
  17221. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  17222. * @returns the currentAbstractMesh
  17223. * @see https://www.babylonjs-playground.com/#19O9TU#0
  17224. */
  17225. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): AbstractMesh;
  17226. }
  17227. }
  17228. module "babylonjs/Meshes/linesMesh" {
  17229. interface InstancedLinesMesh {
  17230. /**
  17231. * Enables the edge rendering mode on the mesh.
  17232. * This mode makes the mesh edges visible
  17233. * @param epsilon defines the maximal distance between two angles to detect a face
  17234. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  17235. * @returns the current InstancedLinesMesh
  17236. * @see https://www.babylonjs-playground.com/#19O9TU#0
  17237. */
  17238. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): InstancedLinesMesh;
  17239. }
  17240. }
  17241. /**
  17242. * Defines the minimum contract an Edges renderer should follow.
  17243. */
  17244. export interface IEdgesRenderer extends IDisposable {
  17245. /**
  17246. * Gets or sets a boolean indicating if the edgesRenderer is active
  17247. */
  17248. isEnabled: boolean;
  17249. /**
  17250. * Renders the edges of the attached mesh,
  17251. */
  17252. render(): void;
  17253. /**
  17254. * Checks wether or not the edges renderer is ready to render.
  17255. * @return true if ready, otherwise false.
  17256. */
  17257. isReady(): boolean;
  17258. /**
  17259. * List of instances to render in case the source mesh has instances
  17260. */
  17261. customInstances: SmartArray<Matrix>;
  17262. }
  17263. /**
  17264. * Defines the additional options of the edges renderer
  17265. */
  17266. export interface IEdgesRendererOptions {
  17267. /**
  17268. * Gets or sets a boolean indicating that the alternate edge finder algorithm must be used
  17269. * If not defined, the default value is true
  17270. */
  17271. useAlternateEdgeFinder?: boolean;
  17272. /**
  17273. * Gets or sets a boolean indicating that the vertex merger fast processing must be used.
  17274. * If not defined, the default value is true.
  17275. * 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)
  17276. * This option is used only if useAlternateEdgeFinder = true
  17277. */
  17278. useFastVertexMerger?: boolean;
  17279. /**
  17280. * During edges processing, the vertices are merged if they are close enough: epsilonVertexMerge is the limit whithin which vertices are considered to be equal.
  17281. * The default value is 1e-6
  17282. * This option is used only if useAlternateEdgeFinder = true
  17283. */
  17284. epsilonVertexMerge?: number;
  17285. /**
  17286. * 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
  17287. * 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.
  17288. * This option is used only if useAlternateEdgeFinder = true
  17289. */
  17290. applyTessellation?: boolean;
  17291. /**
  17292. * 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
  17293. * The default value is 1e-6
  17294. * This option is used only if useAlternateEdgeFinder = true
  17295. */
  17296. epsilonVertexAligned?: number;
  17297. }
  17298. /**
  17299. * This class is used to generate edges of the mesh that could then easily be rendered in a scene.
  17300. */
  17301. export class EdgesRenderer implements IEdgesRenderer {
  17302. /**
  17303. * Define the size of the edges with an orthographic camera
  17304. */
  17305. edgesWidthScalerForOrthographic: number;
  17306. /**
  17307. * Define the size of the edges with a perspective camera
  17308. */
  17309. edgesWidthScalerForPerspective: number;
  17310. protected _source: AbstractMesh;
  17311. protected _linesPositions: number[];
  17312. protected _linesNormals: number[];
  17313. protected _linesIndices: number[];
  17314. protected _epsilon: number;
  17315. protected _indicesCount: number;
  17316. protected _lineShader: ShaderMaterial;
  17317. protected _ib: DataBuffer;
  17318. protected _buffers: {
  17319. [key: string]: Nullable<VertexBuffer>;
  17320. };
  17321. protected _buffersForInstances: {
  17322. [key: string]: Nullable<VertexBuffer>;
  17323. };
  17324. protected _checkVerticesInsteadOfIndices: boolean;
  17325. protected _options: Nullable<IEdgesRendererOptions>;
  17326. private _meshRebuildObserver;
  17327. private _meshDisposeObserver;
  17328. /** Gets or sets a boolean indicating if the edgesRenderer is active */
  17329. isEnabled: boolean;
  17330. /**
  17331. * List of instances to render in case the source mesh has instances
  17332. */
  17333. customInstances: SmartArray<Matrix>;
  17334. private static GetShader;
  17335. /**
  17336. * Creates an instance of the EdgesRenderer. It is primarily use to display edges of a mesh.
  17337. * Beware when you use this class with complex objects as the adjacencies computation can be really long
  17338. * @param source Mesh used to create edges
  17339. * @param epsilon sum of angles in adjacency to check for edge
  17340. * @param checkVerticesInsteadOfIndices bases the edges detection on vertices vs indices. Note that this parameter is not used if options.useAlternateEdgeFinder = true
  17341. * @param generateEdgesLines - should generate Lines or only prepare resources.
  17342. * @param options The options to apply when generating the edges
  17343. */
  17344. constructor(source: AbstractMesh, epsilon?: number, checkVerticesInsteadOfIndices?: boolean, generateEdgesLines?: boolean, options?: IEdgesRendererOptions);
  17345. protected _prepareRessources(): void;
  17346. /** @hidden */
  17347. _rebuild(): void;
  17348. /**
  17349. * Releases the required resources for the edges renderer
  17350. */
  17351. dispose(): void;
  17352. protected _processEdgeForAdjacencies(pa: number, pb: number, p0: number, p1: number, p2: number): number;
  17353. protected _processEdgeForAdjacenciesWithVertices(pa: Vector3, pb: Vector3, p0: Vector3, p1: Vector3, p2: Vector3): number;
  17354. /**
  17355. * Checks if the pair of p0 and p1 is en edge
  17356. * @param faceIndex
  17357. * @param edge
  17358. * @param faceNormals
  17359. * @param p0
  17360. * @param p1
  17361. * @private
  17362. */
  17363. protected _checkEdge(faceIndex: number, edge: number, faceNormals: Array<Vector3>, p0: Vector3, p1: Vector3): void;
  17364. /**
  17365. * push line into the position, normal and index buffer
  17366. * @protected
  17367. */
  17368. protected createLine(p0: Vector3, p1: Vector3, offset: number): void;
  17369. /**
  17370. * See https://playground.babylonjs.com/#R3JR6V#1 for a visual display of the algorithm
  17371. */
  17372. private _tessellateTriangle;
  17373. private _generateEdgesLinesAlternate;
  17374. /**
  17375. * Generates lines edges from adjacencjes
  17376. * @private
  17377. */
  17378. _generateEdgesLines(): void;
  17379. /**
  17380. * Checks wether or not the edges renderer is ready to render.
  17381. * @return true if ready, otherwise false.
  17382. */
  17383. isReady(): boolean;
  17384. /**
  17385. * Renders the edges of the attached mesh,
  17386. */
  17387. render(): void;
  17388. }
  17389. /**
  17390. * LineEdgesRenderer for LineMeshes to remove unnecessary triangulation
  17391. */
  17392. export class LineEdgesRenderer extends EdgesRenderer {
  17393. /**
  17394. * This constructor turns off auto generating edges line in Edges Renderer to make it here.
  17395. * @param source LineMesh used to generate edges
  17396. * @param epsilon not important (specified angle for edge detection)
  17397. * @param checkVerticesInsteadOfIndices not important for LineMesh
  17398. */
  17399. constructor(source: AbstractMesh, epsilon?: number, checkVerticesInsteadOfIndices?: boolean);
  17400. /**
  17401. * Generate edges for each line in LinesMesh. Every Line should be rendered as edge.
  17402. */
  17403. _generateEdgesLines(): void;
  17404. }
  17405. }
  17406. declare module "babylonjs/Rendering/renderingGroup" {
  17407. import { SmartArray, SmartArrayNoDuplicate } from "babylonjs/Misc/smartArray";
  17408. import { SubMesh } from "babylonjs/Meshes/subMesh";
  17409. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  17410. import { Nullable } from "babylonjs/types";
  17411. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  17412. import { IEdgesRenderer } from "babylonjs/Rendering/edgesRenderer";
  17413. import { ISpriteManager } from "babylonjs/Sprites/spriteManager";
  17414. import { Material } from "babylonjs/Materials/material";
  17415. import { Scene } from "babylonjs/scene";
  17416. /**
  17417. * This represents the object necessary to create a rendering group.
  17418. * This is exclusively used and created by the rendering manager.
  17419. * To modify the behavior, you use the available helpers in your scene or meshes.
  17420. * @hidden
  17421. */
  17422. export class RenderingGroup {
  17423. index: number;
  17424. private static _zeroVector;
  17425. private _scene;
  17426. private _opaqueSubMeshes;
  17427. private _transparentSubMeshes;
  17428. private _alphaTestSubMeshes;
  17429. private _depthOnlySubMeshes;
  17430. private _particleSystems;
  17431. private _spriteManagers;
  17432. private _opaqueSortCompareFn;
  17433. private _alphaTestSortCompareFn;
  17434. private _transparentSortCompareFn;
  17435. private _renderOpaque;
  17436. private _renderAlphaTest;
  17437. private _renderTransparent;
  17438. /** @hidden */
  17439. _edgesRenderers: SmartArrayNoDuplicate<IEdgesRenderer>;
  17440. onBeforeTransparentRendering: () => void;
  17441. /**
  17442. * Set the opaque sort comparison function.
  17443. * If null the sub meshes will be render in the order they were created
  17444. */
  17445. set opaqueSortCompareFn(value: Nullable<(a: SubMesh, b: SubMesh) => number>);
  17446. /**
  17447. * Set the alpha test sort comparison function.
  17448. * If null the sub meshes will be render in the order they were created
  17449. */
  17450. set alphaTestSortCompareFn(value: Nullable<(a: SubMesh, b: SubMesh) => number>);
  17451. /**
  17452. * Set the transparent sort comparison function.
  17453. * If null the sub meshes will be render in the order they were created
  17454. */
  17455. set transparentSortCompareFn(value: Nullable<(a: SubMesh, b: SubMesh) => number>);
  17456. /**
  17457. * Creates a new rendering group.
  17458. * @param index The rendering group index
  17459. * @param opaqueSortCompareFn The opaque sort comparison function. If null no order is applied
  17460. * @param alphaTestSortCompareFn The alpha test sort comparison function. If null no order is applied
  17461. * @param transparentSortCompareFn The transparent sort comparison function. If null back to front + alpha index sort is applied
  17462. */
  17463. 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>);
  17464. /**
  17465. * Render all the sub meshes contained in the group.
  17466. * @param customRenderFunction Used to override the default render behaviour of the group.
  17467. * @returns true if rendered some submeshes.
  17468. */
  17469. render(customRenderFunction: Nullable<(opaqueSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>) => void>, renderSprites: boolean, renderParticles: boolean, activeMeshes: Nullable<AbstractMesh[]>): void;
  17470. /**
  17471. * Renders the opaque submeshes in the order from the opaqueSortCompareFn.
  17472. * @param subMeshes The submeshes to render
  17473. */
  17474. private renderOpaqueSorted;
  17475. /**
  17476. * Renders the opaque submeshes in the order from the alphatestSortCompareFn.
  17477. * @param subMeshes The submeshes to render
  17478. */
  17479. private renderAlphaTestSorted;
  17480. /**
  17481. * Renders the opaque submeshes in the order from the transparentSortCompareFn.
  17482. * @param subMeshes The submeshes to render
  17483. */
  17484. private renderTransparentSorted;
  17485. /**
  17486. * Renders the submeshes in a specified order.
  17487. * @param subMeshes The submeshes to sort before render
  17488. * @param sortCompareFn The comparison function use to sort
  17489. * @param cameraPosition The camera position use to preprocess the submeshes to help sorting
  17490. * @param transparent Specifies to activate blending if true
  17491. */
  17492. private static renderSorted;
  17493. /**
  17494. * Renders the submeshes in the order they were dispatched (no sort applied).
  17495. * @param subMeshes The submeshes to render
  17496. */
  17497. private static renderUnsorted;
  17498. /**
  17499. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  17500. * are rendered back to front if in the same alpha index.
  17501. *
  17502. * @param a The first submesh
  17503. * @param b The second submesh
  17504. * @returns The result of the comparison
  17505. */
  17506. static defaultTransparentSortCompare(a: SubMesh, b: SubMesh): number;
  17507. /**
  17508. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  17509. * are rendered back to front.
  17510. *
  17511. * @param a The first submesh
  17512. * @param b The second submesh
  17513. * @returns The result of the comparison
  17514. */
  17515. static backToFrontSortCompare(a: SubMesh, b: SubMesh): number;
  17516. /**
  17517. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  17518. * are rendered front to back (prevent overdraw).
  17519. *
  17520. * @param a The first submesh
  17521. * @param b The second submesh
  17522. * @returns The result of the comparison
  17523. */
  17524. static frontToBackSortCompare(a: SubMesh, b: SubMesh): number;
  17525. /**
  17526. * Resets the different lists of submeshes to prepare a new frame.
  17527. */
  17528. prepare(): void;
  17529. dispose(): void;
  17530. /**
  17531. * Inserts the submesh in its correct queue depending on its material.
  17532. * @param subMesh The submesh to dispatch
  17533. * @param [mesh] Optional reference to the submeshes's mesh. Provide if you have an exiting reference to improve performance.
  17534. * @param [material] Optional reference to the submeshes's material. Provide if you have an exiting reference to improve performance.
  17535. */
  17536. dispatch(subMesh: SubMesh, mesh?: AbstractMesh, material?: Nullable<Material>): void;
  17537. dispatchSprites(spriteManager: ISpriteManager): void;
  17538. dispatchParticles(particleSystem: IParticleSystem): void;
  17539. private _renderParticles;
  17540. private _renderSprites;
  17541. }
  17542. }
  17543. declare module "babylonjs/Rendering/renderingManager" {
  17544. import { Nullable } from "babylonjs/types";
  17545. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  17546. import { SubMesh } from "babylonjs/Meshes/subMesh";
  17547. import { SmartArray } from "babylonjs/Misc/smartArray";
  17548. import { ISpriteManager } from "babylonjs/Sprites/spriteManager";
  17549. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  17550. import { Material } from "babylonjs/Materials/material";
  17551. import { Scene } from "babylonjs/scene";
  17552. import { Camera } from "babylonjs/Cameras/camera";
  17553. /**
  17554. * Interface describing the different options available in the rendering manager
  17555. * regarding Auto Clear between groups.
  17556. */
  17557. export interface IRenderingManagerAutoClearSetup {
  17558. /**
  17559. * Defines whether or not autoclear is enable.
  17560. */
  17561. autoClear: boolean;
  17562. /**
  17563. * Defines whether or not to autoclear the depth buffer.
  17564. */
  17565. depth: boolean;
  17566. /**
  17567. * Defines whether or not to autoclear the stencil buffer.
  17568. */
  17569. stencil: boolean;
  17570. }
  17571. /**
  17572. * This class is used by the onRenderingGroupObservable
  17573. */
  17574. export class RenderingGroupInfo {
  17575. /**
  17576. * The Scene that being rendered
  17577. */
  17578. scene: Scene;
  17579. /**
  17580. * The camera currently used for the rendering pass
  17581. */
  17582. camera: Nullable<Camera>;
  17583. /**
  17584. * The ID of the renderingGroup being processed
  17585. */
  17586. renderingGroupId: number;
  17587. }
  17588. /**
  17589. * This is the manager responsible of all the rendering for meshes sprites and particles.
  17590. * It is enable to manage the different groups as well as the different necessary sort functions.
  17591. * This should not be used directly aside of the few static configurations
  17592. */
  17593. export class RenderingManager {
  17594. /**
  17595. * The max id used for rendering groups (not included)
  17596. */
  17597. static MAX_RENDERINGGROUPS: number;
  17598. /**
  17599. * The min id used for rendering groups (included)
  17600. */
  17601. static MIN_RENDERINGGROUPS: number;
  17602. /**
  17603. * Used to globally prevent autoclearing scenes.
  17604. */
  17605. static AUTOCLEAR: boolean;
  17606. /**
  17607. * @hidden
  17608. */
  17609. _useSceneAutoClearSetup: boolean;
  17610. private _scene;
  17611. private _renderingGroups;
  17612. private _depthStencilBufferAlreadyCleaned;
  17613. private _autoClearDepthStencil;
  17614. private _customOpaqueSortCompareFn;
  17615. private _customAlphaTestSortCompareFn;
  17616. private _customTransparentSortCompareFn;
  17617. private _renderingGroupInfo;
  17618. /**
  17619. * Instantiates a new rendering group for a particular scene
  17620. * @param scene Defines the scene the groups belongs to
  17621. */
  17622. constructor(scene: Scene);
  17623. private _clearDepthStencilBuffer;
  17624. /**
  17625. * Renders the entire managed groups. This is used by the scene or the different rennder targets.
  17626. * @hidden
  17627. */
  17628. render(customRenderFunction: Nullable<(opaqueSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>) => void>, activeMeshes: Nullable<AbstractMesh[]>, renderParticles: boolean, renderSprites: boolean): void;
  17629. /**
  17630. * Resets the different information of the group to prepare a new frame
  17631. * @hidden
  17632. */
  17633. reset(): void;
  17634. /**
  17635. * Dispose and release the group and its associated resources.
  17636. * @hidden
  17637. */
  17638. dispose(): void;
  17639. /**
  17640. * Clear the info related to rendering groups preventing retention points during dispose.
  17641. */
  17642. freeRenderingGroups(): void;
  17643. private _prepareRenderingGroup;
  17644. /**
  17645. * Add a sprite manager to the rendering manager in order to render it this frame.
  17646. * @param spriteManager Define the sprite manager to render
  17647. */
  17648. dispatchSprites(spriteManager: ISpriteManager): void;
  17649. /**
  17650. * Add a particle system to the rendering manager in order to render it this frame.
  17651. * @param particleSystem Define the particle system to render
  17652. */
  17653. dispatchParticles(particleSystem: IParticleSystem): void;
  17654. /**
  17655. * Add a submesh to the manager in order to render it this frame
  17656. * @param subMesh The submesh to dispatch
  17657. * @param mesh Optional reference to the submeshes's mesh. Provide if you have an exiting reference to improve performance.
  17658. * @param material Optional reference to the submeshes's material. Provide if you have an exiting reference to improve performance.
  17659. */
  17660. dispatch(subMesh: SubMesh, mesh?: AbstractMesh, material?: Nullable<Material>): void;
  17661. /**
  17662. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  17663. * This allowed control for front to back rendering or reversly depending of the special needs.
  17664. *
  17665. * @param renderingGroupId The rendering group id corresponding to its index
  17666. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  17667. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  17668. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  17669. */
  17670. 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;
  17671. /**
  17672. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  17673. *
  17674. * @param renderingGroupId The rendering group id corresponding to its index
  17675. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  17676. * @param depth Automatically clears depth between groups if true and autoClear is true.
  17677. * @param stencil Automatically clears stencil between groups if true and autoClear is true.
  17678. */
  17679. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean, depth?: boolean, stencil?: boolean): void;
  17680. /**
  17681. * Gets the current auto clear configuration for one rendering group of the rendering
  17682. * manager.
  17683. * @param index the rendering group index to get the information for
  17684. * @returns The auto clear setup for the requested rendering group
  17685. */
  17686. getAutoClearDepthStencilSetup(index: number): IRenderingManagerAutoClearSetup;
  17687. }
  17688. }
  17689. declare module "babylonjs/Lights/Shadows/shadowGenerator" {
  17690. import { SmartArray } from "babylonjs/Misc/smartArray";
  17691. import { Nullable } from "babylonjs/types";
  17692. import { Scene } from "babylonjs/scene";
  17693. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  17694. import { SubMesh } from "babylonjs/Meshes/subMesh";
  17695. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  17696. import { Mesh } from "babylonjs/Meshes/mesh";
  17697. import { IShadowLight } from "babylonjs/Lights/shadowLight";
  17698. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  17699. import { Effect } from "babylonjs/Materials/effect";
  17700. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  17701. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  17702. import "babylonjs/Shaders/shadowMap.fragment";
  17703. import "babylonjs/Shaders/shadowMap.vertex";
  17704. import "babylonjs/Shaders/depthBoxBlur.fragment";
  17705. import "babylonjs/Shaders/ShadersInclude/shadowMapFragmentSoftTransparentShadow";
  17706. import { Observable } from "babylonjs/Misc/observable";
  17707. /**
  17708. * Defines the options associated with the creation of a custom shader for a shadow generator.
  17709. */
  17710. export interface ICustomShaderOptions {
  17711. /**
  17712. * Gets or sets the custom shader name to use
  17713. */
  17714. shaderName: string;
  17715. /**
  17716. * The list of attribute names used in the shader
  17717. */
  17718. attributes?: string[];
  17719. /**
  17720. * The list of unifrom names used in the shader
  17721. */
  17722. uniforms?: string[];
  17723. /**
  17724. * The list of sampler names used in the shader
  17725. */
  17726. samplers?: string[];
  17727. /**
  17728. * The list of defines used in the shader
  17729. */
  17730. defines?: string[];
  17731. }
  17732. /**
  17733. * Interface to implement to create a shadow generator compatible with BJS.
  17734. */
  17735. export interface IShadowGenerator {
  17736. /**
  17737. * Gets the main RTT containing the shadow map (usually storing depth from the light point of view).
  17738. * @returns The render target texture if present otherwise, null
  17739. */
  17740. getShadowMap(): Nullable<RenderTargetTexture>;
  17741. /**
  17742. * Determine wheter the shadow generator is ready or not (mainly all effects and related post processes needs to be ready).
  17743. * @param subMesh The submesh we want to render in the shadow map
  17744. * @param useInstances Defines wether will draw in the map using instances
  17745. * @param isTransparent Indicates that isReady is called for a transparent subMesh
  17746. * @returns true if ready otherwise, false
  17747. */
  17748. isReady(subMesh: SubMesh, useInstances: boolean, isTransparent: boolean): boolean;
  17749. /**
  17750. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  17751. * @param defines Defines of the material we want to update
  17752. * @param lightIndex Index of the light in the enabled light list of the material
  17753. */
  17754. prepareDefines(defines: MaterialDefines, lightIndex: number): void;
  17755. /**
  17756. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  17757. * defined in the generator but impacting the effect).
  17758. * It implies the unifroms available on the materials are the standard BJS ones.
  17759. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  17760. * @param effect The effect we are binfing the information for
  17761. */
  17762. bindShadowLight(lightIndex: string, effect: Effect): void;
  17763. /**
  17764. * Gets the transformation matrix used to project the meshes into the map from the light point of view.
  17765. * (eq to shadow prjection matrix * light transform matrix)
  17766. * @returns The transform matrix used to create the shadow map
  17767. */
  17768. getTransformMatrix(): Matrix;
  17769. /**
  17770. * Recreates the shadow map dependencies like RTT and post processes. This can be used during the switch between
  17771. * Cube and 2D textures for instance.
  17772. */
  17773. recreateShadowMap(): void;
  17774. /**
  17775. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  17776. * @param onCompiled Callback triggered at the and of the effects compilation
  17777. * @param options Sets of optional options forcing the compilation with different modes
  17778. */
  17779. forceCompilation(onCompiled?: (generator: IShadowGenerator) => void, options?: Partial<{
  17780. useInstances: boolean;
  17781. }>): void;
  17782. /**
  17783. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  17784. * @param options Sets of optional options forcing the compilation with different modes
  17785. * @returns A promise that resolves when the compilation completes
  17786. */
  17787. forceCompilationAsync(options?: Partial<{
  17788. useInstances: boolean;
  17789. }>): Promise<void>;
  17790. /**
  17791. * Serializes the shadow generator setup to a json object.
  17792. * @returns The serialized JSON object
  17793. */
  17794. serialize(): any;
  17795. /**
  17796. * Disposes the Shadow map and related Textures and effects.
  17797. */
  17798. dispose(): void;
  17799. }
  17800. /**
  17801. * Default implementation IShadowGenerator.
  17802. * This is the main object responsible of generating shadows in the framework.
  17803. * Documentation: https://doc.babylonjs.com/babylon101/shadows
  17804. */
  17805. export class ShadowGenerator implements IShadowGenerator {
  17806. /**
  17807. * Name of the shadow generator class
  17808. */
  17809. static CLASSNAME: string;
  17810. /**
  17811. * Shadow generator mode None: no filtering applied.
  17812. */
  17813. static readonly FILTER_NONE: number;
  17814. /**
  17815. * Shadow generator mode ESM: Exponential Shadow Mapping.
  17816. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  17817. */
  17818. static readonly FILTER_EXPONENTIALSHADOWMAP: number;
  17819. /**
  17820. * Shadow generator mode Poisson Sampling: Percentage Closer Filtering.
  17821. * (Multiple Tap around evenly distributed around the pixel are used to evaluate the shadow strength)
  17822. */
  17823. static readonly FILTER_POISSONSAMPLING: number;
  17824. /**
  17825. * Shadow generator mode ESM: Blurred Exponential Shadow Mapping.
  17826. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  17827. */
  17828. static readonly FILTER_BLUREXPONENTIALSHADOWMAP: number;
  17829. /**
  17830. * Shadow generator mode ESM: Exponential Shadow Mapping using the inverse of the exponential preventing
  17831. * edge artifacts on steep falloff.
  17832. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  17833. */
  17834. static readonly FILTER_CLOSEEXPONENTIALSHADOWMAP: number;
  17835. /**
  17836. * Shadow generator mode ESM: Blurred Exponential Shadow Mapping using the inverse of the exponential preventing
  17837. * edge artifacts on steep falloff.
  17838. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  17839. */
  17840. static readonly FILTER_BLURCLOSEEXPONENTIALSHADOWMAP: number;
  17841. /**
  17842. * Shadow generator mode PCF: Percentage Closer Filtering
  17843. * benefits from Webgl 2 shadow samplers. Fallback to Poisson Sampling in Webgl 1
  17844. * (https://developer.nvidia.com/gpugems/GPUGems/gpugems_ch11.html)
  17845. */
  17846. static readonly FILTER_PCF: number;
  17847. /**
  17848. * Shadow generator mode PCSS: Percentage Closering Soft Shadow.
  17849. * benefits from Webgl 2 shadow samplers. Fallback to Poisson Sampling in Webgl 1
  17850. * Contact Hardening
  17851. */
  17852. static readonly FILTER_PCSS: number;
  17853. /**
  17854. * Reserved for PCF and PCSS
  17855. * Highest Quality.
  17856. *
  17857. * Execute PCF on a 5*5 kernel improving a lot the shadow aliasing artifacts.
  17858. *
  17859. * Execute PCSS with 32 taps blocker search and 64 taps PCF.
  17860. */
  17861. static readonly QUALITY_HIGH: number;
  17862. /**
  17863. * Reserved for PCF and PCSS
  17864. * Good tradeoff for quality/perf cross devices
  17865. *
  17866. * Execute PCF on a 3*3 kernel.
  17867. *
  17868. * Execute PCSS with 16 taps blocker search and 32 taps PCF.
  17869. */
  17870. static readonly QUALITY_MEDIUM: number;
  17871. /**
  17872. * Reserved for PCF and PCSS
  17873. * The lowest quality but the fastest.
  17874. *
  17875. * Execute PCF on a 1*1 kernel.
  17876. *
  17877. * Execute PCSS with 16 taps blocker search and 16 taps PCF.
  17878. */
  17879. static readonly QUALITY_LOW: number;
  17880. /** Gets or sets the custom shader name to use */
  17881. customShaderOptions: ICustomShaderOptions;
  17882. /**
  17883. * Observable triggered before the shadow is rendered. Can be used to update internal effect state
  17884. */
  17885. onBeforeShadowMapRenderObservable: Observable<Effect>;
  17886. /**
  17887. * Observable triggered after the shadow is rendered. Can be used to restore internal effect state
  17888. */
  17889. onAfterShadowMapRenderObservable: Observable<Effect>;
  17890. /**
  17891. * Observable triggered before a mesh is rendered in the shadow map.
  17892. * Can be used to update internal effect state (that you can get from the onBeforeShadowMapRenderObservable)
  17893. */
  17894. onBeforeShadowMapRenderMeshObservable: Observable<Mesh>;
  17895. /**
  17896. * Observable triggered after a mesh is rendered in the shadow map.
  17897. * Can be used to update internal effect state (that you can get from the onAfterShadowMapRenderObservable)
  17898. */
  17899. onAfterShadowMapRenderMeshObservable: Observable<Mesh>;
  17900. protected _bias: number;
  17901. /**
  17902. * Gets the bias: offset applied on the depth preventing acnea (in light direction).
  17903. */
  17904. get bias(): number;
  17905. /**
  17906. * Sets the bias: offset applied on the depth preventing acnea (in light direction).
  17907. */
  17908. set bias(bias: number);
  17909. protected _normalBias: number;
  17910. /**
  17911. * Gets the normalBias: offset applied on the depth preventing acnea (along side the normal direction and proportinal to the light/normal angle).
  17912. */
  17913. get normalBias(): number;
  17914. /**
  17915. * Sets the normalBias: offset applied on the depth preventing acnea (along side the normal direction and proportinal to the light/normal angle).
  17916. */
  17917. set normalBias(normalBias: number);
  17918. protected _blurBoxOffset: number;
  17919. /**
  17920. * Gets the blur box offset: offset applied during the blur pass.
  17921. * Only useful if useKernelBlur = false
  17922. */
  17923. get blurBoxOffset(): number;
  17924. /**
  17925. * Sets the blur box offset: offset applied during the blur pass.
  17926. * Only useful if useKernelBlur = false
  17927. */
  17928. set blurBoxOffset(value: number);
  17929. protected _blurScale: number;
  17930. /**
  17931. * Gets the blur scale: scale of the blurred texture compared to the main shadow map.
  17932. * 2 means half of the size.
  17933. */
  17934. get blurScale(): number;
  17935. /**
  17936. * Sets the blur scale: scale of the blurred texture compared to the main shadow map.
  17937. * 2 means half of the size.
  17938. */
  17939. set blurScale(value: number);
  17940. protected _blurKernel: number;
  17941. /**
  17942. * Gets the blur kernel: kernel size of the blur pass.
  17943. * Only useful if useKernelBlur = true
  17944. */
  17945. get blurKernel(): number;
  17946. /**
  17947. * Sets the blur kernel: kernel size of the blur pass.
  17948. * Only useful if useKernelBlur = true
  17949. */
  17950. set blurKernel(value: number);
  17951. protected _useKernelBlur: boolean;
  17952. /**
  17953. * Gets whether the blur pass is a kernel blur (if true) or box blur.
  17954. * Only useful in filtered mode (useBlurExponentialShadowMap...)
  17955. */
  17956. get useKernelBlur(): boolean;
  17957. /**
  17958. * Sets whether the blur pass is a kernel blur (if true) or box blur.
  17959. * Only useful in filtered mode (useBlurExponentialShadowMap...)
  17960. */
  17961. set useKernelBlur(value: boolean);
  17962. protected _depthScale: number;
  17963. /**
  17964. * Gets the depth scale used in ESM mode.
  17965. */
  17966. get depthScale(): number;
  17967. /**
  17968. * Sets the depth scale used in ESM mode.
  17969. * This can override the scale stored on the light.
  17970. */
  17971. set depthScale(value: number);
  17972. protected _validateFilter(filter: number): number;
  17973. protected _filter: number;
  17974. /**
  17975. * Gets the current mode of the shadow generator (normal, PCF, ESM...).
  17976. * The returned value is a number equal to one of the available mode defined in ShadowMap.FILTER_x like _FILTER_NONE
  17977. */
  17978. get filter(): number;
  17979. /**
  17980. * Sets the current mode of the shadow generator (normal, PCF, ESM...).
  17981. * The returned value is a number equal to one of the available mode defined in ShadowMap.FILTER_x like _FILTER_NONE
  17982. */
  17983. set filter(value: number);
  17984. /**
  17985. * Gets if the current filter is set to Poisson Sampling.
  17986. */
  17987. get usePoissonSampling(): boolean;
  17988. /**
  17989. * Sets the current filter to Poisson Sampling.
  17990. */
  17991. set usePoissonSampling(value: boolean);
  17992. /**
  17993. * Gets if the current filter is set to ESM.
  17994. */
  17995. get useExponentialShadowMap(): boolean;
  17996. /**
  17997. * Sets the current filter is to ESM.
  17998. */
  17999. set useExponentialShadowMap(value: boolean);
  18000. /**
  18001. * Gets if the current filter is set to filtered ESM.
  18002. */
  18003. get useBlurExponentialShadowMap(): boolean;
  18004. /**
  18005. * Gets if the current filter is set to filtered ESM.
  18006. */
  18007. set useBlurExponentialShadowMap(value: boolean);
  18008. /**
  18009. * Gets if the current filter is set to "close ESM" (using the inverse of the
  18010. * exponential to prevent steep falloff artifacts).
  18011. */
  18012. get useCloseExponentialShadowMap(): boolean;
  18013. /**
  18014. * Sets the current filter to "close ESM" (using the inverse of the
  18015. * exponential to prevent steep falloff artifacts).
  18016. */
  18017. set useCloseExponentialShadowMap(value: boolean);
  18018. /**
  18019. * Gets if the current filter is set to filtered "close ESM" (using the inverse of the
  18020. * exponential to prevent steep falloff artifacts).
  18021. */
  18022. get useBlurCloseExponentialShadowMap(): boolean;
  18023. /**
  18024. * Sets the current filter to filtered "close ESM" (using the inverse of the
  18025. * exponential to prevent steep falloff artifacts).
  18026. */
  18027. set useBlurCloseExponentialShadowMap(value: boolean);
  18028. /**
  18029. * Gets if the current filter is set to "PCF" (percentage closer filtering).
  18030. */
  18031. get usePercentageCloserFiltering(): boolean;
  18032. /**
  18033. * Sets the current filter to "PCF" (percentage closer filtering).
  18034. */
  18035. set usePercentageCloserFiltering(value: boolean);
  18036. protected _filteringQuality: number;
  18037. /**
  18038. * Gets the PCF or PCSS Quality.
  18039. * Only valid if usePercentageCloserFiltering or usePercentageCloserFiltering is true.
  18040. */
  18041. get filteringQuality(): number;
  18042. /**
  18043. * Sets the PCF or PCSS Quality.
  18044. * Only valid if usePercentageCloserFiltering or usePercentageCloserFiltering is true.
  18045. */
  18046. set filteringQuality(filteringQuality: number);
  18047. /**
  18048. * Gets if the current filter is set to "PCSS" (contact hardening).
  18049. */
  18050. get useContactHardeningShadow(): boolean;
  18051. /**
  18052. * Sets the current filter to "PCSS" (contact hardening).
  18053. */
  18054. set useContactHardeningShadow(value: boolean);
  18055. protected _contactHardeningLightSizeUVRatio: number;
  18056. /**
  18057. * Gets the Light Size (in shadow map uv unit) used in PCSS to determine the blocker search area and the penumbra size.
  18058. * Using a ratio helps keeping shape stability independently of the map size.
  18059. *
  18060. * It does not account for the light projection as it was having too much
  18061. * instability during the light setup or during light position changes.
  18062. *
  18063. * Only valid if useContactHardeningShadow is true.
  18064. */
  18065. get contactHardeningLightSizeUVRatio(): number;
  18066. /**
  18067. * Sets the Light Size (in shadow map uv unit) used in PCSS to determine the blocker search area and the penumbra size.
  18068. * Using a ratio helps keeping shape stability independently of the map size.
  18069. *
  18070. * It does not account for the light projection as it was having too much
  18071. * instability during the light setup or during light position changes.
  18072. *
  18073. * Only valid if useContactHardeningShadow is true.
  18074. */
  18075. set contactHardeningLightSizeUVRatio(contactHardeningLightSizeUVRatio: number);
  18076. protected _darkness: number;
  18077. /** Gets or sets the actual darkness of a shadow */
  18078. get darkness(): number;
  18079. set darkness(value: number);
  18080. /**
  18081. * Returns the darkness value (float). This can only decrease the actual darkness of a shadow.
  18082. * 0 means strongest and 1 would means no shadow.
  18083. * @returns the darkness.
  18084. */
  18085. getDarkness(): number;
  18086. /**
  18087. * Sets the darkness value (float). This can only decrease the actual darkness of a shadow.
  18088. * @param darkness The darkness value 0 means strongest and 1 would means no shadow.
  18089. * @returns the shadow generator allowing fluent coding.
  18090. */
  18091. setDarkness(darkness: number): ShadowGenerator;
  18092. protected _transparencyShadow: boolean;
  18093. /** Gets or sets the ability to have transparent shadow */
  18094. get transparencyShadow(): boolean;
  18095. set transparencyShadow(value: boolean);
  18096. /**
  18097. * Sets the ability to have transparent shadow (boolean).
  18098. * @param transparent True if transparent else False
  18099. * @returns the shadow generator allowing fluent coding
  18100. */
  18101. setTransparencyShadow(transparent: boolean): ShadowGenerator;
  18102. /**
  18103. * Enables or disables shadows with varying strength based on the transparency
  18104. * When it is enabled, the strength of the shadow is taken equal to mesh.visibility
  18105. * If you enabled an alpha texture on your material, the alpha value red from the texture is also combined to compute the strength:
  18106. * mesh.visibility * alphaTexture.a
  18107. * Note that by definition transparencyShadow must be set to true for enableSoftTransparentShadow to work!
  18108. */
  18109. enableSoftTransparentShadow: boolean;
  18110. protected _shadowMap: Nullable<RenderTargetTexture>;
  18111. protected _shadowMap2: Nullable<RenderTargetTexture>;
  18112. /**
  18113. * Gets the main RTT containing the shadow map (usually storing depth from the light point of view).
  18114. * @returns The render target texture if present otherwise, null
  18115. */
  18116. getShadowMap(): Nullable<RenderTargetTexture>;
  18117. /**
  18118. * Gets the RTT used during rendering (can be a blurred version of the shadow map or the shadow map itself).
  18119. * @returns The render target texture if the shadow map is present otherwise, null
  18120. */
  18121. getShadowMapForRendering(): Nullable<RenderTargetTexture>;
  18122. /**
  18123. * Gets the class name of that object
  18124. * @returns "ShadowGenerator"
  18125. */
  18126. getClassName(): string;
  18127. /**
  18128. * Helper function to add a mesh and its descendants to the list of shadow casters.
  18129. * @param mesh Mesh to add
  18130. * @param includeDescendants boolean indicating if the descendants should be added. Default to true
  18131. * @returns the Shadow Generator itself
  18132. */
  18133. addShadowCaster(mesh: AbstractMesh, includeDescendants?: boolean): ShadowGenerator;
  18134. /**
  18135. * Helper function to remove a mesh and its descendants from the list of shadow casters
  18136. * @param mesh Mesh to remove
  18137. * @param includeDescendants boolean indicating if the descendants should be removed. Default to true
  18138. * @returns the Shadow Generator itself
  18139. */
  18140. removeShadowCaster(mesh: AbstractMesh, includeDescendants?: boolean): ShadowGenerator;
  18141. /**
  18142. * Controls the extent to which the shadows fade out at the edge of the frustum
  18143. */
  18144. frustumEdgeFalloff: number;
  18145. protected _light: IShadowLight;
  18146. /**
  18147. * Returns the associated light object.
  18148. * @returns the light generating the shadow
  18149. */
  18150. getLight(): IShadowLight;
  18151. /**
  18152. * If true the shadow map is generated by rendering the back face of the mesh instead of the front face.
  18153. * This can help with self-shadowing as the geometry making up the back of objects is slightly offset.
  18154. * It might on the other hand introduce peter panning.
  18155. */
  18156. forceBackFacesOnly: boolean;
  18157. protected _scene: Scene;
  18158. protected _lightDirection: Vector3;
  18159. protected _effect: Effect;
  18160. protected _viewMatrix: Matrix;
  18161. protected _projectionMatrix: Matrix;
  18162. protected _transformMatrix: Matrix;
  18163. protected _cachedPosition: Vector3;
  18164. protected _cachedDirection: Vector3;
  18165. protected _cachedDefines: string;
  18166. protected _currentRenderID: number;
  18167. protected _boxBlurPostprocess: Nullable<PostProcess>;
  18168. protected _kernelBlurXPostprocess: Nullable<PostProcess>;
  18169. protected _kernelBlurYPostprocess: Nullable<PostProcess>;
  18170. protected _blurPostProcesses: PostProcess[];
  18171. protected _mapSize: number;
  18172. protected _currentFaceIndex: number;
  18173. protected _currentFaceIndexCache: number;
  18174. protected _textureType: number;
  18175. protected _defaultTextureMatrix: Matrix;
  18176. protected _storedUniqueId: Nullable<number>;
  18177. /** @hidden */
  18178. static _SceneComponentInitialization: (scene: Scene) => void;
  18179. /**
  18180. * Creates a ShadowGenerator object.
  18181. * A ShadowGenerator is the required tool to use the shadows.
  18182. * Each light casting shadows needs to use its own ShadowGenerator.
  18183. * Documentation : https://doc.babylonjs.com/babylon101/shadows
  18184. * @param mapSize The size of the texture what stores the shadows. Example : 1024.
  18185. * @param light The light object generating the shadows.
  18186. * @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.
  18187. */
  18188. constructor(mapSize: number, light: IShadowLight, usefulFloatFirst?: boolean);
  18189. protected _initializeGenerator(): void;
  18190. protected _createTargetRenderTexture(): void;
  18191. protected _initializeShadowMap(): void;
  18192. protected _initializeBlurRTTAndPostProcesses(): void;
  18193. protected _renderForShadowMap(opaqueSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>): void;
  18194. protected _bindCustomEffectForRenderSubMeshForShadowMap(subMesh: SubMesh, effect: Effect, matriceNames: any, mesh: AbstractMesh): void;
  18195. protected _renderSubMeshForShadowMap(subMesh: SubMesh, isTransparent?: boolean): void;
  18196. protected _applyFilterValues(): void;
  18197. /**
  18198. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  18199. * @param onCompiled Callback triggered at the and of the effects compilation
  18200. * @param options Sets of optional options forcing the compilation with different modes
  18201. */
  18202. forceCompilation(onCompiled?: (generator: IShadowGenerator) => void, options?: Partial<{
  18203. useInstances: boolean;
  18204. }>): void;
  18205. /**
  18206. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  18207. * @param options Sets of optional options forcing the compilation with different modes
  18208. * @returns A promise that resolves when the compilation completes
  18209. */
  18210. forceCompilationAsync(options?: Partial<{
  18211. useInstances: boolean;
  18212. }>): Promise<void>;
  18213. protected _isReadyCustomDefines(defines: any, subMesh: SubMesh, useInstances: boolean): void;
  18214. private _prepareShadowDefines;
  18215. /**
  18216. * Determine wheter the shadow generator is ready or not (mainly all effects and related post processes needs to be ready).
  18217. * @param subMesh The submesh we want to render in the shadow map
  18218. * @param useInstances Defines wether will draw in the map using instances
  18219. * @param isTransparent Indicates that isReady is called for a transparent subMesh
  18220. * @returns true if ready otherwise, false
  18221. */
  18222. isReady(subMesh: SubMesh, useInstances: boolean, isTransparent: boolean): boolean;
  18223. /**
  18224. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  18225. * @param defines Defines of the material we want to update
  18226. * @param lightIndex Index of the light in the enabled light list of the material
  18227. */
  18228. prepareDefines(defines: any, lightIndex: number): void;
  18229. /**
  18230. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  18231. * defined in the generator but impacting the effect).
  18232. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  18233. * @param effect The effect we are binfing the information for
  18234. */
  18235. bindShadowLight(lightIndex: string, effect: Effect): void;
  18236. /**
  18237. * Gets the transformation matrix used to project the meshes into the map from the light point of view.
  18238. * (eq to shadow prjection matrix * light transform matrix)
  18239. * @returns The transform matrix used to create the shadow map
  18240. */
  18241. getTransformMatrix(): Matrix;
  18242. /**
  18243. * Recreates the shadow map dependencies like RTT and post processes. This can be used during the switch between
  18244. * Cube and 2D textures for instance.
  18245. */
  18246. recreateShadowMap(): void;
  18247. protected _disposeBlurPostProcesses(): void;
  18248. protected _disposeRTTandPostProcesses(): void;
  18249. /**
  18250. * Disposes the ShadowGenerator.
  18251. * Returns nothing.
  18252. */
  18253. dispose(): void;
  18254. /**
  18255. * Serializes the shadow generator setup to a json object.
  18256. * @returns The serialized JSON object
  18257. */
  18258. serialize(): any;
  18259. /**
  18260. * Parses a serialized ShadowGenerator and returns a new ShadowGenerator.
  18261. * @param parsedShadowGenerator The JSON object to parse
  18262. * @param scene The scene to create the shadow map for
  18263. * @param constr A function that builds a shadow generator or undefined to create an instance of the default shadow generator
  18264. * @returns The parsed shadow generator
  18265. */
  18266. static Parse(parsedShadowGenerator: any, scene: Scene, constr?: (mapSize: number, light: IShadowLight) => ShadowGenerator): ShadowGenerator;
  18267. }
  18268. }
  18269. declare module "babylonjs/Lights/light" {
  18270. import { Nullable } from "babylonjs/types";
  18271. import { Scene } from "babylonjs/scene";
  18272. import { Vector3 } from "babylonjs/Maths/math.vector";
  18273. import { Color3 } from "babylonjs/Maths/math.color";
  18274. import { Node } from "babylonjs/node";
  18275. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  18276. import { Effect } from "babylonjs/Materials/effect";
  18277. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  18278. import { IShadowGenerator } from "babylonjs/Lights/Shadows/shadowGenerator";
  18279. /**
  18280. * Base class of all the lights in Babylon. It groups all the generic information about lights.
  18281. * Lights are used, as you would expect, to affect how meshes are seen, in terms of both illumination and colour.
  18282. * 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.
  18283. */
  18284. export abstract class Light extends Node {
  18285. /**
  18286. * Falloff Default: light is falling off following the material specification:
  18287. * standard material is using standard falloff whereas pbr material can request special falloff per materials.
  18288. */
  18289. static readonly FALLOFF_DEFAULT: number;
  18290. /**
  18291. * Falloff Physical: light is falling off following the inverse squared distance law.
  18292. */
  18293. static readonly FALLOFF_PHYSICAL: number;
  18294. /**
  18295. * Falloff gltf: light is falling off as described in the gltf moving to PBR document
  18296. * to enhance interoperability with other engines.
  18297. */
  18298. static readonly FALLOFF_GLTF: number;
  18299. /**
  18300. * Falloff Standard: light is falling off like in the standard material
  18301. * to enhance interoperability with other materials.
  18302. */
  18303. static readonly FALLOFF_STANDARD: number;
  18304. /**
  18305. * If every light affecting the material is in this lightmapMode,
  18306. * material.lightmapTexture adds or multiplies
  18307. * (depends on material.useLightmapAsShadowmap)
  18308. * after every other light calculations.
  18309. */
  18310. static readonly LIGHTMAP_DEFAULT: number;
  18311. /**
  18312. * material.lightmapTexture as only diffuse lighting from this light
  18313. * adds only specular lighting from this light
  18314. * adds dynamic shadows
  18315. */
  18316. static readonly LIGHTMAP_SPECULAR: number;
  18317. /**
  18318. * material.lightmapTexture as only lighting
  18319. * no light calculation from this light
  18320. * only adds dynamic shadows from this light
  18321. */
  18322. static readonly LIGHTMAP_SHADOWSONLY: number;
  18323. /**
  18324. * Each light type uses the default quantity according to its type:
  18325. * point/spot lights use luminous intensity
  18326. * directional lights use illuminance
  18327. */
  18328. static readonly INTENSITYMODE_AUTOMATIC: number;
  18329. /**
  18330. * lumen (lm)
  18331. */
  18332. static readonly INTENSITYMODE_LUMINOUSPOWER: number;
  18333. /**
  18334. * candela (lm/sr)
  18335. */
  18336. static readonly INTENSITYMODE_LUMINOUSINTENSITY: number;
  18337. /**
  18338. * lux (lm/m^2)
  18339. */
  18340. static readonly INTENSITYMODE_ILLUMINANCE: number;
  18341. /**
  18342. * nit (cd/m^2)
  18343. */
  18344. static readonly INTENSITYMODE_LUMINANCE: number;
  18345. /**
  18346. * Light type const id of the point light.
  18347. */
  18348. static readonly LIGHTTYPEID_POINTLIGHT: number;
  18349. /**
  18350. * Light type const id of the directional light.
  18351. */
  18352. static readonly LIGHTTYPEID_DIRECTIONALLIGHT: number;
  18353. /**
  18354. * Light type const id of the spot light.
  18355. */
  18356. static readonly LIGHTTYPEID_SPOTLIGHT: number;
  18357. /**
  18358. * Light type const id of the hemispheric light.
  18359. */
  18360. static readonly LIGHTTYPEID_HEMISPHERICLIGHT: number;
  18361. /**
  18362. * Diffuse gives the basic color to an object.
  18363. */
  18364. diffuse: Color3;
  18365. /**
  18366. * Specular produces a highlight color on an object.
  18367. * Note: This is note affecting PBR materials.
  18368. */
  18369. specular: Color3;
  18370. /**
  18371. * Defines the falloff type for this light. This lets overrriding how punctual light are
  18372. * falling off base on range or angle.
  18373. * This can be set to any values in Light.FALLOFF_x.
  18374. *
  18375. * Note: This is only useful for PBR Materials at the moment. This could be extended if required to
  18376. * other types of materials.
  18377. */
  18378. falloffType: number;
  18379. /**
  18380. * Strength of the light.
  18381. * Note: By default it is define in the framework own unit.
  18382. * Note: In PBR materials the intensityMode can be use to chose what unit the intensity is defined in.
  18383. */
  18384. intensity: number;
  18385. private _range;
  18386. protected _inverseSquaredRange: number;
  18387. /**
  18388. * Defines how far from the source the light is impacting in scene units.
  18389. * Note: Unused in PBR material as the distance light falloff is defined following the inverse squared falloff.
  18390. */
  18391. get range(): number;
  18392. /**
  18393. * Defines how far from the source the light is impacting in scene units.
  18394. * Note: Unused in PBR material as the distance light falloff is defined following the inverse squared falloff.
  18395. */
  18396. set range(value: number);
  18397. /**
  18398. * Cached photometric scale default to 1.0 as the automatic intensity mode defaults to 1.0 for every type
  18399. * of light.
  18400. */
  18401. private _photometricScale;
  18402. private _intensityMode;
  18403. /**
  18404. * Gets the photometric scale used to interpret the intensity.
  18405. * This is only relevant with PBR Materials where the light intensity can be defined in a physical way.
  18406. */
  18407. get intensityMode(): number;
  18408. /**
  18409. * Sets the photometric scale used to interpret the intensity.
  18410. * This is only relevant with PBR Materials where the light intensity can be defined in a physical way.
  18411. */
  18412. set intensityMode(value: number);
  18413. private _radius;
  18414. /**
  18415. * Gets the light radius used by PBR Materials to simulate soft area lights.
  18416. */
  18417. get radius(): number;
  18418. /**
  18419. * sets the light radius used by PBR Materials to simulate soft area lights.
  18420. */
  18421. set radius(value: number);
  18422. private _renderPriority;
  18423. /**
  18424. * Defines the rendering priority of the lights. It can help in case of fallback or number of lights
  18425. * exceeding the number allowed of the materials.
  18426. */
  18427. renderPriority: number;
  18428. private _shadowEnabled;
  18429. /**
  18430. * Gets wether or not the shadows are enabled for this light. This can help turning off/on shadow without detaching
  18431. * the current shadow generator.
  18432. */
  18433. get shadowEnabled(): boolean;
  18434. /**
  18435. * Sets wether or not the shadows are enabled for this light. This can help turning off/on shadow without detaching
  18436. * the current shadow generator.
  18437. */
  18438. set shadowEnabled(value: boolean);
  18439. private _includedOnlyMeshes;
  18440. /**
  18441. * Gets the only meshes impacted by this light.
  18442. */
  18443. get includedOnlyMeshes(): AbstractMesh[];
  18444. /**
  18445. * Sets the only meshes impacted by this light.
  18446. */
  18447. set includedOnlyMeshes(value: AbstractMesh[]);
  18448. private _excludedMeshes;
  18449. /**
  18450. * Gets the meshes not impacted by this light.
  18451. */
  18452. get excludedMeshes(): AbstractMesh[];
  18453. /**
  18454. * Sets the meshes not impacted by this light.
  18455. */
  18456. set excludedMeshes(value: AbstractMesh[]);
  18457. private _excludeWithLayerMask;
  18458. /**
  18459. * Gets the layer id use to find what meshes are not impacted by the light.
  18460. * Inactive if 0
  18461. */
  18462. get excludeWithLayerMask(): number;
  18463. /**
  18464. * Sets the layer id use to find what meshes are not impacted by the light.
  18465. * Inactive if 0
  18466. */
  18467. set excludeWithLayerMask(value: number);
  18468. private _includeOnlyWithLayerMask;
  18469. /**
  18470. * Gets the layer id use to find what meshes are impacted by the light.
  18471. * Inactive if 0
  18472. */
  18473. get includeOnlyWithLayerMask(): number;
  18474. /**
  18475. * Sets the layer id use to find what meshes are impacted by the light.
  18476. * Inactive if 0
  18477. */
  18478. set includeOnlyWithLayerMask(value: number);
  18479. private _lightmapMode;
  18480. /**
  18481. * Gets the lightmap mode of this light (should be one of the constants defined by Light.LIGHTMAP_x)
  18482. */
  18483. get lightmapMode(): number;
  18484. /**
  18485. * Sets the lightmap mode of this light (should be one of the constants defined by Light.LIGHTMAP_x)
  18486. */
  18487. set lightmapMode(value: number);
  18488. /**
  18489. * Shadow generator associted to the light.
  18490. * @hidden Internal use only.
  18491. */
  18492. _shadowGenerator: Nullable<IShadowGenerator>;
  18493. /**
  18494. * @hidden Internal use only.
  18495. */
  18496. _excludedMeshesIds: string[];
  18497. /**
  18498. * @hidden Internal use only.
  18499. */
  18500. _includedOnlyMeshesIds: string[];
  18501. /**
  18502. * The current light unifom buffer.
  18503. * @hidden Internal use only.
  18504. */
  18505. _uniformBuffer: UniformBuffer;
  18506. /** @hidden */
  18507. _renderId: number;
  18508. /**
  18509. * Creates a Light object in the scene.
  18510. * Documentation : https://doc.babylonjs.com/babylon101/lights
  18511. * @param name The firendly name of the light
  18512. * @param scene The scene the light belongs too
  18513. */
  18514. constructor(name: string, scene: Scene);
  18515. protected abstract _buildUniformLayout(): void;
  18516. /**
  18517. * Sets the passed Effect "effect" with the Light information.
  18518. * @param effect The effect to update
  18519. * @param lightIndex The index of the light in the effect to update
  18520. * @returns The light
  18521. */
  18522. abstract transferToEffect(effect: Effect, lightIndex: string): Light;
  18523. /**
  18524. * Sets the passed Effect "effect" with the Light textures.
  18525. * @param effect The effect to update
  18526. * @param lightIndex The index of the light in the effect to update
  18527. * @returns The light
  18528. */
  18529. transferTexturesToEffect(effect: Effect, lightIndex: string): Light;
  18530. /**
  18531. * Binds the lights information from the scene to the effect for the given mesh.
  18532. * @param lightIndex Light index
  18533. * @param scene The scene where the light belongs to
  18534. * @param effect The effect we are binding the data to
  18535. * @param useSpecular Defines if specular is supported
  18536. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  18537. */
  18538. _bindLight(lightIndex: number, scene: Scene, effect: Effect, useSpecular: boolean, rebuildInParallel?: boolean): void;
  18539. /**
  18540. * Sets the passed Effect "effect" with the Light information.
  18541. * @param effect The effect to update
  18542. * @param lightDataUniformName The uniform used to store light data (position or direction)
  18543. * @returns The light
  18544. */
  18545. abstract transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): Light;
  18546. /**
  18547. * Returns the string "Light".
  18548. * @returns the class name
  18549. */
  18550. getClassName(): string;
  18551. /** @hidden */
  18552. readonly _isLight: boolean;
  18553. /**
  18554. * Converts the light information to a readable string for debug purpose.
  18555. * @param fullDetails Supports for multiple levels of logging within scene loading
  18556. * @returns the human readable light info
  18557. */
  18558. toString(fullDetails?: boolean): string;
  18559. /** @hidden */
  18560. protected _syncParentEnabledState(): void;
  18561. /**
  18562. * Set the enabled state of this node.
  18563. * @param value - the new enabled state
  18564. */
  18565. setEnabled(value: boolean): void;
  18566. /**
  18567. * Returns the Light associated shadow generator if any.
  18568. * @return the associated shadow generator.
  18569. */
  18570. getShadowGenerator(): Nullable<IShadowGenerator>;
  18571. /**
  18572. * Returns a Vector3, the absolute light position in the World.
  18573. * @returns the world space position of the light
  18574. */
  18575. getAbsolutePosition(): Vector3;
  18576. /**
  18577. * Specifies if the light will affect the passed mesh.
  18578. * @param mesh The mesh to test against the light
  18579. * @return true the mesh is affected otherwise, false.
  18580. */
  18581. canAffectMesh(mesh: AbstractMesh): boolean;
  18582. /**
  18583. * Sort function to order lights for rendering.
  18584. * @param a First Light object to compare to second.
  18585. * @param b Second Light object to compare first.
  18586. * @return -1 to reduce's a's index relative to be, 0 for no change, 1 to increase a's index relative to b.
  18587. */
  18588. static CompareLightsPriority(a: Light, b: Light): number;
  18589. /**
  18590. * Releases resources associated with this node.
  18591. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  18592. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  18593. */
  18594. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  18595. /**
  18596. * Returns the light type ID (integer).
  18597. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  18598. */
  18599. getTypeID(): number;
  18600. /**
  18601. * Returns the intensity scaled by the Photometric Scale according to the light type and intensity mode.
  18602. * @returns the scaled intensity in intensity mode unit
  18603. */
  18604. getScaledIntensity(): number;
  18605. /**
  18606. * Returns a new Light object, named "name", from the current one.
  18607. * @param name The name of the cloned light
  18608. * @param newParent The parent of this light, if it has one
  18609. * @returns the new created light
  18610. */
  18611. clone(name: string, newParent?: Nullable<Node>): Nullable<Light>;
  18612. /**
  18613. * Serializes the current light into a Serialization object.
  18614. * @returns the serialized object.
  18615. */
  18616. serialize(): any;
  18617. /**
  18618. * Creates a new typed light from the passed type (integer) : point light = 0, directional light = 1, spot light = 2, hemispheric light = 3.
  18619. * This new light is named "name" and added to the passed scene.
  18620. * @param type Type according to the types available in Light.LIGHTTYPEID_x
  18621. * @param name The friendly name of the light
  18622. * @param scene The scene the new light will belong to
  18623. * @returns the constructor function
  18624. */
  18625. static GetConstructorFromName(type: number, name: string, scene: Scene): Nullable<() => Light>;
  18626. /**
  18627. * Parses the passed "parsedLight" and returns a new instanced Light from this parsing.
  18628. * @param parsedLight The JSON representation of the light
  18629. * @param scene The scene to create the parsed light in
  18630. * @returns the created light after parsing
  18631. */
  18632. static Parse(parsedLight: any, scene: Scene): Nullable<Light>;
  18633. private _hookArrayForExcluded;
  18634. private _hookArrayForIncludedOnly;
  18635. private _resyncMeshes;
  18636. /**
  18637. * Forces the meshes to update their light related information in their rendering used effects
  18638. * @hidden Internal Use Only
  18639. */
  18640. _markMeshesAsLightDirty(): void;
  18641. /**
  18642. * Recomputes the cached photometric scale if needed.
  18643. */
  18644. private _computePhotometricScale;
  18645. /**
  18646. * Returns the Photometric Scale according to the light type and intensity mode.
  18647. */
  18648. private _getPhotometricScale;
  18649. /**
  18650. * Reorder the light in the scene according to their defined priority.
  18651. * @hidden Internal Use Only
  18652. */
  18653. _reorderLightsInScene(): void;
  18654. /**
  18655. * Prepares the list of defines specific to the light type.
  18656. * @param defines the list of defines
  18657. * @param lightIndex defines the index of the light for the effect
  18658. */
  18659. abstract prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  18660. }
  18661. }
  18662. declare module "babylonjs/Cameras/targetCamera" {
  18663. import { Nullable } from "babylonjs/types";
  18664. import { Camera } from "babylonjs/Cameras/camera";
  18665. import { Scene } from "babylonjs/scene";
  18666. import { Quaternion, Matrix, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  18667. /**
  18668. * A target camera takes a mesh or position as a target and continues to look at it while it moves.
  18669. * This is the base of the follow, arc rotate cameras and Free camera
  18670. * @see https://doc.babylonjs.com/features/cameras
  18671. */
  18672. export class TargetCamera extends Camera {
  18673. private static _RigCamTransformMatrix;
  18674. private static _TargetTransformMatrix;
  18675. private static _TargetFocalPoint;
  18676. private _tmpUpVector;
  18677. private _tmpTargetVector;
  18678. /**
  18679. * Define the current direction the camera is moving to
  18680. */
  18681. cameraDirection: Vector3;
  18682. /**
  18683. * Define the current rotation the camera is rotating to
  18684. */
  18685. cameraRotation: Vector2;
  18686. /** Gets or sets a boolean indicating that the scaling of the parent hierarchy will not be taken in account by the camera */
  18687. ignoreParentScaling: boolean;
  18688. /**
  18689. * When set, the up vector of the camera will be updated by the rotation of the camera
  18690. */
  18691. updateUpVectorFromRotation: boolean;
  18692. private _tmpQuaternion;
  18693. /**
  18694. * Define the current rotation of the camera
  18695. */
  18696. rotation: Vector3;
  18697. /**
  18698. * Define the current rotation of the camera as a quaternion to prevent Gimbal lock
  18699. */
  18700. rotationQuaternion: Quaternion;
  18701. /**
  18702. * Define the current speed of the camera
  18703. */
  18704. speed: number;
  18705. /**
  18706. * Add constraint to the camera to prevent it to move freely in all directions and
  18707. * around all axis.
  18708. */
  18709. noRotationConstraint: boolean;
  18710. /**
  18711. * Reverses mouselook direction to 'natural' panning as opposed to traditional direct
  18712. * panning
  18713. */
  18714. invertRotation: boolean;
  18715. /**
  18716. * Speed multiplier for inverse camera panning
  18717. */
  18718. inverseRotationSpeed: number;
  18719. /**
  18720. * Define the current target of the camera as an object or a position.
  18721. */
  18722. lockedTarget: any;
  18723. /** @hidden */
  18724. _currentTarget: Vector3;
  18725. /** @hidden */
  18726. _initialFocalDistance: number;
  18727. /** @hidden */
  18728. _viewMatrix: Matrix;
  18729. /** @hidden */
  18730. _camMatrix: Matrix;
  18731. /** @hidden */
  18732. _cameraTransformMatrix: Matrix;
  18733. /** @hidden */
  18734. _cameraRotationMatrix: Matrix;
  18735. /** @hidden */
  18736. _referencePoint: Vector3;
  18737. /** @hidden */
  18738. _transformedReferencePoint: Vector3;
  18739. /** @hidden */
  18740. _reset: () => void;
  18741. private _defaultUp;
  18742. /**
  18743. * Instantiates a target camera that takes a mesh or position as a target and continues to look at it while it moves.
  18744. * This is the base of the follow, arc rotate cameras and Free camera
  18745. * @see https://doc.babylonjs.com/features/cameras
  18746. * @param name Defines the name of the camera in the scene
  18747. * @param position Defines the start position of the camera in the scene
  18748. * @param scene Defines the scene the camera belongs to
  18749. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  18750. */
  18751. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  18752. /**
  18753. * Gets the position in front of the camera at a given distance.
  18754. * @param distance The distance from the camera we want the position to be
  18755. * @returns the position
  18756. */
  18757. getFrontPosition(distance: number): Vector3;
  18758. /** @hidden */
  18759. _getLockedTargetPosition(): Nullable<Vector3>;
  18760. private _storedPosition;
  18761. private _storedRotation;
  18762. private _storedRotationQuaternion;
  18763. /**
  18764. * Store current camera state of the camera (fov, position, rotation, etc..)
  18765. * @returns the camera
  18766. */
  18767. storeState(): Camera;
  18768. /**
  18769. * Restored camera state. You must call storeState() first
  18770. * @returns whether it was successful or not
  18771. * @hidden
  18772. */
  18773. _restoreStateValues(): boolean;
  18774. /** @hidden */
  18775. _initCache(): void;
  18776. /** @hidden */
  18777. _updateCache(ignoreParentClass?: boolean): void;
  18778. /** @hidden */
  18779. _isSynchronizedViewMatrix(): boolean;
  18780. /** @hidden */
  18781. _computeLocalCameraSpeed(): number;
  18782. /**
  18783. * Defines the target the camera should look at.
  18784. * @param target Defines the new target as a Vector or a mesh
  18785. */
  18786. setTarget(target: Vector3): void;
  18787. /**
  18788. * Return the current target position of the camera. This value is expressed in local space.
  18789. * @returns the target position
  18790. */
  18791. getTarget(): Vector3;
  18792. /** @hidden */
  18793. _decideIfNeedsToMove(): boolean;
  18794. /** @hidden */
  18795. _updatePosition(): void;
  18796. /** @hidden */
  18797. _checkInputs(): void;
  18798. protected _updateCameraRotationMatrix(): void;
  18799. /**
  18800. * 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)
  18801. * @returns the current camera
  18802. */
  18803. private _rotateUpVectorWithCameraRotationMatrix;
  18804. private _cachedRotationZ;
  18805. private _cachedQuaternionRotationZ;
  18806. /** @hidden */
  18807. _getViewMatrix(): Matrix;
  18808. protected _computeViewMatrix(position: Vector3, target: Vector3, up: Vector3): void;
  18809. /**
  18810. * @hidden
  18811. */
  18812. createRigCamera(name: string, cameraIndex: number): Nullable<Camera>;
  18813. /**
  18814. * @hidden
  18815. */
  18816. _updateRigCameras(): void;
  18817. private _getRigCamPositionAndTarget;
  18818. /**
  18819. * Gets the current object class name.
  18820. * @return the class name
  18821. */
  18822. getClassName(): string;
  18823. }
  18824. }
  18825. declare module "babylonjs/Events/keyboardEvents" {
  18826. /**
  18827. * Gather the list of keyboard event types as constants.
  18828. */
  18829. export class KeyboardEventTypes {
  18830. /**
  18831. * The keydown event is fired when a key becomes active (pressed).
  18832. */
  18833. static readonly KEYDOWN: number;
  18834. /**
  18835. * The keyup event is fired when a key has been released.
  18836. */
  18837. static readonly KEYUP: number;
  18838. }
  18839. /**
  18840. * This class is used to store keyboard related info for the onKeyboardObservable event.
  18841. */
  18842. export class KeyboardInfo {
  18843. /**
  18844. * Defines the type of event (KeyboardEventTypes)
  18845. */
  18846. type: number;
  18847. /**
  18848. * Defines the related dom event
  18849. */
  18850. event: KeyboardEvent;
  18851. /**
  18852. * Instantiates a new keyboard info.
  18853. * This class is used to store keyboard related info for the onKeyboardObservable event.
  18854. * @param type Defines the type of event (KeyboardEventTypes)
  18855. * @param event Defines the related dom event
  18856. */
  18857. constructor(
  18858. /**
  18859. * Defines the type of event (KeyboardEventTypes)
  18860. */
  18861. type: number,
  18862. /**
  18863. * Defines the related dom event
  18864. */
  18865. event: KeyboardEvent);
  18866. }
  18867. /**
  18868. * This class is used to store keyboard related info for the onPreKeyboardObservable event.
  18869. * Set the skipOnKeyboardObservable property to true if you want the engine to stop any process after this event is triggered, even not calling onKeyboardObservable
  18870. */
  18871. export class KeyboardInfoPre extends KeyboardInfo {
  18872. /**
  18873. * Defines the type of event (KeyboardEventTypes)
  18874. */
  18875. type: number;
  18876. /**
  18877. * Defines the related dom event
  18878. */
  18879. event: KeyboardEvent;
  18880. /**
  18881. * Defines whether the engine should skip the next onKeyboardObservable associated to this pre.
  18882. */
  18883. skipOnPointerObservable: boolean;
  18884. /**
  18885. * Instantiates a new keyboard pre info.
  18886. * This class is used to store keyboard related info for the onPreKeyboardObservable event.
  18887. * @param type Defines the type of event (KeyboardEventTypes)
  18888. * @param event Defines the related dom event
  18889. */
  18890. constructor(
  18891. /**
  18892. * Defines the type of event (KeyboardEventTypes)
  18893. */
  18894. type: number,
  18895. /**
  18896. * Defines the related dom event
  18897. */
  18898. event: KeyboardEvent);
  18899. }
  18900. }
  18901. declare module "babylonjs/Cameras/Inputs/freeCameraKeyboardMoveInput" {
  18902. import { Nullable } from "babylonjs/types";
  18903. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  18904. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  18905. /**
  18906. * Manage the keyboard inputs to control the movement of a free camera.
  18907. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  18908. */
  18909. export class FreeCameraKeyboardMoveInput implements ICameraInput<FreeCamera> {
  18910. /**
  18911. * Defines the camera the input is attached to.
  18912. */
  18913. camera: FreeCamera;
  18914. /**
  18915. * Gets or Set the list of keyboard keys used to control the forward move of the camera.
  18916. */
  18917. keysUp: number[];
  18918. /**
  18919. * Gets or Set the list of keyboard keys used to control the upward move of the camera.
  18920. */
  18921. keysUpward: number[];
  18922. /**
  18923. * Gets or Set the list of keyboard keys used to control the backward move of the camera.
  18924. */
  18925. keysDown: number[];
  18926. /**
  18927. * Gets or Set the list of keyboard keys used to control the downward move of the camera.
  18928. */
  18929. keysDownward: number[];
  18930. /**
  18931. * Gets or Set the list of keyboard keys used to control the left strafe move of the camera.
  18932. */
  18933. keysLeft: number[];
  18934. /**
  18935. * Gets or Set the list of keyboard keys used to control the right strafe move of the camera.
  18936. */
  18937. keysRight: number[];
  18938. private _keys;
  18939. private _onCanvasBlurObserver;
  18940. private _onKeyboardObserver;
  18941. private _engine;
  18942. private _scene;
  18943. /**
  18944. * Attach the input controls to a specific dom element to get the input from.
  18945. * @param element Defines the element the controls should be listened from
  18946. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  18947. */
  18948. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  18949. /**
  18950. * Detach the current controls from the specified dom element.
  18951. * @param element Defines the element to stop listening the inputs from
  18952. */
  18953. detachControl(element: Nullable<HTMLElement>): void;
  18954. /**
  18955. * Update the current camera state depending on the inputs that have been used this frame.
  18956. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  18957. */
  18958. checkInputs(): void;
  18959. /**
  18960. * Gets the class name of the current intput.
  18961. * @returns the class name
  18962. */
  18963. getClassName(): string;
  18964. /** @hidden */
  18965. _onLostFocus(): void;
  18966. /**
  18967. * Get the friendly name associated with the input class.
  18968. * @returns the input friendly name
  18969. */
  18970. getSimpleName(): string;
  18971. }
  18972. }
  18973. declare module "babylonjs/Events/pointerEvents" {
  18974. import { Nullable } from "babylonjs/types";
  18975. import { Vector2 } from "babylonjs/Maths/math.vector";
  18976. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  18977. import { Ray } from "babylonjs/Culling/ray";
  18978. /**
  18979. * Gather the list of pointer event types as constants.
  18980. */
  18981. export class PointerEventTypes {
  18982. /**
  18983. * 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.
  18984. */
  18985. static readonly POINTERDOWN: number;
  18986. /**
  18987. * The pointerup event is fired when a pointer is no longer active.
  18988. */
  18989. static readonly POINTERUP: number;
  18990. /**
  18991. * The pointermove event is fired when a pointer changes coordinates.
  18992. */
  18993. static readonly POINTERMOVE: number;
  18994. /**
  18995. * The pointerwheel event is fired when a mouse wheel has been rotated.
  18996. */
  18997. static readonly POINTERWHEEL: number;
  18998. /**
  18999. * The pointerpick event is fired when a mesh or sprite has been picked by the pointer.
  19000. */
  19001. static readonly POINTERPICK: number;
  19002. /**
  19003. * The pointertap event is fired when a the object has been touched and released without drag.
  19004. */
  19005. static readonly POINTERTAP: number;
  19006. /**
  19007. * The pointerdoubletap event is fired when a the object has been touched and released twice without drag.
  19008. */
  19009. static readonly POINTERDOUBLETAP: number;
  19010. }
  19011. /**
  19012. * Base class of pointer info types.
  19013. */
  19014. export class PointerInfoBase {
  19015. /**
  19016. * Defines the type of event (PointerEventTypes)
  19017. */
  19018. type: number;
  19019. /**
  19020. * Defines the related dom event
  19021. */
  19022. event: PointerEvent | MouseWheelEvent;
  19023. /**
  19024. * Instantiates the base class of pointers info.
  19025. * @param type Defines the type of event (PointerEventTypes)
  19026. * @param event Defines the related dom event
  19027. */
  19028. constructor(
  19029. /**
  19030. * Defines the type of event (PointerEventTypes)
  19031. */
  19032. type: number,
  19033. /**
  19034. * Defines the related dom event
  19035. */
  19036. event: PointerEvent | MouseWheelEvent);
  19037. }
  19038. /**
  19039. * This class is used to store pointer related info for the onPrePointerObservable event.
  19040. * Set the skipOnPointerObservable property to true if you want the engine to stop any process after this event is triggered, even not calling onPointerObservable
  19041. */
  19042. export class PointerInfoPre extends PointerInfoBase {
  19043. /**
  19044. * Ray from a pointer if availible (eg. 6dof controller)
  19045. */
  19046. ray: Nullable<Ray>;
  19047. /**
  19048. * Defines the local position of the pointer on the canvas.
  19049. */
  19050. localPosition: Vector2;
  19051. /**
  19052. * Defines whether the engine should skip the next OnPointerObservable associated to this pre.
  19053. */
  19054. skipOnPointerObservable: boolean;
  19055. /**
  19056. * Instantiates a PointerInfoPre to store pointer related info to the onPrePointerObservable event.
  19057. * @param type Defines the type of event (PointerEventTypes)
  19058. * @param event Defines the related dom event
  19059. * @param localX Defines the local x coordinates of the pointer when the event occured
  19060. * @param localY Defines the local y coordinates of the pointer when the event occured
  19061. */
  19062. constructor(type: number, event: PointerEvent | MouseWheelEvent, localX: number, localY: number);
  19063. }
  19064. /**
  19065. * This type contains all the data related to a pointer event in Babylon.js.
  19066. * 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.
  19067. */
  19068. export class PointerInfo extends PointerInfoBase {
  19069. /**
  19070. * Defines the picking info associated to the info (if any)\
  19071. */
  19072. pickInfo: Nullable<PickingInfo>;
  19073. /**
  19074. * Instantiates a PointerInfo to store pointer related info to the onPointerObservable event.
  19075. * @param type Defines the type of event (PointerEventTypes)
  19076. * @param event Defines the related dom event
  19077. * @param pickInfo Defines the picking info associated to the info (if any)\
  19078. */
  19079. constructor(type: number, event: PointerEvent | MouseWheelEvent,
  19080. /**
  19081. * Defines the picking info associated to the info (if any)\
  19082. */
  19083. pickInfo: Nullable<PickingInfo>);
  19084. }
  19085. /**
  19086. * Data relating to a touch event on the screen.
  19087. */
  19088. export interface PointerTouch {
  19089. /**
  19090. * X coordinate of touch.
  19091. */
  19092. x: number;
  19093. /**
  19094. * Y coordinate of touch.
  19095. */
  19096. y: number;
  19097. /**
  19098. * Id of touch. Unique for each finger.
  19099. */
  19100. pointerId: number;
  19101. /**
  19102. * Event type passed from DOM.
  19103. */
  19104. type: any;
  19105. }
  19106. }
  19107. declare module "babylonjs/Cameras/Inputs/freeCameraMouseInput" {
  19108. import { Observable } from "babylonjs/Misc/observable";
  19109. import { Nullable } from "babylonjs/types";
  19110. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  19111. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  19112. /**
  19113. * Manage the mouse inputs to control the movement of a free camera.
  19114. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  19115. */
  19116. export class FreeCameraMouseInput implements ICameraInput<FreeCamera> {
  19117. /**
  19118. * Define if touch is enabled in the mouse input
  19119. */
  19120. touchEnabled: boolean;
  19121. /**
  19122. * Defines the camera the input is attached to.
  19123. */
  19124. camera: FreeCamera;
  19125. /**
  19126. * Defines the buttons associated with the input to handle camera move.
  19127. */
  19128. buttons: number[];
  19129. /**
  19130. * Defines the pointer angular sensibility along the X and Y axis or how fast is the camera rotating.
  19131. */
  19132. angularSensibility: number;
  19133. private _pointerInput;
  19134. private _onMouseMove;
  19135. private _observer;
  19136. private previousPosition;
  19137. /**
  19138. * Observable for when a pointer move event occurs containing the move offset
  19139. */
  19140. onPointerMovedObservable: Observable<{
  19141. offsetX: number;
  19142. offsetY: number;
  19143. }>;
  19144. /**
  19145. * @hidden
  19146. * If the camera should be rotated automatically based on pointer movement
  19147. */
  19148. _allowCameraRotation: boolean;
  19149. /**
  19150. * Manage the mouse inputs to control the movement of a free camera.
  19151. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  19152. * @param touchEnabled Defines if touch is enabled or not
  19153. */
  19154. constructor(
  19155. /**
  19156. * Define if touch is enabled in the mouse input
  19157. */
  19158. touchEnabled?: boolean);
  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. * Called on JS contextmenu event.
  19167. * Override this method to provide functionality.
  19168. */
  19169. protected onContextMenu(evt: PointerEvent): void;
  19170. /**
  19171. * Detach the current controls from the specified dom element.
  19172. * @param element Defines the element to stop listening the inputs from
  19173. */
  19174. detachControl(element: Nullable<HTMLElement>): void;
  19175. /**
  19176. * Gets the class name of the current intput.
  19177. * @returns the class name
  19178. */
  19179. getClassName(): string;
  19180. /**
  19181. * Get the friendly name associated with the input class.
  19182. * @returns the input friendly name
  19183. */
  19184. getSimpleName(): string;
  19185. }
  19186. }
  19187. declare module "babylonjs/Cameras/Inputs/freeCameraTouchInput" {
  19188. import { Nullable } from "babylonjs/types";
  19189. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  19190. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  19191. /**
  19192. * Manage the touch inputs to control the movement of a free camera.
  19193. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  19194. */
  19195. export class FreeCameraTouchInput implements ICameraInput<FreeCamera> {
  19196. /**
  19197. * Defines the camera the input is attached to.
  19198. */
  19199. camera: FreeCamera;
  19200. /**
  19201. * Defines the touch sensibility for rotation.
  19202. * The higher the faster.
  19203. */
  19204. touchAngularSensibility: number;
  19205. /**
  19206. * Defines the touch sensibility for move.
  19207. * The higher the faster.
  19208. */
  19209. touchMoveSensibility: number;
  19210. private _offsetX;
  19211. private _offsetY;
  19212. private _pointerPressed;
  19213. private _pointerInput;
  19214. private _observer;
  19215. private _onLostFocus;
  19216. /**
  19217. * Attach the input controls to a specific dom element to get the input from.
  19218. * @param element Defines the element the controls should be listened from
  19219. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  19220. */
  19221. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  19222. /**
  19223. * Detach the current controls from the specified dom element.
  19224. * @param element Defines the element to stop listening the inputs from
  19225. */
  19226. detachControl(element: Nullable<HTMLElement>): void;
  19227. /**
  19228. * Update the current camera state depending on the inputs that have been used this frame.
  19229. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  19230. */
  19231. checkInputs(): void;
  19232. /**
  19233. * Gets the class name of the current intput.
  19234. * @returns the class name
  19235. */
  19236. getClassName(): string;
  19237. /**
  19238. * Get the friendly name associated with the input class.
  19239. * @returns the input friendly name
  19240. */
  19241. getSimpleName(): string;
  19242. }
  19243. }
  19244. declare module "babylonjs/Cameras/freeCameraInputsManager" {
  19245. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  19246. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  19247. import { FreeCameraMouseInput } from "babylonjs/Cameras/Inputs/freeCameraMouseInput";
  19248. import { Nullable } from "babylonjs/types";
  19249. /**
  19250. * Default Inputs manager for the FreeCamera.
  19251. * It groups all the default supported inputs for ease of use.
  19252. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  19253. */
  19254. export class FreeCameraInputsManager extends CameraInputsManager<FreeCamera> {
  19255. /**
  19256. * @hidden
  19257. */
  19258. _mouseInput: Nullable<FreeCameraMouseInput>;
  19259. /**
  19260. * Instantiates a new FreeCameraInputsManager.
  19261. * @param camera Defines the camera the inputs belong to
  19262. */
  19263. constructor(camera: FreeCamera);
  19264. /**
  19265. * Add keyboard input support to the input manager.
  19266. * @returns the current input manager
  19267. */
  19268. addKeyboard(): FreeCameraInputsManager;
  19269. /**
  19270. * Add mouse input support to the input manager.
  19271. * @param touchEnabled if the FreeCameraMouseInput should support touch (default: true)
  19272. * @returns the current input manager
  19273. */
  19274. addMouse(touchEnabled?: boolean): FreeCameraInputsManager;
  19275. /**
  19276. * Removes the mouse input support from the manager
  19277. * @returns the current input manager
  19278. */
  19279. removeMouse(): FreeCameraInputsManager;
  19280. /**
  19281. * Add touch input support to the input manager.
  19282. * @returns the current input manager
  19283. */
  19284. addTouch(): FreeCameraInputsManager;
  19285. /**
  19286. * Remove all attached input methods from a camera
  19287. */
  19288. clear(): void;
  19289. }
  19290. }
  19291. declare module "babylonjs/Cameras/freeCamera" {
  19292. import { Vector3 } from "babylonjs/Maths/math.vector";
  19293. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  19294. import { Scene } from "babylonjs/scene";
  19295. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  19296. import { FreeCameraInputsManager } from "babylonjs/Cameras/freeCameraInputsManager";
  19297. /**
  19298. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  19299. * Please consider using the new UniversalCamera instead as it adds more functionality like the gamepad.
  19300. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  19301. */
  19302. export class FreeCamera extends TargetCamera {
  19303. /**
  19304. * Define the collision ellipsoid of the camera.
  19305. * This is helpful to simulate a camera body like the player body around the camera
  19306. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  19307. */
  19308. ellipsoid: Vector3;
  19309. /**
  19310. * Define an offset for the position of the ellipsoid around the camera.
  19311. * This can be helpful to determine the center of the body near the gravity center of the body
  19312. * instead of its head.
  19313. */
  19314. ellipsoidOffset: Vector3;
  19315. /**
  19316. * Enable or disable collisions of the camera with the rest of the scene objects.
  19317. */
  19318. checkCollisions: boolean;
  19319. /**
  19320. * Enable or disable gravity on the camera.
  19321. */
  19322. applyGravity: boolean;
  19323. /**
  19324. * Define the input manager associated to the camera.
  19325. */
  19326. inputs: FreeCameraInputsManager;
  19327. /**
  19328. * Gets the input sensibility for a mouse input. (default is 2000.0)
  19329. * Higher values reduce sensitivity.
  19330. */
  19331. get angularSensibility(): number;
  19332. /**
  19333. * Sets the input sensibility for a mouse input. (default is 2000.0)
  19334. * Higher values reduce sensitivity.
  19335. */
  19336. set angularSensibility(value: number);
  19337. /**
  19338. * Gets or Set the list of keyboard keys used to control the forward move of the camera.
  19339. */
  19340. get keysUp(): number[];
  19341. set keysUp(value: number[]);
  19342. /**
  19343. * Gets or Set the list of keyboard keys used to control the upward move of the camera.
  19344. */
  19345. get keysUpward(): number[];
  19346. set keysUpward(value: number[]);
  19347. /**
  19348. * Gets or Set the list of keyboard keys used to control the backward move of the camera.
  19349. */
  19350. get keysDown(): number[];
  19351. set keysDown(value: number[]);
  19352. /**
  19353. * Gets or Set the list of keyboard keys used to control the downward move of the camera.
  19354. */
  19355. get keysDownward(): number[];
  19356. set keysDownward(value: number[]);
  19357. /**
  19358. * Gets or Set the list of keyboard keys used to control the left strafe move of the camera.
  19359. */
  19360. get keysLeft(): number[];
  19361. set keysLeft(value: number[]);
  19362. /**
  19363. * Gets or Set the list of keyboard keys used to control the right strafe move of the camera.
  19364. */
  19365. get keysRight(): number[];
  19366. set keysRight(value: number[]);
  19367. /**
  19368. * Event raised when the camera collide with a mesh in the scene.
  19369. */
  19370. onCollide: (collidedMesh: AbstractMesh) => void;
  19371. private _collider;
  19372. private _needMoveForGravity;
  19373. private _oldPosition;
  19374. private _diffPosition;
  19375. private _newPosition;
  19376. /** @hidden */
  19377. _localDirection: Vector3;
  19378. /** @hidden */
  19379. _transformedDirection: Vector3;
  19380. /**
  19381. * Instantiates a Free Camera.
  19382. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  19383. * Please consider using the new UniversalCamera instead as it adds more functionality like touch to this camera.
  19384. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  19385. * @param name Define the name of the camera in the scene
  19386. * @param position Define the start position of the camera in the scene
  19387. * @param scene Define the scene the camera belongs to
  19388. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  19389. */
  19390. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  19391. /**
  19392. * Attached controls to the current camera.
  19393. * @param element Defines the element the controls should be listened from
  19394. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  19395. */
  19396. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  19397. /**
  19398. * Detach the current controls from the camera.
  19399. * The camera will stop reacting to inputs.
  19400. * @param element Defines the element to stop listening the inputs from
  19401. */
  19402. detachControl(element: HTMLElement): void;
  19403. private _collisionMask;
  19404. /**
  19405. * Define a collision mask to limit the list of object the camera can collide with
  19406. */
  19407. get collisionMask(): number;
  19408. set collisionMask(mask: number);
  19409. /** @hidden */
  19410. _collideWithWorld(displacement: Vector3): void;
  19411. private _onCollisionPositionChange;
  19412. /** @hidden */
  19413. _checkInputs(): void;
  19414. /** @hidden */
  19415. _decideIfNeedsToMove(): boolean;
  19416. /** @hidden */
  19417. _updatePosition(): void;
  19418. /**
  19419. * Destroy the camera and release the current resources hold by it.
  19420. */
  19421. dispose(): void;
  19422. /**
  19423. * Gets the current object class name.
  19424. * @return the class name
  19425. */
  19426. getClassName(): string;
  19427. }
  19428. }
  19429. declare module "babylonjs/Gamepads/gamepad" {
  19430. import { Observable } from "babylonjs/Misc/observable";
  19431. /**
  19432. * Represents a gamepad control stick position
  19433. */
  19434. export class StickValues {
  19435. /**
  19436. * The x component of the control stick
  19437. */
  19438. x: number;
  19439. /**
  19440. * The y component of the control stick
  19441. */
  19442. y: number;
  19443. /**
  19444. * Initializes the gamepad x and y control stick values
  19445. * @param x The x component of the gamepad control stick value
  19446. * @param y The y component of the gamepad control stick value
  19447. */
  19448. constructor(
  19449. /**
  19450. * The x component of the control stick
  19451. */
  19452. x: number,
  19453. /**
  19454. * The y component of the control stick
  19455. */
  19456. y: number);
  19457. }
  19458. /**
  19459. * An interface which manages callbacks for gamepad button changes
  19460. */
  19461. export interface GamepadButtonChanges {
  19462. /**
  19463. * Called when a gamepad has been changed
  19464. */
  19465. changed: boolean;
  19466. /**
  19467. * Called when a gamepad press event has been triggered
  19468. */
  19469. pressChanged: boolean;
  19470. /**
  19471. * Called when a touch event has been triggered
  19472. */
  19473. touchChanged: boolean;
  19474. /**
  19475. * Called when a value has changed
  19476. */
  19477. valueChanged: boolean;
  19478. }
  19479. /**
  19480. * Represents a gamepad
  19481. */
  19482. export class Gamepad {
  19483. /**
  19484. * The id of the gamepad
  19485. */
  19486. id: string;
  19487. /**
  19488. * The index of the gamepad
  19489. */
  19490. index: number;
  19491. /**
  19492. * The browser gamepad
  19493. */
  19494. browserGamepad: any;
  19495. /**
  19496. * Specifies what type of gamepad this represents
  19497. */
  19498. type: number;
  19499. private _leftStick;
  19500. private _rightStick;
  19501. /** @hidden */
  19502. _isConnected: boolean;
  19503. private _leftStickAxisX;
  19504. private _leftStickAxisY;
  19505. private _rightStickAxisX;
  19506. private _rightStickAxisY;
  19507. /**
  19508. * Triggered when the left control stick has been changed
  19509. */
  19510. private _onleftstickchanged;
  19511. /**
  19512. * Triggered when the right control stick has been changed
  19513. */
  19514. private _onrightstickchanged;
  19515. /**
  19516. * Represents a gamepad controller
  19517. */
  19518. static GAMEPAD: number;
  19519. /**
  19520. * Represents a generic controller
  19521. */
  19522. static GENERIC: number;
  19523. /**
  19524. * Represents an XBox controller
  19525. */
  19526. static XBOX: number;
  19527. /**
  19528. * Represents a pose-enabled controller
  19529. */
  19530. static POSE_ENABLED: number;
  19531. /**
  19532. * Represents an Dual Shock controller
  19533. */
  19534. static DUALSHOCK: number;
  19535. /**
  19536. * Specifies whether the left control stick should be Y-inverted
  19537. */
  19538. protected _invertLeftStickY: boolean;
  19539. /**
  19540. * Specifies if the gamepad has been connected
  19541. */
  19542. get isConnected(): boolean;
  19543. /**
  19544. * Initializes the gamepad
  19545. * @param id The id of the gamepad
  19546. * @param index The index of the gamepad
  19547. * @param browserGamepad The browser gamepad
  19548. * @param leftStickX The x component of the left joystick
  19549. * @param leftStickY The y component of the left joystick
  19550. * @param rightStickX The x component of the right joystick
  19551. * @param rightStickY The y component of the right joystick
  19552. */
  19553. constructor(
  19554. /**
  19555. * The id of the gamepad
  19556. */
  19557. id: string,
  19558. /**
  19559. * The index of the gamepad
  19560. */
  19561. index: number,
  19562. /**
  19563. * The browser gamepad
  19564. */
  19565. browserGamepad: any, leftStickX?: number, leftStickY?: number, rightStickX?: number, rightStickY?: number);
  19566. /**
  19567. * Callback triggered when the left joystick has changed
  19568. * @param callback
  19569. */
  19570. onleftstickchanged(callback: (values: StickValues) => void): void;
  19571. /**
  19572. * Callback triggered when the right joystick has changed
  19573. * @param callback
  19574. */
  19575. onrightstickchanged(callback: (values: StickValues) => void): void;
  19576. /**
  19577. * Gets the left joystick
  19578. */
  19579. get leftStick(): StickValues;
  19580. /**
  19581. * Sets the left joystick values
  19582. */
  19583. set leftStick(newValues: StickValues);
  19584. /**
  19585. * Gets the right joystick
  19586. */
  19587. get rightStick(): StickValues;
  19588. /**
  19589. * Sets the right joystick value
  19590. */
  19591. set rightStick(newValues: StickValues);
  19592. /**
  19593. * Updates the gamepad joystick positions
  19594. */
  19595. update(): void;
  19596. /**
  19597. * Disposes the gamepad
  19598. */
  19599. dispose(): void;
  19600. }
  19601. /**
  19602. * Represents a generic gamepad
  19603. */
  19604. export class GenericPad extends Gamepad {
  19605. private _buttons;
  19606. private _onbuttondown;
  19607. private _onbuttonup;
  19608. /**
  19609. * Observable triggered when a button has been pressed
  19610. */
  19611. onButtonDownObservable: Observable<number>;
  19612. /**
  19613. * Observable triggered when a button has been released
  19614. */
  19615. onButtonUpObservable: Observable<number>;
  19616. /**
  19617. * Callback triggered when a button has been pressed
  19618. * @param callback Called when a button has been pressed
  19619. */
  19620. onbuttondown(callback: (buttonPressed: number) => void): void;
  19621. /**
  19622. * Callback triggered when a button has been released
  19623. * @param callback Called when a button has been released
  19624. */
  19625. onbuttonup(callback: (buttonReleased: number) => void): void;
  19626. /**
  19627. * Initializes the generic gamepad
  19628. * @param id The id of the generic gamepad
  19629. * @param index The index of the generic gamepad
  19630. * @param browserGamepad The browser gamepad
  19631. */
  19632. constructor(id: string, index: number, browserGamepad: any);
  19633. private _setButtonValue;
  19634. /**
  19635. * Updates the generic gamepad
  19636. */
  19637. update(): void;
  19638. /**
  19639. * Disposes the generic gamepad
  19640. */
  19641. dispose(): void;
  19642. }
  19643. }
  19644. declare module "babylonjs/Gamepads/Controllers/poseEnabledController" {
  19645. import { Observable } from "babylonjs/Misc/observable";
  19646. import { Nullable } from "babylonjs/types";
  19647. import { Quaternion, Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  19648. import { TransformNode } from "babylonjs/Meshes/transformNode";
  19649. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  19650. import { Ray } from "babylonjs/Culling/ray";
  19651. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  19652. import { PoseControlled, DevicePose } from "babylonjs/Cameras/VR/webVRCamera";
  19653. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  19654. /**
  19655. * Defines the types of pose enabled controllers that are supported
  19656. */
  19657. export enum PoseEnabledControllerType {
  19658. /**
  19659. * HTC Vive
  19660. */
  19661. VIVE = 0,
  19662. /**
  19663. * Oculus Rift
  19664. */
  19665. OCULUS = 1,
  19666. /**
  19667. * Windows mixed reality
  19668. */
  19669. WINDOWS = 2,
  19670. /**
  19671. * Samsung gear VR
  19672. */
  19673. GEAR_VR = 3,
  19674. /**
  19675. * Google Daydream
  19676. */
  19677. DAYDREAM = 4,
  19678. /**
  19679. * Generic
  19680. */
  19681. GENERIC = 5
  19682. }
  19683. /**
  19684. * Defines the MutableGamepadButton interface for the state of a gamepad button
  19685. */
  19686. export interface MutableGamepadButton {
  19687. /**
  19688. * Value of the button/trigger
  19689. */
  19690. value: number;
  19691. /**
  19692. * If the button/trigger is currently touched
  19693. */
  19694. touched: boolean;
  19695. /**
  19696. * If the button/trigger is currently pressed
  19697. */
  19698. pressed: boolean;
  19699. }
  19700. /**
  19701. * Defines the ExtendedGamepadButton interface for a gamepad button which includes state provided by a pose controller
  19702. * @hidden
  19703. */
  19704. export interface ExtendedGamepadButton extends GamepadButton {
  19705. /**
  19706. * If the button/trigger is currently pressed
  19707. */
  19708. readonly pressed: boolean;
  19709. /**
  19710. * If the button/trigger is currently touched
  19711. */
  19712. readonly touched: boolean;
  19713. /**
  19714. * Value of the button/trigger
  19715. */
  19716. readonly value: number;
  19717. }
  19718. /** @hidden */
  19719. export interface _GamePadFactory {
  19720. /**
  19721. * Returns whether or not the current gamepad can be created for this type of controller.
  19722. * @param gamepadInfo Defines the gamepad info as received from the controller APIs.
  19723. * @returns true if it can be created, otherwise false
  19724. */
  19725. canCreate(gamepadInfo: any): boolean;
  19726. /**
  19727. * Creates a new instance of the Gamepad.
  19728. * @param gamepadInfo Defines the gamepad info as received from the controller APIs.
  19729. * @returns the new gamepad instance
  19730. */
  19731. create(gamepadInfo: any): Gamepad;
  19732. }
  19733. /**
  19734. * Defines the PoseEnabledControllerHelper object that is used initialize a gamepad as the controller type it is specified as (eg. windows mixed reality controller)
  19735. */
  19736. export class PoseEnabledControllerHelper {
  19737. /** @hidden */
  19738. static _ControllerFactories: _GamePadFactory[];
  19739. /** @hidden */
  19740. static _DefaultControllerFactory: Nullable<(gamepadInfo: any) => Gamepad>;
  19741. /**
  19742. * Initializes a gamepad as the controller type it is specified as (eg. windows mixed reality controller)
  19743. * @param vrGamepad the gamepad to initialized
  19744. * @returns a vr controller of the type the gamepad identified as
  19745. */
  19746. static InitiateController(vrGamepad: any): Gamepad;
  19747. }
  19748. /**
  19749. * Defines the PoseEnabledController object that contains state of a vr capable controller
  19750. */
  19751. export class PoseEnabledController extends Gamepad implements PoseControlled {
  19752. /**
  19753. * If the controller is used in a webXR session
  19754. */
  19755. isXR: boolean;
  19756. private _deviceRoomPosition;
  19757. private _deviceRoomRotationQuaternion;
  19758. /**
  19759. * The device position in babylon space
  19760. */
  19761. devicePosition: Vector3;
  19762. /**
  19763. * The device rotation in babylon space
  19764. */
  19765. deviceRotationQuaternion: Quaternion;
  19766. /**
  19767. * The scale factor of the device in babylon space
  19768. */
  19769. deviceScaleFactor: number;
  19770. /**
  19771. * (Likely devicePosition should be used instead) The device position in its room space
  19772. */
  19773. position: Vector3;
  19774. /**
  19775. * (Likely deviceRotationQuaternion should be used instead) The device rotation in its room space
  19776. */
  19777. rotationQuaternion: Quaternion;
  19778. /**
  19779. * The type of controller (Eg. Windows mixed reality)
  19780. */
  19781. controllerType: PoseEnabledControllerType;
  19782. protected _calculatedPosition: Vector3;
  19783. private _calculatedRotation;
  19784. /**
  19785. * The raw pose from the device
  19786. */
  19787. rawPose: DevicePose;
  19788. private _trackPosition;
  19789. private _maxRotationDistFromHeadset;
  19790. private _draggedRoomRotation;
  19791. /**
  19792. * @hidden
  19793. */
  19794. _disableTrackPosition(fixedPosition: Vector3): void;
  19795. /**
  19796. * Internal, the mesh attached to the controller
  19797. * @hidden
  19798. */
  19799. _mesh: Nullable<AbstractMesh>;
  19800. private _poseControlledCamera;
  19801. private _leftHandSystemQuaternion;
  19802. /**
  19803. * Internal, matrix used to convert room space to babylon space
  19804. * @hidden
  19805. */
  19806. _deviceToWorld: Matrix;
  19807. /**
  19808. * Node to be used when casting a ray from the controller
  19809. * @hidden
  19810. */
  19811. _pointingPoseNode: Nullable<TransformNode>;
  19812. /**
  19813. * Name of the child mesh that can be used to cast a ray from the controller
  19814. */
  19815. static readonly POINTING_POSE: string;
  19816. /**
  19817. * Creates a new PoseEnabledController from a gamepad
  19818. * @param browserGamepad the gamepad that the PoseEnabledController should be created from
  19819. */
  19820. constructor(browserGamepad: any);
  19821. private _workingMatrix;
  19822. /**
  19823. * Updates the state of the pose enbaled controller and mesh based on the current position and rotation of the controller
  19824. */
  19825. update(): void;
  19826. /**
  19827. * Updates only the pose device and mesh without doing any button event checking
  19828. */
  19829. protected _updatePoseAndMesh(): void;
  19830. /**
  19831. * Updates the state of the pose enbaled controller based on the raw pose data from the device
  19832. * @param poseData raw pose fromthe device
  19833. */
  19834. updateFromDevice(poseData: DevicePose): void;
  19835. /**
  19836. * @hidden
  19837. */
  19838. _meshAttachedObservable: Observable<AbstractMesh>;
  19839. /**
  19840. * Attaches a mesh to the controller
  19841. * @param mesh the mesh to be attached
  19842. */
  19843. attachToMesh(mesh: AbstractMesh): void;
  19844. /**
  19845. * Attaches the controllers mesh to a camera
  19846. * @param camera the camera the mesh should be attached to
  19847. */
  19848. attachToPoseControlledCamera(camera: TargetCamera): void;
  19849. /**
  19850. * Disposes of the controller
  19851. */
  19852. dispose(): void;
  19853. /**
  19854. * The mesh that is attached to the controller
  19855. */
  19856. get mesh(): Nullable<AbstractMesh>;
  19857. /**
  19858. * Gets the ray of the controller in the direction the controller is pointing
  19859. * @param length the length the resulting ray should be
  19860. * @returns a ray in the direction the controller is pointing
  19861. */
  19862. getForwardRay(length?: number): Ray;
  19863. }
  19864. }
  19865. declare module "babylonjs/Gamepads/Controllers/webVRController" {
  19866. import { Observable } from "babylonjs/Misc/observable";
  19867. import { Scene } from "babylonjs/scene";
  19868. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  19869. import { PoseEnabledController, ExtendedGamepadButton, MutableGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  19870. import { StickValues, GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  19871. import { Nullable } from "babylonjs/types";
  19872. /**
  19873. * Defines the WebVRController object that represents controllers tracked in 3D space
  19874. */
  19875. export abstract class WebVRController extends PoseEnabledController {
  19876. /**
  19877. * Internal, the default controller model for the controller
  19878. */
  19879. protected _defaultModel: Nullable<AbstractMesh>;
  19880. /**
  19881. * Fired when the trigger state has changed
  19882. */
  19883. onTriggerStateChangedObservable: Observable<ExtendedGamepadButton>;
  19884. /**
  19885. * Fired when the main button state has changed
  19886. */
  19887. onMainButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  19888. /**
  19889. * Fired when the secondary button state has changed
  19890. */
  19891. onSecondaryButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  19892. /**
  19893. * Fired when the pad state has changed
  19894. */
  19895. onPadStateChangedObservable: Observable<ExtendedGamepadButton>;
  19896. /**
  19897. * Fired when controllers stick values have changed
  19898. */
  19899. onPadValuesChangedObservable: Observable<StickValues>;
  19900. /**
  19901. * Array of button availible on the controller
  19902. */
  19903. protected _buttons: Array<MutableGamepadButton>;
  19904. private _onButtonStateChange;
  19905. /**
  19906. * Fired when a controller button's state has changed
  19907. * @param callback the callback containing the button that was modified
  19908. */
  19909. onButtonStateChange(callback: (controlledIndex: number, buttonIndex: number, state: ExtendedGamepadButton) => void): void;
  19910. /**
  19911. * X and Y axis corresponding to the controllers joystick
  19912. */
  19913. pad: StickValues;
  19914. /**
  19915. * 'left' or 'right', see https://w3c.github.io/gamepad/extensions.html#gamepadhand-enum
  19916. */
  19917. hand: string;
  19918. /**
  19919. * The default controller model for the controller
  19920. */
  19921. get defaultModel(): Nullable<AbstractMesh>;
  19922. /**
  19923. * Creates a new WebVRController from a gamepad
  19924. * @param vrGamepad the gamepad that the WebVRController should be created from
  19925. */
  19926. constructor(vrGamepad: any);
  19927. /**
  19928. * Updates the state of the controller and mesh based on the current position and rotation of the controller
  19929. */
  19930. update(): void;
  19931. /**
  19932. * Function to be called when a button is modified
  19933. */
  19934. protected abstract _handleButtonChange(buttonIdx: number, value: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  19935. /**
  19936. * Loads a mesh and attaches it to the controller
  19937. * @param scene the scene the mesh should be added to
  19938. * @param meshLoaded callback for when the mesh has been loaded
  19939. */
  19940. abstract initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  19941. private _setButtonValue;
  19942. private _changes;
  19943. private _checkChanges;
  19944. /**
  19945. * Disposes of th webVRCOntroller
  19946. */
  19947. dispose(): void;
  19948. }
  19949. }
  19950. declare module "babylonjs/Lights/hemisphericLight" {
  19951. import { Nullable } from "babylonjs/types";
  19952. import { Scene } from "babylonjs/scene";
  19953. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  19954. import { Color3 } from "babylonjs/Maths/math.color";
  19955. import { Effect } from "babylonjs/Materials/effect";
  19956. import { Light } from "babylonjs/Lights/light";
  19957. import { IShadowGenerator } from "babylonjs/Lights/Shadows/shadowGenerator";
  19958. /**
  19959. * The HemisphericLight simulates the ambient environment light,
  19960. * so the passed direction is the light reflection direction, not the incoming direction.
  19961. */
  19962. export class HemisphericLight extends Light {
  19963. /**
  19964. * The groundColor is the light in the opposite direction to the one specified during creation.
  19965. * 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.
  19966. */
  19967. groundColor: Color3;
  19968. /**
  19969. * The light reflection direction, not the incoming direction.
  19970. */
  19971. direction: Vector3;
  19972. /**
  19973. * Creates a HemisphericLight object in the scene according to the passed direction (Vector3).
  19974. * The HemisphericLight simulates the ambient environment light, so the passed direction is the light reflection direction, not the incoming direction.
  19975. * The HemisphericLight can't cast shadows.
  19976. * Documentation : https://doc.babylonjs.com/babylon101/lights
  19977. * @param name The friendly name of the light
  19978. * @param direction The direction of the light reflection
  19979. * @param scene The scene the light belongs to
  19980. */
  19981. constructor(name: string, direction: Vector3, scene: Scene);
  19982. protected _buildUniformLayout(): void;
  19983. /**
  19984. * Returns the string "HemisphericLight".
  19985. * @return The class name
  19986. */
  19987. getClassName(): string;
  19988. /**
  19989. * Sets the HemisphericLight direction towards the passed target (Vector3).
  19990. * Returns the updated direction.
  19991. * @param target The target the direction should point to
  19992. * @return The computed direction
  19993. */
  19994. setDirectionToTarget(target: Vector3): Vector3;
  19995. /**
  19996. * Returns the shadow generator associated to the light.
  19997. * @returns Always null for hemispheric lights because it does not support shadows.
  19998. */
  19999. getShadowGenerator(): Nullable<IShadowGenerator>;
  20000. /**
  20001. * Sets the passed Effect object with the HemisphericLight normalized direction and color and the passed name (string).
  20002. * @param effect The effect to update
  20003. * @param lightIndex The index of the light in the effect to update
  20004. * @returns The hemispheric light
  20005. */
  20006. transferToEffect(effect: Effect, lightIndex: string): HemisphericLight;
  20007. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  20008. /**
  20009. * Computes the world matrix of the node
  20010. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  20011. * @param useWasUpdatedFlag defines a reserved property
  20012. * @returns the world matrix
  20013. */
  20014. computeWorldMatrix(): Matrix;
  20015. /**
  20016. * Returns the integer 3.
  20017. * @return The light Type id as a constant defines in Light.LIGHTTYPEID_x
  20018. */
  20019. getTypeID(): number;
  20020. /**
  20021. * Prepares the list of defines specific to the light type.
  20022. * @param defines the list of defines
  20023. * @param lightIndex defines the index of the light for the effect
  20024. */
  20025. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  20026. }
  20027. }
  20028. declare module "babylonjs/Shaders/vrMultiviewToSingleview.fragment" {
  20029. /** @hidden */
  20030. export var vrMultiviewToSingleviewPixelShader: {
  20031. name: string;
  20032. shader: string;
  20033. };
  20034. }
  20035. declare module "babylonjs/Materials/Textures/MultiviewRenderTarget" {
  20036. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  20037. import { Scene } from "babylonjs/scene";
  20038. /**
  20039. * Renders to multiple views with a single draw call
  20040. * @see https://www.khronos.org/registry/webgl/extensions/WEBGL_multiview/
  20041. */
  20042. export class MultiviewRenderTarget extends RenderTargetTexture {
  20043. /**
  20044. * Creates a multiview render target
  20045. * @param scene scene used with the render target
  20046. * @param size the size of the render target (used for each view)
  20047. */
  20048. constructor(scene: Scene, size?: number | {
  20049. width: number;
  20050. height: number;
  20051. } | {
  20052. ratio: number;
  20053. });
  20054. /**
  20055. * @hidden
  20056. * @param faceIndex the face index, if its a cube texture
  20057. */
  20058. _bindFrameBuffer(faceIndex?: number): void;
  20059. /**
  20060. * Gets the number of views the corresponding to the texture (eg. a MultiviewRenderTarget will have > 1)
  20061. * @returns the view count
  20062. */
  20063. getViewCount(): number;
  20064. }
  20065. }
  20066. declare module "babylonjs/Engines/Extensions/engine.multiview" {
  20067. import { Camera } from "babylonjs/Cameras/camera";
  20068. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  20069. import { Nullable } from "babylonjs/types";
  20070. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  20071. import { Matrix } from "babylonjs/Maths/math.vector";
  20072. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  20073. module "babylonjs/Engines/engine" {
  20074. interface Engine {
  20075. /**
  20076. * Creates a new multiview render target
  20077. * @param width defines the width of the texture
  20078. * @param height defines the height of the texture
  20079. * @returns the created multiview texture
  20080. */
  20081. createMultiviewRenderTargetTexture(width: number, height: number): InternalTexture;
  20082. /**
  20083. * Binds a multiview framebuffer to be drawn to
  20084. * @param multiviewTexture texture to bind
  20085. */
  20086. bindMultiviewFramebuffer(multiviewTexture: InternalTexture): void;
  20087. }
  20088. }
  20089. module "babylonjs/Cameras/camera" {
  20090. interface Camera {
  20091. /**
  20092. * @hidden
  20093. * 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)
  20094. */
  20095. _useMultiviewToSingleView: boolean;
  20096. /**
  20097. * @hidden
  20098. * 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)
  20099. */
  20100. _multiviewTexture: Nullable<RenderTargetTexture>;
  20101. /**
  20102. * @hidden
  20103. * ensures the multiview texture of the camera exists and has the specified width/height
  20104. * @param width height to set on the multiview texture
  20105. * @param height width to set on the multiview texture
  20106. */
  20107. _resizeOrCreateMultiviewTexture(width: number, height: number): void;
  20108. }
  20109. }
  20110. module "babylonjs/scene" {
  20111. interface Scene {
  20112. /** @hidden */
  20113. _transformMatrixR: Matrix;
  20114. /** @hidden */
  20115. _multiviewSceneUbo: Nullable<UniformBuffer>;
  20116. /** @hidden */
  20117. _createMultiviewUbo(): void;
  20118. /** @hidden */
  20119. _updateMultiviewUbo(viewR?: Matrix, projectionR?: Matrix): void;
  20120. /** @hidden */
  20121. _renderMultiviewToSingleView(camera: Camera): void;
  20122. }
  20123. }
  20124. }
  20125. declare module "babylonjs/PostProcesses/vrMultiviewToSingleviewPostProcess" {
  20126. import { Camera } from "babylonjs/Cameras/camera";
  20127. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  20128. import "babylonjs/Shaders/vrMultiviewToSingleview.fragment";
  20129. import "babylonjs/Engines/Extensions/engine.multiview";
  20130. /**
  20131. * VRMultiviewToSingleview used to convert multiview texture arrays to standard textures for scenarios such as webVR
  20132. * This will not be used for webXR as it supports displaying texture arrays directly
  20133. */
  20134. export class VRMultiviewToSingleviewPostProcess extends PostProcess {
  20135. /**
  20136. * Initializes a VRMultiviewToSingleview
  20137. * @param name name of the post process
  20138. * @param camera camera to be applied to
  20139. * @param scaleFactor scaling factor to the size of the output texture
  20140. */
  20141. constructor(name: string, camera: Camera, scaleFactor: number);
  20142. }
  20143. }
  20144. declare module "babylonjs/Cameras/RigModes/webVRRigMode" { }
  20145. declare module "babylonjs/Engines/Extensions/engine.webVR" {
  20146. import { Nullable } from "babylonjs/types";
  20147. import { Size } from "babylonjs/Maths/math.size";
  20148. import { Observable } from "babylonjs/Misc/observable";
  20149. import { WebVROptions } from "babylonjs/Cameras/VR/webVRCamera";
  20150. /**
  20151. * Interface used to define additional presentation attributes
  20152. */
  20153. export interface IVRPresentationAttributes {
  20154. /**
  20155. * Defines a boolean indicating that we want to get 72hz mode on Oculus Browser (default is off eg. 60hz)
  20156. */
  20157. highRefreshRate: boolean;
  20158. /**
  20159. * Enables foveation in VR to improve perf. 0 none, 1 low, 2 medium, 3 high (Default is 1)
  20160. */
  20161. foveationLevel: number;
  20162. }
  20163. module "babylonjs/Engines/engine" {
  20164. interface Engine {
  20165. /** @hidden */
  20166. _vrDisplay: any;
  20167. /** @hidden */
  20168. _vrSupported: boolean;
  20169. /** @hidden */
  20170. _oldSize: Size;
  20171. /** @hidden */
  20172. _oldHardwareScaleFactor: number;
  20173. /** @hidden */
  20174. _vrExclusivePointerMode: boolean;
  20175. /** @hidden */
  20176. _webVRInitPromise: Promise<IDisplayChangedEventArgs>;
  20177. /** @hidden */
  20178. _onVRDisplayPointerRestricted: () => void;
  20179. /** @hidden */
  20180. _onVRDisplayPointerUnrestricted: () => void;
  20181. /** @hidden */
  20182. _onVrDisplayConnect: Nullable<(display: any) => void>;
  20183. /** @hidden */
  20184. _onVrDisplayDisconnect: Nullable<() => void>;
  20185. /** @hidden */
  20186. _onVrDisplayPresentChange: Nullable<() => void>;
  20187. /**
  20188. * Observable signaled when VR display mode changes
  20189. */
  20190. onVRDisplayChangedObservable: Observable<IDisplayChangedEventArgs>;
  20191. /**
  20192. * Observable signaled when VR request present is complete
  20193. */
  20194. onVRRequestPresentComplete: Observable<boolean>;
  20195. /**
  20196. * Observable signaled when VR request present starts
  20197. */
  20198. onVRRequestPresentStart: Observable<Engine>;
  20199. /**
  20200. * Gets a boolean indicating that the engine is currently in VR exclusive mode for the pointers
  20201. * @see https://docs.microsoft.com/en-us/microsoft-edge/webvr/essentials#mouse-input
  20202. */
  20203. isInVRExclusivePointerMode: boolean;
  20204. /**
  20205. * Gets a boolean indicating if a webVR device was detected
  20206. * @returns true if a webVR device was detected
  20207. */
  20208. isVRDevicePresent(): boolean;
  20209. /**
  20210. * Gets the current webVR device
  20211. * @returns the current webVR device (or null)
  20212. */
  20213. getVRDevice(): any;
  20214. /**
  20215. * Initializes a webVR display and starts listening to display change events
  20216. * The onVRDisplayChangedObservable will be notified upon these changes
  20217. * @returns A promise containing a VRDisplay and if vr is supported
  20218. */
  20219. initWebVRAsync(): Promise<IDisplayChangedEventArgs>;
  20220. /** @hidden */
  20221. _getVRDisplaysAsync(): Promise<IDisplayChangedEventArgs>;
  20222. /**
  20223. * Gets or sets the presentation attributes used to configure VR rendering
  20224. */
  20225. vrPresentationAttributes?: IVRPresentationAttributes;
  20226. /**
  20227. * Call this function to switch to webVR mode
  20228. * Will do nothing if webVR is not supported or if there is no webVR device
  20229. * @param options the webvr options provided to the camera. mainly used for multiview
  20230. * @see https://doc.babylonjs.com/how_to/webvr_camera
  20231. */
  20232. enableVR(options: WebVROptions): void;
  20233. /** @hidden */
  20234. _onVRFullScreenTriggered(): void;
  20235. }
  20236. }
  20237. }
  20238. declare module "babylonjs/Cameras/VR/webVRCamera" {
  20239. import { Nullable } from "babylonjs/types";
  20240. import { Observable } from "babylonjs/Misc/observable";
  20241. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  20242. import { Scene } from "babylonjs/scene";
  20243. import { Quaternion, Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  20244. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  20245. import { Node } from "babylonjs/node";
  20246. import { Ray } from "babylonjs/Culling/ray";
  20247. import "babylonjs/Cameras/RigModes/webVRRigMode";
  20248. import "babylonjs/Engines/Extensions/engine.webVR";
  20249. /**
  20250. * This is a copy of VRPose. See https://developer.mozilla.org/en-US/docs/Web/API/VRPose
  20251. * IMPORTANT!! The data is right-hand data.
  20252. * @export
  20253. * @interface DevicePose
  20254. */
  20255. export interface DevicePose {
  20256. /**
  20257. * The position of the device, values in array are [x,y,z].
  20258. */
  20259. readonly position: Nullable<Float32Array>;
  20260. /**
  20261. * The linearVelocity of the device, values in array are [x,y,z].
  20262. */
  20263. readonly linearVelocity: Nullable<Float32Array>;
  20264. /**
  20265. * The linearAcceleration of the device, values in array are [x,y,z].
  20266. */
  20267. readonly linearAcceleration: Nullable<Float32Array>;
  20268. /**
  20269. * The orientation of the device in a quaternion array, values in array are [x,y,z,w].
  20270. */
  20271. readonly orientation: Nullable<Float32Array>;
  20272. /**
  20273. * The angularVelocity of the device, values in array are [x,y,z].
  20274. */
  20275. readonly angularVelocity: Nullable<Float32Array>;
  20276. /**
  20277. * The angularAcceleration of the device, values in array are [x,y,z].
  20278. */
  20279. readonly angularAcceleration: Nullable<Float32Array>;
  20280. }
  20281. /**
  20282. * Interface representing a pose controlled object in Babylon.
  20283. * A pose controlled object has both regular pose values as well as pose values
  20284. * from an external device such as a VR head mounted display
  20285. */
  20286. export interface PoseControlled {
  20287. /**
  20288. * The position of the object in babylon space.
  20289. */
  20290. position: Vector3;
  20291. /**
  20292. * The rotation quaternion of the object in babylon space.
  20293. */
  20294. rotationQuaternion: Quaternion;
  20295. /**
  20296. * The position of the device in babylon space.
  20297. */
  20298. devicePosition?: Vector3;
  20299. /**
  20300. * The rotation quaternion of the device in babylon space.
  20301. */
  20302. deviceRotationQuaternion: Quaternion;
  20303. /**
  20304. * The raw pose coming from the device.
  20305. */
  20306. rawPose: Nullable<DevicePose>;
  20307. /**
  20308. * The scale of the device to be used when translating from device space to babylon space.
  20309. */
  20310. deviceScaleFactor: number;
  20311. /**
  20312. * Updates the poseControlled values based on the input device pose.
  20313. * @param poseData the pose data to update the object with
  20314. */
  20315. updateFromDevice(poseData: DevicePose): void;
  20316. }
  20317. /**
  20318. * Set of options to customize the webVRCamera
  20319. */
  20320. export interface WebVROptions {
  20321. /**
  20322. * Sets if the webVR camera should be tracked to the vrDevice. (default: true)
  20323. */
  20324. trackPosition?: boolean;
  20325. /**
  20326. * Sets the scale of the vrDevice in babylon space. (default: 1)
  20327. */
  20328. positionScale?: number;
  20329. /**
  20330. * If there are more than one VRDisplays, this will choose the display matching this name. (default: pick first vrDisplay)
  20331. */
  20332. displayName?: string;
  20333. /**
  20334. * Should the native controller meshes be initialized. (default: true)
  20335. */
  20336. controllerMeshes?: boolean;
  20337. /**
  20338. * Creating a default HemiLight only on controllers. (default: true)
  20339. */
  20340. defaultLightingOnControllers?: boolean;
  20341. /**
  20342. * If you don't want to use the default VR button of the helper. (default: false)
  20343. */
  20344. useCustomVRButton?: boolean;
  20345. /**
  20346. * If you'd like to provide your own button to the VRHelper. (default: standard babylon vr button)
  20347. */
  20348. customVRButton?: HTMLButtonElement;
  20349. /**
  20350. * To change the length of the ray for gaze/controllers. Will be scaled by positionScale. (default: 100)
  20351. */
  20352. rayLength?: number;
  20353. /**
  20354. * To change the default offset from the ground to account for user's height in meters. Will be scaled by positionScale. (default: 1.7)
  20355. */
  20356. defaultHeight?: number;
  20357. /**
  20358. * If multiview should be used if availible (default: false)
  20359. */
  20360. useMultiview?: boolean;
  20361. }
  20362. /**
  20363. * This represents a WebVR camera.
  20364. * The WebVR camera is Babylon's simple interface to interaction with Windows Mixed Reality, HTC Vive and Oculus Rift.
  20365. * @example https://doc.babylonjs.com/how_to/webvr_camera
  20366. */
  20367. export class WebVRFreeCamera extends FreeCamera implements PoseControlled {
  20368. private webVROptions;
  20369. /**
  20370. * @hidden
  20371. * The vrDisplay tied to the camera. See https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay
  20372. */
  20373. _vrDevice: any;
  20374. /**
  20375. * The rawPose of the vrDevice.
  20376. */
  20377. rawPose: Nullable<DevicePose>;
  20378. private _onVREnabled;
  20379. private _specsVersion;
  20380. private _attached;
  20381. private _frameData;
  20382. protected _descendants: Array<Node>;
  20383. private _deviceRoomPosition;
  20384. /** @hidden */
  20385. _deviceRoomRotationQuaternion: Quaternion;
  20386. private _standingMatrix;
  20387. /**
  20388. * Represents device position in babylon space.
  20389. */
  20390. devicePosition: Vector3;
  20391. /**
  20392. * Represents device rotation in babylon space.
  20393. */
  20394. deviceRotationQuaternion: Quaternion;
  20395. /**
  20396. * The scale of the device to be used when translating from device space to babylon space.
  20397. */
  20398. deviceScaleFactor: number;
  20399. private _deviceToWorld;
  20400. private _worldToDevice;
  20401. /**
  20402. * References to the webVR controllers for the vrDevice.
  20403. */
  20404. controllers: Array<WebVRController>;
  20405. /**
  20406. * Emits an event when a controller is attached.
  20407. */
  20408. onControllersAttachedObservable: Observable<WebVRController[]>;
  20409. /**
  20410. * Emits an event when a controller's mesh has been loaded;
  20411. */
  20412. onControllerMeshLoadedObservable: Observable<WebVRController>;
  20413. /**
  20414. * Emits an event when the HMD's pose has been updated.
  20415. */
  20416. onPoseUpdatedFromDeviceObservable: Observable<any>;
  20417. private _poseSet;
  20418. /**
  20419. * If the rig cameras be used as parent instead of this camera.
  20420. */
  20421. rigParenting: boolean;
  20422. private _lightOnControllers;
  20423. private _defaultHeight?;
  20424. /**
  20425. * Instantiates a WebVRFreeCamera.
  20426. * @param name The name of the WebVRFreeCamera
  20427. * @param position The starting anchor position for the camera
  20428. * @param scene The scene the camera belongs to
  20429. * @param webVROptions a set of customizable options for the webVRCamera
  20430. */
  20431. constructor(name: string, position: Vector3, scene: Scene, webVROptions?: WebVROptions);
  20432. /**
  20433. * Gets the device distance from the ground in meters.
  20434. * @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.
  20435. */
  20436. deviceDistanceToRoomGround(): number;
  20437. /**
  20438. * Enables the standing matrix when supported. This can be used to position the user's view the correct height from the ground.
  20439. * @param callback will be called when the standing matrix is set. Callback parameter is if the standing matrix is supported.
  20440. */
  20441. useStandingMatrix(callback?: (bool: boolean) => void): void;
  20442. /**
  20443. * Enables the standing matrix when supported. This can be used to position the user's view the correct height from the ground.
  20444. * @returns A promise with a boolean set to if the standing matrix is supported.
  20445. */
  20446. useStandingMatrixAsync(): Promise<boolean>;
  20447. /**
  20448. * Disposes the camera
  20449. */
  20450. dispose(): void;
  20451. /**
  20452. * Gets a vrController by name.
  20453. * @param name The name of the controller to retreive
  20454. * @returns the controller matching the name specified or null if not found
  20455. */
  20456. getControllerByName(name: string): Nullable<WebVRController>;
  20457. private _leftController;
  20458. /**
  20459. * The controller corresponding to the users left hand.
  20460. */
  20461. get leftController(): Nullable<WebVRController>;
  20462. private _rightController;
  20463. /**
  20464. * The controller corresponding to the users right hand.
  20465. */
  20466. get rightController(): Nullable<WebVRController>;
  20467. /**
  20468. * Casts a ray forward from the vrCamera's gaze.
  20469. * @param length Length of the ray (default: 100)
  20470. * @returns the ray corresponding to the gaze
  20471. */
  20472. getForwardRay(length?: number): Ray;
  20473. /**
  20474. * @hidden
  20475. * Updates the camera based on device's frame data
  20476. */
  20477. _checkInputs(): void;
  20478. /**
  20479. * Updates the poseControlled values based on the input device pose.
  20480. * @param poseData Pose coming from the device
  20481. */
  20482. updateFromDevice(poseData: DevicePose): void;
  20483. private _htmlElementAttached;
  20484. private _detachIfAttached;
  20485. /**
  20486. * WebVR's attach control will start broadcasting frames to the device.
  20487. * Note that in certain browsers (chrome for example) this function must be called
  20488. * within a user-interaction callback. Example:
  20489. * <pre> scene.onPointerDown = function() { camera.attachControl(canvas); }</pre>
  20490. *
  20491. * @param element html element to attach the vrDevice to
  20492. * @param noPreventDefault prevent the default html element operation when attaching the vrDevice
  20493. */
  20494. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  20495. /**
  20496. * Detaches the camera from the html element and disables VR
  20497. *
  20498. * @param element html element to detach from
  20499. */
  20500. detachControl(element: HTMLElement): void;
  20501. /**
  20502. * @returns the name of this class
  20503. */
  20504. getClassName(): string;
  20505. /**
  20506. * Calls resetPose on the vrDisplay
  20507. * See: https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay/resetPose
  20508. */
  20509. resetToCurrentRotation(): void;
  20510. /**
  20511. * @hidden
  20512. * Updates the rig cameras (left and right eye)
  20513. */
  20514. _updateRigCameras(): void;
  20515. private _workingVector;
  20516. private _oneVector;
  20517. private _workingMatrix;
  20518. private updateCacheCalled;
  20519. private _correctPositionIfNotTrackPosition;
  20520. /**
  20521. * @hidden
  20522. * Updates the cached values of the camera
  20523. * @param ignoreParentClass ignores updating the parent class's cache (default: false)
  20524. */
  20525. _updateCache(ignoreParentClass?: boolean): void;
  20526. /**
  20527. * @hidden
  20528. * Get current device position in babylon world
  20529. */
  20530. _computeDevicePosition(): void;
  20531. /**
  20532. * Updates the current device position and rotation in the babylon world
  20533. */
  20534. update(): void;
  20535. /**
  20536. * @hidden
  20537. * Gets the view matrix of this camera (Always set to identity as left and right eye cameras contain the actual view matrix)
  20538. * @returns an identity matrix
  20539. */
  20540. _getViewMatrix(): Matrix;
  20541. private _tmpMatrix;
  20542. /**
  20543. * This function is called by the two RIG cameras.
  20544. * 'this' is the left or right camera (and NOT (!!!) the WebVRFreeCamera instance)
  20545. * @hidden
  20546. */
  20547. _getWebVRViewMatrix(): Matrix;
  20548. /** @hidden */
  20549. _getWebVRProjectionMatrix(): Matrix;
  20550. private _onGamepadConnectedObserver;
  20551. private _onGamepadDisconnectedObserver;
  20552. private _updateCacheWhenTrackingDisabledObserver;
  20553. /**
  20554. * Initializes the controllers and their meshes
  20555. */
  20556. initControllers(): void;
  20557. }
  20558. }
  20559. declare module "babylonjs/Materials/materialHelper" {
  20560. import { Nullable } from "babylonjs/types";
  20561. import { Scene } from "babylonjs/scene";
  20562. import { Engine } from "babylonjs/Engines/engine";
  20563. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  20564. import { Light } from "babylonjs/Lights/light";
  20565. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  20566. import { Effect, IEffectCreationOptions } from "babylonjs/Materials/effect";
  20567. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  20568. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  20569. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  20570. /**
  20571. * "Static Class" containing the most commonly used helper while dealing with material for
  20572. * rendering purpose.
  20573. *
  20574. * It contains the basic tools to help defining defines, binding uniform for the common part of the materials.
  20575. *
  20576. * This works by convention in BabylonJS but is meant to be use only with shader following the in place naming rules and conventions.
  20577. */
  20578. export class MaterialHelper {
  20579. /**
  20580. * Bind the current view position to an effect.
  20581. * @param effect The effect to be bound
  20582. * @param scene The scene the eyes position is used from
  20583. * @param variableName name of the shader variable that will hold the eye position
  20584. */
  20585. static BindEyePosition(effect: Effect, scene: Scene, variableName?: string): void;
  20586. /**
  20587. * Helps preparing the defines values about the UVs in used in the effect.
  20588. * UVs are shared as much as we can accross channels in the shaders.
  20589. * @param texture The texture we are preparing the UVs for
  20590. * @param defines The defines to update
  20591. * @param key The channel key "diffuse", "specular"... used in the shader
  20592. */
  20593. static PrepareDefinesForMergedUV(texture: BaseTexture, defines: any, key: string): void;
  20594. /**
  20595. * Binds a texture matrix value to its corrsponding uniform
  20596. * @param texture The texture to bind the matrix for
  20597. * @param uniformBuffer The uniform buffer receivin the data
  20598. * @param key The channel key "diffuse", "specular"... used in the shader
  20599. */
  20600. static BindTextureMatrix(texture: BaseTexture, uniformBuffer: UniformBuffer, key: string): void;
  20601. /**
  20602. * Gets the current status of the fog (should it be enabled?)
  20603. * @param mesh defines the mesh to evaluate for fog support
  20604. * @param scene defines the hosting scene
  20605. * @returns true if fog must be enabled
  20606. */
  20607. static GetFogState(mesh: AbstractMesh, scene: Scene): boolean;
  20608. /**
  20609. * Helper used to prepare the list of defines associated with misc. values for shader compilation
  20610. * @param mesh defines the current mesh
  20611. * @param scene defines the current scene
  20612. * @param useLogarithmicDepth defines if logarithmic depth has to be turned on
  20613. * @param pointsCloud defines if point cloud rendering has to be turned on
  20614. * @param fogEnabled defines if fog has to be turned on
  20615. * @param alphaTest defines if alpha testing has to be turned on
  20616. * @param defines defines the current list of defines
  20617. */
  20618. static PrepareDefinesForMisc(mesh: AbstractMesh, scene: Scene, useLogarithmicDepth: boolean, pointsCloud: boolean, fogEnabled: boolean, alphaTest: boolean, defines: any): void;
  20619. /**
  20620. * Helper used to prepare the list of defines associated with frame values for shader compilation
  20621. * @param scene defines the current scene
  20622. * @param engine defines the current engine
  20623. * @param defines specifies the list of active defines
  20624. * @param useInstances defines if instances have to be turned on
  20625. * @param useClipPlane defines if clip plane have to be turned on
  20626. * @param useInstances defines if instances have to be turned on
  20627. * @param useThinInstances defines if thin instances have to be turned on
  20628. */
  20629. static PrepareDefinesForFrameBoundValues(scene: Scene, engine: Engine, defines: any, useInstances: boolean, useClipPlane?: Nullable<boolean>, useThinInstances?: boolean): void;
  20630. /**
  20631. * Prepares the defines for bones
  20632. * @param mesh The mesh containing the geometry data we will draw
  20633. * @param defines The defines to update
  20634. */
  20635. static PrepareDefinesForBones(mesh: AbstractMesh, defines: any): void;
  20636. /**
  20637. * Prepares the defines for morph targets
  20638. * @param mesh The mesh containing the geometry data we will draw
  20639. * @param defines The defines to update
  20640. */
  20641. static PrepareDefinesForMorphTargets(mesh: AbstractMesh, defines: any): void;
  20642. /**
  20643. * Prepares the defines used in the shader depending on the attributes data available in the mesh
  20644. * @param mesh The mesh containing the geometry data we will draw
  20645. * @param defines The defines to update
  20646. * @param useVertexColor Precise whether vertex colors should be used or not (override mesh info)
  20647. * @param useBones Precise whether bones should be used or not (override mesh info)
  20648. * @param useMorphTargets Precise whether morph targets should be used or not (override mesh info)
  20649. * @param useVertexAlpha Precise whether vertex alpha should be used or not (override mesh info)
  20650. * @returns false if defines are considered not dirty and have not been checked
  20651. */
  20652. static PrepareDefinesForAttributes(mesh: AbstractMesh, defines: any, useVertexColor: boolean, useBones: boolean, useMorphTargets?: boolean, useVertexAlpha?: boolean): boolean;
  20653. /**
  20654. * Prepares the defines related to multiview
  20655. * @param scene The scene we are intending to draw
  20656. * @param defines The defines to update
  20657. */
  20658. static PrepareDefinesForMultiview(scene: Scene, defines: any): void;
  20659. /**
  20660. * Prepares the defines related to the prepass
  20661. * @param scene The scene we are intending to draw
  20662. * @param defines The defines to update
  20663. * @param canRenderToMRT Indicates if this material renders to several textures in the prepass
  20664. */
  20665. static PrepareDefinesForPrePass(scene: Scene, defines: any, canRenderToMRT: boolean): void;
  20666. /**
  20667. * Prepares the defines related to the light information passed in parameter
  20668. * @param scene The scene we are intending to draw
  20669. * @param mesh The mesh the effect is compiling for
  20670. * @param light The light the effect is compiling for
  20671. * @param lightIndex The index of the light
  20672. * @param defines The defines to update
  20673. * @param specularSupported Specifies whether specular is supported or not (override lights data)
  20674. * @param state Defines the current state regarding what is needed (normals, etc...)
  20675. */
  20676. static PrepareDefinesForLight(scene: Scene, mesh: AbstractMesh, light: Light, lightIndex: number, defines: any, specularSupported: boolean, state: {
  20677. needNormals: boolean;
  20678. needRebuild: boolean;
  20679. shadowEnabled: boolean;
  20680. specularEnabled: boolean;
  20681. lightmapMode: boolean;
  20682. }): void;
  20683. /**
  20684. * Prepares the defines related to the light information passed in parameter
  20685. * @param scene The scene we are intending to draw
  20686. * @param mesh The mesh the effect is compiling for
  20687. * @param defines The defines to update
  20688. * @param specularSupported Specifies whether specular is supported or not (override lights data)
  20689. * @param maxSimultaneousLights Specfies how manuy lights can be added to the effect at max
  20690. * @param disableLighting Specifies whether the lighting is disabled (override scene and light)
  20691. * @returns true if normals will be required for the rest of the effect
  20692. */
  20693. static PrepareDefinesForLights(scene: Scene, mesh: AbstractMesh, defines: any, specularSupported: boolean, maxSimultaneousLights?: number, disableLighting?: boolean): boolean;
  20694. /**
  20695. * Prepares the uniforms and samplers list to be used in the effect (for a specific light)
  20696. * @param lightIndex defines the light index
  20697. * @param uniformsList The uniform list
  20698. * @param samplersList The sampler list
  20699. * @param projectedLightTexture defines if projected texture must be used
  20700. * @param uniformBuffersList defines an optional list of uniform buffers
  20701. */
  20702. static PrepareUniformsAndSamplersForLight(lightIndex: number, uniformsList: string[], samplersList: string[], projectedLightTexture?: any, uniformBuffersList?: Nullable<string[]>): void;
  20703. /**
  20704. * Prepares the uniforms and samplers list to be used in the effect
  20705. * @param uniformsListOrOptions The uniform names to prepare or an EffectCreationOptions containing the liist and extra information
  20706. * @param samplersList The sampler list
  20707. * @param defines The defines helping in the list generation
  20708. * @param maxSimultaneousLights The maximum number of simultanous light allowed in the effect
  20709. */
  20710. static PrepareUniformsAndSamplersList(uniformsListOrOptions: string[] | IEffectCreationOptions, samplersList?: string[], defines?: any, maxSimultaneousLights?: number): void;
  20711. /**
  20712. * This helps decreasing rank by rank the shadow quality (0 being the highest rank and quality)
  20713. * @param defines The defines to update while falling back
  20714. * @param fallbacks The authorized effect fallbacks
  20715. * @param maxSimultaneousLights The maximum number of lights allowed
  20716. * @param rank the current rank of the Effect
  20717. * @returns The newly affected rank
  20718. */
  20719. static HandleFallbacksForShadows(defines: any, fallbacks: EffectFallbacks, maxSimultaneousLights?: number, rank?: number): number;
  20720. private static _TmpMorphInfluencers;
  20721. /**
  20722. * Prepares the list of attributes required for morph targets according to the effect defines.
  20723. * @param attribs The current list of supported attribs
  20724. * @param mesh The mesh to prepare the morph targets attributes for
  20725. * @param influencers The number of influencers
  20726. */
  20727. static PrepareAttributesForMorphTargetsInfluencers(attribs: string[], mesh: AbstractMesh, influencers: number): void;
  20728. /**
  20729. * Prepares the list of attributes required for morph targets according to the effect defines.
  20730. * @param attribs The current list of supported attribs
  20731. * @param mesh The mesh to prepare the morph targets attributes for
  20732. * @param defines The current Defines of the effect
  20733. */
  20734. static PrepareAttributesForMorphTargets(attribs: string[], mesh: AbstractMesh, defines: any): void;
  20735. /**
  20736. * Prepares the list of attributes required for bones according to the effect defines.
  20737. * @param attribs The current list of supported attribs
  20738. * @param mesh The mesh to prepare the bones attributes for
  20739. * @param defines The current Defines of the effect
  20740. * @param fallbacks The current efffect fallback strategy
  20741. */
  20742. static PrepareAttributesForBones(attribs: string[], mesh: AbstractMesh, defines: any, fallbacks: EffectFallbacks): void;
  20743. /**
  20744. * Check and prepare the list of attributes required for instances according to the effect defines.
  20745. * @param attribs The current list of supported attribs
  20746. * @param defines The current MaterialDefines of the effect
  20747. */
  20748. static PrepareAttributesForInstances(attribs: string[], defines: MaterialDefines): void;
  20749. /**
  20750. * Add the list of attributes required for instances to the attribs array.
  20751. * @param attribs The current list of supported attribs
  20752. */
  20753. static PushAttributesForInstances(attribs: string[]): void;
  20754. /**
  20755. * Binds the light information to the effect.
  20756. * @param light The light containing the generator
  20757. * @param effect The effect we are binding the data to
  20758. * @param lightIndex The light index in the effect used to render
  20759. */
  20760. static BindLightProperties(light: Light, effect: Effect, lightIndex: number): void;
  20761. /**
  20762. * Binds the lights information from the scene to the effect for the given mesh.
  20763. * @param light Light to bind
  20764. * @param lightIndex Light index
  20765. * @param scene The scene where the light belongs to
  20766. * @param effect The effect we are binding the data to
  20767. * @param useSpecular Defines if specular is supported
  20768. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  20769. */
  20770. static BindLight(light: Light, lightIndex: number, scene: Scene, effect: Effect, useSpecular: boolean, rebuildInParallel?: boolean): void;
  20771. /**
  20772. * Binds the lights information from the scene to the effect for the given mesh.
  20773. * @param scene The scene the lights belongs to
  20774. * @param mesh The mesh we are binding the information to render
  20775. * @param effect The effect we are binding the data to
  20776. * @param defines The generated defines for the effect
  20777. * @param maxSimultaneousLights The maximum number of light that can be bound to the effect
  20778. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  20779. */
  20780. static BindLights(scene: Scene, mesh: AbstractMesh, effect: Effect, defines: any, maxSimultaneousLights?: number, rebuildInParallel?: boolean): void;
  20781. private static _tempFogColor;
  20782. /**
  20783. * Binds the fog information from the scene to the effect for the given mesh.
  20784. * @param scene The scene the lights belongs to
  20785. * @param mesh The mesh we are binding the information to render
  20786. * @param effect The effect we are binding the data to
  20787. * @param linearSpace Defines if the fog effect is applied in linear space
  20788. */
  20789. static BindFogParameters(scene: Scene, mesh: AbstractMesh, effect: Effect, linearSpace?: boolean): void;
  20790. /**
  20791. * Binds the bones information from the mesh to the effect.
  20792. * @param mesh The mesh we are binding the information to render
  20793. * @param effect The effect we are binding the data to
  20794. */
  20795. static BindBonesParameters(mesh?: AbstractMesh, effect?: Effect): void;
  20796. /**
  20797. * Binds the morph targets information from the mesh to the effect.
  20798. * @param abstractMesh The mesh we are binding the information to render
  20799. * @param effect The effect we are binding the data to
  20800. */
  20801. static BindMorphTargetParameters(abstractMesh: AbstractMesh, effect: Effect): void;
  20802. /**
  20803. * Binds the logarithmic depth information from the scene to the effect for the given defines.
  20804. * @param defines The generated defines used in the effect
  20805. * @param effect The effect we are binding the data to
  20806. * @param scene The scene we are willing to render with logarithmic scale for
  20807. */
  20808. static BindLogDepth(defines: any, effect: Effect, scene: Scene): void;
  20809. /**
  20810. * Binds the clip plane information from the scene to the effect.
  20811. * @param scene The scene the clip plane information are extracted from
  20812. * @param effect The effect we are binding the data to
  20813. */
  20814. static BindClipPlane(effect: Effect, scene: Scene): void;
  20815. }
  20816. }
  20817. declare module "babylonjs/Materials/Node/Blocks/Input/inputBlock" {
  20818. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  20819. import { NodeMaterialBlockConnectionPointTypes } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  20820. import { NodeMaterialSystemValues } from "babylonjs/Materials/Node/Enums/nodeMaterialSystemValues";
  20821. import { Nullable } from "babylonjs/types";
  20822. import { Effect } from "babylonjs/Materials/effect";
  20823. import { Matrix } from "babylonjs/Maths/math.vector";
  20824. import { Scene } from "babylonjs/scene";
  20825. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  20826. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  20827. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  20828. import { AnimatedInputBlockTypes } from "babylonjs/Materials/Node/Blocks/Input/animatedInputBlockTypes";
  20829. import { Observable } from "babylonjs/Misc/observable";
  20830. /**
  20831. * Block used to expose an input value
  20832. */
  20833. export class InputBlock extends NodeMaterialBlock {
  20834. private _mode;
  20835. private _associatedVariableName;
  20836. private _storedValue;
  20837. private _valueCallback;
  20838. private _type;
  20839. private _animationType;
  20840. /** Gets or set a value used to limit the range of float values */
  20841. min: number;
  20842. /** Gets or set a value used to limit the range of float values */
  20843. max: number;
  20844. /** Gets or set a value indicating that this input can only get 0 and 1 values */
  20845. isBoolean: boolean;
  20846. /** Gets or sets a value used by the Node Material editor to determine how to configure the current value if it is a matrix */
  20847. matrixMode: number;
  20848. /** @hidden */
  20849. _systemValue: Nullable<NodeMaterialSystemValues>;
  20850. /** Gets or sets a boolean indicating that this input can be edited in the Inspector (false by default) */
  20851. visibleInInspector: boolean;
  20852. /** Gets or sets a boolean indicating that the value of this input will not change after a build */
  20853. isConstant: boolean;
  20854. /** Gets or sets the group to use to display this block in the Inspector */
  20855. groupInInspector: string;
  20856. /** Gets an observable raised when the value is changed */
  20857. onValueChangedObservable: Observable<InputBlock>;
  20858. /**
  20859. * Gets or sets the connection point type (default is float)
  20860. */
  20861. get type(): NodeMaterialBlockConnectionPointTypes;
  20862. /**
  20863. * Creates a new InputBlock
  20864. * @param name defines the block name
  20865. * @param target defines the target of that block (Vertex by default)
  20866. * @param type defines the type of the input (can be set to NodeMaterialBlockConnectionPointTypes.AutoDetect)
  20867. */
  20868. constructor(name: string, target?: NodeMaterialBlockTargets, type?: NodeMaterialBlockConnectionPointTypes);
  20869. /**
  20870. * Validates if a name is a reserve word.
  20871. * @param newName the new name to be given to the node.
  20872. * @returns false if the name is a reserve word, else true.
  20873. */
  20874. validateBlockName(newName: string): boolean;
  20875. /**
  20876. * Gets the output component
  20877. */
  20878. get output(): NodeMaterialConnectionPoint;
  20879. /**
  20880. * Set the source of this connection point to a vertex attribute
  20881. * @param attributeName defines the attribute name (position, uv, normal, etc...). If not specified it will take the connection point name
  20882. * @returns the current connection point
  20883. */
  20884. setAsAttribute(attributeName?: string): InputBlock;
  20885. /**
  20886. * Set the source of this connection point to a system value
  20887. * @param value define the system value to use (world, view, etc...) or null to switch to manual value
  20888. * @returns the current connection point
  20889. */
  20890. setAsSystemValue(value: Nullable<NodeMaterialSystemValues>): InputBlock;
  20891. /**
  20892. * Gets or sets the value of that point.
  20893. * Please note that this value will be ignored if valueCallback is defined
  20894. */
  20895. get value(): any;
  20896. set value(value: any);
  20897. /**
  20898. * Gets or sets a callback used to get the value of that point.
  20899. * Please note that setting this value will force the connection point to ignore the value property
  20900. */
  20901. get valueCallback(): () => any;
  20902. set valueCallback(value: () => any);
  20903. /**
  20904. * Gets or sets the associated variable name in the shader
  20905. */
  20906. get associatedVariableName(): string;
  20907. set associatedVariableName(value: string);
  20908. /** Gets or sets the type of animation applied to the input */
  20909. get animationType(): AnimatedInputBlockTypes;
  20910. set animationType(value: AnimatedInputBlockTypes);
  20911. /**
  20912. * Gets a boolean indicating that this connection point not defined yet
  20913. */
  20914. get isUndefined(): boolean;
  20915. /**
  20916. * Gets or sets a boolean indicating that this connection point is coming from an uniform.
  20917. * In this case the connection point name must be the name of the uniform to use.
  20918. * Can only be set on inputs
  20919. */
  20920. get isUniform(): boolean;
  20921. set isUniform(value: boolean);
  20922. /**
  20923. * Gets or sets a boolean indicating that this connection point is coming from an attribute.
  20924. * In this case the connection point name must be the name of the attribute to use
  20925. * Can only be set on inputs
  20926. */
  20927. get isAttribute(): boolean;
  20928. set isAttribute(value: boolean);
  20929. /**
  20930. * Gets or sets a boolean indicating that this connection point is generating a varying variable.
  20931. * Can only be set on exit points
  20932. */
  20933. get isVarying(): boolean;
  20934. set isVarying(value: boolean);
  20935. /**
  20936. * Gets a boolean indicating that the current connection point is a system value
  20937. */
  20938. get isSystemValue(): boolean;
  20939. /**
  20940. * Gets or sets the current well known value or null if not defined as a system value
  20941. */
  20942. get systemValue(): Nullable<NodeMaterialSystemValues>;
  20943. set systemValue(value: Nullable<NodeMaterialSystemValues>);
  20944. /**
  20945. * Gets the current class name
  20946. * @returns the class name
  20947. */
  20948. getClassName(): string;
  20949. /**
  20950. * Animate the input if animationType !== None
  20951. * @param scene defines the rendering scene
  20952. */
  20953. animate(scene: Scene): void;
  20954. private _emitDefine;
  20955. initialize(state: NodeMaterialBuildState): void;
  20956. /**
  20957. * Set the input block to its default value (based on its type)
  20958. */
  20959. setDefaultValue(): void;
  20960. private _emitConstant;
  20961. /** @hidden */
  20962. get _noContextSwitch(): boolean;
  20963. private _emit;
  20964. /** @hidden */
  20965. _transmitWorld(effect: Effect, world: Matrix, worldView: Matrix, worldViewProjection: Matrix): void;
  20966. /** @hidden */
  20967. _transmit(effect: Effect, scene: Scene): void;
  20968. protected _buildBlock(state: NodeMaterialBuildState): void;
  20969. protected _dumpPropertiesCode(): string;
  20970. dispose(): void;
  20971. serialize(): any;
  20972. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  20973. }
  20974. }
  20975. declare module "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint" {
  20976. import { NodeMaterialBlockConnectionPointTypes } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  20977. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  20978. import { Nullable } from "babylonjs/types";
  20979. import { InputBlock } from "babylonjs/Materials/Node/Blocks/Input/inputBlock";
  20980. import { Observable } from "babylonjs/Misc/observable";
  20981. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  20982. /**
  20983. * Enum used to define the compatibility state between two connection points
  20984. */
  20985. export enum NodeMaterialConnectionPointCompatibilityStates {
  20986. /** Points are compatibles */
  20987. Compatible = 0,
  20988. /** Points are incompatible because of their types */
  20989. TypeIncompatible = 1,
  20990. /** Points are incompatible because of their targets (vertex vs fragment) */
  20991. TargetIncompatible = 2
  20992. }
  20993. /**
  20994. * Defines the direction of a connection point
  20995. */
  20996. export enum NodeMaterialConnectionPointDirection {
  20997. /** Input */
  20998. Input = 0,
  20999. /** Output */
  21000. Output = 1
  21001. }
  21002. /**
  21003. * Defines a connection point for a block
  21004. */
  21005. export class NodeMaterialConnectionPoint {
  21006. /** @hidden */
  21007. _ownerBlock: NodeMaterialBlock;
  21008. /** @hidden */
  21009. _connectedPoint: Nullable<NodeMaterialConnectionPoint>;
  21010. private _endpoints;
  21011. private _associatedVariableName;
  21012. private _direction;
  21013. /** @hidden */
  21014. _typeConnectionSource: Nullable<NodeMaterialConnectionPoint>;
  21015. /** @hidden */
  21016. _linkedConnectionSource: Nullable<NodeMaterialConnectionPoint>;
  21017. private _type;
  21018. /** @hidden */
  21019. _enforceAssociatedVariableName: boolean;
  21020. /** Gets the direction of the point */
  21021. get direction(): NodeMaterialConnectionPointDirection;
  21022. /** Indicates that this connection point needs dual validation before being connected to another point */
  21023. needDualDirectionValidation: boolean;
  21024. /**
  21025. * Gets or sets the additional types supported by this connection point
  21026. */
  21027. acceptedConnectionPointTypes: NodeMaterialBlockConnectionPointTypes[];
  21028. /**
  21029. * Gets or sets the additional types excluded by this connection point
  21030. */
  21031. excludedConnectionPointTypes: NodeMaterialBlockConnectionPointTypes[];
  21032. /**
  21033. * Observable triggered when this point is connected
  21034. */
  21035. onConnectionObservable: Observable<NodeMaterialConnectionPoint>;
  21036. /**
  21037. * Gets or sets the associated variable name in the shader
  21038. */
  21039. get associatedVariableName(): string;
  21040. set associatedVariableName(value: string);
  21041. /** Get the inner type (ie AutoDetect for instance instead of the inferred one) */
  21042. get innerType(): NodeMaterialBlockConnectionPointTypes;
  21043. /**
  21044. * Gets or sets the connection point type (default is float)
  21045. */
  21046. get type(): NodeMaterialBlockConnectionPointTypes;
  21047. set type(value: NodeMaterialBlockConnectionPointTypes);
  21048. /**
  21049. * Gets or sets the connection point name
  21050. */
  21051. name: string;
  21052. /**
  21053. * Gets or sets the connection point name
  21054. */
  21055. displayName: string;
  21056. /**
  21057. * Gets or sets a boolean indicating that this connection point can be omitted
  21058. */
  21059. isOptional: boolean;
  21060. /**
  21061. * Gets or sets a boolean indicating that this connection point is exposed on a frame
  21062. */
  21063. isExposedOnFrame: boolean;
  21064. /**
  21065. * Gets or sets a string indicating that this uniform must be defined under a #ifdef
  21066. */
  21067. define: string;
  21068. /** @hidden */
  21069. _prioritizeVertex: boolean;
  21070. private _target;
  21071. /** Gets or sets the target of that connection point */
  21072. get target(): NodeMaterialBlockTargets;
  21073. set target(value: NodeMaterialBlockTargets);
  21074. /**
  21075. * Gets a boolean indicating that the current point is connected to another NodeMaterialBlock
  21076. */
  21077. get isConnected(): boolean;
  21078. /**
  21079. * Gets a boolean indicating that the current point is connected to an input block
  21080. */
  21081. get isConnectedToInputBlock(): boolean;
  21082. /**
  21083. * Gets a the connected input block (if any)
  21084. */
  21085. get connectInputBlock(): Nullable<InputBlock>;
  21086. /** Get the other side of the connection (if any) */
  21087. get connectedPoint(): Nullable<NodeMaterialConnectionPoint>;
  21088. /** Get the block that owns this connection point */
  21089. get ownerBlock(): NodeMaterialBlock;
  21090. /** Get the block connected on the other side of this connection (if any) */
  21091. get sourceBlock(): Nullable<NodeMaterialBlock>;
  21092. /** Get the block connected on the endpoints of this connection (if any) */
  21093. get connectedBlocks(): Array<NodeMaterialBlock>;
  21094. /** Gets the list of connected endpoints */
  21095. get endpoints(): NodeMaterialConnectionPoint[];
  21096. /** Gets a boolean indicating if that output point is connected to at least one input */
  21097. get hasEndpoints(): boolean;
  21098. /** Gets a boolean indicating that this connection will be used in the vertex shader */
  21099. get isConnectedInVertexShader(): boolean;
  21100. /** Gets a boolean indicating that this connection will be used in the fragment shader */
  21101. get isConnectedInFragmentShader(): boolean;
  21102. /**
  21103. * Creates a block suitable to be used as an input for this input point.
  21104. * If null is returned, a block based on the point type will be created.
  21105. * @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
  21106. */
  21107. createCustomInputBlock(): Nullable<[NodeMaterialBlock, string]>;
  21108. /**
  21109. * Creates a new connection point
  21110. * @param name defines the connection point name
  21111. * @param ownerBlock defines the block hosting this connection point
  21112. * @param direction defines the direction of the connection point
  21113. */
  21114. constructor(name: string, ownerBlock: NodeMaterialBlock, direction: NodeMaterialConnectionPointDirection);
  21115. /**
  21116. * Gets the current class name e.g. "NodeMaterialConnectionPoint"
  21117. * @returns the class name
  21118. */
  21119. getClassName(): string;
  21120. /**
  21121. * Gets a boolean indicating if the current point can be connected to another point
  21122. * @param connectionPoint defines the other connection point
  21123. * @returns a boolean
  21124. */
  21125. canConnectTo(connectionPoint: NodeMaterialConnectionPoint): boolean;
  21126. /**
  21127. * Gets a number indicating if the current point can be connected to another point
  21128. * @param connectionPoint defines the other connection point
  21129. * @returns a number defining the compatibility state
  21130. */
  21131. checkCompatibilityState(connectionPoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPointCompatibilityStates;
  21132. /**
  21133. * Connect this point to another connection point
  21134. * @param connectionPoint defines the other connection point
  21135. * @param ignoreConstraints defines if the system will ignore connection type constraints (default is false)
  21136. * @returns the current connection point
  21137. */
  21138. connectTo(connectionPoint: NodeMaterialConnectionPoint, ignoreConstraints?: boolean): NodeMaterialConnectionPoint;
  21139. /**
  21140. * Disconnect this point from one of his endpoint
  21141. * @param endpoint defines the other connection point
  21142. * @returns the current connection point
  21143. */
  21144. disconnectFrom(endpoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPoint;
  21145. /**
  21146. * Serializes this point in a JSON representation
  21147. * @param isInput defines if the connection point is an input (default is true)
  21148. * @returns the serialized point object
  21149. */
  21150. serialize(isInput?: boolean): any;
  21151. /**
  21152. * Release resources
  21153. */
  21154. dispose(): void;
  21155. }
  21156. }
  21157. declare module "babylonjs/Materials/Node/Enums/nodeMaterialModes" {
  21158. /**
  21159. * Enum used to define the material modes
  21160. */
  21161. export enum NodeMaterialModes {
  21162. /** Regular material */
  21163. Material = 0,
  21164. /** For post process */
  21165. PostProcess = 1,
  21166. /** For particle system */
  21167. Particle = 2
  21168. }
  21169. }
  21170. declare module "babylonjs/Materials/Node/Blocks/Dual/textureBlock" {
  21171. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21172. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  21173. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  21174. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21175. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  21176. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  21177. import { Effect } from "babylonjs/Materials/effect";
  21178. import { Mesh } from "babylonjs/Meshes/mesh";
  21179. import { Nullable } from "babylonjs/types";
  21180. import { Texture } from "babylonjs/Materials/Textures/texture";
  21181. import { Scene } from "babylonjs/scene";
  21182. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  21183. /**
  21184. * Block used to read a texture from a sampler
  21185. */
  21186. export class TextureBlock extends NodeMaterialBlock {
  21187. private _defineName;
  21188. private _linearDefineName;
  21189. private _gammaDefineName;
  21190. private _tempTextureRead;
  21191. private _samplerName;
  21192. private _transformedUVName;
  21193. private _textureTransformName;
  21194. private _textureInfoName;
  21195. private _mainUVName;
  21196. private _mainUVDefineName;
  21197. private _fragmentOnly;
  21198. /**
  21199. * Gets or sets the texture associated with the node
  21200. */
  21201. texture: Nullable<Texture>;
  21202. /**
  21203. * Gets or sets a boolean indicating if content needs to be converted to gamma space
  21204. */
  21205. convertToGammaSpace: boolean;
  21206. /**
  21207. * Gets or sets a boolean indicating if content needs to be converted to linear space
  21208. */
  21209. convertToLinearSpace: boolean;
  21210. /**
  21211. * Create a new TextureBlock
  21212. * @param name defines the block name
  21213. */
  21214. constructor(name: string, fragmentOnly?: boolean);
  21215. /**
  21216. * Gets the current class name
  21217. * @returns the class name
  21218. */
  21219. getClassName(): string;
  21220. /**
  21221. * Gets the uv input component
  21222. */
  21223. get uv(): NodeMaterialConnectionPoint;
  21224. /**
  21225. * Gets the rgba output component
  21226. */
  21227. get rgba(): NodeMaterialConnectionPoint;
  21228. /**
  21229. * Gets the rgb output component
  21230. */
  21231. get rgb(): NodeMaterialConnectionPoint;
  21232. /**
  21233. * Gets the r output component
  21234. */
  21235. get r(): NodeMaterialConnectionPoint;
  21236. /**
  21237. * Gets the g output component
  21238. */
  21239. get g(): NodeMaterialConnectionPoint;
  21240. /**
  21241. * Gets the b output component
  21242. */
  21243. get b(): NodeMaterialConnectionPoint;
  21244. /**
  21245. * Gets the a output component
  21246. */
  21247. get a(): NodeMaterialConnectionPoint;
  21248. get target(): NodeMaterialBlockTargets;
  21249. autoConfigure(material: NodeMaterial): void;
  21250. initializeDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  21251. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  21252. isReady(): boolean;
  21253. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  21254. private get _isMixed();
  21255. private _injectVertexCode;
  21256. private _writeTextureRead;
  21257. private _writeOutput;
  21258. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  21259. protected _dumpPropertiesCode(): string;
  21260. serialize(): any;
  21261. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  21262. }
  21263. }
  21264. declare module "babylonjs/Shaders/ShadersInclude/reflectionFunction" {
  21265. /** @hidden */
  21266. export var reflectionFunction: {
  21267. name: string;
  21268. shader: string;
  21269. };
  21270. }
  21271. declare module "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBaseBlock" {
  21272. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21273. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  21274. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21275. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  21276. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  21277. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  21278. import { Effect } from "babylonjs/Materials/effect";
  21279. import { Mesh } from "babylonjs/Meshes/mesh";
  21280. import { Nullable } from "babylonjs/types";
  21281. import { Scene } from "babylonjs/scene";
  21282. import "babylonjs/Shaders/ShadersInclude/reflectionFunction";
  21283. /**
  21284. * Base block used to read a reflection texture from a sampler
  21285. */
  21286. export abstract class ReflectionTextureBaseBlock extends NodeMaterialBlock {
  21287. /** @hidden */
  21288. _define3DName: string;
  21289. /** @hidden */
  21290. _defineCubicName: string;
  21291. /** @hidden */
  21292. _defineExplicitName: string;
  21293. /** @hidden */
  21294. _defineProjectionName: string;
  21295. /** @hidden */
  21296. _defineLocalCubicName: string;
  21297. /** @hidden */
  21298. _defineSphericalName: string;
  21299. /** @hidden */
  21300. _definePlanarName: string;
  21301. /** @hidden */
  21302. _defineEquirectangularName: string;
  21303. /** @hidden */
  21304. _defineMirroredEquirectangularFixedName: string;
  21305. /** @hidden */
  21306. _defineEquirectangularFixedName: string;
  21307. /** @hidden */
  21308. _defineSkyboxName: string;
  21309. /** @hidden */
  21310. _defineOppositeZ: string;
  21311. /** @hidden */
  21312. _cubeSamplerName: string;
  21313. /** @hidden */
  21314. _2DSamplerName: string;
  21315. protected _positionUVWName: string;
  21316. protected _directionWName: string;
  21317. protected _reflectionVectorName: string;
  21318. /** @hidden */
  21319. _reflectionCoordsName: string;
  21320. /** @hidden */
  21321. _reflectionMatrixName: string;
  21322. protected _reflectionColorName: string;
  21323. /**
  21324. * Gets or sets the texture associated with the node
  21325. */
  21326. texture: Nullable<BaseTexture>;
  21327. /**
  21328. * Create a new ReflectionTextureBaseBlock
  21329. * @param name defines the block name
  21330. */
  21331. constructor(name: string);
  21332. /**
  21333. * Gets the current class name
  21334. * @returns the class name
  21335. */
  21336. getClassName(): string;
  21337. /**
  21338. * Gets the world position input component
  21339. */
  21340. abstract get position(): NodeMaterialConnectionPoint;
  21341. /**
  21342. * Gets the world position input component
  21343. */
  21344. abstract get worldPosition(): NodeMaterialConnectionPoint;
  21345. /**
  21346. * Gets the world normal input component
  21347. */
  21348. abstract get worldNormal(): NodeMaterialConnectionPoint;
  21349. /**
  21350. * Gets the world input component
  21351. */
  21352. abstract get world(): NodeMaterialConnectionPoint;
  21353. /**
  21354. * Gets the camera (or eye) position component
  21355. */
  21356. abstract get cameraPosition(): NodeMaterialConnectionPoint;
  21357. /**
  21358. * Gets the view input component
  21359. */
  21360. abstract get view(): NodeMaterialConnectionPoint;
  21361. protected _getTexture(): Nullable<BaseTexture>;
  21362. autoConfigure(material: NodeMaterial): void;
  21363. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  21364. isReady(): boolean;
  21365. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  21366. /**
  21367. * Gets the code to inject in the vertex shader
  21368. * @param state current state of the node material building
  21369. * @returns the shader code
  21370. */
  21371. handleVertexSide(state: NodeMaterialBuildState): string;
  21372. /**
  21373. * Handles the inits for the fragment code path
  21374. * @param state node material build state
  21375. */
  21376. handleFragmentSideInits(state: NodeMaterialBuildState): void;
  21377. /**
  21378. * Generates the reflection coords code for the fragment code path
  21379. * @param worldNormalVarName name of the world normal variable
  21380. * @param worldPos name of the world position variable. If not provided, will use the world position connected to this block
  21381. * @param onlyReflectionVector if true, generates code only for the reflection vector computation, not for the reflection coordinates
  21382. * @returns the shader code
  21383. */
  21384. handleFragmentSideCodeReflectionCoords(worldNormalVarName: string, worldPos?: string, onlyReflectionVector?: boolean): string;
  21385. /**
  21386. * Generates the reflection color code for the fragment code path
  21387. * @param lodVarName name of the lod variable
  21388. * @param swizzleLookupTexture swizzle to use for the final color variable
  21389. * @returns the shader code
  21390. */
  21391. handleFragmentSideCodeReflectionColor(lodVarName?: string, swizzleLookupTexture?: string): string;
  21392. /**
  21393. * Generates the code corresponding to the connected output points
  21394. * @param state node material build state
  21395. * @param varName name of the variable to output
  21396. * @returns the shader code
  21397. */
  21398. writeOutputs(state: NodeMaterialBuildState, varName: string): string;
  21399. protected _buildBlock(state: NodeMaterialBuildState): this;
  21400. protected _dumpPropertiesCode(): string;
  21401. serialize(): any;
  21402. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  21403. }
  21404. }
  21405. declare module "babylonjs/Materials/Node/nodeMaterialConnectionPointCustomObject" {
  21406. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21407. import { NodeMaterialConnectionPoint, NodeMaterialConnectionPointDirection, NodeMaterialConnectionPointCompatibilityStates } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21408. import { Nullable } from "babylonjs/types";
  21409. /**
  21410. * Defines a connection point to be used for points with a custom object type
  21411. */
  21412. export class NodeMaterialConnectionPointCustomObject<T extends NodeMaterialBlock> extends NodeMaterialConnectionPoint {
  21413. private _blockType;
  21414. private _blockName;
  21415. private _nameForCheking?;
  21416. /**
  21417. * Creates a new connection point
  21418. * @param name defines the connection point name
  21419. * @param ownerBlock defines the block hosting this connection point
  21420. * @param direction defines the direction of the connection point
  21421. */
  21422. constructor(name: string, ownerBlock: NodeMaterialBlock, direction: NodeMaterialConnectionPointDirection, _blockType: new (...args: any[]) => T, _blockName: string, _nameForCheking?: string | undefined);
  21423. /**
  21424. * Gets a number indicating if the current point can be connected to another point
  21425. * @param connectionPoint defines the other connection point
  21426. * @returns a number defining the compatibility state
  21427. */
  21428. checkCompatibilityState(connectionPoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPointCompatibilityStates;
  21429. /**
  21430. * Creates a block suitable to be used as an input for this input point.
  21431. * If null is returned, a block based on the point type will be created.
  21432. * @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
  21433. */
  21434. createCustomInputBlock(): Nullable<[NodeMaterialBlock, string]>;
  21435. }
  21436. }
  21437. declare module "babylonjs/Materials/Node/nodeMaterialDecorator" {
  21438. /**
  21439. * Enum defining the type of properties that can be edited in the property pages in the NME
  21440. */
  21441. export enum PropertyTypeForEdition {
  21442. /** property is a boolean */
  21443. Boolean = 0,
  21444. /** property is a float */
  21445. Float = 1,
  21446. /** property is a Vector2 */
  21447. Vector2 = 2,
  21448. /** property is a list of values */
  21449. List = 3
  21450. }
  21451. /**
  21452. * Interface that defines an option in a variable of type list
  21453. */
  21454. export interface IEditablePropertyListOption {
  21455. /** label of the option */
  21456. "label": string;
  21457. /** value of the option */
  21458. "value": number;
  21459. }
  21460. /**
  21461. * Interface that defines the options available for an editable property
  21462. */
  21463. export interface IEditablePropertyOption {
  21464. /** min value */
  21465. "min"?: number;
  21466. /** max value */
  21467. "max"?: number;
  21468. /** notifiers: indicates which actions to take when the property is changed */
  21469. "notifiers"?: {
  21470. /** the material should be rebuilt */
  21471. "rebuild"?: boolean;
  21472. /** the preview should be updated */
  21473. "update"?: boolean;
  21474. };
  21475. /** list of the options for a variable of type list */
  21476. "options"?: IEditablePropertyListOption[];
  21477. }
  21478. /**
  21479. * Interface that describes an editable property
  21480. */
  21481. export interface IPropertyDescriptionForEdition {
  21482. /** name of the property */
  21483. "propertyName": string;
  21484. /** display name of the property */
  21485. "displayName": string;
  21486. /** type of the property */
  21487. "type": PropertyTypeForEdition;
  21488. /** group of the property - all properties with the same group value will be displayed in a specific section */
  21489. "groupName": string;
  21490. /** options for the property */
  21491. "options": IEditablePropertyOption;
  21492. }
  21493. /**
  21494. * Decorator that flags a property in a node material block as being editable
  21495. */
  21496. export function editableInPropertyPage(displayName: string, propertyType?: PropertyTypeForEdition, groupName?: string, options?: IEditablePropertyOption): (target: any, propertyKey: string) => void;
  21497. }
  21498. declare module "babylonjs/Materials/Node/Blocks/PBR/refractionBlock" {
  21499. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  21500. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21501. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  21502. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  21503. import { Nullable } from "babylonjs/types";
  21504. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  21505. import { Mesh } from "babylonjs/Meshes/mesh";
  21506. import { SubMesh } from "babylonjs/Meshes/subMesh";
  21507. import { Effect } from "babylonjs/Materials/effect";
  21508. import { Scene } from "babylonjs/scene";
  21509. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21510. /**
  21511. * Block used to implement the refraction part of the sub surface module of the PBR material
  21512. */
  21513. export class RefractionBlock extends NodeMaterialBlock {
  21514. /** @hidden */
  21515. _define3DName: string;
  21516. /** @hidden */
  21517. _refractionMatrixName: string;
  21518. /** @hidden */
  21519. _defineLODRefractionAlpha: string;
  21520. /** @hidden */
  21521. _defineLinearSpecularRefraction: string;
  21522. /** @hidden */
  21523. _defineOppositeZ: string;
  21524. /** @hidden */
  21525. _cubeSamplerName: string;
  21526. /** @hidden */
  21527. _2DSamplerName: string;
  21528. /** @hidden */
  21529. _vRefractionMicrosurfaceInfosName: string;
  21530. /** @hidden */
  21531. _vRefractionInfosName: string;
  21532. private _scene;
  21533. /**
  21534. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  21535. * Materials half opaque for instance using refraction could benefit from this control.
  21536. */
  21537. linkRefractionWithTransparency: boolean;
  21538. /**
  21539. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  21540. */
  21541. invertRefractionY: boolean;
  21542. /**
  21543. * Gets or sets the texture associated with the node
  21544. */
  21545. texture: Nullable<BaseTexture>;
  21546. /**
  21547. * Create a new RefractionBlock
  21548. * @param name defines the block name
  21549. */
  21550. constructor(name: string);
  21551. /**
  21552. * Gets the current class name
  21553. * @returns the class name
  21554. */
  21555. getClassName(): string;
  21556. /**
  21557. * Gets the intensity input component
  21558. */
  21559. get intensity(): NodeMaterialConnectionPoint;
  21560. /**
  21561. * Gets the index of refraction input component
  21562. */
  21563. get indexOfRefraction(): NodeMaterialConnectionPoint;
  21564. /**
  21565. * Gets the tint at distance input component
  21566. */
  21567. get tintAtDistance(): NodeMaterialConnectionPoint;
  21568. /**
  21569. * Gets the view input component
  21570. */
  21571. get view(): NodeMaterialConnectionPoint;
  21572. /**
  21573. * Gets the refraction object output component
  21574. */
  21575. get refraction(): NodeMaterialConnectionPoint;
  21576. /**
  21577. * Returns true if the block has a texture
  21578. */
  21579. get hasTexture(): boolean;
  21580. protected _getTexture(): Nullable<BaseTexture>;
  21581. autoConfigure(material: NodeMaterial): void;
  21582. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  21583. isReady(): boolean;
  21584. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  21585. /**
  21586. * Gets the main code of the block (fragment side)
  21587. * @param state current state of the node material building
  21588. * @returns the shader code
  21589. */
  21590. getCode(state: NodeMaterialBuildState): string;
  21591. protected _buildBlock(state: NodeMaterialBuildState): this;
  21592. protected _dumpPropertiesCode(): string;
  21593. serialize(): any;
  21594. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  21595. }
  21596. }
  21597. declare module "babylonjs/Materials/Node/Blocks/Dual/currentScreenBlock" {
  21598. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21599. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  21600. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  21601. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21602. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  21603. import { NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  21604. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  21605. import { Nullable } from "babylonjs/types";
  21606. import { Scene } from "babylonjs/scene";
  21607. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  21608. /**
  21609. * Base block used as input for post process
  21610. */
  21611. export class CurrentScreenBlock extends NodeMaterialBlock {
  21612. private _samplerName;
  21613. private _linearDefineName;
  21614. private _gammaDefineName;
  21615. private _mainUVName;
  21616. private _tempTextureRead;
  21617. /**
  21618. * Gets or sets the texture associated with the node
  21619. */
  21620. texture: Nullable<BaseTexture>;
  21621. /**
  21622. * Gets or sets a boolean indicating if content needs to be converted to gamma space
  21623. */
  21624. convertToGammaSpace: boolean;
  21625. /**
  21626. * Gets or sets a boolean indicating if content needs to be converted to linear space
  21627. */
  21628. convertToLinearSpace: boolean;
  21629. /**
  21630. * Create a new CurrentScreenBlock
  21631. * @param name defines the block name
  21632. */
  21633. constructor(name: string);
  21634. /**
  21635. * Gets the current class name
  21636. * @returns the class name
  21637. */
  21638. getClassName(): string;
  21639. /**
  21640. * Gets the uv input component
  21641. */
  21642. get uv(): NodeMaterialConnectionPoint;
  21643. /**
  21644. * Gets the rgba output component
  21645. */
  21646. get rgba(): NodeMaterialConnectionPoint;
  21647. /**
  21648. * Gets the rgb output component
  21649. */
  21650. get rgb(): NodeMaterialConnectionPoint;
  21651. /**
  21652. * Gets the r output component
  21653. */
  21654. get r(): NodeMaterialConnectionPoint;
  21655. /**
  21656. * Gets the g output component
  21657. */
  21658. get g(): NodeMaterialConnectionPoint;
  21659. /**
  21660. * Gets the b output component
  21661. */
  21662. get b(): NodeMaterialConnectionPoint;
  21663. /**
  21664. * Gets the a output component
  21665. */
  21666. get a(): NodeMaterialConnectionPoint;
  21667. /**
  21668. * Initialize the block and prepare the context for build
  21669. * @param state defines the state that will be used for the build
  21670. */
  21671. initialize(state: NodeMaterialBuildState): void;
  21672. get target(): NodeMaterialBlockTargets;
  21673. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  21674. isReady(): boolean;
  21675. private _injectVertexCode;
  21676. private _writeTextureRead;
  21677. private _writeOutput;
  21678. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  21679. serialize(): any;
  21680. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  21681. }
  21682. }
  21683. declare module "babylonjs/Materials/Node/Blocks/Particle/particleTextureBlock" {
  21684. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21685. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  21686. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21687. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  21688. import { NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  21689. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  21690. import { Nullable } from "babylonjs/types";
  21691. import { Scene } from "babylonjs/scene";
  21692. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  21693. /**
  21694. * Base block used for the particle texture
  21695. */
  21696. export class ParticleTextureBlock extends NodeMaterialBlock {
  21697. private _samplerName;
  21698. private _linearDefineName;
  21699. private _gammaDefineName;
  21700. private _tempTextureRead;
  21701. /**
  21702. * Gets or sets the texture associated with the node
  21703. */
  21704. texture: Nullable<BaseTexture>;
  21705. /**
  21706. * Gets or sets a boolean indicating if content needs to be converted to gamma space
  21707. */
  21708. convertToGammaSpace: boolean;
  21709. /**
  21710. * Gets or sets a boolean indicating if content needs to be converted to linear space
  21711. */
  21712. convertToLinearSpace: boolean;
  21713. /**
  21714. * Create a new ParticleTextureBlock
  21715. * @param name defines the block name
  21716. */
  21717. constructor(name: string);
  21718. /**
  21719. * Gets the current class name
  21720. * @returns the class name
  21721. */
  21722. getClassName(): string;
  21723. /**
  21724. * Gets the uv input component
  21725. */
  21726. get uv(): NodeMaterialConnectionPoint;
  21727. /**
  21728. * Gets the rgba output component
  21729. */
  21730. get rgba(): NodeMaterialConnectionPoint;
  21731. /**
  21732. * Gets the rgb output component
  21733. */
  21734. get rgb(): NodeMaterialConnectionPoint;
  21735. /**
  21736. * Gets the r output component
  21737. */
  21738. get r(): NodeMaterialConnectionPoint;
  21739. /**
  21740. * Gets the g output component
  21741. */
  21742. get g(): NodeMaterialConnectionPoint;
  21743. /**
  21744. * Gets the b output component
  21745. */
  21746. get b(): NodeMaterialConnectionPoint;
  21747. /**
  21748. * Gets the a output component
  21749. */
  21750. get a(): NodeMaterialConnectionPoint;
  21751. /**
  21752. * Initialize the block and prepare the context for build
  21753. * @param state defines the state that will be used for the build
  21754. */
  21755. initialize(state: NodeMaterialBuildState): void;
  21756. autoConfigure(material: NodeMaterial): void;
  21757. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  21758. isReady(): boolean;
  21759. private _writeOutput;
  21760. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  21761. serialize(): any;
  21762. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  21763. }
  21764. }
  21765. declare module "babylonjs/Materials/Node/nodeMaterialBuildStateSharedData" {
  21766. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21767. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21768. import { InputBlock } from "babylonjs/Materials/Node/Blocks/Input/inputBlock";
  21769. import { TextureBlock } from "babylonjs/Materials/Node/Blocks/Dual/textureBlock";
  21770. import { ReflectionTextureBaseBlock } from "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBaseBlock";
  21771. import { RefractionBlock } from "babylonjs/Materials/Node/Blocks/PBR/refractionBlock";
  21772. import { CurrentScreenBlock } from "babylonjs/Materials/Node/Blocks/Dual/currentScreenBlock";
  21773. import { ParticleTextureBlock } from "babylonjs/Materials/Node/Blocks/Particle/particleTextureBlock";
  21774. import { Scene } from "babylonjs/scene";
  21775. /**
  21776. * Class used to store shared data between 2 NodeMaterialBuildState
  21777. */
  21778. export class NodeMaterialBuildStateSharedData {
  21779. /**
  21780. * Gets the list of emitted varyings
  21781. */
  21782. temps: string[];
  21783. /**
  21784. * Gets the list of emitted varyings
  21785. */
  21786. varyings: string[];
  21787. /**
  21788. * Gets the varying declaration string
  21789. */
  21790. varyingDeclaration: string;
  21791. /**
  21792. * Input blocks
  21793. */
  21794. inputBlocks: InputBlock[];
  21795. /**
  21796. * Input blocks
  21797. */
  21798. textureBlocks: (TextureBlock | ReflectionTextureBaseBlock | RefractionBlock | CurrentScreenBlock | ParticleTextureBlock)[];
  21799. /**
  21800. * Bindable blocks (Blocks that need to set data to the effect)
  21801. */
  21802. bindableBlocks: NodeMaterialBlock[];
  21803. /**
  21804. * List of blocks that can provide a compilation fallback
  21805. */
  21806. blocksWithFallbacks: NodeMaterialBlock[];
  21807. /**
  21808. * List of blocks that can provide a define update
  21809. */
  21810. blocksWithDefines: NodeMaterialBlock[];
  21811. /**
  21812. * List of blocks that can provide a repeatable content
  21813. */
  21814. repeatableContentBlocks: NodeMaterialBlock[];
  21815. /**
  21816. * List of blocks that can provide a dynamic list of uniforms
  21817. */
  21818. dynamicUniformBlocks: NodeMaterialBlock[];
  21819. /**
  21820. * List of blocks that can block the isReady function for the material
  21821. */
  21822. blockingBlocks: NodeMaterialBlock[];
  21823. /**
  21824. * Gets the list of animated inputs
  21825. */
  21826. animatedInputs: InputBlock[];
  21827. /**
  21828. * Build Id used to avoid multiple recompilations
  21829. */
  21830. buildId: number;
  21831. /** List of emitted variables */
  21832. variableNames: {
  21833. [key: string]: number;
  21834. };
  21835. /** List of emitted defines */
  21836. defineNames: {
  21837. [key: string]: number;
  21838. };
  21839. /** Should emit comments? */
  21840. emitComments: boolean;
  21841. /** Emit build activity */
  21842. verbose: boolean;
  21843. /** Gets or sets the hosting scene */
  21844. scene: Scene;
  21845. /**
  21846. * Gets the compilation hints emitted at compilation time
  21847. */
  21848. hints: {
  21849. needWorldViewMatrix: boolean;
  21850. needWorldViewProjectionMatrix: boolean;
  21851. needAlphaBlending: boolean;
  21852. needAlphaTesting: boolean;
  21853. };
  21854. /**
  21855. * List of compilation checks
  21856. */
  21857. checks: {
  21858. emitVertex: boolean;
  21859. emitFragment: boolean;
  21860. notConnectedNonOptionalInputs: NodeMaterialConnectionPoint[];
  21861. };
  21862. /**
  21863. * Is vertex program allowed to be empty?
  21864. */
  21865. allowEmptyVertexProgram: boolean;
  21866. /** Creates a new shared data */
  21867. constructor();
  21868. /**
  21869. * Emits console errors and exceptions if there is a failing check
  21870. */
  21871. emitErrors(): void;
  21872. }
  21873. }
  21874. declare module "babylonjs/Materials/Node/nodeMaterialBuildState" {
  21875. import { NodeMaterialBlockConnectionPointTypes } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  21876. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  21877. import { NodeMaterialBuildStateSharedData } from "babylonjs/Materials/Node/nodeMaterialBuildStateSharedData";
  21878. /**
  21879. * Class used to store node based material build state
  21880. */
  21881. export class NodeMaterialBuildState {
  21882. /** Gets or sets a boolean indicating if the current state can emit uniform buffers */
  21883. supportUniformBuffers: boolean;
  21884. /**
  21885. * Gets the list of emitted attributes
  21886. */
  21887. attributes: string[];
  21888. /**
  21889. * Gets the list of emitted uniforms
  21890. */
  21891. uniforms: string[];
  21892. /**
  21893. * Gets the list of emitted constants
  21894. */
  21895. constants: string[];
  21896. /**
  21897. * Gets the list of emitted samplers
  21898. */
  21899. samplers: string[];
  21900. /**
  21901. * Gets the list of emitted functions
  21902. */
  21903. functions: {
  21904. [key: string]: string;
  21905. };
  21906. /**
  21907. * Gets the list of emitted extensions
  21908. */
  21909. extensions: {
  21910. [key: string]: string;
  21911. };
  21912. /**
  21913. * Gets the target of the compilation state
  21914. */
  21915. target: NodeMaterialBlockTargets;
  21916. /**
  21917. * Gets the list of emitted counters
  21918. */
  21919. counters: {
  21920. [key: string]: number;
  21921. };
  21922. /**
  21923. * Shared data between multiple NodeMaterialBuildState instances
  21924. */
  21925. sharedData: NodeMaterialBuildStateSharedData;
  21926. /** @hidden */
  21927. _vertexState: NodeMaterialBuildState;
  21928. /** @hidden */
  21929. _attributeDeclaration: string;
  21930. /** @hidden */
  21931. _uniformDeclaration: string;
  21932. /** @hidden */
  21933. _constantDeclaration: string;
  21934. /** @hidden */
  21935. _samplerDeclaration: string;
  21936. /** @hidden */
  21937. _varyingTransfer: string;
  21938. /** @hidden */
  21939. _injectAtEnd: string;
  21940. private _repeatableContentAnchorIndex;
  21941. /** @hidden */
  21942. _builtCompilationString: string;
  21943. /**
  21944. * Gets the emitted compilation strings
  21945. */
  21946. compilationString: string;
  21947. /**
  21948. * Finalize the compilation strings
  21949. * @param state defines the current compilation state
  21950. */
  21951. finalize(state: NodeMaterialBuildState): void;
  21952. /** @hidden */
  21953. get _repeatableContentAnchor(): string;
  21954. /** @hidden */
  21955. _getFreeVariableName(prefix: string): string;
  21956. /** @hidden */
  21957. _getFreeDefineName(prefix: string): string;
  21958. /** @hidden */
  21959. _excludeVariableName(name: string): void;
  21960. /** @hidden */
  21961. _emit2DSampler(name: string): void;
  21962. /** @hidden */
  21963. _getGLType(type: NodeMaterialBlockConnectionPointTypes): string;
  21964. /** @hidden */
  21965. _emitExtension(name: string, extension: string, define?: string): void;
  21966. /** @hidden */
  21967. _emitFunction(name: string, code: string, comments: string): void;
  21968. /** @hidden */
  21969. _emitCodeFromInclude(includeName: string, comments: string, options?: {
  21970. replaceStrings?: {
  21971. search: RegExp;
  21972. replace: string;
  21973. }[];
  21974. repeatKey?: string;
  21975. }): string;
  21976. /** @hidden */
  21977. _emitFunctionFromInclude(includeName: string, comments: string, options?: {
  21978. repeatKey?: string;
  21979. removeAttributes?: boolean;
  21980. removeUniforms?: boolean;
  21981. removeVaryings?: boolean;
  21982. removeIfDef?: boolean;
  21983. replaceStrings?: {
  21984. search: RegExp;
  21985. replace: string;
  21986. }[];
  21987. }, storeKey?: string): void;
  21988. /** @hidden */
  21989. _registerTempVariable(name: string): boolean;
  21990. /** @hidden */
  21991. _emitVaryingFromString(name: string, type: string, define?: string, notDefine?: boolean): boolean;
  21992. /** @hidden */
  21993. _emitUniformFromString(name: string, type: string, define?: string, notDefine?: boolean): void;
  21994. /** @hidden */
  21995. _emitFloat(value: number): string;
  21996. }
  21997. }
  21998. declare module "babylonjs/Misc/uniqueIdGenerator" {
  21999. /**
  22000. * Helper class used to generate session unique ID
  22001. */
  22002. export class UniqueIdGenerator {
  22003. private static _UniqueIdCounter;
  22004. /**
  22005. * Gets an unique (relatively to the current scene) Id
  22006. */
  22007. static get UniqueId(): number;
  22008. }
  22009. }
  22010. declare module "babylonjs/Materials/Node/nodeMaterialBlock" {
  22011. import { NodeMaterialBlockConnectionPointTypes } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  22012. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22013. import { Nullable } from "babylonjs/types";
  22014. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22015. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  22016. import { Effect } from "babylonjs/Materials/effect";
  22017. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  22018. import { Mesh } from "babylonjs/Meshes/mesh";
  22019. import { SubMesh } from "babylonjs/Meshes/subMesh";
  22020. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  22021. import { Scene } from "babylonjs/scene";
  22022. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  22023. /**
  22024. * Defines a block that can be used inside a node based material
  22025. */
  22026. export class NodeMaterialBlock {
  22027. private _buildId;
  22028. private _buildTarget;
  22029. private _target;
  22030. private _isFinalMerger;
  22031. private _isInput;
  22032. private _name;
  22033. protected _isUnique: boolean;
  22034. /** Gets or sets a boolean indicating that only one input can be connected at a time */
  22035. inputsAreExclusive: boolean;
  22036. /** @hidden */
  22037. _codeVariableName: string;
  22038. /** @hidden */
  22039. _inputs: NodeMaterialConnectionPoint[];
  22040. /** @hidden */
  22041. _outputs: NodeMaterialConnectionPoint[];
  22042. /** @hidden */
  22043. _preparationId: number;
  22044. /**
  22045. * Gets the name of the block
  22046. */
  22047. get name(): string;
  22048. /**
  22049. * Sets the name of the block. Will check if the name is valid.
  22050. */
  22051. set name(newName: string);
  22052. /**
  22053. * Gets or sets the unique id of the node
  22054. */
  22055. uniqueId: number;
  22056. /**
  22057. * Gets or sets the comments associated with this block
  22058. */
  22059. comments: string;
  22060. /**
  22061. * Gets a boolean indicating that this block can only be used once per NodeMaterial
  22062. */
  22063. get isUnique(): boolean;
  22064. /**
  22065. * Gets a boolean indicating that this block is an end block (e.g. it is generating a system value)
  22066. */
  22067. get isFinalMerger(): boolean;
  22068. /**
  22069. * Gets a boolean indicating that this block is an input (e.g. it sends data to the shader)
  22070. */
  22071. get isInput(): boolean;
  22072. /**
  22073. * Gets or sets the build Id
  22074. */
  22075. get buildId(): number;
  22076. set buildId(value: number);
  22077. /**
  22078. * Gets or sets the target of the block
  22079. */
  22080. get target(): NodeMaterialBlockTargets;
  22081. set target(value: NodeMaterialBlockTargets);
  22082. /**
  22083. * Gets the list of input points
  22084. */
  22085. get inputs(): NodeMaterialConnectionPoint[];
  22086. /** Gets the list of output points */
  22087. get outputs(): NodeMaterialConnectionPoint[];
  22088. /**
  22089. * Find an input by its name
  22090. * @param name defines the name of the input to look for
  22091. * @returns the input or null if not found
  22092. */
  22093. getInputByName(name: string): Nullable<NodeMaterialConnectionPoint>;
  22094. /**
  22095. * Find an output by its name
  22096. * @param name defines the name of the outputto look for
  22097. * @returns the output or null if not found
  22098. */
  22099. getOutputByName(name: string): Nullable<NodeMaterialConnectionPoint>;
  22100. /**
  22101. * Creates a new NodeMaterialBlock
  22102. * @param name defines the block name
  22103. * @param target defines the target of that block (Vertex by default)
  22104. * @param isFinalMerger defines a boolean indicating that this block is an end block (e.g. it is generating a system value). Default is false
  22105. * @param isInput defines a boolean indicating that this block is an input (e.g. it sends data to the shader). Default is false
  22106. */
  22107. constructor(name: string, target?: NodeMaterialBlockTargets, isFinalMerger?: boolean, isInput?: boolean);
  22108. /**
  22109. * Initialize the block and prepare the context for build
  22110. * @param state defines the state that will be used for the build
  22111. */
  22112. initialize(state: NodeMaterialBuildState): void;
  22113. /**
  22114. * Bind data to effect. Will only be called for blocks with isBindable === true
  22115. * @param effect defines the effect to bind data to
  22116. * @param nodeMaterial defines the hosting NodeMaterial
  22117. * @param mesh defines the mesh that will be rendered
  22118. * @param subMesh defines the submesh that will be rendered
  22119. */
  22120. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  22121. protected _declareOutput(output: NodeMaterialConnectionPoint, state: NodeMaterialBuildState): string;
  22122. protected _writeVariable(currentPoint: NodeMaterialConnectionPoint): string;
  22123. protected _writeFloat(value: number): string;
  22124. /**
  22125. * Gets the current class name e.g. "NodeMaterialBlock"
  22126. * @returns the class name
  22127. */
  22128. getClassName(): string;
  22129. /**
  22130. * Register a new input. Must be called inside a block constructor
  22131. * @param name defines the connection point name
  22132. * @param type defines the connection point type
  22133. * @param isOptional defines a boolean indicating that this input can be omitted
  22134. * @param target defines the target to use to limit the connection point (will be VertexAndFragment by default)
  22135. * @param point an already created connection point. If not provided, create a new one
  22136. * @returns the current block
  22137. */
  22138. registerInput(name: string, type: NodeMaterialBlockConnectionPointTypes, isOptional?: boolean, target?: NodeMaterialBlockTargets, point?: NodeMaterialConnectionPoint): this;
  22139. /**
  22140. * Register a new output. Must be called inside a block constructor
  22141. * @param name defines the connection point name
  22142. * @param type defines the connection point type
  22143. * @param target defines the target to use to limit the connection point (will be VertexAndFragment by default)
  22144. * @param point an already created connection point. If not provided, create a new one
  22145. * @returns the current block
  22146. */
  22147. registerOutput(name: string, type: NodeMaterialBlockConnectionPointTypes, target?: NodeMaterialBlockTargets, point?: NodeMaterialConnectionPoint): this;
  22148. /**
  22149. * Will return the first available input e.g. the first one which is not an uniform or an attribute
  22150. * @param forOutput defines an optional connection point to check compatibility with
  22151. * @returns the first available input or null
  22152. */
  22153. getFirstAvailableInput(forOutput?: Nullable<NodeMaterialConnectionPoint>): Nullable<NodeMaterialConnectionPoint>;
  22154. /**
  22155. * Will return the first available output e.g. the first one which is not yet connected and not a varying
  22156. * @param forBlock defines an optional block to check compatibility with
  22157. * @returns the first available input or null
  22158. */
  22159. getFirstAvailableOutput(forBlock?: Nullable<NodeMaterialBlock>): Nullable<NodeMaterialConnectionPoint>;
  22160. /**
  22161. * Gets the sibling of the given output
  22162. * @param current defines the current output
  22163. * @returns the next output in the list or null
  22164. */
  22165. getSiblingOutput(current: NodeMaterialConnectionPoint): Nullable<NodeMaterialConnectionPoint>;
  22166. /**
  22167. * Connect current block with another block
  22168. * @param other defines the block to connect with
  22169. * @param options define the various options to help pick the right connections
  22170. * @returns the current block
  22171. */
  22172. connectTo(other: NodeMaterialBlock, options?: {
  22173. input?: string;
  22174. output?: string;
  22175. outputSwizzle?: string;
  22176. }): this | undefined;
  22177. protected _buildBlock(state: NodeMaterialBuildState): void;
  22178. /**
  22179. * Add uniforms, samplers and uniform buffers at compilation time
  22180. * @param state defines the state to update
  22181. * @param nodeMaterial defines the node material requesting the update
  22182. * @param defines defines the material defines to update
  22183. * @param uniformBuffers defines the list of uniform buffer names
  22184. */
  22185. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  22186. /**
  22187. * Add potential fallbacks if shader compilation fails
  22188. * @param mesh defines the mesh to be rendered
  22189. * @param fallbacks defines the current prioritized list of fallbacks
  22190. */
  22191. provideFallbacks(mesh: AbstractMesh, fallbacks: EffectFallbacks): void;
  22192. /**
  22193. * Initialize defines for shader compilation
  22194. * @param mesh defines the mesh to be rendered
  22195. * @param nodeMaterial defines the node material requesting the update
  22196. * @param defines defines the material defines to update
  22197. * @param useInstances specifies that instances should be used
  22198. */
  22199. initializeDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  22200. /**
  22201. * Update defines for shader compilation
  22202. * @param mesh defines the mesh to be rendered
  22203. * @param nodeMaterial defines the node material requesting the update
  22204. * @param defines defines the material defines to update
  22205. * @param useInstances specifies that instances should be used
  22206. * @param subMesh defines which submesh to render
  22207. */
  22208. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean, subMesh?: SubMesh): void;
  22209. /**
  22210. * Lets the block try to connect some inputs automatically
  22211. * @param material defines the hosting NodeMaterial
  22212. */
  22213. autoConfigure(material: NodeMaterial): void;
  22214. /**
  22215. * Function called when a block is declared as repeatable content generator
  22216. * @param vertexShaderState defines the current compilation state for the vertex shader
  22217. * @param fragmentShaderState defines the current compilation state for the fragment shader
  22218. * @param mesh defines the mesh to be rendered
  22219. * @param defines defines the material defines to update
  22220. */
  22221. replaceRepeatableContent(vertexShaderState: NodeMaterialBuildState, fragmentShaderState: NodeMaterialBuildState, mesh: AbstractMesh, defines: NodeMaterialDefines): void;
  22222. /**
  22223. * Checks if the block is ready
  22224. * @param mesh defines the mesh to be rendered
  22225. * @param nodeMaterial defines the node material requesting the update
  22226. * @param defines defines the material defines to update
  22227. * @param useInstances specifies that instances should be used
  22228. * @returns true if the block is ready
  22229. */
  22230. isReady(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): boolean;
  22231. protected _linkConnectionTypes(inputIndex0: number, inputIndex1: number): void;
  22232. private _processBuild;
  22233. /**
  22234. * Validates the new name for the block node.
  22235. * @param newName the new name to be given to the node.
  22236. * @returns false if the name is a reserve word, else true.
  22237. */
  22238. validateBlockName(newName: string): boolean;
  22239. /**
  22240. * Compile the current node and generate the shader code
  22241. * @param state defines the current compilation state (uniforms, samplers, current string)
  22242. * @param activeBlocks defines the list of active blocks (i.e. blocks to compile)
  22243. * @returns true if already built
  22244. */
  22245. build(state: NodeMaterialBuildState, activeBlocks: NodeMaterialBlock[]): boolean;
  22246. protected _inputRename(name: string): string;
  22247. protected _outputRename(name: string): string;
  22248. protected _dumpPropertiesCode(): string;
  22249. /** @hidden */
  22250. _dumpCode(uniqueNames: string[], alreadyDumped: NodeMaterialBlock[]): string;
  22251. /** @hidden */
  22252. _dumpCodeForOutputConnections(alreadyDumped: NodeMaterialBlock[]): string;
  22253. /**
  22254. * Clone the current block to a new identical block
  22255. * @param scene defines the hosting scene
  22256. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  22257. * @returns a copy of the current block
  22258. */
  22259. clone(scene: Scene, rootUrl?: string): Nullable<NodeMaterialBlock>;
  22260. /**
  22261. * Serializes this block in a JSON representation
  22262. * @returns the serialized block object
  22263. */
  22264. serialize(): any;
  22265. /** @hidden */
  22266. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  22267. private _deserializePortDisplayNamesAndExposedOnFrame;
  22268. /**
  22269. * Release resources
  22270. */
  22271. dispose(): void;
  22272. }
  22273. }
  22274. declare module "babylonjs/Materials/pushMaterial" {
  22275. import { Nullable } from "babylonjs/types";
  22276. import { Scene } from "babylonjs/scene";
  22277. import { Matrix } from "babylonjs/Maths/math.vector";
  22278. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  22279. import { Mesh } from "babylonjs/Meshes/mesh";
  22280. import { Material } from "babylonjs/Materials/material";
  22281. import { Effect } from "babylonjs/Materials/effect";
  22282. import { SubMesh } from "babylonjs/Meshes/subMesh";
  22283. /**
  22284. * Base class of materials working in push mode in babylon JS
  22285. * @hidden
  22286. */
  22287. export class PushMaterial extends Material {
  22288. protected _activeEffect: Effect;
  22289. protected _normalMatrix: Matrix;
  22290. constructor(name: string, scene: Scene);
  22291. getEffect(): Effect;
  22292. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  22293. protected _isReadyForSubMesh(subMesh: SubMesh): boolean;
  22294. /**
  22295. * Binds the given world matrix to the active effect
  22296. *
  22297. * @param world the matrix to bind
  22298. */
  22299. bindOnlyWorldMatrix(world: Matrix): void;
  22300. /**
  22301. * Binds the given normal matrix to the active effect
  22302. *
  22303. * @param normalMatrix the matrix to bind
  22304. */
  22305. bindOnlyNormalMatrix(normalMatrix: Matrix): void;
  22306. bind(world: Matrix, mesh?: Mesh): void;
  22307. protected _afterBind(mesh: Mesh, effect?: Nullable<Effect>): void;
  22308. protected _mustRebind(scene: Scene, effect: Effect, visibility?: number): boolean;
  22309. }
  22310. }
  22311. declare module "babylonjs/Materials/Node/Optimizers/nodeMaterialOptimizer" {
  22312. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22313. /**
  22314. * Root class for all node material optimizers
  22315. */
  22316. export class NodeMaterialOptimizer {
  22317. /**
  22318. * Function used to optimize a NodeMaterial graph
  22319. * @param vertexOutputNodes defines the list of output nodes for the vertex shader
  22320. * @param fragmentOutputNodes defines the list of output nodes for the fragment shader
  22321. */
  22322. optimize(vertexOutputNodes: NodeMaterialBlock[], fragmentOutputNodes: NodeMaterialBlock[]): void;
  22323. }
  22324. }
  22325. declare module "babylonjs/Materials/Node/Blocks/transformBlock" {
  22326. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22327. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22328. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22329. import { Scene } from "babylonjs/scene";
  22330. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  22331. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  22332. import { SubMesh } from "babylonjs/Meshes/subMesh";
  22333. /**
  22334. * Block used to transform a vector (2, 3 or 4) with a matrix. It will generate a Vector4
  22335. */
  22336. export class TransformBlock extends NodeMaterialBlock {
  22337. /**
  22338. * Defines the value to use to complement W value to transform it to a Vector4
  22339. */
  22340. complementW: number;
  22341. /**
  22342. * Defines the value to use to complement z value to transform it to a Vector4
  22343. */
  22344. complementZ: number;
  22345. /**
  22346. * Creates a new TransformBlock
  22347. * @param name defines the block name
  22348. */
  22349. constructor(name: string);
  22350. /**
  22351. * Gets the current class name
  22352. * @returns the class name
  22353. */
  22354. getClassName(): string;
  22355. /**
  22356. * Gets the vector input
  22357. */
  22358. get vector(): NodeMaterialConnectionPoint;
  22359. /**
  22360. * Gets the output component
  22361. */
  22362. get output(): NodeMaterialConnectionPoint;
  22363. /**
  22364. * Gets the xyz output component
  22365. */
  22366. get xyz(): NodeMaterialConnectionPoint;
  22367. /**
  22368. * Gets the matrix transform input
  22369. */
  22370. get transform(): NodeMaterialConnectionPoint;
  22371. protected _buildBlock(state: NodeMaterialBuildState): this;
  22372. /**
  22373. * Update defines for shader compilation
  22374. * @param mesh defines the mesh to be rendered
  22375. * @param nodeMaterial defines the node material requesting the update
  22376. * @param defines defines the material defines to update
  22377. * @param useInstances specifies that instances should be used
  22378. * @param subMesh defines which submesh to render
  22379. */
  22380. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean, subMesh?: SubMesh): void;
  22381. serialize(): any;
  22382. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  22383. protected _dumpPropertiesCode(): string;
  22384. }
  22385. }
  22386. declare module "babylonjs/Materials/Node/Blocks/Vertex/vertexOutputBlock" {
  22387. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22388. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22389. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22390. /**
  22391. * Block used to output the vertex position
  22392. */
  22393. export class VertexOutputBlock extends NodeMaterialBlock {
  22394. /**
  22395. * Creates a new VertexOutputBlock
  22396. * @param name defines the block name
  22397. */
  22398. constructor(name: string);
  22399. /**
  22400. * Gets the current class name
  22401. * @returns the class name
  22402. */
  22403. getClassName(): string;
  22404. /**
  22405. * Gets the vector input component
  22406. */
  22407. get vector(): NodeMaterialConnectionPoint;
  22408. protected _buildBlock(state: NodeMaterialBuildState): this;
  22409. }
  22410. }
  22411. declare module "babylonjs/Materials/Node/Blocks/Fragment/fragmentOutputBlock" {
  22412. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22413. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22414. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22415. /**
  22416. * Block used to output the final color
  22417. */
  22418. export class FragmentOutputBlock extends NodeMaterialBlock {
  22419. /**
  22420. * Create a new FragmentOutputBlock
  22421. * @param name defines the block name
  22422. */
  22423. constructor(name: string);
  22424. /**
  22425. * Gets the current class name
  22426. * @returns the class name
  22427. */
  22428. getClassName(): string;
  22429. /**
  22430. * Gets the rgba input component
  22431. */
  22432. get rgba(): NodeMaterialConnectionPoint;
  22433. /**
  22434. * Gets the rgb input component
  22435. */
  22436. get rgb(): NodeMaterialConnectionPoint;
  22437. /**
  22438. * Gets the a input component
  22439. */
  22440. get a(): NodeMaterialConnectionPoint;
  22441. protected _buildBlock(state: NodeMaterialBuildState): this;
  22442. }
  22443. }
  22444. declare module "babylonjs/Materials/Node/Blocks/Particle/particleRampGradientBlock" {
  22445. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22446. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22447. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22448. /**
  22449. * Block used for the particle ramp gradient section
  22450. */
  22451. export class ParticleRampGradientBlock extends NodeMaterialBlock {
  22452. /**
  22453. * Create a new ParticleRampGradientBlock
  22454. * @param name defines the block name
  22455. */
  22456. constructor(name: string);
  22457. /**
  22458. * Gets the current class name
  22459. * @returns the class name
  22460. */
  22461. getClassName(): string;
  22462. /**
  22463. * Gets the color input component
  22464. */
  22465. get color(): NodeMaterialConnectionPoint;
  22466. /**
  22467. * Gets the rampColor output component
  22468. */
  22469. get rampColor(): NodeMaterialConnectionPoint;
  22470. /**
  22471. * Initialize the block and prepare the context for build
  22472. * @param state defines the state that will be used for the build
  22473. */
  22474. initialize(state: NodeMaterialBuildState): void;
  22475. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  22476. }
  22477. }
  22478. declare module "babylonjs/Materials/Node/Blocks/Particle/particleBlendMultiplyBlock" {
  22479. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22480. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22481. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22482. /**
  22483. * Block used for the particle blend multiply section
  22484. */
  22485. export class ParticleBlendMultiplyBlock extends NodeMaterialBlock {
  22486. /**
  22487. * Create a new ParticleBlendMultiplyBlock
  22488. * @param name defines the block name
  22489. */
  22490. constructor(name: string);
  22491. /**
  22492. * Gets the current class name
  22493. * @returns the class name
  22494. */
  22495. getClassName(): string;
  22496. /**
  22497. * Gets the color input component
  22498. */
  22499. get color(): NodeMaterialConnectionPoint;
  22500. /**
  22501. * Gets the alphaTexture input component
  22502. */
  22503. get alphaTexture(): NodeMaterialConnectionPoint;
  22504. /**
  22505. * Gets the alphaColor input component
  22506. */
  22507. get alphaColor(): NodeMaterialConnectionPoint;
  22508. /**
  22509. * Gets the blendColor output component
  22510. */
  22511. get blendColor(): NodeMaterialConnectionPoint;
  22512. /**
  22513. * Initialize the block and prepare the context for build
  22514. * @param state defines the state that will be used for the build
  22515. */
  22516. initialize(state: NodeMaterialBuildState): void;
  22517. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  22518. }
  22519. }
  22520. declare module "babylonjs/Materials/Node/Blocks/vectorMergerBlock" {
  22521. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22522. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22523. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22524. /**
  22525. * Block used to create a Vector2/3/4 out of individual inputs (one for each component)
  22526. */
  22527. export class VectorMergerBlock extends NodeMaterialBlock {
  22528. /**
  22529. * Create a new VectorMergerBlock
  22530. * @param name defines the block name
  22531. */
  22532. constructor(name: string);
  22533. /**
  22534. * Gets the current class name
  22535. * @returns the class name
  22536. */
  22537. getClassName(): string;
  22538. /**
  22539. * Gets the xyz component (input)
  22540. */
  22541. get xyzIn(): NodeMaterialConnectionPoint;
  22542. /**
  22543. * Gets the xy component (input)
  22544. */
  22545. get xyIn(): NodeMaterialConnectionPoint;
  22546. /**
  22547. * Gets the x component (input)
  22548. */
  22549. get x(): NodeMaterialConnectionPoint;
  22550. /**
  22551. * Gets the y component (input)
  22552. */
  22553. get y(): NodeMaterialConnectionPoint;
  22554. /**
  22555. * Gets the z component (input)
  22556. */
  22557. get z(): NodeMaterialConnectionPoint;
  22558. /**
  22559. * Gets the w component (input)
  22560. */
  22561. get w(): NodeMaterialConnectionPoint;
  22562. /**
  22563. * Gets the xyzw component (output)
  22564. */
  22565. get xyzw(): NodeMaterialConnectionPoint;
  22566. /**
  22567. * Gets the xyz component (output)
  22568. */
  22569. get xyzOut(): NodeMaterialConnectionPoint;
  22570. /**
  22571. * Gets the xy component (output)
  22572. */
  22573. get xyOut(): NodeMaterialConnectionPoint;
  22574. /**
  22575. * Gets the xy component (output)
  22576. * @deprecated Please use xyOut instead.
  22577. */
  22578. get xy(): NodeMaterialConnectionPoint;
  22579. /**
  22580. * Gets the xyz component (output)
  22581. * @deprecated Please use xyzOut instead.
  22582. */
  22583. get xyz(): NodeMaterialConnectionPoint;
  22584. protected _buildBlock(state: NodeMaterialBuildState): this;
  22585. }
  22586. }
  22587. declare module "babylonjs/Materials/Node/Blocks/remapBlock" {
  22588. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22589. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22590. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22591. import { Vector2 } from "babylonjs/Maths/math.vector";
  22592. import { Scene } from "babylonjs/scene";
  22593. /**
  22594. * Block used to remap a float from a range to a new one
  22595. */
  22596. export class RemapBlock extends NodeMaterialBlock {
  22597. /**
  22598. * Gets or sets the source range
  22599. */
  22600. sourceRange: Vector2;
  22601. /**
  22602. * Gets or sets the target range
  22603. */
  22604. targetRange: Vector2;
  22605. /**
  22606. * Creates a new RemapBlock
  22607. * @param name defines the block name
  22608. */
  22609. constructor(name: string);
  22610. /**
  22611. * Gets the current class name
  22612. * @returns the class name
  22613. */
  22614. getClassName(): string;
  22615. /**
  22616. * Gets the input component
  22617. */
  22618. get input(): NodeMaterialConnectionPoint;
  22619. /**
  22620. * Gets the source min input component
  22621. */
  22622. get sourceMin(): NodeMaterialConnectionPoint;
  22623. /**
  22624. * Gets the source max input component
  22625. */
  22626. get sourceMax(): NodeMaterialConnectionPoint;
  22627. /**
  22628. * Gets the target min input component
  22629. */
  22630. get targetMin(): NodeMaterialConnectionPoint;
  22631. /**
  22632. * Gets the target max input component
  22633. */
  22634. get targetMax(): NodeMaterialConnectionPoint;
  22635. /**
  22636. * Gets the output component
  22637. */
  22638. get output(): NodeMaterialConnectionPoint;
  22639. protected _buildBlock(state: NodeMaterialBuildState): this;
  22640. protected _dumpPropertiesCode(): string;
  22641. serialize(): any;
  22642. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  22643. }
  22644. }
  22645. declare module "babylonjs/Materials/Node/Blocks/multiplyBlock" {
  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 multiply 2 values
  22651. */
  22652. export class MultiplyBlock extends NodeMaterialBlock {
  22653. /**
  22654. * Creates a new MultiplyBlock
  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 left operand input component
  22665. */
  22666. get left(): NodeMaterialConnectionPoint;
  22667. /**
  22668. * Gets the right operand input component
  22669. */
  22670. get right(): NodeMaterialConnectionPoint;
  22671. /**
  22672. * Gets the output component
  22673. */
  22674. get output(): NodeMaterialConnectionPoint;
  22675. protected _buildBlock(state: NodeMaterialBuildState): this;
  22676. }
  22677. }
  22678. declare module "babylonjs/Materials/Node/Blocks/colorSplitterBlock" {
  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 to expand a Color3/4 into 4 outputs (one for each component)
  22684. */
  22685. export class ColorSplitterBlock extends NodeMaterialBlock {
  22686. /**
  22687. * Create a new ColorSplitterBlock
  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 rgba component (input)
  22698. */
  22699. get rgba(): NodeMaterialConnectionPoint;
  22700. /**
  22701. * Gets the rgb component (input)
  22702. */
  22703. get rgbIn(): NodeMaterialConnectionPoint;
  22704. /**
  22705. * Gets the rgb component (output)
  22706. */
  22707. get rgbOut(): NodeMaterialConnectionPoint;
  22708. /**
  22709. * Gets the r component (output)
  22710. */
  22711. get r(): NodeMaterialConnectionPoint;
  22712. /**
  22713. * Gets the g component (output)
  22714. */
  22715. get g(): NodeMaterialConnectionPoint;
  22716. /**
  22717. * Gets the b component (output)
  22718. */
  22719. get b(): NodeMaterialConnectionPoint;
  22720. /**
  22721. * Gets the a component (output)
  22722. */
  22723. get a(): NodeMaterialConnectionPoint;
  22724. protected _inputRename(name: string): string;
  22725. protected _outputRename(name: string): string;
  22726. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  22727. }
  22728. }
  22729. declare module "babylonjs/Materials/Node/nodeMaterial" {
  22730. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22731. import { PushMaterial } from "babylonjs/Materials/pushMaterial";
  22732. import { Scene } from "babylonjs/scene";
  22733. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  22734. import { Matrix } from "babylonjs/Maths/math.vector";
  22735. import { Mesh } from "babylonjs/Meshes/mesh";
  22736. import { Engine } from "babylonjs/Engines/engine";
  22737. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  22738. import { Observable } from "babylonjs/Misc/observable";
  22739. import { SubMesh } from "babylonjs/Meshes/subMesh";
  22740. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  22741. import { NodeMaterialOptimizer } from "babylonjs/Materials/Node/Optimizers/nodeMaterialOptimizer";
  22742. import { ImageProcessingConfiguration, IImageProcessingConfigurationDefines } from "babylonjs/Materials/imageProcessingConfiguration";
  22743. import { Nullable } from "babylonjs/types";
  22744. import { InputBlock } from "babylonjs/Materials/Node/Blocks/Input/inputBlock";
  22745. import { TextureBlock } from "babylonjs/Materials/Node/Blocks/Dual/textureBlock";
  22746. import { ReflectionTextureBaseBlock } from "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBaseBlock";
  22747. import { RefractionBlock } from "babylonjs/Materials/Node/Blocks/PBR/refractionBlock";
  22748. import { CurrentScreenBlock } from "babylonjs/Materials/Node/Blocks/Dual/currentScreenBlock";
  22749. import { ParticleTextureBlock } from "babylonjs/Materials/Node/Blocks/Particle/particleTextureBlock";
  22750. import { Effect } from "babylonjs/Materials/effect";
  22751. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  22752. import { Camera } from "babylonjs/Cameras/camera";
  22753. import { NodeMaterialModes } from "babylonjs/Materials/Node/Enums/nodeMaterialModes";
  22754. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  22755. /**
  22756. * Interface used to configure the node material editor
  22757. */
  22758. export interface INodeMaterialEditorOptions {
  22759. /** Define the URl to load node editor script */
  22760. editorURL?: string;
  22761. }
  22762. /** @hidden */
  22763. export class NodeMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  22764. NORMAL: boolean;
  22765. TANGENT: boolean;
  22766. UV1: boolean;
  22767. /** BONES */
  22768. NUM_BONE_INFLUENCERS: number;
  22769. BonesPerMesh: number;
  22770. BONETEXTURE: boolean;
  22771. /** MORPH TARGETS */
  22772. MORPHTARGETS: boolean;
  22773. MORPHTARGETS_NORMAL: boolean;
  22774. MORPHTARGETS_TANGENT: boolean;
  22775. MORPHTARGETS_UV: boolean;
  22776. NUM_MORPH_INFLUENCERS: number;
  22777. /** IMAGE PROCESSING */
  22778. IMAGEPROCESSING: boolean;
  22779. VIGNETTE: boolean;
  22780. VIGNETTEBLENDMODEMULTIPLY: boolean;
  22781. VIGNETTEBLENDMODEOPAQUE: boolean;
  22782. TONEMAPPING: boolean;
  22783. TONEMAPPING_ACES: boolean;
  22784. CONTRAST: boolean;
  22785. EXPOSURE: boolean;
  22786. COLORCURVES: boolean;
  22787. COLORGRADING: boolean;
  22788. COLORGRADING3D: boolean;
  22789. SAMPLER3DGREENDEPTH: boolean;
  22790. SAMPLER3DBGRMAP: boolean;
  22791. IMAGEPROCESSINGPOSTPROCESS: boolean;
  22792. /** MISC. */
  22793. BUMPDIRECTUV: number;
  22794. constructor();
  22795. setValue(name: string, value: any, markAsUnprocessedIfDirty?: boolean): void;
  22796. }
  22797. /**
  22798. * Class used to configure NodeMaterial
  22799. */
  22800. export interface INodeMaterialOptions {
  22801. /**
  22802. * Defines if blocks should emit comments
  22803. */
  22804. emitComments: boolean;
  22805. }
  22806. /**
  22807. * Class used to create a node based material built by assembling shader blocks
  22808. */
  22809. export class NodeMaterial extends PushMaterial {
  22810. private static _BuildIdGenerator;
  22811. private _options;
  22812. private _vertexCompilationState;
  22813. private _fragmentCompilationState;
  22814. private _sharedData;
  22815. private _buildId;
  22816. private _buildWasSuccessful;
  22817. private _cachedWorldViewMatrix;
  22818. private _cachedWorldViewProjectionMatrix;
  22819. private _optimizers;
  22820. private _animationFrame;
  22821. /** Define the Url to load node editor script */
  22822. static EditorURL: string;
  22823. /** Define the Url to load snippets */
  22824. static SnippetUrl: string;
  22825. /** Gets or sets a boolean indicating that node materials should not deserialize textures from json / snippet content */
  22826. static IgnoreTexturesAtLoadTime: boolean;
  22827. private BJSNODEMATERIALEDITOR;
  22828. /** Get the inspector from bundle or global */
  22829. private _getGlobalNodeMaterialEditor;
  22830. /**
  22831. * Snippet ID if the material was created from the snippet server
  22832. */
  22833. snippetId: string;
  22834. /**
  22835. * Gets or sets data used by visual editor
  22836. * @see https://nme.babylonjs.com
  22837. */
  22838. editorData: any;
  22839. /**
  22840. * 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)
  22841. */
  22842. ignoreAlpha: boolean;
  22843. /**
  22844. * Defines the maximum number of lights that can be used in the material
  22845. */
  22846. maxSimultaneousLights: number;
  22847. /**
  22848. * Observable raised when the material is built
  22849. */
  22850. onBuildObservable: Observable<NodeMaterial>;
  22851. /**
  22852. * Gets or sets the root nodes of the material vertex shader
  22853. */
  22854. _vertexOutputNodes: NodeMaterialBlock[];
  22855. /**
  22856. * Gets or sets the root nodes of the material fragment (pixel) shader
  22857. */
  22858. _fragmentOutputNodes: NodeMaterialBlock[];
  22859. /** Gets or sets options to control the node material overall behavior */
  22860. get options(): INodeMaterialOptions;
  22861. set options(options: INodeMaterialOptions);
  22862. /**
  22863. * Default configuration related to image processing available in the standard Material.
  22864. */
  22865. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  22866. /**
  22867. * Gets the image processing configuration used either in this material.
  22868. */
  22869. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  22870. /**
  22871. * Sets the Default image processing configuration used either in the this material.
  22872. *
  22873. * If sets to null, the scene one is in use.
  22874. */
  22875. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  22876. /**
  22877. * Gets an array of blocks that needs to be serialized even if they are not yet connected
  22878. */
  22879. attachedBlocks: NodeMaterialBlock[];
  22880. /**
  22881. * Specifies the mode of the node material
  22882. * @hidden
  22883. */
  22884. _mode: NodeMaterialModes;
  22885. /**
  22886. * Gets the mode property
  22887. */
  22888. get mode(): NodeMaterialModes;
  22889. /**
  22890. * Create a new node based material
  22891. * @param name defines the material name
  22892. * @param scene defines the hosting scene
  22893. * @param options defines creation option
  22894. */
  22895. constructor(name: string, scene?: Scene, options?: Partial<INodeMaterialOptions>);
  22896. /**
  22897. * Gets the current class name of the material e.g. "NodeMaterial"
  22898. * @returns the class name
  22899. */
  22900. getClassName(): string;
  22901. /**
  22902. * Keep track of the image processing observer to allow dispose and replace.
  22903. */
  22904. private _imageProcessingObserver;
  22905. /**
  22906. * Attaches a new image processing configuration to the Standard Material.
  22907. * @param configuration
  22908. */
  22909. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  22910. /**
  22911. * Get a block by its name
  22912. * @param name defines the name of the block to retrieve
  22913. * @returns the required block or null if not found
  22914. */
  22915. getBlockByName(name: string): Nullable<NodeMaterialBlock>;
  22916. /**
  22917. * Get a block by its name
  22918. * @param predicate defines the predicate used to find the good candidate
  22919. * @returns the required block or null if not found
  22920. */
  22921. getBlockByPredicate(predicate: (block: NodeMaterialBlock) => boolean): Nullable<NodeMaterialBlock>;
  22922. /**
  22923. * Get an input block by its name
  22924. * @param predicate defines the predicate used to find the good candidate
  22925. * @returns the required input block or null if not found
  22926. */
  22927. getInputBlockByPredicate(predicate: (block: InputBlock) => boolean): Nullable<InputBlock>;
  22928. /**
  22929. * Gets the list of input blocks attached to this material
  22930. * @returns an array of InputBlocks
  22931. */
  22932. getInputBlocks(): InputBlock[];
  22933. /**
  22934. * Adds a new optimizer to the list of optimizers
  22935. * @param optimizer defines the optimizers to add
  22936. * @returns the current material
  22937. */
  22938. registerOptimizer(optimizer: NodeMaterialOptimizer): this | undefined;
  22939. /**
  22940. * Remove an optimizer from the list of optimizers
  22941. * @param optimizer defines the optimizers to remove
  22942. * @returns the current material
  22943. */
  22944. unregisterOptimizer(optimizer: NodeMaterialOptimizer): this | undefined;
  22945. /**
  22946. * Add a new block to the list of output nodes
  22947. * @param node defines the node to add
  22948. * @returns the current material
  22949. */
  22950. addOutputNode(node: NodeMaterialBlock): this;
  22951. /**
  22952. * Remove a block from the list of root nodes
  22953. * @param node defines the node to remove
  22954. * @returns the current material
  22955. */
  22956. removeOutputNode(node: NodeMaterialBlock): this;
  22957. private _addVertexOutputNode;
  22958. private _removeVertexOutputNode;
  22959. private _addFragmentOutputNode;
  22960. private _removeFragmentOutputNode;
  22961. /**
  22962. * Specifies if the material will require alpha blending
  22963. * @returns a boolean specifying if alpha blending is needed
  22964. */
  22965. needAlphaBlending(): boolean;
  22966. /**
  22967. * Specifies if this material should be rendered in alpha test mode
  22968. * @returns a boolean specifying if an alpha test is needed.
  22969. */
  22970. needAlphaTesting(): boolean;
  22971. private _initializeBlock;
  22972. private _resetDualBlocks;
  22973. /**
  22974. * Remove a block from the current node material
  22975. * @param block defines the block to remove
  22976. */
  22977. removeBlock(block: NodeMaterialBlock): void;
  22978. /**
  22979. * Build the material and generates the inner effect
  22980. * @param verbose defines if the build should log activity
  22981. */
  22982. build(verbose?: boolean): void;
  22983. /**
  22984. * Runs an otpimization phase to try to improve the shader code
  22985. */
  22986. optimize(): void;
  22987. private _prepareDefinesForAttributes;
  22988. /**
  22989. * Create a post process from the material
  22990. * @param camera The camera to apply the render pass to.
  22991. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  22992. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  22993. * @param engine The engine which the post process will be applied. (default: current engine)
  22994. * @param reusable If the post process can be reused on the same frame. (default: false)
  22995. * @param textureType Type of textures used when performing the post process. (default: 0)
  22996. * @param textureFormat Format of textures used when performing the post process. (default: TEXTUREFORMAT_RGBA)
  22997. * @returns the post process created
  22998. */
  22999. createPostProcess(camera: Nullable<Camera>, options?: number | PostProcessOptions, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, textureFormat?: number): PostProcess;
  23000. /**
  23001. * Create the post process effect from the material
  23002. * @param postProcess The post process to create the effect for
  23003. */
  23004. createEffectForPostProcess(postProcess: PostProcess): void;
  23005. private _createEffectOrPostProcess;
  23006. private _createEffectForParticles;
  23007. /**
  23008. * Create the effect to be used as the custom effect for a particle system
  23009. * @param particleSystem Particle system to create the effect for
  23010. * @param onCompiled defines a function to call when the effect creation is successful
  23011. * @param onError defines a function to call when the effect creation has failed
  23012. */
  23013. createEffectForParticles(particleSystem: IParticleSystem, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  23014. private _processDefines;
  23015. /**
  23016. * Get if the submesh is ready to be used and all its information available.
  23017. * Child classes can use it to update shaders
  23018. * @param mesh defines the mesh to check
  23019. * @param subMesh defines which submesh to check
  23020. * @param useInstances specifies that instances should be used
  23021. * @returns a boolean indicating that the submesh is ready or not
  23022. */
  23023. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  23024. /**
  23025. * Get a string representing the shaders built by the current node graph
  23026. */
  23027. get compiledShaders(): string;
  23028. /**
  23029. * Binds the world matrix to the material
  23030. * @param world defines the world transformation matrix
  23031. */
  23032. bindOnlyWorldMatrix(world: Matrix): void;
  23033. /**
  23034. * Binds the submesh to this material by preparing the effect and shader to draw
  23035. * @param world defines the world transformation matrix
  23036. * @param mesh defines the mesh containing the submesh
  23037. * @param subMesh defines the submesh to bind the material to
  23038. */
  23039. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  23040. /**
  23041. * Gets the active textures from the material
  23042. * @returns an array of textures
  23043. */
  23044. getActiveTextures(): BaseTexture[];
  23045. /**
  23046. * Gets the list of texture blocks
  23047. * @returns an array of texture blocks
  23048. */
  23049. getTextureBlocks(): (TextureBlock | ReflectionTextureBaseBlock | RefractionBlock | CurrentScreenBlock | ParticleTextureBlock)[];
  23050. /**
  23051. * Specifies if the material uses a texture
  23052. * @param texture defines the texture to check against the material
  23053. * @returns a boolean specifying if the material uses the texture
  23054. */
  23055. hasTexture(texture: BaseTexture): boolean;
  23056. /**
  23057. * Disposes the material
  23058. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  23059. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  23060. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  23061. */
  23062. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  23063. /** Creates the node editor window. */
  23064. private _createNodeEditor;
  23065. /**
  23066. * Launch the node material editor
  23067. * @param config Define the configuration of the editor
  23068. * @return a promise fulfilled when the node editor is visible
  23069. */
  23070. edit(config?: INodeMaterialEditorOptions): Promise<void>;
  23071. /**
  23072. * Clear the current material
  23073. */
  23074. clear(): void;
  23075. /**
  23076. * Clear the current material and set it to a default state
  23077. */
  23078. setToDefault(): void;
  23079. /**
  23080. * Clear the current material and set it to a default state for post process
  23081. */
  23082. setToDefaultPostProcess(): void;
  23083. /**
  23084. * Clear the current material and set it to a default state for particle
  23085. */
  23086. setToDefaultParticle(): void;
  23087. /**
  23088. * Loads the current Node Material from a url pointing to a file save by the Node Material Editor
  23089. * @param url defines the url to load from
  23090. * @returns a promise that will fullfil when the material is fully loaded
  23091. */
  23092. loadAsync(url: string): Promise<void>;
  23093. private _gatherBlocks;
  23094. /**
  23095. * Generate a string containing the code declaration required to create an equivalent of this material
  23096. * @returns a string
  23097. */
  23098. generateCode(): string;
  23099. /**
  23100. * Serializes this material in a JSON representation
  23101. * @returns the serialized material object
  23102. */
  23103. serialize(selectedBlocks?: NodeMaterialBlock[]): any;
  23104. private _restoreConnections;
  23105. /**
  23106. * Clear the current graph and load a new one from a serialization object
  23107. * @param source defines the JSON representation of the material
  23108. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  23109. * @param merge defines whether or not the source must be merged or replace the current content
  23110. */
  23111. loadFromSerialization(source: any, rootUrl?: string, merge?: boolean): void;
  23112. /**
  23113. * Makes a duplicate of the current material.
  23114. * @param name - name to use for the new material.
  23115. */
  23116. clone(name: string): NodeMaterial;
  23117. /**
  23118. * Creates a node material from parsed material data
  23119. * @param source defines the JSON representation of the material
  23120. * @param scene defines the hosting scene
  23121. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  23122. * @returns a new node material
  23123. */
  23124. static Parse(source: any, scene: Scene, rootUrl?: string): NodeMaterial;
  23125. /**
  23126. * Creates a node material from a snippet saved in a remote file
  23127. * @param name defines the name of the material to create
  23128. * @param url defines the url to load from
  23129. * @param scene defines the hosting scene
  23130. * @returns a promise that will resolve to the new node material
  23131. */
  23132. static ParseFromFileAsync(name: string, url: string, scene: Scene): Promise<NodeMaterial>;
  23133. /**
  23134. * Creates a node material from a snippet saved by the node material editor
  23135. * @param snippetId defines the snippet to load
  23136. * @param scene defines the hosting scene
  23137. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  23138. * @param nodeMaterial defines a node material to update (instead of creating a new one)
  23139. * @returns a promise that will resolve to the new node material
  23140. */
  23141. static ParseFromSnippetAsync(snippetId: string, scene: Scene, rootUrl?: string, nodeMaterial?: NodeMaterial): Promise<NodeMaterial>;
  23142. /**
  23143. * Creates a new node material set to default basic configuration
  23144. * @param name defines the name of the material
  23145. * @param scene defines the hosting scene
  23146. * @returns a new NodeMaterial
  23147. */
  23148. static CreateDefault(name: string, scene?: Scene): NodeMaterial;
  23149. }
  23150. }
  23151. declare module "babylonjs/PostProcesses/postProcess" {
  23152. import { Nullable } from "babylonjs/types";
  23153. import { SmartArray } from "babylonjs/Misc/smartArray";
  23154. import { Observable } from "babylonjs/Misc/observable";
  23155. import { Vector2 } from "babylonjs/Maths/math.vector";
  23156. import { Camera } from "babylonjs/Cameras/camera";
  23157. import { Effect } from "babylonjs/Materials/effect";
  23158. import "babylonjs/Shaders/postprocess.vertex";
  23159. import { IInspectable } from "babylonjs/Misc/iInspectable";
  23160. import { Engine } from "babylonjs/Engines/engine";
  23161. import { Color4 } from "babylonjs/Maths/math.color";
  23162. import "babylonjs/Engines/Extensions/engine.renderTarget";
  23163. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  23164. import { Scene } from "babylonjs/scene";
  23165. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  23166. /**
  23167. * Size options for a post process
  23168. */
  23169. export type PostProcessOptions = {
  23170. width: number;
  23171. height: number;
  23172. };
  23173. /**
  23174. * PostProcess can be used to apply a shader to a texture after it has been rendered
  23175. * See https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  23176. */
  23177. export class PostProcess {
  23178. /** Name of the PostProcess. */
  23179. name: string;
  23180. /**
  23181. * Gets or sets the unique id of the post process
  23182. */
  23183. uniqueId: number;
  23184. /**
  23185. * Width of the texture to apply the post process on
  23186. */
  23187. width: number;
  23188. /**
  23189. * Height of the texture to apply the post process on
  23190. */
  23191. height: number;
  23192. /**
  23193. * Gets the node material used to create this postprocess (null if the postprocess was manually created)
  23194. */
  23195. nodeMaterialSource: Nullable<NodeMaterial>;
  23196. /**
  23197. * Internal, reference to the location where this postprocess was output to. (Typically the texture on the next postprocess in the chain)
  23198. * @hidden
  23199. */
  23200. _outputTexture: Nullable<InternalTexture>;
  23201. /**
  23202. * Sampling mode used by the shader
  23203. * See https://doc.babylonjs.com/classes/3.1/texture
  23204. */
  23205. renderTargetSamplingMode: number;
  23206. /**
  23207. * Clear color to use when screen clearing
  23208. */
  23209. clearColor: Color4;
  23210. /**
  23211. * If the buffer needs to be cleared before applying the post process. (default: true)
  23212. * Should be set to false if shader will overwrite all previous pixels.
  23213. */
  23214. autoClear: boolean;
  23215. /**
  23216. * Type of alpha mode to use when performing the post process (default: Engine.ALPHA_DISABLE)
  23217. */
  23218. alphaMode: number;
  23219. /**
  23220. * Sets the setAlphaBlendConstants of the babylon engine
  23221. */
  23222. alphaConstants: Color4;
  23223. /**
  23224. * Animations to be used for the post processing
  23225. */
  23226. animations: import("babylonjs/Animations/animation").Animation[];
  23227. /**
  23228. * Enable Pixel Perfect mode where texture is not scaled to be power of 2.
  23229. * Can only be used on a single postprocess or on the last one of a chain. (default: false)
  23230. */
  23231. enablePixelPerfectMode: boolean;
  23232. /**
  23233. * Force the postprocess to be applied without taking in account viewport
  23234. */
  23235. forceFullscreenViewport: boolean;
  23236. /**
  23237. * List of inspectable custom properties (used by the Inspector)
  23238. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  23239. */
  23240. inspectableCustomProperties: IInspectable[];
  23241. /**
  23242. * Scale mode for the post process (default: Engine.SCALEMODE_FLOOR)
  23243. *
  23244. * | Value | Type | Description |
  23245. * | ----- | ----------------------------------- | ----------- |
  23246. * | 1 | SCALEMODE_FLOOR | [engine.scalemode_floor](https://doc.babylonjs.com/api/classes/babylon.engine#scalemode_floor) |
  23247. * | 2 | SCALEMODE_NEAREST | [engine.scalemode_nearest](https://doc.babylonjs.com/api/classes/babylon.engine#scalemode_nearest) |
  23248. * | 3 | SCALEMODE_CEILING | [engine.scalemode_ceiling](https://doc.babylonjs.com/api/classes/babylon.engine#scalemode_ceiling) |
  23249. *
  23250. */
  23251. scaleMode: number;
  23252. /**
  23253. * Force textures to be a power of two (default: false)
  23254. */
  23255. alwaysForcePOT: boolean;
  23256. private _samples;
  23257. /**
  23258. * Number of sample textures (default: 1)
  23259. */
  23260. get samples(): number;
  23261. set samples(n: number);
  23262. /**
  23263. * Modify the scale of the post process to be the same as the viewport (default: false)
  23264. */
  23265. adaptScaleToCurrentViewport: boolean;
  23266. private _camera;
  23267. protected _scene: Scene;
  23268. private _engine;
  23269. private _options;
  23270. private _reusable;
  23271. private _textureType;
  23272. private _textureFormat;
  23273. /**
  23274. * Smart array of input and output textures for the post process.
  23275. * @hidden
  23276. */
  23277. _textures: SmartArray<import("babylonjs/Materials/Textures/internalTexture").InternalTexture>;
  23278. /**
  23279. * The index in _textures that corresponds to the output texture.
  23280. * @hidden
  23281. */
  23282. _currentRenderTextureInd: number;
  23283. private _effect;
  23284. private _samplers;
  23285. private _fragmentUrl;
  23286. private _vertexUrl;
  23287. private _parameters;
  23288. private _scaleRatio;
  23289. protected _indexParameters: any;
  23290. private _shareOutputWithPostProcess;
  23291. private _texelSize;
  23292. private _forcedOutputTexture;
  23293. /**
  23294. * Returns the fragment url or shader name used in the post process.
  23295. * @returns the fragment url or name in the shader store.
  23296. */
  23297. getEffectName(): string;
  23298. /**
  23299. * An event triggered when the postprocess is activated.
  23300. */
  23301. onActivateObservable: Observable<Camera>;
  23302. private _onActivateObserver;
  23303. /**
  23304. * A function that is added to the onActivateObservable
  23305. */
  23306. set onActivate(callback: Nullable<(camera: Camera) => void>);
  23307. /**
  23308. * An event triggered when the postprocess changes its size.
  23309. */
  23310. onSizeChangedObservable: Observable<PostProcess>;
  23311. private _onSizeChangedObserver;
  23312. /**
  23313. * A function that is added to the onSizeChangedObservable
  23314. */
  23315. set onSizeChanged(callback: (postProcess: PostProcess) => void);
  23316. /**
  23317. * An event triggered when the postprocess applies its effect.
  23318. */
  23319. onApplyObservable: Observable<Effect>;
  23320. private _onApplyObserver;
  23321. /**
  23322. * A function that is added to the onApplyObservable
  23323. */
  23324. set onApply(callback: (effect: Effect) => void);
  23325. /**
  23326. * An event triggered before rendering the postprocess
  23327. */
  23328. onBeforeRenderObservable: Observable<Effect>;
  23329. private _onBeforeRenderObserver;
  23330. /**
  23331. * A function that is added to the onBeforeRenderObservable
  23332. */
  23333. set onBeforeRender(callback: (effect: Effect) => void);
  23334. /**
  23335. * An event triggered after rendering the postprocess
  23336. */
  23337. onAfterRenderObservable: Observable<Effect>;
  23338. private _onAfterRenderObserver;
  23339. /**
  23340. * A function that is added to the onAfterRenderObservable
  23341. */
  23342. set onAfterRender(callback: (efect: Effect) => void);
  23343. /**
  23344. * 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
  23345. * render it's output into this texture and this texture will be used as textureSampler in the fragment shader of this post process.
  23346. */
  23347. get inputTexture(): InternalTexture;
  23348. set inputTexture(value: InternalTexture);
  23349. /**
  23350. * Since inputTexture should always be defined, if we previously manually set `inputTexture`,
  23351. * the only way to unset it is to use this function to restore its internal state
  23352. */
  23353. restoreDefaultInputTexture(): void;
  23354. /**
  23355. * Gets the camera which post process is applied to.
  23356. * @returns The camera the post process is applied to.
  23357. */
  23358. getCamera(): Camera;
  23359. /**
  23360. * Gets the texel size of the postprocess.
  23361. * See https://en.wikipedia.org/wiki/Texel_(graphics)
  23362. */
  23363. get texelSize(): Vector2;
  23364. /**
  23365. * Creates a new instance PostProcess
  23366. * @param name The name of the PostProcess.
  23367. * @param fragmentUrl The url of the fragment shader to be used.
  23368. * @param parameters Array of the names of uniform non-sampler2D variables that will be passed to the shader.
  23369. * @param samplers Array of the names of uniform sampler2D variables that will be passed to the shader.
  23370. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  23371. * @param camera The camera to apply the render pass to.
  23372. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  23373. * @param engine The engine which the post process will be applied. (default: current engine)
  23374. * @param reusable If the post process can be reused on the same frame. (default: false)
  23375. * @param defines String of defines that will be set when running the fragment shader. (default: null)
  23376. * @param textureType Type of textures used when performing the post process. (default: 0)
  23377. * @param vertexUrl The url of the vertex shader to be used. (default: "postprocess")
  23378. * @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
  23379. * @param blockCompilation If the shader should not be compiled imediatly. (default: false)
  23380. * @param textureFormat Format of textures used when performing the post process. (default: TEXTUREFORMAT_RGBA)
  23381. */
  23382. constructor(
  23383. /** Name of the PostProcess. */
  23384. 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);
  23385. /**
  23386. * Gets a string idenfifying the name of the class
  23387. * @returns "PostProcess" string
  23388. */
  23389. getClassName(): string;
  23390. /**
  23391. * Gets the engine which this post process belongs to.
  23392. * @returns The engine the post process was enabled with.
  23393. */
  23394. getEngine(): Engine;
  23395. /**
  23396. * The effect that is created when initializing the post process.
  23397. * @returns The created effect corresponding the the postprocess.
  23398. */
  23399. getEffect(): Effect;
  23400. /**
  23401. * To avoid multiple redundant textures for multiple post process, the output the output texture for this post process can be shared with another.
  23402. * @param postProcess The post process to share the output with.
  23403. * @returns This post process.
  23404. */
  23405. shareOutputWith(postProcess: PostProcess): PostProcess;
  23406. /**
  23407. * Reverses the effect of calling shareOutputWith and returns the post process back to its original state.
  23408. * This should be called if the post process that shares output with this post process is disabled/disposed.
  23409. */
  23410. useOwnOutput(): void;
  23411. /**
  23412. * Updates the effect with the current post process compile time values and recompiles the shader.
  23413. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  23414. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  23415. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  23416. * @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
  23417. * @param onCompiled Called when the shader has been compiled.
  23418. * @param onError Called if there is an error when compiling a shader.
  23419. * @param vertexUrl The url of the vertex shader to be used (default: the one given at construction time)
  23420. * @param fragmentUrl The url of the fragment shader to be used (default: the one given at construction time)
  23421. */
  23422. 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;
  23423. /**
  23424. * The post process is reusable if it can be used multiple times within one frame.
  23425. * @returns If the post process is reusable
  23426. */
  23427. isReusable(): boolean;
  23428. /** invalidate frameBuffer to hint the postprocess to create a depth buffer */
  23429. markTextureDirty(): void;
  23430. /**
  23431. * Activates the post process by intializing the textures to be used when executed. Notifies onActivateObservable.
  23432. * 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.
  23433. * @param camera The camera that will be used in the post process. This camera will be used when calling onActivateObservable.
  23434. * @param sourceTexture The source texture to be inspected to get the width and height if not specified in the post process constructor. (default: null)
  23435. * @param forceDepthStencil If true, a depth and stencil buffer will be generated. (default: false)
  23436. * @returns The target texture that was bound to be written to.
  23437. */
  23438. activate(camera: Nullable<Camera>, sourceTexture?: Nullable<InternalTexture>, forceDepthStencil?: boolean): InternalTexture;
  23439. /**
  23440. * If the post process is supported.
  23441. */
  23442. get isSupported(): boolean;
  23443. /**
  23444. * The aspect ratio of the output texture.
  23445. */
  23446. get aspectRatio(): number;
  23447. /**
  23448. * Get a value indicating if the post-process is ready to be used
  23449. * @returns true if the post-process is ready (shader is compiled)
  23450. */
  23451. isReady(): boolean;
  23452. /**
  23453. * Binds all textures and uniforms to the shader, this will be run on every pass.
  23454. * @returns the effect corresponding to this post process. Null if not compiled or not ready.
  23455. */
  23456. apply(): Nullable<Effect>;
  23457. private _disposeTextures;
  23458. /**
  23459. * Disposes the post process.
  23460. * @param camera The camera to dispose the post process on.
  23461. */
  23462. dispose(camera?: Camera): void;
  23463. }
  23464. }
  23465. declare module "babylonjs/Shaders/ShadersInclude/kernelBlurVaryingDeclaration" {
  23466. /** @hidden */
  23467. export var kernelBlurVaryingDeclaration: {
  23468. name: string;
  23469. shader: string;
  23470. };
  23471. }
  23472. declare module "babylonjs/Shaders/ShadersInclude/kernelBlurFragment" {
  23473. /** @hidden */
  23474. export var kernelBlurFragment: {
  23475. name: string;
  23476. shader: string;
  23477. };
  23478. }
  23479. declare module "babylonjs/Shaders/ShadersInclude/kernelBlurFragment2" {
  23480. /** @hidden */
  23481. export var kernelBlurFragment2: {
  23482. name: string;
  23483. shader: string;
  23484. };
  23485. }
  23486. declare module "babylonjs/Shaders/kernelBlur.fragment" {
  23487. import "babylonjs/Shaders/ShadersInclude/kernelBlurVaryingDeclaration";
  23488. import "babylonjs/Shaders/ShadersInclude/packingFunctions";
  23489. import "babylonjs/Shaders/ShadersInclude/kernelBlurFragment";
  23490. import "babylonjs/Shaders/ShadersInclude/kernelBlurFragment2";
  23491. /** @hidden */
  23492. export var kernelBlurPixelShader: {
  23493. name: string;
  23494. shader: string;
  23495. };
  23496. }
  23497. declare module "babylonjs/Shaders/ShadersInclude/kernelBlurVertex" {
  23498. /** @hidden */
  23499. export var kernelBlurVertex: {
  23500. name: string;
  23501. shader: string;
  23502. };
  23503. }
  23504. declare module "babylonjs/Shaders/kernelBlur.vertex" {
  23505. import "babylonjs/Shaders/ShadersInclude/kernelBlurVaryingDeclaration";
  23506. import "babylonjs/Shaders/ShadersInclude/kernelBlurVertex";
  23507. /** @hidden */
  23508. export var kernelBlurVertexShader: {
  23509. name: string;
  23510. shader: string;
  23511. };
  23512. }
  23513. declare module "babylonjs/PostProcesses/blurPostProcess" {
  23514. import { Vector2 } from "babylonjs/Maths/math.vector";
  23515. import { Nullable } from "babylonjs/types";
  23516. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  23517. import { Camera } from "babylonjs/Cameras/camera";
  23518. import { Effect } from "babylonjs/Materials/effect";
  23519. import { Engine } from "babylonjs/Engines/engine";
  23520. import "babylonjs/Shaders/kernelBlur.fragment";
  23521. import "babylonjs/Shaders/kernelBlur.vertex";
  23522. /**
  23523. * The Blur Post Process which blurs an image based on a kernel and direction.
  23524. * Can be used twice in x and y directions to perform a guassian blur in two passes.
  23525. */
  23526. export class BlurPostProcess extends PostProcess {
  23527. /** The direction in which to blur the image. */
  23528. direction: Vector2;
  23529. private blockCompilation;
  23530. protected _kernel: number;
  23531. protected _idealKernel: number;
  23532. protected _packedFloat: boolean;
  23533. private _staticDefines;
  23534. /**
  23535. * Sets the length in pixels of the blur sample region
  23536. */
  23537. set kernel(v: number);
  23538. /**
  23539. * Gets the length in pixels of the blur sample region
  23540. */
  23541. get kernel(): number;
  23542. /**
  23543. * Sets wether or not the blur needs to unpack/repack floats
  23544. */
  23545. set packedFloat(v: boolean);
  23546. /**
  23547. * Gets wether or not the blur is unpacking/repacking floats
  23548. */
  23549. get packedFloat(): boolean;
  23550. /**
  23551. * Creates a new instance BlurPostProcess
  23552. * @param name The name of the effect.
  23553. * @param direction The direction in which to blur the image.
  23554. * @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.
  23555. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  23556. * @param camera The camera to apply the render pass to.
  23557. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  23558. * @param engine The engine which the post process will be applied. (default: current engine)
  23559. * @param reusable If the post process can be reused on the same frame. (default: false)
  23560. * @param textureType Type of textures used when performing the post process. (default: 0)
  23561. * @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)
  23562. */
  23563. constructor(name: string,
  23564. /** The direction in which to blur the image. */
  23565. direction: Vector2, kernel: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, defines?: string, blockCompilation?: boolean);
  23566. /**
  23567. * Updates the effect with the current post process compile time values and recompiles the shader.
  23568. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  23569. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  23570. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  23571. * @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
  23572. * @param onCompiled Called when the shader has been compiled.
  23573. * @param onError Called if there is an error when compiling a shader.
  23574. */
  23575. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  23576. protected _updateParameters(onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  23577. /**
  23578. * Best kernels are odd numbers that when divided by 2, their integer part is even, so 5, 9 or 13.
  23579. * Other odd kernels optimize correctly but require proportionally more samples, even kernels are
  23580. * possible but will produce minor visual artifacts. Since each new kernel requires a new shader we
  23581. * want to minimize kernel changes, having gaps between physical kernels is helpful in that regard.
  23582. * The gaps between physical kernels are compensated for in the weighting of the samples
  23583. * @param idealKernel Ideal blur kernel.
  23584. * @return Nearest best kernel.
  23585. */
  23586. protected _nearestBestKernel(idealKernel: number): number;
  23587. /**
  23588. * Calculates the value of a Gaussian distribution with sigma 3 at a given point.
  23589. * @param x The point on the Gaussian distribution to sample.
  23590. * @return the value of the Gaussian function at x.
  23591. */
  23592. protected _gaussianWeight(x: number): number;
  23593. /**
  23594. * Generates a string that can be used as a floating point number in GLSL.
  23595. * @param x Value to print.
  23596. * @param decimalFigures Number of decimal places to print the number to (excluding trailing 0s).
  23597. * @return GLSL float string.
  23598. */
  23599. protected _glslFloat(x: number, decimalFigures?: number): string;
  23600. }
  23601. }
  23602. declare module "babylonjs/Materials/Textures/mirrorTexture" {
  23603. import { Scene } from "babylonjs/scene";
  23604. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  23605. import { Plane } from "babylonjs/Maths/math.plane";
  23606. /**
  23607. * Mirror texture can be used to simulate the view from a mirror in a scene.
  23608. * It will dynamically be rendered every frame to adapt to the camera point of view.
  23609. * You can then easily use it as a reflectionTexture on a flat surface.
  23610. * In case the surface is not a plane, please consider relying on reflection probes.
  23611. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  23612. */
  23613. export class MirrorTexture extends RenderTargetTexture {
  23614. private scene;
  23615. /**
  23616. * Define the reflection plane we want to use. The mirrorPlane is usually set to the constructed reflector.
  23617. * 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.
  23618. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  23619. */
  23620. mirrorPlane: Plane;
  23621. /**
  23622. * Define the blur ratio used to blur the reflection if needed.
  23623. */
  23624. set blurRatio(value: number);
  23625. get blurRatio(): number;
  23626. /**
  23627. * Define the adaptive blur kernel used to blur the reflection if needed.
  23628. * This will autocompute the closest best match for the `blurKernel`
  23629. */
  23630. set adaptiveBlurKernel(value: number);
  23631. /**
  23632. * Define the blur kernel used to blur the reflection if needed.
  23633. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  23634. */
  23635. set blurKernel(value: number);
  23636. /**
  23637. * Define the blur kernel on the X Axis used to blur the reflection if needed.
  23638. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  23639. */
  23640. set blurKernelX(value: number);
  23641. get blurKernelX(): number;
  23642. /**
  23643. * Define the blur kernel on the Y Axis used to blur the reflection if needed.
  23644. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  23645. */
  23646. set blurKernelY(value: number);
  23647. get blurKernelY(): number;
  23648. private _autoComputeBlurKernel;
  23649. protected _onRatioRescale(): void;
  23650. private _updateGammaSpace;
  23651. private _imageProcessingConfigChangeObserver;
  23652. private _transformMatrix;
  23653. private _mirrorMatrix;
  23654. private _savedViewMatrix;
  23655. private _blurX;
  23656. private _blurY;
  23657. private _adaptiveBlurKernel;
  23658. private _blurKernelX;
  23659. private _blurKernelY;
  23660. private _blurRatio;
  23661. /**
  23662. * Instantiates a Mirror Texture.
  23663. * Mirror texture can be used to simulate the view from a mirror in a scene.
  23664. * It will dynamically be rendered every frame to adapt to the camera point of view.
  23665. * You can then easily use it as a reflectionTexture on a flat surface.
  23666. * In case the surface is not a plane, please consider relying on reflection probes.
  23667. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  23668. * @param name
  23669. * @param size
  23670. * @param scene
  23671. * @param generateMipMaps
  23672. * @param type
  23673. * @param samplingMode
  23674. * @param generateDepthBuffer
  23675. */
  23676. constructor(name: string, size: number | {
  23677. width: number;
  23678. height: number;
  23679. } | {
  23680. ratio: number;
  23681. }, scene: Scene, generateMipMaps?: boolean, type?: number, samplingMode?: number, generateDepthBuffer?: boolean);
  23682. private _preparePostProcesses;
  23683. /**
  23684. * Clone the mirror texture.
  23685. * @returns the cloned texture
  23686. */
  23687. clone(): MirrorTexture;
  23688. /**
  23689. * Serialize the texture to a JSON representation you could use in Parse later on
  23690. * @returns the serialized JSON representation
  23691. */
  23692. serialize(): any;
  23693. /**
  23694. * Dispose the texture and release its associated resources.
  23695. */
  23696. dispose(): void;
  23697. }
  23698. }
  23699. declare module "babylonjs/Materials/Textures/texture" {
  23700. import { Observable } from "babylonjs/Misc/observable";
  23701. import { Nullable } from "babylonjs/types";
  23702. import { Matrix } from "babylonjs/Maths/math.vector";
  23703. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  23704. import { IInspectable } from "babylonjs/Misc/iInspectable";
  23705. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  23706. import { CubeTexture } from "babylonjs/Materials/Textures/cubeTexture";
  23707. import { MirrorTexture } from "babylonjs/Materials/Textures/mirrorTexture";
  23708. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  23709. import { Scene } from "babylonjs/scene";
  23710. /**
  23711. * This represents a texture in babylon. It can be easily loaded from a network, base64 or html input.
  23712. * @see https://doc.babylonjs.com/babylon101/materials#texture
  23713. */
  23714. export class Texture extends BaseTexture {
  23715. /**
  23716. * Gets or sets a general boolean used to indicate that textures containing direct data (buffers) must be saved as part of the serialization process
  23717. */
  23718. static SerializeBuffers: boolean;
  23719. /** @hidden */
  23720. static _CubeTextureParser: (jsonTexture: any, scene: Scene, rootUrl: string) => CubeTexture;
  23721. /** @hidden */
  23722. static _CreateMirror: (name: string, renderTargetSize: number, scene: Scene, generateMipMaps: boolean) => MirrorTexture;
  23723. /** @hidden */
  23724. static _CreateRenderTargetTexture: (name: string, renderTargetSize: number, scene: Scene, generateMipMaps: boolean) => RenderTargetTexture;
  23725. /** nearest is mag = nearest and min = nearest and mip = linear */
  23726. static readonly NEAREST_SAMPLINGMODE: number;
  23727. /** nearest is mag = nearest and min = nearest and mip = linear */
  23728. static readonly NEAREST_NEAREST_MIPLINEAR: number;
  23729. /** Bilinear is mag = linear and min = linear and mip = nearest */
  23730. static readonly BILINEAR_SAMPLINGMODE: number;
  23731. /** Bilinear is mag = linear and min = linear and mip = nearest */
  23732. static readonly LINEAR_LINEAR_MIPNEAREST: number;
  23733. /** Trilinear is mag = linear and min = linear and mip = linear */
  23734. static readonly TRILINEAR_SAMPLINGMODE: number;
  23735. /** Trilinear is mag = linear and min = linear and mip = linear */
  23736. static readonly LINEAR_LINEAR_MIPLINEAR: number;
  23737. /** mag = nearest and min = nearest and mip = nearest */
  23738. static readonly NEAREST_NEAREST_MIPNEAREST: number;
  23739. /** mag = nearest and min = linear and mip = nearest */
  23740. static readonly NEAREST_LINEAR_MIPNEAREST: number;
  23741. /** mag = nearest and min = linear and mip = linear */
  23742. static readonly NEAREST_LINEAR_MIPLINEAR: number;
  23743. /** mag = nearest and min = linear and mip = none */
  23744. static readonly NEAREST_LINEAR: number;
  23745. /** mag = nearest and min = nearest and mip = none */
  23746. static readonly NEAREST_NEAREST: number;
  23747. /** mag = linear and min = nearest and mip = nearest */
  23748. static readonly LINEAR_NEAREST_MIPNEAREST: number;
  23749. /** mag = linear and min = nearest and mip = linear */
  23750. static readonly LINEAR_NEAREST_MIPLINEAR: number;
  23751. /** mag = linear and min = linear and mip = none */
  23752. static readonly LINEAR_LINEAR: number;
  23753. /** mag = linear and min = nearest and mip = none */
  23754. static readonly LINEAR_NEAREST: number;
  23755. /** Explicit coordinates mode */
  23756. static readonly EXPLICIT_MODE: number;
  23757. /** Spherical coordinates mode */
  23758. static readonly SPHERICAL_MODE: number;
  23759. /** Planar coordinates mode */
  23760. static readonly PLANAR_MODE: number;
  23761. /** Cubic coordinates mode */
  23762. static readonly CUBIC_MODE: number;
  23763. /** Projection coordinates mode */
  23764. static readonly PROJECTION_MODE: number;
  23765. /** Inverse Cubic coordinates mode */
  23766. static readonly SKYBOX_MODE: number;
  23767. /** Inverse Cubic coordinates mode */
  23768. static readonly INVCUBIC_MODE: number;
  23769. /** Equirectangular coordinates mode */
  23770. static readonly EQUIRECTANGULAR_MODE: number;
  23771. /** Equirectangular Fixed coordinates mode */
  23772. static readonly FIXED_EQUIRECTANGULAR_MODE: number;
  23773. /** Equirectangular Fixed Mirrored coordinates mode */
  23774. static readonly FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  23775. /** Texture is not repeating outside of 0..1 UVs */
  23776. static readonly CLAMP_ADDRESSMODE: number;
  23777. /** Texture is repeating outside of 0..1 UVs */
  23778. static readonly WRAP_ADDRESSMODE: number;
  23779. /** Texture is repeating and mirrored */
  23780. static readonly MIRROR_ADDRESSMODE: number;
  23781. /**
  23782. * 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
  23783. */
  23784. static UseSerializedUrlIfAny: boolean;
  23785. /**
  23786. * Define the url of the texture.
  23787. */
  23788. url: Nullable<string>;
  23789. /**
  23790. * Define an offset on the texture to offset the u coordinates of the UVs
  23791. * @see https://doc.babylonjs.com/how_to/more_materials#offsetting
  23792. */
  23793. uOffset: number;
  23794. /**
  23795. * Define an offset on the texture to offset the v coordinates of the UVs
  23796. * @see https://doc.babylonjs.com/how_to/more_materials#offsetting
  23797. */
  23798. vOffset: number;
  23799. /**
  23800. * Define an offset on the texture to scale the u coordinates of the UVs
  23801. * @see https://doc.babylonjs.com/how_to/more_materials#tiling
  23802. */
  23803. uScale: number;
  23804. /**
  23805. * Define an offset on the texture to scale the v coordinates of the UVs
  23806. * @see https://doc.babylonjs.com/how_to/more_materials#tiling
  23807. */
  23808. vScale: number;
  23809. /**
  23810. * Define an offset on the texture to rotate around the u coordinates of the UVs
  23811. * @see https://doc.babylonjs.com/how_to/more_materials
  23812. */
  23813. uAng: number;
  23814. /**
  23815. * Define an offset on the texture to rotate around the v coordinates of the UVs
  23816. * @see https://doc.babylonjs.com/how_to/more_materials
  23817. */
  23818. vAng: number;
  23819. /**
  23820. * Define an offset on the texture to rotate around the w coordinates of the UVs (in case of 3d texture)
  23821. * @see https://doc.babylonjs.com/how_to/more_materials
  23822. */
  23823. wAng: number;
  23824. /**
  23825. * Defines the center of rotation (U)
  23826. */
  23827. uRotationCenter: number;
  23828. /**
  23829. * Defines the center of rotation (V)
  23830. */
  23831. vRotationCenter: number;
  23832. /**
  23833. * Defines the center of rotation (W)
  23834. */
  23835. wRotationCenter: number;
  23836. /**
  23837. * Are mip maps generated for this texture or not.
  23838. */
  23839. get noMipmap(): boolean;
  23840. /**
  23841. * List of inspectable custom properties (used by the Inspector)
  23842. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  23843. */
  23844. inspectableCustomProperties: Nullable<IInspectable[]>;
  23845. private _noMipmap;
  23846. /** @hidden */
  23847. _invertY: boolean;
  23848. private _rowGenerationMatrix;
  23849. private _cachedTextureMatrix;
  23850. private _projectionModeMatrix;
  23851. private _t0;
  23852. private _t1;
  23853. private _t2;
  23854. private _cachedUOffset;
  23855. private _cachedVOffset;
  23856. private _cachedUScale;
  23857. private _cachedVScale;
  23858. private _cachedUAng;
  23859. private _cachedVAng;
  23860. private _cachedWAng;
  23861. private _cachedProjectionMatrixId;
  23862. private _cachedCoordinatesMode;
  23863. /** @hidden */
  23864. protected _initialSamplingMode: number;
  23865. /** @hidden */
  23866. _buffer: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>;
  23867. private _deleteBuffer;
  23868. protected _format: Nullable<number>;
  23869. private _delayedOnLoad;
  23870. private _delayedOnError;
  23871. private _mimeType?;
  23872. /**
  23873. * Observable triggered once the texture has been loaded.
  23874. */
  23875. onLoadObservable: Observable<Texture>;
  23876. protected _isBlocking: boolean;
  23877. /**
  23878. * Is the texture preventing material to render while loading.
  23879. * If false, a default texture will be used instead of the loading one during the preparation step.
  23880. */
  23881. set isBlocking(value: boolean);
  23882. get isBlocking(): boolean;
  23883. /**
  23884. * Get the current sampling mode associated with the texture.
  23885. */
  23886. get samplingMode(): number;
  23887. /**
  23888. * Gets a boolean indicating if the texture needs to be inverted on the y axis during loading
  23889. */
  23890. get invertY(): boolean;
  23891. /**
  23892. * Instantiates a new texture.
  23893. * This represents a texture in babylon. It can be easily loaded from a network, base64 or html input.
  23894. * @see https://doc.babylonjs.com/babylon101/materials#texture
  23895. * @param url defines the url of the picture to load as a texture
  23896. * @param sceneOrEngine defines the scene or engine the texture will belong to
  23897. * @param noMipmap defines if the texture will require mip maps or not
  23898. * @param invertY defines if the texture needs to be inverted on the y axis during loading
  23899. * @param samplingMode defines the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  23900. * @param onLoad defines a callback triggered when the texture has been loaded
  23901. * @param onError defines a callback triggered when an error occurred during the loading session
  23902. * @param buffer defines the buffer to load the texture from in case the texture is loaded from a buffer representation
  23903. * @param deleteBuffer defines if the buffer we are loading the texture from should be deleted after load
  23904. * @param format defines the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  23905. * @param mimeType defines an optional mime type information
  23906. */
  23907. 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);
  23908. /**
  23909. * Update the url (and optional buffer) of this texture if url was null during construction.
  23910. * @param url the url of the texture
  23911. * @param buffer the buffer of the texture (defaults to null)
  23912. * @param onLoad callback called when the texture is loaded (defaults to null)
  23913. */
  23914. updateURL(url: string, buffer?: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob>, onLoad?: () => void): void;
  23915. /**
  23916. * Finish the loading sequence of a texture flagged as delayed load.
  23917. * @hidden
  23918. */
  23919. delayLoad(): void;
  23920. private _prepareRowForTextureGeneration;
  23921. /**
  23922. * Get the current texture matrix which includes the requested offsetting, tiling and rotation components.
  23923. * @returns the transform matrix of the texture.
  23924. */
  23925. getTextureMatrix(uBase?: number): Matrix;
  23926. /**
  23927. * Get the current matrix used to apply reflection. This is useful to rotate an environment texture for instance.
  23928. * @returns The reflection texture transform
  23929. */
  23930. getReflectionTextureMatrix(): Matrix;
  23931. /**
  23932. * Clones the texture.
  23933. * @returns the cloned texture
  23934. */
  23935. clone(): Texture;
  23936. /**
  23937. * Serialize the texture to a JSON representation we can easily use in the resepective Parse function.
  23938. * @returns The JSON representation of the texture
  23939. */
  23940. serialize(): any;
  23941. /**
  23942. * Get the current class name of the texture useful for serialization or dynamic coding.
  23943. * @returns "Texture"
  23944. */
  23945. getClassName(): string;
  23946. /**
  23947. * Dispose the texture and release its associated resources.
  23948. */
  23949. dispose(): void;
  23950. /**
  23951. * Parse the JSON representation of a texture in order to recreate the texture in the given scene.
  23952. * @param parsedTexture Define the JSON representation of the texture
  23953. * @param scene Define the scene the parsed texture should be instantiated in
  23954. * @param rootUrl Define the root url of the parsing sequence in the case of relative dependencies
  23955. * @returns The parsed texture if successful
  23956. */
  23957. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): Nullable<BaseTexture>;
  23958. /**
  23959. * Creates a texture from its base 64 representation.
  23960. * @param data Define the base64 payload without the data: prefix
  23961. * @param name Define the name of the texture in the scene useful fo caching purpose for instance
  23962. * @param scene Define the scene the texture should belong to
  23963. * @param noMipmap Forces the texture to not create mip map information if true
  23964. * @param invertY define if the texture needs to be inverted on the y axis during loading
  23965. * @param samplingMode define the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  23966. * @param onLoad define a callback triggered when the texture has been loaded
  23967. * @param onError define a callback triggered when an error occurred during the loading session
  23968. * @param format define the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  23969. * @returns the created texture
  23970. */
  23971. static CreateFromBase64String(data: string, name: string, scene: Scene, noMipmap?: boolean, invertY?: boolean, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<() => void>, format?: number): Texture;
  23972. /**
  23973. * Creates a texture from its data: representation. (data: will be added in case only the payload has been passed in)
  23974. * @param data Define the base64 payload without the data: prefix
  23975. * @param name Define the name of the texture in the scene useful fo caching purpose for instance
  23976. * @param buffer define the buffer to load the texture from in case the texture is loaded from a buffer representation
  23977. * @param scene Define the scene the texture should belong to
  23978. * @param deleteBuffer define if the buffer we are loading the texture from should be deleted after load
  23979. * @param noMipmap Forces the texture to not create mip map information if true
  23980. * @param invertY define if the texture needs to be inverted on the y axis during loading
  23981. * @param samplingMode define the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  23982. * @param onLoad define a callback triggered when the texture has been loaded
  23983. * @param onError define a callback triggered when an error occurred during the loading session
  23984. * @param format define the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  23985. * @returns the created texture
  23986. */
  23987. 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;
  23988. }
  23989. }
  23990. declare module "babylonjs/PostProcesses/postProcessManager" {
  23991. import { Nullable } from "babylonjs/types";
  23992. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  23993. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  23994. import { Scene } from "babylonjs/scene";
  23995. /**
  23996. * PostProcessManager is used to manage one or more post processes or post process pipelines
  23997. * See https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  23998. */
  23999. export class PostProcessManager {
  24000. private _scene;
  24001. private _indexBuffer;
  24002. private _vertexBuffers;
  24003. /**
  24004. * Creates a new instance PostProcess
  24005. * @param scene The scene that the post process is associated with.
  24006. */
  24007. constructor(scene: Scene);
  24008. private _prepareBuffers;
  24009. private _buildIndexBuffer;
  24010. /**
  24011. * Rebuilds the vertex buffers of the manager.
  24012. * @hidden
  24013. */
  24014. _rebuild(): void;
  24015. /**
  24016. * Prepares a frame to be run through a post process.
  24017. * @param sourceTexture The input texture to the post procesess. (default: null)
  24018. * @param postProcesses An array of post processes to be run. (default: null)
  24019. * @returns True if the post processes were able to be run.
  24020. * @hidden
  24021. */
  24022. _prepareFrame(sourceTexture?: Nullable<InternalTexture>, postProcesses?: Nullable<PostProcess[]>): boolean;
  24023. /**
  24024. * Manually render a set of post processes to a texture.
  24025. * Please note, the frame buffer won't be unbound after the call in case you have more render to do.
  24026. * @param postProcesses An array of post processes to be run.
  24027. * @param targetTexture The target texture to render to.
  24028. * @param forceFullscreenViewport force gl.viewport to be full screen eg. 0,0,textureWidth,textureHeight
  24029. * @param faceIndex defines the face to render to if a cubemap is defined as the target
  24030. * @param lodLevel defines which lod of the texture to render to
  24031. * @param doNotBindFrambuffer If set to true, assumes that the framebuffer has been bound previously
  24032. */
  24033. directRender(postProcesses: PostProcess[], targetTexture?: Nullable<InternalTexture>, forceFullscreenViewport?: boolean, faceIndex?: number, lodLevel?: number, doNotBindFrambuffer?: boolean): void;
  24034. /**
  24035. * Finalize the result of the output of the postprocesses.
  24036. * @param doNotPresent If true the result will not be displayed to the screen.
  24037. * @param targetTexture The target texture to render to.
  24038. * @param faceIndex The index of the face to bind the target texture to.
  24039. * @param postProcesses The array of post processes to render.
  24040. * @param forceFullscreenViewport force gl.viewport to be full screen eg. 0,0,textureWidth,textureHeight (default: false)
  24041. * @hidden
  24042. */
  24043. _finalizeFrame(doNotPresent?: boolean, targetTexture?: InternalTexture, faceIndex?: number, postProcesses?: Array<PostProcess>, forceFullscreenViewport?: boolean): void;
  24044. /**
  24045. * Disposes of the post process manager.
  24046. */
  24047. dispose(): void;
  24048. }
  24049. }
  24050. declare module "babylonjs/Materials/Textures/renderTargetTexture" {
  24051. import { Observable } from "babylonjs/Misc/observable";
  24052. import { SmartArray } from "babylonjs/Misc/smartArray";
  24053. import { Nullable, Immutable } from "babylonjs/types";
  24054. import { Camera } from "babylonjs/Cameras/camera";
  24055. import { Scene } from "babylonjs/scene";
  24056. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  24057. import { Color4 } from "babylonjs/Maths/math.color";
  24058. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  24059. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  24060. import { SubMesh } from "babylonjs/Meshes/subMesh";
  24061. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  24062. import { Texture } from "babylonjs/Materials/Textures/texture";
  24063. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  24064. import { RenderingManager } from "babylonjs/Rendering/renderingManager";
  24065. import "babylonjs/Engines/Extensions/engine.renderTarget";
  24066. import "babylonjs/Engines/Extensions/engine.renderTargetCube";
  24067. import { Engine } from "babylonjs/Engines/engine";
  24068. /**
  24069. * This Helps creating a texture that will be created from a camera in your scene.
  24070. * It is basically a dynamic texture that could be used to create special effects for instance.
  24071. * Actually, It is the base of lot of effects in the framework like post process, shadows, effect layers and rendering pipelines...
  24072. */
  24073. export class RenderTargetTexture extends Texture {
  24074. isCube: boolean;
  24075. /**
  24076. * The texture will only be rendered once which can be useful to improve performance if everything in your render is static for instance.
  24077. */
  24078. static readonly REFRESHRATE_RENDER_ONCE: number;
  24079. /**
  24080. * The texture will only be rendered rendered every frame and is recomended for dynamic contents.
  24081. */
  24082. static readonly REFRESHRATE_RENDER_ONEVERYFRAME: number;
  24083. /**
  24084. * The texture will be rendered every 2 frames which could be enough if your dynamic objects are not
  24085. * the central point of your effect and can save a lot of performances.
  24086. */
  24087. static readonly REFRESHRATE_RENDER_ONEVERYTWOFRAMES: number;
  24088. /**
  24089. * Use this predicate to dynamically define the list of mesh you want to render.
  24090. * If set, the renderList property will be overwritten.
  24091. */
  24092. renderListPredicate: (AbstractMesh: AbstractMesh) => boolean;
  24093. private _renderList;
  24094. /**
  24095. * Use this list to define the list of mesh you want to render.
  24096. */
  24097. get renderList(): Nullable<Array<AbstractMesh>>;
  24098. set renderList(value: Nullable<Array<AbstractMesh>>);
  24099. /**
  24100. * Use this function to overload the renderList array at rendering time.
  24101. * Return null to render with the curent renderList, else return the list of meshes to use for rendering.
  24102. * For 2DArray RTT, layerOrFace is the index of the layer that is going to be rendered, else it is the faceIndex of
  24103. * the cube (if the RTT is a cube, else layerOrFace=0).
  24104. * The renderList passed to the function is the current render list (the one that will be used if the function returns null).
  24105. * The length of this list is passed through renderListLength: don't use renderList.length directly because the array can
  24106. * hold dummy elements!
  24107. */
  24108. getCustomRenderList: (layerOrFace: number, renderList: Nullable<Immutable<Array<AbstractMesh>>>, renderListLength: number) => Nullable<Array<AbstractMesh>>;
  24109. private _hookArray;
  24110. /**
  24111. * Define if particles should be rendered in your texture.
  24112. */
  24113. renderParticles: boolean;
  24114. /**
  24115. * Define if sprites should be rendered in your texture.
  24116. */
  24117. renderSprites: boolean;
  24118. /**
  24119. * Override the default coordinates mode to projection for RTT as it is the most common case for rendered textures.
  24120. */
  24121. coordinatesMode: number;
  24122. /**
  24123. * Define the camera used to render the texture.
  24124. */
  24125. activeCamera: Nullable<Camera>;
  24126. /**
  24127. * Override the mesh isReady function with your own one.
  24128. */
  24129. customIsReadyFunction: (mesh: AbstractMesh, refreshRate: number) => boolean;
  24130. /**
  24131. * Override the render function of the texture with your own one.
  24132. */
  24133. customRenderFunction: (opaqueSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>, beforeTransparents?: () => void) => void;
  24134. /**
  24135. * Define if camera post processes should be use while rendering the texture.
  24136. */
  24137. useCameraPostProcesses: boolean;
  24138. /**
  24139. * Define if the camera viewport should be respected while rendering the texture or if the render should be done to the entire texture.
  24140. */
  24141. ignoreCameraViewport: boolean;
  24142. private _postProcessManager;
  24143. private _postProcesses;
  24144. private _resizeObserver;
  24145. /**
  24146. * An event triggered when the texture is unbind.
  24147. */
  24148. onBeforeBindObservable: Observable<RenderTargetTexture>;
  24149. /**
  24150. * An event triggered when the texture is unbind.
  24151. */
  24152. onAfterUnbindObservable: Observable<RenderTargetTexture>;
  24153. private _onAfterUnbindObserver;
  24154. /**
  24155. * Set a after unbind callback in the texture.
  24156. * This has been kept for backward compatibility and use of onAfterUnbindObservable is recommended.
  24157. */
  24158. set onAfterUnbind(callback: () => void);
  24159. /**
  24160. * An event triggered before rendering the texture
  24161. */
  24162. onBeforeRenderObservable: Observable<number>;
  24163. private _onBeforeRenderObserver;
  24164. /**
  24165. * Set a before render callback in the texture.
  24166. * This has been kept for backward compatibility and use of onBeforeRenderObservable is recommended.
  24167. */
  24168. set onBeforeRender(callback: (faceIndex: number) => void);
  24169. /**
  24170. * An event triggered after rendering the texture
  24171. */
  24172. onAfterRenderObservable: Observable<number>;
  24173. private _onAfterRenderObserver;
  24174. /**
  24175. * Set a after render callback in the texture.
  24176. * This has been kept for backward compatibility and use of onAfterRenderObservable is recommended.
  24177. */
  24178. set onAfterRender(callback: (faceIndex: number) => void);
  24179. /**
  24180. * An event triggered after the texture clear
  24181. */
  24182. onClearObservable: Observable<Engine>;
  24183. private _onClearObserver;
  24184. /**
  24185. * Set a clear callback in the texture.
  24186. * This has been kept for backward compatibility and use of onClearObservable is recommended.
  24187. */
  24188. set onClear(callback: (Engine: Engine) => void);
  24189. /**
  24190. * An event triggered when the texture is resized.
  24191. */
  24192. onResizeObservable: Observable<RenderTargetTexture>;
  24193. /**
  24194. * Define the clear color of the Render Target if it should be different from the scene.
  24195. */
  24196. clearColor: Color4;
  24197. protected _size: number | {
  24198. width: number;
  24199. height: number;
  24200. layers?: number;
  24201. };
  24202. protected _initialSizeParameter: number | {
  24203. width: number;
  24204. height: number;
  24205. } | {
  24206. ratio: number;
  24207. };
  24208. protected _sizeRatio: Nullable<number>;
  24209. /** @hidden */
  24210. _generateMipMaps: boolean;
  24211. protected _renderingManager: RenderingManager;
  24212. /** @hidden */
  24213. _waitingRenderList: string[];
  24214. protected _doNotChangeAspectRatio: boolean;
  24215. protected _currentRefreshId: number;
  24216. protected _refreshRate: number;
  24217. protected _textureMatrix: Matrix;
  24218. protected _samples: number;
  24219. protected _renderTargetOptions: RenderTargetCreationOptions;
  24220. /**
  24221. * Gets render target creation options that were used.
  24222. */
  24223. get renderTargetOptions(): RenderTargetCreationOptions;
  24224. protected _onRatioRescale(): void;
  24225. /**
  24226. * Gets or sets the center of the bounding box associated with the texture (when in cube mode)
  24227. * It must define where the camera used to render the texture is set
  24228. */
  24229. boundingBoxPosition: Vector3;
  24230. private _boundingBoxSize;
  24231. /**
  24232. * Gets or sets the size of the bounding box associated with the texture (when in cube mode)
  24233. * When defined, the cubemap will switch to local mode
  24234. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  24235. * @example https://www.babylonjs-playground.com/#RNASML
  24236. */
  24237. set boundingBoxSize(value: Vector3);
  24238. get boundingBoxSize(): Vector3;
  24239. /**
  24240. * In case the RTT has been created with a depth texture, get the associated
  24241. * depth texture.
  24242. * Otherwise, return null.
  24243. */
  24244. get depthStencilTexture(): Nullable<InternalTexture>;
  24245. /**
  24246. * Instantiate a render target texture. This is mainly used to render of screen the scene to for instance apply post processse
  24247. * or used a shadow, depth texture...
  24248. * @param name The friendly name of the texture
  24249. * @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)
  24250. * @param scene The scene the RTT belongs to. The latest created scene will be used if not precised.
  24251. * @param generateMipMaps True if mip maps need to be generated after render.
  24252. * @param doNotChangeAspectRatio True to not change the aspect ratio of the scene in the RTT
  24253. * @param type The type of the buffer in the RTT (int, half float, float...)
  24254. * @param isCube True if a cube texture needs to be created
  24255. * @param samplingMode The sampling mode to be usedwith the render target (Linear, Nearest...)
  24256. * @param generateDepthBuffer True to generate a depth buffer
  24257. * @param generateStencilBuffer True to generate a stencil buffer
  24258. * @param isMulti True if multiple textures need to be created (Draw Buffers)
  24259. * @param format The internal format of the buffer in the RTT (RED, RG, RGB, RGBA, ALPHA...)
  24260. * @param delayAllocation if the texture allocation should be delayed (default: false)
  24261. */
  24262. constructor(name: string, size: number | {
  24263. width: number;
  24264. height: number;
  24265. layers?: number;
  24266. } | {
  24267. ratio: number;
  24268. }, scene: Nullable<Scene>, generateMipMaps?: boolean, doNotChangeAspectRatio?: boolean, type?: number, isCube?: boolean, samplingMode?: number, generateDepthBuffer?: boolean, generateStencilBuffer?: boolean, isMulti?: boolean, format?: number, delayAllocation?: boolean);
  24269. /**
  24270. * Creates a depth stencil texture.
  24271. * This is only available in WebGL 2 or with the depth texture extension available.
  24272. * @param comparisonFunction Specifies the comparison function to set on the texture. If 0 or undefined, the texture is not in comparison mode
  24273. * @param bilinearFiltering Specifies whether or not bilinear filtering is enable on the texture
  24274. * @param generateStencil Specifies whether or not a stencil should be allocated in the texture
  24275. */
  24276. createDepthStencilTexture(comparisonFunction?: number, bilinearFiltering?: boolean, generateStencil?: boolean): void;
  24277. private _processSizeParameter;
  24278. /**
  24279. * Define the number of samples to use in case of MSAA.
  24280. * It defaults to one meaning no MSAA has been enabled.
  24281. */
  24282. get samples(): number;
  24283. set samples(value: number);
  24284. /**
  24285. * Resets the refresh counter of the texture and start bak from scratch.
  24286. * Could be useful to regenerate the texture if it is setup to render only once.
  24287. */
  24288. resetRefreshCounter(): void;
  24289. /**
  24290. * Define the refresh rate of the texture or the rendering frequency.
  24291. * Use 0 to render just once, 1 to render on every frame, 2 to render every two frames and so on...
  24292. */
  24293. get refreshRate(): number;
  24294. set refreshRate(value: number);
  24295. /**
  24296. * Adds a post process to the render target rendering passes.
  24297. * @param postProcess define the post process to add
  24298. */
  24299. addPostProcess(postProcess: PostProcess): void;
  24300. /**
  24301. * Clear all the post processes attached to the render target
  24302. * @param dispose define if the cleared post processesshould also be disposed (false by default)
  24303. */
  24304. clearPostProcesses(dispose?: boolean): void;
  24305. /**
  24306. * Remove one of the post process from the list of attached post processes to the texture
  24307. * @param postProcess define the post process to remove from the list
  24308. */
  24309. removePostProcess(postProcess: PostProcess): void;
  24310. /** @hidden */
  24311. _shouldRender(): boolean;
  24312. /**
  24313. * Gets the actual render size of the texture.
  24314. * @returns the width of the render size
  24315. */
  24316. getRenderSize(): number;
  24317. /**
  24318. * Gets the actual render width of the texture.
  24319. * @returns the width of the render size
  24320. */
  24321. getRenderWidth(): number;
  24322. /**
  24323. * Gets the actual render height of the texture.
  24324. * @returns the height of the render size
  24325. */
  24326. getRenderHeight(): number;
  24327. /**
  24328. * Gets the actual number of layers of the texture.
  24329. * @returns the number of layers
  24330. */
  24331. getRenderLayers(): number;
  24332. /**
  24333. * Get if the texture can be rescaled or not.
  24334. */
  24335. get canRescale(): boolean;
  24336. /**
  24337. * Resize the texture using a ratio.
  24338. * @param ratio the ratio to apply to the texture size in order to compute the new target size
  24339. */
  24340. scale(ratio: number): void;
  24341. /**
  24342. * Get the texture reflection matrix used to rotate/transform the reflection.
  24343. * @returns the reflection matrix
  24344. */
  24345. getReflectionTextureMatrix(): Matrix;
  24346. /**
  24347. * Resize the texture to a new desired size.
  24348. * Be carrefull as it will recreate all the data in the new texture.
  24349. * @param size Define the new size. It can be:
  24350. * - a number for squared texture,
  24351. * - an object containing { width: number, height: number }
  24352. * - or an object containing a ratio { ratio: number }
  24353. */
  24354. resize(size: number | {
  24355. width: number;
  24356. height: number;
  24357. } | {
  24358. ratio: number;
  24359. }): void;
  24360. private _defaultRenderListPrepared;
  24361. /**
  24362. * Renders all the objects from the render list into the texture.
  24363. * @param useCameraPostProcess Define if camera post processes should be used during the rendering
  24364. * @param dumpForDebug Define if the rendering result should be dumped (copied) for debugging purpose
  24365. */
  24366. render(useCameraPostProcess?: boolean, dumpForDebug?: boolean): void;
  24367. private _bestReflectionRenderTargetDimension;
  24368. private _prepareRenderingManager;
  24369. /**
  24370. * @hidden
  24371. * @param faceIndex face index to bind to if this is a cubetexture
  24372. * @param layer defines the index of the texture to bind in the array
  24373. */
  24374. _bindFrameBuffer(faceIndex?: number, layer?: number): void;
  24375. protected unbindFrameBuffer(engine: Engine, faceIndex: number): void;
  24376. private renderToTarget;
  24377. /**
  24378. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  24379. * This allowed control for front to back rendering or reversly depending of the special needs.
  24380. *
  24381. * @param renderingGroupId The rendering group id corresponding to its index
  24382. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  24383. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  24384. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  24385. */
  24386. 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;
  24387. /**
  24388. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  24389. *
  24390. * @param renderingGroupId The rendering group id corresponding to its index
  24391. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  24392. */
  24393. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean): void;
  24394. /**
  24395. * Clones the texture.
  24396. * @returns the cloned texture
  24397. */
  24398. clone(): RenderTargetTexture;
  24399. /**
  24400. * Serialize the texture to a JSON representation we can easily use in the resepective Parse function.
  24401. * @returns The JSON representation of the texture
  24402. */
  24403. serialize(): any;
  24404. /**
  24405. * This will remove the attached framebuffer objects. The texture will not be able to be used as render target anymore
  24406. */
  24407. disposeFramebufferObjects(): void;
  24408. /**
  24409. * Dispose the texture and release its associated resources.
  24410. */
  24411. dispose(): void;
  24412. /** @hidden */
  24413. _rebuild(): void;
  24414. /**
  24415. * Clear the info related to rendering groups preventing retention point in material dispose.
  24416. */
  24417. freeRenderingGroups(): void;
  24418. /**
  24419. * Gets the number of views the corresponding to the texture (eg. a MultiviewRenderTarget will have > 1)
  24420. * @returns the view count
  24421. */
  24422. getViewCount(): number;
  24423. }
  24424. }
  24425. declare module "babylonjs/Misc/guid" {
  24426. /**
  24427. * Class used to manipulate GUIDs
  24428. */
  24429. export class GUID {
  24430. /**
  24431. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  24432. * Be aware Math.random() could cause collisions, but:
  24433. * "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"
  24434. * @returns a pseudo random id
  24435. */
  24436. static RandomId(): string;
  24437. }
  24438. }
  24439. declare module "babylonjs/Materials/shadowDepthWrapper" {
  24440. import { Nullable } from "babylonjs/types";
  24441. import { Scene } from "babylonjs/scene";
  24442. import { SubMesh } from "babylonjs/Meshes/subMesh";
  24443. import { Material } from "babylonjs/Materials/material";
  24444. import { Effect } from "babylonjs/Materials/effect";
  24445. import { ShadowGenerator } from "babylonjs/Lights/Shadows/shadowGenerator";
  24446. /**
  24447. * Options to be used when creating a shadow depth material
  24448. */
  24449. export interface IIOptionShadowDepthMaterial {
  24450. /** Variables in the vertex shader code that need to have their names remapped.
  24451. * The format is: ["var_name", "var_remapped_name", "var_name", "var_remapped_name", ...]
  24452. * "var_name" should be either: worldPos or vNormalW
  24453. * So, if the variable holding the world position in your vertex shader is not named worldPos, you must tell the system
  24454. * the name to use instead by using: ["worldPos", "myWorldPosVar"] assuming the variable is named myWorldPosVar in your code.
  24455. * If the normal must also be remapped: ["worldPos", "myWorldPosVar", "vNormalW", "myWorldNormal"]
  24456. */
  24457. remappedVariables?: string[];
  24458. /** Set standalone to true if the base material wrapped by ShadowDepthMaterial is not used for a regular object but for depth shadow generation only */
  24459. standalone?: boolean;
  24460. }
  24461. /**
  24462. * Class that can be used to wrap a base material to generate accurate shadows when using custom vertex/fragment code in the base material
  24463. */
  24464. export class ShadowDepthWrapper {
  24465. private _scene;
  24466. private _options?;
  24467. private _baseMaterial;
  24468. private _onEffectCreatedObserver;
  24469. private _subMeshToEffect;
  24470. private _subMeshToDepthEffect;
  24471. private _meshes;
  24472. /** @hidden */
  24473. _matriceNames: any;
  24474. /** Gets the standalone status of the wrapper */
  24475. get standalone(): boolean;
  24476. /** Gets the base material the wrapper is built upon */
  24477. get baseMaterial(): Material;
  24478. /**
  24479. * Instantiate a new shadow depth wrapper.
  24480. * It works by injecting some specific code in the vertex/fragment shaders of the base material and is used by a shadow generator to
  24481. * generate the shadow depth map. For more information, please refer to the documentation:
  24482. * https://doc.babylonjs.com/babylon101/shadows
  24483. * @param baseMaterial Material to wrap
  24484. * @param scene Define the scene the material belongs to
  24485. * @param options Options used to create the wrapper
  24486. */
  24487. constructor(baseMaterial: Material, scene: Scene, options?: IIOptionShadowDepthMaterial);
  24488. /**
  24489. * Gets the effect to use to generate the depth map
  24490. * @param subMesh subMesh to get the effect for
  24491. * @param shadowGenerator shadow generator to get the effect for
  24492. * @returns the effect to use to generate the depth map for the subMesh + shadow generator specified
  24493. */
  24494. getEffect(subMesh: Nullable<SubMesh>, shadowGenerator: ShadowGenerator): Nullable<Effect>;
  24495. /**
  24496. * Specifies that the submesh is ready to be used for depth rendering
  24497. * @param subMesh submesh to check
  24498. * @param defines the list of defines to take into account when checking the effect
  24499. * @param shadowGenerator combined with subMesh, it defines the effect to check
  24500. * @param useInstances specifies that instances should be used
  24501. * @returns a boolean indicating that the submesh is ready or not
  24502. */
  24503. isReadyForSubMesh(subMesh: SubMesh, defines: string[], shadowGenerator: ShadowGenerator, useInstances: boolean): boolean;
  24504. /**
  24505. * Disposes the resources
  24506. */
  24507. dispose(): void;
  24508. private _makeEffect;
  24509. }
  24510. }
  24511. declare module "babylonjs/Engines/Extensions/engine.multiRender" {
  24512. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  24513. import { IMultiRenderTargetOptions } from "babylonjs/Materials/Textures/multiRenderTarget";
  24514. import { Nullable } from "babylonjs/types";
  24515. module "babylonjs/Engines/thinEngine" {
  24516. interface ThinEngine {
  24517. /**
  24518. * Unbind a list of render target textures from the webGL context
  24519. * This is used only when drawBuffer extension or webGL2 are active
  24520. * @param textures defines the render target textures to unbind
  24521. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  24522. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  24523. */
  24524. unBindMultiColorAttachmentFramebuffer(textures: InternalTexture[], disableGenerateMipMaps: boolean, onBeforeUnbind?: () => void): void;
  24525. /**
  24526. * Create a multi render target texture
  24527. * @see https://doc.babylonjs.com/features/webgl2#multiple-render-target
  24528. * @param size defines the size of the texture
  24529. * @param options defines the creation options
  24530. * @returns the cube texture as an InternalTexture
  24531. */
  24532. createMultipleRenderTarget(size: any, options: IMultiRenderTargetOptions): InternalTexture[];
  24533. /**
  24534. * Update the sample count for a given multiple render target texture
  24535. * @see https://doc.babylonjs.com/features/webgl2#multisample-render-targets
  24536. * @param textures defines the textures to update
  24537. * @param samples defines the sample count to set
  24538. * @returns the effective sample count (could be 0 if multisample render targets are not supported)
  24539. */
  24540. updateMultipleRenderTargetTextureSampleCount(textures: Nullable<InternalTexture[]>, samples: number): number;
  24541. /**
  24542. * Select a subsets of attachments to draw to.
  24543. * @param attachments gl attachments
  24544. */
  24545. bindAttachments(attachments: number[]): void;
  24546. }
  24547. }
  24548. }
  24549. declare module "babylonjs/Materials/Textures/multiRenderTarget" {
  24550. import { Scene } from "babylonjs/scene";
  24551. import { Engine } from "babylonjs/Engines/engine";
  24552. import { Texture } from "babylonjs/Materials/Textures/texture";
  24553. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  24554. import "babylonjs/Engines/Extensions/engine.multiRender";
  24555. /**
  24556. * Creation options of the multi render target texture.
  24557. */
  24558. export interface IMultiRenderTargetOptions {
  24559. /**
  24560. * Define if the texture needs to create mip maps after render.
  24561. */
  24562. generateMipMaps?: boolean;
  24563. /**
  24564. * Define the types of all the draw buffers we want to create
  24565. */
  24566. types?: number[];
  24567. /**
  24568. * Define the sampling modes of all the draw buffers we want to create
  24569. */
  24570. samplingModes?: number[];
  24571. /**
  24572. * Define if a depth buffer is required
  24573. */
  24574. generateDepthBuffer?: boolean;
  24575. /**
  24576. * Define if a stencil buffer is required
  24577. */
  24578. generateStencilBuffer?: boolean;
  24579. /**
  24580. * Define if a depth texture is required instead of a depth buffer
  24581. */
  24582. generateDepthTexture?: boolean;
  24583. /**
  24584. * Define the number of desired draw buffers
  24585. */
  24586. textureCount?: number;
  24587. /**
  24588. * Define if aspect ratio should be adapted to the texture or stay the scene one
  24589. */
  24590. doNotChangeAspectRatio?: boolean;
  24591. /**
  24592. * Define the default type of the buffers we are creating
  24593. */
  24594. defaultType?: number;
  24595. }
  24596. /**
  24597. * A multi render target, like a render target provides the ability to render to a texture.
  24598. * Unlike the render target, it can render to several draw buffers in one draw.
  24599. * This is specially interesting in deferred rendering or for any effects requiring more than
  24600. * just one color from a single pass.
  24601. */
  24602. export class MultiRenderTarget extends RenderTargetTexture {
  24603. private _internalTextures;
  24604. private _textures;
  24605. private _multiRenderTargetOptions;
  24606. private _count;
  24607. /**
  24608. * Get if draw buffers are currently supported by the used hardware and browser.
  24609. */
  24610. get isSupported(): boolean;
  24611. /**
  24612. * Get the list of textures generated by the multi render target.
  24613. */
  24614. get textures(): Texture[];
  24615. /**
  24616. * Gets the number of textures in this MRT. This number can be different from `_textures.length` in case a depth texture is generated.
  24617. */
  24618. get count(): number;
  24619. /**
  24620. * Get the depth texture generated by the multi render target if options.generateDepthTexture has been set
  24621. */
  24622. get depthTexture(): Texture;
  24623. /**
  24624. * Set the wrapping mode on U of all the textures we are rendering to.
  24625. * Can be any of the Texture. (CLAMP_ADDRESSMODE, MIRROR_ADDRESSMODE or WRAP_ADDRESSMODE)
  24626. */
  24627. set wrapU(wrap: number);
  24628. /**
  24629. * Set the wrapping mode on V of all the textures we are rendering to.
  24630. * Can be any of the Texture. (CLAMP_ADDRESSMODE, MIRROR_ADDRESSMODE or WRAP_ADDRESSMODE)
  24631. */
  24632. set wrapV(wrap: number);
  24633. /**
  24634. * Instantiate a new multi render target texture.
  24635. * A multi render target, like a render target provides the ability to render to a texture.
  24636. * Unlike the render target, it can render to several draw buffers in one draw.
  24637. * This is specially interesting in deferred rendering or for any effects requiring more than
  24638. * just one color from a single pass.
  24639. * @param name Define the name of the texture
  24640. * @param size Define the size of the buffers to render to
  24641. * @param count Define the number of target we are rendering into
  24642. * @param scene Define the scene the texture belongs to
  24643. * @param options Define the options used to create the multi render target
  24644. */
  24645. constructor(name: string, size: any, count: number, scene: Scene, options?: IMultiRenderTargetOptions);
  24646. /** @hidden */
  24647. _rebuild(): void;
  24648. private _createInternalTextures;
  24649. private _createTextures;
  24650. /**
  24651. * Define the number of samples used if MSAA is enabled.
  24652. */
  24653. get samples(): number;
  24654. set samples(value: number);
  24655. /**
  24656. * Resize all the textures in the multi render target.
  24657. * Be carrefull as it will recreate all the data in the new texture.
  24658. * @param size Define the new size
  24659. */
  24660. resize(size: any): void;
  24661. protected unbindFrameBuffer(engine: Engine, faceIndex: number): void;
  24662. /**
  24663. * Dispose the render targets and their associated resources
  24664. */
  24665. dispose(): void;
  24666. /**
  24667. * Release all the underlying texture used as draw buffers.
  24668. */
  24669. releaseInternalTextures(): void;
  24670. }
  24671. }
  24672. declare module "babylonjs/Shaders/imageProcessing.fragment" {
  24673. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  24674. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  24675. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  24676. /** @hidden */
  24677. export var imageProcessingPixelShader: {
  24678. name: string;
  24679. shader: string;
  24680. };
  24681. }
  24682. declare module "babylonjs/PostProcesses/imageProcessingPostProcess" {
  24683. import { Nullable } from "babylonjs/types";
  24684. import { Color4 } from "babylonjs/Maths/math.color";
  24685. import { Camera } from "babylonjs/Cameras/camera";
  24686. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  24687. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  24688. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  24689. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  24690. import { Engine } from "babylonjs/Engines/engine";
  24691. import "babylonjs/Shaders/imageProcessing.fragment";
  24692. import "babylonjs/Shaders/postprocess.vertex";
  24693. /**
  24694. * ImageProcessingPostProcess
  24695. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#imageprocessing
  24696. */
  24697. export class ImageProcessingPostProcess extends PostProcess {
  24698. /**
  24699. * Default configuration related to image processing available in the PBR Material.
  24700. */
  24701. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  24702. /**
  24703. * Gets the image processing configuration used either in this material.
  24704. */
  24705. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  24706. /**
  24707. * Sets the Default image processing configuration used either in the this material.
  24708. *
  24709. * If sets to null, the scene one is in use.
  24710. */
  24711. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  24712. /**
  24713. * Keep track of the image processing observer to allow dispose and replace.
  24714. */
  24715. private _imageProcessingObserver;
  24716. /**
  24717. * Attaches a new image processing configuration to the PBR Material.
  24718. * @param configuration
  24719. */
  24720. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>, doNotBuild?: boolean): void;
  24721. /**
  24722. * If the post process is supported.
  24723. */
  24724. get isSupported(): boolean;
  24725. /**
  24726. * Gets Color curves setup used in the effect if colorCurvesEnabled is set to true .
  24727. */
  24728. get colorCurves(): Nullable<ColorCurves>;
  24729. /**
  24730. * Sets Color curves setup used in the effect if colorCurvesEnabled is set to true .
  24731. */
  24732. set colorCurves(value: Nullable<ColorCurves>);
  24733. /**
  24734. * Gets wether the color curves effect is enabled.
  24735. */
  24736. get colorCurvesEnabled(): boolean;
  24737. /**
  24738. * Sets wether the color curves effect is enabled.
  24739. */
  24740. set colorCurvesEnabled(value: boolean);
  24741. /**
  24742. * Gets Color grading LUT texture used in the effect if colorGradingEnabled is set to true.
  24743. */
  24744. get colorGradingTexture(): Nullable<BaseTexture>;
  24745. /**
  24746. * Sets Color grading LUT texture used in the effect if colorGradingEnabled is set to true.
  24747. */
  24748. set colorGradingTexture(value: Nullable<BaseTexture>);
  24749. /**
  24750. * Gets wether the color grading effect is enabled.
  24751. */
  24752. get colorGradingEnabled(): boolean;
  24753. /**
  24754. * Gets wether the color grading effect is enabled.
  24755. */
  24756. set colorGradingEnabled(value: boolean);
  24757. /**
  24758. * Gets exposure used in the effect.
  24759. */
  24760. get exposure(): number;
  24761. /**
  24762. * Sets exposure used in the effect.
  24763. */
  24764. set exposure(value: number);
  24765. /**
  24766. * Gets wether tonemapping is enabled or not.
  24767. */
  24768. get toneMappingEnabled(): boolean;
  24769. /**
  24770. * Sets wether tonemapping is enabled or not
  24771. */
  24772. set toneMappingEnabled(value: boolean);
  24773. /**
  24774. * Gets the type of tone mapping effect.
  24775. */
  24776. get toneMappingType(): number;
  24777. /**
  24778. * Sets the type of tone mapping effect.
  24779. */
  24780. set toneMappingType(value: number);
  24781. /**
  24782. * Gets contrast used in the effect.
  24783. */
  24784. get contrast(): number;
  24785. /**
  24786. * Sets contrast used in the effect.
  24787. */
  24788. set contrast(value: number);
  24789. /**
  24790. * Gets Vignette stretch size.
  24791. */
  24792. get vignetteStretch(): number;
  24793. /**
  24794. * Sets Vignette stretch size.
  24795. */
  24796. set vignetteStretch(value: number);
  24797. /**
  24798. * Gets Vignette centre X Offset.
  24799. */
  24800. get vignetteCentreX(): number;
  24801. /**
  24802. * Sets Vignette centre X Offset.
  24803. */
  24804. set vignetteCentreX(value: number);
  24805. /**
  24806. * Gets Vignette centre Y Offset.
  24807. */
  24808. get vignetteCentreY(): number;
  24809. /**
  24810. * Sets Vignette centre Y Offset.
  24811. */
  24812. set vignetteCentreY(value: number);
  24813. /**
  24814. * Gets Vignette weight or intensity of the vignette effect.
  24815. */
  24816. get vignetteWeight(): number;
  24817. /**
  24818. * Sets Vignette weight or intensity of the vignette effect.
  24819. */
  24820. set vignetteWeight(value: number);
  24821. /**
  24822. * Gets Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  24823. * if vignetteEnabled is set to true.
  24824. */
  24825. get vignetteColor(): Color4;
  24826. /**
  24827. * Sets Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  24828. * if vignetteEnabled is set to true.
  24829. */
  24830. set vignetteColor(value: Color4);
  24831. /**
  24832. * Gets Camera field of view used by the Vignette effect.
  24833. */
  24834. get vignetteCameraFov(): number;
  24835. /**
  24836. * Sets Camera field of view used by the Vignette effect.
  24837. */
  24838. set vignetteCameraFov(value: number);
  24839. /**
  24840. * Gets the vignette blend mode allowing different kind of effect.
  24841. */
  24842. get vignetteBlendMode(): number;
  24843. /**
  24844. * Sets the vignette blend mode allowing different kind of effect.
  24845. */
  24846. set vignetteBlendMode(value: number);
  24847. /**
  24848. * Gets wether the vignette effect is enabled.
  24849. */
  24850. get vignetteEnabled(): boolean;
  24851. /**
  24852. * Sets wether the vignette effect is enabled.
  24853. */
  24854. set vignetteEnabled(value: boolean);
  24855. private _fromLinearSpace;
  24856. /**
  24857. * Gets wether the input of the processing is in Gamma or Linear Space.
  24858. */
  24859. get fromLinearSpace(): boolean;
  24860. /**
  24861. * Sets wether the input of the processing is in Gamma or Linear Space.
  24862. */
  24863. set fromLinearSpace(value: boolean);
  24864. /**
  24865. * Defines cache preventing GC.
  24866. */
  24867. private _defines;
  24868. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, imageProcessingConfiguration?: ImageProcessingConfiguration);
  24869. /**
  24870. * "ImageProcessingPostProcess"
  24871. * @returns "ImageProcessingPostProcess"
  24872. */
  24873. getClassName(): string;
  24874. /**
  24875. * @hidden
  24876. */
  24877. _updateParameters(): void;
  24878. dispose(camera?: Camera): void;
  24879. }
  24880. }
  24881. declare module "babylonjs/Shaders/ShadersInclude/fibonacci" {
  24882. /** @hidden */
  24883. export var fibonacci: {
  24884. name: string;
  24885. shader: string;
  24886. };
  24887. }
  24888. declare module "babylonjs/Shaders/ShadersInclude/subSurfaceScatteringFunctions" {
  24889. /** @hidden */
  24890. export var subSurfaceScatteringFunctions: {
  24891. name: string;
  24892. shader: string;
  24893. };
  24894. }
  24895. declare module "babylonjs/Shaders/ShadersInclude/diffusionProfile" {
  24896. /** @hidden */
  24897. export var diffusionProfile: {
  24898. name: string;
  24899. shader: string;
  24900. };
  24901. }
  24902. declare module "babylonjs/Shaders/subSurfaceScattering.fragment" {
  24903. import "babylonjs/Shaders/ShadersInclude/fibonacci";
  24904. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  24905. import "babylonjs/Shaders/ShadersInclude/subSurfaceScatteringFunctions";
  24906. import "babylonjs/Shaders/ShadersInclude/diffusionProfile";
  24907. /** @hidden */
  24908. export var subSurfaceScatteringPixelShader: {
  24909. name: string;
  24910. shader: string;
  24911. };
  24912. }
  24913. declare module "babylonjs/PostProcesses/subSurfaceScatteringPostProcess" {
  24914. import { Nullable } from "babylonjs/types";
  24915. import { Camera } from "babylonjs/Cameras/camera";
  24916. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  24917. import { Engine } from "babylonjs/Engines/engine";
  24918. import { Scene } from "babylonjs/scene";
  24919. import "babylonjs/Shaders/imageProcessing.fragment";
  24920. import "babylonjs/Shaders/subSurfaceScattering.fragment";
  24921. import "babylonjs/Shaders/postprocess.vertex";
  24922. /**
  24923. * Sub surface scattering post process
  24924. */
  24925. export class SubSurfaceScatteringPostProcess extends PostProcess {
  24926. /** @hidden */
  24927. texelWidth: number;
  24928. /** @hidden */
  24929. texelHeight: number;
  24930. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  24931. }
  24932. }
  24933. declare module "babylonjs/Rendering/prePassEffectConfiguration" {
  24934. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  24935. /**
  24936. * Interface for defining prepass effects in the prepass post-process pipeline
  24937. */
  24938. export interface PrePassEffectConfiguration {
  24939. /**
  24940. * Post process to attach for this effect
  24941. */
  24942. postProcess: PostProcess;
  24943. /**
  24944. * Is the effect enabled
  24945. */
  24946. enabled: boolean;
  24947. /**
  24948. * Disposes the effect configuration
  24949. */
  24950. dispose(): void;
  24951. /**
  24952. * Disposes the effect configuration
  24953. */
  24954. createPostProcess: () => PostProcess;
  24955. }
  24956. }
  24957. declare module "babylonjs/Rendering/subSurfaceConfiguration" {
  24958. import { Scene } from "babylonjs/scene";
  24959. import { Color3 } from "babylonjs/Maths/math.color";
  24960. import { SubSurfaceScatteringPostProcess } from "babylonjs/PostProcesses/subSurfaceScatteringPostProcess";
  24961. import { PrePassEffectConfiguration } from "babylonjs/Rendering/prePassEffectConfiguration";
  24962. /**
  24963. * Contains all parameters needed for the prepass to perform
  24964. * screen space subsurface scattering
  24965. */
  24966. export class SubSurfaceConfiguration implements PrePassEffectConfiguration {
  24967. private _ssDiffusionS;
  24968. private _ssFilterRadii;
  24969. private _ssDiffusionD;
  24970. /**
  24971. * Post process to attach for screen space subsurface scattering
  24972. */
  24973. postProcess: SubSurfaceScatteringPostProcess;
  24974. /**
  24975. * Diffusion profile color for subsurface scattering
  24976. */
  24977. get ssDiffusionS(): number[];
  24978. /**
  24979. * Diffusion profile max color channel value for subsurface scattering
  24980. */
  24981. get ssDiffusionD(): number[];
  24982. /**
  24983. * Diffusion profile filter radius for subsurface scattering
  24984. */
  24985. get ssFilterRadii(): number[];
  24986. /**
  24987. * Is subsurface enabled
  24988. */
  24989. enabled: boolean;
  24990. /**
  24991. * Diffusion profile colors for subsurface scattering
  24992. * You can add one diffusion color using `addDiffusionProfile` on `scene.prePassRenderer`
  24993. * See ...
  24994. * Note that you can only store up to 5 of them
  24995. */
  24996. ssDiffusionProfileColors: Color3[];
  24997. /**
  24998. * Defines the ratio real world => scene units.
  24999. * Used for subsurface scattering
  25000. */
  25001. metersPerUnit: number;
  25002. private _scene;
  25003. /**
  25004. * Builds a subsurface configuration object
  25005. * @param scene The scene
  25006. */
  25007. constructor(scene: Scene);
  25008. /**
  25009. * Adds a new diffusion profile.
  25010. * Useful for more realistic subsurface scattering on diverse materials.
  25011. * @param color The color of the diffusion profile. Should be the average color of the material.
  25012. * @return The index of the diffusion profile for the material subsurface configuration
  25013. */
  25014. addDiffusionProfile(color: Color3): number;
  25015. /**
  25016. * Creates the sss post process
  25017. * @return The created post process
  25018. */
  25019. createPostProcess(): SubSurfaceScatteringPostProcess;
  25020. /**
  25021. * Deletes all diffusion profiles.
  25022. * Note that in order to render subsurface scattering, you should have at least 1 diffusion profile.
  25023. */
  25024. clearAllDiffusionProfiles(): void;
  25025. /**
  25026. * Disposes this object
  25027. */
  25028. dispose(): void;
  25029. /**
  25030. * @hidden
  25031. * https://zero-radiance.github.io/post/sampling-diffusion/
  25032. *
  25033. * Importance sample the normalized diffuse reflectance profile for the computed value of 's'.
  25034. * ------------------------------------------------------------------------------------
  25035. * R[r, phi, s] = s * (Exp[-r * s] + Exp[-r * s / 3]) / (8 * Pi * r)
  25036. * PDF[r, phi, s] = r * R[r, phi, s]
  25037. * CDF[r, s] = 1 - 1/4 * Exp[-r * s] - 3/4 * Exp[-r * s / 3]
  25038. * ------------------------------------------------------------------------------------
  25039. * We importance sample the color channel with the widest scattering distance.
  25040. */
  25041. getDiffusionProfileParameters(color: Color3): number;
  25042. /**
  25043. * Performs sampling of a Normalized Burley diffusion profile in polar coordinates.
  25044. * 'u' is the random number (the value of the CDF): [0, 1).
  25045. * rcp(s) = 1 / ShapeParam = ScatteringDistance.
  25046. * Returns the sampled radial distance, s.t. (u = 0 -> r = 0) and (u = 1 -> r = Inf).
  25047. */
  25048. private _sampleBurleyDiffusionProfile;
  25049. }
  25050. }
  25051. declare module "babylonjs/Rendering/prePassRenderer" {
  25052. import { MultiRenderTarget } from "babylonjs/Materials/Textures/multiRenderTarget";
  25053. import { Scene } from "babylonjs/scene";
  25054. import { ImageProcessingPostProcess } from "babylonjs/PostProcesses/imageProcessingPostProcess";
  25055. import { Effect } from "babylonjs/Materials/effect";
  25056. import { SubSurfaceConfiguration } from "babylonjs/Rendering/subSurfaceConfiguration";
  25057. /**
  25058. * Renders a pre pass of the scene
  25059. * This means every mesh in the scene will be rendered to a render target texture
  25060. * And then this texture will be composited to the rendering canvas with post processes
  25061. * It is necessary for effects like subsurface scattering or deferred shading
  25062. */
  25063. export class PrePassRenderer {
  25064. /** @hidden */
  25065. static _SceneComponentInitialization: (scene: Scene) => void;
  25066. private _scene;
  25067. private _engine;
  25068. private _isDirty;
  25069. /**
  25070. * Number of textures in the multi render target texture where the scene is directly rendered
  25071. */
  25072. readonly mrtCount: number;
  25073. /**
  25074. * The render target where the scene is directly rendered
  25075. */
  25076. prePassRT: MultiRenderTarget;
  25077. private _mrtTypes;
  25078. private _multiRenderAttachments;
  25079. private _defaultAttachments;
  25080. private _clearAttachments;
  25081. private _postProcesses;
  25082. private readonly _clearColor;
  25083. /**
  25084. * Image processing post process for composition
  25085. */
  25086. imageProcessingPostProcess: ImageProcessingPostProcess;
  25087. /**
  25088. * Configuration for sub surface scattering post process
  25089. */
  25090. subSurfaceConfiguration: SubSurfaceConfiguration;
  25091. /**
  25092. * Should materials render their geometry on the MRT
  25093. */
  25094. materialsShouldRenderGeometry: boolean;
  25095. /**
  25096. * Should materials render the irradiance information on the MRT
  25097. */
  25098. materialsShouldRenderIrradiance: boolean;
  25099. private _enabled;
  25100. /**
  25101. * Indicates if the prepass is enabled
  25102. */
  25103. get enabled(): boolean;
  25104. /**
  25105. * How many samples are used for MSAA of the scene render target
  25106. */
  25107. get samples(): number;
  25108. set samples(n: number);
  25109. /**
  25110. * Instanciates a prepass renderer
  25111. * @param scene The scene
  25112. */
  25113. constructor(scene: Scene);
  25114. private _initializeAttachments;
  25115. private _createCompositionEffect;
  25116. /**
  25117. * Indicates if rendering a prepass is supported
  25118. */
  25119. get isSupported(): boolean;
  25120. /**
  25121. * Sets the proper output textures to draw in the engine.
  25122. * @param effect The effect that is drawn. It can be or not be compatible with drawing to several output textures.
  25123. */
  25124. bindAttachmentsForEffect(effect: Effect): void;
  25125. /**
  25126. * @hidden
  25127. */
  25128. _beforeCameraDraw(): void;
  25129. /**
  25130. * @hidden
  25131. */
  25132. _afterCameraDraw(): void;
  25133. private _checkRTSize;
  25134. private _bindFrameBuffer;
  25135. /**
  25136. * Clears the scene render target (in the sense of settings pixels to the scene clear color value)
  25137. */
  25138. clear(): void;
  25139. private _setState;
  25140. private _enable;
  25141. private _disable;
  25142. private _resetPostProcessChain;
  25143. private _bindPostProcessChain;
  25144. /**
  25145. * Marks the prepass renderer as dirty, triggering a check if the prepass is necessary for the next rendering.
  25146. */
  25147. markAsDirty(): void;
  25148. private _update;
  25149. /**
  25150. * Disposes the prepass renderer.
  25151. */
  25152. dispose(): void;
  25153. }
  25154. }
  25155. declare module "babylonjs/Materials/material" {
  25156. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  25157. import { SmartArray } from "babylonjs/Misc/smartArray";
  25158. import { Observable } from "babylonjs/Misc/observable";
  25159. import { Nullable } from "babylonjs/types";
  25160. import { Scene } from "babylonjs/scene";
  25161. import { Matrix } from "babylonjs/Maths/math.vector";
  25162. import { SubMesh } from "babylonjs/Meshes/subMesh";
  25163. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  25164. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  25165. import { Effect } from "babylonjs/Materials/effect";
  25166. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  25167. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  25168. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  25169. import { IInspectable } from "babylonjs/Misc/iInspectable";
  25170. import { ShadowDepthWrapper } from "babylonjs/Materials/shadowDepthWrapper";
  25171. import { PrePassRenderer } from "babylonjs/Rendering/prePassRenderer";
  25172. import { Mesh } from "babylonjs/Meshes/mesh";
  25173. import { Animation } from "babylonjs/Animations/animation";
  25174. /**
  25175. * Options for compiling materials.
  25176. */
  25177. export interface IMaterialCompilationOptions {
  25178. /**
  25179. * Defines whether clip planes are enabled.
  25180. */
  25181. clipPlane: boolean;
  25182. /**
  25183. * Defines whether instances are enabled.
  25184. */
  25185. useInstances: boolean;
  25186. }
  25187. /**
  25188. * Options passed when calling customShaderNameResolve
  25189. */
  25190. export interface ICustomShaderNameResolveOptions {
  25191. /**
  25192. * 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
  25193. */
  25194. processFinalCode?: Nullable<(shaderType: string, code: string) => string>;
  25195. }
  25196. /**
  25197. * Base class for the main features of a material in Babylon.js
  25198. */
  25199. export class Material implements IAnimatable {
  25200. /**
  25201. * Returns the triangle fill mode
  25202. */
  25203. static readonly TriangleFillMode: number;
  25204. /**
  25205. * Returns the wireframe mode
  25206. */
  25207. static readonly WireFrameFillMode: number;
  25208. /**
  25209. * Returns the point fill mode
  25210. */
  25211. static readonly PointFillMode: number;
  25212. /**
  25213. * Returns the point list draw mode
  25214. */
  25215. static readonly PointListDrawMode: number;
  25216. /**
  25217. * Returns the line list draw mode
  25218. */
  25219. static readonly LineListDrawMode: number;
  25220. /**
  25221. * Returns the line loop draw mode
  25222. */
  25223. static readonly LineLoopDrawMode: number;
  25224. /**
  25225. * Returns the line strip draw mode
  25226. */
  25227. static readonly LineStripDrawMode: number;
  25228. /**
  25229. * Returns the triangle strip draw mode
  25230. */
  25231. static readonly TriangleStripDrawMode: number;
  25232. /**
  25233. * Returns the triangle fan draw mode
  25234. */
  25235. static readonly TriangleFanDrawMode: number;
  25236. /**
  25237. * Stores the clock-wise side orientation
  25238. */
  25239. static readonly ClockWiseSideOrientation: number;
  25240. /**
  25241. * Stores the counter clock-wise side orientation
  25242. */
  25243. static readonly CounterClockWiseSideOrientation: number;
  25244. /**
  25245. * The dirty texture flag value
  25246. */
  25247. static readonly TextureDirtyFlag: number;
  25248. /**
  25249. * The dirty light flag value
  25250. */
  25251. static readonly LightDirtyFlag: number;
  25252. /**
  25253. * The dirty fresnel flag value
  25254. */
  25255. static readonly FresnelDirtyFlag: number;
  25256. /**
  25257. * The dirty attribute flag value
  25258. */
  25259. static readonly AttributesDirtyFlag: number;
  25260. /**
  25261. * The dirty misc flag value
  25262. */
  25263. static readonly MiscDirtyFlag: number;
  25264. /**
  25265. * The all dirty flag value
  25266. */
  25267. static readonly AllDirtyFlag: number;
  25268. /**
  25269. * MaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  25270. */
  25271. static readonly MATERIAL_OPAQUE: number;
  25272. /**
  25273. * MaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  25274. */
  25275. static readonly MATERIAL_ALPHATEST: number;
  25276. /**
  25277. * MaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  25278. */
  25279. static readonly MATERIAL_ALPHABLEND: number;
  25280. /**
  25281. * MaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  25282. * They are also discarded below the alpha cutoff threshold to improve performances.
  25283. */
  25284. static readonly MATERIAL_ALPHATESTANDBLEND: number;
  25285. /**
  25286. * The Whiteout method is used to blend normals.
  25287. * Details of the algorithm can be found here: https://blog.selfshadow.com/publications/blending-in-detail/
  25288. */
  25289. static readonly MATERIAL_NORMALBLENDMETHOD_WHITEOUT: number;
  25290. /**
  25291. * The Reoriented Normal Mapping method is used to blend normals.
  25292. * Details of the algorithm can be found here: https://blog.selfshadow.com/publications/blending-in-detail/
  25293. */
  25294. static readonly MATERIAL_NORMALBLENDMETHOD_RNM: number;
  25295. /**
  25296. * Custom callback helping to override the default shader used in the material.
  25297. */
  25298. customShaderNameResolve: (shaderName: string, uniforms: string[], uniformBuffers: string[], samplers: string[], defines: MaterialDefines | string[], attributes?: string[], options?: ICustomShaderNameResolveOptions) => string;
  25299. /**
  25300. * Custom shadow depth material to use for shadow rendering instead of the in-built one
  25301. */
  25302. shadowDepthWrapper: Nullable<ShadowDepthWrapper>;
  25303. /**
  25304. * Gets or sets a boolean indicating that the material is allowed (if supported) to do shader hot swapping.
  25305. * This means that the material can keep using a previous shader while a new one is being compiled.
  25306. * This is mostly used when shader parallel compilation is supported (true by default)
  25307. */
  25308. allowShaderHotSwapping: boolean;
  25309. /**
  25310. * The ID of the material
  25311. */
  25312. id: string;
  25313. /**
  25314. * Gets or sets the unique id of the material
  25315. */
  25316. uniqueId: number;
  25317. /**
  25318. * The name of the material
  25319. */
  25320. name: string;
  25321. /**
  25322. * Gets or sets user defined metadata
  25323. */
  25324. metadata: any;
  25325. /**
  25326. * For internal use only. Please do not use.
  25327. */
  25328. reservedDataStore: any;
  25329. /**
  25330. * Specifies if the ready state should be checked on each call
  25331. */
  25332. checkReadyOnEveryCall: boolean;
  25333. /**
  25334. * Specifies if the ready state should be checked once
  25335. */
  25336. checkReadyOnlyOnce: boolean;
  25337. /**
  25338. * The state of the material
  25339. */
  25340. state: string;
  25341. /**
  25342. * If the material can be rendered to several textures with MRT extension
  25343. */
  25344. get canRenderToMRT(): boolean;
  25345. /**
  25346. * The alpha value of the material
  25347. */
  25348. protected _alpha: number;
  25349. /**
  25350. * List of inspectable custom properties (used by the Inspector)
  25351. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  25352. */
  25353. inspectableCustomProperties: IInspectable[];
  25354. /**
  25355. * Sets the alpha value of the material
  25356. */
  25357. set alpha(value: number);
  25358. /**
  25359. * Gets the alpha value of the material
  25360. */
  25361. get alpha(): number;
  25362. /**
  25363. * Specifies if back face culling is enabled
  25364. */
  25365. protected _backFaceCulling: boolean;
  25366. /**
  25367. * Sets the back-face culling state
  25368. */
  25369. set backFaceCulling(value: boolean);
  25370. /**
  25371. * Gets the back-face culling state
  25372. */
  25373. get backFaceCulling(): boolean;
  25374. /**
  25375. * Stores the value for side orientation
  25376. */
  25377. sideOrientation: number;
  25378. /**
  25379. * Callback triggered when the material is compiled
  25380. */
  25381. onCompiled: Nullable<(effect: Effect) => void>;
  25382. /**
  25383. * Callback triggered when an error occurs
  25384. */
  25385. onError: Nullable<(effect: Effect, errors: string) => void>;
  25386. /**
  25387. * Callback triggered to get the render target textures
  25388. */
  25389. getRenderTargetTextures: Nullable<() => SmartArray<RenderTargetTexture>>;
  25390. /**
  25391. * Gets a boolean indicating that current material needs to register RTT
  25392. */
  25393. get hasRenderTargetTextures(): boolean;
  25394. /**
  25395. * Specifies if the material should be serialized
  25396. */
  25397. doNotSerialize: boolean;
  25398. /**
  25399. * @hidden
  25400. */
  25401. _storeEffectOnSubMeshes: boolean;
  25402. /**
  25403. * Stores the animations for the material
  25404. */
  25405. animations: Nullable<Array<Animation>>;
  25406. /**
  25407. * An event triggered when the material is disposed
  25408. */
  25409. onDisposeObservable: Observable<Material>;
  25410. /**
  25411. * An observer which watches for dispose events
  25412. */
  25413. private _onDisposeObserver;
  25414. private _onUnBindObservable;
  25415. /**
  25416. * Called during a dispose event
  25417. */
  25418. set onDispose(callback: () => void);
  25419. private _onBindObservable;
  25420. /**
  25421. * An event triggered when the material is bound
  25422. */
  25423. get onBindObservable(): Observable<AbstractMesh>;
  25424. /**
  25425. * An observer which watches for bind events
  25426. */
  25427. private _onBindObserver;
  25428. /**
  25429. * Called during a bind event
  25430. */
  25431. set onBind(callback: (Mesh: AbstractMesh) => void);
  25432. /**
  25433. * An event triggered when the material is unbound
  25434. */
  25435. get onUnBindObservable(): Observable<Material>;
  25436. protected _onEffectCreatedObservable: Nullable<Observable<{
  25437. effect: Effect;
  25438. subMesh: Nullable<SubMesh>;
  25439. }>>;
  25440. /**
  25441. * An event triggered when the effect is (re)created
  25442. */
  25443. get onEffectCreatedObservable(): Observable<{
  25444. effect: Effect;
  25445. subMesh: Nullable<SubMesh>;
  25446. }>;
  25447. /**
  25448. * Stores the value of the alpha mode
  25449. */
  25450. private _alphaMode;
  25451. /**
  25452. * Sets the value of the alpha mode.
  25453. *
  25454. * | Value | Type | Description |
  25455. * | --- | --- | --- |
  25456. * | 0 | ALPHA_DISABLE | |
  25457. * | 1 | ALPHA_ADD | |
  25458. * | 2 | ALPHA_COMBINE | |
  25459. * | 3 | ALPHA_SUBTRACT | |
  25460. * | 4 | ALPHA_MULTIPLY | |
  25461. * | 5 | ALPHA_MAXIMIZED | |
  25462. * | 6 | ALPHA_ONEONE | |
  25463. * | 7 | ALPHA_PREMULTIPLIED | |
  25464. * | 8 | ALPHA_PREMULTIPLIED_PORTERDUFF | |
  25465. * | 9 | ALPHA_INTERPOLATE | |
  25466. * | 10 | ALPHA_SCREENMODE | |
  25467. *
  25468. */
  25469. set alphaMode(value: number);
  25470. /**
  25471. * Gets the value of the alpha mode
  25472. */
  25473. get alphaMode(): number;
  25474. /**
  25475. * Stores the state of the need depth pre-pass value
  25476. */
  25477. private _needDepthPrePass;
  25478. /**
  25479. * Sets the need depth pre-pass value
  25480. */
  25481. set needDepthPrePass(value: boolean);
  25482. /**
  25483. * Gets the depth pre-pass value
  25484. */
  25485. get needDepthPrePass(): boolean;
  25486. /**
  25487. * Specifies if depth writing should be disabled
  25488. */
  25489. disableDepthWrite: boolean;
  25490. /**
  25491. * Specifies if color writing should be disabled
  25492. */
  25493. disableColorWrite: boolean;
  25494. /**
  25495. * Specifies if depth writing should be forced
  25496. */
  25497. forceDepthWrite: boolean;
  25498. /**
  25499. * Specifies the depth function that should be used. 0 means the default engine function
  25500. */
  25501. depthFunction: number;
  25502. /**
  25503. * Specifies if there should be a separate pass for culling
  25504. */
  25505. separateCullingPass: boolean;
  25506. /**
  25507. * Stores the state specifing if fog should be enabled
  25508. */
  25509. private _fogEnabled;
  25510. /**
  25511. * Sets the state for enabling fog
  25512. */
  25513. set fogEnabled(value: boolean);
  25514. /**
  25515. * Gets the value of the fog enabled state
  25516. */
  25517. get fogEnabled(): boolean;
  25518. /**
  25519. * Stores the size of points
  25520. */
  25521. pointSize: number;
  25522. /**
  25523. * Stores the z offset value
  25524. */
  25525. zOffset: number;
  25526. get wireframe(): boolean;
  25527. /**
  25528. * Sets the state of wireframe mode
  25529. */
  25530. set wireframe(value: boolean);
  25531. /**
  25532. * Gets the value specifying if point clouds are enabled
  25533. */
  25534. get pointsCloud(): boolean;
  25535. /**
  25536. * Sets the state of point cloud mode
  25537. */
  25538. set pointsCloud(value: boolean);
  25539. /**
  25540. * Gets the material fill mode
  25541. */
  25542. get fillMode(): number;
  25543. /**
  25544. * Sets the material fill mode
  25545. */
  25546. set fillMode(value: number);
  25547. /**
  25548. * @hidden
  25549. * Stores the effects for the material
  25550. */
  25551. _effect: Nullable<Effect>;
  25552. /**
  25553. * Specifies if uniform buffers should be used
  25554. */
  25555. private _useUBO;
  25556. /**
  25557. * Stores a reference to the scene
  25558. */
  25559. private _scene;
  25560. /**
  25561. * Stores the fill mode state
  25562. */
  25563. private _fillMode;
  25564. /**
  25565. * Specifies if the depth write state should be cached
  25566. */
  25567. private _cachedDepthWriteState;
  25568. /**
  25569. * Specifies if the color write state should be cached
  25570. */
  25571. private _cachedColorWriteState;
  25572. /**
  25573. * Specifies if the depth function state should be cached
  25574. */
  25575. private _cachedDepthFunctionState;
  25576. /**
  25577. * Stores the uniform buffer
  25578. */
  25579. protected _uniformBuffer: UniformBuffer;
  25580. /** @hidden */
  25581. _indexInSceneMaterialArray: number;
  25582. /** @hidden */
  25583. meshMap: Nullable<{
  25584. [id: string]: AbstractMesh | undefined;
  25585. }>;
  25586. /**
  25587. * Creates a material instance
  25588. * @param name defines the name of the material
  25589. * @param scene defines the scene to reference
  25590. * @param doNotAdd specifies if the material should be added to the scene
  25591. */
  25592. constructor(name: string, scene: Scene, doNotAdd?: boolean);
  25593. /**
  25594. * Returns a string representation of the current material
  25595. * @param fullDetails defines a boolean indicating which levels of logging is desired
  25596. * @returns a string with material information
  25597. */
  25598. toString(fullDetails?: boolean): string;
  25599. /**
  25600. * Gets the class name of the material
  25601. * @returns a string with the class name of the material
  25602. */
  25603. getClassName(): string;
  25604. /**
  25605. * Specifies if updates for the material been locked
  25606. */
  25607. get isFrozen(): boolean;
  25608. /**
  25609. * Locks updates for the material
  25610. */
  25611. freeze(): void;
  25612. /**
  25613. * Unlocks updates for the material
  25614. */
  25615. unfreeze(): void;
  25616. /**
  25617. * Specifies if the material is ready to be used
  25618. * @param mesh defines the mesh to check
  25619. * @param useInstances specifies if instances should be used
  25620. * @returns a boolean indicating if the material is ready to be used
  25621. */
  25622. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  25623. /**
  25624. * Specifies that the submesh is ready to be used
  25625. * @param mesh defines the mesh to check
  25626. * @param subMesh defines which submesh to check
  25627. * @param useInstances specifies that instances should be used
  25628. * @returns a boolean indicating that the submesh is ready or not
  25629. */
  25630. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  25631. /**
  25632. * Returns the material effect
  25633. * @returns the effect associated with the material
  25634. */
  25635. getEffect(): Nullable<Effect>;
  25636. /**
  25637. * Returns the current scene
  25638. * @returns a Scene
  25639. */
  25640. getScene(): Scene;
  25641. /**
  25642. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  25643. */
  25644. protected _forceAlphaTest: boolean;
  25645. /**
  25646. * The transparency mode of the material.
  25647. */
  25648. protected _transparencyMode: Nullable<number>;
  25649. /**
  25650. * Gets the current transparency mode.
  25651. */
  25652. get transparencyMode(): Nullable<number>;
  25653. /**
  25654. * Sets the transparency mode of the material.
  25655. *
  25656. * | Value | Type | Description |
  25657. * | ----- | ----------------------------------- | ----------- |
  25658. * | 0 | OPAQUE | |
  25659. * | 1 | ALPHATEST | |
  25660. * | 2 | ALPHABLEND | |
  25661. * | 3 | ALPHATESTANDBLEND | |
  25662. *
  25663. */
  25664. set transparencyMode(value: Nullable<number>);
  25665. /**
  25666. * Returns true if alpha blending should be disabled.
  25667. */
  25668. protected get _disableAlphaBlending(): boolean;
  25669. /**
  25670. * Specifies whether or not this material should be rendered in alpha blend mode.
  25671. * @returns a boolean specifying if alpha blending is needed
  25672. */
  25673. needAlphaBlending(): boolean;
  25674. /**
  25675. * Specifies if the mesh will require alpha blending
  25676. * @param mesh defines the mesh to check
  25677. * @returns a boolean specifying if alpha blending is needed for the mesh
  25678. */
  25679. needAlphaBlendingForMesh(mesh: AbstractMesh): boolean;
  25680. /**
  25681. * Specifies whether or not this material should be rendered in alpha test mode.
  25682. * @returns a boolean specifying if an alpha test is needed.
  25683. */
  25684. needAlphaTesting(): boolean;
  25685. /**
  25686. * Specifies if material alpha testing should be turned on for the mesh
  25687. * @param mesh defines the mesh to check
  25688. */
  25689. protected _shouldTurnAlphaTestOn(mesh: AbstractMesh): boolean;
  25690. /**
  25691. * Gets the texture used for the alpha test
  25692. * @returns the texture to use for alpha testing
  25693. */
  25694. getAlphaTestTexture(): Nullable<BaseTexture>;
  25695. /**
  25696. * Marks the material to indicate that it needs to be re-calculated
  25697. */
  25698. markDirty(): void;
  25699. /** @hidden */
  25700. _preBind(effect?: Effect, overrideOrientation?: Nullable<number>): boolean;
  25701. /**
  25702. * Binds the material to the mesh
  25703. * @param world defines the world transformation matrix
  25704. * @param mesh defines the mesh to bind the material to
  25705. */
  25706. bind(world: Matrix, mesh?: Mesh): void;
  25707. /**
  25708. * Binds the submesh to the material
  25709. * @param world defines the world transformation matrix
  25710. * @param mesh defines the mesh containing the submesh
  25711. * @param subMesh defines the submesh to bind the material to
  25712. */
  25713. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  25714. /**
  25715. * Binds the world matrix to the material
  25716. * @param world defines the world transformation matrix
  25717. */
  25718. bindOnlyWorldMatrix(world: Matrix): void;
  25719. /**
  25720. * Binds the scene's uniform buffer to the effect.
  25721. * @param effect defines the effect to bind to the scene uniform buffer
  25722. * @param sceneUbo defines the uniform buffer storing scene data
  25723. */
  25724. bindSceneUniformBuffer(effect: Effect, sceneUbo: UniformBuffer): void;
  25725. /**
  25726. * Binds the view matrix to the effect
  25727. * @param effect defines the effect to bind the view matrix to
  25728. */
  25729. bindView(effect: Effect): void;
  25730. /**
  25731. * Binds the view projection matrix to the effect
  25732. * @param effect defines the effect to bind the view projection matrix to
  25733. */
  25734. bindViewProjection(effect: Effect): void;
  25735. /**
  25736. * Processes to execute after binding the material to a mesh
  25737. * @param mesh defines the rendered mesh
  25738. */
  25739. protected _afterBind(mesh?: Mesh): void;
  25740. /**
  25741. * Unbinds the material from the mesh
  25742. */
  25743. unbind(): void;
  25744. /**
  25745. * Gets the active textures from the material
  25746. * @returns an array of textures
  25747. */
  25748. getActiveTextures(): BaseTexture[];
  25749. /**
  25750. * Specifies if the material uses a texture
  25751. * @param texture defines the texture to check against the material
  25752. * @returns a boolean specifying if the material uses the texture
  25753. */
  25754. hasTexture(texture: BaseTexture): boolean;
  25755. /**
  25756. * Makes a duplicate of the material, and gives it a new name
  25757. * @param name defines the new name for the duplicated material
  25758. * @returns the cloned material
  25759. */
  25760. clone(name: string): Nullable<Material>;
  25761. /**
  25762. * Gets the meshes bound to the material
  25763. * @returns an array of meshes bound to the material
  25764. */
  25765. getBindedMeshes(): AbstractMesh[];
  25766. /**
  25767. * Force shader compilation
  25768. * @param mesh defines the mesh associated with this material
  25769. * @param onCompiled defines a function to execute once the material is compiled
  25770. * @param options defines the options to configure the compilation
  25771. * @param onError defines a function to execute if the material fails compiling
  25772. */
  25773. forceCompilation(mesh: AbstractMesh, onCompiled?: (material: Material) => void, options?: Partial<IMaterialCompilationOptions>, onError?: (reason: string) => void): void;
  25774. /**
  25775. * Force shader compilation
  25776. * @param mesh defines the mesh that will use this material
  25777. * @param options defines additional options for compiling the shaders
  25778. * @returns a promise that resolves when the compilation completes
  25779. */
  25780. forceCompilationAsync(mesh: AbstractMesh, options?: Partial<IMaterialCompilationOptions>): Promise<void>;
  25781. private static readonly _AllDirtyCallBack;
  25782. private static readonly _ImageProcessingDirtyCallBack;
  25783. private static readonly _TextureDirtyCallBack;
  25784. private static readonly _FresnelDirtyCallBack;
  25785. private static readonly _MiscDirtyCallBack;
  25786. private static readonly _LightsDirtyCallBack;
  25787. private static readonly _AttributeDirtyCallBack;
  25788. private static _FresnelAndMiscDirtyCallBack;
  25789. private static _TextureAndMiscDirtyCallBack;
  25790. private static readonly _DirtyCallbackArray;
  25791. private static readonly _RunDirtyCallBacks;
  25792. /**
  25793. * Marks a define in the material to indicate that it needs to be re-computed
  25794. * @param flag defines a flag used to determine which parts of the material have to be marked as dirty
  25795. */
  25796. markAsDirty(flag: number): void;
  25797. /**
  25798. * Marks all submeshes of a material to indicate that their material defines need to be re-calculated
  25799. * @param func defines a function which checks material defines against the submeshes
  25800. */
  25801. protected _markAllSubMeshesAsDirty(func: (defines: MaterialDefines) => void): void;
  25802. /**
  25803. * Indicates that the scene should check if the rendering now needs a prepass
  25804. */
  25805. protected _markScenePrePassDirty(): void;
  25806. /**
  25807. * Indicates that we need to re-calculated for all submeshes
  25808. */
  25809. protected _markAllSubMeshesAsAllDirty(): void;
  25810. /**
  25811. * Indicates that image processing needs to be re-calculated for all submeshes
  25812. */
  25813. protected _markAllSubMeshesAsImageProcessingDirty(): void;
  25814. /**
  25815. * Indicates that textures need to be re-calculated for all submeshes
  25816. */
  25817. protected _markAllSubMeshesAsTexturesDirty(): void;
  25818. /**
  25819. * Indicates that fresnel needs to be re-calculated for all submeshes
  25820. */
  25821. protected _markAllSubMeshesAsFresnelDirty(): void;
  25822. /**
  25823. * Indicates that fresnel and misc need to be re-calculated for all submeshes
  25824. */
  25825. protected _markAllSubMeshesAsFresnelAndMiscDirty(): void;
  25826. /**
  25827. * Indicates that lights need to be re-calculated for all submeshes
  25828. */
  25829. protected _markAllSubMeshesAsLightsDirty(): void;
  25830. /**
  25831. * Indicates that attributes need to be re-calculated for all submeshes
  25832. */
  25833. protected _markAllSubMeshesAsAttributesDirty(): void;
  25834. /**
  25835. * Indicates that misc needs to be re-calculated for all submeshes
  25836. */
  25837. protected _markAllSubMeshesAsMiscDirty(): void;
  25838. /**
  25839. * Indicates that textures and misc need to be re-calculated for all submeshes
  25840. */
  25841. protected _markAllSubMeshesAsTexturesAndMiscDirty(): void;
  25842. /**
  25843. * Sets the required values to the prepass renderer.
  25844. * @param prePassRenderer defines the prepass renderer to setup.
  25845. * @returns true if the pre pass is needed.
  25846. */
  25847. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  25848. /**
  25849. * Disposes the material
  25850. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  25851. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  25852. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  25853. */
  25854. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  25855. /** @hidden */
  25856. private releaseVertexArrayObject;
  25857. /**
  25858. * Serializes this material
  25859. * @returns the serialized material object
  25860. */
  25861. serialize(): any;
  25862. /**
  25863. * Creates a material from parsed material data
  25864. * @param parsedMaterial defines parsed material data
  25865. * @param scene defines the hosting scene
  25866. * @param rootUrl defines the root URL to use to load textures
  25867. * @returns a new material
  25868. */
  25869. static Parse(parsedMaterial: any, scene: Scene, rootUrl: string): Nullable<Material>;
  25870. }
  25871. }
  25872. declare module "babylonjs/Materials/multiMaterial" {
  25873. import { Nullable } from "babylonjs/types";
  25874. import { Scene } from "babylonjs/scene";
  25875. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  25876. import { SubMesh } from "babylonjs/Meshes/subMesh";
  25877. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  25878. import { Material } from "babylonjs/Materials/material";
  25879. /**
  25880. * A multi-material is used to apply different materials to different parts of the same object without the need of
  25881. * separate meshes. This can be use to improve performances.
  25882. * @see https://doc.babylonjs.com/how_to/multi_materials
  25883. */
  25884. export class MultiMaterial extends Material {
  25885. private _subMaterials;
  25886. /**
  25887. * Gets or Sets the list of Materials used within the multi material.
  25888. * They need to be ordered according to the submeshes order in the associated mesh
  25889. */
  25890. get subMaterials(): Nullable<Material>[];
  25891. set subMaterials(value: Nullable<Material>[]);
  25892. /**
  25893. * Function used to align with Node.getChildren()
  25894. * @returns the list of Materials used within the multi material
  25895. */
  25896. getChildren(): Nullable<Material>[];
  25897. /**
  25898. * Instantiates a new Multi Material
  25899. * A multi-material is used to apply different materials to different parts of the same object without the need of
  25900. * separate meshes. This can be use to improve performances.
  25901. * @see https://doc.babylonjs.com/how_to/multi_materials
  25902. * @param name Define the name in the scene
  25903. * @param scene Define the scene the material belongs to
  25904. */
  25905. constructor(name: string, scene: Scene);
  25906. private _hookArray;
  25907. /**
  25908. * Get one of the submaterial by its index in the submaterials array
  25909. * @param index The index to look the sub material at
  25910. * @returns The Material if the index has been defined
  25911. */
  25912. getSubMaterial(index: number): Nullable<Material>;
  25913. /**
  25914. * Get the list of active textures for the whole sub materials list.
  25915. * @returns All the textures that will be used during the rendering
  25916. */
  25917. getActiveTextures(): BaseTexture[];
  25918. /**
  25919. * Gets the current class name of the material e.g. "MultiMaterial"
  25920. * Mainly use in serialization.
  25921. * @returns the class name
  25922. */
  25923. getClassName(): string;
  25924. /**
  25925. * Checks if the material is ready to render the requested sub mesh
  25926. * @param mesh Define the mesh the submesh belongs to
  25927. * @param subMesh Define the sub mesh to look readyness for
  25928. * @param useInstances Define whether or not the material is used with instances
  25929. * @returns true if ready, otherwise false
  25930. */
  25931. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  25932. /**
  25933. * Clones the current material and its related sub materials
  25934. * @param name Define the name of the newly cloned material
  25935. * @param cloneChildren Define if submaterial will be cloned or shared with the parent instance
  25936. * @returns the cloned material
  25937. */
  25938. clone(name: string, cloneChildren?: boolean): MultiMaterial;
  25939. /**
  25940. * Serializes the materials into a JSON representation.
  25941. * @returns the JSON representation
  25942. */
  25943. serialize(): any;
  25944. /**
  25945. * Dispose the material and release its associated resources
  25946. * @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)
  25947. * @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)
  25948. * @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)
  25949. */
  25950. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, forceDisposeChildren?: boolean): void;
  25951. /**
  25952. * Creates a MultiMaterial from parsed MultiMaterial data.
  25953. * @param parsedMultiMaterial defines parsed MultiMaterial data.
  25954. * @param scene defines the hosting scene
  25955. * @returns a new MultiMaterial
  25956. */
  25957. static ParseMultiMaterial(parsedMultiMaterial: any, scene: Scene): MultiMaterial;
  25958. }
  25959. }
  25960. declare module "babylonjs/Meshes/subMesh" {
  25961. import { Nullable, IndicesArray, DeepImmutable, FloatArray } from "babylonjs/types";
  25962. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  25963. import { Engine } from "babylonjs/Engines/engine";
  25964. import { IntersectionInfo } from "babylonjs/Collisions/intersectionInfo";
  25965. import { ICullable, BoundingInfo } from "babylonjs/Culling/boundingInfo";
  25966. import { Effect } from "babylonjs/Materials/effect";
  25967. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  25968. import { Plane } from "babylonjs/Maths/math.plane";
  25969. import { Collider } from "babylonjs/Collisions/collider";
  25970. import { Material } from "babylonjs/Materials/material";
  25971. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  25972. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  25973. import { Mesh } from "babylonjs/Meshes/mesh";
  25974. import { Ray } from "babylonjs/Culling/ray";
  25975. import { TrianglePickingPredicate } from "babylonjs/Culling/ray";
  25976. /**
  25977. * Defines a subdivision inside a mesh
  25978. */
  25979. export class SubMesh implements ICullable {
  25980. /** the material index to use */
  25981. materialIndex: number;
  25982. /** vertex index start */
  25983. verticesStart: number;
  25984. /** vertices count */
  25985. verticesCount: number;
  25986. /** index start */
  25987. indexStart: number;
  25988. /** indices count */
  25989. indexCount: number;
  25990. /** @hidden */
  25991. _materialDefines: Nullable<MaterialDefines>;
  25992. /** @hidden */
  25993. _materialEffect: Nullable<Effect>;
  25994. /** @hidden */
  25995. _effectOverride: Nullable<Effect>;
  25996. /**
  25997. * Gets material defines used by the effect associated to the sub mesh
  25998. */
  25999. get materialDefines(): Nullable<MaterialDefines>;
  26000. /**
  26001. * Sets material defines used by the effect associated to the sub mesh
  26002. */
  26003. set materialDefines(defines: Nullable<MaterialDefines>);
  26004. /**
  26005. * Gets associated effect
  26006. */
  26007. get effect(): Nullable<Effect>;
  26008. /**
  26009. * Sets associated effect (effect used to render this submesh)
  26010. * @param effect defines the effect to associate with
  26011. * @param defines defines the set of defines used to compile this effect
  26012. */
  26013. setEffect(effect: Nullable<Effect>, defines?: Nullable<MaterialDefines>): void;
  26014. /** @hidden */
  26015. _linesIndexCount: number;
  26016. private _mesh;
  26017. private _renderingMesh;
  26018. private _boundingInfo;
  26019. private _linesIndexBuffer;
  26020. /** @hidden */
  26021. _lastColliderWorldVertices: Nullable<Vector3[]>;
  26022. /** @hidden */
  26023. _trianglePlanes: Plane[];
  26024. /** @hidden */
  26025. _lastColliderTransformMatrix: Nullable<Matrix>;
  26026. /** @hidden */
  26027. _renderId: number;
  26028. /** @hidden */
  26029. _alphaIndex: number;
  26030. /** @hidden */
  26031. _distanceToCamera: number;
  26032. /** @hidden */
  26033. _id: number;
  26034. private _currentMaterial;
  26035. /**
  26036. * Add a new submesh to a mesh
  26037. * @param materialIndex defines the material index to use
  26038. * @param verticesStart defines vertex index start
  26039. * @param verticesCount defines vertices count
  26040. * @param indexStart defines index start
  26041. * @param indexCount defines indices count
  26042. * @param mesh defines the parent mesh
  26043. * @param renderingMesh defines an optional rendering mesh
  26044. * @param createBoundingBox defines if bounding box should be created for this submesh
  26045. * @returns the new submesh
  26046. */
  26047. static AddToMesh(materialIndex: number, verticesStart: number, verticesCount: number, indexStart: number, indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh, createBoundingBox?: boolean): SubMesh;
  26048. /**
  26049. * Creates a new submesh
  26050. * @param materialIndex defines the material index to use
  26051. * @param verticesStart defines vertex index start
  26052. * @param verticesCount defines vertices count
  26053. * @param indexStart defines index start
  26054. * @param indexCount defines indices count
  26055. * @param mesh defines the parent mesh
  26056. * @param renderingMesh defines an optional rendering mesh
  26057. * @param createBoundingBox defines if bounding box should be created for this submesh
  26058. * @param addToMesh defines a boolean indicating that the submesh must be added to the mesh.subMeshes array (true by default)
  26059. */
  26060. constructor(
  26061. /** the material index to use */
  26062. materialIndex: number,
  26063. /** vertex index start */
  26064. verticesStart: number,
  26065. /** vertices count */
  26066. verticesCount: number,
  26067. /** index start */
  26068. indexStart: number,
  26069. /** indices count */
  26070. indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh, createBoundingBox?: boolean, addToMesh?: boolean);
  26071. /**
  26072. * Returns true if this submesh covers the entire parent mesh
  26073. * @ignorenaming
  26074. */
  26075. get IsGlobal(): boolean;
  26076. /**
  26077. * Returns the submesh BoudingInfo object
  26078. * @returns current bounding info (or mesh's one if the submesh is global)
  26079. */
  26080. getBoundingInfo(): BoundingInfo;
  26081. /**
  26082. * Sets the submesh BoundingInfo
  26083. * @param boundingInfo defines the new bounding info to use
  26084. * @returns the SubMesh
  26085. */
  26086. setBoundingInfo(boundingInfo: BoundingInfo): SubMesh;
  26087. /**
  26088. * Returns the mesh of the current submesh
  26089. * @return the parent mesh
  26090. */
  26091. getMesh(): AbstractMesh;
  26092. /**
  26093. * Returns the rendering mesh of the submesh
  26094. * @returns the rendering mesh (could be different from parent mesh)
  26095. */
  26096. getRenderingMesh(): Mesh;
  26097. /**
  26098. * Returns the replacement mesh of the submesh
  26099. * @returns the replacement mesh (could be different from parent mesh)
  26100. */
  26101. getReplacementMesh(): Nullable<AbstractMesh>;
  26102. /**
  26103. * Returns the effective mesh of the submesh
  26104. * @returns the effective mesh (could be different from parent mesh)
  26105. */
  26106. getEffectiveMesh(): AbstractMesh;
  26107. /**
  26108. * Returns the submesh material
  26109. * @returns null or the current material
  26110. */
  26111. getMaterial(): Nullable<Material>;
  26112. private _IsMultiMaterial;
  26113. /**
  26114. * Sets a new updated BoundingInfo object to the submesh
  26115. * @param data defines an optional position array to use to determine the bounding info
  26116. * @returns the SubMesh
  26117. */
  26118. refreshBoundingInfo(data?: Nullable<FloatArray>): SubMesh;
  26119. /** @hidden */
  26120. _checkCollision(collider: Collider): boolean;
  26121. /**
  26122. * Updates the submesh BoundingInfo
  26123. * @param world defines the world matrix to use to update the bounding info
  26124. * @returns the submesh
  26125. */
  26126. updateBoundingInfo(world: DeepImmutable<Matrix>): SubMesh;
  26127. /**
  26128. * True is the submesh bounding box intersects the frustum defined by the passed array of planes.
  26129. * @param frustumPlanes defines the frustum planes
  26130. * @returns true if the submesh is intersecting with the frustum
  26131. */
  26132. isInFrustum(frustumPlanes: Plane[]): boolean;
  26133. /**
  26134. * True is the submesh bounding box is completely inside the frustum defined by the passed array of planes
  26135. * @param frustumPlanes defines the frustum planes
  26136. * @returns true if the submesh is inside the frustum
  26137. */
  26138. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  26139. /**
  26140. * Renders the submesh
  26141. * @param enableAlphaMode defines if alpha needs to be used
  26142. * @returns the submesh
  26143. */
  26144. render(enableAlphaMode: boolean): SubMesh;
  26145. /**
  26146. * @hidden
  26147. */
  26148. _getLinesIndexBuffer(indices: IndicesArray, engine: Engine): DataBuffer;
  26149. /**
  26150. * Checks if the submesh intersects with a ray
  26151. * @param ray defines the ray to test
  26152. * @returns true is the passed ray intersects the submesh bounding box
  26153. */
  26154. canIntersects(ray: Ray): boolean;
  26155. /**
  26156. * Intersects current submesh with a ray
  26157. * @param ray defines the ray to test
  26158. * @param positions defines mesh's positions array
  26159. * @param indices defines mesh's indices array
  26160. * @param fastCheck defines if the first intersection will be used (and not the closest)
  26161. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  26162. * @returns intersection info or null if no intersection
  26163. */
  26164. intersects(ray: Ray, positions: Vector3[], indices: IndicesArray, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<IntersectionInfo>;
  26165. /** @hidden */
  26166. private _intersectLines;
  26167. /** @hidden */
  26168. private _intersectUnIndexedLines;
  26169. /** @hidden */
  26170. private _intersectTriangles;
  26171. /** @hidden */
  26172. private _intersectUnIndexedTriangles;
  26173. /** @hidden */
  26174. _rebuild(): void;
  26175. /**
  26176. * Creates a new submesh from the passed mesh
  26177. * @param newMesh defines the new hosting mesh
  26178. * @param newRenderingMesh defines an optional rendering mesh
  26179. * @returns the new submesh
  26180. */
  26181. clone(newMesh: AbstractMesh, newRenderingMesh?: Mesh): SubMesh;
  26182. /**
  26183. * Release associated resources
  26184. */
  26185. dispose(): void;
  26186. /**
  26187. * Gets the class name
  26188. * @returns the string "SubMesh".
  26189. */
  26190. getClassName(): string;
  26191. /**
  26192. * Creates a new submesh from indices data
  26193. * @param materialIndex the index of the main mesh material
  26194. * @param startIndex the index where to start the copy in the mesh indices array
  26195. * @param indexCount the number of indices to copy then from the startIndex
  26196. * @param mesh the main mesh to create the submesh from
  26197. * @param renderingMesh the optional rendering mesh
  26198. * @returns a new submesh
  26199. */
  26200. static CreateFromIndices(materialIndex: number, startIndex: number, indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh): SubMesh;
  26201. }
  26202. }
  26203. declare module "babylonjs/Loading/sceneLoaderFlags" {
  26204. /**
  26205. * Class used to represent data loading progression
  26206. */
  26207. export class SceneLoaderFlags {
  26208. private static _ForceFullSceneLoadingForIncremental;
  26209. private static _ShowLoadingScreen;
  26210. private static _CleanBoneMatrixWeights;
  26211. private static _loggingLevel;
  26212. /**
  26213. * Gets or sets a boolean indicating if entire scene must be loaded even if scene contains incremental data
  26214. */
  26215. static get ForceFullSceneLoadingForIncremental(): boolean;
  26216. static set ForceFullSceneLoadingForIncremental(value: boolean);
  26217. /**
  26218. * Gets or sets a boolean indicating if loading screen must be displayed while loading a scene
  26219. */
  26220. static get ShowLoadingScreen(): boolean;
  26221. static set ShowLoadingScreen(value: boolean);
  26222. /**
  26223. * Defines the current logging level (while loading the scene)
  26224. * @ignorenaming
  26225. */
  26226. static get loggingLevel(): number;
  26227. static set loggingLevel(value: number);
  26228. /**
  26229. * Gets or set a boolean indicating if matrix weights must be cleaned upon loading
  26230. */
  26231. static get CleanBoneMatrixWeights(): boolean;
  26232. static set CleanBoneMatrixWeights(value: boolean);
  26233. }
  26234. }
  26235. declare module "babylonjs/Meshes/geometry" {
  26236. import { Nullable, FloatArray, DataArray, IndicesArray } from "babylonjs/types";
  26237. import { Scene } from "babylonjs/scene";
  26238. import { Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  26239. import { Engine } from "babylonjs/Engines/engine";
  26240. import { IGetSetVerticesData, VertexData } from "babylonjs/Meshes/mesh.vertexData";
  26241. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  26242. import { Effect } from "babylonjs/Materials/effect";
  26243. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  26244. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  26245. import { Mesh } from "babylonjs/Meshes/mesh";
  26246. /**
  26247. * Class used to store geometry data (vertex buffers + index buffer)
  26248. */
  26249. export class Geometry implements IGetSetVerticesData {
  26250. /**
  26251. * Gets or sets the ID of the geometry
  26252. */
  26253. id: string;
  26254. /**
  26255. * Gets or sets the unique ID of the geometry
  26256. */
  26257. uniqueId: number;
  26258. /**
  26259. * Gets the delay loading state of the geometry (none by default which means not delayed)
  26260. */
  26261. delayLoadState: number;
  26262. /**
  26263. * Gets the file containing the data to load when running in delay load state
  26264. */
  26265. delayLoadingFile: Nullable<string>;
  26266. /**
  26267. * Callback called when the geometry is updated
  26268. */
  26269. onGeometryUpdated: (geometry: Geometry, kind?: string) => void;
  26270. private _scene;
  26271. private _engine;
  26272. private _meshes;
  26273. private _totalVertices;
  26274. /** @hidden */
  26275. _indices: IndicesArray;
  26276. /** @hidden */
  26277. _vertexBuffers: {
  26278. [key: string]: VertexBuffer;
  26279. };
  26280. private _isDisposed;
  26281. private _extend;
  26282. private _boundingBias;
  26283. /** @hidden */
  26284. _delayInfo: Array<string>;
  26285. private _indexBuffer;
  26286. private _indexBufferIsUpdatable;
  26287. /** @hidden */
  26288. _boundingInfo: Nullable<BoundingInfo>;
  26289. /** @hidden */
  26290. _delayLoadingFunction: Nullable<(any: any, geometry: Geometry) => void>;
  26291. /** @hidden */
  26292. _softwareSkinningFrameId: number;
  26293. private _vertexArrayObjects;
  26294. private _updatable;
  26295. /** @hidden */
  26296. _positions: Nullable<Vector3[]>;
  26297. /**
  26298. * 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
  26299. */
  26300. get boundingBias(): Vector2;
  26301. /**
  26302. * 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
  26303. */
  26304. set boundingBias(value: Vector2);
  26305. /**
  26306. * Static function used to attach a new empty geometry to a mesh
  26307. * @param mesh defines the mesh to attach the geometry to
  26308. * @returns the new Geometry
  26309. */
  26310. static CreateGeometryForMesh(mesh: Mesh): Geometry;
  26311. /** Get the list of meshes using this geometry */
  26312. get meshes(): Mesh[];
  26313. /**
  26314. * 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
  26315. * and won't be computed based on the vertex positions (which is what we get when useBoundingInfoFromGeometry = false)
  26316. */
  26317. useBoundingInfoFromGeometry: boolean;
  26318. /**
  26319. * Creates a new geometry
  26320. * @param id defines the unique ID
  26321. * @param scene defines the hosting scene
  26322. * @param vertexData defines the VertexData used to get geometry data
  26323. * @param updatable defines if geometry must be updatable (false by default)
  26324. * @param mesh defines the mesh that will be associated with the geometry
  26325. */
  26326. constructor(id: string, scene: Scene, vertexData?: VertexData, updatable?: boolean, mesh?: Nullable<Mesh>);
  26327. /**
  26328. * Gets the current extend of the geometry
  26329. */
  26330. get extend(): {
  26331. minimum: Vector3;
  26332. maximum: Vector3;
  26333. };
  26334. /**
  26335. * Gets the hosting scene
  26336. * @returns the hosting Scene
  26337. */
  26338. getScene(): Scene;
  26339. /**
  26340. * Gets the hosting engine
  26341. * @returns the hosting Engine
  26342. */
  26343. getEngine(): Engine;
  26344. /**
  26345. * Defines if the geometry is ready to use
  26346. * @returns true if the geometry is ready to be used
  26347. */
  26348. isReady(): boolean;
  26349. /**
  26350. * Gets a value indicating that the geometry should not be serialized
  26351. */
  26352. get doNotSerialize(): boolean;
  26353. /** @hidden */
  26354. _rebuild(): void;
  26355. /**
  26356. * Affects all geometry data in one call
  26357. * @param vertexData defines the geometry data
  26358. * @param updatable defines if the geometry must be flagged as updatable (false as default)
  26359. */
  26360. setAllVerticesData(vertexData: VertexData, updatable?: boolean): void;
  26361. /**
  26362. * Set specific vertex data
  26363. * @param kind defines the data kind (Position, normal, etc...)
  26364. * @param data defines the vertex data to use
  26365. * @param updatable defines if the vertex must be flagged as updatable (false as default)
  26366. * @param stride defines the stride to use (0 by default). This value is deduced from the kind value if not specified
  26367. */
  26368. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): void;
  26369. /**
  26370. * Removes a specific vertex data
  26371. * @param kind defines the data kind (Position, normal, etc...)
  26372. */
  26373. removeVerticesData(kind: string): void;
  26374. /**
  26375. * Affect a vertex buffer to the geometry. the vertexBuffer.getKind() function is used to determine where to store the data
  26376. * @param buffer defines the vertex buffer to use
  26377. * @param totalVertices defines the total number of vertices for position kind (could be null)
  26378. */
  26379. setVerticesBuffer(buffer: VertexBuffer, totalVertices?: Nullable<number>): void;
  26380. /**
  26381. * Update a specific vertex buffer
  26382. * This function will directly update the underlying DataBuffer according to the passed numeric array or Float32Array
  26383. * It will do nothing if the buffer is not updatable
  26384. * @param kind defines the data kind (Position, normal, etc...)
  26385. * @param data defines the data to use
  26386. * @param offset defines the offset in the target buffer where to store the data
  26387. * @param useBytes set to true if the offset is in bytes
  26388. */
  26389. updateVerticesDataDirectly(kind: string, data: DataArray, offset: number, useBytes?: boolean): void;
  26390. /**
  26391. * Update a specific vertex buffer
  26392. * This function will create a new buffer if the current one is not updatable
  26393. * @param kind defines the data kind (Position, normal, etc...)
  26394. * @param data defines the data to use
  26395. * @param updateExtends defines if the geometry extends must be recomputed (false by default)
  26396. */
  26397. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean): void;
  26398. private _updateBoundingInfo;
  26399. /** @hidden */
  26400. _bind(effect: Nullable<Effect>, indexToBind?: Nullable<DataBuffer>): void;
  26401. /**
  26402. * Gets total number of vertices
  26403. * @returns the total number of vertices
  26404. */
  26405. getTotalVertices(): number;
  26406. /**
  26407. * Gets a specific vertex data attached to this geometry. Float data is constructed if the vertex buffer data cannot be returned directly.
  26408. * @param kind defines the data kind (Position, normal, etc...)
  26409. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  26410. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  26411. * @returns a float array containing vertex data
  26412. */
  26413. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  26414. /**
  26415. * Returns a boolean defining if the vertex data for the requested `kind` is updatable
  26416. * @param kind defines the data kind (Position, normal, etc...)
  26417. * @returns true if the vertex buffer with the specified kind is updatable
  26418. */
  26419. isVertexBufferUpdatable(kind: string): boolean;
  26420. /**
  26421. * Gets a specific vertex buffer
  26422. * @param kind defines the data kind (Position, normal, etc...)
  26423. * @returns a VertexBuffer
  26424. */
  26425. getVertexBuffer(kind: string): Nullable<VertexBuffer>;
  26426. /**
  26427. * Returns all vertex buffers
  26428. * @return an object holding all vertex buffers indexed by kind
  26429. */
  26430. getVertexBuffers(): Nullable<{
  26431. [key: string]: VertexBuffer;
  26432. }>;
  26433. /**
  26434. * Gets a boolean indicating if specific vertex buffer is present
  26435. * @param kind defines the data kind (Position, normal, etc...)
  26436. * @returns true if data is present
  26437. */
  26438. isVerticesDataPresent(kind: string): boolean;
  26439. /**
  26440. * Gets a list of all attached data kinds (Position, normal, etc...)
  26441. * @returns a list of string containing all kinds
  26442. */
  26443. getVerticesDataKinds(): string[];
  26444. /**
  26445. * Update index buffer
  26446. * @param indices defines the indices to store in the index buffer
  26447. * @param offset defines the offset in the target buffer where to store the data
  26448. * @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)
  26449. */
  26450. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): void;
  26451. /**
  26452. * Creates a new index buffer
  26453. * @param indices defines the indices to store in the index buffer
  26454. * @param totalVertices defines the total number of vertices (could be null)
  26455. * @param updatable defines if the index buffer must be flagged as updatable (false by default)
  26456. */
  26457. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>, updatable?: boolean): void;
  26458. /**
  26459. * Return the total number of indices
  26460. * @returns the total number of indices
  26461. */
  26462. getTotalIndices(): number;
  26463. /**
  26464. * Gets the index buffer array
  26465. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  26466. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  26467. * @returns the index buffer array
  26468. */
  26469. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  26470. /**
  26471. * Gets the index buffer
  26472. * @return the index buffer
  26473. */
  26474. getIndexBuffer(): Nullable<DataBuffer>;
  26475. /** @hidden */
  26476. _releaseVertexArrayObject(effect?: Nullable<Effect>): void;
  26477. /**
  26478. * Release the associated resources for a specific mesh
  26479. * @param mesh defines the source mesh
  26480. * @param shouldDispose defines if the geometry must be disposed if there is no more mesh pointing to it
  26481. */
  26482. releaseForMesh(mesh: Mesh, shouldDispose?: boolean): void;
  26483. /**
  26484. * Apply current geometry to a given mesh
  26485. * @param mesh defines the mesh to apply geometry to
  26486. */
  26487. applyToMesh(mesh: Mesh): void;
  26488. private _updateExtend;
  26489. private _applyToMesh;
  26490. private notifyUpdate;
  26491. /**
  26492. * Load the geometry if it was flagged as delay loaded
  26493. * @param scene defines the hosting scene
  26494. * @param onLoaded defines a callback called when the geometry is loaded
  26495. */
  26496. load(scene: Scene, onLoaded?: () => void): void;
  26497. private _queueLoad;
  26498. /**
  26499. * Invert the geometry to move from a right handed system to a left handed one.
  26500. */
  26501. toLeftHanded(): void;
  26502. /** @hidden */
  26503. _resetPointsArrayCache(): void;
  26504. /** @hidden */
  26505. _generatePointsArray(): boolean;
  26506. /**
  26507. * Gets a value indicating if the geometry is disposed
  26508. * @returns true if the geometry was disposed
  26509. */
  26510. isDisposed(): boolean;
  26511. private _disposeVertexArrayObjects;
  26512. /**
  26513. * Free all associated resources
  26514. */
  26515. dispose(): void;
  26516. /**
  26517. * Clone the current geometry into a new geometry
  26518. * @param id defines the unique ID of the new geometry
  26519. * @returns a new geometry object
  26520. */
  26521. copy(id: string): Geometry;
  26522. /**
  26523. * Serialize the current geometry info (and not the vertices data) into a JSON object
  26524. * @return a JSON representation of the current geometry data (without the vertices data)
  26525. */
  26526. serialize(): any;
  26527. private toNumberArray;
  26528. /**
  26529. * Serialize all vertices data into a JSON oject
  26530. * @returns a JSON representation of the current geometry data
  26531. */
  26532. serializeVerticeData(): any;
  26533. /**
  26534. * Extracts a clone of a mesh geometry
  26535. * @param mesh defines the source mesh
  26536. * @param id defines the unique ID of the new geometry object
  26537. * @returns the new geometry object
  26538. */
  26539. static ExtractFromMesh(mesh: Mesh, id: string): Nullable<Geometry>;
  26540. /**
  26541. * You should now use Tools.RandomId(), this method is still here for legacy reasons.
  26542. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  26543. * Be aware Math.random() could cause collisions, but:
  26544. * "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"
  26545. * @returns a string containing a new GUID
  26546. */
  26547. static RandomId(): string;
  26548. /** @hidden */
  26549. static _ImportGeometry(parsedGeometry: any, mesh: Mesh): void;
  26550. private static _CleanMatricesWeights;
  26551. /**
  26552. * Create a new geometry from persisted data (Using .babylon file format)
  26553. * @param parsedVertexData defines the persisted data
  26554. * @param scene defines the hosting scene
  26555. * @param rootUrl defines the root url to use to load assets (like delayed data)
  26556. * @returns the new geometry object
  26557. */
  26558. static Parse(parsedVertexData: any, scene: Scene, rootUrl: string): Nullable<Geometry>;
  26559. }
  26560. }
  26561. declare module "babylonjs/Meshes/mesh.vertexData" {
  26562. import { Nullable, FloatArray, IndicesArray } from "babylonjs/types";
  26563. import { Matrix, Vector3, Vector2, Vector4 } from "babylonjs/Maths/math.vector";
  26564. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  26565. import { Geometry } from "babylonjs/Meshes/geometry";
  26566. import { Mesh } from "babylonjs/Meshes/mesh";
  26567. /**
  26568. * Define an interface for all classes that will get and set the data on vertices
  26569. */
  26570. export interface IGetSetVerticesData {
  26571. /**
  26572. * Gets a boolean indicating if specific vertex data is present
  26573. * @param kind defines the vertex data kind to use
  26574. * @returns true is data kind is present
  26575. */
  26576. isVerticesDataPresent(kind: string): boolean;
  26577. /**
  26578. * Gets a specific vertex data attached to this geometry. Float data is constructed if the vertex buffer data cannot be returned directly.
  26579. * @param kind defines the data kind (Position, normal, etc...)
  26580. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  26581. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  26582. * @returns a float array containing vertex data
  26583. */
  26584. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  26585. /**
  26586. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  26587. * @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.
  26588. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  26589. * @returns the indices array or an empty array if the mesh has no geometry
  26590. */
  26591. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  26592. /**
  26593. * Set specific vertex data
  26594. * @param kind defines the data kind (Position, normal, etc...)
  26595. * @param data defines the vertex data to use
  26596. * @param updatable defines if the vertex must be flagged as updatable (false as default)
  26597. * @param stride defines the stride to use (0 by default). This value is deduced from the kind value if not specified
  26598. */
  26599. setVerticesData(kind: string, data: FloatArray, updatable: boolean): void;
  26600. /**
  26601. * Update a specific associated vertex buffer
  26602. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  26603. * - VertexBuffer.PositionKind
  26604. * - VertexBuffer.UVKind
  26605. * - VertexBuffer.UV2Kind
  26606. * - VertexBuffer.UV3Kind
  26607. * - VertexBuffer.UV4Kind
  26608. * - VertexBuffer.UV5Kind
  26609. * - VertexBuffer.UV6Kind
  26610. * - VertexBuffer.ColorKind
  26611. * - VertexBuffer.MatricesIndicesKind
  26612. * - VertexBuffer.MatricesIndicesExtraKind
  26613. * - VertexBuffer.MatricesWeightsKind
  26614. * - VertexBuffer.MatricesWeightsExtraKind
  26615. * @param data defines the data source
  26616. * @param updateExtends defines if extends info of the mesh must be updated (can be null). This is mostly useful for "position" kind
  26617. * @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)
  26618. */
  26619. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): void;
  26620. /**
  26621. * Creates a new index buffer
  26622. * @param indices defines the indices to store in the index buffer
  26623. * @param totalVertices defines the total number of vertices (could be null)
  26624. * @param updatable defines if the index buffer must be flagged as updatable (false by default)
  26625. */
  26626. setIndices(indices: IndicesArray, totalVertices: Nullable<number>, updatable?: boolean): void;
  26627. }
  26628. /**
  26629. * This class contains the various kinds of data on every vertex of a mesh used in determining its shape and appearance
  26630. */
  26631. export class VertexData {
  26632. /**
  26633. * Mesh side orientation : usually the external or front surface
  26634. */
  26635. static readonly FRONTSIDE: number;
  26636. /**
  26637. * Mesh side orientation : usually the internal or back surface
  26638. */
  26639. static readonly BACKSIDE: number;
  26640. /**
  26641. * Mesh side orientation : both internal and external or front and back surfaces
  26642. */
  26643. static readonly DOUBLESIDE: number;
  26644. /**
  26645. * Mesh side orientation : by default, `FRONTSIDE`
  26646. */
  26647. static readonly DEFAULTSIDE: number;
  26648. /**
  26649. * An array of the x, y, z position of each vertex [...., x, y, z, .....]
  26650. */
  26651. positions: Nullable<FloatArray>;
  26652. /**
  26653. * An array of the x, y, z normal vector of each vertex [...., x, y, z, .....]
  26654. */
  26655. normals: Nullable<FloatArray>;
  26656. /**
  26657. * An array of the x, y, z tangent vector of each vertex [...., x, y, z, .....]
  26658. */
  26659. tangents: Nullable<FloatArray>;
  26660. /**
  26661. * An array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  26662. */
  26663. uvs: Nullable<FloatArray>;
  26664. /**
  26665. * A second array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  26666. */
  26667. uvs2: Nullable<FloatArray>;
  26668. /**
  26669. * A third array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  26670. */
  26671. uvs3: Nullable<FloatArray>;
  26672. /**
  26673. * A fourth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  26674. */
  26675. uvs4: Nullable<FloatArray>;
  26676. /**
  26677. * A fifth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  26678. */
  26679. uvs5: Nullable<FloatArray>;
  26680. /**
  26681. * A sixth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  26682. */
  26683. uvs6: Nullable<FloatArray>;
  26684. /**
  26685. * An array of the r, g, b, a, color of each vertex [...., r, g, b, a, .....]
  26686. */
  26687. colors: Nullable<FloatArray>;
  26688. /**
  26689. * 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).
  26690. */
  26691. matricesIndices: Nullable<FloatArray>;
  26692. /**
  26693. * An array containing the list of weights defining the weight of each indexed matrix in the final computation
  26694. */
  26695. matricesWeights: Nullable<FloatArray>;
  26696. /**
  26697. * An array extending the number of possible indices
  26698. */
  26699. matricesIndicesExtra: Nullable<FloatArray>;
  26700. /**
  26701. * An array extending the number of possible weights when the number of indices is extended
  26702. */
  26703. matricesWeightsExtra: Nullable<FloatArray>;
  26704. /**
  26705. * An array of i, j, k the three vertex indices required for each triangular facet [...., i, j, k .....]
  26706. */
  26707. indices: Nullable<IndicesArray>;
  26708. /**
  26709. * Uses the passed data array to set the set the values for the specified kind of data
  26710. * @param data a linear array of floating numbers
  26711. * @param kind the type of data that is being set, eg positions, colors etc
  26712. */
  26713. set(data: FloatArray, kind: string): void;
  26714. /**
  26715. * Associates the vertexData to the passed Mesh.
  26716. * Sets it as updatable or not (default `false`)
  26717. * @param mesh the mesh the vertexData is applied to
  26718. * @param updatable when used and having the value true allows new data to update the vertexData
  26719. * @returns the VertexData
  26720. */
  26721. applyToMesh(mesh: Mesh, updatable?: boolean): VertexData;
  26722. /**
  26723. * Associates the vertexData to the passed Geometry.
  26724. * Sets it as updatable or not (default `false`)
  26725. * @param geometry the geometry the vertexData is applied to
  26726. * @param updatable when used and having the value true allows new data to update the vertexData
  26727. * @returns VertexData
  26728. */
  26729. applyToGeometry(geometry: Geometry, updatable?: boolean): VertexData;
  26730. /**
  26731. * Updates the associated mesh
  26732. * @param mesh the mesh to be updated
  26733. * @param updateExtends when true the mesh BoundingInfo will be renewed when and if position kind is updated, optional with default false
  26734. * @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
  26735. * @returns VertexData
  26736. */
  26737. updateMesh(mesh: Mesh): VertexData;
  26738. /**
  26739. * Updates the associated geometry
  26740. * @param geometry the geometry to be updated
  26741. * @param updateExtends when true BoundingInfo will be renewed when and if position kind is updated, optional with default false
  26742. * @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
  26743. * @returns VertexData.
  26744. */
  26745. updateGeometry(geometry: Geometry): VertexData;
  26746. private _applyTo;
  26747. private _update;
  26748. /**
  26749. * Transforms each position and each normal of the vertexData according to the passed Matrix
  26750. * @param matrix the transforming matrix
  26751. * @returns the VertexData
  26752. */
  26753. transform(matrix: Matrix): VertexData;
  26754. /**
  26755. * Merges the passed VertexData into the current one
  26756. * @param other the VertexData to be merged into the current one
  26757. * @param use32BitsIndices defines a boolean indicating if indices must be store in a 32 bits array
  26758. * @returns the modified VertexData
  26759. */
  26760. merge(other: VertexData, use32BitsIndices?: boolean): VertexData;
  26761. private _mergeElement;
  26762. private _validate;
  26763. /**
  26764. * Serializes the VertexData
  26765. * @returns a serialized object
  26766. */
  26767. serialize(): any;
  26768. /**
  26769. * Extracts the vertexData from a mesh
  26770. * @param mesh the mesh from which to extract the VertexData
  26771. * @param copyWhenShared defines if the VertexData must be cloned when shared between multiple meshes, optional, default false
  26772. * @param forceCopy indicating that the VertexData must be cloned, optional, default false
  26773. * @returns the object VertexData associated to the passed mesh
  26774. */
  26775. static ExtractFromMesh(mesh: Mesh, copyWhenShared?: boolean, forceCopy?: boolean): VertexData;
  26776. /**
  26777. * Extracts the vertexData from the geometry
  26778. * @param geometry the geometry from which to extract the VertexData
  26779. * @param copyWhenShared defines if the VertexData must be cloned when the geometrty is shared between multiple meshes, optional, default false
  26780. * @param forceCopy indicating that the VertexData must be cloned, optional, default false
  26781. * @returns the object VertexData associated to the passed mesh
  26782. */
  26783. static ExtractFromGeometry(geometry: Geometry, copyWhenShared?: boolean, forceCopy?: boolean): VertexData;
  26784. private static _ExtractFrom;
  26785. /**
  26786. * Creates the VertexData for a Ribbon
  26787. * @param options an object used to set the following optional parameters for the ribbon, required but can be empty
  26788. * * pathArray array of paths, each of which an array of successive Vector3
  26789. * * closeArray creates a seam between the first and the last paths of the pathArray, optional, default false
  26790. * * closePath creates a seam between the first and the last points of each path of the path array, optional, default false
  26791. * * 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
  26792. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  26793. * * 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)
  26794. * * 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)
  26795. * * invertUV swaps in the U and V coordinates when applying a texture, optional, default false
  26796. * * uvs a linear array, of length 2 * number of vertices, of custom UV values, optional
  26797. * * colors a linear array, of length 4 * number of vertices, of custom color values, optional
  26798. * @returns the VertexData of the ribbon
  26799. */
  26800. static CreateRibbon(options: {
  26801. pathArray: Vector3[][];
  26802. closeArray?: boolean;
  26803. closePath?: boolean;
  26804. offset?: number;
  26805. sideOrientation?: number;
  26806. frontUVs?: Vector4;
  26807. backUVs?: Vector4;
  26808. invertUV?: boolean;
  26809. uvs?: Vector2[];
  26810. colors?: Color4[];
  26811. }): VertexData;
  26812. /**
  26813. * Creates the VertexData for a box
  26814. * @param options an object used to set the following optional parameters for the box, required but can be empty
  26815. * * size sets the width, height and depth of the box to the value of size, optional default 1
  26816. * * width sets the width (x direction) of the box, overwrites the width set by size, optional, default size
  26817. * * height sets the height (y direction) of the box, overwrites the height set by size, optional, default size
  26818. * * depth sets the depth (z direction) of the box, overwrites the depth set by size, optional, default size
  26819. * * faceUV an array of 6 Vector4 elements used to set different images to each box side
  26820. * * faceColors an array of 6 Color3 elements used to set different colors to each box side
  26821. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  26822. * * 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)
  26823. * * 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)
  26824. * @returns the VertexData of the box
  26825. */
  26826. static CreateBox(options: {
  26827. size?: number;
  26828. width?: number;
  26829. height?: number;
  26830. depth?: number;
  26831. faceUV?: Vector4[];
  26832. faceColors?: Color4[];
  26833. sideOrientation?: number;
  26834. frontUVs?: Vector4;
  26835. backUVs?: Vector4;
  26836. }): VertexData;
  26837. /**
  26838. * Creates the VertexData for a tiled box
  26839. * @param options an object used to set the following optional parameters for the box, required but can be empty
  26840. * * faceTiles sets the pattern, tile size and number of tiles for a face
  26841. * * faceUV an array of 6 Vector4 elements used to set different images to each box side
  26842. * * faceColors an array of 6 Color3 elements used to set different colors to each box side
  26843. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  26844. * @returns the VertexData of the box
  26845. */
  26846. static CreateTiledBox(options: {
  26847. pattern?: number;
  26848. width?: number;
  26849. height?: number;
  26850. depth?: number;
  26851. tileSize?: number;
  26852. tileWidth?: number;
  26853. tileHeight?: number;
  26854. alignHorizontal?: number;
  26855. alignVertical?: number;
  26856. faceUV?: Vector4[];
  26857. faceColors?: Color4[];
  26858. sideOrientation?: number;
  26859. }): VertexData;
  26860. /**
  26861. * Creates the VertexData for a tiled plane
  26862. * @param options an object used to set the following optional parameters for the box, required but can be empty
  26863. * * pattern a limited pattern arrangement depending on the number
  26864. * * tileSize sets the width, height and depth of the tile to the value of size, optional default 1
  26865. * * tileWidth sets the width (x direction) of the tile, overwrites the width set by size, optional, default size
  26866. * * tileHeight sets the height (y direction) of the tile, overwrites the height set by size, optional, default size
  26867. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  26868. * * 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)
  26869. * * 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)
  26870. * @returns the VertexData of the tiled plane
  26871. */
  26872. static CreateTiledPlane(options: {
  26873. pattern?: number;
  26874. tileSize?: number;
  26875. tileWidth?: number;
  26876. tileHeight?: number;
  26877. size?: number;
  26878. width?: number;
  26879. height?: number;
  26880. alignHorizontal?: number;
  26881. alignVertical?: number;
  26882. sideOrientation?: number;
  26883. frontUVs?: Vector4;
  26884. backUVs?: Vector4;
  26885. }): VertexData;
  26886. /**
  26887. * Creates the VertexData for an ellipsoid, defaults to a sphere
  26888. * @param options an object used to set the following optional parameters for the box, required but can be empty
  26889. * * segments sets the number of horizontal strips optional, default 32
  26890. * * diameter sets the axes dimensions, diameterX, diameterY and diameterZ to the value of diameter, optional default 1
  26891. * * diameterX sets the diameterX (x direction) of the ellipsoid, overwrites the diameterX set by diameter, optional, default diameter
  26892. * * diameterY sets the diameterY (y direction) of the ellipsoid, overwrites the diameterY set by diameter, optional, default diameter
  26893. * * diameterZ sets the diameterZ (z direction) of the ellipsoid, overwrites the diameterZ set by diameter, optional, default diameter
  26894. * * 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
  26895. * * 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
  26896. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  26897. * * 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)
  26898. * * 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)
  26899. * @returns the VertexData of the ellipsoid
  26900. */
  26901. static CreateSphere(options: {
  26902. segments?: number;
  26903. diameter?: number;
  26904. diameterX?: number;
  26905. diameterY?: number;
  26906. diameterZ?: number;
  26907. arc?: number;
  26908. slice?: number;
  26909. sideOrientation?: number;
  26910. frontUVs?: Vector4;
  26911. backUVs?: Vector4;
  26912. }): VertexData;
  26913. /**
  26914. * Creates the VertexData for a cylinder, cone or prism
  26915. * @param options an object used to set the following optional parameters for the box, required but can be empty
  26916. * * height sets the height (y direction) of the cylinder, optional, default 2
  26917. * * diameterTop sets the diameter of the top of the cone, overwrites diameter, optional, default diameter
  26918. * * diameterBottom sets the diameter of the bottom of the cone, overwrites diameter, optional, default diameter
  26919. * * diameter sets the diameter of the top and bottom of the cone, optional default 1
  26920. * * tessellation the number of prism sides, 3 for a triangular prism, optional, default 24
  26921. * * subdivisions` the number of rings along the cylinder height, optional, default 1
  26922. * * 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
  26923. * * faceColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  26924. * * faceUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  26925. * * hasRings when true makes each subdivision independantly treated as a face for faceUV and faceColors, optional, default false
  26926. * * enclose when true closes an open cylinder by adding extra flat faces between the height axis and vertical edges, think cut cake
  26927. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  26928. * * 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)
  26929. * * 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)
  26930. * @returns the VertexData of the cylinder, cone or prism
  26931. */
  26932. static CreateCylinder(options: {
  26933. height?: number;
  26934. diameterTop?: number;
  26935. diameterBottom?: number;
  26936. diameter?: number;
  26937. tessellation?: number;
  26938. subdivisions?: number;
  26939. arc?: number;
  26940. faceColors?: Color4[];
  26941. faceUV?: Vector4[];
  26942. hasRings?: boolean;
  26943. enclose?: boolean;
  26944. sideOrientation?: number;
  26945. frontUVs?: Vector4;
  26946. backUVs?: Vector4;
  26947. }): VertexData;
  26948. /**
  26949. * Creates the VertexData for a torus
  26950. * @param options an object used to set the following optional parameters for the box, required but can be empty
  26951. * * diameter the diameter of the torus, optional default 1
  26952. * * thickness the diameter of the tube forming the torus, optional default 0.5
  26953. * * tessellation the number of prism sides, 3 for a triangular prism, optional, default 24
  26954. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  26955. * * 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)
  26956. * * 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)
  26957. * @returns the VertexData of the torus
  26958. */
  26959. static CreateTorus(options: {
  26960. diameter?: number;
  26961. thickness?: number;
  26962. tessellation?: number;
  26963. sideOrientation?: number;
  26964. frontUVs?: Vector4;
  26965. backUVs?: Vector4;
  26966. }): VertexData;
  26967. /**
  26968. * Creates the VertexData of the LineSystem
  26969. * @param options an object used to set the following optional parameters for the LineSystem, required but can be empty
  26970. * - lines an array of lines, each line being an array of successive Vector3
  26971. * - colors an array of line colors, each of the line colors being an array of successive Color4, one per line point
  26972. * @returns the VertexData of the LineSystem
  26973. */
  26974. static CreateLineSystem(options: {
  26975. lines: Vector3[][];
  26976. colors?: Nullable<Color4[][]>;
  26977. }): VertexData;
  26978. /**
  26979. * Create the VertexData for a DashedLines
  26980. * @param options an object used to set the following optional parameters for the DashedLines, required but can be empty
  26981. * - points an array successive Vector3
  26982. * - dashSize the size of the dashes relative to the dash number, optional, default 3
  26983. * - gapSize the size of the gap between two successive dashes relative to the dash number, optional, default 1
  26984. * - dashNb the intended total number of dashes, optional, default 200
  26985. * @returns the VertexData for the DashedLines
  26986. */
  26987. static CreateDashedLines(options: {
  26988. points: Vector3[];
  26989. dashSize?: number;
  26990. gapSize?: number;
  26991. dashNb?: number;
  26992. }): VertexData;
  26993. /**
  26994. * Creates the VertexData for a Ground
  26995. * @param options an object used to set the following optional parameters for the Ground, required but can be empty
  26996. * - width the width (x direction) of the ground, optional, default 1
  26997. * - height the height (z direction) of the ground, optional, default 1
  26998. * - subdivisions the number of subdivisions per side, optional, default 1
  26999. * @returns the VertexData of the Ground
  27000. */
  27001. static CreateGround(options: {
  27002. width?: number;
  27003. height?: number;
  27004. subdivisions?: number;
  27005. subdivisionsX?: number;
  27006. subdivisionsY?: number;
  27007. }): VertexData;
  27008. /**
  27009. * Creates the VertexData for a TiledGround by subdividing the ground into tiles
  27010. * @param options an object used to set the following optional parameters for the Ground, required but can be empty
  27011. * * xmin the ground minimum X coordinate, optional, default -1
  27012. * * zmin the ground minimum Z coordinate, optional, default -1
  27013. * * xmax the ground maximum X coordinate, optional, default 1
  27014. * * zmax the ground maximum Z coordinate, optional, default 1
  27015. * * 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}
  27016. * * 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}
  27017. * @returns the VertexData of the TiledGround
  27018. */
  27019. static CreateTiledGround(options: {
  27020. xmin: number;
  27021. zmin: number;
  27022. xmax: number;
  27023. zmax: number;
  27024. subdivisions?: {
  27025. w: number;
  27026. h: number;
  27027. };
  27028. precision?: {
  27029. w: number;
  27030. h: number;
  27031. };
  27032. }): VertexData;
  27033. /**
  27034. * Creates the VertexData of the Ground designed from a heightmap
  27035. * @param options an object used to set the following parameters for the Ground, required and provided by MeshBuilder.CreateGroundFromHeightMap
  27036. * * width the width (x direction) of the ground
  27037. * * height the height (z direction) of the ground
  27038. * * subdivisions the number of subdivisions per side
  27039. * * minHeight the minimum altitude on the ground, optional, default 0
  27040. * * maxHeight the maximum altitude on the ground, optional default 1
  27041. * * colorFilter the filter to apply to the image pixel colors to compute the height, optional Color3, default (0.3, 0.59, 0.11)
  27042. * * buffer the array holding the image color data
  27043. * * bufferWidth the width of image
  27044. * * bufferHeight the height of image
  27045. * * alphaFilter Remove any data where the alpha channel is below this value, defaults 0 (all data visible)
  27046. * @returns the VertexData of the Ground designed from a heightmap
  27047. */
  27048. static CreateGroundFromHeightMap(options: {
  27049. width: number;
  27050. height: number;
  27051. subdivisions: number;
  27052. minHeight: number;
  27053. maxHeight: number;
  27054. colorFilter: Color3;
  27055. buffer: Uint8Array;
  27056. bufferWidth: number;
  27057. bufferHeight: number;
  27058. alphaFilter: number;
  27059. }): VertexData;
  27060. /**
  27061. * Creates the VertexData for a Plane
  27062. * @param options an object used to set the following optional parameters for the plane, required but can be empty
  27063. * * size sets the width and height of the plane to the value of size, optional default 1
  27064. * * width sets the width (x direction) of the plane, overwrites the width set by size, optional, default size
  27065. * * height sets the height (y direction) of the plane, overwrites the height set by size, optional, default size
  27066. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27067. * * 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)
  27068. * * 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)
  27069. * @returns the VertexData of the box
  27070. */
  27071. static CreatePlane(options: {
  27072. size?: number;
  27073. width?: number;
  27074. height?: number;
  27075. sideOrientation?: number;
  27076. frontUVs?: Vector4;
  27077. backUVs?: Vector4;
  27078. }): VertexData;
  27079. /**
  27080. * Creates the VertexData of the Disc or regular Polygon
  27081. * @param options an object used to set the following optional parameters for the disc, required but can be empty
  27082. * * radius the radius of the disc, optional default 0.5
  27083. * * tessellation the number of polygon sides, optional, default 64
  27084. * * 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
  27085. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27086. * * 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)
  27087. * * 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)
  27088. * @returns the VertexData of the box
  27089. */
  27090. static CreateDisc(options: {
  27091. radius?: number;
  27092. tessellation?: number;
  27093. arc?: number;
  27094. sideOrientation?: number;
  27095. frontUVs?: Vector4;
  27096. backUVs?: Vector4;
  27097. }): VertexData;
  27098. /**
  27099. * Creates the VertexData for an irregular Polygon in the XoZ plane using a mesh built by polygonTriangulation.build()
  27100. * All parameters are provided by MeshBuilder.CreatePolygon as needed
  27101. * @param polygon a mesh built from polygonTriangulation.build()
  27102. * @param sideOrientation takes the values Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27103. * @param fUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  27104. * @param fColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  27105. * @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)
  27106. * @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)
  27107. * @param wrap a boolean, default false, when true and fUVs used texture is wrapped around all sides, when false texture is applied side
  27108. * @returns the VertexData of the Polygon
  27109. */
  27110. static CreatePolygon(polygon: Mesh, sideOrientation: number, fUV?: Vector4[], fColors?: Color4[], frontUVs?: Vector4, backUVs?: Vector4, wrap?: boolean): VertexData;
  27111. /**
  27112. * Creates the VertexData of the IcoSphere
  27113. * @param options an object used to set the following optional parameters for the IcoSphere, required but can be empty
  27114. * * radius the radius of the IcoSphere, optional default 1
  27115. * * radiusX allows stretching in the x direction, optional, default radius
  27116. * * radiusY allows stretching in the y direction, optional, default radius
  27117. * * radiusZ allows stretching in the z direction, optional, default radius
  27118. * * flat when true creates a flat shaded mesh, optional, default true
  27119. * * subdivisions increasing the subdivisions increases the number of faces, optional, default 4
  27120. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27121. * * 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)
  27122. * * 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)
  27123. * @returns the VertexData of the IcoSphere
  27124. */
  27125. static CreateIcoSphere(options: {
  27126. radius?: number;
  27127. radiusX?: number;
  27128. radiusY?: number;
  27129. radiusZ?: number;
  27130. flat?: boolean;
  27131. subdivisions?: number;
  27132. sideOrientation?: number;
  27133. frontUVs?: Vector4;
  27134. backUVs?: Vector4;
  27135. }): VertexData;
  27136. /**
  27137. * Creates the VertexData for a Polyhedron
  27138. * @param options an object used to set the following optional parameters for the polyhedron, required but can be empty
  27139. * * type provided types are:
  27140. * * 0 : Tetrahedron, 1 : Octahedron, 2 : Dodecahedron, 3 : Icosahedron, 4 : Rhombicuboctahedron, 5 : Triangular Prism, 6 : Pentagonal Prism, 7 : Hexagonal Prism, 8 : Square Pyramid (J1)
  27141. * * 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)
  27142. * * size the size of the IcoSphere, optional default 1
  27143. * * sizeX allows stretching in the x direction, optional, default size
  27144. * * sizeY allows stretching in the y direction, optional, default size
  27145. * * sizeZ allows stretching in the z direction, optional, default size
  27146. * * 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
  27147. * * faceUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  27148. * * faceColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  27149. * * flat when true creates a flat shaded mesh, optional, default true
  27150. * * subdivisions increasing the subdivisions increases the number of faces, optional, default 4
  27151. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27152. * * 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)
  27153. * * 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)
  27154. * @returns the VertexData of the Polyhedron
  27155. */
  27156. static CreatePolyhedron(options: {
  27157. type?: number;
  27158. size?: number;
  27159. sizeX?: number;
  27160. sizeY?: number;
  27161. sizeZ?: number;
  27162. custom?: any;
  27163. faceUV?: Vector4[];
  27164. faceColors?: Color4[];
  27165. flat?: boolean;
  27166. sideOrientation?: number;
  27167. frontUVs?: Vector4;
  27168. backUVs?: Vector4;
  27169. }): VertexData;
  27170. /**
  27171. * Creates the VertexData for a TorusKnot
  27172. * @param options an object used to set the following optional parameters for the TorusKnot, required but can be empty
  27173. * * radius the radius of the torus knot, optional, default 2
  27174. * * tube the thickness of the tube, optional, default 0.5
  27175. * * radialSegments the number of sides on each tube segments, optional, default 32
  27176. * * tubularSegments the number of tubes to decompose the knot into, optional, default 32
  27177. * * p the number of windings around the z axis, optional, default 2
  27178. * * q the number of windings around the x axis, optional, default 3
  27179. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27180. * * 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)
  27181. * * 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)
  27182. * @returns the VertexData of the Torus Knot
  27183. */
  27184. static CreateTorusKnot(options: {
  27185. radius?: number;
  27186. tube?: number;
  27187. radialSegments?: number;
  27188. tubularSegments?: number;
  27189. p?: number;
  27190. q?: number;
  27191. sideOrientation?: number;
  27192. frontUVs?: Vector4;
  27193. backUVs?: Vector4;
  27194. }): VertexData;
  27195. /**
  27196. * Compute normals for given positions and indices
  27197. * @param positions an array of vertex positions, [...., x, y, z, ......]
  27198. * @param indices an array of indices in groups of three for each triangular facet, [...., i, j, k, ......]
  27199. * @param normals an array of vertex normals, [...., x, y, z, ......]
  27200. * @param options an object used to set the following optional parameters for the TorusKnot, optional
  27201. * * facetNormals : optional array of facet normals (vector3)
  27202. * * facetPositions : optional array of facet positions (vector3)
  27203. * * facetPartitioning : optional partitioning array. facetPositions is required for facetPartitioning computation
  27204. * * ratio : optional partitioning ratio / bounding box, required for facetPartitioning computation
  27205. * * bInfo : optional bounding info, required for facetPartitioning computation
  27206. * * bbSize : optional bounding box size data, required for facetPartitioning computation
  27207. * * subDiv : optional partitioning data about subdivsions on each axis (int), required for facetPartitioning computation
  27208. * * useRightHandedSystem: optional boolean to for right handed system computation
  27209. * * depthSort : optional boolean to enable the facet depth sort computation
  27210. * * distanceTo : optional Vector3 to compute the facet depth from this location
  27211. * * depthSortedFacets : optional array of depthSortedFacets to store the facet distances from the reference location
  27212. */
  27213. static ComputeNormals(positions: any, indices: any, normals: any, options?: {
  27214. facetNormals?: any;
  27215. facetPositions?: any;
  27216. facetPartitioning?: any;
  27217. ratio?: number;
  27218. bInfo?: any;
  27219. bbSize?: Vector3;
  27220. subDiv?: any;
  27221. useRightHandedSystem?: boolean;
  27222. depthSort?: boolean;
  27223. distanceTo?: Vector3;
  27224. depthSortedFacets?: any;
  27225. }): void;
  27226. /** @hidden */
  27227. static _ComputeSides(sideOrientation: number, positions: FloatArray, indices: FloatArray, normals: FloatArray, uvs: FloatArray, frontUVs?: Vector4, backUVs?: Vector4): void;
  27228. /**
  27229. * Applies VertexData created from the imported parameters to the geometry
  27230. * @param parsedVertexData the parsed data from an imported file
  27231. * @param geometry the geometry to apply the VertexData to
  27232. */
  27233. static ImportVertexData(parsedVertexData: any, geometry: Geometry): void;
  27234. }
  27235. }
  27236. declare module "babylonjs/Morph/morphTarget" {
  27237. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  27238. import { Observable } from "babylonjs/Misc/observable";
  27239. import { Nullable, FloatArray } from "babylonjs/types";
  27240. import { Scene } from "babylonjs/scene";
  27241. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  27242. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  27243. /**
  27244. * Defines a target to use with MorphTargetManager
  27245. * @see https://doc.babylonjs.com/how_to/how_to_use_morphtargets
  27246. */
  27247. export class MorphTarget implements IAnimatable {
  27248. /** defines the name of the target */
  27249. name: string;
  27250. /**
  27251. * Gets or sets the list of animations
  27252. */
  27253. animations: import("babylonjs/Animations/animation").Animation[];
  27254. private _scene;
  27255. private _positions;
  27256. private _normals;
  27257. private _tangents;
  27258. private _uvs;
  27259. private _influence;
  27260. private _uniqueId;
  27261. /**
  27262. * Observable raised when the influence changes
  27263. */
  27264. onInfluenceChanged: Observable<boolean>;
  27265. /** @hidden */
  27266. _onDataLayoutChanged: Observable<void>;
  27267. /**
  27268. * Gets or sets the influence of this target (ie. its weight in the overall morphing)
  27269. */
  27270. get influence(): number;
  27271. set influence(influence: number);
  27272. /**
  27273. * Gets or sets the id of the morph Target
  27274. */
  27275. id: string;
  27276. private _animationPropertiesOverride;
  27277. /**
  27278. * Gets or sets the animation properties override
  27279. */
  27280. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  27281. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  27282. /**
  27283. * Creates a new MorphTarget
  27284. * @param name defines the name of the target
  27285. * @param influence defines the influence to use
  27286. * @param scene defines the scene the morphtarget belongs to
  27287. */
  27288. constructor(
  27289. /** defines the name of the target */
  27290. name: string, influence?: number, scene?: Nullable<Scene>);
  27291. /**
  27292. * Gets the unique ID of this manager
  27293. */
  27294. get uniqueId(): number;
  27295. /**
  27296. * Gets a boolean defining if the target contains position data
  27297. */
  27298. get hasPositions(): boolean;
  27299. /**
  27300. * Gets a boolean defining if the target contains normal data
  27301. */
  27302. get hasNormals(): boolean;
  27303. /**
  27304. * Gets a boolean defining if the target contains tangent data
  27305. */
  27306. get hasTangents(): boolean;
  27307. /**
  27308. * Gets a boolean defining if the target contains texture coordinates data
  27309. */
  27310. get hasUVs(): boolean;
  27311. /**
  27312. * Affects position data to this target
  27313. * @param data defines the position data to use
  27314. */
  27315. setPositions(data: Nullable<FloatArray>): void;
  27316. /**
  27317. * Gets the position data stored in this target
  27318. * @returns a FloatArray containing the position data (or null if not present)
  27319. */
  27320. getPositions(): Nullable<FloatArray>;
  27321. /**
  27322. * Affects normal data to this target
  27323. * @param data defines the normal data to use
  27324. */
  27325. setNormals(data: Nullable<FloatArray>): void;
  27326. /**
  27327. * Gets the normal data stored in this target
  27328. * @returns a FloatArray containing the normal data (or null if not present)
  27329. */
  27330. getNormals(): Nullable<FloatArray>;
  27331. /**
  27332. * Affects tangent data to this target
  27333. * @param data defines the tangent data to use
  27334. */
  27335. setTangents(data: Nullable<FloatArray>): void;
  27336. /**
  27337. * Gets the tangent data stored in this target
  27338. * @returns a FloatArray containing the tangent data (or null if not present)
  27339. */
  27340. getTangents(): Nullable<FloatArray>;
  27341. /**
  27342. * Affects texture coordinates data to this target
  27343. * @param data defines the texture coordinates data to use
  27344. */
  27345. setUVs(data: Nullable<FloatArray>): void;
  27346. /**
  27347. * Gets the texture coordinates data stored in this target
  27348. * @returns a FloatArray containing the texture coordinates data (or null if not present)
  27349. */
  27350. getUVs(): Nullable<FloatArray>;
  27351. /**
  27352. * Clone the current target
  27353. * @returns a new MorphTarget
  27354. */
  27355. clone(): MorphTarget;
  27356. /**
  27357. * Serializes the current target into a Serialization object
  27358. * @returns the serialized object
  27359. */
  27360. serialize(): any;
  27361. /**
  27362. * Returns the string "MorphTarget"
  27363. * @returns "MorphTarget"
  27364. */
  27365. getClassName(): string;
  27366. /**
  27367. * Creates a new target from serialized data
  27368. * @param serializationObject defines the serialized data to use
  27369. * @returns a new MorphTarget
  27370. */
  27371. static Parse(serializationObject: any): MorphTarget;
  27372. /**
  27373. * Creates a MorphTarget from mesh data
  27374. * @param mesh defines the source mesh
  27375. * @param name defines the name to use for the new target
  27376. * @param influence defines the influence to attach to the target
  27377. * @returns a new MorphTarget
  27378. */
  27379. static FromMesh(mesh: AbstractMesh, name?: string, influence?: number): MorphTarget;
  27380. }
  27381. }
  27382. declare module "babylonjs/Morph/morphTargetManager" {
  27383. import { Nullable } from "babylonjs/types";
  27384. import { Scene } from "babylonjs/scene";
  27385. import { MorphTarget } from "babylonjs/Morph/morphTarget";
  27386. /**
  27387. * This class is used to deform meshes using morphing between different targets
  27388. * @see https://doc.babylonjs.com/how_to/how_to_use_morphtargets
  27389. */
  27390. export class MorphTargetManager {
  27391. private _targets;
  27392. private _targetInfluenceChangedObservers;
  27393. private _targetDataLayoutChangedObservers;
  27394. private _activeTargets;
  27395. private _scene;
  27396. private _influences;
  27397. private _supportsNormals;
  27398. private _supportsTangents;
  27399. private _supportsUVs;
  27400. private _vertexCount;
  27401. private _uniqueId;
  27402. private _tempInfluences;
  27403. /**
  27404. * Gets or sets a boolean indicating if normals must be morphed
  27405. */
  27406. enableNormalMorphing: boolean;
  27407. /**
  27408. * Gets or sets a boolean indicating if tangents must be morphed
  27409. */
  27410. enableTangentMorphing: boolean;
  27411. /**
  27412. * Gets or sets a boolean indicating if UV must be morphed
  27413. */
  27414. enableUVMorphing: boolean;
  27415. /**
  27416. * Creates a new MorphTargetManager
  27417. * @param scene defines the current scene
  27418. */
  27419. constructor(scene?: Nullable<Scene>);
  27420. /**
  27421. * Gets the unique ID of this manager
  27422. */
  27423. get uniqueId(): number;
  27424. /**
  27425. * Gets the number of vertices handled by this manager
  27426. */
  27427. get vertexCount(): number;
  27428. /**
  27429. * Gets a boolean indicating if this manager supports morphing of normals
  27430. */
  27431. get supportsNormals(): boolean;
  27432. /**
  27433. * Gets a boolean indicating if this manager supports morphing of tangents
  27434. */
  27435. get supportsTangents(): boolean;
  27436. /**
  27437. * Gets a boolean indicating if this manager supports morphing of texture coordinates
  27438. */
  27439. get supportsUVs(): boolean;
  27440. /**
  27441. * Gets the number of targets stored in this manager
  27442. */
  27443. get numTargets(): number;
  27444. /**
  27445. * Gets the number of influencers (ie. the number of targets with influences > 0)
  27446. */
  27447. get numInfluencers(): number;
  27448. /**
  27449. * Gets the list of influences (one per target)
  27450. */
  27451. get influences(): Float32Array;
  27452. /**
  27453. * Gets the active target at specified index. An active target is a target with an influence > 0
  27454. * @param index defines the index to check
  27455. * @returns the requested target
  27456. */
  27457. getActiveTarget(index: number): MorphTarget;
  27458. /**
  27459. * Gets the target at specified index
  27460. * @param index defines the index to check
  27461. * @returns the requested target
  27462. */
  27463. getTarget(index: number): MorphTarget;
  27464. /**
  27465. * Add a new target to this manager
  27466. * @param target defines the target to add
  27467. */
  27468. addTarget(target: MorphTarget): void;
  27469. /**
  27470. * Removes a target from the manager
  27471. * @param target defines the target to remove
  27472. */
  27473. removeTarget(target: MorphTarget): void;
  27474. /**
  27475. * Clone the current manager
  27476. * @returns a new MorphTargetManager
  27477. */
  27478. clone(): MorphTargetManager;
  27479. /**
  27480. * Serializes the current manager into a Serialization object
  27481. * @returns the serialized object
  27482. */
  27483. serialize(): any;
  27484. private _syncActiveTargets;
  27485. /**
  27486. * Syncrhonize the targets with all the meshes using this morph target manager
  27487. */
  27488. synchronize(): void;
  27489. /**
  27490. * Creates a new MorphTargetManager from serialized data
  27491. * @param serializationObject defines the serialized data
  27492. * @param scene defines the hosting scene
  27493. * @returns the new MorphTargetManager
  27494. */
  27495. static Parse(serializationObject: any, scene: Scene): MorphTargetManager;
  27496. }
  27497. }
  27498. declare module "babylonjs/Meshes/meshLODLevel" {
  27499. import { Mesh } from "babylonjs/Meshes/mesh";
  27500. import { Nullable } from "babylonjs/types";
  27501. /**
  27502. * Class used to represent a specific level of detail of a mesh
  27503. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  27504. */
  27505. export class MeshLODLevel {
  27506. /** Defines the distance where this level should start being displayed */
  27507. distance: number;
  27508. /** Defines the mesh to use to render this level */
  27509. mesh: Nullable<Mesh>;
  27510. /**
  27511. * Creates a new LOD level
  27512. * @param distance defines the distance where this level should star being displayed
  27513. * @param mesh defines the mesh to use to render this level
  27514. */
  27515. constructor(
  27516. /** Defines the distance where this level should start being displayed */
  27517. distance: number,
  27518. /** Defines the mesh to use to render this level */
  27519. mesh: Nullable<Mesh>);
  27520. }
  27521. }
  27522. declare module "babylonjs/Misc/canvasGenerator" {
  27523. /**
  27524. * Helper class used to generate a canvas to manipulate images
  27525. */
  27526. export class CanvasGenerator {
  27527. /**
  27528. * Create a new canvas (or offscreen canvas depending on the context)
  27529. * @param width defines the expected width
  27530. * @param height defines the expected height
  27531. * @return a new canvas or offscreen canvas
  27532. */
  27533. static CreateCanvas(width: number, height: number): HTMLCanvasElement | OffscreenCanvas;
  27534. }
  27535. }
  27536. declare module "babylonjs/Meshes/groundMesh" {
  27537. import { Scene } from "babylonjs/scene";
  27538. import { Vector3 } from "babylonjs/Maths/math.vector";
  27539. import { Mesh } from "babylonjs/Meshes/mesh";
  27540. /**
  27541. * Mesh representing the gorund
  27542. */
  27543. export class GroundMesh extends Mesh {
  27544. /** If octree should be generated */
  27545. generateOctree: boolean;
  27546. private _heightQuads;
  27547. /** @hidden */
  27548. _subdivisionsX: number;
  27549. /** @hidden */
  27550. _subdivisionsY: number;
  27551. /** @hidden */
  27552. _width: number;
  27553. /** @hidden */
  27554. _height: number;
  27555. /** @hidden */
  27556. _minX: number;
  27557. /** @hidden */
  27558. _maxX: number;
  27559. /** @hidden */
  27560. _minZ: number;
  27561. /** @hidden */
  27562. _maxZ: number;
  27563. constructor(name: string, scene: Scene);
  27564. /**
  27565. * "GroundMesh"
  27566. * @returns "GroundMesh"
  27567. */
  27568. getClassName(): string;
  27569. /**
  27570. * The minimum of x and y subdivisions
  27571. */
  27572. get subdivisions(): number;
  27573. /**
  27574. * X subdivisions
  27575. */
  27576. get subdivisionsX(): number;
  27577. /**
  27578. * Y subdivisions
  27579. */
  27580. get subdivisionsY(): number;
  27581. /**
  27582. * This function will update an octree to help to select the right submeshes for rendering, picking and collision computations.
  27583. * Please note that you must have a decent number of submeshes to get performance improvements when using an octree
  27584. * @param chunksCount the number of subdivisions for x and y
  27585. * @param octreeBlocksSize (Default: 32)
  27586. */
  27587. optimize(chunksCount: number, octreeBlocksSize?: number): void;
  27588. /**
  27589. * Returns a height (y) value in the Worl system :
  27590. * the ground altitude at the coordinates (x, z) expressed in the World system.
  27591. * @param x x coordinate
  27592. * @param z z coordinate
  27593. * @returns the ground y position if (x, z) are outside the ground surface.
  27594. */
  27595. getHeightAtCoordinates(x: number, z: number): number;
  27596. /**
  27597. * Returns a normalized vector (Vector3) orthogonal to the ground
  27598. * at the ground coordinates (x, z) expressed in the World system.
  27599. * @param x x coordinate
  27600. * @param z z coordinate
  27601. * @returns Vector3(0.0, 1.0, 0.0) if (x, z) are outside the ground surface.
  27602. */
  27603. getNormalAtCoordinates(x: number, z: number): Vector3;
  27604. /**
  27605. * Updates the Vector3 passed a reference with a normalized vector orthogonal to the ground
  27606. * at the ground coordinates (x, z) expressed in the World system.
  27607. * Doesn't uptade the reference Vector3 if (x, z) are outside the ground surface.
  27608. * @param x x coordinate
  27609. * @param z z coordinate
  27610. * @param ref vector to store the result
  27611. * @returns the GroundMesh.
  27612. */
  27613. getNormalAtCoordinatesToRef(x: number, z: number, ref: Vector3): GroundMesh;
  27614. /**
  27615. * Force the heights to be recomputed for getHeightAtCoordinates() or getNormalAtCoordinates()
  27616. * if the ground has been updated.
  27617. * This can be used in the render loop.
  27618. * @returns the GroundMesh.
  27619. */
  27620. updateCoordinateHeights(): GroundMesh;
  27621. private _getFacetAt;
  27622. private _initHeightQuads;
  27623. private _computeHeightQuads;
  27624. /**
  27625. * Serializes this ground mesh
  27626. * @param serializationObject object to write serialization to
  27627. */
  27628. serialize(serializationObject: any): void;
  27629. /**
  27630. * Parses a serialized ground mesh
  27631. * @param parsedMesh the serialized mesh
  27632. * @param scene the scene to create the ground mesh in
  27633. * @returns the created ground mesh
  27634. */
  27635. static Parse(parsedMesh: any, scene: Scene): GroundMesh;
  27636. }
  27637. }
  27638. declare module "babylonjs/Physics/physicsJoint" {
  27639. import { Vector3 } from "babylonjs/Maths/math.vector";
  27640. import { IPhysicsEnginePlugin } from "babylonjs/Physics/IPhysicsEngine";
  27641. /**
  27642. * Interface for Physics-Joint data
  27643. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  27644. */
  27645. export interface PhysicsJointData {
  27646. /**
  27647. * The main pivot of the joint
  27648. */
  27649. mainPivot?: Vector3;
  27650. /**
  27651. * The connected pivot of the joint
  27652. */
  27653. connectedPivot?: Vector3;
  27654. /**
  27655. * The main axis of the joint
  27656. */
  27657. mainAxis?: Vector3;
  27658. /**
  27659. * The connected axis of the joint
  27660. */
  27661. connectedAxis?: Vector3;
  27662. /**
  27663. * The collision of the joint
  27664. */
  27665. collision?: boolean;
  27666. /**
  27667. * Native Oimo/Cannon/Energy data
  27668. */
  27669. nativeParams?: any;
  27670. }
  27671. /**
  27672. * This is a holder class for the physics joint created by the physics plugin
  27673. * It holds a set of functions to control the underlying joint
  27674. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  27675. */
  27676. export class PhysicsJoint {
  27677. /**
  27678. * The type of the physics joint
  27679. */
  27680. type: number;
  27681. /**
  27682. * The data for the physics joint
  27683. */
  27684. jointData: PhysicsJointData;
  27685. private _physicsJoint;
  27686. protected _physicsPlugin: IPhysicsEnginePlugin;
  27687. /**
  27688. * Initializes the physics joint
  27689. * @param type The type of the physics joint
  27690. * @param jointData The data for the physics joint
  27691. */
  27692. constructor(
  27693. /**
  27694. * The type of the physics joint
  27695. */
  27696. type: number,
  27697. /**
  27698. * The data for the physics joint
  27699. */
  27700. jointData: PhysicsJointData);
  27701. /**
  27702. * Gets the physics joint
  27703. */
  27704. get physicsJoint(): any;
  27705. /**
  27706. * Sets the physics joint
  27707. */
  27708. set physicsJoint(newJoint: any);
  27709. /**
  27710. * Sets the physics plugin
  27711. */
  27712. set physicsPlugin(physicsPlugin: IPhysicsEnginePlugin);
  27713. /**
  27714. * Execute a function that is physics-plugin specific.
  27715. * @param {Function} func the function that will be executed.
  27716. * It accepts two parameters: the physics world and the physics joint
  27717. */
  27718. executeNativeFunction(func: (world: any, physicsJoint: any) => void): void;
  27719. /**
  27720. * Distance-Joint type
  27721. */
  27722. static DistanceJoint: number;
  27723. /**
  27724. * Hinge-Joint type
  27725. */
  27726. static HingeJoint: number;
  27727. /**
  27728. * Ball-and-Socket joint type
  27729. */
  27730. static BallAndSocketJoint: number;
  27731. /**
  27732. * Wheel-Joint type
  27733. */
  27734. static WheelJoint: number;
  27735. /**
  27736. * Slider-Joint type
  27737. */
  27738. static SliderJoint: number;
  27739. /**
  27740. * Prismatic-Joint type
  27741. */
  27742. static PrismaticJoint: number;
  27743. /**
  27744. * Universal-Joint type
  27745. * ENERGY FTW! (compare with this - @see http://ode-wiki.org/wiki/index.php?title=Manual:_Joint_Types_and_Functions)
  27746. */
  27747. static UniversalJoint: number;
  27748. /**
  27749. * Hinge-Joint 2 type
  27750. */
  27751. static Hinge2Joint: number;
  27752. /**
  27753. * Point to Point Joint type. Similar to a Ball-Joint. Different in parameters
  27754. */
  27755. static PointToPointJoint: number;
  27756. /**
  27757. * Spring-Joint type
  27758. */
  27759. static SpringJoint: number;
  27760. /**
  27761. * Lock-Joint type
  27762. */
  27763. static LockJoint: number;
  27764. }
  27765. /**
  27766. * A class representing a physics distance joint
  27767. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  27768. */
  27769. export class DistanceJoint extends PhysicsJoint {
  27770. /**
  27771. *
  27772. * @param jointData The data for the Distance-Joint
  27773. */
  27774. constructor(jointData: DistanceJointData);
  27775. /**
  27776. * Update the predefined distance.
  27777. * @param maxDistance The maximum preferred distance
  27778. * @param minDistance The minimum preferred distance
  27779. */
  27780. updateDistance(maxDistance: number, minDistance?: number): void;
  27781. }
  27782. /**
  27783. * Represents a Motor-Enabled Joint
  27784. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  27785. */
  27786. export class MotorEnabledJoint extends PhysicsJoint implements IMotorEnabledJoint {
  27787. /**
  27788. * Initializes the Motor-Enabled Joint
  27789. * @param type The type of the joint
  27790. * @param jointData The physica joint data for the joint
  27791. */
  27792. constructor(type: number, jointData: PhysicsJointData);
  27793. /**
  27794. * Set the motor values.
  27795. * Attention, this function is plugin specific. Engines won't react 100% the same.
  27796. * @param force the force to apply
  27797. * @param maxForce max force for this motor.
  27798. */
  27799. setMotor(force?: number, maxForce?: number): void;
  27800. /**
  27801. * Set the motor's limits.
  27802. * Attention, this function is plugin specific. Engines won't react 100% the same.
  27803. * @param upperLimit The upper limit of the motor
  27804. * @param lowerLimit The lower limit of the motor
  27805. */
  27806. setLimit(upperLimit: number, lowerLimit?: number): void;
  27807. }
  27808. /**
  27809. * This class represents a single physics Hinge-Joint
  27810. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  27811. */
  27812. export class HingeJoint extends MotorEnabledJoint {
  27813. /**
  27814. * Initializes the Hinge-Joint
  27815. * @param jointData The joint data for the Hinge-Joint
  27816. */
  27817. constructor(jointData: PhysicsJointData);
  27818. /**
  27819. * Set the motor values.
  27820. * Attention, this function is plugin specific. Engines won't react 100% the same.
  27821. * @param {number} force the force to apply
  27822. * @param {number} maxForce max force for this motor.
  27823. */
  27824. setMotor(force?: number, maxForce?: number): void;
  27825. /**
  27826. * Set the motor's limits.
  27827. * Attention, this function is plugin specific. Engines won't react 100% the same.
  27828. * @param upperLimit The upper limit of the motor
  27829. * @param lowerLimit The lower limit of the motor
  27830. */
  27831. setLimit(upperLimit: number, lowerLimit?: number): void;
  27832. }
  27833. /**
  27834. * This class represents a dual hinge physics joint (same as wheel joint)
  27835. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  27836. */
  27837. export class Hinge2Joint extends MotorEnabledJoint {
  27838. /**
  27839. * Initializes the Hinge2-Joint
  27840. * @param jointData The joint data for the Hinge2-Joint
  27841. */
  27842. constructor(jointData: PhysicsJointData);
  27843. /**
  27844. * Set the motor values.
  27845. * Attention, this function is plugin specific. Engines won't react 100% the same.
  27846. * @param {number} targetSpeed the speed the motor is to reach
  27847. * @param {number} maxForce max force for this motor.
  27848. * @param {motorIndex} the motor's index, 0 or 1.
  27849. */
  27850. setMotor(targetSpeed?: number, maxForce?: number, motorIndex?: number): void;
  27851. /**
  27852. * Set the motor limits.
  27853. * Attention, this function is plugin specific. Engines won't react 100% the same.
  27854. * @param {number} upperLimit the upper limit
  27855. * @param {number} lowerLimit lower limit
  27856. * @param {motorIndex} the motor's index, 0 or 1.
  27857. */
  27858. setLimit(upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  27859. }
  27860. /**
  27861. * Interface for a motor enabled joint
  27862. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  27863. */
  27864. export interface IMotorEnabledJoint {
  27865. /**
  27866. * Physics joint
  27867. */
  27868. physicsJoint: any;
  27869. /**
  27870. * Sets the motor of the motor-enabled joint
  27871. * @param force The force of the motor
  27872. * @param maxForce The maximum force of the motor
  27873. * @param motorIndex The index of the motor
  27874. */
  27875. setMotor(force?: number, maxForce?: number, motorIndex?: number): void;
  27876. /**
  27877. * Sets the limit of the motor
  27878. * @param upperLimit The upper limit of the motor
  27879. * @param lowerLimit The lower limit of the motor
  27880. * @param motorIndex The index of the motor
  27881. */
  27882. setLimit(upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  27883. }
  27884. /**
  27885. * Joint data for a Distance-Joint
  27886. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  27887. */
  27888. export interface DistanceJointData extends PhysicsJointData {
  27889. /**
  27890. * Max distance the 2 joint objects can be apart
  27891. */
  27892. maxDistance: number;
  27893. }
  27894. /**
  27895. * Joint data from a spring joint
  27896. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  27897. */
  27898. export interface SpringJointData extends PhysicsJointData {
  27899. /**
  27900. * Length of the spring
  27901. */
  27902. length: number;
  27903. /**
  27904. * Stiffness of the spring
  27905. */
  27906. stiffness: number;
  27907. /**
  27908. * Damping of the spring
  27909. */
  27910. damping: number;
  27911. /** this callback will be called when applying the force to the impostors. */
  27912. forceApplicationCallback: () => void;
  27913. }
  27914. }
  27915. declare module "babylonjs/Physics/physicsRaycastResult" {
  27916. import { Vector3 } from "babylonjs/Maths/math.vector";
  27917. /**
  27918. * Holds the data for the raycast result
  27919. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  27920. */
  27921. export class PhysicsRaycastResult {
  27922. private _hasHit;
  27923. private _hitDistance;
  27924. private _hitNormalWorld;
  27925. private _hitPointWorld;
  27926. private _rayFromWorld;
  27927. private _rayToWorld;
  27928. /**
  27929. * Gets if there was a hit
  27930. */
  27931. get hasHit(): boolean;
  27932. /**
  27933. * Gets the distance from the hit
  27934. */
  27935. get hitDistance(): number;
  27936. /**
  27937. * Gets the hit normal/direction in the world
  27938. */
  27939. get hitNormalWorld(): Vector3;
  27940. /**
  27941. * Gets the hit point in the world
  27942. */
  27943. get hitPointWorld(): Vector3;
  27944. /**
  27945. * Gets the ray "start point" of the ray in the world
  27946. */
  27947. get rayFromWorld(): Vector3;
  27948. /**
  27949. * Gets the ray "end point" of the ray in the world
  27950. */
  27951. get rayToWorld(): Vector3;
  27952. /**
  27953. * Sets the hit data (normal & point in world space)
  27954. * @param hitNormalWorld defines the normal in world space
  27955. * @param hitPointWorld defines the point in world space
  27956. */
  27957. setHitData(hitNormalWorld: IXYZ, hitPointWorld: IXYZ): void;
  27958. /**
  27959. * Sets the distance from the start point to the hit point
  27960. * @param distance
  27961. */
  27962. setHitDistance(distance: number): void;
  27963. /**
  27964. * Calculates the distance manually
  27965. */
  27966. calculateHitDistance(): void;
  27967. /**
  27968. * Resets all the values to default
  27969. * @param from The from point on world space
  27970. * @param to The to point on world space
  27971. */
  27972. reset(from?: Vector3, to?: Vector3): void;
  27973. }
  27974. /**
  27975. * Interface for the size containing width and height
  27976. */
  27977. interface IXYZ {
  27978. /**
  27979. * X
  27980. */
  27981. x: number;
  27982. /**
  27983. * Y
  27984. */
  27985. y: number;
  27986. /**
  27987. * Z
  27988. */
  27989. z: number;
  27990. }
  27991. }
  27992. declare module "babylonjs/Physics/IPhysicsEngine" {
  27993. import { Nullable } from "babylonjs/types";
  27994. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  27995. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  27996. import { PhysicsImpostor, IPhysicsEnabledObject } from "babylonjs/Physics/physicsImpostor";
  27997. import { PhysicsJoint, IMotorEnabledJoint } from "babylonjs/Physics/physicsJoint";
  27998. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  27999. /**
  28000. * Interface used to describe a physics joint
  28001. */
  28002. export interface PhysicsImpostorJoint {
  28003. /** Defines the main impostor to which the joint is linked */
  28004. mainImpostor: PhysicsImpostor;
  28005. /** Defines the impostor that is connected to the main impostor using this joint */
  28006. connectedImpostor: PhysicsImpostor;
  28007. /** Defines the joint itself */
  28008. joint: PhysicsJoint;
  28009. }
  28010. /** @hidden */
  28011. export interface IPhysicsEnginePlugin {
  28012. world: any;
  28013. name: string;
  28014. setGravity(gravity: Vector3): void;
  28015. setTimeStep(timeStep: number): void;
  28016. getTimeStep(): number;
  28017. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  28018. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  28019. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  28020. generatePhysicsBody(impostor: PhysicsImpostor): void;
  28021. removePhysicsBody(impostor: PhysicsImpostor): void;
  28022. generateJoint(joint: PhysicsImpostorJoint): void;
  28023. removeJoint(joint: PhysicsImpostorJoint): void;
  28024. isSupported(): boolean;
  28025. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  28026. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  28027. setLinearVelocity(impostor: PhysicsImpostor, velocity: Nullable<Vector3>): void;
  28028. setAngularVelocity(impostor: PhysicsImpostor, velocity: Nullable<Vector3>): void;
  28029. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  28030. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  28031. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  28032. getBodyMass(impostor: PhysicsImpostor): number;
  28033. getBodyFriction(impostor: PhysicsImpostor): number;
  28034. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  28035. getBodyRestitution(impostor: PhysicsImpostor): number;
  28036. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  28037. getBodyPressure?(impostor: PhysicsImpostor): number;
  28038. setBodyPressure?(impostor: PhysicsImpostor, pressure: number): void;
  28039. getBodyStiffness?(impostor: PhysicsImpostor): number;
  28040. setBodyStiffness?(impostor: PhysicsImpostor, stiffness: number): void;
  28041. getBodyVelocityIterations?(impostor: PhysicsImpostor): number;
  28042. setBodyVelocityIterations?(impostor: PhysicsImpostor, velocityIterations: number): void;
  28043. getBodyPositionIterations?(impostor: PhysicsImpostor): number;
  28044. setBodyPositionIterations?(impostor: PhysicsImpostor, positionIterations: number): void;
  28045. appendAnchor?(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, width: number, height: number, influence: number, noCollisionBetweenLinkedBodies: boolean): void;
  28046. appendHook?(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, length: number, influence: number, noCollisionBetweenLinkedBodies: boolean): void;
  28047. sleepBody(impostor: PhysicsImpostor): void;
  28048. wakeUpBody(impostor: PhysicsImpostor): void;
  28049. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  28050. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  28051. setMotor(joint: IMotorEnabledJoint, speed: number, maxForce?: number, motorIndex?: number): void;
  28052. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  28053. getRadius(impostor: PhysicsImpostor): number;
  28054. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  28055. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  28056. dispose(): void;
  28057. }
  28058. /**
  28059. * Interface used to define a physics engine
  28060. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28061. */
  28062. export interface IPhysicsEngine {
  28063. /**
  28064. * Gets the gravity vector used by the simulation
  28065. */
  28066. gravity: Vector3;
  28067. /**
  28068. * Sets the gravity vector used by the simulation
  28069. * @param gravity defines the gravity vector to use
  28070. */
  28071. setGravity(gravity: Vector3): void;
  28072. /**
  28073. * Set the time step of the physics engine.
  28074. * Default is 1/60.
  28075. * To slow it down, enter 1/600 for example.
  28076. * To speed it up, 1/30
  28077. * @param newTimeStep the new timestep to apply to this world.
  28078. */
  28079. setTimeStep(newTimeStep: number): void;
  28080. /**
  28081. * Get the time step of the physics engine.
  28082. * @returns the current time step
  28083. */
  28084. getTimeStep(): number;
  28085. /**
  28086. * Set the sub time step of the physics engine.
  28087. * Default is 0 meaning there is no sub steps
  28088. * To increase physics resolution precision, set a small value (like 1 ms)
  28089. * @param subTimeStep defines the new sub timestep used for physics resolution.
  28090. */
  28091. setSubTimeStep(subTimeStep: number): void;
  28092. /**
  28093. * Get the sub time step of the physics engine.
  28094. * @returns the current sub time step
  28095. */
  28096. getSubTimeStep(): number;
  28097. /**
  28098. * Release all resources
  28099. */
  28100. dispose(): void;
  28101. /**
  28102. * Gets the name of the current physics plugin
  28103. * @returns the name of the plugin
  28104. */
  28105. getPhysicsPluginName(): string;
  28106. /**
  28107. * Adding a new impostor for the impostor tracking.
  28108. * This will be done by the impostor itself.
  28109. * @param impostor the impostor to add
  28110. */
  28111. addImpostor(impostor: PhysicsImpostor): void;
  28112. /**
  28113. * Remove an impostor from the engine.
  28114. * This impostor and its mesh will not longer be updated by the physics engine.
  28115. * @param impostor the impostor to remove
  28116. */
  28117. removeImpostor(impostor: PhysicsImpostor): void;
  28118. /**
  28119. * Add a joint to the physics engine
  28120. * @param mainImpostor defines the main impostor to which the joint is added.
  28121. * @param connectedImpostor defines the impostor that is connected to the main impostor using this joint
  28122. * @param joint defines the joint that will connect both impostors.
  28123. */
  28124. addJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  28125. /**
  28126. * Removes a joint from the simulation
  28127. * @param mainImpostor defines the impostor used with the joint
  28128. * @param connectedImpostor defines the other impostor connected to the main one by the joint
  28129. * @param joint defines the joint to remove
  28130. */
  28131. removeJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  28132. /**
  28133. * Gets the current plugin used to run the simulation
  28134. * @returns current plugin
  28135. */
  28136. getPhysicsPlugin(): IPhysicsEnginePlugin;
  28137. /**
  28138. * Gets the list of physic impostors
  28139. * @returns an array of PhysicsImpostor
  28140. */
  28141. getImpostors(): Array<PhysicsImpostor>;
  28142. /**
  28143. * Gets the impostor for a physics enabled object
  28144. * @param object defines the object impersonated by the impostor
  28145. * @returns the PhysicsImpostor or null if not found
  28146. */
  28147. getImpostorForPhysicsObject(object: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  28148. /**
  28149. * Gets the impostor for a physics body object
  28150. * @param body defines physics body used by the impostor
  28151. * @returns the PhysicsImpostor or null if not found
  28152. */
  28153. getImpostorWithPhysicsBody(body: any): Nullable<PhysicsImpostor>;
  28154. /**
  28155. * Does a raycast in the physics world
  28156. * @param from when should the ray start?
  28157. * @param to when should the ray end?
  28158. * @returns PhysicsRaycastResult
  28159. */
  28160. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  28161. /**
  28162. * Called by the scene. No need to call it.
  28163. * @param delta defines the timespam between frames
  28164. */
  28165. _step(delta: number): void;
  28166. }
  28167. }
  28168. declare module "babylonjs/Physics/physicsImpostor" {
  28169. import { Nullable, IndicesArray } from "babylonjs/types";
  28170. import { Vector3, Matrix, Quaternion } from "babylonjs/Maths/math.vector";
  28171. import { TransformNode } from "babylonjs/Meshes/transformNode";
  28172. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  28173. import { Scene } from "babylonjs/scene";
  28174. import { Bone } from "babylonjs/Bones/bone";
  28175. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  28176. import { PhysicsJoint, PhysicsJointData } from "babylonjs/Physics/physicsJoint";
  28177. import { Space } from "babylonjs/Maths/math.axis";
  28178. /**
  28179. * The interface for the physics imposter parameters
  28180. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28181. */
  28182. export interface PhysicsImpostorParameters {
  28183. /**
  28184. * The mass of the physics imposter
  28185. */
  28186. mass: number;
  28187. /**
  28188. * The friction of the physics imposter
  28189. */
  28190. friction?: number;
  28191. /**
  28192. * The coefficient of restitution of the physics imposter
  28193. */
  28194. restitution?: number;
  28195. /**
  28196. * The native options of the physics imposter
  28197. */
  28198. nativeOptions?: any;
  28199. /**
  28200. * Specifies if the parent should be ignored
  28201. */
  28202. ignoreParent?: boolean;
  28203. /**
  28204. * Specifies if bi-directional transformations should be disabled
  28205. */
  28206. disableBidirectionalTransformation?: boolean;
  28207. /**
  28208. * The pressure inside the physics imposter, soft object only
  28209. */
  28210. pressure?: number;
  28211. /**
  28212. * The stiffness the physics imposter, soft object only
  28213. */
  28214. stiffness?: number;
  28215. /**
  28216. * The number of iterations used in maintaining consistent vertex velocities, soft object only
  28217. */
  28218. velocityIterations?: number;
  28219. /**
  28220. * The number of iterations used in maintaining consistent vertex positions, soft object only
  28221. */
  28222. positionIterations?: number;
  28223. /**
  28224. * The number used to fix points on a cloth (0, 1, 2, 4, 8) or rope (0, 1, 2) only
  28225. * 0 None, 1, back left or top, 2, back right or bottom, 4, front left, 8, front right
  28226. * Add to fix multiple points
  28227. */
  28228. fixedPoints?: number;
  28229. /**
  28230. * The collision margin around a soft object
  28231. */
  28232. margin?: number;
  28233. /**
  28234. * The collision margin around a soft object
  28235. */
  28236. damping?: number;
  28237. /**
  28238. * The path for a rope based on an extrusion
  28239. */
  28240. path?: any;
  28241. /**
  28242. * The shape of an extrusion used for a rope based on an extrusion
  28243. */
  28244. shape?: any;
  28245. }
  28246. /**
  28247. * Interface for a physics-enabled object
  28248. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28249. */
  28250. export interface IPhysicsEnabledObject {
  28251. /**
  28252. * The position of the physics-enabled object
  28253. */
  28254. position: Vector3;
  28255. /**
  28256. * The rotation of the physics-enabled object
  28257. */
  28258. rotationQuaternion: Nullable<Quaternion>;
  28259. /**
  28260. * The scale of the physics-enabled object
  28261. */
  28262. scaling: Vector3;
  28263. /**
  28264. * The rotation of the physics-enabled object
  28265. */
  28266. rotation?: Vector3;
  28267. /**
  28268. * The parent of the physics-enabled object
  28269. */
  28270. parent?: any;
  28271. /**
  28272. * The bounding info of the physics-enabled object
  28273. * @returns The bounding info of the physics-enabled object
  28274. */
  28275. getBoundingInfo(): BoundingInfo;
  28276. /**
  28277. * Computes the world matrix
  28278. * @param force Specifies if the world matrix should be computed by force
  28279. * @returns A world matrix
  28280. */
  28281. computeWorldMatrix(force: boolean): Matrix;
  28282. /**
  28283. * Gets the world matrix
  28284. * @returns A world matrix
  28285. */
  28286. getWorldMatrix?(): Matrix;
  28287. /**
  28288. * Gets the child meshes
  28289. * @param directDescendantsOnly Specifies if only direct-descendants should be obtained
  28290. * @returns An array of abstract meshes
  28291. */
  28292. getChildMeshes?(directDescendantsOnly?: boolean): Array<AbstractMesh>;
  28293. /**
  28294. * Gets the vertex data
  28295. * @param kind The type of vertex data
  28296. * @returns A nullable array of numbers, or a float32 array
  28297. */
  28298. getVerticesData(kind: string): Nullable<Array<number> | Float32Array>;
  28299. /**
  28300. * Gets the indices from the mesh
  28301. * @returns A nullable array of index arrays
  28302. */
  28303. getIndices?(): Nullable<IndicesArray>;
  28304. /**
  28305. * Gets the scene from the mesh
  28306. * @returns the indices array or null
  28307. */
  28308. getScene?(): Scene;
  28309. /**
  28310. * Gets the absolute position from the mesh
  28311. * @returns the absolute position
  28312. */
  28313. getAbsolutePosition(): Vector3;
  28314. /**
  28315. * Gets the absolute pivot point from the mesh
  28316. * @returns the absolute pivot point
  28317. */
  28318. getAbsolutePivotPoint(): Vector3;
  28319. /**
  28320. * Rotates the mesh
  28321. * @param axis The axis of rotation
  28322. * @param amount The amount of rotation
  28323. * @param space The space of the rotation
  28324. * @returns The rotation transform node
  28325. */
  28326. rotate(axis: Vector3, amount: number, space?: Space): TransformNode;
  28327. /**
  28328. * Translates the mesh
  28329. * @param axis The axis of translation
  28330. * @param distance The distance of translation
  28331. * @param space The space of the translation
  28332. * @returns The transform node
  28333. */
  28334. translate(axis: Vector3, distance: number, space?: Space): TransformNode;
  28335. /**
  28336. * Sets the absolute position of the mesh
  28337. * @param absolutePosition The absolute position of the mesh
  28338. * @returns The transform node
  28339. */
  28340. setAbsolutePosition(absolutePosition: Vector3): TransformNode;
  28341. /**
  28342. * Gets the class name of the mesh
  28343. * @returns The class name
  28344. */
  28345. getClassName(): string;
  28346. }
  28347. /**
  28348. * Represents a physics imposter
  28349. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28350. */
  28351. export class PhysicsImpostor {
  28352. /**
  28353. * The physics-enabled object used as the physics imposter
  28354. */
  28355. object: IPhysicsEnabledObject;
  28356. /**
  28357. * The type of the physics imposter
  28358. */
  28359. type: number;
  28360. private _options;
  28361. private _scene?;
  28362. /**
  28363. * The default object size of the imposter
  28364. */
  28365. static DEFAULT_OBJECT_SIZE: Vector3;
  28366. /**
  28367. * The identity quaternion of the imposter
  28368. */
  28369. static IDENTITY_QUATERNION: Quaternion;
  28370. /** @hidden */
  28371. _pluginData: any;
  28372. private _physicsEngine;
  28373. private _physicsBody;
  28374. private _bodyUpdateRequired;
  28375. private _onBeforePhysicsStepCallbacks;
  28376. private _onAfterPhysicsStepCallbacks;
  28377. /** @hidden */
  28378. _onPhysicsCollideCallbacks: Array<{
  28379. callback: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor) => void;
  28380. otherImpostors: Array<PhysicsImpostor>;
  28381. }>;
  28382. private _deltaPosition;
  28383. private _deltaRotation;
  28384. private _deltaRotationConjugated;
  28385. /** @hidden */
  28386. _isFromLine: boolean;
  28387. private _parent;
  28388. private _isDisposed;
  28389. private static _tmpVecs;
  28390. private static _tmpQuat;
  28391. /**
  28392. * Specifies if the physics imposter is disposed
  28393. */
  28394. get isDisposed(): boolean;
  28395. /**
  28396. * Gets the mass of the physics imposter
  28397. */
  28398. get mass(): number;
  28399. set mass(value: number);
  28400. /**
  28401. * Gets the coefficient of friction
  28402. */
  28403. get friction(): number;
  28404. /**
  28405. * Sets the coefficient of friction
  28406. */
  28407. set friction(value: number);
  28408. /**
  28409. * Gets the coefficient of restitution
  28410. */
  28411. get restitution(): number;
  28412. /**
  28413. * Sets the coefficient of restitution
  28414. */
  28415. set restitution(value: number);
  28416. /**
  28417. * Gets the pressure of a soft body; only supported by the AmmoJSPlugin
  28418. */
  28419. get pressure(): number;
  28420. /**
  28421. * Sets the pressure of a soft body; only supported by the AmmoJSPlugin
  28422. */
  28423. set pressure(value: number);
  28424. /**
  28425. * Gets the stiffness of a soft body; only supported by the AmmoJSPlugin
  28426. */
  28427. get stiffness(): number;
  28428. /**
  28429. * Sets the stiffness of a soft body; only supported by the AmmoJSPlugin
  28430. */
  28431. set stiffness(value: number);
  28432. /**
  28433. * Gets the velocityIterations of a soft body; only supported by the AmmoJSPlugin
  28434. */
  28435. get velocityIterations(): number;
  28436. /**
  28437. * Sets the velocityIterations of a soft body; only supported by the AmmoJSPlugin
  28438. */
  28439. set velocityIterations(value: number);
  28440. /**
  28441. * Gets the positionIterations of a soft body; only supported by the AmmoJSPlugin
  28442. */
  28443. get positionIterations(): number;
  28444. /**
  28445. * Sets the positionIterations of a soft body; only supported by the AmmoJSPlugin
  28446. */
  28447. set positionIterations(value: number);
  28448. /**
  28449. * The unique id of the physics imposter
  28450. * set by the physics engine when adding this impostor to the array
  28451. */
  28452. uniqueId: number;
  28453. /**
  28454. * @hidden
  28455. */
  28456. soft: boolean;
  28457. /**
  28458. * @hidden
  28459. */
  28460. segments: number;
  28461. private _joints;
  28462. /**
  28463. * Initializes the physics imposter
  28464. * @param object The physics-enabled object used as the physics imposter
  28465. * @param type The type of the physics imposter
  28466. * @param _options The options for the physics imposter
  28467. * @param _scene The Babylon scene
  28468. */
  28469. constructor(
  28470. /**
  28471. * The physics-enabled object used as the physics imposter
  28472. */
  28473. object: IPhysicsEnabledObject,
  28474. /**
  28475. * The type of the physics imposter
  28476. */
  28477. type: number, _options?: PhysicsImpostorParameters, _scene?: Scene | undefined);
  28478. /**
  28479. * This function will completly initialize this impostor.
  28480. * It will create a new body - but only if this mesh has no parent.
  28481. * If it has, this impostor will not be used other than to define the impostor
  28482. * of the child mesh.
  28483. * @hidden
  28484. */
  28485. _init(): void;
  28486. private _getPhysicsParent;
  28487. /**
  28488. * Should a new body be generated.
  28489. * @returns boolean specifying if body initialization is required
  28490. */
  28491. isBodyInitRequired(): boolean;
  28492. /**
  28493. * Sets the updated scaling
  28494. * @param updated Specifies if the scaling is updated
  28495. */
  28496. setScalingUpdated(): void;
  28497. /**
  28498. * Force a regeneration of this or the parent's impostor's body.
  28499. * Use under cautious - This will remove all joints already implemented.
  28500. */
  28501. forceUpdate(): void;
  28502. /**
  28503. * Gets the body that holds this impostor. Either its own, or its parent.
  28504. */
  28505. get physicsBody(): any;
  28506. /**
  28507. * Get the parent of the physics imposter
  28508. * @returns Physics imposter or null
  28509. */
  28510. get parent(): Nullable<PhysicsImpostor>;
  28511. /**
  28512. * Sets the parent of the physics imposter
  28513. */
  28514. set parent(value: Nullable<PhysicsImpostor>);
  28515. /**
  28516. * Set the physics body. Used mainly by the physics engine/plugin
  28517. */
  28518. set physicsBody(physicsBody: any);
  28519. /**
  28520. * Resets the update flags
  28521. */
  28522. resetUpdateFlags(): void;
  28523. /**
  28524. * Gets the object extend size
  28525. * @returns the object extend size
  28526. */
  28527. getObjectExtendSize(): Vector3;
  28528. /**
  28529. * Gets the object center
  28530. * @returns The object center
  28531. */
  28532. getObjectCenter(): Vector3;
  28533. /**
  28534. * Get a specific parameter from the options parameters
  28535. * @param paramName The object parameter name
  28536. * @returns The object parameter
  28537. */
  28538. getParam(paramName: string): any;
  28539. /**
  28540. * Sets a specific parameter in the options given to the physics plugin
  28541. * @param paramName The parameter name
  28542. * @param value The value of the parameter
  28543. */
  28544. setParam(paramName: string, value: number): void;
  28545. /**
  28546. * Specifically change the body's mass option. Won't recreate the physics body object
  28547. * @param mass The mass of the physics imposter
  28548. */
  28549. setMass(mass: number): void;
  28550. /**
  28551. * Gets the linear velocity
  28552. * @returns linear velocity or null
  28553. */
  28554. getLinearVelocity(): Nullable<Vector3>;
  28555. /**
  28556. * Sets the linear velocity
  28557. * @param velocity linear velocity or null
  28558. */
  28559. setLinearVelocity(velocity: Nullable<Vector3>): void;
  28560. /**
  28561. * Gets the angular velocity
  28562. * @returns angular velocity or null
  28563. */
  28564. getAngularVelocity(): Nullable<Vector3>;
  28565. /**
  28566. * Sets the angular velocity
  28567. * @param velocity The velocity or null
  28568. */
  28569. setAngularVelocity(velocity: Nullable<Vector3>): void;
  28570. /**
  28571. * Execute a function with the physics plugin native code
  28572. * Provide a function the will have two variables - the world object and the physics body object
  28573. * @param func The function to execute with the physics plugin native code
  28574. */
  28575. executeNativeFunction(func: (world: any, physicsBody: any) => void): void;
  28576. /**
  28577. * Register a function that will be executed before the physics world is stepping forward
  28578. * @param func The function to execute before the physics world is stepped forward
  28579. */
  28580. registerBeforePhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  28581. /**
  28582. * Unregister a function that will be executed before the physics world is stepping forward
  28583. * @param func The function to execute before the physics world is stepped forward
  28584. */
  28585. unregisterBeforePhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  28586. /**
  28587. * Register a function that will be executed after the physics step
  28588. * @param func The function to execute after physics step
  28589. */
  28590. registerAfterPhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  28591. /**
  28592. * Unregisters a function that will be executed after the physics step
  28593. * @param func The function to execute after physics step
  28594. */
  28595. unregisterAfterPhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  28596. /**
  28597. * register a function that will be executed when this impostor collides against a different body
  28598. * @param collideAgainst Physics imposter, or array of physics imposters to collide against
  28599. * @param func Callback that is executed on collision
  28600. */
  28601. registerOnPhysicsCollide(collideAgainst: PhysicsImpostor | Array<PhysicsImpostor>, func: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor) => void): void;
  28602. /**
  28603. * Unregisters the physics imposter on contact
  28604. * @param collideAgainst The physics object to collide against
  28605. * @param func Callback to execute on collision
  28606. */
  28607. unregisterOnPhysicsCollide(collideAgainst: PhysicsImpostor | Array<PhysicsImpostor>, func: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor | Array<PhysicsImpostor>) => void): void;
  28608. private _tmpQuat;
  28609. private _tmpQuat2;
  28610. /**
  28611. * Get the parent rotation
  28612. * @returns The parent rotation
  28613. */
  28614. getParentsRotation(): Quaternion;
  28615. /**
  28616. * this function is executed by the physics engine.
  28617. */
  28618. beforeStep: () => void;
  28619. /**
  28620. * this function is executed by the physics engine
  28621. */
  28622. afterStep: () => void;
  28623. /**
  28624. * Legacy collision detection event support
  28625. */
  28626. onCollideEvent: Nullable<(collider: PhysicsImpostor, collidedWith: PhysicsImpostor) => void>;
  28627. /**
  28628. * event and body object due to cannon's event-based architecture.
  28629. */
  28630. onCollide: (e: {
  28631. body: any;
  28632. }) => void;
  28633. /**
  28634. * Apply a force
  28635. * @param force The force to apply
  28636. * @param contactPoint The contact point for the force
  28637. * @returns The physics imposter
  28638. */
  28639. applyForce(force: Vector3, contactPoint: Vector3): PhysicsImpostor;
  28640. /**
  28641. * Apply an impulse
  28642. * @param force The impulse force
  28643. * @param contactPoint The contact point for the impulse force
  28644. * @returns The physics imposter
  28645. */
  28646. applyImpulse(force: Vector3, contactPoint: Vector3): PhysicsImpostor;
  28647. /**
  28648. * A help function to create a joint
  28649. * @param otherImpostor A physics imposter used to create a joint
  28650. * @param jointType The type of joint
  28651. * @param jointData The data for the joint
  28652. * @returns The physics imposter
  28653. */
  28654. createJoint(otherImpostor: PhysicsImpostor, jointType: number, jointData: PhysicsJointData): PhysicsImpostor;
  28655. /**
  28656. * Add a joint to this impostor with a different impostor
  28657. * @param otherImpostor A physics imposter used to add a joint
  28658. * @param joint The joint to add
  28659. * @returns The physics imposter
  28660. */
  28661. addJoint(otherImpostor: PhysicsImpostor, joint: PhysicsJoint): PhysicsImpostor;
  28662. /**
  28663. * Add an anchor to a cloth impostor
  28664. * @param otherImpostor rigid impostor to anchor to
  28665. * @param width ratio across width from 0 to 1
  28666. * @param height ratio up height from 0 to 1
  28667. * @param influence the elasticity between cloth impostor and anchor from 0, very stretchy to 1, little strech
  28668. * @param noCollisionBetweenLinkedBodies when true collisions between cloth impostor and anchor are ignored; default false
  28669. * @returns impostor the soft imposter
  28670. */
  28671. addAnchor(otherImpostor: PhysicsImpostor, width: number, height: number, influence: number, noCollisionBetweenLinkedBodies: boolean): PhysicsImpostor;
  28672. /**
  28673. * Add a hook to a rope impostor
  28674. * @param otherImpostor rigid impostor to anchor to
  28675. * @param length ratio across rope from 0 to 1
  28676. * @param influence the elasticity between rope impostor and anchor from 0, very stretchy to 1, little strech
  28677. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  28678. * @returns impostor the rope imposter
  28679. */
  28680. addHook(otherImpostor: PhysicsImpostor, length: number, influence: number, noCollisionBetweenLinkedBodies: boolean): PhysicsImpostor;
  28681. /**
  28682. * Will keep this body still, in a sleep mode.
  28683. * @returns the physics imposter
  28684. */
  28685. sleep(): PhysicsImpostor;
  28686. /**
  28687. * Wake the body up.
  28688. * @returns The physics imposter
  28689. */
  28690. wakeUp(): PhysicsImpostor;
  28691. /**
  28692. * Clones the physics imposter
  28693. * @param newObject The physics imposter clones to this physics-enabled object
  28694. * @returns A nullable physics imposter
  28695. */
  28696. clone(newObject: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  28697. /**
  28698. * Disposes the physics imposter
  28699. */
  28700. dispose(): void;
  28701. /**
  28702. * Sets the delta position
  28703. * @param position The delta position amount
  28704. */
  28705. setDeltaPosition(position: Vector3): void;
  28706. /**
  28707. * Sets the delta rotation
  28708. * @param rotation The delta rotation amount
  28709. */
  28710. setDeltaRotation(rotation: Quaternion): void;
  28711. /**
  28712. * Gets the box size of the physics imposter and stores the result in the input parameter
  28713. * @param result Stores the box size
  28714. * @returns The physics imposter
  28715. */
  28716. getBoxSizeToRef(result: Vector3): PhysicsImpostor;
  28717. /**
  28718. * Gets the radius of the physics imposter
  28719. * @returns Radius of the physics imposter
  28720. */
  28721. getRadius(): number;
  28722. /**
  28723. * Sync a bone with this impostor
  28724. * @param bone The bone to sync to the impostor.
  28725. * @param boneMesh The mesh that the bone is influencing.
  28726. * @param jointPivot The pivot of the joint / bone in local space.
  28727. * @param distToJoint Optional distance from the impostor to the joint.
  28728. * @param adjustRotation Optional quaternion for adjusting the local rotation of the bone.
  28729. */
  28730. syncBoneWithImpostor(bone: Bone, boneMesh: AbstractMesh, jointPivot: Vector3, distToJoint?: number, adjustRotation?: Quaternion): void;
  28731. /**
  28732. * Sync impostor to a bone
  28733. * @param bone The bone that the impostor will be synced to.
  28734. * @param boneMesh The mesh that the bone is influencing.
  28735. * @param jointPivot The pivot of the joint / bone in local space.
  28736. * @param distToJoint Optional distance from the impostor to the joint.
  28737. * @param adjustRotation Optional quaternion for adjusting the local rotation of the bone.
  28738. * @param boneAxis Optional vector3 axis the bone is aligned with
  28739. */
  28740. syncImpostorWithBone(bone: Bone, boneMesh: AbstractMesh, jointPivot: Vector3, distToJoint?: number, adjustRotation?: Quaternion, boneAxis?: Vector3): void;
  28741. /**
  28742. * No-Imposter type
  28743. */
  28744. static NoImpostor: number;
  28745. /**
  28746. * Sphere-Imposter type
  28747. */
  28748. static SphereImpostor: number;
  28749. /**
  28750. * Box-Imposter type
  28751. */
  28752. static BoxImpostor: number;
  28753. /**
  28754. * Plane-Imposter type
  28755. */
  28756. static PlaneImpostor: number;
  28757. /**
  28758. * Mesh-imposter type
  28759. */
  28760. static MeshImpostor: number;
  28761. /**
  28762. * Capsule-Impostor type (Ammo.js plugin only)
  28763. */
  28764. static CapsuleImpostor: number;
  28765. /**
  28766. * Cylinder-Imposter type
  28767. */
  28768. static CylinderImpostor: number;
  28769. /**
  28770. * Particle-Imposter type
  28771. */
  28772. static ParticleImpostor: number;
  28773. /**
  28774. * Heightmap-Imposter type
  28775. */
  28776. static HeightmapImpostor: number;
  28777. /**
  28778. * ConvexHull-Impostor type (Ammo.js plugin only)
  28779. */
  28780. static ConvexHullImpostor: number;
  28781. /**
  28782. * Custom-Imposter type (Ammo.js plugin only)
  28783. */
  28784. static CustomImpostor: number;
  28785. /**
  28786. * Rope-Imposter type
  28787. */
  28788. static RopeImpostor: number;
  28789. /**
  28790. * Cloth-Imposter type
  28791. */
  28792. static ClothImpostor: number;
  28793. /**
  28794. * Softbody-Imposter type
  28795. */
  28796. static SoftbodyImpostor: number;
  28797. }
  28798. }
  28799. declare module "babylonjs/Meshes/mesh" {
  28800. import { Observable } from "babylonjs/Misc/observable";
  28801. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  28802. import { Nullable, FloatArray, IndicesArray } from "babylonjs/types";
  28803. import { Camera } from "babylonjs/Cameras/camera";
  28804. import { Scene } from "babylonjs/scene";
  28805. import { Matrix, Vector3, Vector2, Vector4 } from "babylonjs/Maths/math.vector";
  28806. import { Color4 } from "babylonjs/Maths/math.color";
  28807. import { Engine } from "babylonjs/Engines/engine";
  28808. import { Node } from "babylonjs/node";
  28809. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  28810. import { IGetSetVerticesData } from "babylonjs/Meshes/mesh.vertexData";
  28811. import { Buffer } from "babylonjs/Meshes/buffer";
  28812. import { Geometry } from "babylonjs/Meshes/geometry";
  28813. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  28814. import { SubMesh } from "babylonjs/Meshes/subMesh";
  28815. import { BoundingSphere } from "babylonjs/Culling/boundingSphere";
  28816. import { Effect } from "babylonjs/Materials/effect";
  28817. import { Material } from "babylonjs/Materials/material";
  28818. import { Skeleton } from "babylonjs/Bones/skeleton";
  28819. import { MorphTargetManager } from "babylonjs/Morph/morphTargetManager";
  28820. import { MeshLODLevel } from "babylonjs/Meshes/meshLODLevel";
  28821. import { Path3D } from "babylonjs/Maths/math.path";
  28822. import { Plane } from "babylonjs/Maths/math.plane";
  28823. import { TransformNode } from "babylonjs/Meshes/transformNode";
  28824. import { LinesMesh } from "babylonjs/Meshes/linesMesh";
  28825. import { InstancedMesh } from "babylonjs/Meshes/instancedMesh";
  28826. import { GroundMesh } from "babylonjs/Meshes/groundMesh";
  28827. import { IPhysicsEnabledObject } from "babylonjs/Physics/physicsImpostor";
  28828. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  28829. /**
  28830. * @hidden
  28831. **/
  28832. export class _CreationDataStorage {
  28833. closePath?: boolean;
  28834. closeArray?: boolean;
  28835. idx: number[];
  28836. dashSize: number;
  28837. gapSize: number;
  28838. path3D: Path3D;
  28839. pathArray: Vector3[][];
  28840. arc: number;
  28841. radius: number;
  28842. cap: number;
  28843. tessellation: number;
  28844. }
  28845. /**
  28846. * @hidden
  28847. **/
  28848. class _InstanceDataStorage {
  28849. visibleInstances: any;
  28850. batchCache: _InstancesBatch;
  28851. instancesBufferSize: number;
  28852. instancesBuffer: Nullable<Buffer>;
  28853. instancesData: Float32Array;
  28854. overridenInstanceCount: number;
  28855. isFrozen: boolean;
  28856. previousBatch: Nullable<_InstancesBatch>;
  28857. hardwareInstancedRendering: boolean;
  28858. sideOrientation: number;
  28859. manualUpdate: boolean;
  28860. }
  28861. /**
  28862. * @hidden
  28863. **/
  28864. export class _InstancesBatch {
  28865. mustReturn: boolean;
  28866. visibleInstances: Nullable<import("babylonjs/Meshes/instancedMesh").InstancedMesh[]>[];
  28867. renderSelf: boolean[];
  28868. hardwareInstancedRendering: boolean[];
  28869. }
  28870. /**
  28871. * @hidden
  28872. **/
  28873. class _ThinInstanceDataStorage {
  28874. instancesCount: number;
  28875. matrixBuffer: Nullable<Buffer>;
  28876. matrixBufferSize: number;
  28877. matrixData: Nullable<Float32Array>;
  28878. boundingVectors: Array<Vector3>;
  28879. }
  28880. /**
  28881. * Class used to represent renderable models
  28882. */
  28883. export class Mesh extends AbstractMesh implements IGetSetVerticesData {
  28884. /**
  28885. * Mesh side orientation : usually the external or front surface
  28886. */
  28887. static readonly FRONTSIDE: number;
  28888. /**
  28889. * Mesh side orientation : usually the internal or back surface
  28890. */
  28891. static readonly BACKSIDE: number;
  28892. /**
  28893. * Mesh side orientation : both internal and external or front and back surfaces
  28894. */
  28895. static readonly DOUBLESIDE: number;
  28896. /**
  28897. * Mesh side orientation : by default, `FRONTSIDE`
  28898. */
  28899. static readonly DEFAULTSIDE: number;
  28900. /**
  28901. * Mesh cap setting : no cap
  28902. */
  28903. static readonly NO_CAP: number;
  28904. /**
  28905. * Mesh cap setting : one cap at the beginning of the mesh
  28906. */
  28907. static readonly CAP_START: number;
  28908. /**
  28909. * Mesh cap setting : one cap at the end of the mesh
  28910. */
  28911. static readonly CAP_END: number;
  28912. /**
  28913. * Mesh cap setting : two caps, one at the beginning and one at the end of the mesh
  28914. */
  28915. static readonly CAP_ALL: number;
  28916. /**
  28917. * Mesh pattern setting : no flip or rotate
  28918. */
  28919. static readonly NO_FLIP: number;
  28920. /**
  28921. * Mesh pattern setting : flip (reflect in y axis) alternate tiles on each row or column
  28922. */
  28923. static readonly FLIP_TILE: number;
  28924. /**
  28925. * Mesh pattern setting : rotate (180degs) alternate tiles on each row or column
  28926. */
  28927. static readonly ROTATE_TILE: number;
  28928. /**
  28929. * Mesh pattern setting : flip (reflect in y axis) all tiles on alternate rows
  28930. */
  28931. static readonly FLIP_ROW: number;
  28932. /**
  28933. * Mesh pattern setting : rotate (180degs) all tiles on alternate rows
  28934. */
  28935. static readonly ROTATE_ROW: number;
  28936. /**
  28937. * Mesh pattern setting : flip and rotate alternate tiles on each row or column
  28938. */
  28939. static readonly FLIP_N_ROTATE_TILE: number;
  28940. /**
  28941. * Mesh pattern setting : rotate pattern and rotate
  28942. */
  28943. static readonly FLIP_N_ROTATE_ROW: number;
  28944. /**
  28945. * Mesh tile positioning : part tiles same on left/right or top/bottom
  28946. */
  28947. static readonly CENTER: number;
  28948. /**
  28949. * Mesh tile positioning : part tiles on left
  28950. */
  28951. static readonly LEFT: number;
  28952. /**
  28953. * Mesh tile positioning : part tiles on right
  28954. */
  28955. static readonly RIGHT: number;
  28956. /**
  28957. * Mesh tile positioning : part tiles on top
  28958. */
  28959. static readonly TOP: number;
  28960. /**
  28961. * Mesh tile positioning : part tiles on bottom
  28962. */
  28963. static readonly BOTTOM: number;
  28964. /**
  28965. * Gets the default side orientation.
  28966. * @param orientation the orientation to value to attempt to get
  28967. * @returns the default orientation
  28968. * @hidden
  28969. */
  28970. static _GetDefaultSideOrientation(orientation?: number): number;
  28971. private _internalMeshDataInfo;
  28972. get computeBonesUsingShaders(): boolean;
  28973. set computeBonesUsingShaders(value: boolean);
  28974. /**
  28975. * An event triggered before rendering the mesh
  28976. */
  28977. get onBeforeRenderObservable(): Observable<Mesh>;
  28978. /**
  28979. * An event triggered before binding the mesh
  28980. */
  28981. get onBeforeBindObservable(): Observable<Mesh>;
  28982. /**
  28983. * An event triggered after rendering the mesh
  28984. */
  28985. get onAfterRenderObservable(): Observable<Mesh>;
  28986. /**
  28987. * An event triggered before drawing the mesh
  28988. */
  28989. get onBeforeDrawObservable(): Observable<Mesh>;
  28990. private _onBeforeDrawObserver;
  28991. /**
  28992. * Sets a callback to call before drawing the mesh. It is recommended to use onBeforeDrawObservable instead
  28993. */
  28994. set onBeforeDraw(callback: () => void);
  28995. get hasInstances(): boolean;
  28996. get hasThinInstances(): boolean;
  28997. /**
  28998. * Gets the delay loading state of the mesh (when delay loading is turned on)
  28999. * @see https://doc.babylonjs.com/how_to/using_the_incremental_loading_system
  29000. */
  29001. delayLoadState: number;
  29002. /**
  29003. * Gets the list of instances created from this mesh
  29004. * it is not supposed to be modified manually.
  29005. * Note also that the order of the InstancedMesh wihin the array is not significant and might change.
  29006. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  29007. */
  29008. instances: import("babylonjs/Meshes/instancedMesh").InstancedMesh[];
  29009. /**
  29010. * Gets the file containing delay loading data for this mesh
  29011. */
  29012. delayLoadingFile: string;
  29013. /** @hidden */
  29014. _binaryInfo: any;
  29015. /**
  29016. * User defined function used to change how LOD level selection is done
  29017. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  29018. */
  29019. onLODLevelSelection: (distance: number, mesh: Mesh, selectedLevel: Nullable<Mesh>) => void;
  29020. /**
  29021. * Gets or sets the morph target manager
  29022. * @see https://doc.babylonjs.com/how_to/how_to_use_morphtargets
  29023. */
  29024. get morphTargetManager(): Nullable<MorphTargetManager>;
  29025. set morphTargetManager(value: Nullable<MorphTargetManager>);
  29026. /** @hidden */
  29027. _creationDataStorage: Nullable<_CreationDataStorage>;
  29028. /** @hidden */
  29029. _geometry: Nullable<Geometry>;
  29030. /** @hidden */
  29031. _delayInfo: Array<string>;
  29032. /** @hidden */
  29033. _delayLoadingFunction: (any: any, mesh: Mesh) => void;
  29034. /** @hidden */
  29035. _instanceDataStorage: _InstanceDataStorage;
  29036. /** @hidden */
  29037. _thinInstanceDataStorage: _ThinInstanceDataStorage;
  29038. private _effectiveMaterial;
  29039. /** @hidden */
  29040. _shouldGenerateFlatShading: boolean;
  29041. /** @hidden */
  29042. _originalBuilderSideOrientation: number;
  29043. /**
  29044. * Use this property to change the original side orientation defined at construction time
  29045. */
  29046. overrideMaterialSideOrientation: Nullable<number>;
  29047. /**
  29048. * Gets the source mesh (the one used to clone this one from)
  29049. */
  29050. get source(): Nullable<Mesh>;
  29051. /**
  29052. * Gets or sets a boolean indicating that this mesh does not use index buffer
  29053. */
  29054. get isUnIndexed(): boolean;
  29055. set isUnIndexed(value: boolean);
  29056. /** Gets the array buffer used to store the instanced buffer used for instances' world matrices */
  29057. get worldMatrixInstancedBuffer(): Float32Array;
  29058. /** Gets or sets a boolean indicating that the update of the instance buffer of the world matrices is manual */
  29059. get manualUpdateOfWorldMatrixInstancedBuffer(): boolean;
  29060. set manualUpdateOfWorldMatrixInstancedBuffer(value: boolean);
  29061. /**
  29062. * @constructor
  29063. * @param name The value used by scene.getMeshByName() to do a lookup.
  29064. * @param scene The scene to add this mesh to.
  29065. * @param parent The parent of this mesh, if it has one
  29066. * @param source An optional Mesh from which geometry is shared, cloned.
  29067. * @param doNotCloneChildren When cloning, skip cloning child meshes of source, default False.
  29068. * When false, achieved by calling a clone(), also passing False.
  29069. * This will make creation of children, recursive.
  29070. * @param clonePhysicsImpostor When cloning, include cloning mesh physics impostor, default True.
  29071. */
  29072. constructor(name: string, scene?: Nullable<Scene>, parent?: Nullable<Node>, source?: Nullable<Mesh>, doNotCloneChildren?: boolean, clonePhysicsImpostor?: boolean);
  29073. instantiateHierarchy(newParent?: Nullable<TransformNode>, options?: {
  29074. doNotInstantiate: boolean;
  29075. }, onNewNodeCreated?: (source: TransformNode, clone: TransformNode) => void): Nullable<TransformNode>;
  29076. /**
  29077. * Gets the class name
  29078. * @returns the string "Mesh".
  29079. */
  29080. getClassName(): string;
  29081. /** @hidden */
  29082. get _isMesh(): boolean;
  29083. /**
  29084. * Returns a description of this mesh
  29085. * @param fullDetails define if full details about this mesh must be used
  29086. * @returns a descriptive string representing this mesh
  29087. */
  29088. toString(fullDetails?: boolean): string;
  29089. /** @hidden */
  29090. _unBindEffect(): void;
  29091. /**
  29092. * Gets a boolean indicating if this mesh has LOD
  29093. */
  29094. get hasLODLevels(): boolean;
  29095. /**
  29096. * Gets the list of MeshLODLevel associated with the current mesh
  29097. * @returns an array of MeshLODLevel
  29098. */
  29099. getLODLevels(): MeshLODLevel[];
  29100. private _sortLODLevels;
  29101. /**
  29102. * Add a mesh as LOD level triggered at the given distance.
  29103. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  29104. * @param distance The distance from the center of the object to show this level
  29105. * @param mesh The mesh to be added as LOD level (can be null)
  29106. * @return This mesh (for chaining)
  29107. */
  29108. addLODLevel(distance: number, mesh: Nullable<Mesh>): Mesh;
  29109. /**
  29110. * Returns the LOD level mesh at the passed distance or null if not found.
  29111. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  29112. * @param distance The distance from the center of the object to show this level
  29113. * @returns a Mesh or `null`
  29114. */
  29115. getLODLevelAtDistance(distance: number): Nullable<Mesh>;
  29116. /**
  29117. * Remove a mesh from the LOD array
  29118. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  29119. * @param mesh defines the mesh to be removed
  29120. * @return This mesh (for chaining)
  29121. */
  29122. removeLODLevel(mesh: Mesh): Mesh;
  29123. /**
  29124. * Returns the registered LOD mesh distant from the parameter `camera` position if any, else returns the current mesh.
  29125. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  29126. * @param camera defines the camera to use to compute distance
  29127. * @param boundingSphere defines a custom bounding sphere to use instead of the one from this mesh
  29128. * @return This mesh (for chaining)
  29129. */
  29130. getLOD(camera: Camera, boundingSphere?: BoundingSphere): Nullable<AbstractMesh>;
  29131. /**
  29132. * Gets the mesh internal Geometry object
  29133. */
  29134. get geometry(): Nullable<Geometry>;
  29135. /**
  29136. * Returns the total number of vertices within the mesh geometry or zero if the mesh has no geometry.
  29137. * @returns the total number of vertices
  29138. */
  29139. getTotalVertices(): number;
  29140. /**
  29141. * Returns the content of an associated vertex buffer
  29142. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  29143. * - VertexBuffer.PositionKind
  29144. * - VertexBuffer.UVKind
  29145. * - VertexBuffer.UV2Kind
  29146. * - VertexBuffer.UV3Kind
  29147. * - VertexBuffer.UV4Kind
  29148. * - VertexBuffer.UV5Kind
  29149. * - VertexBuffer.UV6Kind
  29150. * - VertexBuffer.ColorKind
  29151. * - VertexBuffer.MatricesIndicesKind
  29152. * - VertexBuffer.MatricesIndicesExtraKind
  29153. * - VertexBuffer.MatricesWeightsKind
  29154. * - VertexBuffer.MatricesWeightsExtraKind
  29155. * @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
  29156. * @param forceCopy defines a boolean forcing the copy of the buffer no matter what the value of copyWhenShared is
  29157. * @returns a FloatArray or null if the mesh has no geometry or no vertex buffer for this kind.
  29158. */
  29159. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  29160. /**
  29161. * Returns the mesh VertexBuffer object from the requested `kind`
  29162. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  29163. * - VertexBuffer.PositionKind
  29164. * - VertexBuffer.NormalKind
  29165. * - VertexBuffer.UVKind
  29166. * - VertexBuffer.UV2Kind
  29167. * - VertexBuffer.UV3Kind
  29168. * - VertexBuffer.UV4Kind
  29169. * - VertexBuffer.UV5Kind
  29170. * - VertexBuffer.UV6Kind
  29171. * - VertexBuffer.ColorKind
  29172. * - VertexBuffer.MatricesIndicesKind
  29173. * - VertexBuffer.MatricesIndicesExtraKind
  29174. * - VertexBuffer.MatricesWeightsKind
  29175. * - VertexBuffer.MatricesWeightsExtraKind
  29176. * @returns a FloatArray or null if the mesh has no vertex buffer for this kind.
  29177. */
  29178. getVertexBuffer(kind: string): Nullable<VertexBuffer>;
  29179. /**
  29180. * Tests if a specific vertex buffer is associated with this mesh
  29181. * @param kind defines which buffer to check (positions, indices, normals, etc). Possible `kind` values :
  29182. * - VertexBuffer.PositionKind
  29183. * - VertexBuffer.NormalKind
  29184. * - VertexBuffer.UVKind
  29185. * - VertexBuffer.UV2Kind
  29186. * - VertexBuffer.UV3Kind
  29187. * - VertexBuffer.UV4Kind
  29188. * - VertexBuffer.UV5Kind
  29189. * - VertexBuffer.UV6Kind
  29190. * - VertexBuffer.ColorKind
  29191. * - VertexBuffer.MatricesIndicesKind
  29192. * - VertexBuffer.MatricesIndicesExtraKind
  29193. * - VertexBuffer.MatricesWeightsKind
  29194. * - VertexBuffer.MatricesWeightsExtraKind
  29195. * @returns a boolean
  29196. */
  29197. isVerticesDataPresent(kind: string): boolean;
  29198. /**
  29199. * Returns a boolean defining if the vertex data for the requested `kind` is updatable.
  29200. * @param kind defines which buffer to check (positions, indices, normals, etc). Possible `kind` values :
  29201. * - VertexBuffer.PositionKind
  29202. * - VertexBuffer.UVKind
  29203. * - VertexBuffer.UV2Kind
  29204. * - VertexBuffer.UV3Kind
  29205. * - VertexBuffer.UV4Kind
  29206. * - VertexBuffer.UV5Kind
  29207. * - VertexBuffer.UV6Kind
  29208. * - VertexBuffer.ColorKind
  29209. * - VertexBuffer.MatricesIndicesKind
  29210. * - VertexBuffer.MatricesIndicesExtraKind
  29211. * - VertexBuffer.MatricesWeightsKind
  29212. * - VertexBuffer.MatricesWeightsExtraKind
  29213. * @returns a boolean
  29214. */
  29215. isVertexBufferUpdatable(kind: string): boolean;
  29216. /**
  29217. * Returns a string which contains the list of existing `kinds` of Vertex Data associated with this mesh.
  29218. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  29219. * - VertexBuffer.PositionKind
  29220. * - VertexBuffer.NormalKind
  29221. * - VertexBuffer.UVKind
  29222. * - VertexBuffer.UV2Kind
  29223. * - VertexBuffer.UV3Kind
  29224. * - VertexBuffer.UV4Kind
  29225. * - VertexBuffer.UV5Kind
  29226. * - VertexBuffer.UV6Kind
  29227. * - VertexBuffer.ColorKind
  29228. * - VertexBuffer.MatricesIndicesKind
  29229. * - VertexBuffer.MatricesIndicesExtraKind
  29230. * - VertexBuffer.MatricesWeightsKind
  29231. * - VertexBuffer.MatricesWeightsExtraKind
  29232. * @returns an array of strings
  29233. */
  29234. getVerticesDataKinds(): string[];
  29235. /**
  29236. * Returns a positive integer : the total number of indices in this mesh geometry.
  29237. * @returns the numner of indices or zero if the mesh has no geometry.
  29238. */
  29239. getTotalIndices(): number;
  29240. /**
  29241. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  29242. * @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.
  29243. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  29244. * @returns the indices array or an empty array if the mesh has no geometry
  29245. */
  29246. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  29247. get isBlocked(): boolean;
  29248. /**
  29249. * Determine if the current mesh is ready to be rendered
  29250. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  29251. * @param forceInstanceSupport will check if the mesh will be ready when used with instances (false by default)
  29252. * @returns true if all associated assets are ready (material, textures, shaders)
  29253. */
  29254. isReady(completeCheck?: boolean, forceInstanceSupport?: boolean): boolean;
  29255. /**
  29256. * 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.
  29257. */
  29258. get areNormalsFrozen(): boolean;
  29259. /**
  29260. * 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.
  29261. * @returns the current mesh
  29262. */
  29263. freezeNormals(): Mesh;
  29264. /**
  29265. * 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
  29266. * @returns the current mesh
  29267. */
  29268. unfreezeNormals(): Mesh;
  29269. /**
  29270. * Sets a value overriding the instance count. Only applicable when custom instanced InterleavedVertexBuffer are used rather than InstancedMeshs
  29271. */
  29272. set overridenInstanceCount(count: number);
  29273. /** @hidden */
  29274. _preActivate(): Mesh;
  29275. /** @hidden */
  29276. _preActivateForIntermediateRendering(renderId: number): Mesh;
  29277. /** @hidden */
  29278. _registerInstanceForRenderId(instance: InstancedMesh, renderId: number): Mesh;
  29279. protected _afterComputeWorldMatrix(): void;
  29280. /** @hidden */
  29281. _postActivate(): void;
  29282. /**
  29283. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  29284. * This means the mesh underlying bounding box and sphere are recomputed.
  29285. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  29286. * @returns the current mesh
  29287. */
  29288. refreshBoundingInfo(applySkeleton?: boolean): Mesh;
  29289. /** @hidden */
  29290. _createGlobalSubMesh(force: boolean): Nullable<SubMesh>;
  29291. /**
  29292. * This function will subdivide the mesh into multiple submeshes
  29293. * @param count defines the expected number of submeshes
  29294. */
  29295. subdivide(count: number): void;
  29296. /**
  29297. * Copy a FloatArray into a specific associated vertex buffer
  29298. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  29299. * - VertexBuffer.PositionKind
  29300. * - VertexBuffer.UVKind
  29301. * - VertexBuffer.UV2Kind
  29302. * - VertexBuffer.UV3Kind
  29303. * - VertexBuffer.UV4Kind
  29304. * - VertexBuffer.UV5Kind
  29305. * - VertexBuffer.UV6Kind
  29306. * - VertexBuffer.ColorKind
  29307. * - VertexBuffer.MatricesIndicesKind
  29308. * - VertexBuffer.MatricesIndicesExtraKind
  29309. * - VertexBuffer.MatricesWeightsKind
  29310. * - VertexBuffer.MatricesWeightsExtraKind
  29311. * @param data defines the data source
  29312. * @param updatable defines if the updated vertex buffer must be flagged as updatable
  29313. * @param stride defines the data stride size (can be null)
  29314. * @returns the current mesh
  29315. */
  29316. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  29317. /**
  29318. * Delete a vertex buffer associated with this mesh
  29319. * @param kind defines which buffer to delete (positions, indices, normals, etc). Possible `kind` values :
  29320. * - VertexBuffer.PositionKind
  29321. * - VertexBuffer.UVKind
  29322. * - VertexBuffer.UV2Kind
  29323. * - VertexBuffer.UV3Kind
  29324. * - VertexBuffer.UV4Kind
  29325. * - VertexBuffer.UV5Kind
  29326. * - VertexBuffer.UV6Kind
  29327. * - VertexBuffer.ColorKind
  29328. * - VertexBuffer.MatricesIndicesKind
  29329. * - VertexBuffer.MatricesIndicesExtraKind
  29330. * - VertexBuffer.MatricesWeightsKind
  29331. * - VertexBuffer.MatricesWeightsExtraKind
  29332. */
  29333. removeVerticesData(kind: string): void;
  29334. /**
  29335. * Flags an associated vertex buffer as updatable
  29336. * @param kind defines which buffer to use (positions, indices, normals, etc). Possible `kind` values :
  29337. * - VertexBuffer.PositionKind
  29338. * - VertexBuffer.UVKind
  29339. * - VertexBuffer.UV2Kind
  29340. * - VertexBuffer.UV3Kind
  29341. * - VertexBuffer.UV4Kind
  29342. * - VertexBuffer.UV5Kind
  29343. * - VertexBuffer.UV6Kind
  29344. * - VertexBuffer.ColorKind
  29345. * - VertexBuffer.MatricesIndicesKind
  29346. * - VertexBuffer.MatricesIndicesExtraKind
  29347. * - VertexBuffer.MatricesWeightsKind
  29348. * - VertexBuffer.MatricesWeightsExtraKind
  29349. * @param updatable defines if the updated vertex buffer must be flagged as updatable
  29350. */
  29351. markVerticesDataAsUpdatable(kind: string, updatable?: boolean): void;
  29352. /**
  29353. * Sets the mesh global Vertex Buffer
  29354. * @param buffer defines the buffer to use
  29355. * @returns the current mesh
  29356. */
  29357. setVerticesBuffer(buffer: VertexBuffer): Mesh;
  29358. /**
  29359. * Update a specific associated vertex buffer
  29360. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  29361. * - VertexBuffer.PositionKind
  29362. * - VertexBuffer.UVKind
  29363. * - VertexBuffer.UV2Kind
  29364. * - VertexBuffer.UV3Kind
  29365. * - VertexBuffer.UV4Kind
  29366. * - VertexBuffer.UV5Kind
  29367. * - VertexBuffer.UV6Kind
  29368. * - VertexBuffer.ColorKind
  29369. * - VertexBuffer.MatricesIndicesKind
  29370. * - VertexBuffer.MatricesIndicesExtraKind
  29371. * - VertexBuffer.MatricesWeightsKind
  29372. * - VertexBuffer.MatricesWeightsExtraKind
  29373. * @param data defines the data source
  29374. * @param updateExtends defines if extends info of the mesh must be updated (can be null). This is mostly useful for "position" kind
  29375. * @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)
  29376. * @returns the current mesh
  29377. */
  29378. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): AbstractMesh;
  29379. /**
  29380. * This method updates the vertex positions of an updatable mesh according to the `positionFunction` returned values.
  29381. * @see https://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh#other-shapes-updatemeshpositions
  29382. * @param positionFunction is a simple JS function what is passed the mesh `positions` array. It doesn't need to return anything
  29383. * @param computeNormals is a boolean (default true) to enable/disable the mesh normal recomputation after the vertex position update
  29384. * @returns the current mesh
  29385. */
  29386. updateMeshPositions(positionFunction: (data: FloatArray) => void, computeNormals?: boolean): Mesh;
  29387. /**
  29388. * Creates a un-shared specific occurence of the geometry for the mesh.
  29389. * @returns the current mesh
  29390. */
  29391. makeGeometryUnique(): Mesh;
  29392. /**
  29393. * Set the index buffer of this mesh
  29394. * @param indices defines the source data
  29395. * @param totalVertices defines the total number of vertices referenced by this index data (can be null)
  29396. * @param updatable defines if the updated index buffer must be flagged as updatable (default is false)
  29397. * @returns the current mesh
  29398. */
  29399. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>, updatable?: boolean): AbstractMesh;
  29400. /**
  29401. * Update the current index buffer
  29402. * @param indices defines the source data
  29403. * @param offset defines the offset in the index buffer where to store the new data (can be null)
  29404. * @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)
  29405. * @returns the current mesh
  29406. */
  29407. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): AbstractMesh;
  29408. /**
  29409. * Invert the geometry to move from a right handed system to a left handed one.
  29410. * @returns the current mesh
  29411. */
  29412. toLeftHanded(): Mesh;
  29413. /** @hidden */
  29414. _bind(subMesh: SubMesh, effect: Effect, fillMode: number): Mesh;
  29415. /** @hidden */
  29416. _draw(subMesh: SubMesh, fillMode: number, instancesCount?: number): Mesh;
  29417. /**
  29418. * Registers for this mesh a javascript function called just before the rendering process
  29419. * @param func defines the function to call before rendering this mesh
  29420. * @returns the current mesh
  29421. */
  29422. registerBeforeRender(func: (mesh: AbstractMesh) => void): Mesh;
  29423. /**
  29424. * Disposes a previously registered javascript function called before the rendering
  29425. * @param func defines the function to remove
  29426. * @returns the current mesh
  29427. */
  29428. unregisterBeforeRender(func: (mesh: AbstractMesh) => void): Mesh;
  29429. /**
  29430. * Registers for this mesh a javascript function called just after the rendering is complete
  29431. * @param func defines the function to call after rendering this mesh
  29432. * @returns the current mesh
  29433. */
  29434. registerAfterRender(func: (mesh: AbstractMesh) => void): Mesh;
  29435. /**
  29436. * Disposes a previously registered javascript function called after the rendering.
  29437. * @param func defines the function to remove
  29438. * @returns the current mesh
  29439. */
  29440. unregisterAfterRender(func: (mesh: AbstractMesh) => void): Mesh;
  29441. /** @hidden */
  29442. _getInstancesRenderList(subMeshId: number, isReplacementMode?: boolean): _InstancesBatch;
  29443. /** @hidden */
  29444. _renderWithInstances(subMesh: SubMesh, fillMode: number, batch: _InstancesBatch, effect: Effect, engine: Engine): Mesh;
  29445. /** @hidden */
  29446. _renderWithThinInstances(subMesh: SubMesh, fillMode: number, effect: Effect, engine: Engine): void;
  29447. /** @hidden */
  29448. _processInstancedBuffers(visibleInstances: InstancedMesh[], renderSelf: boolean): void;
  29449. /** @hidden */
  29450. _processRendering(renderingMesh: AbstractMesh, subMesh: SubMesh, effect: Effect, fillMode: number, batch: _InstancesBatch, hardwareInstancedRendering: boolean, onBeforeDraw: (isInstance: boolean, world: Matrix, effectiveMaterial?: Material) => void, effectiveMaterial?: Material): Mesh;
  29451. /** @hidden */
  29452. _rebuild(): void;
  29453. /** @hidden */
  29454. _freeze(): void;
  29455. /** @hidden */
  29456. _unFreeze(): void;
  29457. /**
  29458. * 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
  29459. * @param subMesh defines the subMesh to render
  29460. * @param enableAlphaMode defines if alpha mode can be changed
  29461. * @param effectiveMeshReplacement defines an optional mesh used to provide info for the rendering
  29462. * @returns the current mesh
  29463. */
  29464. render(subMesh: SubMesh, enableAlphaMode: boolean, effectiveMeshReplacement?: AbstractMesh): Mesh;
  29465. private _onBeforeDraw;
  29466. /**
  29467. * Renormalize the mesh and patch it up if there are no weights
  29468. * Similar to normalization by adding the weights compute the reciprocal and multiply all elements, this wil ensure that everything adds to 1.
  29469. * However in the case of zero weights then we set just a single influence to 1.
  29470. * We check in the function for extra's present and if so we use the normalizeSkinWeightsWithExtras rather than the FourWeights version.
  29471. */
  29472. cleanMatrixWeights(): void;
  29473. private normalizeSkinFourWeights;
  29474. private normalizeSkinWeightsAndExtra;
  29475. /**
  29476. * ValidateSkinning is used to determine that a mesh has valid skinning data along with skin metrics, if missing weights,
  29477. * or not normalized it is returned as invalid mesh the string can be used for console logs, or on screen messages to let
  29478. * the user know there was an issue with importing the mesh
  29479. * @returns a validation object with skinned, valid and report string
  29480. */
  29481. validateSkinning(): {
  29482. skinned: boolean;
  29483. valid: boolean;
  29484. report: string;
  29485. };
  29486. /** @hidden */
  29487. _checkDelayState(): Mesh;
  29488. private _queueLoad;
  29489. /**
  29490. * Returns `true` if the mesh is within the frustum defined by the passed array of planes.
  29491. * A mesh is in the frustum if its bounding box intersects the frustum
  29492. * @param frustumPlanes defines the frustum to test
  29493. * @returns true if the mesh is in the frustum planes
  29494. */
  29495. isInFrustum(frustumPlanes: Plane[]): boolean;
  29496. /**
  29497. * Sets the mesh material by the material or multiMaterial `id` property
  29498. * @param id is a string identifying the material or the multiMaterial
  29499. * @returns the current mesh
  29500. */
  29501. setMaterialByID(id: string): Mesh;
  29502. /**
  29503. * Returns as a new array populated with the mesh material and/or skeleton, if any.
  29504. * @returns an array of IAnimatable
  29505. */
  29506. getAnimatables(): IAnimatable[];
  29507. /**
  29508. * Modifies the mesh geometry according to the passed transformation matrix.
  29509. * This method returns nothing but it really modifies the mesh even if it's originally not set as updatable.
  29510. * The mesh normals are modified using the same transformation.
  29511. * Note that, under the hood, this method sets a new VertexBuffer each call.
  29512. * @param transform defines the transform matrix to use
  29513. * @see https://doc.babylonjs.com/resources/baking_transformations
  29514. * @returns the current mesh
  29515. */
  29516. bakeTransformIntoVertices(transform: Matrix): Mesh;
  29517. /**
  29518. * Modifies the mesh geometry according to its own current World Matrix.
  29519. * The mesh World Matrix is then reset.
  29520. * This method returns nothing but really modifies the mesh even if it's originally not set as updatable.
  29521. * Note that, under the hood, this method sets a new VertexBuffer each call.
  29522. * @see https://doc.babylonjs.com/resources/baking_transformations
  29523. * @param bakeIndependenlyOfChildren indicates whether to preserve all child nodes' World Matrix during baking
  29524. * @returns the current mesh
  29525. */
  29526. bakeCurrentTransformIntoVertices(bakeIndependenlyOfChildren?: boolean): Mesh;
  29527. /** @hidden */
  29528. get _positions(): Nullable<Vector3[]>;
  29529. /** @hidden */
  29530. _resetPointsArrayCache(): Mesh;
  29531. /** @hidden */
  29532. _generatePointsArray(): boolean;
  29533. /**
  29534. * Returns a new Mesh object generated from the current mesh properties.
  29535. * This method must not get confused with createInstance()
  29536. * @param name is a string, the name given to the new mesh
  29537. * @param newParent can be any Node object (default `null`)
  29538. * @param doNotCloneChildren allows/denies the recursive cloning of the original mesh children if any (default `false`)
  29539. * @param clonePhysicsImpostor allows/denies the cloning in the same time of the original mesh `body` used by the physics engine, if any (default `true`)
  29540. * @returns a new mesh
  29541. */
  29542. clone(name?: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean, clonePhysicsImpostor?: boolean): Mesh;
  29543. /**
  29544. * Releases resources associated with this mesh.
  29545. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  29546. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  29547. */
  29548. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  29549. /** @hidden */
  29550. _disposeInstanceSpecificData(): void;
  29551. /** @hidden */
  29552. _disposeThinInstanceSpecificData(): void;
  29553. /**
  29554. * Modifies the mesh geometry according to a displacement map.
  29555. * 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.
  29556. * The mesh must be set as updatable. Its internal geometry is directly modified, no new buffer are allocated.
  29557. * @param url is a string, the URL from the image file is to be downloaded.
  29558. * @param minHeight is the lower limit of the displacement.
  29559. * @param maxHeight is the upper limit of the displacement.
  29560. * @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.
  29561. * @param uvOffset is an optional vector2 used to offset UV.
  29562. * @param uvScale is an optional vector2 used to scale UV.
  29563. * @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.
  29564. * @returns the Mesh.
  29565. */
  29566. applyDisplacementMap(url: string, minHeight: number, maxHeight: number, onSuccess?: (mesh: Mesh) => void, uvOffset?: Vector2, uvScale?: Vector2, forceUpdate?: boolean): Mesh;
  29567. /**
  29568. * Modifies the mesh geometry according to a displacementMap buffer.
  29569. * 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.
  29570. * The mesh must be set as updatable. Its internal geometry is directly modified, no new buffer are allocated.
  29571. * @param buffer is a `Uint8Array` buffer containing series of `Uint8` lower than 255, the red, green, blue and alpha values of each successive pixel.
  29572. * @param heightMapWidth is the width of the buffer image.
  29573. * @param heightMapHeight is the height of the buffer image.
  29574. * @param minHeight is the lower limit of the displacement.
  29575. * @param maxHeight is the upper limit of the displacement.
  29576. * @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.
  29577. * @param uvOffset is an optional vector2 used to offset UV.
  29578. * @param uvScale is an optional vector2 used to scale UV.
  29579. * @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.
  29580. * @returns the Mesh.
  29581. */
  29582. applyDisplacementMapFromBuffer(buffer: Uint8Array, heightMapWidth: number, heightMapHeight: number, minHeight: number, maxHeight: number, uvOffset?: Vector2, uvScale?: Vector2, forceUpdate?: boolean): Mesh;
  29583. /**
  29584. * Modify the mesh to get a flat shading rendering.
  29585. * This means each mesh facet will then have its own normals. Usually new vertices are added in the mesh geometry to get this result.
  29586. * Warning : the mesh is really modified even if not set originally as updatable and, under the hood, a new VertexBuffer is allocated.
  29587. * @returns current mesh
  29588. */
  29589. convertToFlatShadedMesh(): Mesh;
  29590. /**
  29591. * This method removes all the mesh indices and add new vertices (duplication) in order to unfold facets into buffers.
  29592. * In other words, more vertices, no more indices and a single bigger VBO.
  29593. * The mesh is really modified even if not set originally as updatable. Under the hood, a new VertexBuffer is allocated.
  29594. * @returns current mesh
  29595. */
  29596. convertToUnIndexedMesh(): Mesh;
  29597. /**
  29598. * Inverses facet orientations.
  29599. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  29600. * @param flipNormals will also inverts the normals
  29601. * @returns current mesh
  29602. */
  29603. flipFaces(flipNormals?: boolean): Mesh;
  29604. /**
  29605. * Increase the number of facets and hence vertices in a mesh
  29606. * Vertex normals are interpolated from existing vertex normals
  29607. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  29608. * @param numberPerEdge the number of new vertices to add to each edge of a facet, optional default 1
  29609. */
  29610. increaseVertices(numberPerEdge: number): void;
  29611. /**
  29612. * Force adjacent facets to share vertices and remove any facets that have all vertices in a line
  29613. * This will undo any application of covertToFlatShadedMesh
  29614. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  29615. */
  29616. forceSharedVertices(): void;
  29617. /** @hidden */
  29618. static _instancedMeshFactory(name: string, mesh: Mesh): InstancedMesh;
  29619. /** @hidden */
  29620. static _PhysicsImpostorParser(scene: Scene, physicObject: IPhysicsEnabledObject, jsonObject: any): PhysicsImpostor;
  29621. /**
  29622. * Creates a new InstancedMesh object from the mesh model.
  29623. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  29624. * @param name defines the name of the new instance
  29625. * @returns a new InstancedMesh
  29626. */
  29627. createInstance(name: string): InstancedMesh;
  29628. /**
  29629. * Synchronises all the mesh instance submeshes to the current mesh submeshes, if any.
  29630. * After this call, all the mesh instances have the same submeshes than the current mesh.
  29631. * @returns the current mesh
  29632. */
  29633. synchronizeInstances(): Mesh;
  29634. /**
  29635. * Optimization of the mesh's indices, in case a mesh has duplicated vertices.
  29636. * The function will only reorder the indices and will not remove unused vertices to avoid problems with submeshes.
  29637. * This should be used together with the simplification to avoid disappearing triangles.
  29638. * @param successCallback an optional success callback to be called after the optimization finished.
  29639. * @returns the current mesh
  29640. */
  29641. optimizeIndices(successCallback?: (mesh?: Mesh) => void): Mesh;
  29642. /**
  29643. * Serialize current mesh
  29644. * @param serializationObject defines the object which will receive the serialization data
  29645. */
  29646. serialize(serializationObject: any): void;
  29647. /** @hidden */
  29648. _syncGeometryWithMorphTargetManager(): void;
  29649. /** @hidden */
  29650. static _GroundMeshParser: (parsedMesh: any, scene: Scene) => Mesh;
  29651. /**
  29652. * Returns a new Mesh object parsed from the source provided.
  29653. * @param parsedMesh is the source
  29654. * @param scene defines the hosting scene
  29655. * @param rootUrl is the root URL to prefix the `delayLoadingFile` property with
  29656. * @returns a new Mesh
  29657. */
  29658. static Parse(parsedMesh: any, scene: Scene, rootUrl: string): Mesh;
  29659. /**
  29660. * Creates a ribbon mesh. Please consider using the same method from the MeshBuilder class instead
  29661. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  29662. * @param name defines the name of the mesh to create
  29663. * @param pathArray is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry.
  29664. * @param closeArray creates a seam between the first and the last paths of the path array (default is false)
  29665. * @param closePath creates a seam between the first and the last points of each path of the path array
  29666. * @param offset is taken in account only if the `pathArray` is containing a single path
  29667. * @param scene defines the hosting scene
  29668. * @param updatable defines if the mesh must be flagged as updatable
  29669. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  29670. * @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)
  29671. * @returns a new Mesh
  29672. */
  29673. static CreateRibbon(name: string, pathArray: Vector3[][], closeArray: boolean, closePath: boolean, offset: number, scene?: Scene, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  29674. /**
  29675. * Creates a plane polygonal mesh. By default, this is a disc. Please consider using the same method from the MeshBuilder class instead
  29676. * @param name defines the name of the mesh to create
  29677. * @param radius sets the radius size (float) of the polygon (default 0.5)
  29678. * @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
  29679. * @param scene defines the hosting scene
  29680. * @param updatable defines if the mesh must be flagged as updatable
  29681. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  29682. * @returns a new Mesh
  29683. */
  29684. static CreateDisc(name: string, radius: number, tessellation: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number): Mesh;
  29685. /**
  29686. * Creates a box mesh. Please consider using the same method from the MeshBuilder class instead
  29687. * @param name defines the name of the mesh to create
  29688. * @param size sets the size (float) of each box side (default 1)
  29689. * @param scene defines the hosting scene
  29690. * @param updatable defines if the mesh must be flagged as updatable
  29691. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  29692. * @returns a new Mesh
  29693. */
  29694. static CreateBox(name: string, size: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number): Mesh;
  29695. /**
  29696. * Creates a sphere mesh. Please consider using the same method from the MeshBuilder class instead
  29697. * @param name defines the name of the mesh to create
  29698. * @param segments sets the sphere number of horizontal stripes (positive integer, default 32)
  29699. * @param diameter sets the diameter size (float) of the sphere (default 1)
  29700. * @param scene defines the hosting scene
  29701. * @param updatable defines if the mesh must be flagged as updatable
  29702. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  29703. * @returns a new Mesh
  29704. */
  29705. static CreateSphere(name: string, segments: number, diameter: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  29706. /**
  29707. * Creates a hemisphere mesh. Please consider using the same method from the MeshBuilder class instead
  29708. * @param name defines the name of the mesh to create
  29709. * @param segments sets the sphere number of horizontal stripes (positive integer, default 32)
  29710. * @param diameter sets the diameter size (float) of the sphere (default 1)
  29711. * @param scene defines the hosting scene
  29712. * @returns a new Mesh
  29713. */
  29714. static CreateHemisphere(name: string, segments: number, diameter: number, scene?: Scene): Mesh;
  29715. /**
  29716. * Creates a cylinder or a cone mesh. Please consider using the same method from the MeshBuilder class instead
  29717. * @param name defines the name of the mesh to create
  29718. * @param height sets the height size (float) of the cylinder/cone (float, default 2)
  29719. * @param diameterTop set the top cap diameter (floats, default 1)
  29720. * @param diameterBottom set the bottom cap diameter (floats, default 1). This value can't be zero
  29721. * @param tessellation sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance
  29722. * @param subdivisions sets the number of rings along the cylinder height (positive integer, default 1)
  29723. * @param scene defines the hosting scene
  29724. * @param updatable defines if the mesh must be flagged as updatable
  29725. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  29726. * @returns a new Mesh
  29727. */
  29728. static CreateCylinder(name: string, height: number, diameterTop: number, diameterBottom: number, tessellation: number, subdivisions: any, scene?: Scene, updatable?: any, sideOrientation?: number): Mesh;
  29729. /**
  29730. * Creates a torus mesh. Please consider using the same method from the MeshBuilder class instead
  29731. * @param name defines the name of the mesh to create
  29732. * @param diameter sets the diameter size (float) of the torus (default 1)
  29733. * @param thickness sets the diameter size of the tube of the torus (float, default 0.5)
  29734. * @param tessellation sets the number of torus sides (postive integer, default 16)
  29735. * @param scene defines the hosting scene
  29736. * @param updatable defines if the mesh must be flagged as updatable
  29737. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  29738. * @returns a new Mesh
  29739. */
  29740. static CreateTorus(name: string, diameter: number, thickness: number, tessellation: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  29741. /**
  29742. * Creates a torus knot mesh. Please consider using the same method from the MeshBuilder class instead
  29743. * @param name defines the name of the mesh to create
  29744. * @param radius sets the global radius size (float) of the torus knot (default 2)
  29745. * @param tube sets the diameter size of the tube of the torus (float, default 0.5)
  29746. * @param radialSegments sets the number of sides on each tube segments (positive integer, default 32)
  29747. * @param tubularSegments sets the number of tubes to decompose the knot into (positive integer, default 32)
  29748. * @param p the number of windings on X axis (positive integers, default 2)
  29749. * @param q the number of windings on Y axis (positive integers, default 3)
  29750. * @param scene defines the hosting scene
  29751. * @param updatable defines if the mesh must be flagged as updatable
  29752. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  29753. * @returns a new Mesh
  29754. */
  29755. static CreateTorusKnot(name: string, radius: number, tube: number, radialSegments: number, tubularSegments: number, p: number, q: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  29756. /**
  29757. * Creates a line mesh. Please consider using the same method from the MeshBuilder class instead.
  29758. * @param name defines the name of the mesh to create
  29759. * @param points is an array successive Vector3
  29760. * @param scene defines the hosting scene
  29761. * @param updatable defines if the mesh must be flagged as updatable
  29762. * @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).
  29763. * @returns a new Mesh
  29764. */
  29765. static CreateLines(name: string, points: Vector3[], scene?: Nullable<Scene>, updatable?: boolean, instance?: Nullable<LinesMesh>): LinesMesh;
  29766. /**
  29767. * Creates a dashed line mesh. Please consider using the same method from the MeshBuilder class instead
  29768. * @param name defines the name of the mesh to create
  29769. * @param points is an array successive Vector3
  29770. * @param dashSize is the size of the dashes relatively the dash number (positive float, default 3)
  29771. * @param gapSize is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  29772. * @param dashNb is the intended total number of dashes (positive integer, default 200)
  29773. * @param scene defines the hosting scene
  29774. * @param updatable defines if the mesh must be flagged as updatable
  29775. * @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)
  29776. * @returns a new Mesh
  29777. */
  29778. static CreateDashedLines(name: string, points: Vector3[], dashSize: number, gapSize: number, dashNb: number, scene?: Nullable<Scene>, updatable?: boolean, instance?: LinesMesh): LinesMesh;
  29779. /**
  29780. * Creates a polygon mesh.Please consider using the same method from the MeshBuilder class instead
  29781. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh.
  29782. * 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.
  29783. * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  29784. * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  29785. * Remember you can only change the shape positions, not their number when updating a polygon.
  29786. * @see https://doc.babylonjs.com/how_to/parametric_shapes#non-regular-polygon
  29787. * @param name defines the name of the mesh to create
  29788. * @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
  29789. * @param scene defines the hosting scene
  29790. * @param holes is a required array of arrays of successive Vector3 used to defines holes in the polygon
  29791. * @param updatable defines if the mesh must be flagged as updatable
  29792. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  29793. * @param earcutInjection can be used to inject your own earcut reference
  29794. * @returns a new Mesh
  29795. */
  29796. static CreatePolygon(name: string, shape: Vector3[], scene: Scene, holes?: Vector3[][], updatable?: boolean, sideOrientation?: number, earcutInjection?: any): Mesh;
  29797. /**
  29798. * Creates an extruded polygon mesh, with depth in the Y direction. Please consider using the same method from the MeshBuilder class instead.
  29799. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-non-regular-polygon
  29800. * @param name defines the name of the mesh to create
  29801. * @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
  29802. * @param depth defines the height of extrusion
  29803. * @param scene defines the hosting scene
  29804. * @param holes is a required array of arrays of successive Vector3 used to defines holes in the polygon
  29805. * @param updatable defines if the mesh must be flagged as updatable
  29806. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  29807. * @param earcutInjection can be used to inject your own earcut reference
  29808. * @returns a new Mesh
  29809. */
  29810. static ExtrudePolygon(name: string, shape: Vector3[], depth: number, scene: Scene, holes?: Vector3[][], updatable?: boolean, sideOrientation?: number, earcutInjection?: any): Mesh;
  29811. /**
  29812. * Creates an extruded shape mesh.
  29813. * 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
  29814. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  29815. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  29816. * @param name defines the name of the mesh to create
  29817. * @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
  29818. * @param path is a required array of successive Vector3. This is the axis curve the shape is extruded along
  29819. * @param scale is the value to scale the shape
  29820. * @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
  29821. * @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
  29822. * @param scene defines the hosting scene
  29823. * @param updatable defines if the mesh must be flagged as updatable
  29824. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  29825. * @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)
  29826. * @returns a new Mesh
  29827. */
  29828. static ExtrudeShape(name: string, shape: Vector3[], path: Vector3[], scale: number, rotation: number, cap: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  29829. /**
  29830. * Creates an custom extruded shape mesh.
  29831. * The custom extrusion is a parametric shape.
  29832. * It has no predefined shape. Its final shape will depend on the input parameters.
  29833. * Please consider using the same method from the MeshBuilder class instead
  29834. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  29835. * @param name defines the name of the mesh to create
  29836. * @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
  29837. * @param path is a required array of successive Vector3. This is the axis curve the shape is extruded along
  29838. * @param scaleFunction is a custom Javascript function called on each path point
  29839. * @param rotationFunction is a custom Javascript function called on each path point
  29840. * @param ribbonCloseArray forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  29841. * @param ribbonClosePath forces the extrusion underlying ribbon to close its `pathArray`
  29842. * @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
  29843. * @param scene defines the hosting scene
  29844. * @param updatable defines if the mesh must be flagged as updatable
  29845. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  29846. * @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)
  29847. * @returns a new Mesh
  29848. */
  29849. 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;
  29850. /**
  29851. * Creates lathe mesh.
  29852. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe.
  29853. * Please consider using the same method from the MeshBuilder class instead
  29854. * @param name defines the name of the mesh to create
  29855. * @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
  29856. * @param radius is the radius value of the lathe
  29857. * @param tessellation is the side number of the lathe.
  29858. * @param scene defines the hosting scene
  29859. * @param updatable defines if the mesh must be flagged as updatable
  29860. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  29861. * @returns a new Mesh
  29862. */
  29863. static CreateLathe(name: string, shape: Vector3[], radius: number, tessellation: number, scene: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  29864. /**
  29865. * Creates a plane mesh. Please consider using the same method from the MeshBuilder class instead
  29866. * @param name defines the name of the mesh to create
  29867. * @param size sets the size (float) of both sides of the plane at once (default 1)
  29868. * @param scene defines the hosting scene
  29869. * @param updatable defines if the mesh must be flagged as updatable
  29870. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  29871. * @returns a new Mesh
  29872. */
  29873. static CreatePlane(name: string, size: number, scene: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  29874. /**
  29875. * Creates a ground mesh.
  29876. * Please consider using the same method from the MeshBuilder class instead
  29877. * @param name defines the name of the mesh to create
  29878. * @param width set the width of the ground
  29879. * @param height set the height of the ground
  29880. * @param subdivisions sets the number of subdivisions per side
  29881. * @param scene defines the hosting scene
  29882. * @param updatable defines if the mesh must be flagged as updatable
  29883. * @returns a new Mesh
  29884. */
  29885. static CreateGround(name: string, width: number, height: number, subdivisions: number, scene?: Scene, updatable?: boolean): Mesh;
  29886. /**
  29887. * Creates a tiled ground mesh.
  29888. * Please consider using the same method from the MeshBuilder class instead
  29889. * @param name defines the name of the mesh to create
  29890. * @param xmin set the ground minimum X coordinate
  29891. * @param zmin set the ground minimum Y coordinate
  29892. * @param xmax set the ground maximum X coordinate
  29893. * @param zmax set the ground maximum Z coordinate
  29894. * @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
  29895. * @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
  29896. * @param scene defines the hosting scene
  29897. * @param updatable defines if the mesh must be flagged as updatable
  29898. * @returns a new Mesh
  29899. */
  29900. static CreateTiledGround(name: string, xmin: number, zmin: number, xmax: number, zmax: number, subdivisions: {
  29901. w: number;
  29902. h: number;
  29903. }, precision: {
  29904. w: number;
  29905. h: number;
  29906. }, scene: Scene, updatable?: boolean): Mesh;
  29907. /**
  29908. * Creates a ground mesh from a height map.
  29909. * Please consider using the same method from the MeshBuilder class instead
  29910. * @see https://doc.babylonjs.com/babylon101/height_map
  29911. * @param name defines the name of the mesh to create
  29912. * @param url sets the URL of the height map image resource
  29913. * @param width set the ground width size
  29914. * @param height set the ground height size
  29915. * @param subdivisions sets the number of subdivision per side
  29916. * @param minHeight is the minimum altitude on the ground
  29917. * @param maxHeight is the maximum altitude on the ground
  29918. * @param scene defines the hosting scene
  29919. * @param updatable defines if the mesh must be flagged as updatable
  29920. * @param onReady is a callback function that will be called once the mesh is built (the height map download can last some time)
  29921. * @param alphaFilter will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  29922. * @returns a new Mesh
  29923. */
  29924. 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;
  29925. /**
  29926. * Creates a tube mesh.
  29927. * The tube is a parametric shape.
  29928. * It has no predefined shape. Its final shape will depend on the input parameters.
  29929. * Please consider using the same method from the MeshBuilder class instead
  29930. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  29931. * @param name defines the name of the mesh to create
  29932. * @param path is a required array of successive Vector3. It is the curve used as the axis of the tube
  29933. * @param radius sets the tube radius size
  29934. * @param tessellation is the number of sides on the tubular surface
  29935. * @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
  29936. * @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
  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. * @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)
  29941. * @returns a new Mesh
  29942. */
  29943. static CreateTube(name: string, path: Vector3[], radius: number, tessellation: number, radiusFunction: {
  29944. (i: number, distance: number): number;
  29945. }, cap: number, scene: Scene, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  29946. /**
  29947. * Creates a polyhedron mesh.
  29948. * Please consider using the same method from the MeshBuilder class instead.
  29949. * * 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
  29950. * * The parameter `size` (positive float, default 1) sets the polygon size
  29951. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  29952. * * 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`
  29953. * * 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
  29954. * * 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)`)
  29955. * * 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
  29956. * * 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
  29957. * * You can also set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  29958. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  29959. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  29960. * @param name defines the name of the mesh to create
  29961. * @param options defines the options used to create the mesh
  29962. * @param scene defines the hosting scene
  29963. * @returns a new Mesh
  29964. */
  29965. static CreatePolyhedron(name: string, options: {
  29966. type?: number;
  29967. size?: number;
  29968. sizeX?: number;
  29969. sizeY?: number;
  29970. sizeZ?: number;
  29971. custom?: any;
  29972. faceUV?: Vector4[];
  29973. faceColors?: Color4[];
  29974. updatable?: boolean;
  29975. sideOrientation?: number;
  29976. }, scene: Scene): Mesh;
  29977. /**
  29978. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  29979. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  29980. * * 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`)
  29981. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  29982. * * 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
  29983. * * You can also set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  29984. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  29985. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  29986. * @param name defines the name of the mesh
  29987. * @param options defines the options used to create the mesh
  29988. * @param scene defines the hosting scene
  29989. * @returns a new Mesh
  29990. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  29991. */
  29992. static CreateIcoSphere(name: string, options: {
  29993. radius?: number;
  29994. flat?: boolean;
  29995. subdivisions?: number;
  29996. sideOrientation?: number;
  29997. updatable?: boolean;
  29998. }, scene: Scene): Mesh;
  29999. /**
  30000. * Creates a decal mesh.
  30001. * Please consider using the same method from the MeshBuilder class instead.
  30002. * A decal is a mesh usually applied as a model onto the surface of another mesh
  30003. * @param name defines the name of the mesh
  30004. * @param sourceMesh defines the mesh receiving the decal
  30005. * @param position sets the position of the decal in world coordinates
  30006. * @param normal sets the normal of the mesh where the decal is applied onto in world coordinates
  30007. * @param size sets the decal scaling
  30008. * @param angle sets the angle to rotate the decal
  30009. * @returns a new Mesh
  30010. */
  30011. static CreateDecal(name: string, sourceMesh: AbstractMesh, position: Vector3, normal: Vector3, size: Vector3, angle: number): Mesh;
  30012. /**
  30013. * Prepare internal position array for software CPU skinning
  30014. * @returns original positions used for CPU skinning. Useful for integrating Morphing with skeletons in same mesh
  30015. */
  30016. setPositionsForCPUSkinning(): Float32Array;
  30017. /**
  30018. * Prepare internal normal array for software CPU skinning
  30019. * @returns original normals used for CPU skinning. Useful for integrating Morphing with skeletons in same mesh.
  30020. */
  30021. setNormalsForCPUSkinning(): Float32Array;
  30022. /**
  30023. * Updates the vertex buffer by applying transformation from the bones
  30024. * @param skeleton defines the skeleton to apply to current mesh
  30025. * @returns the current mesh
  30026. */
  30027. applySkeleton(skeleton: Skeleton): Mesh;
  30028. /**
  30029. * 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
  30030. * @param meshes defines the list of meshes to scan
  30031. * @returns an object `{min:` Vector3`, max:` Vector3`}`
  30032. */
  30033. static MinMax(meshes: AbstractMesh[]): {
  30034. min: Vector3;
  30035. max: Vector3;
  30036. };
  30037. /**
  30038. * Returns the center of the `{min:` Vector3`, max:` Vector3`}` or the center of MinMax vector3 computed from a mesh array
  30039. * @param meshesOrMinMaxVector could be an array of meshes or a `{min:` Vector3`, max:` Vector3`}` object
  30040. * @returns a vector3
  30041. */
  30042. static Center(meshesOrMinMaxVector: {
  30043. min: Vector3;
  30044. max: Vector3;
  30045. } | AbstractMesh[]): Vector3;
  30046. /**
  30047. * Merge the array of meshes into a single mesh for performance reasons.
  30048. * @param meshes defines he vertices source. They should all be of the same material. Entries can empty
  30049. * @param disposeSource when true (default), dispose of the vertices from the source meshes
  30050. * @param allow32BitsIndices when the sum of the vertices > 64k, this must be set to true
  30051. * @param meshSubclass when set, vertices inserted into this Mesh. Meshes can then be merged into a Mesh sub-class.
  30052. * @param subdivideWithSubMeshes when true (false default), subdivide mesh to his subMesh array with meshes source.
  30053. * @param multiMultiMaterials when true (false default), subdivide mesh and accept multiple multi materials, ignores subdivideWithSubMeshes.
  30054. * @returns a new mesh
  30055. */
  30056. static MergeMeshes(meshes: Array<Mesh>, disposeSource?: boolean, allow32BitsIndices?: boolean, meshSubclass?: Mesh, subdivideWithSubMeshes?: boolean, multiMultiMaterials?: boolean): Nullable<Mesh>;
  30057. /** @hidden */
  30058. addInstance(instance: InstancedMesh): void;
  30059. /** @hidden */
  30060. removeInstance(instance: InstancedMesh): void;
  30061. }
  30062. }
  30063. declare module "babylonjs/Cameras/camera" {
  30064. import { SmartArray } from "babylonjs/Misc/smartArray";
  30065. import { Observable } from "babylonjs/Misc/observable";
  30066. import { Nullable } from "babylonjs/types";
  30067. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  30068. import { Scene } from "babylonjs/scene";
  30069. import { Matrix, Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  30070. import { Node } from "babylonjs/node";
  30071. import { Mesh } from "babylonjs/Meshes/mesh";
  30072. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  30073. import { ICullable } from "babylonjs/Culling/boundingInfo";
  30074. import { Viewport } from "babylonjs/Maths/math.viewport";
  30075. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  30076. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  30077. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  30078. import { Ray } from "babylonjs/Culling/ray";
  30079. /**
  30080. * This is the base class of all the camera used in the application.
  30081. * @see https://doc.babylonjs.com/features/cameras
  30082. */
  30083. export class Camera extends Node {
  30084. /** @hidden */
  30085. static _createDefaultParsedCamera: (name: string, scene: Scene) => Camera;
  30086. /**
  30087. * This is the default projection mode used by the cameras.
  30088. * It helps recreating a feeling of perspective and better appreciate depth.
  30089. * This is the best way to simulate real life cameras.
  30090. */
  30091. static readonly PERSPECTIVE_CAMERA: number;
  30092. /**
  30093. * This helps creating camera with an orthographic mode.
  30094. * 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.
  30095. */
  30096. static readonly ORTHOGRAPHIC_CAMERA: number;
  30097. /**
  30098. * This is the default FOV mode for perspective cameras.
  30099. * This setting aligns the upper and lower bounds of the viewport to the upper and lower bounds of the camera frustum.
  30100. */
  30101. static readonly FOVMODE_VERTICAL_FIXED: number;
  30102. /**
  30103. * This setting aligns the left and right bounds of the viewport to the left and right bounds of the camera frustum.
  30104. */
  30105. static readonly FOVMODE_HORIZONTAL_FIXED: number;
  30106. /**
  30107. * This specifies ther is no need for a camera rig.
  30108. * Basically only one eye is rendered corresponding to the camera.
  30109. */
  30110. static readonly RIG_MODE_NONE: number;
  30111. /**
  30112. * Simulates a camera Rig with one blue eye and one red eye.
  30113. * This can be use with 3d blue and red glasses.
  30114. */
  30115. static readonly RIG_MODE_STEREOSCOPIC_ANAGLYPH: number;
  30116. /**
  30117. * Defines that both eyes of the camera will be rendered side by side with a parallel target.
  30118. */
  30119. static readonly RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_PARALLEL: number;
  30120. /**
  30121. * Defines that both eyes of the camera will be rendered side by side with a none parallel target.
  30122. */
  30123. static readonly RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_CROSSEYED: number;
  30124. /**
  30125. * Defines that both eyes of the camera will be rendered over under each other.
  30126. */
  30127. static readonly RIG_MODE_STEREOSCOPIC_OVERUNDER: number;
  30128. /**
  30129. * Defines that both eyes of the camera will be rendered on successive lines interlaced for passive 3d monitors.
  30130. */
  30131. static readonly RIG_MODE_STEREOSCOPIC_INTERLACED: number;
  30132. /**
  30133. * Defines that both eyes of the camera should be renderered in a VR mode (carbox).
  30134. */
  30135. static readonly RIG_MODE_VR: number;
  30136. /**
  30137. * Defines that both eyes of the camera should be renderered in a VR mode (webVR).
  30138. */
  30139. static readonly RIG_MODE_WEBVR: number;
  30140. /**
  30141. * Custom rig mode allowing rig cameras to be populated manually with any number of cameras
  30142. */
  30143. static readonly RIG_MODE_CUSTOM: number;
  30144. /**
  30145. * Defines if by default attaching controls should prevent the default javascript event to continue.
  30146. */
  30147. static ForceAttachControlToAlwaysPreventDefault: boolean;
  30148. /**
  30149. * Define the input manager associated with the camera.
  30150. */
  30151. inputs: CameraInputsManager<Camera>;
  30152. /** @hidden */
  30153. _position: Vector3;
  30154. /**
  30155. * Define the current local position of the camera in the scene
  30156. */
  30157. get position(): Vector3;
  30158. set position(newPosition: Vector3);
  30159. /**
  30160. * The vector the camera should consider as up.
  30161. * (default is Vector3(0, 1, 0) aka Vector3.Up())
  30162. */
  30163. upVector: Vector3;
  30164. /**
  30165. * Define the current limit on the left side for an orthographic camera
  30166. * In scene unit
  30167. */
  30168. orthoLeft: Nullable<number>;
  30169. /**
  30170. * Define the current limit on the right side for an orthographic camera
  30171. * In scene unit
  30172. */
  30173. orthoRight: Nullable<number>;
  30174. /**
  30175. * Define the current limit on the bottom side for an orthographic camera
  30176. * In scene unit
  30177. */
  30178. orthoBottom: Nullable<number>;
  30179. /**
  30180. * Define the current limit on the top side for an orthographic camera
  30181. * In scene unit
  30182. */
  30183. orthoTop: Nullable<number>;
  30184. /**
  30185. * Field Of View is set in Radians. (default is 0.8)
  30186. */
  30187. fov: number;
  30188. /**
  30189. * Define the minimum distance the camera can see from.
  30190. * This is important to note that the depth buffer are not infinite and the closer it starts
  30191. * the more your scene might encounter depth fighting issue.
  30192. */
  30193. minZ: number;
  30194. /**
  30195. * Define the maximum distance the camera can see to.
  30196. * This is important to note that the depth buffer are not infinite and the further it end
  30197. * the more your scene might encounter depth fighting issue.
  30198. */
  30199. maxZ: number;
  30200. /**
  30201. * Define the default inertia of the camera.
  30202. * This helps giving a smooth feeling to the camera movement.
  30203. */
  30204. inertia: number;
  30205. /**
  30206. * Define the mode of the camera (Camera.PERSPECTIVE_CAMERA or Camera.ORTHOGRAPHIC_CAMERA)
  30207. */
  30208. mode: number;
  30209. /**
  30210. * Define whether the camera is intermediate.
  30211. * This is useful to not present the output directly to the screen in case of rig without post process for instance
  30212. */
  30213. isIntermediate: boolean;
  30214. /**
  30215. * Define the viewport of the camera.
  30216. * This correspond to the portion of the screen the camera will render to in normalized 0 to 1 unit.
  30217. */
  30218. viewport: Viewport;
  30219. /**
  30220. * Restricts the camera to viewing objects with the same layerMask.
  30221. * A camera with a layerMask of 1 will render mesh.layerMask & camera.layerMask!== 0
  30222. */
  30223. layerMask: number;
  30224. /**
  30225. * fovMode sets the camera frustum bounds to the viewport bounds. (default is FOVMODE_VERTICAL_FIXED)
  30226. */
  30227. fovMode: number;
  30228. /**
  30229. * Rig mode of the camera.
  30230. * This is useful to create the camera with two "eyes" instead of one to create VR or stereoscopic scenes.
  30231. * This is normally controlled byt the camera themselves as internal use.
  30232. */
  30233. cameraRigMode: number;
  30234. /**
  30235. * Defines the distance between both "eyes" in case of a RIG
  30236. */
  30237. interaxialDistance: number;
  30238. /**
  30239. * Defines if stereoscopic rendering is done side by side or over under.
  30240. */
  30241. isStereoscopicSideBySide: boolean;
  30242. /**
  30243. * 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
  30244. * This is pretty helpfull if you wish to make a camera render to a texture you could reuse somewhere
  30245. * else in the scene. (Eg. security camera)
  30246. *
  30247. * 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)
  30248. */
  30249. customRenderTargets: import("babylonjs/Materials/Textures/renderTargetTexture").RenderTargetTexture[];
  30250. /**
  30251. * When set, the camera will render to this render target instead of the default canvas
  30252. *
  30253. * If the desire is to use the output of a camera as a texture in the scene consider using camera.customRenderTargets instead
  30254. */
  30255. outputRenderTarget: Nullable<RenderTargetTexture>;
  30256. /**
  30257. * Observable triggered when the camera view matrix has changed.
  30258. */
  30259. onViewMatrixChangedObservable: Observable<Camera>;
  30260. /**
  30261. * Observable triggered when the camera Projection matrix has changed.
  30262. */
  30263. onProjectionMatrixChangedObservable: Observable<Camera>;
  30264. /**
  30265. * Observable triggered when the inputs have been processed.
  30266. */
  30267. onAfterCheckInputsObservable: Observable<Camera>;
  30268. /**
  30269. * Observable triggered when reset has been called and applied to the camera.
  30270. */
  30271. onRestoreStateObservable: Observable<Camera>;
  30272. /**
  30273. * Is this camera a part of a rig system?
  30274. */
  30275. isRigCamera: boolean;
  30276. /**
  30277. * If isRigCamera set to true this will be set with the parent camera.
  30278. * The parent camera is not (!) necessarily the .parent of this camera (like in the case of XR)
  30279. */
  30280. rigParent?: Camera;
  30281. /** @hidden */
  30282. _cameraRigParams: any;
  30283. /** @hidden */
  30284. _rigCameras: Camera[];
  30285. /** @hidden */
  30286. _rigPostProcess: Nullable<PostProcess>;
  30287. protected _webvrViewMatrix: Matrix;
  30288. /** @hidden */
  30289. _skipRendering: boolean;
  30290. /** @hidden */
  30291. _projectionMatrix: Matrix;
  30292. /** @hidden */
  30293. _postProcesses: Nullable<import("babylonjs/PostProcesses/postProcess").PostProcess>[];
  30294. /** @hidden */
  30295. _activeMeshes: SmartArray<AbstractMesh>;
  30296. protected _globalPosition: Vector3;
  30297. /** @hidden */
  30298. _computedViewMatrix: Matrix;
  30299. private _doNotComputeProjectionMatrix;
  30300. private _transformMatrix;
  30301. private _frustumPlanes;
  30302. private _refreshFrustumPlanes;
  30303. private _storedFov;
  30304. private _stateStored;
  30305. /**
  30306. * Instantiates a new camera object.
  30307. * This should not be used directly but through the inherited cameras: ArcRotate, Free...
  30308. * @see https://doc.babylonjs.com/features/cameras
  30309. * @param name Defines the name of the camera in the scene
  30310. * @param position Defines the position of the camera
  30311. * @param scene Defines the scene the camera belongs too
  30312. * @param setActiveOnSceneIfNoneActive Defines if the camera should be set as active after creation if no other camera have been defined in the scene
  30313. */
  30314. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  30315. /**
  30316. * Store current camera state (fov, position, etc..)
  30317. * @returns the camera
  30318. */
  30319. storeState(): Camera;
  30320. /**
  30321. * Restores the camera state values if it has been stored. You must call storeState() first
  30322. */
  30323. protected _restoreStateValues(): boolean;
  30324. /**
  30325. * Restored camera state. You must call storeState() first.
  30326. * @returns true if restored and false otherwise
  30327. */
  30328. restoreState(): boolean;
  30329. /**
  30330. * Gets the class name of the camera.
  30331. * @returns the class name
  30332. */
  30333. getClassName(): string;
  30334. /** @hidden */
  30335. readonly _isCamera: boolean;
  30336. /**
  30337. * Gets a string representation of the camera useful for debug purpose.
  30338. * @param fullDetails Defines that a more verboe level of logging is required
  30339. * @returns the string representation
  30340. */
  30341. toString(fullDetails?: boolean): string;
  30342. /**
  30343. * Gets the current world space position of the camera.
  30344. */
  30345. get globalPosition(): Vector3;
  30346. /**
  30347. * Gets the list of active meshes this frame (meshes no culled or excluded by lod s in the frame)
  30348. * @returns the active meshe list
  30349. */
  30350. getActiveMeshes(): SmartArray<AbstractMesh>;
  30351. /**
  30352. * Check whether a mesh is part of the current active mesh list of the camera
  30353. * @param mesh Defines the mesh to check
  30354. * @returns true if active, false otherwise
  30355. */
  30356. isActiveMesh(mesh: Mesh): boolean;
  30357. /**
  30358. * Is this camera ready to be used/rendered
  30359. * @param completeCheck defines if a complete check (including post processes) has to be done (false by default)
  30360. * @return true if the camera is ready
  30361. */
  30362. isReady(completeCheck?: boolean): boolean;
  30363. /** @hidden */
  30364. _initCache(): void;
  30365. /** @hidden */
  30366. _updateCache(ignoreParentClass?: boolean): void;
  30367. /** @hidden */
  30368. _isSynchronized(): boolean;
  30369. /** @hidden */
  30370. _isSynchronizedViewMatrix(): boolean;
  30371. /** @hidden */
  30372. _isSynchronizedProjectionMatrix(): boolean;
  30373. /**
  30374. * Attach the input controls to a specific dom element to get the input from.
  30375. * @param element Defines the element the controls should be listened from
  30376. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  30377. */
  30378. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  30379. /**
  30380. * Detach the current controls from the specified dom element.
  30381. * @param element Defines the element to stop listening the inputs from
  30382. */
  30383. detachControl(element: HTMLElement): void;
  30384. /**
  30385. * Update the camera state according to the different inputs gathered during the frame.
  30386. */
  30387. update(): void;
  30388. /** @hidden */
  30389. _checkInputs(): void;
  30390. /** @hidden */
  30391. get rigCameras(): Camera[];
  30392. /**
  30393. * Gets the post process used by the rig cameras
  30394. */
  30395. get rigPostProcess(): Nullable<PostProcess>;
  30396. /**
  30397. * Internal, gets the first post proces.
  30398. * @returns the first post process to be run on this camera.
  30399. */
  30400. _getFirstPostProcess(): Nullable<PostProcess>;
  30401. private _cascadePostProcessesToRigCams;
  30402. /**
  30403. * Attach a post process to the camera.
  30404. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#attach-postprocess
  30405. * @param postProcess The post process to attach to the camera
  30406. * @param insertAt The position of the post process in case several of them are in use in the scene
  30407. * @returns the position the post process has been inserted at
  30408. */
  30409. attachPostProcess(postProcess: PostProcess, insertAt?: Nullable<number>): number;
  30410. /**
  30411. * Detach a post process to the camera.
  30412. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#attach-postprocess
  30413. * @param postProcess The post process to detach from the camera
  30414. */
  30415. detachPostProcess(postProcess: PostProcess): void;
  30416. /**
  30417. * Gets the current world matrix of the camera
  30418. */
  30419. getWorldMatrix(): Matrix;
  30420. /** @hidden */
  30421. _getViewMatrix(): Matrix;
  30422. /**
  30423. * Gets the current view matrix of the camera.
  30424. * @param force forces the camera to recompute the matrix without looking at the cached state
  30425. * @returns the view matrix
  30426. */
  30427. getViewMatrix(force?: boolean): Matrix;
  30428. /**
  30429. * Freeze the projection matrix.
  30430. * It will prevent the cache check of the camera projection compute and can speed up perf
  30431. * if no parameter of the camera are meant to change
  30432. * @param projection Defines manually a projection if necessary
  30433. */
  30434. freezeProjectionMatrix(projection?: Matrix): void;
  30435. /**
  30436. * Unfreeze the projection matrix if it has previously been freezed by freezeProjectionMatrix.
  30437. */
  30438. unfreezeProjectionMatrix(): void;
  30439. /**
  30440. * Gets the current projection matrix of the camera.
  30441. * @param force forces the camera to recompute the matrix without looking at the cached state
  30442. * @returns the projection matrix
  30443. */
  30444. getProjectionMatrix(force?: boolean): Matrix;
  30445. /**
  30446. * Gets the transformation matrix (ie. the multiplication of view by projection matrices)
  30447. * @returns a Matrix
  30448. */
  30449. getTransformationMatrix(): Matrix;
  30450. private _updateFrustumPlanes;
  30451. /**
  30452. * Checks if a cullable object (mesh...) is in the camera frustum
  30453. * This checks the bounding box center. See isCompletelyInFrustum for a full bounding check
  30454. * @param target The object to check
  30455. * @param checkRigCameras If the rig cameras should be checked (eg. with webVR camera both eyes should be checked) (Default: false)
  30456. * @returns true if the object is in frustum otherwise false
  30457. */
  30458. isInFrustum(target: ICullable, checkRigCameras?: boolean): boolean;
  30459. /**
  30460. * Checks if a cullable object (mesh...) is in the camera frustum
  30461. * Unlike isInFrustum this cheks the full bounding box
  30462. * @param target The object to check
  30463. * @returns true if the object is in frustum otherwise false
  30464. */
  30465. isCompletelyInFrustum(target: ICullable): boolean;
  30466. /**
  30467. * Gets a ray in the forward direction from the camera.
  30468. * @param length Defines the length of the ray to create
  30469. * @param transform Defines the transform to apply to the ray, by default the world matrx is used to create a workd space ray
  30470. * @param origin Defines the start point of the ray which defaults to the camera position
  30471. * @returns the forward ray
  30472. */
  30473. getForwardRay(length?: number, transform?: Matrix, origin?: Vector3): Ray;
  30474. /**
  30475. * Releases resources associated with this node.
  30476. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  30477. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  30478. */
  30479. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  30480. /** @hidden */
  30481. _isLeftCamera: boolean;
  30482. /**
  30483. * Gets the left camera of a rig setup in case of Rigged Camera
  30484. */
  30485. get isLeftCamera(): boolean;
  30486. /** @hidden */
  30487. _isRightCamera: boolean;
  30488. /**
  30489. * Gets the right camera of a rig setup in case of Rigged Camera
  30490. */
  30491. get isRightCamera(): boolean;
  30492. /**
  30493. * Gets the left camera of a rig setup in case of Rigged Camera
  30494. */
  30495. get leftCamera(): Nullable<FreeCamera>;
  30496. /**
  30497. * Gets the right camera of a rig setup in case of Rigged Camera
  30498. */
  30499. get rightCamera(): Nullable<FreeCamera>;
  30500. /**
  30501. * Gets the left camera target of a rig setup in case of Rigged Camera
  30502. * @returns the target position
  30503. */
  30504. getLeftTarget(): Nullable<Vector3>;
  30505. /**
  30506. * Gets the right camera target of a rig setup in case of Rigged Camera
  30507. * @returns the target position
  30508. */
  30509. getRightTarget(): Nullable<Vector3>;
  30510. /**
  30511. * @hidden
  30512. */
  30513. setCameraRigMode(mode: number, rigParams: any): void;
  30514. /** @hidden */
  30515. static _setStereoscopicRigMode(camera: Camera): void;
  30516. /** @hidden */
  30517. static _setStereoscopicAnaglyphRigMode(camera: Camera): void;
  30518. /** @hidden */
  30519. static _setVRRigMode(camera: Camera, rigParams: any): void;
  30520. /** @hidden */
  30521. static _setWebVRRigMode(camera: Camera, rigParams: any): void;
  30522. /** @hidden */
  30523. _getVRProjectionMatrix(): Matrix;
  30524. protected _updateCameraRotationMatrix(): void;
  30525. protected _updateWebVRCameraRotationMatrix(): void;
  30526. /**
  30527. * This function MUST be overwritten by the different WebVR cameras available.
  30528. * The context in which it is running is the RIG camera. So 'this' is the TargetCamera, left or right.
  30529. * @hidden
  30530. */
  30531. _getWebVRProjectionMatrix(): Matrix;
  30532. /**
  30533. * This function MUST be overwritten by the different WebVR cameras available.
  30534. * The context in which it is running is the RIG camera. So 'this' is the TargetCamera, left or right.
  30535. * @hidden
  30536. */
  30537. _getWebVRViewMatrix(): Matrix;
  30538. /** @hidden */
  30539. setCameraRigParameter(name: string, value: any): void;
  30540. /**
  30541. * needs to be overridden by children so sub has required properties to be copied
  30542. * @hidden
  30543. */
  30544. createRigCamera(name: string, cameraIndex: number): Nullable<Camera>;
  30545. /**
  30546. * May need to be overridden by children
  30547. * @hidden
  30548. */
  30549. _updateRigCameras(): void;
  30550. /** @hidden */
  30551. _setupInputs(): void;
  30552. /**
  30553. * Serialiaze the camera setup to a json represention
  30554. * @returns the JSON representation
  30555. */
  30556. serialize(): any;
  30557. /**
  30558. * Clones the current camera.
  30559. * @param name The cloned camera name
  30560. * @returns the cloned camera
  30561. */
  30562. clone(name: string): Camera;
  30563. /**
  30564. * Gets the direction of the camera relative to a given local axis.
  30565. * @param localAxis Defines the reference axis to provide a relative direction.
  30566. * @return the direction
  30567. */
  30568. getDirection(localAxis: Vector3): Vector3;
  30569. /**
  30570. * Returns the current camera absolute rotation
  30571. */
  30572. get absoluteRotation(): Quaternion;
  30573. /**
  30574. * Gets the direction of the camera relative to a given local axis into a passed vector.
  30575. * @param localAxis Defines the reference axis to provide a relative direction.
  30576. * @param result Defines the vector to store the result in
  30577. */
  30578. getDirectionToRef(localAxis: Vector3, result: Vector3): void;
  30579. /**
  30580. * Gets a camera constructor for a given camera type
  30581. * @param type The type of the camera to construct (should be equal to one of the camera class name)
  30582. * @param name The name of the camera the result will be able to instantiate
  30583. * @param scene The scene the result will construct the camera in
  30584. * @param interaxial_distance In case of stereoscopic setup, the distance between both eyes
  30585. * @param isStereoscopicSideBySide In case of stereoscopic setup, should the sereo be side b side
  30586. * @returns a factory method to construc the camera
  30587. */
  30588. static GetConstructorFromName(type: string, name: string, scene: Scene, interaxial_distance?: number, isStereoscopicSideBySide?: boolean): () => Camera;
  30589. /**
  30590. * Compute the world matrix of the camera.
  30591. * @returns the camera world matrix
  30592. */
  30593. computeWorldMatrix(): Matrix;
  30594. /**
  30595. * Parse a JSON and creates the camera from the parsed information
  30596. * @param parsedCamera The JSON to parse
  30597. * @param scene The scene to instantiate the camera in
  30598. * @returns the newly constructed camera
  30599. */
  30600. static Parse(parsedCamera: any, scene: Scene): Camera;
  30601. }
  30602. }
  30603. declare module "babylonjs/Meshes/Builders/discBuilder" {
  30604. import { Nullable } from "babylonjs/types";
  30605. import { Scene } from "babylonjs/scene";
  30606. import { Vector4 } from "babylonjs/Maths/math.vector";
  30607. import { Mesh } from "babylonjs/Meshes/mesh";
  30608. /**
  30609. * Class containing static functions to help procedurally build meshes
  30610. */
  30611. export class DiscBuilder {
  30612. /**
  30613. * Creates a plane polygonal mesh. By default, this is a disc
  30614. * * The parameter `radius` sets the radius size (float) of the polygon (default 0.5)
  30615. * * 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
  30616. * * 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
  30617. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  30618. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  30619. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  30620. * @param name defines the name of the mesh
  30621. * @param options defines the options used to create the mesh
  30622. * @param scene defines the hosting scene
  30623. * @returns the plane polygonal mesh
  30624. * @see https://doc.babylonjs.com/how_to/set_shapes#disc-or-regular-polygon
  30625. */
  30626. static CreateDisc(name: string, options: {
  30627. radius?: number;
  30628. tessellation?: number;
  30629. arc?: number;
  30630. updatable?: boolean;
  30631. sideOrientation?: number;
  30632. frontUVs?: Vector4;
  30633. backUVs?: Vector4;
  30634. }, scene?: Nullable<Scene>): Mesh;
  30635. }
  30636. }
  30637. declare module "babylonjs/Materials/fresnelParameters" {
  30638. import { DeepImmutable } from "babylonjs/types";
  30639. import { Color3 } from "babylonjs/Maths/math.color";
  30640. /**
  30641. * Options to be used when creating a FresnelParameters.
  30642. */
  30643. export type IFresnelParametersCreationOptions = {
  30644. /**
  30645. * Define the color used on edges (grazing angle)
  30646. */
  30647. leftColor?: Color3;
  30648. /**
  30649. * Define the color used on center
  30650. */
  30651. rightColor?: Color3;
  30652. /**
  30653. * Define bias applied to computed fresnel term
  30654. */
  30655. bias?: number;
  30656. /**
  30657. * Defined the power exponent applied to fresnel term
  30658. */
  30659. power?: number;
  30660. /**
  30661. * Define if the fresnel effect is enable or not.
  30662. */
  30663. isEnabled?: boolean;
  30664. };
  30665. /**
  30666. * Serialized format for FresnelParameters.
  30667. */
  30668. export type IFresnelParametersSerialized = {
  30669. /**
  30670. * Define the color used on edges (grazing angle) [as an array]
  30671. */
  30672. leftColor: number[];
  30673. /**
  30674. * Define the color used on center [as an array]
  30675. */
  30676. rightColor: number[];
  30677. /**
  30678. * Define bias applied to computed fresnel term
  30679. */
  30680. bias: number;
  30681. /**
  30682. * Defined the power exponent applied to fresnel term
  30683. */
  30684. power?: number;
  30685. /**
  30686. * Define if the fresnel effect is enable or not.
  30687. */
  30688. isEnabled: boolean;
  30689. };
  30690. /**
  30691. * This represents all the required information to add a fresnel effect on a material:
  30692. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  30693. */
  30694. export class FresnelParameters {
  30695. private _isEnabled;
  30696. /**
  30697. * Define if the fresnel effect is enable or not.
  30698. */
  30699. get isEnabled(): boolean;
  30700. set isEnabled(value: boolean);
  30701. /**
  30702. * Define the color used on edges (grazing angle)
  30703. */
  30704. leftColor: Color3;
  30705. /**
  30706. * Define the color used on center
  30707. */
  30708. rightColor: Color3;
  30709. /**
  30710. * Define bias applied to computed fresnel term
  30711. */
  30712. bias: number;
  30713. /**
  30714. * Defined the power exponent applied to fresnel term
  30715. */
  30716. power: number;
  30717. /**
  30718. * Creates a new FresnelParameters object.
  30719. *
  30720. * @param options provide your own settings to optionally to override defaults
  30721. */
  30722. constructor(options?: IFresnelParametersCreationOptions);
  30723. /**
  30724. * Clones the current fresnel and its valuues
  30725. * @returns a clone fresnel configuration
  30726. */
  30727. clone(): FresnelParameters;
  30728. /**
  30729. * Determines equality between FresnelParameters objects
  30730. * @param otherFresnelParameters defines the second operand
  30731. * @returns true if the power, bias, leftColor, rightColor and isEnabled values are equal to the given ones
  30732. */
  30733. equals(otherFresnelParameters: DeepImmutable<FresnelParameters>): boolean;
  30734. /**
  30735. * Serializes the current fresnel parameters to a JSON representation.
  30736. * @return the JSON serialization
  30737. */
  30738. serialize(): IFresnelParametersSerialized;
  30739. /**
  30740. * Parse a JSON object and deserialize it to a new Fresnel parameter object.
  30741. * @param parsedFresnelParameters Define the JSON representation
  30742. * @returns the parsed parameters
  30743. */
  30744. static Parse(parsedFresnelParameters: IFresnelParametersSerialized): FresnelParameters;
  30745. }
  30746. }
  30747. declare module "babylonjs/Materials/materialFlags" {
  30748. /**
  30749. * This groups all the flags used to control the materials channel.
  30750. */
  30751. export class MaterialFlags {
  30752. private static _DiffuseTextureEnabled;
  30753. /**
  30754. * Are diffuse textures enabled in the application.
  30755. */
  30756. static get DiffuseTextureEnabled(): boolean;
  30757. static set DiffuseTextureEnabled(value: boolean);
  30758. private static _DetailTextureEnabled;
  30759. /**
  30760. * Are detail textures enabled in the application.
  30761. */
  30762. static get DetailTextureEnabled(): boolean;
  30763. static set DetailTextureEnabled(value: boolean);
  30764. private static _AmbientTextureEnabled;
  30765. /**
  30766. * Are ambient textures enabled in the application.
  30767. */
  30768. static get AmbientTextureEnabled(): boolean;
  30769. static set AmbientTextureEnabled(value: boolean);
  30770. private static _OpacityTextureEnabled;
  30771. /**
  30772. * Are opacity textures enabled in the application.
  30773. */
  30774. static get OpacityTextureEnabled(): boolean;
  30775. static set OpacityTextureEnabled(value: boolean);
  30776. private static _ReflectionTextureEnabled;
  30777. /**
  30778. * Are reflection textures enabled in the application.
  30779. */
  30780. static get ReflectionTextureEnabled(): boolean;
  30781. static set ReflectionTextureEnabled(value: boolean);
  30782. private static _EmissiveTextureEnabled;
  30783. /**
  30784. * Are emissive textures enabled in the application.
  30785. */
  30786. static get EmissiveTextureEnabled(): boolean;
  30787. static set EmissiveTextureEnabled(value: boolean);
  30788. private static _SpecularTextureEnabled;
  30789. /**
  30790. * Are specular textures enabled in the application.
  30791. */
  30792. static get SpecularTextureEnabled(): boolean;
  30793. static set SpecularTextureEnabled(value: boolean);
  30794. private static _BumpTextureEnabled;
  30795. /**
  30796. * Are bump textures enabled in the application.
  30797. */
  30798. static get BumpTextureEnabled(): boolean;
  30799. static set BumpTextureEnabled(value: boolean);
  30800. private static _LightmapTextureEnabled;
  30801. /**
  30802. * Are lightmap textures enabled in the application.
  30803. */
  30804. static get LightmapTextureEnabled(): boolean;
  30805. static set LightmapTextureEnabled(value: boolean);
  30806. private static _RefractionTextureEnabled;
  30807. /**
  30808. * Are refraction textures enabled in the application.
  30809. */
  30810. static get RefractionTextureEnabled(): boolean;
  30811. static set RefractionTextureEnabled(value: boolean);
  30812. private static _ColorGradingTextureEnabled;
  30813. /**
  30814. * Are color grading textures enabled in the application.
  30815. */
  30816. static get ColorGradingTextureEnabled(): boolean;
  30817. static set ColorGradingTextureEnabled(value: boolean);
  30818. private static _FresnelEnabled;
  30819. /**
  30820. * Are fresnels enabled in the application.
  30821. */
  30822. static get FresnelEnabled(): boolean;
  30823. static set FresnelEnabled(value: boolean);
  30824. private static _ClearCoatTextureEnabled;
  30825. /**
  30826. * Are clear coat textures enabled in the application.
  30827. */
  30828. static get ClearCoatTextureEnabled(): boolean;
  30829. static set ClearCoatTextureEnabled(value: boolean);
  30830. private static _ClearCoatBumpTextureEnabled;
  30831. /**
  30832. * Are clear coat bump textures enabled in the application.
  30833. */
  30834. static get ClearCoatBumpTextureEnabled(): boolean;
  30835. static set ClearCoatBumpTextureEnabled(value: boolean);
  30836. private static _ClearCoatTintTextureEnabled;
  30837. /**
  30838. * Are clear coat tint textures enabled in the application.
  30839. */
  30840. static get ClearCoatTintTextureEnabled(): boolean;
  30841. static set ClearCoatTintTextureEnabled(value: boolean);
  30842. private static _SheenTextureEnabled;
  30843. /**
  30844. * Are sheen textures enabled in the application.
  30845. */
  30846. static get SheenTextureEnabled(): boolean;
  30847. static set SheenTextureEnabled(value: boolean);
  30848. private static _AnisotropicTextureEnabled;
  30849. /**
  30850. * Are anisotropic textures enabled in the application.
  30851. */
  30852. static get AnisotropicTextureEnabled(): boolean;
  30853. static set AnisotropicTextureEnabled(value: boolean);
  30854. private static _ThicknessTextureEnabled;
  30855. /**
  30856. * Are thickness textures enabled in the application.
  30857. */
  30858. static get ThicknessTextureEnabled(): boolean;
  30859. static set ThicknessTextureEnabled(value: boolean);
  30860. }
  30861. }
  30862. declare module "babylonjs/Shaders/ShadersInclude/defaultFragmentDeclaration" {
  30863. /** @hidden */
  30864. export var defaultFragmentDeclaration: {
  30865. name: string;
  30866. shader: string;
  30867. };
  30868. }
  30869. declare module "babylonjs/Shaders/ShadersInclude/defaultUboDeclaration" {
  30870. /** @hidden */
  30871. export var defaultUboDeclaration: {
  30872. name: string;
  30873. shader: string;
  30874. };
  30875. }
  30876. declare module "babylonjs/Shaders/ShadersInclude/prePassDeclaration" {
  30877. /** @hidden */
  30878. export var prePassDeclaration: {
  30879. name: string;
  30880. shader: string;
  30881. };
  30882. }
  30883. declare module "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration" {
  30884. /** @hidden */
  30885. export var lightFragmentDeclaration: {
  30886. name: string;
  30887. shader: string;
  30888. };
  30889. }
  30890. declare module "babylonjs/Shaders/ShadersInclude/lightUboDeclaration" {
  30891. /** @hidden */
  30892. export var lightUboDeclaration: {
  30893. name: string;
  30894. shader: string;
  30895. };
  30896. }
  30897. declare module "babylonjs/Shaders/ShadersInclude/lightsFragmentFunctions" {
  30898. /** @hidden */
  30899. export var lightsFragmentFunctions: {
  30900. name: string;
  30901. shader: string;
  30902. };
  30903. }
  30904. declare module "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions" {
  30905. /** @hidden */
  30906. export var shadowsFragmentFunctions: {
  30907. name: string;
  30908. shader: string;
  30909. };
  30910. }
  30911. declare module "babylonjs/Shaders/ShadersInclude/fresnelFunction" {
  30912. /** @hidden */
  30913. export var fresnelFunction: {
  30914. name: string;
  30915. shader: string;
  30916. };
  30917. }
  30918. declare module "babylonjs/Shaders/ShadersInclude/bumpFragmentMainFunctions" {
  30919. /** @hidden */
  30920. export var bumpFragmentMainFunctions: {
  30921. name: string;
  30922. shader: string;
  30923. };
  30924. }
  30925. declare module "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions" {
  30926. /** @hidden */
  30927. export var bumpFragmentFunctions: {
  30928. name: string;
  30929. shader: string;
  30930. };
  30931. }
  30932. declare module "babylonjs/Shaders/ShadersInclude/logDepthDeclaration" {
  30933. /** @hidden */
  30934. export var logDepthDeclaration: {
  30935. name: string;
  30936. shader: string;
  30937. };
  30938. }
  30939. declare module "babylonjs/Shaders/ShadersInclude/bumpFragment" {
  30940. /** @hidden */
  30941. export var bumpFragment: {
  30942. name: string;
  30943. shader: string;
  30944. };
  30945. }
  30946. declare module "babylonjs/Shaders/ShadersInclude/depthPrePass" {
  30947. /** @hidden */
  30948. export var depthPrePass: {
  30949. name: string;
  30950. shader: string;
  30951. };
  30952. }
  30953. declare module "babylonjs/Shaders/ShadersInclude/lightFragment" {
  30954. /** @hidden */
  30955. export var lightFragment: {
  30956. name: string;
  30957. shader: string;
  30958. };
  30959. }
  30960. declare module "babylonjs/Shaders/ShadersInclude/logDepthFragment" {
  30961. /** @hidden */
  30962. export var logDepthFragment: {
  30963. name: string;
  30964. shader: string;
  30965. };
  30966. }
  30967. declare module "babylonjs/Shaders/default.fragment" {
  30968. import "babylonjs/Shaders/ShadersInclude/defaultFragmentDeclaration";
  30969. import "babylonjs/Shaders/ShadersInclude/defaultUboDeclaration";
  30970. import "babylonjs/Shaders/ShadersInclude/prePassDeclaration";
  30971. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  30972. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  30973. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  30974. import "babylonjs/Shaders/ShadersInclude/lightsFragmentFunctions";
  30975. import "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions";
  30976. import "babylonjs/Shaders/ShadersInclude/fresnelFunction";
  30977. import "babylonjs/Shaders/ShadersInclude/reflectionFunction";
  30978. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  30979. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  30980. import "babylonjs/Shaders/ShadersInclude/bumpFragmentMainFunctions";
  30981. import "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions";
  30982. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  30983. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  30984. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  30985. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  30986. import "babylonjs/Shaders/ShadersInclude/bumpFragment";
  30987. import "babylonjs/Shaders/ShadersInclude/depthPrePass";
  30988. import "babylonjs/Shaders/ShadersInclude/lightFragment";
  30989. import "babylonjs/Shaders/ShadersInclude/logDepthFragment";
  30990. import "babylonjs/Shaders/ShadersInclude/fogFragment";
  30991. /** @hidden */
  30992. export var defaultPixelShader: {
  30993. name: string;
  30994. shader: string;
  30995. };
  30996. }
  30997. declare module "babylonjs/Shaders/ShadersInclude/defaultVertexDeclaration" {
  30998. /** @hidden */
  30999. export var defaultVertexDeclaration: {
  31000. name: string;
  31001. shader: string;
  31002. };
  31003. }
  31004. declare module "babylonjs/Shaders/ShadersInclude/bumpVertexDeclaration" {
  31005. /** @hidden */
  31006. export var bumpVertexDeclaration: {
  31007. name: string;
  31008. shader: string;
  31009. };
  31010. }
  31011. declare module "babylonjs/Shaders/ShadersInclude/bumpVertex" {
  31012. /** @hidden */
  31013. export var bumpVertex: {
  31014. name: string;
  31015. shader: string;
  31016. };
  31017. }
  31018. declare module "babylonjs/Shaders/ShadersInclude/fogVertex" {
  31019. /** @hidden */
  31020. export var fogVertex: {
  31021. name: string;
  31022. shader: string;
  31023. };
  31024. }
  31025. declare module "babylonjs/Shaders/ShadersInclude/shadowsVertex" {
  31026. /** @hidden */
  31027. export var shadowsVertex: {
  31028. name: string;
  31029. shader: string;
  31030. };
  31031. }
  31032. declare module "babylonjs/Shaders/ShadersInclude/pointCloudVertex" {
  31033. /** @hidden */
  31034. export var pointCloudVertex: {
  31035. name: string;
  31036. shader: string;
  31037. };
  31038. }
  31039. declare module "babylonjs/Shaders/ShadersInclude/logDepthVertex" {
  31040. /** @hidden */
  31041. export var logDepthVertex: {
  31042. name: string;
  31043. shader: string;
  31044. };
  31045. }
  31046. declare module "babylonjs/Shaders/default.vertex" {
  31047. import "babylonjs/Shaders/ShadersInclude/defaultVertexDeclaration";
  31048. import "babylonjs/Shaders/ShadersInclude/defaultUboDeclaration";
  31049. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  31050. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  31051. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  31052. import "babylonjs/Shaders/ShadersInclude/bumpVertexDeclaration";
  31053. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  31054. import "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration";
  31055. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  31056. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  31057. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  31058. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  31059. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  31060. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  31061. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  31062. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  31063. import "babylonjs/Shaders/ShadersInclude/bumpVertex";
  31064. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  31065. import "babylonjs/Shaders/ShadersInclude/fogVertex";
  31066. import "babylonjs/Shaders/ShadersInclude/shadowsVertex";
  31067. import "babylonjs/Shaders/ShadersInclude/pointCloudVertex";
  31068. import "babylonjs/Shaders/ShadersInclude/logDepthVertex";
  31069. /** @hidden */
  31070. export var defaultVertexShader: {
  31071. name: string;
  31072. shader: string;
  31073. };
  31074. }
  31075. declare module "babylonjs/Materials/material.detailMapConfiguration" {
  31076. import { Nullable } from "babylonjs/types";
  31077. import { Scene } from "babylonjs/scene";
  31078. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  31079. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  31080. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  31081. /**
  31082. * @hidden
  31083. */
  31084. export interface IMaterialDetailMapDefines {
  31085. DETAIL: boolean;
  31086. DETAILDIRECTUV: number;
  31087. DETAIL_NORMALBLENDMETHOD: number;
  31088. /** @hidden */
  31089. _areTexturesDirty: boolean;
  31090. }
  31091. /**
  31092. * Define the code related to the detail map parameters of a material
  31093. *
  31094. * Inspired from:
  31095. * 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
  31096. * Unreal: https://docs.unrealengine.com/en-US/Engine/Rendering/Materials/HowTo/DetailTexturing/index.html
  31097. * Cryengine: https://docs.cryengine.com/display/SDKDOC2/Detail+Maps
  31098. */
  31099. export class DetailMapConfiguration {
  31100. private _texture;
  31101. /**
  31102. * The detail texture of the material.
  31103. */
  31104. texture: Nullable<BaseTexture>;
  31105. /**
  31106. * Defines how strongly the detail diffuse/albedo channel is blended with the regular diffuse/albedo texture
  31107. * Bigger values mean stronger blending
  31108. */
  31109. diffuseBlendLevel: number;
  31110. /**
  31111. * Defines how strongly the detail roughness channel is blended with the regular roughness value
  31112. * Bigger values mean stronger blending. Only used with PBR materials
  31113. */
  31114. roughnessBlendLevel: number;
  31115. /**
  31116. * Defines how strong the bump effect from the detail map is
  31117. * Bigger values mean stronger effect
  31118. */
  31119. bumpLevel: number;
  31120. private _normalBlendMethod;
  31121. /**
  31122. * The method used to blend the bump and detail normals together
  31123. */
  31124. normalBlendMethod: number;
  31125. private _isEnabled;
  31126. /**
  31127. * Enable or disable the detail map on this material
  31128. */
  31129. isEnabled: boolean;
  31130. /** @hidden */
  31131. private _internalMarkAllSubMeshesAsTexturesDirty;
  31132. /** @hidden */
  31133. _markAllSubMeshesAsTexturesDirty(): void;
  31134. /**
  31135. * Instantiate a new detail map
  31136. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  31137. */
  31138. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  31139. /**
  31140. * Gets whether the submesh is ready to be used or not.
  31141. * @param defines the list of "defines" to update.
  31142. * @param scene defines the scene the material belongs to.
  31143. * @returns - boolean indicating that the submesh is ready or not.
  31144. */
  31145. isReadyForSubMesh(defines: IMaterialDetailMapDefines, scene: Scene): boolean;
  31146. /**
  31147. * Update the defines for detail map usage
  31148. * @param defines the list of "defines" to update.
  31149. * @param scene defines the scene the material belongs to.
  31150. */
  31151. prepareDefines(defines: IMaterialDetailMapDefines, scene: Scene): void;
  31152. /**
  31153. * Binds the material data.
  31154. * @param uniformBuffer defines the Uniform buffer to fill in.
  31155. * @param scene defines the scene the material belongs to.
  31156. * @param isFrozen defines whether the material is frozen or not.
  31157. */
  31158. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  31159. /**
  31160. * Checks to see if a texture is used in the material.
  31161. * @param texture - Base texture to use.
  31162. * @returns - Boolean specifying if a texture is used in the material.
  31163. */
  31164. hasTexture(texture: BaseTexture): boolean;
  31165. /**
  31166. * Returns an array of the actively used textures.
  31167. * @param activeTextures Array of BaseTextures
  31168. */
  31169. getActiveTextures(activeTextures: BaseTexture[]): void;
  31170. /**
  31171. * Returns the animatable textures.
  31172. * @param animatables Array of animatable textures.
  31173. */
  31174. getAnimatables(animatables: IAnimatable[]): void;
  31175. /**
  31176. * Disposes the resources of the material.
  31177. * @param forceDisposeTextures - Forces the disposal of all textures.
  31178. */
  31179. dispose(forceDisposeTextures?: boolean): void;
  31180. /**
  31181. * Get the current class name useful for serialization or dynamic coding.
  31182. * @returns "DetailMap"
  31183. */
  31184. getClassName(): string;
  31185. /**
  31186. * Add the required uniforms to the current list.
  31187. * @param uniforms defines the current uniform list.
  31188. */
  31189. static AddUniforms(uniforms: string[]): void;
  31190. /**
  31191. * Add the required samplers to the current list.
  31192. * @param samplers defines the current sampler list.
  31193. */
  31194. static AddSamplers(samplers: string[]): void;
  31195. /**
  31196. * Add the required uniforms to the current buffer.
  31197. * @param uniformBuffer defines the current uniform buffer.
  31198. */
  31199. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  31200. /**
  31201. * Makes a duplicate of the current instance into another one.
  31202. * @param detailMap define the instance where to copy the info
  31203. */
  31204. copyTo(detailMap: DetailMapConfiguration): void;
  31205. /**
  31206. * Serializes this detail map instance
  31207. * @returns - An object with the serialized instance.
  31208. */
  31209. serialize(): any;
  31210. /**
  31211. * Parses a detail map setting from a serialized object.
  31212. * @param source - Serialized object.
  31213. * @param scene Defines the scene we are parsing for
  31214. * @param rootUrl Defines the rootUrl to load from
  31215. */
  31216. parse(source: any, scene: Scene, rootUrl: string): void;
  31217. }
  31218. }
  31219. declare module "babylonjs/Materials/standardMaterial" {
  31220. import { SmartArray } from "babylonjs/Misc/smartArray";
  31221. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  31222. import { Nullable } from "babylonjs/types";
  31223. import { Scene } from "babylonjs/scene";
  31224. import { Matrix } from "babylonjs/Maths/math.vector";
  31225. import { Color3 } from "babylonjs/Maths/math.color";
  31226. import { SubMesh } from "babylonjs/Meshes/subMesh";
  31227. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  31228. import { Mesh } from "babylonjs/Meshes/mesh";
  31229. import { ImageProcessingConfiguration, IImageProcessingConfigurationDefines } from "babylonjs/Materials/imageProcessingConfiguration";
  31230. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  31231. import { FresnelParameters } from "babylonjs/Materials/fresnelParameters";
  31232. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  31233. import { PushMaterial } from "babylonjs/Materials/pushMaterial";
  31234. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  31235. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  31236. import "babylonjs/Shaders/default.fragment";
  31237. import "babylonjs/Shaders/default.vertex";
  31238. import { IMaterialDetailMapDefines, DetailMapConfiguration } from "babylonjs/Materials/material.detailMapConfiguration";
  31239. /** @hidden */
  31240. export class StandardMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines, IMaterialDetailMapDefines {
  31241. MAINUV1: boolean;
  31242. MAINUV2: boolean;
  31243. DIFFUSE: boolean;
  31244. DIFFUSEDIRECTUV: number;
  31245. DETAIL: boolean;
  31246. DETAILDIRECTUV: number;
  31247. DETAIL_NORMALBLENDMETHOD: number;
  31248. AMBIENT: boolean;
  31249. AMBIENTDIRECTUV: number;
  31250. OPACITY: boolean;
  31251. OPACITYDIRECTUV: number;
  31252. OPACITYRGB: boolean;
  31253. REFLECTION: boolean;
  31254. EMISSIVE: boolean;
  31255. EMISSIVEDIRECTUV: number;
  31256. SPECULAR: boolean;
  31257. SPECULARDIRECTUV: number;
  31258. BUMP: boolean;
  31259. BUMPDIRECTUV: number;
  31260. PARALLAX: boolean;
  31261. PARALLAXOCCLUSION: boolean;
  31262. SPECULAROVERALPHA: boolean;
  31263. CLIPPLANE: boolean;
  31264. CLIPPLANE2: boolean;
  31265. CLIPPLANE3: boolean;
  31266. CLIPPLANE4: boolean;
  31267. CLIPPLANE5: boolean;
  31268. CLIPPLANE6: boolean;
  31269. ALPHATEST: boolean;
  31270. DEPTHPREPASS: boolean;
  31271. ALPHAFROMDIFFUSE: boolean;
  31272. POINTSIZE: boolean;
  31273. FOG: boolean;
  31274. SPECULARTERM: boolean;
  31275. DIFFUSEFRESNEL: boolean;
  31276. OPACITYFRESNEL: boolean;
  31277. REFLECTIONFRESNEL: boolean;
  31278. REFRACTIONFRESNEL: boolean;
  31279. EMISSIVEFRESNEL: boolean;
  31280. FRESNEL: boolean;
  31281. NORMAL: boolean;
  31282. UV1: boolean;
  31283. UV2: boolean;
  31284. VERTEXCOLOR: boolean;
  31285. VERTEXALPHA: boolean;
  31286. NUM_BONE_INFLUENCERS: number;
  31287. BonesPerMesh: number;
  31288. BONETEXTURE: boolean;
  31289. INSTANCES: boolean;
  31290. THIN_INSTANCES: boolean;
  31291. GLOSSINESS: boolean;
  31292. ROUGHNESS: boolean;
  31293. EMISSIVEASILLUMINATION: boolean;
  31294. LINKEMISSIVEWITHDIFFUSE: boolean;
  31295. REFLECTIONFRESNELFROMSPECULAR: boolean;
  31296. LIGHTMAP: boolean;
  31297. LIGHTMAPDIRECTUV: number;
  31298. OBJECTSPACE_NORMALMAP: boolean;
  31299. USELIGHTMAPASSHADOWMAP: boolean;
  31300. REFLECTIONMAP_3D: boolean;
  31301. REFLECTIONMAP_SPHERICAL: boolean;
  31302. REFLECTIONMAP_PLANAR: boolean;
  31303. REFLECTIONMAP_CUBIC: boolean;
  31304. USE_LOCAL_REFLECTIONMAP_CUBIC: boolean;
  31305. REFLECTIONMAP_PROJECTION: boolean;
  31306. REFLECTIONMAP_SKYBOX: boolean;
  31307. REFLECTIONMAP_EXPLICIT: boolean;
  31308. REFLECTIONMAP_EQUIRECTANGULAR: boolean;
  31309. REFLECTIONMAP_EQUIRECTANGULAR_FIXED: boolean;
  31310. REFLECTIONMAP_MIRROREDEQUIRECTANGULAR_FIXED: boolean;
  31311. INVERTCUBICMAP: boolean;
  31312. LOGARITHMICDEPTH: boolean;
  31313. REFRACTION: boolean;
  31314. REFRACTIONMAP_3D: boolean;
  31315. REFLECTIONOVERALPHA: boolean;
  31316. TWOSIDEDLIGHTING: boolean;
  31317. SHADOWFLOAT: boolean;
  31318. MORPHTARGETS: boolean;
  31319. MORPHTARGETS_NORMAL: boolean;
  31320. MORPHTARGETS_TANGENT: boolean;
  31321. MORPHTARGETS_UV: boolean;
  31322. NUM_MORPH_INFLUENCERS: number;
  31323. NONUNIFORMSCALING: boolean;
  31324. PREMULTIPLYALPHA: boolean;
  31325. ALPHATEST_AFTERALLALPHACOMPUTATIONS: boolean;
  31326. ALPHABLEND: boolean;
  31327. PREPASS: boolean;
  31328. SCENE_MRT_COUNT: number;
  31329. RGBDLIGHTMAP: boolean;
  31330. RGBDREFLECTION: boolean;
  31331. RGBDREFRACTION: boolean;
  31332. IMAGEPROCESSING: boolean;
  31333. VIGNETTE: boolean;
  31334. VIGNETTEBLENDMODEMULTIPLY: boolean;
  31335. VIGNETTEBLENDMODEOPAQUE: boolean;
  31336. TONEMAPPING: boolean;
  31337. TONEMAPPING_ACES: boolean;
  31338. CONTRAST: boolean;
  31339. COLORCURVES: boolean;
  31340. COLORGRADING: boolean;
  31341. COLORGRADING3D: boolean;
  31342. SAMPLER3DGREENDEPTH: boolean;
  31343. SAMPLER3DBGRMAP: boolean;
  31344. IMAGEPROCESSINGPOSTPROCESS: boolean;
  31345. MULTIVIEW: boolean;
  31346. /**
  31347. * If the reflection texture on this material is in linear color space
  31348. * @hidden
  31349. */
  31350. IS_REFLECTION_LINEAR: boolean;
  31351. /**
  31352. * If the refraction texture on this material is in linear color space
  31353. * @hidden
  31354. */
  31355. IS_REFRACTION_LINEAR: boolean;
  31356. EXPOSURE: boolean;
  31357. constructor();
  31358. setReflectionMode(modeToEnable: string): void;
  31359. }
  31360. /**
  31361. * This is the default material used in Babylon. It is the best trade off between quality
  31362. * and performances.
  31363. * @see https://doc.babylonjs.com/babylon101/materials
  31364. */
  31365. export class StandardMaterial extends PushMaterial {
  31366. private _diffuseTexture;
  31367. /**
  31368. * The basic texture of the material as viewed under a light.
  31369. */
  31370. diffuseTexture: Nullable<BaseTexture>;
  31371. private _ambientTexture;
  31372. /**
  31373. * AKA Occlusion Texture in other nomenclature, it helps adding baked shadows into your material.
  31374. */
  31375. ambientTexture: Nullable<BaseTexture>;
  31376. private _opacityTexture;
  31377. /**
  31378. * Define the transparency of the material from a texture.
  31379. * The final alpha value can be read either from the red channel (if texture.getAlphaFromRGB is false)
  31380. * or from the luminance or the current texel (if texture.getAlphaFromRGB is true)
  31381. */
  31382. opacityTexture: Nullable<BaseTexture>;
  31383. private _reflectionTexture;
  31384. /**
  31385. * Define the texture used to display the reflection.
  31386. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  31387. */
  31388. reflectionTexture: Nullable<BaseTexture>;
  31389. private _emissiveTexture;
  31390. /**
  31391. * Define texture of the material as if self lit.
  31392. * This will be mixed in the final result even in the absence of light.
  31393. */
  31394. emissiveTexture: Nullable<BaseTexture>;
  31395. private _specularTexture;
  31396. /**
  31397. * Define how the color and intensity of the highlight given by the light in the material.
  31398. */
  31399. specularTexture: Nullable<BaseTexture>;
  31400. private _bumpTexture;
  31401. /**
  31402. * Bump mapping is a technique to simulate bump and dents on a rendered surface.
  31403. * 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.
  31404. * @see https://doc.babylonjs.com/how_to/more_materials#bump-map
  31405. */
  31406. bumpTexture: Nullable<BaseTexture>;
  31407. private _lightmapTexture;
  31408. /**
  31409. * Complex lighting can be computationally expensive to compute at runtime.
  31410. * To save on computation, lightmaps may be used to store calculated lighting in a texture which will be applied to a given mesh.
  31411. * @see https://doc.babylonjs.com/babylon101/lights#lightmaps
  31412. */
  31413. lightmapTexture: Nullable<BaseTexture>;
  31414. private _refractionTexture;
  31415. /**
  31416. * Define the texture used to display the refraction.
  31417. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  31418. */
  31419. refractionTexture: Nullable<BaseTexture>;
  31420. /**
  31421. * The color of the material lit by the environmental background lighting.
  31422. * @see https://doc.babylonjs.com/babylon101/materials#ambient-color-example
  31423. */
  31424. ambientColor: Color3;
  31425. /**
  31426. * The basic color of the material as viewed under a light.
  31427. */
  31428. diffuseColor: Color3;
  31429. /**
  31430. * Define how the color and intensity of the highlight given by the light in the material.
  31431. */
  31432. specularColor: Color3;
  31433. /**
  31434. * Define the color of the material as if self lit.
  31435. * This will be mixed in the final result even in the absence of light.
  31436. */
  31437. emissiveColor: Color3;
  31438. /**
  31439. * Defines how sharp are the highlights in the material.
  31440. * The bigger the value the sharper giving a more glossy feeling to the result.
  31441. * Reversely, the smaller the value the blurrier giving a more rough feeling to the result.
  31442. */
  31443. specularPower: number;
  31444. private _useAlphaFromDiffuseTexture;
  31445. /**
  31446. * Does the transparency come from the diffuse texture alpha channel.
  31447. */
  31448. useAlphaFromDiffuseTexture: boolean;
  31449. private _useEmissiveAsIllumination;
  31450. /**
  31451. * If true, the emissive value is added into the end result, otherwise it is multiplied in.
  31452. */
  31453. useEmissiveAsIllumination: boolean;
  31454. private _linkEmissiveWithDiffuse;
  31455. /**
  31456. * If true, some kind of energy conservation will prevent the end result to be more than 1 by reducing
  31457. * the emissive level when the final color is close to one.
  31458. */
  31459. linkEmissiveWithDiffuse: boolean;
  31460. private _useSpecularOverAlpha;
  31461. /**
  31462. * Specifies that the material will keep the specular highlights over a transparent surface (only the most limunous ones).
  31463. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  31464. */
  31465. useSpecularOverAlpha: boolean;
  31466. private _useReflectionOverAlpha;
  31467. /**
  31468. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  31469. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  31470. */
  31471. useReflectionOverAlpha: boolean;
  31472. private _disableLighting;
  31473. /**
  31474. * Does lights from the scene impacts this material.
  31475. * It can be a nice trick for performance to disable lighting on a fully emissive material.
  31476. */
  31477. disableLighting: boolean;
  31478. private _useObjectSpaceNormalMap;
  31479. /**
  31480. * Allows using an object space normal map (instead of tangent space).
  31481. */
  31482. useObjectSpaceNormalMap: boolean;
  31483. private _useParallax;
  31484. /**
  31485. * Is parallax enabled or not.
  31486. * @see https://doc.babylonjs.com/how_to/using_parallax_mapping
  31487. */
  31488. useParallax: boolean;
  31489. private _useParallaxOcclusion;
  31490. /**
  31491. * Is parallax occlusion enabled or not.
  31492. * If true, the outcome is way more realistic than traditional Parallax but you can expect a performance hit that worthes consideration.
  31493. * @see https://doc.babylonjs.com/how_to/using_parallax_mapping
  31494. */
  31495. useParallaxOcclusion: boolean;
  31496. /**
  31497. * 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.
  31498. */
  31499. parallaxScaleBias: number;
  31500. private _roughness;
  31501. /**
  31502. * Helps to define how blurry the reflections should appears in the material.
  31503. */
  31504. roughness: number;
  31505. /**
  31506. * In case of refraction, define the value of the index of refraction.
  31507. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  31508. */
  31509. indexOfRefraction: number;
  31510. /**
  31511. * Invert the refraction texture alongside the y axis.
  31512. * It can be useful with procedural textures or probe for instance.
  31513. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  31514. */
  31515. invertRefractionY: boolean;
  31516. /**
  31517. * Defines the alpha limits in alpha test mode.
  31518. */
  31519. alphaCutOff: number;
  31520. private _useLightmapAsShadowmap;
  31521. /**
  31522. * In case of light mapping, define whether the map contains light or shadow informations.
  31523. */
  31524. useLightmapAsShadowmap: boolean;
  31525. private _diffuseFresnelParameters;
  31526. /**
  31527. * Define the diffuse fresnel parameters of the material.
  31528. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  31529. */
  31530. diffuseFresnelParameters: FresnelParameters;
  31531. private _opacityFresnelParameters;
  31532. /**
  31533. * Define the opacity fresnel parameters of the material.
  31534. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  31535. */
  31536. opacityFresnelParameters: FresnelParameters;
  31537. private _reflectionFresnelParameters;
  31538. /**
  31539. * Define the reflection fresnel parameters of the material.
  31540. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  31541. */
  31542. reflectionFresnelParameters: FresnelParameters;
  31543. private _refractionFresnelParameters;
  31544. /**
  31545. * Define the refraction fresnel parameters of the material.
  31546. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  31547. */
  31548. refractionFresnelParameters: FresnelParameters;
  31549. private _emissiveFresnelParameters;
  31550. /**
  31551. * Define the emissive fresnel parameters of the material.
  31552. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  31553. */
  31554. emissiveFresnelParameters: FresnelParameters;
  31555. private _useReflectionFresnelFromSpecular;
  31556. /**
  31557. * If true automatically deducts the fresnels values from the material specularity.
  31558. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  31559. */
  31560. useReflectionFresnelFromSpecular: boolean;
  31561. private _useGlossinessFromSpecularMapAlpha;
  31562. /**
  31563. * Defines if the glossiness/roughness of the material should be read from the specular map alpha channel
  31564. */
  31565. useGlossinessFromSpecularMapAlpha: boolean;
  31566. private _maxSimultaneousLights;
  31567. /**
  31568. * Defines the maximum number of lights that can be used in the material
  31569. */
  31570. maxSimultaneousLights: number;
  31571. private _invertNormalMapX;
  31572. /**
  31573. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  31574. */
  31575. invertNormalMapX: boolean;
  31576. private _invertNormalMapY;
  31577. /**
  31578. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  31579. */
  31580. invertNormalMapY: boolean;
  31581. private _twoSidedLighting;
  31582. /**
  31583. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  31584. */
  31585. twoSidedLighting: boolean;
  31586. /**
  31587. * Default configuration related to image processing available in the standard Material.
  31588. */
  31589. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  31590. /**
  31591. * Gets the image processing configuration used either in this material.
  31592. */
  31593. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  31594. /**
  31595. * Sets the Default image processing configuration used either in the this material.
  31596. *
  31597. * If sets to null, the scene one is in use.
  31598. */
  31599. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  31600. /**
  31601. * Keep track of the image processing observer to allow dispose and replace.
  31602. */
  31603. private _imageProcessingObserver;
  31604. /**
  31605. * Attaches a new image processing configuration to the Standard Material.
  31606. * @param configuration
  31607. */
  31608. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  31609. /**
  31610. * Gets wether the color curves effect is enabled.
  31611. */
  31612. get cameraColorCurvesEnabled(): boolean;
  31613. /**
  31614. * Sets wether the color curves effect is enabled.
  31615. */
  31616. set cameraColorCurvesEnabled(value: boolean);
  31617. /**
  31618. * Gets wether the color grading effect is enabled.
  31619. */
  31620. get cameraColorGradingEnabled(): boolean;
  31621. /**
  31622. * Gets wether the color grading effect is enabled.
  31623. */
  31624. set cameraColorGradingEnabled(value: boolean);
  31625. /**
  31626. * Gets wether tonemapping is enabled or not.
  31627. */
  31628. get cameraToneMappingEnabled(): boolean;
  31629. /**
  31630. * Sets wether tonemapping is enabled or not
  31631. */
  31632. set cameraToneMappingEnabled(value: boolean);
  31633. /**
  31634. * The camera exposure used on this material.
  31635. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  31636. * This corresponds to a photographic exposure.
  31637. */
  31638. get cameraExposure(): number;
  31639. /**
  31640. * The camera exposure used on this material.
  31641. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  31642. * This corresponds to a photographic exposure.
  31643. */
  31644. set cameraExposure(value: number);
  31645. /**
  31646. * Gets The camera contrast used on this material.
  31647. */
  31648. get cameraContrast(): number;
  31649. /**
  31650. * Sets The camera contrast used on this material.
  31651. */
  31652. set cameraContrast(value: number);
  31653. /**
  31654. * Gets the Color Grading 2D Lookup Texture.
  31655. */
  31656. get cameraColorGradingTexture(): Nullable<BaseTexture>;
  31657. /**
  31658. * Sets the Color Grading 2D Lookup Texture.
  31659. */
  31660. set cameraColorGradingTexture(value: Nullable<BaseTexture>);
  31661. /**
  31662. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  31663. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  31664. * 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;
  31665. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  31666. */
  31667. get cameraColorCurves(): Nullable<ColorCurves>;
  31668. /**
  31669. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  31670. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  31671. * 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;
  31672. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  31673. */
  31674. set cameraColorCurves(value: Nullable<ColorCurves>);
  31675. /**
  31676. * Can this material render to several textures at once
  31677. */
  31678. get canRenderToMRT(): boolean;
  31679. /**
  31680. * Defines the detail map parameters for the material.
  31681. */
  31682. readonly detailMap: DetailMapConfiguration;
  31683. protected _renderTargets: SmartArray<RenderTargetTexture>;
  31684. protected _worldViewProjectionMatrix: Matrix;
  31685. protected _globalAmbientColor: Color3;
  31686. protected _useLogarithmicDepth: boolean;
  31687. protected _rebuildInParallel: boolean;
  31688. /**
  31689. * Instantiates a new standard material.
  31690. * This is the default material used in Babylon. It is the best trade off between quality
  31691. * and performances.
  31692. * @see https://doc.babylonjs.com/babylon101/materials
  31693. * @param name Define the name of the material in the scene
  31694. * @param scene Define the scene the material belong to
  31695. */
  31696. constructor(name: string, scene: Scene);
  31697. /**
  31698. * Gets a boolean indicating that current material needs to register RTT
  31699. */
  31700. get hasRenderTargetTextures(): boolean;
  31701. /**
  31702. * Gets the current class name of the material e.g. "StandardMaterial"
  31703. * Mainly use in serialization.
  31704. * @returns the class name
  31705. */
  31706. getClassName(): string;
  31707. /**
  31708. * In case the depth buffer does not allow enough depth precision for your scene (might be the case in large scenes)
  31709. * You can try switching to logarithmic depth.
  31710. * @see https://doc.babylonjs.com/how_to/using_logarithmic_depth_buffer
  31711. */
  31712. get useLogarithmicDepth(): boolean;
  31713. set useLogarithmicDepth(value: boolean);
  31714. /**
  31715. * Specifies if the material will require alpha blending
  31716. * @returns a boolean specifying if alpha blending is needed
  31717. */
  31718. needAlphaBlending(): boolean;
  31719. /**
  31720. * Specifies if this material should be rendered in alpha test mode
  31721. * @returns a boolean specifying if an alpha test is needed.
  31722. */
  31723. needAlphaTesting(): boolean;
  31724. protected _shouldUseAlphaFromDiffuseTexture(): boolean;
  31725. /**
  31726. * Get the texture used for alpha test purpose.
  31727. * @returns the diffuse texture in case of the standard material.
  31728. */
  31729. getAlphaTestTexture(): Nullable<BaseTexture>;
  31730. /**
  31731. * Get if the submesh is ready to be used and all its information available.
  31732. * Child classes can use it to update shaders
  31733. * @param mesh defines the mesh to check
  31734. * @param subMesh defines which submesh to check
  31735. * @param useInstances specifies that instances should be used
  31736. * @returns a boolean indicating that the submesh is ready or not
  31737. */
  31738. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  31739. /**
  31740. * Builds the material UBO layouts.
  31741. * Used internally during the effect preparation.
  31742. */
  31743. buildUniformLayout(): void;
  31744. /**
  31745. * Unbinds the material from the mesh
  31746. */
  31747. unbind(): void;
  31748. /**
  31749. * Binds the submesh to this material by preparing the effect and shader to draw
  31750. * @param world defines the world transformation matrix
  31751. * @param mesh defines the mesh containing the submesh
  31752. * @param subMesh defines the submesh to bind the material to
  31753. */
  31754. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  31755. /**
  31756. * Get the list of animatables in the material.
  31757. * @returns the list of animatables object used in the material
  31758. */
  31759. getAnimatables(): IAnimatable[];
  31760. /**
  31761. * Gets the active textures from the material
  31762. * @returns an array of textures
  31763. */
  31764. getActiveTextures(): BaseTexture[];
  31765. /**
  31766. * Specifies if the material uses a texture
  31767. * @param texture defines the texture to check against the material
  31768. * @returns a boolean specifying if the material uses the texture
  31769. */
  31770. hasTexture(texture: BaseTexture): boolean;
  31771. /**
  31772. * Disposes the material
  31773. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  31774. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  31775. */
  31776. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  31777. /**
  31778. * Makes a duplicate of the material, and gives it a new name
  31779. * @param name defines the new name for the duplicated material
  31780. * @returns the cloned material
  31781. */
  31782. clone(name: string): StandardMaterial;
  31783. /**
  31784. * Serializes this material in a JSON representation
  31785. * @returns the serialized material object
  31786. */
  31787. serialize(): any;
  31788. /**
  31789. * Creates a standard material from parsed material data
  31790. * @param source defines the JSON representation of the material
  31791. * @param scene defines the hosting scene
  31792. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  31793. * @returns a new standard material
  31794. */
  31795. static Parse(source: any, scene: Scene, rootUrl: string): StandardMaterial;
  31796. /**
  31797. * Are diffuse textures enabled in the application.
  31798. */
  31799. static get DiffuseTextureEnabled(): boolean;
  31800. static set DiffuseTextureEnabled(value: boolean);
  31801. /**
  31802. * Are detail textures enabled in the application.
  31803. */
  31804. static get DetailTextureEnabled(): boolean;
  31805. static set DetailTextureEnabled(value: boolean);
  31806. /**
  31807. * Are ambient textures enabled in the application.
  31808. */
  31809. static get AmbientTextureEnabled(): boolean;
  31810. static set AmbientTextureEnabled(value: boolean);
  31811. /**
  31812. * Are opacity textures enabled in the application.
  31813. */
  31814. static get OpacityTextureEnabled(): boolean;
  31815. static set OpacityTextureEnabled(value: boolean);
  31816. /**
  31817. * Are reflection textures enabled in the application.
  31818. */
  31819. static get ReflectionTextureEnabled(): boolean;
  31820. static set ReflectionTextureEnabled(value: boolean);
  31821. /**
  31822. * Are emissive textures enabled in the application.
  31823. */
  31824. static get EmissiveTextureEnabled(): boolean;
  31825. static set EmissiveTextureEnabled(value: boolean);
  31826. /**
  31827. * Are specular textures enabled in the application.
  31828. */
  31829. static get SpecularTextureEnabled(): boolean;
  31830. static set SpecularTextureEnabled(value: boolean);
  31831. /**
  31832. * Are bump textures enabled in the application.
  31833. */
  31834. static get BumpTextureEnabled(): boolean;
  31835. static set BumpTextureEnabled(value: boolean);
  31836. /**
  31837. * Are lightmap textures enabled in the application.
  31838. */
  31839. static get LightmapTextureEnabled(): boolean;
  31840. static set LightmapTextureEnabled(value: boolean);
  31841. /**
  31842. * Are refraction textures enabled in the application.
  31843. */
  31844. static get RefractionTextureEnabled(): boolean;
  31845. static set RefractionTextureEnabled(value: boolean);
  31846. /**
  31847. * Are color grading textures enabled in the application.
  31848. */
  31849. static get ColorGradingTextureEnabled(): boolean;
  31850. static set ColorGradingTextureEnabled(value: boolean);
  31851. /**
  31852. * Are fresnels enabled in the application.
  31853. */
  31854. static get FresnelEnabled(): boolean;
  31855. static set FresnelEnabled(value: boolean);
  31856. }
  31857. }
  31858. declare module "babylonjs/Particles/solidParticleSystem" {
  31859. import { Nullable } from "babylonjs/types";
  31860. import { Mesh } from "babylonjs/Meshes/mesh";
  31861. import { Scene, IDisposable } from "babylonjs/scene";
  31862. import { DepthSortedParticle, SolidParticle, SolidParticleVertex } from "babylonjs/Particles/solidParticle";
  31863. import { Material } from "babylonjs/Materials/material";
  31864. import { MultiMaterial } from "babylonjs/Materials/multiMaterial";
  31865. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  31866. /**
  31867. * The SPS is a single updatable mesh. The solid particles are simply separate parts or faces fo this big mesh.
  31868. *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.
  31869. * The SPS is also a particle system. It provides some methods to manage the particles.
  31870. * However it is behavior agnostic. This means it has no emitter, no particle physics, no particle recycler. You have to implement your own behavior.
  31871. *
  31872. * Full documentation here : https://doc.babylonjs.com/how_to/Solid_Particle_System
  31873. */
  31874. export class SolidParticleSystem implements IDisposable {
  31875. /**
  31876. * The SPS array of Solid Particle objects. Just access each particle as with any classic array.
  31877. * Example : var p = SPS.particles[i];
  31878. */
  31879. particles: SolidParticle[];
  31880. /**
  31881. * The SPS total number of particles. Read only. Use SPS.counter instead if you need to set your own value.
  31882. */
  31883. nbParticles: number;
  31884. /**
  31885. * If the particles must ever face the camera (default false). Useful for planar particles.
  31886. */
  31887. billboard: boolean;
  31888. /**
  31889. * Recompute normals when adding a shape
  31890. */
  31891. recomputeNormals: boolean;
  31892. /**
  31893. * This a counter ofr your own usage. It's not set by any SPS functions.
  31894. */
  31895. counter: number;
  31896. /**
  31897. * The SPS name. This name is also given to the underlying mesh.
  31898. */
  31899. name: string;
  31900. /**
  31901. * The SPS mesh. It's a standard BJS Mesh, so all the methods from the Mesh class are avalaible.
  31902. */
  31903. mesh: Mesh;
  31904. /**
  31905. * This empty object is intended to store some SPS specific or temporary values in order to lower the Garbage Collector activity.
  31906. * Please read : https://doc.babylonjs.com/how_to/Solid_Particle_System#garbage-collector-concerns
  31907. */
  31908. vars: any;
  31909. /**
  31910. * This array is populated when the SPS is set as 'pickable'.
  31911. * Each key of this array is a `faceId` value that you can get from a pickResult object.
  31912. * Each element of this array is an object `{idx: int, faceId: int}`.
  31913. * `idx` is the picked particle index in the `SPS.particles` array
  31914. * `faceId` is the picked face index counted within this particle.
  31915. * This array is the first element of the pickedBySubMesh array : sps.pickBySubMesh[0].
  31916. * It's not pertinent to use it when using a SPS with the support for MultiMaterial enabled.
  31917. * Use the method SPS.pickedParticle(pickingInfo) instead.
  31918. * Please read : https://doc.babylonjs.com/how_to/Solid_Particle_System#pickable-particles
  31919. */
  31920. pickedParticles: {
  31921. idx: number;
  31922. faceId: number;
  31923. }[];
  31924. /**
  31925. * This array is populated when the SPS is set as 'pickable'
  31926. * Each key of this array is a submesh index.
  31927. * Each element of this array is a second array defined like this :
  31928. * Each key of this second array is a `faceId` value that you can get from a pickResult object.
  31929. * Each element of this second array is an object `{idx: int, faceId: int}`.
  31930. * `idx` is the picked particle index in the `SPS.particles` array
  31931. * `faceId` is the picked face index counted within this particle.
  31932. * It's better to use the method SPS.pickedParticle(pickingInfo) rather than using directly this array.
  31933. * Please read : https://doc.babylonjs.com/how_to/Solid_Particle_System#pickable-particles
  31934. */
  31935. pickedBySubMesh: {
  31936. idx: number;
  31937. faceId: number;
  31938. }[][];
  31939. /**
  31940. * This array is populated when `enableDepthSort` is set to true.
  31941. * Each element of this array is an instance of the class DepthSortedParticle.
  31942. */
  31943. depthSortedParticles: DepthSortedParticle[];
  31944. /**
  31945. * If the particle intersection must be computed only with the bounding sphere (no bounding box computation, so faster). (Internal use only)
  31946. * @hidden
  31947. */
  31948. _bSphereOnly: boolean;
  31949. /**
  31950. * A number to multiply the boundind sphere radius by in order to reduce it for instance. (Internal use only)
  31951. * @hidden
  31952. */
  31953. _bSphereRadiusFactor: number;
  31954. private _scene;
  31955. private _positions;
  31956. private _indices;
  31957. private _normals;
  31958. private _colors;
  31959. private _uvs;
  31960. private _indices32;
  31961. private _positions32;
  31962. private _normals32;
  31963. private _fixedNormal32;
  31964. private _colors32;
  31965. private _uvs32;
  31966. private _index;
  31967. private _updatable;
  31968. private _pickable;
  31969. private _isVisibilityBoxLocked;
  31970. private _alwaysVisible;
  31971. private _depthSort;
  31972. private _expandable;
  31973. private _shapeCounter;
  31974. private _copy;
  31975. private _color;
  31976. private _computeParticleColor;
  31977. private _computeParticleTexture;
  31978. private _computeParticleRotation;
  31979. private _computeParticleVertex;
  31980. private _computeBoundingBox;
  31981. private _depthSortParticles;
  31982. private _camera;
  31983. private _mustUnrotateFixedNormals;
  31984. private _particlesIntersect;
  31985. private _needs32Bits;
  31986. private _isNotBuilt;
  31987. private _lastParticleId;
  31988. private _idxOfId;
  31989. private _multimaterialEnabled;
  31990. private _useModelMaterial;
  31991. private _indicesByMaterial;
  31992. private _materialIndexes;
  31993. private _depthSortFunction;
  31994. private _materialSortFunction;
  31995. private _materials;
  31996. private _multimaterial;
  31997. private _materialIndexesById;
  31998. private _defaultMaterial;
  31999. private _autoUpdateSubMeshes;
  32000. private _tmpVertex;
  32001. /**
  32002. * Creates a SPS (Solid Particle System) object.
  32003. * @param name (String) is the SPS name, this will be the underlying mesh name.
  32004. * @param scene (Scene) is the scene in which the SPS is added.
  32005. * @param options defines the options of the sps e.g.
  32006. * * updatable (optional boolean, default true) : if the SPS must be updatable or immutable.
  32007. * * isPickable (optional boolean, default false) : if the solid particles must be pickable.
  32008. * * enableDepthSort (optional boolean, default false) : if the solid particles must be sorted in the geometry according to their distance to the camera.
  32009. * * 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.
  32010. * * enableMultiMaterial (optional boolean, default false) : if the solid particles can be given different materials.
  32011. * * expandable (optional boolean, default false) : if particles can still be added after the initial SPS mesh creation.
  32012. * * particleIntersection (optional boolean, default false) : if the solid particle intersections must be computed.
  32013. * * boundingSphereOnly (optional boolean, default false) : if the particle intersection must be computed only with the bounding sphere (no bounding box computation, so faster).
  32014. * * bSphereRadiusFactor (optional float, default 1.0) : a number to multiply the boundind sphere radius by in order to reduce it for instance.
  32015. * @example bSphereRadiusFactor = 1.0 / Math.sqrt(3.0) => the bounding sphere exactly matches a spherical mesh.
  32016. */
  32017. constructor(name: string, scene: Scene, options?: {
  32018. updatable?: boolean;
  32019. isPickable?: boolean;
  32020. enableDepthSort?: boolean;
  32021. particleIntersection?: boolean;
  32022. boundingSphereOnly?: boolean;
  32023. bSphereRadiusFactor?: number;
  32024. expandable?: boolean;
  32025. useModelMaterial?: boolean;
  32026. enableMultiMaterial?: boolean;
  32027. });
  32028. /**
  32029. * Builds the SPS underlying mesh. Returns a standard Mesh.
  32030. * If no model shape was added to the SPS, the returned mesh is just a single triangular plane.
  32031. * @returns the created mesh
  32032. */
  32033. buildMesh(): Mesh;
  32034. /**
  32035. * Digests the mesh and generates as many solid particles in the system as wanted. Returns the SPS.
  32036. * These particles will have the same geometry than the mesh parts and will be positioned at the same localisation than the mesh original places.
  32037. * Thus the particles generated from `digest()` have their property `position` set yet.
  32038. * @param mesh ( Mesh ) is the mesh to be digested
  32039. * @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
  32040. * {delta} (optional integer, default 0) is the random extra number of facets per particle , each particle will have between `facetNb` and `facetNb + delta` facets
  32041. * {number} (optional positive integer) is the wanted number of particles : each particle is built with `mesh_total_facets / number` facets
  32042. * {storage} (optional existing array) is an array where the particles will be stored for a further use instead of being inserted in the SPS.
  32043. * @returns the current SPS
  32044. */
  32045. digest(mesh: Mesh, options?: {
  32046. facetNb?: number;
  32047. number?: number;
  32048. delta?: number;
  32049. storage?: [];
  32050. }): SolidParticleSystem;
  32051. /**
  32052. * Unrotate the fixed normals in case the mesh was built with pre-rotated particles, ex : use of positionFunction in addShape()
  32053. * @hidden
  32054. */
  32055. private _unrotateFixedNormals;
  32056. /**
  32057. * Resets the temporary working copy particle
  32058. * @hidden
  32059. */
  32060. private _resetCopy;
  32061. /**
  32062. * Inserts the shape model geometry in the global SPS mesh by updating the positions, indices, normals, colors, uvs arrays
  32063. * @param p the current index in the positions array to be updated
  32064. * @param ind the current index in the indices array
  32065. * @param shape a Vector3 array, the shape geometry
  32066. * @param positions the positions array to be updated
  32067. * @param meshInd the shape indices array
  32068. * @param indices the indices array to be updated
  32069. * @param meshUV the shape uv array
  32070. * @param uvs the uv array to be updated
  32071. * @param meshCol the shape color array
  32072. * @param colors the color array to be updated
  32073. * @param meshNor the shape normals array
  32074. * @param normals the normals array to be updated
  32075. * @param idx the particle index
  32076. * @param idxInShape the particle index in its shape
  32077. * @param options the addShape() method passed options
  32078. * @model the particle model
  32079. * @hidden
  32080. */
  32081. private _meshBuilder;
  32082. /**
  32083. * Returns a shape Vector3 array from positions float array
  32084. * @param positions float array
  32085. * @returns a vector3 array
  32086. * @hidden
  32087. */
  32088. private _posToShape;
  32089. /**
  32090. * Returns a shapeUV array from a float uvs (array deep copy)
  32091. * @param uvs as a float array
  32092. * @returns a shapeUV array
  32093. * @hidden
  32094. */
  32095. private _uvsToShapeUV;
  32096. /**
  32097. * Adds a new particle object in the particles array
  32098. * @param idx particle index in particles array
  32099. * @param id particle id
  32100. * @param idxpos positionIndex : the starting index of the particle vertices in the SPS "positions" array
  32101. * @param idxind indiceIndex : he starting index of the particle indices in the SPS "indices" array
  32102. * @param model particle ModelShape object
  32103. * @param shapeId model shape identifier
  32104. * @param idxInShape index of the particle in the current model
  32105. * @param bInfo model bounding info object
  32106. * @param storage target storage array, if any
  32107. * @hidden
  32108. */
  32109. private _addParticle;
  32110. /**
  32111. * Adds some particles to the SPS from the model shape. Returns the shape id.
  32112. * Please read the doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#create-an-immutable-sps
  32113. * @param mesh is any Mesh object that will be used as a model for the solid particles.
  32114. * @param nb (positive integer) the number of particles to be created from this model
  32115. * @param options {positionFunction} is an optional javascript function to called for each particle on SPS creation.
  32116. * {vertexFunction} is an optional javascript function to called for each vertex of each particle on SPS creation
  32117. * {storage} (optional existing array) is an array where the particles will be stored for a further use instead of being inserted in the SPS.
  32118. * @returns the number of shapes in the system
  32119. */
  32120. addShape(mesh: Mesh, nb: number, options?: {
  32121. positionFunction?: any;
  32122. vertexFunction?: any;
  32123. storage?: [];
  32124. }): number;
  32125. /**
  32126. * Rebuilds a particle back to its just built status : if needed, recomputes the custom positions and vertices
  32127. * @hidden
  32128. */
  32129. private _rebuildParticle;
  32130. /**
  32131. * Rebuilds the whole mesh and updates the VBO : custom positions and vertices are recomputed if needed.
  32132. * @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.
  32133. * @returns the SPS.
  32134. */
  32135. rebuildMesh(reset?: boolean): SolidParticleSystem;
  32136. /** Removes the particles from the start-th to the end-th included from an expandable SPS (required).
  32137. * Returns an array with the removed particles.
  32138. * 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.
  32139. * The SPS can't be empty so at least one particle needs to remain in place.
  32140. * Under the hood, the VertexData array, so the VBO buffer, is recreated each call.
  32141. * @param start index of the first particle to remove
  32142. * @param end index of the last particle to remove (included)
  32143. * @returns an array populated with the removed particles
  32144. */
  32145. removeParticles(start: number, end: number): SolidParticle[];
  32146. /**
  32147. * Inserts some pre-created particles in the solid particle system so that they can be managed by setParticles().
  32148. * @param solidParticleArray an array populated with Solid Particles objects
  32149. * @returns the SPS
  32150. */
  32151. insertParticlesFromArray(solidParticleArray: SolidParticle[]): SolidParticleSystem;
  32152. /**
  32153. * Creates a new particle and modifies the SPS mesh geometry :
  32154. * - calls _meshBuilder() to increase the SPS mesh geometry step by step
  32155. * - calls _addParticle() to populate the particle array
  32156. * factorized code from addShape() and insertParticlesFromArray()
  32157. * @param idx particle index in the particles array
  32158. * @param i particle index in its shape
  32159. * @param modelShape particle ModelShape object
  32160. * @param shape shape vertex array
  32161. * @param meshInd shape indices array
  32162. * @param meshUV shape uv array
  32163. * @param meshCol shape color array
  32164. * @param meshNor shape normals array
  32165. * @param bbInfo shape bounding info
  32166. * @param storage target particle storage
  32167. * @options addShape() passed options
  32168. * @hidden
  32169. */
  32170. private _insertNewParticle;
  32171. /**
  32172. * Sets all the particles : this method actually really updates the mesh according to the particle positions, rotations, colors, textures, etc.
  32173. * This method calls `updateParticle()` for each particle of the SPS.
  32174. * For an animated SPS, it is usually called within the render loop.
  32175. * 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.
  32176. * @param start The particle index in the particle array where to start to compute the particle property values _(default 0)_
  32177. * @param end The particle index in the particle array where to stop to compute the particle property values _(default nbParticle - 1)_
  32178. * @param update If the mesh must be finally updated on this call after all the particle computations _(default true)_
  32179. * @returns the SPS.
  32180. */
  32181. setParticles(start?: number, end?: number, update?: boolean): SolidParticleSystem;
  32182. /**
  32183. * Disposes the SPS.
  32184. */
  32185. dispose(): void;
  32186. /** Returns an object {idx: numbern faceId: number} for the picked particle from the passed pickingInfo object.
  32187. * idx is the particle index in the SPS
  32188. * faceId is the picked face index counted within this particle.
  32189. * Returns null if the pickInfo can't identify a picked particle.
  32190. * @param pickingInfo (PickingInfo object)
  32191. * @returns {idx: number, faceId: number} or null
  32192. */
  32193. pickedParticle(pickingInfo: PickingInfo): Nullable<{
  32194. idx: number;
  32195. faceId: number;
  32196. }>;
  32197. /**
  32198. * Returns a SolidParticle object from its identifier : particle.id
  32199. * @param id (integer) the particle Id
  32200. * @returns the searched particle or null if not found in the SPS.
  32201. */
  32202. getParticleById(id: number): Nullable<SolidParticle>;
  32203. /**
  32204. * Returns a new array populated with the particles having the passed shapeId.
  32205. * @param shapeId (integer) the shape identifier
  32206. * @returns a new solid particle array
  32207. */
  32208. getParticlesByShapeId(shapeId: number): SolidParticle[];
  32209. /**
  32210. * Populates the passed array "ref" with the particles having the passed shapeId.
  32211. * @param shapeId the shape identifier
  32212. * @returns the SPS
  32213. * @param ref
  32214. */
  32215. getParticlesByShapeIdToRef(shapeId: number, ref: SolidParticle[]): SolidParticleSystem;
  32216. /**
  32217. * Computes the required SubMeshes according the materials assigned to the particles.
  32218. * @returns the solid particle system.
  32219. * Does nothing if called before the SPS mesh is built.
  32220. */
  32221. computeSubMeshes(): SolidParticleSystem;
  32222. /**
  32223. * Sorts the solid particles by material when MultiMaterial is enabled.
  32224. * Updates the indices32 array.
  32225. * Updates the indicesByMaterial array.
  32226. * Updates the mesh indices array.
  32227. * @returns the SPS
  32228. * @hidden
  32229. */
  32230. private _sortParticlesByMaterial;
  32231. /**
  32232. * Sets the material indexes by id materialIndexesById[id] = materialIndex
  32233. * @hidden
  32234. */
  32235. private _setMaterialIndexesById;
  32236. /**
  32237. * Returns an array with unique values of Materials from the passed array
  32238. * @param array the material array to be checked and filtered
  32239. * @hidden
  32240. */
  32241. private _filterUniqueMaterialId;
  32242. /**
  32243. * Sets a new Standard Material as _defaultMaterial if not already set.
  32244. * @hidden
  32245. */
  32246. private _setDefaultMaterial;
  32247. /**
  32248. * Visibilty helper : Recomputes the visible size according to the mesh bounding box
  32249. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  32250. * @returns the SPS.
  32251. */
  32252. refreshVisibleSize(): SolidParticleSystem;
  32253. /**
  32254. * Visibility helper : Sets the size of a visibility box, this sets the underlying mesh bounding box.
  32255. * @param size the size (float) of the visibility box
  32256. * note : this doesn't lock the SPS mesh bounding box.
  32257. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  32258. */
  32259. setVisibilityBox(size: number): void;
  32260. /**
  32261. * Gets whether the SPS as always visible or not
  32262. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  32263. */
  32264. get isAlwaysVisible(): boolean;
  32265. /**
  32266. * Sets the SPS as always visible or not
  32267. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  32268. */
  32269. set isAlwaysVisible(val: boolean);
  32270. /**
  32271. * Sets the SPS visibility box as locked or not. This enables/disables the underlying mesh bounding box updates.
  32272. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  32273. */
  32274. set isVisibilityBoxLocked(val: boolean);
  32275. /**
  32276. * Gets if the SPS visibility box as locked or not. This enables/disables the underlying mesh bounding box updates.
  32277. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  32278. */
  32279. get isVisibilityBoxLocked(): boolean;
  32280. /**
  32281. * Tells to `setParticles()` to compute the particle rotations or not.
  32282. * Default value : true. The SPS is faster when it's set to false.
  32283. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate.
  32284. */
  32285. set computeParticleRotation(val: boolean);
  32286. /**
  32287. * Tells to `setParticles()` to compute the particle colors or not.
  32288. * Default value : true. The SPS is faster when it's set to false.
  32289. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  32290. */
  32291. set computeParticleColor(val: boolean);
  32292. set computeParticleTexture(val: boolean);
  32293. /**
  32294. * Tells to `setParticles()` to call the vertex function for each vertex of each particle, or not.
  32295. * Default value : false. The SPS is faster when it's set to false.
  32296. * Note : the particle custom vertex positions aren't stored values.
  32297. */
  32298. set computeParticleVertex(val: boolean);
  32299. /**
  32300. * Tells to `setParticles()` to compute or not the mesh bounding box when computing the particle positions.
  32301. */
  32302. set computeBoundingBox(val: boolean);
  32303. /**
  32304. * Tells to `setParticles()` to sort or not the distance between each particle and the camera.
  32305. * Skipped when `enableDepthSort` is set to `false` (default) at construction time.
  32306. * Default : `true`
  32307. */
  32308. set depthSortParticles(val: boolean);
  32309. /**
  32310. * Gets if `setParticles()` computes the particle rotations or not.
  32311. * Default value : true. The SPS is faster when it's set to false.
  32312. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate.
  32313. */
  32314. get computeParticleRotation(): boolean;
  32315. /**
  32316. * Gets if `setParticles()` computes the particle colors or not.
  32317. * Default value : true. The SPS is faster when it's set to false.
  32318. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  32319. */
  32320. get computeParticleColor(): boolean;
  32321. /**
  32322. * Gets if `setParticles()` computes the particle textures or not.
  32323. * Default value : true. The SPS is faster when it's set to false.
  32324. * Note : the particle textures are stored values, so setting `computeParticleTexture` to false will keep yet the last colors set.
  32325. */
  32326. get computeParticleTexture(): boolean;
  32327. /**
  32328. * Gets if `setParticles()` calls the vertex function for each vertex of each particle, or not.
  32329. * Default value : false. The SPS is faster when it's set to false.
  32330. * Note : the particle custom vertex positions aren't stored values.
  32331. */
  32332. get computeParticleVertex(): boolean;
  32333. /**
  32334. * Gets if `setParticles()` computes or not the mesh bounding box when computing the particle positions.
  32335. */
  32336. get computeBoundingBox(): boolean;
  32337. /**
  32338. * Gets if `setParticles()` sorts or not the distance between each particle and the camera.
  32339. * Skipped when `enableDepthSort` is set to `false` (default) at construction time.
  32340. * Default : `true`
  32341. */
  32342. get depthSortParticles(): boolean;
  32343. /**
  32344. * Gets if the SPS is created as expandable at construction time.
  32345. * Default : `false`
  32346. */
  32347. get expandable(): boolean;
  32348. /**
  32349. * Gets if the SPS supports the Multi Materials
  32350. */
  32351. get multimaterialEnabled(): boolean;
  32352. /**
  32353. * Gets if the SPS uses the model materials for its own multimaterial.
  32354. */
  32355. get useModelMaterial(): boolean;
  32356. /**
  32357. * The SPS used material array.
  32358. */
  32359. get materials(): Material[];
  32360. /**
  32361. * Sets the SPS MultiMaterial from the passed materials.
  32362. * Note : the passed array is internally copied and not used then by reference.
  32363. * @param materials an array of material objects. This array indexes are the materialIndex values of the particles.
  32364. */
  32365. setMultiMaterial(materials: Material[]): void;
  32366. /**
  32367. * The SPS computed multimaterial object
  32368. */
  32369. get multimaterial(): MultiMaterial;
  32370. set multimaterial(mm: MultiMaterial);
  32371. /**
  32372. * If the subMeshes must be updated on the next call to setParticles()
  32373. */
  32374. get autoUpdateSubMeshes(): boolean;
  32375. set autoUpdateSubMeshes(val: boolean);
  32376. /**
  32377. * This function does nothing. It may be overwritten to set all the particle first values.
  32378. * The SPS doesn't call this function, you may have to call it by your own.
  32379. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  32380. */
  32381. initParticles(): void;
  32382. /**
  32383. * This function does nothing. It may be overwritten to recycle a particle.
  32384. * The SPS doesn't call this function, you may have to call it by your own.
  32385. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  32386. * @param particle The particle to recycle
  32387. * @returns the recycled particle
  32388. */
  32389. recycleParticle(particle: SolidParticle): SolidParticle;
  32390. /**
  32391. * Updates a particle : this function should be overwritten by the user.
  32392. * It is called on each particle by `setParticles()`. This is the place to code each particle behavior.
  32393. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  32394. * @example : just set a particle position or velocity and recycle conditions
  32395. * @param particle The particle to update
  32396. * @returns the updated particle
  32397. */
  32398. updateParticle(particle: SolidParticle): SolidParticle;
  32399. /**
  32400. * Updates a vertex of a particle : it can be overwritten by the user.
  32401. * This will be called on each vertex particle by `setParticles()` if `computeParticleVertex` is set to true only.
  32402. * @param particle the current particle
  32403. * @param vertex the current vertex of the current particle : a SolidParticleVertex object
  32404. * @param pt the index of the current vertex in the particle shape
  32405. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#update-each-particle-shape
  32406. * @example : just set a vertex particle position or color
  32407. * @returns the sps
  32408. */
  32409. updateParticleVertex(particle: SolidParticle, vertex: SolidParticleVertex, pt: number): SolidParticleSystem;
  32410. /**
  32411. * This will be called before any other treatment by `setParticles()` and will be passed three parameters.
  32412. * This does nothing and may be overwritten by the user.
  32413. * @param start the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  32414. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  32415. * @param update the boolean update value actually passed to setParticles()
  32416. */
  32417. beforeUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  32418. /**
  32419. * This will be called by `setParticles()` after all the other treatments and just before the actual mesh update.
  32420. * This will be passed three parameters.
  32421. * This does nothing and may be overwritten by the user.
  32422. * @param start the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  32423. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  32424. * @param update the boolean update value actually passed to setParticles()
  32425. */
  32426. afterUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  32427. }
  32428. }
  32429. declare module "babylonjs/Particles/solidParticle" {
  32430. import { Nullable } from "babylonjs/types";
  32431. import { Vector3, Matrix, Quaternion, Vector4, Vector2 } from "babylonjs/Maths/math.vector";
  32432. import { Color4 } from "babylonjs/Maths/math.color";
  32433. import { Mesh } from "babylonjs/Meshes/mesh";
  32434. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  32435. import { SolidParticleSystem } from "babylonjs/Particles/solidParticleSystem";
  32436. import { Plane } from "babylonjs/Maths/math.plane";
  32437. import { Material } from "babylonjs/Materials/material";
  32438. /**
  32439. * Represents one particle of a solid particle system.
  32440. */
  32441. export class SolidParticle {
  32442. /**
  32443. * particle global index
  32444. */
  32445. idx: number;
  32446. /**
  32447. * particle identifier
  32448. */
  32449. id: number;
  32450. /**
  32451. * The color of the particle
  32452. */
  32453. color: Nullable<Color4>;
  32454. /**
  32455. * The world space position of the particle.
  32456. */
  32457. position: Vector3;
  32458. /**
  32459. * The world space rotation of the particle. (Not use if rotationQuaternion is set)
  32460. */
  32461. rotation: Vector3;
  32462. /**
  32463. * The world space rotation quaternion of the particle.
  32464. */
  32465. rotationQuaternion: Nullable<Quaternion>;
  32466. /**
  32467. * The scaling of the particle.
  32468. */
  32469. scaling: Vector3;
  32470. /**
  32471. * The uvs of the particle.
  32472. */
  32473. uvs: Vector4;
  32474. /**
  32475. * The current speed of the particle.
  32476. */
  32477. velocity: Vector3;
  32478. /**
  32479. * The pivot point in the particle local space.
  32480. */
  32481. pivot: Vector3;
  32482. /**
  32483. * Must the particle be translated from its pivot point in its local space ?
  32484. * In this case, the pivot point is set at the origin of the particle local space and the particle is translated.
  32485. * Default : false
  32486. */
  32487. translateFromPivot: boolean;
  32488. /**
  32489. * Is the particle active or not ?
  32490. */
  32491. alive: boolean;
  32492. /**
  32493. * Is the particle visible or not ?
  32494. */
  32495. isVisible: boolean;
  32496. /**
  32497. * Index of this particle in the global "positions" array (Internal use)
  32498. * @hidden
  32499. */
  32500. _pos: number;
  32501. /**
  32502. * @hidden Index of this particle in the global "indices" array (Internal use)
  32503. */
  32504. _ind: number;
  32505. /**
  32506. * @hidden ModelShape of this particle (Internal use)
  32507. */
  32508. _model: ModelShape;
  32509. /**
  32510. * ModelShape id of this particle
  32511. */
  32512. shapeId: number;
  32513. /**
  32514. * Index of the particle in its shape id
  32515. */
  32516. idxInShape: number;
  32517. /**
  32518. * @hidden Reference to the shape model BoundingInfo object (Internal use)
  32519. */
  32520. _modelBoundingInfo: BoundingInfo;
  32521. /**
  32522. * @hidden Particle BoundingInfo object (Internal use)
  32523. */
  32524. _boundingInfo: BoundingInfo;
  32525. /**
  32526. * @hidden Reference to the SPS what the particle belongs to (Internal use)
  32527. */
  32528. _sps: SolidParticleSystem;
  32529. /**
  32530. * @hidden Still set as invisible in order to skip useless computations (Internal use)
  32531. */
  32532. _stillInvisible: boolean;
  32533. /**
  32534. * @hidden Last computed particle rotation matrix
  32535. */
  32536. _rotationMatrix: number[];
  32537. /**
  32538. * Parent particle Id, if any.
  32539. * Default null.
  32540. */
  32541. parentId: Nullable<number>;
  32542. /**
  32543. * The particle material identifier (integer) when MultiMaterials are enabled in the SPS.
  32544. */
  32545. materialIndex: Nullable<number>;
  32546. /**
  32547. * Custom object or properties.
  32548. */
  32549. props: Nullable<any>;
  32550. /**
  32551. * The culling strategy to use to check whether the solid particle must be culled or not when using isInFrustum().
  32552. * The possible values are :
  32553. * - AbstractMesh.CULLINGSTRATEGY_STANDARD
  32554. * - AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  32555. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION
  32556. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY
  32557. * The default value for solid particles is AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  32558. * Please read each static variable documentation in the class AbstractMesh to get details about the culling process.
  32559. * */
  32560. cullingStrategy: number;
  32561. /**
  32562. * @hidden Internal global position in the SPS.
  32563. */
  32564. _globalPosition: Vector3;
  32565. /**
  32566. * Creates a Solid Particle object.
  32567. * Don't create particles manually, use instead the Solid Particle System internal tools like _addParticle()
  32568. * @param particleIndex (integer) is the particle index in the Solid Particle System pool.
  32569. * @param particleId (integer) is the particle identifier. Unless some particles are removed from the SPS, it's the same value than the particle idx.
  32570. * @param positionIndex (integer) is the starting index of the particle vertices in the SPS "positions" array.
  32571. * @param indiceIndex (integer) is the starting index of the particle indices in the SPS "indices" array.
  32572. * @param model (ModelShape) is a reference to the model shape on what the particle is designed.
  32573. * @param shapeId (integer) is the model shape identifier in the SPS.
  32574. * @param idxInShape (integer) is the index of the particle in the current model (ex: the 10th box of addShape(box, 30))
  32575. * @param sps defines the sps it is associated to
  32576. * @param modelBoundingInfo is the reference to the model BoundingInfo used for intersection computations.
  32577. * @param materialIndex is the particle material identifier (integer) when the MultiMaterials are enabled in the SPS.
  32578. */
  32579. constructor(particleIndex: number, particleId: number, positionIndex: number, indiceIndex: number, model: Nullable<ModelShape>, shapeId: number, idxInShape: number, sps: SolidParticleSystem, modelBoundingInfo?: Nullable<BoundingInfo>, materialIndex?: Nullable<number>);
  32580. /**
  32581. * Copies the particle property values into the existing target : position, rotation, scaling, uvs, colors, pivot, parent, visibility, alive
  32582. * @param target the particle target
  32583. * @returns the current particle
  32584. */
  32585. copyToRef(target: SolidParticle): SolidParticle;
  32586. /**
  32587. * Legacy support, changed scale to scaling
  32588. */
  32589. get scale(): Vector3;
  32590. /**
  32591. * Legacy support, changed scale to scaling
  32592. */
  32593. set scale(scale: Vector3);
  32594. /**
  32595. * Legacy support, changed quaternion to rotationQuaternion
  32596. */
  32597. get quaternion(): Nullable<Quaternion>;
  32598. /**
  32599. * Legacy support, changed quaternion to rotationQuaternion
  32600. */
  32601. set quaternion(q: Nullable<Quaternion>);
  32602. /**
  32603. * Returns a boolean. True if the particle intersects another particle or another mesh, else false.
  32604. * The intersection is computed on the particle bounding sphere and Axis Aligned Bounding Box (AABB)
  32605. * @param target is the object (solid particle or mesh) what the intersection is computed against.
  32606. * @returns true if it intersects
  32607. */
  32608. intersectsMesh(target: Mesh | SolidParticle): boolean;
  32609. /**
  32610. * Returns `true` if the solid particle is within the frustum defined by the passed array of planes.
  32611. * A particle is in the frustum if its bounding box intersects the frustum
  32612. * @param frustumPlanes defines the frustum to test
  32613. * @returns true if the particle is in the frustum planes
  32614. */
  32615. isInFrustum(frustumPlanes: Plane[]): boolean;
  32616. /**
  32617. * get the rotation matrix of the particle
  32618. * @hidden
  32619. */
  32620. getRotationMatrix(m: Matrix): void;
  32621. }
  32622. /**
  32623. * Represents the shape of the model used by one particle of a solid particle system.
  32624. * SPS internal tool, don't use it manually.
  32625. */
  32626. export class ModelShape {
  32627. /**
  32628. * The shape id
  32629. * @hidden
  32630. */
  32631. shapeID: number;
  32632. /**
  32633. * flat array of model positions (internal use)
  32634. * @hidden
  32635. */
  32636. _shape: Vector3[];
  32637. /**
  32638. * flat array of model UVs (internal use)
  32639. * @hidden
  32640. */
  32641. _shapeUV: number[];
  32642. /**
  32643. * color array of the model
  32644. * @hidden
  32645. */
  32646. _shapeColors: number[];
  32647. /**
  32648. * indices array of the model
  32649. * @hidden
  32650. */
  32651. _indices: number[];
  32652. /**
  32653. * normals array of the model
  32654. * @hidden
  32655. */
  32656. _normals: number[];
  32657. /**
  32658. * length of the shape in the model indices array (internal use)
  32659. * @hidden
  32660. */
  32661. _indicesLength: number;
  32662. /**
  32663. * Custom position function (internal use)
  32664. * @hidden
  32665. */
  32666. _positionFunction: Nullable<(particle: SolidParticle, i: number, s: number) => void>;
  32667. /**
  32668. * Custom vertex function (internal use)
  32669. * @hidden
  32670. */
  32671. _vertexFunction: Nullable<(particle: SolidParticle, vertex: Vector3, i: number) => void>;
  32672. /**
  32673. * Model material (internal use)
  32674. * @hidden
  32675. */
  32676. _material: Nullable<Material>;
  32677. /**
  32678. * 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.
  32679. * SPS internal tool, don't use it manually.
  32680. * @hidden
  32681. */
  32682. 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>);
  32683. }
  32684. /**
  32685. * Represents a Depth Sorted Particle in the solid particle system.
  32686. * @hidden
  32687. */
  32688. export class DepthSortedParticle {
  32689. /**
  32690. * Particle index
  32691. */
  32692. idx: number;
  32693. /**
  32694. * Index of the particle in the "indices" array
  32695. */
  32696. ind: number;
  32697. /**
  32698. * Length of the particle shape in the "indices" array
  32699. */
  32700. indicesLength: number;
  32701. /**
  32702. * Squared distance from the particle to the camera
  32703. */
  32704. sqDistance: number;
  32705. /**
  32706. * Material index when used with MultiMaterials
  32707. */
  32708. materialIndex: number;
  32709. /**
  32710. * Creates a new sorted particle
  32711. * @param materialIndex
  32712. */
  32713. constructor(idx: number, ind: number, indLength: number, materialIndex: number);
  32714. }
  32715. /**
  32716. * Represents a solid particle vertex
  32717. */
  32718. export class SolidParticleVertex {
  32719. /**
  32720. * Vertex position
  32721. */
  32722. position: Vector3;
  32723. /**
  32724. * Vertex color
  32725. */
  32726. color: Color4;
  32727. /**
  32728. * Vertex UV
  32729. */
  32730. uv: Vector2;
  32731. /**
  32732. * Creates a new solid particle vertex
  32733. */
  32734. constructor();
  32735. /** Vertex x coordinate */
  32736. get x(): number;
  32737. set x(val: number);
  32738. /** Vertex y coordinate */
  32739. get y(): number;
  32740. set y(val: number);
  32741. /** Vertex z coordinate */
  32742. get z(): number;
  32743. set z(val: number);
  32744. }
  32745. }
  32746. declare module "babylonjs/Collisions/meshCollisionData" {
  32747. import { Collider } from "babylonjs/Collisions/collider";
  32748. import { Vector3 } from "babylonjs/Maths/math.vector";
  32749. import { Nullable } from "babylonjs/types";
  32750. import { Observer } from "babylonjs/Misc/observable";
  32751. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  32752. /**
  32753. * @hidden
  32754. */
  32755. export class _MeshCollisionData {
  32756. _checkCollisions: boolean;
  32757. _collisionMask: number;
  32758. _collisionGroup: number;
  32759. _surroundingMeshes: Nullable<AbstractMesh[]>;
  32760. _collider: Nullable<Collider>;
  32761. _oldPositionForCollisions: Vector3;
  32762. _diffPositionForCollisions: Vector3;
  32763. _onCollideObserver: Nullable<Observer<AbstractMesh>>;
  32764. _onCollisionPositionChangeObserver: Nullable<Observer<Vector3>>;
  32765. }
  32766. }
  32767. declare module "babylonjs/Meshes/abstractMesh" {
  32768. import { Observable } from "babylonjs/Misc/observable";
  32769. import { Nullable, FloatArray, IndicesArray, DeepImmutable } from "babylonjs/types";
  32770. import { Camera } from "babylonjs/Cameras/camera";
  32771. import { Scene, IDisposable } from "babylonjs/scene";
  32772. import { Matrix, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  32773. import { Node } from "babylonjs/node";
  32774. import { IGetSetVerticesData } from "babylonjs/Meshes/mesh.vertexData";
  32775. import { TransformNode } from "babylonjs/Meshes/transformNode";
  32776. import { SubMesh } from "babylonjs/Meshes/subMesh";
  32777. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  32778. import { ICullable, BoundingInfo } from "babylonjs/Culling/boundingInfo";
  32779. import { Material } from "babylonjs/Materials/material";
  32780. import { Light } from "babylonjs/Lights/light";
  32781. import { Skeleton } from "babylonjs/Bones/skeleton";
  32782. import { IEdgesRenderer } from "babylonjs/Rendering/edgesRenderer";
  32783. import { SolidParticle } from "babylonjs/Particles/solidParticle";
  32784. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  32785. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  32786. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  32787. import { Plane } from "babylonjs/Maths/math.plane";
  32788. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  32789. import { Ray } from "babylonjs/Culling/ray";
  32790. import { Collider } from "babylonjs/Collisions/collider";
  32791. import { TrianglePickingPredicate } from "babylonjs/Culling/ray";
  32792. import { RenderingGroup } from "babylonjs/Rendering/renderingGroup";
  32793. /** @hidden */
  32794. class _FacetDataStorage {
  32795. facetPositions: Vector3[];
  32796. facetNormals: Vector3[];
  32797. facetPartitioning: number[][];
  32798. facetNb: number;
  32799. partitioningSubdivisions: number;
  32800. partitioningBBoxRatio: number;
  32801. facetDataEnabled: boolean;
  32802. facetParameters: any;
  32803. bbSize: Vector3;
  32804. subDiv: {
  32805. max: number;
  32806. X: number;
  32807. Y: number;
  32808. Z: number;
  32809. };
  32810. facetDepthSort: boolean;
  32811. facetDepthSortEnabled: boolean;
  32812. depthSortedIndices: IndicesArray;
  32813. depthSortedFacets: {
  32814. ind: number;
  32815. sqDistance: number;
  32816. }[];
  32817. facetDepthSortFunction: (f1: {
  32818. ind: number;
  32819. sqDistance: number;
  32820. }, f2: {
  32821. ind: number;
  32822. sqDistance: number;
  32823. }) => number;
  32824. facetDepthSortFrom: Vector3;
  32825. facetDepthSortOrigin: Vector3;
  32826. invertedMatrix: Matrix;
  32827. }
  32828. /**
  32829. * @hidden
  32830. **/
  32831. class _InternalAbstractMeshDataInfo {
  32832. _hasVertexAlpha: boolean;
  32833. _useVertexColors: boolean;
  32834. _numBoneInfluencers: number;
  32835. _applyFog: boolean;
  32836. _receiveShadows: boolean;
  32837. _facetData: _FacetDataStorage;
  32838. _visibility: number;
  32839. _skeleton: Nullable<Skeleton>;
  32840. _layerMask: number;
  32841. _computeBonesUsingShaders: boolean;
  32842. _isActive: boolean;
  32843. _onlyForInstances: boolean;
  32844. _isActiveIntermediate: boolean;
  32845. _onlyForInstancesIntermediate: boolean;
  32846. _actAsRegularMesh: boolean;
  32847. }
  32848. /**
  32849. * Class used to store all common mesh properties
  32850. */
  32851. export class AbstractMesh extends TransformNode implements IDisposable, ICullable, IGetSetVerticesData {
  32852. /** No occlusion */
  32853. static OCCLUSION_TYPE_NONE: number;
  32854. /** Occlusion set to optimisitic */
  32855. static OCCLUSION_TYPE_OPTIMISTIC: number;
  32856. /** Occlusion set to strict */
  32857. static OCCLUSION_TYPE_STRICT: number;
  32858. /** Use an accurante occlusion algorithm */
  32859. static OCCLUSION_ALGORITHM_TYPE_ACCURATE: number;
  32860. /** Use a conservative occlusion algorithm */
  32861. static OCCLUSION_ALGORITHM_TYPE_CONSERVATIVE: number;
  32862. /** Default culling strategy : this is an exclusion test and it's the more accurate.
  32863. * Test order :
  32864. * Is the bounding sphere outside the frustum ?
  32865. * If not, are the bounding box vertices outside the frustum ?
  32866. * It not, then the cullable object is in the frustum.
  32867. */
  32868. static readonly CULLINGSTRATEGY_STANDARD: number;
  32869. /** Culling strategy : Bounding Sphere Only.
  32870. * This is an exclusion test. It's faster than the standard strategy because the bounding box is not tested.
  32871. * It's also less accurate than the standard because some not visible objects can still be selected.
  32872. * Test : is the bounding sphere outside the frustum ?
  32873. * If not, then the cullable object is in the frustum.
  32874. */
  32875. static readonly CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY: number;
  32876. /** Culling strategy : Optimistic Inclusion.
  32877. * This in an inclusion test first, then the standard exclusion test.
  32878. * This can be faster when a cullable object is expected to be almost always in the camera frustum.
  32879. * 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.
  32880. * Anyway, it's as accurate as the standard strategy.
  32881. * Test :
  32882. * Is the cullable object bounding sphere center in the frustum ?
  32883. * If not, apply the default culling strategy.
  32884. */
  32885. static readonly CULLINGSTRATEGY_OPTIMISTIC_INCLUSION: number;
  32886. /** Culling strategy : Optimistic Inclusion then Bounding Sphere Only.
  32887. * This in an inclusion test first, then the bounding sphere only exclusion test.
  32888. * This can be the fastest test when a cullable object is expected to be almost always in the camera frustum.
  32889. * 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.
  32890. * It's less accurate than the standard strategy and as accurate as the BoundingSphereOnly strategy.
  32891. * Test :
  32892. * Is the cullable object bounding sphere center in the frustum ?
  32893. * If not, apply the Bounding Sphere Only strategy. No Bounding Box is tested here.
  32894. */
  32895. static readonly CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY: number;
  32896. /**
  32897. * No billboard
  32898. */
  32899. static get BILLBOARDMODE_NONE(): number;
  32900. /** Billboard on X axis */
  32901. static get BILLBOARDMODE_X(): number;
  32902. /** Billboard on Y axis */
  32903. static get BILLBOARDMODE_Y(): number;
  32904. /** Billboard on Z axis */
  32905. static get BILLBOARDMODE_Z(): number;
  32906. /** Billboard on all axes */
  32907. static get BILLBOARDMODE_ALL(): number;
  32908. /** Billboard on using position instead of orientation */
  32909. static get BILLBOARDMODE_USE_POSITION(): number;
  32910. /** @hidden */
  32911. _internalAbstractMeshDataInfo: _InternalAbstractMeshDataInfo;
  32912. /**
  32913. * The culling strategy to use to check whether the mesh must be rendered or not.
  32914. * This value can be changed at any time and will be used on the next render mesh selection.
  32915. * The possible values are :
  32916. * - AbstractMesh.CULLINGSTRATEGY_STANDARD
  32917. * - AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  32918. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION
  32919. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY
  32920. * Please read each static variable documentation to get details about the culling process.
  32921. * */
  32922. cullingStrategy: number;
  32923. /**
  32924. * Gets the number of facets in the mesh
  32925. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#what-is-a-mesh-facet
  32926. */
  32927. get facetNb(): number;
  32928. /**
  32929. * Gets or set the number (integer) of subdivisions per axis in the partioning space
  32930. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#tweaking-the-partitioning
  32931. */
  32932. get partitioningSubdivisions(): number;
  32933. set partitioningSubdivisions(nb: number);
  32934. /**
  32935. * The ratio (float) to apply to the bouding box size to set to the partioning space.
  32936. * Ex : 1.01 (default) the partioning space is 1% bigger than the bounding box
  32937. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#tweaking-the-partitioning
  32938. */
  32939. get partitioningBBoxRatio(): number;
  32940. set partitioningBBoxRatio(ratio: number);
  32941. /**
  32942. * Gets or sets a boolean indicating that the facets must be depth sorted on next call to `updateFacetData()`.
  32943. * Works only for updatable meshes.
  32944. * Doesn't work with multi-materials
  32945. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#facet-depth-sort
  32946. */
  32947. get mustDepthSortFacets(): boolean;
  32948. set mustDepthSortFacets(sort: boolean);
  32949. /**
  32950. * The location (Vector3) where the facet depth sort must be computed from.
  32951. * By default, the active camera position.
  32952. * Used only when facet depth sort is enabled
  32953. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#facet-depth-sort
  32954. */
  32955. get facetDepthSortFrom(): Vector3;
  32956. set facetDepthSortFrom(location: Vector3);
  32957. /**
  32958. * gets a boolean indicating if facetData is enabled
  32959. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#what-is-a-mesh-facet
  32960. */
  32961. get isFacetDataEnabled(): boolean;
  32962. /** @hidden */
  32963. _updateNonUniformScalingState(value: boolean): boolean;
  32964. /**
  32965. * An event triggered when this mesh collides with another one
  32966. */
  32967. onCollideObservable: Observable<AbstractMesh>;
  32968. /** Set a function to call when this mesh collides with another one */
  32969. set onCollide(callback: () => void);
  32970. /**
  32971. * An event triggered when the collision's position changes
  32972. */
  32973. onCollisionPositionChangeObservable: Observable<Vector3>;
  32974. /** Set a function to call when the collision's position changes */
  32975. set onCollisionPositionChange(callback: () => void);
  32976. /**
  32977. * An event triggered when material is changed
  32978. */
  32979. onMaterialChangedObservable: Observable<AbstractMesh>;
  32980. /**
  32981. * Gets or sets the orientation for POV movement & rotation
  32982. */
  32983. definedFacingForward: boolean;
  32984. /** @hidden */
  32985. _occlusionQuery: Nullable<WebGLQuery>;
  32986. /** @hidden */
  32987. _renderingGroup: Nullable<RenderingGroup>;
  32988. /**
  32989. * Gets or sets mesh visibility between 0 and 1 (default is 1)
  32990. */
  32991. get visibility(): number;
  32992. /**
  32993. * Gets or sets mesh visibility between 0 and 1 (default is 1)
  32994. */
  32995. set visibility(value: number);
  32996. /** Gets or sets the alpha index used to sort transparent meshes
  32997. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#alpha-index
  32998. */
  32999. alphaIndex: number;
  33000. /**
  33001. * Gets or sets a boolean indicating if the mesh is visible (renderable). Default is true
  33002. */
  33003. isVisible: boolean;
  33004. /**
  33005. * Gets or sets a boolean indicating if the mesh can be picked (by scene.pick for instance or through actions). Default is true
  33006. */
  33007. isPickable: boolean;
  33008. /** Gets or sets a boolean indicating that bounding boxes of subMeshes must be rendered as well (false by default) */
  33009. showSubMeshesBoundingBox: boolean;
  33010. /** Gets or sets a boolean indicating if the mesh must be considered as a ray blocker for lens flares (false by default)
  33011. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  33012. */
  33013. isBlocker: boolean;
  33014. /**
  33015. * Gets or sets a boolean indicating that pointer move events must be supported on this mesh (false by default)
  33016. */
  33017. enablePointerMoveEvents: boolean;
  33018. /**
  33019. * Specifies the rendering group id for this mesh (0 by default)
  33020. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#rendering-groups
  33021. */
  33022. renderingGroupId: number;
  33023. private _material;
  33024. /** Gets or sets current material */
  33025. get material(): Nullable<Material>;
  33026. set material(value: Nullable<Material>);
  33027. /**
  33028. * Gets or sets a boolean indicating that this mesh can receive realtime shadows
  33029. * @see https://doc.babylonjs.com/babylon101/shadows
  33030. */
  33031. get receiveShadows(): boolean;
  33032. set receiveShadows(value: boolean);
  33033. /** Defines color to use when rendering outline */
  33034. outlineColor: Color3;
  33035. /** Define width to use when rendering outline */
  33036. outlineWidth: number;
  33037. /** Defines color to use when rendering overlay */
  33038. overlayColor: Color3;
  33039. /** Defines alpha to use when rendering overlay */
  33040. overlayAlpha: number;
  33041. /** Gets or sets a boolean indicating that this mesh contains vertex color data with alpha values */
  33042. get hasVertexAlpha(): boolean;
  33043. set hasVertexAlpha(value: boolean);
  33044. /** 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) */
  33045. get useVertexColors(): boolean;
  33046. set useVertexColors(value: boolean);
  33047. /**
  33048. * Gets or sets a boolean indicating that bone animations must be computed by the CPU (false by default)
  33049. */
  33050. get computeBonesUsingShaders(): boolean;
  33051. set computeBonesUsingShaders(value: boolean);
  33052. /** Gets or sets the number of allowed bone influences per vertex (4 by default) */
  33053. get numBoneInfluencers(): number;
  33054. set numBoneInfluencers(value: number);
  33055. /** Gets or sets a boolean indicating that this mesh will allow fog to be rendered on it (true by default) */
  33056. get applyFog(): boolean;
  33057. set applyFog(value: boolean);
  33058. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes selection (true by default) */
  33059. useOctreeForRenderingSelection: boolean;
  33060. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes picking (true by default) */
  33061. useOctreeForPicking: boolean;
  33062. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes collision (true by default) */
  33063. useOctreeForCollisions: boolean;
  33064. /**
  33065. * Gets or sets the current layer mask (default is 0x0FFFFFFF)
  33066. * @see https://doc.babylonjs.com/how_to/layermasks_and_multi-cam_textures
  33067. */
  33068. get layerMask(): number;
  33069. set layerMask(value: number);
  33070. /**
  33071. * True if the mesh must be rendered in any case (this will shortcut the frustum clipping phase)
  33072. */
  33073. alwaysSelectAsActiveMesh: boolean;
  33074. /**
  33075. * Gets or sets a boolean indicating that the bounding info does not need to be kept in sync (for performance reason)
  33076. */
  33077. doNotSyncBoundingInfo: boolean;
  33078. /**
  33079. * Gets or sets the current action manager
  33080. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  33081. */
  33082. actionManager: Nullable<AbstractActionManager>;
  33083. private _meshCollisionData;
  33084. /**
  33085. * Gets or sets the ellipsoid used to impersonate this mesh when using collision engine (default is (0.5, 1, 0.5))
  33086. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  33087. */
  33088. ellipsoid: Vector3;
  33089. /**
  33090. * Gets or sets the ellipsoid offset used to impersonate this mesh when using collision engine (default is (0, 0, 0))
  33091. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  33092. */
  33093. ellipsoidOffset: Vector3;
  33094. /**
  33095. * Gets or sets a collision mask used to mask collisions (default is -1).
  33096. * A collision between A and B will happen if A.collisionGroup & b.collisionMask !== 0
  33097. */
  33098. get collisionMask(): number;
  33099. set collisionMask(mask: number);
  33100. /**
  33101. * Gets or sets the current collision group mask (-1 by default).
  33102. * A collision between A and B will happen if A.collisionGroup & b.collisionMask !== 0
  33103. */
  33104. get collisionGroup(): number;
  33105. set collisionGroup(mask: number);
  33106. /**
  33107. * Gets or sets current surrounding meshes (null by default).
  33108. *
  33109. * By default collision detection is tested against every mesh in the scene.
  33110. * It is possible to set surroundingMeshes to a defined list of meshes and then only these specified
  33111. * meshes will be tested for the collision.
  33112. *
  33113. * Note: if set to an empty array no collision will happen when this mesh is moved.
  33114. */
  33115. get surroundingMeshes(): Nullable<AbstractMesh[]>;
  33116. set surroundingMeshes(meshes: Nullable<AbstractMesh[]>);
  33117. /**
  33118. * Defines edge width used when edgesRenderer is enabled
  33119. * @see https://www.babylonjs-playground.com/#10OJSG#13
  33120. */
  33121. edgesWidth: number;
  33122. /**
  33123. * Defines edge color used when edgesRenderer is enabled
  33124. * @see https://www.babylonjs-playground.com/#10OJSG#13
  33125. */
  33126. edgesColor: Color4;
  33127. /** @hidden */
  33128. _edgesRenderer: Nullable<IEdgesRenderer>;
  33129. /** @hidden */
  33130. _masterMesh: Nullable<AbstractMesh>;
  33131. /** @hidden */
  33132. _boundingInfo: Nullable<BoundingInfo>;
  33133. /** @hidden */
  33134. _renderId: number;
  33135. /**
  33136. * Gets or sets the list of subMeshes
  33137. * @see https://doc.babylonjs.com/how_to/multi_materials
  33138. */
  33139. subMeshes: SubMesh[];
  33140. /** @hidden */
  33141. _intersectionsInProgress: AbstractMesh[];
  33142. /** @hidden */
  33143. _unIndexed: boolean;
  33144. /** @hidden */
  33145. _lightSources: Light[];
  33146. /** Gets the list of lights affecting that mesh */
  33147. get lightSources(): Light[];
  33148. /** @hidden */
  33149. get _positions(): Nullable<Vector3[]>;
  33150. /** @hidden */
  33151. _waitingData: {
  33152. lods: Nullable<any>;
  33153. actions: Nullable<any>;
  33154. freezeWorldMatrix: Nullable<boolean>;
  33155. };
  33156. /** @hidden */
  33157. _bonesTransformMatrices: Nullable<Float32Array>;
  33158. /** @hidden */
  33159. _transformMatrixTexture: Nullable<RawTexture>;
  33160. /**
  33161. * Gets or sets a skeleton to apply skining transformations
  33162. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  33163. */
  33164. set skeleton(value: Nullable<Skeleton>);
  33165. get skeleton(): Nullable<Skeleton>;
  33166. /**
  33167. * An event triggered when the mesh is rebuilt.
  33168. */
  33169. onRebuildObservable: Observable<AbstractMesh>;
  33170. /**
  33171. * Creates a new AbstractMesh
  33172. * @param name defines the name of the mesh
  33173. * @param scene defines the hosting scene
  33174. */
  33175. constructor(name: string, scene?: Nullable<Scene>);
  33176. /**
  33177. * Returns the string "AbstractMesh"
  33178. * @returns "AbstractMesh"
  33179. */
  33180. getClassName(): string;
  33181. /**
  33182. * Gets a string representation of the current mesh
  33183. * @param fullDetails defines a boolean indicating if full details must be included
  33184. * @returns a string representation of the current mesh
  33185. */
  33186. toString(fullDetails?: boolean): string;
  33187. /**
  33188. * @hidden
  33189. */
  33190. protected _getEffectiveParent(): Nullable<Node>;
  33191. /** @hidden */
  33192. _getActionManagerForTrigger(trigger?: number, initialCall?: boolean): Nullable<AbstractActionManager>;
  33193. /** @hidden */
  33194. _rebuild(): void;
  33195. /** @hidden */
  33196. _resyncLightSources(): void;
  33197. /** @hidden */
  33198. _resyncLightSource(light: Light): void;
  33199. /** @hidden */
  33200. _unBindEffect(): void;
  33201. /** @hidden */
  33202. _removeLightSource(light: Light, dispose: boolean): void;
  33203. private _markSubMeshesAsDirty;
  33204. /** @hidden */
  33205. _markSubMeshesAsLightDirty(dispose?: boolean): void;
  33206. /** @hidden */
  33207. _markSubMeshesAsAttributesDirty(): void;
  33208. /** @hidden */
  33209. _markSubMeshesAsMiscDirty(): void;
  33210. /**
  33211. * Gets or sets a Vector3 depicting the mesh scaling along each local axis X, Y, Z. Default is (1.0, 1.0, 1.0)
  33212. */
  33213. get scaling(): Vector3;
  33214. set scaling(newScaling: Vector3);
  33215. /**
  33216. * Returns true if the mesh is blocked. Implemented by child classes
  33217. */
  33218. get isBlocked(): boolean;
  33219. /**
  33220. * Returns the mesh itself by default. Implemented by child classes
  33221. * @param camera defines the camera to use to pick the right LOD level
  33222. * @returns the currentAbstractMesh
  33223. */
  33224. getLOD(camera: Camera): Nullable<AbstractMesh>;
  33225. /**
  33226. * Returns 0 by default. Implemented by child classes
  33227. * @returns an integer
  33228. */
  33229. getTotalVertices(): number;
  33230. /**
  33231. * Returns a positive integer : the total number of indices in this mesh geometry.
  33232. * @returns the numner of indices or zero if the mesh has no geometry.
  33233. */
  33234. getTotalIndices(): number;
  33235. /**
  33236. * Returns null by default. Implemented by child classes
  33237. * @returns null
  33238. */
  33239. getIndices(): Nullable<IndicesArray>;
  33240. /**
  33241. * Returns the array of the requested vertex data kind. Implemented by child classes
  33242. * @param kind defines the vertex data kind to use
  33243. * @returns null
  33244. */
  33245. getVerticesData(kind: string): Nullable<FloatArray>;
  33246. /**
  33247. * Sets the vertex data of the mesh geometry for the requested `kind`.
  33248. * If the mesh has no geometry, a new Geometry object is set to the mesh and then passed this vertex data.
  33249. * Note that a new underlying VertexBuffer object is created each call.
  33250. * If the `kind` is the `PositionKind`, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  33251. * @param kind defines vertex data kind:
  33252. * * VertexBuffer.PositionKind
  33253. * * VertexBuffer.UVKind
  33254. * * VertexBuffer.UV2Kind
  33255. * * VertexBuffer.UV3Kind
  33256. * * VertexBuffer.UV4Kind
  33257. * * VertexBuffer.UV5Kind
  33258. * * VertexBuffer.UV6Kind
  33259. * * VertexBuffer.ColorKind
  33260. * * VertexBuffer.MatricesIndicesKind
  33261. * * VertexBuffer.MatricesIndicesExtraKind
  33262. * * VertexBuffer.MatricesWeightsKind
  33263. * * VertexBuffer.MatricesWeightsExtraKind
  33264. * @param data defines the data source
  33265. * @param updatable defines if the data must be flagged as updatable (or static)
  33266. * @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
  33267. * @returns the current mesh
  33268. */
  33269. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  33270. /**
  33271. * Updates the existing vertex data of the mesh geometry for the requested `kind`.
  33272. * If the mesh has no geometry, it is simply returned as it is.
  33273. * @param kind defines vertex data kind:
  33274. * * VertexBuffer.PositionKind
  33275. * * VertexBuffer.UVKind
  33276. * * VertexBuffer.UV2Kind
  33277. * * VertexBuffer.UV3Kind
  33278. * * VertexBuffer.UV4Kind
  33279. * * VertexBuffer.UV5Kind
  33280. * * VertexBuffer.UV6Kind
  33281. * * VertexBuffer.ColorKind
  33282. * * VertexBuffer.MatricesIndicesKind
  33283. * * VertexBuffer.MatricesIndicesExtraKind
  33284. * * VertexBuffer.MatricesWeightsKind
  33285. * * VertexBuffer.MatricesWeightsExtraKind
  33286. * @param data defines the data source
  33287. * @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
  33288. * @param makeItUnique If true, a new global geometry is created from this data and is set to the mesh
  33289. * @returns the current mesh
  33290. */
  33291. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): AbstractMesh;
  33292. /**
  33293. * Sets the mesh indices,
  33294. * If the mesh has no geometry, a new Geometry object is created and set to the mesh.
  33295. * @param indices Expects an array populated with integers or a typed array (Int32Array, Uint32Array, Uint16Array)
  33296. * @param totalVertices Defines the total number of vertices
  33297. * @returns the current mesh
  33298. */
  33299. setIndices(indices: IndicesArray, totalVertices: Nullable<number>): AbstractMesh;
  33300. /**
  33301. * Gets a boolean indicating if specific vertex data is present
  33302. * @param kind defines the vertex data kind to use
  33303. * @returns true is data kind is present
  33304. */
  33305. isVerticesDataPresent(kind: string): boolean;
  33306. /**
  33307. * Returns the mesh BoundingInfo object or creates a new one and returns if it was undefined.
  33308. * Note that it returns a shallow bounding of the mesh (i.e. it does not include children).
  33309. * To get the full bounding of all children, call `getHierarchyBoundingVectors` instead.
  33310. * @returns a BoundingInfo
  33311. */
  33312. getBoundingInfo(): BoundingInfo;
  33313. /**
  33314. * Uniformly scales the mesh to fit inside of a unit cube (1 X 1 X 1 units)
  33315. * @param includeDescendants Use the hierarchy's bounding box instead of the mesh's bounding box. Default is false
  33316. * @param ignoreRotation ignore rotation when computing the scale (ie. object will be axis aligned). Default is false
  33317. * @param predicate predicate that is passed in to getHierarchyBoundingVectors when selecting which object should be included when scaling
  33318. * @returns the current mesh
  33319. */
  33320. normalizeToUnitCube(includeDescendants?: boolean, ignoreRotation?: boolean, predicate?: Nullable<(node: AbstractMesh) => boolean>): AbstractMesh;
  33321. /**
  33322. * Overwrite the current bounding info
  33323. * @param boundingInfo defines the new bounding info
  33324. * @returns the current mesh
  33325. */
  33326. setBoundingInfo(boundingInfo: BoundingInfo): AbstractMesh;
  33327. /** Gets a boolean indicating if this mesh has skinning data and an attached skeleton */
  33328. get useBones(): boolean;
  33329. /** @hidden */
  33330. _preActivate(): void;
  33331. /** @hidden */
  33332. _preActivateForIntermediateRendering(renderId: number): void;
  33333. /** @hidden */
  33334. _activate(renderId: number, intermediateRendering: boolean): boolean;
  33335. /** @hidden */
  33336. _postActivate(): void;
  33337. /** @hidden */
  33338. _freeze(): void;
  33339. /** @hidden */
  33340. _unFreeze(): void;
  33341. /**
  33342. * Gets the current world matrix
  33343. * @returns a Matrix
  33344. */
  33345. getWorldMatrix(): Matrix;
  33346. /** @hidden */
  33347. _getWorldMatrixDeterminant(): number;
  33348. /**
  33349. * Gets a boolean indicating if this mesh is an instance or a regular mesh
  33350. */
  33351. get isAnInstance(): boolean;
  33352. /**
  33353. * Gets a boolean indicating if this mesh has instances
  33354. */
  33355. get hasInstances(): boolean;
  33356. /**
  33357. * Gets a boolean indicating if this mesh has thin instances
  33358. */
  33359. get hasThinInstances(): boolean;
  33360. /**
  33361. * Perform relative position change from the point of view of behind the front of the mesh.
  33362. * This is performed taking into account the meshes current rotation, so you do not have to care.
  33363. * Supports definition of mesh facing forward or backward
  33364. * @param amountRight defines the distance on the right axis
  33365. * @param amountUp defines the distance on the up axis
  33366. * @param amountForward defines the distance on the forward axis
  33367. * @returns the current mesh
  33368. */
  33369. movePOV(amountRight: number, amountUp: number, amountForward: number): AbstractMesh;
  33370. /**
  33371. * Calculate relative position change from the point of view of behind the front of the mesh.
  33372. * This is performed taking into account the meshes current rotation, so you do not have to care.
  33373. * Supports definition of mesh facing forward or backward
  33374. * @param amountRight defines the distance on the right axis
  33375. * @param amountUp defines the distance on the up axis
  33376. * @param amountForward defines the distance on the forward axis
  33377. * @returns the new displacement vector
  33378. */
  33379. calcMovePOV(amountRight: number, amountUp: number, amountForward: number): Vector3;
  33380. /**
  33381. * Perform relative rotation change from the point of view of behind the front of the mesh.
  33382. * Supports definition of mesh facing forward or backward
  33383. * @param flipBack defines the flip
  33384. * @param twirlClockwise defines the twirl
  33385. * @param tiltRight defines the tilt
  33386. * @returns the current mesh
  33387. */
  33388. rotatePOV(flipBack: number, twirlClockwise: number, tiltRight: number): AbstractMesh;
  33389. /**
  33390. * Calculate relative rotation change from the point of view of behind the front of the mesh.
  33391. * Supports definition of mesh facing forward or backward.
  33392. * @param flipBack defines the flip
  33393. * @param twirlClockwise defines the twirl
  33394. * @param tiltRight defines the tilt
  33395. * @returns the new rotation vector
  33396. */
  33397. calcRotatePOV(flipBack: number, twirlClockwise: number, tiltRight: number): Vector3;
  33398. /**
  33399. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  33400. * This means the mesh underlying bounding box and sphere are recomputed.
  33401. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  33402. * @returns the current mesh
  33403. */
  33404. refreshBoundingInfo(applySkeleton?: boolean): AbstractMesh;
  33405. /** @hidden */
  33406. _refreshBoundingInfo(data: Nullable<FloatArray>, bias: Nullable<Vector2>): void;
  33407. /** @hidden */
  33408. _getPositionData(applySkeleton: boolean): Nullable<FloatArray>;
  33409. /** @hidden */
  33410. _updateBoundingInfo(): AbstractMesh;
  33411. /** @hidden */
  33412. _updateSubMeshesBoundingInfo(matrix: DeepImmutable<Matrix>): AbstractMesh;
  33413. /** @hidden */
  33414. protected _afterComputeWorldMatrix(): void;
  33415. /** @hidden */
  33416. get _effectiveMesh(): AbstractMesh;
  33417. /**
  33418. * Returns `true` if the mesh is within the frustum defined by the passed array of planes.
  33419. * A mesh is in the frustum if its bounding box intersects the frustum
  33420. * @param frustumPlanes defines the frustum to test
  33421. * @returns true if the mesh is in the frustum planes
  33422. */
  33423. isInFrustum(frustumPlanes: Plane[]): boolean;
  33424. /**
  33425. * Returns `true` if the mesh is completely in the frustum defined be the passed array of planes.
  33426. * A mesh is completely in the frustum if its bounding box it completely inside the frustum.
  33427. * @param frustumPlanes defines the frustum to test
  33428. * @returns true if the mesh is completely in the frustum planes
  33429. */
  33430. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  33431. /**
  33432. * True if the mesh intersects another mesh or a SolidParticle object
  33433. * @param mesh defines a target mesh or SolidParticle to test
  33434. * @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)
  33435. * @param includeDescendants Can be set to true to test if the mesh defined in parameters intersects with the current mesh or any child meshes
  33436. * @returns true if there is an intersection
  33437. */
  33438. intersectsMesh(mesh: AbstractMesh | SolidParticle, precise?: boolean, includeDescendants?: boolean): boolean;
  33439. /**
  33440. * Returns true if the passed point (Vector3) is inside the mesh bounding box
  33441. * @param point defines the point to test
  33442. * @returns true if there is an intersection
  33443. */
  33444. intersectsPoint(point: Vector3): boolean;
  33445. /**
  33446. * Gets or sets a boolean indicating that this mesh can be used in the collision engine
  33447. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  33448. */
  33449. get checkCollisions(): boolean;
  33450. set checkCollisions(collisionEnabled: boolean);
  33451. /**
  33452. * Gets Collider object used to compute collisions (not physics)
  33453. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  33454. */
  33455. get collider(): Nullable<Collider>;
  33456. /**
  33457. * Move the mesh using collision engine
  33458. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  33459. * @param displacement defines the requested displacement vector
  33460. * @returns the current mesh
  33461. */
  33462. moveWithCollisions(displacement: Vector3): AbstractMesh;
  33463. private _onCollisionPositionChange;
  33464. /** @hidden */
  33465. _collideForSubMesh(subMesh: SubMesh, transformMatrix: Matrix, collider: Collider): AbstractMesh;
  33466. /** @hidden */
  33467. _processCollisionsForSubMeshes(collider: Collider, transformMatrix: Matrix): AbstractMesh;
  33468. /** @hidden */
  33469. _checkCollision(collider: Collider): AbstractMesh;
  33470. /** @hidden */
  33471. _generatePointsArray(): boolean;
  33472. /**
  33473. * Checks if the passed Ray intersects with the mesh
  33474. * @param ray defines the ray to use
  33475. * @param fastCheck defines if fast mode (but less precise) must be used (false by default)
  33476. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  33477. * @param onlyBoundingInfo defines a boolean indicating if picking should only happen using bounding info (false by default)
  33478. * @returns the picking info
  33479. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  33480. */
  33481. intersects(ray: Ray, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate, onlyBoundingInfo?: boolean): PickingInfo;
  33482. /**
  33483. * Clones the current mesh
  33484. * @param name defines the mesh name
  33485. * @param newParent defines the new mesh parent
  33486. * @param doNotCloneChildren defines a boolean indicating that children must not be cloned (false by default)
  33487. * @returns the new mesh
  33488. */
  33489. clone(name: string, newParent: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<AbstractMesh>;
  33490. /**
  33491. * Disposes all the submeshes of the current meshnp
  33492. * @returns the current mesh
  33493. */
  33494. releaseSubMeshes(): AbstractMesh;
  33495. /**
  33496. * Releases resources associated with this abstract mesh.
  33497. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  33498. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  33499. */
  33500. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  33501. /**
  33502. * Adds the passed mesh as a child to the current mesh
  33503. * @param mesh defines the child mesh
  33504. * @returns the current mesh
  33505. */
  33506. addChild(mesh: AbstractMesh): AbstractMesh;
  33507. /**
  33508. * Removes the passed mesh from the current mesh children list
  33509. * @param mesh defines the child mesh
  33510. * @returns the current mesh
  33511. */
  33512. removeChild(mesh: AbstractMesh): AbstractMesh;
  33513. /** @hidden */
  33514. private _initFacetData;
  33515. /**
  33516. * Updates the mesh facetData arrays and the internal partitioning when the mesh is morphed or updated.
  33517. * This method can be called within the render loop.
  33518. * 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
  33519. * @returns the current mesh
  33520. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33521. */
  33522. updateFacetData(): AbstractMesh;
  33523. /**
  33524. * Returns the facetLocalNormals array.
  33525. * The normals are expressed in the mesh local spac
  33526. * @returns an array of Vector3
  33527. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33528. */
  33529. getFacetLocalNormals(): Vector3[];
  33530. /**
  33531. * Returns the facetLocalPositions array.
  33532. * The facet positions are expressed in the mesh local space
  33533. * @returns an array of Vector3
  33534. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33535. */
  33536. getFacetLocalPositions(): Vector3[];
  33537. /**
  33538. * Returns the facetLocalPartioning array
  33539. * @returns an array of array of numbers
  33540. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33541. */
  33542. getFacetLocalPartitioning(): number[][];
  33543. /**
  33544. * Returns the i-th facet position in the world system.
  33545. * This method allocates a new Vector3 per call
  33546. * @param i defines the facet index
  33547. * @returns a new Vector3
  33548. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33549. */
  33550. getFacetPosition(i: number): Vector3;
  33551. /**
  33552. * Sets the reference Vector3 with the i-th facet position in the world system
  33553. * @param i defines the facet index
  33554. * @param ref defines the target vector
  33555. * @returns the current mesh
  33556. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33557. */
  33558. getFacetPositionToRef(i: number, ref: Vector3): AbstractMesh;
  33559. /**
  33560. * Returns the i-th facet normal in the world system.
  33561. * This method allocates a new Vector3 per call
  33562. * @param i defines the facet index
  33563. * @returns a new Vector3
  33564. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33565. */
  33566. getFacetNormal(i: number): Vector3;
  33567. /**
  33568. * Sets the reference Vector3 with the i-th facet normal in the world system
  33569. * @param i defines the facet index
  33570. * @param ref defines the target vector
  33571. * @returns the current mesh
  33572. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33573. */
  33574. getFacetNormalToRef(i: number, ref: Vector3): this;
  33575. /**
  33576. * 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)
  33577. * @param x defines x coordinate
  33578. * @param y defines y coordinate
  33579. * @param z defines z coordinate
  33580. * @returns the array of facet indexes
  33581. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33582. */
  33583. getFacetsAtLocalCoordinates(x: number, y: number, z: number): Nullable<number[]>;
  33584. /**
  33585. * Returns the closest mesh facet index at (x,y,z) World coordinates, null if not found
  33586. * @param projected sets as the (x,y,z) world projection on the facet
  33587. * @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
  33588. * @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
  33589. * @param x defines x coordinate
  33590. * @param y defines y coordinate
  33591. * @param z defines z coordinate
  33592. * @returns the face index if found (or null instead)
  33593. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33594. */
  33595. getClosestFacetAtCoordinates(x: number, y: number, z: number, projected?: Vector3, checkFace?: boolean, facing?: boolean): Nullable<number>;
  33596. /**
  33597. * Returns the closest mesh facet index at (x,y,z) local coordinates, null if not found
  33598. * @param projected sets as the (x,y,z) local projection on the facet
  33599. * @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
  33600. * @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
  33601. * @param x defines x coordinate
  33602. * @param y defines y coordinate
  33603. * @param z defines z coordinate
  33604. * @returns the face index if found (or null instead)
  33605. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33606. */
  33607. getClosestFacetAtLocalCoordinates(x: number, y: number, z: number, projected?: Vector3, checkFace?: boolean, facing?: boolean): Nullable<number>;
  33608. /**
  33609. * Returns the object "parameter" set with all the expected parameters for facetData computation by ComputeNormals()
  33610. * @returns the parameters
  33611. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33612. */
  33613. getFacetDataParameters(): any;
  33614. /**
  33615. * Disables the feature FacetData and frees the related memory
  33616. * @returns the current mesh
  33617. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33618. */
  33619. disableFacetData(): AbstractMesh;
  33620. /**
  33621. * Updates the AbstractMesh indices array
  33622. * @param indices defines the data source
  33623. * @param offset defines the offset in the index buffer where to store the new data (can be null)
  33624. * @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)
  33625. * @returns the current mesh
  33626. */
  33627. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): AbstractMesh;
  33628. /**
  33629. * Creates new normals data for the mesh
  33630. * @param updatable defines if the normal vertex buffer must be flagged as updatable
  33631. * @returns the current mesh
  33632. */
  33633. createNormals(updatable: boolean): AbstractMesh;
  33634. /**
  33635. * Align the mesh with a normal
  33636. * @param normal defines the normal to use
  33637. * @param upDirection can be used to redefined the up vector to use (will use the (0, 1, 0) by default)
  33638. * @returns the current mesh
  33639. */
  33640. alignWithNormal(normal: Vector3, upDirection?: Vector3): AbstractMesh;
  33641. /** @hidden */
  33642. _checkOcclusionQuery(): boolean;
  33643. /**
  33644. * Disables the mesh edge rendering mode
  33645. * @returns the currentAbstractMesh
  33646. */
  33647. disableEdgesRendering(): AbstractMesh;
  33648. /**
  33649. * Enables the edge rendering mode on the mesh.
  33650. * This mode makes the mesh edges visible
  33651. * @param epsilon defines the maximal distance between two angles to detect a face
  33652. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  33653. * @returns the currentAbstractMesh
  33654. * @see https://www.babylonjs-playground.com/#19O9TU#0
  33655. */
  33656. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): AbstractMesh;
  33657. /**
  33658. * This function returns all of the particle systems in the scene that use the mesh as an emitter.
  33659. * @returns an array of particle systems in the scene that use the mesh as an emitter
  33660. */
  33661. getConnectedParticleSystems(): IParticleSystem[];
  33662. }
  33663. }
  33664. declare module "babylonjs/Actions/actionEvent" {
  33665. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  33666. import { Nullable } from "babylonjs/types";
  33667. import { Sprite } from "babylonjs/Sprites/sprite";
  33668. import { Scene } from "babylonjs/scene";
  33669. import { Vector2 } from "babylonjs/Maths/math.vector";
  33670. /**
  33671. * Interface used to define ActionEvent
  33672. */
  33673. export interface IActionEvent {
  33674. /** The mesh or sprite that triggered the action */
  33675. source: any;
  33676. /** The X mouse cursor position at the time of the event */
  33677. pointerX: number;
  33678. /** The Y mouse cursor position at the time of the event */
  33679. pointerY: number;
  33680. /** The mesh that is currently pointed at (can be null) */
  33681. meshUnderPointer: Nullable<AbstractMesh>;
  33682. /** the original (browser) event that triggered the ActionEvent */
  33683. sourceEvent?: any;
  33684. /** additional data for the event */
  33685. additionalData?: any;
  33686. }
  33687. /**
  33688. * ActionEvent is the event being sent when an action is triggered.
  33689. */
  33690. export class ActionEvent implements IActionEvent {
  33691. /** The mesh or sprite that triggered the action */
  33692. source: any;
  33693. /** The X mouse cursor position at the time of the event */
  33694. pointerX: number;
  33695. /** The Y mouse cursor position at the time of the event */
  33696. pointerY: number;
  33697. /** The mesh that is currently pointed at (can be null) */
  33698. meshUnderPointer: Nullable<AbstractMesh>;
  33699. /** the original (browser) event that triggered the ActionEvent */
  33700. sourceEvent?: any;
  33701. /** additional data for the event */
  33702. additionalData?: any;
  33703. /**
  33704. * Creates a new ActionEvent
  33705. * @param source The mesh or sprite that triggered the action
  33706. * @param pointerX The X mouse cursor position at the time of the event
  33707. * @param pointerY The Y mouse cursor position at the time of the event
  33708. * @param meshUnderPointer The mesh that is currently pointed at (can be null)
  33709. * @param sourceEvent the original (browser) event that triggered the ActionEvent
  33710. * @param additionalData additional data for the event
  33711. */
  33712. constructor(
  33713. /** The mesh or sprite that triggered the action */
  33714. source: any,
  33715. /** The X mouse cursor position at the time of the event */
  33716. pointerX: number,
  33717. /** The Y mouse cursor position at the time of the event */
  33718. pointerY: number,
  33719. /** The mesh that is currently pointed at (can be null) */
  33720. meshUnderPointer: Nullable<AbstractMesh>,
  33721. /** the original (browser) event that triggered the ActionEvent */
  33722. sourceEvent?: any,
  33723. /** additional data for the event */
  33724. additionalData?: any);
  33725. /**
  33726. * Helper function to auto-create an ActionEvent from a source mesh.
  33727. * @param source The source mesh that triggered the event
  33728. * @param evt The original (browser) event
  33729. * @param additionalData additional data for the event
  33730. * @returns the new ActionEvent
  33731. */
  33732. static CreateNew(source: AbstractMesh, evt?: Event, additionalData?: any): ActionEvent;
  33733. /**
  33734. * Helper function to auto-create an ActionEvent from a source sprite
  33735. * @param source The source sprite that triggered the event
  33736. * @param scene Scene associated with the sprite
  33737. * @param evt The original (browser) event
  33738. * @param additionalData additional data for the event
  33739. * @returns the new ActionEvent
  33740. */
  33741. static CreateNewFromSprite(source: Sprite, scene: Scene, evt?: Event, additionalData?: any): ActionEvent;
  33742. /**
  33743. * Helper function to auto-create an ActionEvent from a scene. If triggered by a mesh use ActionEvent.CreateNew
  33744. * @param scene the scene where the event occurred
  33745. * @param evt The original (browser) event
  33746. * @returns the new ActionEvent
  33747. */
  33748. static CreateNewFromScene(scene: Scene, evt: Event): ActionEvent;
  33749. /**
  33750. * Helper function to auto-create an ActionEvent from a primitive
  33751. * @param prim defines the target primitive
  33752. * @param pointerPos defines the pointer position
  33753. * @param evt The original (browser) event
  33754. * @param additionalData additional data for the event
  33755. * @returns the new ActionEvent
  33756. */
  33757. static CreateNewFromPrimitive(prim: any, pointerPos: Vector2, evt?: Event, additionalData?: any): ActionEvent;
  33758. }
  33759. }
  33760. declare module "babylonjs/Actions/abstractActionManager" {
  33761. import { IDisposable } from "babylonjs/scene";
  33762. import { IActionEvent } from "babylonjs/Actions/actionEvent";
  33763. import { IAction } from "babylonjs/Actions/action";
  33764. import { Nullable } from "babylonjs/types";
  33765. /**
  33766. * Abstract class used to decouple action Manager from scene and meshes.
  33767. * Do not instantiate.
  33768. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  33769. */
  33770. export abstract class AbstractActionManager implements IDisposable {
  33771. /** Gets the list of active triggers */
  33772. static Triggers: {
  33773. [key: string]: number;
  33774. };
  33775. /** Gets the cursor to use when hovering items */
  33776. hoverCursor: string;
  33777. /** Gets the list of actions */
  33778. actions: IAction[];
  33779. /**
  33780. * Gets or sets a boolean indicating that the manager is recursive meaning that it can trigger action from children
  33781. */
  33782. isRecursive: boolean;
  33783. /**
  33784. * Releases all associated resources
  33785. */
  33786. abstract dispose(): void;
  33787. /**
  33788. * Does this action manager has pointer triggers
  33789. */
  33790. abstract get hasPointerTriggers(): boolean;
  33791. /**
  33792. * Does this action manager has pick triggers
  33793. */
  33794. abstract get hasPickTriggers(): boolean;
  33795. /**
  33796. * Process a specific trigger
  33797. * @param trigger defines the trigger to process
  33798. * @param evt defines the event details to be processed
  33799. */
  33800. abstract processTrigger(trigger: number, evt?: IActionEvent): void;
  33801. /**
  33802. * Does this action manager handles actions of any of the given triggers
  33803. * @param triggers defines the triggers to be tested
  33804. * @return a boolean indicating whether one (or more) of the triggers is handled
  33805. */
  33806. abstract hasSpecificTriggers(triggers: number[]): boolean;
  33807. /**
  33808. * Does this action manager handles actions of any of the given triggers. This function takes two arguments for
  33809. * speed.
  33810. * @param triggerA defines the trigger to be tested
  33811. * @param triggerB defines the trigger to be tested
  33812. * @return a boolean indicating whether one (or more) of the triggers is handled
  33813. */
  33814. abstract hasSpecificTriggers2(triggerA: number, triggerB: number): boolean;
  33815. /**
  33816. * Does this action manager handles actions of a given trigger
  33817. * @param trigger defines the trigger to be tested
  33818. * @param parameterPredicate defines an optional predicate to filter triggers by parameter
  33819. * @return whether the trigger is handled
  33820. */
  33821. abstract hasSpecificTrigger(trigger: number, parameterPredicate?: (parameter: any) => boolean): boolean;
  33822. /**
  33823. * Serialize this manager to a JSON object
  33824. * @param name defines the property name to store this manager
  33825. * @returns a JSON representation of this manager
  33826. */
  33827. abstract serialize(name: string): any;
  33828. /**
  33829. * Registers an action to this action manager
  33830. * @param action defines the action to be registered
  33831. * @return the action amended (prepared) after registration
  33832. */
  33833. abstract registerAction(action: IAction): Nullable<IAction>;
  33834. /**
  33835. * Unregisters an action to this action manager
  33836. * @param action defines the action to be unregistered
  33837. * @return a boolean indicating whether the action has been unregistered
  33838. */
  33839. abstract unregisterAction(action: IAction): Boolean;
  33840. /**
  33841. * Does exist one action manager with at least one trigger
  33842. **/
  33843. static get HasTriggers(): boolean;
  33844. /**
  33845. * Does exist one action manager with at least one pick trigger
  33846. **/
  33847. static get HasPickTriggers(): boolean;
  33848. /**
  33849. * Does exist one action manager that handles actions of a given trigger
  33850. * @param trigger defines the trigger to be tested
  33851. * @return a boolean indicating whether the trigger is handeled by at least one action manager
  33852. **/
  33853. static HasSpecificTrigger(trigger: number): boolean;
  33854. }
  33855. }
  33856. declare module "babylonjs/node" {
  33857. import { Scene } from "babylonjs/scene";
  33858. import { Nullable } from "babylonjs/types";
  33859. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  33860. import { Engine } from "babylonjs/Engines/engine";
  33861. import { IBehaviorAware, Behavior } from "babylonjs/Behaviors/behavior";
  33862. import { Observable } from "babylonjs/Misc/observable";
  33863. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  33864. import { IInspectable } from "babylonjs/Misc/iInspectable";
  33865. import { Animatable } from "babylonjs/Animations/animatable";
  33866. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  33867. import { Animation } from "babylonjs/Animations/animation";
  33868. import { AnimationRange } from "babylonjs/Animations/animationRange";
  33869. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  33870. /**
  33871. * Defines how a node can be built from a string name.
  33872. */
  33873. export type NodeConstructor = (name: string, scene: Scene, options?: any) => () => Node;
  33874. /**
  33875. * Node is the basic class for all scene objects (Mesh, Light, Camera.)
  33876. */
  33877. export class Node implements IBehaviorAware<Node> {
  33878. /** @hidden */
  33879. static _AnimationRangeFactory: (name: string, from: number, to: number) => AnimationRange;
  33880. private static _NodeConstructors;
  33881. /**
  33882. * Add a new node constructor
  33883. * @param type defines the type name of the node to construct
  33884. * @param constructorFunc defines the constructor function
  33885. */
  33886. static AddNodeConstructor(type: string, constructorFunc: NodeConstructor): void;
  33887. /**
  33888. * Returns a node constructor based on type name
  33889. * @param type defines the type name
  33890. * @param name defines the new node name
  33891. * @param scene defines the hosting scene
  33892. * @param options defines optional options to transmit to constructors
  33893. * @returns the new constructor or null
  33894. */
  33895. static Construct(type: string, name: string, scene: Scene, options?: any): Nullable<() => Node>;
  33896. /**
  33897. * Gets or sets the name of the node
  33898. */
  33899. name: string;
  33900. /**
  33901. * Gets or sets the id of the node
  33902. */
  33903. id: string;
  33904. /**
  33905. * Gets or sets the unique id of the node
  33906. */
  33907. uniqueId: number;
  33908. /**
  33909. * Gets or sets a string used to store user defined state for the node
  33910. */
  33911. state: string;
  33912. /**
  33913. * Gets or sets an object used to store user defined information for the node
  33914. */
  33915. metadata: any;
  33916. /**
  33917. * For internal use only. Please do not use.
  33918. */
  33919. reservedDataStore: any;
  33920. /**
  33921. * List of inspectable custom properties (used by the Inspector)
  33922. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  33923. */
  33924. inspectableCustomProperties: IInspectable[];
  33925. private _doNotSerialize;
  33926. /**
  33927. * Gets or sets a boolean used to define if the node must be serialized
  33928. */
  33929. get doNotSerialize(): boolean;
  33930. set doNotSerialize(value: boolean);
  33931. /** @hidden */
  33932. _isDisposed: boolean;
  33933. /**
  33934. * Gets a list of Animations associated with the node
  33935. */
  33936. animations: import("babylonjs/Animations/animation").Animation[];
  33937. protected _ranges: {
  33938. [name: string]: Nullable<AnimationRange>;
  33939. };
  33940. /**
  33941. * Callback raised when the node is ready to be used
  33942. */
  33943. onReady: Nullable<(node: Node) => void>;
  33944. private _isEnabled;
  33945. private _isParentEnabled;
  33946. private _isReady;
  33947. /** @hidden */
  33948. _currentRenderId: number;
  33949. private _parentUpdateId;
  33950. /** @hidden */
  33951. _childUpdateId: number;
  33952. /** @hidden */
  33953. _waitingParentId: Nullable<string>;
  33954. /** @hidden */
  33955. _scene: Scene;
  33956. /** @hidden */
  33957. _cache: any;
  33958. private _parentNode;
  33959. private _children;
  33960. /** @hidden */
  33961. _worldMatrix: Matrix;
  33962. /** @hidden */
  33963. _worldMatrixDeterminant: number;
  33964. /** @hidden */
  33965. _worldMatrixDeterminantIsDirty: boolean;
  33966. /** @hidden */
  33967. private _sceneRootNodesIndex;
  33968. /**
  33969. * Gets a boolean indicating if the node has been disposed
  33970. * @returns true if the node was disposed
  33971. */
  33972. isDisposed(): boolean;
  33973. /**
  33974. * Gets or sets the parent of the node (without keeping the current position in the scene)
  33975. * @see https://doc.babylonjs.com/how_to/parenting
  33976. */
  33977. set parent(parent: Nullable<Node>);
  33978. get parent(): Nullable<Node>;
  33979. /** @hidden */
  33980. _addToSceneRootNodes(): void;
  33981. /** @hidden */
  33982. _removeFromSceneRootNodes(): void;
  33983. private _animationPropertiesOverride;
  33984. /**
  33985. * Gets or sets the animation properties override
  33986. */
  33987. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  33988. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  33989. /**
  33990. * Gets a string idenfifying the name of the class
  33991. * @returns "Node" string
  33992. */
  33993. getClassName(): string;
  33994. /** @hidden */
  33995. readonly _isNode: boolean;
  33996. /**
  33997. * An event triggered when the mesh is disposed
  33998. */
  33999. onDisposeObservable: Observable<Node>;
  34000. private _onDisposeObserver;
  34001. /**
  34002. * Sets a callback that will be raised when the node will be disposed
  34003. */
  34004. set onDispose(callback: () => void);
  34005. /**
  34006. * Creates a new Node
  34007. * @param name the name and id to be given to this node
  34008. * @param scene the scene this node will be added to
  34009. */
  34010. constructor(name: string, scene?: Nullable<Scene>);
  34011. /**
  34012. * Gets the scene of the node
  34013. * @returns a scene
  34014. */
  34015. getScene(): Scene;
  34016. /**
  34017. * Gets the engine of the node
  34018. * @returns a Engine
  34019. */
  34020. getEngine(): Engine;
  34021. private _behaviors;
  34022. /**
  34023. * Attach a behavior to the node
  34024. * @see https://doc.babylonjs.com/features/behaviour
  34025. * @param behavior defines the behavior to attach
  34026. * @param attachImmediately defines that the behavior must be attached even if the scene is still loading
  34027. * @returns the current Node
  34028. */
  34029. addBehavior(behavior: Behavior<Node>, attachImmediately?: boolean): Node;
  34030. /**
  34031. * Remove an attached behavior
  34032. * @see https://doc.babylonjs.com/features/behaviour
  34033. * @param behavior defines the behavior to attach
  34034. * @returns the current Node
  34035. */
  34036. removeBehavior(behavior: Behavior<Node>): Node;
  34037. /**
  34038. * Gets the list of attached behaviors
  34039. * @see https://doc.babylonjs.com/features/behaviour
  34040. */
  34041. get behaviors(): Behavior<Node>[];
  34042. /**
  34043. * Gets an attached behavior by name
  34044. * @param name defines the name of the behavior to look for
  34045. * @see https://doc.babylonjs.com/features/behaviour
  34046. * @returns null if behavior was not found else the requested behavior
  34047. */
  34048. getBehaviorByName(name: string): Nullable<Behavior<Node>>;
  34049. /**
  34050. * Returns the latest update of the World matrix
  34051. * @returns a Matrix
  34052. */
  34053. getWorldMatrix(): Matrix;
  34054. /** @hidden */
  34055. _getWorldMatrixDeterminant(): number;
  34056. /**
  34057. * Returns directly the latest state of the mesh World matrix.
  34058. * A Matrix is returned.
  34059. */
  34060. get worldMatrixFromCache(): Matrix;
  34061. /** @hidden */
  34062. _initCache(): void;
  34063. /** @hidden */
  34064. updateCache(force?: boolean): void;
  34065. /** @hidden */
  34066. _getActionManagerForTrigger(trigger?: number, initialCall?: boolean): Nullable<AbstractActionManager>;
  34067. /** @hidden */
  34068. _updateCache(ignoreParentClass?: boolean): void;
  34069. /** @hidden */
  34070. _isSynchronized(): boolean;
  34071. /** @hidden */
  34072. _markSyncedWithParent(): void;
  34073. /** @hidden */
  34074. isSynchronizedWithParent(): boolean;
  34075. /** @hidden */
  34076. isSynchronized(): boolean;
  34077. /**
  34078. * Is this node ready to be used/rendered
  34079. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  34080. * @return true if the node is ready
  34081. */
  34082. isReady(completeCheck?: boolean): boolean;
  34083. /**
  34084. * Is this node enabled?
  34085. * 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
  34086. * @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
  34087. * @return whether this node (and its parent) is enabled
  34088. */
  34089. isEnabled(checkAncestors?: boolean): boolean;
  34090. /** @hidden */
  34091. protected _syncParentEnabledState(): void;
  34092. /**
  34093. * Set the enabled state of this node
  34094. * @param value defines the new enabled state
  34095. */
  34096. setEnabled(value: boolean): void;
  34097. /**
  34098. * Is this node a descendant of the given node?
  34099. * The function will iterate up the hierarchy until the ancestor was found or no more parents defined
  34100. * @param ancestor defines the parent node to inspect
  34101. * @returns a boolean indicating if this node is a descendant of the given node
  34102. */
  34103. isDescendantOf(ancestor: Node): boolean;
  34104. /** @hidden */
  34105. _getDescendants(results: Node[], directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): void;
  34106. /**
  34107. * Will return all nodes that have this node as ascendant
  34108. * @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
  34109. * @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
  34110. * @return all children nodes of all types
  34111. */
  34112. getDescendants(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): Node[];
  34113. /**
  34114. * Get all child-meshes of this node
  34115. * @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)
  34116. * @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
  34117. * @returns an array of AbstractMesh
  34118. */
  34119. getChildMeshes(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): AbstractMesh[];
  34120. /**
  34121. * Get all direct children of this node
  34122. * @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
  34123. * @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)
  34124. * @returns an array of Node
  34125. */
  34126. getChildren(predicate?: (node: Node) => boolean, directDescendantsOnly?: boolean): Node[];
  34127. /** @hidden */
  34128. _setReady(state: boolean): void;
  34129. /**
  34130. * Get an animation by name
  34131. * @param name defines the name of the animation to look for
  34132. * @returns null if not found else the requested animation
  34133. */
  34134. getAnimationByName(name: string): Nullable<Animation>;
  34135. /**
  34136. * Creates an animation range for this node
  34137. * @param name defines the name of the range
  34138. * @param from defines the starting key
  34139. * @param to defines the end key
  34140. */
  34141. createAnimationRange(name: string, from: number, to: number): void;
  34142. /**
  34143. * Delete a specific animation range
  34144. * @param name defines the name of the range to delete
  34145. * @param deleteFrames defines if animation frames from the range must be deleted as well
  34146. */
  34147. deleteAnimationRange(name: string, deleteFrames?: boolean): void;
  34148. /**
  34149. * Get an animation range by name
  34150. * @param name defines the name of the animation range to look for
  34151. * @returns null if not found else the requested animation range
  34152. */
  34153. getAnimationRange(name: string): Nullable<AnimationRange>;
  34154. /**
  34155. * Gets the list of all animation ranges defined on this node
  34156. * @returns an array
  34157. */
  34158. getAnimationRanges(): Nullable<AnimationRange>[];
  34159. /**
  34160. * Will start the animation sequence
  34161. * @param name defines the range frames for animation sequence
  34162. * @param loop defines if the animation should loop (false by default)
  34163. * @param speedRatio defines the speed factor in which to run the animation (1 by default)
  34164. * @param onAnimationEnd defines a function to be executed when the animation ended (undefined by default)
  34165. * @returns the object created for this animation. If range does not exist, it will return null
  34166. */
  34167. beginAnimation(name: string, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void): Nullable<Animatable>;
  34168. /**
  34169. * Serialize animation ranges into a JSON compatible object
  34170. * @returns serialization object
  34171. */
  34172. serializeAnimationRanges(): any;
  34173. /**
  34174. * Computes the world matrix of the node
  34175. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  34176. * @returns the world matrix
  34177. */
  34178. computeWorldMatrix(force?: boolean): Matrix;
  34179. /**
  34180. * Releases resources associated with this node.
  34181. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  34182. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  34183. */
  34184. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  34185. /**
  34186. * Parse animation range data from a serialization object and store them into a given node
  34187. * @param node defines where to store the animation ranges
  34188. * @param parsedNode defines the serialization object to read data from
  34189. * @param scene defines the hosting scene
  34190. */
  34191. static ParseAnimationRanges(node: Node, parsedNode: any, scene: Scene): void;
  34192. /**
  34193. * Return the minimum and maximum world vectors of the entire hierarchy under current node
  34194. * @param includeDescendants Include bounding info from descendants as well (true by default)
  34195. * @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
  34196. * @returns the new bounding vectors
  34197. */
  34198. getHierarchyBoundingVectors(includeDescendants?: boolean, predicate?: Nullable<(abstractMesh: AbstractMesh) => boolean>): {
  34199. min: Vector3;
  34200. max: Vector3;
  34201. };
  34202. }
  34203. }
  34204. declare module "babylonjs/Animations/animation" {
  34205. import { IEasingFunction, EasingFunction } from "babylonjs/Animations/easing";
  34206. import { Vector3, Quaternion, Vector2, Matrix } from "babylonjs/Maths/math.vector";
  34207. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  34208. import { Nullable } from "babylonjs/types";
  34209. import { Scene } from "babylonjs/scene";
  34210. import { IAnimationKey } from "babylonjs/Animations/animationKey";
  34211. import { AnimationRange } from "babylonjs/Animations/animationRange";
  34212. import { AnimationEvent } from "babylonjs/Animations/animationEvent";
  34213. import { Node } from "babylonjs/node";
  34214. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  34215. import { Size } from "babylonjs/Maths/math.size";
  34216. import { Animatable } from "babylonjs/Animations/animatable";
  34217. import { RuntimeAnimation } from "babylonjs/Animations/runtimeAnimation";
  34218. /**
  34219. * @hidden
  34220. */
  34221. export class _IAnimationState {
  34222. key: number;
  34223. repeatCount: number;
  34224. workValue?: any;
  34225. loopMode?: number;
  34226. offsetValue?: any;
  34227. highLimitValue?: any;
  34228. }
  34229. /**
  34230. * Class used to store any kind of animation
  34231. */
  34232. export class Animation {
  34233. /**Name of the animation */
  34234. name: string;
  34235. /**Property to animate */
  34236. targetProperty: string;
  34237. /**The frames per second of the animation */
  34238. framePerSecond: number;
  34239. /**The data type of the animation */
  34240. dataType: number;
  34241. /**The loop mode of the animation */
  34242. loopMode?: number | undefined;
  34243. /**Specifies if blending should be enabled */
  34244. enableBlending?: boolean | undefined;
  34245. /**
  34246. * Use matrix interpolation instead of using direct key value when animating matrices
  34247. */
  34248. static AllowMatricesInterpolation: boolean;
  34249. /**
  34250. * When matrix interpolation is enabled, this boolean forces the system to use Matrix.DecomposeLerp instead of Matrix.Lerp. Interpolation is more precise but slower
  34251. */
  34252. static AllowMatrixDecomposeForInterpolation: boolean;
  34253. /** Define the Url to load snippets */
  34254. static SnippetUrl: string;
  34255. /** Snippet ID if the animation was created from the snippet server */
  34256. snippetId: string;
  34257. /**
  34258. * Stores the key frames of the animation
  34259. */
  34260. private _keys;
  34261. /**
  34262. * Stores the easing function of the animation
  34263. */
  34264. private _easingFunction;
  34265. /**
  34266. * @hidden Internal use only
  34267. */
  34268. _runtimeAnimations: import("babylonjs/Animations/runtimeAnimation").RuntimeAnimation[];
  34269. /**
  34270. * The set of event that will be linked to this animation
  34271. */
  34272. private _events;
  34273. /**
  34274. * Stores an array of target property paths
  34275. */
  34276. targetPropertyPath: string[];
  34277. /**
  34278. * Stores the blending speed of the animation
  34279. */
  34280. blendingSpeed: number;
  34281. /**
  34282. * Stores the animation ranges for the animation
  34283. */
  34284. private _ranges;
  34285. /**
  34286. * @hidden Internal use
  34287. */
  34288. static _PrepareAnimation(name: string, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction): Nullable<Animation>;
  34289. /**
  34290. * Sets up an animation
  34291. * @param property The property to animate
  34292. * @param animationType The animation type to apply
  34293. * @param framePerSecond The frames per second of the animation
  34294. * @param easingFunction The easing function used in the animation
  34295. * @returns The created animation
  34296. */
  34297. static CreateAnimation(property: string, animationType: number, framePerSecond: number, easingFunction: EasingFunction): Animation;
  34298. /**
  34299. * Create and start an animation on a node
  34300. * @param name defines the name of the global animation that will be run on all nodes
  34301. * @param node defines the root node where the animation will take place
  34302. * @param targetProperty defines property to animate
  34303. * @param framePerSecond defines the number of frame per second yo use
  34304. * @param totalFrame defines the number of frames in total
  34305. * @param from defines the initial value
  34306. * @param to defines the final value
  34307. * @param loopMode defines which loop mode you want to use (off by default)
  34308. * @param easingFunction defines the easing function to use (linear by default)
  34309. * @param onAnimationEnd defines the callback to call when animation end
  34310. * @returns the animatable created for this animation
  34311. */
  34312. static CreateAndStartAnimation(name: string, node: Node, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction, onAnimationEnd?: () => void): Nullable<Animatable>;
  34313. /**
  34314. * Create and start an animation on a node and its descendants
  34315. * @param name defines the name of the global animation that will be run on all nodes
  34316. * @param node defines the root node where the animation will take place
  34317. * @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
  34318. * @param targetProperty defines property to animate
  34319. * @param framePerSecond defines the number of frame per second to use
  34320. * @param totalFrame defines the number of frames in total
  34321. * @param from defines the initial value
  34322. * @param to defines the final value
  34323. * @param loopMode defines which loop mode you want to use (off by default)
  34324. * @param easingFunction defines the easing function to use (linear by default)
  34325. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  34326. * @returns the list of animatables created for all nodes
  34327. * @example https://www.babylonjs-playground.com/#MH0VLI
  34328. */
  34329. 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[]>;
  34330. /**
  34331. * Creates a new animation, merges it with the existing animations and starts it
  34332. * @param name Name of the animation
  34333. * @param node Node which contains the scene that begins the animations
  34334. * @param targetProperty Specifies which property to animate
  34335. * @param framePerSecond The frames per second of the animation
  34336. * @param totalFrame The total number of frames
  34337. * @param from The frame at the beginning of the animation
  34338. * @param to The frame at the end of the animation
  34339. * @param loopMode Specifies the loop mode of the animation
  34340. * @param easingFunction (Optional) The easing function of the animation, which allow custom mathematical formulas for animations
  34341. * @param onAnimationEnd Callback to run once the animation is complete
  34342. * @returns Nullable animation
  34343. */
  34344. static CreateMergeAndStartAnimation(name: string, node: Node, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction, onAnimationEnd?: () => void): Nullable<Animatable>;
  34345. /**
  34346. * Convert the keyframes for all animations belonging to the group to be relative to a given reference frame.
  34347. * @param sourceAnimation defines the Animation containing keyframes to convert
  34348. * @param referenceFrame defines the frame that keyframes in the range will be relative to
  34349. * @param range defines the name of the AnimationRange belonging to the Animation to convert
  34350. * @param cloneOriginal defines whether or not to clone the animation and convert the clone or convert the original animation (default is false)
  34351. * @param clonedName defines the name of the resulting cloned Animation if cloneOriginal is true
  34352. * @returns a new Animation if cloneOriginal is true or the original Animation if cloneOriginal is false
  34353. */
  34354. static MakeAnimationAdditive(sourceAnimation: Animation, referenceFrame?: number, range?: string, cloneOriginal?: boolean, clonedName?: string): Animation;
  34355. /**
  34356. * Transition property of an host to the target Value
  34357. * @param property The property to transition
  34358. * @param targetValue The target Value of the property
  34359. * @param host The object where the property to animate belongs
  34360. * @param scene Scene used to run the animation
  34361. * @param frameRate Framerate (in frame/s) to use
  34362. * @param transition The transition type we want to use
  34363. * @param duration The duration of the animation, in milliseconds
  34364. * @param onAnimationEnd Callback trigger at the end of the animation
  34365. * @returns Nullable animation
  34366. */
  34367. static TransitionTo(property: string, targetValue: any, host: any, scene: Scene, frameRate: number, transition: Animation, duration: number, onAnimationEnd?: Nullable<() => void>): Nullable<Animatable>;
  34368. /**
  34369. * Return the array of runtime animations currently using this animation
  34370. */
  34371. get runtimeAnimations(): RuntimeAnimation[];
  34372. /**
  34373. * Specifies if any of the runtime animations are currently running
  34374. */
  34375. get hasRunningRuntimeAnimations(): boolean;
  34376. /**
  34377. * Initializes the animation
  34378. * @param name Name of the animation
  34379. * @param targetProperty Property to animate
  34380. * @param framePerSecond The frames per second of the animation
  34381. * @param dataType The data type of the animation
  34382. * @param loopMode The loop mode of the animation
  34383. * @param enableBlending Specifies if blending should be enabled
  34384. */
  34385. constructor(
  34386. /**Name of the animation */
  34387. name: string,
  34388. /**Property to animate */
  34389. targetProperty: string,
  34390. /**The frames per second of the animation */
  34391. framePerSecond: number,
  34392. /**The data type of the animation */
  34393. dataType: number,
  34394. /**The loop mode of the animation */
  34395. loopMode?: number | undefined,
  34396. /**Specifies if blending should be enabled */
  34397. enableBlending?: boolean | undefined);
  34398. /**
  34399. * Converts the animation to a string
  34400. * @param fullDetails support for multiple levels of logging within scene loading
  34401. * @returns String form of the animation
  34402. */
  34403. toString(fullDetails?: boolean): string;
  34404. /**
  34405. * Add an event to this animation
  34406. * @param event Event to add
  34407. */
  34408. addEvent(event: AnimationEvent): void;
  34409. /**
  34410. * Remove all events found at the given frame
  34411. * @param frame The frame to remove events from
  34412. */
  34413. removeEvents(frame: number): void;
  34414. /**
  34415. * Retrieves all the events from the animation
  34416. * @returns Events from the animation
  34417. */
  34418. getEvents(): AnimationEvent[];
  34419. /**
  34420. * Creates an animation range
  34421. * @param name Name of the animation range
  34422. * @param from Starting frame of the animation range
  34423. * @param to Ending frame of the animation
  34424. */
  34425. createRange(name: string, from: number, to: number): void;
  34426. /**
  34427. * Deletes an animation range by name
  34428. * @param name Name of the animation range to delete
  34429. * @param deleteFrames Specifies if the key frames for the range should also be deleted (true) or not (false)
  34430. */
  34431. deleteRange(name: string, deleteFrames?: boolean): void;
  34432. /**
  34433. * Gets the animation range by name, or null if not defined
  34434. * @param name Name of the animation range
  34435. * @returns Nullable animation range
  34436. */
  34437. getRange(name: string): Nullable<AnimationRange>;
  34438. /**
  34439. * Gets the key frames from the animation
  34440. * @returns The key frames of the animation
  34441. */
  34442. getKeys(): Array<IAnimationKey>;
  34443. /**
  34444. * Gets the highest frame rate of the animation
  34445. * @returns Highest frame rate of the animation
  34446. */
  34447. getHighestFrame(): number;
  34448. /**
  34449. * Gets the easing function of the animation
  34450. * @returns Easing function of the animation
  34451. */
  34452. getEasingFunction(): IEasingFunction;
  34453. /**
  34454. * Sets the easing function of the animation
  34455. * @param easingFunction A custom mathematical formula for animation
  34456. */
  34457. setEasingFunction(easingFunction: EasingFunction): void;
  34458. /**
  34459. * Interpolates a scalar linearly
  34460. * @param startValue Start value of the animation curve
  34461. * @param endValue End value of the animation curve
  34462. * @param gradient Scalar amount to interpolate
  34463. * @returns Interpolated scalar value
  34464. */
  34465. floatInterpolateFunction(startValue: number, endValue: number, gradient: number): number;
  34466. /**
  34467. * Interpolates a scalar cubically
  34468. * @param startValue Start value of the animation curve
  34469. * @param outTangent End tangent of the animation
  34470. * @param endValue End value of the animation curve
  34471. * @param inTangent Start tangent of the animation curve
  34472. * @param gradient Scalar amount to interpolate
  34473. * @returns Interpolated scalar value
  34474. */
  34475. floatInterpolateFunctionWithTangents(startValue: number, outTangent: number, endValue: number, inTangent: number, gradient: number): number;
  34476. /**
  34477. * Interpolates a quaternion using a spherical linear interpolation
  34478. * @param startValue Start value of the animation curve
  34479. * @param endValue End value of the animation curve
  34480. * @param gradient Scalar amount to interpolate
  34481. * @returns Interpolated quaternion value
  34482. */
  34483. quaternionInterpolateFunction(startValue: Quaternion, endValue: Quaternion, gradient: number): Quaternion;
  34484. /**
  34485. * Interpolates a quaternion cubically
  34486. * @param startValue Start value of the animation curve
  34487. * @param outTangent End tangent of the animation curve
  34488. * @param endValue End value of the animation curve
  34489. * @param inTangent Start tangent of the animation curve
  34490. * @param gradient Scalar amount to interpolate
  34491. * @returns Interpolated quaternion value
  34492. */
  34493. quaternionInterpolateFunctionWithTangents(startValue: Quaternion, outTangent: Quaternion, endValue: Quaternion, inTangent: Quaternion, gradient: number): Quaternion;
  34494. /**
  34495. * Interpolates a Vector3 linearl
  34496. * @param startValue Start value of the animation curve
  34497. * @param endValue End value of the animation curve
  34498. * @param gradient Scalar amount to interpolate
  34499. * @returns Interpolated scalar value
  34500. */
  34501. vector3InterpolateFunction(startValue: Vector3, endValue: Vector3, gradient: number): Vector3;
  34502. /**
  34503. * Interpolates a Vector3 cubically
  34504. * @param startValue Start value of the animation curve
  34505. * @param outTangent End tangent of the animation
  34506. * @param endValue End value of the animation curve
  34507. * @param inTangent Start tangent of the animation curve
  34508. * @param gradient Scalar amount to interpolate
  34509. * @returns InterpolatedVector3 value
  34510. */
  34511. vector3InterpolateFunctionWithTangents(startValue: Vector3, outTangent: Vector3, endValue: Vector3, inTangent: Vector3, gradient: number): Vector3;
  34512. /**
  34513. * Interpolates a Vector2 linearly
  34514. * @param startValue Start value of the animation curve
  34515. * @param endValue End value of the animation curve
  34516. * @param gradient Scalar amount to interpolate
  34517. * @returns Interpolated Vector2 value
  34518. */
  34519. vector2InterpolateFunction(startValue: Vector2, endValue: Vector2, gradient: number): Vector2;
  34520. /**
  34521. * Interpolates a Vector2 cubically
  34522. * @param startValue Start value of the animation curve
  34523. * @param outTangent End tangent of the animation
  34524. * @param endValue End value of the animation curve
  34525. * @param inTangent Start tangent of the animation curve
  34526. * @param gradient Scalar amount to interpolate
  34527. * @returns Interpolated Vector2 value
  34528. */
  34529. vector2InterpolateFunctionWithTangents(startValue: Vector2, outTangent: Vector2, endValue: Vector2, inTangent: Vector2, gradient: number): Vector2;
  34530. /**
  34531. * Interpolates a size linearly
  34532. * @param startValue Start value of the animation curve
  34533. * @param endValue End value of the animation curve
  34534. * @param gradient Scalar amount to interpolate
  34535. * @returns Interpolated Size value
  34536. */
  34537. sizeInterpolateFunction(startValue: Size, endValue: Size, gradient: number): Size;
  34538. /**
  34539. * Interpolates a Color3 linearly
  34540. * @param startValue Start value of the animation curve
  34541. * @param endValue End value of the animation curve
  34542. * @param gradient Scalar amount to interpolate
  34543. * @returns Interpolated Color3 value
  34544. */
  34545. color3InterpolateFunction(startValue: Color3, endValue: Color3, gradient: number): Color3;
  34546. /**
  34547. * Interpolates a Color4 linearly
  34548. * @param startValue Start value of the animation curve
  34549. * @param endValue End value of the animation curve
  34550. * @param gradient Scalar amount to interpolate
  34551. * @returns Interpolated Color3 value
  34552. */
  34553. color4InterpolateFunction(startValue: Color4, endValue: Color4, gradient: number): Color4;
  34554. /**
  34555. * @hidden Internal use only
  34556. */
  34557. _getKeyValue(value: any): any;
  34558. /**
  34559. * @hidden Internal use only
  34560. */
  34561. _interpolate(currentFrame: number, state: _IAnimationState): any;
  34562. /**
  34563. * Defines the function to use to interpolate matrices
  34564. * @param startValue defines the start matrix
  34565. * @param endValue defines the end matrix
  34566. * @param gradient defines the gradient between both matrices
  34567. * @param result defines an optional target matrix where to store the interpolation
  34568. * @returns the interpolated matrix
  34569. */
  34570. matrixInterpolateFunction(startValue: Matrix, endValue: Matrix, gradient: number, result?: Matrix): Matrix;
  34571. /**
  34572. * Makes a copy of the animation
  34573. * @returns Cloned animation
  34574. */
  34575. clone(): Animation;
  34576. /**
  34577. * Sets the key frames of the animation
  34578. * @param values The animation key frames to set
  34579. */
  34580. setKeys(values: Array<IAnimationKey>): void;
  34581. /**
  34582. * Serializes the animation to an object
  34583. * @returns Serialized object
  34584. */
  34585. serialize(): any;
  34586. /**
  34587. * Float animation type
  34588. */
  34589. static readonly ANIMATIONTYPE_FLOAT: number;
  34590. /**
  34591. * Vector3 animation type
  34592. */
  34593. static readonly ANIMATIONTYPE_VECTOR3: number;
  34594. /**
  34595. * Quaternion animation type
  34596. */
  34597. static readonly ANIMATIONTYPE_QUATERNION: number;
  34598. /**
  34599. * Matrix animation type
  34600. */
  34601. static readonly ANIMATIONTYPE_MATRIX: number;
  34602. /**
  34603. * Color3 animation type
  34604. */
  34605. static readonly ANIMATIONTYPE_COLOR3: number;
  34606. /**
  34607. * Color3 animation type
  34608. */
  34609. static readonly ANIMATIONTYPE_COLOR4: number;
  34610. /**
  34611. * Vector2 animation type
  34612. */
  34613. static readonly ANIMATIONTYPE_VECTOR2: number;
  34614. /**
  34615. * Size animation type
  34616. */
  34617. static readonly ANIMATIONTYPE_SIZE: number;
  34618. /**
  34619. * Relative Loop Mode
  34620. */
  34621. static readonly ANIMATIONLOOPMODE_RELATIVE: number;
  34622. /**
  34623. * Cycle Loop Mode
  34624. */
  34625. static readonly ANIMATIONLOOPMODE_CYCLE: number;
  34626. /**
  34627. * Constant Loop Mode
  34628. */
  34629. static readonly ANIMATIONLOOPMODE_CONSTANT: number;
  34630. /** @hidden */
  34631. static _UniversalLerp(left: any, right: any, amount: number): any;
  34632. /**
  34633. * Parses an animation object and creates an animation
  34634. * @param parsedAnimation Parsed animation object
  34635. * @returns Animation object
  34636. */
  34637. static Parse(parsedAnimation: any): Animation;
  34638. /**
  34639. * Appends the serialized animations from the source animations
  34640. * @param source Source containing the animations
  34641. * @param destination Target to store the animations
  34642. */
  34643. static AppendSerializedAnimations(source: IAnimatable, destination: any): void;
  34644. /**
  34645. * Creates a new animation or an array of animations from a snippet saved in a remote file
  34646. * @param name defines the name of the animation to create (can be null or empty to use the one from the json data)
  34647. * @param url defines the url to load from
  34648. * @returns a promise that will resolve to the new animation or an array of animations
  34649. */
  34650. static ParseFromFileAsync(name: Nullable<string>, url: string): Promise<Animation | Array<Animation>>;
  34651. /**
  34652. * Creates an animation or an array of animations from a snippet saved by the Inspector
  34653. * @param snippetId defines the snippet to load
  34654. * @returns a promise that will resolve to the new animation or a new array of animations
  34655. */
  34656. static CreateFromSnippetAsync(snippetId: string): Promise<Animation | Array<Animation>>;
  34657. }
  34658. }
  34659. declare module "babylonjs/Animations/animatable.interface" {
  34660. import { Nullable } from "babylonjs/types";
  34661. import { Animation } from "babylonjs/Animations/animation";
  34662. /**
  34663. * Interface containing an array of animations
  34664. */
  34665. export interface IAnimatable {
  34666. /**
  34667. * Array of animations
  34668. */
  34669. animations: Nullable<Array<Animation>>;
  34670. }
  34671. }
  34672. declare module "babylonjs/Misc/decorators" {
  34673. import { Nullable } from "babylonjs/types";
  34674. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  34675. import { Scene } from "babylonjs/scene";
  34676. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  34677. import { FresnelParameters } from "babylonjs/Materials/fresnelParameters";
  34678. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  34679. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  34680. export function expandToProperty(callback: string, targetKey?: Nullable<string>): (target: any, propertyKey: string) => void;
  34681. export function serialize(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34682. export function serializeAsTexture(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34683. export function serializeAsColor3(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34684. export function serializeAsFresnelParameters(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34685. export function serializeAsVector2(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34686. export function serializeAsVector3(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34687. export function serializeAsMeshReference(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34688. export function serializeAsColorCurves(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34689. export function serializeAsColor4(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34690. export function serializeAsImageProcessingConfiguration(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34691. export function serializeAsQuaternion(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34692. export function serializeAsMatrix(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34693. /**
  34694. * Decorator used to define property that can be serialized as reference to a camera
  34695. * @param sourceName defines the name of the property to decorate
  34696. */
  34697. export function serializeAsCameraReference(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34698. /**
  34699. * Class used to help serialization objects
  34700. */
  34701. export class SerializationHelper {
  34702. /** @hidden */
  34703. static _ImageProcessingConfigurationParser: (sourceProperty: any) => ImageProcessingConfiguration;
  34704. /** @hidden */
  34705. static _FresnelParametersParser: (sourceProperty: any) => FresnelParameters;
  34706. /** @hidden */
  34707. static _ColorCurvesParser: (sourceProperty: any) => ColorCurves;
  34708. /** @hidden */
  34709. static _TextureParser: (sourceProperty: any, scene: Scene, rootUrl: string) => Nullable<BaseTexture>;
  34710. /**
  34711. * Appends the serialized animations from the source animations
  34712. * @param source Source containing the animations
  34713. * @param destination Target to store the animations
  34714. */
  34715. static AppendSerializedAnimations(source: IAnimatable, destination: any): void;
  34716. /**
  34717. * Static function used to serialized a specific entity
  34718. * @param entity defines the entity to serialize
  34719. * @param serializationObject defines the optional target obecjt where serialization data will be stored
  34720. * @returns a JSON compatible object representing the serialization of the entity
  34721. */
  34722. static Serialize<T>(entity: T, serializationObject?: any): any;
  34723. /**
  34724. * Creates a new entity from a serialization data object
  34725. * @param creationFunction defines a function used to instanciated the new entity
  34726. * @param source defines the source serialization data
  34727. * @param scene defines the hosting scene
  34728. * @param rootUrl defines the root url for resources
  34729. * @returns a new entity
  34730. */
  34731. static Parse<T>(creationFunction: () => T, source: any, scene: Nullable<Scene>, rootUrl?: Nullable<string>): T;
  34732. /**
  34733. * Clones an object
  34734. * @param creationFunction defines the function used to instanciate the new object
  34735. * @param source defines the source object
  34736. * @returns the cloned object
  34737. */
  34738. static Clone<T>(creationFunction: () => T, source: T): T;
  34739. /**
  34740. * Instanciates a new object based on a source one (some data will be shared between both object)
  34741. * @param creationFunction defines the function used to instanciate the new object
  34742. * @param source defines the source object
  34743. * @returns the new object
  34744. */
  34745. static Instanciate<T>(creationFunction: () => T, source: T): T;
  34746. }
  34747. }
  34748. declare module "babylonjs/Materials/Textures/baseTexture" {
  34749. import { Observable } from "babylonjs/Misc/observable";
  34750. import { Nullable } from "babylonjs/types";
  34751. import { Scene } from "babylonjs/scene";
  34752. import { Matrix } from "babylonjs/Maths/math.vector";
  34753. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  34754. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  34755. import { ISize } from "babylonjs/Maths/math.size";
  34756. import "babylonjs/Misc/fileTools";
  34757. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  34758. /**
  34759. * Base class of all the textures in babylon.
  34760. * It groups all the common properties the materials, post process, lights... might need
  34761. * in order to make a correct use of the texture.
  34762. */
  34763. export class BaseTexture implements IAnimatable {
  34764. /**
  34765. * Default anisotropic filtering level for the application.
  34766. * It is set to 4 as a good tradeoff between perf and quality.
  34767. */
  34768. static DEFAULT_ANISOTROPIC_FILTERING_LEVEL: number;
  34769. /**
  34770. * Gets or sets the unique id of the texture
  34771. */
  34772. uniqueId: number;
  34773. /**
  34774. * Define the name of the texture.
  34775. */
  34776. name: string;
  34777. /**
  34778. * Gets or sets an object used to store user defined information.
  34779. */
  34780. metadata: any;
  34781. /**
  34782. * For internal use only. Please do not use.
  34783. */
  34784. reservedDataStore: any;
  34785. private _hasAlpha;
  34786. /**
  34787. * Define if the texture is having a usable alpha value (can be use for transparency or glossiness for instance).
  34788. */
  34789. set hasAlpha(value: boolean);
  34790. get hasAlpha(): boolean;
  34791. /**
  34792. * Defines if the alpha value should be determined via the rgb values.
  34793. * If true the luminance of the pixel might be used to find the corresponding alpha value.
  34794. */
  34795. getAlphaFromRGB: boolean;
  34796. /**
  34797. * Intensity or strength of the texture.
  34798. * It is commonly used by materials to fine tune the intensity of the texture
  34799. */
  34800. level: number;
  34801. /**
  34802. * Define the UV chanel to use starting from 0 and defaulting to 0.
  34803. * This is part of the texture as textures usually maps to one uv set.
  34804. */
  34805. coordinatesIndex: number;
  34806. private _coordinatesMode;
  34807. /**
  34808. * How a texture is mapped.
  34809. *
  34810. * | Value | Type | Description |
  34811. * | ----- | ----------------------------------- | ----------- |
  34812. * | 0 | EXPLICIT_MODE | |
  34813. * | 1 | SPHERICAL_MODE | |
  34814. * | 2 | PLANAR_MODE | |
  34815. * | 3 | CUBIC_MODE | |
  34816. * | 4 | PROJECTION_MODE | |
  34817. * | 5 | SKYBOX_MODE | |
  34818. * | 6 | INVCUBIC_MODE | |
  34819. * | 7 | EQUIRECTANGULAR_MODE | |
  34820. * | 8 | FIXED_EQUIRECTANGULAR_MODE | |
  34821. * | 9 | FIXED_EQUIRECTANGULAR_MIRRORED_MODE | |
  34822. */
  34823. set coordinatesMode(value: number);
  34824. get coordinatesMode(): number;
  34825. /**
  34826. * | Value | Type | Description |
  34827. * | ----- | ------------------ | ----------- |
  34828. * | 0 | CLAMP_ADDRESSMODE | |
  34829. * | 1 | WRAP_ADDRESSMODE | |
  34830. * | 2 | MIRROR_ADDRESSMODE | |
  34831. */
  34832. wrapU: number;
  34833. /**
  34834. * | Value | Type | Description |
  34835. * | ----- | ------------------ | ----------- |
  34836. * | 0 | CLAMP_ADDRESSMODE | |
  34837. * | 1 | WRAP_ADDRESSMODE | |
  34838. * | 2 | MIRROR_ADDRESSMODE | |
  34839. */
  34840. wrapV: number;
  34841. /**
  34842. * | Value | Type | Description |
  34843. * | ----- | ------------------ | ----------- |
  34844. * | 0 | CLAMP_ADDRESSMODE | |
  34845. * | 1 | WRAP_ADDRESSMODE | |
  34846. * | 2 | MIRROR_ADDRESSMODE | |
  34847. */
  34848. wrapR: number;
  34849. /**
  34850. * With compliant hardware and browser (supporting anisotropic filtering)
  34851. * this defines the level of anisotropic filtering in the texture.
  34852. * The higher the better but the slower. This defaults to 4 as it seems to be the best tradeoff.
  34853. */
  34854. anisotropicFilteringLevel: number;
  34855. /**
  34856. * Define if the texture is a cube texture or if false a 2d texture.
  34857. */
  34858. get isCube(): boolean;
  34859. set isCube(value: boolean);
  34860. /**
  34861. * Define if the texture is a 3d texture (webgl 2) or if false a 2d texture.
  34862. */
  34863. get is3D(): boolean;
  34864. set is3D(value: boolean);
  34865. /**
  34866. * Define if the texture is a 2d array texture (webgl 2) or if false a 2d texture.
  34867. */
  34868. get is2DArray(): boolean;
  34869. set is2DArray(value: boolean);
  34870. /**
  34871. * Define if the texture contains data in gamma space (most of the png/jpg aside bump).
  34872. * HDR texture are usually stored in linear space.
  34873. * This only impacts the PBR and Background materials
  34874. */
  34875. gammaSpace: boolean;
  34876. /**
  34877. * Gets or sets whether or not the texture contains RGBD data.
  34878. */
  34879. get isRGBD(): boolean;
  34880. set isRGBD(value: boolean);
  34881. /**
  34882. * Is Z inverted in the texture (useful in a cube texture).
  34883. */
  34884. invertZ: boolean;
  34885. /**
  34886. * Are mip maps generated for this texture or not.
  34887. */
  34888. get noMipmap(): boolean;
  34889. /**
  34890. * @hidden
  34891. */
  34892. lodLevelInAlpha: boolean;
  34893. /**
  34894. * With prefiltered texture, defined the offset used during the prefiltering steps.
  34895. */
  34896. get lodGenerationOffset(): number;
  34897. set lodGenerationOffset(value: number);
  34898. /**
  34899. * With prefiltered texture, defined the scale used during the prefiltering steps.
  34900. */
  34901. get lodGenerationScale(): number;
  34902. set lodGenerationScale(value: number);
  34903. /**
  34904. * With prefiltered texture, defined if the specular generation is based on a linear ramp.
  34905. * By default we are using a log2 of the linear roughness helping to keep a better resolution for
  34906. * average roughness values.
  34907. */
  34908. get linearSpecularLOD(): boolean;
  34909. set linearSpecularLOD(value: boolean);
  34910. /**
  34911. * In case a better definition than spherical harmonics is required for the diffuse part of the environment.
  34912. * You can set the irradiance texture to rely on a texture instead of the spherical approach.
  34913. * This texture need to have the same characteristics than its parent (Cube vs 2d, coordinates mode, Gamma/Linear, RGBD).
  34914. */
  34915. get irradianceTexture(): Nullable<BaseTexture>;
  34916. set irradianceTexture(value: Nullable<BaseTexture>);
  34917. /**
  34918. * Define if the texture is a render target.
  34919. */
  34920. isRenderTarget: boolean;
  34921. /**
  34922. * Define the unique id of the texture in the scene.
  34923. */
  34924. get uid(): string;
  34925. /** @hidden */
  34926. _prefiltered: boolean;
  34927. /**
  34928. * Return a string representation of the texture.
  34929. * @returns the texture as a string
  34930. */
  34931. toString(): string;
  34932. /**
  34933. * Get the class name of the texture.
  34934. * @returns "BaseTexture"
  34935. */
  34936. getClassName(): string;
  34937. /**
  34938. * Define the list of animation attached to the texture.
  34939. */
  34940. animations: import("babylonjs/Animations/animation").Animation[];
  34941. /**
  34942. * An event triggered when the texture is disposed.
  34943. */
  34944. onDisposeObservable: Observable<BaseTexture>;
  34945. private _onDisposeObserver;
  34946. /**
  34947. * Callback triggered when the texture has been disposed.
  34948. * Kept for back compatibility, you can use the onDisposeObservable instead.
  34949. */
  34950. set onDispose(callback: () => void);
  34951. /**
  34952. * Define the current state of the loading sequence when in delayed load mode.
  34953. */
  34954. delayLoadState: number;
  34955. private _scene;
  34956. private _engine;
  34957. /** @hidden */
  34958. _texture: Nullable<InternalTexture>;
  34959. private _uid;
  34960. /**
  34961. * Define if the texture is preventinga material to render or not.
  34962. * If not and the texture is not ready, the engine will use a default black texture instead.
  34963. */
  34964. get isBlocking(): boolean;
  34965. /**
  34966. * Instantiates a new BaseTexture.
  34967. * Base class of all the textures in babylon.
  34968. * It groups all the common properties the materials, post process, lights... might need
  34969. * in order to make a correct use of the texture.
  34970. * @param sceneOrEngine Define the scene or engine the texture blongs to
  34971. */
  34972. constructor(sceneOrEngine: Nullable<Scene | ThinEngine>);
  34973. /**
  34974. * Get the scene the texture belongs to.
  34975. * @returns the scene or null if undefined
  34976. */
  34977. getScene(): Nullable<Scene>;
  34978. /** @hidden */
  34979. protected _getEngine(): Nullable<ThinEngine>;
  34980. /**
  34981. * Get the texture transform matrix used to offset tile the texture for istance.
  34982. * @returns the transformation matrix
  34983. */
  34984. getTextureMatrix(): Matrix;
  34985. /**
  34986. * Get the texture reflection matrix used to rotate/transform the reflection.
  34987. * @returns the reflection matrix
  34988. */
  34989. getReflectionTextureMatrix(): Matrix;
  34990. /**
  34991. * Get the underlying lower level texture from Babylon.
  34992. * @returns the insternal texture
  34993. */
  34994. getInternalTexture(): Nullable<InternalTexture>;
  34995. /**
  34996. * Get if the texture is ready to be consumed (either it is ready or it is not blocking)
  34997. * @returns true if ready or not blocking
  34998. */
  34999. isReadyOrNotBlocking(): boolean;
  35000. /**
  35001. * Get if the texture is ready to be used (downloaded, converted, mip mapped...).
  35002. * @returns true if fully ready
  35003. */
  35004. isReady(): boolean;
  35005. private _cachedSize;
  35006. /**
  35007. * Get the size of the texture.
  35008. * @returns the texture size.
  35009. */
  35010. getSize(): ISize;
  35011. /**
  35012. * Get the base size of the texture.
  35013. * It can be different from the size if the texture has been resized for POT for instance
  35014. * @returns the base size
  35015. */
  35016. getBaseSize(): ISize;
  35017. /**
  35018. * Update the sampling mode of the texture.
  35019. * Default is Trilinear mode.
  35020. *
  35021. * | Value | Type | Description |
  35022. * | ----- | ------------------ | ----------- |
  35023. * | 1 | NEAREST_SAMPLINGMODE or NEAREST_NEAREST_MIPLINEAR | Nearest is: mag = nearest, min = nearest, mip = linear |
  35024. * | 2 | BILINEAR_SAMPLINGMODE or LINEAR_LINEAR_MIPNEAREST | Bilinear is: mag = linear, min = linear, mip = nearest |
  35025. * | 3 | TRILINEAR_SAMPLINGMODE or LINEAR_LINEAR_MIPLINEAR | Trilinear is: mag = linear, min = linear, mip = linear |
  35026. * | 4 | NEAREST_NEAREST_MIPNEAREST | |
  35027. * | 5 | NEAREST_LINEAR_MIPNEAREST | |
  35028. * | 6 | NEAREST_LINEAR_MIPLINEAR | |
  35029. * | 7 | NEAREST_LINEAR | |
  35030. * | 8 | NEAREST_NEAREST | |
  35031. * | 9 | LINEAR_NEAREST_MIPNEAREST | |
  35032. * | 10 | LINEAR_NEAREST_MIPLINEAR | |
  35033. * | 11 | LINEAR_LINEAR | |
  35034. * | 12 | LINEAR_NEAREST | |
  35035. *
  35036. * > _mag_: magnification filter (close to the viewer)
  35037. * > _min_: minification filter (far from the viewer)
  35038. * > _mip_: filter used between mip map levels
  35039. *@param samplingMode Define the new sampling mode of the texture
  35040. */
  35041. updateSamplingMode(samplingMode: number): void;
  35042. /**
  35043. * Scales the texture if is `canRescale()`
  35044. * @param ratio the resize factor we want to use to rescale
  35045. */
  35046. scale(ratio: number): void;
  35047. /**
  35048. * Get if the texture can rescale.
  35049. */
  35050. get canRescale(): boolean;
  35051. /** @hidden */
  35052. _getFromCache(url: Nullable<string>, noMipmap: boolean, sampling?: number, invertY?: boolean): Nullable<InternalTexture>;
  35053. /** @hidden */
  35054. _rebuild(): void;
  35055. /**
  35056. * Triggers the load sequence in delayed load mode.
  35057. */
  35058. delayLoad(): void;
  35059. /**
  35060. * Clones the texture.
  35061. * @returns the cloned texture
  35062. */
  35063. clone(): Nullable<BaseTexture>;
  35064. /**
  35065. * Get the texture underlying type (INT, FLOAT...)
  35066. */
  35067. get textureType(): number;
  35068. /**
  35069. * Get the texture underlying format (RGB, RGBA...)
  35070. */
  35071. get textureFormat(): number;
  35072. /**
  35073. * Indicates that textures need to be re-calculated for all materials
  35074. */
  35075. protected _markAllSubMeshesAsTexturesDirty(): void;
  35076. /**
  35077. * Reads the pixels stored in the webgl texture and returns them as an ArrayBuffer.
  35078. * This will returns an RGBA array buffer containing either in values (0-255) or
  35079. * float values (0-1) depending of the underlying buffer type.
  35080. * @param faceIndex defines the face of the texture to read (in case of cube texture)
  35081. * @param level defines the LOD level of the texture to read (in case of Mip Maps)
  35082. * @param buffer defines a user defined buffer to fill with data (can be null)
  35083. * @returns The Array buffer containing the pixels data.
  35084. */
  35085. readPixels(faceIndex?: number, level?: number, buffer?: Nullable<ArrayBufferView>): Nullable<ArrayBufferView>;
  35086. /**
  35087. * Release and destroy the underlying lower level texture aka internalTexture.
  35088. */
  35089. releaseInternalTexture(): void;
  35090. /** @hidden */
  35091. get _lodTextureHigh(): Nullable<BaseTexture>;
  35092. /** @hidden */
  35093. get _lodTextureMid(): Nullable<BaseTexture>;
  35094. /** @hidden */
  35095. get _lodTextureLow(): Nullable<BaseTexture>;
  35096. /**
  35097. * Dispose the texture and release its associated resources.
  35098. */
  35099. dispose(): void;
  35100. /**
  35101. * Serialize the texture into a JSON representation that can be parsed later on.
  35102. * @returns the JSON representation of the texture
  35103. */
  35104. serialize(): any;
  35105. /**
  35106. * Helper function to be called back once a list of texture contains only ready textures.
  35107. * @param textures Define the list of textures to wait for
  35108. * @param callback Define the callback triggered once the entire list will be ready
  35109. */
  35110. static WhenAllReady(textures: BaseTexture[], callback: () => void): void;
  35111. private static _isScene;
  35112. }
  35113. }
  35114. declare module "babylonjs/Materials/effect" {
  35115. import { Observable } from "babylonjs/Misc/observable";
  35116. import { Nullable } from "babylonjs/types";
  35117. import { IDisposable } from "babylonjs/scene";
  35118. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  35119. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  35120. import { IMatrixLike, IVector2Like, IVector3Like, IVector4Like, IColor3Like, IColor4Like } from "babylonjs/Maths/math.like";
  35121. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  35122. import { IEffectFallbacks } from "babylonjs/Materials/iEffectFallbacks";
  35123. import { Engine } from "babylonjs/Engines/engine";
  35124. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  35125. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  35126. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  35127. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  35128. /**
  35129. * Options to be used when creating an effect.
  35130. */
  35131. export interface IEffectCreationOptions {
  35132. /**
  35133. * Atrributes that will be used in the shader.
  35134. */
  35135. attributes: string[];
  35136. /**
  35137. * Uniform varible names that will be set in the shader.
  35138. */
  35139. uniformsNames: string[];
  35140. /**
  35141. * Uniform buffer variable names that will be set in the shader.
  35142. */
  35143. uniformBuffersNames: string[];
  35144. /**
  35145. * Sampler texture variable names that will be set in the shader.
  35146. */
  35147. samplers: string[];
  35148. /**
  35149. * Define statements that will be set in the shader.
  35150. */
  35151. defines: any;
  35152. /**
  35153. * Possible fallbacks for this effect to improve performance when needed.
  35154. */
  35155. fallbacks: Nullable<IEffectFallbacks>;
  35156. /**
  35157. * Callback that will be called when the shader is compiled.
  35158. */
  35159. onCompiled: Nullable<(effect: Effect) => void>;
  35160. /**
  35161. * Callback that will be called if an error occurs during shader compilation.
  35162. */
  35163. onError: Nullable<(effect: Effect, errors: string) => void>;
  35164. /**
  35165. * Parameters to be used with Babylons include syntax to iterate over an array (eg. {lights: 10})
  35166. */
  35167. indexParameters?: any;
  35168. /**
  35169. * Max number of lights that can be used in the shader.
  35170. */
  35171. maxSimultaneousLights?: number;
  35172. /**
  35173. * See https://developer.mozilla.org/en-US/docs/Web/API/WebGL2RenderingContext/transformFeedbackVaryings
  35174. */
  35175. transformFeedbackVaryings?: Nullable<string[]>;
  35176. /**
  35177. * 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
  35178. */
  35179. processFinalCode?: Nullable<(shaderType: string, code: string) => string>;
  35180. /**
  35181. * Is this effect rendering to several color attachments ?
  35182. */
  35183. multiTarget?: boolean;
  35184. }
  35185. /**
  35186. * Effect containing vertex and fragment shader that can be executed on an object.
  35187. */
  35188. export class Effect implements IDisposable {
  35189. /**
  35190. * Gets or sets the relative url used to load shaders if using the engine in non-minified mode
  35191. */
  35192. static ShadersRepository: string;
  35193. /**
  35194. * Enable logging of the shader code when a compilation error occurs
  35195. */
  35196. static LogShaderCodeOnCompilationError: boolean;
  35197. /**
  35198. * Name of the effect.
  35199. */
  35200. name: any;
  35201. /**
  35202. * String container all the define statements that should be set on the shader.
  35203. */
  35204. defines: string;
  35205. /**
  35206. * Callback that will be called when the shader is compiled.
  35207. */
  35208. onCompiled: Nullable<(effect: Effect) => void>;
  35209. /**
  35210. * Callback that will be called if an error occurs during shader compilation.
  35211. */
  35212. onError: Nullable<(effect: Effect, errors: string) => void>;
  35213. /**
  35214. * Callback that will be called when effect is bound.
  35215. */
  35216. onBind: Nullable<(effect: Effect) => void>;
  35217. /**
  35218. * Unique ID of the effect.
  35219. */
  35220. uniqueId: number;
  35221. /**
  35222. * Observable that will be called when the shader is compiled.
  35223. * It is recommended to use executeWhenCompile() or to make sure that scene.isReady() is called to get this observable raised.
  35224. */
  35225. onCompileObservable: Observable<Effect>;
  35226. /**
  35227. * Observable that will be called if an error occurs during shader compilation.
  35228. */
  35229. onErrorObservable: Observable<Effect>;
  35230. /** @hidden */
  35231. _onBindObservable: Nullable<Observable<Effect>>;
  35232. /**
  35233. * @hidden
  35234. * Specifies if the effect was previously ready
  35235. */
  35236. _wasPreviouslyReady: boolean;
  35237. /**
  35238. * Observable that will be called when effect is bound.
  35239. */
  35240. get onBindObservable(): Observable<Effect>;
  35241. /** @hidden */
  35242. _bonesComputationForcedToCPU: boolean;
  35243. /** @hidden */
  35244. _multiTarget: boolean;
  35245. private static _uniqueIdSeed;
  35246. private _engine;
  35247. private _uniformBuffersNames;
  35248. private _uniformBuffersNamesList;
  35249. private _uniformsNames;
  35250. private _samplerList;
  35251. private _samplers;
  35252. private _isReady;
  35253. private _compilationError;
  35254. private _allFallbacksProcessed;
  35255. private _attributesNames;
  35256. private _attributes;
  35257. private _attributeLocationByName;
  35258. private _uniforms;
  35259. /**
  35260. * Key for the effect.
  35261. * @hidden
  35262. */
  35263. _key: string;
  35264. private _indexParameters;
  35265. private _fallbacks;
  35266. private _vertexSourceCode;
  35267. private _fragmentSourceCode;
  35268. private _vertexSourceCodeOverride;
  35269. private _fragmentSourceCodeOverride;
  35270. private _transformFeedbackVaryings;
  35271. /**
  35272. * Compiled shader to webGL program.
  35273. * @hidden
  35274. */
  35275. _pipelineContext: Nullable<IPipelineContext>;
  35276. private _valueCache;
  35277. private static _baseCache;
  35278. /**
  35279. * Instantiates an effect.
  35280. * An effect can be used to create/manage/execute vertex and fragment shaders.
  35281. * @param baseName Name of the effect.
  35282. * @param attributesNamesOrOptions List of attribute names that will be passed to the shader or set of all options to create the effect.
  35283. * @param uniformsNamesOrEngine List of uniform variable names that will be passed to the shader or the engine that will be used to render effect.
  35284. * @param samplers List of sampler variables that will be passed to the shader.
  35285. * @param engine Engine to be used to render the effect
  35286. * @param defines Define statements to be added to the shader.
  35287. * @param fallbacks Possible fallbacks for this effect to improve performance when needed.
  35288. * @param onCompiled Callback that will be called when the shader is compiled.
  35289. * @param onError Callback that will be called if an error occurs during shader compilation.
  35290. * @param indexParameters Parameters to be used with Babylons include syntax to iterate over an array (eg. {lights: 10})
  35291. */
  35292. 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);
  35293. private _useFinalCode;
  35294. /**
  35295. * Unique key for this effect
  35296. */
  35297. get key(): string;
  35298. /**
  35299. * If the effect has been compiled and prepared.
  35300. * @returns if the effect is compiled and prepared.
  35301. */
  35302. isReady(): boolean;
  35303. private _isReadyInternal;
  35304. /**
  35305. * The engine the effect was initialized with.
  35306. * @returns the engine.
  35307. */
  35308. getEngine(): Engine;
  35309. /**
  35310. * The pipeline context for this effect
  35311. * @returns the associated pipeline context
  35312. */
  35313. getPipelineContext(): Nullable<IPipelineContext>;
  35314. /**
  35315. * The set of names of attribute variables for the shader.
  35316. * @returns An array of attribute names.
  35317. */
  35318. getAttributesNames(): string[];
  35319. /**
  35320. * Returns the attribute at the given index.
  35321. * @param index The index of the attribute.
  35322. * @returns The location of the attribute.
  35323. */
  35324. getAttributeLocation(index: number): number;
  35325. /**
  35326. * Returns the attribute based on the name of the variable.
  35327. * @param name of the attribute to look up.
  35328. * @returns the attribute location.
  35329. */
  35330. getAttributeLocationByName(name: string): number;
  35331. /**
  35332. * The number of attributes.
  35333. * @returns the numnber of attributes.
  35334. */
  35335. getAttributesCount(): number;
  35336. /**
  35337. * Gets the index of a uniform variable.
  35338. * @param uniformName of the uniform to look up.
  35339. * @returns the index.
  35340. */
  35341. getUniformIndex(uniformName: string): number;
  35342. /**
  35343. * Returns the attribute based on the name of the variable.
  35344. * @param uniformName of the uniform to look up.
  35345. * @returns the location of the uniform.
  35346. */
  35347. getUniform(uniformName: string): Nullable<WebGLUniformLocation>;
  35348. /**
  35349. * Returns an array of sampler variable names
  35350. * @returns The array of sampler variable names.
  35351. */
  35352. getSamplers(): string[];
  35353. /**
  35354. * Returns an array of uniform variable names
  35355. * @returns The array of uniform variable names.
  35356. */
  35357. getUniformNames(): string[];
  35358. /**
  35359. * Returns an array of uniform buffer variable names
  35360. * @returns The array of uniform buffer variable names.
  35361. */
  35362. getUniformBuffersNames(): string[];
  35363. /**
  35364. * Returns the index parameters used to create the effect
  35365. * @returns The index parameters object
  35366. */
  35367. getIndexParameters(): any;
  35368. /**
  35369. * The error from the last compilation.
  35370. * @returns the error string.
  35371. */
  35372. getCompilationError(): string;
  35373. /**
  35374. * Gets a boolean indicating that all fallbacks were used during compilation
  35375. * @returns true if all fallbacks were used
  35376. */
  35377. allFallbacksProcessed(): boolean;
  35378. /**
  35379. * Adds a callback to the onCompiled observable and call the callback imediatly if already ready.
  35380. * @param func The callback to be used.
  35381. */
  35382. executeWhenCompiled(func: (effect: Effect) => void): void;
  35383. private _checkIsReady;
  35384. private _loadShader;
  35385. /**
  35386. * Gets the vertex shader source code of this effect
  35387. */
  35388. get vertexSourceCode(): string;
  35389. /**
  35390. * Gets the fragment shader source code of this effect
  35391. */
  35392. get fragmentSourceCode(): string;
  35393. /**
  35394. * Recompiles the webGL program
  35395. * @param vertexSourceCode The source code for the vertex shader.
  35396. * @param fragmentSourceCode The source code for the fragment shader.
  35397. * @param onCompiled Callback called when completed.
  35398. * @param onError Callback called on error.
  35399. * @hidden
  35400. */
  35401. _rebuildProgram(vertexSourceCode: string, fragmentSourceCode: string, onCompiled: (pipelineContext: IPipelineContext) => void, onError: (message: string) => void): void;
  35402. /**
  35403. * Prepares the effect
  35404. * @hidden
  35405. */
  35406. _prepareEffect(): void;
  35407. private _getShaderCodeAndErrorLine;
  35408. private _processCompilationErrors;
  35409. /**
  35410. * Checks if the effect is supported. (Must be called after compilation)
  35411. */
  35412. get isSupported(): boolean;
  35413. /**
  35414. * Binds a texture to the engine to be used as output of the shader.
  35415. * @param channel Name of the output variable.
  35416. * @param texture Texture to bind.
  35417. * @hidden
  35418. */
  35419. _bindTexture(channel: string, texture: Nullable<InternalTexture>): void;
  35420. /**
  35421. * Sets a texture on the engine to be used in the shader.
  35422. * @param channel Name of the sampler variable.
  35423. * @param texture Texture to set.
  35424. */
  35425. setTexture(channel: string, texture: Nullable<BaseTexture>): void;
  35426. /**
  35427. * Sets a depth stencil texture from a render target on the engine to be used in the shader.
  35428. * @param channel Name of the sampler variable.
  35429. * @param texture Texture to set.
  35430. */
  35431. setDepthStencilTexture(channel: string, texture: Nullable<RenderTargetTexture>): void;
  35432. /**
  35433. * Sets an array of textures on the engine to be used in the shader.
  35434. * @param channel Name of the variable.
  35435. * @param textures Textures to set.
  35436. */
  35437. setTextureArray(channel: string, textures: BaseTexture[]): void;
  35438. /**
  35439. * 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)
  35440. * @param channel Name of the sampler variable.
  35441. * @param postProcess Post process to get the input texture from.
  35442. */
  35443. setTextureFromPostProcess(channel: string, postProcess: Nullable<PostProcess>): void;
  35444. /**
  35445. * (Warning! setTextureFromPostProcessOutput may be desired instead)
  35446. * 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)
  35447. * @param channel Name of the sampler variable.
  35448. * @param postProcess Post process to get the output texture from.
  35449. */
  35450. setTextureFromPostProcessOutput(channel: string, postProcess: Nullable<PostProcess>): void;
  35451. /** @hidden */
  35452. _cacheMatrix(uniformName: string, matrix: IMatrixLike): boolean;
  35453. /** @hidden */
  35454. _cacheFloat2(uniformName: string, x: number, y: number): boolean;
  35455. /** @hidden */
  35456. _cacheFloat3(uniformName: string, x: number, y: number, z: number): boolean;
  35457. /** @hidden */
  35458. _cacheFloat4(uniformName: string, x: number, y: number, z: number, w: number): boolean;
  35459. /**
  35460. * Binds a buffer to a uniform.
  35461. * @param buffer Buffer to bind.
  35462. * @param name Name of the uniform variable to bind to.
  35463. */
  35464. bindUniformBuffer(buffer: DataBuffer, name: string): void;
  35465. /**
  35466. * Binds block to a uniform.
  35467. * @param blockName Name of the block to bind.
  35468. * @param index Index to bind.
  35469. */
  35470. bindUniformBlock(blockName: string, index: number): void;
  35471. /**
  35472. * Sets an interger value on a uniform variable.
  35473. * @param uniformName Name of the variable.
  35474. * @param value Value to be set.
  35475. * @returns this effect.
  35476. */
  35477. setInt(uniformName: string, value: number): Effect;
  35478. /**
  35479. * Sets an int array on a uniform variable.
  35480. * @param uniformName Name of the variable.
  35481. * @param array array to be set.
  35482. * @returns this effect.
  35483. */
  35484. setIntArray(uniformName: string, array: Int32Array): Effect;
  35485. /**
  35486. * 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)
  35487. * @param uniformName Name of the variable.
  35488. * @param array array to be set.
  35489. * @returns this effect.
  35490. */
  35491. setIntArray2(uniformName: string, array: Int32Array): Effect;
  35492. /**
  35493. * 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)
  35494. * @param uniformName Name of the variable.
  35495. * @param array array to be set.
  35496. * @returns this effect.
  35497. */
  35498. setIntArray3(uniformName: string, array: Int32Array): Effect;
  35499. /**
  35500. * 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)
  35501. * @param uniformName Name of the variable.
  35502. * @param array array to be set.
  35503. * @returns this effect.
  35504. */
  35505. setIntArray4(uniformName: string, array: Int32Array): Effect;
  35506. /**
  35507. * Sets an float array on a uniform variable.
  35508. * @param uniformName Name of the variable.
  35509. * @param array array to be set.
  35510. * @returns this effect.
  35511. */
  35512. setFloatArray(uniformName: string, array: Float32Array): Effect;
  35513. /**
  35514. * 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)
  35515. * @param uniformName Name of the variable.
  35516. * @param array array to be set.
  35517. * @returns this effect.
  35518. */
  35519. setFloatArray2(uniformName: string, array: Float32Array): Effect;
  35520. /**
  35521. * 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)
  35522. * @param uniformName Name of the variable.
  35523. * @param array array to be set.
  35524. * @returns this effect.
  35525. */
  35526. setFloatArray3(uniformName: string, array: Float32Array): Effect;
  35527. /**
  35528. * 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)
  35529. * @param uniformName Name of the variable.
  35530. * @param array array to be set.
  35531. * @returns this effect.
  35532. */
  35533. setFloatArray4(uniformName: string, array: Float32Array): Effect;
  35534. /**
  35535. * Sets an array on a uniform variable.
  35536. * @param uniformName Name of the variable.
  35537. * @param array array to be set.
  35538. * @returns this effect.
  35539. */
  35540. setArray(uniformName: string, array: number[]): Effect;
  35541. /**
  35542. * 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)
  35543. * @param uniformName Name of the variable.
  35544. * @param array array to be set.
  35545. * @returns this effect.
  35546. */
  35547. setArray2(uniformName: string, array: number[]): Effect;
  35548. /**
  35549. * 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)
  35550. * @param uniformName Name of the variable.
  35551. * @param array array to be set.
  35552. * @returns this effect.
  35553. */
  35554. setArray3(uniformName: string, array: number[]): Effect;
  35555. /**
  35556. * 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)
  35557. * @param uniformName Name of the variable.
  35558. * @param array array to be set.
  35559. * @returns this effect.
  35560. */
  35561. setArray4(uniformName: string, array: number[]): Effect;
  35562. /**
  35563. * Sets matrices on a uniform variable.
  35564. * @param uniformName Name of the variable.
  35565. * @param matrices matrices to be set.
  35566. * @returns this effect.
  35567. */
  35568. setMatrices(uniformName: string, matrices: Float32Array | Array<number>): Effect;
  35569. /**
  35570. * Sets matrix on a uniform variable.
  35571. * @param uniformName Name of the variable.
  35572. * @param matrix matrix to be set.
  35573. * @returns this effect.
  35574. */
  35575. setMatrix(uniformName: string, matrix: IMatrixLike): Effect;
  35576. /**
  35577. * 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)
  35578. * @param uniformName Name of the variable.
  35579. * @param matrix matrix to be set.
  35580. * @returns this effect.
  35581. */
  35582. setMatrix3x3(uniformName: string, matrix: Float32Array | Array<number>): Effect;
  35583. /**
  35584. * Sets a 2x2 matrix on a uniform variable. (Speicified as [1,2,3,4] will result in [1,2][3,4] matrix)
  35585. * @param uniformName Name of the variable.
  35586. * @param matrix matrix to be set.
  35587. * @returns this effect.
  35588. */
  35589. setMatrix2x2(uniformName: string, matrix: Float32Array | Array<number>): Effect;
  35590. /**
  35591. * Sets a float on a uniform variable.
  35592. * @param uniformName Name of the variable.
  35593. * @param value value to be set.
  35594. * @returns this effect.
  35595. */
  35596. setFloat(uniformName: string, value: number): Effect;
  35597. /**
  35598. * Sets a boolean on a uniform variable.
  35599. * @param uniformName Name of the variable.
  35600. * @param bool value to be set.
  35601. * @returns this effect.
  35602. */
  35603. setBool(uniformName: string, bool: boolean): Effect;
  35604. /**
  35605. * Sets a Vector2 on a uniform variable.
  35606. * @param uniformName Name of the variable.
  35607. * @param vector2 vector2 to be set.
  35608. * @returns this effect.
  35609. */
  35610. setVector2(uniformName: string, vector2: IVector2Like): Effect;
  35611. /**
  35612. * Sets a float2 on a uniform variable.
  35613. * @param uniformName Name of the variable.
  35614. * @param x First float in float2.
  35615. * @param y Second float in float2.
  35616. * @returns this effect.
  35617. */
  35618. setFloat2(uniformName: string, x: number, y: number): Effect;
  35619. /**
  35620. * Sets a Vector3 on a uniform variable.
  35621. * @param uniformName Name of the variable.
  35622. * @param vector3 Value to be set.
  35623. * @returns this effect.
  35624. */
  35625. setVector3(uniformName: string, vector3: IVector3Like): Effect;
  35626. /**
  35627. * Sets a float3 on a uniform variable.
  35628. * @param uniformName Name of the variable.
  35629. * @param x First float in float3.
  35630. * @param y Second float in float3.
  35631. * @param z Third float in float3.
  35632. * @returns this effect.
  35633. */
  35634. setFloat3(uniformName: string, x: number, y: number, z: number): Effect;
  35635. /**
  35636. * Sets a Vector4 on a uniform variable.
  35637. * @param uniformName Name of the variable.
  35638. * @param vector4 Value to be set.
  35639. * @returns this effect.
  35640. */
  35641. setVector4(uniformName: string, vector4: IVector4Like): Effect;
  35642. /**
  35643. * Sets a float4 on a uniform variable.
  35644. * @param uniformName Name of the variable.
  35645. * @param x First float in float4.
  35646. * @param y Second float in float4.
  35647. * @param z Third float in float4.
  35648. * @param w Fourth float in float4.
  35649. * @returns this effect.
  35650. */
  35651. setFloat4(uniformName: string, x: number, y: number, z: number, w: number): Effect;
  35652. /**
  35653. * Sets a Color3 on a uniform variable.
  35654. * @param uniformName Name of the variable.
  35655. * @param color3 Value to be set.
  35656. * @returns this effect.
  35657. */
  35658. setColor3(uniformName: string, color3: IColor3Like): Effect;
  35659. /**
  35660. * Sets a Color4 on a uniform variable.
  35661. * @param uniformName Name of the variable.
  35662. * @param color3 Value to be set.
  35663. * @param alpha Alpha value to be set.
  35664. * @returns this effect.
  35665. */
  35666. setColor4(uniformName: string, color3: IColor3Like, alpha: number): Effect;
  35667. /**
  35668. * Sets a Color4 on a uniform variable
  35669. * @param uniformName defines the name of the variable
  35670. * @param color4 defines the value to be set
  35671. * @returns this effect.
  35672. */
  35673. setDirectColor4(uniformName: string, color4: IColor4Like): Effect;
  35674. /** Release all associated resources */
  35675. dispose(): void;
  35676. /**
  35677. * This function will add a new shader to the shader store
  35678. * @param name the name of the shader
  35679. * @param pixelShader optional pixel shader content
  35680. * @param vertexShader optional vertex shader content
  35681. */
  35682. static RegisterShader(name: string, pixelShader?: string, vertexShader?: string): void;
  35683. /**
  35684. * Store of each shader (The can be looked up using effect.key)
  35685. */
  35686. static ShadersStore: {
  35687. [key: string]: string;
  35688. };
  35689. /**
  35690. * Store of each included file for a shader (The can be looked up using effect.key)
  35691. */
  35692. static IncludesShadersStore: {
  35693. [key: string]: string;
  35694. };
  35695. /**
  35696. * Resets the cache of effects.
  35697. */
  35698. static ResetCache(): void;
  35699. }
  35700. }
  35701. declare module "babylonjs/Engines/engineCapabilities" {
  35702. /**
  35703. * Interface used to describe the capabilities of the engine relatively to the current browser
  35704. */
  35705. export interface EngineCapabilities {
  35706. /** Maximum textures units per fragment shader */
  35707. maxTexturesImageUnits: number;
  35708. /** Maximum texture units per vertex shader */
  35709. maxVertexTextureImageUnits: number;
  35710. /** Maximum textures units in the entire pipeline */
  35711. maxCombinedTexturesImageUnits: number;
  35712. /** Maximum texture size */
  35713. maxTextureSize: number;
  35714. /** Maximum texture samples */
  35715. maxSamples?: number;
  35716. /** Maximum cube texture size */
  35717. maxCubemapTextureSize: number;
  35718. /** Maximum render texture size */
  35719. maxRenderTextureSize: number;
  35720. /** Maximum number of vertex attributes */
  35721. maxVertexAttribs: number;
  35722. /** Maximum number of varyings */
  35723. maxVaryingVectors: number;
  35724. /** Maximum number of uniforms per vertex shader */
  35725. maxVertexUniformVectors: number;
  35726. /** Maximum number of uniforms per fragment shader */
  35727. maxFragmentUniformVectors: number;
  35728. /** Defines if standard derivates (dx/dy) are supported */
  35729. standardDerivatives: boolean;
  35730. /** Defines if s3tc texture compression is supported */
  35731. s3tc?: WEBGL_compressed_texture_s3tc;
  35732. /** Defines if pvrtc texture compression is supported */
  35733. pvrtc: any;
  35734. /** Defines if etc1 texture compression is supported */
  35735. etc1: any;
  35736. /** Defines if etc2 texture compression is supported */
  35737. etc2: any;
  35738. /** Defines if astc texture compression is supported */
  35739. astc: any;
  35740. /** Defines if float textures are supported */
  35741. textureFloat: boolean;
  35742. /** Defines if vertex array objects are supported */
  35743. vertexArrayObject: boolean;
  35744. /** Gets the webgl extension for anisotropic filtering (null if not supported) */
  35745. textureAnisotropicFilterExtension?: EXT_texture_filter_anisotropic;
  35746. /** Gets the maximum level of anisotropy supported */
  35747. maxAnisotropy: number;
  35748. /** Defines if instancing is supported */
  35749. instancedArrays: boolean;
  35750. /** Defines if 32 bits indices are supported */
  35751. uintIndices: boolean;
  35752. /** Defines if high precision shaders are supported */
  35753. highPrecisionShaderSupported: boolean;
  35754. /** Defines if depth reading in the fragment shader is supported */
  35755. fragmentDepthSupported: boolean;
  35756. /** Defines if float texture linear filtering is supported*/
  35757. textureFloatLinearFiltering: boolean;
  35758. /** Defines if rendering to float textures is supported */
  35759. textureFloatRender: boolean;
  35760. /** Defines if half float textures are supported*/
  35761. textureHalfFloat: boolean;
  35762. /** Defines if half float texture linear filtering is supported*/
  35763. textureHalfFloatLinearFiltering: boolean;
  35764. /** Defines if rendering to half float textures is supported */
  35765. textureHalfFloatRender: boolean;
  35766. /** Defines if textureLOD shader command is supported */
  35767. textureLOD: boolean;
  35768. /** Defines if draw buffers extension is supported */
  35769. drawBuffersExtension: boolean;
  35770. /** Defines if depth textures are supported */
  35771. depthTextureExtension: boolean;
  35772. /** Defines if float color buffer are supported */
  35773. colorBufferFloat: boolean;
  35774. /** Gets disjoint timer query extension (null if not supported) */
  35775. timerQuery?: EXT_disjoint_timer_query;
  35776. /** Defines if timestamp can be used with timer query */
  35777. canUseTimestampForTimerQuery: boolean;
  35778. /** Defines if multiview is supported (https://www.khronos.org/registry/webgl/extensions/WEBGL_multiview/) */
  35779. multiview?: any;
  35780. /** Defines if oculus multiview is supported (https://developer.oculus.com/documentation/oculus-browser/latest/concepts/browser-multiview/) */
  35781. oculusMultiview?: any;
  35782. /** Function used to let the system compiles shaders in background */
  35783. parallelShaderCompile?: {
  35784. COMPLETION_STATUS_KHR: number;
  35785. };
  35786. /** Max number of texture samples for MSAA */
  35787. maxMSAASamples: number;
  35788. /** Defines if the blend min max extension is supported */
  35789. blendMinMax: boolean;
  35790. }
  35791. }
  35792. declare module "babylonjs/States/depthCullingState" {
  35793. import { Nullable } from "babylonjs/types";
  35794. /**
  35795. * @hidden
  35796. **/
  35797. export class DepthCullingState {
  35798. private _isDepthTestDirty;
  35799. private _isDepthMaskDirty;
  35800. private _isDepthFuncDirty;
  35801. private _isCullFaceDirty;
  35802. private _isCullDirty;
  35803. private _isZOffsetDirty;
  35804. private _isFrontFaceDirty;
  35805. private _depthTest;
  35806. private _depthMask;
  35807. private _depthFunc;
  35808. private _cull;
  35809. private _cullFace;
  35810. private _zOffset;
  35811. private _frontFace;
  35812. /**
  35813. * Initializes the state.
  35814. */
  35815. constructor();
  35816. get isDirty(): boolean;
  35817. get zOffset(): number;
  35818. set zOffset(value: number);
  35819. get cullFace(): Nullable<number>;
  35820. set cullFace(value: Nullable<number>);
  35821. get cull(): Nullable<boolean>;
  35822. set cull(value: Nullable<boolean>);
  35823. get depthFunc(): Nullable<number>;
  35824. set depthFunc(value: Nullable<number>);
  35825. get depthMask(): boolean;
  35826. set depthMask(value: boolean);
  35827. get depthTest(): boolean;
  35828. set depthTest(value: boolean);
  35829. get frontFace(): Nullable<number>;
  35830. set frontFace(value: Nullable<number>);
  35831. reset(): void;
  35832. apply(gl: WebGLRenderingContext): void;
  35833. }
  35834. }
  35835. declare module "babylonjs/States/stencilState" {
  35836. /**
  35837. * @hidden
  35838. **/
  35839. export class StencilState {
  35840. /** 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 */
  35841. static readonly ALWAYS: number;
  35842. /** Passed to stencilOperation to specify that stencil value must be kept */
  35843. static readonly KEEP: number;
  35844. /** Passed to stencilOperation to specify that stencil value must be replaced */
  35845. static readonly REPLACE: number;
  35846. private _isStencilTestDirty;
  35847. private _isStencilMaskDirty;
  35848. private _isStencilFuncDirty;
  35849. private _isStencilOpDirty;
  35850. private _stencilTest;
  35851. private _stencilMask;
  35852. private _stencilFunc;
  35853. private _stencilFuncRef;
  35854. private _stencilFuncMask;
  35855. private _stencilOpStencilFail;
  35856. private _stencilOpDepthFail;
  35857. private _stencilOpStencilDepthPass;
  35858. get isDirty(): boolean;
  35859. get stencilFunc(): number;
  35860. set stencilFunc(value: number);
  35861. get stencilFuncRef(): number;
  35862. set stencilFuncRef(value: number);
  35863. get stencilFuncMask(): number;
  35864. set stencilFuncMask(value: number);
  35865. get stencilOpStencilFail(): number;
  35866. set stencilOpStencilFail(value: number);
  35867. get stencilOpDepthFail(): number;
  35868. set stencilOpDepthFail(value: number);
  35869. get stencilOpStencilDepthPass(): number;
  35870. set stencilOpStencilDepthPass(value: number);
  35871. get stencilMask(): number;
  35872. set stencilMask(value: number);
  35873. get stencilTest(): boolean;
  35874. set stencilTest(value: boolean);
  35875. constructor();
  35876. reset(): void;
  35877. apply(gl: WebGLRenderingContext): void;
  35878. }
  35879. }
  35880. declare module "babylonjs/States/alphaCullingState" {
  35881. /**
  35882. * @hidden
  35883. **/
  35884. export class AlphaState {
  35885. private _isAlphaBlendDirty;
  35886. private _isBlendFunctionParametersDirty;
  35887. private _isBlendEquationParametersDirty;
  35888. private _isBlendConstantsDirty;
  35889. private _alphaBlend;
  35890. private _blendFunctionParameters;
  35891. private _blendEquationParameters;
  35892. private _blendConstants;
  35893. /**
  35894. * Initializes the state.
  35895. */
  35896. constructor();
  35897. get isDirty(): boolean;
  35898. get alphaBlend(): boolean;
  35899. set alphaBlend(value: boolean);
  35900. setAlphaBlendConstants(r: number, g: number, b: number, a: number): void;
  35901. setAlphaBlendFunctionParameters(value0: number, value1: number, value2: number, value3: number): void;
  35902. setAlphaEquationParameters(rgb: number, alpha: number): void;
  35903. reset(): void;
  35904. apply(gl: WebGLRenderingContext): void;
  35905. }
  35906. }
  35907. declare module "babylonjs/Engines/WebGL/webGL2ShaderProcessors" {
  35908. import { IShaderProcessor } from "babylonjs/Engines/Processors/iShaderProcessor";
  35909. /** @hidden */
  35910. export class WebGL2ShaderProcessor implements IShaderProcessor {
  35911. attributeProcessor(attribute: string): string;
  35912. varyingProcessor(varying: string, isFragment: boolean): string;
  35913. postProcessor(code: string, defines: string[], isFragment: boolean): string;
  35914. }
  35915. }
  35916. declare module "babylonjs/Engines/instancingAttributeInfo" {
  35917. /**
  35918. * Interface for attribute information associated with buffer instanciation
  35919. */
  35920. export interface InstancingAttributeInfo {
  35921. /**
  35922. * Name of the GLSL attribute
  35923. * if attribute index is not specified, this is used to retrieve the index from the effect
  35924. */
  35925. attributeName: string;
  35926. /**
  35927. * Index/offset of the attribute in the vertex shader
  35928. * if not specified, this will be computes from the name.
  35929. */
  35930. index?: number;
  35931. /**
  35932. * size of the attribute, 1, 2, 3 or 4
  35933. */
  35934. attributeSize: number;
  35935. /**
  35936. * Offset of the data in the Vertex Buffer acting as the instancing buffer
  35937. */
  35938. offset: number;
  35939. /**
  35940. * Modifies the rate at which generic vertex attributes advance when rendering multiple instances
  35941. * default to 1
  35942. */
  35943. divisor?: number;
  35944. /**
  35945. * type of the attribute, gl.BYTE, gl.UNSIGNED_BYTE, gl.SHORT, gl.UNSIGNED_SHORT, gl.FIXED, gl.FLOAT.
  35946. * default is FLOAT
  35947. */
  35948. attributeType?: number;
  35949. /**
  35950. * normalization of fixed-point data. behavior unclear, use FALSE, default is FALSE
  35951. */
  35952. normalized?: boolean;
  35953. }
  35954. }
  35955. declare module "babylonjs/Engines/Extensions/engine.videoTexture" {
  35956. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  35957. import { Nullable } from "babylonjs/types";
  35958. module "babylonjs/Engines/thinEngine" {
  35959. interface ThinEngine {
  35960. /**
  35961. * Update a video texture
  35962. * @param texture defines the texture to update
  35963. * @param video defines the video element to use
  35964. * @param invertY defines if data must be stored with Y axis inverted
  35965. */
  35966. updateVideoTexture(texture: Nullable<InternalTexture>, video: HTMLVideoElement, invertY: boolean): void;
  35967. }
  35968. }
  35969. }
  35970. declare module "babylonjs/Engines/Extensions/engine.dynamicTexture" {
  35971. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  35972. import { Nullable } from "babylonjs/types";
  35973. module "babylonjs/Engines/thinEngine" {
  35974. interface ThinEngine {
  35975. /**
  35976. * Creates a dynamic texture
  35977. * @param width defines the width of the texture
  35978. * @param height defines the height of the texture
  35979. * @param generateMipMaps defines if the engine should generate the mip levels
  35980. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  35981. * @returns the dynamic texture inside an InternalTexture
  35982. */
  35983. createDynamicTexture(width: number, height: number, generateMipMaps: boolean, samplingMode: number): InternalTexture;
  35984. /**
  35985. * Update the content of a dynamic texture
  35986. * @param texture defines the texture to update
  35987. * @param canvas defines the canvas containing the source
  35988. * @param invertY defines if data must be stored with Y axis inverted
  35989. * @param premulAlpha defines if alpha is stored as premultiplied
  35990. * @param format defines the format of the data
  35991. * @param forceBindTexture if the texture should be forced to be bound eg. after a graphics context loss (Default: false)
  35992. */
  35993. updateDynamicTexture(texture: Nullable<InternalTexture>, canvas: HTMLCanvasElement | OffscreenCanvas, invertY: boolean, premulAlpha?: boolean, format?: number, forceBindTexture?: boolean): void;
  35994. }
  35995. }
  35996. }
  35997. declare module "babylonjs/Materials/Textures/videoTexture" {
  35998. import { Observable } from "babylonjs/Misc/observable";
  35999. import { Nullable } from "babylonjs/types";
  36000. import { Scene } from "babylonjs/scene";
  36001. import { Texture } from "babylonjs/Materials/Textures/texture";
  36002. import "babylonjs/Engines/Extensions/engine.videoTexture";
  36003. import "babylonjs/Engines/Extensions/engine.dynamicTexture";
  36004. /**
  36005. * Settings for finer control over video usage
  36006. */
  36007. export interface VideoTextureSettings {
  36008. /**
  36009. * Applies `autoplay` to video, if specified
  36010. */
  36011. autoPlay?: boolean;
  36012. /**
  36013. * Applies `loop` to video, if specified
  36014. */
  36015. loop?: boolean;
  36016. /**
  36017. * Automatically updates internal texture from video at every frame in the render loop
  36018. */
  36019. autoUpdateTexture: boolean;
  36020. /**
  36021. * Image src displayed during the video loading or until the user interacts with the video.
  36022. */
  36023. poster?: string;
  36024. }
  36025. /**
  36026. * If you want to display a video in your scene, this is the special texture for that.
  36027. * This special texture works similar to other textures, with the exception of a few parameters.
  36028. * @see https://doc.babylonjs.com/how_to/video_texture
  36029. */
  36030. export class VideoTexture extends Texture {
  36031. /**
  36032. * Tells whether textures will be updated automatically or user is required to call `updateTexture` manually
  36033. */
  36034. readonly autoUpdateTexture: boolean;
  36035. /**
  36036. * The video instance used by the texture internally
  36037. */
  36038. readonly video: HTMLVideoElement;
  36039. private _onUserActionRequestedObservable;
  36040. /**
  36041. * Event triggerd when a dom action is required by the user to play the video.
  36042. * This happens due to recent changes in browser policies preventing video to auto start.
  36043. */
  36044. get onUserActionRequestedObservable(): Observable<Texture>;
  36045. private _generateMipMaps;
  36046. private _stillImageCaptured;
  36047. private _displayingPosterTexture;
  36048. private _settings;
  36049. private _createInternalTextureOnEvent;
  36050. private _frameId;
  36051. private _currentSrc;
  36052. /**
  36053. * Creates a video texture.
  36054. * If you want to display a video in your scene, this is the special texture for that.
  36055. * This special texture works similar to other textures, with the exception of a few parameters.
  36056. * @see https://doc.babylonjs.com/how_to/video_texture
  36057. * @param name optional name, will detect from video source, if not defined
  36058. * @param src can be used to provide an url, array of urls or an already setup HTML video element.
  36059. * @param scene is obviously the current scene.
  36060. * @param generateMipMaps can be used to turn on mipmaps (Can be expensive for videoTextures because they are often updated).
  36061. * @param invertY is false by default but can be used to invert video on Y axis
  36062. * @param samplingMode controls the sampling method and is set to TRILINEAR_SAMPLINGMODE by default
  36063. * @param settings allows finer control over video usage
  36064. */
  36065. constructor(name: Nullable<string>, src: string | string[] | HTMLVideoElement, scene: Nullable<Scene>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, settings?: VideoTextureSettings);
  36066. private _getName;
  36067. private _getVideo;
  36068. private _createInternalTexture;
  36069. private reset;
  36070. /**
  36071. * @hidden Internal method to initiate `update`.
  36072. */
  36073. _rebuild(): void;
  36074. /**
  36075. * Update Texture in the `auto` mode. Does not do anything if `settings.autoUpdateTexture` is false.
  36076. */
  36077. update(): void;
  36078. /**
  36079. * Update Texture in `manual` mode. Does not do anything if not visible or paused.
  36080. * @param isVisible Visibility state, detected by user using `scene.getActiveMeshes()` or othervise.
  36081. */
  36082. updateTexture(isVisible: boolean): void;
  36083. protected _updateInternalTexture: () => void;
  36084. /**
  36085. * Change video content. Changing video instance or setting multiple urls (as in constructor) is not supported.
  36086. * @param url New url.
  36087. */
  36088. updateURL(url: string): void;
  36089. /**
  36090. * Clones the texture.
  36091. * @returns the cloned texture
  36092. */
  36093. clone(): VideoTexture;
  36094. /**
  36095. * Dispose the texture and release its associated resources.
  36096. */
  36097. dispose(): void;
  36098. /**
  36099. * Creates a video texture straight from a stream.
  36100. * @param scene Define the scene the texture should be created in
  36101. * @param stream Define the stream the texture should be created from
  36102. * @returns The created video texture as a promise
  36103. */
  36104. static CreateFromStreamAsync(scene: Scene, stream: MediaStream): Promise<VideoTexture>;
  36105. /**
  36106. * Creates a video texture straight from your WebCam video feed.
  36107. * @param scene Define the scene the texture should be created in
  36108. * @param constraints Define the constraints to use to create the web cam feed from WebRTC
  36109. * @param audioConstaints Define the audio constraints to use to create the web cam feed from WebRTC
  36110. * @returns The created video texture as a promise
  36111. */
  36112. static CreateFromWebCamAsync(scene: Scene, constraints: {
  36113. minWidth: number;
  36114. maxWidth: number;
  36115. minHeight: number;
  36116. maxHeight: number;
  36117. deviceId: string;
  36118. } & MediaTrackConstraints, audioConstaints?: boolean | MediaTrackConstraints): Promise<VideoTexture>;
  36119. /**
  36120. * Creates a video texture straight from your WebCam video feed.
  36121. * @param scene Define the scene the texture should be created in
  36122. * @param onReady Define a callback to triggered once the texture will be ready
  36123. * @param constraints Define the constraints to use to create the web cam feed from WebRTC
  36124. * @param audioConstaints Define the audio constraints to use to create the web cam feed from WebRTC
  36125. */
  36126. static CreateFromWebCam(scene: Scene, onReady: (videoTexture: VideoTexture) => void, constraints: {
  36127. minWidth: number;
  36128. maxWidth: number;
  36129. minHeight: number;
  36130. maxHeight: number;
  36131. deviceId: string;
  36132. } & MediaTrackConstraints, audioConstaints?: boolean | MediaTrackConstraints): void;
  36133. }
  36134. }
  36135. declare module "babylonjs/Engines/thinEngine" {
  36136. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  36137. import { Effect, IEffectCreationOptions } from "babylonjs/Materials/effect";
  36138. import { IShaderProcessor } from "babylonjs/Engines/Processors/iShaderProcessor";
  36139. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  36140. import { Nullable, DataArray, IndicesArray } from "babylonjs/types";
  36141. import { EngineCapabilities } from "babylonjs/Engines/engineCapabilities";
  36142. import { Observable } from "babylonjs/Misc/observable";
  36143. import { DepthCullingState } from "babylonjs/States/depthCullingState";
  36144. import { StencilState } from "babylonjs/States/stencilState";
  36145. import { AlphaState } from "babylonjs/States/alphaCullingState";
  36146. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  36147. import { IViewportLike, IColor4Like } from "babylonjs/Maths/math.like";
  36148. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  36149. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  36150. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  36151. import { WebGLPipelineContext } from "babylonjs/Engines/WebGL/webGLPipelineContext";
  36152. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  36153. import { InstancingAttributeInfo } from "babylonjs/Engines/instancingAttributeInfo";
  36154. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  36155. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  36156. import { IEffectFallbacks } from "babylonjs/Materials/iEffectFallbacks";
  36157. import { IWebRequest } from "babylonjs/Misc/interfaces/iWebRequest";
  36158. import { WebRequest } from "babylonjs/Misc/webRequest";
  36159. import { LoadFileError } from "babylonjs/Misc/fileTools";
  36160. /**
  36161. * Defines the interface used by objects working like Scene
  36162. * @hidden
  36163. */
  36164. export interface ISceneLike {
  36165. _addPendingData(data: any): void;
  36166. _removePendingData(data: any): void;
  36167. offlineProvider: IOfflineProvider;
  36168. }
  36169. /** Interface defining initialization parameters for Engine class */
  36170. export interface EngineOptions extends WebGLContextAttributes {
  36171. /**
  36172. * Defines if the engine should no exceed a specified device ratio
  36173. * @see https://developer.mozilla.org/en-US/docs/Web/API/Window/devicePixelRatio
  36174. */
  36175. limitDeviceRatio?: number;
  36176. /**
  36177. * Defines if webvr should be enabled automatically
  36178. * @see https://doc.babylonjs.com/how_to/webvr_camera
  36179. */
  36180. autoEnableWebVR?: boolean;
  36181. /**
  36182. * Defines if webgl2 should be turned off even if supported
  36183. * @see https://doc.babylonjs.com/features/webgl2
  36184. */
  36185. disableWebGL2Support?: boolean;
  36186. /**
  36187. * Defines if webaudio should be initialized as well
  36188. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  36189. */
  36190. audioEngine?: boolean;
  36191. /**
  36192. * Defines if animations should run using a deterministic lock step
  36193. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  36194. */
  36195. deterministicLockstep?: boolean;
  36196. /** Defines the maximum steps to use with deterministic lock step mode */
  36197. lockstepMaxSteps?: number;
  36198. /** Defines the seconds between each deterministic lock step */
  36199. timeStep?: number;
  36200. /**
  36201. * Defines that engine should ignore context lost events
  36202. * If this event happens when this parameter is true, you will have to reload the page to restore rendering
  36203. */
  36204. doNotHandleContextLost?: boolean;
  36205. /**
  36206. * Defines that engine should ignore modifying touch action attribute and style
  36207. * If not handle, you might need to set it up on your side for expected touch devices behavior.
  36208. */
  36209. doNotHandleTouchAction?: boolean;
  36210. /**
  36211. * Defines that engine should compile shaders with high precision floats (if supported). True by default
  36212. */
  36213. useHighPrecisionFloats?: boolean;
  36214. /**
  36215. * Make the canvas XR Compatible for XR sessions
  36216. */
  36217. xrCompatible?: boolean;
  36218. /**
  36219. * Make the matrix computations to be performed in 64 bits instead of 32 bits. False by default
  36220. */
  36221. useHighPrecisionMatrix?: boolean;
  36222. }
  36223. /**
  36224. * The base engine class (root of all engines)
  36225. */
  36226. export class ThinEngine {
  36227. /** Use this array to turn off some WebGL2 features on known buggy browsers version */
  36228. static ExceptionList: ({
  36229. key: string;
  36230. capture: string;
  36231. captureConstraint: number;
  36232. targets: string[];
  36233. } | {
  36234. key: string;
  36235. capture: null;
  36236. captureConstraint: null;
  36237. targets: string[];
  36238. })[];
  36239. /** @hidden */
  36240. static _TextureLoaders: IInternalTextureLoader[];
  36241. /**
  36242. * Returns the current npm package of the sdk
  36243. */
  36244. static get NpmPackage(): string;
  36245. /**
  36246. * Returns the current version of the framework
  36247. */
  36248. static get Version(): string;
  36249. /**
  36250. * Returns a string describing the current engine
  36251. */
  36252. get description(): string;
  36253. /**
  36254. * Gets or sets the epsilon value used by collision engine
  36255. */
  36256. static CollisionsEpsilon: number;
  36257. /**
  36258. * Gets or sets the relative url used to load shaders if using the engine in non-minified mode
  36259. */
  36260. static get ShadersRepository(): string;
  36261. static set ShadersRepository(value: string);
  36262. /** @hidden */
  36263. _shaderProcessor: IShaderProcessor;
  36264. /**
  36265. * Gets or sets a boolean that indicates if textures must be forced to power of 2 size even if not required
  36266. */
  36267. forcePOTTextures: boolean;
  36268. /**
  36269. * Gets a boolean indicating if the engine is currently rendering in fullscreen mode
  36270. */
  36271. isFullscreen: boolean;
  36272. /**
  36273. * Gets or sets a boolean indicating if back faces must be culled (true by default)
  36274. */
  36275. cullBackFaces: boolean;
  36276. /**
  36277. * Gets or sets a boolean indicating if the engine must keep rendering even if the window is not in foregroun
  36278. */
  36279. renderEvenInBackground: boolean;
  36280. /**
  36281. * Gets or sets a boolean indicating that cache can be kept between frames
  36282. */
  36283. preventCacheWipeBetweenFrames: boolean;
  36284. /** Gets or sets a boolean indicating if the engine should validate programs after compilation */
  36285. validateShaderPrograms: boolean;
  36286. /**
  36287. * Gets or sets a boolean indicating if depth buffer should be reverse, going from far to near.
  36288. * This can provide greater z depth for distant objects.
  36289. */
  36290. useReverseDepthBuffer: boolean;
  36291. /**
  36292. * Gets or sets a boolean indicating that uniform buffers must be disabled even if they are supported
  36293. */
  36294. disableUniformBuffers: boolean;
  36295. /** @hidden */
  36296. _uniformBuffers: UniformBuffer[];
  36297. /**
  36298. * Gets a boolean indicating that the engine supports uniform buffers
  36299. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  36300. */
  36301. get supportsUniformBuffers(): boolean;
  36302. /** @hidden */
  36303. _gl: WebGLRenderingContext;
  36304. /** @hidden */
  36305. _webGLVersion: number;
  36306. protected _renderingCanvas: Nullable<HTMLCanvasElement>;
  36307. protected _windowIsBackground: boolean;
  36308. protected _creationOptions: EngineOptions;
  36309. protected _highPrecisionShadersAllowed: boolean;
  36310. /** @hidden */
  36311. get _shouldUseHighPrecisionShader(): boolean;
  36312. /**
  36313. * Gets a boolean indicating that only power of 2 textures are supported
  36314. * Please note that you can still use non power of 2 textures but in this case the engine will forcefully convert them
  36315. */
  36316. get needPOTTextures(): boolean;
  36317. /** @hidden */
  36318. _badOS: boolean;
  36319. /** @hidden */
  36320. _badDesktopOS: boolean;
  36321. private _hardwareScalingLevel;
  36322. /** @hidden */
  36323. _caps: EngineCapabilities;
  36324. private _isStencilEnable;
  36325. private _glVersion;
  36326. private _glRenderer;
  36327. private _glVendor;
  36328. /** @hidden */
  36329. _videoTextureSupported: boolean;
  36330. protected _renderingQueueLaunched: boolean;
  36331. protected _activeRenderLoops: (() => void)[];
  36332. /**
  36333. * Observable signaled when a context lost event is raised
  36334. */
  36335. onContextLostObservable: Observable<ThinEngine>;
  36336. /**
  36337. * Observable signaled when a context restored event is raised
  36338. */
  36339. onContextRestoredObservable: Observable<ThinEngine>;
  36340. private _onContextLost;
  36341. private _onContextRestored;
  36342. protected _contextWasLost: boolean;
  36343. /** @hidden */
  36344. _doNotHandleContextLost: boolean;
  36345. /**
  36346. * Gets or sets a boolean indicating if resources should be retained to be able to handle context lost events
  36347. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#handling-webgl-context-lost
  36348. */
  36349. get doNotHandleContextLost(): boolean;
  36350. set doNotHandleContextLost(value: boolean);
  36351. /**
  36352. * Gets or sets a boolean indicating that vertex array object must be disabled even if they are supported
  36353. */
  36354. disableVertexArrayObjects: boolean;
  36355. /** @hidden */
  36356. protected _colorWrite: boolean;
  36357. /** @hidden */
  36358. protected _colorWriteChanged: boolean;
  36359. /** @hidden */
  36360. protected _depthCullingState: DepthCullingState;
  36361. /** @hidden */
  36362. protected _stencilState: StencilState;
  36363. /** @hidden */
  36364. _alphaState: AlphaState;
  36365. /** @hidden */
  36366. _alphaMode: number;
  36367. /** @hidden */
  36368. _alphaEquation: number;
  36369. /** @hidden */
  36370. _internalTexturesCache: InternalTexture[];
  36371. /** @hidden */
  36372. protected _activeChannel: number;
  36373. private _currentTextureChannel;
  36374. /** @hidden */
  36375. protected _boundTexturesCache: {
  36376. [key: string]: Nullable<InternalTexture>;
  36377. };
  36378. /** @hidden */
  36379. protected _currentEffect: Nullable<Effect>;
  36380. /** @hidden */
  36381. protected _currentProgram: Nullable<WebGLProgram>;
  36382. private _compiledEffects;
  36383. private _vertexAttribArraysEnabled;
  36384. /** @hidden */
  36385. protected _cachedViewport: Nullable<IViewportLike>;
  36386. private _cachedVertexArrayObject;
  36387. /** @hidden */
  36388. protected _cachedVertexBuffers: any;
  36389. /** @hidden */
  36390. protected _cachedIndexBuffer: Nullable<DataBuffer>;
  36391. /** @hidden */
  36392. protected _cachedEffectForVertexBuffers: Nullable<Effect>;
  36393. /** @hidden */
  36394. _currentRenderTarget: Nullable<InternalTexture>;
  36395. private _uintIndicesCurrentlySet;
  36396. protected _currentBoundBuffer: Nullable<WebGLBuffer>[];
  36397. /** @hidden */
  36398. _currentFramebuffer: Nullable<WebGLFramebuffer>;
  36399. /** @hidden */
  36400. _dummyFramebuffer: Nullable<WebGLFramebuffer>;
  36401. private _currentBufferPointers;
  36402. private _currentInstanceLocations;
  36403. private _currentInstanceBuffers;
  36404. private _textureUnits;
  36405. /** @hidden */
  36406. _workingCanvas: Nullable<HTMLCanvasElement | OffscreenCanvas>;
  36407. /** @hidden */
  36408. _workingContext: Nullable<CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D>;
  36409. /** @hidden */
  36410. _boundRenderFunction: any;
  36411. private _vaoRecordInProgress;
  36412. private _mustWipeVertexAttributes;
  36413. private _emptyTexture;
  36414. private _emptyCubeTexture;
  36415. private _emptyTexture3D;
  36416. private _emptyTexture2DArray;
  36417. /** @hidden */
  36418. _frameHandler: number;
  36419. private _nextFreeTextureSlots;
  36420. private _maxSimultaneousTextures;
  36421. private _activeRequests;
  36422. /** @hidden */
  36423. _transformTextureUrl: Nullable<(url: string) => string>;
  36424. protected get _supportsHardwareTextureRescaling(): boolean;
  36425. private _framebufferDimensionsObject;
  36426. /**
  36427. * sets the object from which width and height will be taken from when getting render width and height
  36428. * Will fallback to the gl object
  36429. * @param dimensions the framebuffer width and height that will be used.
  36430. */
  36431. set framebufferDimensionsObject(dimensions: Nullable<{
  36432. framebufferWidth: number;
  36433. framebufferHeight: number;
  36434. }>);
  36435. /**
  36436. * Gets the current viewport
  36437. */
  36438. get currentViewport(): Nullable<IViewportLike>;
  36439. /**
  36440. * Gets the default empty texture
  36441. */
  36442. get emptyTexture(): InternalTexture;
  36443. /**
  36444. * Gets the default empty 3D texture
  36445. */
  36446. get emptyTexture3D(): InternalTexture;
  36447. /**
  36448. * Gets the default empty 2D array texture
  36449. */
  36450. get emptyTexture2DArray(): InternalTexture;
  36451. /**
  36452. * Gets the default empty cube texture
  36453. */
  36454. get emptyCubeTexture(): InternalTexture;
  36455. /**
  36456. * Defines whether the engine has been created with the premultipliedAlpha option on or not.
  36457. */
  36458. readonly premultipliedAlpha: boolean;
  36459. /**
  36460. * Observable event triggered before each texture is initialized
  36461. */
  36462. onBeforeTextureInitObservable: Observable<import("babylonjs/Materials/Textures/texture").Texture>;
  36463. /**
  36464. * Creates a new engine
  36465. * @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
  36466. * @param antialias defines enable antialiasing (default: false)
  36467. * @param options defines further options to be sent to the getContext() function
  36468. * @param adaptToDeviceRatio defines whether to adapt to the device's viewport characteristics (default: false)
  36469. */
  36470. constructor(canvasOrContext: Nullable<HTMLCanvasElement | WebGLRenderingContext | WebGL2RenderingContext>, antialias?: boolean, options?: EngineOptions, adaptToDeviceRatio?: boolean);
  36471. private _rebuildInternalTextures;
  36472. private _rebuildEffects;
  36473. /**
  36474. * Gets a boolean indicating if all created effects are ready
  36475. * @returns true if all effects are ready
  36476. */
  36477. areAllEffectsReady(): boolean;
  36478. protected _rebuildBuffers(): void;
  36479. protected _initGLContext(): void;
  36480. /**
  36481. * Gets version of the current webGL context
  36482. */
  36483. get webGLVersion(): number;
  36484. /**
  36485. * Gets a string idenfifying the name of the class
  36486. * @returns "Engine" string
  36487. */
  36488. getClassName(): string;
  36489. /**
  36490. * Returns true if the stencil buffer has been enabled through the creation option of the context.
  36491. */
  36492. get isStencilEnable(): boolean;
  36493. /** @hidden */
  36494. _prepareWorkingCanvas(): void;
  36495. /**
  36496. * Reset the texture cache to empty state
  36497. */
  36498. resetTextureCache(): void;
  36499. /**
  36500. * Gets an object containing information about the current webGL context
  36501. * @returns an object containing the vender, the renderer and the version of the current webGL context
  36502. */
  36503. getGlInfo(): {
  36504. vendor: string;
  36505. renderer: string;
  36506. version: string;
  36507. };
  36508. /**
  36509. * Defines the hardware scaling level.
  36510. * By default the hardware scaling level is computed from the window device ratio.
  36511. * 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.
  36512. * @param level defines the level to use
  36513. */
  36514. setHardwareScalingLevel(level: number): void;
  36515. /**
  36516. * Gets the current hardware scaling level.
  36517. * By default the hardware scaling level is computed from the window device ratio.
  36518. * 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.
  36519. * @returns a number indicating the current hardware scaling level
  36520. */
  36521. getHardwareScalingLevel(): number;
  36522. /**
  36523. * Gets the list of loaded textures
  36524. * @returns an array containing all loaded textures
  36525. */
  36526. getLoadedTexturesCache(): InternalTexture[];
  36527. /**
  36528. * Gets the object containing all engine capabilities
  36529. * @returns the EngineCapabilities object
  36530. */
  36531. getCaps(): EngineCapabilities;
  36532. /**
  36533. * stop executing a render loop function and remove it from the execution array
  36534. * @param renderFunction defines the function to be removed. If not provided all functions will be removed.
  36535. */
  36536. stopRenderLoop(renderFunction?: () => void): void;
  36537. /** @hidden */
  36538. _renderLoop(): void;
  36539. /**
  36540. * Gets the HTML canvas attached with the current webGL context
  36541. * @returns a HTML canvas
  36542. */
  36543. getRenderingCanvas(): Nullable<HTMLCanvasElement>;
  36544. /**
  36545. * Gets host window
  36546. * @returns the host window object
  36547. */
  36548. getHostWindow(): Nullable<Window>;
  36549. /**
  36550. * Gets the current render width
  36551. * @param useScreen defines if screen size must be used (or the current render target if any)
  36552. * @returns a number defining the current render width
  36553. */
  36554. getRenderWidth(useScreen?: boolean): number;
  36555. /**
  36556. * Gets the current render height
  36557. * @param useScreen defines if screen size must be used (or the current render target if any)
  36558. * @returns a number defining the current render height
  36559. */
  36560. getRenderHeight(useScreen?: boolean): number;
  36561. /**
  36562. * Can be used to override the current requestAnimationFrame requester.
  36563. * @hidden
  36564. */
  36565. protected _queueNewFrame(bindedRenderFunction: any, requester?: any): number;
  36566. /**
  36567. * Register and execute a render loop. The engine can have more than one render function
  36568. * @param renderFunction defines the function to continuously execute
  36569. */
  36570. runRenderLoop(renderFunction: () => void): void;
  36571. /**
  36572. * Clear the current render buffer or the current render target (if any is set up)
  36573. * @param color defines the color to use
  36574. * @param backBuffer defines if the back buffer must be cleared
  36575. * @param depth defines if the depth buffer must be cleared
  36576. * @param stencil defines if the stencil buffer must be cleared
  36577. */
  36578. clear(color: Nullable<IColor4Like>, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  36579. private _viewportCached;
  36580. /** @hidden */
  36581. _viewport(x: number, y: number, width: number, height: number): void;
  36582. /**
  36583. * Set the WebGL's viewport
  36584. * @param viewport defines the viewport element to be used
  36585. * @param requiredWidth defines the width required for rendering. If not provided the rendering canvas' width is used
  36586. * @param requiredHeight defines the height required for rendering. If not provided the rendering canvas' height is used
  36587. */
  36588. setViewport(viewport: IViewportLike, requiredWidth?: number, requiredHeight?: number): void;
  36589. /**
  36590. * Begin a new frame
  36591. */
  36592. beginFrame(): void;
  36593. /**
  36594. * Enf the current frame
  36595. */
  36596. endFrame(): void;
  36597. /**
  36598. * Resize the view according to the canvas' size
  36599. */
  36600. resize(): void;
  36601. /**
  36602. * Force a specific size of the canvas
  36603. * @param width defines the new canvas' width
  36604. * @param height defines the new canvas' height
  36605. * @returns true if the size was changed
  36606. */
  36607. setSize(width: number, height: number): boolean;
  36608. /**
  36609. * Binds the frame buffer to the specified texture.
  36610. * @param texture The texture to render to or null for the default canvas
  36611. * @param faceIndex The face of the texture to render to in case of cube texture
  36612. * @param requiredWidth The width of the target to render to
  36613. * @param requiredHeight The height of the target to render to
  36614. * @param forceFullscreenViewport Forces the viewport to be the entire texture/screen if true
  36615. * @param lodLevel defines the lod level to bind to the frame buffer
  36616. * @param layer defines the 2d array index to bind to frame buffer to
  36617. */
  36618. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean, lodLevel?: number, layer?: number): void;
  36619. /** @hidden */
  36620. _bindUnboundFramebuffer(framebuffer: Nullable<WebGLFramebuffer>): void;
  36621. /**
  36622. * Unbind the current render target texture from the webGL context
  36623. * @param texture defines the render target texture to unbind
  36624. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  36625. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  36626. */
  36627. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  36628. /**
  36629. * Force a webGL flush (ie. a flush of all waiting webGL commands)
  36630. */
  36631. flushFramebuffer(): void;
  36632. /**
  36633. * Unbind the current render target and bind the default framebuffer
  36634. */
  36635. restoreDefaultFramebuffer(): void;
  36636. /** @hidden */
  36637. protected _resetVertexBufferBinding(): void;
  36638. /**
  36639. * Creates a vertex buffer
  36640. * @param data the data for the vertex buffer
  36641. * @returns the new WebGL static buffer
  36642. */
  36643. createVertexBuffer(data: DataArray): DataBuffer;
  36644. private _createVertexBuffer;
  36645. /**
  36646. * Creates a dynamic vertex buffer
  36647. * @param data the data for the dynamic vertex buffer
  36648. * @returns the new WebGL dynamic buffer
  36649. */
  36650. createDynamicVertexBuffer(data: DataArray): DataBuffer;
  36651. protected _resetIndexBufferBinding(): void;
  36652. /**
  36653. * Creates a new index buffer
  36654. * @param indices defines the content of the index buffer
  36655. * @param updatable defines if the index buffer must be updatable
  36656. * @returns a new webGL buffer
  36657. */
  36658. createIndexBuffer(indices: IndicesArray, updatable?: boolean): DataBuffer;
  36659. protected _normalizeIndexData(indices: IndicesArray): Uint16Array | Uint32Array;
  36660. /**
  36661. * Bind a webGL buffer to the webGL context
  36662. * @param buffer defines the buffer to bind
  36663. */
  36664. bindArrayBuffer(buffer: Nullable<DataBuffer>): void;
  36665. protected bindIndexBuffer(buffer: Nullable<DataBuffer>): void;
  36666. private bindBuffer;
  36667. /**
  36668. * update the bound buffer with the given data
  36669. * @param data defines the data to update
  36670. */
  36671. updateArrayBuffer(data: Float32Array): void;
  36672. private _vertexAttribPointer;
  36673. /** @hidden */
  36674. _bindIndexBufferWithCache(indexBuffer: Nullable<DataBuffer>): void;
  36675. private _bindVertexBuffersAttributes;
  36676. /**
  36677. * Records a vertex array object
  36678. * @see https://doc.babylonjs.com/features/webgl2#vertex-array-objects
  36679. * @param vertexBuffers defines the list of vertex buffers to store
  36680. * @param indexBuffer defines the index buffer to store
  36681. * @param effect defines the effect to store
  36682. * @returns the new vertex array object
  36683. */
  36684. recordVertexArrayObject(vertexBuffers: {
  36685. [key: string]: VertexBuffer;
  36686. }, indexBuffer: Nullable<DataBuffer>, effect: Effect): WebGLVertexArrayObject;
  36687. /**
  36688. * Bind a specific vertex array object
  36689. * @see https://doc.babylonjs.com/features/webgl2#vertex-array-objects
  36690. * @param vertexArrayObject defines the vertex array object to bind
  36691. * @param indexBuffer defines the index buffer to bind
  36692. */
  36693. bindVertexArrayObject(vertexArrayObject: WebGLVertexArrayObject, indexBuffer: Nullable<DataBuffer>): void;
  36694. /**
  36695. * Bind webGl buffers directly to the webGL context
  36696. * @param vertexBuffer defines the vertex buffer to bind
  36697. * @param indexBuffer defines the index buffer to bind
  36698. * @param vertexDeclaration defines the vertex declaration to use with the vertex buffer
  36699. * @param vertexStrideSize defines the vertex stride of the vertex buffer
  36700. * @param effect defines the effect associated with the vertex buffer
  36701. */
  36702. bindBuffersDirectly(vertexBuffer: DataBuffer, indexBuffer: DataBuffer, vertexDeclaration: number[], vertexStrideSize: number, effect: Effect): void;
  36703. private _unbindVertexArrayObject;
  36704. /**
  36705. * Bind a list of vertex buffers to the webGL context
  36706. * @param vertexBuffers defines the list of vertex buffers to bind
  36707. * @param indexBuffer defines the index buffer to bind
  36708. * @param effect defines the effect associated with the vertex buffers
  36709. */
  36710. bindBuffers(vertexBuffers: {
  36711. [key: string]: Nullable<VertexBuffer>;
  36712. }, indexBuffer: Nullable<DataBuffer>, effect: Effect): void;
  36713. /**
  36714. * Unbind all instance attributes
  36715. */
  36716. unbindInstanceAttributes(): void;
  36717. /**
  36718. * Release and free the memory of a vertex array object
  36719. * @param vao defines the vertex array object to delete
  36720. */
  36721. releaseVertexArrayObject(vao: WebGLVertexArrayObject): void;
  36722. /** @hidden */
  36723. _releaseBuffer(buffer: DataBuffer): boolean;
  36724. protected _deleteBuffer(buffer: DataBuffer): void;
  36725. /**
  36726. * Update the content of a webGL buffer used with instanciation and bind it to the webGL context
  36727. * @param instancesBuffer defines the webGL buffer to update and bind
  36728. * @param data defines the data to store in the buffer
  36729. * @param offsetLocations defines the offsets or attributes information used to determine where data must be stored in the buffer
  36730. */
  36731. updateAndBindInstancesBuffer(instancesBuffer: DataBuffer, data: Float32Array, offsetLocations: number[] | InstancingAttributeInfo[]): void;
  36732. /**
  36733. * Bind the content of a webGL buffer used with instantiation
  36734. * @param instancesBuffer defines the webGL buffer to bind
  36735. * @param attributesInfo defines the offsets or attributes information used to determine where data must be stored in the buffer
  36736. * @param computeStride defines Whether to compute the strides from the info or use the default 0
  36737. */
  36738. bindInstancesBuffer(instancesBuffer: DataBuffer, attributesInfo: InstancingAttributeInfo[], computeStride?: boolean): void;
  36739. /**
  36740. * Disable the instance attribute corresponding to the name in parameter
  36741. * @param name defines the name of the attribute to disable
  36742. */
  36743. disableInstanceAttributeByName(name: string): void;
  36744. /**
  36745. * Disable the instance attribute corresponding to the location in parameter
  36746. * @param attributeLocation defines the attribute location of the attribute to disable
  36747. */
  36748. disableInstanceAttribute(attributeLocation: number): void;
  36749. /**
  36750. * Disable the attribute corresponding to the location in parameter
  36751. * @param attributeLocation defines the attribute location of the attribute to disable
  36752. */
  36753. disableAttributeByIndex(attributeLocation: number): void;
  36754. /**
  36755. * Send a draw order
  36756. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  36757. * @param indexStart defines the starting index
  36758. * @param indexCount defines the number of index to draw
  36759. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  36760. */
  36761. draw(useTriangles: boolean, indexStart: number, indexCount: number, instancesCount?: number): void;
  36762. /**
  36763. * Draw a list of points
  36764. * @param verticesStart defines the index of first vertex to draw
  36765. * @param verticesCount defines the count of vertices to draw
  36766. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  36767. */
  36768. drawPointClouds(verticesStart: number, verticesCount: number, instancesCount?: number): void;
  36769. /**
  36770. * Draw a list of unindexed primitives
  36771. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  36772. * @param verticesStart defines the index of first vertex to draw
  36773. * @param verticesCount defines the count of vertices to draw
  36774. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  36775. */
  36776. drawUnIndexed(useTriangles: boolean, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  36777. /**
  36778. * Draw a list of indexed primitives
  36779. * @param fillMode defines the primitive to use
  36780. * @param indexStart defines the starting index
  36781. * @param indexCount defines the number of index to draw
  36782. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  36783. */
  36784. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  36785. /**
  36786. * Draw a list of unindexed primitives
  36787. * @param fillMode defines the primitive to use
  36788. * @param verticesStart defines the index of first vertex to draw
  36789. * @param verticesCount defines the count of vertices to draw
  36790. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  36791. */
  36792. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  36793. private _drawMode;
  36794. /** @hidden */
  36795. protected _reportDrawCall(): void;
  36796. /** @hidden */
  36797. _releaseEffect(effect: Effect): void;
  36798. /** @hidden */
  36799. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  36800. /**
  36801. * Create a new effect (used to store vertex/fragment shaders)
  36802. * @param baseName defines the base name of the effect (The name of file without .fragment.fx or .vertex.fx)
  36803. * @param attributesNamesOrOptions defines either a list of attribute names or an IEffectCreationOptions object
  36804. * @param uniformsNamesOrEngine defines either a list of uniform names or the engine to use
  36805. * @param samplers defines an array of string used to represent textures
  36806. * @param defines defines the string containing the defines to use to compile the shaders
  36807. * @param fallbacks defines the list of potential fallbacks to use if shader conmpilation fails
  36808. * @param onCompiled defines a function to call when the effect creation is successful
  36809. * @param onError defines a function to call when the effect creation has failed
  36810. * @param indexParameters defines an object containing the index values to use to compile shaders (like the maximum number of simultaneous lights)
  36811. * @returns the new Effect
  36812. */
  36813. 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;
  36814. protected static _ConcatenateShader(source: string, defines: Nullable<string>, shaderVersion?: string): string;
  36815. private _compileShader;
  36816. private _compileRawShader;
  36817. /** @hidden */
  36818. _getShaderSource(shader: WebGLShader): Nullable<string>;
  36819. /**
  36820. * Directly creates a webGL program
  36821. * @param pipelineContext defines the pipeline context to attach to
  36822. * @param vertexCode defines the vertex shader code to use
  36823. * @param fragmentCode defines the fragment shader code to use
  36824. * @param context defines the webGL context to use (if not set, the current one will be used)
  36825. * @param transformFeedbackVaryings defines the list of transform feedback varyings to use
  36826. * @returns the new webGL program
  36827. */
  36828. createRawShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  36829. /**
  36830. * Creates a webGL program
  36831. * @param pipelineContext defines the pipeline context to attach to
  36832. * @param vertexCode defines the vertex shader code to use
  36833. * @param fragmentCode defines the fragment shader code to use
  36834. * @param defines defines the string containing the defines to use to compile the shaders
  36835. * @param context defines the webGL context to use (if not set, the current one will be used)
  36836. * @param transformFeedbackVaryings defines the list of transform feedback varyings to use
  36837. * @returns the new webGL program
  36838. */
  36839. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  36840. /**
  36841. * Creates a new pipeline context
  36842. * @returns the new pipeline
  36843. */
  36844. createPipelineContext(): IPipelineContext;
  36845. protected _createShaderProgram(pipelineContext: WebGLPipelineContext, vertexShader: WebGLShader, fragmentShader: WebGLShader, context: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  36846. protected _finalizePipelineContext(pipelineContext: WebGLPipelineContext): void;
  36847. /** @hidden */
  36848. _preparePipelineContext(pipelineContext: IPipelineContext, vertexSourceCode: string, fragmentSourceCode: string, createAsRaw: boolean, rebuildRebind: any, defines: Nullable<string>, transformFeedbackVaryings: Nullable<string[]>): void;
  36849. /** @hidden */
  36850. _isRenderingStateCompiled(pipelineContext: IPipelineContext): boolean;
  36851. /** @hidden */
  36852. _executeWhenRenderingStateIsCompiled(pipelineContext: IPipelineContext, action: () => void): void;
  36853. /**
  36854. * Gets the list of webGL uniform locations associated with a specific program based on a list of uniform names
  36855. * @param pipelineContext defines the pipeline context to use
  36856. * @param uniformsNames defines the list of uniform names
  36857. * @returns an array of webGL uniform locations
  36858. */
  36859. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): Nullable<WebGLUniformLocation>[];
  36860. /**
  36861. * Gets the lsit of active attributes for a given webGL program
  36862. * @param pipelineContext defines the pipeline context to use
  36863. * @param attributesNames defines the list of attribute names to get
  36864. * @returns an array of indices indicating the offset of each attribute
  36865. */
  36866. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  36867. /**
  36868. * Activates an effect, mkaing it the current one (ie. the one used for rendering)
  36869. * @param effect defines the effect to activate
  36870. */
  36871. enableEffect(effect: Nullable<Effect>): void;
  36872. /**
  36873. * Set the value of an uniform to a number (int)
  36874. * @param uniform defines the webGL uniform location where to store the value
  36875. * @param value defines the int number to store
  36876. */
  36877. setInt(uniform: Nullable<WebGLUniformLocation>, value: number): void;
  36878. /**
  36879. * Set the value of an uniform to an array of int32
  36880. * @param uniform defines the webGL uniform location where to store the value
  36881. * @param array defines the array of int32 to store
  36882. */
  36883. setIntArray(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  36884. /**
  36885. * Set the value of an uniform to an array of int32 (stored as vec2)
  36886. * @param uniform defines the webGL uniform location where to store the value
  36887. * @param array defines the array of int32 to store
  36888. */
  36889. setIntArray2(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  36890. /**
  36891. * Set the value of an uniform to an array of int32 (stored as vec3)
  36892. * @param uniform defines the webGL uniform location where to store the value
  36893. * @param array defines the array of int32 to store
  36894. */
  36895. setIntArray3(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  36896. /**
  36897. * Set the value of an uniform to an array of int32 (stored as vec4)
  36898. * @param uniform defines the webGL uniform location where to store the value
  36899. * @param array defines the array of int32 to store
  36900. */
  36901. setIntArray4(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  36902. /**
  36903. * Set the value of an uniform to an array of number
  36904. * @param uniform defines the webGL uniform location where to store the value
  36905. * @param array defines the array of number to store
  36906. */
  36907. setArray(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  36908. /**
  36909. * Set the value of an uniform to an array of number (stored as vec2)
  36910. * @param uniform defines the webGL uniform location where to store the value
  36911. * @param array defines the array of number to store
  36912. */
  36913. setArray2(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  36914. /**
  36915. * Set the value of an uniform to an array of number (stored as vec3)
  36916. * @param uniform defines the webGL uniform location where to store the value
  36917. * @param array defines the array of number to store
  36918. */
  36919. setArray3(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  36920. /**
  36921. * Set the value of an uniform to an array of number (stored as vec4)
  36922. * @param uniform defines the webGL uniform location where to store the value
  36923. * @param array defines the array of number to store
  36924. */
  36925. setArray4(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  36926. /**
  36927. * Set the value of an uniform to an array of float32 (stored as matrices)
  36928. * @param uniform defines the webGL uniform location where to store the value
  36929. * @param matrices defines the array of float32 to store
  36930. */
  36931. setMatrices(uniform: Nullable<WebGLUniformLocation>, matrices: Float32Array): void;
  36932. /**
  36933. * Set the value of an uniform to a matrix (3x3)
  36934. * @param uniform defines the webGL uniform location where to store the value
  36935. * @param matrix defines the Float32Array representing the 3x3 matrix to store
  36936. */
  36937. setMatrix3x3(uniform: Nullable<WebGLUniformLocation>, matrix: Float32Array): void;
  36938. /**
  36939. * Set the value of an uniform to a matrix (2x2)
  36940. * @param uniform defines the webGL uniform location where to store the value
  36941. * @param matrix defines the Float32Array representing the 2x2 matrix to store
  36942. */
  36943. setMatrix2x2(uniform: Nullable<WebGLUniformLocation>, matrix: Float32Array): void;
  36944. /**
  36945. * Set the value of an uniform to a number (float)
  36946. * @param uniform defines the webGL uniform location where to store the value
  36947. * @param value defines the float number to store
  36948. */
  36949. setFloat(uniform: Nullable<WebGLUniformLocation>, value: number): void;
  36950. /**
  36951. * Set the value of an uniform to a vec2
  36952. * @param uniform defines the webGL uniform location where to store the value
  36953. * @param x defines the 1st component of the value
  36954. * @param y defines the 2nd component of the value
  36955. */
  36956. setFloat2(uniform: Nullable<WebGLUniformLocation>, x: number, y: number): void;
  36957. /**
  36958. * Set the value of an uniform to a vec3
  36959. * @param uniform defines the webGL uniform location where to store the value
  36960. * @param x defines the 1st component of the value
  36961. * @param y defines the 2nd component of the value
  36962. * @param z defines the 3rd component of the value
  36963. */
  36964. setFloat3(uniform: Nullable<WebGLUniformLocation>, x: number, y: number, z: number): void;
  36965. /**
  36966. * Set the value of an uniform to a vec4
  36967. * @param uniform defines the webGL uniform location where to store the value
  36968. * @param x defines the 1st component of the value
  36969. * @param y defines the 2nd component of the value
  36970. * @param z defines the 3rd component of the value
  36971. * @param w defines the 4th component of the value
  36972. */
  36973. setFloat4(uniform: Nullable<WebGLUniformLocation>, x: number, y: number, z: number, w: number): void;
  36974. /**
  36975. * Apply all cached states (depth, culling, stencil and alpha)
  36976. */
  36977. applyStates(): void;
  36978. /**
  36979. * Enable or disable color writing
  36980. * @param enable defines the state to set
  36981. */
  36982. setColorWrite(enable: boolean): void;
  36983. /**
  36984. * Gets a boolean indicating if color writing is enabled
  36985. * @returns the current color writing state
  36986. */
  36987. getColorWrite(): boolean;
  36988. /**
  36989. * Gets the depth culling state manager
  36990. */
  36991. get depthCullingState(): DepthCullingState;
  36992. /**
  36993. * Gets the alpha state manager
  36994. */
  36995. get alphaState(): AlphaState;
  36996. /**
  36997. * Gets the stencil state manager
  36998. */
  36999. get stencilState(): StencilState;
  37000. /**
  37001. * Clears the list of texture accessible through engine.
  37002. * This can help preventing texture load conflict due to name collision.
  37003. */
  37004. clearInternalTexturesCache(): void;
  37005. /**
  37006. * Force the entire cache to be cleared
  37007. * You should not have to use this function unless your engine needs to share the webGL context with another engine
  37008. * @param bruteForce defines a boolean to force clearing ALL caches (including stencil, detoh and alpha states)
  37009. */
  37010. wipeCaches(bruteForce?: boolean): void;
  37011. /** @hidden */
  37012. _getSamplingParameters(samplingMode: number, generateMipMaps: boolean): {
  37013. min: number;
  37014. mag: number;
  37015. };
  37016. /** @hidden */
  37017. _createTexture(): WebGLTexture;
  37018. /**
  37019. * Usually called from Texture.ts.
  37020. * Passed information to create a WebGLTexture
  37021. * @param url defines a value which contains one of the following:
  37022. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  37023. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  37024. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  37025. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  37026. * @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)
  37027. * @param scene needed for loading to the correct scene
  37028. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  37029. * @param onLoad optional callback to be called upon successful completion
  37030. * @param onError optional callback to be called upon failure
  37031. * @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
  37032. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  37033. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  37034. * @param forcedExtension defines the extension to use to pick the right loader
  37035. * @param mimeType defines an optional mime type
  37036. * @returns a InternalTexture for assignment back into BABYLON.Texture
  37037. */
  37038. 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;
  37039. /**
  37040. * Loads an image as an HTMLImageElement.
  37041. * @param input url string, ArrayBuffer, or Blob to load
  37042. * @param onLoad callback called when the image successfully loads
  37043. * @param onError callback called when the image fails to load
  37044. * @param offlineProvider offline provider for caching
  37045. * @param mimeType optional mime type
  37046. * @returns the HTMLImageElement of the loaded image
  37047. * @hidden
  37048. */
  37049. 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>;
  37050. /**
  37051. * @hidden
  37052. */
  37053. _rescaleTexture(source: InternalTexture, destination: InternalTexture, scene: Nullable<any>, internalFormat: number, onComplete: () => void): void;
  37054. private _unpackFlipYCached;
  37055. /**
  37056. * In case you are sharing the context with other applications, it might
  37057. * be interested to not cache the unpack flip y state to ensure a consistent
  37058. * value would be set.
  37059. */
  37060. enableUnpackFlipYCached: boolean;
  37061. /** @hidden */
  37062. _unpackFlipY(value: boolean): void;
  37063. /** @hidden */
  37064. _getUnpackAlignement(): number;
  37065. private _getTextureTarget;
  37066. /**
  37067. * Update the sampling mode of a given texture
  37068. * @param samplingMode defines the required sampling mode
  37069. * @param texture defines the texture to update
  37070. * @param generateMipMaps defines whether to generate mipmaps for the texture
  37071. */
  37072. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture, generateMipMaps?: boolean): void;
  37073. /**
  37074. * Update the sampling mode of a given texture
  37075. * @param texture defines the texture to update
  37076. * @param wrapU defines the texture wrap mode of the u coordinates
  37077. * @param wrapV defines the texture wrap mode of the v coordinates
  37078. * @param wrapR defines the texture wrap mode of the r coordinates
  37079. */
  37080. updateTextureWrappingMode(texture: InternalTexture, wrapU: Nullable<number>, wrapV?: Nullable<number>, wrapR?: Nullable<number>): void;
  37081. /** @hidden */
  37082. _setupDepthStencilTexture(internalTexture: InternalTexture, size: number | {
  37083. width: number;
  37084. height: number;
  37085. layers?: number;
  37086. }, generateStencil: boolean, bilinearFiltering: boolean, comparisonFunction: number): void;
  37087. /** @hidden */
  37088. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  37089. /** @hidden */
  37090. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number, babylonInternalFormat?: number, useTextureWidthAndHeight?: boolean): void;
  37091. /**
  37092. * Update a portion of an internal texture
  37093. * @param texture defines the texture to update
  37094. * @param imageData defines the data to store into the texture
  37095. * @param xOffset defines the x coordinates of the update rectangle
  37096. * @param yOffset defines the y coordinates of the update rectangle
  37097. * @param width defines the width of the update rectangle
  37098. * @param height defines the height of the update rectangle
  37099. * @param faceIndex defines the face index if texture is a cube (0 by default)
  37100. * @param lod defines the lod level to update (0 by default)
  37101. */
  37102. updateTextureData(texture: InternalTexture, imageData: ArrayBufferView, xOffset: number, yOffset: number, width: number, height: number, faceIndex?: number, lod?: number): void;
  37103. /** @hidden */
  37104. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  37105. protected _prepareWebGLTextureContinuation(texture: InternalTexture, scene: Nullable<ISceneLike>, noMipmap: boolean, isCompressed: boolean, samplingMode: number): void;
  37106. private _prepareWebGLTexture;
  37107. /** @hidden */
  37108. _setupFramebufferDepthAttachments(generateStencilBuffer: boolean, generateDepthBuffer: boolean, width: number, height: number, samples?: number): Nullable<WebGLRenderbuffer>;
  37109. private _getDepthStencilBuffer;
  37110. /** @hidden */
  37111. _releaseFramebufferObjects(texture: InternalTexture): void;
  37112. /** @hidden */
  37113. _releaseTexture(texture: InternalTexture): void;
  37114. protected _deleteTexture(texture: Nullable<WebGLTexture>): void;
  37115. protected _setProgram(program: WebGLProgram): void;
  37116. protected _boundUniforms: {
  37117. [key: number]: WebGLUniformLocation;
  37118. };
  37119. /**
  37120. * Binds an effect to the webGL context
  37121. * @param effect defines the effect to bind
  37122. */
  37123. bindSamplers(effect: Effect): void;
  37124. private _activateCurrentTexture;
  37125. /** @hidden */
  37126. _bindTextureDirectly(target: number, texture: Nullable<InternalTexture>, forTextureDataUpdate?: boolean, force?: boolean): boolean;
  37127. /** @hidden */
  37128. _bindTexture(channel: number, texture: Nullable<InternalTexture>): void;
  37129. /**
  37130. * Unbind all textures from the webGL context
  37131. */
  37132. unbindAllTextures(): void;
  37133. /**
  37134. * Sets a texture to the according uniform.
  37135. * @param channel The texture channel
  37136. * @param uniform The uniform to set
  37137. * @param texture The texture to apply
  37138. */
  37139. setTexture(channel: number, uniform: Nullable<WebGLUniformLocation>, texture: Nullable<BaseTexture>): void;
  37140. private _bindSamplerUniformToChannel;
  37141. private _getTextureWrapMode;
  37142. protected _setTexture(channel: number, texture: Nullable<BaseTexture>, isPartOfTextureArray?: boolean, depthStencilTexture?: boolean): boolean;
  37143. /**
  37144. * Sets an array of texture to the webGL context
  37145. * @param channel defines the channel where the texture array must be set
  37146. * @param uniform defines the associated uniform location
  37147. * @param textures defines the array of textures to bind
  37148. */
  37149. setTextureArray(channel: number, uniform: Nullable<WebGLUniformLocation>, textures: BaseTexture[]): void;
  37150. /** @hidden */
  37151. _setAnisotropicLevel(target: number, internalTexture: InternalTexture, anisotropicFilteringLevel: number): void;
  37152. private _setTextureParameterFloat;
  37153. private _setTextureParameterInteger;
  37154. /**
  37155. * Unbind all vertex attributes from the webGL context
  37156. */
  37157. unbindAllAttributes(): void;
  37158. /**
  37159. * 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
  37160. */
  37161. releaseEffects(): void;
  37162. /**
  37163. * Dispose and release all associated resources
  37164. */
  37165. dispose(): void;
  37166. /**
  37167. * Attach a new callback raised when context lost event is fired
  37168. * @param callback defines the callback to call
  37169. */
  37170. attachContextLostEvent(callback: ((event: WebGLContextEvent) => void)): void;
  37171. /**
  37172. * Attach a new callback raised when context restored event is fired
  37173. * @param callback defines the callback to call
  37174. */
  37175. attachContextRestoredEvent(callback: ((event: WebGLContextEvent) => void)): void;
  37176. /**
  37177. * Get the current error code of the webGL context
  37178. * @returns the error code
  37179. * @see https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/getError
  37180. */
  37181. getError(): number;
  37182. private _canRenderToFloatFramebuffer;
  37183. private _canRenderToHalfFloatFramebuffer;
  37184. private _canRenderToFramebuffer;
  37185. /** @hidden */
  37186. _getWebGLTextureType(type: number): number;
  37187. /** @hidden */
  37188. _getInternalFormat(format: number): number;
  37189. /** @hidden */
  37190. _getRGBABufferInternalSizedFormat(type: number, format?: number): number;
  37191. /** @hidden */
  37192. _getRGBAMultiSampleBufferFormat(type: number): number;
  37193. /** @hidden */
  37194. _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;
  37195. /**
  37196. * Loads a file from a url
  37197. * @param url url to load
  37198. * @param onSuccess callback called when the file successfully loads
  37199. * @param onProgress callback called while file is loading (if the server supports this mode)
  37200. * @param offlineProvider defines the offline provider for caching
  37201. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  37202. * @param onError callback called when the file fails to load
  37203. * @returns a file request object
  37204. * @hidden
  37205. */
  37206. 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;
  37207. /**
  37208. * Reads pixels from the current frame buffer. Please note that this function can be slow
  37209. * @param x defines the x coordinate of the rectangle where pixels must be read
  37210. * @param y defines the y coordinate of the rectangle where pixels must be read
  37211. * @param width defines the width of the rectangle where pixels must be read
  37212. * @param height defines the height of the rectangle where pixels must be read
  37213. * @param hasAlpha defines whether the output should have alpha or not (defaults to true)
  37214. * @returns a Uint8Array containing RGBA colors
  37215. */
  37216. readPixels(x: number, y: number, width: number, height: number, hasAlpha?: boolean): Uint8Array;
  37217. private static _isSupported;
  37218. /**
  37219. * Gets a boolean indicating if the engine can be instanciated (ie. if a webGL context can be found)
  37220. * @returns true if the engine can be created
  37221. * @ignorenaming
  37222. */
  37223. static isSupported(): boolean;
  37224. /**
  37225. * Find the next highest power of two.
  37226. * @param x Number to start search from.
  37227. * @return Next highest power of two.
  37228. */
  37229. static CeilingPOT(x: number): number;
  37230. /**
  37231. * Find the next lowest power of two.
  37232. * @param x Number to start search from.
  37233. * @return Next lowest power of two.
  37234. */
  37235. static FloorPOT(x: number): number;
  37236. /**
  37237. * Find the nearest power of two.
  37238. * @param x Number to start search from.
  37239. * @return Next nearest power of two.
  37240. */
  37241. static NearestPOT(x: number): number;
  37242. /**
  37243. * Get the closest exponent of two
  37244. * @param value defines the value to approximate
  37245. * @param max defines the maximum value to return
  37246. * @param mode defines how to define the closest value
  37247. * @returns closest exponent of two of the given value
  37248. */
  37249. static GetExponentOfTwo(value: number, max: number, mode?: number): number;
  37250. /**
  37251. * Queue a new function into the requested animation frame pool (ie. this function will be executed byt the browser for the next frame)
  37252. * @param func - the function to be called
  37253. * @param requester - the object that will request the next frame. Falls back to window.
  37254. * @returns frame number
  37255. */
  37256. static QueueNewFrame(func: () => void, requester?: any): number;
  37257. /**
  37258. * Gets host document
  37259. * @returns the host document object
  37260. */
  37261. getHostDocument(): Nullable<Document>;
  37262. }
  37263. }
  37264. declare module "babylonjs/Maths/sphericalPolynomial" {
  37265. import { Vector3 } from "babylonjs/Maths/math.vector";
  37266. import { Color3 } from "babylonjs/Maths/math.color";
  37267. /**
  37268. * Class representing spherical harmonics coefficients to the 3rd degree
  37269. */
  37270. export class SphericalHarmonics {
  37271. /**
  37272. * Defines whether or not the harmonics have been prescaled for rendering.
  37273. */
  37274. preScaled: boolean;
  37275. /**
  37276. * The l0,0 coefficients of the spherical harmonics
  37277. */
  37278. l00: Vector3;
  37279. /**
  37280. * The l1,-1 coefficients of the spherical harmonics
  37281. */
  37282. l1_1: Vector3;
  37283. /**
  37284. * The l1,0 coefficients of the spherical harmonics
  37285. */
  37286. l10: Vector3;
  37287. /**
  37288. * The l1,1 coefficients of the spherical harmonics
  37289. */
  37290. l11: Vector3;
  37291. /**
  37292. * The l2,-2 coefficients of the spherical harmonics
  37293. */
  37294. l2_2: Vector3;
  37295. /**
  37296. * The l2,-1 coefficients of the spherical harmonics
  37297. */
  37298. l2_1: Vector3;
  37299. /**
  37300. * The l2,0 coefficients of the spherical harmonics
  37301. */
  37302. l20: Vector3;
  37303. /**
  37304. * The l2,1 coefficients of the spherical harmonics
  37305. */
  37306. l21: Vector3;
  37307. /**
  37308. * The l2,2 coefficients of the spherical harmonics
  37309. */
  37310. l22: Vector3;
  37311. /**
  37312. * Adds a light to the spherical harmonics
  37313. * @param direction the direction of the light
  37314. * @param color the color of the light
  37315. * @param deltaSolidAngle the delta solid angle of the light
  37316. */
  37317. addLight(direction: Vector3, color: Color3, deltaSolidAngle: number): void;
  37318. /**
  37319. * Scales the spherical harmonics by the given amount
  37320. * @param scale the amount to scale
  37321. */
  37322. scaleInPlace(scale: number): void;
  37323. /**
  37324. * Convert from incident radiance (Li) to irradiance (E) by applying convolution with the cosine-weighted hemisphere.
  37325. *
  37326. * ```
  37327. * E_lm = A_l * L_lm
  37328. * ```
  37329. *
  37330. * In spherical harmonics this convolution amounts to scaling factors for each frequency band.
  37331. * This corresponds to equation 5 in "An Efficient Representation for Irradiance Environment Maps", where
  37332. * the scaling factors are given in equation 9.
  37333. */
  37334. convertIncidentRadianceToIrradiance(): void;
  37335. /**
  37336. * Convert from irradiance to outgoing radiance for Lambertian BDRF, suitable for efficient shader evaluation.
  37337. *
  37338. * ```
  37339. * L = (1/pi) * E * rho
  37340. * ```
  37341. *
  37342. * This is done by an additional scale by 1/pi, so is a fairly trivial operation but important conceptually.
  37343. */
  37344. convertIrradianceToLambertianRadiance(): void;
  37345. /**
  37346. * Integrates the reconstruction coefficients directly in to the SH preventing further
  37347. * required operations at run time.
  37348. *
  37349. * This is simply done by scaling back the SH with Ylm constants parameter.
  37350. * The trigonometric part being applied by the shader at run time.
  37351. */
  37352. preScaleForRendering(): void;
  37353. /**
  37354. * Constructs a spherical harmonics from an array.
  37355. * @param data defines the 9x3 coefficients (l00, l1-1, l10, l11, l2-2, l2-1, l20, l21, l22)
  37356. * @returns the spherical harmonics
  37357. */
  37358. static FromArray(data: ArrayLike<ArrayLike<number>>): SphericalHarmonics;
  37359. /**
  37360. * Gets the spherical harmonics from polynomial
  37361. * @param polynomial the spherical polynomial
  37362. * @returns the spherical harmonics
  37363. */
  37364. static FromPolynomial(polynomial: SphericalPolynomial): SphericalHarmonics;
  37365. }
  37366. /**
  37367. * Class representing spherical polynomial coefficients to the 3rd degree
  37368. */
  37369. export class SphericalPolynomial {
  37370. private _harmonics;
  37371. /**
  37372. * The spherical harmonics used to create the polynomials.
  37373. */
  37374. get preScaledHarmonics(): SphericalHarmonics;
  37375. /**
  37376. * The x coefficients of the spherical polynomial
  37377. */
  37378. x: Vector3;
  37379. /**
  37380. * The y coefficients of the spherical polynomial
  37381. */
  37382. y: Vector3;
  37383. /**
  37384. * The z coefficients of the spherical polynomial
  37385. */
  37386. z: Vector3;
  37387. /**
  37388. * The xx coefficients of the spherical polynomial
  37389. */
  37390. xx: Vector3;
  37391. /**
  37392. * The yy coefficients of the spherical polynomial
  37393. */
  37394. yy: Vector3;
  37395. /**
  37396. * The zz coefficients of the spherical polynomial
  37397. */
  37398. zz: Vector3;
  37399. /**
  37400. * The xy coefficients of the spherical polynomial
  37401. */
  37402. xy: Vector3;
  37403. /**
  37404. * The yz coefficients of the spherical polynomial
  37405. */
  37406. yz: Vector3;
  37407. /**
  37408. * The zx coefficients of the spherical polynomial
  37409. */
  37410. zx: Vector3;
  37411. /**
  37412. * Adds an ambient color to the spherical polynomial
  37413. * @param color the color to add
  37414. */
  37415. addAmbient(color: Color3): void;
  37416. /**
  37417. * Scales the spherical polynomial by the given amount
  37418. * @param scale the amount to scale
  37419. */
  37420. scaleInPlace(scale: number): void;
  37421. /**
  37422. * Gets the spherical polynomial from harmonics
  37423. * @param harmonics the spherical harmonics
  37424. * @returns the spherical polynomial
  37425. */
  37426. static FromHarmonics(harmonics: SphericalHarmonics): SphericalPolynomial;
  37427. /**
  37428. * Constructs a spherical polynomial from an array.
  37429. * @param data defines the 9x3 coefficients (x, y, z, xx, yy, zz, yz, zx, xy)
  37430. * @returns the spherical polynomial
  37431. */
  37432. static FromArray(data: ArrayLike<ArrayLike<number>>): SphericalPolynomial;
  37433. }
  37434. }
  37435. declare module "babylonjs/Materials/Textures/internalTexture" {
  37436. import { Observable } from "babylonjs/Misc/observable";
  37437. import { Nullable, int } from "babylonjs/types";
  37438. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  37439. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  37440. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  37441. /**
  37442. * Defines the source of the internal texture
  37443. */
  37444. export enum InternalTextureSource {
  37445. /**
  37446. * The source of the texture data is unknown
  37447. */
  37448. Unknown = 0,
  37449. /**
  37450. * Texture data comes from an URL
  37451. */
  37452. Url = 1,
  37453. /**
  37454. * Texture data is only used for temporary storage
  37455. */
  37456. Temp = 2,
  37457. /**
  37458. * Texture data comes from raw data (ArrayBuffer)
  37459. */
  37460. Raw = 3,
  37461. /**
  37462. * Texture content is dynamic (video or dynamic texture)
  37463. */
  37464. Dynamic = 4,
  37465. /**
  37466. * Texture content is generated by rendering to it
  37467. */
  37468. RenderTarget = 5,
  37469. /**
  37470. * Texture content is part of a multi render target process
  37471. */
  37472. MultiRenderTarget = 6,
  37473. /**
  37474. * Texture data comes from a cube data file
  37475. */
  37476. Cube = 7,
  37477. /**
  37478. * Texture data comes from a raw cube data
  37479. */
  37480. CubeRaw = 8,
  37481. /**
  37482. * Texture data come from a prefiltered cube data file
  37483. */
  37484. CubePrefiltered = 9,
  37485. /**
  37486. * Texture content is raw 3D data
  37487. */
  37488. Raw3D = 10,
  37489. /**
  37490. * Texture content is raw 2D array data
  37491. */
  37492. Raw2DArray = 11,
  37493. /**
  37494. * Texture content is a depth texture
  37495. */
  37496. Depth = 12,
  37497. /**
  37498. * Texture data comes from a raw cube data encoded with RGBD
  37499. */
  37500. CubeRawRGBD = 13
  37501. }
  37502. /**
  37503. * Class used to store data associated with WebGL texture data for the engine
  37504. * This class should not be used directly
  37505. */
  37506. export class InternalTexture {
  37507. /** @hidden */
  37508. static _UpdateRGBDAsync: (internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number) => Promise<void>;
  37509. /**
  37510. * Defines if the texture is ready
  37511. */
  37512. isReady: boolean;
  37513. /**
  37514. * Defines if the texture is a cube texture
  37515. */
  37516. isCube: boolean;
  37517. /**
  37518. * Defines if the texture contains 3D data
  37519. */
  37520. is3D: boolean;
  37521. /**
  37522. * Defines if the texture contains 2D array data
  37523. */
  37524. is2DArray: boolean;
  37525. /**
  37526. * Defines if the texture contains multiview data
  37527. */
  37528. isMultiview: boolean;
  37529. /**
  37530. * Gets the URL used to load this texture
  37531. */
  37532. url: string;
  37533. /**
  37534. * Gets the sampling mode of the texture
  37535. */
  37536. samplingMode: number;
  37537. /**
  37538. * Gets a boolean indicating if the texture needs mipmaps generation
  37539. */
  37540. generateMipMaps: boolean;
  37541. /**
  37542. * Gets the number of samples used by the texture (WebGL2+ only)
  37543. */
  37544. samples: number;
  37545. /**
  37546. * Gets the type of the texture (int, float...)
  37547. */
  37548. type: number;
  37549. /**
  37550. * Gets the format of the texture (RGB, RGBA...)
  37551. */
  37552. format: number;
  37553. /**
  37554. * Observable called when the texture is loaded
  37555. */
  37556. onLoadedObservable: Observable<InternalTexture>;
  37557. /**
  37558. * Gets the width of the texture
  37559. */
  37560. width: number;
  37561. /**
  37562. * Gets the height of the texture
  37563. */
  37564. height: number;
  37565. /**
  37566. * Gets the depth of the texture
  37567. */
  37568. depth: number;
  37569. /**
  37570. * Gets the initial width of the texture (It could be rescaled if the current system does not support non power of two textures)
  37571. */
  37572. baseWidth: number;
  37573. /**
  37574. * Gets the initial height of the texture (It could be rescaled if the current system does not support non power of two textures)
  37575. */
  37576. baseHeight: number;
  37577. /**
  37578. * Gets the initial depth of the texture (It could be rescaled if the current system does not support non power of two textures)
  37579. */
  37580. baseDepth: number;
  37581. /**
  37582. * Gets a boolean indicating if the texture is inverted on Y axis
  37583. */
  37584. invertY: boolean;
  37585. /** @hidden */
  37586. _invertVScale: boolean;
  37587. /** @hidden */
  37588. _associatedChannel: number;
  37589. /** @hidden */
  37590. _source: InternalTextureSource;
  37591. /** @hidden */
  37592. _buffer: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>;
  37593. /** @hidden */
  37594. _bufferView: Nullable<ArrayBufferView>;
  37595. /** @hidden */
  37596. _bufferViewArray: Nullable<ArrayBufferView[]>;
  37597. /** @hidden */
  37598. _bufferViewArrayArray: Nullable<ArrayBufferView[][]>;
  37599. /** @hidden */
  37600. _size: number;
  37601. /** @hidden */
  37602. _extension: string;
  37603. /** @hidden */
  37604. _files: Nullable<string[]>;
  37605. /** @hidden */
  37606. _workingCanvas: Nullable<HTMLCanvasElement | OffscreenCanvas>;
  37607. /** @hidden */
  37608. _workingContext: Nullable<CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D>;
  37609. /** @hidden */
  37610. _framebuffer: Nullable<WebGLFramebuffer>;
  37611. /** @hidden */
  37612. _depthStencilBuffer: Nullable<WebGLRenderbuffer>;
  37613. /** @hidden */
  37614. _MSAAFramebuffer: Nullable<WebGLFramebuffer>;
  37615. /** @hidden */
  37616. _MSAARenderBuffer: Nullable<WebGLRenderbuffer>;
  37617. /** @hidden */
  37618. _attachments: Nullable<number[]>;
  37619. /** @hidden */
  37620. _textureArray: Nullable<InternalTexture[]>;
  37621. /** @hidden */
  37622. _cachedCoordinatesMode: Nullable<number>;
  37623. /** @hidden */
  37624. _cachedWrapU: Nullable<number>;
  37625. /** @hidden */
  37626. _cachedWrapV: Nullable<number>;
  37627. /** @hidden */
  37628. _cachedWrapR: Nullable<number>;
  37629. /** @hidden */
  37630. _cachedAnisotropicFilteringLevel: Nullable<number>;
  37631. /** @hidden */
  37632. _isDisabled: boolean;
  37633. /** @hidden */
  37634. _compression: Nullable<string>;
  37635. /** @hidden */
  37636. _generateStencilBuffer: boolean;
  37637. /** @hidden */
  37638. _generateDepthBuffer: boolean;
  37639. /** @hidden */
  37640. _comparisonFunction: number;
  37641. /** @hidden */
  37642. _sphericalPolynomial: Nullable<SphericalPolynomial>;
  37643. /** @hidden */
  37644. _lodGenerationScale: number;
  37645. /** @hidden */
  37646. _lodGenerationOffset: number;
  37647. /** @hidden */
  37648. _depthStencilTexture: Nullable<InternalTexture>;
  37649. /** @hidden */
  37650. _colorTextureArray: Nullable<WebGLTexture>;
  37651. /** @hidden */
  37652. _depthStencilTextureArray: Nullable<WebGLTexture>;
  37653. /** @hidden */
  37654. _lodTextureHigh: Nullable<BaseTexture>;
  37655. /** @hidden */
  37656. _lodTextureMid: Nullable<BaseTexture>;
  37657. /** @hidden */
  37658. _lodTextureLow: Nullable<BaseTexture>;
  37659. /** @hidden */
  37660. _isRGBD: boolean;
  37661. /** @hidden */
  37662. _linearSpecularLOD: boolean;
  37663. /** @hidden */
  37664. _irradianceTexture: Nullable<BaseTexture>;
  37665. /** @hidden */
  37666. _webGLTexture: Nullable<WebGLTexture>;
  37667. /** @hidden */
  37668. _references: number;
  37669. private _engine;
  37670. /**
  37671. * Gets the Engine the texture belongs to.
  37672. * @returns The babylon engine
  37673. */
  37674. getEngine(): ThinEngine;
  37675. /**
  37676. * Gets the data source type of the texture
  37677. */
  37678. get source(): InternalTextureSource;
  37679. /**
  37680. * Creates a new InternalTexture
  37681. * @param engine defines the engine to use
  37682. * @param source defines the type of data that will be used
  37683. * @param delayAllocation if the texture allocation should be delayed (default: false)
  37684. */
  37685. constructor(engine: ThinEngine, source: InternalTextureSource, delayAllocation?: boolean);
  37686. /**
  37687. * Increments the number of references (ie. the number of Texture that point to it)
  37688. */
  37689. incrementReferences(): void;
  37690. /**
  37691. * Change the size of the texture (not the size of the content)
  37692. * @param width defines the new width
  37693. * @param height defines the new height
  37694. * @param depth defines the new depth (1 by default)
  37695. */
  37696. updateSize(width: int, height: int, depth?: int): void;
  37697. /** @hidden */
  37698. _rebuild(): void;
  37699. /** @hidden */
  37700. _swapAndDie(target: InternalTexture): void;
  37701. /**
  37702. * Dispose the current allocated resources
  37703. */
  37704. dispose(): void;
  37705. }
  37706. }
  37707. declare module "babylonjs/Audio/analyser" {
  37708. import { Scene } from "babylonjs/scene";
  37709. /**
  37710. * Class used to work with sound analyzer using fast fourier transform (FFT)
  37711. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  37712. */
  37713. export class Analyser {
  37714. /**
  37715. * Gets or sets the smoothing
  37716. * @ignorenaming
  37717. */
  37718. SMOOTHING: number;
  37719. /**
  37720. * Gets or sets the FFT table size
  37721. * @ignorenaming
  37722. */
  37723. FFT_SIZE: number;
  37724. /**
  37725. * Gets or sets the bar graph amplitude
  37726. * @ignorenaming
  37727. */
  37728. BARGRAPHAMPLITUDE: number;
  37729. /**
  37730. * Gets or sets the position of the debug canvas
  37731. * @ignorenaming
  37732. */
  37733. DEBUGCANVASPOS: {
  37734. x: number;
  37735. y: number;
  37736. };
  37737. /**
  37738. * Gets or sets the debug canvas size
  37739. * @ignorenaming
  37740. */
  37741. DEBUGCANVASSIZE: {
  37742. width: number;
  37743. height: number;
  37744. };
  37745. private _byteFreqs;
  37746. private _byteTime;
  37747. private _floatFreqs;
  37748. private _webAudioAnalyser;
  37749. private _debugCanvas;
  37750. private _debugCanvasContext;
  37751. private _scene;
  37752. private _registerFunc;
  37753. private _audioEngine;
  37754. /**
  37755. * Creates a new analyser
  37756. * @param scene defines hosting scene
  37757. */
  37758. constructor(scene: Scene);
  37759. /**
  37760. * Get the number of data values you will have to play with for the visualization
  37761. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/frequencyBinCount
  37762. * @returns a number
  37763. */
  37764. getFrequencyBinCount(): number;
  37765. /**
  37766. * Gets the current frequency data as a byte array
  37767. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteFrequencyData
  37768. * @returns a Uint8Array
  37769. */
  37770. getByteFrequencyData(): Uint8Array;
  37771. /**
  37772. * Gets the current waveform as a byte array
  37773. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteTimeDomainData
  37774. * @returns a Uint8Array
  37775. */
  37776. getByteTimeDomainData(): Uint8Array;
  37777. /**
  37778. * Gets the current frequency data as a float array
  37779. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteFrequencyData
  37780. * @returns a Float32Array
  37781. */
  37782. getFloatFrequencyData(): Float32Array;
  37783. /**
  37784. * Renders the debug canvas
  37785. */
  37786. drawDebugCanvas(): void;
  37787. /**
  37788. * Stops rendering the debug canvas and removes it
  37789. */
  37790. stopDebugCanvas(): void;
  37791. /**
  37792. * Connects two audio nodes
  37793. * @param inputAudioNode defines first node to connect
  37794. * @param outputAudioNode defines second node to connect
  37795. */
  37796. connectAudioNodes(inputAudioNode: AudioNode, outputAudioNode: AudioNode): void;
  37797. /**
  37798. * Releases all associated resources
  37799. */
  37800. dispose(): void;
  37801. }
  37802. }
  37803. declare module "babylonjs/Audio/audioEngine" {
  37804. import { IDisposable } from "babylonjs/scene";
  37805. import { Analyser } from "babylonjs/Audio/analyser";
  37806. import { Nullable } from "babylonjs/types";
  37807. import { Observable } from "babylonjs/Misc/observable";
  37808. /**
  37809. * This represents an audio engine and it is responsible
  37810. * to play, synchronize and analyse sounds throughout the application.
  37811. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  37812. */
  37813. export interface IAudioEngine extends IDisposable {
  37814. /**
  37815. * Gets whether the current host supports Web Audio and thus could create AudioContexts.
  37816. */
  37817. readonly canUseWebAudio: boolean;
  37818. /**
  37819. * Gets the current AudioContext if available.
  37820. */
  37821. readonly audioContext: Nullable<AudioContext>;
  37822. /**
  37823. * The master gain node defines the global audio volume of your audio engine.
  37824. */
  37825. readonly masterGain: GainNode;
  37826. /**
  37827. * Gets whether or not mp3 are supported by your browser.
  37828. */
  37829. readonly isMP3supported: boolean;
  37830. /**
  37831. * Gets whether or not ogg are supported by your browser.
  37832. */
  37833. readonly isOGGsupported: boolean;
  37834. /**
  37835. * Defines if Babylon should emit a warning if WebAudio is not supported.
  37836. * @ignoreNaming
  37837. */
  37838. WarnedWebAudioUnsupported: boolean;
  37839. /**
  37840. * Defines if the audio engine relies on a custom unlocked button.
  37841. * In this case, the embedded button will not be displayed.
  37842. */
  37843. useCustomUnlockedButton: boolean;
  37844. /**
  37845. * Gets whether or not the audio engine is unlocked (require first a user gesture on some browser).
  37846. */
  37847. readonly unlocked: boolean;
  37848. /**
  37849. * Event raised when audio has been unlocked on the browser.
  37850. */
  37851. onAudioUnlockedObservable: Observable<AudioEngine>;
  37852. /**
  37853. * Event raised when audio has been locked on the browser.
  37854. */
  37855. onAudioLockedObservable: Observable<AudioEngine>;
  37856. /**
  37857. * Flags the audio engine in Locked state.
  37858. * This happens due to new browser policies preventing audio to autoplay.
  37859. */
  37860. lock(): void;
  37861. /**
  37862. * Unlocks the audio engine once a user action has been done on the dom.
  37863. * This is helpful to resume play once browser policies have been satisfied.
  37864. */
  37865. unlock(): void;
  37866. /**
  37867. * Gets the global volume sets on the master gain.
  37868. * @returns the global volume if set or -1 otherwise
  37869. */
  37870. getGlobalVolume(): number;
  37871. /**
  37872. * Sets the global volume of your experience (sets on the master gain).
  37873. * @param newVolume Defines the new global volume of the application
  37874. */
  37875. setGlobalVolume(newVolume: number): void;
  37876. /**
  37877. * Connect the audio engine to an audio analyser allowing some amazing
  37878. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  37879. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  37880. * @param analyser The analyser to connect to the engine
  37881. */
  37882. connectToAnalyser(analyser: Analyser): void;
  37883. }
  37884. /**
  37885. * This represents the default audio engine used in babylon.
  37886. * It is responsible to play, synchronize and analyse sounds throughout the application.
  37887. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  37888. */
  37889. export class AudioEngine implements IAudioEngine {
  37890. private _audioContext;
  37891. private _audioContextInitialized;
  37892. private _muteButton;
  37893. private _hostElement;
  37894. /**
  37895. * Gets whether the current host supports Web Audio and thus could create AudioContexts.
  37896. */
  37897. canUseWebAudio: boolean;
  37898. /**
  37899. * The master gain node defines the global audio volume of your audio engine.
  37900. */
  37901. masterGain: GainNode;
  37902. /**
  37903. * Defines if Babylon should emit a warning if WebAudio is not supported.
  37904. * @ignoreNaming
  37905. */
  37906. WarnedWebAudioUnsupported: boolean;
  37907. /**
  37908. * Gets whether or not mp3 are supported by your browser.
  37909. */
  37910. isMP3supported: boolean;
  37911. /**
  37912. * Gets whether or not ogg are supported by your browser.
  37913. */
  37914. isOGGsupported: boolean;
  37915. /**
  37916. * Gets whether audio has been unlocked on the device.
  37917. * Some Browsers have strong restrictions about Audio and won t autoplay unless
  37918. * a user interaction has happened.
  37919. */
  37920. unlocked: boolean;
  37921. /**
  37922. * Defines if the audio engine relies on a custom unlocked button.
  37923. * In this case, the embedded button will not be displayed.
  37924. */
  37925. useCustomUnlockedButton: boolean;
  37926. /**
  37927. * Event raised when audio has been unlocked on the browser.
  37928. */
  37929. onAudioUnlockedObservable: Observable<AudioEngine>;
  37930. /**
  37931. * Event raised when audio has been locked on the browser.
  37932. */
  37933. onAudioLockedObservable: Observable<AudioEngine>;
  37934. /**
  37935. * Gets the current AudioContext if available.
  37936. */
  37937. get audioContext(): Nullable<AudioContext>;
  37938. private _connectedAnalyser;
  37939. /**
  37940. * Instantiates a new audio engine.
  37941. *
  37942. * There should be only one per page as some browsers restrict the number
  37943. * of audio contexts you can create.
  37944. * @param hostElement defines the host element where to display the mute icon if necessary
  37945. */
  37946. constructor(hostElement?: Nullable<HTMLElement>);
  37947. /**
  37948. * Flags the audio engine in Locked state.
  37949. * This happens due to new browser policies preventing audio to autoplay.
  37950. */
  37951. lock(): void;
  37952. /**
  37953. * Unlocks the audio engine once a user action has been done on the dom.
  37954. * This is helpful to resume play once browser policies have been satisfied.
  37955. */
  37956. unlock(): void;
  37957. private _resumeAudioContext;
  37958. private _initializeAudioContext;
  37959. private _tryToRun;
  37960. private _triggerRunningState;
  37961. private _triggerSuspendedState;
  37962. private _displayMuteButton;
  37963. private _moveButtonToTopLeft;
  37964. private _onResize;
  37965. private _hideMuteButton;
  37966. /**
  37967. * Destroy and release the resources associated with the audio ccontext.
  37968. */
  37969. dispose(): void;
  37970. /**
  37971. * Gets the global volume sets on the master gain.
  37972. * @returns the global volume if set or -1 otherwise
  37973. */
  37974. getGlobalVolume(): number;
  37975. /**
  37976. * Sets the global volume of your experience (sets on the master gain).
  37977. * @param newVolume Defines the new global volume of the application
  37978. */
  37979. setGlobalVolume(newVolume: number): void;
  37980. /**
  37981. * Connect the audio engine to an audio analyser allowing some amazing
  37982. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  37983. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  37984. * @param analyser The analyser to connect to the engine
  37985. */
  37986. connectToAnalyser(analyser: Analyser): void;
  37987. }
  37988. }
  37989. declare module "babylonjs/Loading/loadingScreen" {
  37990. /**
  37991. * Interface used to present a loading screen while loading a scene
  37992. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  37993. */
  37994. export interface ILoadingScreen {
  37995. /**
  37996. * Function called to display the loading screen
  37997. */
  37998. displayLoadingUI: () => void;
  37999. /**
  38000. * Function called to hide the loading screen
  38001. */
  38002. hideLoadingUI: () => void;
  38003. /**
  38004. * Gets or sets the color to use for the background
  38005. */
  38006. loadingUIBackgroundColor: string;
  38007. /**
  38008. * Gets or sets the text to display while loading
  38009. */
  38010. loadingUIText: string;
  38011. }
  38012. /**
  38013. * Class used for the default loading screen
  38014. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  38015. */
  38016. export class DefaultLoadingScreen implements ILoadingScreen {
  38017. private _renderingCanvas;
  38018. private _loadingText;
  38019. private _loadingDivBackgroundColor;
  38020. private _loadingDiv;
  38021. private _loadingTextDiv;
  38022. /** Gets or sets the logo url to use for the default loading screen */
  38023. static DefaultLogoUrl: string;
  38024. /** Gets or sets the spinner url to use for the default loading screen */
  38025. static DefaultSpinnerUrl: string;
  38026. /**
  38027. * Creates a new default loading screen
  38028. * @param _renderingCanvas defines the canvas used to render the scene
  38029. * @param _loadingText defines the default text to display
  38030. * @param _loadingDivBackgroundColor defines the default background color
  38031. */
  38032. constructor(_renderingCanvas: HTMLCanvasElement, _loadingText?: string, _loadingDivBackgroundColor?: string);
  38033. /**
  38034. * Function called to display the loading screen
  38035. */
  38036. displayLoadingUI(): void;
  38037. /**
  38038. * Function called to hide the loading screen
  38039. */
  38040. hideLoadingUI(): void;
  38041. /**
  38042. * Gets or sets the text to display while loading
  38043. */
  38044. set loadingUIText(text: string);
  38045. get loadingUIText(): string;
  38046. /**
  38047. * Gets or sets the color to use for the background
  38048. */
  38049. get loadingUIBackgroundColor(): string;
  38050. set loadingUIBackgroundColor(color: string);
  38051. private _resizeLoadingUI;
  38052. }
  38053. }
  38054. declare module "babylonjs/Misc/customAnimationFrameRequester" {
  38055. /**
  38056. * Interface for any object that can request an animation frame
  38057. */
  38058. export interface ICustomAnimationFrameRequester {
  38059. /**
  38060. * This function will be called when the render loop is ready. If this is not populated, the engine's renderloop function will be called
  38061. */
  38062. renderFunction?: Function;
  38063. /**
  38064. * Called to request the next frame to render to
  38065. * @see https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame
  38066. */
  38067. requestAnimationFrame: Function;
  38068. /**
  38069. * You can pass this value to cancelAnimationFrame() to cancel the refresh callback request
  38070. * @see https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame#Return_value
  38071. */
  38072. requestID?: number;
  38073. }
  38074. }
  38075. declare module "babylonjs/Misc/performanceMonitor" {
  38076. /**
  38077. * Performance monitor tracks rolling average frame-time and frame-time variance over a user defined sliding-window
  38078. */
  38079. export class PerformanceMonitor {
  38080. private _enabled;
  38081. private _rollingFrameTime;
  38082. private _lastFrameTimeMs;
  38083. /**
  38084. * constructor
  38085. * @param frameSampleSize The number of samples required to saturate the sliding window
  38086. */
  38087. constructor(frameSampleSize?: number);
  38088. /**
  38089. * Samples current frame
  38090. * @param timeMs A timestamp in milliseconds of the current frame to compare with other frames
  38091. */
  38092. sampleFrame(timeMs?: number): void;
  38093. /**
  38094. * Returns the average frame time in milliseconds over the sliding window (or the subset of frames sampled so far)
  38095. */
  38096. get averageFrameTime(): number;
  38097. /**
  38098. * Returns the variance frame time in milliseconds over the sliding window (or the subset of frames sampled so far)
  38099. */
  38100. get averageFrameTimeVariance(): number;
  38101. /**
  38102. * Returns the frame time of the most recent frame
  38103. */
  38104. get instantaneousFrameTime(): number;
  38105. /**
  38106. * Returns the average framerate in frames per second over the sliding window (or the subset of frames sampled so far)
  38107. */
  38108. get averageFPS(): number;
  38109. /**
  38110. * Returns the average framerate in frames per second using the most recent frame time
  38111. */
  38112. get instantaneousFPS(): number;
  38113. /**
  38114. * Returns true if enough samples have been taken to completely fill the sliding window
  38115. */
  38116. get isSaturated(): boolean;
  38117. /**
  38118. * Enables contributions to the sliding window sample set
  38119. */
  38120. enable(): void;
  38121. /**
  38122. * Disables contributions to the sliding window sample set
  38123. * Samples will not be interpolated over the disabled period
  38124. */
  38125. disable(): void;
  38126. /**
  38127. * Returns true if sampling is enabled
  38128. */
  38129. get isEnabled(): boolean;
  38130. /**
  38131. * Resets performance monitor
  38132. */
  38133. reset(): void;
  38134. }
  38135. /**
  38136. * RollingAverage
  38137. *
  38138. * Utility to efficiently compute the rolling average and variance over a sliding window of samples
  38139. */
  38140. export class RollingAverage {
  38141. /**
  38142. * Current average
  38143. */
  38144. average: number;
  38145. /**
  38146. * Current variance
  38147. */
  38148. variance: number;
  38149. protected _samples: Array<number>;
  38150. protected _sampleCount: number;
  38151. protected _pos: number;
  38152. protected _m2: number;
  38153. /**
  38154. * constructor
  38155. * @param length The number of samples required to saturate the sliding window
  38156. */
  38157. constructor(length: number);
  38158. /**
  38159. * Adds a sample to the sample set
  38160. * @param v The sample value
  38161. */
  38162. add(v: number): void;
  38163. /**
  38164. * Returns previously added values or null if outside of history or outside the sliding window domain
  38165. * @param i Index in history. For example, pass 0 for the most recent value and 1 for the value before that
  38166. * @return Value previously recorded with add() or null if outside of range
  38167. */
  38168. history(i: number): number;
  38169. /**
  38170. * Returns true if enough samples have been taken to completely fill the sliding window
  38171. * @return true if sample-set saturated
  38172. */
  38173. isSaturated(): boolean;
  38174. /**
  38175. * Resets the rolling average (equivalent to 0 samples taken so far)
  38176. */
  38177. reset(): void;
  38178. /**
  38179. * Wraps a value around the sample range boundaries
  38180. * @param i Position in sample range, for example if the sample length is 5, and i is -3, then 2 will be returned.
  38181. * @return Wrapped position in sample range
  38182. */
  38183. protected _wrapPosition(i: number): number;
  38184. }
  38185. }
  38186. declare module "babylonjs/Misc/perfCounter" {
  38187. /**
  38188. * This class is used to track a performance counter which is number based.
  38189. * The user has access to many properties which give statistics of different nature.
  38190. *
  38191. * The implementer can track two kinds of Performance Counter: time and count.
  38192. * 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.
  38193. * 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.
  38194. */
  38195. export class PerfCounter {
  38196. /**
  38197. * Gets or sets a global boolean to turn on and off all the counters
  38198. */
  38199. static Enabled: boolean;
  38200. /**
  38201. * Returns the smallest value ever
  38202. */
  38203. get min(): number;
  38204. /**
  38205. * Returns the biggest value ever
  38206. */
  38207. get max(): number;
  38208. /**
  38209. * Returns the average value since the performance counter is running
  38210. */
  38211. get average(): number;
  38212. /**
  38213. * Returns the average value of the last second the counter was monitored
  38214. */
  38215. get lastSecAverage(): number;
  38216. /**
  38217. * Returns the current value
  38218. */
  38219. get current(): number;
  38220. /**
  38221. * Gets the accumulated total
  38222. */
  38223. get total(): number;
  38224. /**
  38225. * Gets the total value count
  38226. */
  38227. get count(): number;
  38228. /**
  38229. * Creates a new counter
  38230. */
  38231. constructor();
  38232. /**
  38233. * Call this method to start monitoring a new frame.
  38234. * 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.
  38235. */
  38236. fetchNewFrame(): void;
  38237. /**
  38238. * Call this method to monitor a count of something (e.g. mesh drawn in viewport count)
  38239. * @param newCount the count value to add to the monitored count
  38240. * @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.
  38241. */
  38242. addCount(newCount: number, fetchResult: boolean): void;
  38243. /**
  38244. * Start monitoring this performance counter
  38245. */
  38246. beginMonitoring(): void;
  38247. /**
  38248. * Compute the time lapsed since the previous beginMonitoring() call.
  38249. * @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
  38250. */
  38251. endMonitoring(newFrame?: boolean): void;
  38252. private _fetchResult;
  38253. private _startMonitoringTime;
  38254. private _min;
  38255. private _max;
  38256. private _average;
  38257. private _current;
  38258. private _totalValueCount;
  38259. private _totalAccumulated;
  38260. private _lastSecAverage;
  38261. private _lastSecAccumulated;
  38262. private _lastSecTime;
  38263. private _lastSecValueCount;
  38264. }
  38265. }
  38266. declare module "babylonjs/Engines/Extensions/engine.alpha" {
  38267. module "babylonjs/Engines/thinEngine" {
  38268. interface ThinEngine {
  38269. /**
  38270. * Sets alpha constants used by some alpha blending modes
  38271. * @param r defines the red component
  38272. * @param g defines the green component
  38273. * @param b defines the blue component
  38274. * @param a defines the alpha component
  38275. */
  38276. setAlphaConstants(r: number, g: number, b: number, a: number): void;
  38277. /**
  38278. * Sets the current alpha mode
  38279. * @param mode defines the mode to use (one of the Engine.ALPHA_XXX)
  38280. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  38281. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  38282. */
  38283. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  38284. /**
  38285. * Gets the current alpha mode
  38286. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  38287. * @returns the current alpha mode
  38288. */
  38289. getAlphaMode(): number;
  38290. /**
  38291. * Sets the current alpha equation
  38292. * @param equation defines the equation to use (one of the Engine.ALPHA_EQUATION_XXX)
  38293. */
  38294. setAlphaEquation(equation: number): void;
  38295. /**
  38296. * Gets the current alpha equation.
  38297. * @returns the current alpha equation
  38298. */
  38299. getAlphaEquation(): number;
  38300. }
  38301. }
  38302. }
  38303. declare module "babylonjs/Engines/Extensions/engine.readTexture" {
  38304. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  38305. import { Nullable } from "babylonjs/types";
  38306. module "babylonjs/Engines/thinEngine" {
  38307. interface ThinEngine {
  38308. /** @hidden */
  38309. _readTexturePixels(texture: InternalTexture, width: number, height: number, faceIndex?: number, level?: number, buffer?: Nullable<ArrayBufferView>): ArrayBufferView;
  38310. }
  38311. }
  38312. }
  38313. declare module "babylonjs/Engines/engine" {
  38314. import { Observable } from "babylonjs/Misc/observable";
  38315. import { Nullable, IndicesArray, DataArray } from "babylonjs/types";
  38316. import { Scene } from "babylonjs/scene";
  38317. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  38318. import { IAudioEngine } from "babylonjs/Audio/audioEngine";
  38319. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  38320. import { ILoadingScreen } from "babylonjs/Loading/loadingScreen";
  38321. import { WebGLPipelineContext } from "babylonjs/Engines/WebGL/webGLPipelineContext";
  38322. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  38323. import { ICustomAnimationFrameRequester } from "babylonjs/Misc/customAnimationFrameRequester";
  38324. import { ThinEngine, EngineOptions } from "babylonjs/Engines/thinEngine";
  38325. import { IViewportLike, IColor4Like } from "babylonjs/Maths/math.like";
  38326. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  38327. import { PerformanceMonitor } from "babylonjs/Misc/performanceMonitor";
  38328. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  38329. import { PerfCounter } from "babylonjs/Misc/perfCounter";
  38330. import "babylonjs/Engines/Extensions/engine.alpha";
  38331. import "babylonjs/Engines/Extensions/engine.readTexture";
  38332. import { Material } from "babylonjs/Materials/material";
  38333. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  38334. /**
  38335. * Defines the interface used by display changed events
  38336. */
  38337. export interface IDisplayChangedEventArgs {
  38338. /** Gets the vrDisplay object (if any) */
  38339. vrDisplay: Nullable<any>;
  38340. /** Gets a boolean indicating if webVR is supported */
  38341. vrSupported: boolean;
  38342. }
  38343. /**
  38344. * Defines the interface used by objects containing a viewport (like a camera)
  38345. */
  38346. interface IViewportOwnerLike {
  38347. /**
  38348. * Gets or sets the viewport
  38349. */
  38350. viewport: IViewportLike;
  38351. }
  38352. /**
  38353. * The engine class is responsible for interfacing with all lower-level APIs such as WebGL and Audio
  38354. */
  38355. export class Engine extends ThinEngine {
  38356. /** Defines that alpha blending is disabled */
  38357. static readonly ALPHA_DISABLE: number;
  38358. /** Defines that alpha blending to SRC ALPHA * SRC + DEST */
  38359. static readonly ALPHA_ADD: number;
  38360. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC ALPHA) * DEST */
  38361. static readonly ALPHA_COMBINE: number;
  38362. /** Defines that alpha blending to DEST - SRC * DEST */
  38363. static readonly ALPHA_SUBTRACT: number;
  38364. /** Defines that alpha blending to SRC * DEST */
  38365. static readonly ALPHA_MULTIPLY: number;
  38366. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC) * DEST */
  38367. static readonly ALPHA_MAXIMIZED: number;
  38368. /** Defines that alpha blending to SRC + DEST */
  38369. static readonly ALPHA_ONEONE: number;
  38370. /** Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST */
  38371. static readonly ALPHA_PREMULTIPLIED: number;
  38372. /**
  38373. * Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST
  38374. * Alpha will be set to (1 - SRC ALPHA) * DEST ALPHA
  38375. */
  38376. static readonly ALPHA_PREMULTIPLIED_PORTERDUFF: number;
  38377. /** Defines that alpha blending to CST * SRC + (1 - CST) * DEST */
  38378. static readonly ALPHA_INTERPOLATE: number;
  38379. /**
  38380. * Defines that alpha blending to SRC + (1 - SRC) * DEST
  38381. * Alpha will be set to SRC ALPHA + (1 - SRC ALPHA) * DEST ALPHA
  38382. */
  38383. static readonly ALPHA_SCREENMODE: number;
  38384. /** Defines that the ressource is not delayed*/
  38385. static readonly DELAYLOADSTATE_NONE: number;
  38386. /** Defines that the ressource was successfully delay loaded */
  38387. static readonly DELAYLOADSTATE_LOADED: number;
  38388. /** Defines that the ressource is currently delay loading */
  38389. static readonly DELAYLOADSTATE_LOADING: number;
  38390. /** Defines that the ressource is delayed and has not started loading */
  38391. static readonly DELAYLOADSTATE_NOTLOADED: number;
  38392. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will never pass. i.e. Nothing will be drawn */
  38393. static readonly NEVER: number;
  38394. /** 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 */
  38395. static readonly ALWAYS: number;
  38396. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than the stored value */
  38397. static readonly LESS: number;
  38398. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is equals to the stored value */
  38399. static readonly EQUAL: number;
  38400. /** 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 */
  38401. static readonly LEQUAL: number;
  38402. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than the stored value */
  38403. static readonly GREATER: number;
  38404. /** 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 */
  38405. static readonly GEQUAL: number;
  38406. /** 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 */
  38407. static readonly NOTEQUAL: number;
  38408. /** Passed to stencilOperation to specify that stencil value must be kept */
  38409. static readonly KEEP: number;
  38410. /** Passed to stencilOperation to specify that stencil value must be replaced */
  38411. static readonly REPLACE: number;
  38412. /** Passed to stencilOperation to specify that stencil value must be incremented */
  38413. static readonly INCR: number;
  38414. /** Passed to stencilOperation to specify that stencil value must be decremented */
  38415. static readonly DECR: number;
  38416. /** Passed to stencilOperation to specify that stencil value must be inverted */
  38417. static readonly INVERT: number;
  38418. /** Passed to stencilOperation to specify that stencil value must be incremented with wrapping */
  38419. static readonly INCR_WRAP: number;
  38420. /** Passed to stencilOperation to specify that stencil value must be decremented with wrapping */
  38421. static readonly DECR_WRAP: number;
  38422. /** Texture is not repeating outside of 0..1 UVs */
  38423. static readonly TEXTURE_CLAMP_ADDRESSMODE: number;
  38424. /** Texture is repeating outside of 0..1 UVs */
  38425. static readonly TEXTURE_WRAP_ADDRESSMODE: number;
  38426. /** Texture is repeating and mirrored */
  38427. static readonly TEXTURE_MIRROR_ADDRESSMODE: number;
  38428. /** ALPHA */
  38429. static readonly TEXTUREFORMAT_ALPHA: number;
  38430. /** LUMINANCE */
  38431. static readonly TEXTUREFORMAT_LUMINANCE: number;
  38432. /** LUMINANCE_ALPHA */
  38433. static readonly TEXTUREFORMAT_LUMINANCE_ALPHA: number;
  38434. /** RGB */
  38435. static readonly TEXTUREFORMAT_RGB: number;
  38436. /** RGBA */
  38437. static readonly TEXTUREFORMAT_RGBA: number;
  38438. /** RED */
  38439. static readonly TEXTUREFORMAT_RED: number;
  38440. /** RED (2nd reference) */
  38441. static readonly TEXTUREFORMAT_R: number;
  38442. /** RG */
  38443. static readonly TEXTUREFORMAT_RG: number;
  38444. /** RED_INTEGER */
  38445. static readonly TEXTUREFORMAT_RED_INTEGER: number;
  38446. /** RED_INTEGER (2nd reference) */
  38447. static readonly TEXTUREFORMAT_R_INTEGER: number;
  38448. /** RG_INTEGER */
  38449. static readonly TEXTUREFORMAT_RG_INTEGER: number;
  38450. /** RGB_INTEGER */
  38451. static readonly TEXTUREFORMAT_RGB_INTEGER: number;
  38452. /** RGBA_INTEGER */
  38453. static readonly TEXTUREFORMAT_RGBA_INTEGER: number;
  38454. /** UNSIGNED_BYTE */
  38455. static readonly TEXTURETYPE_UNSIGNED_BYTE: number;
  38456. /** UNSIGNED_BYTE (2nd reference) */
  38457. static readonly TEXTURETYPE_UNSIGNED_INT: number;
  38458. /** FLOAT */
  38459. static readonly TEXTURETYPE_FLOAT: number;
  38460. /** HALF_FLOAT */
  38461. static readonly TEXTURETYPE_HALF_FLOAT: number;
  38462. /** BYTE */
  38463. static readonly TEXTURETYPE_BYTE: number;
  38464. /** SHORT */
  38465. static readonly TEXTURETYPE_SHORT: number;
  38466. /** UNSIGNED_SHORT */
  38467. static readonly TEXTURETYPE_UNSIGNED_SHORT: number;
  38468. /** INT */
  38469. static readonly TEXTURETYPE_INT: number;
  38470. /** UNSIGNED_INT */
  38471. static readonly TEXTURETYPE_UNSIGNED_INTEGER: number;
  38472. /** UNSIGNED_SHORT_4_4_4_4 */
  38473. static readonly TEXTURETYPE_UNSIGNED_SHORT_4_4_4_4: number;
  38474. /** UNSIGNED_SHORT_5_5_5_1 */
  38475. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_5_5_1: number;
  38476. /** UNSIGNED_SHORT_5_6_5 */
  38477. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_6_5: number;
  38478. /** UNSIGNED_INT_2_10_10_10_REV */
  38479. static readonly TEXTURETYPE_UNSIGNED_INT_2_10_10_10_REV: number;
  38480. /** UNSIGNED_INT_24_8 */
  38481. static readonly TEXTURETYPE_UNSIGNED_INT_24_8: number;
  38482. /** UNSIGNED_INT_10F_11F_11F_REV */
  38483. static readonly TEXTURETYPE_UNSIGNED_INT_10F_11F_11F_REV: number;
  38484. /** UNSIGNED_INT_5_9_9_9_REV */
  38485. static readonly TEXTURETYPE_UNSIGNED_INT_5_9_9_9_REV: number;
  38486. /** FLOAT_32_UNSIGNED_INT_24_8_REV */
  38487. static readonly TEXTURETYPE_FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  38488. /** nearest is mag = nearest and min = nearest and mip = linear */
  38489. static readonly TEXTURE_NEAREST_SAMPLINGMODE: number;
  38490. /** Bilinear is mag = linear and min = linear and mip = nearest */
  38491. static readonly TEXTURE_BILINEAR_SAMPLINGMODE: number;
  38492. /** Trilinear is mag = linear and min = linear and mip = linear */
  38493. static readonly TEXTURE_TRILINEAR_SAMPLINGMODE: number;
  38494. /** nearest is mag = nearest and min = nearest and mip = linear */
  38495. static readonly TEXTURE_NEAREST_NEAREST_MIPLINEAR: number;
  38496. /** Bilinear is mag = linear and min = linear and mip = nearest */
  38497. static readonly TEXTURE_LINEAR_LINEAR_MIPNEAREST: number;
  38498. /** Trilinear is mag = linear and min = linear and mip = linear */
  38499. static readonly TEXTURE_LINEAR_LINEAR_MIPLINEAR: number;
  38500. /** mag = nearest and min = nearest and mip = nearest */
  38501. static readonly TEXTURE_NEAREST_NEAREST_MIPNEAREST: number;
  38502. /** mag = nearest and min = linear and mip = nearest */
  38503. static readonly TEXTURE_NEAREST_LINEAR_MIPNEAREST: number;
  38504. /** mag = nearest and min = linear and mip = linear */
  38505. static readonly TEXTURE_NEAREST_LINEAR_MIPLINEAR: number;
  38506. /** mag = nearest and min = linear and mip = none */
  38507. static readonly TEXTURE_NEAREST_LINEAR: number;
  38508. /** mag = nearest and min = nearest and mip = none */
  38509. static readonly TEXTURE_NEAREST_NEAREST: number;
  38510. /** mag = linear and min = nearest and mip = nearest */
  38511. static readonly TEXTURE_LINEAR_NEAREST_MIPNEAREST: number;
  38512. /** mag = linear and min = nearest and mip = linear */
  38513. static readonly TEXTURE_LINEAR_NEAREST_MIPLINEAR: number;
  38514. /** mag = linear and min = linear and mip = none */
  38515. static readonly TEXTURE_LINEAR_LINEAR: number;
  38516. /** mag = linear and min = nearest and mip = none */
  38517. static readonly TEXTURE_LINEAR_NEAREST: number;
  38518. /** Explicit coordinates mode */
  38519. static readonly TEXTURE_EXPLICIT_MODE: number;
  38520. /** Spherical coordinates mode */
  38521. static readonly TEXTURE_SPHERICAL_MODE: number;
  38522. /** Planar coordinates mode */
  38523. static readonly TEXTURE_PLANAR_MODE: number;
  38524. /** Cubic coordinates mode */
  38525. static readonly TEXTURE_CUBIC_MODE: number;
  38526. /** Projection coordinates mode */
  38527. static readonly TEXTURE_PROJECTION_MODE: number;
  38528. /** Skybox coordinates mode */
  38529. static readonly TEXTURE_SKYBOX_MODE: number;
  38530. /** Inverse Cubic coordinates mode */
  38531. static readonly TEXTURE_INVCUBIC_MODE: number;
  38532. /** Equirectangular coordinates mode */
  38533. static readonly TEXTURE_EQUIRECTANGULAR_MODE: number;
  38534. /** Equirectangular Fixed coordinates mode */
  38535. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MODE: number;
  38536. /** Equirectangular Fixed Mirrored coordinates mode */
  38537. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  38538. /** Defines that texture rescaling will use a floor to find the closer power of 2 size */
  38539. static readonly SCALEMODE_FLOOR: number;
  38540. /** Defines that texture rescaling will look for the nearest power of 2 size */
  38541. static readonly SCALEMODE_NEAREST: number;
  38542. /** Defines that texture rescaling will use a ceil to find the closer power of 2 size */
  38543. static readonly SCALEMODE_CEILING: number;
  38544. /**
  38545. * Returns the current npm package of the sdk
  38546. */
  38547. static get NpmPackage(): string;
  38548. /**
  38549. * Returns the current version of the framework
  38550. */
  38551. static get Version(): string;
  38552. /** Gets the list of created engines */
  38553. static get Instances(): Engine[];
  38554. /**
  38555. * Gets the latest created engine
  38556. */
  38557. static get LastCreatedEngine(): Nullable<Engine>;
  38558. /**
  38559. * Gets the latest created scene
  38560. */
  38561. static get LastCreatedScene(): Nullable<Scene>;
  38562. /**
  38563. * Will flag all materials in all scenes in all engines as dirty to trigger new shader compilation
  38564. * @param flag defines which part of the materials must be marked as dirty
  38565. * @param predicate defines a predicate used to filter which materials should be affected
  38566. */
  38567. static MarkAllMaterialsAsDirty(flag: number, predicate?: (mat: Material) => boolean): void;
  38568. /**
  38569. * Method called to create the default loading screen.
  38570. * This can be overriden in your own app.
  38571. * @param canvas The rendering canvas element
  38572. * @returns The loading screen
  38573. */
  38574. static DefaultLoadingScreenFactory(canvas: HTMLCanvasElement): ILoadingScreen;
  38575. /**
  38576. * Method called to create the default rescale post process on each engine.
  38577. */
  38578. static _RescalePostProcessFactory: Nullable<(engine: Engine) => PostProcess>;
  38579. /**
  38580. * Gets or sets a boolean to enable/disable IndexedDB support and avoid XHR on .manifest
  38581. **/
  38582. enableOfflineSupport: boolean;
  38583. /**
  38584. * 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)
  38585. **/
  38586. disableManifestCheck: boolean;
  38587. /**
  38588. * Gets the list of created scenes
  38589. */
  38590. scenes: Scene[];
  38591. /**
  38592. * Event raised when a new scene is created
  38593. */
  38594. onNewSceneAddedObservable: Observable<Scene>;
  38595. /**
  38596. * Gets the list of created postprocesses
  38597. */
  38598. postProcesses: import("babylonjs/PostProcesses/postProcess").PostProcess[];
  38599. /**
  38600. * Gets a boolean indicating if the pointer is currently locked
  38601. */
  38602. isPointerLock: boolean;
  38603. /**
  38604. * Observable event triggered each time the rendering canvas is resized
  38605. */
  38606. onResizeObservable: Observable<Engine>;
  38607. /**
  38608. * Observable event triggered each time the canvas loses focus
  38609. */
  38610. onCanvasBlurObservable: Observable<Engine>;
  38611. /**
  38612. * Observable event triggered each time the canvas gains focus
  38613. */
  38614. onCanvasFocusObservable: Observable<Engine>;
  38615. /**
  38616. * Observable event triggered each time the canvas receives pointerout event
  38617. */
  38618. onCanvasPointerOutObservable: Observable<PointerEvent>;
  38619. /**
  38620. * Observable raised when the engine begins a new frame
  38621. */
  38622. onBeginFrameObservable: Observable<Engine>;
  38623. /**
  38624. * If set, will be used to request the next animation frame for the render loop
  38625. */
  38626. customAnimationFrameRequester: Nullable<ICustomAnimationFrameRequester>;
  38627. /**
  38628. * Observable raised when the engine ends the current frame
  38629. */
  38630. onEndFrameObservable: Observable<Engine>;
  38631. /**
  38632. * Observable raised when the engine is about to compile a shader
  38633. */
  38634. onBeforeShaderCompilationObservable: Observable<Engine>;
  38635. /**
  38636. * Observable raised when the engine has jsut compiled a shader
  38637. */
  38638. onAfterShaderCompilationObservable: Observable<Engine>;
  38639. /**
  38640. * Gets the audio engine
  38641. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  38642. * @ignorenaming
  38643. */
  38644. static audioEngine: IAudioEngine;
  38645. /**
  38646. * Default AudioEngine factory responsible of creating the Audio Engine.
  38647. * By default, this will create a BabylonJS Audio Engine if the workload has been embedded.
  38648. */
  38649. static AudioEngineFactory: (hostElement: Nullable<HTMLElement>) => IAudioEngine;
  38650. /**
  38651. * Default offline support factory responsible of creating a tool used to store data locally.
  38652. * By default, this will create a Database object if the workload has been embedded.
  38653. */
  38654. static OfflineProviderFactory: (urlToScene: string, callbackManifestChecked: (checked: boolean) => any, disableManifestCheck: boolean) => IOfflineProvider;
  38655. private _loadingScreen;
  38656. private _pointerLockRequested;
  38657. private _rescalePostProcess;
  38658. private _deterministicLockstep;
  38659. private _lockstepMaxSteps;
  38660. private _timeStep;
  38661. protected get _supportsHardwareTextureRescaling(): boolean;
  38662. private _fps;
  38663. private _deltaTime;
  38664. /** @hidden */
  38665. _drawCalls: PerfCounter;
  38666. /** 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 */
  38667. canvasTabIndex: number;
  38668. /**
  38669. * Turn this value on if you want to pause FPS computation when in background
  38670. */
  38671. disablePerformanceMonitorInBackground: boolean;
  38672. private _performanceMonitor;
  38673. /**
  38674. * Gets the performance monitor attached to this engine
  38675. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  38676. */
  38677. get performanceMonitor(): PerformanceMonitor;
  38678. private _onFocus;
  38679. private _onBlur;
  38680. private _onCanvasPointerOut;
  38681. private _onCanvasBlur;
  38682. private _onCanvasFocus;
  38683. private _onFullscreenChange;
  38684. private _onPointerLockChange;
  38685. /**
  38686. * Gets the HTML element used to attach event listeners
  38687. * @returns a HTML element
  38688. */
  38689. getInputElement(): Nullable<HTMLElement>;
  38690. /**
  38691. * Creates a new engine
  38692. * @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
  38693. * @param antialias defines enable antialiasing (default: false)
  38694. * @param options defines further options to be sent to the getContext() function
  38695. * @param adaptToDeviceRatio defines whether to adapt to the device's viewport characteristics (default: false)
  38696. */
  38697. constructor(canvasOrContext: Nullable<HTMLCanvasElement | WebGLRenderingContext>, antialias?: boolean, options?: EngineOptions, adaptToDeviceRatio?: boolean);
  38698. /**
  38699. * Gets current aspect ratio
  38700. * @param viewportOwner defines the camera to use to get the aspect ratio
  38701. * @param useScreen defines if screen size must be used (or the current render target if any)
  38702. * @returns a number defining the aspect ratio
  38703. */
  38704. getAspectRatio(viewportOwner: IViewportOwnerLike, useScreen?: boolean): number;
  38705. /**
  38706. * Gets current screen aspect ratio
  38707. * @returns a number defining the aspect ratio
  38708. */
  38709. getScreenAspectRatio(): number;
  38710. /**
  38711. * Gets the client rect of the HTML canvas attached with the current webGL context
  38712. * @returns a client rectanglee
  38713. */
  38714. getRenderingCanvasClientRect(): Nullable<ClientRect>;
  38715. /**
  38716. * Gets the client rect of the HTML element used for events
  38717. * @returns a client rectanglee
  38718. */
  38719. getInputElementClientRect(): Nullable<ClientRect>;
  38720. /**
  38721. * Gets a boolean indicating that the engine is running in deterministic lock step mode
  38722. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  38723. * @returns true if engine is in deterministic lock step mode
  38724. */
  38725. isDeterministicLockStep(): boolean;
  38726. /**
  38727. * Gets the max steps when engine is running in deterministic lock step
  38728. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  38729. * @returns the max steps
  38730. */
  38731. getLockstepMaxSteps(): number;
  38732. /**
  38733. * Returns the time in ms between steps when using deterministic lock step.
  38734. * @returns time step in (ms)
  38735. */
  38736. getTimeStep(): number;
  38737. /**
  38738. * Force the mipmap generation for the given render target texture
  38739. * @param texture defines the render target texture to use
  38740. * @param unbind defines whether or not to unbind the texture after generation. Defaults to true.
  38741. */
  38742. generateMipMapsForCubemap(texture: InternalTexture, unbind?: boolean): void;
  38743. /** States */
  38744. /**
  38745. * Set various states to the webGL context
  38746. * @param culling defines backface culling state
  38747. * @param zOffset defines the value to apply to zOffset (0 by default)
  38748. * @param force defines if states must be applied even if cache is up to date
  38749. * @param reverseSide defines if culling must be reversed (CCW instead of CW and CW instead of CCW)
  38750. */
  38751. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  38752. /**
  38753. * Set the z offset to apply to current rendering
  38754. * @param value defines the offset to apply
  38755. */
  38756. setZOffset(value: number): void;
  38757. /**
  38758. * Gets the current value of the zOffset
  38759. * @returns the current zOffset state
  38760. */
  38761. getZOffset(): number;
  38762. /**
  38763. * Enable or disable depth buffering
  38764. * @param enable defines the state to set
  38765. */
  38766. setDepthBuffer(enable: boolean): void;
  38767. /**
  38768. * Gets a boolean indicating if depth writing is enabled
  38769. * @returns the current depth writing state
  38770. */
  38771. getDepthWrite(): boolean;
  38772. /**
  38773. * Enable or disable depth writing
  38774. * @param enable defines the state to set
  38775. */
  38776. setDepthWrite(enable: boolean): void;
  38777. /**
  38778. * Gets a boolean indicating if stencil buffer is enabled
  38779. * @returns the current stencil buffer state
  38780. */
  38781. getStencilBuffer(): boolean;
  38782. /**
  38783. * Enable or disable the stencil buffer
  38784. * @param enable defines if the stencil buffer must be enabled or disabled
  38785. */
  38786. setStencilBuffer(enable: boolean): void;
  38787. /**
  38788. * Gets the current stencil mask
  38789. * @returns a number defining the new stencil mask to use
  38790. */
  38791. getStencilMask(): number;
  38792. /**
  38793. * Sets the current stencil mask
  38794. * @param mask defines the new stencil mask to use
  38795. */
  38796. setStencilMask(mask: number): void;
  38797. /**
  38798. * Gets the current stencil function
  38799. * @returns a number defining the stencil function to use
  38800. */
  38801. getStencilFunction(): number;
  38802. /**
  38803. * Gets the current stencil reference value
  38804. * @returns a number defining the stencil reference value to use
  38805. */
  38806. getStencilFunctionReference(): number;
  38807. /**
  38808. * Gets the current stencil mask
  38809. * @returns a number defining the stencil mask to use
  38810. */
  38811. getStencilFunctionMask(): number;
  38812. /**
  38813. * Sets the current stencil function
  38814. * @param stencilFunc defines the new stencil function to use
  38815. */
  38816. setStencilFunction(stencilFunc: number): void;
  38817. /**
  38818. * Sets the current stencil reference
  38819. * @param reference defines the new stencil reference to use
  38820. */
  38821. setStencilFunctionReference(reference: number): void;
  38822. /**
  38823. * Sets the current stencil mask
  38824. * @param mask defines the new stencil mask to use
  38825. */
  38826. setStencilFunctionMask(mask: number): void;
  38827. /**
  38828. * Gets the current stencil operation when stencil fails
  38829. * @returns a number defining stencil operation to use when stencil fails
  38830. */
  38831. getStencilOperationFail(): number;
  38832. /**
  38833. * Gets the current stencil operation when depth fails
  38834. * @returns a number defining stencil operation to use when depth fails
  38835. */
  38836. getStencilOperationDepthFail(): number;
  38837. /**
  38838. * Gets the current stencil operation when stencil passes
  38839. * @returns a number defining stencil operation to use when stencil passes
  38840. */
  38841. getStencilOperationPass(): number;
  38842. /**
  38843. * Sets the stencil operation to use when stencil fails
  38844. * @param operation defines the stencil operation to use when stencil fails
  38845. */
  38846. setStencilOperationFail(operation: number): void;
  38847. /**
  38848. * Sets the stencil operation to use when depth fails
  38849. * @param operation defines the stencil operation to use when depth fails
  38850. */
  38851. setStencilOperationDepthFail(operation: number): void;
  38852. /**
  38853. * Sets the stencil operation to use when stencil passes
  38854. * @param operation defines the stencil operation to use when stencil passes
  38855. */
  38856. setStencilOperationPass(operation: number): void;
  38857. /**
  38858. * Sets a boolean indicating if the dithering state is enabled or disabled
  38859. * @param value defines the dithering state
  38860. */
  38861. setDitheringState(value: boolean): void;
  38862. /**
  38863. * Sets a boolean indicating if the rasterizer state is enabled or disabled
  38864. * @param value defines the rasterizer state
  38865. */
  38866. setRasterizerState(value: boolean): void;
  38867. /**
  38868. * Gets the current depth function
  38869. * @returns a number defining the depth function
  38870. */
  38871. getDepthFunction(): Nullable<number>;
  38872. /**
  38873. * Sets the current depth function
  38874. * @param depthFunc defines the function to use
  38875. */
  38876. setDepthFunction(depthFunc: number): void;
  38877. /**
  38878. * Sets the current depth function to GREATER
  38879. */
  38880. setDepthFunctionToGreater(): void;
  38881. /**
  38882. * Sets the current depth function to GEQUAL
  38883. */
  38884. setDepthFunctionToGreaterOrEqual(): void;
  38885. /**
  38886. * Sets the current depth function to LESS
  38887. */
  38888. setDepthFunctionToLess(): void;
  38889. /**
  38890. * Sets the current depth function to LEQUAL
  38891. */
  38892. setDepthFunctionToLessOrEqual(): void;
  38893. private _cachedStencilBuffer;
  38894. private _cachedStencilFunction;
  38895. private _cachedStencilMask;
  38896. private _cachedStencilOperationPass;
  38897. private _cachedStencilOperationFail;
  38898. private _cachedStencilOperationDepthFail;
  38899. private _cachedStencilReference;
  38900. /**
  38901. * Caches the the state of the stencil buffer
  38902. */
  38903. cacheStencilState(): void;
  38904. /**
  38905. * Restores the state of the stencil buffer
  38906. */
  38907. restoreStencilState(): void;
  38908. /**
  38909. * Directly set the WebGL Viewport
  38910. * @param x defines the x coordinate of the viewport (in screen space)
  38911. * @param y defines the y coordinate of the viewport (in screen space)
  38912. * @param width defines the width of the viewport (in screen space)
  38913. * @param height defines the height of the viewport (in screen space)
  38914. * @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
  38915. */
  38916. setDirectViewport(x: number, y: number, width: number, height: number): Nullable<IViewportLike>;
  38917. /**
  38918. * Executes a scissor clear (ie. a clear on a specific portion of the screen)
  38919. * @param x defines the x-coordinate of the top left corner of the clear rectangle
  38920. * @param y defines the y-coordinate of the corner of the clear rectangle
  38921. * @param width defines the width of the clear rectangle
  38922. * @param height defines the height of the clear rectangle
  38923. * @param clearColor defines the clear color
  38924. */
  38925. scissorClear(x: number, y: number, width: number, height: number, clearColor: IColor4Like): void;
  38926. /**
  38927. * Enable scissor test on a specific rectangle (ie. render will only be executed on a specific portion of the screen)
  38928. * @param x defines the x-coordinate of the top left corner of the clear rectangle
  38929. * @param y defines the y-coordinate of the corner of the clear rectangle
  38930. * @param width defines the width of the clear rectangle
  38931. * @param height defines the height of the clear rectangle
  38932. */
  38933. enableScissor(x: number, y: number, width: number, height: number): void;
  38934. /**
  38935. * Disable previously set scissor test rectangle
  38936. */
  38937. disableScissor(): void;
  38938. protected _reportDrawCall(): void;
  38939. /**
  38940. * Initializes a webVR display and starts listening to display change events
  38941. * The onVRDisplayChangedObservable will be notified upon these changes
  38942. * @returns The onVRDisplayChangedObservable
  38943. */
  38944. initWebVR(): Observable<IDisplayChangedEventArgs>;
  38945. /** @hidden */
  38946. _prepareVRComponent(): void;
  38947. /** @hidden */
  38948. _connectVREvents(canvas?: HTMLCanvasElement, document?: any): void;
  38949. /** @hidden */
  38950. _submitVRFrame(): void;
  38951. /**
  38952. * Call this function to leave webVR mode
  38953. * Will do nothing if webVR is not supported or if there is no webVR device
  38954. * @see https://doc.babylonjs.com/how_to/webvr_camera
  38955. */
  38956. disableVR(): void;
  38957. /**
  38958. * Gets a boolean indicating that the system is in VR mode and is presenting
  38959. * @returns true if VR mode is engaged
  38960. */
  38961. isVRPresenting(): boolean;
  38962. /** @hidden */
  38963. _requestVRFrame(): void;
  38964. /** @hidden */
  38965. _loadFileAsync(url: string, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  38966. /**
  38967. * Gets the source code of the vertex shader associated with a specific webGL program
  38968. * @param program defines the program to use
  38969. * @returns a string containing the source code of the vertex shader associated with the program
  38970. */
  38971. getVertexShaderSource(program: WebGLProgram): Nullable<string>;
  38972. /**
  38973. * Gets the source code of the fragment shader associated with a specific webGL program
  38974. * @param program defines the program to use
  38975. * @returns a string containing the source code of the fragment shader associated with the program
  38976. */
  38977. getFragmentShaderSource(program: WebGLProgram): Nullable<string>;
  38978. /**
  38979. * Sets a depth stencil texture from a render target to the according uniform.
  38980. * @param channel The texture channel
  38981. * @param uniform The uniform to set
  38982. * @param texture The render target texture containing the depth stencil texture to apply
  38983. */
  38984. setDepthStencilTexture(channel: number, uniform: Nullable<WebGLUniformLocation>, texture: Nullable<RenderTargetTexture>): void;
  38985. /**
  38986. * Sets a texture to the webGL context from a postprocess
  38987. * @param channel defines the channel to use
  38988. * @param postProcess defines the source postprocess
  38989. */
  38990. setTextureFromPostProcess(channel: number, postProcess: Nullable<PostProcess>): void;
  38991. /**
  38992. * Binds the output of the passed in post process to the texture channel specified
  38993. * @param channel The channel the texture should be bound to
  38994. * @param postProcess The post process which's output should be bound
  38995. */
  38996. setTextureFromPostProcessOutput(channel: number, postProcess: Nullable<PostProcess>): void;
  38997. protected _rebuildBuffers(): void;
  38998. /** @hidden */
  38999. _renderFrame(): void;
  39000. _renderLoop(): void;
  39001. /** @hidden */
  39002. _renderViews(): boolean;
  39003. /**
  39004. * Toggle full screen mode
  39005. * @param requestPointerLock defines if a pointer lock should be requested from the user
  39006. */
  39007. switchFullscreen(requestPointerLock: boolean): void;
  39008. /**
  39009. * Enters full screen mode
  39010. * @param requestPointerLock defines if a pointer lock should be requested from the user
  39011. */
  39012. enterFullscreen(requestPointerLock: boolean): void;
  39013. /**
  39014. * Exits full screen mode
  39015. */
  39016. exitFullscreen(): void;
  39017. /**
  39018. * Enters Pointerlock mode
  39019. */
  39020. enterPointerlock(): void;
  39021. /**
  39022. * Exits Pointerlock mode
  39023. */
  39024. exitPointerlock(): void;
  39025. /**
  39026. * Begin a new frame
  39027. */
  39028. beginFrame(): void;
  39029. /**
  39030. * Enf the current frame
  39031. */
  39032. endFrame(): void;
  39033. resize(): void;
  39034. /**
  39035. * Force a specific size of the canvas
  39036. * @param width defines the new canvas' width
  39037. * @param height defines the new canvas' height
  39038. * @returns true if the size was changed
  39039. */
  39040. setSize(width: number, height: number): boolean;
  39041. /**
  39042. * Updates a dynamic vertex buffer.
  39043. * @param vertexBuffer the vertex buffer to update
  39044. * @param data the data used to update the vertex buffer
  39045. * @param byteOffset the byte offset of the data
  39046. * @param byteLength the byte length of the data
  39047. */
  39048. updateDynamicVertexBuffer(vertexBuffer: DataBuffer, data: DataArray, byteOffset?: number, byteLength?: number): void;
  39049. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  39050. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  39051. protected _createShaderProgram(pipelineContext: WebGLPipelineContext, vertexShader: WebGLShader, fragmentShader: WebGLShader, context: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  39052. _releaseTexture(texture: InternalTexture): void;
  39053. /**
  39054. * @hidden
  39055. * Rescales a texture
  39056. * @param source input texutre
  39057. * @param destination destination texture
  39058. * @param scene scene to use to render the resize
  39059. * @param internalFormat format to use when resizing
  39060. * @param onComplete callback to be called when resize has completed
  39061. */
  39062. _rescaleTexture(source: InternalTexture, destination: InternalTexture, scene: Nullable<any>, internalFormat: number, onComplete: () => void): void;
  39063. /**
  39064. * Gets the current framerate
  39065. * @returns a number representing the framerate
  39066. */
  39067. getFps(): number;
  39068. /**
  39069. * Gets the time spent between current and previous frame
  39070. * @returns a number representing the delta time in ms
  39071. */
  39072. getDeltaTime(): number;
  39073. private _measureFps;
  39074. /** @hidden */
  39075. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement | ImageBitmap, faceIndex?: number, lod?: number): void;
  39076. /**
  39077. * Update a dynamic index buffer
  39078. * @param indexBuffer defines the target index buffer
  39079. * @param indices defines the data to update
  39080. * @param offset defines the offset in the target index buffer where update should start
  39081. */
  39082. updateDynamicIndexBuffer(indexBuffer: DataBuffer, indices: IndicesArray, offset?: number): void;
  39083. /**
  39084. * Updates the sample count of a render target texture
  39085. * @see https://doc.babylonjs.com/features/webgl2#multisample-render-targets
  39086. * @param texture defines the texture to update
  39087. * @param samples defines the sample count to set
  39088. * @returns the effective sample count (could be 0 if multisample render targets are not supported)
  39089. */
  39090. updateRenderTargetTextureSampleCount(texture: Nullable<InternalTexture>, samples: number): number;
  39091. /**
  39092. * Updates a depth texture Comparison Mode and Function.
  39093. * If the comparison Function is equal to 0, the mode will be set to none.
  39094. * Otherwise, this only works in webgl 2 and requires a shadow sampler in the shader.
  39095. * @param texture The texture to set the comparison function for
  39096. * @param comparisonFunction The comparison function to set, 0 if no comparison required
  39097. */
  39098. updateTextureComparisonFunction(texture: InternalTexture, comparisonFunction: number): void;
  39099. /**
  39100. * Creates a webGL buffer to use with instanciation
  39101. * @param capacity defines the size of the buffer
  39102. * @returns the webGL buffer
  39103. */
  39104. createInstancesBuffer(capacity: number): DataBuffer;
  39105. /**
  39106. * Delete a webGL buffer used with instanciation
  39107. * @param buffer defines the webGL buffer to delete
  39108. */
  39109. deleteInstancesBuffer(buffer: WebGLBuffer): void;
  39110. private _clientWaitAsync;
  39111. /** @hidden */
  39112. _readPixelsAsync(x: number, y: number, w: number, h: number, format: number, type: number, outputBuffer: ArrayBufferView): Promise<ArrayBufferView> | null;
  39113. dispose(): void;
  39114. private _disableTouchAction;
  39115. /**
  39116. * Display the loading screen
  39117. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  39118. */
  39119. displayLoadingUI(): void;
  39120. /**
  39121. * Hide the loading screen
  39122. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  39123. */
  39124. hideLoadingUI(): void;
  39125. /**
  39126. * Gets the current loading screen object
  39127. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  39128. */
  39129. get loadingScreen(): ILoadingScreen;
  39130. /**
  39131. * Sets the current loading screen object
  39132. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  39133. */
  39134. set loadingScreen(loadingScreen: ILoadingScreen);
  39135. /**
  39136. * Sets the current loading screen text
  39137. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  39138. */
  39139. set loadingUIText(text: string);
  39140. /**
  39141. * Sets the current loading screen background color
  39142. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  39143. */
  39144. set loadingUIBackgroundColor(color: string);
  39145. /** Pointerlock and fullscreen */
  39146. /**
  39147. * Ask the browser to promote the current element to pointerlock mode
  39148. * @param element defines the DOM element to promote
  39149. */
  39150. static _RequestPointerlock(element: HTMLElement): void;
  39151. /**
  39152. * Asks the browser to exit pointerlock mode
  39153. */
  39154. static _ExitPointerlock(): void;
  39155. /**
  39156. * Ask the browser to promote the current element to fullscreen rendering mode
  39157. * @param element defines the DOM element to promote
  39158. */
  39159. static _RequestFullscreen(element: HTMLElement): void;
  39160. /**
  39161. * Asks the browser to exit fullscreen mode
  39162. */
  39163. static _ExitFullscreen(): void;
  39164. }
  39165. }
  39166. declare module "babylonjs/Engines/engineStore" {
  39167. import { Nullable } from "babylonjs/types";
  39168. import { Engine } from "babylonjs/Engines/engine";
  39169. import { Scene } from "babylonjs/scene";
  39170. /**
  39171. * The engine store class is responsible to hold all the instances of Engine and Scene created
  39172. * during the life time of the application.
  39173. */
  39174. export class EngineStore {
  39175. /** Gets the list of created engines */
  39176. static Instances: import("babylonjs/Engines/engine").Engine[];
  39177. /** @hidden */
  39178. static _LastCreatedScene: Nullable<Scene>;
  39179. /**
  39180. * Gets the latest created engine
  39181. */
  39182. static get LastCreatedEngine(): Nullable<Engine>;
  39183. /**
  39184. * Gets the latest created scene
  39185. */
  39186. static get LastCreatedScene(): Nullable<Scene>;
  39187. /**
  39188. * Gets or sets a global variable indicating if fallback texture must be used when a texture cannot be loaded
  39189. * @ignorenaming
  39190. */
  39191. static UseFallbackTexture: boolean;
  39192. /**
  39193. * Texture content used if a texture cannot loaded
  39194. * @ignorenaming
  39195. */
  39196. static FallbackTexture: string;
  39197. }
  39198. }
  39199. declare module "babylonjs/Misc/promise" {
  39200. /**
  39201. * Helper class that provides a small promise polyfill
  39202. */
  39203. export class PromisePolyfill {
  39204. /**
  39205. * Static function used to check if the polyfill is required
  39206. * If this is the case then the function will inject the polyfill to window.Promise
  39207. * @param force defines a boolean used to force the injection (mostly for testing purposes)
  39208. */
  39209. static Apply(force?: boolean): void;
  39210. }
  39211. }
  39212. declare module "babylonjs/Misc/interfaces/screenshotSize" {
  39213. /**
  39214. * Interface for screenshot methods with describe argument called `size` as object with options
  39215. * @link https://doc.babylonjs.com/api/classes/babylon.screenshottools
  39216. */
  39217. export interface IScreenshotSize {
  39218. /**
  39219. * number in pixels for canvas height
  39220. */
  39221. height?: number;
  39222. /**
  39223. * multiplier allowing render at a higher or lower resolution
  39224. * If value is defined then height and width will be ignored and taken from camera
  39225. */
  39226. precision?: number;
  39227. /**
  39228. * number in pixels for canvas width
  39229. */
  39230. width?: number;
  39231. }
  39232. }
  39233. declare module "babylonjs/Misc/tools" {
  39234. import { Nullable, float } from "babylonjs/types";
  39235. import { DomManagement } from "babylonjs/Misc/domManagement";
  39236. import { WebRequest } from "babylonjs/Misc/webRequest";
  39237. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  39238. import { ReadFileError } from "babylonjs/Misc/fileTools";
  39239. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  39240. import { IScreenshotSize } from "babylonjs/Misc/interfaces/screenshotSize";
  39241. import { Camera } from "babylonjs/Cameras/camera";
  39242. import { Engine } from "babylonjs/Engines/engine";
  39243. interface IColor4Like {
  39244. r: float;
  39245. g: float;
  39246. b: float;
  39247. a: float;
  39248. }
  39249. /**
  39250. * Class containing a set of static utilities functions
  39251. */
  39252. export class Tools {
  39253. /**
  39254. * Gets or sets the base URL to use to load assets
  39255. */
  39256. static get BaseUrl(): string;
  39257. static set BaseUrl(value: string);
  39258. /**
  39259. * Enable/Disable Custom HTTP Request Headers globally.
  39260. * default = false
  39261. * @see CustomRequestHeaders
  39262. */
  39263. static UseCustomRequestHeaders: boolean;
  39264. /**
  39265. * Custom HTTP Request Headers to be sent with XMLHttpRequests
  39266. * i.e. when loading files, where the server/service expects an Authorization header
  39267. */
  39268. static CustomRequestHeaders: {
  39269. [key: string]: string;
  39270. };
  39271. /**
  39272. * Gets or sets the retry strategy to apply when an error happens while loading an asset
  39273. */
  39274. static get DefaultRetryStrategy(): (url: string, request: WebRequest, retryIndex: number) => number;
  39275. static set DefaultRetryStrategy(strategy: (url: string, request: WebRequest, retryIndex: number) => number);
  39276. /**
  39277. * Default behaviour for cors in the application.
  39278. * It can be a string if the expected behavior is identical in the entire app.
  39279. * Or a callback to be able to set it per url or on a group of them (in case of Video source for instance)
  39280. */
  39281. static get CorsBehavior(): string | ((url: string | string[]) => string);
  39282. static set CorsBehavior(value: string | ((url: string | string[]) => string));
  39283. /**
  39284. * Gets or sets a global variable indicating if fallback texture must be used when a texture cannot be loaded
  39285. * @ignorenaming
  39286. */
  39287. static get UseFallbackTexture(): boolean;
  39288. static set UseFallbackTexture(value: boolean);
  39289. /**
  39290. * Use this object to register external classes like custom textures or material
  39291. * to allow the laoders to instantiate them
  39292. */
  39293. static get RegisteredExternalClasses(): {
  39294. [key: string]: Object;
  39295. };
  39296. static set RegisteredExternalClasses(classes: {
  39297. [key: string]: Object;
  39298. });
  39299. /**
  39300. * Texture content used if a texture cannot loaded
  39301. * @ignorenaming
  39302. */
  39303. static get fallbackTexture(): string;
  39304. static set fallbackTexture(value: string);
  39305. /**
  39306. * Read the content of a byte array at a specified coordinates (taking in account wrapping)
  39307. * @param u defines the coordinate on X axis
  39308. * @param v defines the coordinate on Y axis
  39309. * @param width defines the width of the source data
  39310. * @param height defines the height of the source data
  39311. * @param pixels defines the source byte array
  39312. * @param color defines the output color
  39313. */
  39314. static FetchToRef(u: number, v: number, width: number, height: number, pixels: Uint8Array, color: IColor4Like): void;
  39315. /**
  39316. * Interpolates between a and b via alpha
  39317. * @param a The lower value (returned when alpha = 0)
  39318. * @param b The upper value (returned when alpha = 1)
  39319. * @param alpha The interpolation-factor
  39320. * @return The mixed value
  39321. */
  39322. static Mix(a: number, b: number, alpha: number): number;
  39323. /**
  39324. * Tries to instantiate a new object from a given class name
  39325. * @param className defines the class name to instantiate
  39326. * @returns the new object or null if the system was not able to do the instantiation
  39327. */
  39328. static Instantiate(className: string): any;
  39329. /**
  39330. * Provides a slice function that will work even on IE
  39331. * @param data defines the array to slice
  39332. * @param start defines the start of the data (optional)
  39333. * @param end defines the end of the data (optional)
  39334. * @returns the new sliced array
  39335. */
  39336. static Slice<T>(data: T, start?: number, end?: number): T;
  39337. /**
  39338. * Polyfill for setImmediate
  39339. * @param action defines the action to execute after the current execution block
  39340. */
  39341. static SetImmediate(action: () => void): void;
  39342. /**
  39343. * Function indicating if a number is an exponent of 2
  39344. * @param value defines the value to test
  39345. * @returns true if the value is an exponent of 2
  39346. */
  39347. static IsExponentOfTwo(value: number): boolean;
  39348. private static _tmpFloatArray;
  39349. /**
  39350. * Returns the nearest 32-bit single precision float representation of a Number
  39351. * @param value A Number. If the parameter is of a different type, it will get converted
  39352. * to a number or to NaN if it cannot be converted
  39353. * @returns number
  39354. */
  39355. static FloatRound(value: number): number;
  39356. /**
  39357. * Extracts the filename from a path
  39358. * @param path defines the path to use
  39359. * @returns the filename
  39360. */
  39361. static GetFilename(path: string): string;
  39362. /**
  39363. * Extracts the "folder" part of a path (everything before the filename).
  39364. * @param uri The URI to extract the info from
  39365. * @param returnUnchangedIfNoSlash Do not touch the URI if no slashes are present
  39366. * @returns The "folder" part of the path
  39367. */
  39368. static GetFolderPath(uri: string, returnUnchangedIfNoSlash?: boolean): string;
  39369. /**
  39370. * Extracts text content from a DOM element hierarchy
  39371. * Back Compat only, please use DomManagement.GetDOMTextContent instead.
  39372. */
  39373. static GetDOMTextContent: typeof DomManagement.GetDOMTextContent;
  39374. /**
  39375. * Convert an angle in radians to degrees
  39376. * @param angle defines the angle to convert
  39377. * @returns the angle in degrees
  39378. */
  39379. static ToDegrees(angle: number): number;
  39380. /**
  39381. * Convert an angle in degrees to radians
  39382. * @param angle defines the angle to convert
  39383. * @returns the angle in radians
  39384. */
  39385. static ToRadians(angle: number): number;
  39386. /**
  39387. * Returns an array if obj is not an array
  39388. * @param obj defines the object to evaluate as an array
  39389. * @param allowsNullUndefined defines a boolean indicating if obj is allowed to be null or undefined
  39390. * @returns either obj directly if obj is an array or a new array containing obj
  39391. */
  39392. static MakeArray(obj: any, allowsNullUndefined?: boolean): Nullable<Array<any>>;
  39393. /**
  39394. * Gets the pointer prefix to use
  39395. * @param engine defines the engine we are finding the prefix for
  39396. * @returns "pointer" if touch is enabled. Else returns "mouse"
  39397. */
  39398. static GetPointerPrefix(engine: Engine): string;
  39399. /**
  39400. * Sets the cors behavior on a dom element. This will add the required Tools.CorsBehavior to the element.
  39401. * @param url define the url we are trying
  39402. * @param element define the dom element where to configure the cors policy
  39403. */
  39404. static SetCorsBehavior(url: string | string[], element: {
  39405. crossOrigin: string | null;
  39406. }): void;
  39407. /**
  39408. * Removes unwanted characters from an url
  39409. * @param url defines the url to clean
  39410. * @returns the cleaned url
  39411. */
  39412. static CleanUrl(url: string): string;
  39413. /**
  39414. * Gets or sets a function used to pre-process url before using them to load assets
  39415. */
  39416. static get PreprocessUrl(): (url: string) => string;
  39417. static set PreprocessUrl(processor: (url: string) => string);
  39418. /**
  39419. * Loads an image as an HTMLImageElement.
  39420. * @param input url string, ArrayBuffer, or Blob to load
  39421. * @param onLoad callback called when the image successfully loads
  39422. * @param onError callback called when the image fails to load
  39423. * @param offlineProvider offline provider for caching
  39424. * @param mimeType optional mime type
  39425. * @returns the HTMLImageElement of the loaded image
  39426. */
  39427. static LoadImage(input: string | ArrayBuffer | Blob, onLoad: (img: HTMLImageElement | ImageBitmap) => void, onError: (message?: string, exception?: any) => void, offlineProvider: Nullable<IOfflineProvider>, mimeType?: string): Nullable<HTMLImageElement>;
  39428. /**
  39429. * Loads a file from a url
  39430. * @param url url string, ArrayBuffer, or Blob to load
  39431. * @param onSuccess callback called when the file successfully loads
  39432. * @param onProgress callback called while file is loading (if the server supports this mode)
  39433. * @param offlineProvider defines the offline provider for caching
  39434. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  39435. * @param onError callback called when the file fails to load
  39436. * @returns a file request object
  39437. */
  39438. 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;
  39439. /**
  39440. * Loads a file from a url
  39441. * @param url the file url to load
  39442. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  39443. * @returns a promise containing an ArrayBuffer corresponding to the loaded file
  39444. */
  39445. static LoadFileAsync(url: string, useArrayBuffer?: boolean): Promise<ArrayBuffer | string>;
  39446. /**
  39447. * Load a script (identified by an url). When the url returns, the
  39448. * content of this file is added into a new script element, attached to the DOM (body element)
  39449. * @param scriptUrl defines the url of the script to laod
  39450. * @param onSuccess defines the callback called when the script is loaded
  39451. * @param onError defines the callback to call if an error occurs
  39452. * @param scriptId defines the id of the script element
  39453. */
  39454. static LoadScript(scriptUrl: string, onSuccess: () => void, onError?: (message?: string, exception?: any) => void, scriptId?: string): void;
  39455. /**
  39456. * Load an asynchronous script (identified by an url). When the url returns, the
  39457. * content of this file is added into a new script element, attached to the DOM (body element)
  39458. * @param scriptUrl defines the url of the script to laod
  39459. * @param scriptId defines the id of the script element
  39460. * @returns a promise request object
  39461. */
  39462. static LoadScriptAsync(scriptUrl: string, scriptId?: string): Promise<void>;
  39463. /**
  39464. * Loads a file from a blob
  39465. * @param fileToLoad defines the blob to use
  39466. * @param callback defines the callback to call when data is loaded
  39467. * @param progressCallback defines the callback to call during loading process
  39468. * @returns a file request object
  39469. */
  39470. static ReadFileAsDataURL(fileToLoad: Blob, callback: (data: any) => void, progressCallback: (ev: ProgressEvent) => any): IFileRequest;
  39471. /**
  39472. * Reads a file from a File object
  39473. * @param file defines the file to load
  39474. * @param onSuccess defines the callback to call when data is loaded
  39475. * @param onProgress defines the callback to call during loading process
  39476. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  39477. * @param onError defines the callback to call when an error occurs
  39478. * @returns a file request object
  39479. */
  39480. static ReadFile(file: File, onSuccess: (data: any) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  39481. /**
  39482. * Creates a data url from a given string content
  39483. * @param content defines the content to convert
  39484. * @returns the new data url link
  39485. */
  39486. static FileAsURL(content: string): string;
  39487. /**
  39488. * Format the given number to a specific decimal format
  39489. * @param value defines the number to format
  39490. * @param decimals defines the number of decimals to use
  39491. * @returns the formatted string
  39492. */
  39493. static Format(value: number, decimals?: number): string;
  39494. /**
  39495. * Tries to copy an object by duplicating every property
  39496. * @param source defines the source object
  39497. * @param destination defines the target object
  39498. * @param doNotCopyList defines a list of properties to avoid
  39499. * @param mustCopyList defines a list of properties to copy (even if they start with _)
  39500. */
  39501. static DeepCopy(source: any, destination: any, doNotCopyList?: string[], mustCopyList?: string[]): void;
  39502. /**
  39503. * Gets a boolean indicating if the given object has no own property
  39504. * @param obj defines the object to test
  39505. * @returns true if object has no own property
  39506. */
  39507. static IsEmpty(obj: any): boolean;
  39508. /**
  39509. * Function used to register events at window level
  39510. * @param windowElement defines the Window object to use
  39511. * @param events defines the events to register
  39512. */
  39513. static RegisterTopRootEvents(windowElement: Window, events: {
  39514. name: string;
  39515. handler: Nullable<(e: FocusEvent) => any>;
  39516. }[]): void;
  39517. /**
  39518. * Function used to unregister events from window level
  39519. * @param windowElement defines the Window object to use
  39520. * @param events defines the events to unregister
  39521. */
  39522. static UnregisterTopRootEvents(windowElement: Window, events: {
  39523. name: string;
  39524. handler: Nullable<(e: FocusEvent) => any>;
  39525. }[]): void;
  39526. /**
  39527. * @ignore
  39528. */
  39529. static _ScreenshotCanvas: HTMLCanvasElement;
  39530. /**
  39531. * Dumps the current bound framebuffer
  39532. * @param width defines the rendering width
  39533. * @param height defines the rendering height
  39534. * @param engine defines the hosting engine
  39535. * @param successCallback defines the callback triggered once the data are available
  39536. * @param mimeType defines the mime type of the result
  39537. * @param fileName defines the filename to download. If present, the result will automatically be downloaded
  39538. */
  39539. static DumpFramebuffer(width: number, height: number, engine: Engine, successCallback?: (data: string) => void, mimeType?: string, fileName?: string): void;
  39540. /**
  39541. * Converts the canvas data to blob.
  39542. * This acts as a polyfill for browsers not supporting the to blob function.
  39543. * @param canvas Defines the canvas to extract the data from
  39544. * @param successCallback Defines the callback triggered once the data are available
  39545. * @param mimeType Defines the mime type of the result
  39546. */
  39547. static ToBlob(canvas: HTMLCanvasElement, successCallback: (blob: Nullable<Blob>) => void, mimeType?: string): void;
  39548. /**
  39549. * Encodes the canvas data to base 64 or automatically download the result if filename is defined
  39550. * @param successCallback defines the callback triggered once the data are available
  39551. * @param mimeType defines the mime type of the result
  39552. * @param fileName defines he filename to download. If present, the result will automatically be downloaded
  39553. */
  39554. static EncodeScreenshotCanvasData(successCallback?: (data: string) => void, mimeType?: string, fileName?: string): void;
  39555. /**
  39556. * Downloads a blob in the browser
  39557. * @param blob defines the blob to download
  39558. * @param fileName defines the name of the downloaded file
  39559. */
  39560. static Download(blob: Blob, fileName: string): void;
  39561. /**
  39562. * Captures a screenshot of the current rendering
  39563. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  39564. * @param engine defines the rendering engine
  39565. * @param camera defines the source camera
  39566. * @param size This parameter can be set to a single number or to an object with the
  39567. * following (optional) properties: precision, width, height. If a single number is passed,
  39568. * it will be used for both width and height. If an object is passed, the screenshot size
  39569. * will be derived from the parameters. The precision property is a multiplier allowing
  39570. * rendering at a higher or lower resolution
  39571. * @param successCallback defines the callback receives a single parameter which contains the
  39572. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  39573. * src parameter of an <img> to display it
  39574. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  39575. * Check your browser for supported MIME types
  39576. */
  39577. static CreateScreenshot(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string): void;
  39578. /**
  39579. * Captures a screenshot of the current rendering
  39580. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  39581. * @param engine defines the rendering engine
  39582. * @param camera defines the source camera
  39583. * @param size This parameter can be set to a single number or to an object with the
  39584. * following (optional) properties: precision, width, height. If a single number is passed,
  39585. * it will be used for both width and height. If an object is passed, the screenshot size
  39586. * will be derived from the parameters. The precision property is a multiplier allowing
  39587. * rendering at a higher or lower resolution
  39588. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  39589. * Check your browser for supported MIME types
  39590. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  39591. * to the src parameter of an <img> to display it
  39592. */
  39593. static CreateScreenshotAsync(engine: Engine, camera: Camera, size: IScreenshotSize | number, mimeType?: string): Promise<string>;
  39594. /**
  39595. * Generates an image screenshot from the specified camera.
  39596. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  39597. * @param engine The engine to use for rendering
  39598. * @param camera The camera to use for rendering
  39599. * @param size This parameter can be set to a single number or to an object with the
  39600. * following (optional) properties: precision, width, height. If a single number is passed,
  39601. * it will be used for both width and height. If an object is passed, the screenshot size
  39602. * will be derived from the parameters. The precision property is a multiplier allowing
  39603. * rendering at a higher or lower resolution
  39604. * @param successCallback The callback receives a single parameter which contains the
  39605. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  39606. * src parameter of an <img> to display it
  39607. * @param mimeType The MIME type of the screenshot image (default: image/png).
  39608. * Check your browser for supported MIME types
  39609. * @param samples Texture samples (default: 1)
  39610. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  39611. * @param fileName A name for for the downloaded file.
  39612. */
  39613. static CreateScreenshotUsingRenderTarget(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): void;
  39614. /**
  39615. * Generates an image screenshot from the specified camera.
  39616. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  39617. * @param engine The engine to use for rendering
  39618. * @param camera The camera to use for rendering
  39619. * @param size This parameter can be set to a single number or to an object with the
  39620. * following (optional) properties: precision, width, height. If a single number is passed,
  39621. * it will be used for both width and height. If an object is passed, the screenshot size
  39622. * will be derived from the parameters. The precision property is a multiplier allowing
  39623. * rendering at a higher or lower resolution
  39624. * @param mimeType The MIME type of the screenshot image (default: image/png).
  39625. * Check your browser for supported MIME types
  39626. * @param samples Texture samples (default: 1)
  39627. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  39628. * @param fileName A name for for the downloaded file.
  39629. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  39630. * to the src parameter of an <img> to display it
  39631. */
  39632. static CreateScreenshotUsingRenderTargetAsync(engine: Engine, camera: Camera, size: IScreenshotSize | number, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): Promise<string>;
  39633. /**
  39634. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  39635. * Be aware Math.random() could cause collisions, but:
  39636. * "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"
  39637. * @returns a pseudo random id
  39638. */
  39639. static RandomId(): string;
  39640. /**
  39641. * Test if the given uri is a base64 string
  39642. * @param uri The uri to test
  39643. * @return True if the uri is a base64 string or false otherwise
  39644. */
  39645. static IsBase64(uri: string): boolean;
  39646. /**
  39647. * Decode the given base64 uri.
  39648. * @param uri The uri to decode
  39649. * @return The decoded base64 data.
  39650. */
  39651. static DecodeBase64(uri: string): ArrayBuffer;
  39652. /**
  39653. * Gets the absolute url.
  39654. * @param url the input url
  39655. * @return the absolute url
  39656. */
  39657. static GetAbsoluteUrl(url: string): string;
  39658. /**
  39659. * No log
  39660. */
  39661. static readonly NoneLogLevel: number;
  39662. /**
  39663. * Only message logs
  39664. */
  39665. static readonly MessageLogLevel: number;
  39666. /**
  39667. * Only warning logs
  39668. */
  39669. static readonly WarningLogLevel: number;
  39670. /**
  39671. * Only error logs
  39672. */
  39673. static readonly ErrorLogLevel: number;
  39674. /**
  39675. * All logs
  39676. */
  39677. static readonly AllLogLevel: number;
  39678. /**
  39679. * Gets a value indicating the number of loading errors
  39680. * @ignorenaming
  39681. */
  39682. static get errorsCount(): number;
  39683. /**
  39684. * Callback called when a new log is added
  39685. */
  39686. static OnNewCacheEntry: (entry: string) => void;
  39687. /**
  39688. * Log a message to the console
  39689. * @param message defines the message to log
  39690. */
  39691. static Log(message: string): void;
  39692. /**
  39693. * Write a warning message to the console
  39694. * @param message defines the message to log
  39695. */
  39696. static Warn(message: string): void;
  39697. /**
  39698. * Write an error message to the console
  39699. * @param message defines the message to log
  39700. */
  39701. static Error(message: string): void;
  39702. /**
  39703. * Gets current log cache (list of logs)
  39704. */
  39705. static get LogCache(): string;
  39706. /**
  39707. * Clears the log cache
  39708. */
  39709. static ClearLogCache(): void;
  39710. /**
  39711. * Sets the current log level (MessageLogLevel / WarningLogLevel / ErrorLogLevel)
  39712. */
  39713. static set LogLevels(level: number);
  39714. /**
  39715. * Checks if the window object exists
  39716. * Back Compat only, please use DomManagement.IsWindowObjectExist instead.
  39717. */
  39718. static IsWindowObjectExist: typeof DomManagement.IsWindowObjectExist;
  39719. /**
  39720. * No performance log
  39721. */
  39722. static readonly PerformanceNoneLogLevel: number;
  39723. /**
  39724. * Use user marks to log performance
  39725. */
  39726. static readonly PerformanceUserMarkLogLevel: number;
  39727. /**
  39728. * Log performance to the console
  39729. */
  39730. static readonly PerformanceConsoleLogLevel: number;
  39731. private static _performance;
  39732. /**
  39733. * Sets the current performance log level
  39734. */
  39735. static set PerformanceLogLevel(level: number);
  39736. private static _StartPerformanceCounterDisabled;
  39737. private static _EndPerformanceCounterDisabled;
  39738. private static _StartUserMark;
  39739. private static _EndUserMark;
  39740. private static _StartPerformanceConsole;
  39741. private static _EndPerformanceConsole;
  39742. /**
  39743. * Starts a performance counter
  39744. */
  39745. static StartPerformanceCounter: (counterName: string, condition?: boolean) => void;
  39746. /**
  39747. * Ends a specific performance coutner
  39748. */
  39749. static EndPerformanceCounter: (counterName: string, condition?: boolean) => void;
  39750. /**
  39751. * Gets either window.performance.now() if supported or Date.now() else
  39752. */
  39753. static get Now(): number;
  39754. /**
  39755. * This method will return the name of the class used to create the instance of the given object.
  39756. * It will works only on Javascript basic data types (number, string, ...) and instance of class declared with the @className decorator.
  39757. * @param object the object to get the class name from
  39758. * @param isType defines if the object is actually a type
  39759. * @returns the name of the class, will be "object" for a custom data type not using the @className decorator
  39760. */
  39761. static GetClassName(object: any, isType?: boolean): string;
  39762. /**
  39763. * Gets the first element of an array satisfying a given predicate
  39764. * @param array defines the array to browse
  39765. * @param predicate defines the predicate to use
  39766. * @returns null if not found or the element
  39767. */
  39768. static First<T>(array: Array<T>, predicate: (item: T) => boolean): Nullable<T>;
  39769. /**
  39770. * This method will return the name of the full name of the class, including its owning module (if any).
  39771. * 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).
  39772. * @param object the object to get the class name from
  39773. * @param isType defines if the object is actually a type
  39774. * @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.
  39775. * @ignorenaming
  39776. */
  39777. static getFullClassName(object: any, isType?: boolean): Nullable<string>;
  39778. /**
  39779. * Returns a promise that resolves after the given amount of time.
  39780. * @param delay Number of milliseconds to delay
  39781. * @returns Promise that resolves after the given amount of time
  39782. */
  39783. static DelayAsync(delay: number): Promise<void>;
  39784. /**
  39785. * Utility function to detect if the current user agent is Safari
  39786. * @returns whether or not the current user agent is safari
  39787. */
  39788. static IsSafari(): boolean;
  39789. }
  39790. /**
  39791. * Use this className as a decorator on a given class definition to add it a name and optionally its module.
  39792. * You can then use the Tools.getClassName(obj) on an instance to retrieve its class name.
  39793. * This method is the only way to get it done in all cases, even if the .js file declaring the class is minified
  39794. * @param name The name of the class, case should be preserved
  39795. * @param module The name of the Module hosting the class, optional, but strongly recommended to specify if possible. Case should be preserved.
  39796. */
  39797. export function className(name: string, module?: string): (target: Object) => void;
  39798. /**
  39799. * An implementation of a loop for asynchronous functions.
  39800. */
  39801. export class AsyncLoop {
  39802. /**
  39803. * Defines the number of iterations for the loop
  39804. */
  39805. iterations: number;
  39806. /**
  39807. * Defines the current index of the loop.
  39808. */
  39809. index: number;
  39810. private _done;
  39811. private _fn;
  39812. private _successCallback;
  39813. /**
  39814. * Constructor.
  39815. * @param iterations the number of iterations.
  39816. * @param func the function to run each iteration
  39817. * @param successCallback the callback that will be called upon succesful execution
  39818. * @param offset starting offset.
  39819. */
  39820. constructor(
  39821. /**
  39822. * Defines the number of iterations for the loop
  39823. */
  39824. iterations: number, func: (asyncLoop: AsyncLoop) => void, successCallback: () => void, offset?: number);
  39825. /**
  39826. * Execute the next iteration. Must be called after the last iteration was finished.
  39827. */
  39828. executeNext(): void;
  39829. /**
  39830. * Break the loop and run the success callback.
  39831. */
  39832. breakLoop(): void;
  39833. /**
  39834. * Create and run an async loop.
  39835. * @param iterations the number of iterations.
  39836. * @param fn the function to run each iteration
  39837. * @param successCallback the callback that will be called upon succesful execution
  39838. * @param offset starting offset.
  39839. * @returns the created async loop object
  39840. */
  39841. static Run(iterations: number, fn: (asyncLoop: AsyncLoop) => void, successCallback: () => void, offset?: number): AsyncLoop;
  39842. /**
  39843. * A for-loop that will run a given number of iterations synchronous and the rest async.
  39844. * @param iterations total number of iterations
  39845. * @param syncedIterations number of synchronous iterations in each async iteration.
  39846. * @param fn the function to call each iteration.
  39847. * @param callback a success call back that will be called when iterating stops.
  39848. * @param breakFunction a break condition (optional)
  39849. * @param timeout timeout settings for the setTimeout function. default - 0.
  39850. * @returns the created async loop object
  39851. */
  39852. static SyncAsyncForLoop(iterations: number, syncedIterations: number, fn: (iteration: number) => void, callback: () => void, breakFunction?: () => boolean, timeout?: number): AsyncLoop;
  39853. }
  39854. }
  39855. declare module "babylonjs/Misc/stringDictionary" {
  39856. import { Nullable } from "babylonjs/types";
  39857. /**
  39858. * This class implement a typical dictionary using a string as key and the generic type T as value.
  39859. * The underlying implementation relies on an associative array to ensure the best performances.
  39860. * The value can be anything including 'null' but except 'undefined'
  39861. */
  39862. export class StringDictionary<T> {
  39863. /**
  39864. * This will clear this dictionary and copy the content from the 'source' one.
  39865. * If the T value is a custom object, it won't be copied/cloned, the same object will be used
  39866. * @param source the dictionary to take the content from and copy to this dictionary
  39867. */
  39868. copyFrom(source: StringDictionary<T>): void;
  39869. /**
  39870. * Get a value based from its key
  39871. * @param key the given key to get the matching value from
  39872. * @return the value if found, otherwise undefined is returned
  39873. */
  39874. get(key: string): T | undefined;
  39875. /**
  39876. * Get a value from its key or add it if it doesn't exist.
  39877. * This method will ensure you that a given key/data will be present in the dictionary.
  39878. * @param key the given key to get the matching value from
  39879. * @param factory the factory that will create the value if the key is not present in the dictionary.
  39880. * The factory will only be invoked if there's no data for the given key.
  39881. * @return the value corresponding to the key.
  39882. */
  39883. getOrAddWithFactory(key: string, factory: (key: string) => T): T;
  39884. /**
  39885. * Get a value from its key if present in the dictionary otherwise add it
  39886. * @param key the key to get the value from
  39887. * @param val if there's no such key/value pair in the dictionary add it with this value
  39888. * @return the value corresponding to the key
  39889. */
  39890. getOrAdd(key: string, val: T): T;
  39891. /**
  39892. * Check if there's a given key in the dictionary
  39893. * @param key the key to check for
  39894. * @return true if the key is present, false otherwise
  39895. */
  39896. contains(key: string): boolean;
  39897. /**
  39898. * Add a new key and its corresponding value
  39899. * @param key the key to add
  39900. * @param value the value corresponding to the key
  39901. * @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
  39902. */
  39903. add(key: string, value: T): boolean;
  39904. /**
  39905. * Update a specific value associated to a key
  39906. * @param key defines the key to use
  39907. * @param value defines the value to store
  39908. * @returns true if the value was updated (or false if the key was not found)
  39909. */
  39910. set(key: string, value: T): boolean;
  39911. /**
  39912. * Get the element of the given key and remove it from the dictionary
  39913. * @param key defines the key to search
  39914. * @returns the value associated with the key or null if not found
  39915. */
  39916. getAndRemove(key: string): Nullable<T>;
  39917. /**
  39918. * Remove a key/value from the dictionary.
  39919. * @param key the key to remove
  39920. * @return true if the item was successfully deleted, false if no item with such key exist in the dictionary
  39921. */
  39922. remove(key: string): boolean;
  39923. /**
  39924. * Clear the whole content of the dictionary
  39925. */
  39926. clear(): void;
  39927. /**
  39928. * Gets the current count
  39929. */
  39930. get count(): number;
  39931. /**
  39932. * Execute a callback on each key/val of the dictionary.
  39933. * Note that you can remove any element in this dictionary in the callback implementation
  39934. * @param callback the callback to execute on a given key/value pair
  39935. */
  39936. forEach(callback: (key: string, val: T) => void): void;
  39937. /**
  39938. * Execute a callback on every occurrence of the dictionary until it returns a valid TRes object.
  39939. * If the callback returns null or undefined the method will iterate to the next key/value pair
  39940. * Note that you can remove any element in this dictionary in the callback implementation
  39941. * @param callback the callback to execute, if it return a valid T instanced object the enumeration will stop and the object will be returned
  39942. * @returns the first item
  39943. */
  39944. first<TRes>(callback: (key: string, val: T) => TRes): TRes | null;
  39945. private _count;
  39946. private _data;
  39947. }
  39948. }
  39949. declare module "babylonjs/Collisions/collisionCoordinator" {
  39950. import { Nullable } from "babylonjs/types";
  39951. import { Scene } from "babylonjs/scene";
  39952. import { Vector3 } from "babylonjs/Maths/math.vector";
  39953. import { Collider } from "babylonjs/Collisions/collider";
  39954. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  39955. /** @hidden */
  39956. export interface ICollisionCoordinator {
  39957. createCollider(): Collider;
  39958. getNewPosition(position: Vector3, displacement: Vector3, collider: Collider, maximumRetry: number, excludedMesh: Nullable<AbstractMesh>, onNewPosition: (collisionIndex: number, newPosition: Vector3, collidedMesh: Nullable<AbstractMesh>) => void, collisionIndex: number): void;
  39959. init(scene: Scene): void;
  39960. }
  39961. /** @hidden */
  39962. export class DefaultCollisionCoordinator implements ICollisionCoordinator {
  39963. private _scene;
  39964. private _scaledPosition;
  39965. private _scaledVelocity;
  39966. private _finalPosition;
  39967. getNewPosition(position: Vector3, displacement: Vector3, collider: Collider, maximumRetry: number, excludedMesh: AbstractMesh, onNewPosition: (collisionIndex: number, newPosition: Vector3, collidedMesh: Nullable<AbstractMesh>) => void, collisionIndex: number): void;
  39968. createCollider(): Collider;
  39969. init(scene: Scene): void;
  39970. private _collideWithWorld;
  39971. }
  39972. }
  39973. declare module "babylonjs/Inputs/scene.inputManager" {
  39974. import { Nullable } from "babylonjs/types";
  39975. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  39976. import { Vector2 } from "babylonjs/Maths/math.vector";
  39977. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  39978. import { Scene } from "babylonjs/scene";
  39979. /**
  39980. * Class used to manage all inputs for the scene.
  39981. */
  39982. export class InputManager {
  39983. /** The distance in pixel that you have to move to prevent some events */
  39984. static DragMovementThreshold: number;
  39985. /** Time in milliseconds to wait to raise long press events if button is still pressed */
  39986. static LongPressDelay: number;
  39987. /** Time in milliseconds with two consecutive clicks will be considered as a double click */
  39988. static DoubleClickDelay: number;
  39989. /** If you need to check double click without raising a single click at first click, enable this flag */
  39990. static ExclusiveDoubleClickMode: boolean;
  39991. private _wheelEventName;
  39992. private _onPointerMove;
  39993. private _onPointerDown;
  39994. private _onPointerUp;
  39995. private _initClickEvent;
  39996. private _initActionManager;
  39997. private _delayedSimpleClick;
  39998. private _delayedSimpleClickTimeout;
  39999. private _previousDelayedSimpleClickTimeout;
  40000. private _meshPickProceed;
  40001. private _previousButtonPressed;
  40002. private _currentPickResult;
  40003. private _previousPickResult;
  40004. private _totalPointersPressed;
  40005. private _doubleClickOccured;
  40006. private _pointerOverMesh;
  40007. private _pickedDownMesh;
  40008. private _pickedUpMesh;
  40009. private _pointerX;
  40010. private _pointerY;
  40011. private _unTranslatedPointerX;
  40012. private _unTranslatedPointerY;
  40013. private _startingPointerPosition;
  40014. private _previousStartingPointerPosition;
  40015. private _startingPointerTime;
  40016. private _previousStartingPointerTime;
  40017. private _pointerCaptures;
  40018. private _onKeyDown;
  40019. private _onKeyUp;
  40020. private _onCanvasFocusObserver;
  40021. private _onCanvasBlurObserver;
  40022. private _scene;
  40023. /**
  40024. * Creates a new InputManager
  40025. * @param scene defines the hosting scene
  40026. */
  40027. constructor(scene: Scene);
  40028. /**
  40029. * Gets the mesh that is currently under the pointer
  40030. */
  40031. get meshUnderPointer(): Nullable<AbstractMesh>;
  40032. /**
  40033. * Gets the pointer coordinates in 2D without any translation (ie. straight out of the pointer event)
  40034. */
  40035. get unTranslatedPointer(): Vector2;
  40036. /**
  40037. * Gets or sets the current on-screen X position of the pointer
  40038. */
  40039. get pointerX(): number;
  40040. set pointerX(value: number);
  40041. /**
  40042. * Gets or sets the current on-screen Y position of the pointer
  40043. */
  40044. get pointerY(): number;
  40045. set pointerY(value: number);
  40046. private _updatePointerPosition;
  40047. private _processPointerMove;
  40048. private _setRayOnPointerInfo;
  40049. private _checkPrePointerObservable;
  40050. /**
  40051. * Use this method to simulate a pointer move on a mesh
  40052. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  40053. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  40054. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  40055. */
  40056. simulatePointerMove(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): void;
  40057. /**
  40058. * Use this method to simulate a pointer down on a mesh
  40059. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  40060. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  40061. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  40062. */
  40063. simulatePointerDown(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): void;
  40064. private _processPointerDown;
  40065. /** @hidden */
  40066. _isPointerSwiping(): boolean;
  40067. /**
  40068. * Use this method to simulate a pointer up on a mesh
  40069. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  40070. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  40071. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  40072. * @param doubleTap indicates that the pointer up event should be considered as part of a double click (false by default)
  40073. */
  40074. simulatePointerUp(pickResult: PickingInfo, pointerEventInit?: PointerEventInit, doubleTap?: boolean): void;
  40075. private _processPointerUp;
  40076. /**
  40077. * Gets a boolean indicating if the current pointer event is captured (meaning that the scene has already handled the pointer down)
  40078. * @param pointerId defines the pointer id to use in a multi-touch scenario (0 by default)
  40079. * @returns true if the pointer was captured
  40080. */
  40081. isPointerCaptured(pointerId?: number): boolean;
  40082. /**
  40083. * Attach events to the canvas (To handle actionManagers triggers and raise onPointerMove, onPointerDown and onPointerUp
  40084. * @param attachUp defines if you want to attach events to pointerup
  40085. * @param attachDown defines if you want to attach events to pointerdown
  40086. * @param attachMove defines if you want to attach events to pointermove
  40087. * @param elementToAttachTo defines the target DOM element to attach to (will use the canvas by default)
  40088. */
  40089. attachControl(attachUp?: boolean, attachDown?: boolean, attachMove?: boolean, elementToAttachTo?: Nullable<HTMLElement>): void;
  40090. /**
  40091. * Detaches all event handlers
  40092. */
  40093. detachControl(): void;
  40094. /**
  40095. * Force the value of meshUnderPointer
  40096. * @param mesh defines the mesh to use
  40097. */
  40098. setPointerOverMesh(mesh: Nullable<AbstractMesh>): void;
  40099. /**
  40100. * Gets the mesh under the pointer
  40101. * @returns a Mesh or null if no mesh is under the pointer
  40102. */
  40103. getPointerOverMesh(): Nullable<AbstractMesh>;
  40104. }
  40105. }
  40106. declare module "babylonjs/Animations/animationGroup" {
  40107. import { Animatable } from "babylonjs/Animations/animatable";
  40108. import { Animation } from "babylonjs/Animations/animation";
  40109. import { Scene, IDisposable } from "babylonjs/scene";
  40110. import { Observable } from "babylonjs/Misc/observable";
  40111. import { Nullable } from "babylonjs/types";
  40112. import "babylonjs/Animations/animatable";
  40113. /**
  40114. * This class defines the direct association between an animation and a target
  40115. */
  40116. export class TargetedAnimation {
  40117. /**
  40118. * Animation to perform
  40119. */
  40120. animation: Animation;
  40121. /**
  40122. * Target to animate
  40123. */
  40124. target: any;
  40125. /**
  40126. * Returns the string "TargetedAnimation"
  40127. * @returns "TargetedAnimation"
  40128. */
  40129. getClassName(): string;
  40130. /**
  40131. * Serialize the object
  40132. * @returns the JSON object representing the current entity
  40133. */
  40134. serialize(): any;
  40135. }
  40136. /**
  40137. * Use this class to create coordinated animations on multiple targets
  40138. */
  40139. export class AnimationGroup implements IDisposable {
  40140. /** The name of the animation group */
  40141. name: string;
  40142. private _scene;
  40143. private _targetedAnimations;
  40144. private _animatables;
  40145. private _from;
  40146. private _to;
  40147. private _isStarted;
  40148. private _isPaused;
  40149. private _speedRatio;
  40150. private _loopAnimation;
  40151. private _isAdditive;
  40152. /**
  40153. * Gets or sets the unique id of the node
  40154. */
  40155. uniqueId: number;
  40156. /**
  40157. * This observable will notify when one animation have ended
  40158. */
  40159. onAnimationEndObservable: Observable<TargetedAnimation>;
  40160. /**
  40161. * Observer raised when one animation loops
  40162. */
  40163. onAnimationLoopObservable: Observable<TargetedAnimation>;
  40164. /**
  40165. * Observer raised when all animations have looped
  40166. */
  40167. onAnimationGroupLoopObservable: Observable<AnimationGroup>;
  40168. /**
  40169. * This observable will notify when all animations have ended.
  40170. */
  40171. onAnimationGroupEndObservable: Observable<AnimationGroup>;
  40172. /**
  40173. * This observable will notify when all animations have paused.
  40174. */
  40175. onAnimationGroupPauseObservable: Observable<AnimationGroup>;
  40176. /**
  40177. * This observable will notify when all animations are playing.
  40178. */
  40179. onAnimationGroupPlayObservable: Observable<AnimationGroup>;
  40180. /**
  40181. * Gets the first frame
  40182. */
  40183. get from(): number;
  40184. /**
  40185. * Gets the last frame
  40186. */
  40187. get to(): number;
  40188. /**
  40189. * Define if the animations are started
  40190. */
  40191. get isStarted(): boolean;
  40192. /**
  40193. * Gets a value indicating that the current group is playing
  40194. */
  40195. get isPlaying(): boolean;
  40196. /**
  40197. * Gets or sets the speed ratio to use for all animations
  40198. */
  40199. get speedRatio(): number;
  40200. /**
  40201. * Gets or sets the speed ratio to use for all animations
  40202. */
  40203. set speedRatio(value: number);
  40204. /**
  40205. * Gets or sets if all animations should loop or not
  40206. */
  40207. get loopAnimation(): boolean;
  40208. set loopAnimation(value: boolean);
  40209. /**
  40210. * Gets or sets if all animations should be evaluated additively
  40211. */
  40212. get isAdditive(): boolean;
  40213. set isAdditive(value: boolean);
  40214. /**
  40215. * Gets the targeted animations for this animation group
  40216. */
  40217. get targetedAnimations(): Array<TargetedAnimation>;
  40218. /**
  40219. * returning the list of animatables controlled by this animation group.
  40220. */
  40221. get animatables(): Array<Animatable>;
  40222. /**
  40223. * Gets the list of target animations
  40224. */
  40225. get children(): TargetedAnimation[];
  40226. /**
  40227. * Instantiates a new Animation Group.
  40228. * This helps managing several animations at once.
  40229. * @see https://doc.babylonjs.com/how_to/group
  40230. * @param name Defines the name of the group
  40231. * @param scene Defines the scene the group belongs to
  40232. */
  40233. constructor(
  40234. /** The name of the animation group */
  40235. name: string, scene?: Nullable<Scene>);
  40236. /**
  40237. * Add an animation (with its target) in the group
  40238. * @param animation defines the animation we want to add
  40239. * @param target defines the target of the animation
  40240. * @returns the TargetedAnimation object
  40241. */
  40242. addTargetedAnimation(animation: Animation, target: any): TargetedAnimation;
  40243. /**
  40244. * This function will normalize every animation in the group to make sure they all go from beginFrame to endFrame
  40245. * It can add constant keys at begin or end
  40246. * @param beginFrame defines the new begin frame for all animations or the smallest begin frame of all animations if null (defaults to null)
  40247. * @param endFrame defines the new end frame for all animations or the largest end frame of all animations if null (defaults to null)
  40248. * @returns the animation group
  40249. */
  40250. normalize(beginFrame?: Nullable<number>, endFrame?: Nullable<number>): AnimationGroup;
  40251. private _animationLoopCount;
  40252. private _animationLoopFlags;
  40253. private _processLoop;
  40254. /**
  40255. * Start all animations on given targets
  40256. * @param loop defines if animations must loop
  40257. * @param speedRatio defines the ratio to apply to animation speed (1 by default)
  40258. * @param from defines the from key (optional)
  40259. * @param to defines the to key (optional)
  40260. * @param isAdditive defines the additive state for the resulting animatables (optional)
  40261. * @returns the current animation group
  40262. */
  40263. start(loop?: boolean, speedRatio?: number, from?: number, to?: number, isAdditive?: boolean): AnimationGroup;
  40264. /**
  40265. * Pause all animations
  40266. * @returns the animation group
  40267. */
  40268. pause(): AnimationGroup;
  40269. /**
  40270. * Play all animations to initial state
  40271. * This function will start() the animations if they were not started or will restart() them if they were paused
  40272. * @param loop defines if animations must loop
  40273. * @returns the animation group
  40274. */
  40275. play(loop?: boolean): AnimationGroup;
  40276. /**
  40277. * Reset all animations to initial state
  40278. * @returns the animation group
  40279. */
  40280. reset(): AnimationGroup;
  40281. /**
  40282. * Restart animations from key 0
  40283. * @returns the animation group
  40284. */
  40285. restart(): AnimationGroup;
  40286. /**
  40287. * Stop all animations
  40288. * @returns the animation group
  40289. */
  40290. stop(): AnimationGroup;
  40291. /**
  40292. * Set animation weight for all animatables
  40293. * @param weight defines the weight to use
  40294. * @return the animationGroup
  40295. * @see https://doc.babylonjs.com/babylon101/animations#animation-weights
  40296. */
  40297. setWeightForAllAnimatables(weight: number): AnimationGroup;
  40298. /**
  40299. * Synchronize and normalize all animatables with a source animatable
  40300. * @param root defines the root animatable to synchronize with
  40301. * @return the animationGroup
  40302. * @see https://doc.babylonjs.com/babylon101/animations#animation-weights
  40303. */
  40304. syncAllAnimationsWith(root: Animatable): AnimationGroup;
  40305. /**
  40306. * Goes to a specific frame in this animation group
  40307. * @param frame the frame number to go to
  40308. * @return the animationGroup
  40309. */
  40310. goToFrame(frame: number): AnimationGroup;
  40311. /**
  40312. * Dispose all associated resources
  40313. */
  40314. dispose(): void;
  40315. private _checkAnimationGroupEnded;
  40316. /**
  40317. * Clone the current animation group and returns a copy
  40318. * @param newName defines the name of the new group
  40319. * @param targetConverter defines an optional function used to convert current animation targets to new ones
  40320. * @returns the new aniamtion group
  40321. */
  40322. clone(newName: string, targetConverter?: (oldTarget: any) => any): AnimationGroup;
  40323. /**
  40324. * Serializes the animationGroup to an object
  40325. * @returns Serialized object
  40326. */
  40327. serialize(): any;
  40328. /**
  40329. * Returns a new AnimationGroup object parsed from the source provided.
  40330. * @param parsedAnimationGroup defines the source
  40331. * @param scene defines the scene that will receive the animationGroup
  40332. * @returns a new AnimationGroup
  40333. */
  40334. static Parse(parsedAnimationGroup: any, scene: Scene): AnimationGroup;
  40335. /**
  40336. * Convert the keyframes for all animations belonging to the group to be relative to a given reference frame.
  40337. * @param sourceAnimationGroup defines the AnimationGroup containing animations to convert
  40338. * @param referenceFrame defines the frame that keyframes in the range will be relative to
  40339. * @param range defines the name of the AnimationRange belonging to the animations in the group to convert
  40340. * @param cloneOriginal defines whether or not to clone the group and convert the clone or convert the original group (default is false)
  40341. * @param clonedName defines the name of the resulting cloned AnimationGroup if cloneOriginal is true
  40342. * @returns a new AnimationGroup if cloneOriginal is true or the original AnimationGroup if cloneOriginal is false
  40343. */
  40344. static MakeAnimationAdditive(sourceAnimationGroup: AnimationGroup, referenceFrame?: number, range?: string, cloneOriginal?: boolean, clonedName?: string): AnimationGroup;
  40345. /**
  40346. * Returns the string "AnimationGroup"
  40347. * @returns "AnimationGroup"
  40348. */
  40349. getClassName(): string;
  40350. /**
  40351. * Creates a detailled string about the object
  40352. * @param fullDetails defines if the output string will support multiple levels of logging within scene loading
  40353. * @returns a string representing the object
  40354. */
  40355. toString(fullDetails?: boolean): string;
  40356. }
  40357. }
  40358. declare module "babylonjs/scene" {
  40359. import { Nullable } from "babylonjs/types";
  40360. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  40361. import { Observable } from "babylonjs/Misc/observable";
  40362. import { SmartArrayNoDuplicate, SmartArray, ISmartArrayLike } from "babylonjs/Misc/smartArray";
  40363. import { Vector2, Vector3, Matrix } from "babylonjs/Maths/math.vector";
  40364. import { Geometry } from "babylonjs/Meshes/geometry";
  40365. import { TransformNode } from "babylonjs/Meshes/transformNode";
  40366. import { SubMesh } from "babylonjs/Meshes/subMesh";
  40367. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  40368. import { Mesh } from "babylonjs/Meshes/mesh";
  40369. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  40370. import { Bone } from "babylonjs/Bones/bone";
  40371. import { Skeleton } from "babylonjs/Bones/skeleton";
  40372. import { MorphTargetManager } from "babylonjs/Morph/morphTargetManager";
  40373. import { Camera } from "babylonjs/Cameras/camera";
  40374. import { AbstractScene } from "babylonjs/abstractScene";
  40375. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  40376. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  40377. import { Material } from "babylonjs/Materials/material";
  40378. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  40379. import { Effect } from "babylonjs/Materials/effect";
  40380. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  40381. import { MultiMaterial } from "babylonjs/Materials/multiMaterial";
  40382. import { Light } from "babylonjs/Lights/light";
  40383. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  40384. import { ICollisionCoordinator } from "babylonjs/Collisions/collisionCoordinator";
  40385. import { PointerEventTypes, PointerInfoPre, PointerInfo } from "babylonjs/Events/pointerEvents";
  40386. import { KeyboardInfoPre, KeyboardInfo } from "babylonjs/Events/keyboardEvents";
  40387. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  40388. import { PostProcessManager } from "babylonjs/PostProcesses/postProcessManager";
  40389. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  40390. import { RenderingGroupInfo, IRenderingManagerAutoClearSetup } from "babylonjs/Rendering/renderingManager";
  40391. import { ISceneComponent, ISceneSerializableComponent, Stage, SimpleStageAction, RenderTargetsStageAction, RenderTargetStageAction, MeshStageAction, EvaluateSubMeshStageAction, ActiveMeshStageAction, CameraStageAction, RenderingGroupStageAction, RenderingMeshStageAction, PointerMoveStageAction, PointerUpDownStageAction, CameraStageFrameBufferAction } from "babylonjs/sceneComponent";
  40392. import { Engine } from "babylonjs/Engines/engine";
  40393. import { Node } from "babylonjs/node";
  40394. import { MorphTarget } from "babylonjs/Morph/morphTarget";
  40395. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  40396. import { WebRequest } from "babylonjs/Misc/webRequest";
  40397. import { InputManager } from "babylonjs/Inputs/scene.inputManager";
  40398. import { PerfCounter } from "babylonjs/Misc/perfCounter";
  40399. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  40400. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  40401. import { Plane } from "babylonjs/Maths/math.plane";
  40402. import { LoadFileError, RequestFileError, ReadFileError } from "babylonjs/Misc/fileTools";
  40403. import { Ray } from "babylonjs/Culling/ray";
  40404. import { TrianglePickingPredicate } from "babylonjs/Culling/ray";
  40405. import { Animation } from "babylonjs/Animations/animation";
  40406. import { Animatable } from "babylonjs/Animations/animatable";
  40407. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  40408. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  40409. import { Collider } from "babylonjs/Collisions/collider";
  40410. /**
  40411. * Define an interface for all classes that will hold resources
  40412. */
  40413. export interface IDisposable {
  40414. /**
  40415. * Releases all held resources
  40416. */
  40417. dispose(): void;
  40418. }
  40419. /** Interface defining initialization parameters for Scene class */
  40420. export interface SceneOptions {
  40421. /**
  40422. * Defines that scene should keep up-to-date a map of geometry to enable fast look-up by uniqueId
  40423. * It will improve performance when the number of geometries becomes important.
  40424. */
  40425. useGeometryUniqueIdsMap?: boolean;
  40426. /**
  40427. * Defines that each material of the scene should keep up-to-date a map of referencing meshes for fast diposing
  40428. * It will improve performance when the number of mesh becomes important, but might consume a bit more memory
  40429. */
  40430. useMaterialMeshMap?: boolean;
  40431. /**
  40432. * Defines that each mesh of the scene should keep up-to-date a map of referencing cloned meshes for fast diposing
  40433. * It will improve performance when the number of mesh becomes important, but might consume a bit more memory
  40434. */
  40435. useClonedMeshMap?: boolean;
  40436. /** Defines if the creation of the scene should impact the engine (Eg. UtilityLayer's scene) */
  40437. virtual?: boolean;
  40438. }
  40439. /**
  40440. * Represents a scene to be rendered by the engine.
  40441. * @see https://doc.babylonjs.com/features/scene
  40442. */
  40443. export class Scene extends AbstractScene implements IAnimatable {
  40444. /** The fog is deactivated */
  40445. static readonly FOGMODE_NONE: number;
  40446. /** The fog density is following an exponential function */
  40447. static readonly FOGMODE_EXP: number;
  40448. /** The fog density is following an exponential function faster than FOGMODE_EXP */
  40449. static readonly FOGMODE_EXP2: number;
  40450. /** The fog density is following a linear function. */
  40451. static readonly FOGMODE_LINEAR: number;
  40452. /**
  40453. * Gets or sets the minimum deltatime when deterministic lock step is enabled
  40454. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  40455. */
  40456. static MinDeltaTime: number;
  40457. /**
  40458. * Gets or sets the maximum deltatime when deterministic lock step is enabled
  40459. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  40460. */
  40461. static MaxDeltaTime: number;
  40462. /**
  40463. * Factory used to create the default material.
  40464. * @param name The name of the material to create
  40465. * @param scene The scene to create the material for
  40466. * @returns The default material
  40467. */
  40468. static DefaultMaterialFactory(scene: Scene): Material;
  40469. /**
  40470. * Factory used to create the a collision coordinator.
  40471. * @returns The collision coordinator
  40472. */
  40473. static CollisionCoordinatorFactory(): ICollisionCoordinator;
  40474. /** @hidden */
  40475. _inputManager: InputManager;
  40476. /** Define this parameter if you are using multiple cameras and you want to specify which one should be used for pointer position */
  40477. cameraToUseForPointers: Nullable<Camera>;
  40478. /** @hidden */
  40479. readonly _isScene: boolean;
  40480. /** @hidden */
  40481. _blockEntityCollection: boolean;
  40482. /**
  40483. * Gets or sets a boolean that indicates if the scene must clear the render buffer before rendering a frame
  40484. */
  40485. autoClear: boolean;
  40486. /**
  40487. * Gets or sets a boolean that indicates if the scene must clear the depth and stencil buffers before rendering a frame
  40488. */
  40489. autoClearDepthAndStencil: boolean;
  40490. /**
  40491. * Defines the color used to clear the render buffer (Default is (0.2, 0.2, 0.3, 1.0))
  40492. */
  40493. clearColor: Color4;
  40494. /**
  40495. * Defines the color used to simulate the ambient color (Default is (0, 0, 0))
  40496. */
  40497. ambientColor: Color3;
  40498. /**
  40499. * This is use to store the default BRDF lookup for PBR materials in your scene.
  40500. * It should only be one of the following (if not the default embedded one):
  40501. * * For uncorrelated BRDF (pbr.brdf.useEnergyConservation = false and pbr.brdf.useSmithVisibilityHeightCorrelated = false) : https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds
  40502. * * For correlated BRDF (pbr.brdf.useEnergyConservation = false and pbr.brdf.useSmithVisibilityHeightCorrelated = true) : https://assets.babylonjs.com/environments/correlatedBRDF.dds
  40503. * * For correlated multi scattering BRDF (pbr.brdf.useEnergyConservation = true and pbr.brdf.useSmithVisibilityHeightCorrelated = true) : https://assets.babylonjs.com/environments/correlatedMSBRDF.dds
  40504. * The material properties need to be setup according to the type of texture in use.
  40505. */
  40506. environmentBRDFTexture: BaseTexture;
  40507. /** @hidden */
  40508. protected _environmentTexture: Nullable<BaseTexture>;
  40509. /**
  40510. * Texture used in all pbr material as the reflection texture.
  40511. * As in the majority of the scene they are the same (exception for multi room and so on),
  40512. * this is easier to reference from here than from all the materials.
  40513. */
  40514. get environmentTexture(): Nullable<BaseTexture>;
  40515. /**
  40516. * Texture used in all pbr material as the reflection texture.
  40517. * As in the majority of the scene they are the same (exception for multi room and so on),
  40518. * this is easier to set here than in all the materials.
  40519. */
  40520. set environmentTexture(value: Nullable<BaseTexture>);
  40521. /** @hidden */
  40522. protected _environmentIntensity: number;
  40523. /**
  40524. * Intensity of the environment in all pbr material.
  40525. * This dims or reinforces the IBL lighting overall (reflection and diffuse).
  40526. * As in the majority of the scene they are the same (exception for multi room and so on),
  40527. * this is easier to reference from here than from all the materials.
  40528. */
  40529. get environmentIntensity(): number;
  40530. /**
  40531. * Intensity of the environment in all pbr material.
  40532. * This dims or reinforces the IBL lighting overall (reflection and diffuse).
  40533. * As in the majority of the scene they are the same (exception for multi room and so on),
  40534. * this is easier to set here than in all the materials.
  40535. */
  40536. set environmentIntensity(value: number);
  40537. /** @hidden */
  40538. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  40539. /**
  40540. * Default image processing configuration used either in the rendering
  40541. * Forward main pass or through the imageProcessingPostProcess if present.
  40542. * As in the majority of the scene they are the same (exception for multi camera),
  40543. * this is easier to reference from here than from all the materials and post process.
  40544. *
  40545. * No setter as we it is a shared configuration, you can set the values instead.
  40546. */
  40547. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  40548. private _forceWireframe;
  40549. /**
  40550. * Gets or sets a boolean indicating if all rendering must be done in wireframe
  40551. */
  40552. set forceWireframe(value: boolean);
  40553. get forceWireframe(): boolean;
  40554. private _skipFrustumClipping;
  40555. /**
  40556. * Gets or sets a boolean indicating if we should skip the frustum clipping part of the active meshes selection
  40557. */
  40558. set skipFrustumClipping(value: boolean);
  40559. get skipFrustumClipping(): boolean;
  40560. private _forcePointsCloud;
  40561. /**
  40562. * Gets or sets a boolean indicating if all rendering must be done in point cloud
  40563. */
  40564. set forcePointsCloud(value: boolean);
  40565. get forcePointsCloud(): boolean;
  40566. /**
  40567. * Gets or sets the active clipplane 1
  40568. */
  40569. clipPlane: Nullable<Plane>;
  40570. /**
  40571. * Gets or sets the active clipplane 2
  40572. */
  40573. clipPlane2: Nullable<Plane>;
  40574. /**
  40575. * Gets or sets the active clipplane 3
  40576. */
  40577. clipPlane3: Nullable<Plane>;
  40578. /**
  40579. * Gets or sets the active clipplane 4
  40580. */
  40581. clipPlane4: Nullable<Plane>;
  40582. /**
  40583. * Gets or sets the active clipplane 5
  40584. */
  40585. clipPlane5: Nullable<Plane>;
  40586. /**
  40587. * Gets or sets the active clipplane 6
  40588. */
  40589. clipPlane6: Nullable<Plane>;
  40590. /**
  40591. * Gets or sets a boolean indicating if animations are enabled
  40592. */
  40593. animationsEnabled: boolean;
  40594. private _animationPropertiesOverride;
  40595. /**
  40596. * Gets or sets the animation properties override
  40597. */
  40598. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  40599. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  40600. /**
  40601. * Gets or sets a boolean indicating if a constant deltatime has to be used
  40602. * This is mostly useful for testing purposes when you do not want the animations to scale with the framerate
  40603. */
  40604. useConstantAnimationDeltaTime: boolean;
  40605. /**
  40606. * Gets or sets a boolean indicating if the scene must keep the meshUnderPointer property updated
  40607. * Please note that it requires to run a ray cast through the scene on every frame
  40608. */
  40609. constantlyUpdateMeshUnderPointer: boolean;
  40610. /**
  40611. * Defines the HTML cursor to use when hovering over interactive elements
  40612. */
  40613. hoverCursor: string;
  40614. /**
  40615. * Defines the HTML default cursor to use (empty by default)
  40616. */
  40617. defaultCursor: string;
  40618. /**
  40619. * Defines whether cursors are handled by the scene.
  40620. */
  40621. doNotHandleCursors: boolean;
  40622. /**
  40623. * This is used to call preventDefault() on pointer down
  40624. * in order to block unwanted artifacts like system double clicks
  40625. */
  40626. preventDefaultOnPointerDown: boolean;
  40627. /**
  40628. * This is used to call preventDefault() on pointer up
  40629. * in order to block unwanted artifacts like system double clicks
  40630. */
  40631. preventDefaultOnPointerUp: boolean;
  40632. /**
  40633. * Gets or sets user defined metadata
  40634. */
  40635. metadata: any;
  40636. /**
  40637. * For internal use only. Please do not use.
  40638. */
  40639. reservedDataStore: any;
  40640. /**
  40641. * Gets the name of the plugin used to load this scene (null by default)
  40642. */
  40643. loadingPluginName: string;
  40644. /**
  40645. * Use this array to add regular expressions used to disable offline support for specific urls
  40646. */
  40647. disableOfflineSupportExceptionRules: RegExp[];
  40648. /**
  40649. * An event triggered when the scene is disposed.
  40650. */
  40651. onDisposeObservable: Observable<Scene>;
  40652. private _onDisposeObserver;
  40653. /** Sets a function to be executed when this scene is disposed. */
  40654. set onDispose(callback: () => void);
  40655. /**
  40656. * An event triggered before rendering the scene (right after animations and physics)
  40657. */
  40658. onBeforeRenderObservable: Observable<Scene>;
  40659. private _onBeforeRenderObserver;
  40660. /** Sets a function to be executed before rendering this scene */
  40661. set beforeRender(callback: Nullable<() => void>);
  40662. /**
  40663. * An event triggered after rendering the scene
  40664. */
  40665. onAfterRenderObservable: Observable<Scene>;
  40666. /**
  40667. * An event triggered after rendering the scene for an active camera (When scene.render is called this will be called after each camera)
  40668. */
  40669. onAfterRenderCameraObservable: Observable<Camera>;
  40670. private _onAfterRenderObserver;
  40671. /** Sets a function to be executed after rendering this scene */
  40672. set afterRender(callback: Nullable<() => void>);
  40673. /**
  40674. * An event triggered before animating the scene
  40675. */
  40676. onBeforeAnimationsObservable: Observable<Scene>;
  40677. /**
  40678. * An event triggered after animations processing
  40679. */
  40680. onAfterAnimationsObservable: Observable<Scene>;
  40681. /**
  40682. * An event triggered before draw calls are ready to be sent
  40683. */
  40684. onBeforeDrawPhaseObservable: Observable<Scene>;
  40685. /**
  40686. * An event triggered after draw calls have been sent
  40687. */
  40688. onAfterDrawPhaseObservable: Observable<Scene>;
  40689. /**
  40690. * An event triggered when the scene is ready
  40691. */
  40692. onReadyObservable: Observable<Scene>;
  40693. /**
  40694. * An event triggered before rendering a camera
  40695. */
  40696. onBeforeCameraRenderObservable: Observable<Camera>;
  40697. private _onBeforeCameraRenderObserver;
  40698. /** Sets a function to be executed before rendering a camera*/
  40699. set beforeCameraRender(callback: () => void);
  40700. /**
  40701. * An event triggered after rendering a camera
  40702. */
  40703. onAfterCameraRenderObservable: Observable<Camera>;
  40704. private _onAfterCameraRenderObserver;
  40705. /** Sets a function to be executed after rendering a camera*/
  40706. set afterCameraRender(callback: () => void);
  40707. /**
  40708. * An event triggered when active meshes evaluation is about to start
  40709. */
  40710. onBeforeActiveMeshesEvaluationObservable: Observable<Scene>;
  40711. /**
  40712. * An event triggered when active meshes evaluation is done
  40713. */
  40714. onAfterActiveMeshesEvaluationObservable: Observable<Scene>;
  40715. /**
  40716. * An event triggered when particles rendering is about to start
  40717. * Note: This event can be trigger more than once per frame (because particles can be rendered by render target textures as well)
  40718. */
  40719. onBeforeParticlesRenderingObservable: Observable<Scene>;
  40720. /**
  40721. * An event triggered when particles rendering is done
  40722. * Note: This event can be trigger more than once per frame (because particles can be rendered by render target textures as well)
  40723. */
  40724. onAfterParticlesRenderingObservable: Observable<Scene>;
  40725. /**
  40726. * An event triggered when SceneLoader.Append or SceneLoader.Load or SceneLoader.ImportMesh were successfully executed
  40727. */
  40728. onDataLoadedObservable: Observable<Scene>;
  40729. /**
  40730. * An event triggered when a camera is created
  40731. */
  40732. onNewCameraAddedObservable: Observable<Camera>;
  40733. /**
  40734. * An event triggered when a camera is removed
  40735. */
  40736. onCameraRemovedObservable: Observable<Camera>;
  40737. /**
  40738. * An event triggered when a light is created
  40739. */
  40740. onNewLightAddedObservable: Observable<Light>;
  40741. /**
  40742. * An event triggered when a light is removed
  40743. */
  40744. onLightRemovedObservable: Observable<Light>;
  40745. /**
  40746. * An event triggered when a geometry is created
  40747. */
  40748. onNewGeometryAddedObservable: Observable<Geometry>;
  40749. /**
  40750. * An event triggered when a geometry is removed
  40751. */
  40752. onGeometryRemovedObservable: Observable<Geometry>;
  40753. /**
  40754. * An event triggered when a transform node is created
  40755. */
  40756. onNewTransformNodeAddedObservable: Observable<TransformNode>;
  40757. /**
  40758. * An event triggered when a transform node is removed
  40759. */
  40760. onTransformNodeRemovedObservable: Observable<TransformNode>;
  40761. /**
  40762. * An event triggered when a mesh is created
  40763. */
  40764. onNewMeshAddedObservable: Observable<AbstractMesh>;
  40765. /**
  40766. * An event triggered when a mesh is removed
  40767. */
  40768. onMeshRemovedObservable: Observable<AbstractMesh>;
  40769. /**
  40770. * An event triggered when a skeleton is created
  40771. */
  40772. onNewSkeletonAddedObservable: Observable<Skeleton>;
  40773. /**
  40774. * An event triggered when a skeleton is removed
  40775. */
  40776. onSkeletonRemovedObservable: Observable<Skeleton>;
  40777. /**
  40778. * An event triggered when a material is created
  40779. */
  40780. onNewMaterialAddedObservable: Observable<Material>;
  40781. /**
  40782. * An event triggered when a material is removed
  40783. */
  40784. onMaterialRemovedObservable: Observable<Material>;
  40785. /**
  40786. * An event triggered when a texture is created
  40787. */
  40788. onNewTextureAddedObservable: Observable<BaseTexture>;
  40789. /**
  40790. * An event triggered when a texture is removed
  40791. */
  40792. onTextureRemovedObservable: Observable<BaseTexture>;
  40793. /**
  40794. * An event triggered when render targets are about to be rendered
  40795. * Can happen multiple times per frame.
  40796. */
  40797. onBeforeRenderTargetsRenderObservable: Observable<Scene>;
  40798. /**
  40799. * An event triggered when render targets were rendered.
  40800. * Can happen multiple times per frame.
  40801. */
  40802. onAfterRenderTargetsRenderObservable: Observable<Scene>;
  40803. /**
  40804. * An event triggered before calculating deterministic simulation step
  40805. */
  40806. onBeforeStepObservable: Observable<Scene>;
  40807. /**
  40808. * An event triggered after calculating deterministic simulation step
  40809. */
  40810. onAfterStepObservable: Observable<Scene>;
  40811. /**
  40812. * An event triggered when the activeCamera property is updated
  40813. */
  40814. onActiveCameraChanged: Observable<Scene>;
  40815. /**
  40816. * This Observable will be triggered before rendering each renderingGroup of each rendered camera.
  40817. * The RenderinGroupInfo class contains all the information about the context in which the observable is called
  40818. * 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)
  40819. */
  40820. onBeforeRenderingGroupObservable: Observable<RenderingGroupInfo>;
  40821. /**
  40822. * This Observable will be triggered after rendering each renderingGroup of each rendered camera.
  40823. * The RenderinGroupInfo class contains all the information about the context in which the observable is called
  40824. * 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)
  40825. */
  40826. onAfterRenderingGroupObservable: Observable<RenderingGroupInfo>;
  40827. /**
  40828. * This Observable will when a mesh has been imported into the scene.
  40829. */
  40830. onMeshImportedObservable: Observable<AbstractMesh>;
  40831. /**
  40832. * This Observable will when an animation file has been imported into the scene.
  40833. */
  40834. onAnimationFileImportedObservable: Observable<Scene>;
  40835. /**
  40836. * Gets or sets a user defined funtion to select LOD from a mesh and a camera.
  40837. * By default this function is undefined and Babylon.js will select LOD based on distance to camera
  40838. */
  40839. customLODSelector: (mesh: AbstractMesh, camera: Camera) => Nullable<AbstractMesh>;
  40840. /** @hidden */
  40841. _registeredForLateAnimationBindings: SmartArrayNoDuplicate<any>;
  40842. /**
  40843. * Gets or sets a predicate used to select candidate meshes for a pointer down event
  40844. */
  40845. pointerDownPredicate: (Mesh: AbstractMesh) => boolean;
  40846. /**
  40847. * Gets or sets a predicate used to select candidate meshes for a pointer up event
  40848. */
  40849. pointerUpPredicate: (Mesh: AbstractMesh) => boolean;
  40850. /**
  40851. * Gets or sets a predicate used to select candidate meshes for a pointer move event
  40852. */
  40853. pointerMovePredicate: (Mesh: AbstractMesh) => boolean;
  40854. /** Callback called when a pointer move is detected */
  40855. onPointerMove: (evt: PointerEvent, pickInfo: PickingInfo, type: PointerEventTypes) => void;
  40856. /** Callback called when a pointer down is detected */
  40857. onPointerDown: (evt: PointerEvent, pickInfo: PickingInfo, type: PointerEventTypes) => void;
  40858. /** Callback called when a pointer up is detected */
  40859. onPointerUp: (evt: PointerEvent, pickInfo: Nullable<PickingInfo>, type: PointerEventTypes) => void;
  40860. /** Callback called when a pointer pick is detected */
  40861. onPointerPick: (evt: PointerEvent, pickInfo: PickingInfo) => void;
  40862. /**
  40863. * 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).
  40864. * You have the possibility to skip the process and the call to onPointerObservable by setting PointerInfoPre.skipOnPointerObservable to true
  40865. */
  40866. onPrePointerObservable: Observable<PointerInfoPre>;
  40867. /**
  40868. * Observable event triggered each time an input event is received from the rendering canvas
  40869. */
  40870. onPointerObservable: Observable<PointerInfo>;
  40871. /**
  40872. * Gets the pointer coordinates without any translation (ie. straight out of the pointer event)
  40873. */
  40874. get unTranslatedPointer(): Vector2;
  40875. /**
  40876. * Gets or sets the distance in pixel that you have to move to prevent some events. Default is 10 pixels
  40877. */
  40878. static get DragMovementThreshold(): number;
  40879. static set DragMovementThreshold(value: number);
  40880. /**
  40881. * Time in milliseconds to wait to raise long press events if button is still pressed. Default is 500 ms
  40882. */
  40883. static get LongPressDelay(): number;
  40884. static set LongPressDelay(value: number);
  40885. /**
  40886. * Time in milliseconds to wait to raise long press events if button is still pressed. Default is 300 ms
  40887. */
  40888. static get DoubleClickDelay(): number;
  40889. static set DoubleClickDelay(value: number);
  40890. /** If you need to check double click without raising a single click at first click, enable this flag */
  40891. static get ExclusiveDoubleClickMode(): boolean;
  40892. static set ExclusiveDoubleClickMode(value: boolean);
  40893. /** @hidden */
  40894. _mirroredCameraPosition: Nullable<Vector3>;
  40895. /**
  40896. * This observable event is triggered when any keyboard event si raised and registered during Scene.attachControl()
  40897. * You have the possibility to skip the process and the call to onKeyboardObservable by setting KeyboardInfoPre.skipOnPointerObservable to true
  40898. */
  40899. onPreKeyboardObservable: Observable<KeyboardInfoPre>;
  40900. /**
  40901. * Observable event triggered each time an keyboard event is received from the hosting window
  40902. */
  40903. onKeyboardObservable: Observable<KeyboardInfo>;
  40904. private _useRightHandedSystem;
  40905. /**
  40906. * Gets or sets a boolean indicating if the scene must use right-handed coordinates system
  40907. */
  40908. set useRightHandedSystem(value: boolean);
  40909. get useRightHandedSystem(): boolean;
  40910. private _timeAccumulator;
  40911. private _currentStepId;
  40912. private _currentInternalStep;
  40913. /**
  40914. * Sets the step Id used by deterministic lock step
  40915. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  40916. * @param newStepId defines the step Id
  40917. */
  40918. setStepId(newStepId: number): void;
  40919. /**
  40920. * Gets the step Id used by deterministic lock step
  40921. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  40922. * @returns the step Id
  40923. */
  40924. getStepId(): number;
  40925. /**
  40926. * Gets the internal step used by deterministic lock step
  40927. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  40928. * @returns the internal step
  40929. */
  40930. getInternalStep(): number;
  40931. private _fogEnabled;
  40932. /**
  40933. * Gets or sets a boolean indicating if fog is enabled on this scene
  40934. * @see https://doc.babylonjs.com/babylon101/environment#fog
  40935. * (Default is true)
  40936. */
  40937. set fogEnabled(value: boolean);
  40938. get fogEnabled(): boolean;
  40939. private _fogMode;
  40940. /**
  40941. * Gets or sets the fog mode to use
  40942. * @see https://doc.babylonjs.com/babylon101/environment#fog
  40943. * | mode | value |
  40944. * | --- | --- |
  40945. * | FOGMODE_NONE | 0 |
  40946. * | FOGMODE_EXP | 1 |
  40947. * | FOGMODE_EXP2 | 2 |
  40948. * | FOGMODE_LINEAR | 3 |
  40949. */
  40950. set fogMode(value: number);
  40951. get fogMode(): number;
  40952. /**
  40953. * Gets or sets the fog color to use
  40954. * @see https://doc.babylonjs.com/babylon101/environment#fog
  40955. * (Default is Color3(0.2, 0.2, 0.3))
  40956. */
  40957. fogColor: Color3;
  40958. /**
  40959. * Gets or sets the fog density to use
  40960. * @see https://doc.babylonjs.com/babylon101/environment#fog
  40961. * (Default is 0.1)
  40962. */
  40963. fogDensity: number;
  40964. /**
  40965. * Gets or sets the fog start distance to use
  40966. * @see https://doc.babylonjs.com/babylon101/environment#fog
  40967. * (Default is 0)
  40968. */
  40969. fogStart: number;
  40970. /**
  40971. * Gets or sets the fog end distance to use
  40972. * @see https://doc.babylonjs.com/babylon101/environment#fog
  40973. * (Default is 1000)
  40974. */
  40975. fogEnd: number;
  40976. /**
  40977. * Flag indicating that the frame buffer binding is handled by another component
  40978. */
  40979. prePass: boolean;
  40980. private _shadowsEnabled;
  40981. /**
  40982. * Gets or sets a boolean indicating if shadows are enabled on this scene
  40983. */
  40984. set shadowsEnabled(value: boolean);
  40985. get shadowsEnabled(): boolean;
  40986. private _lightsEnabled;
  40987. /**
  40988. * Gets or sets a boolean indicating if lights are enabled on this scene
  40989. */
  40990. set lightsEnabled(value: boolean);
  40991. get lightsEnabled(): boolean;
  40992. /** All of the active cameras added to this scene. */
  40993. activeCameras: Camera[];
  40994. /** @hidden */
  40995. _activeCamera: Nullable<Camera>;
  40996. /** Gets or sets the current active camera */
  40997. get activeCamera(): Nullable<Camera>;
  40998. set activeCamera(value: Nullable<Camera>);
  40999. private _defaultMaterial;
  41000. /** The default material used on meshes when no material is affected */
  41001. get defaultMaterial(): Material;
  41002. /** The default material used on meshes when no material is affected */
  41003. set defaultMaterial(value: Material);
  41004. private _texturesEnabled;
  41005. /**
  41006. * Gets or sets a boolean indicating if textures are enabled on this scene
  41007. */
  41008. set texturesEnabled(value: boolean);
  41009. get texturesEnabled(): boolean;
  41010. /**
  41011. * Gets or sets a boolean indicating if physic engines are enabled on this scene
  41012. */
  41013. physicsEnabled: boolean;
  41014. /**
  41015. * Gets or sets a boolean indicating if particles are enabled on this scene
  41016. */
  41017. particlesEnabled: boolean;
  41018. /**
  41019. * Gets or sets a boolean indicating if sprites are enabled on this scene
  41020. */
  41021. spritesEnabled: boolean;
  41022. private _skeletonsEnabled;
  41023. /**
  41024. * Gets or sets a boolean indicating if skeletons are enabled on this scene
  41025. */
  41026. set skeletonsEnabled(value: boolean);
  41027. get skeletonsEnabled(): boolean;
  41028. /**
  41029. * Gets or sets a boolean indicating if lens flares are enabled on this scene
  41030. */
  41031. lensFlaresEnabled: boolean;
  41032. /**
  41033. * Gets or sets a boolean indicating if collisions are enabled on this scene
  41034. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  41035. */
  41036. collisionsEnabled: boolean;
  41037. private _collisionCoordinator;
  41038. /** @hidden */
  41039. get collisionCoordinator(): ICollisionCoordinator;
  41040. /**
  41041. * Defines the gravity applied to this scene (used only for collisions)
  41042. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  41043. */
  41044. gravity: Vector3;
  41045. /**
  41046. * Gets or sets a boolean indicating if postprocesses are enabled on this scene
  41047. */
  41048. postProcessesEnabled: boolean;
  41049. /**
  41050. * The list of postprocesses added to the scene
  41051. */
  41052. postProcesses: PostProcess[];
  41053. /**
  41054. * Gets the current postprocess manager
  41055. */
  41056. postProcessManager: PostProcessManager;
  41057. /**
  41058. * Gets or sets a boolean indicating if render targets are enabled on this scene
  41059. */
  41060. renderTargetsEnabled: boolean;
  41061. /**
  41062. * Gets or sets a boolean indicating if next render targets must be dumped as image for debugging purposes
  41063. * We recommend not using it and instead rely on Spector.js: http://spector.babylonjs.com
  41064. */
  41065. dumpNextRenderTargets: boolean;
  41066. /**
  41067. * The list of user defined render targets added to the scene
  41068. */
  41069. customRenderTargets: RenderTargetTexture[];
  41070. /**
  41071. * Defines if texture loading must be delayed
  41072. * If true, textures will only be loaded when they need to be rendered
  41073. */
  41074. useDelayedTextureLoading: boolean;
  41075. /**
  41076. * Gets the list of meshes imported to the scene through SceneLoader
  41077. */
  41078. importedMeshesFiles: String[];
  41079. /**
  41080. * Gets or sets a boolean indicating if probes are enabled on this scene
  41081. */
  41082. probesEnabled: boolean;
  41083. /**
  41084. * Gets or sets the current offline provider to use to store scene data
  41085. * @see https://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  41086. */
  41087. offlineProvider: IOfflineProvider;
  41088. /**
  41089. * Gets or sets the action manager associated with the scene
  41090. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  41091. */
  41092. actionManager: AbstractActionManager;
  41093. private _meshesForIntersections;
  41094. /**
  41095. * Gets or sets a boolean indicating if procedural textures are enabled on this scene
  41096. */
  41097. proceduralTexturesEnabled: boolean;
  41098. private _engine;
  41099. private _totalVertices;
  41100. /** @hidden */
  41101. _activeIndices: PerfCounter;
  41102. /** @hidden */
  41103. _activeParticles: PerfCounter;
  41104. /** @hidden */
  41105. _activeBones: PerfCounter;
  41106. private _animationRatio;
  41107. /** @hidden */
  41108. _animationTimeLast: number;
  41109. /** @hidden */
  41110. _animationTime: number;
  41111. /**
  41112. * Gets or sets a general scale for animation speed
  41113. * @see https://www.babylonjs-playground.com/#IBU2W7#3
  41114. */
  41115. animationTimeScale: number;
  41116. /** @hidden */
  41117. _cachedMaterial: Nullable<Material>;
  41118. /** @hidden */
  41119. _cachedEffect: Nullable<Effect>;
  41120. /** @hidden */
  41121. _cachedVisibility: Nullable<number>;
  41122. private _renderId;
  41123. private _frameId;
  41124. private _executeWhenReadyTimeoutId;
  41125. private _intermediateRendering;
  41126. private _viewUpdateFlag;
  41127. private _projectionUpdateFlag;
  41128. /** @hidden */
  41129. _toBeDisposed: Nullable<IDisposable>[];
  41130. private _activeRequests;
  41131. /** @hidden */
  41132. _pendingData: any[];
  41133. private _isDisposed;
  41134. /**
  41135. * Gets or sets a boolean indicating that all submeshes of active meshes must be rendered
  41136. * Use this boolean to avoid computing frustum clipping on submeshes (This could help when you are CPU bound)
  41137. */
  41138. dispatchAllSubMeshesOfActiveMeshes: boolean;
  41139. private _activeMeshes;
  41140. private _processedMaterials;
  41141. private _renderTargets;
  41142. /** @hidden */
  41143. _activeParticleSystems: SmartArray<IParticleSystem>;
  41144. private _activeSkeletons;
  41145. private _softwareSkinnedMeshes;
  41146. private _renderingManager;
  41147. /** @hidden */
  41148. _activeAnimatables: import("babylonjs/Animations/animatable").Animatable[];
  41149. private _transformMatrix;
  41150. private _sceneUbo;
  41151. /** @hidden */
  41152. _viewMatrix: Matrix;
  41153. private _projectionMatrix;
  41154. /** @hidden */
  41155. _forcedViewPosition: Nullable<Vector3>;
  41156. /** @hidden */
  41157. _frustumPlanes: Plane[];
  41158. /**
  41159. * Gets the list of frustum planes (built from the active camera)
  41160. */
  41161. get frustumPlanes(): Plane[];
  41162. /**
  41163. * Gets or sets a boolean indicating if lights must be sorted by priority (off by default)
  41164. * This is useful if there are more lights that the maximum simulteanous authorized
  41165. */
  41166. requireLightSorting: boolean;
  41167. /** @hidden */
  41168. readonly useMaterialMeshMap: boolean;
  41169. /** @hidden */
  41170. readonly useClonedMeshMap: boolean;
  41171. private _externalData;
  41172. private _uid;
  41173. /**
  41174. * @hidden
  41175. * Backing store of defined scene components.
  41176. */
  41177. _components: ISceneComponent[];
  41178. /**
  41179. * @hidden
  41180. * Backing store of defined scene components.
  41181. */
  41182. _serializableComponents: ISceneSerializableComponent[];
  41183. /**
  41184. * List of components to register on the next registration step.
  41185. */
  41186. private _transientComponents;
  41187. /**
  41188. * Registers the transient components if needed.
  41189. */
  41190. private _registerTransientComponents;
  41191. /**
  41192. * @hidden
  41193. * Add a component to the scene.
  41194. * Note that the ccomponent could be registered on th next frame if this is called after
  41195. * the register component stage.
  41196. * @param component Defines the component to add to the scene
  41197. */
  41198. _addComponent(component: ISceneComponent): void;
  41199. /**
  41200. * @hidden
  41201. * Gets a component from the scene.
  41202. * @param name defines the name of the component to retrieve
  41203. * @returns the component or null if not present
  41204. */
  41205. _getComponent(name: string): Nullable<ISceneComponent>;
  41206. /**
  41207. * @hidden
  41208. * Defines the actions happening before camera updates.
  41209. */
  41210. _beforeCameraUpdateStage: Stage<SimpleStageAction>;
  41211. /**
  41212. * @hidden
  41213. * Defines the actions happening before clear the canvas.
  41214. */
  41215. _beforeClearStage: Stage<SimpleStageAction>;
  41216. /**
  41217. * @hidden
  41218. * Defines the actions when collecting render targets for the frame.
  41219. */
  41220. _gatherRenderTargetsStage: Stage<RenderTargetsStageAction>;
  41221. /**
  41222. * @hidden
  41223. * Defines the actions happening for one camera in the frame.
  41224. */
  41225. _gatherActiveCameraRenderTargetsStage: Stage<RenderTargetsStageAction>;
  41226. /**
  41227. * @hidden
  41228. * Defines the actions happening during the per mesh ready checks.
  41229. */
  41230. _isReadyForMeshStage: Stage<MeshStageAction>;
  41231. /**
  41232. * @hidden
  41233. * Defines the actions happening before evaluate active mesh checks.
  41234. */
  41235. _beforeEvaluateActiveMeshStage: Stage<SimpleStageAction>;
  41236. /**
  41237. * @hidden
  41238. * Defines the actions happening during the evaluate sub mesh checks.
  41239. */
  41240. _evaluateSubMeshStage: Stage<EvaluateSubMeshStageAction>;
  41241. /**
  41242. * @hidden
  41243. * Defines the actions happening during the active mesh stage.
  41244. */
  41245. _activeMeshStage: Stage<ActiveMeshStageAction>;
  41246. /**
  41247. * @hidden
  41248. * Defines the actions happening during the per camera render target step.
  41249. */
  41250. _cameraDrawRenderTargetStage: Stage<CameraStageFrameBufferAction>;
  41251. /**
  41252. * @hidden
  41253. * Defines the actions happening just before the active camera is drawing.
  41254. */
  41255. _beforeCameraDrawStage: Stage<CameraStageAction>;
  41256. /**
  41257. * @hidden
  41258. * Defines the actions happening just before a render target is drawing.
  41259. */
  41260. _beforeRenderTargetDrawStage: Stage<RenderTargetStageAction>;
  41261. /**
  41262. * @hidden
  41263. * Defines the actions happening just before a rendering group is drawing.
  41264. */
  41265. _beforeRenderingGroupDrawStage: Stage<RenderingGroupStageAction>;
  41266. /**
  41267. * @hidden
  41268. * Defines the actions happening just before a mesh is drawing.
  41269. */
  41270. _beforeRenderingMeshStage: Stage<RenderingMeshStageAction>;
  41271. /**
  41272. * @hidden
  41273. * Defines the actions happening just after a mesh has been drawn.
  41274. */
  41275. _afterRenderingMeshStage: Stage<RenderingMeshStageAction>;
  41276. /**
  41277. * @hidden
  41278. * Defines the actions happening just after a rendering group has been drawn.
  41279. */
  41280. _afterRenderingGroupDrawStage: Stage<RenderingGroupStageAction>;
  41281. /**
  41282. * @hidden
  41283. * Defines the actions happening just after the active camera has been drawn.
  41284. */
  41285. _afterCameraDrawStage: Stage<CameraStageAction>;
  41286. /**
  41287. * @hidden
  41288. * Defines the actions happening just after a render target has been drawn.
  41289. */
  41290. _afterRenderTargetDrawStage: Stage<RenderTargetStageAction>;
  41291. /**
  41292. * @hidden
  41293. * Defines the actions happening just after rendering all cameras and computing intersections.
  41294. */
  41295. _afterRenderStage: Stage<SimpleStageAction>;
  41296. /**
  41297. * @hidden
  41298. * Defines the actions happening when a pointer move event happens.
  41299. */
  41300. _pointerMoveStage: Stage<PointerMoveStageAction>;
  41301. /**
  41302. * @hidden
  41303. * Defines the actions happening when a pointer down event happens.
  41304. */
  41305. _pointerDownStage: Stage<PointerUpDownStageAction>;
  41306. /**
  41307. * @hidden
  41308. * Defines the actions happening when a pointer up event happens.
  41309. */
  41310. _pointerUpStage: Stage<PointerUpDownStageAction>;
  41311. /**
  41312. * an optional map from Geometry Id to Geometry index in the 'geometries' array
  41313. */
  41314. private geometriesByUniqueId;
  41315. /**
  41316. * Creates a new Scene
  41317. * @param engine defines the engine to use to render this scene
  41318. * @param options defines the scene options
  41319. */
  41320. constructor(engine: Engine, options?: SceneOptions);
  41321. /**
  41322. * Gets a string idenfifying the name of the class
  41323. * @returns "Scene" string
  41324. */
  41325. getClassName(): string;
  41326. private _defaultMeshCandidates;
  41327. /**
  41328. * @hidden
  41329. */
  41330. _getDefaultMeshCandidates(): ISmartArrayLike<AbstractMesh>;
  41331. private _defaultSubMeshCandidates;
  41332. /**
  41333. * @hidden
  41334. */
  41335. _getDefaultSubMeshCandidates(mesh: AbstractMesh): ISmartArrayLike<SubMesh>;
  41336. /**
  41337. * Sets the default candidate providers for the scene.
  41338. * This sets the getActiveMeshCandidates, getActiveSubMeshCandidates, getIntersectingSubMeshCandidates
  41339. * and getCollidingSubMeshCandidates to their default function
  41340. */
  41341. setDefaultCandidateProviders(): void;
  41342. /**
  41343. * Gets the mesh that is currently under the pointer
  41344. */
  41345. get meshUnderPointer(): Nullable<AbstractMesh>;
  41346. /**
  41347. * Gets or sets the current on-screen X position of the pointer
  41348. */
  41349. get pointerX(): number;
  41350. set pointerX(value: number);
  41351. /**
  41352. * Gets or sets the current on-screen Y position of the pointer
  41353. */
  41354. get pointerY(): number;
  41355. set pointerY(value: number);
  41356. /**
  41357. * Gets the cached material (ie. the latest rendered one)
  41358. * @returns the cached material
  41359. */
  41360. getCachedMaterial(): Nullable<Material>;
  41361. /**
  41362. * Gets the cached effect (ie. the latest rendered one)
  41363. * @returns the cached effect
  41364. */
  41365. getCachedEffect(): Nullable<Effect>;
  41366. /**
  41367. * Gets the cached visibility state (ie. the latest rendered one)
  41368. * @returns the cached visibility state
  41369. */
  41370. getCachedVisibility(): Nullable<number>;
  41371. /**
  41372. * Gets a boolean indicating if the current material / effect / visibility must be bind again
  41373. * @param material defines the current material
  41374. * @param effect defines the current effect
  41375. * @param visibility defines the current visibility state
  41376. * @returns true if one parameter is not cached
  41377. */
  41378. isCachedMaterialInvalid(material: Material, effect: Effect, visibility?: number): boolean;
  41379. /**
  41380. * Gets the engine associated with the scene
  41381. * @returns an Engine
  41382. */
  41383. getEngine(): Engine;
  41384. /**
  41385. * Gets the total number of vertices rendered per frame
  41386. * @returns the total number of vertices rendered per frame
  41387. */
  41388. getTotalVertices(): number;
  41389. /**
  41390. * Gets the performance counter for total vertices
  41391. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  41392. */
  41393. get totalVerticesPerfCounter(): PerfCounter;
  41394. /**
  41395. * Gets the total number of active indices rendered per frame (You can deduce the number of rendered triangles by dividing this number by 3)
  41396. * @returns the total number of active indices rendered per frame
  41397. */
  41398. getActiveIndices(): number;
  41399. /**
  41400. * Gets the performance counter for active indices
  41401. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  41402. */
  41403. get totalActiveIndicesPerfCounter(): PerfCounter;
  41404. /**
  41405. * Gets the total number of active particles rendered per frame
  41406. * @returns the total number of active particles rendered per frame
  41407. */
  41408. getActiveParticles(): number;
  41409. /**
  41410. * Gets the performance counter for active particles
  41411. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  41412. */
  41413. get activeParticlesPerfCounter(): PerfCounter;
  41414. /**
  41415. * Gets the total number of active bones rendered per frame
  41416. * @returns the total number of active bones rendered per frame
  41417. */
  41418. getActiveBones(): number;
  41419. /**
  41420. * Gets the performance counter for active bones
  41421. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  41422. */
  41423. get activeBonesPerfCounter(): PerfCounter;
  41424. /**
  41425. * Gets the array of active meshes
  41426. * @returns an array of AbstractMesh
  41427. */
  41428. getActiveMeshes(): SmartArray<AbstractMesh>;
  41429. /**
  41430. * Gets the animation ratio (which is 1.0 is the scene renders at 60fps and 2 if the scene renders at 30fps, etc.)
  41431. * @returns a number
  41432. */
  41433. getAnimationRatio(): number;
  41434. /**
  41435. * Gets an unique Id for the current render phase
  41436. * @returns a number
  41437. */
  41438. getRenderId(): number;
  41439. /**
  41440. * Gets an unique Id for the current frame
  41441. * @returns a number
  41442. */
  41443. getFrameId(): number;
  41444. /** Call this function if you want to manually increment the render Id*/
  41445. incrementRenderId(): void;
  41446. private _createUbo;
  41447. /**
  41448. * Use this method to simulate a pointer move on a mesh
  41449. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  41450. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  41451. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  41452. * @returns the current scene
  41453. */
  41454. simulatePointerMove(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): Scene;
  41455. /**
  41456. * Use this method to simulate a pointer down on a mesh
  41457. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  41458. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  41459. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  41460. * @returns the current scene
  41461. */
  41462. simulatePointerDown(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): Scene;
  41463. /**
  41464. * Use this method to simulate a pointer up on a mesh
  41465. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  41466. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  41467. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  41468. * @param doubleTap indicates that the pointer up event should be considered as part of a double click (false by default)
  41469. * @returns the current scene
  41470. */
  41471. simulatePointerUp(pickResult: PickingInfo, pointerEventInit?: PointerEventInit, doubleTap?: boolean): Scene;
  41472. /**
  41473. * Gets a boolean indicating if the current pointer event is captured (meaning that the scene has already handled the pointer down)
  41474. * @param pointerId defines the pointer id to use in a multi-touch scenario (0 by default)
  41475. * @returns true if the pointer was captured
  41476. */
  41477. isPointerCaptured(pointerId?: number): boolean;
  41478. /**
  41479. * Attach events to the canvas (To handle actionManagers triggers and raise onPointerMove, onPointerDown and onPointerUp
  41480. * @param attachUp defines if you want to attach events to pointerup
  41481. * @param attachDown defines if you want to attach events to pointerdown
  41482. * @param attachMove defines if you want to attach events to pointermove
  41483. */
  41484. attachControl(attachUp?: boolean, attachDown?: boolean, attachMove?: boolean): void;
  41485. /** Detaches all event handlers*/
  41486. detachControl(): void;
  41487. /**
  41488. * This function will check if the scene can be rendered (textures are loaded, shaders are compiled)
  41489. * Delay loaded resources are not taking in account
  41490. * @return true if all required resources are ready
  41491. */
  41492. isReady(): boolean;
  41493. /** Resets all cached information relative to material (including effect and visibility) */
  41494. resetCachedMaterial(): void;
  41495. /**
  41496. * Registers a function to be called before every frame render
  41497. * @param func defines the function to register
  41498. */
  41499. registerBeforeRender(func: () => void): void;
  41500. /**
  41501. * Unregisters a function called before every frame render
  41502. * @param func defines the function to unregister
  41503. */
  41504. unregisterBeforeRender(func: () => void): void;
  41505. /**
  41506. * Registers a function to be called after every frame render
  41507. * @param func defines the function to register
  41508. */
  41509. registerAfterRender(func: () => void): void;
  41510. /**
  41511. * Unregisters a function called after every frame render
  41512. * @param func defines the function to unregister
  41513. */
  41514. unregisterAfterRender(func: () => void): void;
  41515. private _executeOnceBeforeRender;
  41516. /**
  41517. * The provided function will run before render once and will be disposed afterwards.
  41518. * A timeout delay can be provided so that the function will be executed in N ms.
  41519. * The timeout is using the browser's native setTimeout so time percision cannot be guaranteed.
  41520. * @param func The function to be executed.
  41521. * @param timeout optional delay in ms
  41522. */
  41523. executeOnceBeforeRender(func: () => void, timeout?: number): void;
  41524. /** @hidden */
  41525. _addPendingData(data: any): void;
  41526. /** @hidden */
  41527. _removePendingData(data: any): void;
  41528. /**
  41529. * Returns the number of items waiting to be loaded
  41530. * @returns the number of items waiting to be loaded
  41531. */
  41532. getWaitingItemsCount(): number;
  41533. /**
  41534. * Returns a boolean indicating if the scene is still loading data
  41535. */
  41536. get isLoading(): boolean;
  41537. /**
  41538. * Registers a function to be executed when the scene is ready
  41539. * @param {Function} func - the function to be executed
  41540. */
  41541. executeWhenReady(func: () => void): void;
  41542. /**
  41543. * Returns a promise that resolves when the scene is ready
  41544. * @returns A promise that resolves when the scene is ready
  41545. */
  41546. whenReadyAsync(): Promise<void>;
  41547. /** @hidden */
  41548. _checkIsReady(): void;
  41549. /**
  41550. * Gets all animatable attached to the scene
  41551. */
  41552. get animatables(): Animatable[];
  41553. /**
  41554. * Resets the last animation time frame.
  41555. * Useful to override when animations start running when loading a scene for the first time.
  41556. */
  41557. resetLastAnimationTimeFrame(): void;
  41558. /**
  41559. * Gets the current view matrix
  41560. * @returns a Matrix
  41561. */
  41562. getViewMatrix(): Matrix;
  41563. /**
  41564. * Gets the current projection matrix
  41565. * @returns a Matrix
  41566. */
  41567. getProjectionMatrix(): Matrix;
  41568. /**
  41569. * Gets the current transform matrix
  41570. * @returns a Matrix made of View * Projection
  41571. */
  41572. getTransformMatrix(): Matrix;
  41573. /**
  41574. * Sets the current transform matrix
  41575. * @param viewL defines the View matrix to use
  41576. * @param projectionL defines the Projection matrix to use
  41577. * @param viewR defines the right View matrix to use (if provided)
  41578. * @param projectionR defines the right Projection matrix to use (if provided)
  41579. */
  41580. setTransformMatrix(viewL: Matrix, projectionL: Matrix, viewR?: Matrix, projectionR?: Matrix): void;
  41581. /**
  41582. * Gets the uniform buffer used to store scene data
  41583. * @returns a UniformBuffer
  41584. */
  41585. getSceneUniformBuffer(): UniformBuffer;
  41586. /**
  41587. * Gets an unique (relatively to the current scene) Id
  41588. * @returns an unique number for the scene
  41589. */
  41590. getUniqueId(): number;
  41591. /**
  41592. * Add a mesh to the list of scene's meshes
  41593. * @param newMesh defines the mesh to add
  41594. * @param recursive if all child meshes should also be added to the scene
  41595. */
  41596. addMesh(newMesh: AbstractMesh, recursive?: boolean): void;
  41597. /**
  41598. * Remove a mesh for the list of scene's meshes
  41599. * @param toRemove defines the mesh to remove
  41600. * @param recursive if all child meshes should also be removed from the scene
  41601. * @returns the index where the mesh was in the mesh list
  41602. */
  41603. removeMesh(toRemove: AbstractMesh, recursive?: boolean): number;
  41604. /**
  41605. * Add a transform node to the list of scene's transform nodes
  41606. * @param newTransformNode defines the transform node to add
  41607. */
  41608. addTransformNode(newTransformNode: TransformNode): void;
  41609. /**
  41610. * Remove a transform node for the list of scene's transform nodes
  41611. * @param toRemove defines the transform node to remove
  41612. * @returns the index where the transform node was in the transform node list
  41613. */
  41614. removeTransformNode(toRemove: TransformNode): number;
  41615. /**
  41616. * Remove a skeleton for the list of scene's skeletons
  41617. * @param toRemove defines the skeleton to remove
  41618. * @returns the index where the skeleton was in the skeleton list
  41619. */
  41620. removeSkeleton(toRemove: Skeleton): number;
  41621. /**
  41622. * Remove a morph target for the list of scene's morph targets
  41623. * @param toRemove defines the morph target to remove
  41624. * @returns the index where the morph target was in the morph target list
  41625. */
  41626. removeMorphTargetManager(toRemove: MorphTargetManager): number;
  41627. /**
  41628. * Remove a light for the list of scene's lights
  41629. * @param toRemove defines the light to remove
  41630. * @returns the index where the light was in the light list
  41631. */
  41632. removeLight(toRemove: Light): number;
  41633. /**
  41634. * Remove a camera for the list of scene's cameras
  41635. * @param toRemove defines the camera to remove
  41636. * @returns the index where the camera was in the camera list
  41637. */
  41638. removeCamera(toRemove: Camera): number;
  41639. /**
  41640. * Remove a particle system for the list of scene's particle systems
  41641. * @param toRemove defines the particle system to remove
  41642. * @returns the index where the particle system was in the particle system list
  41643. */
  41644. removeParticleSystem(toRemove: IParticleSystem): number;
  41645. /**
  41646. * Remove a animation for the list of scene's animations
  41647. * @param toRemove defines the animation to remove
  41648. * @returns the index where the animation was in the animation list
  41649. */
  41650. removeAnimation(toRemove: Animation): number;
  41651. /**
  41652. * Will stop the animation of the given target
  41653. * @param target - the target
  41654. * @param animationName - the name of the animation to stop (all animations will be stopped if both this and targetMask are empty)
  41655. * @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)
  41656. */
  41657. stopAnimation(target: any, animationName?: string, targetMask?: (target: any) => boolean): void;
  41658. /**
  41659. * Removes the given animation group from this scene.
  41660. * @param toRemove The animation group to remove
  41661. * @returns The index of the removed animation group
  41662. */
  41663. removeAnimationGroup(toRemove: AnimationGroup): number;
  41664. /**
  41665. * Removes the given multi-material from this scene.
  41666. * @param toRemove The multi-material to remove
  41667. * @returns The index of the removed multi-material
  41668. */
  41669. removeMultiMaterial(toRemove: MultiMaterial): number;
  41670. /**
  41671. * Removes the given material from this scene.
  41672. * @param toRemove The material to remove
  41673. * @returns The index of the removed material
  41674. */
  41675. removeMaterial(toRemove: Material): number;
  41676. /**
  41677. * Removes the given action manager from this scene.
  41678. * @param toRemove The action manager to remove
  41679. * @returns The index of the removed action manager
  41680. */
  41681. removeActionManager(toRemove: AbstractActionManager): number;
  41682. /**
  41683. * Removes the given texture from this scene.
  41684. * @param toRemove The texture to remove
  41685. * @returns The index of the removed texture
  41686. */
  41687. removeTexture(toRemove: BaseTexture): number;
  41688. /**
  41689. * Adds the given light to this scene
  41690. * @param newLight The light to add
  41691. */
  41692. addLight(newLight: Light): void;
  41693. /**
  41694. * Sorts the list list based on light priorities
  41695. */
  41696. sortLightsByPriority(): void;
  41697. /**
  41698. * Adds the given camera to this scene
  41699. * @param newCamera The camera to add
  41700. */
  41701. addCamera(newCamera: Camera): void;
  41702. /**
  41703. * Adds the given skeleton to this scene
  41704. * @param newSkeleton The skeleton to add
  41705. */
  41706. addSkeleton(newSkeleton: Skeleton): void;
  41707. /**
  41708. * Adds the given particle system to this scene
  41709. * @param newParticleSystem The particle system to add
  41710. */
  41711. addParticleSystem(newParticleSystem: IParticleSystem): void;
  41712. /**
  41713. * Adds the given animation to this scene
  41714. * @param newAnimation The animation to add
  41715. */
  41716. addAnimation(newAnimation: Animation): void;
  41717. /**
  41718. * Adds the given animation group to this scene.
  41719. * @param newAnimationGroup The animation group to add
  41720. */
  41721. addAnimationGroup(newAnimationGroup: AnimationGroup): void;
  41722. /**
  41723. * Adds the given multi-material to this scene
  41724. * @param newMultiMaterial The multi-material to add
  41725. */
  41726. addMultiMaterial(newMultiMaterial: MultiMaterial): void;
  41727. /**
  41728. * Adds the given material to this scene
  41729. * @param newMaterial The material to add
  41730. */
  41731. addMaterial(newMaterial: Material): void;
  41732. /**
  41733. * Adds the given morph target to this scene
  41734. * @param newMorphTargetManager The morph target to add
  41735. */
  41736. addMorphTargetManager(newMorphTargetManager: MorphTargetManager): void;
  41737. /**
  41738. * Adds the given geometry to this scene
  41739. * @param newGeometry The geometry to add
  41740. */
  41741. addGeometry(newGeometry: Geometry): void;
  41742. /**
  41743. * Adds the given action manager to this scene
  41744. * @param newActionManager The action manager to add
  41745. */
  41746. addActionManager(newActionManager: AbstractActionManager): void;
  41747. /**
  41748. * Adds the given texture to this scene.
  41749. * @param newTexture The texture to add
  41750. */
  41751. addTexture(newTexture: BaseTexture): void;
  41752. /**
  41753. * Switch active camera
  41754. * @param newCamera defines the new active camera
  41755. * @param attachControl defines if attachControl must be called for the new active camera (default: true)
  41756. */
  41757. switchActiveCamera(newCamera: Camera, attachControl?: boolean): void;
  41758. /**
  41759. * sets the active camera of the scene using its ID
  41760. * @param id defines the camera's ID
  41761. * @return the new active camera or null if none found.
  41762. */
  41763. setActiveCameraByID(id: string): Nullable<Camera>;
  41764. /**
  41765. * sets the active camera of the scene using its name
  41766. * @param name defines the camera's name
  41767. * @returns the new active camera or null if none found.
  41768. */
  41769. setActiveCameraByName(name: string): Nullable<Camera>;
  41770. /**
  41771. * get an animation group using its name
  41772. * @param name defines the material's name
  41773. * @return the animation group or null if none found.
  41774. */
  41775. getAnimationGroupByName(name: string): Nullable<AnimationGroup>;
  41776. /**
  41777. * Get a material using its unique id
  41778. * @param uniqueId defines the material's unique id
  41779. * @return the material or null if none found.
  41780. */
  41781. getMaterialByUniqueID(uniqueId: number): Nullable<Material>;
  41782. /**
  41783. * get a material using its id
  41784. * @param id defines the material's ID
  41785. * @return the material or null if none found.
  41786. */
  41787. getMaterialByID(id: string): Nullable<Material>;
  41788. /**
  41789. * Gets a the last added material using a given id
  41790. * @param id defines the material's ID
  41791. * @return the last material with the given id or null if none found.
  41792. */
  41793. getLastMaterialByID(id: string): Nullable<Material>;
  41794. /**
  41795. * Gets a material using its name
  41796. * @param name defines the material's name
  41797. * @return the material or null if none found.
  41798. */
  41799. getMaterialByName(name: string): Nullable<Material>;
  41800. /**
  41801. * Get a texture using its unique id
  41802. * @param uniqueId defines the texture's unique id
  41803. * @return the texture or null if none found.
  41804. */
  41805. getTextureByUniqueID(uniqueId: number): Nullable<BaseTexture>;
  41806. /**
  41807. * Gets a camera using its id
  41808. * @param id defines the id to look for
  41809. * @returns the camera or null if not found
  41810. */
  41811. getCameraByID(id: string): Nullable<Camera>;
  41812. /**
  41813. * Gets a camera using its unique id
  41814. * @param uniqueId defines the unique id to look for
  41815. * @returns the camera or null if not found
  41816. */
  41817. getCameraByUniqueID(uniqueId: number): Nullable<Camera>;
  41818. /**
  41819. * Gets a camera using its name
  41820. * @param name defines the camera's name
  41821. * @return the camera or null if none found.
  41822. */
  41823. getCameraByName(name: string): Nullable<Camera>;
  41824. /**
  41825. * Gets a bone using its id
  41826. * @param id defines the bone's id
  41827. * @return the bone or null if not found
  41828. */
  41829. getBoneByID(id: string): Nullable<Bone>;
  41830. /**
  41831. * Gets a bone using its id
  41832. * @param name defines the bone's name
  41833. * @return the bone or null if not found
  41834. */
  41835. getBoneByName(name: string): Nullable<Bone>;
  41836. /**
  41837. * Gets a light node using its name
  41838. * @param name defines the the light's name
  41839. * @return the light or null if none found.
  41840. */
  41841. getLightByName(name: string): Nullable<Light>;
  41842. /**
  41843. * Gets a light node using its id
  41844. * @param id defines the light's id
  41845. * @return the light or null if none found.
  41846. */
  41847. getLightByID(id: string): Nullable<Light>;
  41848. /**
  41849. * Gets a light node using its scene-generated unique ID
  41850. * @param uniqueId defines the light's unique id
  41851. * @return the light or null if none found.
  41852. */
  41853. getLightByUniqueID(uniqueId: number): Nullable<Light>;
  41854. /**
  41855. * Gets a particle system by id
  41856. * @param id defines the particle system id
  41857. * @return the corresponding system or null if none found
  41858. */
  41859. getParticleSystemByID(id: string): Nullable<IParticleSystem>;
  41860. /**
  41861. * Gets a geometry using its ID
  41862. * @param id defines the geometry's id
  41863. * @return the geometry or null if none found.
  41864. */
  41865. getGeometryByID(id: string): Nullable<Geometry>;
  41866. private _getGeometryByUniqueID;
  41867. /**
  41868. * Add a new geometry to this scene
  41869. * @param geometry defines the geometry to be added to the scene.
  41870. * @param force defines if the geometry must be pushed even if a geometry with this id already exists
  41871. * @return a boolean defining if the geometry was added or not
  41872. */
  41873. pushGeometry(geometry: Geometry, force?: boolean): boolean;
  41874. /**
  41875. * Removes an existing geometry
  41876. * @param geometry defines the geometry to be removed from the scene
  41877. * @return a boolean defining if the geometry was removed or not
  41878. */
  41879. removeGeometry(geometry: Geometry): boolean;
  41880. /**
  41881. * Gets the list of geometries attached to the scene
  41882. * @returns an array of Geometry
  41883. */
  41884. getGeometries(): Geometry[];
  41885. /**
  41886. * Gets the first added mesh found of a given ID
  41887. * @param id defines the id to search for
  41888. * @return the mesh found or null if not found at all
  41889. */
  41890. getMeshByID(id: string): Nullable<AbstractMesh>;
  41891. /**
  41892. * Gets a list of meshes using their id
  41893. * @param id defines the id to search for
  41894. * @returns a list of meshes
  41895. */
  41896. getMeshesByID(id: string): Array<AbstractMesh>;
  41897. /**
  41898. * Gets the first added transform node found of a given ID
  41899. * @param id defines the id to search for
  41900. * @return the found transform node or null if not found at all.
  41901. */
  41902. getTransformNodeByID(id: string): Nullable<TransformNode>;
  41903. /**
  41904. * Gets a transform node with its auto-generated unique id
  41905. * @param uniqueId efines the unique id to search for
  41906. * @return the found transform node or null if not found at all.
  41907. */
  41908. getTransformNodeByUniqueID(uniqueId: number): Nullable<TransformNode>;
  41909. /**
  41910. * Gets a list of transform nodes using their id
  41911. * @param id defines the id to search for
  41912. * @returns a list of transform nodes
  41913. */
  41914. getTransformNodesByID(id: string): Array<TransformNode>;
  41915. /**
  41916. * Gets a mesh with its auto-generated unique id
  41917. * @param uniqueId defines the unique id to search for
  41918. * @return the found mesh or null if not found at all.
  41919. */
  41920. getMeshByUniqueID(uniqueId: number): Nullable<AbstractMesh>;
  41921. /**
  41922. * Gets a the last added mesh using a given id
  41923. * @param id defines the id to search for
  41924. * @return the found mesh or null if not found at all.
  41925. */
  41926. getLastMeshByID(id: string): Nullable<AbstractMesh>;
  41927. /**
  41928. * Gets a the last added node (Mesh, Camera, Light) using a given id
  41929. * @param id defines the id to search for
  41930. * @return the found node or null if not found at all
  41931. */
  41932. getLastEntryByID(id: string): Nullable<Node>;
  41933. /**
  41934. * Gets a node (Mesh, Camera, Light) using a given id
  41935. * @param id defines the id to search for
  41936. * @return the found node or null if not found at all
  41937. */
  41938. getNodeByID(id: string): Nullable<Node>;
  41939. /**
  41940. * Gets a node (Mesh, Camera, Light) using a given name
  41941. * @param name defines the name to search for
  41942. * @return the found node or null if not found at all.
  41943. */
  41944. getNodeByName(name: string): Nullable<Node>;
  41945. /**
  41946. * Gets a mesh using a given name
  41947. * @param name defines the name to search for
  41948. * @return the found mesh or null if not found at all.
  41949. */
  41950. getMeshByName(name: string): Nullable<AbstractMesh>;
  41951. /**
  41952. * Gets a transform node using a given name
  41953. * @param name defines the name to search for
  41954. * @return the found transform node or null if not found at all.
  41955. */
  41956. getTransformNodeByName(name: string): Nullable<TransformNode>;
  41957. /**
  41958. * Gets a skeleton using a given id (if many are found, this function will pick the last one)
  41959. * @param id defines the id to search for
  41960. * @return the found skeleton or null if not found at all.
  41961. */
  41962. getLastSkeletonByID(id: string): Nullable<Skeleton>;
  41963. /**
  41964. * Gets a skeleton using a given auto generated unique id
  41965. * @param uniqueId defines the unique id to search for
  41966. * @return the found skeleton or null if not found at all.
  41967. */
  41968. getSkeletonByUniqueId(uniqueId: number): Nullable<Skeleton>;
  41969. /**
  41970. * Gets a skeleton using a given id (if many are found, this function will pick the first one)
  41971. * @param id defines the id to search for
  41972. * @return the found skeleton or null if not found at all.
  41973. */
  41974. getSkeletonById(id: string): Nullable<Skeleton>;
  41975. /**
  41976. * Gets a skeleton using a given name
  41977. * @param name defines the name to search for
  41978. * @return the found skeleton or null if not found at all.
  41979. */
  41980. getSkeletonByName(name: string): Nullable<Skeleton>;
  41981. /**
  41982. * Gets a morph target manager using a given id (if many are found, this function will pick the last one)
  41983. * @param id defines the id to search for
  41984. * @return the found morph target manager or null if not found at all.
  41985. */
  41986. getMorphTargetManagerById(id: number): Nullable<MorphTargetManager>;
  41987. /**
  41988. * Gets a morph target using a given id (if many are found, this function will pick the first one)
  41989. * @param id defines the id to search for
  41990. * @return the found morph target or null if not found at all.
  41991. */
  41992. getMorphTargetById(id: string): Nullable<MorphTarget>;
  41993. /**
  41994. * Gets a morph target using a given name (if many are found, this function will pick the first one)
  41995. * @param name defines the name to search for
  41996. * @return the found morph target or null if not found at all.
  41997. */
  41998. getMorphTargetByName(name: string): Nullable<MorphTarget>;
  41999. /**
  42000. * Gets a boolean indicating if the given mesh is active
  42001. * @param mesh defines the mesh to look for
  42002. * @returns true if the mesh is in the active list
  42003. */
  42004. isActiveMesh(mesh: AbstractMesh): boolean;
  42005. /**
  42006. * Return a unique id as a string which can serve as an identifier for the scene
  42007. */
  42008. get uid(): string;
  42009. /**
  42010. * Add an externaly attached data from its key.
  42011. * This method call will fail and return false, if such key already exists.
  42012. * If you don't care and just want to get the data no matter what, use the more convenient getOrAddExternalDataWithFactory() method.
  42013. * @param key the unique key that identifies the data
  42014. * @param data the data object to associate to the key for this Engine instance
  42015. * @return true if no such key were already present and the data was added successfully, false otherwise
  42016. */
  42017. addExternalData<T>(key: string, data: T): boolean;
  42018. /**
  42019. * Get an externaly attached data from its key
  42020. * @param key the unique key that identifies the data
  42021. * @return the associated data, if present (can be null), or undefined if not present
  42022. */
  42023. getExternalData<T>(key: string): Nullable<T>;
  42024. /**
  42025. * Get an externaly attached data from its key, create it using a factory if it's not already present
  42026. * @param key the unique key that identifies the data
  42027. * @param factory the factory that will be called to create the instance if and only if it doesn't exists
  42028. * @return the associated data, can be null if the factory returned null.
  42029. */
  42030. getOrAddExternalDataWithFactory<T>(key: string, factory: (k: string) => T): T;
  42031. /**
  42032. * Remove an externaly attached data from the Engine instance
  42033. * @param key the unique key that identifies the data
  42034. * @return true if the data was successfully removed, false if it doesn't exist
  42035. */
  42036. removeExternalData(key: string): boolean;
  42037. private _evaluateSubMesh;
  42038. /**
  42039. * Clear the processed materials smart array preventing retention point in material dispose.
  42040. */
  42041. freeProcessedMaterials(): void;
  42042. private _preventFreeActiveMeshesAndRenderingGroups;
  42043. /** Gets or sets a boolean blocking all the calls to freeActiveMeshes and freeRenderingGroups
  42044. * It can be used in order to prevent going through methods freeRenderingGroups and freeActiveMeshes several times to improve performance
  42045. * when disposing several meshes in a row or a hierarchy of meshes.
  42046. * When used, it is the responsability of the user to blockfreeActiveMeshesAndRenderingGroups back to false.
  42047. */
  42048. get blockfreeActiveMeshesAndRenderingGroups(): boolean;
  42049. set blockfreeActiveMeshesAndRenderingGroups(value: boolean);
  42050. /**
  42051. * Clear the active meshes smart array preventing retention point in mesh dispose.
  42052. */
  42053. freeActiveMeshes(): void;
  42054. /**
  42055. * Clear the info related to rendering groups preventing retention points during dispose.
  42056. */
  42057. freeRenderingGroups(): void;
  42058. /** @hidden */
  42059. _isInIntermediateRendering(): boolean;
  42060. /**
  42061. * Lambda returning the list of potentially active meshes.
  42062. */
  42063. getActiveMeshCandidates: () => ISmartArrayLike<AbstractMesh>;
  42064. /**
  42065. * Lambda returning the list of potentially active sub meshes.
  42066. */
  42067. getActiveSubMeshCandidates: (mesh: AbstractMesh) => ISmartArrayLike<SubMesh>;
  42068. /**
  42069. * Lambda returning the list of potentially intersecting sub meshes.
  42070. */
  42071. getIntersectingSubMeshCandidates: (mesh: AbstractMesh, localRay: Ray) => ISmartArrayLike<SubMesh>;
  42072. /**
  42073. * Lambda returning the list of potentially colliding sub meshes.
  42074. */
  42075. getCollidingSubMeshCandidates: (mesh: AbstractMesh, collider: Collider) => ISmartArrayLike<SubMesh>;
  42076. private _activeMeshesFrozen;
  42077. private _skipEvaluateActiveMeshesCompletely;
  42078. /**
  42079. * Use this function to stop evaluating active meshes. The current list will be keep alive between frames
  42080. * @param skipEvaluateActiveMeshes defines an optional boolean indicating that the evaluate active meshes step must be completely skipped
  42081. * @returns the current scene
  42082. */
  42083. freezeActiveMeshes(skipEvaluateActiveMeshes?: boolean): Scene;
  42084. /**
  42085. * Use this function to restart evaluating active meshes on every frame
  42086. * @returns the current scene
  42087. */
  42088. unfreezeActiveMeshes(): Scene;
  42089. private _evaluateActiveMeshes;
  42090. private _activeMesh;
  42091. /**
  42092. * Update the transform matrix to update from the current active camera
  42093. * @param force defines a boolean used to force the update even if cache is up to date
  42094. */
  42095. updateTransformMatrix(force?: boolean): void;
  42096. private _bindFrameBuffer;
  42097. /** @hidden */
  42098. _allowPostProcessClearColor: boolean;
  42099. /** @hidden */
  42100. _renderForCamera(camera: Camera, rigParent?: Camera): void;
  42101. private _processSubCameras;
  42102. private _checkIntersections;
  42103. /** @hidden */
  42104. _advancePhysicsEngineStep(step: number): void;
  42105. /**
  42106. * User updatable function that will return a deterministic frame time when engine is in deterministic lock step mode
  42107. */
  42108. getDeterministicFrameTime: () => number;
  42109. /** @hidden */
  42110. _animate(): void;
  42111. /** Execute all animations (for a frame) */
  42112. animate(): void;
  42113. /**
  42114. * Render the scene
  42115. * @param updateCameras defines a boolean indicating if cameras must update according to their inputs (true by default)
  42116. * @param ignoreAnimations defines a boolean indicating if animations should not be executed (false by default)
  42117. */
  42118. render(updateCameras?: boolean, ignoreAnimations?: boolean): void;
  42119. /**
  42120. * Freeze all materials
  42121. * A frozen material will not be updatable but should be faster to render
  42122. */
  42123. freezeMaterials(): void;
  42124. /**
  42125. * Unfreeze all materials
  42126. * A frozen material will not be updatable but should be faster to render
  42127. */
  42128. unfreezeMaterials(): void;
  42129. /**
  42130. * Releases all held ressources
  42131. */
  42132. dispose(): void;
  42133. /**
  42134. * Gets if the scene is already disposed
  42135. */
  42136. get isDisposed(): boolean;
  42137. /**
  42138. * Call this function to reduce memory footprint of the scene.
  42139. * Vertex buffers will not store CPU data anymore (this will prevent picking, collisions or physics to work correctly)
  42140. */
  42141. clearCachedVertexData(): void;
  42142. /**
  42143. * This function will remove the local cached buffer data from texture.
  42144. * It will save memory but will prevent the texture from being rebuilt
  42145. */
  42146. cleanCachedTextureBuffer(): void;
  42147. /**
  42148. * Get the world extend vectors with an optional filter
  42149. *
  42150. * @param filterPredicate the predicate - which meshes should be included when calculating the world size
  42151. * @returns {{ min: Vector3; max: Vector3 }} min and max vectors
  42152. */
  42153. getWorldExtends(filterPredicate?: (mesh: AbstractMesh) => boolean): {
  42154. min: Vector3;
  42155. max: Vector3;
  42156. };
  42157. /**
  42158. * Creates a ray that can be used to pick in the scene
  42159. * @param x defines the x coordinate of the origin (on-screen)
  42160. * @param y defines the y coordinate of the origin (on-screen)
  42161. * @param world defines the world matrix to use if you want to pick in object space (instead of world space)
  42162. * @param camera defines the camera to use for the picking
  42163. * @param cameraViewSpace defines if picking will be done in view space (false by default)
  42164. * @returns a Ray
  42165. */
  42166. createPickingRay(x: number, y: number, world: Matrix, camera: Nullable<Camera>, cameraViewSpace?: boolean): Ray;
  42167. /**
  42168. * Creates a ray that can be used to pick in the scene
  42169. * @param x defines the x coordinate of the origin (on-screen)
  42170. * @param y defines the y coordinate of the origin (on-screen)
  42171. * @param world defines the world matrix to use if you want to pick in object space (instead of world space)
  42172. * @param result defines the ray where to store the picking ray
  42173. * @param camera defines the camera to use for the picking
  42174. * @param cameraViewSpace defines if picking will be done in view space (false by default)
  42175. * @returns the current scene
  42176. */
  42177. createPickingRayToRef(x: number, y: number, world: Matrix, result: Ray, camera: Nullable<Camera>, cameraViewSpace?: boolean): Scene;
  42178. /**
  42179. * Creates a ray that can be used to pick in the scene
  42180. * @param x defines the x coordinate of the origin (on-screen)
  42181. * @param y defines the y coordinate of the origin (on-screen)
  42182. * @param camera defines the camera to use for the picking
  42183. * @returns a Ray
  42184. */
  42185. createPickingRayInCameraSpace(x: number, y: number, camera?: Camera): Ray;
  42186. /**
  42187. * Creates a ray that can be used to pick in the scene
  42188. * @param x defines the x coordinate of the origin (on-screen)
  42189. * @param y defines the y coordinate of the origin (on-screen)
  42190. * @param result defines the ray where to store the picking ray
  42191. * @param camera defines the camera to use for the picking
  42192. * @returns the current scene
  42193. */
  42194. createPickingRayInCameraSpaceToRef(x: number, y: number, result: Ray, camera?: Camera): Scene;
  42195. /** Launch a ray to try to pick a mesh in the scene
  42196. * @param x position on screen
  42197. * @param y position on screen
  42198. * @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
  42199. * @param fastCheck defines if the first intersection will be used (and not the closest)
  42200. * @param camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  42201. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  42202. * @returns a PickingInfo
  42203. */
  42204. pick(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, camera?: Nullable<Camera>, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  42205. /** Launch a ray to try to pick a mesh in the scene using only bounding information of the main mesh (not using submeshes)
  42206. * @param x position on screen
  42207. * @param y position on screen
  42208. * @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
  42209. * @param fastCheck defines if the first intersection will be used (and not the closest)
  42210. * @param camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  42211. * @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)
  42212. */
  42213. pickWithBoundingInfo(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, camera?: Nullable<Camera>): Nullable<PickingInfo>;
  42214. /** Use the given ray to pick a mesh in the scene
  42215. * @param ray The ray to use to pick meshes
  42216. * @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
  42217. * @param fastCheck defines if the first intersection will be used (and not the closest)
  42218. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  42219. * @returns a PickingInfo
  42220. */
  42221. pickWithRay(ray: Ray, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  42222. /**
  42223. * Launch a ray to try to pick a mesh in the scene
  42224. * @param x X position on screen
  42225. * @param y Y position on screen
  42226. * @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
  42227. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  42228. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  42229. * @returns an array of PickingInfo
  42230. */
  42231. multiPick(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, camera?: Camera, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  42232. /**
  42233. * Launch a ray to try to pick a mesh in the scene
  42234. * @param ray Ray to use
  42235. * @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
  42236. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  42237. * @returns an array of PickingInfo
  42238. */
  42239. multiPickWithRay(ray: Ray, predicate: (mesh: AbstractMesh) => boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  42240. /**
  42241. * Force the value of meshUnderPointer
  42242. * @param mesh defines the mesh to use
  42243. */
  42244. setPointerOverMesh(mesh: Nullable<AbstractMesh>): void;
  42245. /**
  42246. * Gets the mesh under the pointer
  42247. * @returns a Mesh or null if no mesh is under the pointer
  42248. */
  42249. getPointerOverMesh(): Nullable<AbstractMesh>;
  42250. /** @hidden */
  42251. _rebuildGeometries(): void;
  42252. /** @hidden */
  42253. _rebuildTextures(): void;
  42254. private _getByTags;
  42255. /**
  42256. * Get a list of meshes by tags
  42257. * @param tagsQuery defines the tags query to use
  42258. * @param forEach defines a predicate used to filter results
  42259. * @returns an array of Mesh
  42260. */
  42261. getMeshesByTags(tagsQuery: string, forEach?: (mesh: AbstractMesh) => void): Mesh[];
  42262. /**
  42263. * Get a list of cameras by tags
  42264. * @param tagsQuery defines the tags query to use
  42265. * @param forEach defines a predicate used to filter results
  42266. * @returns an array of Camera
  42267. */
  42268. getCamerasByTags(tagsQuery: string, forEach?: (camera: Camera) => void): Camera[];
  42269. /**
  42270. * Get a list of lights by tags
  42271. * @param tagsQuery defines the tags query to use
  42272. * @param forEach defines a predicate used to filter results
  42273. * @returns an array of Light
  42274. */
  42275. getLightsByTags(tagsQuery: string, forEach?: (light: Light) => void): Light[];
  42276. /**
  42277. * Get a list of materials by tags
  42278. * @param tagsQuery defines the tags query to use
  42279. * @param forEach defines a predicate used to filter results
  42280. * @returns an array of Material
  42281. */
  42282. getMaterialByTags(tagsQuery: string, forEach?: (material: Material) => void): Material[];
  42283. /**
  42284. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  42285. * This allowed control for front to back rendering or reversly depending of the special needs.
  42286. *
  42287. * @param renderingGroupId The rendering group id corresponding to its index
  42288. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  42289. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  42290. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  42291. */
  42292. 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;
  42293. /**
  42294. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  42295. *
  42296. * @param renderingGroupId The rendering group id corresponding to its index
  42297. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  42298. * @param depth Automatically clears depth between groups if true and autoClear is true.
  42299. * @param stencil Automatically clears stencil between groups if true and autoClear is true.
  42300. */
  42301. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean, depth?: boolean, stencil?: boolean): void;
  42302. /**
  42303. * Gets the current auto clear configuration for one rendering group of the rendering
  42304. * manager.
  42305. * @param index the rendering group index to get the information for
  42306. * @returns The auto clear setup for the requested rendering group
  42307. */
  42308. getAutoClearDepthStencilSetup(index: number): IRenderingManagerAutoClearSetup;
  42309. private _blockMaterialDirtyMechanism;
  42310. /** Gets or sets a boolean blocking all the calls to markAllMaterialsAsDirty (ie. the materials won't be updated if they are out of sync) */
  42311. get blockMaterialDirtyMechanism(): boolean;
  42312. set blockMaterialDirtyMechanism(value: boolean);
  42313. /**
  42314. * Will flag all materials as dirty to trigger new shader compilation
  42315. * @param flag defines the flag used to specify which material part must be marked as dirty
  42316. * @param predicate If not null, it will be used to specifiy if a material has to be marked as dirty
  42317. */
  42318. markAllMaterialsAsDirty(flag: number, predicate?: (mat: Material) => boolean): void;
  42319. /** @hidden */
  42320. _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;
  42321. /** @hidden */
  42322. _loadFileAsync(url: string, onProgress?: (data: any) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  42323. /** @hidden */
  42324. _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;
  42325. /** @hidden */
  42326. _requestFileAsync(url: string, onProgress?: (ev: ProgressEvent) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean, onOpened?: (request: WebRequest) => void): Promise<string | ArrayBuffer>;
  42327. /** @hidden */
  42328. _readFile(file: File, onSuccess: (data: string | ArrayBuffer) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  42329. /** @hidden */
  42330. _readFileAsync(file: File, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  42331. }
  42332. }
  42333. declare module "babylonjs/assetContainer" {
  42334. import { AbstractScene } from "babylonjs/abstractScene";
  42335. import { Scene } from "babylonjs/scene";
  42336. import { Mesh } from "babylonjs/Meshes/mesh";
  42337. import { TransformNode } from "babylonjs/Meshes/transformNode";
  42338. import { Skeleton } from "babylonjs/Bones/skeleton";
  42339. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  42340. import { Animatable } from "babylonjs/Animations/animatable";
  42341. import { Nullable } from "babylonjs/types";
  42342. import { Node } from "babylonjs/node";
  42343. /**
  42344. * Set of assets to keep when moving a scene into an asset container.
  42345. */
  42346. export class KeepAssets extends AbstractScene {
  42347. }
  42348. /**
  42349. * Class used to store the output of the AssetContainer.instantiateAllMeshesToScene function
  42350. */
  42351. export class InstantiatedEntries {
  42352. /**
  42353. * List of new root nodes (eg. nodes with no parent)
  42354. */
  42355. rootNodes: TransformNode[];
  42356. /**
  42357. * List of new skeletons
  42358. */
  42359. skeletons: Skeleton[];
  42360. /**
  42361. * List of new animation groups
  42362. */
  42363. animationGroups: AnimationGroup[];
  42364. }
  42365. /**
  42366. * Container with a set of assets that can be added or removed from a scene.
  42367. */
  42368. export class AssetContainer extends AbstractScene {
  42369. private _wasAddedToScene;
  42370. /**
  42371. * The scene the AssetContainer belongs to.
  42372. */
  42373. scene: Scene;
  42374. /**
  42375. * Instantiates an AssetContainer.
  42376. * @param scene The scene the AssetContainer belongs to.
  42377. */
  42378. constructor(scene: Scene);
  42379. /**
  42380. * Instantiate or clone all meshes and add the new ones to the scene.
  42381. * Skeletons and animation groups will all be cloned
  42382. * @param nameFunction defines an optional function used to get new names for clones
  42383. * @param cloneMaterials defines an optional boolean that defines if materials must be cloned as well (false by default)
  42384. * @returns a list of rootNodes, skeletons and aniamtion groups that were duplicated
  42385. */
  42386. instantiateModelsToScene(nameFunction?: (sourceName: string) => string, cloneMaterials?: boolean): InstantiatedEntries;
  42387. /**
  42388. * Adds all the assets from the container to the scene.
  42389. */
  42390. addAllToScene(): void;
  42391. /**
  42392. * Removes all the assets in the container from the scene
  42393. */
  42394. removeAllFromScene(): void;
  42395. /**
  42396. * Disposes all the assets in the container
  42397. */
  42398. dispose(): void;
  42399. private _moveAssets;
  42400. /**
  42401. * Removes all the assets contained in the scene and adds them to the container.
  42402. * @param keepAssets Set of assets to keep in the scene. (default: empty)
  42403. */
  42404. moveAllFromScene(keepAssets?: KeepAssets): void;
  42405. /**
  42406. * 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.
  42407. * @returns the root mesh
  42408. */
  42409. createRootMesh(): Mesh;
  42410. /**
  42411. * Merge animations (direct and animation groups) from this asset container into a scene
  42412. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  42413. * @param animatables set of animatables to retarget to a node from the scene
  42414. * @param targetConverter defines a function used to convert animation targets from the asset container to the scene (default: search node by name)
  42415. * @returns an array of the new AnimationGroup added to the scene (empty array if none)
  42416. */
  42417. mergeAnimationsTo(scene: Scene | null | undefined, animatables: Animatable[], targetConverter?: Nullable<(target: any) => Nullable<Node>>): AnimationGroup[];
  42418. }
  42419. }
  42420. declare module "babylonjs/abstractScene" {
  42421. import { Scene } from "babylonjs/scene";
  42422. import { Nullable } from "babylonjs/types";
  42423. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  42424. import { TransformNode } from "babylonjs/Meshes/transformNode";
  42425. import { Geometry } from "babylonjs/Meshes/geometry";
  42426. import { Skeleton } from "babylonjs/Bones/skeleton";
  42427. import { MorphTargetManager } from "babylonjs/Morph/morphTargetManager";
  42428. import { AssetContainer } from "babylonjs/assetContainer";
  42429. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  42430. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  42431. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  42432. import { Material } from "babylonjs/Materials/material";
  42433. import { MultiMaterial } from "babylonjs/Materials/multiMaterial";
  42434. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  42435. import { Camera } from "babylonjs/Cameras/camera";
  42436. import { Light } from "babylonjs/Lights/light";
  42437. import { Node } from "babylonjs/node";
  42438. import { Animation } from "babylonjs/Animations/animation";
  42439. /**
  42440. * Defines how the parser contract is defined.
  42441. * These parsers are used to parse a list of specific assets (like particle systems, etc..)
  42442. */
  42443. export type BabylonFileParser = (parsedData: any, scene: Scene, container: AssetContainer, rootUrl: string) => void;
  42444. /**
  42445. * Defines how the individual parser contract is defined.
  42446. * These parser can parse an individual asset
  42447. */
  42448. export type IndividualBabylonFileParser = (parsedData: any, scene: Scene, rootUrl: string) => any;
  42449. /**
  42450. * Base class of the scene acting as a container for the different elements composing a scene.
  42451. * This class is dynamically extended by the different components of the scene increasing
  42452. * flexibility and reducing coupling
  42453. */
  42454. export abstract class AbstractScene {
  42455. /**
  42456. * Stores the list of available parsers in the application.
  42457. */
  42458. private static _BabylonFileParsers;
  42459. /**
  42460. * Stores the list of available individual parsers in the application.
  42461. */
  42462. private static _IndividualBabylonFileParsers;
  42463. /**
  42464. * Adds a parser in the list of available ones
  42465. * @param name Defines the name of the parser
  42466. * @param parser Defines the parser to add
  42467. */
  42468. static AddParser(name: string, parser: BabylonFileParser): void;
  42469. /**
  42470. * Gets a general parser from the list of avaialble ones
  42471. * @param name Defines the name of the parser
  42472. * @returns the requested parser or null
  42473. */
  42474. static GetParser(name: string): Nullable<BabylonFileParser>;
  42475. /**
  42476. * Adds n individual parser in the list of available ones
  42477. * @param name Defines the name of the parser
  42478. * @param parser Defines the parser to add
  42479. */
  42480. static AddIndividualParser(name: string, parser: IndividualBabylonFileParser): void;
  42481. /**
  42482. * Gets an individual parser from the list of avaialble ones
  42483. * @param name Defines the name of the parser
  42484. * @returns the requested parser or null
  42485. */
  42486. static GetIndividualParser(name: string): Nullable<IndividualBabylonFileParser>;
  42487. /**
  42488. * Parser json data and populate both a scene and its associated container object
  42489. * @param jsonData Defines the data to parse
  42490. * @param scene Defines the scene to parse the data for
  42491. * @param container Defines the container attached to the parsing sequence
  42492. * @param rootUrl Defines the root url of the data
  42493. */
  42494. static Parse(jsonData: any, scene: Scene, container: AssetContainer, rootUrl: string): void;
  42495. /**
  42496. * Gets the list of root nodes (ie. nodes with no parent)
  42497. */
  42498. rootNodes: Node[];
  42499. /** All of the cameras added to this scene
  42500. * @see https://doc.babylonjs.com/babylon101/cameras
  42501. */
  42502. cameras: Camera[];
  42503. /**
  42504. * All of the lights added to this scene
  42505. * @see https://doc.babylonjs.com/babylon101/lights
  42506. */
  42507. lights: Light[];
  42508. /**
  42509. * All of the (abstract) meshes added to this scene
  42510. */
  42511. meshes: AbstractMesh[];
  42512. /**
  42513. * The list of skeletons added to the scene
  42514. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  42515. */
  42516. skeletons: Skeleton[];
  42517. /**
  42518. * All of the particle systems added to this scene
  42519. * @see https://doc.babylonjs.com/babylon101/particles
  42520. */
  42521. particleSystems: IParticleSystem[];
  42522. /**
  42523. * Gets a list of Animations associated with the scene
  42524. */
  42525. animations: Animation[];
  42526. /**
  42527. * All of the animation groups added to this scene
  42528. * @see https://doc.babylonjs.com/how_to/group
  42529. */
  42530. animationGroups: AnimationGroup[];
  42531. /**
  42532. * All of the multi-materials added to this scene
  42533. * @see https://doc.babylonjs.com/how_to/multi_materials
  42534. */
  42535. multiMaterials: MultiMaterial[];
  42536. /**
  42537. * All of the materials added to this scene
  42538. * In the context of a Scene, it is not supposed to be modified manually.
  42539. * Any addition or removal should be done using the addMaterial and removeMaterial Scene methods.
  42540. * Note also that the order of the Material within the array is not significant and might change.
  42541. * @see https://doc.babylonjs.com/babylon101/materials
  42542. */
  42543. materials: Material[];
  42544. /**
  42545. * The list of morph target managers added to the scene
  42546. * @see https://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh
  42547. */
  42548. morphTargetManagers: MorphTargetManager[];
  42549. /**
  42550. * The list of geometries used in the scene.
  42551. */
  42552. geometries: Geometry[];
  42553. /**
  42554. * All of the tranform nodes added to this scene
  42555. * In the context of a Scene, it is not supposed to be modified manually.
  42556. * Any addition or removal should be done using the addTransformNode and removeTransformNode Scene methods.
  42557. * Note also that the order of the TransformNode wihin the array is not significant and might change.
  42558. * @see https://doc.babylonjs.com/how_to/transformnode
  42559. */
  42560. transformNodes: TransformNode[];
  42561. /**
  42562. * ActionManagers available on the scene.
  42563. */
  42564. actionManagers: AbstractActionManager[];
  42565. /**
  42566. * Textures to keep.
  42567. */
  42568. textures: BaseTexture[];
  42569. /**
  42570. * Environment texture for the scene
  42571. */
  42572. environmentTexture: Nullable<BaseTexture>;
  42573. /**
  42574. * @returns all meshes, lights, cameras, transformNodes and bones
  42575. */
  42576. getNodes(): Array<Node>;
  42577. }
  42578. }
  42579. declare module "babylonjs/Audio/sound" {
  42580. import { Observable } from "babylonjs/Misc/observable";
  42581. import { Vector3 } from "babylonjs/Maths/math.vector";
  42582. import { Nullable } from "babylonjs/types";
  42583. import { Scene } from "babylonjs/scene";
  42584. import { TransformNode } from "babylonjs/Meshes/transformNode";
  42585. /**
  42586. * Interface used to define options for Sound class
  42587. */
  42588. export interface ISoundOptions {
  42589. /**
  42590. * Does the sound autoplay once loaded.
  42591. */
  42592. autoplay?: boolean;
  42593. /**
  42594. * Does the sound loop after it finishes playing once.
  42595. */
  42596. loop?: boolean;
  42597. /**
  42598. * Sound's volume
  42599. */
  42600. volume?: number;
  42601. /**
  42602. * Is it a spatial sound?
  42603. */
  42604. spatialSound?: boolean;
  42605. /**
  42606. * Maximum distance to hear that sound
  42607. */
  42608. maxDistance?: number;
  42609. /**
  42610. * Uses user defined attenuation function
  42611. */
  42612. useCustomAttenuation?: boolean;
  42613. /**
  42614. * Define the roll off factor of spatial sounds.
  42615. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  42616. */
  42617. rolloffFactor?: number;
  42618. /**
  42619. * Define the reference distance the sound should be heard perfectly.
  42620. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  42621. */
  42622. refDistance?: number;
  42623. /**
  42624. * Define the distance attenuation model the sound will follow.
  42625. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  42626. */
  42627. distanceModel?: string;
  42628. /**
  42629. * Defines the playback speed (1 by default)
  42630. */
  42631. playbackRate?: number;
  42632. /**
  42633. * Defines if the sound is from a streaming source
  42634. */
  42635. streaming?: boolean;
  42636. /**
  42637. * Defines an optional length (in seconds) inside the sound file
  42638. */
  42639. length?: number;
  42640. /**
  42641. * Defines an optional offset (in seconds) inside the sound file
  42642. */
  42643. offset?: number;
  42644. /**
  42645. * If true, URLs will not be required to state the audio file codec to use.
  42646. */
  42647. skipCodecCheck?: boolean;
  42648. }
  42649. /**
  42650. * Defines a sound that can be played in the application.
  42651. * The sound can either be an ambient track or a simple sound played in reaction to a user action.
  42652. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  42653. */
  42654. export class Sound {
  42655. /**
  42656. * The name of the sound in the scene.
  42657. */
  42658. name: string;
  42659. /**
  42660. * Does the sound autoplay once loaded.
  42661. */
  42662. autoplay: boolean;
  42663. /**
  42664. * Does the sound loop after it finishes playing once.
  42665. */
  42666. loop: boolean;
  42667. /**
  42668. * Does the sound use a custom attenuation curve to simulate the falloff
  42669. * happening when the source gets further away from the camera.
  42670. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-your-own-custom-attenuation-function
  42671. */
  42672. useCustomAttenuation: boolean;
  42673. /**
  42674. * The sound track id this sound belongs to.
  42675. */
  42676. soundTrackId: number;
  42677. /**
  42678. * Is this sound currently played.
  42679. */
  42680. isPlaying: boolean;
  42681. /**
  42682. * Is this sound currently paused.
  42683. */
  42684. isPaused: boolean;
  42685. /**
  42686. * Does this sound enables spatial sound.
  42687. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  42688. */
  42689. spatialSound: boolean;
  42690. /**
  42691. * Define the reference distance the sound should be heard perfectly.
  42692. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  42693. */
  42694. refDistance: number;
  42695. /**
  42696. * Define the roll off factor of spatial sounds.
  42697. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  42698. */
  42699. rolloffFactor: number;
  42700. /**
  42701. * Define the max distance the sound should be heard (intensity just became 0 at this point).
  42702. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  42703. */
  42704. maxDistance: number;
  42705. /**
  42706. * Define the distance attenuation model the sound will follow.
  42707. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  42708. */
  42709. distanceModel: string;
  42710. /**
  42711. * @hidden
  42712. * Back Compat
  42713. **/
  42714. onended: () => any;
  42715. /**
  42716. * Gets or sets an object used to store user defined information for the sound.
  42717. */
  42718. metadata: any;
  42719. /**
  42720. * Observable event when the current playing sound finishes.
  42721. */
  42722. onEndedObservable: Observable<Sound>;
  42723. private _panningModel;
  42724. private _playbackRate;
  42725. private _streaming;
  42726. private _startTime;
  42727. private _startOffset;
  42728. private _position;
  42729. /** @hidden */
  42730. _positionInEmitterSpace: boolean;
  42731. private _localDirection;
  42732. private _volume;
  42733. private _isReadyToPlay;
  42734. private _isDirectional;
  42735. private _readyToPlayCallback;
  42736. private _audioBuffer;
  42737. private _soundSource;
  42738. private _streamingSource;
  42739. private _soundPanner;
  42740. private _soundGain;
  42741. private _inputAudioNode;
  42742. private _outputAudioNode;
  42743. private _coneInnerAngle;
  42744. private _coneOuterAngle;
  42745. private _coneOuterGain;
  42746. private _scene;
  42747. private _connectedTransformNode;
  42748. private _customAttenuationFunction;
  42749. private _registerFunc;
  42750. private _isOutputConnected;
  42751. private _htmlAudioElement;
  42752. private _urlType;
  42753. private _length?;
  42754. private _offset?;
  42755. /** @hidden */
  42756. static _SceneComponentInitialization: (scene: Scene) => void;
  42757. /**
  42758. * Create a sound and attach it to a scene
  42759. * @param name Name of your sound
  42760. * @param urlOrArrayBuffer Url to the sound to load async or ArrayBuffer, it also works with MediaStreams
  42761. * @param scene defines the scene the sound belongs to
  42762. * @param readyToPlayCallback Provide a callback function if you'd like to load your code once the sound is ready to be played
  42763. * @param options Objects to provide with the current available options: autoplay, loop, volume, spatialSound, maxDistance, rolloffFactor, refDistance, distanceModel, panningModel, streaming
  42764. */
  42765. constructor(name: string, urlOrArrayBuffer: any, scene: Scene, readyToPlayCallback?: Nullable<() => void>, options?: ISoundOptions);
  42766. /**
  42767. * Release the sound and its associated resources
  42768. */
  42769. dispose(): void;
  42770. /**
  42771. * Gets if the sounds is ready to be played or not.
  42772. * @returns true if ready, otherwise false
  42773. */
  42774. isReady(): boolean;
  42775. private _soundLoaded;
  42776. /**
  42777. * Sets the data of the sound from an audiobuffer
  42778. * @param audioBuffer The audioBuffer containing the data
  42779. */
  42780. setAudioBuffer(audioBuffer: AudioBuffer): void;
  42781. /**
  42782. * Updates the current sounds options such as maxdistance, loop...
  42783. * @param options A JSON object containing values named as the object properties
  42784. */
  42785. updateOptions(options: ISoundOptions): void;
  42786. private _createSpatialParameters;
  42787. private _updateSpatialParameters;
  42788. /**
  42789. * Switch the panning model to HRTF:
  42790. * Renders a stereo output of higher quality than equalpower — it uses a convolution with measured impulse responses from human subjects.
  42791. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  42792. */
  42793. switchPanningModelToHRTF(): void;
  42794. /**
  42795. * Switch the panning model to Equal Power:
  42796. * Represents the equal-power panning algorithm, generally regarded as simple and efficient. equalpower is the default value.
  42797. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  42798. */
  42799. switchPanningModelToEqualPower(): void;
  42800. private _switchPanningModel;
  42801. /**
  42802. * Connect this sound to a sound track audio node like gain...
  42803. * @param soundTrackAudioNode the sound track audio node to connect to
  42804. */
  42805. connectToSoundTrackAudioNode(soundTrackAudioNode: AudioNode): void;
  42806. /**
  42807. * Transform this sound into a directional source
  42808. * @param coneInnerAngle Size of the inner cone in degree
  42809. * @param coneOuterAngle Size of the outer cone in degree
  42810. * @param coneOuterGain Volume of the sound outside the outer cone (between 0.0 and 1.0)
  42811. */
  42812. setDirectionalCone(coneInnerAngle: number, coneOuterAngle: number, coneOuterGain: number): void;
  42813. /**
  42814. * Gets or sets the inner angle for the directional cone.
  42815. */
  42816. get directionalConeInnerAngle(): number;
  42817. /**
  42818. * Gets or sets the inner angle for the directional cone.
  42819. */
  42820. set directionalConeInnerAngle(value: number);
  42821. /**
  42822. * Gets or sets the outer angle for the directional cone.
  42823. */
  42824. get directionalConeOuterAngle(): number;
  42825. /**
  42826. * Gets or sets the outer angle for the directional cone.
  42827. */
  42828. set directionalConeOuterAngle(value: number);
  42829. /**
  42830. * Sets the position of the emitter if spatial sound is enabled
  42831. * @param newPosition Defines the new posisiton
  42832. */
  42833. setPosition(newPosition: Vector3): void;
  42834. /**
  42835. * Sets the local direction of the emitter if spatial sound is enabled
  42836. * @param newLocalDirection Defines the new local direction
  42837. */
  42838. setLocalDirectionToMesh(newLocalDirection: Vector3): void;
  42839. private _updateDirection;
  42840. /** @hidden */
  42841. updateDistanceFromListener(): void;
  42842. /**
  42843. * Sets a new custom attenuation function for the sound.
  42844. * @param callback Defines the function used for the attenuation
  42845. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-your-own-custom-attenuation-function
  42846. */
  42847. setAttenuationFunction(callback: (currentVolume: number, currentDistance: number, maxDistance: number, refDistance: number, rolloffFactor: number) => number): void;
  42848. /**
  42849. * Play the sound
  42850. * @param time (optional) Start the sound after X seconds. Start immediately (0) by default.
  42851. * @param offset (optional) Start the sound at a specific time in seconds
  42852. * @param length (optional) Sound duration (in seconds)
  42853. */
  42854. play(time?: number, offset?: number, length?: number): void;
  42855. private _onended;
  42856. /**
  42857. * Stop the sound
  42858. * @param time (optional) Stop the sound after X seconds. Stop immediately (0) by default.
  42859. */
  42860. stop(time?: number): void;
  42861. /**
  42862. * Put the sound in pause
  42863. */
  42864. pause(): void;
  42865. /**
  42866. * Sets a dedicated volume for this sounds
  42867. * @param newVolume Define the new volume of the sound
  42868. * @param time Define time for gradual change to new volume
  42869. */
  42870. setVolume(newVolume: number, time?: number): void;
  42871. /**
  42872. * Set the sound play back rate
  42873. * @param newPlaybackRate Define the playback rate the sound should be played at
  42874. */
  42875. setPlaybackRate(newPlaybackRate: number): void;
  42876. /**
  42877. * Gets the volume of the sound.
  42878. * @returns the volume of the sound
  42879. */
  42880. getVolume(): number;
  42881. /**
  42882. * Attach the sound to a dedicated mesh
  42883. * @param transformNode The transform node to connect the sound with
  42884. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#attaching-a-sound-to-a-mesh
  42885. */
  42886. attachToMesh(transformNode: TransformNode): void;
  42887. /**
  42888. * Detach the sound from the previously attached mesh
  42889. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#attaching-a-sound-to-a-mesh
  42890. */
  42891. detachFromMesh(): void;
  42892. private _onRegisterAfterWorldMatrixUpdate;
  42893. /**
  42894. * Clone the current sound in the scene.
  42895. * @returns the new sound clone
  42896. */
  42897. clone(): Nullable<Sound>;
  42898. /**
  42899. * Gets the current underlying audio buffer containing the data
  42900. * @returns the audio buffer
  42901. */
  42902. getAudioBuffer(): Nullable<AudioBuffer>;
  42903. /**
  42904. * Gets the WebAudio AudioBufferSourceNode, lets you keep track of and stop instances of this Sound.
  42905. * @returns the source node
  42906. */
  42907. getSoundSource(): Nullable<AudioBufferSourceNode>;
  42908. /**
  42909. * Gets the WebAudio GainNode, gives you precise control over the gain of instances of this Sound.
  42910. * @returns the gain node
  42911. */
  42912. getSoundGain(): Nullable<GainNode>;
  42913. /**
  42914. * Serializes the Sound in a JSON representation
  42915. * @returns the JSON representation of the sound
  42916. */
  42917. serialize(): any;
  42918. /**
  42919. * Parse a JSON representation of a sound to innstantiate in a given scene
  42920. * @param parsedSound Define the JSON representation of the sound (usually coming from the serialize method)
  42921. * @param scene Define the scene the new parsed sound should be created in
  42922. * @param rootUrl Define the rooturl of the load in case we need to fetch relative dependencies
  42923. * @param sourceSound Define a cound place holder if do not need to instantiate a new one
  42924. * @returns the newly parsed sound
  42925. */
  42926. static Parse(parsedSound: any, scene: Scene, rootUrl: string, sourceSound?: Sound): Sound;
  42927. }
  42928. }
  42929. declare module "babylonjs/Actions/directAudioActions" {
  42930. import { Action } from "babylonjs/Actions/action";
  42931. import { Condition } from "babylonjs/Actions/condition";
  42932. import { Sound } from "babylonjs/Audio/sound";
  42933. /**
  42934. * This defines an action helpful to play a defined sound on a triggered action.
  42935. */
  42936. export class PlaySoundAction extends Action {
  42937. private _sound;
  42938. /**
  42939. * Instantiate the action
  42940. * @param triggerOptions defines the trigger options
  42941. * @param sound defines the sound to play
  42942. * @param condition defines the trigger related conditions
  42943. */
  42944. constructor(triggerOptions: any, sound: Sound, condition?: Condition);
  42945. /** @hidden */
  42946. _prepare(): void;
  42947. /**
  42948. * Execute the action and play the sound.
  42949. */
  42950. execute(): void;
  42951. /**
  42952. * Serializes the actions and its related information.
  42953. * @param parent defines the object to serialize in
  42954. * @returns the serialized object
  42955. */
  42956. serialize(parent: any): any;
  42957. }
  42958. /**
  42959. * This defines an action helpful to stop a defined sound on a triggered action.
  42960. */
  42961. export class StopSoundAction extends Action {
  42962. private _sound;
  42963. /**
  42964. * Instantiate the action
  42965. * @param triggerOptions defines the trigger options
  42966. * @param sound defines the sound to stop
  42967. * @param condition defines the trigger related conditions
  42968. */
  42969. constructor(triggerOptions: any, sound: Sound, condition?: Condition);
  42970. /** @hidden */
  42971. _prepare(): void;
  42972. /**
  42973. * Execute the action and stop the sound.
  42974. */
  42975. execute(): void;
  42976. /**
  42977. * Serializes the actions and its related information.
  42978. * @param parent defines the object to serialize in
  42979. * @returns the serialized object
  42980. */
  42981. serialize(parent: any): any;
  42982. }
  42983. }
  42984. declare module "babylonjs/Actions/interpolateValueAction" {
  42985. import { Action } from "babylonjs/Actions/action";
  42986. import { Condition } from "babylonjs/Actions/condition";
  42987. import { Observable } from "babylonjs/Misc/observable";
  42988. /**
  42989. * This defines an action responsible to change the value of a property
  42990. * by interpolating between its current value and the newly set one once triggered.
  42991. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  42992. */
  42993. export class InterpolateValueAction extends Action {
  42994. /**
  42995. * Defines the path of the property where the value should be interpolated
  42996. */
  42997. propertyPath: string;
  42998. /**
  42999. * Defines the target value at the end of the interpolation.
  43000. */
  43001. value: any;
  43002. /**
  43003. * Defines the time it will take for the property to interpolate to the value.
  43004. */
  43005. duration: number;
  43006. /**
  43007. * Defines if the other scene animations should be stopped when the action has been triggered
  43008. */
  43009. stopOtherAnimations?: boolean;
  43010. /**
  43011. * Defines a callback raised once the interpolation animation has been done.
  43012. */
  43013. onInterpolationDone?: () => void;
  43014. /**
  43015. * Observable triggered once the interpolation animation has been done.
  43016. */
  43017. onInterpolationDoneObservable: Observable<InterpolateValueAction>;
  43018. private _target;
  43019. private _effectiveTarget;
  43020. private _property;
  43021. /**
  43022. * Instantiate the action
  43023. * @param triggerOptions defines the trigger options
  43024. * @param target defines the object containing the value to interpolate
  43025. * @param propertyPath defines the path to the property in the target object
  43026. * @param value defines the target value at the end of the interpolation
  43027. * @param duration deines the time it will take for the property to interpolate to the value.
  43028. * @param condition defines the trigger related conditions
  43029. * @param stopOtherAnimations defines if the other scene animations should be stopped when the action has been triggered
  43030. * @param onInterpolationDone defines a callback raised once the interpolation animation has been done
  43031. */
  43032. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, duration?: number, condition?: Condition, stopOtherAnimations?: boolean, onInterpolationDone?: () => void);
  43033. /** @hidden */
  43034. _prepare(): void;
  43035. /**
  43036. * Execute the action starts the value interpolation.
  43037. */
  43038. execute(): void;
  43039. /**
  43040. * Serializes the actions and its related information.
  43041. * @param parent defines the object to serialize in
  43042. * @returns the serialized object
  43043. */
  43044. serialize(parent: any): any;
  43045. }
  43046. }
  43047. declare module "babylonjs/Actions/index" {
  43048. export * from "babylonjs/Actions/abstractActionManager";
  43049. export * from "babylonjs/Actions/action";
  43050. export * from "babylonjs/Actions/actionEvent";
  43051. export * from "babylonjs/Actions/actionManager";
  43052. export * from "babylonjs/Actions/condition";
  43053. export * from "babylonjs/Actions/directActions";
  43054. export * from "babylonjs/Actions/directAudioActions";
  43055. export * from "babylonjs/Actions/interpolateValueAction";
  43056. }
  43057. declare module "babylonjs/Animations/index" {
  43058. export * from "babylonjs/Animations/animatable";
  43059. export * from "babylonjs/Animations/animation";
  43060. export * from "babylonjs/Animations/animationGroup";
  43061. export * from "babylonjs/Animations/animationPropertiesOverride";
  43062. export * from "babylonjs/Animations/easing";
  43063. export * from "babylonjs/Animations/runtimeAnimation";
  43064. export * from "babylonjs/Animations/animationEvent";
  43065. export * from "babylonjs/Animations/animationGroup";
  43066. export * from "babylonjs/Animations/animationKey";
  43067. export * from "babylonjs/Animations/animationRange";
  43068. export * from "babylonjs/Animations/animatable.interface";
  43069. }
  43070. declare module "babylonjs/Audio/soundTrack" {
  43071. import { Sound } from "babylonjs/Audio/sound";
  43072. import { Analyser } from "babylonjs/Audio/analyser";
  43073. import { Scene } from "babylonjs/scene";
  43074. /**
  43075. * Options allowed during the creation of a sound track.
  43076. */
  43077. export interface ISoundTrackOptions {
  43078. /**
  43079. * The volume the sound track should take during creation
  43080. */
  43081. volume?: number;
  43082. /**
  43083. * Define if the sound track is the main sound track of the scene
  43084. */
  43085. mainTrack?: boolean;
  43086. }
  43087. /**
  43088. * It could be useful to isolate your music & sounds on several tracks to better manage volume on a grouped instance of sounds.
  43089. * It will be also used in a future release to apply effects on a specific track.
  43090. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-sound-tracks
  43091. */
  43092. export class SoundTrack {
  43093. /**
  43094. * The unique identifier of the sound track in the scene.
  43095. */
  43096. id: number;
  43097. /**
  43098. * The list of sounds included in the sound track.
  43099. */
  43100. soundCollection: Array<Sound>;
  43101. private _outputAudioNode;
  43102. private _scene;
  43103. private _connectedAnalyser;
  43104. private _options;
  43105. private _isInitialized;
  43106. /**
  43107. * Creates a new sound track.
  43108. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-sound-tracks
  43109. * @param scene Define the scene the sound track belongs to
  43110. * @param options
  43111. */
  43112. constructor(scene: Scene, options?: ISoundTrackOptions);
  43113. private _initializeSoundTrackAudioGraph;
  43114. /**
  43115. * Release the sound track and its associated resources
  43116. */
  43117. dispose(): void;
  43118. /**
  43119. * Adds a sound to this sound track
  43120. * @param sound define the cound to add
  43121. * @ignoreNaming
  43122. */
  43123. AddSound(sound: Sound): void;
  43124. /**
  43125. * Removes a sound to this sound track
  43126. * @param sound define the cound to remove
  43127. * @ignoreNaming
  43128. */
  43129. RemoveSound(sound: Sound): void;
  43130. /**
  43131. * Set a global volume for the full sound track.
  43132. * @param newVolume Define the new volume of the sound track
  43133. */
  43134. setVolume(newVolume: number): void;
  43135. /**
  43136. * Switch the panning model to HRTF:
  43137. * Renders a stereo output of higher quality than equalpower — it uses a convolution with measured impulse responses from human subjects.
  43138. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  43139. */
  43140. switchPanningModelToHRTF(): void;
  43141. /**
  43142. * Switch the panning model to Equal Power:
  43143. * Represents the equal-power panning algorithm, generally regarded as simple and efficient. equalpower is the default value.
  43144. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  43145. */
  43146. switchPanningModelToEqualPower(): void;
  43147. /**
  43148. * Connect the sound track to an audio analyser allowing some amazing
  43149. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  43150. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  43151. * @param analyser The analyser to connect to the engine
  43152. */
  43153. connectToAnalyser(analyser: Analyser): void;
  43154. }
  43155. }
  43156. declare module "babylonjs/Audio/audioSceneComponent" {
  43157. import { Sound } from "babylonjs/Audio/sound";
  43158. import { SoundTrack } from "babylonjs/Audio/soundTrack";
  43159. import { Nullable } from "babylonjs/types";
  43160. import { Vector3 } from "babylonjs/Maths/math.vector";
  43161. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  43162. import { Scene } from "babylonjs/scene";
  43163. import { AbstractScene } from "babylonjs/abstractScene";
  43164. import "babylonjs/Audio/audioEngine";
  43165. module "babylonjs/abstractScene" {
  43166. interface AbstractScene {
  43167. /**
  43168. * The list of sounds used in the scene.
  43169. */
  43170. sounds: Nullable<Array<Sound>>;
  43171. }
  43172. }
  43173. module "babylonjs/scene" {
  43174. interface Scene {
  43175. /**
  43176. * @hidden
  43177. * Backing field
  43178. */
  43179. _mainSoundTrack: SoundTrack;
  43180. /**
  43181. * The main sound track played by the scene.
  43182. * It cotains your primary collection of sounds.
  43183. */
  43184. mainSoundTrack: SoundTrack;
  43185. /**
  43186. * The list of sound tracks added to the scene
  43187. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  43188. */
  43189. soundTracks: Nullable<Array<SoundTrack>>;
  43190. /**
  43191. * Gets a sound using a given name
  43192. * @param name defines the name to search for
  43193. * @return the found sound or null if not found at all.
  43194. */
  43195. getSoundByName(name: string): Nullable<Sound>;
  43196. /**
  43197. * Gets or sets if audio support is enabled
  43198. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  43199. */
  43200. audioEnabled: boolean;
  43201. /**
  43202. * Gets or sets if audio will be output to headphones
  43203. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  43204. */
  43205. headphone: boolean;
  43206. /**
  43207. * Gets or sets custom audio listener position provider
  43208. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  43209. */
  43210. audioListenerPositionProvider: Nullable<() => Vector3>;
  43211. /**
  43212. * Gets or sets a refresh rate when using 3D audio positioning
  43213. */
  43214. audioPositioningRefreshRate: number;
  43215. }
  43216. }
  43217. /**
  43218. * Defines the sound scene component responsible to manage any sounds
  43219. * in a given scene.
  43220. */
  43221. export class AudioSceneComponent implements ISceneSerializableComponent {
  43222. /**
  43223. * The component name helpfull to identify the component in the list of scene components.
  43224. */
  43225. readonly name: string;
  43226. /**
  43227. * The scene the component belongs to.
  43228. */
  43229. scene: Scene;
  43230. private _audioEnabled;
  43231. /**
  43232. * Gets whether audio is enabled or not.
  43233. * Please use related enable/disable method to switch state.
  43234. */
  43235. get audioEnabled(): boolean;
  43236. private _headphone;
  43237. /**
  43238. * Gets whether audio is outputing to headphone or not.
  43239. * Please use the according Switch methods to change output.
  43240. */
  43241. get headphone(): boolean;
  43242. /**
  43243. * Gets or sets a refresh rate when using 3D audio positioning
  43244. */
  43245. audioPositioningRefreshRate: number;
  43246. private _audioListenerPositionProvider;
  43247. /**
  43248. * Gets the current audio listener position provider
  43249. */
  43250. get audioListenerPositionProvider(): Nullable<() => Vector3>;
  43251. /**
  43252. * Sets a custom listener position for all sounds in the scene
  43253. * By default, this is the position of the first active camera
  43254. */
  43255. set audioListenerPositionProvider(value: Nullable<() => Vector3>);
  43256. /**
  43257. * Creates a new instance of the component for the given scene
  43258. * @param scene Defines the scene to register the component in
  43259. */
  43260. constructor(scene: Scene);
  43261. /**
  43262. * Registers the component in a given scene
  43263. */
  43264. register(): void;
  43265. /**
  43266. * Rebuilds the elements related to this component in case of
  43267. * context lost for instance.
  43268. */
  43269. rebuild(): void;
  43270. /**
  43271. * Serializes the component data to the specified json object
  43272. * @param serializationObject The object to serialize to
  43273. */
  43274. serialize(serializationObject: any): void;
  43275. /**
  43276. * Adds all the elements from the container to the scene
  43277. * @param container the container holding the elements
  43278. */
  43279. addFromContainer(container: AbstractScene): void;
  43280. /**
  43281. * Removes all the elements in the container from the scene
  43282. * @param container contains the elements to remove
  43283. * @param dispose if the removed element should be disposed (default: false)
  43284. */
  43285. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  43286. /**
  43287. * Disposes the component and the associated ressources.
  43288. */
  43289. dispose(): void;
  43290. /**
  43291. * Disables audio in the associated scene.
  43292. */
  43293. disableAudio(): void;
  43294. /**
  43295. * Enables audio in the associated scene.
  43296. */
  43297. enableAudio(): void;
  43298. /**
  43299. * Switch audio to headphone output.
  43300. */
  43301. switchAudioModeForHeadphones(): void;
  43302. /**
  43303. * Switch audio to normal speakers.
  43304. */
  43305. switchAudioModeForNormalSpeakers(): void;
  43306. private _cachedCameraDirection;
  43307. private _cachedCameraPosition;
  43308. private _lastCheck;
  43309. private _afterRender;
  43310. }
  43311. }
  43312. declare module "babylonjs/Audio/weightedsound" {
  43313. import { Sound } from "babylonjs/Audio/sound";
  43314. /**
  43315. * Wraps one or more Sound objects and selects one with random weight for playback.
  43316. */
  43317. export class WeightedSound {
  43318. /** When true a Sound will be selected and played when the current playing Sound completes. */
  43319. loop: boolean;
  43320. private _coneInnerAngle;
  43321. private _coneOuterAngle;
  43322. private _volume;
  43323. /** A Sound is currently playing. */
  43324. isPlaying: boolean;
  43325. /** A Sound is currently paused. */
  43326. isPaused: boolean;
  43327. private _sounds;
  43328. private _weights;
  43329. private _currentIndex?;
  43330. /**
  43331. * Creates a new WeightedSound from the list of sounds given.
  43332. * @param loop When true a Sound will be selected and played when the current playing Sound completes.
  43333. * @param sounds Array of Sounds that will be selected from.
  43334. * @param weights Array of number values for selection weights; length must equal sounds, values will be normalized to 1
  43335. */
  43336. constructor(loop: boolean, sounds: Sound[], weights: number[]);
  43337. /**
  43338. * The size of cone in degrees for a directional sound in which there will be no attenuation.
  43339. */
  43340. get directionalConeInnerAngle(): number;
  43341. /**
  43342. * The size of cone in degress for a directional sound in which there will be no attenuation.
  43343. */
  43344. set directionalConeInnerAngle(value: number);
  43345. /**
  43346. * Size of cone in degrees for a directional sound outside of which there will be no sound.
  43347. * Listener angles between innerAngle and outerAngle will falloff linearly.
  43348. */
  43349. get directionalConeOuterAngle(): number;
  43350. /**
  43351. * Size of cone in degrees for a directional sound outside of which there will be no sound.
  43352. * Listener angles between innerAngle and outerAngle will falloff linearly.
  43353. */
  43354. set directionalConeOuterAngle(value: number);
  43355. /**
  43356. * Playback volume.
  43357. */
  43358. get volume(): number;
  43359. /**
  43360. * Playback volume.
  43361. */
  43362. set volume(value: number);
  43363. private _onended;
  43364. /**
  43365. * Suspend playback
  43366. */
  43367. pause(): void;
  43368. /**
  43369. * Stop playback
  43370. */
  43371. stop(): void;
  43372. /**
  43373. * Start playback.
  43374. * @param startOffset Position the clip head at a specific time in seconds.
  43375. */
  43376. play(startOffset?: number): void;
  43377. }
  43378. }
  43379. declare module "babylonjs/Audio/index" {
  43380. export * from "babylonjs/Audio/analyser";
  43381. export * from "babylonjs/Audio/audioEngine";
  43382. export * from "babylonjs/Audio/audioSceneComponent";
  43383. export * from "babylonjs/Audio/sound";
  43384. export * from "babylonjs/Audio/soundTrack";
  43385. export * from "babylonjs/Audio/weightedsound";
  43386. }
  43387. declare module "babylonjs/Behaviors/Cameras/bouncingBehavior" {
  43388. import { Behavior } from "babylonjs/Behaviors/behavior";
  43389. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  43390. import { BackEase } from "babylonjs/Animations/easing";
  43391. /**
  43392. * Add a bouncing effect to an ArcRotateCamera when reaching a specified minimum and maximum radius
  43393. * @see https://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  43394. */
  43395. export class BouncingBehavior implements Behavior<ArcRotateCamera> {
  43396. /**
  43397. * Gets the name of the behavior.
  43398. */
  43399. get name(): string;
  43400. /**
  43401. * The easing function used by animations
  43402. */
  43403. static EasingFunction: BackEase;
  43404. /**
  43405. * The easing mode used by animations
  43406. */
  43407. static EasingMode: number;
  43408. /**
  43409. * The duration of the animation, in milliseconds
  43410. */
  43411. transitionDuration: number;
  43412. /**
  43413. * Length of the distance animated by the transition when lower radius is reached
  43414. */
  43415. lowerRadiusTransitionRange: number;
  43416. /**
  43417. * Length of the distance animated by the transition when upper radius is reached
  43418. */
  43419. upperRadiusTransitionRange: number;
  43420. private _autoTransitionRange;
  43421. /**
  43422. * Gets a value indicating if the lowerRadiusTransitionRange and upperRadiusTransitionRange are defined automatically
  43423. */
  43424. get autoTransitionRange(): boolean;
  43425. /**
  43426. * Sets a value indicating if the lowerRadiusTransitionRange and upperRadiusTransitionRange are defined automatically
  43427. * Transition ranges will be set to 5% of the bounding box diagonal in world space
  43428. */
  43429. set autoTransitionRange(value: boolean);
  43430. private _attachedCamera;
  43431. private _onAfterCheckInputsObserver;
  43432. private _onMeshTargetChangedObserver;
  43433. /**
  43434. * Initializes the behavior.
  43435. */
  43436. init(): void;
  43437. /**
  43438. * Attaches the behavior to its arc rotate camera.
  43439. * @param camera Defines the camera to attach the behavior to
  43440. */
  43441. attach(camera: ArcRotateCamera): void;
  43442. /**
  43443. * Detaches the behavior from its current arc rotate camera.
  43444. */
  43445. detach(): void;
  43446. private _radiusIsAnimating;
  43447. private _radiusBounceTransition;
  43448. private _animatables;
  43449. private _cachedWheelPrecision;
  43450. /**
  43451. * Checks if the camera radius is at the specified limit. Takes into account animation locks.
  43452. * @param radiusLimit The limit to check against.
  43453. * @return Bool to indicate if at limit.
  43454. */
  43455. private _isRadiusAtLimit;
  43456. /**
  43457. * Applies an animation to the radius of the camera, extending by the radiusDelta.
  43458. * @param radiusDelta The delta by which to animate to. Can be negative.
  43459. */
  43460. private _applyBoundRadiusAnimation;
  43461. /**
  43462. * Removes all animation locks. Allows new animations to be added to any of the camera properties.
  43463. */
  43464. protected _clearAnimationLocks(): void;
  43465. /**
  43466. * Stops and removes all animations that have been applied to the camera
  43467. */
  43468. stopAllAnimations(): void;
  43469. }
  43470. }
  43471. declare module "babylonjs/Behaviors/Cameras/framingBehavior" {
  43472. import { Behavior } from "babylonjs/Behaviors/behavior";
  43473. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  43474. import { ExponentialEase } from "babylonjs/Animations/easing";
  43475. import { Nullable } from "babylonjs/types";
  43476. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  43477. import { Vector3 } from "babylonjs/Maths/math.vector";
  43478. /**
  43479. * 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.
  43480. * @see https://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  43481. */
  43482. export class FramingBehavior implements Behavior<ArcRotateCamera> {
  43483. /**
  43484. * Gets the name of the behavior.
  43485. */
  43486. get name(): string;
  43487. private _mode;
  43488. private _radiusScale;
  43489. private _positionScale;
  43490. private _defaultElevation;
  43491. private _elevationReturnTime;
  43492. private _elevationReturnWaitTime;
  43493. private _zoomStopsAnimation;
  43494. private _framingTime;
  43495. /**
  43496. * The easing function used by animations
  43497. */
  43498. static EasingFunction: ExponentialEase;
  43499. /**
  43500. * The easing mode used by animations
  43501. */
  43502. static EasingMode: number;
  43503. /**
  43504. * Sets the current mode used by the behavior
  43505. */
  43506. set mode(mode: number);
  43507. /**
  43508. * Gets current mode used by the behavior.
  43509. */
  43510. get mode(): number;
  43511. /**
  43512. * Sets the scale applied to the radius (1 by default)
  43513. */
  43514. set radiusScale(radius: number);
  43515. /**
  43516. * Gets the scale applied to the radius
  43517. */
  43518. get radiusScale(): number;
  43519. /**
  43520. * Sets the scale to apply on Y axis to position camera focus. 0.5 by default which means the center of the bounding box.
  43521. */
  43522. set positionScale(scale: number);
  43523. /**
  43524. * Gets the scale to apply on Y axis to position camera focus. 0.5 by default which means the center of the bounding box.
  43525. */
  43526. get positionScale(): number;
  43527. /**
  43528. * Sets the angle above/below the horizontal plane to return to when the return to default elevation idle
  43529. * behaviour is triggered, in radians.
  43530. */
  43531. set defaultElevation(elevation: number);
  43532. /**
  43533. * Gets the angle above/below the horizontal plane to return to when the return to default elevation idle
  43534. * behaviour is triggered, in radians.
  43535. */
  43536. get defaultElevation(): number;
  43537. /**
  43538. * Sets the time (in milliseconds) taken to return to the default beta position.
  43539. * Negative value indicates camera should not return to default.
  43540. */
  43541. set elevationReturnTime(speed: number);
  43542. /**
  43543. * Gets the time (in milliseconds) taken to return to the default beta position.
  43544. * Negative value indicates camera should not return to default.
  43545. */
  43546. get elevationReturnTime(): number;
  43547. /**
  43548. * Sets the delay (in milliseconds) taken before the camera returns to the default beta position.
  43549. */
  43550. set elevationReturnWaitTime(time: number);
  43551. /**
  43552. * Gets the delay (in milliseconds) taken before the camera returns to the default beta position.
  43553. */
  43554. get elevationReturnWaitTime(): number;
  43555. /**
  43556. * Sets the flag that indicates if user zooming should stop animation.
  43557. */
  43558. set zoomStopsAnimation(flag: boolean);
  43559. /**
  43560. * Gets the flag that indicates if user zooming should stop animation.
  43561. */
  43562. get zoomStopsAnimation(): boolean;
  43563. /**
  43564. * Sets the transition time when framing the mesh, in milliseconds
  43565. */
  43566. set framingTime(time: number);
  43567. /**
  43568. * Gets the transition time when framing the mesh, in milliseconds
  43569. */
  43570. get framingTime(): number;
  43571. /**
  43572. * Define if the behavior should automatically change the configured
  43573. * camera limits and sensibilities.
  43574. */
  43575. autoCorrectCameraLimitsAndSensibility: boolean;
  43576. private _onPrePointerObservableObserver;
  43577. private _onAfterCheckInputsObserver;
  43578. private _onMeshTargetChangedObserver;
  43579. private _attachedCamera;
  43580. private _isPointerDown;
  43581. private _lastInteractionTime;
  43582. /**
  43583. * Initializes the behavior.
  43584. */
  43585. init(): void;
  43586. /**
  43587. * Attaches the behavior to its arc rotate camera.
  43588. * @param camera Defines the camera to attach the behavior to
  43589. */
  43590. attach(camera: ArcRotateCamera): void;
  43591. /**
  43592. * Detaches the behavior from its current arc rotate camera.
  43593. */
  43594. detach(): void;
  43595. private _animatables;
  43596. private _betaIsAnimating;
  43597. private _betaTransition;
  43598. private _radiusTransition;
  43599. private _vectorTransition;
  43600. /**
  43601. * Targets the given mesh and updates zoom level accordingly.
  43602. * @param mesh The mesh to target.
  43603. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  43604. * @param onAnimationEnd Callback triggered at the end of the framing animation
  43605. */
  43606. zoomOnMesh(mesh: AbstractMesh, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  43607. /**
  43608. * Targets the given mesh with its children and updates zoom level accordingly.
  43609. * @param mesh The mesh to target.
  43610. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  43611. * @param onAnimationEnd Callback triggered at the end of the framing animation
  43612. */
  43613. zoomOnMeshHierarchy(mesh: AbstractMesh, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  43614. /**
  43615. * Targets the given meshes with their children and updates zoom level accordingly.
  43616. * @param meshes The mesh to target.
  43617. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  43618. * @param onAnimationEnd Callback triggered at the end of the framing animation
  43619. */
  43620. zoomOnMeshesHierarchy(meshes: AbstractMesh[], focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  43621. /**
  43622. * Targets the bounding box info defined by its extends and updates zoom level accordingly.
  43623. * @param minimumWorld Determines the smaller position of the bounding box extend
  43624. * @param maximumWorld Determines the bigger position of the bounding box extend
  43625. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  43626. * @param onAnimationEnd Callback triggered at the end of the framing animation
  43627. */
  43628. zoomOnBoundingInfo(minimumWorld: Vector3, maximumWorld: Vector3, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  43629. /**
  43630. * Calculates the lowest radius for the camera based on the bounding box of the mesh.
  43631. * @param mesh The mesh on which to base the calculation. mesh boundingInfo used to estimate necessary
  43632. * frustum width.
  43633. * @return The minimum distance from the primary mesh's center point at which the camera must be kept in order
  43634. * to fully enclose the mesh in the viewing frustum.
  43635. */
  43636. protected _calculateLowerRadiusFromModelBoundingSphere(minimumWorld: Vector3, maximumWorld: Vector3): number;
  43637. /**
  43638. * Keeps the camera above the ground plane. If the user pulls the camera below the ground plane, the camera
  43639. * is automatically returned to its default position (expected to be above ground plane).
  43640. */
  43641. private _maintainCameraAboveGround;
  43642. /**
  43643. * Returns the frustum slope based on the canvas ratio and camera FOV
  43644. * @returns The frustum slope represented as a Vector2 with X and Y slopes
  43645. */
  43646. private _getFrustumSlope;
  43647. /**
  43648. * Removes all animation locks. Allows new animations to be added to any of the arcCamera properties.
  43649. */
  43650. private _clearAnimationLocks;
  43651. /**
  43652. * Applies any current user interaction to the camera. Takes into account maximum alpha rotation.
  43653. */
  43654. private _applyUserInteraction;
  43655. /**
  43656. * Stops and removes all animations that have been applied to the camera
  43657. */
  43658. stopAllAnimations(): void;
  43659. /**
  43660. * Gets a value indicating if the user is moving the camera
  43661. */
  43662. get isUserIsMoving(): boolean;
  43663. /**
  43664. * The camera can move all the way towards the mesh.
  43665. */
  43666. static IgnoreBoundsSizeMode: number;
  43667. /**
  43668. * The camera is not allowed to zoom closer to the mesh than the point at which the adjusted bounding sphere touches the frustum sides
  43669. */
  43670. static FitFrustumSidesMode: number;
  43671. }
  43672. }
  43673. declare module "babylonjs/Cameras/Inputs/BaseCameraPointersInput" {
  43674. import { Nullable } from "babylonjs/types";
  43675. import { Camera } from "babylonjs/Cameras/camera";
  43676. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  43677. import { PointerTouch } from "babylonjs/Events/pointerEvents";
  43678. /**
  43679. * Base class for Camera Pointer Inputs.
  43680. * See FollowCameraPointersInput in src/Cameras/Inputs/followCameraPointersInput.ts
  43681. * for example usage.
  43682. */
  43683. export abstract class BaseCameraPointersInput implements ICameraInput<Camera> {
  43684. /**
  43685. * Defines the camera the input is attached to.
  43686. */
  43687. abstract camera: Camera;
  43688. /**
  43689. * Whether keyboard modifier keys are pressed at time of last mouse event.
  43690. */
  43691. protected _altKey: boolean;
  43692. protected _ctrlKey: boolean;
  43693. protected _metaKey: boolean;
  43694. protected _shiftKey: boolean;
  43695. /**
  43696. * Which mouse buttons were pressed at time of last mouse event.
  43697. * https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/buttons
  43698. */
  43699. protected _buttonsPressed: number;
  43700. /**
  43701. * Defines the buttons associated with the input to handle camera move.
  43702. */
  43703. buttons: number[];
  43704. /**
  43705. * Attach the input controls to a specific dom element to get the input from.
  43706. * @param element Defines the element the controls should be listened from
  43707. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  43708. */
  43709. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  43710. /**
  43711. * Detach the current controls from the specified dom element.
  43712. * @param element Defines the element to stop listening the inputs from
  43713. */
  43714. detachControl(element: Nullable<HTMLElement>): void;
  43715. /**
  43716. * Gets the class name of the current input.
  43717. * @returns the class name
  43718. */
  43719. getClassName(): string;
  43720. /**
  43721. * Get the friendly name associated with the input class.
  43722. * @returns the input friendly name
  43723. */
  43724. getSimpleName(): string;
  43725. /**
  43726. * Called on pointer POINTERDOUBLETAP event.
  43727. * Override this method to provide functionality on POINTERDOUBLETAP event.
  43728. */
  43729. protected onDoubleTap(type: string): void;
  43730. /**
  43731. * Called on pointer POINTERMOVE event if only a single touch is active.
  43732. * Override this method to provide functionality.
  43733. */
  43734. protected onTouch(point: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  43735. /**
  43736. * Called on pointer POINTERMOVE event if multiple touches are active.
  43737. * Override this method to provide functionality.
  43738. */
  43739. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  43740. /**
  43741. * Called on JS contextmenu event.
  43742. * Override this method to provide functionality.
  43743. */
  43744. protected onContextMenu(evt: PointerEvent): void;
  43745. /**
  43746. * Called each time a new POINTERDOWN event occurs. Ie, for each button
  43747. * press.
  43748. * Override this method to provide functionality.
  43749. */
  43750. protected onButtonDown(evt: PointerEvent): void;
  43751. /**
  43752. * Called each time a new POINTERUP event occurs. Ie, for each button
  43753. * release.
  43754. * Override this method to provide functionality.
  43755. */
  43756. protected onButtonUp(evt: PointerEvent): void;
  43757. /**
  43758. * Called when window becomes inactive.
  43759. * Override this method to provide functionality.
  43760. */
  43761. protected onLostFocus(): void;
  43762. private _pointerInput;
  43763. private _observer;
  43764. private _onLostFocus;
  43765. private pointA;
  43766. private pointB;
  43767. }
  43768. }
  43769. declare module "babylonjs/Cameras/Inputs/arcRotateCameraPointersInput" {
  43770. import { Nullable } from "babylonjs/types";
  43771. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  43772. import { BaseCameraPointersInput } from "babylonjs/Cameras/Inputs/BaseCameraPointersInput";
  43773. import { PointerTouch } from "babylonjs/Events/pointerEvents";
  43774. /**
  43775. * Manage the pointers inputs to control an arc rotate camera.
  43776. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  43777. */
  43778. export class ArcRotateCameraPointersInput extends BaseCameraPointersInput {
  43779. /**
  43780. * Defines the camera the input is attached to.
  43781. */
  43782. camera: ArcRotateCamera;
  43783. /**
  43784. * Gets the class name of the current input.
  43785. * @returns the class name
  43786. */
  43787. getClassName(): string;
  43788. /**
  43789. * Defines the buttons associated with the input to handle camera move.
  43790. */
  43791. buttons: number[];
  43792. /**
  43793. * Defines the pointer angular sensibility along the X axis or how fast is
  43794. * the camera rotating.
  43795. */
  43796. angularSensibilityX: number;
  43797. /**
  43798. * Defines the pointer angular sensibility along the Y axis or how fast is
  43799. * the camera rotating.
  43800. */
  43801. angularSensibilityY: number;
  43802. /**
  43803. * Defines the pointer pinch precision or how fast is the camera zooming.
  43804. */
  43805. pinchPrecision: number;
  43806. /**
  43807. * pinchDeltaPercentage will be used instead of pinchPrecision if different
  43808. * from 0.
  43809. * It defines the percentage of current camera.radius to use as delta when
  43810. * pinch zoom is used.
  43811. */
  43812. pinchDeltaPercentage: number;
  43813. /**
  43814. * When useNaturalPinchZoom is true, multi touch zoom will zoom in such
  43815. * that any object in the plane at the camera's target point will scale
  43816. * perfectly with finger motion.
  43817. * Overrides pinchDeltaPercentage and pinchPrecision.
  43818. */
  43819. useNaturalPinchZoom: boolean;
  43820. /**
  43821. * Defines the pointer panning sensibility or how fast is the camera moving.
  43822. */
  43823. panningSensibility: number;
  43824. /**
  43825. * Defines whether panning (2 fingers swipe) is enabled through multitouch.
  43826. */
  43827. multiTouchPanning: boolean;
  43828. /**
  43829. * Defines whether panning is enabled for both pan (2 fingers swipe) and
  43830. * zoom (pinch) through multitouch.
  43831. */
  43832. multiTouchPanAndZoom: boolean;
  43833. /**
  43834. * Revers pinch action direction.
  43835. */
  43836. pinchInwards: boolean;
  43837. private _isPanClick;
  43838. private _twoFingerActivityCount;
  43839. private _isPinching;
  43840. /**
  43841. * Called on pointer POINTERMOVE event if only a single touch is active.
  43842. */
  43843. protected onTouch(point: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  43844. /**
  43845. * Called on pointer POINTERDOUBLETAP event.
  43846. */
  43847. protected onDoubleTap(type: string): void;
  43848. /**
  43849. * Called on pointer POINTERMOVE event if multiple touches are active.
  43850. */
  43851. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  43852. /**
  43853. * Called each time a new POINTERDOWN event occurs. Ie, for each button
  43854. * press.
  43855. */
  43856. protected onButtonDown(evt: PointerEvent): void;
  43857. /**
  43858. * Called each time a new POINTERUP event occurs. Ie, for each button
  43859. * release.
  43860. */
  43861. protected onButtonUp(evt: PointerEvent): void;
  43862. /**
  43863. * Called when window becomes inactive.
  43864. */
  43865. protected onLostFocus(): void;
  43866. }
  43867. }
  43868. declare module "babylonjs/Cameras/Inputs/arcRotateCameraKeyboardMoveInput" {
  43869. import { Nullable } from "babylonjs/types";
  43870. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  43871. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  43872. /**
  43873. * Manage the keyboard inputs to control the movement of an arc rotate camera.
  43874. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  43875. */
  43876. export class ArcRotateCameraKeyboardMoveInput implements ICameraInput<ArcRotateCamera> {
  43877. /**
  43878. * Defines the camera the input is attached to.
  43879. */
  43880. camera: ArcRotateCamera;
  43881. /**
  43882. * Defines the list of key codes associated with the up action (increase alpha)
  43883. */
  43884. keysUp: number[];
  43885. /**
  43886. * Defines the list of key codes associated with the down action (decrease alpha)
  43887. */
  43888. keysDown: number[];
  43889. /**
  43890. * Defines the list of key codes associated with the left action (increase beta)
  43891. */
  43892. keysLeft: number[];
  43893. /**
  43894. * Defines the list of key codes associated with the right action (decrease beta)
  43895. */
  43896. keysRight: number[];
  43897. /**
  43898. * Defines the list of key codes associated with the reset action.
  43899. * Those keys reset the camera to its last stored state (with the method camera.storeState())
  43900. */
  43901. keysReset: number[];
  43902. /**
  43903. * Defines the panning sensibility of the inputs.
  43904. * (How fast is the camera panning)
  43905. */
  43906. panningSensibility: number;
  43907. /**
  43908. * Defines the zooming sensibility of the inputs.
  43909. * (How fast is the camera zooming)
  43910. */
  43911. zoomingSensibility: number;
  43912. /**
  43913. * Defines whether maintaining the alt key down switch the movement mode from
  43914. * orientation to zoom.
  43915. */
  43916. useAltToZoom: boolean;
  43917. /**
  43918. * Rotation speed of the camera
  43919. */
  43920. angularSpeed: number;
  43921. private _keys;
  43922. private _ctrlPressed;
  43923. private _altPressed;
  43924. private _onCanvasBlurObserver;
  43925. private _onKeyboardObserver;
  43926. private _engine;
  43927. private _scene;
  43928. /**
  43929. * Attach the input controls to a specific dom element to get the input from.
  43930. * @param element Defines the element the controls should be listened from
  43931. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  43932. */
  43933. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  43934. /**
  43935. * Detach the current controls from the specified dom element.
  43936. * @param element Defines the element to stop listening the inputs from
  43937. */
  43938. detachControl(element: Nullable<HTMLElement>): void;
  43939. /**
  43940. * Update the current camera state depending on the inputs that have been used this frame.
  43941. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  43942. */
  43943. checkInputs(): void;
  43944. /**
  43945. * Gets the class name of the current intput.
  43946. * @returns the class name
  43947. */
  43948. getClassName(): string;
  43949. /**
  43950. * Get the friendly name associated with the input class.
  43951. * @returns the input friendly name
  43952. */
  43953. getSimpleName(): string;
  43954. }
  43955. }
  43956. declare module "babylonjs/Cameras/Inputs/arcRotateCameraMouseWheelInput" {
  43957. import { Nullable } from "babylonjs/types";
  43958. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  43959. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  43960. /**
  43961. * Manage the mouse wheel inputs to control an arc rotate camera.
  43962. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  43963. */
  43964. export class ArcRotateCameraMouseWheelInput implements ICameraInput<ArcRotateCamera> {
  43965. /**
  43966. * Defines the camera the input is attached to.
  43967. */
  43968. camera: ArcRotateCamera;
  43969. /**
  43970. * Gets or Set the mouse wheel precision or how fast is the camera zooming.
  43971. */
  43972. wheelPrecision: number;
  43973. /**
  43974. * wheelDeltaPercentage will be used instead of wheelPrecision if different from 0.
  43975. * It defines the percentage of current camera.radius to use as delta when wheel is used.
  43976. */
  43977. wheelDeltaPercentage: number;
  43978. private _wheel;
  43979. private _observer;
  43980. private computeDeltaFromMouseWheelLegacyEvent;
  43981. /**
  43982. * Attach the input controls to a specific dom element to get the input from.
  43983. * @param element Defines the element the controls should be listened from
  43984. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  43985. */
  43986. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  43987. /**
  43988. * Detach the current controls from the specified dom element.
  43989. * @param element Defines the element to stop listening the inputs from
  43990. */
  43991. detachControl(element: Nullable<HTMLElement>): void;
  43992. /**
  43993. * Gets the class name of the current intput.
  43994. * @returns the class name
  43995. */
  43996. getClassName(): string;
  43997. /**
  43998. * Get the friendly name associated with the input class.
  43999. * @returns the input friendly name
  44000. */
  44001. getSimpleName(): string;
  44002. }
  44003. }
  44004. declare module "babylonjs/Cameras/arcRotateCameraInputsManager" {
  44005. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  44006. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  44007. /**
  44008. * Default Inputs manager for the ArcRotateCamera.
  44009. * It groups all the default supported inputs for ease of use.
  44010. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  44011. */
  44012. export class ArcRotateCameraInputsManager extends CameraInputsManager<ArcRotateCamera> {
  44013. /**
  44014. * Instantiates a new ArcRotateCameraInputsManager.
  44015. * @param camera Defines the camera the inputs belong to
  44016. */
  44017. constructor(camera: ArcRotateCamera);
  44018. /**
  44019. * Add mouse wheel input support to the input manager.
  44020. * @returns the current input manager
  44021. */
  44022. addMouseWheel(): ArcRotateCameraInputsManager;
  44023. /**
  44024. * Add pointers input support to the input manager.
  44025. * @returns the current input manager
  44026. */
  44027. addPointers(): ArcRotateCameraInputsManager;
  44028. /**
  44029. * Add keyboard input support to the input manager.
  44030. * @returns the current input manager
  44031. */
  44032. addKeyboard(): ArcRotateCameraInputsManager;
  44033. }
  44034. }
  44035. declare module "babylonjs/Cameras/arcRotateCamera" {
  44036. import { Observable } from "babylonjs/Misc/observable";
  44037. import { Nullable } from "babylonjs/types";
  44038. import { Scene } from "babylonjs/scene";
  44039. import { Matrix, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  44040. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  44041. import { AutoRotationBehavior } from "babylonjs/Behaviors/Cameras/autoRotationBehavior";
  44042. import { BouncingBehavior } from "babylonjs/Behaviors/Cameras/bouncingBehavior";
  44043. import { FramingBehavior } from "babylonjs/Behaviors/Cameras/framingBehavior";
  44044. import { Camera } from "babylonjs/Cameras/camera";
  44045. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  44046. import { ArcRotateCameraInputsManager } from "babylonjs/Cameras/arcRotateCameraInputsManager";
  44047. import { Collider } from "babylonjs/Collisions/collider";
  44048. /**
  44049. * This represents an orbital type of camera.
  44050. *
  44051. * 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.
  44052. * 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.
  44053. * @see https://doc.babylonjs.com/babylon101/cameras#arc-rotate-camera
  44054. */
  44055. export class ArcRotateCamera extends TargetCamera {
  44056. /**
  44057. * Defines the rotation angle of the camera along the longitudinal axis.
  44058. */
  44059. alpha: number;
  44060. /**
  44061. * Defines the rotation angle of the camera along the latitudinal axis.
  44062. */
  44063. beta: number;
  44064. /**
  44065. * Defines the radius of the camera from it s target point.
  44066. */
  44067. radius: number;
  44068. protected _target: Vector3;
  44069. protected _targetHost: Nullable<AbstractMesh>;
  44070. /**
  44071. * Defines the target point of the camera.
  44072. * The camera looks towards it form the radius distance.
  44073. */
  44074. get target(): Vector3;
  44075. set target(value: Vector3);
  44076. /**
  44077. * Define the current local position of the camera in the scene
  44078. */
  44079. get position(): Vector3;
  44080. set position(newPosition: Vector3);
  44081. protected _upVector: Vector3;
  44082. protected _upToYMatrix: Matrix;
  44083. protected _YToUpMatrix: Matrix;
  44084. /**
  44085. * The vector the camera should consider as up. (default is Vector3(0, 1, 0) as returned by Vector3.Up())
  44086. * Setting this will copy the given vector to the camera's upVector, and set rotation matrices to and from Y up.
  44087. * DO NOT set the up vector using copyFrom or copyFromFloats, as this bypasses setting the above matrices.
  44088. */
  44089. set upVector(vec: Vector3);
  44090. get upVector(): Vector3;
  44091. /**
  44092. * Sets the Y-up to camera up-vector rotation matrix, and the up-vector to Y-up rotation matrix.
  44093. */
  44094. setMatUp(): void;
  44095. /**
  44096. * Current inertia value on the longitudinal axis.
  44097. * The bigger this number the longer it will take for the camera to stop.
  44098. */
  44099. inertialAlphaOffset: number;
  44100. /**
  44101. * Current inertia value on the latitudinal axis.
  44102. * The bigger this number the longer it will take for the camera to stop.
  44103. */
  44104. inertialBetaOffset: number;
  44105. /**
  44106. * Current inertia value on the radius axis.
  44107. * The bigger this number the longer it will take for the camera to stop.
  44108. */
  44109. inertialRadiusOffset: number;
  44110. /**
  44111. * Minimum allowed angle on the longitudinal axis.
  44112. * This can help limiting how the Camera is able to move in the scene.
  44113. */
  44114. lowerAlphaLimit: Nullable<number>;
  44115. /**
  44116. * Maximum allowed angle on the longitudinal axis.
  44117. * This can help limiting how the Camera is able to move in the scene.
  44118. */
  44119. upperAlphaLimit: Nullable<number>;
  44120. /**
  44121. * Minimum allowed angle on the latitudinal axis.
  44122. * This can help limiting how the Camera is able to move in the scene.
  44123. */
  44124. lowerBetaLimit: number;
  44125. /**
  44126. * Maximum allowed angle on the latitudinal axis.
  44127. * This can help limiting how the Camera is able to move in the scene.
  44128. */
  44129. upperBetaLimit: number;
  44130. /**
  44131. * Minimum allowed distance of the camera to the target (The camera can not get closer).
  44132. * This can help limiting how the Camera is able to move in the scene.
  44133. */
  44134. lowerRadiusLimit: Nullable<number>;
  44135. /**
  44136. * Maximum allowed distance of the camera to the target (The camera can not get further).
  44137. * This can help limiting how the Camera is able to move in the scene.
  44138. */
  44139. upperRadiusLimit: Nullable<number>;
  44140. /**
  44141. * Defines the current inertia value used during panning of the camera along the X axis.
  44142. */
  44143. inertialPanningX: number;
  44144. /**
  44145. * Defines the current inertia value used during panning of the camera along the Y axis.
  44146. */
  44147. inertialPanningY: number;
  44148. /**
  44149. * Defines the distance used to consider the camera in pan mode vs pinch/zoom.
  44150. * Basically if your fingers moves away from more than this distance you will be considered
  44151. * in pinch mode.
  44152. */
  44153. pinchToPanMaxDistance: number;
  44154. /**
  44155. * Defines the maximum distance the camera can pan.
  44156. * This could help keeping the cammera always in your scene.
  44157. */
  44158. panningDistanceLimit: Nullable<number>;
  44159. /**
  44160. * Defines the target of the camera before paning.
  44161. */
  44162. panningOriginTarget: Vector3;
  44163. /**
  44164. * Defines the value of the inertia used during panning.
  44165. * 0 would mean stop inertia and one would mean no decelleration at all.
  44166. */
  44167. panningInertia: number;
  44168. /**
  44169. * Gets or Set the pointer angular sensibility along the X axis or how fast is the camera rotating.
  44170. */
  44171. get angularSensibilityX(): number;
  44172. set angularSensibilityX(value: number);
  44173. /**
  44174. * Gets or Set the pointer angular sensibility along the Y axis or how fast is the camera rotating.
  44175. */
  44176. get angularSensibilityY(): number;
  44177. set angularSensibilityY(value: number);
  44178. /**
  44179. * Gets or Set the pointer pinch precision or how fast is the camera zooming.
  44180. */
  44181. get pinchPrecision(): number;
  44182. set pinchPrecision(value: number);
  44183. /**
  44184. * Gets or Set the pointer pinch delta percentage or how fast is the camera zooming.
  44185. * It will be used instead of pinchDeltaPrecision if different from 0.
  44186. * It defines the percentage of current camera.radius to use as delta when pinch zoom is used.
  44187. */
  44188. get pinchDeltaPercentage(): number;
  44189. set pinchDeltaPercentage(value: number);
  44190. /**
  44191. * Gets or Set the pointer use natural pinch zoom to override the pinch precision
  44192. * and pinch delta percentage.
  44193. * When useNaturalPinchZoom is true, multi touch zoom will zoom in such
  44194. * that any object in the plane at the camera's target point will scale
  44195. * perfectly with finger motion.
  44196. */
  44197. get useNaturalPinchZoom(): boolean;
  44198. set useNaturalPinchZoom(value: boolean);
  44199. /**
  44200. * Gets or Set the pointer panning sensibility or how fast is the camera moving.
  44201. */
  44202. get panningSensibility(): number;
  44203. set panningSensibility(value: number);
  44204. /**
  44205. * Gets or Set the list of keyboard keys used to control beta angle in a positive direction.
  44206. */
  44207. get keysUp(): number[];
  44208. set keysUp(value: number[]);
  44209. /**
  44210. * Gets or Set the list of keyboard keys used to control beta angle in a negative direction.
  44211. */
  44212. get keysDown(): number[];
  44213. set keysDown(value: number[]);
  44214. /**
  44215. * Gets or Set the list of keyboard keys used to control alpha angle in a negative direction.
  44216. */
  44217. get keysLeft(): number[];
  44218. set keysLeft(value: number[]);
  44219. /**
  44220. * Gets or Set the list of keyboard keys used to control alpha angle in a positive direction.
  44221. */
  44222. get keysRight(): number[];
  44223. set keysRight(value: number[]);
  44224. /**
  44225. * Gets or Set the mouse wheel precision or how fast is the camera zooming.
  44226. */
  44227. get wheelPrecision(): number;
  44228. set wheelPrecision(value: number);
  44229. /**
  44230. * Gets or Set the mouse wheel delta percentage or how fast is the camera zooming.
  44231. * It will be used instead of pinchDeltaPrecision if different from 0.
  44232. * It defines the percentage of current camera.radius to use as delta when pinch zoom is used.
  44233. */
  44234. get wheelDeltaPercentage(): number;
  44235. set wheelDeltaPercentage(value: number);
  44236. /**
  44237. * Defines how much the radius should be scaled while zomming on a particular mesh (through the zoomOn function)
  44238. */
  44239. zoomOnFactor: number;
  44240. /**
  44241. * Defines a screen offset for the camera position.
  44242. */
  44243. targetScreenOffset: Vector2;
  44244. /**
  44245. * Allows the camera to be completely reversed.
  44246. * If false the camera can not arrive upside down.
  44247. */
  44248. allowUpsideDown: boolean;
  44249. /**
  44250. * Define if double tap/click is used to restore the previously saved state of the camera.
  44251. */
  44252. useInputToRestoreState: boolean;
  44253. /** @hidden */
  44254. _viewMatrix: Matrix;
  44255. /** @hidden */
  44256. _useCtrlForPanning: boolean;
  44257. /** @hidden */
  44258. _panningMouseButton: number;
  44259. /**
  44260. * Defines the input associated to the camera.
  44261. */
  44262. inputs: ArcRotateCameraInputsManager;
  44263. /** @hidden */
  44264. _reset: () => void;
  44265. /**
  44266. * Defines the allowed panning axis.
  44267. */
  44268. panningAxis: Vector3;
  44269. protected _localDirection: Vector3;
  44270. protected _transformedDirection: Vector3;
  44271. private _bouncingBehavior;
  44272. /**
  44273. * Gets the bouncing behavior of the camera if it has been enabled.
  44274. * @see https://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  44275. */
  44276. get bouncingBehavior(): Nullable<BouncingBehavior>;
  44277. /**
  44278. * Defines if the bouncing behavior of the camera is enabled on the camera.
  44279. * @see https://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  44280. */
  44281. get useBouncingBehavior(): boolean;
  44282. set useBouncingBehavior(value: boolean);
  44283. private _framingBehavior;
  44284. /**
  44285. * Gets the framing behavior of the camera if it has been enabled.
  44286. * @see https://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  44287. */
  44288. get framingBehavior(): Nullable<FramingBehavior>;
  44289. /**
  44290. * Defines if the framing behavior of the camera is enabled on the camera.
  44291. * @see https://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  44292. */
  44293. get useFramingBehavior(): boolean;
  44294. set useFramingBehavior(value: boolean);
  44295. private _autoRotationBehavior;
  44296. /**
  44297. * Gets the auto rotation behavior of the camera if it has been enabled.
  44298. * @see https://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  44299. */
  44300. get autoRotationBehavior(): Nullable<AutoRotationBehavior>;
  44301. /**
  44302. * Defines if the auto rotation behavior of the camera is enabled on the camera.
  44303. * @see https://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  44304. */
  44305. get useAutoRotationBehavior(): boolean;
  44306. set useAutoRotationBehavior(value: boolean);
  44307. /**
  44308. * Observable triggered when the mesh target has been changed on the camera.
  44309. */
  44310. onMeshTargetChangedObservable: Observable<Nullable<AbstractMesh>>;
  44311. /**
  44312. * Event raised when the camera is colliding with a mesh.
  44313. */
  44314. onCollide: (collidedMesh: AbstractMesh) => void;
  44315. /**
  44316. * Defines whether the camera should check collision with the objects oh the scene.
  44317. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#how-can-i-do-this
  44318. */
  44319. checkCollisions: boolean;
  44320. /**
  44321. * Defines the collision radius of the camera.
  44322. * This simulates a sphere around the camera.
  44323. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  44324. */
  44325. collisionRadius: Vector3;
  44326. protected _collider: Collider;
  44327. protected _previousPosition: Vector3;
  44328. protected _collisionVelocity: Vector3;
  44329. protected _newPosition: Vector3;
  44330. protected _previousAlpha: number;
  44331. protected _previousBeta: number;
  44332. protected _previousRadius: number;
  44333. protected _collisionTriggered: boolean;
  44334. protected _targetBoundingCenter: Nullable<Vector3>;
  44335. private _computationVector;
  44336. /**
  44337. * Instantiates a new ArcRotateCamera in a given scene
  44338. * @param name Defines the name of the camera
  44339. * @param alpha Defines the camera rotation along the logitudinal axis
  44340. * @param beta Defines the camera rotation along the latitudinal axis
  44341. * @param radius Defines the camera distance from its target
  44342. * @param target Defines the camera target
  44343. * @param scene Defines the scene the camera belongs to
  44344. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  44345. */
  44346. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  44347. /** @hidden */
  44348. _initCache(): void;
  44349. /** @hidden */
  44350. _updateCache(ignoreParentClass?: boolean): void;
  44351. protected _getTargetPosition(): Vector3;
  44352. private _storedAlpha;
  44353. private _storedBeta;
  44354. private _storedRadius;
  44355. private _storedTarget;
  44356. private _storedTargetScreenOffset;
  44357. /**
  44358. * Stores the current state of the camera (alpha, beta, radius and target)
  44359. * @returns the camera itself
  44360. */
  44361. storeState(): Camera;
  44362. /**
  44363. * @hidden
  44364. * Restored camera state. You must call storeState() first
  44365. */
  44366. _restoreStateValues(): boolean;
  44367. /** @hidden */
  44368. _isSynchronizedViewMatrix(): boolean;
  44369. /**
  44370. * Attached controls to the current camera.
  44371. * @param element Defines the element the controls should be listened from
  44372. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  44373. * @param useCtrlForPanning Defines whether ctrl is used for paning within the controls
  44374. * @param panningMouseButton Defines whether panning is allowed through mouse click button
  44375. */
  44376. attachControl(element: HTMLElement, noPreventDefault?: boolean, useCtrlForPanning?: boolean, panningMouseButton?: number): void;
  44377. /**
  44378. * Detach the current controls from the camera.
  44379. * The camera will stop reacting to inputs.
  44380. * @param element Defines the element to stop listening the inputs from
  44381. */
  44382. detachControl(element: HTMLElement): void;
  44383. /** @hidden */
  44384. _checkInputs(): void;
  44385. protected _checkLimits(): void;
  44386. /**
  44387. * Rebuilds angles (alpha, beta) and radius from the give position and target
  44388. */
  44389. rebuildAnglesAndRadius(): void;
  44390. /**
  44391. * Use a position to define the current camera related information like alpha, beta and radius
  44392. * @param position Defines the position to set the camera at
  44393. */
  44394. setPosition(position: Vector3): void;
  44395. /**
  44396. * Defines the target the camera should look at.
  44397. * This will automatically adapt alpha beta and radius to fit within the new target.
  44398. * @param target Defines the new target as a Vector or a mesh
  44399. * @param toBoundingCenter In case of a mesh target, defines whether to target the mesh position or its bounding information center
  44400. * @param allowSamePosition If false, prevents reapplying the new computed position if it is identical to the current one (optim)
  44401. */
  44402. setTarget(target: AbstractMesh | Vector3, toBoundingCenter?: boolean, allowSamePosition?: boolean): void;
  44403. /** @hidden */
  44404. _getViewMatrix(): Matrix;
  44405. protected _onCollisionPositionChange: (collisionId: number, newPosition: Vector3, collidedMesh?: Nullable<AbstractMesh>) => void;
  44406. /**
  44407. * Zooms on a mesh to be at the min distance where we could see it fully in the current viewport.
  44408. * @param meshes Defines the mesh to zoom on
  44409. * @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)
  44410. */
  44411. zoomOn(meshes?: AbstractMesh[], doNotUpdateMaxZ?: boolean): void;
  44412. /**
  44413. * Focus on a mesh or a bounding box. This adapts the target and maxRadius if necessary but does not update the current radius.
  44414. * The target will be changed but the radius
  44415. * @param meshesOrMinMaxVectorAndDistance Defines the mesh or bounding info to focus on
  44416. * @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)
  44417. */
  44418. focusOn(meshesOrMinMaxVectorAndDistance: AbstractMesh[] | {
  44419. min: Vector3;
  44420. max: Vector3;
  44421. distance: number;
  44422. }, doNotUpdateMaxZ?: boolean): void;
  44423. /**
  44424. * @override
  44425. * Override Camera.createRigCamera
  44426. */
  44427. createRigCamera(name: string, cameraIndex: number): Camera;
  44428. /**
  44429. * @hidden
  44430. * @override
  44431. * Override Camera._updateRigCameras
  44432. */
  44433. _updateRigCameras(): void;
  44434. /**
  44435. * Destroy the camera and release the current resources hold by it.
  44436. */
  44437. dispose(): void;
  44438. /**
  44439. * Gets the current object class name.
  44440. * @return the class name
  44441. */
  44442. getClassName(): string;
  44443. }
  44444. }
  44445. declare module "babylonjs/Behaviors/Cameras/autoRotationBehavior" {
  44446. import { Behavior } from "babylonjs/Behaviors/behavior";
  44447. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  44448. /**
  44449. * The autoRotation behavior (AutoRotationBehavior) is designed to create a smooth rotation of an ArcRotateCamera when there is no user interaction.
  44450. * @see https://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  44451. */
  44452. export class AutoRotationBehavior implements Behavior<ArcRotateCamera> {
  44453. /**
  44454. * Gets the name of the behavior.
  44455. */
  44456. get name(): string;
  44457. private _zoomStopsAnimation;
  44458. private _idleRotationSpeed;
  44459. private _idleRotationWaitTime;
  44460. private _idleRotationSpinupTime;
  44461. /**
  44462. * Sets the flag that indicates if user zooming should stop animation.
  44463. */
  44464. set zoomStopsAnimation(flag: boolean);
  44465. /**
  44466. * Gets the flag that indicates if user zooming should stop animation.
  44467. */
  44468. get zoomStopsAnimation(): boolean;
  44469. /**
  44470. * Sets the default speed at which the camera rotates around the model.
  44471. */
  44472. set idleRotationSpeed(speed: number);
  44473. /**
  44474. * Gets the default speed at which the camera rotates around the model.
  44475. */
  44476. get idleRotationSpeed(): number;
  44477. /**
  44478. * Sets the time (in milliseconds) to wait after user interaction before the camera starts rotating.
  44479. */
  44480. set idleRotationWaitTime(time: number);
  44481. /**
  44482. * Gets the time (milliseconds) to wait after user interaction before the camera starts rotating.
  44483. */
  44484. get idleRotationWaitTime(): number;
  44485. /**
  44486. * Sets the time (milliseconds) to take to spin up to the full idle rotation speed.
  44487. */
  44488. set idleRotationSpinupTime(time: number);
  44489. /**
  44490. * Gets the time (milliseconds) to take to spin up to the full idle rotation speed.
  44491. */
  44492. get idleRotationSpinupTime(): number;
  44493. /**
  44494. * Gets a value indicating if the camera is currently rotating because of this behavior
  44495. */
  44496. get rotationInProgress(): boolean;
  44497. private _onPrePointerObservableObserver;
  44498. private _onAfterCheckInputsObserver;
  44499. private _attachedCamera;
  44500. private _isPointerDown;
  44501. private _lastFrameTime;
  44502. private _lastInteractionTime;
  44503. private _cameraRotationSpeed;
  44504. /**
  44505. * Initializes the behavior.
  44506. */
  44507. init(): void;
  44508. /**
  44509. * Attaches the behavior to its arc rotate camera.
  44510. * @param camera Defines the camera to attach the behavior to
  44511. */
  44512. attach(camera: ArcRotateCamera): void;
  44513. /**
  44514. * Detaches the behavior from its current arc rotate camera.
  44515. */
  44516. detach(): void;
  44517. /**
  44518. * Returns true if user is scrolling.
  44519. * @return true if user is scrolling.
  44520. */
  44521. private _userIsZooming;
  44522. private _lastFrameRadius;
  44523. private _shouldAnimationStopForInteraction;
  44524. /**
  44525. * Applies any current user interaction to the camera. Takes into account maximum alpha rotation.
  44526. */
  44527. private _applyUserInteraction;
  44528. private _userIsMoving;
  44529. }
  44530. }
  44531. declare module "babylonjs/Behaviors/Cameras/index" {
  44532. export * from "babylonjs/Behaviors/Cameras/autoRotationBehavior";
  44533. export * from "babylonjs/Behaviors/Cameras/bouncingBehavior";
  44534. export * from "babylonjs/Behaviors/Cameras/framingBehavior";
  44535. }
  44536. declare module "babylonjs/Behaviors/Meshes/attachToBoxBehavior" {
  44537. import { Mesh } from "babylonjs/Meshes/mesh";
  44538. import { TransformNode } from "babylonjs/Meshes/transformNode";
  44539. import { Behavior } from "babylonjs/Behaviors/behavior";
  44540. /**
  44541. * A behavior that when attached to a mesh will will place a specified node on the meshes face pointing towards the camera
  44542. */
  44543. export class AttachToBoxBehavior implements Behavior<Mesh> {
  44544. private ui;
  44545. /**
  44546. * The name of the behavior
  44547. */
  44548. name: string;
  44549. /**
  44550. * The distance away from the face of the mesh that the UI should be attached to (default: 0.15)
  44551. */
  44552. distanceAwayFromFace: number;
  44553. /**
  44554. * The distance from the bottom of the face that the UI should be attached to (default: 0.15)
  44555. */
  44556. distanceAwayFromBottomOfFace: number;
  44557. private _faceVectors;
  44558. private _target;
  44559. private _scene;
  44560. private _onRenderObserver;
  44561. private _tmpMatrix;
  44562. private _tmpVector;
  44563. /**
  44564. * Creates the AttachToBoxBehavior, used to attach UI to the closest face of the box to a camera
  44565. * @param ui The transform node that should be attched to the mesh
  44566. */
  44567. constructor(ui: TransformNode);
  44568. /**
  44569. * Initializes the behavior
  44570. */
  44571. init(): void;
  44572. private _closestFace;
  44573. private _zeroVector;
  44574. private _lookAtTmpMatrix;
  44575. private _lookAtToRef;
  44576. /**
  44577. * Attaches the AttachToBoxBehavior to the passed in mesh
  44578. * @param target The mesh that the specified node will be attached to
  44579. */
  44580. attach(target: Mesh): void;
  44581. /**
  44582. * Detaches the behavior from the mesh
  44583. */
  44584. detach(): void;
  44585. }
  44586. }
  44587. declare module "babylonjs/Behaviors/Meshes/fadeInOutBehavior" {
  44588. import { Behavior } from "babylonjs/Behaviors/behavior";
  44589. import { Mesh } from "babylonjs/Meshes/mesh";
  44590. /**
  44591. * A behavior that when attached to a mesh will allow the mesh to fade in and out
  44592. */
  44593. export class FadeInOutBehavior implements Behavior<Mesh> {
  44594. /**
  44595. * Time in milliseconds to delay before fading in (Default: 0)
  44596. */
  44597. delay: number;
  44598. /**
  44599. * Time in milliseconds for the mesh to fade in (Default: 300)
  44600. */
  44601. fadeInTime: number;
  44602. private _millisecondsPerFrame;
  44603. private _hovered;
  44604. private _hoverValue;
  44605. private _ownerNode;
  44606. /**
  44607. * Instatiates the FadeInOutBehavior
  44608. */
  44609. constructor();
  44610. /**
  44611. * The name of the behavior
  44612. */
  44613. get name(): string;
  44614. /**
  44615. * Initializes the behavior
  44616. */
  44617. init(): void;
  44618. /**
  44619. * Attaches the fade behavior on the passed in mesh
  44620. * @param ownerNode The mesh that will be faded in/out once attached
  44621. */
  44622. attach(ownerNode: Mesh): void;
  44623. /**
  44624. * Detaches the behavior from the mesh
  44625. */
  44626. detach(): void;
  44627. /**
  44628. * Triggers the mesh to begin fading in or out
  44629. * @param value if the object should fade in or out (true to fade in)
  44630. */
  44631. fadeIn(value: boolean): void;
  44632. private _update;
  44633. private _setAllVisibility;
  44634. }
  44635. }
  44636. declare module "babylonjs/Misc/pivotTools" {
  44637. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  44638. /**
  44639. * Class containing a set of static utilities functions for managing Pivots
  44640. * @hidden
  44641. */
  44642. export class PivotTools {
  44643. private static _PivotCached;
  44644. private static _OldPivotPoint;
  44645. private static _PivotTranslation;
  44646. private static _PivotTmpVector;
  44647. /** @hidden */
  44648. static _RemoveAndStorePivotPoint(mesh: AbstractMesh): void;
  44649. /** @hidden */
  44650. static _RestorePivotPoint(mesh: AbstractMesh): void;
  44651. }
  44652. }
  44653. declare module "babylonjs/Meshes/Builders/planeBuilder" {
  44654. import { Scene } from "babylonjs/scene";
  44655. import { Vector4 } from "babylonjs/Maths/math.vector";
  44656. import { Mesh } from "babylonjs/Meshes/mesh";
  44657. import { Nullable } from "babylonjs/types";
  44658. import { Plane } from "babylonjs/Maths/math.plane";
  44659. /**
  44660. * Class containing static functions to help procedurally build meshes
  44661. */
  44662. export class PlaneBuilder {
  44663. /**
  44664. * Creates a plane mesh
  44665. * * The parameter `size` sets the size (float) of both sides of the plane at once (default 1)
  44666. * * You can set some different plane dimensions by using the parameters `width` and `height` (both by default have the same value of `size`)
  44667. * * The parameter `sourcePlane` is a Plane instance. It builds a mesh plane from a Math plane
  44668. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  44669. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  44670. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  44671. * @param name defines the name of the mesh
  44672. * @param options defines the options used to create the mesh
  44673. * @param scene defines the hosting scene
  44674. * @returns the plane mesh
  44675. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  44676. */
  44677. static CreatePlane(name: string, options: {
  44678. size?: number;
  44679. width?: number;
  44680. height?: number;
  44681. sideOrientation?: number;
  44682. frontUVs?: Vector4;
  44683. backUVs?: Vector4;
  44684. updatable?: boolean;
  44685. sourcePlane?: Plane;
  44686. }, scene?: Nullable<Scene>): Mesh;
  44687. }
  44688. }
  44689. declare module "babylonjs/Behaviors/Meshes/pointerDragBehavior" {
  44690. import { Behavior } from "babylonjs/Behaviors/behavior";
  44691. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  44692. import { Observable } from "babylonjs/Misc/observable";
  44693. import { Vector3 } from "babylonjs/Maths/math.vector";
  44694. import { Ray } from "babylonjs/Culling/ray";
  44695. import "babylonjs/Meshes/Builders/planeBuilder";
  44696. /**
  44697. * A behavior that when attached to a mesh will allow the mesh to be dragged around the screen based on pointer events
  44698. */
  44699. export class PointerDragBehavior implements Behavior<AbstractMesh> {
  44700. private static _AnyMouseID;
  44701. /**
  44702. * Abstract mesh the behavior is set on
  44703. */
  44704. attachedNode: AbstractMesh;
  44705. private _dragPlane;
  44706. private _scene;
  44707. private _pointerObserver;
  44708. private _beforeRenderObserver;
  44709. private static _planeScene;
  44710. private _useAlternatePickedPointAboveMaxDragAngleDragSpeed;
  44711. /**
  44712. * 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)
  44713. */
  44714. maxDragAngle: number;
  44715. /**
  44716. * @hidden
  44717. */
  44718. _useAlternatePickedPointAboveMaxDragAngle: boolean;
  44719. /**
  44720. * The id of the pointer that is currently interacting with the behavior (-1 when no pointer is active)
  44721. */
  44722. currentDraggingPointerID: number;
  44723. /**
  44724. * The last position where the pointer hit the drag plane in world space
  44725. */
  44726. lastDragPosition: Vector3;
  44727. /**
  44728. * If the behavior is currently in a dragging state
  44729. */
  44730. dragging: boolean;
  44731. /**
  44732. * 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)
  44733. */
  44734. dragDeltaRatio: number;
  44735. /**
  44736. * If the drag plane orientation should be updated during the dragging (Default: true)
  44737. */
  44738. updateDragPlane: boolean;
  44739. private _debugMode;
  44740. private _moving;
  44741. /**
  44742. * Fires each time the attached mesh is dragged with the pointer
  44743. * * delta between last drag position and current drag position in world space
  44744. * * dragDistance along the drag axis
  44745. * * dragPlaneNormal normal of the current drag plane used during the drag
  44746. * * dragPlanePoint in world space where the drag intersects the drag plane
  44747. */
  44748. onDragObservable: Observable<{
  44749. delta: Vector3;
  44750. dragPlanePoint: Vector3;
  44751. dragPlaneNormal: Vector3;
  44752. dragDistance: number;
  44753. pointerId: number;
  44754. }>;
  44755. /**
  44756. * Fires each time a drag begins (eg. mouse down on mesh)
  44757. */
  44758. onDragStartObservable: Observable<{
  44759. dragPlanePoint: Vector3;
  44760. pointerId: number;
  44761. }>;
  44762. /**
  44763. * Fires each time a drag ends (eg. mouse release after drag)
  44764. */
  44765. onDragEndObservable: Observable<{
  44766. dragPlanePoint: Vector3;
  44767. pointerId: number;
  44768. }>;
  44769. /**
  44770. * If the attached mesh should be moved when dragged
  44771. */
  44772. moveAttached: boolean;
  44773. /**
  44774. * If the drag behavior will react to drag events (Default: true)
  44775. */
  44776. enabled: boolean;
  44777. /**
  44778. * If pointer events should start and release the drag (Default: true)
  44779. */
  44780. startAndReleaseDragOnPointerEvents: boolean;
  44781. /**
  44782. * If camera controls should be detached during the drag
  44783. */
  44784. detachCameraControls: boolean;
  44785. /**
  44786. * If set, the drag plane/axis will be rotated based on the attached mesh's world rotation (Default: true)
  44787. */
  44788. useObjectOrientationForDragging: boolean;
  44789. private _options;
  44790. /**
  44791. * Gets the options used by the behavior
  44792. */
  44793. get options(): {
  44794. dragAxis?: Vector3;
  44795. dragPlaneNormal?: Vector3;
  44796. };
  44797. /**
  44798. * Sets the options used by the behavior
  44799. */
  44800. set options(options: {
  44801. dragAxis?: Vector3;
  44802. dragPlaneNormal?: Vector3;
  44803. });
  44804. /**
  44805. * Creates a pointer drag behavior that can be attached to a mesh
  44806. * @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)
  44807. */
  44808. constructor(options?: {
  44809. dragAxis?: Vector3;
  44810. dragPlaneNormal?: Vector3;
  44811. });
  44812. /**
  44813. * Predicate to determine if it is valid to move the object to a new position when it is moved
  44814. */
  44815. validateDrag: (targetPosition: Vector3) => boolean;
  44816. /**
  44817. * The name of the behavior
  44818. */
  44819. get name(): string;
  44820. /**
  44821. * Initializes the behavior
  44822. */
  44823. init(): void;
  44824. private _tmpVector;
  44825. private _alternatePickedPoint;
  44826. private _worldDragAxis;
  44827. private _targetPosition;
  44828. private _attachedElement;
  44829. /**
  44830. * Attaches the drag behavior the passed in mesh
  44831. * @param ownerNode The mesh that will be dragged around once attached
  44832. * @param predicate Predicate to use for pick filtering
  44833. */
  44834. attach(ownerNode: AbstractMesh, predicate?: (m: AbstractMesh) => boolean): void;
  44835. /**
  44836. * Force relase the drag action by code.
  44837. */
  44838. releaseDrag(): void;
  44839. private _startDragRay;
  44840. private _lastPointerRay;
  44841. /**
  44842. * Simulates the start of a pointer drag event on the behavior
  44843. * @param pointerId pointerID of the pointer that should be simulated (Default: Any mouse pointer ID)
  44844. * @param fromRay initial ray of the pointer to be simulated (Default: Ray from camera to attached mesh)
  44845. * @param startPickedPoint picked point of the pointer to be simulated (Default: attached mesh position)
  44846. */
  44847. startDrag(pointerId?: number, fromRay?: Ray, startPickedPoint?: Vector3): void;
  44848. private _startDrag;
  44849. private _dragDelta;
  44850. private _moveDrag;
  44851. private _pickWithRayOnDragPlane;
  44852. private _pointA;
  44853. private _pointC;
  44854. private _localAxis;
  44855. private _lookAt;
  44856. private _updateDragPlanePosition;
  44857. /**
  44858. * Detaches the behavior from the mesh
  44859. */
  44860. detach(): void;
  44861. }
  44862. }
  44863. declare module "babylonjs/Behaviors/Meshes/multiPointerScaleBehavior" {
  44864. import { Mesh } from "babylonjs/Meshes/mesh";
  44865. import { Behavior } from "babylonjs/Behaviors/behavior";
  44866. /**
  44867. * A behavior that when attached to a mesh will allow the mesh to be scaled
  44868. */
  44869. export class MultiPointerScaleBehavior implements Behavior<Mesh> {
  44870. private _dragBehaviorA;
  44871. private _dragBehaviorB;
  44872. private _startDistance;
  44873. private _initialScale;
  44874. private _targetScale;
  44875. private _ownerNode;
  44876. private _sceneRenderObserver;
  44877. /**
  44878. * Instantiate a new behavior that when attached to a mesh will allow the mesh to be scaled
  44879. */
  44880. constructor();
  44881. /**
  44882. * The name of the behavior
  44883. */
  44884. get name(): string;
  44885. /**
  44886. * Initializes the behavior
  44887. */
  44888. init(): void;
  44889. private _getCurrentDistance;
  44890. /**
  44891. * Attaches the scale behavior the passed in mesh
  44892. * @param ownerNode The mesh that will be scaled around once attached
  44893. */
  44894. attach(ownerNode: Mesh): void;
  44895. /**
  44896. * Detaches the behavior from the mesh
  44897. */
  44898. detach(): void;
  44899. }
  44900. }
  44901. declare module "babylonjs/Behaviors/Meshes/sixDofDragBehavior" {
  44902. import { Behavior } from "babylonjs/Behaviors/behavior";
  44903. import { Mesh } from "babylonjs/Meshes/mesh";
  44904. import { Observable } from "babylonjs/Misc/observable";
  44905. /**
  44906. * 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
  44907. */
  44908. export class SixDofDragBehavior implements Behavior<Mesh> {
  44909. private static _virtualScene;
  44910. private _ownerNode;
  44911. private _sceneRenderObserver;
  44912. private _scene;
  44913. private _targetPosition;
  44914. private _virtualOriginMesh;
  44915. private _virtualDragMesh;
  44916. private _pointerObserver;
  44917. private _moving;
  44918. private _startingOrientation;
  44919. private _attachedElement;
  44920. /**
  44921. * 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)
  44922. */
  44923. private zDragFactor;
  44924. /**
  44925. * If the object should rotate to face the drag origin
  44926. */
  44927. rotateDraggedObject: boolean;
  44928. /**
  44929. * If the behavior is currently in a dragging state
  44930. */
  44931. dragging: boolean;
  44932. /**
  44933. * 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)
  44934. */
  44935. dragDeltaRatio: number;
  44936. /**
  44937. * The id of the pointer that is currently interacting with the behavior (-1 when no pointer is active)
  44938. */
  44939. currentDraggingPointerID: number;
  44940. /**
  44941. * If camera controls should be detached during the drag
  44942. */
  44943. detachCameraControls: boolean;
  44944. /**
  44945. * Fires each time a drag starts
  44946. */
  44947. onDragStartObservable: Observable<{}>;
  44948. /**
  44949. * Fires each time a drag ends (eg. mouse release after drag)
  44950. */
  44951. onDragEndObservable: Observable<{}>;
  44952. /**
  44953. * 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
  44954. */
  44955. constructor();
  44956. /**
  44957. * The name of the behavior
  44958. */
  44959. get name(): string;
  44960. /**
  44961. * Initializes the behavior
  44962. */
  44963. init(): void;
  44964. /**
  44965. * In the case of multiplea active cameras, the cameraToUseForPointers should be used if set instead of active camera
  44966. */
  44967. private get _pointerCamera();
  44968. /**
  44969. * Attaches the scale behavior the passed in mesh
  44970. * @param ownerNode The mesh that will be scaled around once attached
  44971. */
  44972. attach(ownerNode: Mesh): void;
  44973. /**
  44974. * Detaches the behavior from the mesh
  44975. */
  44976. detach(): void;
  44977. }
  44978. }
  44979. declare module "babylonjs/Behaviors/Meshes/index" {
  44980. export * from "babylonjs/Behaviors/Meshes/attachToBoxBehavior";
  44981. export * from "babylonjs/Behaviors/Meshes/fadeInOutBehavior";
  44982. export * from "babylonjs/Behaviors/Meshes/multiPointerScaleBehavior";
  44983. export * from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  44984. export * from "babylonjs/Behaviors/Meshes/sixDofDragBehavior";
  44985. }
  44986. declare module "babylonjs/Behaviors/index" {
  44987. export * from "babylonjs/Behaviors/behavior";
  44988. export * from "babylonjs/Behaviors/Cameras/index";
  44989. export * from "babylonjs/Behaviors/Meshes/index";
  44990. }
  44991. declare module "babylonjs/Bones/boneIKController" {
  44992. import { Bone } from "babylonjs/Bones/bone";
  44993. import { Vector3 } from "babylonjs/Maths/math.vector";
  44994. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  44995. import { Nullable } from "babylonjs/types";
  44996. /**
  44997. * Class used to apply inverse kinematics to bones
  44998. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons#boneikcontroller
  44999. */
  45000. export class BoneIKController {
  45001. private static _tmpVecs;
  45002. private static _tmpQuat;
  45003. private static _tmpMats;
  45004. /**
  45005. * Gets or sets the target mesh
  45006. */
  45007. targetMesh: AbstractMesh;
  45008. /** Gets or sets the mesh used as pole */
  45009. poleTargetMesh: AbstractMesh;
  45010. /**
  45011. * Gets or sets the bone used as pole
  45012. */
  45013. poleTargetBone: Nullable<Bone>;
  45014. /**
  45015. * Gets or sets the target position
  45016. */
  45017. targetPosition: Vector3;
  45018. /**
  45019. * Gets or sets the pole target position
  45020. */
  45021. poleTargetPosition: Vector3;
  45022. /**
  45023. * Gets or sets the pole target local offset
  45024. */
  45025. poleTargetLocalOffset: Vector3;
  45026. /**
  45027. * Gets or sets the pole angle
  45028. */
  45029. poleAngle: number;
  45030. /**
  45031. * Gets or sets the mesh associated with the controller
  45032. */
  45033. mesh: AbstractMesh;
  45034. /**
  45035. * 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)
  45036. */
  45037. slerpAmount: number;
  45038. private _bone1Quat;
  45039. private _bone1Mat;
  45040. private _bone2Ang;
  45041. private _bone1;
  45042. private _bone2;
  45043. private _bone1Length;
  45044. private _bone2Length;
  45045. private _maxAngle;
  45046. private _maxReach;
  45047. private _rightHandedSystem;
  45048. private _bendAxis;
  45049. private _slerping;
  45050. private _adjustRoll;
  45051. /**
  45052. * Gets or sets maximum allowed angle
  45053. */
  45054. get maxAngle(): number;
  45055. set maxAngle(value: number);
  45056. /**
  45057. * Creates a new BoneIKController
  45058. * @param mesh defines the mesh to control
  45059. * @param bone defines the bone to control
  45060. * @param options defines options to set up the controller
  45061. */
  45062. constructor(mesh: AbstractMesh, bone: Bone, options?: {
  45063. targetMesh?: AbstractMesh;
  45064. poleTargetMesh?: AbstractMesh;
  45065. poleTargetBone?: Bone;
  45066. poleTargetLocalOffset?: Vector3;
  45067. poleAngle?: number;
  45068. bendAxis?: Vector3;
  45069. maxAngle?: number;
  45070. slerpAmount?: number;
  45071. });
  45072. private _setMaxAngle;
  45073. /**
  45074. * Force the controller to update the bones
  45075. */
  45076. update(): void;
  45077. }
  45078. }
  45079. declare module "babylonjs/Bones/boneLookController" {
  45080. import { Vector3 } from "babylonjs/Maths/math.vector";
  45081. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  45082. import { Bone } from "babylonjs/Bones/bone";
  45083. import { Space } from "babylonjs/Maths/math.axis";
  45084. /**
  45085. * Class used to make a bone look toward a point in space
  45086. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons#bonelookcontroller
  45087. */
  45088. export class BoneLookController {
  45089. private static _tmpVecs;
  45090. private static _tmpQuat;
  45091. private static _tmpMats;
  45092. /**
  45093. * The target Vector3 that the bone will look at
  45094. */
  45095. target: Vector3;
  45096. /**
  45097. * The mesh that the bone is attached to
  45098. */
  45099. mesh: AbstractMesh;
  45100. /**
  45101. * The bone that will be looking to the target
  45102. */
  45103. bone: Bone;
  45104. /**
  45105. * The up axis of the coordinate system that is used when the bone is rotated
  45106. */
  45107. upAxis: Vector3;
  45108. /**
  45109. * The space that the up axis is in - Space.BONE, Space.LOCAL (default), or Space.WORLD
  45110. */
  45111. upAxisSpace: Space;
  45112. /**
  45113. * Used to make an adjustment to the yaw of the bone
  45114. */
  45115. adjustYaw: number;
  45116. /**
  45117. * Used to make an adjustment to the pitch of the bone
  45118. */
  45119. adjustPitch: number;
  45120. /**
  45121. * Used to make an adjustment to the roll of the bone
  45122. */
  45123. adjustRoll: number;
  45124. /**
  45125. * 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)
  45126. */
  45127. slerpAmount: number;
  45128. private _minYaw;
  45129. private _maxYaw;
  45130. private _minPitch;
  45131. private _maxPitch;
  45132. private _minYawSin;
  45133. private _minYawCos;
  45134. private _maxYawSin;
  45135. private _maxYawCos;
  45136. private _midYawConstraint;
  45137. private _minPitchTan;
  45138. private _maxPitchTan;
  45139. private _boneQuat;
  45140. private _slerping;
  45141. private _transformYawPitch;
  45142. private _transformYawPitchInv;
  45143. private _firstFrameSkipped;
  45144. private _yawRange;
  45145. private _fowardAxis;
  45146. /**
  45147. * Gets or sets the minimum yaw angle that the bone can look to
  45148. */
  45149. get minYaw(): number;
  45150. set minYaw(value: number);
  45151. /**
  45152. * Gets or sets the maximum yaw angle that the bone can look to
  45153. */
  45154. get maxYaw(): number;
  45155. set maxYaw(value: number);
  45156. /**
  45157. * Gets or sets the minimum pitch angle that the bone can look to
  45158. */
  45159. get minPitch(): number;
  45160. set minPitch(value: number);
  45161. /**
  45162. * Gets or sets the maximum pitch angle that the bone can look to
  45163. */
  45164. get maxPitch(): number;
  45165. set maxPitch(value: number);
  45166. /**
  45167. * Create a BoneLookController
  45168. * @param mesh the mesh that the bone belongs to
  45169. * @param bone the bone that will be looking to the target
  45170. * @param target the target Vector3 to look at
  45171. * @param options optional settings:
  45172. * * maxYaw: the maximum angle the bone will yaw to
  45173. * * minYaw: the minimum angle the bone will yaw to
  45174. * * maxPitch: the maximum angle the bone will pitch to
  45175. * * minPitch: the minimum angle the bone will yaw to
  45176. * * slerpAmount: set the between 0 and 1 to make the bone slerp to the target.
  45177. * * upAxis: the up axis of the coordinate system
  45178. * * upAxisSpace: the space that the up axis is in - Space.BONE, Space.LOCAL (default), or Space.WORLD.
  45179. * * yawAxis: set yawAxis if the bone does not yaw on the y axis
  45180. * * pitchAxis: set pitchAxis if the bone does not pitch on the x axis
  45181. * * adjustYaw: used to make an adjustment to the yaw of the bone
  45182. * * adjustPitch: used to make an adjustment to the pitch of the bone
  45183. * * adjustRoll: used to make an adjustment to the roll of the bone
  45184. **/
  45185. constructor(mesh: AbstractMesh, bone: Bone, target: Vector3, options?: {
  45186. maxYaw?: number;
  45187. minYaw?: number;
  45188. maxPitch?: number;
  45189. minPitch?: number;
  45190. slerpAmount?: number;
  45191. upAxis?: Vector3;
  45192. upAxisSpace?: Space;
  45193. yawAxis?: Vector3;
  45194. pitchAxis?: Vector3;
  45195. adjustYaw?: number;
  45196. adjustPitch?: number;
  45197. adjustRoll?: number;
  45198. });
  45199. /**
  45200. * Update the bone to look at the target. This should be called before the scene is rendered (use scene.registerBeforeRender())
  45201. */
  45202. update(): void;
  45203. private _getAngleDiff;
  45204. private _getAngleBetween;
  45205. private _isAngleBetween;
  45206. }
  45207. }
  45208. declare module "babylonjs/Bones/index" {
  45209. export * from "babylonjs/Bones/bone";
  45210. export * from "babylonjs/Bones/boneIKController";
  45211. export * from "babylonjs/Bones/boneLookController";
  45212. export * from "babylonjs/Bones/skeleton";
  45213. }
  45214. declare module "babylonjs/Cameras/Inputs/arcRotateCameraGamepadInput" {
  45215. import { Nullable } from "babylonjs/types";
  45216. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  45217. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  45218. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  45219. /**
  45220. * Manage the gamepad inputs to control an arc rotate camera.
  45221. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  45222. */
  45223. export class ArcRotateCameraGamepadInput implements ICameraInput<ArcRotateCamera> {
  45224. /**
  45225. * Defines the camera the input is attached to.
  45226. */
  45227. camera: ArcRotateCamera;
  45228. /**
  45229. * Defines the gamepad the input is gathering event from.
  45230. */
  45231. gamepad: Nullable<Gamepad>;
  45232. /**
  45233. * Defines the gamepad rotation sensiblity.
  45234. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  45235. */
  45236. gamepadRotationSensibility: number;
  45237. /**
  45238. * Defines the gamepad move sensiblity.
  45239. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  45240. */
  45241. gamepadMoveSensibility: number;
  45242. private _yAxisScale;
  45243. /**
  45244. * Gets or sets a boolean indicating that Yaxis (for right stick) should be inverted
  45245. */
  45246. get invertYAxis(): boolean;
  45247. set invertYAxis(value: boolean);
  45248. private _onGamepadConnectedObserver;
  45249. private _onGamepadDisconnectedObserver;
  45250. /**
  45251. * Attach the input controls to a specific dom element to get the input from.
  45252. * @param element Defines the element the controls should be listened from
  45253. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  45254. */
  45255. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  45256. /**
  45257. * Detach the current controls from the specified dom element.
  45258. * @param element Defines the element to stop listening the inputs from
  45259. */
  45260. detachControl(element: Nullable<HTMLElement>): void;
  45261. /**
  45262. * Update the current camera state depending on the inputs that have been used this frame.
  45263. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  45264. */
  45265. checkInputs(): void;
  45266. /**
  45267. * Gets the class name of the current intput.
  45268. * @returns the class name
  45269. */
  45270. getClassName(): string;
  45271. /**
  45272. * Get the friendly name associated with the input class.
  45273. * @returns the input friendly name
  45274. */
  45275. getSimpleName(): string;
  45276. }
  45277. }
  45278. declare module "babylonjs/Cameras/Inputs/arcRotateCameraVRDeviceOrientationInput" {
  45279. import { Nullable } from "babylonjs/types";
  45280. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  45281. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  45282. module "babylonjs/Cameras/arcRotateCameraInputsManager" {
  45283. interface ArcRotateCameraInputsManager {
  45284. /**
  45285. * Add orientation input support to the input manager.
  45286. * @returns the current input manager
  45287. */
  45288. addVRDeviceOrientation(): ArcRotateCameraInputsManager;
  45289. }
  45290. }
  45291. /**
  45292. * Manage the device orientation inputs (gyroscope) to control an arc rotate camera.
  45293. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  45294. */
  45295. export class ArcRotateCameraVRDeviceOrientationInput implements ICameraInput<ArcRotateCamera> {
  45296. /**
  45297. * Defines the camera the input is attached to.
  45298. */
  45299. camera: ArcRotateCamera;
  45300. /**
  45301. * Defines a correction factor applied on the alpha value retrieved from the orientation events.
  45302. */
  45303. alphaCorrection: number;
  45304. /**
  45305. * Defines a correction factor applied on the gamma value retrieved from the orientation events.
  45306. */
  45307. gammaCorrection: number;
  45308. private _alpha;
  45309. private _gamma;
  45310. private _dirty;
  45311. private _deviceOrientationHandler;
  45312. /**
  45313. * Instantiate a new ArcRotateCameraVRDeviceOrientationInput.
  45314. */
  45315. constructor();
  45316. /**
  45317. * Attach the input controls to a specific dom element to get the input from.
  45318. * @param element Defines the element the controls should be listened from
  45319. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  45320. */
  45321. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  45322. /** @hidden */
  45323. _onOrientationEvent(evt: DeviceOrientationEvent): void;
  45324. /**
  45325. * Update the current camera state depending on the inputs that have been used this frame.
  45326. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  45327. */
  45328. checkInputs(): void;
  45329. /**
  45330. * Detach the current controls from the specified dom element.
  45331. * @param element Defines the element to stop listening the inputs from
  45332. */
  45333. detachControl(element: Nullable<HTMLElement>): void;
  45334. /**
  45335. * Gets the class name of the current intput.
  45336. * @returns the class name
  45337. */
  45338. getClassName(): string;
  45339. /**
  45340. * Get the friendly name associated with the input class.
  45341. * @returns the input friendly name
  45342. */
  45343. getSimpleName(): string;
  45344. }
  45345. }
  45346. declare module "babylonjs/Cameras/Inputs/flyCameraMouseInput" {
  45347. import { Nullable } from "babylonjs/types";
  45348. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  45349. import { FlyCamera } from "babylonjs/Cameras/flyCamera";
  45350. /**
  45351. * Listen to mouse events to control the camera.
  45352. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  45353. */
  45354. export class FlyCameraMouseInput implements ICameraInput<FlyCamera> {
  45355. /**
  45356. * Defines the camera the input is attached to.
  45357. */
  45358. camera: FlyCamera;
  45359. /**
  45360. * Defines if touch is enabled. (Default is true.)
  45361. */
  45362. touchEnabled: boolean;
  45363. /**
  45364. * Defines the buttons associated with the input to handle camera rotation.
  45365. */
  45366. buttons: number[];
  45367. /**
  45368. * Assign buttons for Yaw control.
  45369. */
  45370. buttonsYaw: number[];
  45371. /**
  45372. * Assign buttons for Pitch control.
  45373. */
  45374. buttonsPitch: number[];
  45375. /**
  45376. * Assign buttons for Roll control.
  45377. */
  45378. buttonsRoll: number[];
  45379. /**
  45380. * Detect if any button is being pressed while mouse is moved.
  45381. * -1 = Mouse locked.
  45382. * 0 = Left button.
  45383. * 1 = Middle Button.
  45384. * 2 = Right Button.
  45385. */
  45386. activeButton: number;
  45387. /**
  45388. * Defines the pointer's angular sensibility, to control the camera rotation speed.
  45389. * Higher values reduce its sensitivity.
  45390. */
  45391. angularSensibility: number;
  45392. private _mousemoveCallback;
  45393. private _observer;
  45394. private _rollObserver;
  45395. private previousPosition;
  45396. private noPreventDefault;
  45397. private element;
  45398. /**
  45399. * Listen to mouse events to control the camera.
  45400. * @param touchEnabled Define if touch is enabled. (Default is true.)
  45401. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  45402. */
  45403. constructor(touchEnabled?: boolean);
  45404. /**
  45405. * Attach the mouse control to the HTML DOM element.
  45406. * @param element Defines the element that listens to the input events.
  45407. * @param noPreventDefault Defines whether events caught by the controls should call preventdefault().
  45408. */
  45409. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  45410. /**
  45411. * Detach the current controls from the specified dom element.
  45412. * @param element Defines the element to stop listening the inputs from
  45413. */
  45414. detachControl(element: Nullable<HTMLElement>): void;
  45415. /**
  45416. * Gets the class name of the current input.
  45417. * @returns the class name.
  45418. */
  45419. getClassName(): string;
  45420. /**
  45421. * Get the friendly name associated with the input class.
  45422. * @returns the input's friendly name.
  45423. */
  45424. getSimpleName(): string;
  45425. private _pointerInput;
  45426. private _onMouseMove;
  45427. /**
  45428. * Rotate camera by mouse offset.
  45429. */
  45430. private rotateCamera;
  45431. }
  45432. }
  45433. declare module "babylonjs/Cameras/flyCameraInputsManager" {
  45434. import { FlyCamera } from "babylonjs/Cameras/flyCamera";
  45435. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  45436. /**
  45437. * Default Inputs manager for the FlyCamera.
  45438. * It groups all the default supported inputs for ease of use.
  45439. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  45440. */
  45441. export class FlyCameraInputsManager extends CameraInputsManager<FlyCamera> {
  45442. /**
  45443. * Instantiates a new FlyCameraInputsManager.
  45444. * @param camera Defines the camera the inputs belong to.
  45445. */
  45446. constructor(camera: FlyCamera);
  45447. /**
  45448. * Add keyboard input support to the input manager.
  45449. * @returns the new FlyCameraKeyboardMoveInput().
  45450. */
  45451. addKeyboard(): FlyCameraInputsManager;
  45452. /**
  45453. * Add mouse input support to the input manager.
  45454. * @param touchEnabled Enable touch screen support.
  45455. * @returns the new FlyCameraMouseInput().
  45456. */
  45457. addMouse(touchEnabled?: boolean): FlyCameraInputsManager;
  45458. }
  45459. }
  45460. declare module "babylonjs/Cameras/flyCamera" {
  45461. import { Scene } from "babylonjs/scene";
  45462. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  45463. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  45464. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  45465. import { FlyCameraInputsManager } from "babylonjs/Cameras/flyCameraInputsManager";
  45466. /**
  45467. * This is a flying camera, designed for 3D movement and rotation in all directions,
  45468. * such as in a 3D Space Shooter or a Flight Simulator.
  45469. */
  45470. export class FlyCamera extends TargetCamera {
  45471. /**
  45472. * Define the collision ellipsoid of the camera.
  45473. * This is helpful for simulating a camera body, like a player's body.
  45474. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  45475. */
  45476. ellipsoid: Vector3;
  45477. /**
  45478. * Define an offset for the position of the ellipsoid around the camera.
  45479. * This can be helpful if the camera is attached away from the player's body center,
  45480. * such as at its head.
  45481. */
  45482. ellipsoidOffset: Vector3;
  45483. /**
  45484. * Enable or disable collisions of the camera with the rest of the scene objects.
  45485. */
  45486. checkCollisions: boolean;
  45487. /**
  45488. * Enable or disable gravity on the camera.
  45489. */
  45490. applyGravity: boolean;
  45491. /**
  45492. * Define the current direction the camera is moving to.
  45493. */
  45494. cameraDirection: Vector3;
  45495. /**
  45496. * Define the current local rotation of the camera as a quaternion to prevent Gimbal lock.
  45497. * This overrides and empties cameraRotation.
  45498. */
  45499. rotationQuaternion: Quaternion;
  45500. /**
  45501. * Track Roll to maintain the wanted Rolling when looking around.
  45502. */
  45503. _trackRoll: number;
  45504. /**
  45505. * Slowly correct the Roll to its original value after a Pitch+Yaw rotation.
  45506. */
  45507. rollCorrect: number;
  45508. /**
  45509. * Mimic a banked turn, Rolling the camera when Yawing.
  45510. * It's recommended to use rollCorrect = 10 for faster banking correction.
  45511. */
  45512. bankedTurn: boolean;
  45513. /**
  45514. * Limit in radians for how much Roll banking will add. (Default: 90°)
  45515. */
  45516. bankedTurnLimit: number;
  45517. /**
  45518. * Value of 0 disables the banked Roll.
  45519. * Value of 1 is equal to the Yaw angle in radians.
  45520. */
  45521. bankedTurnMultiplier: number;
  45522. /**
  45523. * The inputs manager loads all the input sources, such as keyboard and mouse.
  45524. */
  45525. inputs: FlyCameraInputsManager;
  45526. /**
  45527. * Gets the input sensibility for mouse input.
  45528. * Higher values reduce sensitivity.
  45529. */
  45530. get angularSensibility(): number;
  45531. /**
  45532. * Sets the input sensibility for a mouse input.
  45533. * Higher values reduce sensitivity.
  45534. */
  45535. set angularSensibility(value: number);
  45536. /**
  45537. * Get the keys for camera movement forward.
  45538. */
  45539. get keysForward(): number[];
  45540. /**
  45541. * Set the keys for camera movement forward.
  45542. */
  45543. set keysForward(value: number[]);
  45544. /**
  45545. * Get the keys for camera movement backward.
  45546. */
  45547. get keysBackward(): number[];
  45548. set keysBackward(value: number[]);
  45549. /**
  45550. * Get the keys for camera movement up.
  45551. */
  45552. get keysUp(): number[];
  45553. /**
  45554. * Set the keys for camera movement up.
  45555. */
  45556. set keysUp(value: number[]);
  45557. /**
  45558. * Get the keys for camera movement down.
  45559. */
  45560. get keysDown(): number[];
  45561. /**
  45562. * Set the keys for camera movement down.
  45563. */
  45564. set keysDown(value: number[]);
  45565. /**
  45566. * Get the keys for camera movement left.
  45567. */
  45568. get keysLeft(): number[];
  45569. /**
  45570. * Set the keys for camera movement left.
  45571. */
  45572. set keysLeft(value: number[]);
  45573. /**
  45574. * Set the keys for camera movement right.
  45575. */
  45576. get keysRight(): number[];
  45577. /**
  45578. * Set the keys for camera movement right.
  45579. */
  45580. set keysRight(value: number[]);
  45581. /**
  45582. * Event raised when the camera collides with a mesh in the scene.
  45583. */
  45584. onCollide: (collidedMesh: AbstractMesh) => void;
  45585. private _collider;
  45586. private _needMoveForGravity;
  45587. private _oldPosition;
  45588. private _diffPosition;
  45589. private _newPosition;
  45590. /** @hidden */
  45591. _localDirection: Vector3;
  45592. /** @hidden */
  45593. _transformedDirection: Vector3;
  45594. /**
  45595. * Instantiates a FlyCamera.
  45596. * This is a flying camera, designed for 3D movement and rotation in all directions,
  45597. * such as in a 3D Space Shooter or a Flight Simulator.
  45598. * @param name Define the name of the camera in the scene.
  45599. * @param position Define the starting position of the camera in the scene.
  45600. * @param scene Define the scene the camera belongs to.
  45601. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active, if no other camera has been defined as active.
  45602. */
  45603. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  45604. /**
  45605. * Attach a control to the HTML DOM element.
  45606. * @param element Defines the element that listens to the input events.
  45607. * @param noPreventDefault Defines whether events caught by the controls should call preventdefault(). https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault
  45608. */
  45609. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  45610. /**
  45611. * Detach a control from the HTML DOM element.
  45612. * The camera will stop reacting to that input.
  45613. * @param element Defines the element that listens to the input events.
  45614. */
  45615. detachControl(element: HTMLElement): void;
  45616. private _collisionMask;
  45617. /**
  45618. * Get the mask that the camera ignores in collision events.
  45619. */
  45620. get collisionMask(): number;
  45621. /**
  45622. * Set the mask that the camera ignores in collision events.
  45623. */
  45624. set collisionMask(mask: number);
  45625. /** @hidden */
  45626. _collideWithWorld(displacement: Vector3): void;
  45627. /** @hidden */
  45628. private _onCollisionPositionChange;
  45629. /** @hidden */
  45630. _checkInputs(): void;
  45631. /** @hidden */
  45632. _decideIfNeedsToMove(): boolean;
  45633. /** @hidden */
  45634. _updatePosition(): void;
  45635. /**
  45636. * Restore the Roll to its target value at the rate specified.
  45637. * @param rate - Higher means slower restoring.
  45638. * @hidden
  45639. */
  45640. restoreRoll(rate: number): void;
  45641. /**
  45642. * Destroy the camera and release the current resources held by it.
  45643. */
  45644. dispose(): void;
  45645. /**
  45646. * Get the current object class name.
  45647. * @returns the class name.
  45648. */
  45649. getClassName(): string;
  45650. }
  45651. }
  45652. declare module "babylonjs/Cameras/Inputs/flyCameraKeyboardInput" {
  45653. import { Nullable } from "babylonjs/types";
  45654. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  45655. import { FlyCamera } from "babylonjs/Cameras/flyCamera";
  45656. /**
  45657. * Listen to keyboard events to control the camera.
  45658. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  45659. */
  45660. export class FlyCameraKeyboardInput implements ICameraInput<FlyCamera> {
  45661. /**
  45662. * Defines the camera the input is attached to.
  45663. */
  45664. camera: FlyCamera;
  45665. /**
  45666. * The list of keyboard keys used to control the forward move of the camera.
  45667. */
  45668. keysForward: number[];
  45669. /**
  45670. * The list of keyboard keys used to control the backward move of the camera.
  45671. */
  45672. keysBackward: number[];
  45673. /**
  45674. * The list of keyboard keys used to control the forward move of the camera.
  45675. */
  45676. keysUp: number[];
  45677. /**
  45678. * The list of keyboard keys used to control the backward move of the camera.
  45679. */
  45680. keysDown: number[];
  45681. /**
  45682. * The list of keyboard keys used to control the right strafe move of the camera.
  45683. */
  45684. keysRight: number[];
  45685. /**
  45686. * The list of keyboard keys used to control the left strafe move of the camera.
  45687. */
  45688. keysLeft: number[];
  45689. private _keys;
  45690. private _onCanvasBlurObserver;
  45691. private _onKeyboardObserver;
  45692. private _engine;
  45693. private _scene;
  45694. /**
  45695. * Attach the input controls to a specific dom element to get the input from.
  45696. * @param element Defines the element the controls should be listened from
  45697. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  45698. */
  45699. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  45700. /**
  45701. * Detach the current controls from the specified dom element.
  45702. * @param element Defines the element to stop listening the inputs from
  45703. */
  45704. detachControl(element: Nullable<HTMLElement>): void;
  45705. /**
  45706. * Gets the class name of the current intput.
  45707. * @returns the class name
  45708. */
  45709. getClassName(): string;
  45710. /** @hidden */
  45711. _onLostFocus(e: FocusEvent): void;
  45712. /**
  45713. * Get the friendly name associated with the input class.
  45714. * @returns the input friendly name
  45715. */
  45716. getSimpleName(): string;
  45717. /**
  45718. * Update the current camera state depending on the inputs that have been used this frame.
  45719. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  45720. */
  45721. checkInputs(): void;
  45722. }
  45723. }
  45724. declare module "babylonjs/Cameras/Inputs/followCameraMouseWheelInput" {
  45725. import { Nullable } from "babylonjs/types";
  45726. import { FollowCamera } from "babylonjs/Cameras/followCamera";
  45727. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  45728. /**
  45729. * Manage the mouse wheel inputs to control a follow camera.
  45730. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  45731. */
  45732. export class FollowCameraMouseWheelInput implements ICameraInput<FollowCamera> {
  45733. /**
  45734. * Defines the camera the input is attached to.
  45735. */
  45736. camera: FollowCamera;
  45737. /**
  45738. * Moue wheel controls zoom. (Mouse wheel modifies camera.radius value.)
  45739. */
  45740. axisControlRadius: boolean;
  45741. /**
  45742. * Moue wheel controls height. (Mouse wheel modifies camera.heightOffset value.)
  45743. */
  45744. axisControlHeight: boolean;
  45745. /**
  45746. * Moue wheel controls angle. (Mouse wheel modifies camera.rotationOffset value.)
  45747. */
  45748. axisControlRotation: boolean;
  45749. /**
  45750. * Gets or Set the mouse wheel precision or how fast is the camera moves in
  45751. * relation to mouseWheel events.
  45752. */
  45753. wheelPrecision: number;
  45754. /**
  45755. * wheelDeltaPercentage will be used instead of wheelPrecision if different from 0.
  45756. * It defines the percentage of current camera.radius to use as delta when wheel is used.
  45757. */
  45758. wheelDeltaPercentage: number;
  45759. private _wheel;
  45760. private _observer;
  45761. /**
  45762. * Attach the input controls to a specific dom element to get the input from.
  45763. * @param element Defines the element the controls should be listened from
  45764. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  45765. */
  45766. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  45767. /**
  45768. * Detach the current controls from the specified dom element.
  45769. * @param element Defines the element to stop listening the inputs from
  45770. */
  45771. detachControl(element: Nullable<HTMLElement>): void;
  45772. /**
  45773. * Gets the class name of the current intput.
  45774. * @returns the class name
  45775. */
  45776. getClassName(): string;
  45777. /**
  45778. * Get the friendly name associated with the input class.
  45779. * @returns the input friendly name
  45780. */
  45781. getSimpleName(): string;
  45782. }
  45783. }
  45784. declare module "babylonjs/Cameras/Inputs/followCameraPointersInput" {
  45785. import { Nullable } from "babylonjs/types";
  45786. import { FollowCamera } from "babylonjs/Cameras/followCamera";
  45787. import { BaseCameraPointersInput } from "babylonjs/Cameras/Inputs/BaseCameraPointersInput";
  45788. import { PointerTouch } from "babylonjs/Events/pointerEvents";
  45789. /**
  45790. * Manage the pointers inputs to control an follow camera.
  45791. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  45792. */
  45793. export class FollowCameraPointersInput extends BaseCameraPointersInput {
  45794. /**
  45795. * Defines the camera the input is attached to.
  45796. */
  45797. camera: FollowCamera;
  45798. /**
  45799. * Gets the class name of the current input.
  45800. * @returns the class name
  45801. */
  45802. getClassName(): string;
  45803. /**
  45804. * Defines the pointer angular sensibility along the X axis or how fast is
  45805. * the camera rotating.
  45806. * A negative number will reverse the axis direction.
  45807. */
  45808. angularSensibilityX: number;
  45809. /**
  45810. * Defines the pointer angular sensibility along the Y axis or how fast is
  45811. * the camera rotating.
  45812. * A negative number will reverse the axis direction.
  45813. */
  45814. angularSensibilityY: number;
  45815. /**
  45816. * Defines the pointer pinch precision or how fast is the camera zooming.
  45817. * A negative number will reverse the axis direction.
  45818. */
  45819. pinchPrecision: number;
  45820. /**
  45821. * pinchDeltaPercentage will be used instead of pinchPrecision if different
  45822. * from 0.
  45823. * It defines the percentage of current camera.radius to use as delta when
  45824. * pinch zoom is used.
  45825. */
  45826. pinchDeltaPercentage: number;
  45827. /**
  45828. * Pointer X axis controls zoom. (X axis modifies camera.radius value.)
  45829. */
  45830. axisXControlRadius: boolean;
  45831. /**
  45832. * Pointer X axis controls height. (X axis modifies camera.heightOffset value.)
  45833. */
  45834. axisXControlHeight: boolean;
  45835. /**
  45836. * Pointer X axis controls angle. (X axis modifies camera.rotationOffset value.)
  45837. */
  45838. axisXControlRotation: boolean;
  45839. /**
  45840. * Pointer Y axis controls zoom. (Y axis modifies camera.radius value.)
  45841. */
  45842. axisYControlRadius: boolean;
  45843. /**
  45844. * Pointer Y axis controls height. (Y axis modifies camera.heightOffset value.)
  45845. */
  45846. axisYControlHeight: boolean;
  45847. /**
  45848. * Pointer Y axis controls angle. (Y axis modifies camera.rotationOffset value.)
  45849. */
  45850. axisYControlRotation: boolean;
  45851. /**
  45852. * Pinch controls zoom. (Pinch modifies camera.radius value.)
  45853. */
  45854. axisPinchControlRadius: boolean;
  45855. /**
  45856. * Pinch controls height. (Pinch modifies camera.heightOffset value.)
  45857. */
  45858. axisPinchControlHeight: boolean;
  45859. /**
  45860. * Pinch controls angle. (Pinch modifies camera.rotationOffset value.)
  45861. */
  45862. axisPinchControlRotation: boolean;
  45863. /**
  45864. * Log error messages if basic misconfiguration has occurred.
  45865. */
  45866. warningEnable: boolean;
  45867. protected onTouch(pointA: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  45868. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  45869. private _warningCounter;
  45870. private _warning;
  45871. }
  45872. }
  45873. declare module "babylonjs/Cameras/followCameraInputsManager" {
  45874. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  45875. import { FollowCamera } from "babylonjs/Cameras/followCamera";
  45876. /**
  45877. * Default Inputs manager for the FollowCamera.
  45878. * It groups all the default supported inputs for ease of use.
  45879. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  45880. */
  45881. export class FollowCameraInputsManager extends CameraInputsManager<FollowCamera> {
  45882. /**
  45883. * Instantiates a new FollowCameraInputsManager.
  45884. * @param camera Defines the camera the inputs belong to
  45885. */
  45886. constructor(camera: FollowCamera);
  45887. /**
  45888. * Add keyboard input support to the input manager.
  45889. * @returns the current input manager
  45890. */
  45891. addKeyboard(): FollowCameraInputsManager;
  45892. /**
  45893. * Add mouse wheel input support to the input manager.
  45894. * @returns the current input manager
  45895. */
  45896. addMouseWheel(): FollowCameraInputsManager;
  45897. /**
  45898. * Add pointers input support to the input manager.
  45899. * @returns the current input manager
  45900. */
  45901. addPointers(): FollowCameraInputsManager;
  45902. /**
  45903. * Add orientation input support to the input manager.
  45904. * @returns the current input manager
  45905. */
  45906. addVRDeviceOrientation(): FollowCameraInputsManager;
  45907. }
  45908. }
  45909. declare module "babylonjs/Cameras/followCamera" {
  45910. import { Nullable } from "babylonjs/types";
  45911. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  45912. import { Scene } from "babylonjs/scene";
  45913. import { Vector3 } from "babylonjs/Maths/math.vector";
  45914. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  45915. import { FollowCameraInputsManager } from "babylonjs/Cameras/followCameraInputsManager";
  45916. /**
  45917. * A follow camera takes a mesh as a target and follows it as it moves. Both a free camera version followCamera and
  45918. * an arc rotate version arcFollowCamera are available.
  45919. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  45920. */
  45921. export class FollowCamera extends TargetCamera {
  45922. /**
  45923. * Distance the follow camera should follow an object at
  45924. */
  45925. radius: number;
  45926. /**
  45927. * Minimum allowed distance of the camera to the axis of rotation
  45928. * (The camera can not get closer).
  45929. * This can help limiting how the Camera is able to move in the scene.
  45930. */
  45931. lowerRadiusLimit: Nullable<number>;
  45932. /**
  45933. * Maximum allowed distance of the camera to the axis of rotation
  45934. * (The camera can not get further).
  45935. * This can help limiting how the Camera is able to move in the scene.
  45936. */
  45937. upperRadiusLimit: Nullable<number>;
  45938. /**
  45939. * Define a rotation offset between the camera and the object it follows
  45940. */
  45941. rotationOffset: number;
  45942. /**
  45943. * Minimum allowed angle to camera position relative to target object.
  45944. * This can help limiting how the Camera is able to move in the scene.
  45945. */
  45946. lowerRotationOffsetLimit: Nullable<number>;
  45947. /**
  45948. * Maximum allowed angle to camera position relative to target object.
  45949. * This can help limiting how the Camera is able to move in the scene.
  45950. */
  45951. upperRotationOffsetLimit: Nullable<number>;
  45952. /**
  45953. * Define a height offset between the camera and the object it follows.
  45954. * It can help following an object from the top (like a car chaing a plane)
  45955. */
  45956. heightOffset: number;
  45957. /**
  45958. * Minimum allowed height of camera position relative to target object.
  45959. * This can help limiting how the Camera is able to move in the scene.
  45960. */
  45961. lowerHeightOffsetLimit: Nullable<number>;
  45962. /**
  45963. * Maximum allowed height of camera position relative to target object.
  45964. * This can help limiting how the Camera is able to move in the scene.
  45965. */
  45966. upperHeightOffsetLimit: Nullable<number>;
  45967. /**
  45968. * Define how fast the camera can accelerate to follow it s target.
  45969. */
  45970. cameraAcceleration: number;
  45971. /**
  45972. * Define the speed limit of the camera following an object.
  45973. */
  45974. maxCameraSpeed: number;
  45975. /**
  45976. * Define the target of the camera.
  45977. */
  45978. lockedTarget: Nullable<AbstractMesh>;
  45979. /**
  45980. * Defines the input associated with the camera.
  45981. */
  45982. inputs: FollowCameraInputsManager;
  45983. /**
  45984. * Instantiates the follow camera.
  45985. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  45986. * @param name Define the name of the camera in the scene
  45987. * @param position Define the position of the camera
  45988. * @param scene Define the scene the camera belong to
  45989. * @param lockedTarget Define the target of the camera
  45990. */
  45991. constructor(name: string, position: Vector3, scene: Scene, lockedTarget?: Nullable<AbstractMesh>);
  45992. private _follow;
  45993. /**
  45994. * Attached controls to the current camera.
  45995. * @param element Defines the element the controls should be listened from
  45996. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  45997. */
  45998. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  45999. /**
  46000. * Detach the current controls from the camera.
  46001. * The camera will stop reacting to inputs.
  46002. * @param element Defines the element to stop listening the inputs from
  46003. */
  46004. detachControl(element: HTMLElement): void;
  46005. /** @hidden */
  46006. _checkInputs(): void;
  46007. private _checkLimits;
  46008. /**
  46009. * Gets the camera class name.
  46010. * @returns the class name
  46011. */
  46012. getClassName(): string;
  46013. }
  46014. /**
  46015. * Arc Rotate version of the follow camera.
  46016. * It still follows a Defined mesh but in an Arc Rotate Camera fashion.
  46017. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  46018. */
  46019. export class ArcFollowCamera extends TargetCamera {
  46020. /** The longitudinal angle of the camera */
  46021. alpha: number;
  46022. /** The latitudinal angle of the camera */
  46023. beta: number;
  46024. /** The radius of the camera from its target */
  46025. radius: number;
  46026. /** Define the camera target (the mesh it should follow) */
  46027. target: Nullable<AbstractMesh>;
  46028. private _cartesianCoordinates;
  46029. /**
  46030. * Instantiates a new ArcFollowCamera
  46031. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  46032. * @param name Define the name of the camera
  46033. * @param alpha Define the rotation angle of the camera around the logitudinal axis
  46034. * @param beta Define the rotation angle of the camera around the elevation axis
  46035. * @param radius Define the radius of the camera from its target point
  46036. * @param target Define the target of the camera
  46037. * @param scene Define the scene the camera belongs to
  46038. */
  46039. constructor(name: string,
  46040. /** The longitudinal angle of the camera */
  46041. alpha: number,
  46042. /** The latitudinal angle of the camera */
  46043. beta: number,
  46044. /** The radius of the camera from its target */
  46045. radius: number,
  46046. /** Define the camera target (the mesh it should follow) */
  46047. target: Nullable<AbstractMesh>, scene: Scene);
  46048. private _follow;
  46049. /** @hidden */
  46050. _checkInputs(): void;
  46051. /**
  46052. * Returns the class name of the object.
  46053. * It is mostly used internally for serialization purposes.
  46054. */
  46055. getClassName(): string;
  46056. }
  46057. }
  46058. declare module "babylonjs/Cameras/Inputs/followCameraKeyboardMoveInput" {
  46059. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  46060. import { FollowCamera } from "babylonjs/Cameras/followCamera";
  46061. import { Nullable } from "babylonjs/types";
  46062. /**
  46063. * Manage the keyboard inputs to control the movement of a follow camera.
  46064. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  46065. */
  46066. export class FollowCameraKeyboardMoveInput implements ICameraInput<FollowCamera> {
  46067. /**
  46068. * Defines the camera the input is attached to.
  46069. */
  46070. camera: FollowCamera;
  46071. /**
  46072. * Defines the list of key codes associated with the up action (increase heightOffset)
  46073. */
  46074. keysHeightOffsetIncr: number[];
  46075. /**
  46076. * Defines the list of key codes associated with the down action (decrease heightOffset)
  46077. */
  46078. keysHeightOffsetDecr: number[];
  46079. /**
  46080. * Defines whether the Alt modifier key is required to move up/down (alter heightOffset)
  46081. */
  46082. keysHeightOffsetModifierAlt: boolean;
  46083. /**
  46084. * Defines whether the Ctrl modifier key is required to move up/down (alter heightOffset)
  46085. */
  46086. keysHeightOffsetModifierCtrl: boolean;
  46087. /**
  46088. * Defines whether the Shift modifier key is required to move up/down (alter heightOffset)
  46089. */
  46090. keysHeightOffsetModifierShift: boolean;
  46091. /**
  46092. * Defines the list of key codes associated with the left action (increase rotationOffset)
  46093. */
  46094. keysRotationOffsetIncr: number[];
  46095. /**
  46096. * Defines the list of key codes associated with the right action (decrease rotationOffset)
  46097. */
  46098. keysRotationOffsetDecr: number[];
  46099. /**
  46100. * Defines whether the Alt modifier key is required to move left/right (alter rotationOffset)
  46101. */
  46102. keysRotationOffsetModifierAlt: boolean;
  46103. /**
  46104. * Defines whether the Ctrl modifier key is required to move left/right (alter rotationOffset)
  46105. */
  46106. keysRotationOffsetModifierCtrl: boolean;
  46107. /**
  46108. * Defines whether the Shift modifier key is required to move left/right (alter rotationOffset)
  46109. */
  46110. keysRotationOffsetModifierShift: boolean;
  46111. /**
  46112. * Defines the list of key codes associated with the zoom-in action (decrease radius)
  46113. */
  46114. keysRadiusIncr: number[];
  46115. /**
  46116. * Defines the list of key codes associated with the zoom-out action (increase radius)
  46117. */
  46118. keysRadiusDecr: number[];
  46119. /**
  46120. * Defines whether the Alt modifier key is required to zoom in/out (alter radius value)
  46121. */
  46122. keysRadiusModifierAlt: boolean;
  46123. /**
  46124. * Defines whether the Ctrl modifier key is required to zoom in/out (alter radius value)
  46125. */
  46126. keysRadiusModifierCtrl: boolean;
  46127. /**
  46128. * Defines whether the Shift modifier key is required to zoom in/out (alter radius value)
  46129. */
  46130. keysRadiusModifierShift: boolean;
  46131. /**
  46132. * Defines the rate of change of heightOffset.
  46133. */
  46134. heightSensibility: number;
  46135. /**
  46136. * Defines the rate of change of rotationOffset.
  46137. */
  46138. rotationSensibility: number;
  46139. /**
  46140. * Defines the rate of change of radius.
  46141. */
  46142. radiusSensibility: number;
  46143. private _keys;
  46144. private _ctrlPressed;
  46145. private _altPressed;
  46146. private _shiftPressed;
  46147. private _onCanvasBlurObserver;
  46148. private _onKeyboardObserver;
  46149. private _engine;
  46150. private _scene;
  46151. /**
  46152. * Attach the input controls to a specific dom element to get the input from.
  46153. * @param element Defines the element the controls should be listened from
  46154. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  46155. */
  46156. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  46157. /**
  46158. * Detach the current controls from the specified dom element.
  46159. * @param element Defines the element to stop listening the inputs from
  46160. */
  46161. detachControl(element: Nullable<HTMLElement>): void;
  46162. /**
  46163. * Update the current camera state depending on the inputs that have been used this frame.
  46164. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  46165. */
  46166. checkInputs(): void;
  46167. /**
  46168. * Gets the class name of the current input.
  46169. * @returns the class name
  46170. */
  46171. getClassName(): string;
  46172. /**
  46173. * Get the friendly name associated with the input class.
  46174. * @returns the input friendly name
  46175. */
  46176. getSimpleName(): string;
  46177. /**
  46178. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  46179. * allow modification of the heightOffset value.
  46180. */
  46181. private _modifierHeightOffset;
  46182. /**
  46183. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  46184. * allow modification of the rotationOffset value.
  46185. */
  46186. private _modifierRotationOffset;
  46187. /**
  46188. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  46189. * allow modification of the radius value.
  46190. */
  46191. private _modifierRadius;
  46192. }
  46193. }
  46194. declare module "babylonjs/Cameras/Inputs/freeCameraDeviceOrientationInput" {
  46195. import { Nullable } from "babylonjs/types";
  46196. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  46197. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  46198. import { Observable } from "babylonjs/Misc/observable";
  46199. module "babylonjs/Cameras/freeCameraInputsManager" {
  46200. interface FreeCameraInputsManager {
  46201. /**
  46202. * @hidden
  46203. */
  46204. _deviceOrientationInput: Nullable<FreeCameraDeviceOrientationInput>;
  46205. /**
  46206. * Add orientation input support to the input manager.
  46207. * @returns the current input manager
  46208. */
  46209. addDeviceOrientation(): FreeCameraInputsManager;
  46210. }
  46211. }
  46212. /**
  46213. * Takes information about the orientation of the device as reported by the deviceorientation event to orient the camera.
  46214. * Screen rotation is taken into account.
  46215. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  46216. */
  46217. export class FreeCameraDeviceOrientationInput implements ICameraInput<FreeCamera> {
  46218. private _camera;
  46219. private _screenOrientationAngle;
  46220. private _constantTranform;
  46221. private _screenQuaternion;
  46222. private _alpha;
  46223. private _beta;
  46224. private _gamma;
  46225. /**
  46226. * Can be used to detect if a device orientation sensor is available on a device
  46227. * @param timeout amount of time in milliseconds to wait for a response from the sensor (default: infinite)
  46228. * @returns a promise that will resolve on orientation change
  46229. */
  46230. static WaitForOrientationChangeAsync(timeout?: number): Promise<unknown>;
  46231. /**
  46232. * @hidden
  46233. */
  46234. _onDeviceOrientationChangedObservable: Observable<void>;
  46235. /**
  46236. * Instantiates a new input
  46237. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  46238. */
  46239. constructor();
  46240. /**
  46241. * Define the camera controlled by the input.
  46242. */
  46243. get camera(): FreeCamera;
  46244. set camera(camera: FreeCamera);
  46245. /**
  46246. * Attach the input controls to a specific dom element to get the input from.
  46247. * @param element Defines the element the controls should be listened from
  46248. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  46249. */
  46250. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  46251. private _orientationChanged;
  46252. private _deviceOrientation;
  46253. /**
  46254. * Detach the current controls from the specified dom element.
  46255. * @param element Defines the element to stop listening the inputs from
  46256. */
  46257. detachControl(element: Nullable<HTMLElement>): void;
  46258. /**
  46259. * Update the current camera state depending on the inputs that have been used this frame.
  46260. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  46261. */
  46262. checkInputs(): void;
  46263. /**
  46264. * Gets the class name of the current intput.
  46265. * @returns the class name
  46266. */
  46267. getClassName(): string;
  46268. /**
  46269. * Get the friendly name associated with the input class.
  46270. * @returns the input friendly name
  46271. */
  46272. getSimpleName(): string;
  46273. }
  46274. }
  46275. declare module "babylonjs/Cameras/Inputs/freeCameraGamepadInput" {
  46276. import { Nullable } from "babylonjs/types";
  46277. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  46278. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  46279. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  46280. /**
  46281. * Manage the gamepad inputs to control a free camera.
  46282. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  46283. */
  46284. export class FreeCameraGamepadInput implements ICameraInput<FreeCamera> {
  46285. /**
  46286. * Define the camera the input is attached to.
  46287. */
  46288. camera: FreeCamera;
  46289. /**
  46290. * Define the Gamepad controlling the input
  46291. */
  46292. gamepad: Nullable<Gamepad>;
  46293. /**
  46294. * Defines the gamepad rotation sensiblity.
  46295. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  46296. */
  46297. gamepadAngularSensibility: number;
  46298. /**
  46299. * Defines the gamepad move sensiblity.
  46300. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  46301. */
  46302. gamepadMoveSensibility: number;
  46303. private _yAxisScale;
  46304. /**
  46305. * Gets or sets a boolean indicating that Yaxis (for right stick) should be inverted
  46306. */
  46307. get invertYAxis(): boolean;
  46308. set invertYAxis(value: boolean);
  46309. private _onGamepadConnectedObserver;
  46310. private _onGamepadDisconnectedObserver;
  46311. private _cameraTransform;
  46312. private _deltaTransform;
  46313. private _vector3;
  46314. private _vector2;
  46315. /**
  46316. * Attach the input controls to a specific dom element to get the input from.
  46317. * @param element Defines the element the controls should be listened from
  46318. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  46319. */
  46320. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  46321. /**
  46322. * Detach the current controls from the specified dom element.
  46323. * @param element Defines the element to stop listening the inputs from
  46324. */
  46325. detachControl(element: Nullable<HTMLElement>): void;
  46326. /**
  46327. * Update the current camera state depending on the inputs that have been used this frame.
  46328. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  46329. */
  46330. checkInputs(): void;
  46331. /**
  46332. * Gets the class name of the current intput.
  46333. * @returns the class name
  46334. */
  46335. getClassName(): string;
  46336. /**
  46337. * Get the friendly name associated with the input class.
  46338. * @returns the input friendly name
  46339. */
  46340. getSimpleName(): string;
  46341. }
  46342. }
  46343. declare module "babylonjs/Misc/virtualJoystick" {
  46344. import { Nullable } from "babylonjs/types";
  46345. import { Vector3 } from "babylonjs/Maths/math.vector";
  46346. /**
  46347. * Defines the potential axis of a Joystick
  46348. */
  46349. export enum JoystickAxis {
  46350. /** X axis */
  46351. X = 0,
  46352. /** Y axis */
  46353. Y = 1,
  46354. /** Z axis */
  46355. Z = 2
  46356. }
  46357. /**
  46358. * Represents the different customization options available
  46359. * for VirtualJoystick
  46360. */
  46361. interface VirtualJoystickCustomizations {
  46362. /**
  46363. * Size of the joystick's puck
  46364. */
  46365. puckSize: number;
  46366. /**
  46367. * Size of the joystick's container
  46368. */
  46369. containerSize: number;
  46370. /**
  46371. * Color of the joystick && puck
  46372. */
  46373. color: string;
  46374. /**
  46375. * Image URL for the joystick's puck
  46376. */
  46377. puckImage?: string;
  46378. /**
  46379. * Image URL for the joystick's container
  46380. */
  46381. containerImage?: string;
  46382. /**
  46383. * Defines the unmoving position of the joystick container
  46384. */
  46385. position?: {
  46386. x: number;
  46387. y: number;
  46388. };
  46389. /**
  46390. * Defines whether or not the joystick container is always visible
  46391. */
  46392. alwaysVisible: boolean;
  46393. /**
  46394. * Defines whether or not to limit the movement of the puck to the joystick's container
  46395. */
  46396. limitToContainer: boolean;
  46397. }
  46398. /**
  46399. * Class used to define virtual joystick (used in touch mode)
  46400. */
  46401. export class VirtualJoystick {
  46402. /**
  46403. * Gets or sets a boolean indicating that left and right values must be inverted
  46404. */
  46405. reverseLeftRight: boolean;
  46406. /**
  46407. * Gets or sets a boolean indicating that up and down values must be inverted
  46408. */
  46409. reverseUpDown: boolean;
  46410. /**
  46411. * Gets the offset value for the position (ie. the change of the position value)
  46412. */
  46413. deltaPosition: Vector3;
  46414. /**
  46415. * Gets a boolean indicating if the virtual joystick was pressed
  46416. */
  46417. pressed: boolean;
  46418. /**
  46419. * Canvas the virtual joystick will render onto, default z-index of this is 5
  46420. */
  46421. static Canvas: Nullable<HTMLCanvasElement>;
  46422. /**
  46423. * boolean indicating whether or not the joystick's puck's movement should be limited to the joystick's container area
  46424. */
  46425. limitToContainer: boolean;
  46426. private static _globalJoystickIndex;
  46427. private static _alwaysVisibleSticks;
  46428. private static vjCanvasContext;
  46429. private static vjCanvasWidth;
  46430. private static vjCanvasHeight;
  46431. private static halfWidth;
  46432. private static _GetDefaultOptions;
  46433. private _action;
  46434. private _axisTargetedByLeftAndRight;
  46435. private _axisTargetedByUpAndDown;
  46436. private _joystickSensibility;
  46437. private _inversedSensibility;
  46438. private _joystickPointerID;
  46439. private _joystickColor;
  46440. private _joystickPointerPos;
  46441. private _joystickPreviousPointerPos;
  46442. private _joystickPointerStartPos;
  46443. private _deltaJoystickVector;
  46444. private _leftJoystick;
  46445. private _touches;
  46446. private _joystickPosition;
  46447. private _alwaysVisible;
  46448. private _puckImage;
  46449. private _containerImage;
  46450. private _joystickPuckSize;
  46451. private _joystickContainerSize;
  46452. private _clearPuckSize;
  46453. private _clearContainerSize;
  46454. private _clearPuckSizeOffset;
  46455. private _clearContainerSizeOffset;
  46456. private _onPointerDownHandlerRef;
  46457. private _onPointerMoveHandlerRef;
  46458. private _onPointerUpHandlerRef;
  46459. private _onResize;
  46460. /**
  46461. * Creates a new virtual joystick
  46462. * @param leftJoystick defines that the joystick is for left hand (false by default)
  46463. * @param customizations Defines the options we want to customize the VirtualJoystick
  46464. */
  46465. constructor(leftJoystick?: boolean, customizations?: Partial<VirtualJoystickCustomizations>);
  46466. /**
  46467. * Defines joystick sensibility (ie. the ratio beteen a physical move and virtual joystick position change)
  46468. * @param newJoystickSensibility defines the new sensibility
  46469. */
  46470. setJoystickSensibility(newJoystickSensibility: number): void;
  46471. private _onPointerDown;
  46472. private _onPointerMove;
  46473. private _onPointerUp;
  46474. /**
  46475. * Change the color of the virtual joystick
  46476. * @param newColor a string that must be a CSS color value (like "red") or the hexa value (like "#FF0000")
  46477. */
  46478. setJoystickColor(newColor: string): void;
  46479. /**
  46480. * Size of the joystick's container
  46481. */
  46482. set containerSize(newSize: number);
  46483. get containerSize(): number;
  46484. /**
  46485. * Size of the joystick's puck
  46486. */
  46487. set puckSize(newSize: number);
  46488. get puckSize(): number;
  46489. /**
  46490. * Clears the set position of the joystick
  46491. */
  46492. clearPosition(): void;
  46493. /**
  46494. * Defines whether or not the joystick container is always visible
  46495. */
  46496. set alwaysVisible(value: boolean);
  46497. get alwaysVisible(): boolean;
  46498. /**
  46499. * Sets the constant position of the Joystick container
  46500. * @param x X axis coordinate
  46501. * @param y Y axis coordinate
  46502. */
  46503. setPosition(x: number, y: number): void;
  46504. /**
  46505. * Defines a callback to call when the joystick is touched
  46506. * @param action defines the callback
  46507. */
  46508. setActionOnTouch(action: () => any): void;
  46509. /**
  46510. * Defines which axis you'd like to control for left & right
  46511. * @param axis defines the axis to use
  46512. */
  46513. setAxisForLeftRight(axis: JoystickAxis): void;
  46514. /**
  46515. * Defines which axis you'd like to control for up & down
  46516. * @param axis defines the axis to use
  46517. */
  46518. setAxisForUpDown(axis: JoystickAxis): void;
  46519. /**
  46520. * Clears the canvas from the previous puck / container draw
  46521. */
  46522. private _clearPreviousDraw;
  46523. /**
  46524. * Loads `urlPath` to be used for the container's image
  46525. * @param urlPath defines the urlPath of an image to use
  46526. */
  46527. setContainerImage(urlPath: string): void;
  46528. /**
  46529. * Loads `urlPath` to be used for the puck's image
  46530. * @param urlPath defines the urlPath of an image to use
  46531. */
  46532. setPuckImage(urlPath: string): void;
  46533. /**
  46534. * Draws the Virtual Joystick's container
  46535. */
  46536. private _drawContainer;
  46537. /**
  46538. * Draws the Virtual Joystick's puck
  46539. */
  46540. private _drawPuck;
  46541. private _drawVirtualJoystick;
  46542. /**
  46543. * Release internal HTML canvas
  46544. */
  46545. releaseCanvas(): void;
  46546. }
  46547. }
  46548. declare module "babylonjs/Cameras/Inputs/freeCameraVirtualJoystickInput" {
  46549. import { VirtualJoystick } from "babylonjs/Misc/virtualJoystick";
  46550. import { Nullable } from "babylonjs/types";
  46551. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  46552. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  46553. module "babylonjs/Cameras/freeCameraInputsManager" {
  46554. interface FreeCameraInputsManager {
  46555. /**
  46556. * Add virtual joystick input support to the input manager.
  46557. * @returns the current input manager
  46558. */
  46559. addVirtualJoystick(): FreeCameraInputsManager;
  46560. }
  46561. }
  46562. /**
  46563. * Manage the Virtual Joystick inputs to control the movement of a free camera.
  46564. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  46565. */
  46566. export class FreeCameraVirtualJoystickInput implements ICameraInput<FreeCamera> {
  46567. /**
  46568. * Defines the camera the input is attached to.
  46569. */
  46570. camera: FreeCamera;
  46571. private _leftjoystick;
  46572. private _rightjoystick;
  46573. /**
  46574. * Gets the left stick of the virtual joystick.
  46575. * @returns The virtual Joystick
  46576. */
  46577. getLeftJoystick(): VirtualJoystick;
  46578. /**
  46579. * Gets the right stick of the virtual joystick.
  46580. * @returns The virtual Joystick
  46581. */
  46582. getRightJoystick(): VirtualJoystick;
  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. * Attach the input controls to a specific dom element to get the input from.
  46590. * @param element Defines the element the controls should be listened from
  46591. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  46592. */
  46593. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  46594. /**
  46595. * Detach the current controls from the specified dom element.
  46596. * @param element Defines the element to stop listening the inputs from
  46597. */
  46598. detachControl(element: Nullable<HTMLElement>): void;
  46599. /**
  46600. * Gets the class name of the current intput.
  46601. * @returns the class name
  46602. */
  46603. getClassName(): string;
  46604. /**
  46605. * Get the friendly name associated with the input class.
  46606. * @returns the input friendly name
  46607. */
  46608. getSimpleName(): string;
  46609. }
  46610. }
  46611. declare module "babylonjs/Cameras/Inputs/index" {
  46612. export * from "babylonjs/Cameras/Inputs/arcRotateCameraGamepadInput";
  46613. export * from "babylonjs/Cameras/Inputs/arcRotateCameraKeyboardMoveInput";
  46614. export * from "babylonjs/Cameras/Inputs/arcRotateCameraMouseWheelInput";
  46615. export * from "babylonjs/Cameras/Inputs/arcRotateCameraPointersInput";
  46616. export * from "babylonjs/Cameras/Inputs/arcRotateCameraVRDeviceOrientationInput";
  46617. export * from "babylonjs/Cameras/Inputs/flyCameraKeyboardInput";
  46618. export * from "babylonjs/Cameras/Inputs/flyCameraMouseInput";
  46619. export * from "babylonjs/Cameras/Inputs/followCameraKeyboardMoveInput";
  46620. export * from "babylonjs/Cameras/Inputs/followCameraMouseWheelInput";
  46621. export * from "babylonjs/Cameras/Inputs/followCameraPointersInput";
  46622. export * from "babylonjs/Cameras/Inputs/freeCameraDeviceOrientationInput";
  46623. export * from "babylonjs/Cameras/Inputs/freeCameraGamepadInput";
  46624. export * from "babylonjs/Cameras/Inputs/freeCameraKeyboardMoveInput";
  46625. export * from "babylonjs/Cameras/Inputs/freeCameraMouseInput";
  46626. export * from "babylonjs/Cameras/Inputs/freeCameraTouchInput";
  46627. export * from "babylonjs/Cameras/Inputs/freeCameraVirtualJoystickInput";
  46628. }
  46629. declare module "babylonjs/Cameras/touchCamera" {
  46630. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  46631. import { Scene } from "babylonjs/scene";
  46632. import { Vector3 } from "babylonjs/Maths/math.vector";
  46633. /**
  46634. * This represents a FPS type of camera controlled by touch.
  46635. * This is like a universal camera minus the Gamepad controls.
  46636. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  46637. */
  46638. export class TouchCamera extends FreeCamera {
  46639. /**
  46640. * Defines the touch sensibility for rotation.
  46641. * The higher the faster.
  46642. */
  46643. get touchAngularSensibility(): number;
  46644. set touchAngularSensibility(value: number);
  46645. /**
  46646. * Defines the touch sensibility for move.
  46647. * The higher the faster.
  46648. */
  46649. get touchMoveSensibility(): number;
  46650. set touchMoveSensibility(value: number);
  46651. /**
  46652. * Instantiates a new touch camera.
  46653. * This represents a FPS type of camera controlled by touch.
  46654. * This is like a universal camera minus the Gamepad controls.
  46655. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  46656. * @param name Define the name of the camera in the scene
  46657. * @param position Define the start position of the camera in the scene
  46658. * @param scene Define the scene the camera belongs to
  46659. */
  46660. constructor(name: string, position: Vector3, scene: Scene);
  46661. /**
  46662. * Gets the current object class name.
  46663. * @return the class name
  46664. */
  46665. getClassName(): string;
  46666. /** @hidden */
  46667. _setupInputs(): void;
  46668. }
  46669. }
  46670. declare module "babylonjs/Cameras/deviceOrientationCamera" {
  46671. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  46672. import { Scene } from "babylonjs/scene";
  46673. import { Vector3 } from "babylonjs/Maths/math.vector";
  46674. import "babylonjs/Cameras/Inputs/freeCameraDeviceOrientationInput";
  46675. import { Axis } from "babylonjs/Maths/math.axis";
  46676. /**
  46677. * This is a camera specifically designed to react to device orientation events such as a modern mobile device
  46678. * being tilted forward or back and left or right.
  46679. */
  46680. export class DeviceOrientationCamera extends FreeCamera {
  46681. private _initialQuaternion;
  46682. private _quaternionCache;
  46683. private _tmpDragQuaternion;
  46684. private _disablePointerInputWhenUsingDeviceOrientation;
  46685. /**
  46686. * Creates a new device orientation camera
  46687. * @param name The name of the camera
  46688. * @param position The start position camera
  46689. * @param scene The scene the camera belongs to
  46690. */
  46691. constructor(name: string, position: Vector3, scene: Scene);
  46692. /**
  46693. * Gets or sets a boolean indicating that pointer input must be disabled on first orientation sensor update (Default: true)
  46694. */
  46695. get disablePointerInputWhenUsingDeviceOrientation(): boolean;
  46696. set disablePointerInputWhenUsingDeviceOrientation(value: boolean);
  46697. private _dragFactor;
  46698. /**
  46699. * Enabled turning on the y axis when the orientation sensor is active
  46700. * @param dragFactor the factor that controls the turn speed (default: 1/300)
  46701. */
  46702. enableHorizontalDragging(dragFactor?: number): void;
  46703. /**
  46704. * Gets the current instance class name ("DeviceOrientationCamera").
  46705. * This helps avoiding instanceof at run time.
  46706. * @returns the class name
  46707. */
  46708. getClassName(): string;
  46709. /**
  46710. * @hidden
  46711. * Checks and applies the current values of the inputs to the camera. (Internal use only)
  46712. */
  46713. _checkInputs(): void;
  46714. /**
  46715. * Reset the camera to its default orientation on the specified axis only.
  46716. * @param axis The axis to reset
  46717. */
  46718. resetToCurrentRotation(axis?: Axis): void;
  46719. }
  46720. }
  46721. declare module "babylonjs/Gamepads/xboxGamepad" {
  46722. import { Observable } from "babylonjs/Misc/observable";
  46723. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  46724. /**
  46725. * Defines supported buttons for XBox360 compatible gamepads
  46726. */
  46727. export enum Xbox360Button {
  46728. /** A */
  46729. A = 0,
  46730. /** B */
  46731. B = 1,
  46732. /** X */
  46733. X = 2,
  46734. /** Y */
  46735. Y = 3,
  46736. /** Left button */
  46737. LB = 4,
  46738. /** Right button */
  46739. RB = 5,
  46740. /** Back */
  46741. Back = 8,
  46742. /** Start */
  46743. Start = 9,
  46744. /** Left stick */
  46745. LeftStick = 10,
  46746. /** Right stick */
  46747. RightStick = 11
  46748. }
  46749. /** Defines values for XBox360 DPad */
  46750. export enum Xbox360Dpad {
  46751. /** Up */
  46752. Up = 12,
  46753. /** Down */
  46754. Down = 13,
  46755. /** Left */
  46756. Left = 14,
  46757. /** Right */
  46758. Right = 15
  46759. }
  46760. /**
  46761. * Defines a XBox360 gamepad
  46762. */
  46763. export class Xbox360Pad extends Gamepad {
  46764. private _leftTrigger;
  46765. private _rightTrigger;
  46766. private _onlefttriggerchanged;
  46767. private _onrighttriggerchanged;
  46768. private _onbuttondown;
  46769. private _onbuttonup;
  46770. private _ondpaddown;
  46771. private _ondpadup;
  46772. /** Observable raised when a button is pressed */
  46773. onButtonDownObservable: Observable<Xbox360Button>;
  46774. /** Observable raised when a button is released */
  46775. onButtonUpObservable: Observable<Xbox360Button>;
  46776. /** Observable raised when a pad is pressed */
  46777. onPadDownObservable: Observable<Xbox360Dpad>;
  46778. /** Observable raised when a pad is released */
  46779. onPadUpObservable: Observable<Xbox360Dpad>;
  46780. private _buttonA;
  46781. private _buttonB;
  46782. private _buttonX;
  46783. private _buttonY;
  46784. private _buttonBack;
  46785. private _buttonStart;
  46786. private _buttonLB;
  46787. private _buttonRB;
  46788. private _buttonLeftStick;
  46789. private _buttonRightStick;
  46790. private _dPadUp;
  46791. private _dPadDown;
  46792. private _dPadLeft;
  46793. private _dPadRight;
  46794. private _isXboxOnePad;
  46795. /**
  46796. * Creates a new XBox360 gamepad object
  46797. * @param id defines the id of this gamepad
  46798. * @param index defines its index
  46799. * @param gamepad defines the internal HTML gamepad object
  46800. * @param xboxOne defines if it is a XBox One gamepad
  46801. */
  46802. constructor(id: string, index: number, gamepad: any, xboxOne?: boolean);
  46803. /**
  46804. * Defines the callback to call when left trigger is pressed
  46805. * @param callback defines the callback to use
  46806. */
  46807. onlefttriggerchanged(callback: (value: number) => void): void;
  46808. /**
  46809. * Defines the callback to call when right trigger is pressed
  46810. * @param callback defines the callback to use
  46811. */
  46812. onrighttriggerchanged(callback: (value: number) => void): void;
  46813. /**
  46814. * Gets the left trigger value
  46815. */
  46816. get leftTrigger(): number;
  46817. /**
  46818. * Sets the left trigger value
  46819. */
  46820. set leftTrigger(newValue: number);
  46821. /**
  46822. * Gets the right trigger value
  46823. */
  46824. get rightTrigger(): number;
  46825. /**
  46826. * Sets the right trigger value
  46827. */
  46828. set rightTrigger(newValue: number);
  46829. /**
  46830. * Defines the callback to call when a button is pressed
  46831. * @param callback defines the callback to use
  46832. */
  46833. onbuttondown(callback: (buttonPressed: Xbox360Button) => void): void;
  46834. /**
  46835. * Defines the callback to call when a button is released
  46836. * @param callback defines the callback to use
  46837. */
  46838. onbuttonup(callback: (buttonReleased: Xbox360Button) => void): void;
  46839. /**
  46840. * Defines the callback to call when a pad is pressed
  46841. * @param callback defines the callback to use
  46842. */
  46843. ondpaddown(callback: (dPadPressed: Xbox360Dpad) => void): void;
  46844. /**
  46845. * Defines the callback to call when a pad is released
  46846. * @param callback defines the callback to use
  46847. */
  46848. ondpadup(callback: (dPadReleased: Xbox360Dpad) => void): void;
  46849. private _setButtonValue;
  46850. private _setDPadValue;
  46851. /**
  46852. * Gets the value of the `A` button
  46853. */
  46854. get buttonA(): number;
  46855. /**
  46856. * Sets the value of the `A` button
  46857. */
  46858. set buttonA(value: number);
  46859. /**
  46860. * Gets the value of the `B` button
  46861. */
  46862. get buttonB(): number;
  46863. /**
  46864. * Sets the value of the `B` button
  46865. */
  46866. set buttonB(value: number);
  46867. /**
  46868. * Gets the value of the `X` button
  46869. */
  46870. get buttonX(): number;
  46871. /**
  46872. * Sets the value of the `X` button
  46873. */
  46874. set buttonX(value: number);
  46875. /**
  46876. * Gets the value of the `Y` button
  46877. */
  46878. get buttonY(): number;
  46879. /**
  46880. * Sets the value of the `Y` button
  46881. */
  46882. set buttonY(value: number);
  46883. /**
  46884. * Gets the value of the `Start` button
  46885. */
  46886. get buttonStart(): number;
  46887. /**
  46888. * Sets the value of the `Start` button
  46889. */
  46890. set buttonStart(value: number);
  46891. /**
  46892. * Gets the value of the `Back` button
  46893. */
  46894. get buttonBack(): number;
  46895. /**
  46896. * Sets the value of the `Back` button
  46897. */
  46898. set buttonBack(value: number);
  46899. /**
  46900. * Gets the value of the `Left` button
  46901. */
  46902. get buttonLB(): number;
  46903. /**
  46904. * Sets the value of the `Left` button
  46905. */
  46906. set buttonLB(value: number);
  46907. /**
  46908. * Gets the value of the `Right` button
  46909. */
  46910. get buttonRB(): number;
  46911. /**
  46912. * Sets the value of the `Right` button
  46913. */
  46914. set buttonRB(value: number);
  46915. /**
  46916. * Gets the value of the Left joystick
  46917. */
  46918. get buttonLeftStick(): number;
  46919. /**
  46920. * Sets the value of the Left joystick
  46921. */
  46922. set buttonLeftStick(value: number);
  46923. /**
  46924. * Gets the value of the Right joystick
  46925. */
  46926. get buttonRightStick(): number;
  46927. /**
  46928. * Sets the value of the Right joystick
  46929. */
  46930. set buttonRightStick(value: number);
  46931. /**
  46932. * Gets the value of D-pad up
  46933. */
  46934. get dPadUp(): number;
  46935. /**
  46936. * Sets the value of D-pad up
  46937. */
  46938. set dPadUp(value: number);
  46939. /**
  46940. * Gets the value of D-pad down
  46941. */
  46942. get dPadDown(): number;
  46943. /**
  46944. * Sets the value of D-pad down
  46945. */
  46946. set dPadDown(value: number);
  46947. /**
  46948. * Gets the value of D-pad left
  46949. */
  46950. get dPadLeft(): number;
  46951. /**
  46952. * Sets the value of D-pad left
  46953. */
  46954. set dPadLeft(value: number);
  46955. /**
  46956. * Gets the value of D-pad right
  46957. */
  46958. get dPadRight(): number;
  46959. /**
  46960. * Sets the value of D-pad right
  46961. */
  46962. set dPadRight(value: number);
  46963. /**
  46964. * Force the gamepad to synchronize with device values
  46965. */
  46966. update(): void;
  46967. /**
  46968. * Disposes the gamepad
  46969. */
  46970. dispose(): void;
  46971. }
  46972. }
  46973. declare module "babylonjs/Gamepads/dualShockGamepad" {
  46974. import { Observable } from "babylonjs/Misc/observable";
  46975. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  46976. /**
  46977. * Defines supported buttons for DualShock compatible gamepads
  46978. */
  46979. export enum DualShockButton {
  46980. /** Cross */
  46981. Cross = 0,
  46982. /** Circle */
  46983. Circle = 1,
  46984. /** Square */
  46985. Square = 2,
  46986. /** Triangle */
  46987. Triangle = 3,
  46988. /** L1 */
  46989. L1 = 4,
  46990. /** R1 */
  46991. R1 = 5,
  46992. /** Share */
  46993. Share = 8,
  46994. /** Options */
  46995. Options = 9,
  46996. /** Left stick */
  46997. LeftStick = 10,
  46998. /** Right stick */
  46999. RightStick = 11
  47000. }
  47001. /** Defines values for DualShock DPad */
  47002. export enum DualShockDpad {
  47003. /** Up */
  47004. Up = 12,
  47005. /** Down */
  47006. Down = 13,
  47007. /** Left */
  47008. Left = 14,
  47009. /** Right */
  47010. Right = 15
  47011. }
  47012. /**
  47013. * Defines a DualShock gamepad
  47014. */
  47015. export class DualShockPad extends Gamepad {
  47016. private _leftTrigger;
  47017. private _rightTrigger;
  47018. private _onlefttriggerchanged;
  47019. private _onrighttriggerchanged;
  47020. private _onbuttondown;
  47021. private _onbuttonup;
  47022. private _ondpaddown;
  47023. private _ondpadup;
  47024. /** Observable raised when a button is pressed */
  47025. onButtonDownObservable: Observable<DualShockButton>;
  47026. /** Observable raised when a button is released */
  47027. onButtonUpObservable: Observable<DualShockButton>;
  47028. /** Observable raised when a pad is pressed */
  47029. onPadDownObservable: Observable<DualShockDpad>;
  47030. /** Observable raised when a pad is released */
  47031. onPadUpObservable: Observable<DualShockDpad>;
  47032. private _buttonCross;
  47033. private _buttonCircle;
  47034. private _buttonSquare;
  47035. private _buttonTriangle;
  47036. private _buttonShare;
  47037. private _buttonOptions;
  47038. private _buttonL1;
  47039. private _buttonR1;
  47040. private _buttonLeftStick;
  47041. private _buttonRightStick;
  47042. private _dPadUp;
  47043. private _dPadDown;
  47044. private _dPadLeft;
  47045. private _dPadRight;
  47046. /**
  47047. * Creates a new DualShock gamepad object
  47048. * @param id defines the id of this gamepad
  47049. * @param index defines its index
  47050. * @param gamepad defines the internal HTML gamepad object
  47051. */
  47052. constructor(id: string, index: number, gamepad: any);
  47053. /**
  47054. * Defines the callback to call when left trigger is pressed
  47055. * @param callback defines the callback to use
  47056. */
  47057. onlefttriggerchanged(callback: (value: number) => void): void;
  47058. /**
  47059. * Defines the callback to call when right trigger is pressed
  47060. * @param callback defines the callback to use
  47061. */
  47062. onrighttriggerchanged(callback: (value: number) => void): void;
  47063. /**
  47064. * Gets the left trigger value
  47065. */
  47066. get leftTrigger(): number;
  47067. /**
  47068. * Sets the left trigger value
  47069. */
  47070. set leftTrigger(newValue: number);
  47071. /**
  47072. * Gets the right trigger value
  47073. */
  47074. get rightTrigger(): number;
  47075. /**
  47076. * Sets the right trigger value
  47077. */
  47078. set rightTrigger(newValue: number);
  47079. /**
  47080. * Defines the callback to call when a button is pressed
  47081. * @param callback defines the callback to use
  47082. */
  47083. onbuttondown(callback: (buttonPressed: DualShockButton) => void): void;
  47084. /**
  47085. * Defines the callback to call when a button is released
  47086. * @param callback defines the callback to use
  47087. */
  47088. onbuttonup(callback: (buttonReleased: DualShockButton) => void): void;
  47089. /**
  47090. * Defines the callback to call when a pad is pressed
  47091. * @param callback defines the callback to use
  47092. */
  47093. ondpaddown(callback: (dPadPressed: DualShockDpad) => void): void;
  47094. /**
  47095. * Defines the callback to call when a pad is released
  47096. * @param callback defines the callback to use
  47097. */
  47098. ondpadup(callback: (dPadReleased: DualShockDpad) => void): void;
  47099. private _setButtonValue;
  47100. private _setDPadValue;
  47101. /**
  47102. * Gets the value of the `Cross` button
  47103. */
  47104. get buttonCross(): number;
  47105. /**
  47106. * Sets the value of the `Cross` button
  47107. */
  47108. set buttonCross(value: number);
  47109. /**
  47110. * Gets the value of the `Circle` button
  47111. */
  47112. get buttonCircle(): number;
  47113. /**
  47114. * Sets the value of the `Circle` button
  47115. */
  47116. set buttonCircle(value: number);
  47117. /**
  47118. * Gets the value of the `Square` button
  47119. */
  47120. get buttonSquare(): number;
  47121. /**
  47122. * Sets the value of the `Square` button
  47123. */
  47124. set buttonSquare(value: number);
  47125. /**
  47126. * Gets the value of the `Triangle` button
  47127. */
  47128. get buttonTriangle(): number;
  47129. /**
  47130. * Sets the value of the `Triangle` button
  47131. */
  47132. set buttonTriangle(value: number);
  47133. /**
  47134. * Gets the value of the `Options` button
  47135. */
  47136. get buttonOptions(): number;
  47137. /**
  47138. * Sets the value of the `Options` button
  47139. */
  47140. set buttonOptions(value: number);
  47141. /**
  47142. * Gets the value of the `Share` button
  47143. */
  47144. get buttonShare(): number;
  47145. /**
  47146. * Sets the value of the `Share` button
  47147. */
  47148. set buttonShare(value: number);
  47149. /**
  47150. * Gets the value of the `L1` button
  47151. */
  47152. get buttonL1(): number;
  47153. /**
  47154. * Sets the value of the `L1` button
  47155. */
  47156. set buttonL1(value: number);
  47157. /**
  47158. * Gets the value of the `R1` button
  47159. */
  47160. get buttonR1(): number;
  47161. /**
  47162. * Sets the value of the `R1` button
  47163. */
  47164. set buttonR1(value: number);
  47165. /**
  47166. * Gets the value of the Left joystick
  47167. */
  47168. get buttonLeftStick(): number;
  47169. /**
  47170. * Sets the value of the Left joystick
  47171. */
  47172. set buttonLeftStick(value: number);
  47173. /**
  47174. * Gets the value of the Right joystick
  47175. */
  47176. get buttonRightStick(): number;
  47177. /**
  47178. * Sets the value of the Right joystick
  47179. */
  47180. set buttonRightStick(value: number);
  47181. /**
  47182. * Gets the value of D-pad up
  47183. */
  47184. get dPadUp(): number;
  47185. /**
  47186. * Sets the value of D-pad up
  47187. */
  47188. set dPadUp(value: number);
  47189. /**
  47190. * Gets the value of D-pad down
  47191. */
  47192. get dPadDown(): number;
  47193. /**
  47194. * Sets the value of D-pad down
  47195. */
  47196. set dPadDown(value: number);
  47197. /**
  47198. * Gets the value of D-pad left
  47199. */
  47200. get dPadLeft(): number;
  47201. /**
  47202. * Sets the value of D-pad left
  47203. */
  47204. set dPadLeft(value: number);
  47205. /**
  47206. * Gets the value of D-pad right
  47207. */
  47208. get dPadRight(): number;
  47209. /**
  47210. * Sets the value of D-pad right
  47211. */
  47212. set dPadRight(value: number);
  47213. /**
  47214. * Force the gamepad to synchronize with device values
  47215. */
  47216. update(): void;
  47217. /**
  47218. * Disposes the gamepad
  47219. */
  47220. dispose(): void;
  47221. }
  47222. }
  47223. declare module "babylonjs/Gamepads/gamepadManager" {
  47224. import { Observable } from "babylonjs/Misc/observable";
  47225. import { Nullable } from "babylonjs/types";
  47226. import { Scene } from "babylonjs/scene";
  47227. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  47228. /**
  47229. * Manager for handling gamepads
  47230. */
  47231. export class GamepadManager {
  47232. private _scene?;
  47233. private _babylonGamepads;
  47234. private _oneGamepadConnected;
  47235. /** @hidden */
  47236. _isMonitoring: boolean;
  47237. private _gamepadEventSupported;
  47238. private _gamepadSupport?;
  47239. /**
  47240. * observable to be triggered when the gamepad controller has been connected
  47241. */
  47242. onGamepadConnectedObservable: Observable<Gamepad>;
  47243. /**
  47244. * observable to be triggered when the gamepad controller has been disconnected
  47245. */
  47246. onGamepadDisconnectedObservable: Observable<Gamepad>;
  47247. private _onGamepadConnectedEvent;
  47248. private _onGamepadDisconnectedEvent;
  47249. /**
  47250. * Initializes the gamepad manager
  47251. * @param _scene BabylonJS scene
  47252. */
  47253. constructor(_scene?: Scene | undefined);
  47254. /**
  47255. * The gamepads in the game pad manager
  47256. */
  47257. get gamepads(): Gamepad[];
  47258. /**
  47259. * Get the gamepad controllers based on type
  47260. * @param type The type of gamepad controller
  47261. * @returns Nullable gamepad
  47262. */
  47263. getGamepadByType(type?: number): Nullable<Gamepad>;
  47264. /**
  47265. * Disposes the gamepad manager
  47266. */
  47267. dispose(): void;
  47268. private _addNewGamepad;
  47269. private _startMonitoringGamepads;
  47270. private _stopMonitoringGamepads;
  47271. /** @hidden */
  47272. _checkGamepadsStatus(): void;
  47273. private _updateGamepadObjects;
  47274. }
  47275. }
  47276. declare module "babylonjs/Gamepads/gamepadSceneComponent" {
  47277. import { Nullable } from "babylonjs/types";
  47278. import { Scene } from "babylonjs/scene";
  47279. import { ISceneComponent } from "babylonjs/sceneComponent";
  47280. import { GamepadManager } from "babylonjs/Gamepads/gamepadManager";
  47281. module "babylonjs/scene" {
  47282. interface Scene {
  47283. /** @hidden */
  47284. _gamepadManager: Nullable<GamepadManager>;
  47285. /**
  47286. * Gets the gamepad manager associated with the scene
  47287. * @see https://doc.babylonjs.com/how_to/how_to_use_gamepads
  47288. */
  47289. gamepadManager: GamepadManager;
  47290. }
  47291. }
  47292. module "babylonjs/Cameras/freeCameraInputsManager" {
  47293. /**
  47294. * Interface representing a free camera inputs manager
  47295. */
  47296. interface FreeCameraInputsManager {
  47297. /**
  47298. * Adds gamepad input support to the FreeCameraInputsManager.
  47299. * @returns the FreeCameraInputsManager
  47300. */
  47301. addGamepad(): FreeCameraInputsManager;
  47302. }
  47303. }
  47304. module "babylonjs/Cameras/arcRotateCameraInputsManager" {
  47305. /**
  47306. * Interface representing an arc rotate camera inputs manager
  47307. */
  47308. interface ArcRotateCameraInputsManager {
  47309. /**
  47310. * Adds gamepad input support to the ArcRotateCamera InputManager.
  47311. * @returns the camera inputs manager
  47312. */
  47313. addGamepad(): ArcRotateCameraInputsManager;
  47314. }
  47315. }
  47316. /**
  47317. * Defines the gamepad scene component responsible to manage gamepads in a given scene
  47318. */
  47319. export class GamepadSystemSceneComponent implements ISceneComponent {
  47320. /**
  47321. * The component name helpfull to identify the component in the list of scene components.
  47322. */
  47323. readonly name: string;
  47324. /**
  47325. * The scene the component belongs to.
  47326. */
  47327. scene: Scene;
  47328. /**
  47329. * Creates a new instance of the component for the given scene
  47330. * @param scene Defines the scene to register the component in
  47331. */
  47332. constructor(scene: Scene);
  47333. /**
  47334. * Registers the component in a given scene
  47335. */
  47336. register(): void;
  47337. /**
  47338. * Rebuilds the elements related to this component in case of
  47339. * context lost for instance.
  47340. */
  47341. rebuild(): void;
  47342. /**
  47343. * Disposes the component and the associated ressources
  47344. */
  47345. dispose(): void;
  47346. private _beforeCameraUpdate;
  47347. }
  47348. }
  47349. declare module "babylonjs/Cameras/universalCamera" {
  47350. import { TouchCamera } from "babylonjs/Cameras/touchCamera";
  47351. import { Scene } from "babylonjs/scene";
  47352. import { Vector3 } from "babylonjs/Maths/math.vector";
  47353. import "babylonjs/Gamepads/gamepadSceneComponent";
  47354. /**
  47355. * 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,
  47356. * which still works and will still be found in many Playgrounds.
  47357. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  47358. */
  47359. export class UniversalCamera extends TouchCamera {
  47360. /**
  47361. * Defines the gamepad rotation sensiblity.
  47362. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  47363. */
  47364. get gamepadAngularSensibility(): number;
  47365. set gamepadAngularSensibility(value: number);
  47366. /**
  47367. * Defines the gamepad move sensiblity.
  47368. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  47369. */
  47370. get gamepadMoveSensibility(): number;
  47371. set gamepadMoveSensibility(value: number);
  47372. /**
  47373. * 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,
  47374. * which still works and will still be found in many Playgrounds.
  47375. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  47376. * @param name Define the name of the camera in the scene
  47377. * @param position Define the start position of the camera in the scene
  47378. * @param scene Define the scene the camera belongs to
  47379. */
  47380. constructor(name: string, position: Vector3, scene: Scene);
  47381. /**
  47382. * Gets the current object class name.
  47383. * @return the class name
  47384. */
  47385. getClassName(): string;
  47386. }
  47387. }
  47388. declare module "babylonjs/Cameras/gamepadCamera" {
  47389. import { UniversalCamera } from "babylonjs/Cameras/universalCamera";
  47390. import { Scene } from "babylonjs/scene";
  47391. import { Vector3 } from "babylonjs/Maths/math.vector";
  47392. /**
  47393. * This represents a FPS type of camera. This is only here for back compat purpose.
  47394. * Please use the UniversalCamera instead as both are identical.
  47395. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  47396. */
  47397. export class GamepadCamera extends UniversalCamera {
  47398. /**
  47399. * Instantiates a new Gamepad Camera
  47400. * This represents a FPS type of camera. This is only here for back compat purpose.
  47401. * Please use the UniversalCamera instead as both are identical.
  47402. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  47403. * @param name Define the name of the camera in the scene
  47404. * @param position Define the start position of the camera in the scene
  47405. * @param scene Define the scene the camera belongs to
  47406. */
  47407. constructor(name: string, position: Vector3, scene: Scene);
  47408. /**
  47409. * Gets the current object class name.
  47410. * @return the class name
  47411. */
  47412. getClassName(): string;
  47413. }
  47414. }
  47415. declare module "babylonjs/Shaders/pass.fragment" {
  47416. /** @hidden */
  47417. export var passPixelShader: {
  47418. name: string;
  47419. shader: string;
  47420. };
  47421. }
  47422. declare module "babylonjs/Shaders/passCube.fragment" {
  47423. /** @hidden */
  47424. export var passCubePixelShader: {
  47425. name: string;
  47426. shader: string;
  47427. };
  47428. }
  47429. declare module "babylonjs/PostProcesses/passPostProcess" {
  47430. import { Nullable } from "babylonjs/types";
  47431. import { Camera } from "babylonjs/Cameras/camera";
  47432. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  47433. import { Engine } from "babylonjs/Engines/engine";
  47434. import "babylonjs/Shaders/pass.fragment";
  47435. import "babylonjs/Shaders/passCube.fragment";
  47436. /**
  47437. * PassPostProcess which produces an output the same as it's input
  47438. */
  47439. export class PassPostProcess extends PostProcess {
  47440. /**
  47441. * Creates the PassPostProcess
  47442. * @param name The name of the effect.
  47443. * @param options The required width/height ratio to downsize to before computing the render pass.
  47444. * @param camera The camera to apply the render pass to.
  47445. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  47446. * @param engine The engine which the post process will be applied. (default: current engine)
  47447. * @param reusable If the post process can be reused on the same frame. (default: false)
  47448. * @param textureType The type of texture to be used when performing the post processing.
  47449. * @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)
  47450. */
  47451. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  47452. }
  47453. /**
  47454. * PassCubePostProcess which produces an output the same as it's input (which must be a cube texture)
  47455. */
  47456. export class PassCubePostProcess extends PostProcess {
  47457. private _face;
  47458. /**
  47459. * Gets or sets the cube face to display.
  47460. * * 0 is +X
  47461. * * 1 is -X
  47462. * * 2 is +Y
  47463. * * 3 is -Y
  47464. * * 4 is +Z
  47465. * * 5 is -Z
  47466. */
  47467. get face(): number;
  47468. set face(value: number);
  47469. /**
  47470. * Creates the PassCubePostProcess
  47471. * @param name The name of the effect.
  47472. * @param options The required width/height ratio to downsize to before computing the render pass.
  47473. * @param camera The camera to apply the render pass to.
  47474. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  47475. * @param engine The engine which the post process will be applied. (default: current engine)
  47476. * @param reusable If the post process can be reused on the same frame. (default: false)
  47477. * @param textureType The type of texture to be used when performing the post processing.
  47478. * @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)
  47479. */
  47480. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  47481. }
  47482. }
  47483. declare module "babylonjs/Shaders/anaglyph.fragment" {
  47484. /** @hidden */
  47485. export var anaglyphPixelShader: {
  47486. name: string;
  47487. shader: string;
  47488. };
  47489. }
  47490. declare module "babylonjs/PostProcesses/anaglyphPostProcess" {
  47491. import { Engine } from "babylonjs/Engines/engine";
  47492. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  47493. import { Camera } from "babylonjs/Cameras/camera";
  47494. import "babylonjs/Shaders/anaglyph.fragment";
  47495. /**
  47496. * Postprocess used to generate anaglyphic rendering
  47497. */
  47498. export class AnaglyphPostProcess extends PostProcess {
  47499. private _passedProcess;
  47500. /**
  47501. * Creates a new AnaglyphPostProcess
  47502. * @param name defines postprocess name
  47503. * @param options defines creation options or target ratio scale
  47504. * @param rigCameras defines cameras using this postprocess
  47505. * @param samplingMode defines required sampling mode (BABYLON.Texture.NEAREST_SAMPLINGMODE by default)
  47506. * @param engine defines hosting engine
  47507. * @param reusable defines if the postprocess will be reused multiple times per frame
  47508. */
  47509. constructor(name: string, options: number | PostProcessOptions, rigCameras: Camera[], samplingMode?: number, engine?: Engine, reusable?: boolean);
  47510. }
  47511. }
  47512. declare module "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode" { }
  47513. declare module "babylonjs/Cameras/Stereoscopic/anaglyphArcRotateCamera" {
  47514. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  47515. import { Scene } from "babylonjs/scene";
  47516. import { Vector3 } from "babylonjs/Maths/math.vector";
  47517. import "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  47518. /**
  47519. * Camera used to simulate anaglyphic rendering (based on ArcRotateCamera)
  47520. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  47521. */
  47522. export class AnaglyphArcRotateCamera extends ArcRotateCamera {
  47523. /**
  47524. * Creates a new AnaglyphArcRotateCamera
  47525. * @param name defines camera name
  47526. * @param alpha defines alpha angle (in radians)
  47527. * @param beta defines beta angle (in radians)
  47528. * @param radius defines radius
  47529. * @param target defines camera target
  47530. * @param interaxialDistance defines distance between each color axis
  47531. * @param scene defines the hosting scene
  47532. */
  47533. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, interaxialDistance: number, scene: Scene);
  47534. /**
  47535. * Gets camera class name
  47536. * @returns AnaglyphArcRotateCamera
  47537. */
  47538. getClassName(): string;
  47539. }
  47540. }
  47541. declare module "babylonjs/Cameras/Stereoscopic/anaglyphFreeCamera" {
  47542. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  47543. import { Scene } from "babylonjs/scene";
  47544. import { Vector3 } from "babylonjs/Maths/math.vector";
  47545. import "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  47546. /**
  47547. * Camera used to simulate anaglyphic rendering (based on FreeCamera)
  47548. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  47549. */
  47550. export class AnaglyphFreeCamera extends FreeCamera {
  47551. /**
  47552. * Creates a new AnaglyphFreeCamera
  47553. * @param name defines camera name
  47554. * @param position defines initial position
  47555. * @param interaxialDistance defines distance between each color axis
  47556. * @param scene defines the hosting scene
  47557. */
  47558. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  47559. /**
  47560. * Gets camera class name
  47561. * @returns AnaglyphFreeCamera
  47562. */
  47563. getClassName(): string;
  47564. }
  47565. }
  47566. declare module "babylonjs/Cameras/Stereoscopic/anaglyphGamepadCamera" {
  47567. import { GamepadCamera } from "babylonjs/Cameras/gamepadCamera";
  47568. import { Scene } from "babylonjs/scene";
  47569. import { Vector3 } from "babylonjs/Maths/math.vector";
  47570. import "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  47571. /**
  47572. * Camera used to simulate anaglyphic rendering (based on GamepadCamera)
  47573. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  47574. */
  47575. export class AnaglyphGamepadCamera extends GamepadCamera {
  47576. /**
  47577. * Creates a new AnaglyphGamepadCamera
  47578. * @param name defines camera name
  47579. * @param position defines initial position
  47580. * @param interaxialDistance defines distance between each color axis
  47581. * @param scene defines the hosting scene
  47582. */
  47583. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  47584. /**
  47585. * Gets camera class name
  47586. * @returns AnaglyphGamepadCamera
  47587. */
  47588. getClassName(): string;
  47589. }
  47590. }
  47591. declare module "babylonjs/Cameras/Stereoscopic/anaglyphUniversalCamera" {
  47592. import { UniversalCamera } from "babylonjs/Cameras/universalCamera";
  47593. import { Scene } from "babylonjs/scene";
  47594. import { Vector3 } from "babylonjs/Maths/math.vector";
  47595. import "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  47596. /**
  47597. * Camera used to simulate anaglyphic rendering (based on UniversalCamera)
  47598. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  47599. */
  47600. export class AnaglyphUniversalCamera extends UniversalCamera {
  47601. /**
  47602. * Creates a new AnaglyphUniversalCamera
  47603. * @param name defines camera name
  47604. * @param position defines initial position
  47605. * @param interaxialDistance defines distance between each color axis
  47606. * @param scene defines the hosting scene
  47607. */
  47608. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  47609. /**
  47610. * Gets camera class name
  47611. * @returns AnaglyphUniversalCamera
  47612. */
  47613. getClassName(): string;
  47614. }
  47615. }
  47616. declare module "babylonjs/Cameras/RigModes/stereoscopicRigMode" { }
  47617. declare module "babylonjs/Cameras/Stereoscopic/stereoscopicArcRotateCamera" {
  47618. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  47619. import { Scene } from "babylonjs/scene";
  47620. import { Vector3 } from "babylonjs/Maths/math.vector";
  47621. import "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  47622. /**
  47623. * Camera used to simulate stereoscopic rendering (based on ArcRotateCamera)
  47624. * @see https://doc.babylonjs.com/features/cameras
  47625. */
  47626. export class StereoscopicArcRotateCamera extends ArcRotateCamera {
  47627. /**
  47628. * Creates a new StereoscopicArcRotateCamera
  47629. * @param name defines camera name
  47630. * @param alpha defines alpha angle (in radians)
  47631. * @param beta defines beta angle (in radians)
  47632. * @param radius defines radius
  47633. * @param target defines camera target
  47634. * @param interaxialDistance defines distance between each color axis
  47635. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  47636. * @param scene defines the hosting scene
  47637. */
  47638. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  47639. /**
  47640. * Gets camera class name
  47641. * @returns StereoscopicArcRotateCamera
  47642. */
  47643. getClassName(): string;
  47644. }
  47645. }
  47646. declare module "babylonjs/Cameras/Stereoscopic/stereoscopicFreeCamera" {
  47647. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  47648. import { Scene } from "babylonjs/scene";
  47649. import { Vector3 } from "babylonjs/Maths/math.vector";
  47650. import "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  47651. /**
  47652. * Camera used to simulate stereoscopic rendering (based on FreeCamera)
  47653. * @see https://doc.babylonjs.com/features/cameras
  47654. */
  47655. export class StereoscopicFreeCamera extends FreeCamera {
  47656. /**
  47657. * Creates a new StereoscopicFreeCamera
  47658. * @param name defines camera name
  47659. * @param position defines initial position
  47660. * @param interaxialDistance defines distance between each color axis
  47661. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  47662. * @param scene defines the hosting scene
  47663. */
  47664. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  47665. /**
  47666. * Gets camera class name
  47667. * @returns StereoscopicFreeCamera
  47668. */
  47669. getClassName(): string;
  47670. }
  47671. }
  47672. declare module "babylonjs/Cameras/Stereoscopic/stereoscopicGamepadCamera" {
  47673. import { GamepadCamera } from "babylonjs/Cameras/gamepadCamera";
  47674. import { Scene } from "babylonjs/scene";
  47675. import { Vector3 } from "babylonjs/Maths/math.vector";
  47676. import "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  47677. /**
  47678. * Camera used to simulate stereoscopic rendering (based on GamepadCamera)
  47679. * @see https://doc.babylonjs.com/features/cameras
  47680. */
  47681. export class StereoscopicGamepadCamera extends GamepadCamera {
  47682. /**
  47683. * Creates a new StereoscopicGamepadCamera
  47684. * @param name defines camera name
  47685. * @param position defines initial position
  47686. * @param interaxialDistance defines distance between each color axis
  47687. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  47688. * @param scene defines the hosting scene
  47689. */
  47690. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  47691. /**
  47692. * Gets camera class name
  47693. * @returns StereoscopicGamepadCamera
  47694. */
  47695. getClassName(): string;
  47696. }
  47697. }
  47698. declare module "babylonjs/Cameras/Stereoscopic/stereoscopicUniversalCamera" {
  47699. import { UniversalCamera } from "babylonjs/Cameras/universalCamera";
  47700. import { Scene } from "babylonjs/scene";
  47701. import { Vector3 } from "babylonjs/Maths/math.vector";
  47702. import "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  47703. /**
  47704. * Camera used to simulate stereoscopic rendering (based on UniversalCamera)
  47705. * @see https://doc.babylonjs.com/features/cameras
  47706. */
  47707. export class StereoscopicUniversalCamera extends UniversalCamera {
  47708. /**
  47709. * Creates a new StereoscopicUniversalCamera
  47710. * @param name defines camera name
  47711. * @param position defines initial position
  47712. * @param interaxialDistance defines distance between each color axis
  47713. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  47714. * @param scene defines the hosting scene
  47715. */
  47716. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  47717. /**
  47718. * Gets camera class name
  47719. * @returns StereoscopicUniversalCamera
  47720. */
  47721. getClassName(): string;
  47722. }
  47723. }
  47724. declare module "babylonjs/Cameras/Stereoscopic/index" {
  47725. export * from "babylonjs/Cameras/Stereoscopic/anaglyphArcRotateCamera";
  47726. export * from "babylonjs/Cameras/Stereoscopic/anaglyphFreeCamera";
  47727. export * from "babylonjs/Cameras/Stereoscopic/anaglyphGamepadCamera";
  47728. export * from "babylonjs/Cameras/Stereoscopic/anaglyphUniversalCamera";
  47729. export * from "babylonjs/Cameras/Stereoscopic/stereoscopicArcRotateCamera";
  47730. export * from "babylonjs/Cameras/Stereoscopic/stereoscopicFreeCamera";
  47731. export * from "babylonjs/Cameras/Stereoscopic/stereoscopicGamepadCamera";
  47732. export * from "babylonjs/Cameras/Stereoscopic/stereoscopicUniversalCamera";
  47733. }
  47734. declare module "babylonjs/Cameras/virtualJoysticksCamera" {
  47735. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  47736. import { Scene } from "babylonjs/scene";
  47737. import { Vector3 } from "babylonjs/Maths/math.vector";
  47738. import "babylonjs/Cameras/Inputs/freeCameraVirtualJoystickInput";
  47739. /**
  47740. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  47741. * It is identical to the Free Camera and simply adds by default a virtual joystick.
  47742. * Virtual Joysticks are on-screen 2D graphics that are used to control the camera or other scene items.
  47743. * @see https://doc.babylonjs.com/features/cameras#virtual-joysticks-camera
  47744. */
  47745. export class VirtualJoysticksCamera extends FreeCamera {
  47746. /**
  47747. * Intantiates a VirtualJoysticksCamera. It can be useful in First Person Shooter game for instance.
  47748. * It is identical to the Free Camera and simply adds by default a virtual joystick.
  47749. * Virtual Joysticks are on-screen 2D graphics that are used to control the camera or other scene items.
  47750. * @see https://doc.babylonjs.com/features/cameras#virtual-joysticks-camera
  47751. * @param name Define the name of the camera in the scene
  47752. * @param position Define the start position of the camera in the scene
  47753. * @param scene Define the scene the camera belongs to
  47754. */
  47755. constructor(name: string, position: Vector3, scene: Scene);
  47756. /**
  47757. * Gets the current object class name.
  47758. * @return the class name
  47759. */
  47760. getClassName(): string;
  47761. }
  47762. }
  47763. declare module "babylonjs/Cameras/VR/vrCameraMetrics" {
  47764. import { Matrix } from "babylonjs/Maths/math.vector";
  47765. /**
  47766. * This represents all the required metrics to create a VR camera.
  47767. * @see https://doc.babylonjs.com/babylon101/cameras#device-orientation-camera
  47768. */
  47769. export class VRCameraMetrics {
  47770. /**
  47771. * Define the horizontal resolution off the screen.
  47772. */
  47773. hResolution: number;
  47774. /**
  47775. * Define the vertical resolution off the screen.
  47776. */
  47777. vResolution: number;
  47778. /**
  47779. * Define the horizontal screen size.
  47780. */
  47781. hScreenSize: number;
  47782. /**
  47783. * Define the vertical screen size.
  47784. */
  47785. vScreenSize: number;
  47786. /**
  47787. * Define the vertical screen center position.
  47788. */
  47789. vScreenCenter: number;
  47790. /**
  47791. * Define the distance of the eyes to the screen.
  47792. */
  47793. eyeToScreenDistance: number;
  47794. /**
  47795. * Define the distance between both lenses
  47796. */
  47797. lensSeparationDistance: number;
  47798. /**
  47799. * Define the distance between both viewer's eyes.
  47800. */
  47801. interpupillaryDistance: number;
  47802. /**
  47803. * Define the distortion factor of the VR postprocess.
  47804. * Please, touch with care.
  47805. */
  47806. distortionK: number[];
  47807. /**
  47808. * Define the chromatic aberration correction factors for the VR post process.
  47809. */
  47810. chromaAbCorrection: number[];
  47811. /**
  47812. * Define the scale factor of the post process.
  47813. * The smaller the better but the slower.
  47814. */
  47815. postProcessScaleFactor: number;
  47816. /**
  47817. * Define an offset for the lens center.
  47818. */
  47819. lensCenterOffset: number;
  47820. /**
  47821. * Define if the current vr camera should compensate the distortion of the lense or not.
  47822. */
  47823. compensateDistortion: boolean;
  47824. /**
  47825. * Defines if multiview should be enabled when rendering (Default: false)
  47826. */
  47827. multiviewEnabled: boolean;
  47828. /**
  47829. * Gets the rendering aspect ratio based on the provided resolutions.
  47830. */
  47831. get aspectRatio(): number;
  47832. /**
  47833. * Gets the aspect ratio based on the FOV, scale factors, and real screen sizes.
  47834. */
  47835. get aspectRatioFov(): number;
  47836. /**
  47837. * @hidden
  47838. */
  47839. get leftHMatrix(): Matrix;
  47840. /**
  47841. * @hidden
  47842. */
  47843. get rightHMatrix(): Matrix;
  47844. /**
  47845. * @hidden
  47846. */
  47847. get leftPreViewMatrix(): Matrix;
  47848. /**
  47849. * @hidden
  47850. */
  47851. get rightPreViewMatrix(): Matrix;
  47852. /**
  47853. * Get the default VRMetrics based on the most generic setup.
  47854. * @returns the default vr metrics
  47855. */
  47856. static GetDefault(): VRCameraMetrics;
  47857. }
  47858. }
  47859. declare module "babylonjs/Shaders/vrDistortionCorrection.fragment" {
  47860. /** @hidden */
  47861. export var vrDistortionCorrectionPixelShader: {
  47862. name: string;
  47863. shader: string;
  47864. };
  47865. }
  47866. declare module "babylonjs/PostProcesses/vrDistortionCorrectionPostProcess" {
  47867. import { Camera } from "babylonjs/Cameras/camera";
  47868. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  47869. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  47870. import "babylonjs/Shaders/vrDistortionCorrection.fragment";
  47871. /**
  47872. * VRDistortionCorrectionPostProcess used for mobile VR
  47873. */
  47874. export class VRDistortionCorrectionPostProcess extends PostProcess {
  47875. private _isRightEye;
  47876. private _distortionFactors;
  47877. private _postProcessScaleFactor;
  47878. private _lensCenterOffset;
  47879. private _scaleIn;
  47880. private _scaleFactor;
  47881. private _lensCenter;
  47882. /**
  47883. * Initializes the VRDistortionCorrectionPostProcess
  47884. * @param name The name of the effect.
  47885. * @param camera The camera to apply the render pass to.
  47886. * @param isRightEye If this is for the right eye distortion
  47887. * @param vrMetrics All the required metrics for the VR camera
  47888. */
  47889. constructor(name: string, camera: Camera, isRightEye: boolean, vrMetrics: VRCameraMetrics);
  47890. }
  47891. }
  47892. declare module "babylonjs/Cameras/RigModes/vrRigMode" { }
  47893. declare module "babylonjs/Cameras/VR/vrDeviceOrientationArcRotateCamera" {
  47894. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  47895. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  47896. import { Scene } from "babylonjs/scene";
  47897. import { Vector3 } from "babylonjs/Maths/math.vector";
  47898. import "babylonjs/Cameras/Inputs/arcRotateCameraVRDeviceOrientationInput";
  47899. import "babylonjs/Cameras/RigModes/vrRigMode";
  47900. /**
  47901. * Camera used to simulate VR rendering (based on ArcRotateCamera)
  47902. * @see https://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  47903. */
  47904. export class VRDeviceOrientationArcRotateCamera extends ArcRotateCamera {
  47905. /**
  47906. * Creates a new VRDeviceOrientationArcRotateCamera
  47907. * @param name defines camera name
  47908. * @param alpha defines the camera rotation along the logitudinal axis
  47909. * @param beta defines the camera rotation along the latitudinal axis
  47910. * @param radius defines the camera distance from its target
  47911. * @param target defines the camera target
  47912. * @param scene defines the scene the camera belongs to
  47913. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  47914. * @param vrCameraMetrics defines the vr metrics associated to the camera
  47915. */
  47916. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  47917. /**
  47918. * Gets camera class name
  47919. * @returns VRDeviceOrientationArcRotateCamera
  47920. */
  47921. getClassName(): string;
  47922. }
  47923. }
  47924. declare module "babylonjs/Cameras/VR/vrDeviceOrientationFreeCamera" {
  47925. import { DeviceOrientationCamera } from "babylonjs/Cameras/deviceOrientationCamera";
  47926. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  47927. import { Scene } from "babylonjs/scene";
  47928. import { Vector3 } from "babylonjs/Maths/math.vector";
  47929. import "babylonjs/Cameras/RigModes/vrRigMode";
  47930. /**
  47931. * Camera used to simulate VR rendering (based on FreeCamera)
  47932. * @see https://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  47933. */
  47934. export class VRDeviceOrientationFreeCamera extends DeviceOrientationCamera {
  47935. /**
  47936. * Creates a new VRDeviceOrientationFreeCamera
  47937. * @param name defines camera name
  47938. * @param position defines the start position of the camera
  47939. * @param scene defines the scene the camera belongs to
  47940. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  47941. * @param vrCameraMetrics defines the vr metrics associated to the camera
  47942. */
  47943. constructor(name: string, position: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  47944. /**
  47945. * Gets camera class name
  47946. * @returns VRDeviceOrientationFreeCamera
  47947. */
  47948. getClassName(): string;
  47949. }
  47950. }
  47951. declare module "babylonjs/Cameras/VR/vrDeviceOrientationGamepadCamera" {
  47952. import { VRDeviceOrientationFreeCamera } from "babylonjs/Cameras/VR/vrDeviceOrientationFreeCamera";
  47953. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  47954. import { Scene } from "babylonjs/scene";
  47955. import { Vector3 } from "babylonjs/Maths/math.vector";
  47956. import "babylonjs/Gamepads/gamepadSceneComponent";
  47957. /**
  47958. * Camera used to simulate VR rendering (based on VRDeviceOrientationFreeCamera)
  47959. * @see https://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  47960. */
  47961. export class VRDeviceOrientationGamepadCamera extends VRDeviceOrientationFreeCamera {
  47962. /**
  47963. * Creates a new VRDeviceOrientationGamepadCamera
  47964. * @param name defines camera name
  47965. * @param position defines the start position of the camera
  47966. * @param scene defines the scene the camera belongs to
  47967. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  47968. * @param vrCameraMetrics defines the vr metrics associated to the camera
  47969. */
  47970. constructor(name: string, position: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  47971. /**
  47972. * Gets camera class name
  47973. * @returns VRDeviceOrientationGamepadCamera
  47974. */
  47975. getClassName(): string;
  47976. }
  47977. }
  47978. declare module "babylonjs/Materials/Textures/dynamicTexture" {
  47979. import { Scene } from "babylonjs/scene";
  47980. import { Texture } from "babylonjs/Materials/Textures/texture";
  47981. import "babylonjs/Engines/Extensions/engine.dynamicTexture";
  47982. /**
  47983. * A class extending Texture allowing drawing on a texture
  47984. * @see https://doc.babylonjs.com/how_to/dynamictexture
  47985. */
  47986. export class DynamicTexture extends Texture {
  47987. private _generateMipMaps;
  47988. private _canvas;
  47989. private _context;
  47990. /**
  47991. * Creates a DynamicTexture
  47992. * @param name defines the name of the texture
  47993. * @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
  47994. * @param scene defines the scene where you want the texture
  47995. * @param generateMipMaps defines the use of MinMaps or not (default is false)
  47996. * @param samplingMode defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  47997. * @param format defines the texture format to use (default is Engine.TEXTUREFORMAT_RGBA)
  47998. */
  47999. constructor(name: string, options: any, scene: Scene | null | undefined, generateMipMaps: boolean, samplingMode?: number, format?: number);
  48000. /**
  48001. * Get the current class name of the texture useful for serialization or dynamic coding.
  48002. * @returns "DynamicTexture"
  48003. */
  48004. getClassName(): string;
  48005. /**
  48006. * Gets the current state of canRescale
  48007. */
  48008. get canRescale(): boolean;
  48009. private _recreate;
  48010. /**
  48011. * Scales the texture
  48012. * @param ratio the scale factor to apply to both width and height
  48013. */
  48014. scale(ratio: number): void;
  48015. /**
  48016. * Resizes the texture
  48017. * @param width the new width
  48018. * @param height the new height
  48019. */
  48020. scaleTo(width: number, height: number): void;
  48021. /**
  48022. * Gets the context of the canvas used by the texture
  48023. * @returns the canvas context of the dynamic texture
  48024. */
  48025. getContext(): CanvasRenderingContext2D;
  48026. /**
  48027. * Clears the texture
  48028. */
  48029. clear(): void;
  48030. /**
  48031. * Updates the texture
  48032. * @param invertY defines the direction for the Y axis (default is true - y increases downwards)
  48033. * @param premulAlpha defines if alpha is stored as premultiplied (default is false)
  48034. */
  48035. update(invertY?: boolean, premulAlpha?: boolean): void;
  48036. /**
  48037. * Draws text onto the texture
  48038. * @param text defines the text to be drawn
  48039. * @param x defines the placement of the text from the left
  48040. * @param y defines the placement of the text from the top when invertY is true and from the bottom when false
  48041. * @param font defines the font to be used with font-style, font-size, font-name
  48042. * @param color defines the color used for the text
  48043. * @param clearColor defines the color for the canvas, use null to not overwrite canvas
  48044. * @param invertY defines the direction for the Y axis (default is true - y increases downwards)
  48045. * @param update defines whether texture is immediately update (default is true)
  48046. */
  48047. drawText(text: string, x: number | null | undefined, y: number | null | undefined, font: string, color: string | null, clearColor: string, invertY?: boolean, update?: boolean): void;
  48048. /**
  48049. * Clones the texture
  48050. * @returns the clone of the texture.
  48051. */
  48052. clone(): DynamicTexture;
  48053. /**
  48054. * Serializes the dynamic texture. The scene should be ready before the dynamic texture is serialized
  48055. * @returns a serialized dynamic texture object
  48056. */
  48057. serialize(): any;
  48058. private _IsCanvasElement;
  48059. /** @hidden */
  48060. _rebuild(): void;
  48061. }
  48062. }
  48063. declare module "babylonjs/Meshes/Builders/groundBuilder" {
  48064. import { Scene } from "babylonjs/scene";
  48065. import { Color3 } from "babylonjs/Maths/math.color";
  48066. import { Mesh } from "babylonjs/Meshes/mesh";
  48067. import { GroundMesh } from "babylonjs/Meshes/groundMesh";
  48068. import { Nullable } from "babylonjs/types";
  48069. /**
  48070. * Class containing static functions to help procedurally build meshes
  48071. */
  48072. export class GroundBuilder {
  48073. /**
  48074. * Creates a ground mesh
  48075. * * The parameters `width` and `height` (floats, default 1) set the width and height sizes of the ground
  48076. * * The parameter `subdivisions` (positive integer) sets the number of subdivisions per side
  48077. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  48078. * @param name defines the name of the mesh
  48079. * @param options defines the options used to create the mesh
  48080. * @param scene defines the hosting scene
  48081. * @returns the ground mesh
  48082. * @see https://doc.babylonjs.com/how_to/set_shapes#ground
  48083. */
  48084. static CreateGround(name: string, options: {
  48085. width?: number;
  48086. height?: number;
  48087. subdivisions?: number;
  48088. subdivisionsX?: number;
  48089. subdivisionsY?: number;
  48090. updatable?: boolean;
  48091. }, scene: any): Mesh;
  48092. /**
  48093. * Creates a tiled ground mesh
  48094. * * The parameters `xmin` and `xmax` (floats, default -1 and 1) set the ground minimum and maximum X coordinates
  48095. * * The parameters `zmin` and `zmax` (floats, default -1 and 1) set the ground minimum and maximum Z coordinates
  48096. * * 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
  48097. * * 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
  48098. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  48099. * @param name defines the name of the mesh
  48100. * @param options defines the options used to create the mesh
  48101. * @param scene defines the hosting scene
  48102. * @returns the tiled ground mesh
  48103. * @see https://doc.babylonjs.com/how_to/set_shapes#tiled-ground
  48104. */
  48105. static CreateTiledGround(name: string, options: {
  48106. xmin: number;
  48107. zmin: number;
  48108. xmax: number;
  48109. zmax: number;
  48110. subdivisions?: {
  48111. w: number;
  48112. h: number;
  48113. };
  48114. precision?: {
  48115. w: number;
  48116. h: number;
  48117. };
  48118. updatable?: boolean;
  48119. }, scene?: Nullable<Scene>): Mesh;
  48120. /**
  48121. * Creates a ground mesh from a height map
  48122. * * The parameter `url` sets the URL of the height map image resource.
  48123. * * The parameters `width` and `height` (positive floats, default 10) set the ground width and height sizes.
  48124. * * The parameter `subdivisions` (positive integer, default 1) sets the number of subdivision per side.
  48125. * * The parameter `minHeight` (float, default 0) is the minimum altitude on the ground.
  48126. * * The parameter `maxHeight` (float, default 1) is the maximum altitude on the ground.
  48127. * * 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.
  48128. * * 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).
  48129. * * The parameter `alphaFilter` will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  48130. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  48131. * @param name defines the name of the mesh
  48132. * @param url defines the url to the height map
  48133. * @param options defines the options used to create the mesh
  48134. * @param scene defines the hosting scene
  48135. * @returns the ground mesh
  48136. * @see https://doc.babylonjs.com/babylon101/height_map
  48137. * @see https://doc.babylonjs.com/how_to/set_shapes#ground-from-a-height-map
  48138. */
  48139. static CreateGroundFromHeightMap(name: string, url: string, options: {
  48140. width?: number;
  48141. height?: number;
  48142. subdivisions?: number;
  48143. minHeight?: number;
  48144. maxHeight?: number;
  48145. colorFilter?: Color3;
  48146. alphaFilter?: number;
  48147. updatable?: boolean;
  48148. onReady?: (mesh: GroundMesh) => void;
  48149. }, scene?: Nullable<Scene>): GroundMesh;
  48150. }
  48151. }
  48152. declare module "babylonjs/Meshes/Builders/torusBuilder" {
  48153. import { Vector4 } from "babylonjs/Maths/math.vector";
  48154. import { Mesh } from "babylonjs/Meshes/mesh";
  48155. /**
  48156. * Class containing static functions to help procedurally build meshes
  48157. */
  48158. export class TorusBuilder {
  48159. /**
  48160. * Creates a torus mesh
  48161. * * The parameter `diameter` sets the diameter size (float) of the torus (default 1)
  48162. * * The parameter `thickness` sets the diameter size of the tube of the torus (float, default 0.5)
  48163. * * The parameter `tessellation` sets the number of torus sides (postive integer, default 16)
  48164. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  48165. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  48166. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  48167. * @param name defines the name of the mesh
  48168. * @param options defines the options used to create the mesh
  48169. * @param scene defines the hosting scene
  48170. * @returns the torus mesh
  48171. * @see https://doc.babylonjs.com/how_to/set_shapes#torus
  48172. */
  48173. static CreateTorus(name: string, options: {
  48174. diameter?: number;
  48175. thickness?: number;
  48176. tessellation?: number;
  48177. updatable?: boolean;
  48178. sideOrientation?: number;
  48179. frontUVs?: Vector4;
  48180. backUVs?: Vector4;
  48181. }, scene: any): Mesh;
  48182. }
  48183. }
  48184. declare module "babylonjs/Meshes/Builders/cylinderBuilder" {
  48185. import { Vector4 } from "babylonjs/Maths/math.vector";
  48186. import { Color4 } from "babylonjs/Maths/math.color";
  48187. import { Mesh } from "babylonjs/Meshes/mesh";
  48188. /**
  48189. * Class containing static functions to help procedurally build meshes
  48190. */
  48191. export class CylinderBuilder {
  48192. /**
  48193. * Creates a cylinder or a cone mesh
  48194. * * The parameter `height` sets the height size (float) of the cylinder/cone (float, default 2).
  48195. * * The parameter `diameter` sets the diameter of the top and bottom cap at once (float, default 1).
  48196. * * 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.
  48197. * * The parameter `tessellation` sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance.
  48198. * * The parameter `subdivisions` sets the number of rings along the cylinder height (positive integer, default 1).
  48199. * * The parameter `hasRings` (boolean, default false) makes the subdivisions independent from each other, so they become different faces.
  48200. * * The parameter `enclose` (boolean, default false) adds two extra faces per subdivision to a sliced cylinder to close it around its height axis.
  48201. * * 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).
  48202. * * The parameter `arc` (float, default 1) is the ratio (max 1) to apply to the circumference to slice the cylinder.
  48203. * * 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).
  48204. * * 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
  48205. * * Now, if the cylinder has 5 independent subdivisions (hasRings = true), n equals : top face + 5 stripe surfaces + bottom face = 2 + 5 = 7
  48206. * * 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
  48207. * * 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.
  48208. * * If `enclose` is false, a ring surface is one element.
  48209. * * If `enclose` is true, a ring surface is 3 successive elements in the array : the tubular surface, then the two closing faces.
  48210. * * 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
  48211. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  48212. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  48213. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  48214. * @param name defines the name of the mesh
  48215. * @param options defines the options used to create the mesh
  48216. * @param scene defines the hosting scene
  48217. * @returns the cylinder mesh
  48218. * @see https://doc.babylonjs.com/how_to/set_shapes#cylinder-or-cone
  48219. */
  48220. static CreateCylinder(name: string, options: {
  48221. height?: number;
  48222. diameterTop?: number;
  48223. diameterBottom?: number;
  48224. diameter?: number;
  48225. tessellation?: number;
  48226. subdivisions?: number;
  48227. arc?: number;
  48228. faceColors?: Color4[];
  48229. faceUV?: Vector4[];
  48230. updatable?: boolean;
  48231. hasRings?: boolean;
  48232. enclose?: boolean;
  48233. cap?: number;
  48234. sideOrientation?: number;
  48235. frontUVs?: Vector4;
  48236. backUVs?: Vector4;
  48237. }, scene: any): Mesh;
  48238. }
  48239. }
  48240. declare module "babylonjs/XR/webXRTypes" {
  48241. import { Nullable } from "babylonjs/types";
  48242. import { IDisposable } from "babylonjs/scene";
  48243. /**
  48244. * States of the webXR experience
  48245. */
  48246. export enum WebXRState {
  48247. /**
  48248. * Transitioning to being in XR mode
  48249. */
  48250. ENTERING_XR = 0,
  48251. /**
  48252. * Transitioning to non XR mode
  48253. */
  48254. EXITING_XR = 1,
  48255. /**
  48256. * In XR mode and presenting
  48257. */
  48258. IN_XR = 2,
  48259. /**
  48260. * Not entered XR mode
  48261. */
  48262. NOT_IN_XR = 3
  48263. }
  48264. /**
  48265. * Abstraction of the XR render target
  48266. */
  48267. export interface WebXRRenderTarget extends IDisposable {
  48268. /**
  48269. * xrpresent context of the canvas which can be used to display/mirror xr content
  48270. */
  48271. canvasContext: WebGLRenderingContext;
  48272. /**
  48273. * xr layer for the canvas
  48274. */
  48275. xrLayer: Nullable<XRWebGLLayer>;
  48276. /**
  48277. * Initializes the xr layer for the session
  48278. * @param xrSession xr session
  48279. * @returns a promise that will resolve once the XR Layer has been created
  48280. */
  48281. initializeXRLayerAsync(xrSession: XRSession): Promise<XRWebGLLayer>;
  48282. }
  48283. }
  48284. declare module "babylonjs/XR/webXRManagedOutputCanvas" {
  48285. import { Nullable } from "babylonjs/types";
  48286. import { WebXRRenderTarget } from "babylonjs/XR/webXRTypes";
  48287. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  48288. import { Observable } from "babylonjs/Misc/observable";
  48289. /**
  48290. * COnfiguration object for WebXR output canvas
  48291. */
  48292. export class WebXRManagedOutputCanvasOptions {
  48293. /**
  48294. * An optional canvas in case you wish to create it yourself and provide it here.
  48295. * If not provided, a new canvas will be created
  48296. */
  48297. canvasElement?: HTMLCanvasElement;
  48298. /**
  48299. * Options for this XR Layer output
  48300. */
  48301. canvasOptions?: XRWebGLLayerOptions;
  48302. /**
  48303. * CSS styling for a newly created canvas (if not provided)
  48304. */
  48305. newCanvasCssStyle?: string;
  48306. /**
  48307. * Get the default values of the configuration object
  48308. * @returns default values of this configuration object
  48309. */
  48310. static GetDefaults(): WebXRManagedOutputCanvasOptions;
  48311. }
  48312. /**
  48313. * Creates a canvas that is added/removed from the webpage when entering/exiting XR
  48314. */
  48315. export class WebXRManagedOutputCanvas implements WebXRRenderTarget {
  48316. private _options;
  48317. private _canvas;
  48318. private _engine;
  48319. private _originalCanvasSize;
  48320. /**
  48321. * Rendering context of the canvas which can be used to display/mirror xr content
  48322. */
  48323. canvasContext: WebGLRenderingContext;
  48324. /**
  48325. * xr layer for the canvas
  48326. */
  48327. xrLayer: Nullable<XRWebGLLayer>;
  48328. /**
  48329. * Obseervers registered here will be triggered when the xr layer was initialized
  48330. */
  48331. onXRLayerInitObservable: Observable<XRWebGLLayer>;
  48332. /**
  48333. * Initializes the canvas to be added/removed upon entering/exiting xr
  48334. * @param _xrSessionManager The XR Session manager
  48335. * @param _options optional configuration for this canvas output. defaults will be used if not provided
  48336. */
  48337. constructor(_xrSessionManager: WebXRSessionManager, _options?: WebXRManagedOutputCanvasOptions);
  48338. /**
  48339. * Disposes of the object
  48340. */
  48341. dispose(): void;
  48342. /**
  48343. * Initializes the xr layer for the session
  48344. * @param xrSession xr session
  48345. * @returns a promise that will resolve once the XR Layer has been created
  48346. */
  48347. initializeXRLayerAsync(xrSession: XRSession): Promise<XRWebGLLayer>;
  48348. private _addCanvas;
  48349. private _removeCanvas;
  48350. private _setCanvasSize;
  48351. private _setManagedOutputCanvas;
  48352. }
  48353. }
  48354. declare module "babylonjs/XR/webXRSessionManager" {
  48355. import { Observable } from "babylonjs/Misc/observable";
  48356. import { Nullable } from "babylonjs/types";
  48357. import { IDisposable, Scene } from "babylonjs/scene";
  48358. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  48359. import { WebXRRenderTarget } from "babylonjs/XR/webXRTypes";
  48360. import { WebXRManagedOutputCanvasOptions } from "babylonjs/XR/webXRManagedOutputCanvas";
  48361. /**
  48362. * Manages an XRSession to work with Babylon's engine
  48363. * @see https://doc.babylonjs.com/how_to/webxr_session_manager
  48364. */
  48365. export class WebXRSessionManager implements IDisposable {
  48366. /** The scene which the session should be created for */
  48367. scene: Scene;
  48368. private _referenceSpace;
  48369. private _rttProvider;
  48370. private _sessionEnded;
  48371. private _xrNavigator;
  48372. private baseLayer;
  48373. /**
  48374. * The base reference space from which the session started. good if you want to reset your
  48375. * reference space
  48376. */
  48377. baseReferenceSpace: XRReferenceSpace;
  48378. /**
  48379. * Current XR frame
  48380. */
  48381. currentFrame: Nullable<XRFrame>;
  48382. /** WebXR timestamp updated every frame */
  48383. currentTimestamp: number;
  48384. /**
  48385. * Used just in case of a failure to initialize an immersive session.
  48386. * The viewer reference space is compensated using this height, creating a kind of "viewer-floor" reference space
  48387. */
  48388. defaultHeightCompensation: number;
  48389. /**
  48390. * Fires every time a new xrFrame arrives which can be used to update the camera
  48391. */
  48392. onXRFrameObservable: Observable<XRFrame>;
  48393. /**
  48394. * Fires when the reference space changed
  48395. */
  48396. onXRReferenceSpaceChanged: Observable<XRReferenceSpace>;
  48397. /**
  48398. * Fires when the xr session is ended either by the device or manually done
  48399. */
  48400. onXRSessionEnded: Observable<any>;
  48401. /**
  48402. * Fires when the xr session is ended either by the device or manually done
  48403. */
  48404. onXRSessionInit: Observable<XRSession>;
  48405. /**
  48406. * Underlying xr session
  48407. */
  48408. session: XRSession;
  48409. /**
  48410. * The viewer (head position) reference space. This can be used to get the XR world coordinates
  48411. * or get the offset the player is currently at.
  48412. */
  48413. viewerReferenceSpace: XRReferenceSpace;
  48414. /**
  48415. * Constructs a WebXRSessionManager, this must be initialized within a user action before usage
  48416. * @param scene The scene which the session should be created for
  48417. */
  48418. constructor(
  48419. /** The scene which the session should be created for */
  48420. scene: Scene);
  48421. /**
  48422. * The current reference space used in this session. This reference space can constantly change!
  48423. * It is mainly used to offset the camera's position.
  48424. */
  48425. get referenceSpace(): XRReferenceSpace;
  48426. /**
  48427. * Set a new reference space and triggers the observable
  48428. */
  48429. set referenceSpace(newReferenceSpace: XRReferenceSpace);
  48430. /**
  48431. * Disposes of the session manager
  48432. */
  48433. dispose(): void;
  48434. /**
  48435. * Stops the xrSession and restores the render loop
  48436. * @returns Promise which resolves after it exits XR
  48437. */
  48438. exitXRAsync(): Promise<void>;
  48439. /**
  48440. * Gets the correct render target texture to be rendered this frame for this eye
  48441. * @param eye the eye for which to get the render target
  48442. * @returns the render target for the specified eye
  48443. */
  48444. getRenderTargetTextureForEye(eye: XREye): RenderTargetTexture;
  48445. /**
  48446. * Creates a WebXRRenderTarget object for the XR session
  48447. * @param onStateChangedObservable optional, mechanism for enabling/disabling XR rendering canvas, used only on Web
  48448. * @param options optional options to provide when creating a new render target
  48449. * @returns a WebXR render target to which the session can render
  48450. */
  48451. getWebXRRenderTarget(options?: WebXRManagedOutputCanvasOptions): WebXRRenderTarget;
  48452. /**
  48453. * Initializes the manager
  48454. * After initialization enterXR can be called to start an XR session
  48455. * @returns Promise which resolves after it is initialized
  48456. */
  48457. initializeAsync(): Promise<void>;
  48458. /**
  48459. * Initializes an xr session
  48460. * @param xrSessionMode mode to initialize
  48461. * @param xrSessionInit defines optional and required values to pass to the session builder
  48462. * @returns a promise which will resolve once the session has been initialized
  48463. */
  48464. initializeSessionAsync(xrSessionMode?: XRSessionMode, xrSessionInit?: XRSessionInit): Promise<XRSession>;
  48465. /**
  48466. * Checks if a session would be supported for the creation options specified
  48467. * @param sessionMode session mode to check if supported eg. immersive-vr
  48468. * @returns A Promise that resolves to true if supported and false if not
  48469. */
  48470. isSessionSupportedAsync(sessionMode: XRSessionMode): Promise<boolean>;
  48471. /**
  48472. * Resets the reference space to the one started the session
  48473. */
  48474. resetReferenceSpace(): void;
  48475. /**
  48476. * Starts rendering to the xr layer
  48477. */
  48478. runXRRenderLoop(): void;
  48479. /**
  48480. * Sets the reference space on the xr session
  48481. * @param referenceSpaceType space to set
  48482. * @returns a promise that will resolve once the reference space has been set
  48483. */
  48484. setReferenceSpaceTypeAsync(referenceSpaceType?: XRReferenceSpaceType): Promise<XRReferenceSpace>;
  48485. /**
  48486. * Updates the render state of the session
  48487. * @param state state to set
  48488. * @returns a promise that resolves once the render state has been updated
  48489. */
  48490. updateRenderStateAsync(state: XRRenderState): Promise<void>;
  48491. /**
  48492. * Returns a promise that resolves with a boolean indicating if the provided session mode is supported by this browser
  48493. * @param sessionMode defines the session to test
  48494. * @returns a promise with boolean as final value
  48495. */
  48496. static IsSessionSupportedAsync(sessionMode: XRSessionMode): Promise<boolean>;
  48497. private _createRenderTargetTexture;
  48498. }
  48499. }
  48500. declare module "babylonjs/XR/webXRCamera" {
  48501. import { Scene } from "babylonjs/scene";
  48502. import { Camera } from "babylonjs/Cameras/camera";
  48503. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  48504. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  48505. /**
  48506. * WebXR Camera which holds the views for the xrSession
  48507. * @see https://doc.babylonjs.com/how_to/webxr_camera
  48508. */
  48509. export class WebXRCamera extends FreeCamera {
  48510. private _xrSessionManager;
  48511. private _firstFrame;
  48512. private _referenceQuaternion;
  48513. private _referencedPosition;
  48514. private _xrInvPositionCache;
  48515. private _xrInvQuaternionCache;
  48516. /**
  48517. * Should position compensation execute on first frame.
  48518. * This is used when copying the position from a native (non XR) camera
  48519. */
  48520. compensateOnFirstFrame: boolean;
  48521. /**
  48522. * Creates a new webXRCamera, this should only be set at the camera after it has been updated by the xrSessionManager
  48523. * @param name the name of the camera
  48524. * @param scene the scene to add the camera to
  48525. * @param _xrSessionManager a constructed xr session manager
  48526. */
  48527. constructor(name: string, scene: Scene, _xrSessionManager: WebXRSessionManager);
  48528. /**
  48529. * Return the user's height, unrelated to the current ground.
  48530. * This will be the y position of this camera, when ground level is 0.
  48531. */
  48532. get realWorldHeight(): number;
  48533. /** @hidden */
  48534. _updateForDualEyeDebugging(): void;
  48535. /**
  48536. * Sets this camera's transformation based on a non-vr camera
  48537. * @param otherCamera the non-vr camera to copy the transformation from
  48538. * @param resetToBaseReferenceSpace should XR reset to the base reference space
  48539. */
  48540. setTransformationFromNonVRCamera(otherCamera?: Camera, resetToBaseReferenceSpace?: boolean): void;
  48541. /**
  48542. * Gets the current instance class name ("WebXRCamera").
  48543. * @returns the class name
  48544. */
  48545. getClassName(): string;
  48546. private _rotate180;
  48547. private _updateFromXRSession;
  48548. private _updateNumberOfRigCameras;
  48549. private _updateReferenceSpace;
  48550. private _updateReferenceSpaceOffset;
  48551. }
  48552. }
  48553. declare module "babylonjs/XR/webXRFeaturesManager" {
  48554. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  48555. import { IDisposable } from "babylonjs/scene";
  48556. /**
  48557. * Defining the interface required for a (webxr) feature
  48558. */
  48559. export interface IWebXRFeature extends IDisposable {
  48560. /**
  48561. * Is this feature attached
  48562. */
  48563. attached: boolean;
  48564. /**
  48565. * Should auto-attach be disabled?
  48566. */
  48567. disableAutoAttach: boolean;
  48568. /**
  48569. * Attach the feature to the session
  48570. * Will usually be called by the features manager
  48571. *
  48572. * @param force should attachment be forced (even when already attached)
  48573. * @returns true if successful.
  48574. */
  48575. attach(force?: boolean): boolean;
  48576. /**
  48577. * Detach the feature from the session
  48578. * Will usually be called by the features manager
  48579. *
  48580. * @returns true if successful.
  48581. */
  48582. detach(): boolean;
  48583. }
  48584. /**
  48585. * A list of the currently available features without referencing them
  48586. */
  48587. export class WebXRFeatureName {
  48588. /**
  48589. * The name of the anchor system feature
  48590. */
  48591. static ANCHOR_SYSTEM: string;
  48592. /**
  48593. * The name of the background remover feature
  48594. */
  48595. static BACKGROUND_REMOVER: string;
  48596. /**
  48597. * The name of the hit test feature
  48598. */
  48599. static HIT_TEST: string;
  48600. /**
  48601. * physics impostors for xr controllers feature
  48602. */
  48603. static PHYSICS_CONTROLLERS: string;
  48604. /**
  48605. * The name of the plane detection feature
  48606. */
  48607. static PLANE_DETECTION: string;
  48608. /**
  48609. * The name of the pointer selection feature
  48610. */
  48611. static POINTER_SELECTION: string;
  48612. /**
  48613. * The name of the teleportation feature
  48614. */
  48615. static TELEPORTATION: string;
  48616. }
  48617. /**
  48618. * Defining the constructor of a feature. Used to register the modules.
  48619. */
  48620. export type WebXRFeatureConstructor = (xrSessionManager: WebXRSessionManager, options?: any) => () => IWebXRFeature;
  48621. /**
  48622. * The WebXR features manager is responsible of enabling or disabling features required for the current XR session.
  48623. * It is mainly used in AR sessions.
  48624. *
  48625. * A feature can have a version that is defined by Babylon (and does not correspond with the webxr version).
  48626. */
  48627. export class WebXRFeaturesManager implements IDisposable {
  48628. private _xrSessionManager;
  48629. private static readonly _AvailableFeatures;
  48630. private _features;
  48631. /**
  48632. * constructs a new features manages.
  48633. *
  48634. * @param _xrSessionManager an instance of WebXRSessionManager
  48635. */
  48636. constructor(_xrSessionManager: WebXRSessionManager);
  48637. /**
  48638. * Used to register a module. After calling this function a developer can use this feature in the scene.
  48639. * Mainly used internally.
  48640. *
  48641. * @param featureName the name of the feature to register
  48642. * @param constructorFunction the function used to construct the module
  48643. * @param version the (babylon) version of the module
  48644. * @param stable is that a stable version of this module
  48645. */
  48646. static AddWebXRFeature(featureName: string, constructorFunction: WebXRFeatureConstructor, version?: number, stable?: boolean): void;
  48647. /**
  48648. * Returns a constructor of a specific feature.
  48649. *
  48650. * @param featureName the name of the feature to construct
  48651. * @param version the version of the feature to load
  48652. * @param xrSessionManager the xrSessionManager. Used to construct the module
  48653. * @param options optional options provided to the module.
  48654. * @returns a function that, when called, will return a new instance of this feature
  48655. */
  48656. static ConstructFeature(featureName: string, version: number | undefined, xrSessionManager: WebXRSessionManager, options?: any): () => IWebXRFeature;
  48657. /**
  48658. * Can be used to return the list of features currently registered
  48659. *
  48660. * @returns an Array of available features
  48661. */
  48662. static GetAvailableFeatures(): string[];
  48663. /**
  48664. * Gets the versions available for a specific feature
  48665. * @param featureName the name of the feature
  48666. * @returns an array with the available versions
  48667. */
  48668. static GetAvailableVersions(featureName: string): string[];
  48669. /**
  48670. * Return the latest unstable version of this feature
  48671. * @param featureName the name of the feature to search
  48672. * @returns the version number. if not found will return -1
  48673. */
  48674. static GetLatestVersionOfFeature(featureName: string): number;
  48675. /**
  48676. * Return the latest stable version of this feature
  48677. * @param featureName the name of the feature to search
  48678. * @returns the version number. if not found will return -1
  48679. */
  48680. static GetStableVersionOfFeature(featureName: string): number;
  48681. /**
  48682. * Attach a feature to the current session. Mainly used when session started to start the feature effect.
  48683. * Can be used during a session to start a feature
  48684. * @param featureName the name of feature to attach
  48685. */
  48686. attachFeature(featureName: string): void;
  48687. /**
  48688. * Can be used inside a session or when the session ends to detach a specific feature
  48689. * @param featureName the name of the feature to detach
  48690. */
  48691. detachFeature(featureName: string): void;
  48692. /**
  48693. * Used to disable an already-enabled feature
  48694. * The feature will be disposed and will be recreated once enabled.
  48695. * @param featureName the feature to disable
  48696. * @returns true if disable was successful
  48697. */
  48698. disableFeature(featureName: string | {
  48699. Name: string;
  48700. }): boolean;
  48701. /**
  48702. * dispose this features manager
  48703. */
  48704. dispose(): void;
  48705. /**
  48706. * 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.
  48707. * 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.
  48708. *
  48709. * @param featureName the name of the feature to load or the class of the feature
  48710. * @param version optional version to load. if not provided the latest version will be enabled
  48711. * @param moduleOptions options provided to the module. Ses the module documentation / constructor
  48712. * @param attachIfPossible if set to true (default) the feature will be automatically attached, if it is currently possible
  48713. * @returns a new constructed feature or throws an error if feature not found.
  48714. */
  48715. enableFeature(featureName: string | {
  48716. Name: string;
  48717. }, version?: number | string, moduleOptions?: any, attachIfPossible?: boolean): IWebXRFeature;
  48718. /**
  48719. * get the implementation of an enabled feature.
  48720. * @param featureName the name of the feature to load
  48721. * @returns the feature class, if found
  48722. */
  48723. getEnabledFeature(featureName: string): IWebXRFeature;
  48724. /**
  48725. * Get the list of enabled features
  48726. * @returns an array of enabled features
  48727. */
  48728. getEnabledFeatures(): string[];
  48729. }
  48730. }
  48731. declare module "babylonjs/XR/webXRExperienceHelper" {
  48732. import { Observable } from "babylonjs/Misc/observable";
  48733. import { IDisposable, Scene } from "babylonjs/scene";
  48734. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  48735. import { WebXRCamera } from "babylonjs/XR/webXRCamera";
  48736. import { WebXRState, WebXRRenderTarget } from "babylonjs/XR/webXRTypes";
  48737. import { WebXRFeaturesManager } from "babylonjs/XR/webXRFeaturesManager";
  48738. /**
  48739. * Base set of functionality needed to create an XR experience (WebXRSessionManager, Camera, StateManagement, etc.)
  48740. * @see https://doc.babylonjs.com/how_to/webxr_experience_helpers
  48741. */
  48742. export class WebXRExperienceHelper implements IDisposable {
  48743. private scene;
  48744. private _nonVRCamera;
  48745. private _originalSceneAutoClear;
  48746. private _supported;
  48747. /**
  48748. * Camera used to render xr content
  48749. */
  48750. camera: WebXRCamera;
  48751. /** A features manager for this xr session */
  48752. featuresManager: WebXRFeaturesManager;
  48753. /**
  48754. * Observers registered here will be triggered after the camera's initial transformation is set
  48755. * This can be used to set a different ground level or an extra rotation.
  48756. *
  48757. * Note that ground level is considered to be at 0. The height defined by the XR camera will be added
  48758. * to the position set after this observable is done executing.
  48759. */
  48760. onInitialXRPoseSetObservable: Observable<WebXRCamera>;
  48761. /**
  48762. * Fires when the state of the experience helper has changed
  48763. */
  48764. onStateChangedObservable: Observable<WebXRState>;
  48765. /** Session manager used to keep track of xr session */
  48766. sessionManager: WebXRSessionManager;
  48767. /**
  48768. * The current state of the XR experience (eg. transitioning, in XR or not in XR)
  48769. */
  48770. state: WebXRState;
  48771. /**
  48772. * Creates a WebXRExperienceHelper
  48773. * @param scene The scene the helper should be created in
  48774. */
  48775. private constructor();
  48776. /**
  48777. * Creates the experience helper
  48778. * @param scene the scene to attach the experience helper to
  48779. * @returns a promise for the experience helper
  48780. */
  48781. static CreateAsync(scene: Scene): Promise<WebXRExperienceHelper>;
  48782. /**
  48783. * Disposes of the experience helper
  48784. */
  48785. dispose(): void;
  48786. /**
  48787. * Enters XR mode (This must be done within a user interaction in most browsers eg. button click)
  48788. * @param sessionMode options for the XR session
  48789. * @param referenceSpaceType frame of reference of the XR session
  48790. * @param renderTarget the output canvas that will be used to enter XR mode
  48791. * @param sessionCreationOptions optional XRSessionInit object to init the session with
  48792. * @returns promise that resolves after xr mode has entered
  48793. */
  48794. enterXRAsync(sessionMode: XRSessionMode, referenceSpaceType: XRReferenceSpaceType, renderTarget?: WebXRRenderTarget, sessionCreationOptions?: XRSessionInit): Promise<WebXRSessionManager>;
  48795. /**
  48796. * Exits XR mode and returns the scene to its original state
  48797. * @returns promise that resolves after xr mode has exited
  48798. */
  48799. exitXRAsync(): Promise<void>;
  48800. private _nonXRToXRCamera;
  48801. private _setState;
  48802. }
  48803. }
  48804. declare module "babylonjs/XR/motionController/webXRControllerComponent" {
  48805. import { IMinimalMotionControllerObject, MotionControllerComponentType } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  48806. import { Observable } from "babylonjs/Misc/observable";
  48807. import { IDisposable } from "babylonjs/scene";
  48808. /**
  48809. * X-Y values for axes in WebXR
  48810. */
  48811. export interface IWebXRMotionControllerAxesValue {
  48812. /**
  48813. * The value of the x axis
  48814. */
  48815. x: number;
  48816. /**
  48817. * The value of the y-axis
  48818. */
  48819. y: number;
  48820. }
  48821. /**
  48822. * changed / previous values for the values of this component
  48823. */
  48824. export interface IWebXRMotionControllerComponentChangesValues<T> {
  48825. /**
  48826. * current (this frame) value
  48827. */
  48828. current: T;
  48829. /**
  48830. * previous (last change) value
  48831. */
  48832. previous: T;
  48833. }
  48834. /**
  48835. * Represents changes in the component between current frame and last values recorded
  48836. */
  48837. export interface IWebXRMotionControllerComponentChanges {
  48838. /**
  48839. * will be populated with previous and current values if axes changed
  48840. */
  48841. axes?: IWebXRMotionControllerComponentChangesValues<IWebXRMotionControllerAxesValue>;
  48842. /**
  48843. * will be populated with previous and current values if pressed changed
  48844. */
  48845. pressed?: IWebXRMotionControllerComponentChangesValues<boolean>;
  48846. /**
  48847. * will be populated with previous and current values if touched changed
  48848. */
  48849. touched?: IWebXRMotionControllerComponentChangesValues<boolean>;
  48850. /**
  48851. * will be populated with previous and current values if value changed
  48852. */
  48853. value?: IWebXRMotionControllerComponentChangesValues<number>;
  48854. }
  48855. /**
  48856. * This class represents a single component (for example button or thumbstick) of a motion controller
  48857. */
  48858. export class WebXRControllerComponent implements IDisposable {
  48859. /**
  48860. * the id of this component
  48861. */
  48862. id: string;
  48863. /**
  48864. * the type of the component
  48865. */
  48866. type: MotionControllerComponentType;
  48867. private _buttonIndex;
  48868. private _axesIndices;
  48869. private _axes;
  48870. private _changes;
  48871. private _currentValue;
  48872. private _hasChanges;
  48873. private _pressed;
  48874. private _touched;
  48875. /**
  48876. * button component type
  48877. */
  48878. static BUTTON_TYPE: MotionControllerComponentType;
  48879. /**
  48880. * squeeze component type
  48881. */
  48882. static SQUEEZE_TYPE: MotionControllerComponentType;
  48883. /**
  48884. * Thumbstick component type
  48885. */
  48886. static THUMBSTICK_TYPE: MotionControllerComponentType;
  48887. /**
  48888. * Touchpad component type
  48889. */
  48890. static TOUCHPAD_TYPE: MotionControllerComponentType;
  48891. /**
  48892. * trigger component type
  48893. */
  48894. static TRIGGER_TYPE: MotionControllerComponentType;
  48895. /**
  48896. * If axes are available for this component (like a touchpad or thumbstick) the observers will be notified when
  48897. * the axes data changes
  48898. */
  48899. onAxisValueChangedObservable: Observable<{
  48900. x: number;
  48901. y: number;
  48902. }>;
  48903. /**
  48904. * Observers registered here will be triggered when the state of a button changes
  48905. * State change is either pressed / touched / value
  48906. */
  48907. onButtonStateChangedObservable: Observable<WebXRControllerComponent>;
  48908. /**
  48909. * Creates a new component for a motion controller.
  48910. * It is created by the motion controller itself
  48911. *
  48912. * @param id the id of this component
  48913. * @param type the type of the component
  48914. * @param _buttonIndex index in the buttons array of the gamepad
  48915. * @param _axesIndices indices of the values in the axes array of the gamepad
  48916. */
  48917. constructor(
  48918. /**
  48919. * the id of this component
  48920. */
  48921. id: string,
  48922. /**
  48923. * the type of the component
  48924. */
  48925. type: MotionControllerComponentType, _buttonIndex?: number, _axesIndices?: number[]);
  48926. /**
  48927. * The current axes data. If this component has no axes it will still return an object { x: 0, y: 0 }
  48928. */
  48929. get axes(): IWebXRMotionControllerAxesValue;
  48930. /**
  48931. * Get the changes. Elements will be populated only if they changed with their previous and current value
  48932. */
  48933. get changes(): IWebXRMotionControllerComponentChanges;
  48934. /**
  48935. * Return whether or not the component changed the last frame
  48936. */
  48937. get hasChanges(): boolean;
  48938. /**
  48939. * is the button currently pressed
  48940. */
  48941. get pressed(): boolean;
  48942. /**
  48943. * is the button currently touched
  48944. */
  48945. get touched(): boolean;
  48946. /**
  48947. * Get the current value of this component
  48948. */
  48949. get value(): number;
  48950. /**
  48951. * Dispose this component
  48952. */
  48953. dispose(): void;
  48954. /**
  48955. * Are there axes correlating to this component
  48956. * @return true is axes data is available
  48957. */
  48958. isAxes(): boolean;
  48959. /**
  48960. * Is this component a button (hence - pressable)
  48961. * @returns true if can be pressed
  48962. */
  48963. isButton(): boolean;
  48964. /**
  48965. * update this component using the gamepad object it is in. Called on every frame
  48966. * @param nativeController the native gamepad controller object
  48967. */
  48968. update(nativeController: IMinimalMotionControllerObject): void;
  48969. }
  48970. }
  48971. declare module "babylonjs/Loading/sceneLoader" {
  48972. import { Observable } from "babylonjs/Misc/observable";
  48973. import { Nullable } from "babylonjs/types";
  48974. import { Scene } from "babylonjs/scene";
  48975. import { Engine } from "babylonjs/Engines/engine";
  48976. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  48977. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  48978. import { AssetContainer } from "babylonjs/assetContainer";
  48979. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  48980. import { Skeleton } from "babylonjs/Bones/skeleton";
  48981. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  48982. import { WebRequest } from "babylonjs/Misc/webRequest";
  48983. /**
  48984. * Interface used to represent data loading progression
  48985. */
  48986. export interface ISceneLoaderProgressEvent {
  48987. /**
  48988. * Defines if data length to load can be evaluated
  48989. */
  48990. readonly lengthComputable: boolean;
  48991. /**
  48992. * Defines the loaded data length
  48993. */
  48994. readonly loaded: number;
  48995. /**
  48996. * Defines the data length to load
  48997. */
  48998. readonly total: number;
  48999. }
  49000. /**
  49001. * Interface used by SceneLoader plugins to define supported file extensions
  49002. */
  49003. export interface ISceneLoaderPluginExtensions {
  49004. /**
  49005. * Defines the list of supported extensions
  49006. */
  49007. [extension: string]: {
  49008. isBinary: boolean;
  49009. };
  49010. }
  49011. /**
  49012. * Interface used by SceneLoader plugin factory
  49013. */
  49014. export interface ISceneLoaderPluginFactory {
  49015. /**
  49016. * Defines the name of the factory
  49017. */
  49018. name: string;
  49019. /**
  49020. * Function called to create a new plugin
  49021. * @return the new plugin
  49022. */
  49023. createPlugin(): ISceneLoaderPlugin | ISceneLoaderPluginAsync;
  49024. /**
  49025. * The callback that returns true if the data can be directly loaded.
  49026. * @param data string containing the file data
  49027. * @returns if the data can be loaded directly
  49028. */
  49029. canDirectLoad?(data: string): boolean;
  49030. }
  49031. /**
  49032. * Interface used to define the base of ISceneLoaderPlugin and ISceneLoaderPluginAsync
  49033. */
  49034. export interface ISceneLoaderPluginBase {
  49035. /**
  49036. * The friendly name of this plugin.
  49037. */
  49038. name: string;
  49039. /**
  49040. * The file extensions supported by this plugin.
  49041. */
  49042. extensions: string | ISceneLoaderPluginExtensions;
  49043. /**
  49044. * The callback called when loading from a url.
  49045. * @param scene scene loading this url
  49046. * @param url url to load
  49047. * @param onSuccess callback called when the file successfully loads
  49048. * @param onProgress callback called while file is loading (if the server supports this mode)
  49049. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  49050. * @param onError callback called when the file fails to load
  49051. * @returns a file request object
  49052. */
  49053. requestFile?(scene: Scene, url: string, onSuccess: (data: any, request?: WebRequest) => void, onProgress?: (ev: ISceneLoaderProgressEvent) => void, useArrayBuffer?: boolean, onError?: (error: any) => void): IFileRequest;
  49054. /**
  49055. * The callback called when loading from a file object.
  49056. * @param scene scene loading this file
  49057. * @param file defines the file to load
  49058. * @param onSuccess defines the callback to call when data is loaded
  49059. * @param onProgress defines the callback to call during loading process
  49060. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  49061. * @param onError defines the callback to call when an error occurs
  49062. * @returns a file request object
  49063. */
  49064. readFile?(scene: Scene, file: File, onSuccess: (data: any) => void, onProgress?: (ev: ISceneLoaderProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: any) => void): IFileRequest;
  49065. /**
  49066. * The callback that returns true if the data can be directly loaded.
  49067. * @param data string containing the file data
  49068. * @returns if the data can be loaded directly
  49069. */
  49070. canDirectLoad?(data: string): boolean;
  49071. /**
  49072. * The callback that returns the data to pass to the plugin if the data can be directly loaded.
  49073. * @param scene scene loading this data
  49074. * @param data string containing the data
  49075. * @returns data to pass to the plugin
  49076. */
  49077. directLoad?(scene: Scene, data: string): any;
  49078. /**
  49079. * The callback that allows custom handling of the root url based on the response url.
  49080. * @param rootUrl the original root url
  49081. * @param responseURL the response url if available
  49082. * @returns the new root url
  49083. */
  49084. rewriteRootURL?(rootUrl: string, responseURL?: string): string;
  49085. }
  49086. /**
  49087. * Interface used to define a SceneLoader plugin
  49088. */
  49089. export interface ISceneLoaderPlugin extends ISceneLoaderPluginBase {
  49090. /**
  49091. * Import meshes into a scene.
  49092. * @param meshesNames An array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  49093. * @param scene The scene to import into
  49094. * @param data The data to import
  49095. * @param rootUrl The root url for scene and resources
  49096. * @param meshes The meshes array to import into
  49097. * @param particleSystems The particle systems array to import into
  49098. * @param skeletons The skeletons array to import into
  49099. * @param onError The callback when import fails
  49100. * @returns True if successful or false otherwise
  49101. */
  49102. importMesh(meshesNames: any, scene: Scene, data: any, rootUrl: string, meshes: AbstractMesh[], particleSystems: IParticleSystem[], skeletons: Skeleton[], onError?: (message: string, exception?: any) => void): boolean;
  49103. /**
  49104. * Load into a scene.
  49105. * @param scene The scene to load into
  49106. * @param data The data to import
  49107. * @param rootUrl The root url for scene and resources
  49108. * @param onError The callback when import fails
  49109. * @returns True if successful or false otherwise
  49110. */
  49111. load(scene: Scene, data: any, rootUrl: string, onError?: (message: string, exception?: any) => void): boolean;
  49112. /**
  49113. * Load into an asset container.
  49114. * @param scene The scene to load into
  49115. * @param data The data to import
  49116. * @param rootUrl The root url for scene and resources
  49117. * @param onError The callback when import fails
  49118. * @returns The loaded asset container
  49119. */
  49120. loadAssetContainer(scene: Scene, data: any, rootUrl: string, onError?: (message: string, exception?: any) => void): AssetContainer;
  49121. }
  49122. /**
  49123. * Interface used to define an async SceneLoader plugin
  49124. */
  49125. export interface ISceneLoaderPluginAsync extends ISceneLoaderPluginBase {
  49126. /**
  49127. * Import meshes into a scene.
  49128. * @param meshesNames An array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  49129. * @param scene The scene to import into
  49130. * @param data The data to import
  49131. * @param rootUrl The root url for scene and resources
  49132. * @param onProgress The callback when the load progresses
  49133. * @param fileName Defines the name of the file to load
  49134. * @returns The loaded meshes, particle systems, skeletons, and animation groups
  49135. */
  49136. importMeshAsync(meshesNames: any, scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<{
  49137. meshes: AbstractMesh[];
  49138. particleSystems: IParticleSystem[];
  49139. skeletons: Skeleton[];
  49140. animationGroups: AnimationGroup[];
  49141. }>;
  49142. /**
  49143. * Load into a scene.
  49144. * @param scene The scene to load into
  49145. * @param data The data to import
  49146. * @param rootUrl The root url for scene and resources
  49147. * @param onProgress The callback when the load progresses
  49148. * @param fileName Defines the name of the file to load
  49149. * @returns Nothing
  49150. */
  49151. loadAsync(scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<void>;
  49152. /**
  49153. * Load into an asset container.
  49154. * @param scene The scene to load into
  49155. * @param data The data to import
  49156. * @param rootUrl The root url for scene and resources
  49157. * @param onProgress The callback when the load progresses
  49158. * @param fileName Defines the name of the file to load
  49159. * @returns The loaded asset container
  49160. */
  49161. loadAssetContainerAsync(scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<AssetContainer>;
  49162. }
  49163. /**
  49164. * Mode that determines how to handle old animation groups before loading new ones.
  49165. */
  49166. export enum SceneLoaderAnimationGroupLoadingMode {
  49167. /**
  49168. * Reset all old animations to initial state then dispose them.
  49169. */
  49170. Clean = 0,
  49171. /**
  49172. * Stop all old animations.
  49173. */
  49174. Stop = 1,
  49175. /**
  49176. * Restart old animations from first frame.
  49177. */
  49178. Sync = 2,
  49179. /**
  49180. * Old animations remains untouched.
  49181. */
  49182. NoSync = 3
  49183. }
  49184. /**
  49185. * Class used to load scene from various file formats using registered plugins
  49186. * @see https://doc.babylonjs.com/how_to/load_from_any_file_type
  49187. */
  49188. export class SceneLoader {
  49189. /**
  49190. * No logging while loading
  49191. */
  49192. static readonly NO_LOGGING: number;
  49193. /**
  49194. * Minimal logging while loading
  49195. */
  49196. static readonly MINIMAL_LOGGING: number;
  49197. /**
  49198. * Summary logging while loading
  49199. */
  49200. static readonly SUMMARY_LOGGING: number;
  49201. /**
  49202. * Detailled logging while loading
  49203. */
  49204. static readonly DETAILED_LOGGING: number;
  49205. /**
  49206. * Gets or sets a boolean indicating if entire scene must be loaded even if scene contains incremental data
  49207. */
  49208. static get ForceFullSceneLoadingForIncremental(): boolean;
  49209. static set ForceFullSceneLoadingForIncremental(value: boolean);
  49210. /**
  49211. * Gets or sets a boolean indicating if loading screen must be displayed while loading a scene
  49212. */
  49213. static get ShowLoadingScreen(): boolean;
  49214. static set ShowLoadingScreen(value: boolean);
  49215. /**
  49216. * Defines the current logging level (while loading the scene)
  49217. * @ignorenaming
  49218. */
  49219. static get loggingLevel(): number;
  49220. static set loggingLevel(value: number);
  49221. /**
  49222. * Gets or set a boolean indicating if matrix weights must be cleaned upon loading
  49223. */
  49224. static get CleanBoneMatrixWeights(): boolean;
  49225. static set CleanBoneMatrixWeights(value: boolean);
  49226. /**
  49227. * Event raised when a plugin is used to load a scene
  49228. */
  49229. static OnPluginActivatedObservable: Observable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>;
  49230. private static _registeredPlugins;
  49231. private static _showingLoadingScreen;
  49232. private static _getDefaultPlugin;
  49233. private static _getPluginForExtension;
  49234. private static _getPluginForDirectLoad;
  49235. private static _getPluginForFilename;
  49236. private static _getDirectLoad;
  49237. private static _loadData;
  49238. private static _getFileInfo;
  49239. /**
  49240. * Gets a plugin that can load the given extension
  49241. * @param extension defines the extension to load
  49242. * @returns a plugin or null if none works
  49243. */
  49244. static GetPluginForExtension(extension: string): ISceneLoaderPlugin | ISceneLoaderPluginAsync | ISceneLoaderPluginFactory;
  49245. /**
  49246. * Gets a boolean indicating that the given extension can be loaded
  49247. * @param extension defines the extension to load
  49248. * @returns true if the extension is supported
  49249. */
  49250. static IsPluginForExtensionAvailable(extension: string): boolean;
  49251. /**
  49252. * Adds a new plugin to the list of registered plugins
  49253. * @param plugin defines the plugin to add
  49254. */
  49255. static RegisterPlugin(plugin: ISceneLoaderPlugin | ISceneLoaderPluginAsync): void;
  49256. /**
  49257. * Import meshes into a scene
  49258. * @param meshNames an array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  49259. * @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)
  49260. * @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)
  49261. * @param scene the instance of BABYLON.Scene to append to
  49262. * @param onSuccess a callback with a list of imported meshes, particleSystems, and skeletons when import succeeds
  49263. * @param onProgress a callback with a progress event for each file being loaded
  49264. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  49265. * @param pluginExtension the extension used to determine the plugin
  49266. * @returns The loaded plugin
  49267. */
  49268. 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>;
  49269. /**
  49270. * Import meshes into a scene
  49271. * @param meshNames an array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  49272. * @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)
  49273. * @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)
  49274. * @param scene the instance of BABYLON.Scene to append to
  49275. * @param onProgress a callback with a progress event for each file being loaded
  49276. * @param pluginExtension the extension used to determine the plugin
  49277. * @returns The loaded list of imported meshes, particle systems, skeletons, and animation groups
  49278. */
  49279. static ImportMeshAsync(meshNames: any, rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<{
  49280. meshes: AbstractMesh[];
  49281. particleSystems: IParticleSystem[];
  49282. skeletons: Skeleton[];
  49283. animationGroups: AnimationGroup[];
  49284. }>;
  49285. /**
  49286. * Load a scene
  49287. * @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)
  49288. * @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)
  49289. * @param engine is the instance of BABYLON.Engine to use to create the scene
  49290. * @param onSuccess a callback with the scene when import succeeds
  49291. * @param onProgress a callback with a progress event for each file being loaded
  49292. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  49293. * @param pluginExtension the extension used to determine the plugin
  49294. * @returns The loaded plugin
  49295. */
  49296. 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>;
  49297. /**
  49298. * Load a scene
  49299. * @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)
  49300. * @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)
  49301. * @param engine is the instance of BABYLON.Engine to use to create the scene
  49302. * @param onProgress a callback with a progress event for each file being loaded
  49303. * @param pluginExtension the extension used to determine the plugin
  49304. * @returns The loaded scene
  49305. */
  49306. static LoadAsync(rootUrl: string, sceneFilename?: string | File, engine?: Nullable<Engine>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<Scene>;
  49307. /**
  49308. * Append a scene
  49309. * @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)
  49310. * @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)
  49311. * @param scene is the instance of BABYLON.Scene to append to
  49312. * @param onSuccess a callback with the scene when import succeeds
  49313. * @param onProgress a callback with a progress event for each file being loaded
  49314. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  49315. * @param pluginExtension the extension used to determine the plugin
  49316. * @returns The loaded plugin
  49317. */
  49318. 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>;
  49319. /**
  49320. * Append a scene
  49321. * @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)
  49322. * @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)
  49323. * @param scene is the instance of BABYLON.Scene to append to
  49324. * @param onProgress a callback with a progress event for each file being loaded
  49325. * @param pluginExtension the extension used to determine the plugin
  49326. * @returns The given scene
  49327. */
  49328. static AppendAsync(rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<Scene>;
  49329. /**
  49330. * Load a scene into an asset container
  49331. * @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)
  49332. * @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)
  49333. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  49334. * @param onSuccess a callback with the scene when import succeeds
  49335. * @param onProgress a callback with a progress event for each file being loaded
  49336. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  49337. * @param pluginExtension the extension used to determine the plugin
  49338. * @returns The loaded plugin
  49339. */
  49340. 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>;
  49341. /**
  49342. * Load a scene into an asset container
  49343. * @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)
  49344. * @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)
  49345. * @param scene is the instance of Scene to append to
  49346. * @param onProgress a callback with a progress event for each file being loaded
  49347. * @param pluginExtension the extension used to determine the plugin
  49348. * @returns The loaded asset container
  49349. */
  49350. static LoadAssetContainerAsync(rootUrl: string, sceneFilename?: string, scene?: Nullable<Scene>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<AssetContainer>;
  49351. /**
  49352. * Import animations from a file into a scene
  49353. * @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)
  49354. * @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)
  49355. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  49356. * @param overwriteAnimations when true, animations are cleaned before importing new ones. Animations are appended otherwise
  49357. * @param animationGroupLoadingMode defines how to handle old animations groups before importing new ones
  49358. * @param targetConverter defines a function used to convert animation targets from loaded scene to current scene (default: search node by name)
  49359. * @param onSuccess a callback with the scene when import succeeds
  49360. * @param onProgress a callback with a progress event for each file being loaded
  49361. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  49362. * @param pluginExtension the extension used to determine the plugin
  49363. */
  49364. 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;
  49365. /**
  49366. * Import animations from a file into a scene
  49367. * @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)
  49368. * @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)
  49369. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  49370. * @param overwriteAnimations when true, animations are cleaned before importing new ones. Animations are appended otherwise
  49371. * @param animationGroupLoadingMode defines how to handle old animations groups before importing new ones
  49372. * @param targetConverter defines a function used to convert animation targets from loaded scene to current scene (default: search node by name)
  49373. * @param onSuccess a callback with the scene when import succeeds
  49374. * @param onProgress a callback with a progress event for each file being loaded
  49375. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  49376. * @param pluginExtension the extension used to determine the plugin
  49377. * @returns the updated scene with imported animations
  49378. */
  49379. 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>;
  49380. }
  49381. }
  49382. declare module "babylonjs/XR/motionController/webXRAbstractMotionController" {
  49383. import { IDisposable, Scene } from "babylonjs/scene";
  49384. import { WebXRControllerComponent } from "babylonjs/XR/motionController/webXRControllerComponent";
  49385. import { Observable } from "babylonjs/Misc/observable";
  49386. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  49387. import { Nullable } from "babylonjs/types";
  49388. /**
  49389. * Handedness type in xrInput profiles. These can be used to define layouts in the Layout Map.
  49390. */
  49391. export type MotionControllerHandedness = "none" | "left" | "right";
  49392. /**
  49393. * The type of components available in motion controllers.
  49394. * This is not the name of the component.
  49395. */
  49396. export type MotionControllerComponentType = "trigger" | "squeeze" | "touchpad" | "thumbstick" | "button";
  49397. /**
  49398. * The state of a controller component
  49399. */
  49400. export type MotionControllerComponentStateType = "default" | "touched" | "pressed";
  49401. /**
  49402. * The schema of motion controller layout.
  49403. * No object will be initialized using this interface
  49404. * This is used just to define the profile.
  49405. */
  49406. export interface IMotionControllerLayout {
  49407. /**
  49408. * Path to load the assets. Usually relative to the base path
  49409. */
  49410. assetPath: string;
  49411. /**
  49412. * Available components (unsorted)
  49413. */
  49414. components: {
  49415. /**
  49416. * A map of component Ids
  49417. */
  49418. [componentId: string]: {
  49419. /**
  49420. * The type of input the component outputs
  49421. */
  49422. type: MotionControllerComponentType;
  49423. /**
  49424. * The indices of this component in the gamepad object
  49425. */
  49426. gamepadIndices: {
  49427. /**
  49428. * Index of button
  49429. */
  49430. button?: number;
  49431. /**
  49432. * If available, index of x-axis
  49433. */
  49434. xAxis?: number;
  49435. /**
  49436. * If available, index of y-axis
  49437. */
  49438. yAxis?: number;
  49439. };
  49440. /**
  49441. * The mesh's root node name
  49442. */
  49443. rootNodeName: string;
  49444. /**
  49445. * Animation definitions for this model
  49446. */
  49447. visualResponses: {
  49448. [stateKey: string]: {
  49449. /**
  49450. * What property will be animated
  49451. */
  49452. componentProperty: "xAxis" | "yAxis" | "button" | "state";
  49453. /**
  49454. * What states influence this visual response
  49455. */
  49456. states: MotionControllerComponentStateType[];
  49457. /**
  49458. * Type of animation - movement or visibility
  49459. */
  49460. valueNodeProperty: "transform" | "visibility";
  49461. /**
  49462. * Base node name to move. Its position will be calculated according to the min and max nodes
  49463. */
  49464. valueNodeName?: string;
  49465. /**
  49466. * Minimum movement node
  49467. */
  49468. minNodeName?: string;
  49469. /**
  49470. * Max movement node
  49471. */
  49472. maxNodeName?: string;
  49473. };
  49474. };
  49475. /**
  49476. * If touch enabled, what is the name of node to display user feedback
  49477. */
  49478. touchPointNodeName?: string;
  49479. };
  49480. };
  49481. /**
  49482. * Is it xr standard mapping or not
  49483. */
  49484. gamepadMapping: "" | "xr-standard";
  49485. /**
  49486. * Base root node of this entire model
  49487. */
  49488. rootNodeName: string;
  49489. /**
  49490. * Defines the main button component id
  49491. */
  49492. selectComponentId: string;
  49493. }
  49494. /**
  49495. * A definition for the layout map in the input profile
  49496. */
  49497. export interface IMotionControllerLayoutMap {
  49498. /**
  49499. * Layouts with handedness type as a key
  49500. */
  49501. [handedness: string]: IMotionControllerLayout;
  49502. }
  49503. /**
  49504. * The XR Input profile schema
  49505. * Profiles can be found here:
  49506. * https://github.com/immersive-web/webxr-input-profiles/tree/master/packages/registry/profiles
  49507. */
  49508. export interface IMotionControllerProfile {
  49509. /**
  49510. * fallback profiles for this profileId
  49511. */
  49512. fallbackProfileIds: string[];
  49513. /**
  49514. * The layout map, with handedness as key
  49515. */
  49516. layouts: IMotionControllerLayoutMap;
  49517. /**
  49518. * The id of this profile
  49519. * correlates to the profile(s) in the xrInput.profiles array
  49520. */
  49521. profileId: string;
  49522. }
  49523. /**
  49524. * A helper-interface for the 3 meshes needed for controller button animation
  49525. * The meshes are provided to the _lerpButtonTransform function to calculate the current position of the value mesh
  49526. */
  49527. export interface IMotionControllerButtonMeshMap {
  49528. /**
  49529. * the mesh that defines the pressed value mesh position.
  49530. * This is used to find the max-position of this button
  49531. */
  49532. pressedMesh: AbstractMesh;
  49533. /**
  49534. * the mesh that defines the unpressed value mesh position.
  49535. * This is used to find the min (or initial) position of this button
  49536. */
  49537. unpressedMesh: AbstractMesh;
  49538. /**
  49539. * The mesh that will be changed when value changes
  49540. */
  49541. valueMesh: AbstractMesh;
  49542. }
  49543. /**
  49544. * A helper-interface for the 3 meshes needed for controller axis animation.
  49545. * This will be expanded when touchpad animations are fully supported
  49546. * The meshes are provided to the _lerpAxisTransform function to calculate the current position of the value mesh
  49547. */
  49548. export interface IMotionControllerMeshMap {
  49549. /**
  49550. * the mesh that defines the maximum value mesh position.
  49551. */
  49552. maxMesh?: AbstractMesh;
  49553. /**
  49554. * the mesh that defines the minimum value mesh position.
  49555. */
  49556. minMesh?: AbstractMesh;
  49557. /**
  49558. * The mesh that will be changed when axis value changes
  49559. */
  49560. valueMesh: AbstractMesh;
  49561. }
  49562. /**
  49563. * The elements needed for change-detection of the gamepad objects in motion controllers
  49564. */
  49565. export interface IMinimalMotionControllerObject {
  49566. /**
  49567. * Available axes of this controller
  49568. */
  49569. axes: number[];
  49570. /**
  49571. * An array of available buttons
  49572. */
  49573. buttons: Array<{
  49574. /**
  49575. * Value of the button/trigger
  49576. */
  49577. value: number;
  49578. /**
  49579. * If the button/trigger is currently touched
  49580. */
  49581. touched: boolean;
  49582. /**
  49583. * If the button/trigger is currently pressed
  49584. */
  49585. pressed: boolean;
  49586. }>;
  49587. /**
  49588. * EXPERIMENTAL haptic support.
  49589. */
  49590. hapticActuators?: Array<{
  49591. pulse: (value: number, duration: number) => Promise<boolean>;
  49592. }>;
  49593. }
  49594. /**
  49595. * An Abstract Motion controller
  49596. * This class receives an xrInput and a profile layout and uses those to initialize the components
  49597. * Each component has an observable to check for changes in value and state
  49598. */
  49599. export abstract class WebXRAbstractMotionController implements IDisposable {
  49600. protected scene: Scene;
  49601. protected layout: IMotionControllerLayout;
  49602. /**
  49603. * The gamepad object correlating to this controller
  49604. */
  49605. gamepadObject: IMinimalMotionControllerObject;
  49606. /**
  49607. * handedness (left/right/none) of this controller
  49608. */
  49609. handedness: MotionControllerHandedness;
  49610. private _initComponent;
  49611. private _modelReady;
  49612. /**
  49613. * A map of components (WebXRControllerComponent) in this motion controller
  49614. * Components have a ComponentType and can also have both button and axis definitions
  49615. */
  49616. readonly components: {
  49617. [id: string]: WebXRControllerComponent;
  49618. };
  49619. /**
  49620. * Disable the model's animation. Can be set at any time.
  49621. */
  49622. disableAnimation: boolean;
  49623. /**
  49624. * Observers registered here will be triggered when the model of this controller is done loading
  49625. */
  49626. onModelLoadedObservable: Observable<WebXRAbstractMotionController>;
  49627. /**
  49628. * The profile id of this motion controller
  49629. */
  49630. abstract profileId: string;
  49631. /**
  49632. * The root mesh of the model. It is null if the model was not yet initialized
  49633. */
  49634. rootMesh: Nullable<AbstractMesh>;
  49635. /**
  49636. * constructs a new abstract motion controller
  49637. * @param scene the scene to which the model of the controller will be added
  49638. * @param layout The profile layout to load
  49639. * @param gamepadObject The gamepad object correlating to this controller
  49640. * @param handedness handedness (left/right/none) of this controller
  49641. * @param _doNotLoadControllerMesh set this flag to ignore the mesh loading
  49642. */
  49643. constructor(scene: Scene, layout: IMotionControllerLayout,
  49644. /**
  49645. * The gamepad object correlating to this controller
  49646. */
  49647. gamepadObject: IMinimalMotionControllerObject,
  49648. /**
  49649. * handedness (left/right/none) of this controller
  49650. */
  49651. handedness: MotionControllerHandedness, _doNotLoadControllerMesh?: boolean);
  49652. /**
  49653. * Dispose this controller, the model mesh and all its components
  49654. */
  49655. dispose(): void;
  49656. /**
  49657. * Returns all components of specific type
  49658. * @param type the type to search for
  49659. * @return an array of components with this type
  49660. */
  49661. getAllComponentsOfType(type: MotionControllerComponentType): WebXRControllerComponent[];
  49662. /**
  49663. * get a component based an its component id as defined in layout.components
  49664. * @param id the id of the component
  49665. * @returns the component correlates to the id or undefined if not found
  49666. */
  49667. getComponent(id: string): WebXRControllerComponent;
  49668. /**
  49669. * Get the list of components available in this motion controller
  49670. * @returns an array of strings correlating to available components
  49671. */
  49672. getComponentIds(): string[];
  49673. /**
  49674. * Get the first component of specific type
  49675. * @param type type of component to find
  49676. * @return a controller component or null if not found
  49677. */
  49678. getComponentOfType(type: MotionControllerComponentType): Nullable<WebXRControllerComponent>;
  49679. /**
  49680. * Get the main (Select) component of this controller as defined in the layout
  49681. * @returns the main component of this controller
  49682. */
  49683. getMainComponent(): WebXRControllerComponent;
  49684. /**
  49685. * Loads the model correlating to this controller
  49686. * When the mesh is loaded, the onModelLoadedObservable will be triggered
  49687. * @returns A promise fulfilled with the result of the model loading
  49688. */
  49689. loadModel(): Promise<boolean>;
  49690. /**
  49691. * Update this model using the current XRFrame
  49692. * @param xrFrame the current xr frame to use and update the model
  49693. */
  49694. updateFromXRFrame(xrFrame: XRFrame): void;
  49695. /**
  49696. * Backwards compatibility due to a deeply-integrated typo
  49697. */
  49698. get handness(): XREye;
  49699. /**
  49700. * Pulse (vibrate) this controller
  49701. * If the controller does not support pulses, this function will fail silently and return Promise<false> directly after called
  49702. * Consecutive calls to this function will cancel the last pulse call
  49703. *
  49704. * @param value the strength of the pulse in 0.0...1.0 range
  49705. * @param duration Duration of the pulse in milliseconds
  49706. * @param hapticActuatorIndex optional index of actuator (will usually be 0)
  49707. * @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
  49708. */
  49709. pulse(value: number, duration: number, hapticActuatorIndex?: number): Promise<boolean>;
  49710. protected _getChildByName(node: AbstractMesh, name: string): AbstractMesh;
  49711. protected _getImmediateChildByName(node: AbstractMesh, name: string): AbstractMesh;
  49712. /**
  49713. * Moves the axis on the controller mesh based on its current state
  49714. * @param axis the index of the axis
  49715. * @param axisValue the value of the axis which determines the meshes new position
  49716. * @hidden
  49717. */
  49718. protected _lerpTransform(axisMap: IMotionControllerMeshMap, axisValue: number, fixValueCoordinates?: boolean): void;
  49719. /**
  49720. * Update the model itself with the current frame data
  49721. * @param xrFrame the frame to use for updating the model mesh
  49722. */
  49723. protected updateModel(xrFrame: XRFrame): void;
  49724. /**
  49725. * Get the filename and path for this controller's model
  49726. * @returns a map of filename and path
  49727. */
  49728. protected abstract _getFilenameAndPath(): {
  49729. filename: string;
  49730. path: string;
  49731. };
  49732. /**
  49733. * This function is called before the mesh is loaded. It checks for loading constraints.
  49734. * For example, this function can check if the GLB loader is available
  49735. * If this function returns false, the generic controller will be loaded instead
  49736. * @returns Is the client ready to load the mesh
  49737. */
  49738. protected abstract _getModelLoadingConstraints(): boolean;
  49739. /**
  49740. * This function will be called after the model was successfully loaded and can be used
  49741. * for mesh transformations before it is available for the user
  49742. * @param meshes the loaded meshes
  49743. */
  49744. protected abstract _processLoadedModel(meshes: AbstractMesh[]): void;
  49745. /**
  49746. * Set the root mesh for this controller. Important for the WebXR controller class
  49747. * @param meshes the loaded meshes
  49748. */
  49749. protected abstract _setRootMesh(meshes: AbstractMesh[]): void;
  49750. /**
  49751. * A function executed each frame that updates the mesh (if needed)
  49752. * @param xrFrame the current xrFrame
  49753. */
  49754. protected abstract _updateModel(xrFrame: XRFrame): void;
  49755. private _getGenericFilenameAndPath;
  49756. private _getGenericParentMesh;
  49757. }
  49758. }
  49759. declare module "babylonjs/XR/motionController/webXRGenericMotionController" {
  49760. import { WebXRAbstractMotionController, IMinimalMotionControllerObject, MotionControllerHandedness } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  49761. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  49762. import { Scene } from "babylonjs/scene";
  49763. /**
  49764. * A generic trigger-only motion controller for WebXR
  49765. */
  49766. export class WebXRGenericTriggerMotionController extends WebXRAbstractMotionController {
  49767. /**
  49768. * Static version of the profile id of this controller
  49769. */
  49770. static ProfileId: string;
  49771. profileId: string;
  49772. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness);
  49773. protected _getFilenameAndPath(): {
  49774. filename: string;
  49775. path: string;
  49776. };
  49777. protected _getModelLoadingConstraints(): boolean;
  49778. protected _processLoadedModel(meshes: AbstractMesh[]): void;
  49779. protected _setRootMesh(meshes: AbstractMesh[]): void;
  49780. protected _updateModel(): void;
  49781. }
  49782. }
  49783. declare module "babylonjs/Meshes/Builders/sphereBuilder" {
  49784. import { Vector4 } from "babylonjs/Maths/math.vector";
  49785. import { Mesh } from "babylonjs/Meshes/mesh";
  49786. import { Scene } from "babylonjs/scene";
  49787. import { Nullable } from "babylonjs/types";
  49788. /**
  49789. * Class containing static functions to help procedurally build meshes
  49790. */
  49791. export class SphereBuilder {
  49792. /**
  49793. * Creates a sphere mesh
  49794. * * The parameter `diameter` sets the diameter size (float) of the sphere (default 1)
  49795. * * 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`)
  49796. * * The parameter `segments` sets the sphere number of horizontal stripes (positive integer, default 32)
  49797. * * 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
  49798. * * 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)
  49799. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  49800. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  49801. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  49802. * @param name defines the name of the mesh
  49803. * @param options defines the options used to create the mesh
  49804. * @param scene defines the hosting scene
  49805. * @returns the sphere mesh
  49806. * @see https://doc.babylonjs.com/how_to/set_shapes#sphere
  49807. */
  49808. static CreateSphere(name: string, options: {
  49809. segments?: number;
  49810. diameter?: number;
  49811. diameterX?: number;
  49812. diameterY?: number;
  49813. diameterZ?: number;
  49814. arc?: number;
  49815. slice?: number;
  49816. sideOrientation?: number;
  49817. frontUVs?: Vector4;
  49818. backUVs?: Vector4;
  49819. updatable?: boolean;
  49820. }, scene?: Nullable<Scene>): Mesh;
  49821. }
  49822. }
  49823. declare module "babylonjs/XR/motionController/webXRProfiledMotionController" {
  49824. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  49825. import { WebXRAbstractMotionController, IMotionControllerProfile } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  49826. import { Scene } from "babylonjs/scene";
  49827. /**
  49828. * A profiled motion controller has its profile loaded from an online repository.
  49829. * The class is responsible of loading the model, mapping the keys and enabling model-animations
  49830. */
  49831. export class WebXRProfiledMotionController extends WebXRAbstractMotionController {
  49832. private _repositoryUrl;
  49833. private _buttonMeshMapping;
  49834. private _touchDots;
  49835. /**
  49836. * The profile ID of this controller. Will be populated when the controller initializes.
  49837. */
  49838. profileId: string;
  49839. constructor(scene: Scene, xrInput: XRInputSource, _profile: IMotionControllerProfile, _repositoryUrl: string);
  49840. dispose(): void;
  49841. protected _getFilenameAndPath(): {
  49842. filename: string;
  49843. path: string;
  49844. };
  49845. protected _getModelLoadingConstraints(): boolean;
  49846. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  49847. protected _setRootMesh(meshes: AbstractMesh[]): void;
  49848. protected _updateModel(_xrFrame: XRFrame): void;
  49849. }
  49850. }
  49851. declare module "babylonjs/XR/motionController/webXRMotionControllerManager" {
  49852. import { WebXRAbstractMotionController } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  49853. import { Scene } from "babylonjs/scene";
  49854. /**
  49855. * A construction function type to create a new controller based on an xrInput object
  49856. */
  49857. export type MotionControllerConstructor = (xrInput: XRInputSource, scene: Scene) => WebXRAbstractMotionController;
  49858. /**
  49859. * The MotionController Manager manages all registered motion controllers and loads the right one when needed.
  49860. *
  49861. * When this repository is complete: https://github.com/immersive-web/webxr-input-profiles/tree/master/packages/assets
  49862. * it should be replaced with auto-loaded controllers.
  49863. *
  49864. * When using a model try to stay as generic as possible. Eventually there will be no need in any of the controller classes
  49865. */
  49866. export class WebXRMotionControllerManager {
  49867. private static _AvailableControllers;
  49868. private static _Fallbacks;
  49869. private static _ProfileLoadingPromises;
  49870. private static _ProfilesList;
  49871. /**
  49872. * The base URL of the online controller repository. Can be changed at any time.
  49873. */
  49874. static BaseRepositoryUrl: string;
  49875. /**
  49876. * Which repository gets priority - local or online
  49877. */
  49878. static PrioritizeOnlineRepository: boolean;
  49879. /**
  49880. * Use the online repository, or use only locally-defined controllers
  49881. */
  49882. static UseOnlineRepository: boolean;
  49883. /**
  49884. * Clear the cache used for profile loading and reload when requested again
  49885. */
  49886. static ClearProfilesCache(): void;
  49887. /**
  49888. * Register the default fallbacks.
  49889. * This function is called automatically when this file is imported.
  49890. */
  49891. static DefaultFallbacks(): void;
  49892. /**
  49893. * Find a fallback profile if the profile was not found. There are a few predefined generic profiles.
  49894. * @param profileId the profile to which a fallback needs to be found
  49895. * @return an array with corresponding fallback profiles
  49896. */
  49897. static FindFallbackWithProfileId(profileId: string): string[];
  49898. /**
  49899. * When acquiring a new xrInput object (usually by the WebXRInput class), match it with the correct profile.
  49900. * The order of search:
  49901. *
  49902. * 1) Iterate the profiles array of the xr input and try finding a corresponding motion controller
  49903. * 2) (If not found) search in the gamepad id and try using it (legacy versions only)
  49904. * 3) search for registered fallbacks (should be redundant, nonetheless it makes sense to check)
  49905. * 4) return the generic trigger controller if none were found
  49906. *
  49907. * @param xrInput the xrInput to which a new controller is initialized
  49908. * @param scene the scene to which the model will be added
  49909. * @param forceProfile force a certain profile for this controller
  49910. * @return A promise that fulfils with the motion controller class for this profile id or the generic standard class if none was found
  49911. */
  49912. static GetMotionControllerWithXRInput(xrInput: XRInputSource, scene: Scene, forceProfile?: string): Promise<WebXRAbstractMotionController>;
  49913. /**
  49914. * Register a new controller based on its profile. This function will be called by the controller classes themselves.
  49915. *
  49916. * If you are missing a profile, make sure it is imported in your source, otherwise it will not register.
  49917. *
  49918. * @param type the profile type to register
  49919. * @param constructFunction the function to be called when loading this profile
  49920. */
  49921. static RegisterController(type: string, constructFunction: MotionControllerConstructor): void;
  49922. /**
  49923. * Register a fallback to a specific profile.
  49924. * @param profileId the profileId that will receive the fallbacks
  49925. * @param fallbacks A list of fallback profiles
  49926. */
  49927. static RegisterFallbacksForProfileId(profileId: string, fallbacks: string[]): void;
  49928. /**
  49929. * Will update the list of profiles available in the repository
  49930. * @return a promise that resolves to a map of profiles available online
  49931. */
  49932. static UpdateProfilesList(): Promise<{
  49933. [profile: string]: string;
  49934. }>;
  49935. private static _LoadProfileFromRepository;
  49936. private static _LoadProfilesFromAvailableControllers;
  49937. }
  49938. }
  49939. declare module "babylonjs/XR/webXRInputSource" {
  49940. import { Observable } from "babylonjs/Misc/observable";
  49941. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  49942. import { Ray } from "babylonjs/Culling/ray";
  49943. import { Scene } from "babylonjs/scene";
  49944. import { WebXRAbstractMotionController } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  49945. /**
  49946. * Configuration options for the WebXR controller creation
  49947. */
  49948. export interface IWebXRControllerOptions {
  49949. /**
  49950. * Should the controller mesh be animated when a user interacts with it
  49951. * The pressed buttons / thumbstick and touchpad animations will be disabled
  49952. */
  49953. disableMotionControllerAnimation?: boolean;
  49954. /**
  49955. * Do not load the controller mesh, in case a different mesh needs to be loaded.
  49956. */
  49957. doNotLoadControllerMesh?: boolean;
  49958. /**
  49959. * Force a specific controller type for this controller.
  49960. * This can be used when creating your own profile or when testing different controllers
  49961. */
  49962. forceControllerProfile?: string;
  49963. /**
  49964. * Defines a rendering group ID for meshes that will be loaded.
  49965. * This is for the default controllers only.
  49966. */
  49967. renderingGroupId?: number;
  49968. }
  49969. /**
  49970. * Represents an XR controller
  49971. */
  49972. export class WebXRInputSource {
  49973. private _scene;
  49974. /** The underlying input source for the controller */
  49975. inputSource: XRInputSource;
  49976. private _options;
  49977. private _tmpVector;
  49978. private _uniqueId;
  49979. /**
  49980. * 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
  49981. */
  49982. grip?: AbstractMesh;
  49983. /**
  49984. * If available, this is the gamepad object related to this controller.
  49985. * Using this object it is possible to get click events and trackpad changes of the
  49986. * webxr controller that is currently being used.
  49987. */
  49988. motionController?: WebXRAbstractMotionController;
  49989. /**
  49990. * Event that fires when the controller is removed/disposed.
  49991. * The object provided as event data is this controller, after associated assets were disposed.
  49992. * uniqueId is still available.
  49993. */
  49994. onDisposeObservable: Observable<WebXRInputSource>;
  49995. /**
  49996. * Will be triggered when the mesh associated with the motion controller is done loading.
  49997. * It is also possible that this will never trigger (!) if no mesh was loaded, or if the developer decides to load a different mesh
  49998. * A shortened version of controller -> motion controller -> on mesh loaded.
  49999. */
  50000. onMeshLoadedObservable: Observable<AbstractMesh>;
  50001. /**
  50002. * Observers registered here will trigger when a motion controller profile was assigned to this xr controller
  50003. */
  50004. onMotionControllerInitObservable: Observable<WebXRAbstractMotionController>;
  50005. /**
  50006. * Pointer which can be used to select objects or attach a visible laser to
  50007. */
  50008. pointer: AbstractMesh;
  50009. /**
  50010. * Creates the input source object
  50011. * @see https://doc.babylonjs.com/how_to/webxr_controllers_support
  50012. * @param _scene the scene which the controller should be associated to
  50013. * @param inputSource the underlying input source for the controller
  50014. * @param _options options for this controller creation
  50015. */
  50016. constructor(_scene: Scene,
  50017. /** The underlying input source for the controller */
  50018. inputSource: XRInputSource, _options?: IWebXRControllerOptions);
  50019. /**
  50020. * Get this controllers unique id
  50021. */
  50022. get uniqueId(): string;
  50023. /**
  50024. * Disposes of the object
  50025. */
  50026. dispose(): void;
  50027. /**
  50028. * Gets a world space ray coming from the pointer or grip
  50029. * @param result the resulting ray
  50030. * @param gripIfAvailable use the grip mesh instead of the pointer, if available
  50031. */
  50032. getWorldPointerRayToRef(result: Ray, gripIfAvailable?: boolean): void;
  50033. /**
  50034. * Updates the controller pose based on the given XRFrame
  50035. * @param xrFrame xr frame to update the pose with
  50036. * @param referenceSpace reference space to use
  50037. */
  50038. updateFromXRFrame(xrFrame: XRFrame, referenceSpace: XRReferenceSpace): void;
  50039. }
  50040. }
  50041. declare module "babylonjs/XR/webXRInput" {
  50042. import { Observable } from "babylonjs/Misc/observable";
  50043. import { IDisposable } from "babylonjs/scene";
  50044. import { WebXRInputSource, IWebXRControllerOptions } from "babylonjs/XR/webXRInputSource";
  50045. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  50046. import { WebXRCamera } from "babylonjs/XR/webXRCamera";
  50047. /**
  50048. * The schema for initialization options of the XR Input class
  50049. */
  50050. export interface IWebXRInputOptions {
  50051. /**
  50052. * If set to true no model will be automatically loaded
  50053. */
  50054. doNotLoadControllerMeshes?: boolean;
  50055. /**
  50056. * If set, this profile will be used for all controllers loaded (for example "microsoft-mixed-reality")
  50057. * If not found, the xr input profile data will be used.
  50058. * Profiles are defined here - https://github.com/immersive-web/webxr-input-profiles/
  50059. */
  50060. forceInputProfile?: string;
  50061. /**
  50062. * Do not send a request to the controller repository to load the profile.
  50063. *
  50064. * Instead, use the controllers available in babylon itself.
  50065. */
  50066. disableOnlineControllerRepository?: boolean;
  50067. /**
  50068. * A custom URL for the controllers repository
  50069. */
  50070. customControllersRepositoryURL?: string;
  50071. /**
  50072. * Should the controller model's components not move according to the user input
  50073. */
  50074. disableControllerAnimation?: boolean;
  50075. /**
  50076. * Optional options to pass to the controller. Will be overridden by the Input options where applicable
  50077. */
  50078. controllerOptions?: IWebXRControllerOptions;
  50079. }
  50080. /**
  50081. * XR input used to track XR inputs such as controllers/rays
  50082. */
  50083. export class WebXRInput implements IDisposable {
  50084. /**
  50085. * the xr session manager for this session
  50086. */
  50087. xrSessionManager: WebXRSessionManager;
  50088. /**
  50089. * the WebXR camera for this session. Mainly used for teleportation
  50090. */
  50091. xrCamera: WebXRCamera;
  50092. private readonly options;
  50093. /**
  50094. * XR controllers being tracked
  50095. */
  50096. controllers: Array<WebXRInputSource>;
  50097. private _frameObserver;
  50098. private _sessionEndedObserver;
  50099. private _sessionInitObserver;
  50100. /**
  50101. * Event when a controller has been connected/added
  50102. */
  50103. onControllerAddedObservable: Observable<WebXRInputSource>;
  50104. /**
  50105. * Event when a controller has been removed/disconnected
  50106. */
  50107. onControllerRemovedObservable: Observable<WebXRInputSource>;
  50108. /**
  50109. * Initializes the WebXRInput
  50110. * @param xrSessionManager the xr session manager for this session
  50111. * @param xrCamera the WebXR camera for this session. Mainly used for teleportation
  50112. * @param options = initialization options for this xr input
  50113. */
  50114. constructor(
  50115. /**
  50116. * the xr session manager for this session
  50117. */
  50118. xrSessionManager: WebXRSessionManager,
  50119. /**
  50120. * the WebXR camera for this session. Mainly used for teleportation
  50121. */
  50122. xrCamera: WebXRCamera, options?: IWebXRInputOptions);
  50123. private _onInputSourcesChange;
  50124. private _addAndRemoveControllers;
  50125. /**
  50126. * Disposes of the object
  50127. */
  50128. dispose(): void;
  50129. }
  50130. }
  50131. declare module "babylonjs/XR/features/WebXRAbstractFeature" {
  50132. import { IWebXRFeature } from "babylonjs/XR/webXRFeaturesManager";
  50133. import { Observable, EventState } from "babylonjs/Misc/observable";
  50134. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  50135. /**
  50136. * This is the base class for all WebXR features.
  50137. * Since most features require almost the same resources and callbacks, this class can be used to simplify the development
  50138. * Note that since the features manager is using the `IWebXRFeature` you are in no way obligated to use this class
  50139. */
  50140. export abstract class WebXRAbstractFeature implements IWebXRFeature {
  50141. protected _xrSessionManager: WebXRSessionManager;
  50142. private _attached;
  50143. private _removeOnDetach;
  50144. /**
  50145. * Should auto-attach be disabled?
  50146. */
  50147. disableAutoAttach: boolean;
  50148. /**
  50149. * Construct a new (abstract) WebXR feature
  50150. * @param _xrSessionManager the xr session manager for this feature
  50151. */
  50152. constructor(_xrSessionManager: WebXRSessionManager);
  50153. /**
  50154. * Is this feature attached
  50155. */
  50156. get attached(): boolean;
  50157. /**
  50158. * attach this feature
  50159. *
  50160. * @param force should attachment be forced (even when already attached)
  50161. * @returns true if successful, false is failed or already attached
  50162. */
  50163. attach(force?: boolean): boolean;
  50164. /**
  50165. * detach this feature.
  50166. *
  50167. * @returns true if successful, false if failed or already detached
  50168. */
  50169. detach(): boolean;
  50170. /**
  50171. * Dispose this feature and all of the resources attached
  50172. */
  50173. dispose(): void;
  50174. /**
  50175. * This is used to register callbacks that will automatically be removed when detach is called.
  50176. * @param observable the observable to which the observer will be attached
  50177. * @param callback the callback to register
  50178. */
  50179. protected _addNewAttachObserver<T>(observable: Observable<T>, callback: (eventData: T, eventState: EventState) => void): void;
  50180. /**
  50181. * Code in this function will be executed on each xrFrame received from the browser.
  50182. * This function will not execute after the feature is detached.
  50183. * @param _xrFrame the current frame
  50184. */
  50185. protected abstract _onXRFrame(_xrFrame: XRFrame): void;
  50186. }
  50187. }
  50188. declare module "babylonjs/Rendering/utilityLayerRenderer" {
  50189. import { IDisposable, Scene } from "babylonjs/scene";
  50190. import { Nullable } from "babylonjs/types";
  50191. import { Observable } from "babylonjs/Misc/observable";
  50192. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  50193. import { HemisphericLight } from "babylonjs/Lights/hemisphericLight";
  50194. import { Camera } from "babylonjs/Cameras/camera";
  50195. /**
  50196. * Renders a layer on top of an existing scene
  50197. */
  50198. export class UtilityLayerRenderer implements IDisposable {
  50199. /** the original scene that will be rendered on top of */
  50200. originalScene: Scene;
  50201. private _pointerCaptures;
  50202. private _lastPointerEvents;
  50203. private static _DefaultUtilityLayer;
  50204. private static _DefaultKeepDepthUtilityLayer;
  50205. private _sharedGizmoLight;
  50206. private _renderCamera;
  50207. /**
  50208. * Gets the camera that is used to render the utility layer (when not set, this will be the last active camera)
  50209. * @param getRigParentIfPossible if the current active camera is a rig camera, should its parent camera be returned
  50210. * @returns the camera that is used when rendering the utility layer
  50211. */
  50212. getRenderCamera(getRigParentIfPossible?: boolean): Camera;
  50213. /**
  50214. * Sets the camera that should be used when rendering the utility layer (If set to null the last active camera will be used)
  50215. * @param cam the camera that should be used when rendering the utility layer
  50216. */
  50217. setRenderCamera(cam: Nullable<Camera>): void;
  50218. /**
  50219. * @hidden
  50220. * Light which used by gizmos to get light shading
  50221. */
  50222. _getSharedGizmoLight(): HemisphericLight;
  50223. /**
  50224. * If the picking should be done on the utility layer prior to the actual scene (Default: true)
  50225. */
  50226. pickUtilitySceneFirst: boolean;
  50227. /**
  50228. * 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)
  50229. */
  50230. static get DefaultUtilityLayer(): UtilityLayerRenderer;
  50231. /**
  50232. * 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)
  50233. */
  50234. static get DefaultKeepDepthUtilityLayer(): UtilityLayerRenderer;
  50235. /**
  50236. * The scene that is rendered on top of the original scene
  50237. */
  50238. utilityLayerScene: Scene;
  50239. /**
  50240. * If the utility layer should automatically be rendered on top of existing scene
  50241. */
  50242. shouldRender: boolean;
  50243. /**
  50244. * If set to true, only pointer down onPointerObservable events will be blocked when picking is occluded by original scene
  50245. */
  50246. onlyCheckPointerDownEvents: boolean;
  50247. /**
  50248. * If set to false, only pointerUp, pointerDown and pointerMove will be sent to the utilityLayerScene (false by default)
  50249. */
  50250. processAllEvents: boolean;
  50251. /**
  50252. * Observable raised when the pointer move from the utility layer scene to the main scene
  50253. */
  50254. onPointerOutObservable: Observable<number>;
  50255. /** Gets or sets a predicate that will be used to indicate utility meshes present in the main scene */
  50256. mainSceneTrackerPredicate: (mesh: Nullable<AbstractMesh>) => boolean;
  50257. private _afterRenderObserver;
  50258. private _sceneDisposeObserver;
  50259. private _originalPointerObserver;
  50260. /**
  50261. * Instantiates a UtilityLayerRenderer
  50262. * @param originalScene the original scene that will be rendered on top of
  50263. * @param handleEvents boolean indicating if the utility layer should handle events
  50264. */
  50265. constructor(
  50266. /** the original scene that will be rendered on top of */
  50267. originalScene: Scene, handleEvents?: boolean);
  50268. private _notifyObservers;
  50269. /**
  50270. * Renders the utility layers scene on top of the original scene
  50271. */
  50272. render(): void;
  50273. /**
  50274. * Disposes of the renderer
  50275. */
  50276. dispose(): void;
  50277. private _updateCamera;
  50278. }
  50279. }
  50280. declare module "babylonjs/XR/features/WebXRControllerPointerSelection" {
  50281. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  50282. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  50283. import { WebXRInput } from "babylonjs/XR/webXRInput";
  50284. import { WebXRInputSource } from "babylonjs/XR/webXRInputSource";
  50285. import { Scene } from "babylonjs/scene";
  50286. import { Nullable } from "babylonjs/types";
  50287. import { Color3 } from "babylonjs/Maths/math.color";
  50288. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  50289. /**
  50290. * Options interface for the pointer selection module
  50291. */
  50292. export interface IWebXRControllerPointerSelectionOptions {
  50293. /**
  50294. * if provided, this scene will be used to render meshes.
  50295. */
  50296. customUtilityLayerScene?: Scene;
  50297. /**
  50298. * 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)
  50299. * If not disabled, the last picked point will be used to execute a pointer up event
  50300. * If disabled, pointer up event will be triggered right after the pointer down event.
  50301. * Used in screen and gaze target ray mode only
  50302. */
  50303. disablePointerUpOnTouchOut: boolean;
  50304. /**
  50305. * For gaze mode (time to select instead of press)
  50306. */
  50307. forceGazeMode: boolean;
  50308. /**
  50309. * 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
  50310. * to start a new countdown to the pointer down event.
  50311. * Defaults to 1.
  50312. */
  50313. gazeModePointerMovedFactor?: number;
  50314. /**
  50315. * Different button type to use instead of the main component
  50316. */
  50317. overrideButtonId?: string;
  50318. /**
  50319. * use this rendering group id for the meshes (optional)
  50320. */
  50321. renderingGroupId?: number;
  50322. /**
  50323. * The amount of time in milliseconds it takes between pick found something to a pointer down event.
  50324. * Used in gaze modes. Tracked pointer uses the trigger, screen uses touch events
  50325. * 3000 means 3 seconds between pointing at something and selecting it
  50326. */
  50327. timeToSelect?: number;
  50328. /**
  50329. * Should meshes created here be added to a utility layer or the main scene
  50330. */
  50331. useUtilityLayer?: boolean;
  50332. /**
  50333. * the xr input to use with this pointer selection
  50334. */
  50335. xrInput: WebXRInput;
  50336. }
  50337. /**
  50338. * A module that will enable pointer selection for motion controllers of XR Input Sources
  50339. */
  50340. export class WebXRControllerPointerSelection extends WebXRAbstractFeature {
  50341. private readonly _options;
  50342. private static _idCounter;
  50343. private _attachController;
  50344. private _controllers;
  50345. private _scene;
  50346. private _tmpVectorForPickCompare;
  50347. /**
  50348. * The module's name
  50349. */
  50350. static readonly Name: string;
  50351. /**
  50352. * The (Babylon) version of this module.
  50353. * This is an integer representing the implementation version.
  50354. * This number does not correspond to the WebXR specs version
  50355. */
  50356. static readonly Version: number;
  50357. /**
  50358. * Disable lighting on the laser pointer (so it will always be visible)
  50359. */
  50360. disablePointerLighting: boolean;
  50361. /**
  50362. * Disable lighting on the selection mesh (so it will always be visible)
  50363. */
  50364. disableSelectionMeshLighting: boolean;
  50365. /**
  50366. * Should the laser pointer be displayed
  50367. */
  50368. displayLaserPointer: boolean;
  50369. /**
  50370. * Should the selection mesh be displayed (The ring at the end of the laser pointer)
  50371. */
  50372. displaySelectionMesh: boolean;
  50373. /**
  50374. * This color will be set to the laser pointer when selection is triggered
  50375. */
  50376. laserPointerPickedColor: Color3;
  50377. /**
  50378. * Default color of the laser pointer
  50379. */
  50380. laserPointerDefaultColor: Color3;
  50381. /**
  50382. * default color of the selection ring
  50383. */
  50384. selectionMeshDefaultColor: Color3;
  50385. /**
  50386. * This color will be applied to the selection ring when selection is triggered
  50387. */
  50388. selectionMeshPickedColor: Color3;
  50389. /**
  50390. * Optional filter to be used for ray selection. This predicate shares behavior with
  50391. * scene.pointerMovePredicate which takes priority if it is also assigned.
  50392. */
  50393. raySelectionPredicate: (mesh: AbstractMesh) => boolean;
  50394. /**
  50395. * constructs a new background remover module
  50396. * @param _xrSessionManager the session manager for this module
  50397. * @param _options read-only options to be used in this module
  50398. */
  50399. constructor(_xrSessionManager: WebXRSessionManager, _options: IWebXRControllerPointerSelectionOptions);
  50400. /**
  50401. * attach this feature
  50402. * Will usually be called by the features manager
  50403. *
  50404. * @returns true if successful.
  50405. */
  50406. attach(): boolean;
  50407. /**
  50408. * detach this feature.
  50409. * Will usually be called by the features manager
  50410. *
  50411. * @returns true if successful.
  50412. */
  50413. detach(): boolean;
  50414. /**
  50415. * Will get the mesh under a specific pointer.
  50416. * `scene.meshUnderPointer` will only return one mesh - either left or right.
  50417. * @param controllerId the controllerId to check
  50418. * @returns The mesh under pointer or null if no mesh is under the pointer
  50419. */
  50420. getMeshUnderPointer(controllerId: string): Nullable<AbstractMesh>;
  50421. /**
  50422. * Get the xr controller that correlates to the pointer id in the pointer event
  50423. *
  50424. * @param id the pointer id to search for
  50425. * @returns the controller that correlates to this id or null if not found
  50426. */
  50427. getXRControllerByPointerId(id: number): Nullable<WebXRInputSource>;
  50428. protected _onXRFrame(_xrFrame: XRFrame): void;
  50429. private _attachGazeMode;
  50430. private _attachScreenRayMode;
  50431. private _attachTrackedPointerRayMode;
  50432. private _convertNormalToDirectionOfRay;
  50433. private _detachController;
  50434. private _generateNewMeshPair;
  50435. private _pickingMoved;
  50436. private _updatePointerDistance;
  50437. /** @hidden */
  50438. get lasterPointerDefaultColor(): Color3;
  50439. }
  50440. }
  50441. declare module "babylonjs/XR/webXREnterExitUI" {
  50442. import { Nullable } from "babylonjs/types";
  50443. import { Observable } from "babylonjs/Misc/observable";
  50444. import { IDisposable, Scene } from "babylonjs/scene";
  50445. import { WebXRExperienceHelper } from "babylonjs/XR/webXRExperienceHelper";
  50446. import { WebXRRenderTarget } from "babylonjs/XR/webXRTypes";
  50447. /**
  50448. * Button which can be used to enter a different mode of XR
  50449. */
  50450. export class WebXREnterExitUIButton {
  50451. /** button element */
  50452. element: HTMLElement;
  50453. /** XR initialization options for the button */
  50454. sessionMode: XRSessionMode;
  50455. /** Reference space type */
  50456. referenceSpaceType: XRReferenceSpaceType;
  50457. /**
  50458. * Creates a WebXREnterExitUIButton
  50459. * @param element button element
  50460. * @param sessionMode XR initialization session mode
  50461. * @param referenceSpaceType the type of reference space to be used
  50462. */
  50463. constructor(
  50464. /** button element */
  50465. element: HTMLElement,
  50466. /** XR initialization options for the button */
  50467. sessionMode: XRSessionMode,
  50468. /** Reference space type */
  50469. referenceSpaceType: XRReferenceSpaceType);
  50470. /**
  50471. * Extendable function which can be used to update the button's visuals when the state changes
  50472. * @param activeButton the current active button in the UI
  50473. */
  50474. update(activeButton: Nullable<WebXREnterExitUIButton>): void;
  50475. }
  50476. /**
  50477. * Options to create the webXR UI
  50478. */
  50479. export class WebXREnterExitUIOptions {
  50480. /**
  50481. * User provided buttons to enable/disable WebXR. The system will provide default if not set
  50482. */
  50483. customButtons?: Array<WebXREnterExitUIButton>;
  50484. /**
  50485. * A reference space type to use when creating the default button.
  50486. * Default is local-floor
  50487. */
  50488. referenceSpaceType?: XRReferenceSpaceType;
  50489. /**
  50490. * Context to enter xr with
  50491. */
  50492. renderTarget?: Nullable<WebXRRenderTarget>;
  50493. /**
  50494. * A session mode to use when creating the default button.
  50495. * Default is immersive-vr
  50496. */
  50497. sessionMode?: XRSessionMode;
  50498. /**
  50499. * A list of optional features to init the session with
  50500. */
  50501. optionalFeatures?: string[];
  50502. /**
  50503. * A list of optional features to init the session with
  50504. */
  50505. requiredFeatures?: string[];
  50506. }
  50507. /**
  50508. * UI to allow the user to enter/exit XR mode
  50509. */
  50510. export class WebXREnterExitUI implements IDisposable {
  50511. private scene;
  50512. /** version of the options passed to this UI */
  50513. options: WebXREnterExitUIOptions;
  50514. private _activeButton;
  50515. private _buttons;
  50516. private _overlay;
  50517. /**
  50518. * Fired every time the active button is changed.
  50519. *
  50520. * When xr is entered via a button that launches xr that button will be the callback parameter
  50521. *
  50522. * When exiting xr the callback parameter will be null)
  50523. */
  50524. activeButtonChangedObservable: Observable<Nullable<WebXREnterExitUIButton>>;
  50525. /**
  50526. *
  50527. * @param scene babylon scene object to use
  50528. * @param options (read-only) version of the options passed to this UI
  50529. */
  50530. private constructor();
  50531. /**
  50532. * Creates UI to allow the user to enter/exit XR mode
  50533. * @param scene the scene to add the ui to
  50534. * @param helper the xr experience helper to enter/exit xr with
  50535. * @param options options to configure the UI
  50536. * @returns the created ui
  50537. */
  50538. static CreateAsync(scene: Scene, helper: WebXRExperienceHelper, options: WebXREnterExitUIOptions): Promise<WebXREnterExitUI>;
  50539. /**
  50540. * Disposes of the XR UI component
  50541. */
  50542. dispose(): void;
  50543. private _updateButtons;
  50544. }
  50545. }
  50546. declare module "babylonjs/Meshes/Builders/linesBuilder" {
  50547. import { Vector3 } from "babylonjs/Maths/math.vector";
  50548. import { Color4 } from "babylonjs/Maths/math.color";
  50549. import { Nullable } from "babylonjs/types";
  50550. import { LinesMesh } from "babylonjs/Meshes/linesMesh";
  50551. import { Scene } from "babylonjs/scene";
  50552. /**
  50553. * Class containing static functions to help procedurally build meshes
  50554. */
  50555. export class LinesBuilder {
  50556. /**
  50557. * Creates a line system mesh. A line system is a pool of many lines gathered in a single mesh
  50558. * * 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
  50559. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineSystem to this static function
  50560. * * The parameter `lines` is an array of lines, each line being an array of successive Vector3
  50561. * * The optional parameter `instance` is an instance of an existing LineSystem object to be updated with the passed `lines` parameter
  50562. * * The optional parameter `colors` is an array of line colors, each line colors being an array of successive Color4, one per line point
  50563. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  50564. * * 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
  50565. * * When updating an instance, remember that only line point positions can change, not the number of points, neither the number of lines
  50566. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  50567. * @see https://doc.babylonjs.com/how_to/parametric_shapes#line-system
  50568. * @param name defines the name of the new line system
  50569. * @param options defines the options used to create the line system
  50570. * @param scene defines the hosting scene
  50571. * @returns a new line system mesh
  50572. */
  50573. static CreateLineSystem(name: string, options: {
  50574. lines: Vector3[][];
  50575. updatable?: boolean;
  50576. instance?: Nullable<LinesMesh>;
  50577. colors?: Nullable<Color4[][]>;
  50578. useVertexAlpha?: boolean;
  50579. }, scene: Nullable<Scene>): LinesMesh;
  50580. /**
  50581. * Creates a line mesh
  50582. * 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
  50583. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  50584. * * The parameter `points` is an array successive Vector3
  50585. * * 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
  50586. * * The optional parameter `colors` is an array of successive Color4, one per line point
  50587. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need alpha blending (faster)
  50588. * * When updating an instance, remember that only point positions can change, not the number of points
  50589. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  50590. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lines
  50591. * @param name defines the name of the new line system
  50592. * @param options defines the options used to create the line system
  50593. * @param scene defines the hosting scene
  50594. * @returns a new line mesh
  50595. */
  50596. static CreateLines(name: string, options: {
  50597. points: Vector3[];
  50598. updatable?: boolean;
  50599. instance?: Nullable<LinesMesh>;
  50600. colors?: Color4[];
  50601. useVertexAlpha?: boolean;
  50602. }, scene?: Nullable<Scene>): LinesMesh;
  50603. /**
  50604. * Creates a dashed line mesh
  50605. * * 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
  50606. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  50607. * * The parameter `points` is an array successive Vector3
  50608. * * The parameter `dashNb` is the intended total number of dashes (positive integer, default 200)
  50609. * * The parameter `dashSize` is the size of the dashes relatively the dash number (positive float, default 3)
  50610. * * The parameter `gapSize` is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  50611. * * 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
  50612. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  50613. * * When updating an instance, remember that only point positions can change, not the number of points
  50614. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  50615. * @param name defines the name of the mesh
  50616. * @param options defines the options used to create the mesh
  50617. * @param scene defines the hosting scene
  50618. * @returns the dashed line mesh
  50619. * @see https://doc.babylonjs.com/how_to/parametric_shapes#dashed-lines
  50620. */
  50621. static CreateDashedLines(name: string, options: {
  50622. points: Vector3[];
  50623. dashSize?: number;
  50624. gapSize?: number;
  50625. dashNb?: number;
  50626. updatable?: boolean;
  50627. instance?: LinesMesh;
  50628. useVertexAlpha?: boolean;
  50629. }, scene?: Nullable<Scene>): LinesMesh;
  50630. }
  50631. }
  50632. declare module "babylonjs/Misc/timer" {
  50633. import { Observable, Observer } from "babylonjs/Misc/observable";
  50634. import { Nullable } from "babylonjs/types";
  50635. import { IDisposable } from "babylonjs/scene";
  50636. /**
  50637. * Construction options for a timer
  50638. */
  50639. export interface ITimerOptions<T> {
  50640. /**
  50641. * Time-to-end
  50642. */
  50643. timeout: number;
  50644. /**
  50645. * The context observable is used to calculate time deltas and provides the context of the timer's callbacks. Will usually be OnBeforeRenderObservable.
  50646. * Countdown calculation is done ONLY when the observable is notifying its observers, meaning that if
  50647. * you choose an observable that doesn't trigger too often, the wait time might extend further than the requested max time
  50648. */
  50649. contextObservable: Observable<T>;
  50650. /**
  50651. * Optional parameters when adding an observer to the observable
  50652. */
  50653. observableParameters?: {
  50654. mask?: number;
  50655. insertFirst?: boolean;
  50656. scope?: any;
  50657. };
  50658. /**
  50659. * An optional break condition that will stop the times prematurely. In this case onEnded will not be triggered!
  50660. */
  50661. breakCondition?: (data?: ITimerData<T>) => boolean;
  50662. /**
  50663. * Will be triggered when the time condition has met
  50664. */
  50665. onEnded?: (data: ITimerData<any>) => void;
  50666. /**
  50667. * Will be triggered when the break condition has met (prematurely ended)
  50668. */
  50669. onAborted?: (data: ITimerData<any>) => void;
  50670. /**
  50671. * Optional function to execute on each tick (or count)
  50672. */
  50673. onTick?: (data: ITimerData<any>) => void;
  50674. }
  50675. /**
  50676. * An interface defining the data sent by the timer
  50677. */
  50678. export interface ITimerData<T> {
  50679. /**
  50680. * When did it start
  50681. */
  50682. startTime: number;
  50683. /**
  50684. * Time now
  50685. */
  50686. currentTime: number;
  50687. /**
  50688. * Time passed since started
  50689. */
  50690. deltaTime: number;
  50691. /**
  50692. * How much is completed, in [0.0...1.0].
  50693. * Note that this CAN be higher than 1 due to the fact that we don't actually measure time but delta between observable calls
  50694. */
  50695. completeRate: number;
  50696. /**
  50697. * What the registered observable sent in the last count
  50698. */
  50699. payload: T;
  50700. }
  50701. /**
  50702. * The current state of the timer
  50703. */
  50704. export enum TimerState {
  50705. /**
  50706. * Timer initialized, not yet started
  50707. */
  50708. INIT = 0,
  50709. /**
  50710. * Timer started and counting
  50711. */
  50712. STARTED = 1,
  50713. /**
  50714. * Timer ended (whether aborted or time reached)
  50715. */
  50716. ENDED = 2
  50717. }
  50718. /**
  50719. * A simple version of the timer. Will take options and start the timer immediately after calling it
  50720. *
  50721. * @param options options with which to initialize this timer
  50722. */
  50723. export function setAndStartTimer(options: ITimerOptions<any>): Nullable<Observer<any>>;
  50724. /**
  50725. * An advanced implementation of a timer class
  50726. */
  50727. export class AdvancedTimer<T = any> implements IDisposable {
  50728. /**
  50729. * Will notify each time the timer calculates the remaining time
  50730. */
  50731. onEachCountObservable: Observable<ITimerData<T>>;
  50732. /**
  50733. * Will trigger when the timer was aborted due to the break condition
  50734. */
  50735. onTimerAbortedObservable: Observable<ITimerData<T>>;
  50736. /**
  50737. * Will trigger when the timer ended successfully
  50738. */
  50739. onTimerEndedObservable: Observable<ITimerData<T>>;
  50740. /**
  50741. * Will trigger when the timer state has changed
  50742. */
  50743. onStateChangedObservable: Observable<TimerState>;
  50744. private _observer;
  50745. private _contextObservable;
  50746. private _observableParameters;
  50747. private _startTime;
  50748. private _timer;
  50749. private _state;
  50750. private _breakCondition;
  50751. private _timeToEnd;
  50752. private _breakOnNextTick;
  50753. /**
  50754. * Will construct a new advanced timer based on the options provided. Timer will not start until start() is called.
  50755. * @param options construction options for this advanced timer
  50756. */
  50757. constructor(options: ITimerOptions<T>);
  50758. /**
  50759. * set a breaking condition for this timer. Default is to never break during count
  50760. * @param predicate the new break condition. Returns true to break, false otherwise
  50761. */
  50762. set breakCondition(predicate: (data: ITimerData<T>) => boolean);
  50763. /**
  50764. * Reset ALL associated observables in this advanced timer
  50765. */
  50766. clearObservables(): void;
  50767. /**
  50768. * Will start a new iteration of this timer. Only one instance of this timer can run at a time.
  50769. *
  50770. * @param timeToEnd how much time to measure until timer ended
  50771. */
  50772. start(timeToEnd?: number): void;
  50773. /**
  50774. * Will force a stop on the next tick.
  50775. */
  50776. stop(): void;
  50777. /**
  50778. * Dispose this timer, clearing all resources
  50779. */
  50780. dispose(): void;
  50781. private _setState;
  50782. private _tick;
  50783. private _stop;
  50784. }
  50785. }
  50786. declare module "babylonjs/XR/features/WebXRControllerTeleportation" {
  50787. import { IWebXRFeature } from "babylonjs/XR/webXRFeaturesManager";
  50788. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  50789. import { WebXRInput } from "babylonjs/XR/webXRInput";
  50790. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  50791. import { Vector3 } from "babylonjs/Maths/math.vector";
  50792. import { Material } from "babylonjs/Materials/material";
  50793. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  50794. import { Scene } from "babylonjs/scene";
  50795. /**
  50796. * The options container for the teleportation module
  50797. */
  50798. export interface IWebXRTeleportationOptions {
  50799. /**
  50800. * if provided, this scene will be used to render meshes.
  50801. */
  50802. customUtilityLayerScene?: Scene;
  50803. /**
  50804. * Values to configure the default target mesh
  50805. */
  50806. defaultTargetMeshOptions?: {
  50807. /**
  50808. * Fill color of the teleportation area
  50809. */
  50810. teleportationFillColor?: string;
  50811. /**
  50812. * Border color for the teleportation area
  50813. */
  50814. teleportationBorderColor?: string;
  50815. /**
  50816. * Disable the mesh's animation sequence
  50817. */
  50818. disableAnimation?: boolean;
  50819. /**
  50820. * Disable lighting on the material or the ring and arrow
  50821. */
  50822. disableLighting?: boolean;
  50823. /**
  50824. * Override the default material of the torus and arrow
  50825. */
  50826. torusArrowMaterial?: Material;
  50827. };
  50828. /**
  50829. * A list of meshes to use as floor meshes.
  50830. * Meshes can be added and removed after initializing the feature using the
  50831. * addFloorMesh and removeFloorMesh functions
  50832. * If empty, rotation will still work
  50833. */
  50834. floorMeshes?: AbstractMesh[];
  50835. /**
  50836. * use this rendering group id for the meshes (optional)
  50837. */
  50838. renderingGroupId?: number;
  50839. /**
  50840. * Should teleportation move only to snap points
  50841. */
  50842. snapPointsOnly?: boolean;
  50843. /**
  50844. * An array of points to which the teleportation will snap to.
  50845. * If the teleportation ray is in the proximity of one of those points, it will be corrected to this point.
  50846. */
  50847. snapPositions?: Vector3[];
  50848. /**
  50849. * How close should the teleportation ray be in order to snap to position.
  50850. * Default to 0.8 units (meters)
  50851. */
  50852. snapToPositionRadius?: number;
  50853. /**
  50854. * Provide your own teleportation mesh instead of babylon's wonderful doughnut.
  50855. * If you want to support rotation, make sure your mesh has a direction indicator.
  50856. *
  50857. * When left untouched, the default mesh will be initialized.
  50858. */
  50859. teleportationTargetMesh?: AbstractMesh;
  50860. /**
  50861. * If main component is used (no thumbstick), how long should the "long press" take before teleport
  50862. */
  50863. timeToTeleport?: number;
  50864. /**
  50865. * Disable using the thumbstick and use the main component (usually trigger) on long press.
  50866. * This will be automatically true if the controller doesn't have a thumbstick or touchpad.
  50867. */
  50868. useMainComponentOnly?: boolean;
  50869. /**
  50870. * Should meshes created here be added to a utility layer or the main scene
  50871. */
  50872. useUtilityLayer?: boolean;
  50873. /**
  50874. * Babylon XR Input class for controller
  50875. */
  50876. xrInput: WebXRInput;
  50877. }
  50878. /**
  50879. * This is a teleportation feature to be used with WebXR-enabled motion controllers.
  50880. * When enabled and attached, the feature will allow a user to move around and rotate in the scene using
  50881. * the input of the attached controllers.
  50882. */
  50883. export class WebXRMotionControllerTeleportation extends WebXRAbstractFeature {
  50884. private _options;
  50885. private _controllers;
  50886. private _currentTeleportationControllerId;
  50887. private _floorMeshes;
  50888. private _quadraticBezierCurve;
  50889. private _selectionFeature;
  50890. private _snapToPositions;
  50891. private _snappedToPoint;
  50892. private _teleportationRingMaterial?;
  50893. private _tmpRay;
  50894. private _tmpVector;
  50895. /**
  50896. * The module's name
  50897. */
  50898. static readonly Name: string;
  50899. /**
  50900. * The (Babylon) version of this module.
  50901. * This is an integer representing the implementation version.
  50902. * This number does not correspond to the webxr specs version
  50903. */
  50904. static readonly Version: number;
  50905. /**
  50906. * Is movement backwards enabled
  50907. */
  50908. backwardsMovementEnabled: boolean;
  50909. /**
  50910. * Distance to travel when moving backwards
  50911. */
  50912. backwardsTeleportationDistance: number;
  50913. /**
  50914. * The distance from the user to the inspection point in the direction of the controller
  50915. * A higher number will allow the user to move further
  50916. * defaults to 5 (meters, in xr units)
  50917. */
  50918. parabolicCheckRadius: number;
  50919. /**
  50920. * Should the module support parabolic ray on top of direct ray
  50921. * If enabled, the user will be able to point "at the sky" and move according to predefined radius distance
  50922. * Very helpful when moving between floors / different heights
  50923. */
  50924. parabolicRayEnabled: boolean;
  50925. /**
  50926. * How much rotation should be applied when rotating right and left
  50927. */
  50928. rotationAngle: number;
  50929. /**
  50930. * Is rotation enabled when moving forward?
  50931. * Disabling this feature will prevent the user from deciding the direction when teleporting
  50932. */
  50933. rotationEnabled: boolean;
  50934. /**
  50935. * constructs a new anchor system
  50936. * @param _xrSessionManager an instance of WebXRSessionManager
  50937. * @param _options configuration object for this feature
  50938. */
  50939. constructor(_xrSessionManager: WebXRSessionManager, _options: IWebXRTeleportationOptions);
  50940. /**
  50941. * Get the snapPointsOnly flag
  50942. */
  50943. get snapPointsOnly(): boolean;
  50944. /**
  50945. * Sets the snapPointsOnly flag
  50946. * @param snapToPoints should teleportation be exclusively to snap points
  50947. */
  50948. set snapPointsOnly(snapToPoints: boolean);
  50949. /**
  50950. * Add a new mesh to the floor meshes array
  50951. * @param mesh the mesh to use as floor mesh
  50952. */
  50953. addFloorMesh(mesh: AbstractMesh): void;
  50954. /**
  50955. * Add a new snap-to point to fix teleportation to this position
  50956. * @param newSnapPoint The new Snap-To point
  50957. */
  50958. addSnapPoint(newSnapPoint: Vector3): void;
  50959. attach(): boolean;
  50960. detach(): boolean;
  50961. dispose(): void;
  50962. /**
  50963. * Remove a mesh from the floor meshes array
  50964. * @param mesh the mesh to remove
  50965. */
  50966. removeFloorMesh(mesh: AbstractMesh): void;
  50967. /**
  50968. * Remove a mesh from the floor meshes array using its name
  50969. * @param name the mesh name to remove
  50970. */
  50971. removeFloorMeshByName(name: string): void;
  50972. /**
  50973. * 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
  50974. * @param snapPointToRemove the point (or a clone of it) to be removed from the array
  50975. * @returns was the point found and removed or not
  50976. */
  50977. removeSnapPoint(snapPointToRemove: Vector3): boolean;
  50978. /**
  50979. * This function sets a selection feature that will be disabled when
  50980. * the forward ray is shown and will be reattached when hidden.
  50981. * This is used to remove the selection rays when moving.
  50982. * @param selectionFeature the feature to disable when forward movement is enabled
  50983. */
  50984. setSelectionFeature(selectionFeature: IWebXRFeature): void;
  50985. protected _onXRFrame(_xrFrame: XRFrame): void;
  50986. private _attachController;
  50987. private _createDefaultTargetMesh;
  50988. private _detachController;
  50989. private _findClosestSnapPointWithRadius;
  50990. private _setTargetMeshPosition;
  50991. private _setTargetMeshVisibility;
  50992. private _showParabolicPath;
  50993. private _teleportForward;
  50994. }
  50995. }
  50996. declare module "babylonjs/XR/webXRDefaultExperience" {
  50997. import { WebXRExperienceHelper } from "babylonjs/XR/webXRExperienceHelper";
  50998. import { Scene } from "babylonjs/scene";
  50999. import { WebXRInput, IWebXRInputOptions } from "babylonjs/XR/webXRInput";
  51000. import { WebXRControllerPointerSelection } from "babylonjs/XR/features/WebXRControllerPointerSelection";
  51001. import { WebXRRenderTarget } from "babylonjs/XR/webXRTypes";
  51002. import { WebXREnterExitUI, WebXREnterExitUIOptions } from "babylonjs/XR/webXREnterExitUI";
  51003. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  51004. import { WebXRManagedOutputCanvasOptions } from "babylonjs/XR/webXRManagedOutputCanvas";
  51005. import { WebXRMotionControllerTeleportation } from "babylonjs/XR/features/WebXRControllerTeleportation";
  51006. /**
  51007. * Options for the default xr helper
  51008. */
  51009. export class WebXRDefaultExperienceOptions {
  51010. /**
  51011. * Enable or disable default UI to enter XR
  51012. */
  51013. disableDefaultUI?: boolean;
  51014. /**
  51015. * Should teleportation not initialize. defaults to false.
  51016. */
  51017. disableTeleportation?: boolean;
  51018. /**
  51019. * Floor meshes that will be used for teleport
  51020. */
  51021. floorMeshes?: Array<AbstractMesh>;
  51022. /**
  51023. * If set to true, the first frame will not be used to reset position
  51024. * The first frame is mainly used when copying transformation from the old camera
  51025. * Mainly used in AR
  51026. */
  51027. ignoreNativeCameraTransformation?: boolean;
  51028. /**
  51029. * Disable the controller mesh-loading. Can be used if you want to load your own meshes
  51030. */
  51031. inputOptions?: IWebXRInputOptions;
  51032. /**
  51033. * optional configuration for the output canvas
  51034. */
  51035. outputCanvasOptions?: WebXRManagedOutputCanvasOptions;
  51036. /**
  51037. * optional UI options. This can be used among other to change session mode and reference space type
  51038. */
  51039. uiOptions?: WebXREnterExitUIOptions;
  51040. /**
  51041. * When loading teleportation and pointer select, use stable versions instead of latest.
  51042. */
  51043. useStablePlugins?: boolean;
  51044. /**
  51045. * An optional rendering group id that will be set globally for teleportation, pointer selection and default controller meshes
  51046. */
  51047. renderingGroupId?: number;
  51048. /**
  51049. * A list of optional features to init the session with
  51050. * If set to true, all features we support will be added
  51051. */
  51052. optionalFeatures?: boolean | string[];
  51053. }
  51054. /**
  51055. * Default experience which provides a similar setup to the previous webVRExperience
  51056. */
  51057. export class WebXRDefaultExperience {
  51058. /**
  51059. * Base experience
  51060. */
  51061. baseExperience: WebXRExperienceHelper;
  51062. /**
  51063. * Enables ui for entering/exiting xr
  51064. */
  51065. enterExitUI: WebXREnterExitUI;
  51066. /**
  51067. * Input experience extension
  51068. */
  51069. input: WebXRInput;
  51070. /**
  51071. * Enables laser pointer and selection
  51072. */
  51073. pointerSelection: WebXRControllerPointerSelection;
  51074. /**
  51075. * Default target xr should render to
  51076. */
  51077. renderTarget: WebXRRenderTarget;
  51078. /**
  51079. * Enables teleportation
  51080. */
  51081. teleportation: WebXRMotionControllerTeleportation;
  51082. private constructor();
  51083. /**
  51084. * Creates the default xr experience
  51085. * @param scene scene
  51086. * @param options options for basic configuration
  51087. * @returns resulting WebXRDefaultExperience
  51088. */
  51089. static CreateAsync(scene: Scene, options?: WebXRDefaultExperienceOptions): Promise<WebXRDefaultExperience>;
  51090. /**
  51091. * DIsposes of the experience helper
  51092. */
  51093. dispose(): void;
  51094. }
  51095. }
  51096. declare module "babylonjs/Cameras/VR/vrExperienceHelper" {
  51097. import { Observable } from "babylonjs/Misc/observable";
  51098. import { Nullable } from "babylonjs/types";
  51099. import { Camera } from "babylonjs/Cameras/camera";
  51100. import { DeviceOrientationCamera } from "babylonjs/Cameras/deviceOrientationCamera";
  51101. import { VRDeviceOrientationFreeCamera } from "babylonjs/Cameras/VR/vrDeviceOrientationFreeCamera";
  51102. import { WebVROptions, WebVRFreeCamera } from "babylonjs/Cameras/VR/webVRCamera";
  51103. import { Scene } from "babylonjs/scene";
  51104. import { Vector3 } from "babylonjs/Maths/math.vector";
  51105. import { Color3 } from "babylonjs/Maths/math.color";
  51106. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  51107. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  51108. import { Mesh } from "babylonjs/Meshes/mesh";
  51109. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  51110. import { EasingFunction } from "babylonjs/Animations/easing";
  51111. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  51112. import "babylonjs/Meshes/Builders/groundBuilder";
  51113. import "babylonjs/Meshes/Builders/torusBuilder";
  51114. import "babylonjs/Meshes/Builders/cylinderBuilder";
  51115. import "babylonjs/Gamepads/gamepadSceneComponent";
  51116. import "babylonjs/Animations/animatable";
  51117. import { WebXRDefaultExperience } from "babylonjs/XR/webXRDefaultExperience";
  51118. /**
  51119. * Options to modify the vr teleportation behavior.
  51120. */
  51121. export interface VRTeleportationOptions {
  51122. /**
  51123. * The name of the mesh which should be used as the teleportation floor. (default: null)
  51124. */
  51125. floorMeshName?: string;
  51126. /**
  51127. * A list of meshes to be used as the teleportation floor. (default: empty)
  51128. */
  51129. floorMeshes?: Mesh[];
  51130. /**
  51131. * The teleportation mode. (default: TELEPORTATIONMODE_CONSTANTTIME)
  51132. */
  51133. teleportationMode?: number;
  51134. /**
  51135. * The duration of the animation in ms, apply when animationMode is TELEPORTATIONMODE_CONSTANTTIME. (default 122ms)
  51136. */
  51137. teleportationTime?: number;
  51138. /**
  51139. * The speed of the animation in distance/sec, apply when animationMode is TELEPORTATIONMODE_CONSTANTSPEED. (default 20 units / sec)
  51140. */
  51141. teleportationSpeed?: number;
  51142. /**
  51143. * The easing function used in the animation or null for Linear. (default CircleEase)
  51144. */
  51145. easingFunction?: EasingFunction;
  51146. }
  51147. /**
  51148. * Options to modify the vr experience helper's behavior.
  51149. */
  51150. export interface VRExperienceHelperOptions extends WebVROptions {
  51151. /**
  51152. * Create a DeviceOrientationCamera to be used as your out of vr camera. (default: true)
  51153. */
  51154. createDeviceOrientationCamera?: boolean;
  51155. /**
  51156. * Create a VRDeviceOrientationFreeCamera to be used for VR when no external HMD is found. (default: true)
  51157. */
  51158. createFallbackVRDeviceOrientationFreeCamera?: boolean;
  51159. /**
  51160. * Uses the main button on the controller to toggle the laser casted. (default: true)
  51161. */
  51162. laserToggle?: boolean;
  51163. /**
  51164. * A list of meshes to be used as the teleportation floor. If specified, teleportation will be enabled (default: undefined)
  51165. */
  51166. floorMeshes?: Mesh[];
  51167. /**
  51168. * Distortion metrics for the fallback vrDeviceOrientationCamera (default: VRCameraMetrics.Default)
  51169. */
  51170. vrDeviceOrientationCameraMetrics?: VRCameraMetrics;
  51171. /**
  51172. * Defines if WebXR should be used instead of WebVR (if available)
  51173. */
  51174. useXR?: boolean;
  51175. }
  51176. /**
  51177. * Event containing information after VR has been entered
  51178. */
  51179. export class OnAfterEnteringVRObservableEvent {
  51180. /**
  51181. * If entering vr was successful
  51182. */
  51183. success: boolean;
  51184. }
  51185. /**
  51186. * Helps to quickly add VR support to an existing scene.
  51187. * See https://doc.babylonjs.com/how_to/webvr_helper
  51188. */
  51189. export class VRExperienceHelper {
  51190. /** Options to modify the vr experience helper's behavior. */
  51191. webVROptions: VRExperienceHelperOptions;
  51192. private _scene;
  51193. private _position;
  51194. private _btnVR;
  51195. private _btnVRDisplayed;
  51196. private _webVRsupported;
  51197. private _webVRready;
  51198. private _webVRrequesting;
  51199. private _webVRpresenting;
  51200. private _hasEnteredVR;
  51201. private _fullscreenVRpresenting;
  51202. private _inputElement;
  51203. private _webVRCamera;
  51204. private _vrDeviceOrientationCamera;
  51205. private _deviceOrientationCamera;
  51206. private _existingCamera;
  51207. private _onKeyDown;
  51208. private _onVrDisplayPresentChange;
  51209. private _onVRDisplayChanged;
  51210. private _onVRRequestPresentStart;
  51211. private _onVRRequestPresentComplete;
  51212. /**
  51213. * 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)
  51214. */
  51215. enableGazeEvenWhenNoPointerLock: boolean;
  51216. /**
  51217. * Gets or sets a boolean indicating that the VREXperienceHelper will exit VR if double tap is detected
  51218. */
  51219. exitVROnDoubleTap: boolean;
  51220. /**
  51221. * Observable raised right before entering VR.
  51222. */
  51223. onEnteringVRObservable: Observable<VRExperienceHelper>;
  51224. /**
  51225. * Observable raised when entering VR has completed.
  51226. */
  51227. onAfterEnteringVRObservable: Observable<OnAfterEnteringVRObservableEvent>;
  51228. /**
  51229. * Observable raised when exiting VR.
  51230. */
  51231. onExitingVRObservable: Observable<VRExperienceHelper>;
  51232. /**
  51233. * Observable raised when controller mesh is loaded.
  51234. */
  51235. onControllerMeshLoadedObservable: Observable<WebVRController>;
  51236. /** Return this.onEnteringVRObservable
  51237. * Note: This one is for backward compatibility. Please use onEnteringVRObservable directly
  51238. */
  51239. get onEnteringVR(): Observable<VRExperienceHelper>;
  51240. /** Return this.onExitingVRObservable
  51241. * Note: This one is for backward compatibility. Please use onExitingVRObservable directly
  51242. */
  51243. get onExitingVR(): Observable<VRExperienceHelper>;
  51244. /** Return this.onControllerMeshLoadedObservable
  51245. * Note: This one is for backward compatibility. Please use onControllerMeshLoadedObservable directly
  51246. */
  51247. get onControllerMeshLoaded(): Observable<WebVRController>;
  51248. private _rayLength;
  51249. private _useCustomVRButton;
  51250. private _teleportationRequested;
  51251. private _teleportActive;
  51252. private _floorMeshName;
  51253. private _floorMeshesCollection;
  51254. private _teleportationMode;
  51255. private _teleportationTime;
  51256. private _teleportationSpeed;
  51257. private _teleportationEasing;
  51258. private _rotationAllowed;
  51259. private _teleportBackwardsVector;
  51260. private _teleportationTarget;
  51261. private _isDefaultTeleportationTarget;
  51262. private _postProcessMove;
  51263. private _teleportationFillColor;
  51264. private _teleportationBorderColor;
  51265. private _rotationAngle;
  51266. private _haloCenter;
  51267. private _cameraGazer;
  51268. private _padSensibilityUp;
  51269. private _padSensibilityDown;
  51270. private _leftController;
  51271. private _rightController;
  51272. private _gazeColor;
  51273. private _laserColor;
  51274. private _pickedLaserColor;
  51275. private _pickedGazeColor;
  51276. /**
  51277. * Observable raised when a new mesh is selected based on meshSelectionPredicate
  51278. */
  51279. onNewMeshSelected: Observable<AbstractMesh>;
  51280. /**
  51281. * Observable raised when a new mesh is selected based on meshSelectionPredicate.
  51282. * This observable will provide the mesh and the controller used to select the mesh
  51283. */
  51284. onMeshSelectedWithController: Observable<{
  51285. mesh: AbstractMesh;
  51286. controller: WebVRController;
  51287. }>;
  51288. /**
  51289. * Observable raised when a new mesh is picked based on meshSelectionPredicate
  51290. */
  51291. onNewMeshPicked: Observable<PickingInfo>;
  51292. private _circleEase;
  51293. /**
  51294. * Observable raised before camera teleportation
  51295. */
  51296. onBeforeCameraTeleport: Observable<Vector3>;
  51297. /**
  51298. * Observable raised after camera teleportation
  51299. */
  51300. onAfterCameraTeleport: Observable<Vector3>;
  51301. /**
  51302. * Observable raised when current selected mesh gets unselected
  51303. */
  51304. onSelectedMeshUnselected: Observable<AbstractMesh>;
  51305. private _raySelectionPredicate;
  51306. /**
  51307. * To be optionaly changed by user to define custom ray selection
  51308. */
  51309. raySelectionPredicate: (mesh: AbstractMesh) => boolean;
  51310. /**
  51311. * To be optionaly changed by user to define custom selection logic (after ray selection)
  51312. */
  51313. meshSelectionPredicate: (mesh: AbstractMesh) => boolean;
  51314. /**
  51315. * Set teleportation enabled. If set to false camera teleportation will be disabled but camera rotation will be kept.
  51316. */
  51317. teleportationEnabled: boolean;
  51318. private _defaultHeight;
  51319. private _teleportationInitialized;
  51320. private _interactionsEnabled;
  51321. private _interactionsRequested;
  51322. private _displayGaze;
  51323. private _displayLaserPointer;
  51324. /**
  51325. * The mesh used to display where the user is going to teleport.
  51326. */
  51327. get teleportationTarget(): Mesh;
  51328. /**
  51329. * Sets the mesh to be used to display where the user is going to teleport.
  51330. */
  51331. set teleportationTarget(value: Mesh);
  51332. /**
  51333. * 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
  51334. * when set bakeCurrentTransformIntoVertices will be called on the mesh.
  51335. * See https://doc.babylonjs.com/resources/baking_transformations
  51336. */
  51337. get gazeTrackerMesh(): Mesh;
  51338. set gazeTrackerMesh(value: Mesh);
  51339. /**
  51340. * If the gaze trackers scale should be updated to be constant size when pointing at near/far meshes
  51341. */
  51342. updateGazeTrackerScale: boolean;
  51343. /**
  51344. * If the gaze trackers color should be updated when selecting meshes
  51345. */
  51346. updateGazeTrackerColor: boolean;
  51347. /**
  51348. * If the controller laser color should be updated when selecting meshes
  51349. */
  51350. updateControllerLaserColor: boolean;
  51351. /**
  51352. * The gaze tracking mesh corresponding to the left controller
  51353. */
  51354. get leftControllerGazeTrackerMesh(): Nullable<Mesh>;
  51355. /**
  51356. * The gaze tracking mesh corresponding to the right controller
  51357. */
  51358. get rightControllerGazeTrackerMesh(): Nullable<Mesh>;
  51359. /**
  51360. * If the ray of the gaze should be displayed.
  51361. */
  51362. get displayGaze(): boolean;
  51363. /**
  51364. * Sets if the ray of the gaze should be displayed.
  51365. */
  51366. set displayGaze(value: boolean);
  51367. /**
  51368. * If the ray of the LaserPointer should be displayed.
  51369. */
  51370. get displayLaserPointer(): boolean;
  51371. /**
  51372. * Sets if the ray of the LaserPointer should be displayed.
  51373. */
  51374. set displayLaserPointer(value: boolean);
  51375. /**
  51376. * The deviceOrientationCamera used as the camera when not in VR.
  51377. */
  51378. get deviceOrientationCamera(): Nullable<DeviceOrientationCamera>;
  51379. /**
  51380. * Based on the current WebVR support, returns the current VR camera used.
  51381. */
  51382. get currentVRCamera(): Nullable<Camera>;
  51383. /**
  51384. * The webVRCamera which is used when in VR.
  51385. */
  51386. get webVRCamera(): WebVRFreeCamera;
  51387. /**
  51388. * The deviceOrientationCamera that is used as a fallback when vr device is not connected.
  51389. */
  51390. get vrDeviceOrientationCamera(): Nullable<VRDeviceOrientationFreeCamera>;
  51391. /**
  51392. * The html button that is used to trigger entering into VR.
  51393. */
  51394. get vrButton(): Nullable<HTMLButtonElement>;
  51395. private get _teleportationRequestInitiated();
  51396. /**
  51397. * Defines whether or not Pointer lock should be requested when switching to
  51398. * full screen.
  51399. */
  51400. requestPointerLockOnFullScreen: boolean;
  51401. /**
  51402. * If asking to force XR, this will be populated with the default xr experience
  51403. */
  51404. xr: WebXRDefaultExperience;
  51405. /**
  51406. * Was the XR test done already. If this is true AND this.xr exists, xr is initialized.
  51407. * If this is true and no this.xr, xr exists but is not supported, using WebVR.
  51408. */
  51409. xrTestDone: boolean;
  51410. /**
  51411. * Instantiates a VRExperienceHelper.
  51412. * Helps to quickly add VR support to an existing scene.
  51413. * @param scene The scene the VRExperienceHelper belongs to.
  51414. * @param webVROptions Options to modify the vr experience helper's behavior.
  51415. */
  51416. constructor(scene: Scene,
  51417. /** Options to modify the vr experience helper's behavior. */
  51418. webVROptions?: VRExperienceHelperOptions);
  51419. private completeVRInit;
  51420. private _onDefaultMeshLoaded;
  51421. private _onResize;
  51422. private _onFullscreenChange;
  51423. /**
  51424. * Gets a value indicating if we are currently in VR mode.
  51425. */
  51426. get isInVRMode(): boolean;
  51427. private onVrDisplayPresentChange;
  51428. private onVRDisplayChanged;
  51429. private moveButtonToBottomRight;
  51430. private displayVRButton;
  51431. private updateButtonVisibility;
  51432. private _cachedAngularSensibility;
  51433. /**
  51434. * Attempt to enter VR. If a headset is connected and ready, will request present on that.
  51435. * Otherwise, will use the fullscreen API.
  51436. */
  51437. enterVR(): void;
  51438. /**
  51439. * Attempt to exit VR, or fullscreen.
  51440. */
  51441. exitVR(): void;
  51442. /**
  51443. * The position of the vr experience helper.
  51444. */
  51445. get position(): Vector3;
  51446. /**
  51447. * Sets the position of the vr experience helper.
  51448. */
  51449. set position(value: Vector3);
  51450. /**
  51451. * Enables controllers and user interactions such as selecting and object or clicking on an object.
  51452. */
  51453. enableInteractions(): void;
  51454. private get _noControllerIsActive();
  51455. private beforeRender;
  51456. private _isTeleportationFloor;
  51457. /**
  51458. * Adds a floor mesh to be used for teleportation.
  51459. * @param floorMesh the mesh to be used for teleportation.
  51460. */
  51461. addFloorMesh(floorMesh: Mesh): void;
  51462. /**
  51463. * Removes a floor mesh from being used for teleportation.
  51464. * @param floorMesh the mesh to be removed.
  51465. */
  51466. removeFloorMesh(floorMesh: Mesh): void;
  51467. /**
  51468. * Enables interactions and teleportation using the VR controllers and gaze.
  51469. * @param vrTeleportationOptions options to modify teleportation behavior.
  51470. */
  51471. enableTeleportation(vrTeleportationOptions?: VRTeleportationOptions): void;
  51472. private _onNewGamepadConnected;
  51473. private _tryEnableInteractionOnController;
  51474. private _onNewGamepadDisconnected;
  51475. private _enableInteractionOnController;
  51476. private _checkTeleportWithRay;
  51477. private _checkRotate;
  51478. private _checkTeleportBackwards;
  51479. private _enableTeleportationOnController;
  51480. private _createTeleportationCircles;
  51481. private _displayTeleportationTarget;
  51482. private _hideTeleportationTarget;
  51483. private _rotateCamera;
  51484. private _moveTeleportationSelectorTo;
  51485. private _workingVector;
  51486. private _workingQuaternion;
  51487. private _workingMatrix;
  51488. /**
  51489. * Time Constant Teleportation Mode
  51490. */
  51491. static readonly TELEPORTATIONMODE_CONSTANTTIME: number;
  51492. /**
  51493. * Speed Constant Teleportation Mode
  51494. */
  51495. static readonly TELEPORTATIONMODE_CONSTANTSPEED: number;
  51496. /**
  51497. * Teleports the users feet to the desired location
  51498. * @param location The location where the user's feet should be placed
  51499. */
  51500. teleportCamera(location: Vector3): void;
  51501. private _convertNormalToDirectionOfRay;
  51502. private _castRayAndSelectObject;
  51503. private _notifySelectedMeshUnselected;
  51504. /**
  51505. * Permanently set new colors for the laser pointer
  51506. * @param color the new laser color
  51507. * @param pickedColor the new laser color when picked mesh detected
  51508. */
  51509. setLaserColor(color: Color3, pickedColor?: Color3): void;
  51510. /**
  51511. * Set lighting enabled / disabled on the laser pointer of both controllers
  51512. * @param enabled should the lighting be enabled on the laser pointer
  51513. */
  51514. setLaserLightingState(enabled?: boolean): void;
  51515. /**
  51516. * Permanently set new colors for the gaze pointer
  51517. * @param color the new gaze color
  51518. * @param pickedColor the new gaze color when picked mesh detected
  51519. */
  51520. setGazeColor(color: Color3, pickedColor?: Color3): void;
  51521. /**
  51522. * Sets the color of the laser ray from the vr controllers.
  51523. * @param color new color for the ray.
  51524. */
  51525. changeLaserColor(color: Color3): void;
  51526. /**
  51527. * Sets the color of the ray from the vr headsets gaze.
  51528. * @param color new color for the ray.
  51529. */
  51530. changeGazeColor(color: Color3): void;
  51531. /**
  51532. * Exits VR and disposes of the vr experience helper
  51533. */
  51534. dispose(): void;
  51535. /**
  51536. * Gets the name of the VRExperienceHelper class
  51537. * @returns "VRExperienceHelper"
  51538. */
  51539. getClassName(): string;
  51540. }
  51541. }
  51542. declare module "babylonjs/Cameras/VR/index" {
  51543. export * from "babylonjs/Cameras/VR/vrCameraMetrics";
  51544. export * from "babylonjs/Cameras/VR/vrDeviceOrientationArcRotateCamera";
  51545. export * from "babylonjs/Cameras/VR/vrDeviceOrientationFreeCamera";
  51546. export * from "babylonjs/Cameras/VR/vrDeviceOrientationGamepadCamera";
  51547. export * from "babylonjs/Cameras/VR/vrExperienceHelper";
  51548. export * from "babylonjs/Cameras/VR/webVRCamera";
  51549. }
  51550. declare module "babylonjs/Cameras/RigModes/index" {
  51551. export * from "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  51552. export * from "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  51553. export * from "babylonjs/Cameras/RigModes/vrRigMode";
  51554. export * from "babylonjs/Cameras/RigModes/webVRRigMode";
  51555. }
  51556. declare module "babylonjs/Cameras/index" {
  51557. export * from "babylonjs/Cameras/Inputs/index";
  51558. export * from "babylonjs/Cameras/cameraInputsManager";
  51559. export * from "babylonjs/Cameras/camera";
  51560. export * from "babylonjs/Cameras/targetCamera";
  51561. export * from "babylonjs/Cameras/freeCamera";
  51562. export * from "babylonjs/Cameras/freeCameraInputsManager";
  51563. export * from "babylonjs/Cameras/touchCamera";
  51564. export * from "babylonjs/Cameras/arcRotateCamera";
  51565. export * from "babylonjs/Cameras/arcRotateCameraInputsManager";
  51566. export * from "babylonjs/Cameras/deviceOrientationCamera";
  51567. export * from "babylonjs/Cameras/flyCamera";
  51568. export * from "babylonjs/Cameras/flyCameraInputsManager";
  51569. export * from "babylonjs/Cameras/followCamera";
  51570. export * from "babylonjs/Cameras/followCameraInputsManager";
  51571. export * from "babylonjs/Cameras/gamepadCamera";
  51572. export * from "babylonjs/Cameras/Stereoscopic/index";
  51573. export * from "babylonjs/Cameras/universalCamera";
  51574. export * from "babylonjs/Cameras/virtualJoysticksCamera";
  51575. export * from "babylonjs/Cameras/VR/index";
  51576. export * from "babylonjs/Cameras/RigModes/index";
  51577. }
  51578. declare module "babylonjs/Collisions/index" {
  51579. export * from "babylonjs/Collisions/collider";
  51580. export * from "babylonjs/Collisions/collisionCoordinator";
  51581. export * from "babylonjs/Collisions/pickingInfo";
  51582. export * from "babylonjs/Collisions/intersectionInfo";
  51583. export * from "babylonjs/Collisions/meshCollisionData";
  51584. }
  51585. declare module "babylonjs/Culling/Octrees/octreeBlock" {
  51586. import { SmartArrayNoDuplicate } from "babylonjs/Misc/smartArray";
  51587. import { Vector3 } from "babylonjs/Maths/math.vector";
  51588. import { Ray } from "babylonjs/Culling/ray";
  51589. import { Plane } from "babylonjs/Maths/math.plane";
  51590. /**
  51591. * Contains an array of blocks representing the octree
  51592. */
  51593. export interface IOctreeContainer<T> {
  51594. /**
  51595. * Blocks within the octree
  51596. */
  51597. blocks: Array<OctreeBlock<T>>;
  51598. }
  51599. /**
  51600. * Class used to store a cell in an octree
  51601. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  51602. */
  51603. export class OctreeBlock<T> {
  51604. /**
  51605. * Gets the content of the current block
  51606. */
  51607. entries: T[];
  51608. /**
  51609. * Gets the list of block children
  51610. */
  51611. blocks: Array<OctreeBlock<T>>;
  51612. private _depth;
  51613. private _maxDepth;
  51614. private _capacity;
  51615. private _minPoint;
  51616. private _maxPoint;
  51617. private _boundingVectors;
  51618. private _creationFunc;
  51619. /**
  51620. * Creates a new block
  51621. * @param minPoint defines the minimum vector (in world space) of the block's bounding box
  51622. * @param maxPoint defines the maximum vector (in world space) of the block's bounding box
  51623. * @param capacity defines the maximum capacity of this block (if capacity is reached the block will be split into sub blocks)
  51624. * @param depth defines the current depth of this block in the octree
  51625. * @param maxDepth defines the maximal depth allowed (beyond this value, the capacity is ignored)
  51626. * @param creationFunc defines a callback to call when an element is added to the block
  51627. */
  51628. constructor(minPoint: Vector3, maxPoint: Vector3, capacity: number, depth: number, maxDepth: number, creationFunc: (entry: T, block: OctreeBlock<T>) => void);
  51629. /**
  51630. * Gets the maximum capacity of this block (if capacity is reached the block will be split into sub blocks)
  51631. */
  51632. get capacity(): number;
  51633. /**
  51634. * Gets the minimum vector (in world space) of the block's bounding box
  51635. */
  51636. get minPoint(): Vector3;
  51637. /**
  51638. * Gets the maximum vector (in world space) of the block's bounding box
  51639. */
  51640. get maxPoint(): Vector3;
  51641. /**
  51642. * Add a new element to this block
  51643. * @param entry defines the element to add
  51644. */
  51645. addEntry(entry: T): void;
  51646. /**
  51647. * Remove an element from this block
  51648. * @param entry defines the element to remove
  51649. */
  51650. removeEntry(entry: T): void;
  51651. /**
  51652. * Add an array of elements to this block
  51653. * @param entries defines the array of elements to add
  51654. */
  51655. addEntries(entries: T[]): void;
  51656. /**
  51657. * Test if the current block intersects the furstum planes and if yes, then add its content to the selection array
  51658. * @param frustumPlanes defines the frustum planes to test
  51659. * @param selection defines the array to store current content if selection is positive
  51660. * @param allowDuplicate defines if the selection array can contains duplicated entries
  51661. */
  51662. select(frustumPlanes: Plane[], selection: SmartArrayNoDuplicate<T>, allowDuplicate?: boolean): void;
  51663. /**
  51664. * Test if the current block intersect with the given bounding sphere and if yes, then add its content to the selection array
  51665. * @param sphereCenter defines the bounding sphere center
  51666. * @param sphereRadius defines the bounding sphere radius
  51667. * @param selection defines the array to store current content if selection is positive
  51668. * @param allowDuplicate defines if the selection array can contains duplicated entries
  51669. */
  51670. intersects(sphereCenter: Vector3, sphereRadius: number, selection: SmartArrayNoDuplicate<T>, allowDuplicate?: boolean): void;
  51671. /**
  51672. * Test if the current block intersect with the given ray and if yes, then add its content to the selection array
  51673. * @param ray defines the ray to test with
  51674. * @param selection defines the array to store current content if selection is positive
  51675. */
  51676. intersectsRay(ray: Ray, selection: SmartArrayNoDuplicate<T>): void;
  51677. /**
  51678. * Subdivide the content into child blocks (this block will then be empty)
  51679. */
  51680. createInnerBlocks(): void;
  51681. /**
  51682. * @hidden
  51683. */
  51684. 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;
  51685. }
  51686. }
  51687. declare module "babylonjs/Culling/Octrees/octree" {
  51688. import { SmartArray } from "babylonjs/Misc/smartArray";
  51689. import { Vector3 } from "babylonjs/Maths/math.vector";
  51690. import { SubMesh } from "babylonjs/Meshes/subMesh";
  51691. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  51692. import { Ray } from "babylonjs/Culling/ray";
  51693. import { OctreeBlock } from "babylonjs/Culling/Octrees/octreeBlock";
  51694. import { Plane } from "babylonjs/Maths/math.plane";
  51695. /**
  51696. * Octrees are a really powerful data structure that can quickly select entities based on space coordinates.
  51697. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  51698. */
  51699. export class Octree<T> {
  51700. /** 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.) */
  51701. maxDepth: number;
  51702. /**
  51703. * Blocks within the octree containing objects
  51704. */
  51705. blocks: Array<OctreeBlock<T>>;
  51706. /**
  51707. * Content stored in the octree
  51708. */
  51709. dynamicContent: T[];
  51710. private _maxBlockCapacity;
  51711. private _selectionContent;
  51712. private _creationFunc;
  51713. /**
  51714. * Creates a octree
  51715. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  51716. * @param creationFunc function to be used to instatiate the octree
  51717. * @param maxBlockCapacity defines the maximum number of meshes you want on your octree's leaves (default: 64)
  51718. * @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.)
  51719. */
  51720. constructor(creationFunc: (entry: T, block: OctreeBlock<T>) => void, maxBlockCapacity?: number,
  51721. /** 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.) */
  51722. maxDepth?: number);
  51723. /**
  51724. * Updates the octree by adding blocks for the passed in meshes within the min and max world parameters
  51725. * @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);
  51726. * @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);
  51727. * @param entries meshes to be added to the octree blocks
  51728. */
  51729. update(worldMin: Vector3, worldMax: Vector3, entries: T[]): void;
  51730. /**
  51731. * Adds a mesh to the octree
  51732. * @param entry Mesh to add to the octree
  51733. */
  51734. addMesh(entry: T): void;
  51735. /**
  51736. * Remove an element from the octree
  51737. * @param entry defines the element to remove
  51738. */
  51739. removeMesh(entry: T): void;
  51740. /**
  51741. * Selects an array of meshes within the frustum
  51742. * @param frustumPlanes The frustum planes to use which will select all meshes within it
  51743. * @param allowDuplicate If duplicate objects are allowed in the resulting object array
  51744. * @returns array of meshes within the frustum
  51745. */
  51746. select(frustumPlanes: Plane[], allowDuplicate?: boolean): SmartArray<T>;
  51747. /**
  51748. * Test if the octree intersect with the given bounding sphere and if yes, then add its content to the selection array
  51749. * @param sphereCenter defines the bounding sphere center
  51750. * @param sphereRadius defines the bounding sphere radius
  51751. * @param allowDuplicate defines if the selection array can contains duplicated entries
  51752. * @returns an array of objects that intersect the sphere
  51753. */
  51754. intersects(sphereCenter: Vector3, sphereRadius: number, allowDuplicate?: boolean): SmartArray<T>;
  51755. /**
  51756. * Test if the octree intersect with the given ray and if yes, then add its content to resulting array
  51757. * @param ray defines the ray to test with
  51758. * @returns array of intersected objects
  51759. */
  51760. intersectsRay(ray: Ray): SmartArray<T>;
  51761. /**
  51762. * Adds a mesh into the octree block if it intersects the block
  51763. */
  51764. static CreationFuncForMeshes: (entry: AbstractMesh, block: OctreeBlock<AbstractMesh>) => void;
  51765. /**
  51766. * Adds a submesh into the octree block if it intersects the block
  51767. */
  51768. static CreationFuncForSubMeshes: (entry: SubMesh, block: OctreeBlock<SubMesh>) => void;
  51769. }
  51770. }
  51771. declare module "babylonjs/Culling/Octrees/octreeSceneComponent" {
  51772. import { ISmartArrayLike } from "babylonjs/Misc/smartArray";
  51773. import { Scene } from "babylonjs/scene";
  51774. import { SubMesh } from "babylonjs/Meshes/subMesh";
  51775. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  51776. import { Ray } from "babylonjs/Culling/ray";
  51777. import { Octree } from "babylonjs/Culling/Octrees/octree";
  51778. import { Collider } from "babylonjs/Collisions/collider";
  51779. module "babylonjs/scene" {
  51780. interface Scene {
  51781. /**
  51782. * @hidden
  51783. * Backing Filed
  51784. */
  51785. _selectionOctree: Octree<AbstractMesh>;
  51786. /**
  51787. * Gets the octree used to boost mesh selection (picking)
  51788. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  51789. */
  51790. selectionOctree: Octree<AbstractMesh>;
  51791. /**
  51792. * Creates or updates the octree used to boost selection (picking)
  51793. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  51794. * @param maxCapacity defines the maximum capacity per leaf
  51795. * @param maxDepth defines the maximum depth of the octree
  51796. * @returns an octree of AbstractMesh
  51797. */
  51798. createOrUpdateSelectionOctree(maxCapacity?: number, maxDepth?: number): Octree<AbstractMesh>;
  51799. }
  51800. }
  51801. module "babylonjs/Meshes/abstractMesh" {
  51802. interface AbstractMesh {
  51803. /**
  51804. * @hidden
  51805. * Backing Field
  51806. */
  51807. _submeshesOctree: Octree<SubMesh>;
  51808. /**
  51809. * This function will create an octree to help to select the right submeshes for rendering, picking and collision computations.
  51810. * Please note that you must have a decent number of submeshes to get performance improvements when using an octree
  51811. * @param maxCapacity defines the maximum size of each block (64 by default)
  51812. * @param maxDepth defines the maximum depth to use (no more than 2 levels by default)
  51813. * @returns the new octree
  51814. * @see https://www.babylonjs-playground.com/#NA4OQ#12
  51815. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  51816. */
  51817. createOrUpdateSubmeshesOctree(maxCapacity?: number, maxDepth?: number): Octree<SubMesh>;
  51818. }
  51819. }
  51820. /**
  51821. * Defines the octree scene component responsible to manage any octrees
  51822. * in a given scene.
  51823. */
  51824. export class OctreeSceneComponent {
  51825. /**
  51826. * The component name help to identify the component in the list of scene components.
  51827. */
  51828. readonly name: string;
  51829. /**
  51830. * The scene the component belongs to.
  51831. */
  51832. scene: Scene;
  51833. /**
  51834. * Indicates if the meshes have been checked to make sure they are isEnabled()
  51835. */
  51836. readonly checksIsEnabled: boolean;
  51837. /**
  51838. * Creates a new instance of the component for the given scene
  51839. * @param scene Defines the scene to register the component in
  51840. */
  51841. constructor(scene: Scene);
  51842. /**
  51843. * Registers the component in a given scene
  51844. */
  51845. register(): void;
  51846. /**
  51847. * Return the list of active meshes
  51848. * @returns the list of active meshes
  51849. */
  51850. getActiveMeshCandidates(): ISmartArrayLike<AbstractMesh>;
  51851. /**
  51852. * Return the list of active sub meshes
  51853. * @param mesh The mesh to get the candidates sub meshes from
  51854. * @returns the list of active sub meshes
  51855. */
  51856. getActiveSubMeshCandidates(mesh: AbstractMesh): ISmartArrayLike<SubMesh>;
  51857. private _tempRay;
  51858. /**
  51859. * Return the list of sub meshes intersecting with a given local ray
  51860. * @param mesh defines the mesh to find the submesh for
  51861. * @param localRay defines the ray in local space
  51862. * @returns the list of intersecting sub meshes
  51863. */
  51864. getIntersectingSubMeshCandidates(mesh: AbstractMesh, localRay: Ray): ISmartArrayLike<SubMesh>;
  51865. /**
  51866. * Return the list of sub meshes colliding with a collider
  51867. * @param mesh defines the mesh to find the submesh for
  51868. * @param collider defines the collider to evaluate the collision against
  51869. * @returns the list of colliding sub meshes
  51870. */
  51871. getCollidingSubMeshCandidates(mesh: AbstractMesh, collider: Collider): ISmartArrayLike<SubMesh>;
  51872. /**
  51873. * Rebuilds the elements related to this component in case of
  51874. * context lost for instance.
  51875. */
  51876. rebuild(): void;
  51877. /**
  51878. * Disposes the component and the associated ressources.
  51879. */
  51880. dispose(): void;
  51881. }
  51882. }
  51883. declare module "babylonjs/Culling/Octrees/index" {
  51884. export * from "babylonjs/Culling/Octrees/octree";
  51885. export * from "babylonjs/Culling/Octrees/octreeBlock";
  51886. export * from "babylonjs/Culling/Octrees/octreeSceneComponent";
  51887. }
  51888. declare module "babylonjs/Culling/index" {
  51889. export * from "babylonjs/Culling/boundingBox";
  51890. export * from "babylonjs/Culling/boundingInfo";
  51891. export * from "babylonjs/Culling/boundingSphere";
  51892. export * from "babylonjs/Culling/Octrees/index";
  51893. export * from "babylonjs/Culling/ray";
  51894. }
  51895. declare module "babylonjs/Gizmos/gizmo" {
  51896. import { Nullable } from "babylonjs/types";
  51897. import { IDisposable } from "babylonjs/scene";
  51898. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  51899. import { Mesh } from "babylonjs/Meshes/mesh";
  51900. import { Node } from "babylonjs/node";
  51901. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  51902. /**
  51903. * Renders gizmos on top of an existing scene which provide controls for position, rotation, etc.
  51904. */
  51905. export class Gizmo implements IDisposable {
  51906. /** The utility layer the gizmo will be added to */
  51907. gizmoLayer: UtilityLayerRenderer;
  51908. /**
  51909. * The root mesh of the gizmo
  51910. */
  51911. _rootMesh: Mesh;
  51912. private _attachedMesh;
  51913. private _attachedNode;
  51914. /**
  51915. * Ratio for the scale of the gizmo (Default: 1)
  51916. */
  51917. scaleRatio: number;
  51918. /**
  51919. * If a custom mesh has been set (Default: false)
  51920. */
  51921. protected _customMeshSet: boolean;
  51922. /**
  51923. * Mesh that the gizmo will be attached to. (eg. on a drag gizmo the mesh that will be dragged)
  51924. * * When set, interactions will be enabled
  51925. */
  51926. get attachedMesh(): Nullable<AbstractMesh>;
  51927. set attachedMesh(value: Nullable<AbstractMesh>);
  51928. /**
  51929. * Node that the gizmo will be attached to. (eg. on a drag gizmo the mesh, bone or NodeTransform that will be dragged)
  51930. * * When set, interactions will be enabled
  51931. */
  51932. get attachedNode(): Nullable<Node>;
  51933. set attachedNode(value: Nullable<Node>);
  51934. /**
  51935. * Disposes and replaces the current meshes in the gizmo with the specified mesh
  51936. * @param mesh The mesh to replace the default mesh of the gizmo
  51937. */
  51938. setCustomMesh(mesh: Mesh): void;
  51939. /**
  51940. * If set the gizmo's rotation will be updated to match the attached mesh each frame (Default: true)
  51941. */
  51942. updateGizmoRotationToMatchAttachedMesh: boolean;
  51943. /**
  51944. * If set the gizmo's position will be updated to match the attached mesh each frame (Default: true)
  51945. */
  51946. updateGizmoPositionToMatchAttachedMesh: boolean;
  51947. /**
  51948. * When set, the gizmo will always appear the same size no matter where the camera is (default: true)
  51949. */
  51950. updateScale: boolean;
  51951. protected _interactionsEnabled: boolean;
  51952. protected _attachedNodeChanged(value: Nullable<Node>): void;
  51953. private _beforeRenderObserver;
  51954. private _tempVector;
  51955. /**
  51956. * Creates a gizmo
  51957. * @param gizmoLayer The utility layer the gizmo will be added to
  51958. */
  51959. constructor(
  51960. /** The utility layer the gizmo will be added to */
  51961. gizmoLayer?: UtilityLayerRenderer);
  51962. /**
  51963. * Updates the gizmo to match the attached mesh's position/rotation
  51964. */
  51965. protected _update(): void;
  51966. /**
  51967. * computes the rotation/scaling/position of the transform once the Node world matrix has changed.
  51968. * @param value Node, TransformNode or mesh
  51969. */
  51970. protected _matrixChanged(): void;
  51971. /**
  51972. * Disposes of the gizmo
  51973. */
  51974. dispose(): void;
  51975. }
  51976. }
  51977. declare module "babylonjs/Gizmos/planeDragGizmo" {
  51978. import { Observable } from "babylonjs/Misc/observable";
  51979. import { Nullable } from "babylonjs/types";
  51980. import { Vector3 } from "babylonjs/Maths/math.vector";
  51981. import { Color3 } from "babylonjs/Maths/math.color";
  51982. import { TransformNode } from "babylonjs/Meshes/transformNode";
  51983. import { Node } from "babylonjs/node";
  51984. import { PointerDragBehavior } from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  51985. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  51986. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  51987. import { StandardMaterial } from "babylonjs/Materials/standardMaterial";
  51988. import { Scene } from "babylonjs/scene";
  51989. import { PositionGizmo } from "babylonjs/Gizmos/positionGizmo";
  51990. /**
  51991. * Single plane drag gizmo
  51992. */
  51993. export class PlaneDragGizmo extends Gizmo {
  51994. /**
  51995. * Drag behavior responsible for the gizmos dragging interactions
  51996. */
  51997. dragBehavior: PointerDragBehavior;
  51998. private _pointerObserver;
  51999. /**
  52000. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  52001. */
  52002. snapDistance: number;
  52003. /**
  52004. * Event that fires each time the gizmo snaps to a new location.
  52005. * * snapDistance is the the change in distance
  52006. */
  52007. onSnapObservable: Observable<{
  52008. snapDistance: number;
  52009. }>;
  52010. private _plane;
  52011. private _coloredMaterial;
  52012. private _hoverMaterial;
  52013. private _isEnabled;
  52014. private _parent;
  52015. /** @hidden */
  52016. static _CreatePlane(scene: Scene, material: StandardMaterial): TransformNode;
  52017. /** @hidden */
  52018. static _CreateArrowInstance(scene: Scene, arrow: TransformNode): TransformNode;
  52019. /**
  52020. * Creates a PlaneDragGizmo
  52021. * @param gizmoLayer The utility layer the gizmo will be added to
  52022. * @param dragPlaneNormal The axis normal to which the gizmo will be able to drag on
  52023. * @param color The color of the gizmo
  52024. */
  52025. constructor(dragPlaneNormal: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<PositionGizmo>);
  52026. protected _attachedNodeChanged(value: Nullable<Node>): void;
  52027. /**
  52028. * If the gizmo is enabled
  52029. */
  52030. set isEnabled(value: boolean);
  52031. get isEnabled(): boolean;
  52032. /**
  52033. * Disposes of the gizmo
  52034. */
  52035. dispose(): void;
  52036. }
  52037. }
  52038. declare module "babylonjs/Gizmos/positionGizmo" {
  52039. import { Observable } from "babylonjs/Misc/observable";
  52040. import { Nullable } from "babylonjs/types";
  52041. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  52042. import { Node } from "babylonjs/node";
  52043. import { Mesh } from "babylonjs/Meshes/mesh";
  52044. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  52045. import { AxisDragGizmo } from "babylonjs/Gizmos/axisDragGizmo";
  52046. import { PlaneDragGizmo } from "babylonjs/Gizmos/planeDragGizmo";
  52047. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  52048. /**
  52049. * Gizmo that enables dragging a mesh along 3 axis
  52050. */
  52051. export class PositionGizmo extends Gizmo {
  52052. /**
  52053. * Internal gizmo used for interactions on the x axis
  52054. */
  52055. xGizmo: AxisDragGizmo;
  52056. /**
  52057. * Internal gizmo used for interactions on the y axis
  52058. */
  52059. yGizmo: AxisDragGizmo;
  52060. /**
  52061. * Internal gizmo used for interactions on the z axis
  52062. */
  52063. zGizmo: AxisDragGizmo;
  52064. /**
  52065. * Internal gizmo used for interactions on the yz plane
  52066. */
  52067. xPlaneGizmo: PlaneDragGizmo;
  52068. /**
  52069. * Internal gizmo used for interactions on the xz plane
  52070. */
  52071. yPlaneGizmo: PlaneDragGizmo;
  52072. /**
  52073. * Internal gizmo used for interactions on the xy plane
  52074. */
  52075. zPlaneGizmo: PlaneDragGizmo;
  52076. /**
  52077. * private variables
  52078. */
  52079. private _meshAttached;
  52080. private _nodeAttached;
  52081. private _updateGizmoRotationToMatchAttachedMesh;
  52082. private _snapDistance;
  52083. private _scaleRatio;
  52084. /** Fires an event when any of it's sub gizmos are dragged */
  52085. onDragStartObservable: Observable<unknown>;
  52086. /** Fires an event when any of it's sub gizmos are released from dragging */
  52087. onDragEndObservable: Observable<unknown>;
  52088. /**
  52089. * If set to true, planar drag is enabled
  52090. */
  52091. private _planarGizmoEnabled;
  52092. get attachedMesh(): Nullable<AbstractMesh>;
  52093. set attachedMesh(mesh: Nullable<AbstractMesh>);
  52094. get attachedNode(): Nullable<Node>;
  52095. set attachedNode(node: Nullable<Node>);
  52096. /**
  52097. * Creates a PositionGizmo
  52098. * @param gizmoLayer The utility layer the gizmo will be added to
  52099. @param thickness display gizmo axis thickness
  52100. */
  52101. constructor(gizmoLayer?: UtilityLayerRenderer, thickness?: number);
  52102. /**
  52103. * If the planar drag gizmo is enabled
  52104. * setting this will enable/disable XY, XZ and YZ planes regardless of individual gizmo settings.
  52105. */
  52106. set planarGizmoEnabled(value: boolean);
  52107. get planarGizmoEnabled(): boolean;
  52108. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  52109. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  52110. /**
  52111. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  52112. */
  52113. set snapDistance(value: number);
  52114. get snapDistance(): number;
  52115. /**
  52116. * Ratio for the scale of the gizmo (Default: 1)
  52117. */
  52118. set scaleRatio(value: number);
  52119. get scaleRatio(): number;
  52120. /**
  52121. * Disposes of the gizmo
  52122. */
  52123. dispose(): void;
  52124. /**
  52125. * CustomMeshes are not supported by this gizmo
  52126. * @param mesh The mesh to replace the default mesh of the gizmo
  52127. */
  52128. setCustomMesh(mesh: Mesh): void;
  52129. }
  52130. }
  52131. declare module "babylonjs/Gizmos/axisDragGizmo" {
  52132. import { Observable } from "babylonjs/Misc/observable";
  52133. import { Nullable } from "babylonjs/types";
  52134. import { Vector3 } from "babylonjs/Maths/math.vector";
  52135. import { TransformNode } from "babylonjs/Meshes/transformNode";
  52136. import { Node } from "babylonjs/node";
  52137. import { PointerDragBehavior } from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  52138. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  52139. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  52140. import { StandardMaterial } from "babylonjs/Materials/standardMaterial";
  52141. import { Scene } from "babylonjs/scene";
  52142. import { PositionGizmo } from "babylonjs/Gizmos/positionGizmo";
  52143. import { Color3 } from "babylonjs/Maths/math.color";
  52144. /**
  52145. * Single axis drag gizmo
  52146. */
  52147. export class AxisDragGizmo extends Gizmo {
  52148. /**
  52149. * Drag behavior responsible for the gizmos dragging interactions
  52150. */
  52151. dragBehavior: PointerDragBehavior;
  52152. private _pointerObserver;
  52153. /**
  52154. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  52155. */
  52156. snapDistance: number;
  52157. /**
  52158. * Event that fires each time the gizmo snaps to a new location.
  52159. * * snapDistance is the the change in distance
  52160. */
  52161. onSnapObservable: Observable<{
  52162. snapDistance: number;
  52163. }>;
  52164. private _isEnabled;
  52165. private _parent;
  52166. private _arrow;
  52167. private _coloredMaterial;
  52168. private _hoverMaterial;
  52169. /** @hidden */
  52170. static _CreateArrow(scene: Scene, material: StandardMaterial, thickness?: number): TransformNode;
  52171. /** @hidden */
  52172. static _CreateArrowInstance(scene: Scene, arrow: TransformNode): TransformNode;
  52173. /**
  52174. * Creates an AxisDragGizmo
  52175. * @param gizmoLayer The utility layer the gizmo will be added to
  52176. * @param dragAxis The axis which the gizmo will be able to drag on
  52177. * @param color The color of the gizmo
  52178. * @param thickness display gizmo axis thickness
  52179. */
  52180. constructor(dragAxis: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<PositionGizmo>, thickness?: number);
  52181. protected _attachedNodeChanged(value: Nullable<Node>): void;
  52182. /**
  52183. * If the gizmo is enabled
  52184. */
  52185. set isEnabled(value: boolean);
  52186. get isEnabled(): boolean;
  52187. /**
  52188. * Disposes of the gizmo
  52189. */
  52190. dispose(): void;
  52191. }
  52192. }
  52193. declare module "babylonjs/Debug/axesViewer" {
  52194. import { Vector3 } from "babylonjs/Maths/math.vector";
  52195. import { Nullable } from "babylonjs/types";
  52196. import { Scene } from "babylonjs/scene";
  52197. import { TransformNode } from "babylonjs/Meshes/transformNode";
  52198. /**
  52199. * The Axes viewer will show 3 axes in a specific point in space
  52200. */
  52201. export class AxesViewer {
  52202. private _xAxis;
  52203. private _yAxis;
  52204. private _zAxis;
  52205. private _scaleLinesFactor;
  52206. private _instanced;
  52207. /**
  52208. * Gets the hosting scene
  52209. */
  52210. scene: Scene;
  52211. /**
  52212. * Gets or sets a number used to scale line length
  52213. */
  52214. scaleLines: number;
  52215. /** Gets the node hierarchy used to render x-axis */
  52216. get xAxis(): TransformNode;
  52217. /** Gets the node hierarchy used to render y-axis */
  52218. get yAxis(): TransformNode;
  52219. /** Gets the node hierarchy used to render z-axis */
  52220. get zAxis(): TransformNode;
  52221. /**
  52222. * Creates a new AxesViewer
  52223. * @param scene defines the hosting scene
  52224. * @param scaleLines defines a number used to scale line length (1 by default)
  52225. * @param renderingGroupId defines a number used to set the renderingGroupId of the meshes (2 by default)
  52226. * @param xAxis defines the node hierarchy used to render the x-axis
  52227. * @param yAxis defines the node hierarchy used to render the y-axis
  52228. * @param zAxis defines the node hierarchy used to render the z-axis
  52229. */
  52230. constructor(scene: Scene, scaleLines?: number, renderingGroupId?: Nullable<number>, xAxis?: TransformNode, yAxis?: TransformNode, zAxis?: TransformNode);
  52231. /**
  52232. * Force the viewer to update
  52233. * @param position defines the position of the viewer
  52234. * @param xaxis defines the x axis of the viewer
  52235. * @param yaxis defines the y axis of the viewer
  52236. * @param zaxis defines the z axis of the viewer
  52237. */
  52238. update(position: Vector3, xaxis: Vector3, yaxis: Vector3, zaxis: Vector3): void;
  52239. /**
  52240. * Creates an instance of this axes viewer.
  52241. * @returns a new axes viewer with instanced meshes
  52242. */
  52243. createInstance(): AxesViewer;
  52244. /** Releases resources */
  52245. dispose(): void;
  52246. private static _SetRenderingGroupId;
  52247. }
  52248. }
  52249. declare module "babylonjs/Debug/boneAxesViewer" {
  52250. import { Nullable } from "babylonjs/types";
  52251. import { AxesViewer } from "babylonjs/Debug/axesViewer";
  52252. import { Vector3 } from "babylonjs/Maths/math.vector";
  52253. import { Mesh } from "babylonjs/Meshes/mesh";
  52254. import { Bone } from "babylonjs/Bones/bone";
  52255. import { Scene } from "babylonjs/scene";
  52256. /**
  52257. * The BoneAxesViewer will attach 3 axes to a specific bone of a specific mesh
  52258. * @see demo here: https://www.babylonjs-playground.com/#0DE8F4#8
  52259. */
  52260. export class BoneAxesViewer extends AxesViewer {
  52261. /**
  52262. * Gets or sets the target mesh where to display the axes viewer
  52263. */
  52264. mesh: Nullable<Mesh>;
  52265. /**
  52266. * Gets or sets the target bone where to display the axes viewer
  52267. */
  52268. bone: Nullable<Bone>;
  52269. /** Gets current position */
  52270. pos: Vector3;
  52271. /** Gets direction of X axis */
  52272. xaxis: Vector3;
  52273. /** Gets direction of Y axis */
  52274. yaxis: Vector3;
  52275. /** Gets direction of Z axis */
  52276. zaxis: Vector3;
  52277. /**
  52278. * Creates a new BoneAxesViewer
  52279. * @param scene defines the hosting scene
  52280. * @param bone defines the target bone
  52281. * @param mesh defines the target mesh
  52282. * @param scaleLines defines a scaling factor for line length (1 by default)
  52283. */
  52284. constructor(scene: Scene, bone: Bone, mesh: Mesh, scaleLines?: number);
  52285. /**
  52286. * Force the viewer to update
  52287. */
  52288. update(): void;
  52289. /** Releases resources */
  52290. dispose(): void;
  52291. }
  52292. }
  52293. declare module "babylonjs/Debug/debugLayer" {
  52294. import { Scene } from "babylonjs/scene";
  52295. /**
  52296. * Interface used to define scene explorer extensibility option
  52297. */
  52298. export interface IExplorerExtensibilityOption {
  52299. /**
  52300. * Define the option label
  52301. */
  52302. label: string;
  52303. /**
  52304. * Defines the action to execute on click
  52305. */
  52306. action: (entity: any) => void;
  52307. }
  52308. /**
  52309. * Defines a group of actions associated with a predicate to use when extending the Inspector scene explorer
  52310. */
  52311. export interface IExplorerExtensibilityGroup {
  52312. /**
  52313. * Defines a predicate to test if a given type mut be extended
  52314. */
  52315. predicate: (entity: any) => boolean;
  52316. /**
  52317. * Gets the list of options added to a type
  52318. */
  52319. entries: IExplorerExtensibilityOption[];
  52320. }
  52321. /**
  52322. * Interface used to define the options to use to create the Inspector
  52323. */
  52324. export interface IInspectorOptions {
  52325. /**
  52326. * Display in overlay mode (default: false)
  52327. */
  52328. overlay?: boolean;
  52329. /**
  52330. * HTML element to use as root (the parent of the rendering canvas will be used as default value)
  52331. */
  52332. globalRoot?: HTMLElement;
  52333. /**
  52334. * Display the Scene explorer
  52335. */
  52336. showExplorer?: boolean;
  52337. /**
  52338. * Display the property inspector
  52339. */
  52340. showInspector?: boolean;
  52341. /**
  52342. * Display in embed mode (both panes on the right)
  52343. */
  52344. embedMode?: boolean;
  52345. /**
  52346. * let the Inspector handles resize of the canvas when panes are resized (default to true)
  52347. */
  52348. handleResize?: boolean;
  52349. /**
  52350. * Allow the panes to popup (default: true)
  52351. */
  52352. enablePopup?: boolean;
  52353. /**
  52354. * Allow the panes to be closed by users (default: true)
  52355. */
  52356. enableClose?: boolean;
  52357. /**
  52358. * Optional list of extensibility entries
  52359. */
  52360. explorerExtensibility?: IExplorerExtensibilityGroup[];
  52361. /**
  52362. * Optional URL to get the inspector script from (by default it uses the babylonjs CDN).
  52363. */
  52364. inspectorURL?: string;
  52365. /**
  52366. * Optional initial tab (default to DebugLayerTab.Properties)
  52367. */
  52368. initialTab?: DebugLayerTab;
  52369. }
  52370. module "babylonjs/scene" {
  52371. interface Scene {
  52372. /**
  52373. * @hidden
  52374. * Backing field
  52375. */
  52376. _debugLayer: DebugLayer;
  52377. /**
  52378. * Gets the debug layer (aka Inspector) associated with the scene
  52379. * @see https://doc.babylonjs.com/features/playground_debuglayer
  52380. */
  52381. debugLayer: DebugLayer;
  52382. }
  52383. }
  52384. /**
  52385. * Enum of inspector action tab
  52386. */
  52387. export enum DebugLayerTab {
  52388. /**
  52389. * Properties tag (default)
  52390. */
  52391. Properties = 0,
  52392. /**
  52393. * Debug tab
  52394. */
  52395. Debug = 1,
  52396. /**
  52397. * Statistics tab
  52398. */
  52399. Statistics = 2,
  52400. /**
  52401. * Tools tab
  52402. */
  52403. Tools = 3,
  52404. /**
  52405. * Settings tab
  52406. */
  52407. Settings = 4
  52408. }
  52409. /**
  52410. * The debug layer (aka Inspector) is the go to tool in order to better understand
  52411. * what is happening in your scene
  52412. * @see https://doc.babylonjs.com/features/playground_debuglayer
  52413. */
  52414. export class DebugLayer {
  52415. /**
  52416. * Define the url to get the inspector script from.
  52417. * By default it uses the babylonjs CDN.
  52418. * @ignoreNaming
  52419. */
  52420. static InspectorURL: string;
  52421. private _scene;
  52422. private BJSINSPECTOR;
  52423. private _onPropertyChangedObservable?;
  52424. /**
  52425. * Observable triggered when a property is changed through the inspector.
  52426. */
  52427. get onPropertyChangedObservable(): any;
  52428. /**
  52429. * Instantiates a new debug layer.
  52430. * The debug layer (aka Inspector) is the go to tool in order to better understand
  52431. * what is happening in your scene
  52432. * @see https://doc.babylonjs.com/features/playground_debuglayer
  52433. * @param scene Defines the scene to inspect
  52434. */
  52435. constructor(scene: Scene);
  52436. /** Creates the inspector window. */
  52437. private _createInspector;
  52438. /**
  52439. * Select a specific entity in the scene explorer and highlight a specific block in that entity property grid
  52440. * @param entity defines the entity to select
  52441. * @param lineContainerTitles defines the specific blocks to highlight (could be a string or an array of strings)
  52442. */
  52443. select(entity: any, lineContainerTitles?: string | string[]): void;
  52444. /** Get the inspector from bundle or global */
  52445. private _getGlobalInspector;
  52446. /**
  52447. * Get if the inspector is visible or not.
  52448. * @returns true if visible otherwise, false
  52449. */
  52450. isVisible(): boolean;
  52451. /**
  52452. * Hide the inspector and close its window.
  52453. */
  52454. hide(): void;
  52455. /**
  52456. * Update the scene in the inspector
  52457. */
  52458. setAsActiveScene(): void;
  52459. /**
  52460. * Launch the debugLayer.
  52461. * @param config Define the configuration of the inspector
  52462. * @return a promise fulfilled when the debug layer is visible
  52463. */
  52464. show(config?: IInspectorOptions): Promise<DebugLayer>;
  52465. }
  52466. }
  52467. declare module "babylonjs/Meshes/Builders/boxBuilder" {
  52468. import { Nullable } from "babylonjs/types";
  52469. import { Scene } from "babylonjs/scene";
  52470. import { Vector4 } from "babylonjs/Maths/math.vector";
  52471. import { Color4 } from "babylonjs/Maths/math.color";
  52472. import { Mesh } from "babylonjs/Meshes/mesh";
  52473. /**
  52474. * Class containing static functions to help procedurally build meshes
  52475. */
  52476. export class BoxBuilder {
  52477. /**
  52478. * Creates a box mesh
  52479. * * The parameter `size` sets the size (float) of each box side (default 1)
  52480. * * You can set some different box dimensions by using the parameters `width`, `height` and `depth` (all by default have the same value of `size`)
  52481. * * 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)
  52482. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  52483. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  52484. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  52485. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  52486. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  52487. * @param name defines the name of the mesh
  52488. * @param options defines the options used to create the mesh
  52489. * @param scene defines the hosting scene
  52490. * @returns the box mesh
  52491. */
  52492. static CreateBox(name: string, options: {
  52493. size?: number;
  52494. width?: number;
  52495. height?: number;
  52496. depth?: number;
  52497. faceUV?: Vector4[];
  52498. faceColors?: Color4[];
  52499. sideOrientation?: number;
  52500. frontUVs?: Vector4;
  52501. backUVs?: Vector4;
  52502. wrap?: boolean;
  52503. topBaseAt?: number;
  52504. bottomBaseAt?: number;
  52505. updatable?: boolean;
  52506. }, scene?: Nullable<Scene>): Mesh;
  52507. }
  52508. }
  52509. declare module "babylonjs/Debug/physicsViewer" {
  52510. import { Nullable } from "babylonjs/types";
  52511. import { Scene } from "babylonjs/scene";
  52512. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  52513. import { Mesh } from "babylonjs/Meshes/mesh";
  52514. import { IPhysicsEnginePlugin } from "babylonjs/Physics/IPhysicsEngine";
  52515. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  52516. /**
  52517. * Used to show the physics impostor around the specific mesh
  52518. */
  52519. export class PhysicsViewer {
  52520. /** @hidden */
  52521. protected _impostors: Array<Nullable<PhysicsImpostor>>;
  52522. /** @hidden */
  52523. protected _meshes: Array<Nullable<AbstractMesh>>;
  52524. /** @hidden */
  52525. protected _scene: Nullable<Scene>;
  52526. /** @hidden */
  52527. protected _numMeshes: number;
  52528. /** @hidden */
  52529. protected _physicsEnginePlugin: Nullable<IPhysicsEnginePlugin>;
  52530. private _renderFunction;
  52531. private _utilityLayer;
  52532. private _debugBoxMesh;
  52533. private _debugSphereMesh;
  52534. private _debugCylinderMesh;
  52535. private _debugMaterial;
  52536. private _debugMeshMeshes;
  52537. /**
  52538. * Creates a new PhysicsViewer
  52539. * @param scene defines the hosting scene
  52540. */
  52541. constructor(scene: Scene);
  52542. /** @hidden */
  52543. protected _updateDebugMeshes(): void;
  52544. /**
  52545. * Renders a specified physic impostor
  52546. * @param impostor defines the impostor to render
  52547. * @param targetMesh defines the mesh represented by the impostor
  52548. * @returns the new debug mesh used to render the impostor
  52549. */
  52550. showImpostor(impostor: PhysicsImpostor, targetMesh?: Mesh): Nullable<AbstractMesh>;
  52551. /**
  52552. * Hides a specified physic impostor
  52553. * @param impostor defines the impostor to hide
  52554. */
  52555. hideImpostor(impostor: Nullable<PhysicsImpostor>): void;
  52556. private _getDebugMaterial;
  52557. private _getDebugBoxMesh;
  52558. private _getDebugSphereMesh;
  52559. private _getDebugCylinderMesh;
  52560. private _getDebugMeshMesh;
  52561. private _getDebugMesh;
  52562. /** Releases all resources */
  52563. dispose(): void;
  52564. }
  52565. }
  52566. declare module "babylonjs/Debug/rayHelper" {
  52567. import { Nullable } from "babylonjs/types";
  52568. import { Ray } from "babylonjs/Culling/ray";
  52569. import { Vector3 } from "babylonjs/Maths/math.vector";
  52570. import { Color3 } from "babylonjs/Maths/math.color";
  52571. import { Scene } from "babylonjs/scene";
  52572. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  52573. import "babylonjs/Meshes/Builders/linesBuilder";
  52574. /**
  52575. * As raycast might be hard to debug, the RayHelper can help rendering the different rays
  52576. * in order to better appreciate the issue one might have.
  52577. * @see https://doc.babylonjs.com/babylon101/raycasts#debugging
  52578. */
  52579. export class RayHelper {
  52580. /**
  52581. * Defines the ray we are currently tryin to visualize.
  52582. */
  52583. ray: Nullable<Ray>;
  52584. private _renderPoints;
  52585. private _renderLine;
  52586. private _renderFunction;
  52587. private _scene;
  52588. private _updateToMeshFunction;
  52589. private _attachedToMesh;
  52590. private _meshSpaceDirection;
  52591. private _meshSpaceOrigin;
  52592. /**
  52593. * Helper function to create a colored helper in a scene in one line.
  52594. * @param ray Defines the ray we are currently tryin to visualize
  52595. * @param scene Defines the scene the ray is used in
  52596. * @param color Defines the color we want to see the ray in
  52597. * @returns The newly created ray helper.
  52598. */
  52599. static CreateAndShow(ray: Ray, scene: Scene, color: Color3): RayHelper;
  52600. /**
  52601. * Instantiate a new ray helper.
  52602. * As raycast might be hard to debug, the RayHelper can help rendering the different rays
  52603. * in order to better appreciate the issue one might have.
  52604. * @see https://doc.babylonjs.com/babylon101/raycasts#debugging
  52605. * @param ray Defines the ray we are currently tryin to visualize
  52606. */
  52607. constructor(ray: Ray);
  52608. /**
  52609. * Shows the ray we are willing to debug.
  52610. * @param scene Defines the scene the ray needs to be rendered in
  52611. * @param color Defines the color the ray needs to be rendered in
  52612. */
  52613. show(scene: Scene, color?: Color3): void;
  52614. /**
  52615. * Hides the ray we are debugging.
  52616. */
  52617. hide(): void;
  52618. private _render;
  52619. /**
  52620. * Attach a ray helper to a mesh so that we can easily see its orientation for instance or information like its normals.
  52621. * @param mesh Defines the mesh we want the helper attached to
  52622. * @param meshSpaceDirection Defines the direction of the Ray in mesh space (local space of the mesh node)
  52623. * @param meshSpaceOrigin Defines the origin of the Ray in mesh space (local space of the mesh node)
  52624. * @param length Defines the length of the ray
  52625. */
  52626. attachToMesh(mesh: AbstractMesh, meshSpaceDirection?: Vector3, meshSpaceOrigin?: Vector3, length?: number): void;
  52627. /**
  52628. * Detach the ray helper from the mesh it has previously been attached to.
  52629. */
  52630. detachFromMesh(): void;
  52631. private _updateToMesh;
  52632. /**
  52633. * Dispose the helper and release its associated resources.
  52634. */
  52635. dispose(): void;
  52636. }
  52637. }
  52638. declare module "babylonjs/Debug/skeletonViewer" {
  52639. import { Color3 } from "babylonjs/Maths/math.color";
  52640. import { Scene } from "babylonjs/scene";
  52641. import { Nullable } from "babylonjs/types";
  52642. import { Skeleton } from "babylonjs/Bones/skeleton";
  52643. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  52644. import { LinesMesh } from "babylonjs/Meshes/linesMesh";
  52645. /**
  52646. * Class used to render a debug view of a given skeleton
  52647. * @see http://www.babylonjs-playground.com/#1BZJVJ#8
  52648. */
  52649. export class SkeletonViewer {
  52650. /** defines the skeleton to render */
  52651. skeleton: Skeleton;
  52652. /** defines the mesh attached to the skeleton */
  52653. mesh: AbstractMesh;
  52654. /** defines a boolean indicating if bones matrices must be forced to update before rendering (true by default) */
  52655. autoUpdateBonesMatrices: boolean;
  52656. /** defines the rendering group id to use with the viewer */
  52657. renderingGroupId: number;
  52658. /** Gets or sets the color used to render the skeleton */
  52659. color: Color3;
  52660. private _scene;
  52661. private _debugLines;
  52662. private _debugMesh;
  52663. private _isEnabled;
  52664. private _renderFunction;
  52665. private _utilityLayer;
  52666. /**
  52667. * Returns the mesh used to render the bones
  52668. */
  52669. get debugMesh(): Nullable<LinesMesh>;
  52670. /**
  52671. * Creates a new SkeletonViewer
  52672. * @param skeleton defines the skeleton to render
  52673. * @param mesh defines the mesh attached to the skeleton
  52674. * @param scene defines the hosting scene
  52675. * @param autoUpdateBonesMatrices defines a boolean indicating if bones matrices must be forced to update before rendering (true by default)
  52676. * @param renderingGroupId defines the rendering group id to use with the viewer
  52677. */
  52678. constructor(
  52679. /** defines the skeleton to render */
  52680. skeleton: Skeleton,
  52681. /** defines the mesh attached to the skeleton */
  52682. mesh: AbstractMesh, scene: Scene,
  52683. /** defines a boolean indicating if bones matrices must be forced to update before rendering (true by default) */
  52684. autoUpdateBonesMatrices?: boolean,
  52685. /** defines the rendering group id to use with the viewer */
  52686. renderingGroupId?: number);
  52687. /** Gets or sets a boolean indicating if the viewer is enabled */
  52688. set isEnabled(value: boolean);
  52689. get isEnabled(): boolean;
  52690. private _getBonePosition;
  52691. private _getLinesForBonesWithLength;
  52692. private _getLinesForBonesNoLength;
  52693. /** Update the viewer to sync with current skeleton state */
  52694. update(): void;
  52695. /** Release associated resources */
  52696. dispose(): void;
  52697. }
  52698. }
  52699. declare module "babylonjs/Debug/index" {
  52700. export * from "babylonjs/Debug/axesViewer";
  52701. export * from "babylonjs/Debug/boneAxesViewer";
  52702. export * from "babylonjs/Debug/debugLayer";
  52703. export * from "babylonjs/Debug/physicsViewer";
  52704. export * from "babylonjs/Debug/rayHelper";
  52705. export * from "babylonjs/Debug/skeletonViewer";
  52706. }
  52707. declare module "babylonjs/DeviceInput/InputDevices/deviceEnums" {
  52708. /**
  52709. * Enum for Device Types
  52710. */
  52711. export enum DeviceType {
  52712. /** Generic */
  52713. Generic = 0,
  52714. /** Keyboard */
  52715. Keyboard = 1,
  52716. /** Mouse */
  52717. Mouse = 2,
  52718. /** Touch Pointers */
  52719. Touch = 3,
  52720. /** PS4 Dual Shock */
  52721. DualShock = 4,
  52722. /** Xbox */
  52723. Xbox = 5,
  52724. /** Switch Controller */
  52725. Switch = 6
  52726. }
  52727. /**
  52728. * Enum for All Pointers (Touch/Mouse)
  52729. */
  52730. export enum PointerInput {
  52731. /** Horizontal Axis */
  52732. Horizontal = 0,
  52733. /** Vertical Axis */
  52734. Vertical = 1,
  52735. /** Left Click or Touch */
  52736. LeftClick = 2,
  52737. /** Middle Click */
  52738. MiddleClick = 3,
  52739. /** Right Click */
  52740. RightClick = 4,
  52741. /** Browser Back */
  52742. BrowserBack = 5,
  52743. /** Browser Forward */
  52744. BrowserForward = 6
  52745. }
  52746. /**
  52747. * Enum for Dual Shock Gamepad
  52748. */
  52749. export enum DualShockInput {
  52750. /** Cross */
  52751. Cross = 0,
  52752. /** Circle */
  52753. Circle = 1,
  52754. /** Square */
  52755. Square = 2,
  52756. /** Triangle */
  52757. Triangle = 3,
  52758. /** L1 */
  52759. L1 = 4,
  52760. /** R1 */
  52761. R1 = 5,
  52762. /** L2 */
  52763. L2 = 6,
  52764. /** R2 */
  52765. R2 = 7,
  52766. /** Share */
  52767. Share = 8,
  52768. /** Options */
  52769. Options = 9,
  52770. /** L3 */
  52771. L3 = 10,
  52772. /** R3 */
  52773. R3 = 11,
  52774. /** DPadUp */
  52775. DPadUp = 12,
  52776. /** DPadDown */
  52777. DPadDown = 13,
  52778. /** DPadLeft */
  52779. DPadLeft = 14,
  52780. /** DRight */
  52781. DPadRight = 15,
  52782. /** Home */
  52783. Home = 16,
  52784. /** TouchPad */
  52785. TouchPad = 17,
  52786. /** LStickXAxis */
  52787. LStickXAxis = 18,
  52788. /** LStickYAxis */
  52789. LStickYAxis = 19,
  52790. /** RStickXAxis */
  52791. RStickXAxis = 20,
  52792. /** RStickYAxis */
  52793. RStickYAxis = 21
  52794. }
  52795. /**
  52796. * Enum for Xbox Gamepad
  52797. */
  52798. export enum XboxInput {
  52799. /** A */
  52800. A = 0,
  52801. /** B */
  52802. B = 1,
  52803. /** X */
  52804. X = 2,
  52805. /** Y */
  52806. Y = 3,
  52807. /** LB */
  52808. LB = 4,
  52809. /** RB */
  52810. RB = 5,
  52811. /** LT */
  52812. LT = 6,
  52813. /** RT */
  52814. RT = 7,
  52815. /** Back */
  52816. Back = 8,
  52817. /** Start */
  52818. Start = 9,
  52819. /** LS */
  52820. LS = 10,
  52821. /** RS */
  52822. RS = 11,
  52823. /** DPadUp */
  52824. DPadUp = 12,
  52825. /** DPadDown */
  52826. DPadDown = 13,
  52827. /** DPadLeft */
  52828. DPadLeft = 14,
  52829. /** DRight */
  52830. DPadRight = 15,
  52831. /** Home */
  52832. Home = 16,
  52833. /** LStickXAxis */
  52834. LStickXAxis = 17,
  52835. /** LStickYAxis */
  52836. LStickYAxis = 18,
  52837. /** RStickXAxis */
  52838. RStickXAxis = 19,
  52839. /** RStickYAxis */
  52840. RStickYAxis = 20
  52841. }
  52842. /**
  52843. * Enum for Switch (Pro/JoyCon L+R) Gamepad
  52844. */
  52845. export enum SwitchInput {
  52846. /** B */
  52847. B = 0,
  52848. /** A */
  52849. A = 1,
  52850. /** Y */
  52851. Y = 2,
  52852. /** X */
  52853. X = 3,
  52854. /** L */
  52855. L = 4,
  52856. /** R */
  52857. R = 5,
  52858. /** ZL */
  52859. ZL = 6,
  52860. /** ZR */
  52861. ZR = 7,
  52862. /** Minus */
  52863. Minus = 8,
  52864. /** Plus */
  52865. Plus = 9,
  52866. /** LS */
  52867. LS = 10,
  52868. /** RS */
  52869. RS = 11,
  52870. /** DPadUp */
  52871. DPadUp = 12,
  52872. /** DPadDown */
  52873. DPadDown = 13,
  52874. /** DPadLeft */
  52875. DPadLeft = 14,
  52876. /** DRight */
  52877. DPadRight = 15,
  52878. /** Home */
  52879. Home = 16,
  52880. /** Capture */
  52881. Capture = 17,
  52882. /** LStickXAxis */
  52883. LStickXAxis = 18,
  52884. /** LStickYAxis */
  52885. LStickYAxis = 19,
  52886. /** RStickXAxis */
  52887. RStickXAxis = 20,
  52888. /** RStickYAxis */
  52889. RStickYAxis = 21
  52890. }
  52891. }
  52892. declare module "babylonjs/DeviceInput/deviceInputSystem" {
  52893. import { Engine } from "babylonjs/Engines/engine";
  52894. import { IDisposable } from "babylonjs/scene";
  52895. import { Nullable } from "babylonjs/types";
  52896. import { DeviceType } from "babylonjs/DeviceInput/InputDevices/deviceEnums";
  52897. /**
  52898. * This class will take all inputs from Keyboard, Pointer, and
  52899. * any Gamepads and provide a polling system that all devices
  52900. * will use. This class assumes that there will only be one
  52901. * pointer device and one keyboard.
  52902. */
  52903. export class DeviceInputSystem implements IDisposable {
  52904. /**
  52905. * Callback to be triggered when a device is connected
  52906. */
  52907. onDeviceConnected: (deviceType: DeviceType, deviceSlot: number) => void;
  52908. /**
  52909. * Callback to be triggered when a device is disconnected
  52910. */
  52911. onDeviceDisconnected: (deviceType: DeviceType, deviceSlot: number) => void;
  52912. /**
  52913. * Callback to be triggered when event driven input is updated
  52914. */
  52915. onInputChanged: (deviceType: DeviceType, deviceSlot: number, inputIndex: number, previousState: Nullable<number>, currentState: Nullable<number>) => void;
  52916. private _inputs;
  52917. private _gamepads;
  52918. private _keyboardActive;
  52919. private _pointerActive;
  52920. private _elementToAttachTo;
  52921. private _keyboardDownEvent;
  52922. private _keyboardUpEvent;
  52923. private _pointerMoveEvent;
  52924. private _pointerDownEvent;
  52925. private _pointerUpEvent;
  52926. private _gamepadConnectedEvent;
  52927. private _gamepadDisconnectedEvent;
  52928. private static _MAX_KEYCODES;
  52929. private static _MAX_POINTER_INPUTS;
  52930. private constructor();
  52931. /**
  52932. * Creates a new DeviceInputSystem instance
  52933. * @param engine Engine to pull input element from
  52934. * @returns The new instance
  52935. */
  52936. static Create(engine: Engine): DeviceInputSystem;
  52937. /**
  52938. * Checks for current device input value, given an id and input index
  52939. * @param deviceName Id of connected device
  52940. * @param inputIndex Index of device input
  52941. * @returns Current value of input
  52942. */
  52943. /**
  52944. * Checks for current device input value, given an id and input index
  52945. * @param deviceType Enum specifiying device type
  52946. * @param deviceSlot "Slot" or index that device is referenced in
  52947. * @param inputIndex Id of input to be checked
  52948. * @returns Current value of input
  52949. */
  52950. pollInput(deviceType: DeviceType, deviceSlot: number, inputIndex: number): Nullable<number>;
  52951. /**
  52952. * Dispose of all the eventlisteners
  52953. */
  52954. dispose(): void;
  52955. /**
  52956. * Add device and inputs to device array
  52957. * @param deviceType Enum specifiying device type
  52958. * @param deviceSlot "Slot" or index that device is referenced in
  52959. * @param numberOfInputs Number of input entries to create for given device
  52960. */
  52961. private _registerDevice;
  52962. /**
  52963. * Given a specific device name, remove that device from the device map
  52964. * @param deviceType Enum specifiying device type
  52965. * @param deviceSlot "Slot" or index that device is referenced in
  52966. */
  52967. private _unregisterDevice;
  52968. /**
  52969. * Handle all actions that come from keyboard interaction
  52970. */
  52971. private _handleKeyActions;
  52972. /**
  52973. * Handle all actions that come from pointer interaction
  52974. */
  52975. private _handlePointerActions;
  52976. /**
  52977. * Handle all actions that come from gamepad interaction
  52978. */
  52979. private _handleGamepadActions;
  52980. /**
  52981. * Update all non-event based devices with each frame
  52982. * @param deviceType Enum specifiying device type
  52983. * @param deviceSlot "Slot" or index that device is referenced in
  52984. * @param inputIndex Id of input to be checked
  52985. */
  52986. private _updateDevice;
  52987. /**
  52988. * Gets DeviceType from the device name
  52989. * @param deviceName Name of Device from DeviceInputSystem
  52990. * @returns DeviceType enum value
  52991. */
  52992. private _getGamepadDeviceType;
  52993. }
  52994. }
  52995. declare module "babylonjs/DeviceInput/InputDevices/deviceTypes" {
  52996. import { DeviceType, PointerInput, DualShockInput, XboxInput, SwitchInput } from "babylonjs/DeviceInput/InputDevices/deviceEnums";
  52997. /**
  52998. * Type to handle enforcement of inputs
  52999. */
  53000. 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;
  53001. }
  53002. declare module "babylonjs/DeviceInput/InputDevices/deviceSourceManager" {
  53003. import { DeviceInputSystem } from "babylonjs/DeviceInput/deviceInputSystem";
  53004. import { Engine } from "babylonjs/Engines/engine";
  53005. import { IDisposable } from "babylonjs/scene";
  53006. import { DeviceType } from "babylonjs/DeviceInput/InputDevices/deviceEnums";
  53007. import { Nullable } from "babylonjs/types";
  53008. import { Observable } from "babylonjs/Misc/observable";
  53009. import { DeviceInput } from "babylonjs/DeviceInput/InputDevices/deviceTypes";
  53010. /**
  53011. * Class that handles all input for a specific device
  53012. */
  53013. export class DeviceSource<T extends DeviceType> {
  53014. /** Type of device */
  53015. readonly deviceType: DeviceType;
  53016. /** "Slot" or index that device is referenced in */
  53017. readonly deviceSlot: number;
  53018. /**
  53019. * Observable to handle device input changes per device
  53020. */
  53021. readonly onInputChangedObservable: Observable<{
  53022. inputIndex: DeviceInput<T>;
  53023. previousState: Nullable<number>;
  53024. currentState: Nullable<number>;
  53025. }>;
  53026. private readonly _deviceInputSystem;
  53027. /**
  53028. * Default Constructor
  53029. * @param deviceInputSystem Reference to DeviceInputSystem
  53030. * @param deviceType Type of device
  53031. * @param deviceSlot "Slot" or index that device is referenced in
  53032. */
  53033. constructor(deviceInputSystem: DeviceInputSystem,
  53034. /** Type of device */
  53035. deviceType: DeviceType,
  53036. /** "Slot" or index that device is referenced in */
  53037. deviceSlot?: number);
  53038. /**
  53039. * Get input for specific input
  53040. * @param inputIndex index of specific input on device
  53041. * @returns Input value from DeviceInputSystem
  53042. */
  53043. getInput(inputIndex: DeviceInput<T>): Nullable<number>;
  53044. }
  53045. /**
  53046. * Class to keep track of devices
  53047. */
  53048. export class DeviceSourceManager implements IDisposable {
  53049. /**
  53050. * Observable to be triggered when before a device is connected
  53051. */
  53052. readonly onBeforeDeviceConnectedObservable: Observable<{
  53053. deviceType: DeviceType;
  53054. deviceSlot: number;
  53055. }>;
  53056. /**
  53057. * Observable to be triggered when before a device is disconnected
  53058. */
  53059. readonly onBeforeDeviceDisconnectedObservable: Observable<{
  53060. deviceType: DeviceType;
  53061. deviceSlot: number;
  53062. }>;
  53063. /**
  53064. * Observable to be triggered when after a device is connected
  53065. */
  53066. readonly onAfterDeviceConnectedObservable: Observable<{
  53067. deviceType: DeviceType;
  53068. deviceSlot: number;
  53069. }>;
  53070. /**
  53071. * Observable to be triggered when after a device is disconnected
  53072. */
  53073. readonly onAfterDeviceDisconnectedObservable: Observable<{
  53074. deviceType: DeviceType;
  53075. deviceSlot: number;
  53076. }>;
  53077. private readonly _devices;
  53078. private readonly _firstDevice;
  53079. private readonly _deviceInputSystem;
  53080. /**
  53081. * Default Constructor
  53082. * @param engine engine to pull input element from
  53083. */
  53084. constructor(engine: Engine);
  53085. /**
  53086. * Gets a DeviceSource, given a type and slot
  53087. * @param deviceType Enum specifying device type
  53088. * @param deviceSlot "Slot" or index that device is referenced in
  53089. * @returns DeviceSource object
  53090. */
  53091. getDeviceSource<T extends DeviceType>(deviceType: T, deviceSlot?: number): Nullable<DeviceSource<T>>;
  53092. /**
  53093. * Gets an array of DeviceSource objects for a given device type
  53094. * @param deviceType Enum specifying device type
  53095. * @returns Array of DeviceSource objects
  53096. */
  53097. getDeviceSources<T extends DeviceType>(deviceType: T): ReadonlyArray<DeviceSource<T>>;
  53098. /**
  53099. * Dispose of DeviceInputSystem and other parts
  53100. */
  53101. dispose(): void;
  53102. /**
  53103. * Function to add device name to device list
  53104. * @param deviceType Enum specifying device type
  53105. * @param deviceSlot "Slot" or index that device is referenced in
  53106. */
  53107. private _addDevice;
  53108. /**
  53109. * Function to remove device name to device list
  53110. * @param deviceType Enum specifying device type
  53111. * @param deviceSlot "Slot" or index that device is referenced in
  53112. */
  53113. private _removeDevice;
  53114. /**
  53115. * Updates array storing first connected device of each type
  53116. * @param type Type of Device
  53117. */
  53118. private _updateFirstDevices;
  53119. }
  53120. }
  53121. declare module "babylonjs/DeviceInput/index" {
  53122. export * from "babylonjs/DeviceInput/deviceInputSystem";
  53123. export * from "babylonjs/DeviceInput/InputDevices/deviceEnums";
  53124. export * from "babylonjs/DeviceInput/InputDevices/deviceTypes";
  53125. import "babylonjs/DeviceInput/InputDevices/deviceSourceManager";
  53126. export * from "babylonjs/DeviceInput/InputDevices/deviceSourceManager";
  53127. }
  53128. declare module "babylonjs/Engines/nullEngine" {
  53129. import { Nullable, FloatArray, IndicesArray } from "babylonjs/types";
  53130. import { Engine } from "babylonjs/Engines/engine";
  53131. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  53132. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  53133. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  53134. import { Effect } from "babylonjs/Materials/effect";
  53135. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  53136. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  53137. import { IColor4Like, IViewportLike } from "babylonjs/Maths/math.like";
  53138. import { ISceneLike } from "babylonjs/Engines/thinEngine";
  53139. /**
  53140. * Options to create the null engine
  53141. */
  53142. export class NullEngineOptions {
  53143. /**
  53144. * Render width (Default: 512)
  53145. */
  53146. renderWidth: number;
  53147. /**
  53148. * Render height (Default: 256)
  53149. */
  53150. renderHeight: number;
  53151. /**
  53152. * Texture size (Default: 512)
  53153. */
  53154. textureSize: number;
  53155. /**
  53156. * If delta time between frames should be constant
  53157. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  53158. */
  53159. deterministicLockstep: boolean;
  53160. /**
  53161. * Maximum about of steps between frames (Default: 4)
  53162. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  53163. */
  53164. lockstepMaxSteps: number;
  53165. /**
  53166. * Make the matrix computations to be performed in 64 bits instead of 32 bits. False by default
  53167. */
  53168. useHighPrecisionMatrix?: boolean;
  53169. }
  53170. /**
  53171. * The null engine class provides support for headless version of babylon.js.
  53172. * This can be used in server side scenario or for testing purposes
  53173. */
  53174. export class NullEngine extends Engine {
  53175. private _options;
  53176. /**
  53177. * Gets a boolean indicating that the engine is running in deterministic lock step mode
  53178. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  53179. * @returns true if engine is in deterministic lock step mode
  53180. */
  53181. isDeterministicLockStep(): boolean;
  53182. /**
  53183. * Gets the max steps when engine is running in deterministic lock step
  53184. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  53185. * @returns the max steps
  53186. */
  53187. getLockstepMaxSteps(): number;
  53188. /**
  53189. * Gets the current hardware scaling level.
  53190. * By default the hardware scaling level is computed from the window device ratio.
  53191. * 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.
  53192. * @returns a number indicating the current hardware scaling level
  53193. */
  53194. getHardwareScalingLevel(): number;
  53195. constructor(options?: NullEngineOptions);
  53196. /**
  53197. * Creates a vertex buffer
  53198. * @param vertices the data for the vertex buffer
  53199. * @returns the new WebGL static buffer
  53200. */
  53201. createVertexBuffer(vertices: FloatArray): DataBuffer;
  53202. /**
  53203. * Creates a new index buffer
  53204. * @param indices defines the content of the index buffer
  53205. * @param updatable defines if the index buffer must be updatable
  53206. * @returns a new webGL buffer
  53207. */
  53208. createIndexBuffer(indices: IndicesArray): DataBuffer;
  53209. /**
  53210. * Clear the current render buffer or the current render target (if any is set up)
  53211. * @param color defines the color to use
  53212. * @param backBuffer defines if the back buffer must be cleared
  53213. * @param depth defines if the depth buffer must be cleared
  53214. * @param stencil defines if the stencil buffer must be cleared
  53215. */
  53216. clear(color: IColor4Like, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  53217. /**
  53218. * Gets the current render width
  53219. * @param useScreen defines if screen size must be used (or the current render target if any)
  53220. * @returns a number defining the current render width
  53221. */
  53222. getRenderWidth(useScreen?: boolean): number;
  53223. /**
  53224. * Gets the current render height
  53225. * @param useScreen defines if screen size must be used (or the current render target if any)
  53226. * @returns a number defining the current render height
  53227. */
  53228. getRenderHeight(useScreen?: boolean): number;
  53229. /**
  53230. * Set the WebGL's viewport
  53231. * @param viewport defines the viewport element to be used
  53232. * @param requiredWidth defines the width required for rendering. If not provided the rendering canvas' width is used
  53233. * @param requiredHeight defines the height required for rendering. If not provided the rendering canvas' height is used
  53234. */
  53235. setViewport(viewport: IViewportLike, requiredWidth?: number, requiredHeight?: number): void;
  53236. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: string, context?: WebGLRenderingContext): WebGLProgram;
  53237. /**
  53238. * Gets the list of webGL uniform locations associated with a specific program based on a list of uniform names
  53239. * @param pipelineContext defines the pipeline context to use
  53240. * @param uniformsNames defines the list of uniform names
  53241. * @returns an array of webGL uniform locations
  53242. */
  53243. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): Nullable<WebGLUniformLocation>[];
  53244. /**
  53245. * Gets the lsit of active attributes for a given webGL program
  53246. * @param pipelineContext defines the pipeline context to use
  53247. * @param attributesNames defines the list of attribute names to get
  53248. * @returns an array of indices indicating the offset of each attribute
  53249. */
  53250. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  53251. /**
  53252. * Binds an effect to the webGL context
  53253. * @param effect defines the effect to bind
  53254. */
  53255. bindSamplers(effect: Effect): void;
  53256. /**
  53257. * Activates an effect, mkaing it the current one (ie. the one used for rendering)
  53258. * @param effect defines the effect to activate
  53259. */
  53260. enableEffect(effect: Effect): void;
  53261. /**
  53262. * Set various states to the webGL context
  53263. * @param culling defines backface culling state
  53264. * @param zOffset defines the value to apply to zOffset (0 by default)
  53265. * @param force defines if states must be applied even if cache is up to date
  53266. * @param reverseSide defines if culling must be reversed (CCW instead of CW and CW instead of CCW)
  53267. */
  53268. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  53269. /**
  53270. * Set the value of an uniform to an array of int32
  53271. * @param uniform defines the webGL uniform location where to store the value
  53272. * @param array defines the array of int32 to store
  53273. */
  53274. setIntArray(uniform: WebGLUniformLocation, array: Int32Array): void;
  53275. /**
  53276. * Set the value of an uniform to an array of int32 (stored as vec2)
  53277. * @param uniform defines the webGL uniform location where to store the value
  53278. * @param array defines the array of int32 to store
  53279. */
  53280. setIntArray2(uniform: WebGLUniformLocation, array: Int32Array): void;
  53281. /**
  53282. * Set the value of an uniform to an array of int32 (stored as vec3)
  53283. * @param uniform defines the webGL uniform location where to store the value
  53284. * @param array defines the array of int32 to store
  53285. */
  53286. setIntArray3(uniform: WebGLUniformLocation, array: Int32Array): void;
  53287. /**
  53288. * Set the value of an uniform to an array of int32 (stored as vec4)
  53289. * @param uniform defines the webGL uniform location where to store the value
  53290. * @param array defines the array of int32 to store
  53291. */
  53292. setIntArray4(uniform: WebGLUniformLocation, array: Int32Array): void;
  53293. /**
  53294. * Set the value of an uniform to an array of float32
  53295. * @param uniform defines the webGL uniform location where to store the value
  53296. * @param array defines the array of float32 to store
  53297. */
  53298. setFloatArray(uniform: WebGLUniformLocation, array: Float32Array): void;
  53299. /**
  53300. * Set the value of an uniform to an array of float32 (stored as vec2)
  53301. * @param uniform defines the webGL uniform location where to store the value
  53302. * @param array defines the array of float32 to store
  53303. */
  53304. setFloatArray2(uniform: WebGLUniformLocation, array: Float32Array): void;
  53305. /**
  53306. * Set the value of an uniform to an array of float32 (stored as vec3)
  53307. * @param uniform defines the webGL uniform location where to store the value
  53308. * @param array defines the array of float32 to store
  53309. */
  53310. setFloatArray3(uniform: WebGLUniformLocation, array: Float32Array): void;
  53311. /**
  53312. * Set the value of an uniform to an array of float32 (stored as vec4)
  53313. * @param uniform defines the webGL uniform location where to store the value
  53314. * @param array defines the array of float32 to store
  53315. */
  53316. setFloatArray4(uniform: WebGLUniformLocation, array: Float32Array): void;
  53317. /**
  53318. * Set the value of an uniform to an array of number
  53319. * @param uniform defines the webGL uniform location where to store the value
  53320. * @param array defines the array of number to store
  53321. */
  53322. setArray(uniform: WebGLUniformLocation, array: number[]): void;
  53323. /**
  53324. * Set the value of an uniform to an array of number (stored as vec2)
  53325. * @param uniform defines the webGL uniform location where to store the value
  53326. * @param array defines the array of number to store
  53327. */
  53328. setArray2(uniform: WebGLUniformLocation, array: number[]): void;
  53329. /**
  53330. * Set the value of an uniform to an array of number (stored as vec3)
  53331. * @param uniform defines the webGL uniform location where to store the value
  53332. * @param array defines the array of number to store
  53333. */
  53334. setArray3(uniform: WebGLUniformLocation, array: number[]): void;
  53335. /**
  53336. * Set the value of an uniform to an array of number (stored as vec4)
  53337. * @param uniform defines the webGL uniform location where to store the value
  53338. * @param array defines the array of number to store
  53339. */
  53340. setArray4(uniform: WebGLUniformLocation, array: number[]): void;
  53341. /**
  53342. * Set the value of an uniform to an array of float32 (stored as matrices)
  53343. * @param uniform defines the webGL uniform location where to store the value
  53344. * @param matrices defines the array of float32 to store
  53345. */
  53346. setMatrices(uniform: WebGLUniformLocation, matrices: Float32Array): void;
  53347. /**
  53348. * Set the value of an uniform to a matrix (3x3)
  53349. * @param uniform defines the webGL uniform location where to store the value
  53350. * @param matrix defines the Float32Array representing the 3x3 matrix to store
  53351. */
  53352. setMatrix3x3(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  53353. /**
  53354. * Set the value of an uniform to a matrix (2x2)
  53355. * @param uniform defines the webGL uniform location where to store the value
  53356. * @param matrix defines the Float32Array representing the 2x2 matrix to store
  53357. */
  53358. setMatrix2x2(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  53359. /**
  53360. * Set the value of an uniform to a number (float)
  53361. * @param uniform defines the webGL uniform location where to store the value
  53362. * @param value defines the float number to store
  53363. */
  53364. setFloat(uniform: WebGLUniformLocation, value: number): void;
  53365. /**
  53366. * Set the value of an uniform to a vec2
  53367. * @param uniform defines the webGL uniform location where to store the value
  53368. * @param x defines the 1st component of the value
  53369. * @param y defines the 2nd component of the value
  53370. */
  53371. setFloat2(uniform: WebGLUniformLocation, x: number, y: number): void;
  53372. /**
  53373. * Set the value of an uniform to a vec3
  53374. * @param uniform defines the webGL uniform location where to store the value
  53375. * @param x defines the 1st component of the value
  53376. * @param y defines the 2nd component of the value
  53377. * @param z defines the 3rd component of the value
  53378. */
  53379. setFloat3(uniform: WebGLUniformLocation, x: number, y: number, z: number): void;
  53380. /**
  53381. * Set the value of an uniform to a boolean
  53382. * @param uniform defines the webGL uniform location where to store the value
  53383. * @param bool defines the boolean to store
  53384. */
  53385. setBool(uniform: WebGLUniformLocation, bool: number): void;
  53386. /**
  53387. * Set the value of an uniform to a vec4
  53388. * @param uniform defines the webGL uniform location where to store the value
  53389. * @param x defines the 1st component of the value
  53390. * @param y defines the 2nd component of the value
  53391. * @param z defines the 3rd component of the value
  53392. * @param w defines the 4th component of the value
  53393. */
  53394. setFloat4(uniform: WebGLUniformLocation, x: number, y: number, z: number, w: number): void;
  53395. /**
  53396. * Sets the current alpha mode
  53397. * @param mode defines the mode to use (one of the Engine.ALPHA_XXX)
  53398. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  53399. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  53400. */
  53401. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  53402. /**
  53403. * Bind webGl buffers directly to the webGL context
  53404. * @param vertexBuffers defines the vertex buffer to bind
  53405. * @param indexBuffer defines the index buffer to bind
  53406. * @param vertexDeclaration defines the vertex declaration to use with the vertex buffer
  53407. * @param vertexStrideSize defines the vertex stride of the vertex buffer
  53408. * @param effect defines the effect associated with the vertex buffer
  53409. */
  53410. bindBuffers(vertexBuffers: {
  53411. [key: string]: VertexBuffer;
  53412. }, indexBuffer: DataBuffer, effect: Effect): void;
  53413. /**
  53414. * Force the entire cache to be cleared
  53415. * You should not have to use this function unless your engine needs to share the webGL context with another engine
  53416. * @param bruteForce defines a boolean to force clearing ALL caches (including stencil, detoh and alpha states)
  53417. */
  53418. wipeCaches(bruteForce?: boolean): void;
  53419. /**
  53420. * Send a draw order
  53421. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  53422. * @param indexStart defines the starting index
  53423. * @param indexCount defines the number of index to draw
  53424. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  53425. */
  53426. draw(useTriangles: boolean, indexStart: number, indexCount: number, instancesCount?: number): void;
  53427. /**
  53428. * Draw a list of indexed primitives
  53429. * @param fillMode defines the primitive to use
  53430. * @param indexStart defines the starting index
  53431. * @param indexCount defines the number of index to draw
  53432. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  53433. */
  53434. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  53435. /**
  53436. * Draw a list of unindexed primitives
  53437. * @param fillMode defines the primitive to use
  53438. * @param verticesStart defines the index of first vertex to draw
  53439. * @param verticesCount defines the count of vertices to draw
  53440. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  53441. */
  53442. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  53443. /** @hidden */
  53444. _createTexture(): WebGLTexture;
  53445. /** @hidden */
  53446. _releaseTexture(texture: InternalTexture): void;
  53447. /**
  53448. * Usually called from Texture.ts.
  53449. * Passed information to create a WebGLTexture
  53450. * @param urlArg defines a value which contains one of the following:
  53451. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  53452. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  53453. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  53454. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  53455. * @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)
  53456. * @param scene needed for loading to the correct scene
  53457. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  53458. * @param onLoad optional callback to be called upon successful completion
  53459. * @param onError optional callback to be called upon failure
  53460. * @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
  53461. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  53462. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  53463. * @param forcedExtension defines the extension to use to pick the right loader
  53464. * @param mimeType defines an optional mime type
  53465. * @returns a InternalTexture for assignment back into BABYLON.Texture
  53466. */
  53467. 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;
  53468. /**
  53469. * Creates a new render target texture
  53470. * @param size defines the size of the texture
  53471. * @param options defines the options used to create the texture
  53472. * @returns a new render target texture stored in an InternalTexture
  53473. */
  53474. createRenderTargetTexture(size: any, options: boolean | RenderTargetCreationOptions): InternalTexture;
  53475. /**
  53476. * Update the sampling mode of a given texture
  53477. * @param samplingMode defines the required sampling mode
  53478. * @param texture defines the texture to update
  53479. */
  53480. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  53481. /**
  53482. * Binds the frame buffer to the specified texture.
  53483. * @param texture The texture to render to or null for the default canvas
  53484. * @param faceIndex The face of the texture to render to in case of cube texture
  53485. * @param requiredWidth The width of the target to render to
  53486. * @param requiredHeight The height of the target to render to
  53487. * @param forceFullscreenViewport Forces the viewport to be the entire texture/screen if true
  53488. * @param lodLevel defines le lod level to bind to the frame buffer
  53489. */
  53490. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean): void;
  53491. /**
  53492. * Unbind the current render target texture from the webGL context
  53493. * @param texture defines the render target texture to unbind
  53494. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  53495. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  53496. */
  53497. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  53498. /**
  53499. * Creates a dynamic vertex buffer
  53500. * @param vertices the data for the dynamic vertex buffer
  53501. * @returns the new WebGL dynamic buffer
  53502. */
  53503. createDynamicVertexBuffer(vertices: FloatArray): DataBuffer;
  53504. /**
  53505. * Update the content of a dynamic texture
  53506. * @param texture defines the texture to update
  53507. * @param canvas defines the canvas containing the source
  53508. * @param invertY defines if data must be stored with Y axis inverted
  53509. * @param premulAlpha defines if alpha is stored as premultiplied
  53510. * @param format defines the format of the data
  53511. * @param forceBindTexture if the texture should be forced to be bound eg. after a graphics context loss (Default: false)
  53512. */
  53513. updateDynamicTexture(texture: Nullable<InternalTexture>, canvas: HTMLCanvasElement, invertY: boolean, premulAlpha?: boolean, format?: number): void;
  53514. /**
  53515. * Gets a boolean indicating if all created effects are ready
  53516. * @returns true if all effects are ready
  53517. */
  53518. areAllEffectsReady(): boolean;
  53519. /**
  53520. * @hidden
  53521. * Get the current error code of the webGL context
  53522. * @returns the error code
  53523. * @see https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/getError
  53524. */
  53525. getError(): number;
  53526. /** @hidden */
  53527. _getUnpackAlignement(): number;
  53528. /** @hidden */
  53529. _unpackFlipY(value: boolean): void;
  53530. /**
  53531. * Update a dynamic index buffer
  53532. * @param indexBuffer defines the target index buffer
  53533. * @param indices defines the data to update
  53534. * @param offset defines the offset in the target index buffer where update should start
  53535. */
  53536. updateDynamicIndexBuffer(indexBuffer: WebGLBuffer, indices: IndicesArray, offset?: number): void;
  53537. /**
  53538. * Updates a dynamic vertex buffer.
  53539. * @param vertexBuffer the vertex buffer to update
  53540. * @param vertices the data used to update the vertex buffer
  53541. * @param byteOffset the byte offset of the data (optional)
  53542. * @param byteLength the byte length of the data (optional)
  53543. */
  53544. updateDynamicVertexBuffer(vertexBuffer: WebGLBuffer, vertices: FloatArray, byteOffset?: number, byteLength?: number): void;
  53545. /** @hidden */
  53546. _bindTextureDirectly(target: number, texture: InternalTexture): boolean;
  53547. /** @hidden */
  53548. _bindTexture(channel: number, texture: InternalTexture): void;
  53549. protected _deleteBuffer(buffer: WebGLBuffer): void;
  53550. /**
  53551. * 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
  53552. */
  53553. releaseEffects(): void;
  53554. displayLoadingUI(): void;
  53555. hideLoadingUI(): void;
  53556. /** @hidden */
  53557. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  53558. /** @hidden */
  53559. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  53560. /** @hidden */
  53561. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  53562. /** @hidden */
  53563. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement, faceIndex?: number, lod?: number): void;
  53564. }
  53565. }
  53566. declare module "babylonjs/Instrumentation/timeToken" {
  53567. import { Nullable } from "babylonjs/types";
  53568. /**
  53569. * @hidden
  53570. **/
  53571. export class _TimeToken {
  53572. _startTimeQuery: Nullable<WebGLQuery>;
  53573. _endTimeQuery: Nullable<WebGLQuery>;
  53574. _timeElapsedQuery: Nullable<WebGLQuery>;
  53575. _timeElapsedQueryEnded: boolean;
  53576. }
  53577. }
  53578. declare module "babylonjs/Engines/Extensions/engine.occlusionQuery" {
  53579. import { Nullable, int } from "babylonjs/types";
  53580. import { _TimeToken } from "babylonjs/Instrumentation/timeToken";
  53581. /** @hidden */
  53582. export class _OcclusionDataStorage {
  53583. /** @hidden */
  53584. occlusionInternalRetryCounter: number;
  53585. /** @hidden */
  53586. isOcclusionQueryInProgress: boolean;
  53587. /** @hidden */
  53588. isOccluded: boolean;
  53589. /** @hidden */
  53590. occlusionRetryCount: number;
  53591. /** @hidden */
  53592. occlusionType: number;
  53593. /** @hidden */
  53594. occlusionQueryAlgorithmType: number;
  53595. }
  53596. module "babylonjs/Engines/engine" {
  53597. interface Engine {
  53598. /**
  53599. * Create a new webGL query (you must be sure that queries are supported by checking getCaps() function)
  53600. * @return the new query
  53601. */
  53602. createQuery(): WebGLQuery;
  53603. /**
  53604. * Delete and release a webGL query
  53605. * @param query defines the query to delete
  53606. * @return the current engine
  53607. */
  53608. deleteQuery(query: WebGLQuery): Engine;
  53609. /**
  53610. * Check if a given query has resolved and got its value
  53611. * @param query defines the query to check
  53612. * @returns true if the query got its value
  53613. */
  53614. isQueryResultAvailable(query: WebGLQuery): boolean;
  53615. /**
  53616. * Gets the value of a given query
  53617. * @param query defines the query to check
  53618. * @returns the value of the query
  53619. */
  53620. getQueryResult(query: WebGLQuery): number;
  53621. /**
  53622. * Initiates an occlusion query
  53623. * @param algorithmType defines the algorithm to use
  53624. * @param query defines the query to use
  53625. * @returns the current engine
  53626. * @see https://doc.babylonjs.com/features/occlusionquery
  53627. */
  53628. beginOcclusionQuery(algorithmType: number, query: WebGLQuery): Engine;
  53629. /**
  53630. * Ends an occlusion query
  53631. * @see https://doc.babylonjs.com/features/occlusionquery
  53632. * @param algorithmType defines the algorithm to use
  53633. * @returns the current engine
  53634. */
  53635. endOcclusionQuery(algorithmType: number): Engine;
  53636. /**
  53637. * Starts a time query (used to measure time spent by the GPU on a specific frame)
  53638. * Please note that only one query can be issued at a time
  53639. * @returns a time token used to track the time span
  53640. */
  53641. startTimeQuery(): Nullable<_TimeToken>;
  53642. /**
  53643. * Ends a time query
  53644. * @param token defines the token used to measure the time span
  53645. * @returns the time spent (in ns)
  53646. */
  53647. endTimeQuery(token: _TimeToken): int;
  53648. /** @hidden */
  53649. _currentNonTimestampToken: Nullable<_TimeToken>;
  53650. /** @hidden */
  53651. _createTimeQuery(): WebGLQuery;
  53652. /** @hidden */
  53653. _deleteTimeQuery(query: WebGLQuery): void;
  53654. /** @hidden */
  53655. _getGlAlgorithmType(algorithmType: number): number;
  53656. /** @hidden */
  53657. _getTimeQueryResult(query: WebGLQuery): any;
  53658. /** @hidden */
  53659. _getTimeQueryAvailability(query: WebGLQuery): any;
  53660. }
  53661. }
  53662. module "babylonjs/Meshes/abstractMesh" {
  53663. interface AbstractMesh {
  53664. /**
  53665. * Backing filed
  53666. * @hidden
  53667. */
  53668. __occlusionDataStorage: _OcclusionDataStorage;
  53669. /**
  53670. * Access property
  53671. * @hidden
  53672. */
  53673. _occlusionDataStorage: _OcclusionDataStorage;
  53674. /**
  53675. * 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.
  53676. * The default value is -1 which means don't break the query and wait till the result
  53677. * @see https://doc.babylonjs.com/features/occlusionquery
  53678. */
  53679. occlusionRetryCount: number;
  53680. /**
  53681. * 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:
  53682. * * OCCLUSION_TYPE_NONE (Default Value): this option means no occlusion query whith the Mesh.
  53683. * * OCCLUSION_TYPE_OPTIMISTIC: this option is means use occlusion query and if occlusionRetryCount is reached and the query is broken show the mesh.
  53684. * * 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.
  53685. * @see https://doc.babylonjs.com/features/occlusionquery
  53686. */
  53687. occlusionType: number;
  53688. /**
  53689. * This property determines the type of occlusion query algorithm to run in WebGl, you can use:
  53690. * * AbstractMesh.OCCLUSION_ALGORITHM_TYPE_ACCURATE which is mapped to GL_ANY_SAMPLES_PASSED.
  53691. * * 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.
  53692. * @see https://doc.babylonjs.com/features/occlusionquery
  53693. */
  53694. occlusionQueryAlgorithmType: number;
  53695. /**
  53696. * 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
  53697. * @see https://doc.babylonjs.com/features/occlusionquery
  53698. */
  53699. isOccluded: boolean;
  53700. /**
  53701. * Flag to check the progress status of the query
  53702. * @see https://doc.babylonjs.com/features/occlusionquery
  53703. */
  53704. isOcclusionQueryInProgress: boolean;
  53705. }
  53706. }
  53707. }
  53708. declare module "babylonjs/Engines/Extensions/engine.transformFeedback" {
  53709. import { Nullable } from "babylonjs/types";
  53710. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  53711. /** @hidden */
  53712. export var _forceTransformFeedbackToBundle: boolean;
  53713. module "babylonjs/Engines/engine" {
  53714. interface Engine {
  53715. /**
  53716. * Creates a webGL transform feedback object
  53717. * Please makes sure to check webGLVersion property to check if you are running webGL 2+
  53718. * @returns the webGL transform feedback object
  53719. */
  53720. createTransformFeedback(): WebGLTransformFeedback;
  53721. /**
  53722. * Delete a webGL transform feedback object
  53723. * @param value defines the webGL transform feedback object to delete
  53724. */
  53725. deleteTransformFeedback(value: WebGLTransformFeedback): void;
  53726. /**
  53727. * Bind a webGL transform feedback object to the webgl context
  53728. * @param value defines the webGL transform feedback object to bind
  53729. */
  53730. bindTransformFeedback(value: Nullable<WebGLTransformFeedback>): void;
  53731. /**
  53732. * Begins a transform feedback operation
  53733. * @param usePoints defines if points or triangles must be used
  53734. */
  53735. beginTransformFeedback(usePoints: boolean): void;
  53736. /**
  53737. * Ends a transform feedback operation
  53738. */
  53739. endTransformFeedback(): void;
  53740. /**
  53741. * Specify the varyings to use with transform feedback
  53742. * @param program defines the associated webGL program
  53743. * @param value defines the list of strings representing the varying names
  53744. */
  53745. setTranformFeedbackVaryings(program: WebGLProgram, value: string[]): void;
  53746. /**
  53747. * Bind a webGL buffer for a transform feedback operation
  53748. * @param value defines the webGL buffer to bind
  53749. */
  53750. bindTransformFeedbackBuffer(value: Nullable<DataBuffer>): void;
  53751. }
  53752. }
  53753. }
  53754. declare module "babylonjs/Engines/Extensions/engine.views" {
  53755. import { Camera } from "babylonjs/Cameras/camera";
  53756. import { Nullable } from "babylonjs/types";
  53757. /**
  53758. * Class used to define an additional view for the engine
  53759. * @see https://doc.babylonjs.com/how_to/multi_canvases
  53760. */
  53761. export class EngineView {
  53762. /** Defines the canvas where to render the view */
  53763. target: HTMLCanvasElement;
  53764. /** Defines an optional camera used to render the view (will use active camera else) */
  53765. camera?: Camera;
  53766. }
  53767. module "babylonjs/Engines/engine" {
  53768. interface Engine {
  53769. /**
  53770. * Gets or sets the HTML element to use for attaching events
  53771. */
  53772. inputElement: Nullable<HTMLElement>;
  53773. /**
  53774. * Gets the current engine view
  53775. * @see https://doc.babylonjs.com/how_to/multi_canvases
  53776. */
  53777. activeView: Nullable<EngineView>;
  53778. /** Gets or sets the list of views */
  53779. views: EngineView[];
  53780. /**
  53781. * Register a new child canvas
  53782. * @param canvas defines the canvas to register
  53783. * @param camera defines an optional camera to use with this canvas (it will overwrite the scene.camera for this view)
  53784. * @returns the associated view
  53785. */
  53786. registerView(canvas: HTMLCanvasElement, camera?: Camera): EngineView;
  53787. /**
  53788. * Remove a registered child canvas
  53789. * @param canvas defines the canvas to remove
  53790. * @returns the current engine
  53791. */
  53792. unRegisterView(canvas: HTMLCanvasElement): Engine;
  53793. }
  53794. }
  53795. }
  53796. declare module "babylonjs/Engines/Extensions/engine.textureSelector" {
  53797. import { Nullable } from "babylonjs/types";
  53798. module "babylonjs/Engines/engine" {
  53799. interface Engine {
  53800. /** @hidden */
  53801. _excludedCompressedTextures: string[];
  53802. /** @hidden */
  53803. _textureFormatInUse: string;
  53804. /**
  53805. * Gets the list of texture formats supported
  53806. */
  53807. readonly texturesSupported: Array<string>;
  53808. /**
  53809. * Gets the texture format in use
  53810. */
  53811. readonly textureFormatInUse: Nullable<string>;
  53812. /**
  53813. * Set the compressed texture extensions or file names to skip.
  53814. *
  53815. * @param skippedFiles defines the list of those texture files you want to skip
  53816. * Example: [".dds", ".env", "myfile.png"]
  53817. */
  53818. setCompressedTextureExclusions(skippedFiles: Array<string>): void;
  53819. /**
  53820. * Set the compressed texture format to use, based on the formats you have, and the formats
  53821. * supported by the hardware / browser.
  53822. *
  53823. * Khronos Texture Container (.ktx) files are used to support this. This format has the
  53824. * advantage of being specifically designed for OpenGL. Header elements directly correspond
  53825. * to API arguments needed to compressed textures. This puts the burden on the container
  53826. * generator to house the arcane code for determining these for current & future formats.
  53827. *
  53828. * for description see https://www.khronos.org/opengles/sdk/tools/KTX/
  53829. * for file layout see https://www.khronos.org/opengles/sdk/tools/KTX/file_format_spec/
  53830. *
  53831. * Note: The result of this call is not taken into account when a texture is base64.
  53832. *
  53833. * @param formatsAvailable defines the list of those format families you have created
  53834. * on your server. Syntax: '-' + format family + '.ktx'. (Case and order do not matter.)
  53835. *
  53836. * Current families are astc, dxt, pvrtc, etc2, & etc1.
  53837. * @returns The extension selected.
  53838. */
  53839. setTextureFormatToUse(formatsAvailable: Array<string>): Nullable<string>;
  53840. }
  53841. }
  53842. }
  53843. declare module "babylonjs/Engines/Extensions/index" {
  53844. export * from "babylonjs/Engines/Extensions/engine.alpha";
  53845. export * from "babylonjs/Engines/Extensions/engine.occlusionQuery";
  53846. export * from "babylonjs/Engines/Extensions/engine.transformFeedback";
  53847. export * from "babylonjs/Engines/Extensions/engine.multiview";
  53848. export * from "babylonjs/Engines/Extensions/engine.rawTexture";
  53849. export * from "babylonjs/Engines/Extensions/engine.dynamicTexture";
  53850. export * from "babylonjs/Engines/Extensions/engine.videoTexture";
  53851. export * from "babylonjs/Engines/Extensions/engine.multiRender";
  53852. export * from "babylonjs/Engines/Extensions/engine.cubeTexture";
  53853. export * from "babylonjs/Engines/Extensions/engine.renderTarget";
  53854. export * from "babylonjs/Engines/Extensions/engine.renderTargetCube";
  53855. export * from "babylonjs/Engines/Extensions/engine.webVR";
  53856. export * from "babylonjs/Engines/Extensions/engine.uniformBuffer";
  53857. export * from "babylonjs/Engines/Extensions/engine.views";
  53858. export * from "babylonjs/Engines/Extensions/engine.readTexture";
  53859. import "babylonjs/Engines/Extensions/engine.textureSelector";
  53860. export * from "babylonjs/Engines/Extensions/engine.textureSelector";
  53861. }
  53862. declare module "babylonjs/Misc/HighDynamicRange/panoramaToCubemap" {
  53863. import { Nullable } from "babylonjs/types";
  53864. /**
  53865. * CubeMap information grouping all the data for each faces as well as the cubemap size.
  53866. */
  53867. export interface CubeMapInfo {
  53868. /**
  53869. * The pixel array for the front face.
  53870. * This is stored in format, left to right, up to down format.
  53871. */
  53872. front: Nullable<ArrayBufferView>;
  53873. /**
  53874. * The pixel array for the back face.
  53875. * This is stored in format, left to right, up to down format.
  53876. */
  53877. back: Nullable<ArrayBufferView>;
  53878. /**
  53879. * The pixel array for the left face.
  53880. * This is stored in format, left to right, up to down format.
  53881. */
  53882. left: Nullable<ArrayBufferView>;
  53883. /**
  53884. * The pixel array for the right face.
  53885. * This is stored in format, left to right, up to down format.
  53886. */
  53887. right: Nullable<ArrayBufferView>;
  53888. /**
  53889. * The pixel array for the up face.
  53890. * This is stored in format, left to right, up to down format.
  53891. */
  53892. up: Nullable<ArrayBufferView>;
  53893. /**
  53894. * The pixel array for the down face.
  53895. * This is stored in format, left to right, up to down format.
  53896. */
  53897. down: Nullable<ArrayBufferView>;
  53898. /**
  53899. * The size of the cubemap stored.
  53900. *
  53901. * Each faces will be size * size pixels.
  53902. */
  53903. size: number;
  53904. /**
  53905. * The format of the texture.
  53906. *
  53907. * RGBA, RGB.
  53908. */
  53909. format: number;
  53910. /**
  53911. * The type of the texture data.
  53912. *
  53913. * UNSIGNED_INT, FLOAT.
  53914. */
  53915. type: number;
  53916. /**
  53917. * Specifies whether the texture is in gamma space.
  53918. */
  53919. gammaSpace: boolean;
  53920. }
  53921. /**
  53922. * Helper class useful to convert panorama picture to their cubemap representation in 6 faces.
  53923. */
  53924. export class PanoramaToCubeMapTools {
  53925. private static FACE_LEFT;
  53926. private static FACE_RIGHT;
  53927. private static FACE_FRONT;
  53928. private static FACE_BACK;
  53929. private static FACE_DOWN;
  53930. private static FACE_UP;
  53931. /**
  53932. * Converts a panorma stored in RGB right to left up to down format into a cubemap (6 faces).
  53933. *
  53934. * @param float32Array The source data.
  53935. * @param inputWidth The width of the input panorama.
  53936. * @param inputHeight The height of the input panorama.
  53937. * @param size The willing size of the generated cubemap (each faces will be size * size pixels)
  53938. * @return The cubemap data
  53939. */
  53940. static ConvertPanoramaToCubemap(float32Array: Float32Array, inputWidth: number, inputHeight: number, size: number): CubeMapInfo;
  53941. private static CreateCubemapTexture;
  53942. private static CalcProjectionSpherical;
  53943. }
  53944. }
  53945. declare module "babylonjs/Misc/HighDynamicRange/cubemapToSphericalPolynomial" {
  53946. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  53947. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  53948. import { Nullable } from "babylonjs/types";
  53949. import { CubeMapInfo } from "babylonjs/Misc/HighDynamicRange/panoramaToCubemap";
  53950. /**
  53951. * Helper class dealing with the extraction of spherical polynomial dataArray
  53952. * from a cube map.
  53953. */
  53954. export class CubeMapToSphericalPolynomialTools {
  53955. private static FileFaces;
  53956. /**
  53957. * Converts a texture to the according Spherical Polynomial data.
  53958. * This extracts the first 3 orders only as they are the only one used in the lighting.
  53959. *
  53960. * @param texture The texture to extract the information from.
  53961. * @return The Spherical Polynomial data.
  53962. */
  53963. static ConvertCubeMapTextureToSphericalPolynomial(texture: BaseTexture): Nullable<SphericalPolynomial>;
  53964. /**
  53965. * Converts a cubemap to the according Spherical Polynomial data.
  53966. * This extracts the first 3 orders only as they are the only one used in the lighting.
  53967. *
  53968. * @param cubeInfo The Cube map to extract the information from.
  53969. * @return The Spherical Polynomial data.
  53970. */
  53971. static ConvertCubeMapToSphericalPolynomial(cubeInfo: CubeMapInfo): SphericalPolynomial;
  53972. }
  53973. }
  53974. declare module "babylonjs/Materials/Textures/baseTexture.polynomial" {
  53975. import { Nullable } from "babylonjs/types";
  53976. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  53977. module "babylonjs/Materials/Textures/baseTexture" {
  53978. interface BaseTexture {
  53979. /**
  53980. * Get the polynomial representation of the texture data.
  53981. * This is mainly use as a fast way to recover IBL Diffuse irradiance data.
  53982. * @see https://learnopengl.com/PBR/IBL/Diffuse-irradiance
  53983. */
  53984. sphericalPolynomial: Nullable<SphericalPolynomial>;
  53985. }
  53986. }
  53987. }
  53988. declare module "babylonjs/Shaders/rgbdEncode.fragment" {
  53989. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  53990. /** @hidden */
  53991. export var rgbdEncodePixelShader: {
  53992. name: string;
  53993. shader: string;
  53994. };
  53995. }
  53996. declare module "babylonjs/Shaders/rgbdDecode.fragment" {
  53997. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  53998. /** @hidden */
  53999. export var rgbdDecodePixelShader: {
  54000. name: string;
  54001. shader: string;
  54002. };
  54003. }
  54004. declare module "babylonjs/Misc/environmentTextureTools" {
  54005. import { Nullable } from "babylonjs/types";
  54006. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  54007. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  54008. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  54009. import "babylonjs/Engines/Extensions/engine.renderTargetCube";
  54010. import "babylonjs/Engines/Extensions/engine.readTexture";
  54011. import "babylonjs/Materials/Textures/baseTexture.polynomial";
  54012. import "babylonjs/Shaders/rgbdEncode.fragment";
  54013. import "babylonjs/Shaders/rgbdDecode.fragment";
  54014. /**
  54015. * Raw texture data and descriptor sufficient for WebGL texture upload
  54016. */
  54017. export interface EnvironmentTextureInfo {
  54018. /**
  54019. * Version of the environment map
  54020. */
  54021. version: number;
  54022. /**
  54023. * Width of image
  54024. */
  54025. width: number;
  54026. /**
  54027. * Irradiance information stored in the file.
  54028. */
  54029. irradiance: any;
  54030. /**
  54031. * Specular information stored in the file.
  54032. */
  54033. specular: any;
  54034. }
  54035. /**
  54036. * Defines One Image in the file. It requires only the position in the file
  54037. * as well as the length.
  54038. */
  54039. interface BufferImageData {
  54040. /**
  54041. * Length of the image data.
  54042. */
  54043. length: number;
  54044. /**
  54045. * Position of the data from the null terminator delimiting the end of the JSON.
  54046. */
  54047. position: number;
  54048. }
  54049. /**
  54050. * Defines the specular data enclosed in the file.
  54051. * This corresponds to the version 1 of the data.
  54052. */
  54053. export interface EnvironmentTextureSpecularInfoV1 {
  54054. /**
  54055. * Defines where the specular Payload is located. It is a runtime value only not stored in the file.
  54056. */
  54057. specularDataPosition?: number;
  54058. /**
  54059. * This contains all the images data needed to reconstruct the cubemap.
  54060. */
  54061. mipmaps: Array<BufferImageData>;
  54062. /**
  54063. * Defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness.
  54064. */
  54065. lodGenerationScale: number;
  54066. }
  54067. /**
  54068. * Sets of helpers addressing the serialization and deserialization of environment texture
  54069. * stored in a BabylonJS env file.
  54070. * Those files are usually stored as .env files.
  54071. */
  54072. export class EnvironmentTextureTools {
  54073. /**
  54074. * Magic number identifying the env file.
  54075. */
  54076. private static _MagicBytes;
  54077. /**
  54078. * Gets the environment info from an env file.
  54079. * @param data The array buffer containing the .env bytes.
  54080. * @returns the environment file info (the json header) if successfully parsed.
  54081. */
  54082. static GetEnvInfo(data: ArrayBufferView): Nullable<EnvironmentTextureInfo>;
  54083. /**
  54084. * Creates an environment texture from a loaded cube texture.
  54085. * @param texture defines the cube texture to convert in env file
  54086. * @return a promise containing the environment data if succesfull.
  54087. */
  54088. static CreateEnvTextureAsync(texture: BaseTexture): Promise<ArrayBuffer>;
  54089. /**
  54090. * Creates a JSON representation of the spherical data.
  54091. * @param texture defines the texture containing the polynomials
  54092. * @return the JSON representation of the spherical info
  54093. */
  54094. private static _CreateEnvTextureIrradiance;
  54095. /**
  54096. * Creates the ArrayBufferViews used for initializing environment texture image data.
  54097. * @param data the image data
  54098. * @param info parameters that determine what views will be created for accessing the underlying buffer
  54099. * @return the views described by info providing access to the underlying buffer
  54100. */
  54101. static CreateImageDataArrayBufferViews(data: ArrayBufferView, info: EnvironmentTextureInfo): Array<Array<ArrayBufferView>>;
  54102. /**
  54103. * Uploads the texture info contained in the env file to the GPU.
  54104. * @param texture defines the internal texture to upload to
  54105. * @param data defines the data to load
  54106. * @param info defines the texture info retrieved through the GetEnvInfo method
  54107. * @returns a promise
  54108. */
  54109. static UploadEnvLevelsAsync(texture: InternalTexture, data: ArrayBufferView, info: EnvironmentTextureInfo): Promise<void>;
  54110. private static _OnImageReadyAsync;
  54111. /**
  54112. * Uploads the levels of image data to the GPU.
  54113. * @param texture defines the internal texture to upload to
  54114. * @param imageData defines the array buffer views of image data [mipmap][face]
  54115. * @returns a promise
  54116. */
  54117. static UploadLevelsAsync(texture: InternalTexture, imageData: ArrayBufferView[][]): Promise<void>;
  54118. /**
  54119. * Uploads spherical polynomials information to the texture.
  54120. * @param texture defines the texture we are trying to upload the information to
  54121. * @param info defines the environment texture info retrieved through the GetEnvInfo method
  54122. */
  54123. static UploadEnvSpherical(texture: InternalTexture, info: EnvironmentTextureInfo): void;
  54124. /** @hidden */
  54125. static _UpdateRGBDAsync(internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number): Promise<void>;
  54126. }
  54127. }
  54128. declare module "babylonjs/Engines/Processors/shaderCodeInliner" {
  54129. /**
  54130. * Class used to inline functions in shader code
  54131. */
  54132. export class ShaderCodeInliner {
  54133. private static readonly _RegexpFindFunctionNameAndType;
  54134. private _sourceCode;
  54135. private _functionDescr;
  54136. private _numMaxIterations;
  54137. /** Gets or sets the token used to mark the functions to inline */
  54138. inlineToken: string;
  54139. /** Gets or sets the debug mode */
  54140. debug: boolean;
  54141. /** Gets the code after the inlining process */
  54142. get code(): string;
  54143. /**
  54144. * Initializes the inliner
  54145. * @param sourceCode shader code source to inline
  54146. * @param numMaxIterations maximum number of iterations (used to detect recursive calls)
  54147. */
  54148. constructor(sourceCode: string, numMaxIterations?: number);
  54149. /**
  54150. * Start the processing of the shader code
  54151. */
  54152. processCode(): void;
  54153. private _collectFunctions;
  54154. private _processInlining;
  54155. private _extractBetweenMarkers;
  54156. private _skipWhitespaces;
  54157. private _removeComments;
  54158. private _replaceFunctionCallsByCode;
  54159. private _findBackward;
  54160. private _escapeRegExp;
  54161. private _replaceNames;
  54162. }
  54163. }
  54164. declare module "babylonjs/Engines/nativeEngine" {
  54165. import { Nullable, IndicesArray, DataArray } from "babylonjs/types";
  54166. import { Engine } from "babylonjs/Engines/engine";
  54167. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  54168. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  54169. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  54170. import { Effect } from "babylonjs/Materials/effect";
  54171. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  54172. import { Matrix, Viewport, Color3 } from "babylonjs/Maths/math";
  54173. import { IColor4Like } from "babylonjs/Maths/math.like";
  54174. import { Scene } from "babylonjs/scene";
  54175. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  54176. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  54177. import { ISceneLike } from "babylonjs/Engines/thinEngine";
  54178. /**
  54179. * Container for accessors for natively-stored mesh data buffers.
  54180. */
  54181. class NativeDataBuffer extends DataBuffer {
  54182. /**
  54183. * Accessor value used to identify/retrieve a natively-stored index buffer.
  54184. */
  54185. nativeIndexBuffer?: any;
  54186. /**
  54187. * Accessor value used to identify/retrieve a natively-stored vertex buffer.
  54188. */
  54189. nativeVertexBuffer?: any;
  54190. }
  54191. /** @hidden */
  54192. class NativeTexture extends InternalTexture {
  54193. getInternalTexture(): InternalTexture;
  54194. getViewCount(): number;
  54195. }
  54196. /** @hidden */
  54197. export class NativeEngine extends Engine {
  54198. private readonly _native;
  54199. /** Defines the invalid handle returned by bgfx when resource creation goes wrong */
  54200. private readonly INVALID_HANDLE;
  54201. getHardwareScalingLevel(): number;
  54202. constructor();
  54203. dispose(): void;
  54204. /**
  54205. * Can be used to override the current requestAnimationFrame requester.
  54206. * @hidden
  54207. */
  54208. protected _queueNewFrame(bindedRenderFunction: any, requester?: any): number;
  54209. /**
  54210. * Override default engine behavior.
  54211. * @param color
  54212. * @param backBuffer
  54213. * @param depth
  54214. * @param stencil
  54215. */
  54216. _bindUnboundFramebuffer(framebuffer: Nullable<WebGLFramebuffer>): void;
  54217. /**
  54218. * Gets host document
  54219. * @returns the host document object
  54220. */
  54221. getHostDocument(): Nullable<Document>;
  54222. clear(color: Nullable<IColor4Like>, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  54223. createIndexBuffer(indices: IndicesArray, updateable?: boolean): NativeDataBuffer;
  54224. createVertexBuffer(data: DataArray, updateable?: boolean): NativeDataBuffer;
  54225. recordVertexArrayObject(vertexBuffers: {
  54226. [key: string]: VertexBuffer;
  54227. }, indexBuffer: Nullable<NativeDataBuffer>, effect: Effect): WebGLVertexArrayObject;
  54228. bindVertexArrayObject(vertexArray: WebGLVertexArrayObject): void;
  54229. releaseVertexArrayObject(vertexArray: WebGLVertexArrayObject): void;
  54230. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  54231. /**
  54232. * Draw a list of indexed primitives
  54233. * @param fillMode defines the primitive to use
  54234. * @param indexStart defines the starting index
  54235. * @param indexCount defines the number of index to draw
  54236. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  54237. */
  54238. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  54239. /**
  54240. * Draw a list of unindexed primitives
  54241. * @param fillMode defines the primitive to use
  54242. * @param verticesStart defines the index of first vertex to draw
  54243. * @param verticesCount defines the count of vertices to draw
  54244. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  54245. */
  54246. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  54247. createPipelineContext(): IPipelineContext;
  54248. _preparePipelineContext(pipelineContext: IPipelineContext, vertexSourceCode: string, fragmentSourceCode: string, createAsRaw: boolean, rebuildRebind: any, defines: Nullable<string>, transformFeedbackVaryings: Nullable<string[]>): void;
  54249. /** @hidden */
  54250. _isRenderingStateCompiled(pipelineContext: IPipelineContext): boolean;
  54251. /** @hidden */
  54252. _executeWhenRenderingStateIsCompiled(pipelineContext: IPipelineContext, action: () => void): void;
  54253. createRawShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): any;
  54254. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): any;
  54255. protected _setProgram(program: WebGLProgram): void;
  54256. _releaseEffect(effect: Effect): void;
  54257. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  54258. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): WebGLUniformLocation[];
  54259. bindUniformBlock(pipelineContext: IPipelineContext, blockName: string, index: number): void;
  54260. bindSamplers(effect: Effect): void;
  54261. setMatrix(uniform: WebGLUniformLocation, matrix: Matrix): void;
  54262. getRenderWidth(useScreen?: boolean): number;
  54263. getRenderHeight(useScreen?: boolean): number;
  54264. setViewport(viewport: Viewport, requiredWidth?: number, requiredHeight?: number): void;
  54265. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  54266. /**
  54267. * Set the z offset to apply to current rendering
  54268. * @param value defines the offset to apply
  54269. */
  54270. setZOffset(value: number): void;
  54271. /**
  54272. * Gets the current value of the zOffset
  54273. * @returns the current zOffset state
  54274. */
  54275. getZOffset(): number;
  54276. /**
  54277. * Enable or disable depth buffering
  54278. * @param enable defines the state to set
  54279. */
  54280. setDepthBuffer(enable: boolean): void;
  54281. /**
  54282. * Gets a boolean indicating if depth writing is enabled
  54283. * @returns the current depth writing state
  54284. */
  54285. getDepthWrite(): boolean;
  54286. /**
  54287. * Enable or disable depth writing
  54288. * @param enable defines the state to set
  54289. */
  54290. setDepthWrite(enable: boolean): void;
  54291. /**
  54292. * Enable or disable color writing
  54293. * @param enable defines the state to set
  54294. */
  54295. setColorWrite(enable: boolean): void;
  54296. /**
  54297. * Gets a boolean indicating if color writing is enabled
  54298. * @returns the current color writing state
  54299. */
  54300. getColorWrite(): boolean;
  54301. /**
  54302. * Sets alpha constants used by some alpha blending modes
  54303. * @param r defines the red component
  54304. * @param g defines the green component
  54305. * @param b defines the blue component
  54306. * @param a defines the alpha component
  54307. */
  54308. setAlphaConstants(r: number, g: number, b: number, a: number): void;
  54309. /**
  54310. * Sets the current alpha mode
  54311. * @param mode defines the mode to use (one of the BABYLON.Constants.ALPHA_XXX)
  54312. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  54313. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  54314. */
  54315. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  54316. /**
  54317. * Gets the current alpha mode
  54318. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  54319. * @returns the current alpha mode
  54320. */
  54321. getAlphaMode(): number;
  54322. setInt(uniform: WebGLUniformLocation, int: number): void;
  54323. setIntArray(uniform: WebGLUniformLocation, array: Int32Array): void;
  54324. setIntArray2(uniform: WebGLUniformLocation, array: Int32Array): void;
  54325. setIntArray3(uniform: WebGLUniformLocation, array: Int32Array): void;
  54326. setIntArray4(uniform: WebGLUniformLocation, array: Int32Array): void;
  54327. setFloatArray(uniform: WebGLUniformLocation, array: Float32Array): void;
  54328. setFloatArray2(uniform: WebGLUniformLocation, array: Float32Array): void;
  54329. setFloatArray3(uniform: WebGLUniformLocation, array: Float32Array): void;
  54330. setFloatArray4(uniform: WebGLUniformLocation, array: Float32Array): void;
  54331. setArray(uniform: WebGLUniformLocation, array: number[]): void;
  54332. setArray2(uniform: WebGLUniformLocation, array: number[]): void;
  54333. setArray3(uniform: WebGLUniformLocation, array: number[]): void;
  54334. setArray4(uniform: WebGLUniformLocation, array: number[]): void;
  54335. setMatrices(uniform: WebGLUniformLocation, matrices: Float32Array): void;
  54336. setMatrix3x3(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  54337. setMatrix2x2(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  54338. setFloat(uniform: WebGLUniformLocation, value: number): void;
  54339. setFloat2(uniform: WebGLUniformLocation, x: number, y: number): void;
  54340. setFloat3(uniform: WebGLUniformLocation, x: number, y: number, z: number): void;
  54341. setFloat4(uniform: WebGLUniformLocation, x: number, y: number, z: number, w: number): void;
  54342. setColor3(uniform: WebGLUniformLocation, color3: Color3): void;
  54343. setColor4(uniform: WebGLUniformLocation, color3: Color3, alpha: number): void;
  54344. wipeCaches(bruteForce?: boolean): void;
  54345. _createTexture(): WebGLTexture;
  54346. protected _deleteTexture(texture: Nullable<WebGLTexture>): void;
  54347. /**
  54348. * Usually called from Texture.ts.
  54349. * Passed information to create a WebGLTexture
  54350. * @param url defines a value which contains one of the following:
  54351. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  54352. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  54353. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  54354. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  54355. * @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)
  54356. * @param scene needed for loading to the correct scene
  54357. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  54358. * @param onLoad optional callback to be called upon successful completion
  54359. * @param onError optional callback to be called upon failure
  54360. * @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
  54361. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  54362. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  54363. * @param forcedExtension defines the extension to use to pick the right loader
  54364. * @param mimeType defines an optional mime type
  54365. * @returns a InternalTexture for assignment back into BABYLON.Texture
  54366. */
  54367. 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;
  54368. /**
  54369. * Creates a cube texture
  54370. * @param rootUrl defines the url where the files to load is located
  54371. * @param scene defines the current scene
  54372. * @param files defines the list of files to load (1 per face)
  54373. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  54374. * @param onLoad defines an optional callback raised when the texture is loaded
  54375. * @param onError defines an optional callback raised if there is an issue to load the texture
  54376. * @param format defines the format of the data
  54377. * @param forcedExtension defines the extension to use to pick the right loader
  54378. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  54379. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  54380. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  54381. * @param fallback defines texture to use while falling back when (compressed) texture file not found.
  54382. * @returns the cube texture as an InternalTexture
  54383. */
  54384. 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;
  54385. private _getSamplingFilter;
  54386. private static _GetNativeTextureFormat;
  54387. createRenderTargetTexture(size: number | {
  54388. width: number;
  54389. height: number;
  54390. }, options: boolean | RenderTargetCreationOptions): NativeTexture;
  54391. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  54392. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean): void;
  54393. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  54394. createDynamicVertexBuffer(data: DataArray): DataBuffer;
  54395. updateDynamicIndexBuffer(indexBuffer: DataBuffer, indices: IndicesArray, offset?: number): void;
  54396. /**
  54397. * Updates a dynamic vertex buffer.
  54398. * @param vertexBuffer the vertex buffer to update
  54399. * @param data the data used to update the vertex buffer
  54400. * @param byteOffset the byte offset of the data (optional)
  54401. * @param byteLength the byte length of the data (optional)
  54402. */
  54403. updateDynamicVertexBuffer(vertexBuffer: DataBuffer, data: DataArray, byteOffset?: number, byteLength?: number): void;
  54404. protected _setTexture(channel: number, texture: Nullable<BaseTexture>, isPartOfTextureArray?: boolean, depthStencilTexture?: boolean): boolean;
  54405. private _updateAnisotropicLevel;
  54406. private _getAddressMode;
  54407. /** @hidden */
  54408. _bindTexture(channel: number, texture: InternalTexture): void;
  54409. protected _deleteBuffer(buffer: NativeDataBuffer): void;
  54410. releaseEffects(): void;
  54411. /** @hidden */
  54412. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  54413. /** @hidden */
  54414. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  54415. /** @hidden */
  54416. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  54417. /** @hidden */
  54418. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement, faceIndex?: number, lod?: number): void;
  54419. }
  54420. }
  54421. declare module "babylonjs/Engines/index" {
  54422. export * from "babylonjs/Engines/constants";
  54423. export * from "babylonjs/Engines/engineCapabilities";
  54424. export * from "babylonjs/Engines/instancingAttributeInfo";
  54425. export * from "babylonjs/Engines/thinEngine";
  54426. export * from "babylonjs/Engines/engine";
  54427. export * from "babylonjs/Engines/engineStore";
  54428. export * from "babylonjs/Engines/nullEngine";
  54429. export * from "babylonjs/Engines/Extensions/index";
  54430. export * from "babylonjs/Engines/IPipelineContext";
  54431. export * from "babylonjs/Engines/WebGL/webGLPipelineContext";
  54432. export * from "babylonjs/Engines/WebGL/webGL2ShaderProcessors";
  54433. export * from "babylonjs/Engines/nativeEngine";
  54434. export * from "babylonjs/Engines/Processors/shaderCodeInliner";
  54435. export * from "babylonjs/Engines/performanceConfigurator";
  54436. }
  54437. declare module "babylonjs/Events/clipboardEvents" {
  54438. /**
  54439. * Gather the list of clipboard event types as constants.
  54440. */
  54441. export class ClipboardEventTypes {
  54442. /**
  54443. * The clipboard event is fired when a copy command is active (pressed).
  54444. */
  54445. static readonly COPY: number;
  54446. /**
  54447. * The clipboard event is fired when a cut command is active (pressed).
  54448. */
  54449. static readonly CUT: number;
  54450. /**
  54451. * The clipboard event is fired when a paste command is active (pressed).
  54452. */
  54453. static readonly PASTE: number;
  54454. }
  54455. /**
  54456. * This class is used to store clipboard related info for the onClipboardObservable event.
  54457. */
  54458. export class ClipboardInfo {
  54459. /**
  54460. * Defines the type of event (BABYLON.ClipboardEventTypes)
  54461. */
  54462. type: number;
  54463. /**
  54464. * Defines the related dom event
  54465. */
  54466. event: ClipboardEvent;
  54467. /**
  54468. *Creates an instance of ClipboardInfo.
  54469. * @param type Defines the type of event (BABYLON.ClipboardEventTypes)
  54470. * @param event Defines the related dom event
  54471. */
  54472. constructor(
  54473. /**
  54474. * Defines the type of event (BABYLON.ClipboardEventTypes)
  54475. */
  54476. type: number,
  54477. /**
  54478. * Defines the related dom event
  54479. */
  54480. event: ClipboardEvent);
  54481. /**
  54482. * Get the clipboard event's type from the keycode.
  54483. * @param keyCode Defines the keyCode for the current keyboard event.
  54484. * @return {number}
  54485. */
  54486. static GetTypeFromCharacter(keyCode: number): number;
  54487. }
  54488. }
  54489. declare module "babylonjs/Events/index" {
  54490. export * from "babylonjs/Events/keyboardEvents";
  54491. export * from "babylonjs/Events/pointerEvents";
  54492. export * from "babylonjs/Events/clipboardEvents";
  54493. }
  54494. declare module "babylonjs/Gamepads/Controllers/daydreamController" {
  54495. import { Scene } from "babylonjs/scene";
  54496. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  54497. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  54498. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  54499. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  54500. /**
  54501. * Google Daydream controller
  54502. */
  54503. export class DaydreamController extends WebVRController {
  54504. /**
  54505. * Base Url for the controller model.
  54506. */
  54507. static MODEL_BASE_URL: string;
  54508. /**
  54509. * File name for the controller model.
  54510. */
  54511. static MODEL_FILENAME: string;
  54512. /**
  54513. * Gamepad Id prefix used to identify Daydream Controller.
  54514. */
  54515. static readonly GAMEPAD_ID_PREFIX: string;
  54516. /**
  54517. * Creates a new DaydreamController from a gamepad
  54518. * @param vrGamepad the gamepad that the controller should be created from
  54519. */
  54520. constructor(vrGamepad: any);
  54521. /**
  54522. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  54523. * @param scene scene in which to add meshes
  54524. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  54525. */
  54526. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  54527. /**
  54528. * Called once for each button that changed state since the last frame
  54529. * @param buttonIdx Which button index changed
  54530. * @param state New state of the button
  54531. * @param changes Which properties on the state changed since last frame
  54532. */
  54533. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  54534. }
  54535. }
  54536. declare module "babylonjs/Gamepads/Controllers/gearVRController" {
  54537. import { Scene } from "babylonjs/scene";
  54538. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  54539. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  54540. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  54541. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  54542. /**
  54543. * Gear VR Controller
  54544. */
  54545. export class GearVRController extends WebVRController {
  54546. /**
  54547. * Base Url for the controller model.
  54548. */
  54549. static MODEL_BASE_URL: string;
  54550. /**
  54551. * File name for the controller model.
  54552. */
  54553. static MODEL_FILENAME: string;
  54554. /**
  54555. * Gamepad Id prefix used to identify this controller.
  54556. */
  54557. static readonly GAMEPAD_ID_PREFIX: string;
  54558. private readonly _buttonIndexToObservableNameMap;
  54559. /**
  54560. * Creates a new GearVRController from a gamepad
  54561. * @param vrGamepad the gamepad that the controller should be created from
  54562. */
  54563. constructor(vrGamepad: any);
  54564. /**
  54565. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  54566. * @param scene scene in which to add meshes
  54567. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  54568. */
  54569. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  54570. /**
  54571. * Called once for each button that changed state since the last frame
  54572. * @param buttonIdx Which button index changed
  54573. * @param state New state of the button
  54574. * @param changes Which properties on the state changed since last frame
  54575. */
  54576. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  54577. }
  54578. }
  54579. declare module "babylonjs/Gamepads/Controllers/genericController" {
  54580. import { Scene } from "babylonjs/scene";
  54581. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  54582. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  54583. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  54584. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  54585. /**
  54586. * Generic Controller
  54587. */
  54588. export class GenericController extends WebVRController {
  54589. /**
  54590. * Base Url for the controller model.
  54591. */
  54592. static readonly MODEL_BASE_URL: string;
  54593. /**
  54594. * File name for the controller model.
  54595. */
  54596. static readonly MODEL_FILENAME: string;
  54597. /**
  54598. * Creates a new GenericController from a gamepad
  54599. * @param vrGamepad the gamepad that the controller should be created from
  54600. */
  54601. constructor(vrGamepad: any);
  54602. /**
  54603. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  54604. * @param scene scene in which to add meshes
  54605. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  54606. */
  54607. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  54608. /**
  54609. * Called once for each button that changed state since the last frame
  54610. * @param buttonIdx Which button index changed
  54611. * @param state New state of the button
  54612. * @param changes Which properties on the state changed since last frame
  54613. */
  54614. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  54615. }
  54616. }
  54617. declare module "babylonjs/Gamepads/Controllers/oculusTouchController" {
  54618. import { Observable } from "babylonjs/Misc/observable";
  54619. import { Scene } from "babylonjs/scene";
  54620. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  54621. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  54622. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  54623. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  54624. /**
  54625. * Oculus Touch Controller
  54626. */
  54627. export class OculusTouchController extends WebVRController {
  54628. /**
  54629. * Base Url for the controller model.
  54630. */
  54631. static MODEL_BASE_URL: string;
  54632. /**
  54633. * File name for the left controller model.
  54634. */
  54635. static MODEL_LEFT_FILENAME: string;
  54636. /**
  54637. * File name for the right controller model.
  54638. */
  54639. static MODEL_RIGHT_FILENAME: string;
  54640. /**
  54641. * Base Url for the Quest controller model.
  54642. */
  54643. static QUEST_MODEL_BASE_URL: string;
  54644. /**
  54645. * @hidden
  54646. * If the controllers are running on a device that needs the updated Quest controller models
  54647. */
  54648. static _IsQuest: boolean;
  54649. /**
  54650. * Fired when the secondary trigger on this controller is modified
  54651. */
  54652. onSecondaryTriggerStateChangedObservable: Observable<ExtendedGamepadButton>;
  54653. /**
  54654. * Fired when the thumb rest on this controller is modified
  54655. */
  54656. onThumbRestChangedObservable: Observable<ExtendedGamepadButton>;
  54657. /**
  54658. * Creates a new OculusTouchController from a gamepad
  54659. * @param vrGamepad the gamepad that the controller should be created from
  54660. */
  54661. constructor(vrGamepad: any);
  54662. /**
  54663. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  54664. * @param scene scene in which to add meshes
  54665. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  54666. */
  54667. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  54668. /**
  54669. * Fired when the A button on this controller is modified
  54670. */
  54671. get onAButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  54672. /**
  54673. * Fired when the B button on this controller is modified
  54674. */
  54675. get onBButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  54676. /**
  54677. * Fired when the X button on this controller is modified
  54678. */
  54679. get onXButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  54680. /**
  54681. * Fired when the Y button on this controller is modified
  54682. */
  54683. get onYButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  54684. /**
  54685. * Called once for each button that changed state since the last frame
  54686. * 0) thumb stick (touch, press, value = pressed (0,1)). value is in this.leftStick
  54687. * 1) index trigger (touch (?), press (only when value > 0.1), value 0 to 1)
  54688. * 2) secondary trigger (same)
  54689. * 3) A (right) X (left), touch, pressed = value
  54690. * 4) B / Y
  54691. * 5) thumb rest
  54692. * @param buttonIdx Which button index changed
  54693. * @param state New state of the button
  54694. * @param changes Which properties on the state changed since last frame
  54695. */
  54696. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  54697. }
  54698. }
  54699. declare module "babylonjs/Gamepads/Controllers/viveController" {
  54700. import { Scene } from "babylonjs/scene";
  54701. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  54702. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  54703. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  54704. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  54705. import { Observable } from "babylonjs/Misc/observable";
  54706. /**
  54707. * Vive Controller
  54708. */
  54709. export class ViveController extends WebVRController {
  54710. /**
  54711. * Base Url for the controller model.
  54712. */
  54713. static MODEL_BASE_URL: string;
  54714. /**
  54715. * File name for the controller model.
  54716. */
  54717. static MODEL_FILENAME: string;
  54718. /**
  54719. * Creates a new ViveController from a gamepad
  54720. * @param vrGamepad the gamepad that the controller should be created from
  54721. */
  54722. constructor(vrGamepad: any);
  54723. /**
  54724. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  54725. * @param scene scene in which to add meshes
  54726. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  54727. */
  54728. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  54729. /**
  54730. * Fired when the left button on this controller is modified
  54731. */
  54732. get onLeftButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  54733. /**
  54734. * Fired when the right button on this controller is modified
  54735. */
  54736. get onRightButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  54737. /**
  54738. * Fired when the menu button on this controller is modified
  54739. */
  54740. get onMenuButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  54741. /**
  54742. * Called once for each button that changed state since the last frame
  54743. * Vive mapping:
  54744. * 0: touchpad
  54745. * 1: trigger
  54746. * 2: left AND right buttons
  54747. * 3: menu button
  54748. * @param buttonIdx Which button index changed
  54749. * @param state New state of the button
  54750. * @param changes Which properties on the state changed since last frame
  54751. */
  54752. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  54753. }
  54754. }
  54755. declare module "babylonjs/Gamepads/Controllers/windowsMotionController" {
  54756. import { Observable } from "babylonjs/Misc/observable";
  54757. import { Scene } from "babylonjs/scene";
  54758. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  54759. import { Ray } from "babylonjs/Culling/ray";
  54760. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  54761. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  54762. import { StickValues, GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  54763. /**
  54764. * Defines the WindowsMotionController object that the state of the windows motion controller
  54765. */
  54766. export class WindowsMotionController extends WebVRController {
  54767. /**
  54768. * The base url used to load the left and right controller models
  54769. */
  54770. static MODEL_BASE_URL: string;
  54771. /**
  54772. * The name of the left controller model file
  54773. */
  54774. static MODEL_LEFT_FILENAME: string;
  54775. /**
  54776. * The name of the right controller model file
  54777. */
  54778. static MODEL_RIGHT_FILENAME: string;
  54779. /**
  54780. * The controller name prefix for this controller type
  54781. */
  54782. static readonly GAMEPAD_ID_PREFIX: string;
  54783. /**
  54784. * The controller id pattern for this controller type
  54785. */
  54786. private static readonly GAMEPAD_ID_PATTERN;
  54787. private _loadedMeshInfo;
  54788. protected readonly _mapping: {
  54789. buttons: string[];
  54790. buttonMeshNames: {
  54791. trigger: string;
  54792. menu: string;
  54793. grip: string;
  54794. thumbstick: string;
  54795. trackpad: string;
  54796. };
  54797. buttonObservableNames: {
  54798. trigger: string;
  54799. menu: string;
  54800. grip: string;
  54801. thumbstick: string;
  54802. trackpad: string;
  54803. };
  54804. axisMeshNames: string[];
  54805. pointingPoseMeshName: string;
  54806. };
  54807. /**
  54808. * Fired when the trackpad on this controller is clicked
  54809. */
  54810. onTrackpadChangedObservable: Observable<ExtendedGamepadButton>;
  54811. /**
  54812. * Fired when the trackpad on this controller is modified
  54813. */
  54814. onTrackpadValuesChangedObservable: Observable<StickValues>;
  54815. /**
  54816. * The current x and y values of this controller's trackpad
  54817. */
  54818. trackpad: StickValues;
  54819. /**
  54820. * Creates a new WindowsMotionController from a gamepad
  54821. * @param vrGamepad the gamepad that the controller should be created from
  54822. */
  54823. constructor(vrGamepad: any);
  54824. /**
  54825. * Fired when the trigger on this controller is modified
  54826. */
  54827. get onTriggerButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  54828. /**
  54829. * Fired when the menu button on this controller is modified
  54830. */
  54831. get onMenuButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  54832. /**
  54833. * Fired when the grip button on this controller is modified
  54834. */
  54835. get onGripButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  54836. /**
  54837. * Fired when the thumbstick button on this controller is modified
  54838. */
  54839. get onThumbstickButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  54840. /**
  54841. * Fired when the touchpad button on this controller is modified
  54842. */
  54843. get onTouchpadButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  54844. /**
  54845. * Fired when the touchpad values on this controller are modified
  54846. */
  54847. get onTouchpadValuesChangedObservable(): Observable<StickValues>;
  54848. protected _updateTrackpad(): void;
  54849. /**
  54850. * Called once per frame by the engine.
  54851. */
  54852. update(): void;
  54853. /**
  54854. * Called once for each button that changed state since the last frame
  54855. * @param buttonIdx Which button index changed
  54856. * @param state New state of the button
  54857. * @param changes Which properties on the state changed since last frame
  54858. */
  54859. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  54860. /**
  54861. * Moves the buttons on the controller mesh based on their current state
  54862. * @param buttonName the name of the button to move
  54863. * @param buttonValue the value of the button which determines the buttons new position
  54864. */
  54865. protected _lerpButtonTransform(buttonName: string, buttonValue: number): void;
  54866. /**
  54867. * Moves the axis on the controller mesh based on its current state
  54868. * @param axis the index of the axis
  54869. * @param axisValue the value of the axis which determines the meshes new position
  54870. * @hidden
  54871. */
  54872. protected _lerpAxisTransform(axis: number, axisValue: number): void;
  54873. /**
  54874. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  54875. * @param scene scene in which to add meshes
  54876. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  54877. */
  54878. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void, forceDefault?: boolean): void;
  54879. /**
  54880. * Takes a list of meshes (as loaded from the glTF file) and finds the root node, as well as nodes that
  54881. * can be transformed by button presses and axes values, based on this._mapping.
  54882. *
  54883. * @param scene scene in which the meshes exist
  54884. * @param meshes list of meshes that make up the controller model to process
  54885. * @return structured view of the given meshes, with mapping of buttons and axes to meshes that can be transformed.
  54886. */
  54887. private processModel;
  54888. private createMeshInfo;
  54889. /**
  54890. * Gets the ray of the controller in the direction the controller is pointing
  54891. * @param length the length the resulting ray should be
  54892. * @returns a ray in the direction the controller is pointing
  54893. */
  54894. getForwardRay(length?: number): Ray;
  54895. /**
  54896. * Disposes of the controller
  54897. */
  54898. dispose(): void;
  54899. }
  54900. /**
  54901. * This class represents a new windows motion controller in XR.
  54902. */
  54903. export class XRWindowsMotionController extends WindowsMotionController {
  54904. /**
  54905. * Changing the original WIndowsMotionController mapping to fir the new mapping
  54906. */
  54907. protected readonly _mapping: {
  54908. buttons: string[];
  54909. buttonMeshNames: {
  54910. trigger: string;
  54911. menu: string;
  54912. grip: string;
  54913. thumbstick: string;
  54914. trackpad: string;
  54915. };
  54916. buttonObservableNames: {
  54917. trigger: string;
  54918. menu: string;
  54919. grip: string;
  54920. thumbstick: string;
  54921. trackpad: string;
  54922. };
  54923. axisMeshNames: string[];
  54924. pointingPoseMeshName: string;
  54925. };
  54926. /**
  54927. * Construct a new XR-Based windows motion controller
  54928. *
  54929. * @param gamepadInfo the gamepad object from the browser
  54930. */
  54931. constructor(gamepadInfo: any);
  54932. /**
  54933. * holds the thumbstick values (X,Y)
  54934. */
  54935. thumbstickValues: StickValues;
  54936. /**
  54937. * Fired when the thumbstick on this controller is clicked
  54938. */
  54939. onThumbstickStateChangedObservable: Observable<ExtendedGamepadButton>;
  54940. /**
  54941. * Fired when the thumbstick on this controller is modified
  54942. */
  54943. onThumbstickValuesChangedObservable: Observable<StickValues>;
  54944. /**
  54945. * Fired when the touchpad button on this controller is modified
  54946. */
  54947. onTrackpadChangedObservable: Observable<ExtendedGamepadButton>;
  54948. /**
  54949. * Fired when the touchpad values on this controller are modified
  54950. */
  54951. onTrackpadValuesChangedObservable: Observable<StickValues>;
  54952. /**
  54953. * Fired when the thumbstick button on this controller is modified
  54954. * here to prevent breaking changes
  54955. */
  54956. get onThumbstickButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  54957. /**
  54958. * updating the thumbstick(!) and not the trackpad.
  54959. * This is named this way due to the difference between WebVR and XR and to avoid
  54960. * changing the parent class.
  54961. */
  54962. protected _updateTrackpad(): void;
  54963. /**
  54964. * Disposes the class with joy
  54965. */
  54966. dispose(): void;
  54967. }
  54968. }
  54969. declare module "babylonjs/Gamepads/Controllers/index" {
  54970. export * from "babylonjs/Gamepads/Controllers/daydreamController";
  54971. export * from "babylonjs/Gamepads/Controllers/gearVRController";
  54972. export * from "babylonjs/Gamepads/Controllers/genericController";
  54973. export * from "babylonjs/Gamepads/Controllers/oculusTouchController";
  54974. export * from "babylonjs/Gamepads/Controllers/poseEnabledController";
  54975. export * from "babylonjs/Gamepads/Controllers/viveController";
  54976. export * from "babylonjs/Gamepads/Controllers/webVRController";
  54977. export * from "babylonjs/Gamepads/Controllers/windowsMotionController";
  54978. }
  54979. declare module "babylonjs/Gamepads/index" {
  54980. export * from "babylonjs/Gamepads/Controllers/index";
  54981. export * from "babylonjs/Gamepads/gamepad";
  54982. export * from "babylonjs/Gamepads/gamepadManager";
  54983. export * from "babylonjs/Gamepads/gamepadSceneComponent";
  54984. export * from "babylonjs/Gamepads/xboxGamepad";
  54985. export * from "babylonjs/Gamepads/dualShockGamepad";
  54986. }
  54987. declare module "babylonjs/Meshes/Builders/polyhedronBuilder" {
  54988. import { Scene } from "babylonjs/scene";
  54989. import { Vector4 } from "babylonjs/Maths/math.vector";
  54990. import { Color4 } from "babylonjs/Maths/math.color";
  54991. import { Mesh } from "babylonjs/Meshes/mesh";
  54992. import { Nullable } from "babylonjs/types";
  54993. /**
  54994. * Class containing static functions to help procedurally build meshes
  54995. */
  54996. export class PolyhedronBuilder {
  54997. /**
  54998. * Creates a polyhedron mesh
  54999. * * 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
  55000. * * The parameter `size` (positive float, default 1) sets the polygon size
  55001. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  55002. * * 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`
  55003. * * 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
  55004. * * 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)`)
  55005. * * 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
  55006. * * 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
  55007. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  55008. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  55009. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  55010. * @param name defines the name of the mesh
  55011. * @param options defines the options used to create the mesh
  55012. * @param scene defines the hosting scene
  55013. * @returns the polyhedron mesh
  55014. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes
  55015. */
  55016. static CreatePolyhedron(name: string, options: {
  55017. type?: number;
  55018. size?: number;
  55019. sizeX?: number;
  55020. sizeY?: number;
  55021. sizeZ?: number;
  55022. custom?: any;
  55023. faceUV?: Vector4[];
  55024. faceColors?: Color4[];
  55025. flat?: boolean;
  55026. updatable?: boolean;
  55027. sideOrientation?: number;
  55028. frontUVs?: Vector4;
  55029. backUVs?: Vector4;
  55030. }, scene?: Nullable<Scene>): Mesh;
  55031. }
  55032. }
  55033. declare module "babylonjs/Gizmos/scaleGizmo" {
  55034. import { Observable } from "babylonjs/Misc/observable";
  55035. import { Nullable } from "babylonjs/types";
  55036. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55037. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  55038. import { AxisScaleGizmo } from "babylonjs/Gizmos/axisScaleGizmo";
  55039. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  55040. import { Node } from "babylonjs/node";
  55041. /**
  55042. * Gizmo that enables scaling a mesh along 3 axis
  55043. */
  55044. export class ScaleGizmo extends Gizmo {
  55045. /**
  55046. * Internal gizmo used for interactions on the x axis
  55047. */
  55048. xGizmo: AxisScaleGizmo;
  55049. /**
  55050. * Internal gizmo used for interactions on the y axis
  55051. */
  55052. yGizmo: AxisScaleGizmo;
  55053. /**
  55054. * Internal gizmo used for interactions on the z axis
  55055. */
  55056. zGizmo: AxisScaleGizmo;
  55057. /**
  55058. * Internal gizmo used to scale all axis equally
  55059. */
  55060. uniformScaleGizmo: AxisScaleGizmo;
  55061. private _meshAttached;
  55062. private _nodeAttached;
  55063. private _updateGizmoRotationToMatchAttachedMesh;
  55064. private _snapDistance;
  55065. private _scaleRatio;
  55066. private _uniformScalingMesh;
  55067. private _octahedron;
  55068. private _sensitivity;
  55069. /** Fires an event when any of it's sub gizmos are dragged */
  55070. onDragStartObservable: Observable<unknown>;
  55071. /** Fires an event when any of it's sub gizmos are released from dragging */
  55072. onDragEndObservable: Observable<unknown>;
  55073. get attachedMesh(): Nullable<AbstractMesh>;
  55074. set attachedMesh(mesh: Nullable<AbstractMesh>);
  55075. get attachedNode(): Nullable<Node>;
  55076. set attachedNode(node: Nullable<Node>);
  55077. /**
  55078. * Creates a ScaleGizmo
  55079. * @param gizmoLayer The utility layer the gizmo will be added to
  55080. * @param thickness display gizmo axis thickness
  55081. */
  55082. constructor(gizmoLayer?: UtilityLayerRenderer, thickness?: number);
  55083. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  55084. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  55085. /**
  55086. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  55087. */
  55088. set snapDistance(value: number);
  55089. get snapDistance(): number;
  55090. /**
  55091. * Ratio for the scale of the gizmo (Default: 1)
  55092. */
  55093. set scaleRatio(value: number);
  55094. get scaleRatio(): number;
  55095. /**
  55096. * Sensitivity factor for dragging (Default: 1)
  55097. */
  55098. set sensitivity(value: number);
  55099. get sensitivity(): number;
  55100. /**
  55101. * Disposes of the gizmo
  55102. */
  55103. dispose(): void;
  55104. }
  55105. }
  55106. declare module "babylonjs/Gizmos/axisScaleGizmo" {
  55107. import { Observable } from "babylonjs/Misc/observable";
  55108. import { Nullable } from "babylonjs/types";
  55109. import { Vector3 } from "babylonjs/Maths/math.vector";
  55110. import { Node } from "babylonjs/node";
  55111. import { Mesh } from "babylonjs/Meshes/mesh";
  55112. import { PointerDragBehavior } from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  55113. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  55114. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  55115. import { ScaleGizmo } from "babylonjs/Gizmos/scaleGizmo";
  55116. import { Color3 } from "babylonjs/Maths/math.color";
  55117. /**
  55118. * Single axis scale gizmo
  55119. */
  55120. export class AxisScaleGizmo extends Gizmo {
  55121. /**
  55122. * Drag behavior responsible for the gizmos dragging interactions
  55123. */
  55124. dragBehavior: PointerDragBehavior;
  55125. private _pointerObserver;
  55126. /**
  55127. * Scale distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  55128. */
  55129. snapDistance: number;
  55130. /**
  55131. * Event that fires each time the gizmo snaps to a new location.
  55132. * * snapDistance is the the change in distance
  55133. */
  55134. onSnapObservable: Observable<{
  55135. snapDistance: number;
  55136. }>;
  55137. /**
  55138. * If the scaling operation should be done on all axis (default: false)
  55139. */
  55140. uniformScaling: boolean;
  55141. /**
  55142. * Custom sensitivity value for the drag strength
  55143. */
  55144. sensitivity: number;
  55145. private _isEnabled;
  55146. private _parent;
  55147. private _arrow;
  55148. private _coloredMaterial;
  55149. private _hoverMaterial;
  55150. /**
  55151. * Creates an AxisScaleGizmo
  55152. * @param gizmoLayer The utility layer the gizmo will be added to
  55153. * @param dragAxis The axis which the gizmo will be able to scale on
  55154. * @param color The color of the gizmo
  55155. * @param thickness display gizmo axis thickness
  55156. */
  55157. constructor(dragAxis: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<ScaleGizmo>, thickness?: number);
  55158. protected _attachedNodeChanged(value: Nullable<Node>): void;
  55159. /**
  55160. * If the gizmo is enabled
  55161. */
  55162. set isEnabled(value: boolean);
  55163. get isEnabled(): boolean;
  55164. /**
  55165. * Disposes of the gizmo
  55166. */
  55167. dispose(): void;
  55168. /**
  55169. * Disposes and replaces the current meshes in the gizmo with the specified mesh
  55170. * @param mesh The mesh to replace the default mesh of the gizmo
  55171. * @param useGizmoMaterial If the gizmo's default material should be used (default: false)
  55172. */
  55173. setCustomMesh(mesh: Mesh, useGizmoMaterial?: boolean): void;
  55174. }
  55175. }
  55176. declare module "babylonjs/Gizmos/boundingBoxGizmo" {
  55177. import { Observable } from "babylonjs/Misc/observable";
  55178. import { Nullable } from "babylonjs/types";
  55179. import { Vector3 } from "babylonjs/Maths/math.vector";
  55180. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55181. import { Mesh } from "babylonjs/Meshes/mesh";
  55182. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  55183. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  55184. import { Color3 } from "babylonjs/Maths/math.color";
  55185. import "babylonjs/Meshes/Builders/boxBuilder";
  55186. /**
  55187. * Bounding box gizmo
  55188. */
  55189. export class BoundingBoxGizmo extends Gizmo {
  55190. private _lineBoundingBox;
  55191. private _rotateSpheresParent;
  55192. private _scaleBoxesParent;
  55193. private _boundingDimensions;
  55194. private _renderObserver;
  55195. private _pointerObserver;
  55196. private _scaleDragSpeed;
  55197. private _tmpQuaternion;
  55198. private _tmpVector;
  55199. private _tmpRotationMatrix;
  55200. /**
  55201. * 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)
  55202. */
  55203. ignoreChildren: boolean;
  55204. /**
  55205. * 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)
  55206. */
  55207. includeChildPredicate: Nullable<(abstractMesh: AbstractMesh) => boolean>;
  55208. /**
  55209. * The size of the rotation spheres attached to the bounding box (Default: 0.1)
  55210. */
  55211. rotationSphereSize: number;
  55212. /**
  55213. * The size of the scale boxes attached to the bounding box (Default: 0.1)
  55214. */
  55215. scaleBoxSize: number;
  55216. /**
  55217. * 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)
  55218. */
  55219. fixedDragMeshScreenSize: boolean;
  55220. /**
  55221. * The distance away from the object which the draggable meshes should appear world sized when fixedDragMeshScreenSize is set to true (default: 10)
  55222. */
  55223. fixedDragMeshScreenSizeDistanceFactor: number;
  55224. /**
  55225. * Fired when a rotation sphere or scale box is dragged
  55226. */
  55227. onDragStartObservable: Observable<{}>;
  55228. /**
  55229. * Fired when a scale box is dragged
  55230. */
  55231. onScaleBoxDragObservable: Observable<{}>;
  55232. /**
  55233. * Fired when a scale box drag is ended
  55234. */
  55235. onScaleBoxDragEndObservable: Observable<{}>;
  55236. /**
  55237. * Fired when a rotation sphere is dragged
  55238. */
  55239. onRotationSphereDragObservable: Observable<{}>;
  55240. /**
  55241. * Fired when a rotation sphere drag is ended
  55242. */
  55243. onRotationSphereDragEndObservable: Observable<{}>;
  55244. /**
  55245. * 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)
  55246. */
  55247. scalePivot: Nullable<Vector3>;
  55248. /**
  55249. * Mesh used as a pivot to rotate the attached node
  55250. */
  55251. private _anchorMesh;
  55252. private _existingMeshScale;
  55253. private _dragMesh;
  55254. private pointerDragBehavior;
  55255. private coloredMaterial;
  55256. private hoverColoredMaterial;
  55257. /**
  55258. * Sets the color of the bounding box gizmo
  55259. * @param color the color to set
  55260. */
  55261. setColor(color: Color3): void;
  55262. /**
  55263. * Creates an BoundingBoxGizmo
  55264. * @param gizmoLayer The utility layer the gizmo will be added to
  55265. * @param color The color of the gizmo
  55266. */
  55267. constructor(color?: Color3, gizmoLayer?: UtilityLayerRenderer);
  55268. protected _attachedNodeChanged(value: Nullable<AbstractMesh>): void;
  55269. private _selectNode;
  55270. /**
  55271. * Updates the bounding box information for the Gizmo
  55272. */
  55273. updateBoundingBox(): void;
  55274. private _updateRotationSpheres;
  55275. private _updateScaleBoxes;
  55276. /**
  55277. * Enables rotation on the specified axis and disables rotation on the others
  55278. * @param axis The list of axis that should be enabled (eg. "xy" or "xyz")
  55279. */
  55280. setEnabledRotationAxis(axis: string): void;
  55281. /**
  55282. * Enables/disables scaling
  55283. * @param enable if scaling should be enabled
  55284. * @param homogeneousScaling defines if scaling should only be homogeneous
  55285. */
  55286. setEnabledScaling(enable: boolean, homogeneousScaling?: boolean): void;
  55287. private _updateDummy;
  55288. /**
  55289. * Enables a pointer drag behavior on the bounding box of the gizmo
  55290. */
  55291. enableDragBehavior(): void;
  55292. /**
  55293. * Disposes of the gizmo
  55294. */
  55295. dispose(): void;
  55296. /**
  55297. * 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)
  55298. * @param mesh the mesh to wrap in the bounding box mesh and make not pickable
  55299. * @returns the bounding box mesh with the passed in mesh as a child
  55300. */
  55301. static MakeNotPickableAndWrapInBoundingBox(mesh: Mesh): Mesh;
  55302. /**
  55303. * CustomMeshes are not supported by this gizmo
  55304. * @param mesh The mesh to replace the default mesh of the gizmo
  55305. */
  55306. setCustomMesh(mesh: Mesh): void;
  55307. }
  55308. }
  55309. declare module "babylonjs/Gizmos/planeRotationGizmo" {
  55310. import { Observable } from "babylonjs/Misc/observable";
  55311. import { Nullable } from "babylonjs/types";
  55312. import { Vector3 } from "babylonjs/Maths/math.vector";
  55313. import { Color3 } from "babylonjs/Maths/math.color";
  55314. import { Node } from "babylonjs/node";
  55315. import { PointerDragBehavior } from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  55316. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  55317. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  55318. import "babylonjs/Meshes/Builders/linesBuilder";
  55319. import { RotationGizmo } from "babylonjs/Gizmos/rotationGizmo";
  55320. /**
  55321. * Single plane rotation gizmo
  55322. */
  55323. export class PlaneRotationGizmo extends Gizmo {
  55324. /**
  55325. * Drag behavior responsible for the gizmos dragging interactions
  55326. */
  55327. dragBehavior: PointerDragBehavior;
  55328. private _pointerObserver;
  55329. /**
  55330. * Rotation distance in radians that the gizmo will snap to (Default: 0)
  55331. */
  55332. snapDistance: number;
  55333. /**
  55334. * Event that fires each time the gizmo snaps to a new location.
  55335. * * snapDistance is the the change in distance
  55336. */
  55337. onSnapObservable: Observable<{
  55338. snapDistance: number;
  55339. }>;
  55340. private _isEnabled;
  55341. private _parent;
  55342. /**
  55343. * Creates a PlaneRotationGizmo
  55344. * @param gizmoLayer The utility layer the gizmo will be added to
  55345. * @param planeNormal The normal of the plane which the gizmo will be able to rotate on
  55346. * @param color The color of the gizmo
  55347. * @param tessellation Amount of tessellation to be used when creating rotation circles
  55348. * @param useEulerRotation Use and update Euler angle instead of quaternion
  55349. * @param thickness display gizmo axis thickness
  55350. */
  55351. constructor(planeNormal: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, tessellation?: number, parent?: Nullable<RotationGizmo>, useEulerRotation?: boolean, thickness?: number);
  55352. protected _attachedNodeChanged(value: Nullable<Node>): void;
  55353. /**
  55354. * If the gizmo is enabled
  55355. */
  55356. set isEnabled(value: boolean);
  55357. get isEnabled(): boolean;
  55358. /**
  55359. * Disposes of the gizmo
  55360. */
  55361. dispose(): void;
  55362. }
  55363. }
  55364. declare module "babylonjs/Gizmos/rotationGizmo" {
  55365. import { Observable } from "babylonjs/Misc/observable";
  55366. import { Nullable } from "babylonjs/types";
  55367. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55368. import { Mesh } from "babylonjs/Meshes/mesh";
  55369. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  55370. import { PlaneRotationGizmo } from "babylonjs/Gizmos/planeRotationGizmo";
  55371. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  55372. import { Node } from "babylonjs/node";
  55373. /**
  55374. * Gizmo that enables rotating a mesh along 3 axis
  55375. */
  55376. export class RotationGizmo extends Gizmo {
  55377. /**
  55378. * Internal gizmo used for interactions on the x axis
  55379. */
  55380. xGizmo: PlaneRotationGizmo;
  55381. /**
  55382. * Internal gizmo used for interactions on the y axis
  55383. */
  55384. yGizmo: PlaneRotationGizmo;
  55385. /**
  55386. * Internal gizmo used for interactions on the z axis
  55387. */
  55388. zGizmo: PlaneRotationGizmo;
  55389. /** Fires an event when any of it's sub gizmos are dragged */
  55390. onDragStartObservable: Observable<unknown>;
  55391. /** Fires an event when any of it's sub gizmos are released from dragging */
  55392. onDragEndObservable: Observable<unknown>;
  55393. private _meshAttached;
  55394. private _nodeAttached;
  55395. get attachedMesh(): Nullable<AbstractMesh>;
  55396. set attachedMesh(mesh: Nullable<AbstractMesh>);
  55397. get attachedNode(): Nullable<Node>;
  55398. set attachedNode(node: Nullable<Node>);
  55399. /**
  55400. * Creates a RotationGizmo
  55401. * @param gizmoLayer The utility layer the gizmo will be added to
  55402. * @param tessellation Amount of tessellation to be used when creating rotation circles
  55403. * @param useEulerRotation Use and update Euler angle instead of quaternion
  55404. * @param thickness display gizmo axis thickness
  55405. */
  55406. constructor(gizmoLayer?: UtilityLayerRenderer, tessellation?: number, useEulerRotation?: boolean, thickness?: number);
  55407. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  55408. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  55409. /**
  55410. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  55411. */
  55412. set snapDistance(value: number);
  55413. get snapDistance(): number;
  55414. /**
  55415. * Ratio for the scale of the gizmo (Default: 1)
  55416. */
  55417. set scaleRatio(value: number);
  55418. get scaleRatio(): number;
  55419. /**
  55420. * Disposes of the gizmo
  55421. */
  55422. dispose(): void;
  55423. /**
  55424. * CustomMeshes are not supported by this gizmo
  55425. * @param mesh The mesh to replace the default mesh of the gizmo
  55426. */
  55427. setCustomMesh(mesh: Mesh): void;
  55428. }
  55429. }
  55430. declare module "babylonjs/Gizmos/gizmoManager" {
  55431. import { Observable } from "babylonjs/Misc/observable";
  55432. import { Nullable } from "babylonjs/types";
  55433. import { Scene, IDisposable } from "babylonjs/scene";
  55434. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55435. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  55436. import { SixDofDragBehavior } from "babylonjs/Behaviors/Meshes/sixDofDragBehavior";
  55437. import { RotationGizmo } from "babylonjs/Gizmos/rotationGizmo";
  55438. import { PositionGizmo } from "babylonjs/Gizmos/positionGizmo";
  55439. import { ScaleGizmo } from "babylonjs/Gizmos/scaleGizmo";
  55440. import { BoundingBoxGizmo } from "babylonjs/Gizmos/boundingBoxGizmo";
  55441. /**
  55442. * Helps setup gizmo's in the scene to rotate/scale/position meshes
  55443. */
  55444. export class GizmoManager implements IDisposable {
  55445. private scene;
  55446. /**
  55447. * Gizmo's created by the gizmo manager, gizmo will be null until gizmo has been enabled for the first time
  55448. */
  55449. gizmos: {
  55450. positionGizmo: Nullable<PositionGizmo>;
  55451. rotationGizmo: Nullable<RotationGizmo>;
  55452. scaleGizmo: Nullable<ScaleGizmo>;
  55453. boundingBoxGizmo: Nullable<BoundingBoxGizmo>;
  55454. };
  55455. /** When true, the gizmo will be detached from the current object when a pointer down occurs with an empty picked mesh */
  55456. clearGizmoOnEmptyPointerEvent: boolean;
  55457. /** Fires an event when the manager is attached to a mesh */
  55458. onAttachedToMeshObservable: Observable<Nullable<AbstractMesh>>;
  55459. private _gizmosEnabled;
  55460. private _pointerObserver;
  55461. private _attachedMesh;
  55462. private _boundingBoxColor;
  55463. private _defaultUtilityLayer;
  55464. private _defaultKeepDepthUtilityLayer;
  55465. private _thickness;
  55466. /**
  55467. * When bounding box gizmo is enabled, this can be used to track drag/end events
  55468. */
  55469. boundingBoxDragBehavior: SixDofDragBehavior;
  55470. /**
  55471. * Array of meshes which will have the gizmo attached when a pointer selected them. If null, all meshes are attachable. (Default: null)
  55472. */
  55473. attachableMeshes: Nullable<Array<AbstractMesh>>;
  55474. /**
  55475. * If pointer events should perform attaching/detaching a gizmo, if false this can be done manually via attachToMesh. (Default: true)
  55476. */
  55477. usePointerToAttachGizmos: boolean;
  55478. /**
  55479. * Utility layer that the bounding box gizmo belongs to
  55480. */
  55481. get keepDepthUtilityLayer(): UtilityLayerRenderer;
  55482. /**
  55483. * Utility layer that all gizmos besides bounding box belong to
  55484. */
  55485. get utilityLayer(): UtilityLayerRenderer;
  55486. /**
  55487. * Instatiates a gizmo manager
  55488. * @param scene the scene to overlay the gizmos on top of
  55489. * @param thickness display gizmo axis thickness
  55490. */
  55491. constructor(scene: Scene, thickness?: number);
  55492. /**
  55493. * Attaches a set of gizmos to the specified mesh
  55494. * @param mesh The mesh the gizmo's should be attached to
  55495. */
  55496. attachToMesh(mesh: Nullable<AbstractMesh>): void;
  55497. /**
  55498. * If the position gizmo is enabled
  55499. */
  55500. set positionGizmoEnabled(value: boolean);
  55501. get positionGizmoEnabled(): boolean;
  55502. /**
  55503. * If the rotation gizmo is enabled
  55504. */
  55505. set rotationGizmoEnabled(value: boolean);
  55506. get rotationGizmoEnabled(): boolean;
  55507. /**
  55508. * If the scale gizmo is enabled
  55509. */
  55510. set scaleGizmoEnabled(value: boolean);
  55511. get scaleGizmoEnabled(): boolean;
  55512. /**
  55513. * If the boundingBox gizmo is enabled
  55514. */
  55515. set boundingBoxGizmoEnabled(value: boolean);
  55516. get boundingBoxGizmoEnabled(): boolean;
  55517. /**
  55518. * Disposes of the gizmo manager
  55519. */
  55520. dispose(): void;
  55521. }
  55522. }
  55523. declare module "babylonjs/Lights/directionalLight" {
  55524. import { Camera } from "babylonjs/Cameras/camera";
  55525. import { Scene } from "babylonjs/scene";
  55526. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  55527. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55528. import { Light } from "babylonjs/Lights/light";
  55529. import { ShadowLight } from "babylonjs/Lights/shadowLight";
  55530. import { Effect } from "babylonjs/Materials/effect";
  55531. /**
  55532. * A directional light is defined by a direction (what a surprise!).
  55533. * The light is emitted from everywhere in the specified direction, and has an infinite range.
  55534. * 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.
  55535. * Documentation: https://doc.babylonjs.com/babylon101/lights
  55536. */
  55537. export class DirectionalLight extends ShadowLight {
  55538. private _shadowFrustumSize;
  55539. /**
  55540. * Fix frustum size for the shadow generation. This is disabled if the value is 0.
  55541. */
  55542. get shadowFrustumSize(): number;
  55543. /**
  55544. * Specifies a fix frustum size for the shadow generation.
  55545. */
  55546. set shadowFrustumSize(value: number);
  55547. private _shadowOrthoScale;
  55548. /**
  55549. * Gets the shadow projection scale against the optimal computed one.
  55550. * 0.1 by default which means that the projection window is increase by 10% from the optimal size.
  55551. * This does not impact in fixed frustum size (shadowFrustumSize being set)
  55552. */
  55553. get shadowOrthoScale(): number;
  55554. /**
  55555. * Sets the shadow projection scale against the optimal computed one.
  55556. * 0.1 by default which means that the projection window is increase by 10% from the optimal size.
  55557. * This does not impact in fixed frustum size (shadowFrustumSize being set)
  55558. */
  55559. set shadowOrthoScale(value: number);
  55560. /**
  55561. * Automatically compute the projection matrix to best fit (including all the casters)
  55562. * on each frame.
  55563. */
  55564. autoUpdateExtends: boolean;
  55565. /**
  55566. * Automatically compute the shadowMinZ and shadowMaxZ for the projection matrix to best fit (including all the casters)
  55567. * on each frame. autoUpdateExtends must be set to true for this to work
  55568. */
  55569. autoCalcShadowZBounds: boolean;
  55570. private _orthoLeft;
  55571. private _orthoRight;
  55572. private _orthoTop;
  55573. private _orthoBottom;
  55574. /**
  55575. * Creates a DirectionalLight object in the scene, oriented towards the passed direction (Vector3).
  55576. * The directional light is emitted from everywhere in the given direction.
  55577. * It can cast shadows.
  55578. * Documentation : https://doc.babylonjs.com/babylon101/lights
  55579. * @param name The friendly name of the light
  55580. * @param direction The direction of the light
  55581. * @param scene The scene the light belongs to
  55582. */
  55583. constructor(name: string, direction: Vector3, scene: Scene);
  55584. /**
  55585. * Returns the string "DirectionalLight".
  55586. * @return The class name
  55587. */
  55588. getClassName(): string;
  55589. /**
  55590. * Returns the integer 1.
  55591. * @return The light Type id as a constant defines in Light.LIGHTTYPEID_x
  55592. */
  55593. getTypeID(): number;
  55594. /**
  55595. * Sets the passed matrix "matrix" as projection matrix for the shadows cast by the light according to the passed view matrix.
  55596. * Returns the DirectionalLight Shadow projection matrix.
  55597. */
  55598. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  55599. /**
  55600. * Sets the passed matrix "matrix" as fixed frustum projection matrix for the shadows cast by the light according to the passed view matrix.
  55601. * Returns the DirectionalLight Shadow projection matrix.
  55602. */
  55603. protected _setDefaultFixedFrustumShadowProjectionMatrix(matrix: Matrix): void;
  55604. /**
  55605. * Sets the passed matrix "matrix" as auto extend projection matrix for the shadows cast by the light according to the passed view matrix.
  55606. * Returns the DirectionalLight Shadow projection matrix.
  55607. */
  55608. protected _setDefaultAutoExtendShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  55609. protected _buildUniformLayout(): void;
  55610. /**
  55611. * Sets the passed Effect object with the DirectionalLight transformed position (or position if not parented) and the passed name.
  55612. * @param effect The effect to update
  55613. * @param lightIndex The index of the light in the effect to update
  55614. * @returns The directional light
  55615. */
  55616. transferToEffect(effect: Effect, lightIndex: string): DirectionalLight;
  55617. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): Light;
  55618. /**
  55619. * Gets the minZ used for shadow according to both the scene and the light.
  55620. *
  55621. * Values are fixed on directional lights as it relies on an ortho projection hence the need to convert being
  55622. * -1 and 1 to 0 and 1 doing (depth + min) / (min + max) -> (depth + 1) / (1 + 1) -> (depth * 0.5) + 0.5.
  55623. * @param activeCamera The camera we are returning the min for
  55624. * @returns the depth min z
  55625. */
  55626. getDepthMinZ(activeCamera: Camera): number;
  55627. /**
  55628. * Gets the maxZ used for shadow according to both the scene and the light.
  55629. *
  55630. * Values are fixed on directional lights as it relies on an ortho projection hence the need to convert being
  55631. * -1 and 1 to 0 and 1 doing (depth + min) / (min + max) -> (depth + 1) / (1 + 1) -> (depth * 0.5) + 0.5.
  55632. * @param activeCamera The camera we are returning the max for
  55633. * @returns the depth max z
  55634. */
  55635. getDepthMaxZ(activeCamera: Camera): number;
  55636. /**
  55637. * Prepares the list of defines specific to the light type.
  55638. * @param defines the list of defines
  55639. * @param lightIndex defines the index of the light for the effect
  55640. */
  55641. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  55642. }
  55643. }
  55644. declare module "babylonjs/Meshes/Builders/hemisphereBuilder" {
  55645. import { Mesh } from "babylonjs/Meshes/mesh";
  55646. /**
  55647. * Class containing static functions to help procedurally build meshes
  55648. */
  55649. export class HemisphereBuilder {
  55650. /**
  55651. * Creates a hemisphere mesh
  55652. * @param name defines the name of the mesh
  55653. * @param options defines the options used to create the mesh
  55654. * @param scene defines the hosting scene
  55655. * @returns the hemisphere mesh
  55656. */
  55657. static CreateHemisphere(name: string, options: {
  55658. segments?: number;
  55659. diameter?: number;
  55660. sideOrientation?: number;
  55661. }, scene: any): Mesh;
  55662. }
  55663. }
  55664. declare module "babylonjs/Lights/spotLight" {
  55665. import { Nullable } from "babylonjs/types";
  55666. import { Scene } from "babylonjs/scene";
  55667. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  55668. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55669. import { Effect } from "babylonjs/Materials/effect";
  55670. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  55671. import { Light } from "babylonjs/Lights/light";
  55672. import { ShadowLight } from "babylonjs/Lights/shadowLight";
  55673. /**
  55674. * A spot light is defined by a position, a direction, an angle, and an exponent.
  55675. * These values define a cone of light starting from the position, emitting toward the direction.
  55676. * The angle, in radians, defines the size (field of illumination) of the spotlight's conical beam,
  55677. * and the exponent defines the speed of the decay of the light with distance (reach).
  55678. * Documentation: https://doc.babylonjs.com/babylon101/lights
  55679. */
  55680. export class SpotLight extends ShadowLight {
  55681. private _angle;
  55682. private _innerAngle;
  55683. private _cosHalfAngle;
  55684. private _lightAngleScale;
  55685. private _lightAngleOffset;
  55686. /**
  55687. * Gets the cone angle of the spot light in Radians.
  55688. */
  55689. get angle(): number;
  55690. /**
  55691. * Sets the cone angle of the spot light in Radians.
  55692. */
  55693. set angle(value: number);
  55694. /**
  55695. * Only used in gltf falloff mode, this defines the angle where
  55696. * the directional falloff will start before cutting at angle which could be seen
  55697. * as outer angle.
  55698. */
  55699. get innerAngle(): number;
  55700. /**
  55701. * Only used in gltf falloff mode, this defines the angle where
  55702. * the directional falloff will start before cutting at angle which could be seen
  55703. * as outer angle.
  55704. */
  55705. set innerAngle(value: number);
  55706. private _shadowAngleScale;
  55707. /**
  55708. * Allows scaling the angle of the light for shadow generation only.
  55709. */
  55710. get shadowAngleScale(): number;
  55711. /**
  55712. * Allows scaling the angle of the light for shadow generation only.
  55713. */
  55714. set shadowAngleScale(value: number);
  55715. /**
  55716. * The light decay speed with the distance from the emission spot.
  55717. */
  55718. exponent: number;
  55719. private _projectionTextureMatrix;
  55720. /**
  55721. * Allows reading the projecton texture
  55722. */
  55723. get projectionTextureMatrix(): Matrix;
  55724. protected _projectionTextureLightNear: number;
  55725. /**
  55726. * Gets the near clip of the Spotlight for texture projection.
  55727. */
  55728. get projectionTextureLightNear(): number;
  55729. /**
  55730. * Sets the near clip of the Spotlight for texture projection.
  55731. */
  55732. set projectionTextureLightNear(value: number);
  55733. protected _projectionTextureLightFar: number;
  55734. /**
  55735. * Gets the far clip of the Spotlight for texture projection.
  55736. */
  55737. get projectionTextureLightFar(): number;
  55738. /**
  55739. * Sets the far clip of the Spotlight for texture projection.
  55740. */
  55741. set projectionTextureLightFar(value: number);
  55742. protected _projectionTextureUpDirection: Vector3;
  55743. /**
  55744. * Gets the Up vector of the Spotlight for texture projection.
  55745. */
  55746. get projectionTextureUpDirection(): Vector3;
  55747. /**
  55748. * Sets the Up vector of the Spotlight for texture projection.
  55749. */
  55750. set projectionTextureUpDirection(value: Vector3);
  55751. private _projectionTexture;
  55752. /**
  55753. * Gets the projection texture of the light.
  55754. */
  55755. get projectionTexture(): Nullable<BaseTexture>;
  55756. /**
  55757. * Sets the projection texture of the light.
  55758. */
  55759. set projectionTexture(value: Nullable<BaseTexture>);
  55760. private _projectionTextureViewLightDirty;
  55761. private _projectionTextureProjectionLightDirty;
  55762. private _projectionTextureDirty;
  55763. private _projectionTextureViewTargetVector;
  55764. private _projectionTextureViewLightMatrix;
  55765. private _projectionTextureProjectionLightMatrix;
  55766. private _projectionTextureScalingMatrix;
  55767. /**
  55768. * Creates a SpotLight object in the scene. A spot light is a simply light oriented cone.
  55769. * It can cast shadows.
  55770. * Documentation : https://doc.babylonjs.com/babylon101/lights
  55771. * @param name The light friendly name
  55772. * @param position The position of the spot light in the scene
  55773. * @param direction The direction of the light in the scene
  55774. * @param angle The cone angle of the light in Radians
  55775. * @param exponent The light decay speed with the distance from the emission spot
  55776. * @param scene The scene the lights belongs to
  55777. */
  55778. constructor(name: string, position: Vector3, direction: Vector3, angle: number, exponent: number, scene: Scene);
  55779. /**
  55780. * Returns the string "SpotLight".
  55781. * @returns the class name
  55782. */
  55783. getClassName(): string;
  55784. /**
  55785. * Returns the integer 2.
  55786. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  55787. */
  55788. getTypeID(): number;
  55789. /**
  55790. * Overrides the direction setter to recompute the projection texture view light Matrix.
  55791. */
  55792. protected _setDirection(value: Vector3): void;
  55793. /**
  55794. * Overrides the position setter to recompute the projection texture view light Matrix.
  55795. */
  55796. protected _setPosition(value: Vector3): void;
  55797. /**
  55798. * 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.
  55799. * Returns the SpotLight.
  55800. */
  55801. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  55802. protected _computeProjectionTextureViewLightMatrix(): void;
  55803. protected _computeProjectionTextureProjectionLightMatrix(): void;
  55804. /**
  55805. * Main function for light texture projection matrix computing.
  55806. */
  55807. protected _computeProjectionTextureMatrix(): void;
  55808. protected _buildUniformLayout(): void;
  55809. private _computeAngleValues;
  55810. /**
  55811. * Sets the passed Effect "effect" with the Light textures.
  55812. * @param effect The effect to update
  55813. * @param lightIndex The index of the light in the effect to update
  55814. * @returns The light
  55815. */
  55816. transferTexturesToEffect(effect: Effect, lightIndex: string): Light;
  55817. /**
  55818. * Sets the passed Effect object with the SpotLight transfomed position (or position if not parented) and normalized direction.
  55819. * @param effect The effect to update
  55820. * @param lightIndex The index of the light in the effect to update
  55821. * @returns The spot light
  55822. */
  55823. transferToEffect(effect: Effect, lightIndex: string): SpotLight;
  55824. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  55825. /**
  55826. * Disposes the light and the associated resources.
  55827. */
  55828. dispose(): void;
  55829. /**
  55830. * Prepares the list of defines specific to the light type.
  55831. * @param defines the list of defines
  55832. * @param lightIndex defines the index of the light for the effect
  55833. */
  55834. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  55835. }
  55836. }
  55837. declare module "babylonjs/Gizmos/lightGizmo" {
  55838. import { Nullable } from "babylonjs/types";
  55839. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  55840. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  55841. import { StandardMaterial } from "babylonjs/Materials/standardMaterial";
  55842. import { Light } from "babylonjs/Lights/light";
  55843. /**
  55844. * Gizmo that enables viewing a light
  55845. */
  55846. export class LightGizmo extends Gizmo {
  55847. private _lightMesh;
  55848. private _material;
  55849. private _cachedPosition;
  55850. private _cachedForward;
  55851. private _attachedMeshParent;
  55852. /**
  55853. * Creates a LightGizmo
  55854. * @param gizmoLayer The utility layer the gizmo will be added to
  55855. */
  55856. constructor(gizmoLayer?: UtilityLayerRenderer);
  55857. private _light;
  55858. /**
  55859. * The light that the gizmo is attached to
  55860. */
  55861. set light(light: Nullable<Light>);
  55862. get light(): Nullable<Light>;
  55863. /**
  55864. * Gets the material used to render the light gizmo
  55865. */
  55866. get material(): StandardMaterial;
  55867. /**
  55868. * @hidden
  55869. * Updates the gizmo to match the attached mesh's position/rotation
  55870. */
  55871. protected _update(): void;
  55872. private static _Scale;
  55873. /**
  55874. * Creates the lines for a light mesh
  55875. */
  55876. private static _CreateLightLines;
  55877. /**
  55878. * Disposes of the light gizmo
  55879. */
  55880. dispose(): void;
  55881. private static _CreateHemisphericLightMesh;
  55882. private static _CreatePointLightMesh;
  55883. private static _CreateSpotLightMesh;
  55884. private static _CreateDirectionalLightMesh;
  55885. }
  55886. }
  55887. declare module "babylonjs/Gizmos/index" {
  55888. export * from "babylonjs/Gizmos/axisDragGizmo";
  55889. export * from "babylonjs/Gizmos/axisScaleGizmo";
  55890. export * from "babylonjs/Gizmos/boundingBoxGizmo";
  55891. export * from "babylonjs/Gizmos/gizmo";
  55892. export * from "babylonjs/Gizmos/gizmoManager";
  55893. export * from "babylonjs/Gizmos/planeRotationGizmo";
  55894. export * from "babylonjs/Gizmos/positionGizmo";
  55895. export * from "babylonjs/Gizmos/rotationGizmo";
  55896. export * from "babylonjs/Gizmos/scaleGizmo";
  55897. export * from "babylonjs/Gizmos/lightGizmo";
  55898. export * from "babylonjs/Gizmos/planeDragGizmo";
  55899. }
  55900. declare module "babylonjs/Shaders/ShadersInclude/backgroundFragmentDeclaration" {
  55901. /** @hidden */
  55902. export var backgroundFragmentDeclaration: {
  55903. name: string;
  55904. shader: string;
  55905. };
  55906. }
  55907. declare module "babylonjs/Shaders/ShadersInclude/backgroundUboDeclaration" {
  55908. /** @hidden */
  55909. export var backgroundUboDeclaration: {
  55910. name: string;
  55911. shader: string;
  55912. };
  55913. }
  55914. declare module "babylonjs/Shaders/background.fragment" {
  55915. import "babylonjs/Shaders/ShadersInclude/backgroundFragmentDeclaration";
  55916. import "babylonjs/Shaders/ShadersInclude/backgroundUboDeclaration";
  55917. import "babylonjs/Shaders/ShadersInclude/reflectionFunction";
  55918. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  55919. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  55920. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  55921. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  55922. import "babylonjs/Shaders/ShadersInclude/lightsFragmentFunctions";
  55923. import "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions";
  55924. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  55925. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  55926. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  55927. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  55928. import "babylonjs/Shaders/ShadersInclude/lightFragment";
  55929. import "babylonjs/Shaders/ShadersInclude/fogFragment";
  55930. /** @hidden */
  55931. export var backgroundPixelShader: {
  55932. name: string;
  55933. shader: string;
  55934. };
  55935. }
  55936. declare module "babylonjs/Shaders/ShadersInclude/backgroundVertexDeclaration" {
  55937. /** @hidden */
  55938. export var backgroundVertexDeclaration: {
  55939. name: string;
  55940. shader: string;
  55941. };
  55942. }
  55943. declare module "babylonjs/Shaders/background.vertex" {
  55944. import "babylonjs/Shaders/ShadersInclude/backgroundVertexDeclaration";
  55945. import "babylonjs/Shaders/ShadersInclude/backgroundUboDeclaration";
  55946. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  55947. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  55948. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  55949. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  55950. import "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration";
  55951. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  55952. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  55953. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  55954. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  55955. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  55956. import "babylonjs/Shaders/ShadersInclude/fogVertex";
  55957. import "babylonjs/Shaders/ShadersInclude/shadowsVertex";
  55958. /** @hidden */
  55959. export var backgroundVertexShader: {
  55960. name: string;
  55961. shader: string;
  55962. };
  55963. }
  55964. declare module "babylonjs/Materials/Background/backgroundMaterial" {
  55965. import { Nullable, int, float } from "babylonjs/types";
  55966. import { Scene } from "babylonjs/scene";
  55967. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  55968. import { SubMesh } from "babylonjs/Meshes/subMesh";
  55969. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55970. import { Mesh } from "babylonjs/Meshes/mesh";
  55971. import { PushMaterial } from "babylonjs/Materials/pushMaterial";
  55972. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  55973. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  55974. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  55975. import { IShadowLight } from "babylonjs/Lights/shadowLight";
  55976. import { Color3 } from "babylonjs/Maths/math.color";
  55977. import "babylonjs/Shaders/background.fragment";
  55978. import "babylonjs/Shaders/background.vertex";
  55979. /**
  55980. * Background material used to create an efficient environement around your scene.
  55981. */
  55982. export class BackgroundMaterial extends PushMaterial {
  55983. /**
  55984. * Standard reflectance value at parallel view angle.
  55985. */
  55986. static StandardReflectance0: number;
  55987. /**
  55988. * Standard reflectance value at grazing angle.
  55989. */
  55990. static StandardReflectance90: number;
  55991. protected _primaryColor: Color3;
  55992. /**
  55993. * Key light Color (multiply against the environement texture)
  55994. */
  55995. primaryColor: Color3;
  55996. protected __perceptualColor: Nullable<Color3>;
  55997. /**
  55998. * Experimental Internal Use Only.
  55999. *
  56000. * Key light Color in "perceptual value" meaning the color you would like to see on screen.
  56001. * This acts as a helper to set the primary color to a more "human friendly" value.
  56002. * Conversion to linear space as well as exposure and tone mapping correction will be applied to keep the
  56003. * output color as close as possible from the chosen value.
  56004. * (This does not account for contrast color grading and color curves as they are considered post effect and not directly
  56005. * part of lighting setup.)
  56006. */
  56007. get _perceptualColor(): Nullable<Color3>;
  56008. set _perceptualColor(value: Nullable<Color3>);
  56009. protected _primaryColorShadowLevel: float;
  56010. /**
  56011. * Defines the level of the shadows (dark area of the reflection map) in order to help scaling the colors.
  56012. * The color opposite to the primary color is used at the level chosen to define what the black area would look.
  56013. */
  56014. get primaryColorShadowLevel(): float;
  56015. set primaryColorShadowLevel(value: float);
  56016. protected _primaryColorHighlightLevel: float;
  56017. /**
  56018. * Defines the level of the highliights (highlight area of the reflection map) in order to help scaling the colors.
  56019. * The primary color is used at the level chosen to define what the white area would look.
  56020. */
  56021. get primaryColorHighlightLevel(): float;
  56022. set primaryColorHighlightLevel(value: float);
  56023. protected _reflectionTexture: Nullable<BaseTexture>;
  56024. /**
  56025. * Reflection Texture used in the material.
  56026. * Should be author in a specific way for the best result (refer to the documentation).
  56027. */
  56028. reflectionTexture: Nullable<BaseTexture>;
  56029. protected _reflectionBlur: float;
  56030. /**
  56031. * Reflection Texture level of blur.
  56032. *
  56033. * Can be use to reuse an existing HDR Texture and target a specific LOD to prevent authoring the
  56034. * texture twice.
  56035. */
  56036. reflectionBlur: float;
  56037. protected _diffuseTexture: Nullable<BaseTexture>;
  56038. /**
  56039. * Diffuse Texture used in the material.
  56040. * Should be author in a specific way for the best result (refer to the documentation).
  56041. */
  56042. diffuseTexture: Nullable<BaseTexture>;
  56043. protected _shadowLights: Nullable<IShadowLight[]>;
  56044. /**
  56045. * Specify the list of lights casting shadow on the material.
  56046. * All scene shadow lights will be included if null.
  56047. */
  56048. shadowLights: Nullable<IShadowLight[]>;
  56049. protected _shadowLevel: float;
  56050. /**
  56051. * Helps adjusting the shadow to a softer level if required.
  56052. * 0 means black shadows and 1 means no shadows.
  56053. */
  56054. shadowLevel: float;
  56055. protected _sceneCenter: Vector3;
  56056. /**
  56057. * In case of opacity Fresnel or reflection falloff, this is use as a scene center.
  56058. * It is usually zero but might be interesting to modify according to your setup.
  56059. */
  56060. sceneCenter: Vector3;
  56061. protected _opacityFresnel: boolean;
  56062. /**
  56063. * This helps specifying that the material is falling off to the sky box at grazing angle.
  56064. * This helps ensuring a nice transition when the camera goes under the ground.
  56065. */
  56066. opacityFresnel: boolean;
  56067. protected _reflectionFresnel: boolean;
  56068. /**
  56069. * This helps specifying that the material is falling off from diffuse to the reflection texture at grazing angle.
  56070. * This helps adding a mirror texture on the ground.
  56071. */
  56072. reflectionFresnel: boolean;
  56073. protected _reflectionFalloffDistance: number;
  56074. /**
  56075. * This helps specifying the falloff radius off the reflection texture from the sceneCenter.
  56076. * This helps adding a nice falloff effect to the reflection if used as a mirror for instance.
  56077. */
  56078. reflectionFalloffDistance: number;
  56079. protected _reflectionAmount: number;
  56080. /**
  56081. * This specifies the weight of the reflection against the background in case of reflection Fresnel.
  56082. */
  56083. reflectionAmount: number;
  56084. protected _reflectionReflectance0: number;
  56085. /**
  56086. * This specifies the weight of the reflection at grazing angle.
  56087. */
  56088. reflectionReflectance0: number;
  56089. protected _reflectionReflectance90: number;
  56090. /**
  56091. * This specifies the weight of the reflection at a perpendicular point of view.
  56092. */
  56093. reflectionReflectance90: number;
  56094. /**
  56095. * Sets the reflection reflectance fresnel values according to the default standard
  56096. * empirically know to work well :-)
  56097. */
  56098. set reflectionStandardFresnelWeight(value: number);
  56099. protected _useRGBColor: boolean;
  56100. /**
  56101. * Helps to directly use the maps channels instead of their level.
  56102. */
  56103. useRGBColor: boolean;
  56104. protected _enableNoise: boolean;
  56105. /**
  56106. * This helps reducing the banding effect that could occur on the background.
  56107. */
  56108. enableNoise: boolean;
  56109. /**
  56110. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  56111. * Best used when trying to implement visual zoom effects like fish-eye or binoculars while not adjusting camera fov.
  56112. * Recommended to be keep at 1.0 except for special cases.
  56113. */
  56114. get fovMultiplier(): number;
  56115. set fovMultiplier(value: number);
  56116. private _fovMultiplier;
  56117. /**
  56118. * Enable the FOV adjustment feature controlled by fovMultiplier.
  56119. */
  56120. useEquirectangularFOV: boolean;
  56121. private _maxSimultaneousLights;
  56122. /**
  56123. * Number of Simultaneous lights allowed on the material.
  56124. */
  56125. maxSimultaneousLights: int;
  56126. private _shadowOnly;
  56127. /**
  56128. * Make the material only render shadows
  56129. */
  56130. shadowOnly: boolean;
  56131. /**
  56132. * Default configuration related to image processing available in the Background Material.
  56133. */
  56134. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  56135. /**
  56136. * Keep track of the image processing observer to allow dispose and replace.
  56137. */
  56138. private _imageProcessingObserver;
  56139. /**
  56140. * Attaches a new image processing configuration to the PBR Material.
  56141. * @param configuration (if null the scene configuration will be use)
  56142. */
  56143. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  56144. /**
  56145. * Gets the image processing configuration used either in this material.
  56146. */
  56147. get imageProcessingConfiguration(): Nullable<ImageProcessingConfiguration>;
  56148. /**
  56149. * Sets the Default image processing configuration used either in the this material.
  56150. *
  56151. * If sets to null, the scene one is in use.
  56152. */
  56153. set imageProcessingConfiguration(value: Nullable<ImageProcessingConfiguration>);
  56154. /**
  56155. * Gets wether the color curves effect is enabled.
  56156. */
  56157. get cameraColorCurvesEnabled(): boolean;
  56158. /**
  56159. * Sets wether the color curves effect is enabled.
  56160. */
  56161. set cameraColorCurvesEnabled(value: boolean);
  56162. /**
  56163. * Gets wether the color grading effect is enabled.
  56164. */
  56165. get cameraColorGradingEnabled(): boolean;
  56166. /**
  56167. * Gets wether the color grading effect is enabled.
  56168. */
  56169. set cameraColorGradingEnabled(value: boolean);
  56170. /**
  56171. * Gets wether tonemapping is enabled or not.
  56172. */
  56173. get cameraToneMappingEnabled(): boolean;
  56174. /**
  56175. * Sets wether tonemapping is enabled or not
  56176. */
  56177. set cameraToneMappingEnabled(value: boolean);
  56178. /**
  56179. * The camera exposure used on this material.
  56180. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  56181. * This corresponds to a photographic exposure.
  56182. */
  56183. get cameraExposure(): float;
  56184. /**
  56185. * The camera exposure used on this material.
  56186. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  56187. * This corresponds to a photographic exposure.
  56188. */
  56189. set cameraExposure(value: float);
  56190. /**
  56191. * Gets The camera contrast used on this material.
  56192. */
  56193. get cameraContrast(): float;
  56194. /**
  56195. * Sets The camera contrast used on this material.
  56196. */
  56197. set cameraContrast(value: float);
  56198. /**
  56199. * Gets the Color Grading 2D Lookup Texture.
  56200. */
  56201. get cameraColorGradingTexture(): Nullable<BaseTexture>;
  56202. /**
  56203. * Sets the Color Grading 2D Lookup Texture.
  56204. */
  56205. set cameraColorGradingTexture(value: Nullable<BaseTexture>);
  56206. /**
  56207. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  56208. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  56209. * 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;
  56210. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  56211. */
  56212. get cameraColorCurves(): Nullable<ColorCurves>;
  56213. /**
  56214. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  56215. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  56216. * 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;
  56217. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  56218. */
  56219. set cameraColorCurves(value: Nullable<ColorCurves>);
  56220. /**
  56221. * Due to a bug in iOS10, video tags (which are using the background material) are in BGR and not RGB.
  56222. * Setting this flag to true (not done automatically!) will convert it back to RGB.
  56223. */
  56224. switchToBGR: boolean;
  56225. private _renderTargets;
  56226. private _reflectionControls;
  56227. private _white;
  56228. private _primaryShadowColor;
  56229. private _primaryHighlightColor;
  56230. /**
  56231. * Instantiates a Background Material in the given scene
  56232. * @param name The friendly name of the material
  56233. * @param scene The scene to add the material to
  56234. */
  56235. constructor(name: string, scene: Scene);
  56236. /**
  56237. * Gets a boolean indicating that current material needs to register RTT
  56238. */
  56239. get hasRenderTargetTextures(): boolean;
  56240. /**
  56241. * The entire material has been created in order to prevent overdraw.
  56242. * @returns false
  56243. */
  56244. needAlphaTesting(): boolean;
  56245. /**
  56246. * The entire material has been created in order to prevent overdraw.
  56247. * @returns true if blending is enable
  56248. */
  56249. needAlphaBlending(): boolean;
  56250. /**
  56251. * Checks wether the material is ready to be rendered for a given mesh.
  56252. * @param mesh The mesh to render
  56253. * @param subMesh The submesh to check against
  56254. * @param useInstances Specify wether or not the material is used with instances
  56255. * @returns true if all the dependencies are ready (Textures, Effects...)
  56256. */
  56257. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  56258. /**
  56259. * Compute the primary color according to the chosen perceptual color.
  56260. */
  56261. private _computePrimaryColorFromPerceptualColor;
  56262. /**
  56263. * Compute the highlights and shadow colors according to their chosen levels.
  56264. */
  56265. private _computePrimaryColors;
  56266. /**
  56267. * Build the uniform buffer used in the material.
  56268. */
  56269. buildUniformLayout(): void;
  56270. /**
  56271. * Unbind the material.
  56272. */
  56273. unbind(): void;
  56274. /**
  56275. * Bind only the world matrix to the material.
  56276. * @param world The world matrix to bind.
  56277. */
  56278. bindOnlyWorldMatrix(world: Matrix): void;
  56279. /**
  56280. * Bind the material for a dedicated submeh (every used meshes will be considered opaque).
  56281. * @param world The world matrix to bind.
  56282. * @param subMesh The submesh to bind for.
  56283. */
  56284. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  56285. /**
  56286. * Checks to see if a texture is used in the material.
  56287. * @param texture - Base texture to use.
  56288. * @returns - Boolean specifying if a texture is used in the material.
  56289. */
  56290. hasTexture(texture: BaseTexture): boolean;
  56291. /**
  56292. * Dispose the material.
  56293. * @param forceDisposeEffect Force disposal of the associated effect.
  56294. * @param forceDisposeTextures Force disposal of the associated textures.
  56295. */
  56296. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  56297. /**
  56298. * Clones the material.
  56299. * @param name The cloned name.
  56300. * @returns The cloned material.
  56301. */
  56302. clone(name: string): BackgroundMaterial;
  56303. /**
  56304. * Serializes the current material to its JSON representation.
  56305. * @returns The JSON representation.
  56306. */
  56307. serialize(): any;
  56308. /**
  56309. * Gets the class name of the material
  56310. * @returns "BackgroundMaterial"
  56311. */
  56312. getClassName(): string;
  56313. /**
  56314. * Parse a JSON input to create back a background material.
  56315. * @param source The JSON data to parse
  56316. * @param scene The scene to create the parsed material in
  56317. * @param rootUrl The root url of the assets the material depends upon
  56318. * @returns the instantiated BackgroundMaterial.
  56319. */
  56320. static Parse(source: any, scene: Scene, rootUrl: string): BackgroundMaterial;
  56321. }
  56322. }
  56323. declare module "babylonjs/Helpers/environmentHelper" {
  56324. import { Observable } from "babylonjs/Misc/observable";
  56325. import { Nullable } from "babylonjs/types";
  56326. import { Scene } from "babylonjs/scene";
  56327. import { Vector3 } from "babylonjs/Maths/math.vector";
  56328. import { Color3 } from "babylonjs/Maths/math.color";
  56329. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  56330. import { Mesh } from "babylonjs/Meshes/mesh";
  56331. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  56332. import { MirrorTexture } from "babylonjs/Materials/Textures/mirrorTexture";
  56333. import { BackgroundMaterial } from "babylonjs/Materials/Background/backgroundMaterial";
  56334. import "babylonjs/Meshes/Builders/planeBuilder";
  56335. import "babylonjs/Meshes/Builders/boxBuilder";
  56336. /**
  56337. * Represents the different options available during the creation of
  56338. * a Environment helper.
  56339. *
  56340. * This can control the default ground, skybox and image processing setup of your scene.
  56341. */
  56342. export interface IEnvironmentHelperOptions {
  56343. /**
  56344. * Specifies whether or not to create a ground.
  56345. * True by default.
  56346. */
  56347. createGround: boolean;
  56348. /**
  56349. * Specifies the ground size.
  56350. * 15 by default.
  56351. */
  56352. groundSize: number;
  56353. /**
  56354. * The texture used on the ground for the main color.
  56355. * Comes from the BabylonJS CDN by default.
  56356. *
  56357. * Remarks: Can be either a texture or a url.
  56358. */
  56359. groundTexture: string | BaseTexture;
  56360. /**
  56361. * The color mixed in the ground texture by default.
  56362. * BabylonJS clearColor by default.
  56363. */
  56364. groundColor: Color3;
  56365. /**
  56366. * Specifies the ground opacity.
  56367. * 1 by default.
  56368. */
  56369. groundOpacity: number;
  56370. /**
  56371. * Enables the ground to receive shadows.
  56372. * True by default.
  56373. */
  56374. enableGroundShadow: boolean;
  56375. /**
  56376. * Helps preventing the shadow to be fully black on the ground.
  56377. * 0.5 by default.
  56378. */
  56379. groundShadowLevel: number;
  56380. /**
  56381. * Creates a mirror texture attach to the ground.
  56382. * false by default.
  56383. */
  56384. enableGroundMirror: boolean;
  56385. /**
  56386. * Specifies the ground mirror size ratio.
  56387. * 0.3 by default as the default kernel is 64.
  56388. */
  56389. groundMirrorSizeRatio: number;
  56390. /**
  56391. * Specifies the ground mirror blur kernel size.
  56392. * 64 by default.
  56393. */
  56394. groundMirrorBlurKernel: number;
  56395. /**
  56396. * Specifies the ground mirror visibility amount.
  56397. * 1 by default
  56398. */
  56399. groundMirrorAmount: number;
  56400. /**
  56401. * Specifies the ground mirror reflectance weight.
  56402. * This uses the standard weight of the background material to setup the fresnel effect
  56403. * of the mirror.
  56404. * 1 by default.
  56405. */
  56406. groundMirrorFresnelWeight: number;
  56407. /**
  56408. * Specifies the ground mirror Falloff distance.
  56409. * This can helps reducing the size of the reflection.
  56410. * 0 by Default.
  56411. */
  56412. groundMirrorFallOffDistance: number;
  56413. /**
  56414. * Specifies the ground mirror texture type.
  56415. * Unsigned Int by Default.
  56416. */
  56417. groundMirrorTextureType: number;
  56418. /**
  56419. * Specifies a bias applied to the ground vertical position to prevent z-fighting with
  56420. * the shown objects.
  56421. */
  56422. groundYBias: number;
  56423. /**
  56424. * Specifies whether or not to create a skybox.
  56425. * True by default.
  56426. */
  56427. createSkybox: boolean;
  56428. /**
  56429. * Specifies the skybox size.
  56430. * 20 by default.
  56431. */
  56432. skyboxSize: number;
  56433. /**
  56434. * The texture used on the skybox for the main color.
  56435. * Comes from the BabylonJS CDN by default.
  56436. *
  56437. * Remarks: Can be either a texture or a url.
  56438. */
  56439. skyboxTexture: string | BaseTexture;
  56440. /**
  56441. * The color mixed in the skybox texture by default.
  56442. * BabylonJS clearColor by default.
  56443. */
  56444. skyboxColor: Color3;
  56445. /**
  56446. * The background rotation around the Y axis of the scene.
  56447. * This helps aligning the key lights of your scene with the background.
  56448. * 0 by default.
  56449. */
  56450. backgroundYRotation: number;
  56451. /**
  56452. * Compute automatically the size of the elements to best fit with the scene.
  56453. */
  56454. sizeAuto: boolean;
  56455. /**
  56456. * Default position of the rootMesh if autoSize is not true.
  56457. */
  56458. rootPosition: Vector3;
  56459. /**
  56460. * Sets up the image processing in the scene.
  56461. * true by default.
  56462. */
  56463. setupImageProcessing: boolean;
  56464. /**
  56465. * The texture used as your environment texture in the scene.
  56466. * Comes from the BabylonJS CDN by default and in use if setupImageProcessing is true.
  56467. *
  56468. * Remarks: Can be either a texture or a url.
  56469. */
  56470. environmentTexture: string | BaseTexture;
  56471. /**
  56472. * The value of the exposure to apply to the scene.
  56473. * 0.6 by default if setupImageProcessing is true.
  56474. */
  56475. cameraExposure: number;
  56476. /**
  56477. * The value of the contrast to apply to the scene.
  56478. * 1.6 by default if setupImageProcessing is true.
  56479. */
  56480. cameraContrast: number;
  56481. /**
  56482. * Specifies whether or not tonemapping should be enabled in the scene.
  56483. * true by default if setupImageProcessing is true.
  56484. */
  56485. toneMappingEnabled: boolean;
  56486. }
  56487. /**
  56488. * The Environment helper class can be used to add a fully featuread none expensive background to your scene.
  56489. * It includes by default a skybox and a ground relying on the BackgroundMaterial.
  56490. * It also helps with the default setup of your imageProcessing configuration.
  56491. */
  56492. export class EnvironmentHelper {
  56493. /**
  56494. * Default ground texture URL.
  56495. */
  56496. private static _groundTextureCDNUrl;
  56497. /**
  56498. * Default skybox texture URL.
  56499. */
  56500. private static _skyboxTextureCDNUrl;
  56501. /**
  56502. * Default environment texture URL.
  56503. */
  56504. private static _environmentTextureCDNUrl;
  56505. /**
  56506. * Creates the default options for the helper.
  56507. */
  56508. private static _getDefaultOptions;
  56509. private _rootMesh;
  56510. /**
  56511. * Gets the root mesh created by the helper.
  56512. */
  56513. get rootMesh(): Mesh;
  56514. private _skybox;
  56515. /**
  56516. * Gets the skybox created by the helper.
  56517. */
  56518. get skybox(): Nullable<Mesh>;
  56519. private _skyboxTexture;
  56520. /**
  56521. * Gets the skybox texture created by the helper.
  56522. */
  56523. get skyboxTexture(): Nullable<BaseTexture>;
  56524. private _skyboxMaterial;
  56525. /**
  56526. * Gets the skybox material created by the helper.
  56527. */
  56528. get skyboxMaterial(): Nullable<BackgroundMaterial>;
  56529. private _ground;
  56530. /**
  56531. * Gets the ground mesh created by the helper.
  56532. */
  56533. get ground(): Nullable<Mesh>;
  56534. private _groundTexture;
  56535. /**
  56536. * Gets the ground texture created by the helper.
  56537. */
  56538. get groundTexture(): Nullable<BaseTexture>;
  56539. private _groundMirror;
  56540. /**
  56541. * Gets the ground mirror created by the helper.
  56542. */
  56543. get groundMirror(): Nullable<MirrorTexture>;
  56544. /**
  56545. * Gets the ground mirror render list to helps pushing the meshes
  56546. * you wish in the ground reflection.
  56547. */
  56548. get groundMirrorRenderList(): Nullable<AbstractMesh[]>;
  56549. private _groundMaterial;
  56550. /**
  56551. * Gets the ground material created by the helper.
  56552. */
  56553. get groundMaterial(): Nullable<BackgroundMaterial>;
  56554. /**
  56555. * Stores the creation options.
  56556. */
  56557. private readonly _scene;
  56558. private _options;
  56559. /**
  56560. * This observable will be notified with any error during the creation of the environment,
  56561. * mainly texture creation errors.
  56562. */
  56563. onErrorObservable: Observable<{
  56564. message?: string;
  56565. exception?: any;
  56566. }>;
  56567. /**
  56568. * constructor
  56569. * @param options Defines the options we want to customize the helper
  56570. * @param scene The scene to add the material to
  56571. */
  56572. constructor(options: Partial<IEnvironmentHelperOptions>, scene: Scene);
  56573. /**
  56574. * Updates the background according to the new options
  56575. * @param options
  56576. */
  56577. updateOptions(options: Partial<IEnvironmentHelperOptions>): void;
  56578. /**
  56579. * Sets the primary color of all the available elements.
  56580. * @param color the main color to affect to the ground and the background
  56581. */
  56582. setMainColor(color: Color3): void;
  56583. /**
  56584. * Setup the image processing according to the specified options.
  56585. */
  56586. private _setupImageProcessing;
  56587. /**
  56588. * Setup the environment texture according to the specified options.
  56589. */
  56590. private _setupEnvironmentTexture;
  56591. /**
  56592. * Setup the background according to the specified options.
  56593. */
  56594. private _setupBackground;
  56595. /**
  56596. * Get the scene sizes according to the setup.
  56597. */
  56598. private _getSceneSize;
  56599. /**
  56600. * Setup the ground according to the specified options.
  56601. */
  56602. private _setupGround;
  56603. /**
  56604. * Setup the ground material according to the specified options.
  56605. */
  56606. private _setupGroundMaterial;
  56607. /**
  56608. * Setup the ground diffuse texture according to the specified options.
  56609. */
  56610. private _setupGroundDiffuseTexture;
  56611. /**
  56612. * Setup the ground mirror texture according to the specified options.
  56613. */
  56614. private _setupGroundMirrorTexture;
  56615. /**
  56616. * Setup the ground to receive the mirror texture.
  56617. */
  56618. private _setupMirrorInGroundMaterial;
  56619. /**
  56620. * Setup the skybox according to the specified options.
  56621. */
  56622. private _setupSkybox;
  56623. /**
  56624. * Setup the skybox material according to the specified options.
  56625. */
  56626. private _setupSkyboxMaterial;
  56627. /**
  56628. * Setup the skybox reflection texture according to the specified options.
  56629. */
  56630. private _setupSkyboxReflectionTexture;
  56631. private _errorHandler;
  56632. /**
  56633. * Dispose all the elements created by the Helper.
  56634. */
  56635. dispose(): void;
  56636. }
  56637. }
  56638. declare module "babylonjs/Helpers/photoDome" {
  56639. import { Observable } from "babylonjs/Misc/observable";
  56640. import { Nullable } from "babylonjs/types";
  56641. import { Scene } from "babylonjs/scene";
  56642. import { TransformNode } from "babylonjs/Meshes/transformNode";
  56643. import { Mesh } from "babylonjs/Meshes/mesh";
  56644. import { Texture } from "babylonjs/Materials/Textures/texture";
  56645. import { BackgroundMaterial } from "babylonjs/Materials/Background/backgroundMaterial";
  56646. import "babylonjs/Meshes/Builders/sphereBuilder";
  56647. /**
  56648. * Display a 360 degree photo on an approximately spherical surface, useful for VR applications or skyboxes.
  56649. * As a subclass of TransformNode, this allow parenting to the camera with different locations in the scene.
  56650. * This class achieves its effect with a Texture and a correctly configured BackgroundMaterial on an inverted sphere.
  56651. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  56652. */
  56653. export class PhotoDome extends TransformNode {
  56654. /**
  56655. * Define the image as a Monoscopic panoramic 360 image.
  56656. */
  56657. static readonly MODE_MONOSCOPIC: number;
  56658. /**
  56659. * Define the image as a Stereoscopic TopBottom/OverUnder panoramic 360 image.
  56660. */
  56661. static readonly MODE_TOPBOTTOM: number;
  56662. /**
  56663. * Define the image as a Stereoscopic Side by Side panoramic 360 image.
  56664. */
  56665. static readonly MODE_SIDEBYSIDE: number;
  56666. private _useDirectMapping;
  56667. /**
  56668. * The texture being displayed on the sphere
  56669. */
  56670. protected _photoTexture: Texture;
  56671. /**
  56672. * Gets or sets the texture being displayed on the sphere
  56673. */
  56674. get photoTexture(): Texture;
  56675. set photoTexture(value: Texture);
  56676. /**
  56677. * Observable raised when an error occured while loading the 360 image
  56678. */
  56679. onLoadErrorObservable: Observable<string>;
  56680. /**
  56681. * The skybox material
  56682. */
  56683. protected _material: BackgroundMaterial;
  56684. /**
  56685. * The surface used for the skybox
  56686. */
  56687. protected _mesh: Mesh;
  56688. /**
  56689. * Gets the mesh used for the skybox.
  56690. */
  56691. get mesh(): Mesh;
  56692. /**
  56693. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  56694. * Also see the options.resolution property.
  56695. */
  56696. get fovMultiplier(): number;
  56697. set fovMultiplier(value: number);
  56698. private _imageMode;
  56699. /**
  56700. * Gets or set the current video mode for the video. It can be:
  56701. * * PhotoDome.MODE_MONOSCOPIC : Define the image as a Monoscopic panoramic 360 image.
  56702. * * PhotoDome.MODE_TOPBOTTOM : Define the image as a Stereoscopic TopBottom/OverUnder panoramic 360 image.
  56703. * * PhotoDome.MODE_SIDEBYSIDE : Define the image as a Stereoscopic Side by Side panoramic 360 image.
  56704. */
  56705. get imageMode(): number;
  56706. set imageMode(value: number);
  56707. /**
  56708. * Create an instance of this class and pass through the parameters to the relevant classes, Texture, StandardMaterial, and Mesh.
  56709. * @param name Element's name, child elements will append suffixes for their own names.
  56710. * @param urlsOfPhoto defines the url of the photo to display
  56711. * @param options defines an object containing optional or exposed sub element properties
  56712. * @param onError defines a callback called when an error occured while loading the texture
  56713. */
  56714. constructor(name: string, urlOfPhoto: string, options: {
  56715. resolution?: number;
  56716. size?: number;
  56717. useDirectMapping?: boolean;
  56718. faceForward?: boolean;
  56719. }, scene: Scene, onError?: Nullable<(message?: string, exception?: any) => void>);
  56720. private _onBeforeCameraRenderObserver;
  56721. private _changeImageMode;
  56722. /**
  56723. * Releases resources associated with this node.
  56724. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  56725. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  56726. */
  56727. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  56728. }
  56729. }
  56730. declare module "babylonjs/Misc/rgbdTextureTools" {
  56731. import "babylonjs/Shaders/rgbdDecode.fragment";
  56732. import "babylonjs/Engines/Extensions/engine.renderTarget";
  56733. import { Texture } from "babylonjs/Materials/Textures/texture";
  56734. /**
  56735. * Class used to host RGBD texture specific utilities
  56736. */
  56737. export class RGBDTextureTools {
  56738. /**
  56739. * Expand the RGBD Texture from RGBD to Half Float if possible.
  56740. * @param texture the texture to expand.
  56741. */
  56742. static ExpandRGBDTexture(texture: Texture): void;
  56743. }
  56744. }
  56745. declare module "babylonjs/Misc/brdfTextureTools" {
  56746. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  56747. import { Scene } from "babylonjs/scene";
  56748. /**
  56749. * Class used to host texture specific utilities
  56750. */
  56751. export class BRDFTextureTools {
  56752. /**
  56753. * Prevents texture cache collision
  56754. */
  56755. private static _instanceNumber;
  56756. /**
  56757. * Gets a default environment BRDF for MS-BRDF Height Correlated BRDF
  56758. * @param scene defines the hosting scene
  56759. * @returns the environment BRDF texture
  56760. */
  56761. static GetEnvironmentBRDFTexture(scene: Scene): BaseTexture;
  56762. private static _environmentBRDFBase64Texture;
  56763. }
  56764. }
  56765. declare module "babylonjs/Materials/PBR/pbrClearCoatConfiguration" {
  56766. import { Nullable } from "babylonjs/types";
  56767. import { Color3 } from "babylonjs/Maths/math.color";
  56768. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  56769. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  56770. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  56771. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  56772. import { Engine } from "babylonjs/Engines/engine";
  56773. import { Scene } from "babylonjs/scene";
  56774. /**
  56775. * @hidden
  56776. */
  56777. export interface IMaterialClearCoatDefines {
  56778. CLEARCOAT: boolean;
  56779. CLEARCOAT_DEFAULTIOR: boolean;
  56780. CLEARCOAT_TEXTURE: boolean;
  56781. CLEARCOAT_TEXTUREDIRECTUV: number;
  56782. CLEARCOAT_BUMP: boolean;
  56783. CLEARCOAT_BUMPDIRECTUV: number;
  56784. CLEARCOAT_TINT: boolean;
  56785. CLEARCOAT_TINT_TEXTURE: boolean;
  56786. CLEARCOAT_TINT_TEXTUREDIRECTUV: number;
  56787. /** @hidden */
  56788. _areTexturesDirty: boolean;
  56789. }
  56790. /**
  56791. * Define the code related to the clear coat parameters of the pbr material.
  56792. */
  56793. export class PBRClearCoatConfiguration {
  56794. /**
  56795. * This defaults to 1.5 corresponding to a 0.04 f0 or a 4% reflectance at normal incidence
  56796. * The default fits with a polyurethane material.
  56797. */
  56798. private static readonly _DefaultIndexOfRefraction;
  56799. private _isEnabled;
  56800. /**
  56801. * Defines if the clear coat is enabled in the material.
  56802. */
  56803. isEnabled: boolean;
  56804. /**
  56805. * Defines the clear coat layer strength (between 0 and 1) it defaults to 1.
  56806. */
  56807. intensity: number;
  56808. /**
  56809. * Defines the clear coat layer roughness.
  56810. */
  56811. roughness: number;
  56812. private _indexOfRefraction;
  56813. /**
  56814. * Defines the index of refraction of the clear coat.
  56815. * This defaults to 1.5 corresponding to a 0.04 f0 or a 4% reflectance at normal incidence
  56816. * The default fits with a polyurethane material.
  56817. * Changing the default value is more performance intensive.
  56818. */
  56819. indexOfRefraction: number;
  56820. private _texture;
  56821. /**
  56822. * Stores the clear coat values in a texture.
  56823. */
  56824. texture: Nullable<BaseTexture>;
  56825. private _bumpTexture;
  56826. /**
  56827. * Define the clear coat specific bump texture.
  56828. */
  56829. bumpTexture: Nullable<BaseTexture>;
  56830. private _isTintEnabled;
  56831. /**
  56832. * Defines if the clear coat tint is enabled in the material.
  56833. */
  56834. isTintEnabled: boolean;
  56835. /**
  56836. * Defines the clear coat tint of the material.
  56837. * This is only use if tint is enabled
  56838. */
  56839. tintColor: Color3;
  56840. /**
  56841. * Defines the distance at which the tint color should be found in the
  56842. * clear coat media.
  56843. * This is only use if tint is enabled
  56844. */
  56845. tintColorAtDistance: number;
  56846. /**
  56847. * Defines the clear coat layer thickness.
  56848. * This is only use if tint is enabled
  56849. */
  56850. tintThickness: number;
  56851. private _tintTexture;
  56852. /**
  56853. * Stores the clear tint values in a texture.
  56854. * rgb is tint
  56855. * a is a thickness factor
  56856. */
  56857. tintTexture: Nullable<BaseTexture>;
  56858. /** @hidden */
  56859. private _internalMarkAllSubMeshesAsTexturesDirty;
  56860. /** @hidden */
  56861. _markAllSubMeshesAsTexturesDirty(): void;
  56862. /**
  56863. * Instantiate a new istance of clear coat configuration.
  56864. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  56865. */
  56866. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  56867. /**
  56868. * Gets wehter the submesh is ready to be used or not.
  56869. * @param defines the list of "defines" to update.
  56870. * @param scene defines the scene the material belongs to.
  56871. * @param engine defines the engine the material belongs to.
  56872. * @param disableBumpMap defines wether the material disables bump or not.
  56873. * @returns - boolean indicating that the submesh is ready or not.
  56874. */
  56875. isReadyForSubMesh(defines: IMaterialClearCoatDefines, scene: Scene, engine: Engine, disableBumpMap: boolean): boolean;
  56876. /**
  56877. * Checks to see if a texture is used in the material.
  56878. * @param defines the list of "defines" to update.
  56879. * @param scene defines the scene to the material belongs to.
  56880. */
  56881. prepareDefines(defines: IMaterialClearCoatDefines, scene: Scene): void;
  56882. /**
  56883. * Binds the material data.
  56884. * @param uniformBuffer defines the Uniform buffer to fill in.
  56885. * @param scene defines the scene the material belongs to.
  56886. * @param engine defines the engine the material belongs to.
  56887. * @param disableBumpMap defines wether the material disables bump or not.
  56888. * @param isFrozen defines wether the material is frozen or not.
  56889. * @param invertNormalMapX If sets to true, x component of normal map value will be inverted (x = 1.0 - x).
  56890. * @param invertNormalMapY If sets to true, y component of normal map value will be inverted (y = 1.0 - y).
  56891. */
  56892. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, engine: Engine, disableBumpMap: boolean, isFrozen: boolean, invertNormalMapX: boolean, invertNormalMapY: boolean): void;
  56893. /**
  56894. * Checks to see if a texture is used in the material.
  56895. * @param texture - Base texture to use.
  56896. * @returns - Boolean specifying if a texture is used in the material.
  56897. */
  56898. hasTexture(texture: BaseTexture): boolean;
  56899. /**
  56900. * Returns an array of the actively used textures.
  56901. * @param activeTextures Array of BaseTextures
  56902. */
  56903. getActiveTextures(activeTextures: BaseTexture[]): void;
  56904. /**
  56905. * Returns the animatable textures.
  56906. * @param animatables Array of animatable textures.
  56907. */
  56908. getAnimatables(animatables: IAnimatable[]): void;
  56909. /**
  56910. * Disposes the resources of the material.
  56911. * @param forceDisposeTextures - Forces the disposal of all textures.
  56912. */
  56913. dispose(forceDisposeTextures?: boolean): void;
  56914. /**
  56915. * Get the current class name of the texture useful for serialization or dynamic coding.
  56916. * @returns "PBRClearCoatConfiguration"
  56917. */
  56918. getClassName(): string;
  56919. /**
  56920. * Add fallbacks to the effect fallbacks list.
  56921. * @param defines defines the Base texture to use.
  56922. * @param fallbacks defines the current fallback list.
  56923. * @param currentRank defines the current fallback rank.
  56924. * @returns the new fallback rank.
  56925. */
  56926. static AddFallbacks(defines: IMaterialClearCoatDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  56927. /**
  56928. * Add the required uniforms to the current list.
  56929. * @param uniforms defines the current uniform list.
  56930. */
  56931. static AddUniforms(uniforms: string[]): void;
  56932. /**
  56933. * Add the required samplers to the current list.
  56934. * @param samplers defines the current sampler list.
  56935. */
  56936. static AddSamplers(samplers: string[]): void;
  56937. /**
  56938. * Add the required uniforms to the current buffer.
  56939. * @param uniformBuffer defines the current uniform buffer.
  56940. */
  56941. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  56942. /**
  56943. * Makes a duplicate of the current configuration into another one.
  56944. * @param clearCoatConfiguration define the config where to copy the info
  56945. */
  56946. copyTo(clearCoatConfiguration: PBRClearCoatConfiguration): void;
  56947. /**
  56948. * Serializes this clear coat configuration.
  56949. * @returns - An object with the serialized config.
  56950. */
  56951. serialize(): any;
  56952. /**
  56953. * Parses a anisotropy Configuration from a serialized object.
  56954. * @param source - Serialized object.
  56955. * @param scene Defines the scene we are parsing for
  56956. * @param rootUrl Defines the rootUrl to load from
  56957. */
  56958. parse(source: any, scene: Scene, rootUrl: string): void;
  56959. }
  56960. }
  56961. declare module "babylonjs/Materials/PBR/pbrAnisotropicConfiguration" {
  56962. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  56963. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  56964. import { Vector2 } from "babylonjs/Maths/math.vector";
  56965. import { Scene } from "babylonjs/scene";
  56966. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  56967. import { Nullable } from "babylonjs/types";
  56968. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  56969. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  56970. /**
  56971. * @hidden
  56972. */
  56973. export interface IMaterialAnisotropicDefines {
  56974. ANISOTROPIC: boolean;
  56975. ANISOTROPIC_TEXTURE: boolean;
  56976. ANISOTROPIC_TEXTUREDIRECTUV: number;
  56977. MAINUV1: boolean;
  56978. _areTexturesDirty: boolean;
  56979. _needUVs: boolean;
  56980. }
  56981. /**
  56982. * Define the code related to the anisotropic parameters of the pbr material.
  56983. */
  56984. export class PBRAnisotropicConfiguration {
  56985. private _isEnabled;
  56986. /**
  56987. * Defines if the anisotropy is enabled in the material.
  56988. */
  56989. isEnabled: boolean;
  56990. /**
  56991. * Defines the anisotropy strength (between 0 and 1) it defaults to 1.
  56992. */
  56993. intensity: number;
  56994. /**
  56995. * Defines if the effect is along the tangents, bitangents or in between.
  56996. * By default, the effect is "strectching" the highlights along the tangents.
  56997. */
  56998. direction: Vector2;
  56999. private _texture;
  57000. /**
  57001. * Stores the anisotropy values in a texture.
  57002. * rg is direction (like normal from -1 to 1)
  57003. * b is a intensity
  57004. */
  57005. texture: Nullable<BaseTexture>;
  57006. /** @hidden */
  57007. private _internalMarkAllSubMeshesAsTexturesDirty;
  57008. /** @hidden */
  57009. _markAllSubMeshesAsTexturesDirty(): void;
  57010. /**
  57011. * Instantiate a new istance of anisotropy configuration.
  57012. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  57013. */
  57014. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  57015. /**
  57016. * Specifies that the submesh is ready to be used.
  57017. * @param defines the list of "defines" to update.
  57018. * @param scene defines the scene the material belongs to.
  57019. * @returns - boolean indicating that the submesh is ready or not.
  57020. */
  57021. isReadyForSubMesh(defines: IMaterialAnisotropicDefines, scene: Scene): boolean;
  57022. /**
  57023. * Checks to see if a texture is used in the material.
  57024. * @param defines the list of "defines" to update.
  57025. * @param mesh the mesh we are preparing the defines for.
  57026. * @param scene defines the scene the material belongs to.
  57027. */
  57028. prepareDefines(defines: IMaterialAnisotropicDefines, mesh: AbstractMesh, scene: Scene): void;
  57029. /**
  57030. * Binds the material data.
  57031. * @param uniformBuffer defines the Uniform buffer to fill in.
  57032. * @param scene defines the scene the material belongs to.
  57033. * @param isFrozen defines wether the material is frozen or not.
  57034. */
  57035. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  57036. /**
  57037. * Checks to see if a texture is used in the material.
  57038. * @param texture - Base texture to use.
  57039. * @returns - Boolean specifying if a texture is used in the material.
  57040. */
  57041. hasTexture(texture: BaseTexture): boolean;
  57042. /**
  57043. * Returns an array of the actively used textures.
  57044. * @param activeTextures Array of BaseTextures
  57045. */
  57046. getActiveTextures(activeTextures: BaseTexture[]): void;
  57047. /**
  57048. * Returns the animatable textures.
  57049. * @param animatables Array of animatable textures.
  57050. */
  57051. getAnimatables(animatables: IAnimatable[]): void;
  57052. /**
  57053. * Disposes the resources of the material.
  57054. * @param forceDisposeTextures - Forces the disposal of all textures.
  57055. */
  57056. dispose(forceDisposeTextures?: boolean): void;
  57057. /**
  57058. * Get the current class name of the texture useful for serialization or dynamic coding.
  57059. * @returns "PBRAnisotropicConfiguration"
  57060. */
  57061. getClassName(): string;
  57062. /**
  57063. * Add fallbacks to the effect fallbacks list.
  57064. * @param defines defines the Base texture to use.
  57065. * @param fallbacks defines the current fallback list.
  57066. * @param currentRank defines the current fallback rank.
  57067. * @returns the new fallback rank.
  57068. */
  57069. static AddFallbacks(defines: IMaterialAnisotropicDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  57070. /**
  57071. * Add the required uniforms to the current list.
  57072. * @param uniforms defines the current uniform list.
  57073. */
  57074. static AddUniforms(uniforms: string[]): void;
  57075. /**
  57076. * Add the required uniforms to the current buffer.
  57077. * @param uniformBuffer defines the current uniform buffer.
  57078. */
  57079. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  57080. /**
  57081. * Add the required samplers to the current list.
  57082. * @param samplers defines the current sampler list.
  57083. */
  57084. static AddSamplers(samplers: string[]): void;
  57085. /**
  57086. * Makes a duplicate of the current configuration into another one.
  57087. * @param anisotropicConfiguration define the config where to copy the info
  57088. */
  57089. copyTo(anisotropicConfiguration: PBRAnisotropicConfiguration): void;
  57090. /**
  57091. * Serializes this anisotropy configuration.
  57092. * @returns - An object with the serialized config.
  57093. */
  57094. serialize(): any;
  57095. /**
  57096. * Parses a anisotropy Configuration from a serialized object.
  57097. * @param source - Serialized object.
  57098. * @param scene Defines the scene we are parsing for
  57099. * @param rootUrl Defines the rootUrl to load from
  57100. */
  57101. parse(source: any, scene: Scene, rootUrl: string): void;
  57102. }
  57103. }
  57104. declare module "babylonjs/Materials/PBR/pbrBRDFConfiguration" {
  57105. import { Scene } from "babylonjs/scene";
  57106. /**
  57107. * @hidden
  57108. */
  57109. export interface IMaterialBRDFDefines {
  57110. BRDF_V_HEIGHT_CORRELATED: boolean;
  57111. MS_BRDF_ENERGY_CONSERVATION: boolean;
  57112. SPHERICAL_HARMONICS: boolean;
  57113. SPECULAR_GLOSSINESS_ENERGY_CONSERVATION: boolean;
  57114. /** @hidden */
  57115. _areMiscDirty: boolean;
  57116. }
  57117. /**
  57118. * Define the code related to the BRDF parameters of the pbr material.
  57119. */
  57120. export class PBRBRDFConfiguration {
  57121. /**
  57122. * Default value used for the energy conservation.
  57123. * This should only be changed to adapt to the type of texture in scene.environmentBRDFTexture.
  57124. */
  57125. static DEFAULT_USE_ENERGY_CONSERVATION: boolean;
  57126. /**
  57127. * Default value used for the Smith Visibility Height Correlated mode.
  57128. * This should only be changed to adapt to the type of texture in scene.environmentBRDFTexture.
  57129. */
  57130. static DEFAULT_USE_SMITH_VISIBILITY_HEIGHT_CORRELATED: boolean;
  57131. /**
  57132. * Default value used for the IBL diffuse part.
  57133. * This can help switching back to the polynomials mode globally which is a tiny bit
  57134. * less GPU intensive at the drawback of a lower quality.
  57135. */
  57136. static DEFAULT_USE_SPHERICAL_HARMONICS: boolean;
  57137. /**
  57138. * Default value used for activating energy conservation for the specular workflow.
  57139. * If activated, the albedo color is multiplied with (1. - maxChannel(specular color)).
  57140. * If deactivated, a material is only physically plausible, when (albedo color + specular color) < 1.
  57141. */
  57142. static DEFAULT_USE_SPECULAR_GLOSSINESS_INPUT_ENERGY_CONSERVATION: boolean;
  57143. private _useEnergyConservation;
  57144. /**
  57145. * Defines if the material uses energy conservation.
  57146. */
  57147. useEnergyConservation: boolean;
  57148. private _useSmithVisibilityHeightCorrelated;
  57149. /**
  57150. * LEGACY Mode set to false
  57151. * Defines if the material uses height smith correlated visibility term.
  57152. * If you intent to not use our default BRDF, you need to load a separate BRDF Texture for the PBR
  57153. * You can either load https://assets.babylonjs.com/environments/uncorrelatedBRDF.png
  57154. * or https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds to have more precision
  57155. * Not relying on height correlated will also disable energy conservation.
  57156. */
  57157. useSmithVisibilityHeightCorrelated: boolean;
  57158. private _useSphericalHarmonics;
  57159. /**
  57160. * LEGACY Mode set to false
  57161. * Defines if the material uses spherical harmonics vs spherical polynomials for the
  57162. * diffuse part of the IBL.
  57163. * The harmonics despite a tiny bigger cost has been proven to provide closer results
  57164. * to the ground truth.
  57165. */
  57166. useSphericalHarmonics: boolean;
  57167. private _useSpecularGlossinessInputEnergyConservation;
  57168. /**
  57169. * Defines if the material uses energy conservation, when the specular workflow is active.
  57170. * If activated, the albedo color is multiplied with (1. - maxChannel(specular color)).
  57171. * If deactivated, a material is only physically plausible, when (albedo color + specular color) < 1.
  57172. * In the deactivated case, the material author has to ensure energy conservation, for a physically plausible rendering.
  57173. */
  57174. useSpecularGlossinessInputEnergyConservation: boolean;
  57175. /** @hidden */
  57176. private _internalMarkAllSubMeshesAsMiscDirty;
  57177. /** @hidden */
  57178. _markAllSubMeshesAsMiscDirty(): void;
  57179. /**
  57180. * Instantiate a new istance of clear coat configuration.
  57181. * @param markAllSubMeshesAsMiscDirty Callback to flag the material to dirty
  57182. */
  57183. constructor(markAllSubMeshesAsMiscDirty: () => void);
  57184. /**
  57185. * Checks to see if a texture is used in the material.
  57186. * @param defines the list of "defines" to update.
  57187. */
  57188. prepareDefines(defines: IMaterialBRDFDefines): void;
  57189. /**
  57190. * Get the current class name of the texture useful for serialization or dynamic coding.
  57191. * @returns "PBRClearCoatConfiguration"
  57192. */
  57193. getClassName(): string;
  57194. /**
  57195. * Makes a duplicate of the current configuration into another one.
  57196. * @param brdfConfiguration define the config where to copy the info
  57197. */
  57198. copyTo(brdfConfiguration: PBRBRDFConfiguration): void;
  57199. /**
  57200. * Serializes this BRDF configuration.
  57201. * @returns - An object with the serialized config.
  57202. */
  57203. serialize(): any;
  57204. /**
  57205. * Parses a anisotropy Configuration from a serialized object.
  57206. * @param source - Serialized object.
  57207. * @param scene Defines the scene we are parsing for
  57208. * @param rootUrl Defines the rootUrl to load from
  57209. */
  57210. parse(source: any, scene: Scene, rootUrl: string): void;
  57211. }
  57212. }
  57213. declare module "babylonjs/Materials/PBR/pbrSheenConfiguration" {
  57214. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  57215. import { Color3 } from "babylonjs/Maths/math.color";
  57216. import { Scene } from "babylonjs/scene";
  57217. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  57218. import { Nullable } from "babylonjs/types";
  57219. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  57220. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  57221. /**
  57222. * @hidden
  57223. */
  57224. export interface IMaterialSheenDefines {
  57225. SHEEN: boolean;
  57226. SHEEN_TEXTURE: boolean;
  57227. SHEEN_TEXTUREDIRECTUV: number;
  57228. SHEEN_LINKWITHALBEDO: boolean;
  57229. SHEEN_ROUGHNESS: boolean;
  57230. SHEEN_ALBEDOSCALING: boolean;
  57231. /** @hidden */
  57232. _areTexturesDirty: boolean;
  57233. }
  57234. /**
  57235. * Define the code related to the Sheen parameters of the pbr material.
  57236. */
  57237. export class PBRSheenConfiguration {
  57238. private _isEnabled;
  57239. /**
  57240. * Defines if the material uses sheen.
  57241. */
  57242. isEnabled: boolean;
  57243. private _linkSheenWithAlbedo;
  57244. /**
  57245. * Defines if the sheen is linked to the sheen color.
  57246. */
  57247. linkSheenWithAlbedo: boolean;
  57248. /**
  57249. * Defines the sheen intensity.
  57250. */
  57251. intensity: number;
  57252. /**
  57253. * Defines the sheen color.
  57254. */
  57255. color: Color3;
  57256. private _texture;
  57257. /**
  57258. * Stores the sheen tint values in a texture.
  57259. * rgb is tint
  57260. * a is a intensity or roughness if roughness has been defined
  57261. */
  57262. texture: Nullable<BaseTexture>;
  57263. private _roughness;
  57264. /**
  57265. * Defines the sheen roughness.
  57266. * It is not taken into account if linkSheenWithAlbedo is true.
  57267. * To stay backward compatible, material roughness is used instead if sheen roughness = null
  57268. */
  57269. roughness: Nullable<number>;
  57270. private _albedoScaling;
  57271. /**
  57272. * If true, the sheen effect is layered above the base BRDF with the albedo-scaling technique.
  57273. * It allows the strength of the sheen effect to not depend on the base color of the material,
  57274. * making it easier to setup and tweak the effect
  57275. */
  57276. albedoScaling: boolean;
  57277. /** @hidden */
  57278. private _internalMarkAllSubMeshesAsTexturesDirty;
  57279. /** @hidden */
  57280. _markAllSubMeshesAsTexturesDirty(): void;
  57281. /**
  57282. * Instantiate a new istance of clear coat configuration.
  57283. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  57284. */
  57285. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  57286. /**
  57287. * Specifies that the submesh is ready to be used.
  57288. * @param defines the list of "defines" to update.
  57289. * @param scene defines the scene the material belongs to.
  57290. * @returns - boolean indicating that the submesh is ready or not.
  57291. */
  57292. isReadyForSubMesh(defines: IMaterialSheenDefines, scene: Scene): boolean;
  57293. /**
  57294. * Checks to see if a texture is used in the material.
  57295. * @param defines the list of "defines" to update.
  57296. * @param scene defines the scene the material belongs to.
  57297. */
  57298. prepareDefines(defines: IMaterialSheenDefines, scene: Scene): void;
  57299. /**
  57300. * Binds the material data.
  57301. * @param uniformBuffer defines the Uniform buffer to fill in.
  57302. * @param scene defines the scene the material belongs to.
  57303. * @param isFrozen defines wether the material is frozen or not.
  57304. */
  57305. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  57306. /**
  57307. * Checks to see if a texture is used in the material.
  57308. * @param texture - Base texture to use.
  57309. * @returns - Boolean specifying if a texture is used in the material.
  57310. */
  57311. hasTexture(texture: BaseTexture): boolean;
  57312. /**
  57313. * Returns an array of the actively used textures.
  57314. * @param activeTextures Array of BaseTextures
  57315. */
  57316. getActiveTextures(activeTextures: BaseTexture[]): void;
  57317. /**
  57318. * Returns the animatable textures.
  57319. * @param animatables Array of animatable textures.
  57320. */
  57321. getAnimatables(animatables: IAnimatable[]): void;
  57322. /**
  57323. * Disposes the resources of the material.
  57324. * @param forceDisposeTextures - Forces the disposal of all textures.
  57325. */
  57326. dispose(forceDisposeTextures?: boolean): void;
  57327. /**
  57328. * Get the current class name of the texture useful for serialization or dynamic coding.
  57329. * @returns "PBRSheenConfiguration"
  57330. */
  57331. getClassName(): string;
  57332. /**
  57333. * Add fallbacks to the effect fallbacks list.
  57334. * @param defines defines the Base texture to use.
  57335. * @param fallbacks defines the current fallback list.
  57336. * @param currentRank defines the current fallback rank.
  57337. * @returns the new fallback rank.
  57338. */
  57339. static AddFallbacks(defines: IMaterialSheenDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  57340. /**
  57341. * Add the required uniforms to the current list.
  57342. * @param uniforms defines the current uniform list.
  57343. */
  57344. static AddUniforms(uniforms: string[]): void;
  57345. /**
  57346. * Add the required uniforms to the current buffer.
  57347. * @param uniformBuffer defines the current uniform buffer.
  57348. */
  57349. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  57350. /**
  57351. * Add the required samplers to the current list.
  57352. * @param samplers defines the current sampler list.
  57353. */
  57354. static AddSamplers(samplers: string[]): void;
  57355. /**
  57356. * Makes a duplicate of the current configuration into another one.
  57357. * @param sheenConfiguration define the config where to copy the info
  57358. */
  57359. copyTo(sheenConfiguration: PBRSheenConfiguration): void;
  57360. /**
  57361. * Serializes this BRDF configuration.
  57362. * @returns - An object with the serialized config.
  57363. */
  57364. serialize(): any;
  57365. /**
  57366. * Parses a anisotropy Configuration from a serialized object.
  57367. * @param source - Serialized object.
  57368. * @param scene Defines the scene we are parsing for
  57369. * @param rootUrl Defines the rootUrl to load from
  57370. */
  57371. parse(source: any, scene: Scene, rootUrl: string): void;
  57372. }
  57373. }
  57374. declare module "babylonjs/Materials/PBR/pbrSubSurfaceConfiguration" {
  57375. import { Nullable } from "babylonjs/types";
  57376. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  57377. import { Color3 } from "babylonjs/Maths/math.color";
  57378. import { SmartArray } from "babylonjs/Misc/smartArray";
  57379. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  57380. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  57381. import { Effect } from "babylonjs/Materials/effect";
  57382. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  57383. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  57384. import { Engine } from "babylonjs/Engines/engine";
  57385. import { Scene } from "babylonjs/scene";
  57386. /**
  57387. * @hidden
  57388. */
  57389. export interface IMaterialSubSurfaceDefines {
  57390. SUBSURFACE: boolean;
  57391. SS_REFRACTION: boolean;
  57392. SS_TRANSLUCENCY: boolean;
  57393. SS_SCATTERING: boolean;
  57394. SS_THICKNESSANDMASK_TEXTURE: boolean;
  57395. SS_THICKNESSANDMASK_TEXTUREDIRECTUV: number;
  57396. SS_REFRACTIONMAP_3D: boolean;
  57397. SS_REFRACTIONMAP_OPPOSITEZ: boolean;
  57398. SS_LODINREFRACTIONALPHA: boolean;
  57399. SS_GAMMAREFRACTION: boolean;
  57400. SS_RGBDREFRACTION: boolean;
  57401. SS_LINEARSPECULARREFRACTION: boolean;
  57402. SS_LINKREFRACTIONTOTRANSPARENCY: boolean;
  57403. SS_ALBEDOFORREFRACTIONTINT: boolean;
  57404. SS_MASK_FROM_THICKNESS_TEXTURE: boolean;
  57405. /** @hidden */
  57406. _areTexturesDirty: boolean;
  57407. }
  57408. /**
  57409. * Define the code related to the sub surface parameters of the pbr material.
  57410. */
  57411. export class PBRSubSurfaceConfiguration {
  57412. private _isRefractionEnabled;
  57413. /**
  57414. * Defines if the refraction is enabled in the material.
  57415. */
  57416. isRefractionEnabled: boolean;
  57417. private _isTranslucencyEnabled;
  57418. /**
  57419. * Defines if the translucency is enabled in the material.
  57420. */
  57421. isTranslucencyEnabled: boolean;
  57422. private _isScatteringEnabled;
  57423. /**
  57424. * Defines if the sub surface scattering is enabled in the material.
  57425. */
  57426. isScatteringEnabled: boolean;
  57427. private _scatteringDiffusionProfileIndex;
  57428. /**
  57429. * Diffusion profile for subsurface scattering.
  57430. * Useful for better scattering in the skins or foliages.
  57431. */
  57432. get scatteringDiffusionProfile(): Nullable<Color3>;
  57433. set scatteringDiffusionProfile(c: Nullable<Color3>);
  57434. /**
  57435. * Defines the refraction intensity of the material.
  57436. * The refraction when enabled replaces the Diffuse part of the material.
  57437. * The intensity helps transitionning between diffuse and refraction.
  57438. */
  57439. refractionIntensity: number;
  57440. /**
  57441. * Defines the translucency intensity of the material.
  57442. * When translucency has been enabled, this defines how much of the "translucency"
  57443. * is addded to the diffuse part of the material.
  57444. */
  57445. translucencyIntensity: number;
  57446. /**
  57447. * When enabled, transparent surfaces will be tinted with the albedo colour (independent of thickness)
  57448. */
  57449. useAlbedoToTintRefraction: boolean;
  57450. private _thicknessTexture;
  57451. /**
  57452. * Stores the average thickness of a mesh in a texture (The texture is holding the values linearly).
  57453. * The red channel of the texture should contain the thickness remapped between 0 and 1.
  57454. * 0 would mean minimumThickness
  57455. * 1 would mean maximumThickness
  57456. * The other channels might be use as a mask to vary the different effects intensity.
  57457. */
  57458. thicknessTexture: Nullable<BaseTexture>;
  57459. private _refractionTexture;
  57460. /**
  57461. * Defines the texture to use for refraction.
  57462. */
  57463. refractionTexture: Nullable<BaseTexture>;
  57464. private _indexOfRefraction;
  57465. /**
  57466. * Index of refraction of the material base layer.
  57467. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  57468. *
  57469. * This does not only impact refraction but also the Base F0 of Dielectric Materials.
  57470. *
  57471. * From dielectric fresnel rules: F0 = square((iorT - iorI) / (iorT + iorI))
  57472. */
  57473. indexOfRefraction: number;
  57474. private _volumeIndexOfRefraction;
  57475. /**
  57476. * Index of refraction of the material's volume.
  57477. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  57478. *
  57479. * This ONLY impacts refraction. If not provided or given a non-valid value,
  57480. * the volume will use the same IOR as the surface.
  57481. */
  57482. get volumeIndexOfRefraction(): number;
  57483. set volumeIndexOfRefraction(value: number);
  57484. private _invertRefractionY;
  57485. /**
  57486. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  57487. */
  57488. invertRefractionY: boolean;
  57489. private _linkRefractionWithTransparency;
  57490. /**
  57491. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  57492. * Materials half opaque for instance using refraction could benefit from this control.
  57493. */
  57494. linkRefractionWithTransparency: boolean;
  57495. /**
  57496. * Defines the minimum thickness stored in the thickness map.
  57497. * If no thickness map is defined, this value will be used to simulate thickness.
  57498. */
  57499. minimumThickness: number;
  57500. /**
  57501. * Defines the maximum thickness stored in the thickness map.
  57502. */
  57503. maximumThickness: number;
  57504. /**
  57505. * Defines the volume tint of the material.
  57506. * This is used for both translucency and scattering.
  57507. */
  57508. tintColor: Color3;
  57509. /**
  57510. * Defines the distance at which the tint color should be found in the media.
  57511. * This is used for refraction only.
  57512. */
  57513. tintColorAtDistance: number;
  57514. /**
  57515. * Defines how far each channel transmit through the media.
  57516. * It is defined as a color to simplify it selection.
  57517. */
  57518. diffusionDistance: Color3;
  57519. private _useMaskFromThicknessTexture;
  57520. /**
  57521. * Stores the intensity of the different subsurface effects in the thickness texture.
  57522. * * the green channel is the translucency intensity.
  57523. * * the blue channel is the scattering intensity.
  57524. * * the alpha channel is the refraction intensity.
  57525. */
  57526. useMaskFromThicknessTexture: boolean;
  57527. private _scene;
  57528. /** @hidden */
  57529. private _internalMarkAllSubMeshesAsTexturesDirty;
  57530. private _internalMarkScenePrePassDirty;
  57531. /** @hidden */
  57532. _markAllSubMeshesAsTexturesDirty(): void;
  57533. /** @hidden */
  57534. _markScenePrePassDirty(): void;
  57535. /**
  57536. * Instantiate a new istance of sub surface configuration.
  57537. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  57538. * @param markScenePrePassDirty Callback to flag the scene as prepass dirty
  57539. * @param scene The scene
  57540. */
  57541. constructor(markAllSubMeshesAsTexturesDirty: () => void, markScenePrePassDirty: () => void, scene: Scene);
  57542. /**
  57543. * Gets wehter the submesh is ready to be used or not.
  57544. * @param defines the list of "defines" to update.
  57545. * @param scene defines the scene the material belongs to.
  57546. * @returns - boolean indicating that the submesh is ready or not.
  57547. */
  57548. isReadyForSubMesh(defines: IMaterialSubSurfaceDefines, scene: Scene): boolean;
  57549. /**
  57550. * Checks to see if a texture is used in the material.
  57551. * @param defines the list of "defines" to update.
  57552. * @param scene defines the scene to the material belongs to.
  57553. */
  57554. prepareDefines(defines: IMaterialSubSurfaceDefines, scene: Scene): void;
  57555. /**
  57556. * Binds the material data.
  57557. * @param uniformBuffer defines the Uniform buffer to fill in.
  57558. * @param scene defines the scene the material belongs to.
  57559. * @param engine defines the engine the material belongs to.
  57560. * @param isFrozen defines whether the material is frozen or not.
  57561. * @param lodBasedMicrosurface defines whether the material relies on lod based microsurface or not.
  57562. * @param realTimeFiltering defines whether the textures should be filtered on the fly.
  57563. */
  57564. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, engine: Engine, isFrozen: boolean, lodBasedMicrosurface: boolean, realTimeFiltering: boolean): void;
  57565. /**
  57566. * Unbinds the material from the mesh.
  57567. * @param activeEffect defines the effect that should be unbound from.
  57568. * @returns true if unbound, otherwise false
  57569. */
  57570. unbind(activeEffect: Effect): boolean;
  57571. /**
  57572. * Returns the texture used for refraction or null if none is used.
  57573. * @param scene defines the scene the material belongs to.
  57574. * @returns - Refraction texture if present. If no refraction texture and refraction
  57575. * is linked with transparency, returns environment texture. Otherwise, returns null.
  57576. */
  57577. private _getRefractionTexture;
  57578. /**
  57579. * Returns true if alpha blending should be disabled.
  57580. */
  57581. get disableAlphaBlending(): boolean;
  57582. /**
  57583. * Fills the list of render target textures.
  57584. * @param renderTargets the list of render targets to update
  57585. */
  57586. fillRenderTargetTextures(renderTargets: SmartArray<RenderTargetTexture>): void;
  57587. /**
  57588. * Checks to see if a texture is used in the material.
  57589. * @param texture - Base texture to use.
  57590. * @returns - Boolean specifying if a texture is used in the material.
  57591. */
  57592. hasTexture(texture: BaseTexture): boolean;
  57593. /**
  57594. * Gets a boolean indicating that current material needs to register RTT
  57595. * @returns true if this uses a render target otherwise false.
  57596. */
  57597. hasRenderTargetTextures(): boolean;
  57598. /**
  57599. * Returns an array of the actively used textures.
  57600. * @param activeTextures Array of BaseTextures
  57601. */
  57602. getActiveTextures(activeTextures: BaseTexture[]): void;
  57603. /**
  57604. * Returns the animatable textures.
  57605. * @param animatables Array of animatable textures.
  57606. */
  57607. getAnimatables(animatables: IAnimatable[]): void;
  57608. /**
  57609. * Disposes the resources of the material.
  57610. * @param forceDisposeTextures - Forces the disposal of all textures.
  57611. */
  57612. dispose(forceDisposeTextures?: boolean): void;
  57613. /**
  57614. * Get the current class name of the texture useful for serialization or dynamic coding.
  57615. * @returns "PBRSubSurfaceConfiguration"
  57616. */
  57617. getClassName(): string;
  57618. /**
  57619. * Add fallbacks to the effect fallbacks list.
  57620. * @param defines defines the Base texture to use.
  57621. * @param fallbacks defines the current fallback list.
  57622. * @param currentRank defines the current fallback rank.
  57623. * @returns the new fallback rank.
  57624. */
  57625. static AddFallbacks(defines: IMaterialSubSurfaceDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  57626. /**
  57627. * Add the required uniforms to the current list.
  57628. * @param uniforms defines the current uniform list.
  57629. */
  57630. static AddUniforms(uniforms: string[]): void;
  57631. /**
  57632. * Add the required samplers to the current list.
  57633. * @param samplers defines the current sampler list.
  57634. */
  57635. static AddSamplers(samplers: string[]): void;
  57636. /**
  57637. * Add the required uniforms to the current buffer.
  57638. * @param uniformBuffer defines the current uniform buffer.
  57639. */
  57640. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  57641. /**
  57642. * Makes a duplicate of the current configuration into another one.
  57643. * @param configuration define the config where to copy the info
  57644. */
  57645. copyTo(configuration: PBRSubSurfaceConfiguration): void;
  57646. /**
  57647. * Serializes this Sub Surface configuration.
  57648. * @returns - An object with the serialized config.
  57649. */
  57650. serialize(): any;
  57651. /**
  57652. * Parses a anisotropy Configuration from a serialized object.
  57653. * @param source - Serialized object.
  57654. * @param scene Defines the scene we are parsing for
  57655. * @param rootUrl Defines the rootUrl to load from
  57656. */
  57657. parse(source: any, scene: Scene, rootUrl: string): void;
  57658. }
  57659. }
  57660. declare module "babylonjs/Shaders/ShadersInclude/pbrFragmentDeclaration" {
  57661. /** @hidden */
  57662. export var pbrFragmentDeclaration: {
  57663. name: string;
  57664. shader: string;
  57665. };
  57666. }
  57667. declare module "babylonjs/Shaders/ShadersInclude/pbrUboDeclaration" {
  57668. /** @hidden */
  57669. export var pbrUboDeclaration: {
  57670. name: string;
  57671. shader: string;
  57672. };
  57673. }
  57674. declare module "babylonjs/Shaders/ShadersInclude/pbrFragmentExtraDeclaration" {
  57675. /** @hidden */
  57676. export var pbrFragmentExtraDeclaration: {
  57677. name: string;
  57678. shader: string;
  57679. };
  57680. }
  57681. declare module "babylonjs/Shaders/ShadersInclude/pbrFragmentSamplersDeclaration" {
  57682. /** @hidden */
  57683. export var pbrFragmentSamplersDeclaration: {
  57684. name: string;
  57685. shader: string;
  57686. };
  57687. }
  57688. declare module "babylonjs/Shaders/ShadersInclude/importanceSampling" {
  57689. /** @hidden */
  57690. export var importanceSampling: {
  57691. name: string;
  57692. shader: string;
  57693. };
  57694. }
  57695. declare module "babylonjs/Shaders/ShadersInclude/pbrHelperFunctions" {
  57696. /** @hidden */
  57697. export var pbrHelperFunctions: {
  57698. name: string;
  57699. shader: string;
  57700. };
  57701. }
  57702. declare module "babylonjs/Shaders/ShadersInclude/harmonicsFunctions" {
  57703. /** @hidden */
  57704. export var harmonicsFunctions: {
  57705. name: string;
  57706. shader: string;
  57707. };
  57708. }
  57709. declare module "babylonjs/Shaders/ShadersInclude/pbrDirectLightingSetupFunctions" {
  57710. /** @hidden */
  57711. export var pbrDirectLightingSetupFunctions: {
  57712. name: string;
  57713. shader: string;
  57714. };
  57715. }
  57716. declare module "babylonjs/Shaders/ShadersInclude/pbrDirectLightingFalloffFunctions" {
  57717. /** @hidden */
  57718. export var pbrDirectLightingFalloffFunctions: {
  57719. name: string;
  57720. shader: string;
  57721. };
  57722. }
  57723. declare module "babylonjs/Shaders/ShadersInclude/pbrBRDFFunctions" {
  57724. /** @hidden */
  57725. export var pbrBRDFFunctions: {
  57726. name: string;
  57727. shader: string;
  57728. };
  57729. }
  57730. declare module "babylonjs/Shaders/ShadersInclude/hdrFilteringFunctions" {
  57731. /** @hidden */
  57732. export var hdrFilteringFunctions: {
  57733. name: string;
  57734. shader: string;
  57735. };
  57736. }
  57737. declare module "babylonjs/Shaders/ShadersInclude/pbrDirectLightingFunctions" {
  57738. /** @hidden */
  57739. export var pbrDirectLightingFunctions: {
  57740. name: string;
  57741. shader: string;
  57742. };
  57743. }
  57744. declare module "babylonjs/Shaders/ShadersInclude/pbrIBLFunctions" {
  57745. /** @hidden */
  57746. export var pbrIBLFunctions: {
  57747. name: string;
  57748. shader: string;
  57749. };
  57750. }
  57751. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockAlbedoOpacity" {
  57752. /** @hidden */
  57753. export var pbrBlockAlbedoOpacity: {
  57754. name: string;
  57755. shader: string;
  57756. };
  57757. }
  57758. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockReflectivity" {
  57759. /** @hidden */
  57760. export var pbrBlockReflectivity: {
  57761. name: string;
  57762. shader: string;
  57763. };
  57764. }
  57765. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockAmbientOcclusion" {
  57766. /** @hidden */
  57767. export var pbrBlockAmbientOcclusion: {
  57768. name: string;
  57769. shader: string;
  57770. };
  57771. }
  57772. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockAlphaFresnel" {
  57773. /** @hidden */
  57774. export var pbrBlockAlphaFresnel: {
  57775. name: string;
  57776. shader: string;
  57777. };
  57778. }
  57779. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockAnisotropic" {
  57780. /** @hidden */
  57781. export var pbrBlockAnisotropic: {
  57782. name: string;
  57783. shader: string;
  57784. };
  57785. }
  57786. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockReflection" {
  57787. /** @hidden */
  57788. export var pbrBlockReflection: {
  57789. name: string;
  57790. shader: string;
  57791. };
  57792. }
  57793. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockSheen" {
  57794. /** @hidden */
  57795. export var pbrBlockSheen: {
  57796. name: string;
  57797. shader: string;
  57798. };
  57799. }
  57800. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockClearcoat" {
  57801. /** @hidden */
  57802. export var pbrBlockClearcoat: {
  57803. name: string;
  57804. shader: string;
  57805. };
  57806. }
  57807. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockSubSurface" {
  57808. /** @hidden */
  57809. export var pbrBlockSubSurface: {
  57810. name: string;
  57811. shader: string;
  57812. };
  57813. }
  57814. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockNormalGeometric" {
  57815. /** @hidden */
  57816. export var pbrBlockNormalGeometric: {
  57817. name: string;
  57818. shader: string;
  57819. };
  57820. }
  57821. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockNormalFinal" {
  57822. /** @hidden */
  57823. export var pbrBlockNormalFinal: {
  57824. name: string;
  57825. shader: string;
  57826. };
  57827. }
  57828. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockLightmapInit" {
  57829. /** @hidden */
  57830. export var pbrBlockLightmapInit: {
  57831. name: string;
  57832. shader: string;
  57833. };
  57834. }
  57835. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockGeometryInfo" {
  57836. /** @hidden */
  57837. export var pbrBlockGeometryInfo: {
  57838. name: string;
  57839. shader: string;
  57840. };
  57841. }
  57842. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockReflectance0" {
  57843. /** @hidden */
  57844. export var pbrBlockReflectance0: {
  57845. name: string;
  57846. shader: string;
  57847. };
  57848. }
  57849. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockReflectance" {
  57850. /** @hidden */
  57851. export var pbrBlockReflectance: {
  57852. name: string;
  57853. shader: string;
  57854. };
  57855. }
  57856. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockDirectLighting" {
  57857. /** @hidden */
  57858. export var pbrBlockDirectLighting: {
  57859. name: string;
  57860. shader: string;
  57861. };
  57862. }
  57863. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockFinalLitComponents" {
  57864. /** @hidden */
  57865. export var pbrBlockFinalLitComponents: {
  57866. name: string;
  57867. shader: string;
  57868. };
  57869. }
  57870. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockFinalUnlitComponents" {
  57871. /** @hidden */
  57872. export var pbrBlockFinalUnlitComponents: {
  57873. name: string;
  57874. shader: string;
  57875. };
  57876. }
  57877. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockFinalColorComposition" {
  57878. /** @hidden */
  57879. export var pbrBlockFinalColorComposition: {
  57880. name: string;
  57881. shader: string;
  57882. };
  57883. }
  57884. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockImageProcessing" {
  57885. /** @hidden */
  57886. export var pbrBlockImageProcessing: {
  57887. name: string;
  57888. shader: string;
  57889. };
  57890. }
  57891. declare module "babylonjs/Shaders/ShadersInclude/pbrDebug" {
  57892. /** @hidden */
  57893. export var pbrDebug: {
  57894. name: string;
  57895. shader: string;
  57896. };
  57897. }
  57898. declare module "babylonjs/Shaders/pbr.fragment" {
  57899. import "babylonjs/Shaders/ShadersInclude/prePassDeclaration";
  57900. import "babylonjs/Shaders/ShadersInclude/pbrFragmentDeclaration";
  57901. import "babylonjs/Shaders/ShadersInclude/pbrUboDeclaration";
  57902. import "babylonjs/Shaders/ShadersInclude/pbrFragmentExtraDeclaration";
  57903. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  57904. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  57905. import "babylonjs/Shaders/ShadersInclude/pbrFragmentSamplersDeclaration";
  57906. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  57907. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  57908. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  57909. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  57910. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  57911. import "babylonjs/Shaders/ShadersInclude/subSurfaceScatteringFunctions";
  57912. import "babylonjs/Shaders/ShadersInclude/importanceSampling";
  57913. import "babylonjs/Shaders/ShadersInclude/pbrHelperFunctions";
  57914. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  57915. import "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions";
  57916. import "babylonjs/Shaders/ShadersInclude/harmonicsFunctions";
  57917. import "babylonjs/Shaders/ShadersInclude/pbrDirectLightingSetupFunctions";
  57918. import "babylonjs/Shaders/ShadersInclude/pbrDirectLightingFalloffFunctions";
  57919. import "babylonjs/Shaders/ShadersInclude/pbrBRDFFunctions";
  57920. import "babylonjs/Shaders/ShadersInclude/hdrFilteringFunctions";
  57921. import "babylonjs/Shaders/ShadersInclude/pbrDirectLightingFunctions";
  57922. import "babylonjs/Shaders/ShadersInclude/pbrIBLFunctions";
  57923. import "babylonjs/Shaders/ShadersInclude/bumpFragmentMainFunctions";
  57924. import "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions";
  57925. import "babylonjs/Shaders/ShadersInclude/reflectionFunction";
  57926. import "babylonjs/Shaders/ShadersInclude/pbrBlockAlbedoOpacity";
  57927. import "babylonjs/Shaders/ShadersInclude/pbrBlockReflectivity";
  57928. import "babylonjs/Shaders/ShadersInclude/pbrBlockAmbientOcclusion";
  57929. import "babylonjs/Shaders/ShadersInclude/pbrBlockAlphaFresnel";
  57930. import "babylonjs/Shaders/ShadersInclude/pbrBlockAnisotropic";
  57931. import "babylonjs/Shaders/ShadersInclude/pbrBlockReflection";
  57932. import "babylonjs/Shaders/ShadersInclude/pbrBlockSheen";
  57933. import "babylonjs/Shaders/ShadersInclude/pbrBlockClearcoat";
  57934. import "babylonjs/Shaders/ShadersInclude/pbrBlockSubSurface";
  57935. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  57936. import "babylonjs/Shaders/ShadersInclude/pbrBlockNormalGeometric";
  57937. import "babylonjs/Shaders/ShadersInclude/bumpFragment";
  57938. import "babylonjs/Shaders/ShadersInclude/pbrBlockNormalFinal";
  57939. import "babylonjs/Shaders/ShadersInclude/depthPrePass";
  57940. import "babylonjs/Shaders/ShadersInclude/pbrBlockLightmapInit";
  57941. import "babylonjs/Shaders/ShadersInclude/pbrBlockGeometryInfo";
  57942. import "babylonjs/Shaders/ShadersInclude/pbrBlockReflectance0";
  57943. import "babylonjs/Shaders/ShadersInclude/pbrBlockReflectance";
  57944. import "babylonjs/Shaders/ShadersInclude/pbrBlockDirectLighting";
  57945. import "babylonjs/Shaders/ShadersInclude/lightFragment";
  57946. import "babylonjs/Shaders/ShadersInclude/pbrBlockFinalLitComponents";
  57947. import "babylonjs/Shaders/ShadersInclude/pbrBlockFinalUnlitComponents";
  57948. import "babylonjs/Shaders/ShadersInclude/pbrBlockFinalColorComposition";
  57949. import "babylonjs/Shaders/ShadersInclude/logDepthFragment";
  57950. import "babylonjs/Shaders/ShadersInclude/fogFragment";
  57951. import "babylonjs/Shaders/ShadersInclude/pbrBlockImageProcessing";
  57952. import "babylonjs/Shaders/ShadersInclude/pbrDebug";
  57953. /** @hidden */
  57954. export var pbrPixelShader: {
  57955. name: string;
  57956. shader: string;
  57957. };
  57958. }
  57959. declare module "babylonjs/Shaders/ShadersInclude/pbrVertexDeclaration" {
  57960. /** @hidden */
  57961. export var pbrVertexDeclaration: {
  57962. name: string;
  57963. shader: string;
  57964. };
  57965. }
  57966. declare module "babylonjs/Shaders/pbr.vertex" {
  57967. import "babylonjs/Shaders/ShadersInclude/pbrVertexDeclaration";
  57968. import "babylonjs/Shaders/ShadersInclude/pbrUboDeclaration";
  57969. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  57970. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  57971. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  57972. import "babylonjs/Shaders/ShadersInclude/harmonicsFunctions";
  57973. import "babylonjs/Shaders/ShadersInclude/bumpVertexDeclaration";
  57974. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  57975. import "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration";
  57976. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  57977. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  57978. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  57979. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  57980. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  57981. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  57982. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  57983. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  57984. import "babylonjs/Shaders/ShadersInclude/bumpVertex";
  57985. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  57986. import "babylonjs/Shaders/ShadersInclude/fogVertex";
  57987. import "babylonjs/Shaders/ShadersInclude/shadowsVertex";
  57988. import "babylonjs/Shaders/ShadersInclude/logDepthVertex";
  57989. /** @hidden */
  57990. export var pbrVertexShader: {
  57991. name: string;
  57992. shader: string;
  57993. };
  57994. }
  57995. declare module "babylonjs/Materials/PBR/pbrBaseMaterial" {
  57996. import { Nullable } from "babylonjs/types";
  57997. import { Scene } from "babylonjs/scene";
  57998. import { Matrix } from "babylonjs/Maths/math.vector";
  57999. import { SubMesh } from "babylonjs/Meshes/subMesh";
  58000. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  58001. import { Mesh } from "babylonjs/Meshes/mesh";
  58002. import { IMaterialClearCoatDefines, PBRClearCoatConfiguration } from "babylonjs/Materials/PBR/pbrClearCoatConfiguration";
  58003. import { IMaterialAnisotropicDefines, PBRAnisotropicConfiguration } from "babylonjs/Materials/PBR/pbrAnisotropicConfiguration";
  58004. import { IMaterialBRDFDefines, PBRBRDFConfiguration } from "babylonjs/Materials/PBR/pbrBRDFConfiguration";
  58005. import { IMaterialSheenDefines, PBRSheenConfiguration } from "babylonjs/Materials/PBR/pbrSheenConfiguration";
  58006. import { IMaterialSubSurfaceDefines, PBRSubSurfaceConfiguration } from "babylonjs/Materials/PBR/pbrSubSurfaceConfiguration";
  58007. import { Color3 } from "babylonjs/Maths/math.color";
  58008. import { ImageProcessingConfiguration, IImageProcessingConfigurationDefines } from "babylonjs/Materials/imageProcessingConfiguration";
  58009. import { Material, IMaterialCompilationOptions } from "babylonjs/Materials/material";
  58010. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  58011. import { PushMaterial } from "babylonjs/Materials/pushMaterial";
  58012. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  58013. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  58014. import "babylonjs/Materials/Textures/baseTexture.polynomial";
  58015. import "babylonjs/Shaders/pbr.fragment";
  58016. import "babylonjs/Shaders/pbr.vertex";
  58017. import { IMaterialDetailMapDefines, DetailMapConfiguration } from "babylonjs/Materials/material.detailMapConfiguration";
  58018. import { PrePassRenderer } from "babylonjs/Rendering/prePassRenderer";
  58019. /**
  58020. * Manages the defines for the PBR Material.
  58021. * @hidden
  58022. */
  58023. export class PBRMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines, IMaterialClearCoatDefines, IMaterialAnisotropicDefines, IMaterialBRDFDefines, IMaterialSheenDefines, IMaterialSubSurfaceDefines, IMaterialDetailMapDefines {
  58024. PBR: boolean;
  58025. NUM_SAMPLES: string;
  58026. REALTIME_FILTERING: boolean;
  58027. MAINUV1: boolean;
  58028. MAINUV2: boolean;
  58029. UV1: boolean;
  58030. UV2: boolean;
  58031. ALBEDO: boolean;
  58032. GAMMAALBEDO: boolean;
  58033. ALBEDODIRECTUV: number;
  58034. VERTEXCOLOR: boolean;
  58035. DETAIL: boolean;
  58036. DETAILDIRECTUV: number;
  58037. DETAIL_NORMALBLENDMETHOD: number;
  58038. AMBIENT: boolean;
  58039. AMBIENTDIRECTUV: number;
  58040. AMBIENTINGRAYSCALE: boolean;
  58041. OPACITY: boolean;
  58042. VERTEXALPHA: boolean;
  58043. OPACITYDIRECTUV: number;
  58044. OPACITYRGB: boolean;
  58045. ALPHATEST: boolean;
  58046. DEPTHPREPASS: boolean;
  58047. ALPHABLEND: boolean;
  58048. ALPHAFROMALBEDO: boolean;
  58049. ALPHATESTVALUE: string;
  58050. SPECULAROVERALPHA: boolean;
  58051. RADIANCEOVERALPHA: boolean;
  58052. ALPHAFRESNEL: boolean;
  58053. LINEARALPHAFRESNEL: boolean;
  58054. PREMULTIPLYALPHA: boolean;
  58055. EMISSIVE: boolean;
  58056. EMISSIVEDIRECTUV: number;
  58057. REFLECTIVITY: boolean;
  58058. REFLECTIVITYDIRECTUV: number;
  58059. SPECULARTERM: boolean;
  58060. MICROSURFACEFROMREFLECTIVITYMAP: boolean;
  58061. MICROSURFACEAUTOMATIC: boolean;
  58062. LODBASEDMICROSFURACE: boolean;
  58063. MICROSURFACEMAP: boolean;
  58064. MICROSURFACEMAPDIRECTUV: number;
  58065. METALLICWORKFLOW: boolean;
  58066. ROUGHNESSSTOREINMETALMAPALPHA: boolean;
  58067. ROUGHNESSSTOREINMETALMAPGREEN: boolean;
  58068. METALLNESSSTOREINMETALMAPBLUE: boolean;
  58069. AOSTOREINMETALMAPRED: boolean;
  58070. METALLIC_REFLECTANCE: boolean;
  58071. METALLIC_REFLECTANCEDIRECTUV: number;
  58072. ENVIRONMENTBRDF: boolean;
  58073. ENVIRONMENTBRDF_RGBD: boolean;
  58074. NORMAL: boolean;
  58075. TANGENT: boolean;
  58076. BUMP: boolean;
  58077. BUMPDIRECTUV: number;
  58078. OBJECTSPACE_NORMALMAP: boolean;
  58079. PARALLAX: boolean;
  58080. PARALLAXOCCLUSION: boolean;
  58081. NORMALXYSCALE: boolean;
  58082. LIGHTMAP: boolean;
  58083. LIGHTMAPDIRECTUV: number;
  58084. USELIGHTMAPASSHADOWMAP: boolean;
  58085. GAMMALIGHTMAP: boolean;
  58086. RGBDLIGHTMAP: boolean;
  58087. REFLECTION: boolean;
  58088. REFLECTIONMAP_3D: boolean;
  58089. REFLECTIONMAP_SPHERICAL: boolean;
  58090. REFLECTIONMAP_PLANAR: boolean;
  58091. REFLECTIONMAP_CUBIC: boolean;
  58092. USE_LOCAL_REFLECTIONMAP_CUBIC: boolean;
  58093. REFLECTIONMAP_PROJECTION: boolean;
  58094. REFLECTIONMAP_SKYBOX: boolean;
  58095. REFLECTIONMAP_EXPLICIT: boolean;
  58096. REFLECTIONMAP_EQUIRECTANGULAR: boolean;
  58097. REFLECTIONMAP_EQUIRECTANGULAR_FIXED: boolean;
  58098. REFLECTIONMAP_MIRROREDEQUIRECTANGULAR_FIXED: boolean;
  58099. INVERTCUBICMAP: boolean;
  58100. USESPHERICALFROMREFLECTIONMAP: boolean;
  58101. USEIRRADIANCEMAP: boolean;
  58102. SPHERICAL_HARMONICS: boolean;
  58103. USESPHERICALINVERTEX: boolean;
  58104. REFLECTIONMAP_OPPOSITEZ: boolean;
  58105. LODINREFLECTIONALPHA: boolean;
  58106. GAMMAREFLECTION: boolean;
  58107. RGBDREFLECTION: boolean;
  58108. LINEARSPECULARREFLECTION: boolean;
  58109. RADIANCEOCCLUSION: boolean;
  58110. HORIZONOCCLUSION: boolean;
  58111. INSTANCES: boolean;
  58112. THIN_INSTANCES: boolean;
  58113. PREPASS: boolean;
  58114. SCENE_MRT_COUNT: number;
  58115. NUM_BONE_INFLUENCERS: number;
  58116. BonesPerMesh: number;
  58117. BONETEXTURE: boolean;
  58118. NONUNIFORMSCALING: boolean;
  58119. MORPHTARGETS: boolean;
  58120. MORPHTARGETS_NORMAL: boolean;
  58121. MORPHTARGETS_TANGENT: boolean;
  58122. MORPHTARGETS_UV: boolean;
  58123. NUM_MORPH_INFLUENCERS: number;
  58124. IMAGEPROCESSING: boolean;
  58125. VIGNETTE: boolean;
  58126. VIGNETTEBLENDMODEMULTIPLY: boolean;
  58127. VIGNETTEBLENDMODEOPAQUE: boolean;
  58128. TONEMAPPING: boolean;
  58129. TONEMAPPING_ACES: boolean;
  58130. CONTRAST: boolean;
  58131. COLORCURVES: boolean;
  58132. COLORGRADING: boolean;
  58133. COLORGRADING3D: boolean;
  58134. SAMPLER3DGREENDEPTH: boolean;
  58135. SAMPLER3DBGRMAP: boolean;
  58136. IMAGEPROCESSINGPOSTPROCESS: boolean;
  58137. EXPOSURE: boolean;
  58138. MULTIVIEW: boolean;
  58139. USEPHYSICALLIGHTFALLOFF: boolean;
  58140. USEGLTFLIGHTFALLOFF: boolean;
  58141. TWOSIDEDLIGHTING: boolean;
  58142. SHADOWFLOAT: boolean;
  58143. CLIPPLANE: boolean;
  58144. CLIPPLANE2: boolean;
  58145. CLIPPLANE3: boolean;
  58146. CLIPPLANE4: boolean;
  58147. CLIPPLANE5: boolean;
  58148. CLIPPLANE6: boolean;
  58149. POINTSIZE: boolean;
  58150. FOG: boolean;
  58151. LOGARITHMICDEPTH: boolean;
  58152. FORCENORMALFORWARD: boolean;
  58153. SPECULARAA: boolean;
  58154. CLEARCOAT: boolean;
  58155. CLEARCOAT_DEFAULTIOR: boolean;
  58156. CLEARCOAT_TEXTURE: boolean;
  58157. CLEARCOAT_TEXTUREDIRECTUV: number;
  58158. CLEARCOAT_BUMP: boolean;
  58159. CLEARCOAT_BUMPDIRECTUV: number;
  58160. CLEARCOAT_TINT: boolean;
  58161. CLEARCOAT_TINT_TEXTURE: boolean;
  58162. CLEARCOAT_TINT_TEXTUREDIRECTUV: number;
  58163. ANISOTROPIC: boolean;
  58164. ANISOTROPIC_TEXTURE: boolean;
  58165. ANISOTROPIC_TEXTUREDIRECTUV: number;
  58166. BRDF_V_HEIGHT_CORRELATED: boolean;
  58167. MS_BRDF_ENERGY_CONSERVATION: boolean;
  58168. SPECULAR_GLOSSINESS_ENERGY_CONSERVATION: boolean;
  58169. SHEEN: boolean;
  58170. SHEEN_TEXTURE: boolean;
  58171. SHEEN_TEXTUREDIRECTUV: number;
  58172. SHEEN_LINKWITHALBEDO: boolean;
  58173. SHEEN_ROUGHNESS: boolean;
  58174. SHEEN_ALBEDOSCALING: boolean;
  58175. SUBSURFACE: boolean;
  58176. SS_REFRACTION: boolean;
  58177. SS_TRANSLUCENCY: boolean;
  58178. SS_SCATTERING: boolean;
  58179. SS_THICKNESSANDMASK_TEXTURE: boolean;
  58180. SS_THICKNESSANDMASK_TEXTUREDIRECTUV: number;
  58181. SS_REFRACTIONMAP_3D: boolean;
  58182. SS_REFRACTIONMAP_OPPOSITEZ: boolean;
  58183. SS_LODINREFRACTIONALPHA: boolean;
  58184. SS_GAMMAREFRACTION: boolean;
  58185. SS_RGBDREFRACTION: boolean;
  58186. SS_LINEARSPECULARREFRACTION: boolean;
  58187. SS_LINKREFRACTIONTOTRANSPARENCY: boolean;
  58188. SS_ALBEDOFORREFRACTIONTINT: boolean;
  58189. SS_MASK_FROM_THICKNESS_TEXTURE: boolean;
  58190. UNLIT: boolean;
  58191. DEBUGMODE: number;
  58192. /**
  58193. * Initializes the PBR Material defines.
  58194. */
  58195. constructor();
  58196. /**
  58197. * Resets the PBR Material defines.
  58198. */
  58199. reset(): void;
  58200. }
  58201. /**
  58202. * The Physically based material base class of BJS.
  58203. *
  58204. * This offers the main features of a standard PBR material.
  58205. * For more information, please refer to the documentation :
  58206. * https://doc.babylonjs.com/how_to/physically_based_rendering
  58207. */
  58208. export abstract class PBRBaseMaterial extends PushMaterial {
  58209. /**
  58210. * PBRMaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  58211. */
  58212. static readonly PBRMATERIAL_OPAQUE: number;
  58213. /**
  58214. * PBRMaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  58215. */
  58216. static readonly PBRMATERIAL_ALPHATEST: number;
  58217. /**
  58218. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  58219. */
  58220. static readonly PBRMATERIAL_ALPHABLEND: number;
  58221. /**
  58222. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  58223. * They are also discarded below the alpha cutoff threshold to improve performances.
  58224. */
  58225. static readonly PBRMATERIAL_ALPHATESTANDBLEND: number;
  58226. /**
  58227. * Defines the default value of how much AO map is occluding the analytical lights
  58228. * (point spot...).
  58229. */
  58230. static DEFAULT_AO_ON_ANALYTICAL_LIGHTS: number;
  58231. /**
  58232. * PBRMaterialLightFalloff Physical: light is falling off following the inverse squared distance law.
  58233. */
  58234. static readonly LIGHTFALLOFF_PHYSICAL: number;
  58235. /**
  58236. * PBRMaterialLightFalloff gltf: light is falling off as described in the gltf moving to PBR document
  58237. * to enhance interoperability with other engines.
  58238. */
  58239. static readonly LIGHTFALLOFF_GLTF: number;
  58240. /**
  58241. * PBRMaterialLightFalloff Standard: light is falling off like in the standard material
  58242. * to enhance interoperability with other materials.
  58243. */
  58244. static readonly LIGHTFALLOFF_STANDARD: number;
  58245. /**
  58246. * Intensity of the direct lights e.g. the four lights available in your scene.
  58247. * This impacts both the direct diffuse and specular highlights.
  58248. */
  58249. protected _directIntensity: number;
  58250. /**
  58251. * Intensity of the emissive part of the material.
  58252. * This helps controlling the emissive effect without modifying the emissive color.
  58253. */
  58254. protected _emissiveIntensity: number;
  58255. /**
  58256. * Intensity of the environment e.g. how much the environment will light the object
  58257. * either through harmonics for rough material or through the refelction for shiny ones.
  58258. */
  58259. protected _environmentIntensity: number;
  58260. /**
  58261. * This is a special control allowing the reduction of the specular highlights coming from the
  58262. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  58263. */
  58264. protected _specularIntensity: number;
  58265. /**
  58266. * This stores the direct, emissive, environment, and specular light intensities into a Vector4.
  58267. */
  58268. private _lightingInfos;
  58269. /**
  58270. * Debug Control allowing disabling the bump map on this material.
  58271. */
  58272. protected _disableBumpMap: boolean;
  58273. /**
  58274. * AKA Diffuse Texture in standard nomenclature.
  58275. */
  58276. protected _albedoTexture: Nullable<BaseTexture>;
  58277. /**
  58278. * AKA Occlusion Texture in other nomenclature.
  58279. */
  58280. protected _ambientTexture: Nullable<BaseTexture>;
  58281. /**
  58282. * AKA Occlusion Texture Intensity in other nomenclature.
  58283. */
  58284. protected _ambientTextureStrength: number;
  58285. /**
  58286. * Defines how much the AO map is occluding the analytical lights (point spot...).
  58287. * 1 means it completely occludes it
  58288. * 0 mean it has no impact
  58289. */
  58290. protected _ambientTextureImpactOnAnalyticalLights: number;
  58291. /**
  58292. * Stores the alpha values in a texture.
  58293. */
  58294. protected _opacityTexture: Nullable<BaseTexture>;
  58295. /**
  58296. * Stores the reflection values in a texture.
  58297. */
  58298. protected _reflectionTexture: Nullable<BaseTexture>;
  58299. /**
  58300. * Stores the emissive values in a texture.
  58301. */
  58302. protected _emissiveTexture: Nullable<BaseTexture>;
  58303. /**
  58304. * AKA Specular texture in other nomenclature.
  58305. */
  58306. protected _reflectivityTexture: Nullable<BaseTexture>;
  58307. /**
  58308. * Used to switch from specular/glossiness to metallic/roughness workflow.
  58309. */
  58310. protected _metallicTexture: Nullable<BaseTexture>;
  58311. /**
  58312. * Specifies the metallic scalar of the metallic/roughness workflow.
  58313. * Can also be used to scale the metalness values of the metallic texture.
  58314. */
  58315. protected _metallic: Nullable<number>;
  58316. /**
  58317. * Specifies the roughness scalar of the metallic/roughness workflow.
  58318. * Can also be used to scale the roughness values of the metallic texture.
  58319. */
  58320. protected _roughness: Nullable<number>;
  58321. /**
  58322. * In metallic workflow, specifies an F0 factor to help configuring the material F0.
  58323. * By default the indexOfrefraction is used to compute F0;
  58324. *
  58325. * This is used as a factor against the default reflectance at normal incidence to tweak it.
  58326. *
  58327. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor;
  58328. * F90 = metallicReflectanceColor;
  58329. */
  58330. protected _metallicF0Factor: number;
  58331. /**
  58332. * In metallic workflow, specifies an F90 color to help configuring the material F90.
  58333. * By default the F90 is always 1;
  58334. *
  58335. * Please note that this factor is also used as a factor against the default reflectance at normal incidence.
  58336. *
  58337. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor
  58338. * F90 = metallicReflectanceColor;
  58339. */
  58340. protected _metallicReflectanceColor: Color3;
  58341. /**
  58342. * Defines to store metallicReflectanceColor in RGB and metallicF0Factor in A
  58343. * This is multiply against the scalar values defined in the material.
  58344. */
  58345. protected _metallicReflectanceTexture: Nullable<BaseTexture>;
  58346. /**
  58347. * Used to enable roughness/glossiness fetch from a separate channel depending on the current mode.
  58348. * Gray Scale represents roughness in metallic mode and glossiness in specular mode.
  58349. */
  58350. protected _microSurfaceTexture: Nullable<BaseTexture>;
  58351. /**
  58352. * Stores surface normal data used to displace a mesh in a texture.
  58353. */
  58354. protected _bumpTexture: Nullable<BaseTexture>;
  58355. /**
  58356. * Stores the pre-calculated light information of a mesh in a texture.
  58357. */
  58358. protected _lightmapTexture: Nullable<BaseTexture>;
  58359. /**
  58360. * The color of a material in ambient lighting.
  58361. */
  58362. protected _ambientColor: Color3;
  58363. /**
  58364. * AKA Diffuse Color in other nomenclature.
  58365. */
  58366. protected _albedoColor: Color3;
  58367. /**
  58368. * AKA Specular Color in other nomenclature.
  58369. */
  58370. protected _reflectivityColor: Color3;
  58371. /**
  58372. * The color applied when light is reflected from a material.
  58373. */
  58374. protected _reflectionColor: Color3;
  58375. /**
  58376. * The color applied when light is emitted from a material.
  58377. */
  58378. protected _emissiveColor: Color3;
  58379. /**
  58380. * AKA Glossiness in other nomenclature.
  58381. */
  58382. protected _microSurface: number;
  58383. /**
  58384. * Specifies that the material will use the light map as a show map.
  58385. */
  58386. protected _useLightmapAsShadowmap: boolean;
  58387. /**
  58388. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  58389. * makes the reflect vector face the model (under horizon).
  58390. */
  58391. protected _useHorizonOcclusion: boolean;
  58392. /**
  58393. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  58394. * too much the area relying on ambient texture to define their ambient occlusion.
  58395. */
  58396. protected _useRadianceOcclusion: boolean;
  58397. /**
  58398. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  58399. */
  58400. protected _useAlphaFromAlbedoTexture: boolean;
  58401. /**
  58402. * Specifies that the material will keeps the specular highlights over a transparent surface (only the most limunous ones).
  58403. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  58404. */
  58405. protected _useSpecularOverAlpha: boolean;
  58406. /**
  58407. * Specifies if the reflectivity texture contains the glossiness information in its alpha channel.
  58408. */
  58409. protected _useMicroSurfaceFromReflectivityMapAlpha: boolean;
  58410. /**
  58411. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  58412. */
  58413. protected _useRoughnessFromMetallicTextureAlpha: boolean;
  58414. /**
  58415. * Specifies if the metallic texture contains the roughness information in its green channel.
  58416. */
  58417. protected _useRoughnessFromMetallicTextureGreen: boolean;
  58418. /**
  58419. * Specifies if the metallic texture contains the metallness information in its blue channel.
  58420. */
  58421. protected _useMetallnessFromMetallicTextureBlue: boolean;
  58422. /**
  58423. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  58424. */
  58425. protected _useAmbientOcclusionFromMetallicTextureRed: boolean;
  58426. /**
  58427. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  58428. */
  58429. protected _useAmbientInGrayScale: boolean;
  58430. /**
  58431. * In case the reflectivity map does not contain the microsurface information in its alpha channel,
  58432. * The material will try to infer what glossiness each pixel should be.
  58433. */
  58434. protected _useAutoMicroSurfaceFromReflectivityMap: boolean;
  58435. /**
  58436. * Defines the falloff type used in this material.
  58437. * It by default is Physical.
  58438. */
  58439. protected _lightFalloff: number;
  58440. /**
  58441. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  58442. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  58443. */
  58444. protected _useRadianceOverAlpha: boolean;
  58445. /**
  58446. * Allows using an object space normal map (instead of tangent space).
  58447. */
  58448. protected _useObjectSpaceNormalMap: boolean;
  58449. /**
  58450. * Allows using the bump map in parallax mode.
  58451. */
  58452. protected _useParallax: boolean;
  58453. /**
  58454. * Allows using the bump map in parallax occlusion mode.
  58455. */
  58456. protected _useParallaxOcclusion: boolean;
  58457. /**
  58458. * Controls the scale bias of the parallax mode.
  58459. */
  58460. protected _parallaxScaleBias: number;
  58461. /**
  58462. * If sets to true, disables all the lights affecting the material.
  58463. */
  58464. protected _disableLighting: boolean;
  58465. /**
  58466. * Number of Simultaneous lights allowed on the material.
  58467. */
  58468. protected _maxSimultaneousLights: number;
  58469. /**
  58470. * If sets to true, x component of normal map value will be inverted (x = 1.0 - x).
  58471. */
  58472. protected _invertNormalMapX: boolean;
  58473. /**
  58474. * If sets to true, y component of normal map value will be inverted (y = 1.0 - y).
  58475. */
  58476. protected _invertNormalMapY: boolean;
  58477. /**
  58478. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  58479. */
  58480. protected _twoSidedLighting: boolean;
  58481. /**
  58482. * Defines the alpha limits in alpha test mode.
  58483. */
  58484. protected _alphaCutOff: number;
  58485. /**
  58486. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  58487. */
  58488. protected _forceAlphaTest: boolean;
  58489. /**
  58490. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  58491. * And/Or occlude the blended part. (alpha is converted to gamma to compute the fresnel)
  58492. */
  58493. protected _useAlphaFresnel: boolean;
  58494. /**
  58495. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  58496. * And/Or occlude the blended part. (alpha stays linear to compute the fresnel)
  58497. */
  58498. protected _useLinearAlphaFresnel: boolean;
  58499. /**
  58500. * Specifies the environment BRDF texture used to comput the scale and offset roughness values
  58501. * from cos thetav and roughness:
  58502. * http://blog.selfshadow.com/publications/s2013-shading-course/karis/s2013_pbs_epic_notes_v2.pdf
  58503. */
  58504. protected _environmentBRDFTexture: Nullable<BaseTexture>;
  58505. /**
  58506. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  58507. */
  58508. protected _forceIrradianceInFragment: boolean;
  58509. private _realTimeFiltering;
  58510. /**
  58511. * Enables realtime filtering on the texture.
  58512. */
  58513. get realTimeFiltering(): boolean;
  58514. set realTimeFiltering(b: boolean);
  58515. private _realTimeFilteringQuality;
  58516. /**
  58517. * Quality switch for realtime filtering
  58518. */
  58519. get realTimeFilteringQuality(): number;
  58520. set realTimeFilteringQuality(n: number);
  58521. /**
  58522. * Can this material render to several textures at once
  58523. */
  58524. get canRenderToMRT(): boolean;
  58525. /**
  58526. * Force normal to face away from face.
  58527. */
  58528. protected _forceNormalForward: boolean;
  58529. /**
  58530. * Enables specular anti aliasing in the PBR shader.
  58531. * It will both interacts on the Geometry for analytical and IBL lighting.
  58532. * It also prefilter the roughness map based on the bump values.
  58533. */
  58534. protected _enableSpecularAntiAliasing: boolean;
  58535. /**
  58536. * Default configuration related to image processing available in the PBR Material.
  58537. */
  58538. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  58539. /**
  58540. * Keep track of the image processing observer to allow dispose and replace.
  58541. */
  58542. private _imageProcessingObserver;
  58543. /**
  58544. * Attaches a new image processing configuration to the PBR Material.
  58545. * @param configuration
  58546. */
  58547. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  58548. /**
  58549. * Stores the available render targets.
  58550. */
  58551. private _renderTargets;
  58552. /**
  58553. * Sets the global ambient color for the material used in lighting calculations.
  58554. */
  58555. private _globalAmbientColor;
  58556. /**
  58557. * Enables the use of logarithmic depth buffers, which is good for wide depth buffers.
  58558. */
  58559. private _useLogarithmicDepth;
  58560. /**
  58561. * If set to true, no lighting calculations will be applied.
  58562. */
  58563. private _unlit;
  58564. private _debugMode;
  58565. /**
  58566. * @hidden
  58567. * This is reserved for the inspector.
  58568. * Defines the material debug mode.
  58569. * It helps seeing only some components of the material while troubleshooting.
  58570. */
  58571. debugMode: number;
  58572. /**
  58573. * @hidden
  58574. * This is reserved for the inspector.
  58575. * Specify from where on screen the debug mode should start.
  58576. * The value goes from -1 (full screen) to 1 (not visible)
  58577. * It helps with side by side comparison against the final render
  58578. * This defaults to -1
  58579. */
  58580. private debugLimit;
  58581. /**
  58582. * @hidden
  58583. * This is reserved for the inspector.
  58584. * As the default viewing range might not be enough (if the ambient is really small for instance)
  58585. * You can use the factor to better multiply the final value.
  58586. */
  58587. private debugFactor;
  58588. /**
  58589. * Defines the clear coat layer parameters for the material.
  58590. */
  58591. readonly clearCoat: PBRClearCoatConfiguration;
  58592. /**
  58593. * Defines the anisotropic parameters for the material.
  58594. */
  58595. readonly anisotropy: PBRAnisotropicConfiguration;
  58596. /**
  58597. * Defines the BRDF parameters for the material.
  58598. */
  58599. readonly brdf: PBRBRDFConfiguration;
  58600. /**
  58601. * Defines the Sheen parameters for the material.
  58602. */
  58603. readonly sheen: PBRSheenConfiguration;
  58604. /**
  58605. * Defines the SubSurface parameters for the material.
  58606. */
  58607. readonly subSurface: PBRSubSurfaceConfiguration;
  58608. /**
  58609. * Defines the detail map parameters for the material.
  58610. */
  58611. readonly detailMap: DetailMapConfiguration;
  58612. protected _rebuildInParallel: boolean;
  58613. /**
  58614. * Instantiates a new PBRMaterial instance.
  58615. *
  58616. * @param name The material name
  58617. * @param scene The scene the material will be use in.
  58618. */
  58619. constructor(name: string, scene: Scene);
  58620. /**
  58621. * Gets a boolean indicating that current material needs to register RTT
  58622. */
  58623. get hasRenderTargetTextures(): boolean;
  58624. /**
  58625. * Gets the name of the material class.
  58626. */
  58627. getClassName(): string;
  58628. /**
  58629. * Enabled the use of logarithmic depth buffers, which is good for wide depth buffers.
  58630. */
  58631. get useLogarithmicDepth(): boolean;
  58632. /**
  58633. * Enabled the use of logarithmic depth buffers, which is good for wide depth buffers.
  58634. */
  58635. set useLogarithmicDepth(value: boolean);
  58636. /**
  58637. * Returns true if alpha blending should be disabled.
  58638. */
  58639. protected get _disableAlphaBlending(): boolean;
  58640. /**
  58641. * Specifies whether or not this material should be rendered in alpha blend mode.
  58642. */
  58643. needAlphaBlending(): boolean;
  58644. /**
  58645. * Specifies whether or not this material should be rendered in alpha test mode.
  58646. */
  58647. needAlphaTesting(): boolean;
  58648. /**
  58649. * Specifies whether or not the alpha value of the albedo texture should be used for alpha blending.
  58650. */
  58651. protected _shouldUseAlphaFromAlbedoTexture(): boolean;
  58652. /**
  58653. * Gets the texture used for the alpha test.
  58654. */
  58655. getAlphaTestTexture(): Nullable<BaseTexture>;
  58656. /**
  58657. * Specifies that the submesh is ready to be used.
  58658. * @param mesh - BJS mesh.
  58659. * @param subMesh - A submesh of the BJS mesh. Used to check if it is ready.
  58660. * @param useInstances - Specifies that instances should be used.
  58661. * @returns - boolean indicating that the submesh is ready or not.
  58662. */
  58663. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  58664. /**
  58665. * Specifies if the material uses metallic roughness workflow.
  58666. * @returns boolean specifiying if the material uses metallic roughness workflow.
  58667. */
  58668. isMetallicWorkflow(): boolean;
  58669. private _prepareEffect;
  58670. private _prepareDefines;
  58671. /**
  58672. * Force shader compilation
  58673. */
  58674. forceCompilation(mesh: AbstractMesh, onCompiled?: (material: Material) => void, options?: Partial<IMaterialCompilationOptions>): void;
  58675. /**
  58676. * Initializes the uniform buffer layout for the shader.
  58677. */
  58678. buildUniformLayout(): void;
  58679. /**
  58680. * Unbinds the material from the mesh
  58681. */
  58682. unbind(): void;
  58683. /**
  58684. * Binds the submesh data.
  58685. * @param world - The world matrix.
  58686. * @param mesh - The BJS mesh.
  58687. * @param subMesh - A submesh of the BJS mesh.
  58688. */
  58689. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  58690. /**
  58691. * Returns the animatable textures.
  58692. * @returns - Array of animatable textures.
  58693. */
  58694. getAnimatables(): IAnimatable[];
  58695. /**
  58696. * Returns the texture used for reflections.
  58697. * @returns - Reflection texture if present. Otherwise, returns the environment texture.
  58698. */
  58699. private _getReflectionTexture;
  58700. /**
  58701. * Returns an array of the actively used textures.
  58702. * @returns - Array of BaseTextures
  58703. */
  58704. getActiveTextures(): BaseTexture[];
  58705. /**
  58706. * Checks to see if a texture is used in the material.
  58707. * @param texture - Base texture to use.
  58708. * @returns - Boolean specifying if a texture is used in the material.
  58709. */
  58710. hasTexture(texture: BaseTexture): boolean;
  58711. /**
  58712. * Sets the required values to the prepass renderer.
  58713. * @param prePassRenderer defines the prepass renderer to setup
  58714. */
  58715. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  58716. /**
  58717. * Disposes the resources of the material.
  58718. * @param forceDisposeEffect - Forces the disposal of effects.
  58719. * @param forceDisposeTextures - Forces the disposal of all textures.
  58720. */
  58721. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  58722. }
  58723. }
  58724. declare module "babylonjs/Materials/PBR/pbrMaterial" {
  58725. import { Nullable } from "babylonjs/types";
  58726. import { Scene } from "babylonjs/scene";
  58727. import { Color3 } from "babylonjs/Maths/math.color";
  58728. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  58729. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  58730. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  58731. import { PBRBaseMaterial } from "babylonjs/Materials/PBR/pbrBaseMaterial";
  58732. /**
  58733. * The Physically based material of BJS.
  58734. *
  58735. * This offers the main features of a standard PBR material.
  58736. * For more information, please refer to the documentation :
  58737. * https://doc.babylonjs.com/how_to/physically_based_rendering
  58738. */
  58739. export class PBRMaterial extends PBRBaseMaterial {
  58740. /**
  58741. * PBRMaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  58742. */
  58743. static readonly PBRMATERIAL_OPAQUE: number;
  58744. /**
  58745. * PBRMaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  58746. */
  58747. static readonly PBRMATERIAL_ALPHATEST: number;
  58748. /**
  58749. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  58750. */
  58751. static readonly PBRMATERIAL_ALPHABLEND: number;
  58752. /**
  58753. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  58754. * They are also discarded below the alpha cutoff threshold to improve performances.
  58755. */
  58756. static readonly PBRMATERIAL_ALPHATESTANDBLEND: number;
  58757. /**
  58758. * Defines the default value of how much AO map is occluding the analytical lights
  58759. * (point spot...).
  58760. */
  58761. static DEFAULT_AO_ON_ANALYTICAL_LIGHTS: number;
  58762. /**
  58763. * Intensity of the direct lights e.g. the four lights available in your scene.
  58764. * This impacts both the direct diffuse and specular highlights.
  58765. */
  58766. directIntensity: number;
  58767. /**
  58768. * Intensity of the emissive part of the material.
  58769. * This helps controlling the emissive effect without modifying the emissive color.
  58770. */
  58771. emissiveIntensity: number;
  58772. /**
  58773. * Intensity of the environment e.g. how much the environment will light the object
  58774. * either through harmonics for rough material or through the refelction for shiny ones.
  58775. */
  58776. environmentIntensity: number;
  58777. /**
  58778. * This is a special control allowing the reduction of the specular highlights coming from the
  58779. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  58780. */
  58781. specularIntensity: number;
  58782. /**
  58783. * Debug Control allowing disabling the bump map on this material.
  58784. */
  58785. disableBumpMap: boolean;
  58786. /**
  58787. * AKA Diffuse Texture in standard nomenclature.
  58788. */
  58789. albedoTexture: BaseTexture;
  58790. /**
  58791. * AKA Occlusion Texture in other nomenclature.
  58792. */
  58793. ambientTexture: BaseTexture;
  58794. /**
  58795. * AKA Occlusion Texture Intensity in other nomenclature.
  58796. */
  58797. ambientTextureStrength: number;
  58798. /**
  58799. * Defines how much the AO map is occluding the analytical lights (point spot...).
  58800. * 1 means it completely occludes it
  58801. * 0 mean it has no impact
  58802. */
  58803. ambientTextureImpactOnAnalyticalLights: number;
  58804. /**
  58805. * Stores the alpha values in a texture. Use luminance if texture.getAlphaFromRGB is true.
  58806. */
  58807. opacityTexture: BaseTexture;
  58808. /**
  58809. * Stores the reflection values in a texture.
  58810. */
  58811. reflectionTexture: Nullable<BaseTexture>;
  58812. /**
  58813. * Stores the emissive values in a texture.
  58814. */
  58815. emissiveTexture: BaseTexture;
  58816. /**
  58817. * AKA Specular texture in other nomenclature.
  58818. */
  58819. reflectivityTexture: BaseTexture;
  58820. /**
  58821. * Used to switch from specular/glossiness to metallic/roughness workflow.
  58822. */
  58823. metallicTexture: BaseTexture;
  58824. /**
  58825. * Specifies the metallic scalar of the metallic/roughness workflow.
  58826. * Can also be used to scale the metalness values of the metallic texture.
  58827. */
  58828. metallic: Nullable<number>;
  58829. /**
  58830. * Specifies the roughness scalar of the metallic/roughness workflow.
  58831. * Can also be used to scale the roughness values of the metallic texture.
  58832. */
  58833. roughness: Nullable<number>;
  58834. /**
  58835. * In metallic workflow, specifies an F0 factor to help configuring the material F0.
  58836. * By default the indexOfrefraction is used to compute F0;
  58837. *
  58838. * This is used as a factor against the default reflectance at normal incidence to tweak it.
  58839. *
  58840. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor;
  58841. * F90 = metallicReflectanceColor;
  58842. */
  58843. metallicF0Factor: number;
  58844. /**
  58845. * In metallic workflow, specifies an F90 color to help configuring the material F90.
  58846. * By default the F90 is always 1;
  58847. *
  58848. * Please note that this factor is also used as a factor against the default reflectance at normal incidence.
  58849. *
  58850. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor
  58851. * F90 = metallicReflectanceColor;
  58852. */
  58853. metallicReflectanceColor: Color3;
  58854. /**
  58855. * Defines to store metallicReflectanceColor in RGB and metallicF0Factor in A
  58856. * This is multiply against the scalar values defined in the material.
  58857. */
  58858. metallicReflectanceTexture: Nullable<BaseTexture>;
  58859. /**
  58860. * Used to enable roughness/glossiness fetch from a separate channel depending on the current mode.
  58861. * Gray Scale represents roughness in metallic mode and glossiness in specular mode.
  58862. */
  58863. microSurfaceTexture: BaseTexture;
  58864. /**
  58865. * Stores surface normal data used to displace a mesh in a texture.
  58866. */
  58867. bumpTexture: BaseTexture;
  58868. /**
  58869. * Stores the pre-calculated light information of a mesh in a texture.
  58870. */
  58871. lightmapTexture: BaseTexture;
  58872. /**
  58873. * Stores the refracted light information in a texture.
  58874. */
  58875. get refractionTexture(): Nullable<BaseTexture>;
  58876. set refractionTexture(value: Nullable<BaseTexture>);
  58877. /**
  58878. * The color of a material in ambient lighting.
  58879. */
  58880. ambientColor: Color3;
  58881. /**
  58882. * AKA Diffuse Color in other nomenclature.
  58883. */
  58884. albedoColor: Color3;
  58885. /**
  58886. * AKA Specular Color in other nomenclature.
  58887. */
  58888. reflectivityColor: Color3;
  58889. /**
  58890. * The color reflected from the material.
  58891. */
  58892. reflectionColor: Color3;
  58893. /**
  58894. * The color emitted from the material.
  58895. */
  58896. emissiveColor: Color3;
  58897. /**
  58898. * AKA Glossiness in other nomenclature.
  58899. */
  58900. microSurface: number;
  58901. /**
  58902. * Index of refraction of the material base layer.
  58903. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  58904. *
  58905. * This does not only impact refraction but also the Base F0 of Dielectric Materials.
  58906. *
  58907. * From dielectric fresnel rules: F0 = square((iorT - iorI) / (iorT + iorI))
  58908. */
  58909. get indexOfRefraction(): number;
  58910. set indexOfRefraction(value: number);
  58911. /**
  58912. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  58913. */
  58914. get invertRefractionY(): boolean;
  58915. set invertRefractionY(value: boolean);
  58916. /**
  58917. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  58918. * Materials half opaque for instance using refraction could benefit from this control.
  58919. */
  58920. get linkRefractionWithTransparency(): boolean;
  58921. set linkRefractionWithTransparency(value: boolean);
  58922. /**
  58923. * If true, the light map contains occlusion information instead of lighting info.
  58924. */
  58925. useLightmapAsShadowmap: boolean;
  58926. /**
  58927. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  58928. */
  58929. useAlphaFromAlbedoTexture: boolean;
  58930. /**
  58931. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  58932. */
  58933. forceAlphaTest: boolean;
  58934. /**
  58935. * Defines the alpha limits in alpha test mode.
  58936. */
  58937. alphaCutOff: number;
  58938. /**
  58939. * Specifies that the material will keep the specular highlights over a transparent surface (only the most limunous ones).
  58940. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  58941. */
  58942. useSpecularOverAlpha: boolean;
  58943. /**
  58944. * Specifies if the reflectivity texture contains the glossiness information in its alpha channel.
  58945. */
  58946. useMicroSurfaceFromReflectivityMapAlpha: boolean;
  58947. /**
  58948. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  58949. */
  58950. useRoughnessFromMetallicTextureAlpha: boolean;
  58951. /**
  58952. * Specifies if the metallic texture contains the roughness information in its green channel.
  58953. */
  58954. useRoughnessFromMetallicTextureGreen: boolean;
  58955. /**
  58956. * Specifies if the metallic texture contains the metallness information in its blue channel.
  58957. */
  58958. useMetallnessFromMetallicTextureBlue: boolean;
  58959. /**
  58960. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  58961. */
  58962. useAmbientOcclusionFromMetallicTextureRed: boolean;
  58963. /**
  58964. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  58965. */
  58966. useAmbientInGrayScale: boolean;
  58967. /**
  58968. * In case the reflectivity map does not contain the microsurface information in its alpha channel,
  58969. * The material will try to infer what glossiness each pixel should be.
  58970. */
  58971. useAutoMicroSurfaceFromReflectivityMap: boolean;
  58972. /**
  58973. * BJS is using an harcoded light falloff based on a manually sets up range.
  58974. * In PBR, one way to represents the fallof is to use the inverse squared root algorythm.
  58975. * This parameter can help you switch back to the BJS mode in order to create scenes using both materials.
  58976. */
  58977. get usePhysicalLightFalloff(): boolean;
  58978. /**
  58979. * BJS is using an harcoded light falloff based on a manually sets up range.
  58980. * In PBR, one way to represents the fallof is to use the inverse squared root algorythm.
  58981. * This parameter can help you switch back to the BJS mode in order to create scenes using both materials.
  58982. */
  58983. set usePhysicalLightFalloff(value: boolean);
  58984. /**
  58985. * In order to support the falloff compatibility with gltf, a special mode has been added
  58986. * to reproduce the gltf light falloff.
  58987. */
  58988. get useGLTFLightFalloff(): boolean;
  58989. /**
  58990. * In order to support the falloff compatibility with gltf, a special mode has been added
  58991. * to reproduce the gltf light falloff.
  58992. */
  58993. set useGLTFLightFalloff(value: boolean);
  58994. /**
  58995. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  58996. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  58997. */
  58998. useRadianceOverAlpha: boolean;
  58999. /**
  59000. * Allows using an object space normal map (instead of tangent space).
  59001. */
  59002. useObjectSpaceNormalMap: boolean;
  59003. /**
  59004. * Allows using the bump map in parallax mode.
  59005. */
  59006. useParallax: boolean;
  59007. /**
  59008. * Allows using the bump map in parallax occlusion mode.
  59009. */
  59010. useParallaxOcclusion: boolean;
  59011. /**
  59012. * Controls the scale bias of the parallax mode.
  59013. */
  59014. parallaxScaleBias: number;
  59015. /**
  59016. * If sets to true, disables all the lights affecting the material.
  59017. */
  59018. disableLighting: boolean;
  59019. /**
  59020. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  59021. */
  59022. forceIrradianceInFragment: boolean;
  59023. /**
  59024. * Number of Simultaneous lights allowed on the material.
  59025. */
  59026. maxSimultaneousLights: number;
  59027. /**
  59028. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  59029. */
  59030. invertNormalMapX: boolean;
  59031. /**
  59032. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  59033. */
  59034. invertNormalMapY: boolean;
  59035. /**
  59036. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  59037. */
  59038. twoSidedLighting: boolean;
  59039. /**
  59040. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  59041. * And/Or occlude the blended part. (alpha is converted to gamma to compute the fresnel)
  59042. */
  59043. useAlphaFresnel: boolean;
  59044. /**
  59045. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  59046. * And/Or occlude the blended part. (alpha stays linear to compute the fresnel)
  59047. */
  59048. useLinearAlphaFresnel: boolean;
  59049. /**
  59050. * Let user defines the brdf lookup texture used for IBL.
  59051. * A default 8bit version is embedded but you could point at :
  59052. * * Default texture: https://assets.babylonjs.com/environments/correlatedMSBRDF_RGBD.png
  59053. * * Default 16bit pixel depth texture: https://assets.babylonjs.com/environments/correlatedMSBRDF.dds
  59054. * * LEGACY Default None correlated https://assets.babylonjs.com/environments/uncorrelatedBRDF_RGBD.png
  59055. * * LEGACY Default None correlated 16bit pixel depth https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds
  59056. */
  59057. environmentBRDFTexture: Nullable<BaseTexture>;
  59058. /**
  59059. * Force normal to face away from face.
  59060. */
  59061. forceNormalForward: boolean;
  59062. /**
  59063. * Enables specular anti aliasing in the PBR shader.
  59064. * It will both interacts on the Geometry for analytical and IBL lighting.
  59065. * It also prefilter the roughness map based on the bump values.
  59066. */
  59067. enableSpecularAntiAliasing: boolean;
  59068. /**
  59069. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  59070. * makes the reflect vector face the model (under horizon).
  59071. */
  59072. useHorizonOcclusion: boolean;
  59073. /**
  59074. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  59075. * too much the area relying on ambient texture to define their ambient occlusion.
  59076. */
  59077. useRadianceOcclusion: boolean;
  59078. /**
  59079. * If set to true, no lighting calculations will be applied.
  59080. */
  59081. unlit: boolean;
  59082. /**
  59083. * Gets the image processing configuration used either in this material.
  59084. */
  59085. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  59086. /**
  59087. * Sets the Default image processing configuration used either in the this material.
  59088. *
  59089. * If sets to null, the scene one is in use.
  59090. */
  59091. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  59092. /**
  59093. * Gets wether the color curves effect is enabled.
  59094. */
  59095. get cameraColorCurvesEnabled(): boolean;
  59096. /**
  59097. * Sets wether the color curves effect is enabled.
  59098. */
  59099. set cameraColorCurvesEnabled(value: boolean);
  59100. /**
  59101. * Gets wether the color grading effect is enabled.
  59102. */
  59103. get cameraColorGradingEnabled(): boolean;
  59104. /**
  59105. * Gets wether the color grading effect is enabled.
  59106. */
  59107. set cameraColorGradingEnabled(value: boolean);
  59108. /**
  59109. * Gets wether tonemapping is enabled or not.
  59110. */
  59111. get cameraToneMappingEnabled(): boolean;
  59112. /**
  59113. * Sets wether tonemapping is enabled or not
  59114. */
  59115. set cameraToneMappingEnabled(value: boolean);
  59116. /**
  59117. * The camera exposure used on this material.
  59118. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  59119. * This corresponds to a photographic exposure.
  59120. */
  59121. get cameraExposure(): number;
  59122. /**
  59123. * The camera exposure used on this material.
  59124. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  59125. * This corresponds to a photographic exposure.
  59126. */
  59127. set cameraExposure(value: number);
  59128. /**
  59129. * Gets The camera contrast used on this material.
  59130. */
  59131. get cameraContrast(): number;
  59132. /**
  59133. * Sets The camera contrast used on this material.
  59134. */
  59135. set cameraContrast(value: number);
  59136. /**
  59137. * Gets the Color Grading 2D Lookup Texture.
  59138. */
  59139. get cameraColorGradingTexture(): Nullable<BaseTexture>;
  59140. /**
  59141. * Sets the Color Grading 2D Lookup Texture.
  59142. */
  59143. set cameraColorGradingTexture(value: Nullable<BaseTexture>);
  59144. /**
  59145. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  59146. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  59147. * 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;
  59148. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  59149. */
  59150. get cameraColorCurves(): Nullable<ColorCurves>;
  59151. /**
  59152. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  59153. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  59154. * 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;
  59155. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  59156. */
  59157. set cameraColorCurves(value: Nullable<ColorCurves>);
  59158. /**
  59159. * Instantiates a new PBRMaterial instance.
  59160. *
  59161. * @param name The material name
  59162. * @param scene The scene the material will be use in.
  59163. */
  59164. constructor(name: string, scene: Scene);
  59165. /**
  59166. * Returns the name of this material class.
  59167. */
  59168. getClassName(): string;
  59169. /**
  59170. * Makes a duplicate of the current material.
  59171. * @param name - name to use for the new material.
  59172. */
  59173. clone(name: string): PBRMaterial;
  59174. /**
  59175. * Serializes this PBR Material.
  59176. * @returns - An object with the serialized material.
  59177. */
  59178. serialize(): any;
  59179. /**
  59180. * Parses a PBR Material from a serialized object.
  59181. * @param source - Serialized object.
  59182. * @param scene - BJS scene instance.
  59183. * @param rootUrl - url for the scene object
  59184. * @returns - PBRMaterial
  59185. */
  59186. static Parse(source: any, scene: Scene, rootUrl: string): PBRMaterial;
  59187. }
  59188. }
  59189. declare module "babylonjs/Misc/dds" {
  59190. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  59191. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  59192. import { Nullable } from "babylonjs/types";
  59193. import { Scene } from "babylonjs/scene";
  59194. import "babylonjs/Engines/Extensions/engine.cubeTexture";
  59195. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  59196. /**
  59197. * Direct draw surface info
  59198. * @see https://docs.microsoft.com/en-us/windows/desktop/direct3ddds/dx-graphics-dds-pguide
  59199. */
  59200. export interface DDSInfo {
  59201. /**
  59202. * Width of the texture
  59203. */
  59204. width: number;
  59205. /**
  59206. * Width of the texture
  59207. */
  59208. height: number;
  59209. /**
  59210. * Number of Mipmaps for the texture
  59211. * @see https://en.wikipedia.org/wiki/Mipmap
  59212. */
  59213. mipmapCount: number;
  59214. /**
  59215. * If the textures format is a known fourCC format
  59216. * @see https://www.fourcc.org/
  59217. */
  59218. isFourCC: boolean;
  59219. /**
  59220. * If the texture is an RGB format eg. DXGI_FORMAT_B8G8R8X8_UNORM format
  59221. */
  59222. isRGB: boolean;
  59223. /**
  59224. * If the texture is a lumincance format
  59225. */
  59226. isLuminance: boolean;
  59227. /**
  59228. * If this is a cube texture
  59229. * @see https://docs.microsoft.com/en-us/windows/desktop/direct3ddds/dds-file-layout-for-cubic-environment-maps
  59230. */
  59231. isCube: boolean;
  59232. /**
  59233. * If the texture is a compressed format eg. FOURCC_DXT1
  59234. */
  59235. isCompressed: boolean;
  59236. /**
  59237. * The dxgiFormat of the texture
  59238. * @see https://docs.microsoft.com/en-us/windows/desktop/api/dxgiformat/ne-dxgiformat-dxgi_format
  59239. */
  59240. dxgiFormat: number;
  59241. /**
  59242. * Texture type eg. Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT
  59243. */
  59244. textureType: number;
  59245. /**
  59246. * Sphericle polynomial created for the dds texture
  59247. */
  59248. sphericalPolynomial?: SphericalPolynomial;
  59249. }
  59250. /**
  59251. * Class used to provide DDS decompression tools
  59252. */
  59253. export class DDSTools {
  59254. /**
  59255. * Gets or sets a boolean indicating that LOD info is stored in alpha channel (false by default)
  59256. */
  59257. static StoreLODInAlphaChannel: boolean;
  59258. /**
  59259. * Gets DDS information from an array buffer
  59260. * @param data defines the array buffer view to read data from
  59261. * @returns the DDS information
  59262. */
  59263. static GetDDSInfo(data: ArrayBufferView): DDSInfo;
  59264. private static _FloatView;
  59265. private static _Int32View;
  59266. private static _ToHalfFloat;
  59267. private static _FromHalfFloat;
  59268. private static _GetHalfFloatAsFloatRGBAArrayBuffer;
  59269. private static _GetHalfFloatRGBAArrayBuffer;
  59270. private static _GetFloatRGBAArrayBuffer;
  59271. private static _GetFloatAsUIntRGBAArrayBuffer;
  59272. private static _GetHalfFloatAsUIntRGBAArrayBuffer;
  59273. private static _GetRGBAArrayBuffer;
  59274. private static _ExtractLongWordOrder;
  59275. private static _GetRGBArrayBuffer;
  59276. private static _GetLuminanceArrayBuffer;
  59277. /**
  59278. * Uploads DDS Levels to a Babylon Texture
  59279. * @hidden
  59280. */
  59281. static UploadDDSLevels(engine: ThinEngine, texture: InternalTexture, data: ArrayBufferView, info: DDSInfo, loadMipmaps: boolean, faces: number, lodIndex?: number, currentFace?: number): void;
  59282. }
  59283. module "babylonjs/Engines/thinEngine" {
  59284. interface ThinEngine {
  59285. /**
  59286. * Create a cube texture from prefiltered data (ie. the mipmaps contain ready to use data for PBR reflection)
  59287. * @param rootUrl defines the url where the file to load is located
  59288. * @param scene defines the current scene
  59289. * @param lodScale defines scale to apply to the mip map selection
  59290. * @param lodOffset defines offset to apply to the mip map selection
  59291. * @param onLoad defines an optional callback raised when the texture is loaded
  59292. * @param onError defines an optional callback raised if there is an issue to load the texture
  59293. * @param format defines the format of the data
  59294. * @param forcedExtension defines the extension to use to pick the right loader
  59295. * @param createPolynomials defines wheter or not to create polynomails harmonics for the texture
  59296. * @returns the cube texture as an InternalTexture
  59297. */
  59298. 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;
  59299. }
  59300. }
  59301. }
  59302. declare module "babylonjs/Materials/Textures/Loaders/ddsTextureLoader" {
  59303. import { Nullable } from "babylonjs/types";
  59304. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  59305. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  59306. /**
  59307. * Implementation of the DDS Texture Loader.
  59308. * @hidden
  59309. */
  59310. export class _DDSTextureLoader implements IInternalTextureLoader {
  59311. /**
  59312. * Defines wether the loader supports cascade loading the different faces.
  59313. */
  59314. readonly supportCascades: boolean;
  59315. /**
  59316. * This returns if the loader support the current file information.
  59317. * @param extension defines the file extension of the file being loaded
  59318. * @returns true if the loader can load the specified file
  59319. */
  59320. canLoad(extension: string): boolean;
  59321. /**
  59322. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  59323. * @param data contains the texture data
  59324. * @param texture defines the BabylonJS internal texture
  59325. * @param createPolynomials will be true if polynomials have been requested
  59326. * @param onLoad defines the callback to trigger once the texture is ready
  59327. * @param onError defines the callback to trigger in case of error
  59328. */
  59329. loadCubeData(imgs: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  59330. /**
  59331. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  59332. * @param data contains the texture data
  59333. * @param texture defines the BabylonJS internal texture
  59334. * @param callback defines the method to call once ready to upload
  59335. */
  59336. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  59337. }
  59338. }
  59339. declare module "babylonjs/Materials/Textures/Loaders/envTextureLoader" {
  59340. import { Nullable } from "babylonjs/types";
  59341. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  59342. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  59343. /**
  59344. * Implementation of the ENV Texture Loader.
  59345. * @hidden
  59346. */
  59347. export class _ENVTextureLoader implements IInternalTextureLoader {
  59348. /**
  59349. * Defines wether the loader supports cascade loading the different faces.
  59350. */
  59351. readonly supportCascades: boolean;
  59352. /**
  59353. * This returns if the loader support the current file information.
  59354. * @param extension defines the file extension of the file being loaded
  59355. * @returns true if the loader can load the specified file
  59356. */
  59357. canLoad(extension: string): boolean;
  59358. /**
  59359. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  59360. * @param data contains the texture data
  59361. * @param texture defines the BabylonJS internal texture
  59362. * @param createPolynomials will be true if polynomials have been requested
  59363. * @param onLoad defines the callback to trigger once the texture is ready
  59364. * @param onError defines the callback to trigger in case of error
  59365. */
  59366. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  59367. /**
  59368. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  59369. * @param data contains the texture data
  59370. * @param texture defines the BabylonJS internal texture
  59371. * @param callback defines the method to call once ready to upload
  59372. */
  59373. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  59374. }
  59375. }
  59376. declare module "babylonjs/Misc/khronosTextureContainer" {
  59377. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  59378. /**
  59379. * for description see https://www.khronos.org/opengles/sdk/tools/KTX/
  59380. * for file layout see https://www.khronos.org/opengles/sdk/tools/KTX/file_format_spec/
  59381. */
  59382. export class KhronosTextureContainer {
  59383. /** contents of the KTX container file */
  59384. data: ArrayBufferView;
  59385. private static HEADER_LEN;
  59386. private static COMPRESSED_2D;
  59387. private static COMPRESSED_3D;
  59388. private static TEX_2D;
  59389. private static TEX_3D;
  59390. /**
  59391. * Gets the openGL type
  59392. */
  59393. glType: number;
  59394. /**
  59395. * Gets the openGL type size
  59396. */
  59397. glTypeSize: number;
  59398. /**
  59399. * Gets the openGL format
  59400. */
  59401. glFormat: number;
  59402. /**
  59403. * Gets the openGL internal format
  59404. */
  59405. glInternalFormat: number;
  59406. /**
  59407. * Gets the base internal format
  59408. */
  59409. glBaseInternalFormat: number;
  59410. /**
  59411. * Gets image width in pixel
  59412. */
  59413. pixelWidth: number;
  59414. /**
  59415. * Gets image height in pixel
  59416. */
  59417. pixelHeight: number;
  59418. /**
  59419. * Gets image depth in pixels
  59420. */
  59421. pixelDepth: number;
  59422. /**
  59423. * Gets the number of array elements
  59424. */
  59425. numberOfArrayElements: number;
  59426. /**
  59427. * Gets the number of faces
  59428. */
  59429. numberOfFaces: number;
  59430. /**
  59431. * Gets the number of mipmap levels
  59432. */
  59433. numberOfMipmapLevels: number;
  59434. /**
  59435. * Gets the bytes of key value data
  59436. */
  59437. bytesOfKeyValueData: number;
  59438. /**
  59439. * Gets the load type
  59440. */
  59441. loadType: number;
  59442. /**
  59443. * If the container has been made invalid (eg. constructor failed to correctly load array buffer)
  59444. */
  59445. isInvalid: boolean;
  59446. /**
  59447. * Creates a new KhronosTextureContainer
  59448. * @param data contents of the KTX container file
  59449. * @param facesExpected should be either 1 or 6, based whether a cube texture or or
  59450. * @param threeDExpected provision for indicating that data should be a 3D texture, not implemented
  59451. * @param textureArrayExpected provision for indicating that data should be a texture array, not implemented
  59452. */
  59453. constructor(
  59454. /** contents of the KTX container file */
  59455. data: ArrayBufferView, facesExpected: number, threeDExpected?: boolean, textureArrayExpected?: boolean);
  59456. /**
  59457. * Uploads KTX content to a Babylon Texture.
  59458. * It is assumed that the texture has already been created & is currently bound
  59459. * @hidden
  59460. */
  59461. uploadLevels(texture: InternalTexture, loadMipmaps: boolean): void;
  59462. private _upload2DCompressedLevels;
  59463. /**
  59464. * Checks if the given data starts with a KTX file identifier.
  59465. * @param data the data to check
  59466. * @returns true if the data is a KTX file or false otherwise
  59467. */
  59468. static IsValid(data: ArrayBufferView): boolean;
  59469. }
  59470. }
  59471. declare module "babylonjs/Misc/khronosTextureContainer2" {
  59472. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  59473. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  59474. /**
  59475. * Class for loading KTX2 files
  59476. * !!! Experimental Extension Subject to Changes !!!
  59477. * @hidden
  59478. */
  59479. export class KhronosTextureContainer2 {
  59480. private static _ModulePromise;
  59481. private static _TranscodeFormat;
  59482. constructor(engine: ThinEngine);
  59483. uploadAsync(data: ArrayBufferView, internalTexture: InternalTexture): Promise<void>;
  59484. private _determineTranscodeFormat;
  59485. /**
  59486. * Checks if the given data starts with a KTX2 file identifier.
  59487. * @param data the data to check
  59488. * @returns true if the data is a KTX2 file or false otherwise
  59489. */
  59490. static IsValid(data: ArrayBufferView): boolean;
  59491. }
  59492. }
  59493. declare module "babylonjs/Materials/Textures/Loaders/ktxTextureLoader" {
  59494. import { Nullable } from "babylonjs/types";
  59495. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  59496. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  59497. /**
  59498. * Implementation of the KTX Texture Loader.
  59499. * @hidden
  59500. */
  59501. export class _KTXTextureLoader implements IInternalTextureLoader {
  59502. /**
  59503. * Defines wether the loader supports cascade loading the different faces.
  59504. */
  59505. readonly supportCascades: boolean;
  59506. /**
  59507. * This returns if the loader support the current file information.
  59508. * @param extension defines the file extension of the file being loaded
  59509. * @param mimeType defines the optional mime type of the file being loaded
  59510. * @returns true if the loader can load the specified file
  59511. */
  59512. canLoad(extension: string, mimeType?: string): boolean;
  59513. /**
  59514. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  59515. * @param data contains the texture data
  59516. * @param texture defines the BabylonJS internal texture
  59517. * @param createPolynomials will be true if polynomials have been requested
  59518. * @param onLoad defines the callback to trigger once the texture is ready
  59519. * @param onError defines the callback to trigger in case of error
  59520. */
  59521. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  59522. /**
  59523. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  59524. * @param data contains the texture data
  59525. * @param texture defines the BabylonJS internal texture
  59526. * @param callback defines the method to call once ready to upload
  59527. */
  59528. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void, loadFailed: boolean) => void): void;
  59529. }
  59530. }
  59531. declare module "babylonjs/Helpers/sceneHelpers" {
  59532. import { Nullable } from "babylonjs/types";
  59533. import { Mesh } from "babylonjs/Meshes/mesh";
  59534. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  59535. import { IEnvironmentHelperOptions, EnvironmentHelper } from "babylonjs/Helpers/environmentHelper";
  59536. import { VRExperienceHelperOptions, VRExperienceHelper } from "babylonjs/Cameras/VR/vrExperienceHelper";
  59537. import "babylonjs/Materials/Textures/Loaders/ddsTextureLoader";
  59538. import "babylonjs/Materials/Textures/Loaders/envTextureLoader";
  59539. import "babylonjs/Materials/Textures/Loaders/ktxTextureLoader";
  59540. import "babylonjs/Meshes/Builders/boxBuilder";
  59541. import { WebXRDefaultExperience, WebXRDefaultExperienceOptions } from "babylonjs/XR/webXRDefaultExperience";
  59542. /** @hidden */
  59543. export var _forceSceneHelpersToBundle: boolean;
  59544. module "babylonjs/scene" {
  59545. interface Scene {
  59546. /**
  59547. * Creates a default light for the scene.
  59548. * @see https://doc.babylonjs.com/How_To/Fast_Build#create-default-light
  59549. * @param replace has the default false, when true replaces the existing lights in the scene with a hemispheric light
  59550. */
  59551. createDefaultLight(replace?: boolean): void;
  59552. /**
  59553. * Creates a default camera for the scene.
  59554. * @see https://doc.babylonjs.com/How_To/Fast_Build#create-default-camera
  59555. * @param createArcRotateCamera has the default false which creates a free camera, when true creates an arc rotate camera
  59556. * @param replace has default false, when true replaces the active camera in the scene
  59557. * @param attachCameraControls has default false, when true attaches camera controls to the canvas.
  59558. */
  59559. createDefaultCamera(createArcRotateCamera?: boolean, replace?: boolean, attachCameraControls?: boolean): void;
  59560. /**
  59561. * Creates a default camera and a default light.
  59562. * @see https://doc.babylonjs.com/how_to/Fast_Build#create-default-camera-or-light
  59563. * @param createArcRotateCamera has the default false which creates a free camera, when true creates an arc rotate camera
  59564. * @param replace has the default false, when true replaces the active camera/light in the scene
  59565. * @param attachCameraControls has the default false, when true attaches camera controls to the canvas.
  59566. */
  59567. createDefaultCameraOrLight(createArcRotateCamera?: boolean, replace?: boolean, attachCameraControls?: boolean): void;
  59568. /**
  59569. * Creates a new sky box
  59570. * @see https://doc.babylonjs.com/how_to/Fast_Build#create-default-skybox
  59571. * @param environmentTexture defines the texture to use as environment texture
  59572. * @param pbr has default false which requires the StandardMaterial to be used, when true PBRMaterial must be used
  59573. * @param scale defines the overall scale of the skybox
  59574. * @param blur is only available when pbr is true, default is 0, no blur, maximum value is 1
  59575. * @param setGlobalEnvTexture has default true indicating that scene.environmentTexture must match the current skybox texture
  59576. * @returns a new mesh holding the sky box
  59577. */
  59578. createDefaultSkybox(environmentTexture?: BaseTexture, pbr?: boolean, scale?: number, blur?: number, setGlobalEnvTexture?: boolean): Nullable<Mesh>;
  59579. /**
  59580. * Creates a new environment
  59581. * @see https://doc.babylonjs.com/How_To/Fast_Build#create-default-environment
  59582. * @param options defines the options you can use to configure the environment
  59583. * @returns the new EnvironmentHelper
  59584. */
  59585. createDefaultEnvironment(options?: Partial<IEnvironmentHelperOptions>): Nullable<EnvironmentHelper>;
  59586. /**
  59587. * Creates a new VREXperienceHelper
  59588. * @see https://doc.babylonjs.com/how_to/webvr_helper
  59589. * @param webVROptions defines the options used to create the new VREXperienceHelper
  59590. * @returns a new VREXperienceHelper
  59591. */
  59592. createDefaultVRExperience(webVROptions?: VRExperienceHelperOptions): VRExperienceHelper;
  59593. /**
  59594. * Creates a new WebXRDefaultExperience
  59595. * @see https://doc.babylonjs.com/how_to/introduction_to_webxr
  59596. * @param options experience options
  59597. * @returns a promise for a new WebXRDefaultExperience
  59598. */
  59599. createDefaultXRExperienceAsync(options: WebXRDefaultExperienceOptions): Promise<WebXRDefaultExperience>;
  59600. }
  59601. }
  59602. }
  59603. declare module "babylonjs/Helpers/videoDome" {
  59604. import { Scene } from "babylonjs/scene";
  59605. import { TransformNode } from "babylonjs/Meshes/transformNode";
  59606. import { Mesh } from "babylonjs/Meshes/mesh";
  59607. import { VideoTexture } from "babylonjs/Materials/Textures/videoTexture";
  59608. import { BackgroundMaterial } from "babylonjs/Materials/Background/backgroundMaterial";
  59609. import "babylonjs/Meshes/Builders/sphereBuilder";
  59610. /**
  59611. * Display a 360/180 degree video on an approximately spherical surface, useful for VR applications or skyboxes.
  59612. * As a subclass of TransformNode, this allow parenting to the camera or multiple videos with different locations in the scene.
  59613. * This class achieves its effect with a VideoTexture and a correctly configured BackgroundMaterial on an inverted sphere.
  59614. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  59615. */
  59616. export class VideoDome extends TransformNode {
  59617. /**
  59618. * Define the video source as a Monoscopic panoramic 360 video.
  59619. */
  59620. static readonly MODE_MONOSCOPIC: number;
  59621. /**
  59622. * Define the video source as a Stereoscopic TopBottom/OverUnder panoramic 360 video.
  59623. */
  59624. static readonly MODE_TOPBOTTOM: number;
  59625. /**
  59626. * Define the video source as a Stereoscopic Side by Side panoramic 360 video.
  59627. */
  59628. static readonly MODE_SIDEBYSIDE: number;
  59629. private _halfDome;
  59630. private _useDirectMapping;
  59631. /**
  59632. * The video texture being displayed on the sphere
  59633. */
  59634. protected _videoTexture: VideoTexture;
  59635. /**
  59636. * Gets the video texture being displayed on the sphere
  59637. */
  59638. get videoTexture(): VideoTexture;
  59639. /**
  59640. * The skybox material
  59641. */
  59642. protected _material: BackgroundMaterial;
  59643. /**
  59644. * The surface used for the video dome
  59645. */
  59646. protected _mesh: Mesh;
  59647. /**
  59648. * Gets the mesh used for the video dome.
  59649. */
  59650. get mesh(): Mesh;
  59651. /**
  59652. * A mesh that will be used to mask the back of the video dome in case it is a 180 degree movie.
  59653. */
  59654. private _halfDomeMask;
  59655. /**
  59656. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  59657. * Also see the options.resolution property.
  59658. */
  59659. get fovMultiplier(): number;
  59660. set fovMultiplier(value: number);
  59661. private _videoMode;
  59662. /**
  59663. * Gets or set the current video mode for the video. It can be:
  59664. * * VideoDome.MODE_MONOSCOPIC : Define the video source as a Monoscopic panoramic 360 video.
  59665. * * VideoDome.MODE_TOPBOTTOM : Define the video source as a Stereoscopic TopBottom/OverUnder panoramic 360 video.
  59666. * * VideoDome.MODE_SIDEBYSIDE : Define the video source as a Stereoscopic Side by Side panoramic 360 video.
  59667. */
  59668. get videoMode(): number;
  59669. set videoMode(value: number);
  59670. /**
  59671. * Is the video a 180 degrees video (half dome) or 360 video (full dome)
  59672. *
  59673. */
  59674. get halfDome(): boolean;
  59675. /**
  59676. * Set the halfDome mode. If set, only the front (180 degrees) will be displayed and the back will be blacked out.
  59677. */
  59678. set halfDome(enabled: boolean);
  59679. /**
  59680. * Oberserver used in Stereoscopic VR Mode.
  59681. */
  59682. private _onBeforeCameraRenderObserver;
  59683. /**
  59684. * Create an instance of this class and pass through the parameters to the relevant classes, VideoTexture, StandardMaterial, and Mesh.
  59685. * @param name Element's name, child elements will append suffixes for their own names.
  59686. * @param urlsOrVideo defines the url(s) or the video element to use
  59687. * @param options An object containing optional or exposed sub element properties
  59688. */
  59689. constructor(name: string, urlsOrVideo: string | string[] | HTMLVideoElement, options: {
  59690. resolution?: number;
  59691. clickToPlay?: boolean;
  59692. autoPlay?: boolean;
  59693. loop?: boolean;
  59694. size?: number;
  59695. poster?: string;
  59696. faceForward?: boolean;
  59697. useDirectMapping?: boolean;
  59698. halfDomeMode?: boolean;
  59699. }, scene: Scene);
  59700. private _changeVideoMode;
  59701. /**
  59702. * Releases resources associated with this node.
  59703. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  59704. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  59705. */
  59706. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  59707. }
  59708. }
  59709. declare module "babylonjs/Helpers/index" {
  59710. export * from "babylonjs/Helpers/environmentHelper";
  59711. export * from "babylonjs/Helpers/photoDome";
  59712. export * from "babylonjs/Helpers/sceneHelpers";
  59713. export * from "babylonjs/Helpers/videoDome";
  59714. }
  59715. declare module "babylonjs/Instrumentation/engineInstrumentation" {
  59716. import { PerfCounter } from "babylonjs/Misc/perfCounter";
  59717. import { IDisposable } from "babylonjs/scene";
  59718. import { Engine } from "babylonjs/Engines/engine";
  59719. /**
  59720. * This class can be used to get instrumentation data from a Babylon engine
  59721. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  59722. */
  59723. export class EngineInstrumentation implements IDisposable {
  59724. /**
  59725. * Define the instrumented engine.
  59726. */
  59727. engine: Engine;
  59728. private _captureGPUFrameTime;
  59729. private _gpuFrameTimeToken;
  59730. private _gpuFrameTime;
  59731. private _captureShaderCompilationTime;
  59732. private _shaderCompilationTime;
  59733. private _onBeginFrameObserver;
  59734. private _onEndFrameObserver;
  59735. private _onBeforeShaderCompilationObserver;
  59736. private _onAfterShaderCompilationObserver;
  59737. /**
  59738. * Gets the perf counter used for GPU frame time
  59739. */
  59740. get gpuFrameTimeCounter(): PerfCounter;
  59741. /**
  59742. * Gets the GPU frame time capture status
  59743. */
  59744. get captureGPUFrameTime(): boolean;
  59745. /**
  59746. * Enable or disable the GPU frame time capture
  59747. */
  59748. set captureGPUFrameTime(value: boolean);
  59749. /**
  59750. * Gets the perf counter used for shader compilation time
  59751. */
  59752. get shaderCompilationTimeCounter(): PerfCounter;
  59753. /**
  59754. * Gets the shader compilation time capture status
  59755. */
  59756. get captureShaderCompilationTime(): boolean;
  59757. /**
  59758. * Enable or disable the shader compilation time capture
  59759. */
  59760. set captureShaderCompilationTime(value: boolean);
  59761. /**
  59762. * Instantiates a new engine instrumentation.
  59763. * This class can be used to get instrumentation data from a Babylon engine
  59764. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  59765. * @param engine Defines the engine to instrument
  59766. */
  59767. constructor(
  59768. /**
  59769. * Define the instrumented engine.
  59770. */
  59771. engine: Engine);
  59772. /**
  59773. * Dispose and release associated resources.
  59774. */
  59775. dispose(): void;
  59776. }
  59777. }
  59778. declare module "babylonjs/Instrumentation/sceneInstrumentation" {
  59779. import { Scene, IDisposable } from "babylonjs/scene";
  59780. import { PerfCounter } from "babylonjs/Misc/perfCounter";
  59781. /**
  59782. * This class can be used to get instrumentation data from a Babylon engine
  59783. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#sceneinstrumentation
  59784. */
  59785. export class SceneInstrumentation implements IDisposable {
  59786. /**
  59787. * Defines the scene to instrument
  59788. */
  59789. scene: Scene;
  59790. private _captureActiveMeshesEvaluationTime;
  59791. private _activeMeshesEvaluationTime;
  59792. private _captureRenderTargetsRenderTime;
  59793. private _renderTargetsRenderTime;
  59794. private _captureFrameTime;
  59795. private _frameTime;
  59796. private _captureRenderTime;
  59797. private _renderTime;
  59798. private _captureInterFrameTime;
  59799. private _interFrameTime;
  59800. private _captureParticlesRenderTime;
  59801. private _particlesRenderTime;
  59802. private _captureSpritesRenderTime;
  59803. private _spritesRenderTime;
  59804. private _capturePhysicsTime;
  59805. private _physicsTime;
  59806. private _captureAnimationsTime;
  59807. private _animationsTime;
  59808. private _captureCameraRenderTime;
  59809. private _cameraRenderTime;
  59810. private _onBeforeActiveMeshesEvaluationObserver;
  59811. private _onAfterActiveMeshesEvaluationObserver;
  59812. private _onBeforeRenderTargetsRenderObserver;
  59813. private _onAfterRenderTargetsRenderObserver;
  59814. private _onAfterRenderObserver;
  59815. private _onBeforeDrawPhaseObserver;
  59816. private _onAfterDrawPhaseObserver;
  59817. private _onBeforeAnimationsObserver;
  59818. private _onBeforeParticlesRenderingObserver;
  59819. private _onAfterParticlesRenderingObserver;
  59820. private _onBeforeSpritesRenderingObserver;
  59821. private _onAfterSpritesRenderingObserver;
  59822. private _onBeforePhysicsObserver;
  59823. private _onAfterPhysicsObserver;
  59824. private _onAfterAnimationsObserver;
  59825. private _onBeforeCameraRenderObserver;
  59826. private _onAfterCameraRenderObserver;
  59827. /**
  59828. * Gets the perf counter used for active meshes evaluation time
  59829. */
  59830. get activeMeshesEvaluationTimeCounter(): PerfCounter;
  59831. /**
  59832. * Gets the active meshes evaluation time capture status
  59833. */
  59834. get captureActiveMeshesEvaluationTime(): boolean;
  59835. /**
  59836. * Enable or disable the active meshes evaluation time capture
  59837. */
  59838. set captureActiveMeshesEvaluationTime(value: boolean);
  59839. /**
  59840. * Gets the perf counter used for render targets render time
  59841. */
  59842. get renderTargetsRenderTimeCounter(): PerfCounter;
  59843. /**
  59844. * Gets the render targets render time capture status
  59845. */
  59846. get captureRenderTargetsRenderTime(): boolean;
  59847. /**
  59848. * Enable or disable the render targets render time capture
  59849. */
  59850. set captureRenderTargetsRenderTime(value: boolean);
  59851. /**
  59852. * Gets the perf counter used for particles render time
  59853. */
  59854. get particlesRenderTimeCounter(): PerfCounter;
  59855. /**
  59856. * Gets the particles render time capture status
  59857. */
  59858. get captureParticlesRenderTime(): boolean;
  59859. /**
  59860. * Enable or disable the particles render time capture
  59861. */
  59862. set captureParticlesRenderTime(value: boolean);
  59863. /**
  59864. * Gets the perf counter used for sprites render time
  59865. */
  59866. get spritesRenderTimeCounter(): PerfCounter;
  59867. /**
  59868. * Gets the sprites render time capture status
  59869. */
  59870. get captureSpritesRenderTime(): boolean;
  59871. /**
  59872. * Enable or disable the sprites render time capture
  59873. */
  59874. set captureSpritesRenderTime(value: boolean);
  59875. /**
  59876. * Gets the perf counter used for physics time
  59877. */
  59878. get physicsTimeCounter(): PerfCounter;
  59879. /**
  59880. * Gets the physics time capture status
  59881. */
  59882. get capturePhysicsTime(): boolean;
  59883. /**
  59884. * Enable or disable the physics time capture
  59885. */
  59886. set capturePhysicsTime(value: boolean);
  59887. /**
  59888. * Gets the perf counter used for animations time
  59889. */
  59890. get animationsTimeCounter(): PerfCounter;
  59891. /**
  59892. * Gets the animations time capture status
  59893. */
  59894. get captureAnimationsTime(): boolean;
  59895. /**
  59896. * Enable or disable the animations time capture
  59897. */
  59898. set captureAnimationsTime(value: boolean);
  59899. /**
  59900. * Gets the perf counter used for frame time capture
  59901. */
  59902. get frameTimeCounter(): PerfCounter;
  59903. /**
  59904. * Gets the frame time capture status
  59905. */
  59906. get captureFrameTime(): boolean;
  59907. /**
  59908. * Enable or disable the frame time capture
  59909. */
  59910. set captureFrameTime(value: boolean);
  59911. /**
  59912. * Gets the perf counter used for inter-frames time capture
  59913. */
  59914. get interFrameTimeCounter(): PerfCounter;
  59915. /**
  59916. * Gets the inter-frames time capture status
  59917. */
  59918. get captureInterFrameTime(): boolean;
  59919. /**
  59920. * Enable or disable the inter-frames time capture
  59921. */
  59922. set captureInterFrameTime(value: boolean);
  59923. /**
  59924. * Gets the perf counter used for render time capture
  59925. */
  59926. get renderTimeCounter(): PerfCounter;
  59927. /**
  59928. * Gets the render time capture status
  59929. */
  59930. get captureRenderTime(): boolean;
  59931. /**
  59932. * Enable or disable the render time capture
  59933. */
  59934. set captureRenderTime(value: boolean);
  59935. /**
  59936. * Gets the perf counter used for camera render time capture
  59937. */
  59938. get cameraRenderTimeCounter(): PerfCounter;
  59939. /**
  59940. * Gets the camera render time capture status
  59941. */
  59942. get captureCameraRenderTime(): boolean;
  59943. /**
  59944. * Enable or disable the camera render time capture
  59945. */
  59946. set captureCameraRenderTime(value: boolean);
  59947. /**
  59948. * Gets the perf counter used for draw calls
  59949. */
  59950. get drawCallsCounter(): PerfCounter;
  59951. /**
  59952. * Instantiates a new scene instrumentation.
  59953. * This class can be used to get instrumentation data from a Babylon engine
  59954. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#sceneinstrumentation
  59955. * @param scene Defines the scene to instrument
  59956. */
  59957. constructor(
  59958. /**
  59959. * Defines the scene to instrument
  59960. */
  59961. scene: Scene);
  59962. /**
  59963. * Dispose and release associated resources.
  59964. */
  59965. dispose(): void;
  59966. }
  59967. }
  59968. declare module "babylonjs/Instrumentation/index" {
  59969. export * from "babylonjs/Instrumentation/engineInstrumentation";
  59970. export * from "babylonjs/Instrumentation/sceneInstrumentation";
  59971. export * from "babylonjs/Instrumentation/timeToken";
  59972. }
  59973. declare module "babylonjs/Shaders/glowMapGeneration.fragment" {
  59974. /** @hidden */
  59975. export var glowMapGenerationPixelShader: {
  59976. name: string;
  59977. shader: string;
  59978. };
  59979. }
  59980. declare module "babylonjs/Shaders/glowMapGeneration.vertex" {
  59981. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  59982. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  59983. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  59984. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  59985. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  59986. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  59987. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  59988. /** @hidden */
  59989. export var glowMapGenerationVertexShader: {
  59990. name: string;
  59991. shader: string;
  59992. };
  59993. }
  59994. declare module "babylonjs/Layers/effectLayer" {
  59995. import { Observable } from "babylonjs/Misc/observable";
  59996. import { Nullable } from "babylonjs/types";
  59997. import { Camera } from "babylonjs/Cameras/camera";
  59998. import { Scene } from "babylonjs/scene";
  59999. import { ISize } from "babylonjs/Maths/math.size";
  60000. import { Color4 } from "babylonjs/Maths/math.color";
  60001. import { Engine } from "babylonjs/Engines/engine";
  60002. import { SubMesh } from "babylonjs/Meshes/subMesh";
  60003. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  60004. import { Mesh } from "babylonjs/Meshes/mesh";
  60005. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  60006. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  60007. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  60008. import { Effect } from "babylonjs/Materials/effect";
  60009. import { Material } from "babylonjs/Materials/material";
  60010. import "babylonjs/Shaders/glowMapGeneration.fragment";
  60011. import "babylonjs/Shaders/glowMapGeneration.vertex";
  60012. /**
  60013. * Effect layer options. This helps customizing the behaviour
  60014. * of the effect layer.
  60015. */
  60016. export interface IEffectLayerOptions {
  60017. /**
  60018. * Multiplication factor apply to the canvas size to compute the render target size
  60019. * used to generated the objects (the smaller the faster).
  60020. */
  60021. mainTextureRatio: number;
  60022. /**
  60023. * Enforces a fixed size texture to ensure effect stability across devices.
  60024. */
  60025. mainTextureFixedSize?: number;
  60026. /**
  60027. * Alpha blending mode used to apply the blur. Default depends of the implementation.
  60028. */
  60029. alphaBlendingMode: number;
  60030. /**
  60031. * The camera attached to the layer.
  60032. */
  60033. camera: Nullable<Camera>;
  60034. /**
  60035. * The rendering group to draw the layer in.
  60036. */
  60037. renderingGroupId: number;
  60038. }
  60039. /**
  60040. * The effect layer Helps adding post process effect blended with the main pass.
  60041. *
  60042. * This can be for instance use to generate glow or higlight effects on the scene.
  60043. *
  60044. * The effect layer class can not be used directly and is intented to inherited from to be
  60045. * customized per effects.
  60046. */
  60047. export abstract class EffectLayer {
  60048. private _vertexBuffers;
  60049. private _indexBuffer;
  60050. private _cachedDefines;
  60051. private _effectLayerMapGenerationEffect;
  60052. private _effectLayerOptions;
  60053. private _mergeEffect;
  60054. protected _scene: Scene;
  60055. protected _engine: Engine;
  60056. protected _maxSize: number;
  60057. protected _mainTextureDesiredSize: ISize;
  60058. protected _mainTexture: RenderTargetTexture;
  60059. protected _shouldRender: boolean;
  60060. protected _postProcesses: PostProcess[];
  60061. protected _textures: BaseTexture[];
  60062. protected _emissiveTextureAndColor: {
  60063. texture: Nullable<BaseTexture>;
  60064. color: Color4;
  60065. };
  60066. /**
  60067. * The name of the layer
  60068. */
  60069. name: string;
  60070. /**
  60071. * The clear color of the texture used to generate the glow map.
  60072. */
  60073. neutralColor: Color4;
  60074. /**
  60075. * Specifies whether the highlight layer is enabled or not.
  60076. */
  60077. isEnabled: boolean;
  60078. /**
  60079. * Gets the camera attached to the layer.
  60080. */
  60081. get camera(): Nullable<Camera>;
  60082. /**
  60083. * Gets the rendering group id the layer should render in.
  60084. */
  60085. get renderingGroupId(): number;
  60086. set renderingGroupId(renderingGroupId: number);
  60087. /**
  60088. * An event triggered when the effect layer has been disposed.
  60089. */
  60090. onDisposeObservable: Observable<EffectLayer>;
  60091. /**
  60092. * An event triggered when the effect layer is about rendering the main texture with the glowy parts.
  60093. */
  60094. onBeforeRenderMainTextureObservable: Observable<EffectLayer>;
  60095. /**
  60096. * An event triggered when the generated texture is being merged in the scene.
  60097. */
  60098. onBeforeComposeObservable: Observable<EffectLayer>;
  60099. /**
  60100. * An event triggered when the mesh is rendered into the effect render target.
  60101. */
  60102. onBeforeRenderMeshToEffect: Observable<AbstractMesh>;
  60103. /**
  60104. * An event triggered after the mesh has been rendered into the effect render target.
  60105. */
  60106. onAfterRenderMeshToEffect: Observable<AbstractMesh>;
  60107. /**
  60108. * An event triggered when the generated texture has been merged in the scene.
  60109. */
  60110. onAfterComposeObservable: Observable<EffectLayer>;
  60111. /**
  60112. * An event triggered when the efffect layer changes its size.
  60113. */
  60114. onSizeChangedObservable: Observable<EffectLayer>;
  60115. /** @hidden */
  60116. static _SceneComponentInitialization: (scene: Scene) => void;
  60117. /**
  60118. * Instantiates a new effect Layer and references it in the scene.
  60119. * @param name The name of the layer
  60120. * @param scene The scene to use the layer in
  60121. */
  60122. constructor(
  60123. /** The Friendly of the effect in the scene */
  60124. name: string, scene: Scene);
  60125. /**
  60126. * Get the effect name of the layer.
  60127. * @return The effect name
  60128. */
  60129. abstract getEffectName(): string;
  60130. /**
  60131. * Checks for the readiness of the element composing the layer.
  60132. * @param subMesh the mesh to check for
  60133. * @param useInstances specify whether or not to use instances to render the mesh
  60134. * @return true if ready otherwise, false
  60135. */
  60136. abstract isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  60137. /**
  60138. * Returns whether or nood the layer needs stencil enabled during the mesh rendering.
  60139. * @returns true if the effect requires stencil during the main canvas render pass.
  60140. */
  60141. abstract needStencil(): boolean;
  60142. /**
  60143. * Create the merge effect. This is the shader use to blit the information back
  60144. * to the main canvas at the end of the scene rendering.
  60145. * @returns The effect containing the shader used to merge the effect on the main canvas
  60146. */
  60147. protected abstract _createMergeEffect(): Effect;
  60148. /**
  60149. * Creates the render target textures and post processes used in the effect layer.
  60150. */
  60151. protected abstract _createTextureAndPostProcesses(): void;
  60152. /**
  60153. * Implementation specific of rendering the generating effect on the main canvas.
  60154. * @param effect The effect used to render through
  60155. */
  60156. protected abstract _internalRender(effect: Effect): void;
  60157. /**
  60158. * Sets the required values for both the emissive texture and and the main color.
  60159. */
  60160. protected abstract _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  60161. /**
  60162. * Free any resources and references associated to a mesh.
  60163. * Internal use
  60164. * @param mesh The mesh to free.
  60165. */
  60166. abstract _disposeMesh(mesh: Mesh): void;
  60167. /**
  60168. * Serializes this layer (Glow or Highlight for example)
  60169. * @returns a serialized layer object
  60170. */
  60171. abstract serialize?(): any;
  60172. /**
  60173. * Initializes the effect layer with the required options.
  60174. * @param options Sets of none mandatory options to use with the layer (see IEffectLayerOptions for more information)
  60175. */
  60176. protected _init(options: Partial<IEffectLayerOptions>): void;
  60177. /**
  60178. * Generates the index buffer of the full screen quad blending to the main canvas.
  60179. */
  60180. private _generateIndexBuffer;
  60181. /**
  60182. * Generates the vertex buffer of the full screen quad blending to the main canvas.
  60183. */
  60184. private _generateVertexBuffer;
  60185. /**
  60186. * Sets the main texture desired size which is the closest power of two
  60187. * of the engine canvas size.
  60188. */
  60189. private _setMainTextureSize;
  60190. /**
  60191. * Creates the main texture for the effect layer.
  60192. */
  60193. protected _createMainTexture(): void;
  60194. /**
  60195. * Adds specific effects defines.
  60196. * @param defines The defines to add specifics to.
  60197. */
  60198. protected _addCustomEffectDefines(defines: string[]): void;
  60199. /**
  60200. * Checks for the readiness of the element composing the layer.
  60201. * @param subMesh the mesh to check for
  60202. * @param useInstances specify whether or not to use instances to render the mesh
  60203. * @param emissiveTexture the associated emissive texture used to generate the glow
  60204. * @return true if ready otherwise, false
  60205. */
  60206. protected _isReady(subMesh: SubMesh, useInstances: boolean, emissiveTexture: Nullable<BaseTexture>): boolean;
  60207. /**
  60208. * Renders the glowing part of the scene by blending the blurred glowing meshes on top of the rendered scene.
  60209. */
  60210. render(): void;
  60211. /**
  60212. * Determine if a given mesh will be used in the current effect.
  60213. * @param mesh mesh to test
  60214. * @returns true if the mesh will be used
  60215. */
  60216. hasMesh(mesh: AbstractMesh): boolean;
  60217. /**
  60218. * Returns true if the layer contains information to display, otherwise false.
  60219. * @returns true if the glow layer should be rendered
  60220. */
  60221. shouldRender(): boolean;
  60222. /**
  60223. * Returns true if the mesh should render, otherwise false.
  60224. * @param mesh The mesh to render
  60225. * @returns true if it should render otherwise false
  60226. */
  60227. protected _shouldRenderMesh(mesh: AbstractMesh): boolean;
  60228. /**
  60229. * Returns true if the mesh can be rendered, otherwise false.
  60230. * @param mesh The mesh to render
  60231. * @param material The material used on the mesh
  60232. * @returns true if it can be rendered otherwise false
  60233. */
  60234. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  60235. /**
  60236. * Returns true if the mesh should render, otherwise false.
  60237. * @param mesh The mesh to render
  60238. * @returns true if it should render otherwise false
  60239. */
  60240. protected _shouldRenderEmissiveTextureForMesh(): boolean;
  60241. /**
  60242. * Renders the submesh passed in parameter to the generation map.
  60243. */
  60244. protected _renderSubMesh(subMesh: SubMesh, enableAlphaMode?: boolean): void;
  60245. /**
  60246. * Defines whether the current material of the mesh should be use to render the effect.
  60247. * @param mesh defines the current mesh to render
  60248. */
  60249. protected _useMeshMaterial(mesh: AbstractMesh): boolean;
  60250. /**
  60251. * Rebuild the required buffers.
  60252. * @hidden Internal use only.
  60253. */
  60254. _rebuild(): void;
  60255. /**
  60256. * Dispose only the render target textures and post process.
  60257. */
  60258. private _disposeTextureAndPostProcesses;
  60259. /**
  60260. * Dispose the highlight layer and free resources.
  60261. */
  60262. dispose(): void;
  60263. /**
  60264. * Gets the class name of the effect layer
  60265. * @returns the string with the class name of the effect layer
  60266. */
  60267. getClassName(): string;
  60268. /**
  60269. * Creates an effect layer from parsed effect layer data
  60270. * @param parsedEffectLayer defines effect layer data
  60271. * @param scene defines the current scene
  60272. * @param rootUrl defines the root URL containing the effect layer information
  60273. * @returns a parsed effect Layer
  60274. */
  60275. static Parse(parsedEffectLayer: any, scene: Scene, rootUrl: string): EffectLayer;
  60276. }
  60277. }
  60278. declare module "babylonjs/Layers/effectLayerSceneComponent" {
  60279. import { Scene } from "babylonjs/scene";
  60280. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  60281. import { EffectLayer } from "babylonjs/Layers/effectLayer";
  60282. import { AbstractScene } from "babylonjs/abstractScene";
  60283. module "babylonjs/abstractScene" {
  60284. interface AbstractScene {
  60285. /**
  60286. * The list of effect layers (highlights/glow) added to the scene
  60287. * @see https://doc.babylonjs.com/how_to/highlight_layer
  60288. * @see https://doc.babylonjs.com/how_to/glow_layer
  60289. */
  60290. effectLayers: Array<EffectLayer>;
  60291. /**
  60292. * Removes the given effect layer from this scene.
  60293. * @param toRemove defines the effect layer to remove
  60294. * @returns the index of the removed effect layer
  60295. */
  60296. removeEffectLayer(toRemove: EffectLayer): number;
  60297. /**
  60298. * Adds the given effect layer to this scene
  60299. * @param newEffectLayer defines the effect layer to add
  60300. */
  60301. addEffectLayer(newEffectLayer: EffectLayer): void;
  60302. }
  60303. }
  60304. /**
  60305. * Defines the layer scene component responsible to manage any effect layers
  60306. * in a given scene.
  60307. */
  60308. export class EffectLayerSceneComponent implements ISceneSerializableComponent {
  60309. /**
  60310. * The component name helpfull to identify the component in the list of scene components.
  60311. */
  60312. readonly name: string;
  60313. /**
  60314. * The scene the component belongs to.
  60315. */
  60316. scene: Scene;
  60317. private _engine;
  60318. private _renderEffects;
  60319. private _needStencil;
  60320. private _previousStencilState;
  60321. /**
  60322. * Creates a new instance of the component for the given scene
  60323. * @param scene Defines the scene to register the component in
  60324. */
  60325. constructor(scene: Scene);
  60326. /**
  60327. * Registers the component in a given scene
  60328. */
  60329. register(): void;
  60330. /**
  60331. * Rebuilds the elements related to this component in case of
  60332. * context lost for instance.
  60333. */
  60334. rebuild(): void;
  60335. /**
  60336. * Serializes the component data to the specified json object
  60337. * @param serializationObject The object to serialize to
  60338. */
  60339. serialize(serializationObject: any): void;
  60340. /**
  60341. * Adds all the elements from the container to the scene
  60342. * @param container the container holding the elements
  60343. */
  60344. addFromContainer(container: AbstractScene): void;
  60345. /**
  60346. * Removes all the elements in the container from the scene
  60347. * @param container contains the elements to remove
  60348. * @param dispose if the removed element should be disposed (default: false)
  60349. */
  60350. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  60351. /**
  60352. * Disposes the component and the associated ressources.
  60353. */
  60354. dispose(): void;
  60355. private _isReadyForMesh;
  60356. private _renderMainTexture;
  60357. private _setStencil;
  60358. private _setStencilBack;
  60359. private _draw;
  60360. private _drawCamera;
  60361. private _drawRenderingGroup;
  60362. }
  60363. }
  60364. declare module "babylonjs/Shaders/glowMapMerge.fragment" {
  60365. /** @hidden */
  60366. export var glowMapMergePixelShader: {
  60367. name: string;
  60368. shader: string;
  60369. };
  60370. }
  60371. declare module "babylonjs/Shaders/glowMapMerge.vertex" {
  60372. /** @hidden */
  60373. export var glowMapMergeVertexShader: {
  60374. name: string;
  60375. shader: string;
  60376. };
  60377. }
  60378. declare module "babylonjs/Layers/glowLayer" {
  60379. import { Nullable } from "babylonjs/types";
  60380. import { Camera } from "babylonjs/Cameras/camera";
  60381. import { Scene } from "babylonjs/scene";
  60382. import { SubMesh } from "babylonjs/Meshes/subMesh";
  60383. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  60384. import { Mesh } from "babylonjs/Meshes/mesh";
  60385. import { Texture } from "babylonjs/Materials/Textures/texture";
  60386. import { Effect } from "babylonjs/Materials/effect";
  60387. import { Material } from "babylonjs/Materials/material";
  60388. import { EffectLayer } from "babylonjs/Layers/effectLayer";
  60389. import { Color4 } from "babylonjs/Maths/math.color";
  60390. import "babylonjs/Shaders/glowMapMerge.fragment";
  60391. import "babylonjs/Shaders/glowMapMerge.vertex";
  60392. import "babylonjs/Layers/effectLayerSceneComponent";
  60393. module "babylonjs/abstractScene" {
  60394. interface AbstractScene {
  60395. /**
  60396. * Return a the first highlight layer of the scene with a given name.
  60397. * @param name The name of the highlight layer to look for.
  60398. * @return The highlight layer if found otherwise null.
  60399. */
  60400. getGlowLayerByName(name: string): Nullable<GlowLayer>;
  60401. }
  60402. }
  60403. /**
  60404. * Glow layer options. This helps customizing the behaviour
  60405. * of the glow layer.
  60406. */
  60407. export interface IGlowLayerOptions {
  60408. /**
  60409. * Multiplication factor apply to the canvas size to compute the render target size
  60410. * used to generated the glowing objects (the smaller the faster).
  60411. */
  60412. mainTextureRatio: number;
  60413. /**
  60414. * Enforces a fixed size texture to ensure resize independant blur.
  60415. */
  60416. mainTextureFixedSize?: number;
  60417. /**
  60418. * How big is the kernel of the blur texture.
  60419. */
  60420. blurKernelSize: number;
  60421. /**
  60422. * The camera attached to the layer.
  60423. */
  60424. camera: Nullable<Camera>;
  60425. /**
  60426. * Enable MSAA by chosing the number of samples.
  60427. */
  60428. mainTextureSamples?: number;
  60429. /**
  60430. * The rendering group to draw the layer in.
  60431. */
  60432. renderingGroupId: number;
  60433. }
  60434. /**
  60435. * The glow layer Helps adding a glow effect around the emissive parts of a mesh.
  60436. *
  60437. * Once instantiated in a scene, by default, all the emissive meshes will glow.
  60438. *
  60439. * Documentation: https://doc.babylonjs.com/how_to/glow_layer
  60440. */
  60441. export class GlowLayer extends EffectLayer {
  60442. /**
  60443. * Effect Name of the layer.
  60444. */
  60445. static readonly EffectName: string;
  60446. /**
  60447. * The default blur kernel size used for the glow.
  60448. */
  60449. static DefaultBlurKernelSize: number;
  60450. /**
  60451. * The default texture size ratio used for the glow.
  60452. */
  60453. static DefaultTextureRatio: number;
  60454. /**
  60455. * Sets the kernel size of the blur.
  60456. */
  60457. set blurKernelSize(value: number);
  60458. /**
  60459. * Gets the kernel size of the blur.
  60460. */
  60461. get blurKernelSize(): number;
  60462. /**
  60463. * Sets the glow intensity.
  60464. */
  60465. set intensity(value: number);
  60466. /**
  60467. * Gets the glow intensity.
  60468. */
  60469. get intensity(): number;
  60470. private _options;
  60471. private _intensity;
  60472. private _horizontalBlurPostprocess1;
  60473. private _verticalBlurPostprocess1;
  60474. private _horizontalBlurPostprocess2;
  60475. private _verticalBlurPostprocess2;
  60476. private _blurTexture1;
  60477. private _blurTexture2;
  60478. private _postProcesses1;
  60479. private _postProcesses2;
  60480. private _includedOnlyMeshes;
  60481. private _excludedMeshes;
  60482. private _meshesUsingTheirOwnMaterials;
  60483. /**
  60484. * Callback used to let the user override the color selection on a per mesh basis
  60485. */
  60486. customEmissiveColorSelector: (mesh: Mesh, subMesh: SubMesh, material: Material, result: Color4) => void;
  60487. /**
  60488. * Callback used to let the user override the texture selection on a per mesh basis
  60489. */
  60490. customEmissiveTextureSelector: (mesh: Mesh, subMesh: SubMesh, material: Material) => Texture;
  60491. /**
  60492. * Instantiates a new glow Layer and references it to the scene.
  60493. * @param name The name of the layer
  60494. * @param scene The scene to use the layer in
  60495. * @param options Sets of none mandatory options to use with the layer (see IGlowLayerOptions for more information)
  60496. */
  60497. constructor(name: string, scene: Scene, options?: Partial<IGlowLayerOptions>);
  60498. /**
  60499. * Get the effect name of the layer.
  60500. * @return The effect name
  60501. */
  60502. getEffectName(): string;
  60503. /**
  60504. * Create the merge effect. This is the shader use to blit the information back
  60505. * to the main canvas at the end of the scene rendering.
  60506. */
  60507. protected _createMergeEffect(): Effect;
  60508. /**
  60509. * Creates the render target textures and post processes used in the glow layer.
  60510. */
  60511. protected _createTextureAndPostProcesses(): void;
  60512. /**
  60513. * Checks for the readiness of the element composing the layer.
  60514. * @param subMesh the mesh to check for
  60515. * @param useInstances specify wether or not to use instances to render the mesh
  60516. * @param emissiveTexture the associated emissive texture used to generate the glow
  60517. * @return true if ready otherwise, false
  60518. */
  60519. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  60520. /**
  60521. * Returns whether or nood the layer needs stencil enabled during the mesh rendering.
  60522. */
  60523. needStencil(): boolean;
  60524. /**
  60525. * Returns true if the mesh can be rendered, otherwise false.
  60526. * @param mesh The mesh to render
  60527. * @param material The material used on the mesh
  60528. * @returns true if it can be rendered otherwise false
  60529. */
  60530. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  60531. /**
  60532. * Implementation specific of rendering the generating effect on the main canvas.
  60533. * @param effect The effect used to render through
  60534. */
  60535. protected _internalRender(effect: Effect): void;
  60536. /**
  60537. * Sets the required values for both the emissive texture and and the main color.
  60538. */
  60539. protected _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  60540. /**
  60541. * Returns true if the mesh should render, otherwise false.
  60542. * @param mesh The mesh to render
  60543. * @returns true if it should render otherwise false
  60544. */
  60545. protected _shouldRenderMesh(mesh: Mesh): boolean;
  60546. /**
  60547. * Adds specific effects defines.
  60548. * @param defines The defines to add specifics to.
  60549. */
  60550. protected _addCustomEffectDefines(defines: string[]): void;
  60551. /**
  60552. * Add a mesh in the exclusion list to prevent it to impact or being impacted by the glow layer.
  60553. * @param mesh The mesh to exclude from the glow layer
  60554. */
  60555. addExcludedMesh(mesh: Mesh): void;
  60556. /**
  60557. * Remove a mesh from the exclusion list to let it impact or being impacted by the glow layer.
  60558. * @param mesh The mesh to remove
  60559. */
  60560. removeExcludedMesh(mesh: Mesh): void;
  60561. /**
  60562. * Add a mesh in the inclusion list to impact or being impacted by the glow layer.
  60563. * @param mesh The mesh to include in the glow layer
  60564. */
  60565. addIncludedOnlyMesh(mesh: Mesh): void;
  60566. /**
  60567. * Remove a mesh from the Inclusion list to prevent it to impact or being impacted by the glow layer.
  60568. * @param mesh The mesh to remove
  60569. */
  60570. removeIncludedOnlyMesh(mesh: Mesh): void;
  60571. /**
  60572. * Determine if a given mesh will be used in the glow layer
  60573. * @param mesh The mesh to test
  60574. * @returns true if the mesh will be highlighted by the current glow layer
  60575. */
  60576. hasMesh(mesh: AbstractMesh): boolean;
  60577. /**
  60578. * Defines whether the current material of the mesh should be use to render the effect.
  60579. * @param mesh defines the current mesh to render
  60580. */
  60581. protected _useMeshMaterial(mesh: AbstractMesh): boolean;
  60582. /**
  60583. * Add a mesh to be rendered through its own material and not with emissive only.
  60584. * @param mesh The mesh for which we need to use its material
  60585. */
  60586. referenceMeshToUseItsOwnMaterial(mesh: AbstractMesh): void;
  60587. /**
  60588. * Remove a mesh from being rendered through its own material and not with emissive only.
  60589. * @param mesh The mesh for which we need to not use its material
  60590. */
  60591. unReferenceMeshFromUsingItsOwnMaterial(mesh: AbstractMesh): void;
  60592. /**
  60593. * Free any resources and references associated to a mesh.
  60594. * Internal use
  60595. * @param mesh The mesh to free.
  60596. * @hidden
  60597. */
  60598. _disposeMesh(mesh: Mesh): void;
  60599. /**
  60600. * Gets the class name of the effect layer
  60601. * @returns the string with the class name of the effect layer
  60602. */
  60603. getClassName(): string;
  60604. /**
  60605. * Serializes this glow layer
  60606. * @returns a serialized glow layer object
  60607. */
  60608. serialize(): any;
  60609. /**
  60610. * Creates a Glow Layer from parsed glow layer data
  60611. * @param parsedGlowLayer defines glow layer data
  60612. * @param scene defines the current scene
  60613. * @param rootUrl defines the root URL containing the glow layer information
  60614. * @returns a parsed Glow Layer
  60615. */
  60616. static Parse(parsedGlowLayer: any, scene: Scene, rootUrl: string): GlowLayer;
  60617. }
  60618. }
  60619. declare module "babylonjs/Shaders/glowBlurPostProcess.fragment" {
  60620. /** @hidden */
  60621. export var glowBlurPostProcessPixelShader: {
  60622. name: string;
  60623. shader: string;
  60624. };
  60625. }
  60626. declare module "babylonjs/Layers/highlightLayer" {
  60627. import { Observable } from "babylonjs/Misc/observable";
  60628. import { Nullable } from "babylonjs/types";
  60629. import { Camera } from "babylonjs/Cameras/camera";
  60630. import { Scene } from "babylonjs/scene";
  60631. import { SubMesh } from "babylonjs/Meshes/subMesh";
  60632. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  60633. import { Mesh } from "babylonjs/Meshes/mesh";
  60634. import { Effect } from "babylonjs/Materials/effect";
  60635. import { Material } from "babylonjs/Materials/material";
  60636. import { EffectLayer } from "babylonjs/Layers/effectLayer";
  60637. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  60638. import "babylonjs/Shaders/glowMapMerge.fragment";
  60639. import "babylonjs/Shaders/glowMapMerge.vertex";
  60640. import "babylonjs/Shaders/glowBlurPostProcess.fragment";
  60641. module "babylonjs/abstractScene" {
  60642. interface AbstractScene {
  60643. /**
  60644. * Return a the first highlight layer of the scene with a given name.
  60645. * @param name The name of the highlight layer to look for.
  60646. * @return The highlight layer if found otherwise null.
  60647. */
  60648. getHighlightLayerByName(name: string): Nullable<HighlightLayer>;
  60649. }
  60650. }
  60651. /**
  60652. * Highlight layer options. This helps customizing the behaviour
  60653. * of the highlight layer.
  60654. */
  60655. export interface IHighlightLayerOptions {
  60656. /**
  60657. * Multiplication factor apply to the canvas size to compute the render target size
  60658. * used to generated the glowing objects (the smaller the faster).
  60659. */
  60660. mainTextureRatio: number;
  60661. /**
  60662. * Enforces a fixed size texture to ensure resize independant blur.
  60663. */
  60664. mainTextureFixedSize?: number;
  60665. /**
  60666. * Multiplication factor apply to the main texture size in the first step of the blur to reduce the size
  60667. * of the picture to blur (the smaller the faster).
  60668. */
  60669. blurTextureSizeRatio: number;
  60670. /**
  60671. * How big in texel of the blur texture is the vertical blur.
  60672. */
  60673. blurVerticalSize: number;
  60674. /**
  60675. * How big in texel of the blur texture is the horizontal blur.
  60676. */
  60677. blurHorizontalSize: number;
  60678. /**
  60679. * Alpha blending mode used to apply the blur. Default is combine.
  60680. */
  60681. alphaBlendingMode: number;
  60682. /**
  60683. * The camera attached to the layer.
  60684. */
  60685. camera: Nullable<Camera>;
  60686. /**
  60687. * Should we display highlight as a solid stroke?
  60688. */
  60689. isStroke?: boolean;
  60690. /**
  60691. * The rendering group to draw the layer in.
  60692. */
  60693. renderingGroupId: number;
  60694. }
  60695. /**
  60696. * The highlight layer Helps adding a glow effect around a mesh.
  60697. *
  60698. * Once instantiated in a scene, simply use the addMesh or removeMesh method to add or remove
  60699. * glowy meshes to your scene.
  60700. *
  60701. * !!! THIS REQUIRES AN ACTIVE STENCIL BUFFER ON THE CANVAS !!!
  60702. */
  60703. export class HighlightLayer extends EffectLayer {
  60704. name: string;
  60705. /**
  60706. * Effect Name of the highlight layer.
  60707. */
  60708. static readonly EffectName: string;
  60709. /**
  60710. * The neutral color used during the preparation of the glow effect.
  60711. * This is black by default as the blend operation is a blend operation.
  60712. */
  60713. static NeutralColor: Color4;
  60714. /**
  60715. * Stencil value used for glowing meshes.
  60716. */
  60717. static GlowingMeshStencilReference: number;
  60718. /**
  60719. * Stencil value used for the other meshes in the scene.
  60720. */
  60721. static NormalMeshStencilReference: number;
  60722. /**
  60723. * Specifies whether or not the inner glow is ACTIVE in the layer.
  60724. */
  60725. innerGlow: boolean;
  60726. /**
  60727. * Specifies whether or not the outer glow is ACTIVE in the layer.
  60728. */
  60729. outerGlow: boolean;
  60730. /**
  60731. * Specifies the horizontal size of the blur.
  60732. */
  60733. set blurHorizontalSize(value: number);
  60734. /**
  60735. * Specifies the vertical size of the blur.
  60736. */
  60737. set blurVerticalSize(value: number);
  60738. /**
  60739. * Gets the horizontal size of the blur.
  60740. */
  60741. get blurHorizontalSize(): number;
  60742. /**
  60743. * Gets the vertical size of the blur.
  60744. */
  60745. get blurVerticalSize(): number;
  60746. /**
  60747. * An event triggered when the highlight layer is being blurred.
  60748. */
  60749. onBeforeBlurObservable: Observable<HighlightLayer>;
  60750. /**
  60751. * An event triggered when the highlight layer has been blurred.
  60752. */
  60753. onAfterBlurObservable: Observable<HighlightLayer>;
  60754. private _instanceGlowingMeshStencilReference;
  60755. private _options;
  60756. private _downSamplePostprocess;
  60757. private _horizontalBlurPostprocess;
  60758. private _verticalBlurPostprocess;
  60759. private _blurTexture;
  60760. private _meshes;
  60761. private _excludedMeshes;
  60762. /**
  60763. * Instantiates a new highlight Layer and references it to the scene..
  60764. * @param name The name of the layer
  60765. * @param scene The scene to use the layer in
  60766. * @param options Sets of none mandatory options to use with the layer (see IHighlightLayerOptions for more information)
  60767. */
  60768. constructor(name: string, scene: Scene, options?: Partial<IHighlightLayerOptions>);
  60769. /**
  60770. * Get the effect name of the layer.
  60771. * @return The effect name
  60772. */
  60773. getEffectName(): string;
  60774. /**
  60775. * Create the merge effect. This is the shader use to blit the information back
  60776. * to the main canvas at the end of the scene rendering.
  60777. */
  60778. protected _createMergeEffect(): Effect;
  60779. /**
  60780. * Creates the render target textures and post processes used in the highlight layer.
  60781. */
  60782. protected _createTextureAndPostProcesses(): void;
  60783. /**
  60784. * Returns wether or nood the layer needs stencil enabled during the mesh rendering.
  60785. */
  60786. needStencil(): boolean;
  60787. /**
  60788. * Checks for the readiness of the element composing the layer.
  60789. * @param subMesh the mesh to check for
  60790. * @param useInstances specify wether or not to use instances to render the mesh
  60791. * @param emissiveTexture the associated emissive texture used to generate the glow
  60792. * @return true if ready otherwise, false
  60793. */
  60794. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  60795. /**
  60796. * Implementation specific of rendering the generating effect on the main canvas.
  60797. * @param effect The effect used to render through
  60798. */
  60799. protected _internalRender(effect: Effect): void;
  60800. /**
  60801. * Returns true if the layer contains information to display, otherwise false.
  60802. */
  60803. shouldRender(): boolean;
  60804. /**
  60805. * Returns true if the mesh should render, otherwise false.
  60806. * @param mesh The mesh to render
  60807. * @returns true if it should render otherwise false
  60808. */
  60809. protected _shouldRenderMesh(mesh: Mesh): boolean;
  60810. /**
  60811. * Returns true if the mesh can be rendered, otherwise false.
  60812. * @param mesh The mesh to render
  60813. * @param material The material used on the mesh
  60814. * @returns true if it can be rendered otherwise false
  60815. */
  60816. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  60817. /**
  60818. * Adds specific effects defines.
  60819. * @param defines The defines to add specifics to.
  60820. */
  60821. protected _addCustomEffectDefines(defines: string[]): void;
  60822. /**
  60823. * Sets the required values for both the emissive texture and and the main color.
  60824. */
  60825. protected _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  60826. /**
  60827. * Add a mesh in the exclusion list to prevent it to impact or being impacted by the highlight layer.
  60828. * @param mesh The mesh to exclude from the highlight layer
  60829. */
  60830. addExcludedMesh(mesh: Mesh): void;
  60831. /**
  60832. * Remove a mesh from the exclusion list to let it impact or being impacted by the highlight layer.
  60833. * @param mesh The mesh to highlight
  60834. */
  60835. removeExcludedMesh(mesh: Mesh): void;
  60836. /**
  60837. * Determine if a given mesh will be highlighted by the current HighlightLayer
  60838. * @param mesh mesh to test
  60839. * @returns true if the mesh will be highlighted by the current HighlightLayer
  60840. */
  60841. hasMesh(mesh: AbstractMesh): boolean;
  60842. /**
  60843. * Add a mesh in the highlight layer in order to make it glow with the chosen color.
  60844. * @param mesh The mesh to highlight
  60845. * @param color The color of the highlight
  60846. * @param glowEmissiveOnly Extract the glow from the emissive texture
  60847. */
  60848. addMesh(mesh: Mesh, color: Color3, glowEmissiveOnly?: boolean): void;
  60849. /**
  60850. * Remove a mesh from the highlight layer in order to make it stop glowing.
  60851. * @param mesh The mesh to highlight
  60852. */
  60853. removeMesh(mesh: Mesh): void;
  60854. /**
  60855. * Remove all the meshes currently referenced in the highlight layer
  60856. */
  60857. removeAllMeshes(): void;
  60858. /**
  60859. * Force the stencil to the normal expected value for none glowing parts
  60860. */
  60861. private _defaultStencilReference;
  60862. /**
  60863. * Free any resources and references associated to a mesh.
  60864. * Internal use
  60865. * @param mesh The mesh to free.
  60866. * @hidden
  60867. */
  60868. _disposeMesh(mesh: Mesh): void;
  60869. /**
  60870. * Dispose the highlight layer and free resources.
  60871. */
  60872. dispose(): void;
  60873. /**
  60874. * Gets the class name of the effect layer
  60875. * @returns the string with the class name of the effect layer
  60876. */
  60877. getClassName(): string;
  60878. /**
  60879. * Serializes this Highlight layer
  60880. * @returns a serialized Highlight layer object
  60881. */
  60882. serialize(): any;
  60883. /**
  60884. * Creates a Highlight layer from parsed Highlight layer data
  60885. * @param parsedHightlightLayer defines the Highlight layer data
  60886. * @param scene defines the current scene
  60887. * @param rootUrl defines the root URL containing the Highlight layer information
  60888. * @returns a parsed Highlight layer
  60889. */
  60890. static Parse(parsedHightlightLayer: any, scene: Scene, rootUrl: string): HighlightLayer;
  60891. }
  60892. }
  60893. declare module "babylonjs/Layers/layerSceneComponent" {
  60894. import { Scene } from "babylonjs/scene";
  60895. import { ISceneComponent } from "babylonjs/sceneComponent";
  60896. import { Layer } from "babylonjs/Layers/layer";
  60897. import { AbstractScene } from "babylonjs/abstractScene";
  60898. module "babylonjs/abstractScene" {
  60899. interface AbstractScene {
  60900. /**
  60901. * The list of layers (background and foreground) of the scene
  60902. */
  60903. layers: Array<Layer>;
  60904. }
  60905. }
  60906. /**
  60907. * Defines the layer scene component responsible to manage any layers
  60908. * in a given scene.
  60909. */
  60910. export class LayerSceneComponent implements ISceneComponent {
  60911. /**
  60912. * The component name helpfull to identify the component in the list of scene components.
  60913. */
  60914. readonly name: string;
  60915. /**
  60916. * The scene the component belongs to.
  60917. */
  60918. scene: Scene;
  60919. private _engine;
  60920. /**
  60921. * Creates a new instance of the component for the given scene
  60922. * @param scene Defines the scene to register the component in
  60923. */
  60924. constructor(scene: Scene);
  60925. /**
  60926. * Registers the component in a given scene
  60927. */
  60928. register(): void;
  60929. /**
  60930. * Rebuilds the elements related to this component in case of
  60931. * context lost for instance.
  60932. */
  60933. rebuild(): void;
  60934. /**
  60935. * Disposes the component and the associated ressources.
  60936. */
  60937. dispose(): void;
  60938. private _draw;
  60939. private _drawCameraPredicate;
  60940. private _drawCameraBackground;
  60941. private _drawCameraForeground;
  60942. private _drawRenderTargetPredicate;
  60943. private _drawRenderTargetBackground;
  60944. private _drawRenderTargetForeground;
  60945. /**
  60946. * Adds all the elements from the container to the scene
  60947. * @param container the container holding the elements
  60948. */
  60949. addFromContainer(container: AbstractScene): void;
  60950. /**
  60951. * Removes all the elements in the container from the scene
  60952. * @param container contains the elements to remove
  60953. * @param dispose if the removed element should be disposed (default: false)
  60954. */
  60955. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  60956. }
  60957. }
  60958. declare module "babylonjs/Shaders/layer.fragment" {
  60959. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  60960. /** @hidden */
  60961. export var layerPixelShader: {
  60962. name: string;
  60963. shader: string;
  60964. };
  60965. }
  60966. declare module "babylonjs/Shaders/layer.vertex" {
  60967. /** @hidden */
  60968. export var layerVertexShader: {
  60969. name: string;
  60970. shader: string;
  60971. };
  60972. }
  60973. declare module "babylonjs/Layers/layer" {
  60974. import { Observable } from "babylonjs/Misc/observable";
  60975. import { Nullable } from "babylonjs/types";
  60976. import { Scene } from "babylonjs/scene";
  60977. import { Vector2 } from "babylonjs/Maths/math.vector";
  60978. import { Color4 } from "babylonjs/Maths/math.color";
  60979. import { Texture } from "babylonjs/Materials/Textures/texture";
  60980. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  60981. import "babylonjs/Shaders/layer.fragment";
  60982. import "babylonjs/Shaders/layer.vertex";
  60983. /**
  60984. * This represents a full screen 2d layer.
  60985. * This can be useful to display a picture in the background of your scene for instance.
  60986. * @see https://www.babylonjs-playground.com/#08A2BS#1
  60987. */
  60988. export class Layer {
  60989. /**
  60990. * Define the name of the layer.
  60991. */
  60992. name: string;
  60993. /**
  60994. * Define the texture the layer should display.
  60995. */
  60996. texture: Nullable<Texture>;
  60997. /**
  60998. * Is the layer in background or foreground.
  60999. */
  61000. isBackground: boolean;
  61001. /**
  61002. * Define the color of the layer (instead of texture).
  61003. */
  61004. color: Color4;
  61005. /**
  61006. * Define the scale of the layer in order to zoom in out of the texture.
  61007. */
  61008. scale: Vector2;
  61009. /**
  61010. * Define an offset for the layer in order to shift the texture.
  61011. */
  61012. offset: Vector2;
  61013. /**
  61014. * Define the alpha blending mode used in the layer in case the texture or color has an alpha.
  61015. */
  61016. alphaBlendingMode: number;
  61017. /**
  61018. * Define if the layer should alpha test or alpha blend with the rest of the scene.
  61019. * Alpha test will not mix with the background color in case of transparency.
  61020. * It will either use the texture color or the background depending on the alpha value of the current pixel.
  61021. */
  61022. alphaTest: boolean;
  61023. /**
  61024. * Define a mask to restrict the layer to only some of the scene cameras.
  61025. */
  61026. layerMask: number;
  61027. /**
  61028. * Define the list of render target the layer is visible into.
  61029. */
  61030. renderTargetTextures: RenderTargetTexture[];
  61031. /**
  61032. * Define if the layer is only used in renderTarget or if it also
  61033. * renders in the main frame buffer of the canvas.
  61034. */
  61035. renderOnlyInRenderTargetTextures: boolean;
  61036. private _scene;
  61037. private _vertexBuffers;
  61038. private _indexBuffer;
  61039. private _effect;
  61040. private _previousDefines;
  61041. /**
  61042. * An event triggered when the layer is disposed.
  61043. */
  61044. onDisposeObservable: Observable<Layer>;
  61045. private _onDisposeObserver;
  61046. /**
  61047. * Back compatibility with callback before the onDisposeObservable existed.
  61048. * The set callback will be triggered when the layer has been disposed.
  61049. */
  61050. set onDispose(callback: () => void);
  61051. /**
  61052. * An event triggered before rendering the scene
  61053. */
  61054. onBeforeRenderObservable: Observable<Layer>;
  61055. private _onBeforeRenderObserver;
  61056. /**
  61057. * Back compatibility with callback before the onBeforeRenderObservable existed.
  61058. * The set callback will be triggered just before rendering the layer.
  61059. */
  61060. set onBeforeRender(callback: () => void);
  61061. /**
  61062. * An event triggered after rendering the scene
  61063. */
  61064. onAfterRenderObservable: Observable<Layer>;
  61065. private _onAfterRenderObserver;
  61066. /**
  61067. * Back compatibility with callback before the onAfterRenderObservable existed.
  61068. * The set callback will be triggered just after rendering the layer.
  61069. */
  61070. set onAfterRender(callback: () => void);
  61071. /**
  61072. * Instantiates a new layer.
  61073. * This represents a full screen 2d layer.
  61074. * This can be useful to display a picture in the background of your scene for instance.
  61075. * @see https://www.babylonjs-playground.com/#08A2BS#1
  61076. * @param name Define the name of the layer in the scene
  61077. * @param imgUrl Define the url of the texture to display in the layer
  61078. * @param scene Define the scene the layer belongs to
  61079. * @param isBackground Defines whether the layer is displayed in front or behind the scene
  61080. * @param color Defines a color for the layer
  61081. */
  61082. constructor(
  61083. /**
  61084. * Define the name of the layer.
  61085. */
  61086. name: string, imgUrl: Nullable<string>, scene: Nullable<Scene>, isBackground?: boolean, color?: Color4);
  61087. private _createIndexBuffer;
  61088. /** @hidden */
  61089. _rebuild(): void;
  61090. /**
  61091. * Renders the layer in the scene.
  61092. */
  61093. render(): void;
  61094. /**
  61095. * Disposes and releases the associated ressources.
  61096. */
  61097. dispose(): void;
  61098. }
  61099. }
  61100. declare module "babylonjs/Layers/index" {
  61101. export * from "babylonjs/Layers/effectLayer";
  61102. export * from "babylonjs/Layers/effectLayerSceneComponent";
  61103. export * from "babylonjs/Layers/glowLayer";
  61104. export * from "babylonjs/Layers/highlightLayer";
  61105. export * from "babylonjs/Layers/layer";
  61106. export * from "babylonjs/Layers/layerSceneComponent";
  61107. }
  61108. declare module "babylonjs/Shaders/lensFlare.fragment" {
  61109. /** @hidden */
  61110. export var lensFlarePixelShader: {
  61111. name: string;
  61112. shader: string;
  61113. };
  61114. }
  61115. declare module "babylonjs/Shaders/lensFlare.vertex" {
  61116. /** @hidden */
  61117. export var lensFlareVertexShader: {
  61118. name: string;
  61119. shader: string;
  61120. };
  61121. }
  61122. declare module "babylonjs/LensFlares/lensFlareSystem" {
  61123. import { Scene } from "babylonjs/scene";
  61124. import { Vector3 } from "babylonjs/Maths/math.vector";
  61125. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  61126. import { LensFlare } from "babylonjs/LensFlares/lensFlare";
  61127. import "babylonjs/Shaders/lensFlare.fragment";
  61128. import "babylonjs/Shaders/lensFlare.vertex";
  61129. import { Viewport } from "babylonjs/Maths/math.viewport";
  61130. /**
  61131. * This represents a Lens Flare System or the shiny effect created by the light reflection on the camera lenses.
  61132. * It is usually composed of several `lensFlare`.
  61133. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  61134. */
  61135. export class LensFlareSystem {
  61136. /**
  61137. * Define the name of the lens flare system
  61138. */
  61139. name: string;
  61140. /**
  61141. * List of lens flares used in this system.
  61142. */
  61143. lensFlares: LensFlare[];
  61144. /**
  61145. * Define a limit from the border the lens flare can be visible.
  61146. */
  61147. borderLimit: number;
  61148. /**
  61149. * Define a viewport border we do not want to see the lens flare in.
  61150. */
  61151. viewportBorder: number;
  61152. /**
  61153. * Define a predicate which could limit the list of meshes able to occlude the effect.
  61154. */
  61155. meshesSelectionPredicate: (mesh: AbstractMesh) => boolean;
  61156. /**
  61157. * Restricts the rendering of the effect to only the camera rendering this layer mask.
  61158. */
  61159. layerMask: number;
  61160. /**
  61161. * Define the id of the lens flare system in the scene.
  61162. * (equal to name by default)
  61163. */
  61164. id: string;
  61165. private _scene;
  61166. private _emitter;
  61167. private _vertexBuffers;
  61168. private _indexBuffer;
  61169. private _effect;
  61170. private _positionX;
  61171. private _positionY;
  61172. private _isEnabled;
  61173. /** @hidden */
  61174. static _SceneComponentInitialization: (scene: Scene) => void;
  61175. /**
  61176. * Instantiates a lens flare system.
  61177. * This represents a Lens Flare System or the shiny effect created by the light reflection on the camera lenses.
  61178. * It is usually composed of several `lensFlare`.
  61179. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  61180. * @param name Define the name of the lens flare system in the scene
  61181. * @param emitter Define the source (the emitter) of the lens flares (it can be a camera, a light or a mesh).
  61182. * @param scene Define the scene the lens flare system belongs to
  61183. */
  61184. constructor(
  61185. /**
  61186. * Define the name of the lens flare system
  61187. */
  61188. name: string, emitter: any, scene: Scene);
  61189. /**
  61190. * Define if the lens flare system is enabled.
  61191. */
  61192. get isEnabled(): boolean;
  61193. set isEnabled(value: boolean);
  61194. /**
  61195. * Get the scene the effects belongs to.
  61196. * @returns the scene holding the lens flare system
  61197. */
  61198. getScene(): Scene;
  61199. /**
  61200. * Get the emitter of the lens flare system.
  61201. * It defines the source of the lens flares (it can be a camera, a light or a mesh).
  61202. * @returns the emitter of the lens flare system
  61203. */
  61204. getEmitter(): any;
  61205. /**
  61206. * Set the emitter of the lens flare system.
  61207. * It defines the source of the lens flares (it can be a camera, a light or a mesh).
  61208. * @param newEmitter Define the new emitter of the system
  61209. */
  61210. setEmitter(newEmitter: any): void;
  61211. /**
  61212. * Get the lens flare system emitter position.
  61213. * The emitter defines the source of the lens flares (it can be a camera, a light or a mesh).
  61214. * @returns the position
  61215. */
  61216. getEmitterPosition(): Vector3;
  61217. /**
  61218. * @hidden
  61219. */
  61220. computeEffectivePosition(globalViewport: Viewport): boolean;
  61221. /** @hidden */
  61222. _isVisible(): boolean;
  61223. /**
  61224. * @hidden
  61225. */
  61226. render(): boolean;
  61227. /**
  61228. * Dispose and release the lens flare with its associated resources.
  61229. */
  61230. dispose(): void;
  61231. /**
  61232. * Parse a lens flare system from a JSON repressentation
  61233. * @param parsedLensFlareSystem Define the JSON to parse
  61234. * @param scene Define the scene the parsed system should be instantiated in
  61235. * @param rootUrl Define the rootUrl of the load sequence to easily find a load relative dependencies such as textures
  61236. * @returns the parsed system
  61237. */
  61238. static Parse(parsedLensFlareSystem: any, scene: Scene, rootUrl: string): LensFlareSystem;
  61239. /**
  61240. * Serialize the current Lens Flare System into a JSON representation.
  61241. * @returns the serialized JSON
  61242. */
  61243. serialize(): any;
  61244. }
  61245. }
  61246. declare module "babylonjs/LensFlares/lensFlare" {
  61247. import { Nullable } from "babylonjs/types";
  61248. import { Color3 } from "babylonjs/Maths/math.color";
  61249. import { Texture } from "babylonjs/Materials/Textures/texture";
  61250. import { LensFlareSystem } from "babylonjs/LensFlares/lensFlareSystem";
  61251. /**
  61252. * This represents one of the lens effect in a `lensFlareSystem`.
  61253. * It controls one of the indiviual texture used in the effect.
  61254. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  61255. */
  61256. export class LensFlare {
  61257. /**
  61258. * Define the size of the lens flare in the system (a floating value between 0 and 1)
  61259. */
  61260. size: number;
  61261. /**
  61262. * 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.
  61263. */
  61264. position: number;
  61265. /**
  61266. * Define the lens color.
  61267. */
  61268. color: Color3;
  61269. /**
  61270. * Define the lens texture.
  61271. */
  61272. texture: Nullable<Texture>;
  61273. /**
  61274. * Define the alpha mode to render this particular lens.
  61275. */
  61276. alphaMode: number;
  61277. private _system;
  61278. /**
  61279. * Creates a new Lens Flare.
  61280. * This represents one of the lens effect in a `lensFlareSystem`.
  61281. * It controls one of the indiviual texture used in the effect.
  61282. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  61283. * @param size Define the size of the lens flare (a floating value between 0 and 1)
  61284. * @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.
  61285. * @param color Define the lens color
  61286. * @param imgUrl Define the lens texture url
  61287. * @param system Define the `lensFlareSystem` this flare is part of
  61288. * @returns The newly created Lens Flare
  61289. */
  61290. static AddFlare(size: number, position: number, color: Color3, imgUrl: string, system: LensFlareSystem): LensFlare;
  61291. /**
  61292. * Instantiates a new Lens Flare.
  61293. * This represents one of the lens effect in a `lensFlareSystem`.
  61294. * It controls one of the indiviual texture used in the effect.
  61295. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  61296. * @param size Define the size of the lens flare in the system (a floating value between 0 and 1)
  61297. * @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.
  61298. * @param color Define the lens color
  61299. * @param imgUrl Define the lens texture url
  61300. * @param system Define the `lensFlareSystem` this flare is part of
  61301. */
  61302. constructor(
  61303. /**
  61304. * Define the size of the lens flare in the system (a floating value between 0 and 1)
  61305. */
  61306. size: number,
  61307. /**
  61308. * 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.
  61309. */
  61310. position: number, color: Color3, imgUrl: string, system: LensFlareSystem);
  61311. /**
  61312. * Dispose and release the lens flare with its associated resources.
  61313. */
  61314. dispose(): void;
  61315. }
  61316. }
  61317. declare module "babylonjs/LensFlares/lensFlareSystemSceneComponent" {
  61318. import { Nullable } from "babylonjs/types";
  61319. import { Scene } from "babylonjs/scene";
  61320. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  61321. import { AbstractScene } from "babylonjs/abstractScene";
  61322. import { LensFlareSystem } from "babylonjs/LensFlares/lensFlareSystem";
  61323. module "babylonjs/abstractScene" {
  61324. interface AbstractScene {
  61325. /**
  61326. * The list of lens flare system added to the scene
  61327. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  61328. */
  61329. lensFlareSystems: Array<LensFlareSystem>;
  61330. /**
  61331. * Removes the given lens flare system from this scene.
  61332. * @param toRemove The lens flare system to remove
  61333. * @returns The index of the removed lens flare system
  61334. */
  61335. removeLensFlareSystem(toRemove: LensFlareSystem): number;
  61336. /**
  61337. * Adds the given lens flare system to this scene
  61338. * @param newLensFlareSystem The lens flare system to add
  61339. */
  61340. addLensFlareSystem(newLensFlareSystem: LensFlareSystem): void;
  61341. /**
  61342. * Gets a lens flare system using its name
  61343. * @param name defines the name to look for
  61344. * @returns the lens flare system or null if not found
  61345. */
  61346. getLensFlareSystemByName(name: string): Nullable<LensFlareSystem>;
  61347. /**
  61348. * Gets a lens flare system using its id
  61349. * @param id defines the id to look for
  61350. * @returns the lens flare system or null if not found
  61351. */
  61352. getLensFlareSystemByID(id: string): Nullable<LensFlareSystem>;
  61353. }
  61354. }
  61355. /**
  61356. * Defines the lens flare scene component responsible to manage any lens flares
  61357. * in a given scene.
  61358. */
  61359. export class LensFlareSystemSceneComponent implements ISceneSerializableComponent {
  61360. /**
  61361. * The component name helpfull to identify the component in the list of scene components.
  61362. */
  61363. readonly name: string;
  61364. /**
  61365. * The scene the component belongs to.
  61366. */
  61367. scene: Scene;
  61368. /**
  61369. * Creates a new instance of the component for the given scene
  61370. * @param scene Defines the scene to register the component in
  61371. */
  61372. constructor(scene: Scene);
  61373. /**
  61374. * Registers the component in a given scene
  61375. */
  61376. register(): void;
  61377. /**
  61378. * Rebuilds the elements related to this component in case of
  61379. * context lost for instance.
  61380. */
  61381. rebuild(): void;
  61382. /**
  61383. * Adds all the elements from the container to the scene
  61384. * @param container the container holding the elements
  61385. */
  61386. addFromContainer(container: AbstractScene): void;
  61387. /**
  61388. * Removes all the elements in the container from the scene
  61389. * @param container contains the elements to remove
  61390. * @param dispose if the removed element should be disposed (default: false)
  61391. */
  61392. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  61393. /**
  61394. * Serializes the component data to the specified json object
  61395. * @param serializationObject The object to serialize to
  61396. */
  61397. serialize(serializationObject: any): void;
  61398. /**
  61399. * Disposes the component and the associated ressources.
  61400. */
  61401. dispose(): void;
  61402. private _draw;
  61403. }
  61404. }
  61405. declare module "babylonjs/LensFlares/index" {
  61406. export * from "babylonjs/LensFlares/lensFlare";
  61407. export * from "babylonjs/LensFlares/lensFlareSystem";
  61408. export * from "babylonjs/LensFlares/lensFlareSystemSceneComponent";
  61409. }
  61410. declare module "babylonjs/Shaders/depth.fragment" {
  61411. import "babylonjs/Shaders/ShadersInclude/packingFunctions";
  61412. /** @hidden */
  61413. export var depthPixelShader: {
  61414. name: string;
  61415. shader: string;
  61416. };
  61417. }
  61418. declare module "babylonjs/Shaders/depth.vertex" {
  61419. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  61420. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  61421. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  61422. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  61423. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  61424. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  61425. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  61426. /** @hidden */
  61427. export var depthVertexShader: {
  61428. name: string;
  61429. shader: string;
  61430. };
  61431. }
  61432. declare module "babylonjs/Rendering/depthRenderer" {
  61433. import { Nullable } from "babylonjs/types";
  61434. import { SubMesh } from "babylonjs/Meshes/subMesh";
  61435. import { Scene } from "babylonjs/scene";
  61436. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  61437. import { Camera } from "babylonjs/Cameras/camera";
  61438. import "babylonjs/Shaders/depth.fragment";
  61439. import "babylonjs/Shaders/depth.vertex";
  61440. /**
  61441. * This represents a depth renderer in Babylon.
  61442. * A depth renderer will render to it's depth map every frame which can be displayed or used in post processing
  61443. */
  61444. export class DepthRenderer {
  61445. private _scene;
  61446. private _depthMap;
  61447. private _effect;
  61448. private readonly _storeNonLinearDepth;
  61449. private readonly _clearColor;
  61450. /** Get if the depth renderer is using packed depth or not */
  61451. readonly isPacked: boolean;
  61452. private _cachedDefines;
  61453. private _camera;
  61454. /** Enable or disable the depth renderer. When disabled, the depth texture is not updated */
  61455. enabled: boolean;
  61456. /**
  61457. * Specifiess that the depth renderer will only be used within
  61458. * the camera it is created for.
  61459. * This can help forcing its rendering during the camera processing.
  61460. */
  61461. useOnlyInActiveCamera: boolean;
  61462. /** @hidden */
  61463. static _SceneComponentInitialization: (scene: Scene) => void;
  61464. /**
  61465. * Instantiates a depth renderer
  61466. * @param scene The scene the renderer belongs to
  61467. * @param type The texture type of the depth map (default: Engine.TEXTURETYPE_FLOAT)
  61468. * @param camera The camera to be used to render the depth map (default: scene's active camera)
  61469. * @param storeNonLinearDepth Defines whether the depth is stored linearly like in Babylon Shadows or directly like glFragCoord.z
  61470. */
  61471. constructor(scene: Scene, type?: number, camera?: Nullable<Camera>, storeNonLinearDepth?: boolean);
  61472. /**
  61473. * Creates the depth rendering effect and checks if the effect is ready.
  61474. * @param subMesh The submesh to be used to render the depth map of
  61475. * @param useInstances If multiple world instances should be used
  61476. * @returns if the depth renderer is ready to render the depth map
  61477. */
  61478. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  61479. /**
  61480. * Gets the texture which the depth map will be written to.
  61481. * @returns The depth map texture
  61482. */
  61483. getDepthMap(): RenderTargetTexture;
  61484. /**
  61485. * Disposes of the depth renderer.
  61486. */
  61487. dispose(): void;
  61488. }
  61489. }
  61490. declare module "babylonjs/Shaders/minmaxRedux.fragment" {
  61491. /** @hidden */
  61492. export var minmaxReduxPixelShader: {
  61493. name: string;
  61494. shader: string;
  61495. };
  61496. }
  61497. declare module "babylonjs/Misc/minMaxReducer" {
  61498. import { Nullable } from "babylonjs/types";
  61499. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  61500. import { Camera } from "babylonjs/Cameras/camera";
  61501. import { Observer } from "babylonjs/Misc/observable";
  61502. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  61503. import { PostProcessManager } from "babylonjs/PostProcesses/postProcessManager";
  61504. import { Observable } from "babylonjs/Misc/observable";
  61505. import "babylonjs/Shaders/minmaxRedux.fragment";
  61506. /**
  61507. * This class computes a min/max reduction from a texture: it means it computes the minimum
  61508. * and maximum values from all values of the texture.
  61509. * It is performed on the GPU for better performances, thanks to a succession of post processes.
  61510. * The source values are read from the red channel of the texture.
  61511. */
  61512. export class MinMaxReducer {
  61513. /**
  61514. * Observable triggered when the computation has been performed
  61515. */
  61516. onAfterReductionPerformed: Observable<{
  61517. min: number;
  61518. max: number;
  61519. }>;
  61520. protected _camera: Camera;
  61521. protected _sourceTexture: Nullable<RenderTargetTexture>;
  61522. protected _reductionSteps: Nullable<Array<PostProcess>>;
  61523. protected _postProcessManager: PostProcessManager;
  61524. protected _onAfterUnbindObserver: Nullable<Observer<RenderTargetTexture>>;
  61525. protected _forceFullscreenViewport: boolean;
  61526. /**
  61527. * Creates a min/max reducer
  61528. * @param camera The camera to use for the post processes
  61529. */
  61530. constructor(camera: Camera);
  61531. /**
  61532. * Gets the texture used to read the values from.
  61533. */
  61534. get sourceTexture(): Nullable<RenderTargetTexture>;
  61535. /**
  61536. * Sets the source texture to read the values from.
  61537. * One must indicate if the texture is a depth texture or not through the depthRedux parameter
  61538. * because in such textures '1' value must not be taken into account to compute the maximum
  61539. * as this value is used to clear the texture.
  61540. * Note that the computation is not activated by calling this function, you must call activate() for that!
  61541. * @param sourceTexture The texture to read the values from. The values should be in the red channel.
  61542. * @param depthRedux Indicates if the texture is a depth texture or not
  61543. * @param type The type of the textures created for the reduction (defaults to TEXTURETYPE_HALF_FLOAT)
  61544. * @param forceFullscreenViewport Forces the post processes used for the reduction to be applied without taking into account viewport (defaults to true)
  61545. */
  61546. setSourceTexture(sourceTexture: RenderTargetTexture, depthRedux: boolean, type?: number, forceFullscreenViewport?: boolean): void;
  61547. /**
  61548. * Defines the refresh rate of the computation.
  61549. * Use 0 to compute just once, 1 to compute on every frame, 2 to compute every two frames and so on...
  61550. */
  61551. get refreshRate(): number;
  61552. set refreshRate(value: number);
  61553. protected _activated: boolean;
  61554. /**
  61555. * Gets the activation status of the reducer
  61556. */
  61557. get activated(): boolean;
  61558. /**
  61559. * Activates the reduction computation.
  61560. * When activated, the observers registered in onAfterReductionPerformed are
  61561. * called after the compuation is performed
  61562. */
  61563. activate(): void;
  61564. /**
  61565. * Deactivates the reduction computation.
  61566. */
  61567. deactivate(): void;
  61568. /**
  61569. * Disposes the min/max reducer
  61570. * @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.
  61571. */
  61572. dispose(disposeAll?: boolean): void;
  61573. }
  61574. }
  61575. declare module "babylonjs/Misc/depthReducer" {
  61576. import { Nullable } from "babylonjs/types";
  61577. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  61578. import { Camera } from "babylonjs/Cameras/camera";
  61579. import { DepthRenderer } from "babylonjs/Rendering/depthRenderer";
  61580. import { MinMaxReducer } from "babylonjs/Misc/minMaxReducer";
  61581. /**
  61582. * This class is a small wrapper around the MinMaxReducer class to compute the min/max values of a depth texture
  61583. */
  61584. export class DepthReducer extends MinMaxReducer {
  61585. private _depthRenderer;
  61586. private _depthRendererId;
  61587. /**
  61588. * Gets the depth renderer used for the computation.
  61589. * Note that the result is null if you provide your own renderer when calling setDepthRenderer.
  61590. */
  61591. get depthRenderer(): Nullable<DepthRenderer>;
  61592. /**
  61593. * Creates a depth reducer
  61594. * @param camera The camera used to render the depth texture
  61595. */
  61596. constructor(camera: Camera);
  61597. /**
  61598. * Sets the depth renderer to use to generate the depth map
  61599. * @param depthRenderer The depth renderer to use. If not provided, a new one will be created automatically
  61600. * @param type The texture type of the depth map (default: TEXTURETYPE_HALF_FLOAT)
  61601. * @param forceFullscreenViewport Forces the post processes used for the reduction to be applied without taking into account viewport (defaults to true)
  61602. */
  61603. setDepthRenderer(depthRenderer?: Nullable<DepthRenderer>, type?: number, forceFullscreenViewport?: boolean): void;
  61604. /** @hidden */
  61605. setSourceTexture(sourceTexture: RenderTargetTexture, depthRedux: boolean, type?: number, forceFullscreenViewport?: boolean): void;
  61606. /**
  61607. * Activates the reduction computation.
  61608. * When activated, the observers registered in onAfterReductionPerformed are
  61609. * called after the compuation is performed
  61610. */
  61611. activate(): void;
  61612. /**
  61613. * Deactivates the reduction computation.
  61614. */
  61615. deactivate(): void;
  61616. /**
  61617. * Disposes the depth reducer
  61618. * @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.
  61619. */
  61620. dispose(disposeAll?: boolean): void;
  61621. }
  61622. }
  61623. declare module "babylonjs/Lights/Shadows/cascadedShadowGenerator" {
  61624. import { Nullable } from "babylonjs/types";
  61625. import { Scene } from "babylonjs/scene";
  61626. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  61627. import { SubMesh } from "babylonjs/Meshes/subMesh";
  61628. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  61629. import { Effect } from "babylonjs/Materials/effect";
  61630. import "babylonjs/Shaders/shadowMap.fragment";
  61631. import "babylonjs/Shaders/shadowMap.vertex";
  61632. import "babylonjs/Shaders/depthBoxBlur.fragment";
  61633. import { ShadowGenerator } from "babylonjs/Lights/Shadows/shadowGenerator";
  61634. import { DirectionalLight } from "babylonjs/Lights/directionalLight";
  61635. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  61636. import { DepthRenderer } from "babylonjs/Rendering/depthRenderer";
  61637. /**
  61638. * A CSM implementation allowing casting shadows on large scenes.
  61639. * Documentation : https://doc.babylonjs.com/babylon101/cascadedShadows
  61640. * Based on: https://github.com/TheRealMJP/Shadows and https://johanmedestrom.wordpress.com/2016/03/18/opengl-cascaded-shadow-maps/
  61641. */
  61642. export class CascadedShadowGenerator extends ShadowGenerator {
  61643. private static readonly frustumCornersNDCSpace;
  61644. /**
  61645. * Name of the CSM class
  61646. */
  61647. static CLASSNAME: string;
  61648. /**
  61649. * Defines the default number of cascades used by the CSM.
  61650. */
  61651. static readonly DEFAULT_CASCADES_COUNT: number;
  61652. /**
  61653. * Defines the minimum number of cascades used by the CSM.
  61654. */
  61655. static readonly MIN_CASCADES_COUNT: number;
  61656. /**
  61657. * Defines the maximum number of cascades used by the CSM.
  61658. */
  61659. static readonly MAX_CASCADES_COUNT: number;
  61660. protected _validateFilter(filter: number): number;
  61661. /**
  61662. * Gets or sets the actual darkness of the soft shadows while using PCSS filtering (value between 0. and 1.)
  61663. */
  61664. penumbraDarkness: number;
  61665. private _numCascades;
  61666. /**
  61667. * Gets or set the number of cascades used by the CSM.
  61668. */
  61669. get numCascades(): number;
  61670. set numCascades(value: number);
  61671. /**
  61672. * Sets this to true if you want that the edges of the shadows don't "swimm" / "shimmer" when rotating the camera.
  61673. * The trade off is that you lose some precision in the shadow rendering when enabling this setting.
  61674. */
  61675. stabilizeCascades: boolean;
  61676. private _freezeShadowCastersBoundingInfo;
  61677. private _freezeShadowCastersBoundingInfoObservable;
  61678. /**
  61679. * Enables or disables the shadow casters bounding info computation.
  61680. * If your shadow casters don't move, you can disable this feature.
  61681. * If it is enabled, the bounding box computation is done every frame.
  61682. */
  61683. get freezeShadowCastersBoundingInfo(): boolean;
  61684. set freezeShadowCastersBoundingInfo(freeze: boolean);
  61685. private _scbiMin;
  61686. private _scbiMax;
  61687. protected _computeShadowCastersBoundingInfo(): void;
  61688. protected _shadowCastersBoundingInfo: BoundingInfo;
  61689. /**
  61690. * Gets or sets the shadow casters bounding info.
  61691. * If you provide your own shadow casters bounding info, first enable freezeShadowCastersBoundingInfo
  61692. * so that the system won't overwrite the bounds you provide
  61693. */
  61694. get shadowCastersBoundingInfo(): BoundingInfo;
  61695. set shadowCastersBoundingInfo(boundingInfo: BoundingInfo);
  61696. protected _breaksAreDirty: boolean;
  61697. protected _minDistance: number;
  61698. protected _maxDistance: number;
  61699. /**
  61700. * Sets the minimal and maximal distances to use when computing the cascade breaks.
  61701. *
  61702. * The values of min / max are typically the depth zmin and zmax values of your scene, for a given frame.
  61703. * If you don't know these values, simply leave them to their defaults and don't call this function.
  61704. * @param min minimal distance for the breaks (default to 0.)
  61705. * @param max maximal distance for the breaks (default to 1.)
  61706. */
  61707. setMinMaxDistance(min: number, max: number): void;
  61708. /** Gets the minimal distance used in the cascade break computation */
  61709. get minDistance(): number;
  61710. /** Gets the maximal distance used in the cascade break computation */
  61711. get maxDistance(): number;
  61712. /**
  61713. * Gets the class name of that object
  61714. * @returns "CascadedShadowGenerator"
  61715. */
  61716. getClassName(): string;
  61717. private _cascadeMinExtents;
  61718. private _cascadeMaxExtents;
  61719. /**
  61720. * Gets a cascade minimum extents
  61721. * @param cascadeIndex index of the cascade
  61722. * @returns the minimum cascade extents
  61723. */
  61724. getCascadeMinExtents(cascadeIndex: number): Nullable<Vector3>;
  61725. /**
  61726. * Gets a cascade maximum extents
  61727. * @param cascadeIndex index of the cascade
  61728. * @returns the maximum cascade extents
  61729. */
  61730. getCascadeMaxExtents(cascadeIndex: number): Nullable<Vector3>;
  61731. private _cascades;
  61732. private _currentLayer;
  61733. private _viewSpaceFrustumsZ;
  61734. private _viewMatrices;
  61735. private _projectionMatrices;
  61736. private _transformMatrices;
  61737. private _transformMatricesAsArray;
  61738. private _frustumLengths;
  61739. private _lightSizeUVCorrection;
  61740. private _depthCorrection;
  61741. private _frustumCornersWorldSpace;
  61742. private _frustumCenter;
  61743. private _shadowCameraPos;
  61744. private _shadowMaxZ;
  61745. /**
  61746. * Gets the shadow max z distance. It's the limit beyond which shadows are not displayed.
  61747. * It defaults to camera.maxZ
  61748. */
  61749. get shadowMaxZ(): number;
  61750. /**
  61751. * Sets the shadow max z distance.
  61752. */
  61753. set shadowMaxZ(value: number);
  61754. protected _debug: boolean;
  61755. /**
  61756. * Gets or sets the debug flag.
  61757. * When enabled, the cascades are materialized by different colors on the screen.
  61758. */
  61759. get debug(): boolean;
  61760. set debug(dbg: boolean);
  61761. private _depthClamp;
  61762. /**
  61763. * Gets or sets the depth clamping value.
  61764. *
  61765. * When enabled, it improves the shadow quality because the near z plane of the light frustum don't need to be adjusted
  61766. * to account for the shadow casters far away.
  61767. *
  61768. * Note that this property is incompatible with PCSS filtering, so it won't be used in that case.
  61769. */
  61770. get depthClamp(): boolean;
  61771. set depthClamp(value: boolean);
  61772. private _cascadeBlendPercentage;
  61773. /**
  61774. * Gets or sets the percentage of blending between two cascades (value between 0. and 1.).
  61775. * It defaults to 0.1 (10% blending).
  61776. */
  61777. get cascadeBlendPercentage(): number;
  61778. set cascadeBlendPercentage(value: number);
  61779. private _lambda;
  61780. /**
  61781. * Gets or set the lambda parameter.
  61782. * This parameter is used to split the camera frustum and create the cascades.
  61783. * 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.
  61784. * For all values in-between, it's a linear combination of the uniform and logarithm split algorithm.
  61785. */
  61786. get lambda(): number;
  61787. set lambda(value: number);
  61788. /**
  61789. * Gets the view matrix corresponding to a given cascade
  61790. * @param cascadeNum cascade to retrieve the view matrix from
  61791. * @returns the cascade view matrix
  61792. */
  61793. getCascadeViewMatrix(cascadeNum: number): Nullable<Matrix>;
  61794. /**
  61795. * Gets the projection matrix corresponding to a given cascade
  61796. * @param cascadeNum cascade to retrieve the projection matrix from
  61797. * @returns the cascade projection matrix
  61798. */
  61799. getCascadeProjectionMatrix(cascadeNum: number): Nullable<Matrix>;
  61800. /**
  61801. * Gets the transformation matrix corresponding to a given cascade
  61802. * @param cascadeNum cascade to retrieve the transformation matrix from
  61803. * @returns the cascade transformation matrix
  61804. */
  61805. getCascadeTransformMatrix(cascadeNum: number): Nullable<Matrix>;
  61806. private _depthRenderer;
  61807. /**
  61808. * Sets the depth renderer to use when autoCalcDepthBounds is enabled.
  61809. *
  61810. * Note that if no depth renderer is set, a new one will be automatically created internally when necessary.
  61811. *
  61812. * You should call this function if you already have a depth renderer enabled in your scene, to avoid
  61813. * doing multiple depth rendering each frame. If you provide your own depth renderer, make sure it stores linear depth!
  61814. * @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
  61815. */
  61816. setDepthRenderer(depthRenderer: Nullable<DepthRenderer>): void;
  61817. private _depthReducer;
  61818. private _autoCalcDepthBounds;
  61819. /**
  61820. * Gets or sets the autoCalcDepthBounds property.
  61821. *
  61822. * When enabled, a depth rendering pass is first performed (with an internally created depth renderer or with the one
  61823. * you provide by calling setDepthRenderer). Then, a min/max reducing is applied on the depth map to compute the
  61824. * minimal and maximal depth of the map and those values are used as inputs for the setMinMaxDistance() function.
  61825. * It can greatly enhance the shadow quality, at the expense of more GPU works.
  61826. * When using this option, you should increase the value of the lambda parameter, and even set it to 1 for best results.
  61827. */
  61828. get autoCalcDepthBounds(): boolean;
  61829. set autoCalcDepthBounds(value: boolean);
  61830. /**
  61831. * Defines the refresh rate of the min/max computation used when autoCalcDepthBounds is set to true
  61832. * Use 0 to compute just once, 1 to compute on every frame, 2 to compute every two frames and so on...
  61833. * Note that if you provided your own depth renderer through a call to setDepthRenderer, you are responsible
  61834. * for setting the refresh rate on the renderer yourself!
  61835. */
  61836. get autoCalcDepthBoundsRefreshRate(): number;
  61837. set autoCalcDepthBoundsRefreshRate(value: number);
  61838. /**
  61839. * Create the cascade breaks according to the lambda, shadowMaxZ and min/max distance properties, as well as the camera near and far planes.
  61840. * This function is automatically called when updating lambda, shadowMaxZ and min/max distances, however you should call it yourself if
  61841. * you change the camera near/far planes!
  61842. */
  61843. splitFrustum(): void;
  61844. private _splitFrustum;
  61845. private _computeMatrices;
  61846. private _computeFrustumInWorldSpace;
  61847. private _computeCascadeFrustum;
  61848. /**
  61849. * Support test.
  61850. */
  61851. static get IsSupported(): boolean;
  61852. /** @hidden */
  61853. static _SceneComponentInitialization: (scene: Scene) => void;
  61854. /**
  61855. * Creates a Cascaded Shadow Generator object.
  61856. * A ShadowGenerator is the required tool to use the shadows.
  61857. * Each directional light casting shadows needs to use its own ShadowGenerator.
  61858. * Documentation : https://doc.babylonjs.com/babylon101/cascadedShadows
  61859. * @param mapSize The size of the texture what stores the shadows. Example : 1024.
  61860. * @param light The directional light object generating the shadows.
  61861. * @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.
  61862. */
  61863. constructor(mapSize: number, light: DirectionalLight, usefulFloatFirst?: boolean);
  61864. protected _initializeGenerator(): void;
  61865. protected _createTargetRenderTexture(): void;
  61866. protected _initializeShadowMap(): void;
  61867. protected _bindCustomEffectForRenderSubMeshForShadowMap(subMesh: SubMesh, effect: Effect, matriceNames: any, mesh: AbstractMesh): void;
  61868. protected _isReadyCustomDefines(defines: any, subMesh: SubMesh, useInstances: boolean): void;
  61869. /**
  61870. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  61871. * @param defines Defines of the material we want to update
  61872. * @param lightIndex Index of the light in the enabled light list of the material
  61873. */
  61874. prepareDefines(defines: any, lightIndex: number): void;
  61875. /**
  61876. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  61877. * defined in the generator but impacting the effect).
  61878. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  61879. * @param effect The effect we are binfing the information for
  61880. */
  61881. bindShadowLight(lightIndex: string, effect: Effect): void;
  61882. /**
  61883. * Gets the transformation matrix of the first cascade used to project the meshes into the map from the light point of view.
  61884. * (eq to view projection * shadow projection matrices)
  61885. * @returns The transform matrix used to create the shadow map
  61886. */
  61887. getTransformMatrix(): Matrix;
  61888. /**
  61889. * Disposes the ShadowGenerator.
  61890. * Returns nothing.
  61891. */
  61892. dispose(): void;
  61893. /**
  61894. * Serializes the shadow generator setup to a json object.
  61895. * @returns The serialized JSON object
  61896. */
  61897. serialize(): any;
  61898. /**
  61899. * Parses a serialized ShadowGenerator and returns a new ShadowGenerator.
  61900. * @param parsedShadowGenerator The JSON object to parse
  61901. * @param scene The scene to create the shadow map for
  61902. * @returns The parsed shadow generator
  61903. */
  61904. static Parse(parsedShadowGenerator: any, scene: Scene): ShadowGenerator;
  61905. }
  61906. }
  61907. declare module "babylonjs/Lights/Shadows/shadowGeneratorSceneComponent" {
  61908. import { Scene } from "babylonjs/scene";
  61909. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  61910. import { AbstractScene } from "babylonjs/abstractScene";
  61911. /**
  61912. * Defines the shadow generator component responsible to manage any shadow generators
  61913. * in a given scene.
  61914. */
  61915. export class ShadowGeneratorSceneComponent implements ISceneSerializableComponent {
  61916. /**
  61917. * The component name helpfull to identify the component in the list of scene components.
  61918. */
  61919. readonly name: string;
  61920. /**
  61921. * The scene the component belongs to.
  61922. */
  61923. scene: Scene;
  61924. /**
  61925. * Creates a new instance of the component for the given scene
  61926. * @param scene Defines the scene to register the component in
  61927. */
  61928. constructor(scene: Scene);
  61929. /**
  61930. * Registers the component in a given scene
  61931. */
  61932. register(): void;
  61933. /**
  61934. * Rebuilds the elements related to this component in case of
  61935. * context lost for instance.
  61936. */
  61937. rebuild(): void;
  61938. /**
  61939. * Serializes the component data to the specified json object
  61940. * @param serializationObject The object to serialize to
  61941. */
  61942. serialize(serializationObject: any): void;
  61943. /**
  61944. * Adds all the elements from the container to the scene
  61945. * @param container the container holding the elements
  61946. */
  61947. addFromContainer(container: AbstractScene): void;
  61948. /**
  61949. * Removes all the elements in the container from the scene
  61950. * @param container contains the elements to remove
  61951. * @param dispose if the removed element should be disposed (default: false)
  61952. */
  61953. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  61954. /**
  61955. * Rebuilds the elements related to this component in case of
  61956. * context lost for instance.
  61957. */
  61958. dispose(): void;
  61959. private _gatherRenderTargets;
  61960. }
  61961. }
  61962. declare module "babylonjs/Lights/Shadows/index" {
  61963. export * from "babylonjs/Lights/Shadows/shadowGenerator";
  61964. export * from "babylonjs/Lights/Shadows/cascadedShadowGenerator";
  61965. export * from "babylonjs/Lights/Shadows/shadowGeneratorSceneComponent";
  61966. }
  61967. declare module "babylonjs/Lights/pointLight" {
  61968. import { Scene } from "babylonjs/scene";
  61969. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  61970. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  61971. import { ShadowLight } from "babylonjs/Lights/shadowLight";
  61972. import { Effect } from "babylonjs/Materials/effect";
  61973. /**
  61974. * A point light is a light defined by an unique point in world space.
  61975. * The light is emitted in every direction from this point.
  61976. * A good example of a point light is a standard light bulb.
  61977. * Documentation: https://doc.babylonjs.com/babylon101/lights
  61978. */
  61979. export class PointLight extends ShadowLight {
  61980. private _shadowAngle;
  61981. /**
  61982. * Getter: In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  61983. * This specifies what angle the shadow will use to be created.
  61984. *
  61985. * It default to 90 degrees to work nicely with the cube texture generation for point lights shadow maps.
  61986. */
  61987. get shadowAngle(): number;
  61988. /**
  61989. * Setter: In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  61990. * This specifies what angle the shadow will use to be created.
  61991. *
  61992. * It default to 90 degrees to work nicely with the cube texture generation for point lights shadow maps.
  61993. */
  61994. set shadowAngle(value: number);
  61995. /**
  61996. * Gets the direction if it has been set.
  61997. * In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  61998. */
  61999. get direction(): Vector3;
  62000. /**
  62001. * In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  62002. */
  62003. set direction(value: Vector3);
  62004. /**
  62005. * Creates a PointLight object from the passed name and position (Vector3) and adds it in the scene.
  62006. * A PointLight emits the light in every direction.
  62007. * It can cast shadows.
  62008. * If the scene camera is already defined and you want to set your PointLight at the camera position, just set it :
  62009. * ```javascript
  62010. * var pointLight = new PointLight("pl", camera.position, scene);
  62011. * ```
  62012. * Documentation : https://doc.babylonjs.com/babylon101/lights
  62013. * @param name The light friendly name
  62014. * @param position The position of the point light in the scene
  62015. * @param scene The scene the lights belongs to
  62016. */
  62017. constructor(name: string, position: Vector3, scene: Scene);
  62018. /**
  62019. * Returns the string "PointLight"
  62020. * @returns the class name
  62021. */
  62022. getClassName(): string;
  62023. /**
  62024. * Returns the integer 0.
  62025. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  62026. */
  62027. getTypeID(): number;
  62028. /**
  62029. * Specifies wether or not the shadowmap should be a cube texture.
  62030. * @returns true if the shadowmap needs to be a cube texture.
  62031. */
  62032. needCube(): boolean;
  62033. /**
  62034. * Returns a new Vector3 aligned with the PointLight cube system according to the passed cube face index (integer).
  62035. * @param faceIndex The index of the face we are computed the direction to generate shadow
  62036. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  62037. */
  62038. getShadowDirection(faceIndex?: number): Vector3;
  62039. /**
  62040. * Sets the passed matrix "matrix" as a left-handed perspective projection matrix with the following settings :
  62041. * - fov = PI / 2
  62042. * - aspect ratio : 1.0
  62043. * - z-near and far equal to the active camera minZ and maxZ.
  62044. * Returns the PointLight.
  62045. */
  62046. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  62047. protected _buildUniformLayout(): void;
  62048. /**
  62049. * Sets the passed Effect "effect" with the PointLight transformed position (or position, if none) and passed name (string).
  62050. * @param effect The effect to update
  62051. * @param lightIndex The index of the light in the effect to update
  62052. * @returns The point light
  62053. */
  62054. transferToEffect(effect: Effect, lightIndex: string): PointLight;
  62055. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  62056. /**
  62057. * Prepares the list of defines specific to the light type.
  62058. * @param defines the list of defines
  62059. * @param lightIndex defines the index of the light for the effect
  62060. */
  62061. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  62062. }
  62063. }
  62064. declare module "babylonjs/Lights/index" {
  62065. export * from "babylonjs/Lights/light";
  62066. export * from "babylonjs/Lights/shadowLight";
  62067. export * from "babylonjs/Lights/Shadows/index";
  62068. export * from "babylonjs/Lights/directionalLight";
  62069. export * from "babylonjs/Lights/hemisphericLight";
  62070. export * from "babylonjs/Lights/pointLight";
  62071. export * from "babylonjs/Lights/spotLight";
  62072. }
  62073. declare module "babylonjs/Misc/HighDynamicRange/hdr" {
  62074. import { CubeMapInfo } from "babylonjs/Misc/HighDynamicRange/panoramaToCubemap";
  62075. /**
  62076. * Header information of HDR texture files.
  62077. */
  62078. export interface HDRInfo {
  62079. /**
  62080. * The height of the texture in pixels.
  62081. */
  62082. height: number;
  62083. /**
  62084. * The width of the texture in pixels.
  62085. */
  62086. width: number;
  62087. /**
  62088. * The index of the beginning of the data in the binary file.
  62089. */
  62090. dataPosition: number;
  62091. }
  62092. /**
  62093. * This groups tools to convert HDR texture to native colors array.
  62094. */
  62095. export class HDRTools {
  62096. private static Ldexp;
  62097. private static Rgbe2float;
  62098. private static readStringLine;
  62099. /**
  62100. * Reads header information from an RGBE texture stored in a native array.
  62101. * More information on this format are available here:
  62102. * https://en.wikipedia.org/wiki/RGBE_image_format
  62103. *
  62104. * @param uint8array The binary file stored in native array.
  62105. * @return The header information.
  62106. */
  62107. static RGBE_ReadHeader(uint8array: Uint8Array): HDRInfo;
  62108. /**
  62109. * Returns the cubemap information (each faces texture data) extracted from an RGBE texture.
  62110. * This RGBE texture needs to store the information as a panorama.
  62111. *
  62112. * More information on this format are available here:
  62113. * https://en.wikipedia.org/wiki/RGBE_image_format
  62114. *
  62115. * @param buffer The binary file stored in an array buffer.
  62116. * @param size The expected size of the extracted cubemap.
  62117. * @return The Cube Map information.
  62118. */
  62119. static GetCubeMapTextureData(buffer: ArrayBuffer, size: number): CubeMapInfo;
  62120. /**
  62121. * Returns the pixels data extracted from an RGBE texture.
  62122. * This pixels will be stored left to right up to down in the R G B order in one array.
  62123. *
  62124. * More information on this format are available here:
  62125. * https://en.wikipedia.org/wiki/RGBE_image_format
  62126. *
  62127. * @param uint8array The binary file stored in an array buffer.
  62128. * @param hdrInfo The header information of the file.
  62129. * @return The pixels data in RGB right to left up to down order.
  62130. */
  62131. static RGBE_ReadPixels(uint8array: Uint8Array, hdrInfo: HDRInfo): Float32Array;
  62132. private static RGBE_ReadPixels_RLE;
  62133. private static RGBE_ReadPixels_NOT_RLE;
  62134. }
  62135. }
  62136. declare module "babylonjs/Materials/effectRenderer" {
  62137. import { Nullable } from "babylonjs/types";
  62138. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  62139. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  62140. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  62141. import { Viewport } from "babylonjs/Maths/math.viewport";
  62142. import { Observable } from "babylonjs/Misc/observable";
  62143. import { Effect } from "babylonjs/Materials/effect";
  62144. import "babylonjs/Shaders/postprocess.vertex";
  62145. /**
  62146. * Effect Render Options
  62147. */
  62148. export interface IEffectRendererOptions {
  62149. /**
  62150. * Defines the vertices positions.
  62151. */
  62152. positions?: number[];
  62153. /**
  62154. * Defines the indices.
  62155. */
  62156. indices?: number[];
  62157. }
  62158. /**
  62159. * Helper class to render one or more effects.
  62160. * You can access the previous rendering in your shader by declaring a sampler named textureSampler
  62161. */
  62162. export class EffectRenderer {
  62163. private engine;
  62164. private static _DefaultOptions;
  62165. private _vertexBuffers;
  62166. private _indexBuffer;
  62167. private _fullscreenViewport;
  62168. /**
  62169. * Creates an effect renderer
  62170. * @param engine the engine to use for rendering
  62171. * @param options defines the options of the effect renderer
  62172. */
  62173. constructor(engine: ThinEngine, options?: IEffectRendererOptions);
  62174. /**
  62175. * Sets the current viewport in normalized coordinates 0-1
  62176. * @param viewport Defines the viewport to set (defaults to 0 0 1 1)
  62177. */
  62178. setViewport(viewport?: Viewport): void;
  62179. /**
  62180. * Binds the embedded attributes buffer to the effect.
  62181. * @param effect Defines the effect to bind the attributes for
  62182. */
  62183. bindBuffers(effect: Effect): void;
  62184. /**
  62185. * Sets the current effect wrapper to use during draw.
  62186. * The effect needs to be ready before calling this api.
  62187. * This also sets the default full screen position attribute.
  62188. * @param effectWrapper Defines the effect to draw with
  62189. */
  62190. applyEffectWrapper(effectWrapper: EffectWrapper): void;
  62191. /**
  62192. * Restores engine states
  62193. */
  62194. restoreStates(): void;
  62195. /**
  62196. * Draws a full screen quad.
  62197. */
  62198. draw(): void;
  62199. private isRenderTargetTexture;
  62200. /**
  62201. * renders one or more effects to a specified texture
  62202. * @param effectWrapper the effect to renderer
  62203. * @param outputTexture texture to draw to, if null it will render to the screen.
  62204. */
  62205. render(effectWrapper: EffectWrapper, outputTexture?: Nullable<InternalTexture | RenderTargetTexture>): void;
  62206. /**
  62207. * Disposes of the effect renderer
  62208. */
  62209. dispose(): void;
  62210. }
  62211. /**
  62212. * Options to create an EffectWrapper
  62213. */
  62214. interface EffectWrapperCreationOptions {
  62215. /**
  62216. * Engine to use to create the effect
  62217. */
  62218. engine: ThinEngine;
  62219. /**
  62220. * Fragment shader for the effect
  62221. */
  62222. fragmentShader: string;
  62223. /**
  62224. * Use the shader store instead of direct source code
  62225. */
  62226. useShaderStore?: boolean;
  62227. /**
  62228. * Vertex shader for the effect
  62229. */
  62230. vertexShader?: string;
  62231. /**
  62232. * Attributes to use in the shader
  62233. */
  62234. attributeNames?: Array<string>;
  62235. /**
  62236. * Uniforms to use in the shader
  62237. */
  62238. uniformNames?: Array<string>;
  62239. /**
  62240. * Texture sampler names to use in the shader
  62241. */
  62242. samplerNames?: Array<string>;
  62243. /**
  62244. * Defines to use in the shader
  62245. */
  62246. defines?: Array<string>;
  62247. /**
  62248. * Callback when effect is compiled
  62249. */
  62250. onCompiled?: Nullable<(effect: Effect) => void>;
  62251. /**
  62252. * The friendly name of the effect displayed in Spector.
  62253. */
  62254. name?: string;
  62255. }
  62256. /**
  62257. * Wraps an effect to be used for rendering
  62258. */
  62259. export class EffectWrapper {
  62260. /**
  62261. * Event that is fired right before the effect is drawn (should be used to update uniforms)
  62262. */
  62263. onApplyObservable: Observable<{}>;
  62264. /**
  62265. * The underlying effect
  62266. */
  62267. effect: Effect;
  62268. /**
  62269. * Creates an effect to be renderer
  62270. * @param creationOptions options to create the effect
  62271. */
  62272. constructor(creationOptions: EffectWrapperCreationOptions);
  62273. /**
  62274. * Disposes of the effect wrapper
  62275. */
  62276. dispose(): void;
  62277. }
  62278. }
  62279. declare module "babylonjs/Shaders/hdrFiltering.vertex" {
  62280. /** @hidden */
  62281. export var hdrFilteringVertexShader: {
  62282. name: string;
  62283. shader: string;
  62284. };
  62285. }
  62286. declare module "babylonjs/Shaders/hdrFiltering.fragment" {
  62287. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  62288. import "babylonjs/Shaders/ShadersInclude/importanceSampling";
  62289. import "babylonjs/Shaders/ShadersInclude/pbrBRDFFunctions";
  62290. import "babylonjs/Shaders/ShadersInclude/hdrFilteringFunctions";
  62291. /** @hidden */
  62292. export var hdrFilteringPixelShader: {
  62293. name: string;
  62294. shader: string;
  62295. };
  62296. }
  62297. declare module "babylonjs/Materials/Textures/Filtering/hdrFiltering" {
  62298. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  62299. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  62300. import { Nullable } from "babylonjs/types";
  62301. import "babylonjs/Shaders/hdrFiltering.vertex";
  62302. import "babylonjs/Shaders/hdrFiltering.fragment";
  62303. /**
  62304. * Options for texture filtering
  62305. */
  62306. interface IHDRFilteringOptions {
  62307. /**
  62308. * Scales pixel intensity for the input HDR map.
  62309. */
  62310. hdrScale?: number;
  62311. /**
  62312. * Quality of the filter. Should be `Constants.TEXTURE_FILTERING_QUALITY_OFFLINE` for prefiltering
  62313. */
  62314. quality?: number;
  62315. }
  62316. /**
  62317. * Filters HDR maps to get correct renderings of PBR reflections
  62318. */
  62319. export class HDRFiltering {
  62320. private _engine;
  62321. private _effectRenderer;
  62322. private _effectWrapper;
  62323. private _lodGenerationOffset;
  62324. private _lodGenerationScale;
  62325. /**
  62326. * Quality switch for prefiltering. Should be set to `Constants.TEXTURE_FILTERING_QUALITY_OFFLINE` unless
  62327. * you care about baking speed.
  62328. */
  62329. quality: number;
  62330. /**
  62331. * Scales pixel intensity for the input HDR map.
  62332. */
  62333. hdrScale: number;
  62334. /**
  62335. * Instantiates HDR filter for reflection maps
  62336. *
  62337. * @param engine Thin engine
  62338. * @param options Options
  62339. */
  62340. constructor(engine: ThinEngine, options?: IHDRFilteringOptions);
  62341. private _createRenderTarget;
  62342. private _prefilterInternal;
  62343. private _createEffect;
  62344. /**
  62345. * Get a value indicating if the filter is ready to be used
  62346. * @param texture Texture to filter
  62347. * @returns true if the filter is ready
  62348. */
  62349. isReady(texture: BaseTexture): boolean;
  62350. /**
  62351. * Prefilters a cube texture to have mipmap levels representing roughness values.
  62352. * Prefiltering will be invoked at the end of next rendering pass.
  62353. * This has to be done once the map is loaded, and has not been prefiltered by a third party software.
  62354. * See http://blog.selfshadow.com/publications/s2013-shading-course/karis/s2013_pbs_epic_notes_v2.pdf for more information
  62355. * @param texture Texture to filter
  62356. * @param onFinished Callback when filtering is done
  62357. * @return Promise called when prefiltering is done
  62358. */
  62359. prefilter(texture: BaseTexture, onFinished?: Nullable<() => void>): Promise<unknown> | undefined;
  62360. }
  62361. }
  62362. declare module "babylonjs/Materials/Textures/hdrCubeTexture" {
  62363. import { Nullable } from "babylonjs/types";
  62364. import { Scene } from "babylonjs/scene";
  62365. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  62366. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  62367. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  62368. import "babylonjs/Engines/Extensions/engine.rawTexture";
  62369. import "babylonjs/Materials/Textures/baseTexture.polynomial";
  62370. /**
  62371. * This represents a texture coming from an HDR input.
  62372. *
  62373. * The only supported format is currently panorama picture stored in RGBE format.
  62374. * Example of such files can be found on HDRLib: http://hdrlib.com/
  62375. */
  62376. export class HDRCubeTexture extends BaseTexture {
  62377. private static _facesMapping;
  62378. private _generateHarmonics;
  62379. private _noMipmap;
  62380. private _prefilterOnLoad;
  62381. private _textureMatrix;
  62382. private _size;
  62383. private _onLoad;
  62384. private _onError;
  62385. /**
  62386. * The texture URL.
  62387. */
  62388. url: string;
  62389. /**
  62390. * The texture coordinates mode. As this texture is stored in a cube format, please modify carefully.
  62391. */
  62392. coordinatesMode: number;
  62393. protected _isBlocking: boolean;
  62394. /**
  62395. * Sets wether or not the texture is blocking during loading.
  62396. */
  62397. set isBlocking(value: boolean);
  62398. /**
  62399. * Gets wether or not the texture is blocking during loading.
  62400. */
  62401. get isBlocking(): boolean;
  62402. protected _rotationY: number;
  62403. /**
  62404. * Sets texture matrix rotation angle around Y axis in radians.
  62405. */
  62406. set rotationY(value: number);
  62407. /**
  62408. * Gets texture matrix rotation angle around Y axis radians.
  62409. */
  62410. get rotationY(): number;
  62411. /**
  62412. * Gets or sets the center of the bounding box associated with the cube texture
  62413. * It must define where the camera used to render the texture was set
  62414. */
  62415. boundingBoxPosition: Vector3;
  62416. private _boundingBoxSize;
  62417. /**
  62418. * Gets or sets the size of the bounding box associated with the cube texture
  62419. * When defined, the cubemap will switch to local mode
  62420. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  62421. * @example https://www.babylonjs-playground.com/#RNASML
  62422. */
  62423. set boundingBoxSize(value: Vector3);
  62424. get boundingBoxSize(): Vector3;
  62425. /**
  62426. * Instantiates an HDRTexture from the following parameters.
  62427. *
  62428. * @param url The location of the HDR raw data (Panorama stored in RGBE format)
  62429. * @param sceneOrEngine The scene or engine the texture will be used in
  62430. * @param size The cubemap desired size (the more it increases the longer the generation will be)
  62431. * @param noMipmap Forces to not generate the mipmap if true
  62432. * @param generateHarmonics Specifies whether you want to extract the polynomial harmonics during the generation process
  62433. * @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)
  62434. * @param prefilterOnLoad Prefilters HDR texture to allow use of this texture as a PBR reflection texture.
  62435. */
  62436. 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>);
  62437. /**
  62438. * Get the current class name of the texture useful for serialization or dynamic coding.
  62439. * @returns "HDRCubeTexture"
  62440. */
  62441. getClassName(): string;
  62442. /**
  62443. * Occurs when the file is raw .hdr file.
  62444. */
  62445. private loadTexture;
  62446. clone(): HDRCubeTexture;
  62447. delayLoad(): void;
  62448. /**
  62449. * Get the texture reflection matrix used to rotate/transform the reflection.
  62450. * @returns the reflection matrix
  62451. */
  62452. getReflectionTextureMatrix(): Matrix;
  62453. /**
  62454. * Set the texture reflection matrix used to rotate/transform the reflection.
  62455. * @param value Define the reflection matrix to set
  62456. */
  62457. setReflectionTextureMatrix(value: Matrix): void;
  62458. /**
  62459. * Parses a JSON representation of an HDR Texture in order to create the texture
  62460. * @param parsedTexture Define the JSON representation
  62461. * @param scene Define the scene the texture should be created in
  62462. * @param rootUrl Define the root url in case we need to load relative dependencies
  62463. * @returns the newly created texture after parsing
  62464. */
  62465. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): Nullable<HDRCubeTexture>;
  62466. serialize(): any;
  62467. }
  62468. }
  62469. declare module "babylonjs/Physics/physicsEngine" {
  62470. import { Nullable } from "babylonjs/types";
  62471. import { Vector3 } from "babylonjs/Maths/math.vector";
  62472. import { IPhysicsEngine, IPhysicsEnginePlugin } from "babylonjs/Physics/IPhysicsEngine";
  62473. import { PhysicsImpostor, IPhysicsEnabledObject } from "babylonjs/Physics/physicsImpostor";
  62474. import { PhysicsJoint } from "babylonjs/Physics/physicsJoint";
  62475. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  62476. /**
  62477. * Class used to control physics engine
  62478. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  62479. */
  62480. export class PhysicsEngine implements IPhysicsEngine {
  62481. private _physicsPlugin;
  62482. /**
  62483. * Global value used to control the smallest number supported by the simulation
  62484. */
  62485. static Epsilon: number;
  62486. private _impostors;
  62487. private _joints;
  62488. private _subTimeStep;
  62489. /**
  62490. * Gets the gravity vector used by the simulation
  62491. */
  62492. gravity: Vector3;
  62493. /**
  62494. * Factory used to create the default physics plugin.
  62495. * @returns The default physics plugin
  62496. */
  62497. static DefaultPluginFactory(): IPhysicsEnginePlugin;
  62498. /**
  62499. * Creates a new Physics Engine
  62500. * @param gravity defines the gravity vector used by the simulation
  62501. * @param _physicsPlugin defines the plugin to use (CannonJS by default)
  62502. */
  62503. constructor(gravity: Nullable<Vector3>, _physicsPlugin?: IPhysicsEnginePlugin);
  62504. /**
  62505. * Sets the gravity vector used by the simulation
  62506. * @param gravity defines the gravity vector to use
  62507. */
  62508. setGravity(gravity: Vector3): void;
  62509. /**
  62510. * Set the time step of the physics engine.
  62511. * Default is 1/60.
  62512. * To slow it down, enter 1/600 for example.
  62513. * To speed it up, 1/30
  62514. * @param newTimeStep defines the new timestep to apply to this world.
  62515. */
  62516. setTimeStep(newTimeStep?: number): void;
  62517. /**
  62518. * Get the time step of the physics engine.
  62519. * @returns the current time step
  62520. */
  62521. getTimeStep(): number;
  62522. /**
  62523. * Set the sub time step of the physics engine.
  62524. * Default is 0 meaning there is no sub steps
  62525. * To increase physics resolution precision, set a small value (like 1 ms)
  62526. * @param subTimeStep defines the new sub timestep used for physics resolution.
  62527. */
  62528. setSubTimeStep(subTimeStep?: number): void;
  62529. /**
  62530. * Get the sub time step of the physics engine.
  62531. * @returns the current sub time step
  62532. */
  62533. getSubTimeStep(): number;
  62534. /**
  62535. * Release all resources
  62536. */
  62537. dispose(): void;
  62538. /**
  62539. * Gets the name of the current physics plugin
  62540. * @returns the name of the plugin
  62541. */
  62542. getPhysicsPluginName(): string;
  62543. /**
  62544. * Adding a new impostor for the impostor tracking.
  62545. * This will be done by the impostor itself.
  62546. * @param impostor the impostor to add
  62547. */
  62548. addImpostor(impostor: PhysicsImpostor): void;
  62549. /**
  62550. * Remove an impostor from the engine.
  62551. * This impostor and its mesh will not longer be updated by the physics engine.
  62552. * @param impostor the impostor to remove
  62553. */
  62554. removeImpostor(impostor: PhysicsImpostor): void;
  62555. /**
  62556. * Add a joint to the physics engine
  62557. * @param mainImpostor defines the main impostor to which the joint is added.
  62558. * @param connectedImpostor defines the impostor that is connected to the main impostor using this joint
  62559. * @param joint defines the joint that will connect both impostors.
  62560. */
  62561. addJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  62562. /**
  62563. * Removes a joint from the simulation
  62564. * @param mainImpostor defines the impostor used with the joint
  62565. * @param connectedImpostor defines the other impostor connected to the main one by the joint
  62566. * @param joint defines the joint to remove
  62567. */
  62568. removeJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  62569. /**
  62570. * Called by the scene. No need to call it.
  62571. * @param delta defines the timespam between frames
  62572. */
  62573. _step(delta: number): void;
  62574. /**
  62575. * Gets the current plugin used to run the simulation
  62576. * @returns current plugin
  62577. */
  62578. getPhysicsPlugin(): IPhysicsEnginePlugin;
  62579. /**
  62580. * Gets the list of physic impostors
  62581. * @returns an array of PhysicsImpostor
  62582. */
  62583. getImpostors(): Array<PhysicsImpostor>;
  62584. /**
  62585. * Gets the impostor for a physics enabled object
  62586. * @param object defines the object impersonated by the impostor
  62587. * @returns the PhysicsImpostor or null if not found
  62588. */
  62589. getImpostorForPhysicsObject(object: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  62590. /**
  62591. * Gets the impostor for a physics body object
  62592. * @param body defines physics body used by the impostor
  62593. * @returns the PhysicsImpostor or null if not found
  62594. */
  62595. getImpostorWithPhysicsBody(body: any): Nullable<PhysicsImpostor>;
  62596. /**
  62597. * Does a raycast in the physics world
  62598. * @param from when should the ray start?
  62599. * @param to when should the ray end?
  62600. * @returns PhysicsRaycastResult
  62601. */
  62602. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  62603. }
  62604. }
  62605. declare module "babylonjs/Physics/Plugins/cannonJSPlugin" {
  62606. import { Nullable } from "babylonjs/types";
  62607. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  62608. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  62609. import { IPhysicsEnginePlugin, PhysicsImpostorJoint } from "babylonjs/Physics/IPhysicsEngine";
  62610. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  62611. import { PhysicsJoint, IMotorEnabledJoint } from "babylonjs/Physics/physicsJoint";
  62612. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  62613. /** @hidden */
  62614. export class CannonJSPlugin implements IPhysicsEnginePlugin {
  62615. private _useDeltaForWorldStep;
  62616. world: any;
  62617. name: string;
  62618. private _physicsMaterials;
  62619. private _fixedTimeStep;
  62620. private _cannonRaycastResult;
  62621. private _raycastResult;
  62622. private _physicsBodysToRemoveAfterStep;
  62623. private _firstFrame;
  62624. BJSCANNON: any;
  62625. constructor(_useDeltaForWorldStep?: boolean, iterations?: number, cannonInjection?: any);
  62626. setGravity(gravity: Vector3): void;
  62627. setTimeStep(timeStep: number): void;
  62628. getTimeStep(): number;
  62629. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  62630. private _removeMarkedPhysicsBodiesFromWorld;
  62631. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  62632. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  62633. generatePhysicsBody(impostor: PhysicsImpostor): void;
  62634. private _processChildMeshes;
  62635. removePhysicsBody(impostor: PhysicsImpostor): void;
  62636. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  62637. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  62638. private _addMaterial;
  62639. private _checkWithEpsilon;
  62640. private _createShape;
  62641. private _createHeightmap;
  62642. private _minus90X;
  62643. private _plus90X;
  62644. private _tmpPosition;
  62645. private _tmpDeltaPosition;
  62646. private _tmpUnityRotation;
  62647. private _updatePhysicsBodyTransformation;
  62648. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  62649. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  62650. isSupported(): boolean;
  62651. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  62652. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  62653. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  62654. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  62655. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  62656. getBodyMass(impostor: PhysicsImpostor): number;
  62657. getBodyFriction(impostor: PhysicsImpostor): number;
  62658. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  62659. getBodyRestitution(impostor: PhysicsImpostor): number;
  62660. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  62661. sleepBody(impostor: PhysicsImpostor): void;
  62662. wakeUpBody(impostor: PhysicsImpostor): void;
  62663. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number): void;
  62664. setMotor(joint: IMotorEnabledJoint, speed?: number, maxForce?: number, motorIndex?: number): void;
  62665. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number): void;
  62666. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  62667. getRadius(impostor: PhysicsImpostor): number;
  62668. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  62669. dispose(): void;
  62670. private _extendNamespace;
  62671. /**
  62672. * Does a raycast in the physics world
  62673. * @param from when should the ray start?
  62674. * @param to when should the ray end?
  62675. * @returns PhysicsRaycastResult
  62676. */
  62677. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  62678. }
  62679. }
  62680. declare module "babylonjs/Physics/Plugins/oimoJSPlugin" {
  62681. import { IPhysicsEnginePlugin, PhysicsImpostorJoint } from "babylonjs/Physics/IPhysicsEngine";
  62682. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  62683. import { PhysicsJoint, IMotorEnabledJoint } from "babylonjs/Physics/physicsJoint";
  62684. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  62685. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  62686. import { Nullable } from "babylonjs/types";
  62687. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  62688. /** @hidden */
  62689. export class OimoJSPlugin implements IPhysicsEnginePlugin {
  62690. private _useDeltaForWorldStep;
  62691. world: any;
  62692. name: string;
  62693. BJSOIMO: any;
  62694. private _raycastResult;
  62695. private _fixedTimeStep;
  62696. constructor(_useDeltaForWorldStep?: boolean, iterations?: number, oimoInjection?: any);
  62697. setGravity(gravity: Vector3): void;
  62698. setTimeStep(timeStep: number): void;
  62699. getTimeStep(): number;
  62700. private _tmpImpostorsArray;
  62701. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  62702. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  62703. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  62704. generatePhysicsBody(impostor: PhysicsImpostor): void;
  62705. private _tmpPositionVector;
  62706. removePhysicsBody(impostor: PhysicsImpostor): void;
  62707. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  62708. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  62709. isSupported(): boolean;
  62710. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  62711. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  62712. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  62713. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  62714. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  62715. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  62716. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  62717. getBodyMass(impostor: PhysicsImpostor): number;
  62718. getBodyFriction(impostor: PhysicsImpostor): number;
  62719. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  62720. getBodyRestitution(impostor: PhysicsImpostor): number;
  62721. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  62722. sleepBody(impostor: PhysicsImpostor): void;
  62723. wakeUpBody(impostor: PhysicsImpostor): void;
  62724. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  62725. setMotor(joint: IMotorEnabledJoint, speed: number, force?: number, motorIndex?: number): void;
  62726. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  62727. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  62728. getRadius(impostor: PhysicsImpostor): number;
  62729. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  62730. dispose(): void;
  62731. /**
  62732. * Does a raycast in the physics world
  62733. * @param from when should the ray start?
  62734. * @param to when should the ray end?
  62735. * @returns PhysicsRaycastResult
  62736. */
  62737. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  62738. }
  62739. }
  62740. declare module "babylonjs/Meshes/Builders/ribbonBuilder" {
  62741. import { Nullable } from "babylonjs/types";
  62742. import { Scene } from "babylonjs/scene";
  62743. import { Vector3, Vector2, Vector4 } from "babylonjs/Maths/math.vector";
  62744. import { Color4 } from "babylonjs/Maths/math.color";
  62745. import { Mesh } from "babylonjs/Meshes/mesh";
  62746. /**
  62747. * Class containing static functions to help procedurally build meshes
  62748. */
  62749. export class RibbonBuilder {
  62750. /**
  62751. * Creates a ribbon mesh. The ribbon is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  62752. * * The parameter `pathArray` is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry
  62753. * * The parameter `closeArray` (boolean, default false) creates a seam between the first and the last paths of the path array
  62754. * * The parameter `closePath` (boolean, default false) creates a seam between the first and the last points of each path of the path array
  62755. * * 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
  62756. * * 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
  62757. * * 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
  62758. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  62759. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  62760. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  62761. * * 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
  62762. * * The parameters `colors` is an optional flat array of `Color4` to set/update each ribbon vertex with its own custom color values
  62763. * * 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
  62764. * * Moreover, you can use the parameter `color` with `instance` (to update the ribbon), only if you previously used it at creation time
  62765. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  62766. * @param name defines the name of the mesh
  62767. * @param options defines the options used to create the mesh
  62768. * @param scene defines the hosting scene
  62769. * @returns the ribbon mesh
  62770. * @see https://doc.babylonjs.com/how_to/ribbon_tutorial
  62771. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  62772. */
  62773. static CreateRibbon(name: string, options: {
  62774. pathArray: Vector3[][];
  62775. closeArray?: boolean;
  62776. closePath?: boolean;
  62777. offset?: number;
  62778. updatable?: boolean;
  62779. sideOrientation?: number;
  62780. frontUVs?: Vector4;
  62781. backUVs?: Vector4;
  62782. instance?: Mesh;
  62783. invertUV?: boolean;
  62784. uvs?: Vector2[];
  62785. colors?: Color4[];
  62786. }, scene?: Nullable<Scene>): Mesh;
  62787. }
  62788. }
  62789. declare module "babylonjs/Meshes/Builders/shapeBuilder" {
  62790. import { Nullable } from "babylonjs/types";
  62791. import { Scene } from "babylonjs/scene";
  62792. import { Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  62793. import { Mesh } from "babylonjs/Meshes/mesh";
  62794. /**
  62795. * Class containing static functions to help procedurally build meshes
  62796. */
  62797. export class ShapeBuilder {
  62798. /**
  62799. * 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.
  62800. * * 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.
  62801. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  62802. * * 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.
  62803. * * The parameter `scale` (float, default 1) is the value to scale the shape.
  62804. * * 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
  62805. * * 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
  62806. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape.
  62807. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  62808. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  62809. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture.
  62810. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  62811. * @param name defines the name of the mesh
  62812. * @param options defines the options used to create the mesh
  62813. * @param scene defines the hosting scene
  62814. * @returns the extruded shape mesh
  62815. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  62816. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  62817. */
  62818. static ExtrudeShape(name: string, options: {
  62819. shape: Vector3[];
  62820. path: Vector3[];
  62821. scale?: number;
  62822. rotation?: number;
  62823. cap?: number;
  62824. updatable?: boolean;
  62825. sideOrientation?: number;
  62826. frontUVs?: Vector4;
  62827. backUVs?: Vector4;
  62828. instance?: Mesh;
  62829. invertUV?: boolean;
  62830. }, scene?: Nullable<Scene>): Mesh;
  62831. /**
  62832. * Creates an custom extruded shape mesh.
  62833. * The custom extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
  62834. * * 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.
  62835. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  62836. * * 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
  62837. * * It must returns a float value that will be the rotation in radians applied to the shape on each path point.
  62838. * * 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
  62839. * * It must returns a float value that will be the scale value applied to the shape on each path point
  62840. * * The parameter `ribbonClosePath` (boolean, default false) forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  62841. * * The parameter `ribbonCloseArray` (boolean, default false) forces the extrusion underlying ribbon to close its `pathArray`
  62842. * * 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
  62843. * * 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
  62844. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape
  62845. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  62846. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  62847. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  62848. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  62849. * @param name defines the name of the mesh
  62850. * @param options defines the options used to create the mesh
  62851. * @param scene defines the hosting scene
  62852. * @returns the custom extruded shape mesh
  62853. * @see https://doc.babylonjs.com/how_to/parametric_shapes#custom-extruded-shapes
  62854. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  62855. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  62856. */
  62857. static ExtrudeShapeCustom(name: string, options: {
  62858. shape: Vector3[];
  62859. path: Vector3[];
  62860. scaleFunction?: any;
  62861. rotationFunction?: any;
  62862. ribbonCloseArray?: boolean;
  62863. ribbonClosePath?: boolean;
  62864. cap?: number;
  62865. updatable?: boolean;
  62866. sideOrientation?: number;
  62867. frontUVs?: Vector4;
  62868. backUVs?: Vector4;
  62869. instance?: Mesh;
  62870. invertUV?: boolean;
  62871. }, scene?: Nullable<Scene>): Mesh;
  62872. private static _ExtrudeShapeGeneric;
  62873. }
  62874. }
  62875. declare module "babylonjs/Physics/Plugins/ammoJSPlugin" {
  62876. import { Quaternion, Vector3 } from "babylonjs/Maths/math.vector";
  62877. import { IPhysicsEnginePlugin, PhysicsImpostorJoint } from "babylonjs/Physics/IPhysicsEngine";
  62878. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  62879. import { PhysicsJoint, IMotorEnabledJoint } from "babylonjs/Physics/physicsJoint";
  62880. import { Nullable } from "babylonjs/types";
  62881. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  62882. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  62883. /**
  62884. * AmmoJS Physics plugin
  62885. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  62886. * @see https://github.com/kripken/ammo.js/
  62887. */
  62888. export class AmmoJSPlugin implements IPhysicsEnginePlugin {
  62889. private _useDeltaForWorldStep;
  62890. /**
  62891. * Reference to the Ammo library
  62892. */
  62893. bjsAMMO: any;
  62894. /**
  62895. * Created ammoJS world which physics bodies are added to
  62896. */
  62897. world: any;
  62898. /**
  62899. * Name of the plugin
  62900. */
  62901. name: string;
  62902. private _timeStep;
  62903. private _fixedTimeStep;
  62904. private _maxSteps;
  62905. private _tmpQuaternion;
  62906. private _tmpAmmoTransform;
  62907. private _tmpAmmoQuaternion;
  62908. private _tmpAmmoConcreteContactResultCallback;
  62909. private _collisionConfiguration;
  62910. private _dispatcher;
  62911. private _overlappingPairCache;
  62912. private _solver;
  62913. private _softBodySolver;
  62914. private _tmpAmmoVectorA;
  62915. private _tmpAmmoVectorB;
  62916. private _tmpAmmoVectorC;
  62917. private _tmpAmmoVectorD;
  62918. private _tmpContactCallbackResult;
  62919. private _tmpAmmoVectorRCA;
  62920. private _tmpAmmoVectorRCB;
  62921. private _raycastResult;
  62922. private static readonly DISABLE_COLLISION_FLAG;
  62923. private static readonly KINEMATIC_FLAG;
  62924. private static readonly DISABLE_DEACTIVATION_FLAG;
  62925. /**
  62926. * Initializes the ammoJS plugin
  62927. * @param _useDeltaForWorldStep if the time between frames should be used when calculating physics steps (Default: true)
  62928. * @param ammoInjection can be used to inject your own ammo reference
  62929. * @param overlappingPairCache can be used to specify your own overlapping pair cache
  62930. */
  62931. constructor(_useDeltaForWorldStep?: boolean, ammoInjection?: any, overlappingPairCache?: any);
  62932. /**
  62933. * Sets the gravity of the physics world (m/(s^2))
  62934. * @param gravity Gravity to set
  62935. */
  62936. setGravity(gravity: Vector3): void;
  62937. /**
  62938. * Amount of time to step forward on each frame (only used if useDeltaForWorldStep is false in the constructor)
  62939. * @param timeStep timestep to use in seconds
  62940. */
  62941. setTimeStep(timeStep: number): void;
  62942. /**
  62943. * 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)
  62944. * @param fixedTimeStep fixedTimeStep to use in seconds
  62945. */
  62946. setFixedTimeStep(fixedTimeStep: number): void;
  62947. /**
  62948. * Sets the maximum number of steps by the physics engine per frame (Default: 5)
  62949. * @param maxSteps the maximum number of steps by the physics engine per frame
  62950. */
  62951. setMaxSteps(maxSteps: number): void;
  62952. /**
  62953. * Gets the current timestep (only used if useDeltaForWorldStep is false in the constructor)
  62954. * @returns the current timestep in seconds
  62955. */
  62956. getTimeStep(): number;
  62957. /**
  62958. * The create custom shape handler function to be called when using BABYLON.PhysicsImposter.CustomImpostor
  62959. */
  62960. onCreateCustomShape: (impostor: PhysicsImpostor) => any;
  62961. private _isImpostorInContact;
  62962. private _isImpostorPairInContact;
  62963. private _stepSimulation;
  62964. /**
  62965. * Moves the physics simulation forward delta seconds and updates the given physics imposters
  62966. * Prior to the step the imposters physics location is set to the position of the babylon meshes
  62967. * After the step the babylon meshes are set to the position of the physics imposters
  62968. * @param delta amount of time to step forward
  62969. * @param impostors array of imposters to update before/after the step
  62970. */
  62971. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  62972. /**
  62973. * Update babylon mesh to match physics world object
  62974. * @param impostor imposter to match
  62975. */
  62976. private _afterSoftStep;
  62977. /**
  62978. * Update babylon mesh vertices vertices to match physics world softbody or cloth
  62979. * @param impostor imposter to match
  62980. */
  62981. private _ropeStep;
  62982. /**
  62983. * Update babylon mesh vertices vertices to match physics world softbody or cloth
  62984. * @param impostor imposter to match
  62985. */
  62986. private _softbodyOrClothStep;
  62987. private _tmpMatrix;
  62988. /**
  62989. * Applies an impulse on the imposter
  62990. * @param impostor imposter to apply impulse to
  62991. * @param force amount of force to be applied to the imposter
  62992. * @param contactPoint the location to apply the impulse on the imposter
  62993. */
  62994. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  62995. /**
  62996. * Applies a force on the imposter
  62997. * @param impostor imposter to apply force
  62998. * @param force amount of force to be applied to the imposter
  62999. * @param contactPoint the location to apply the force on the imposter
  63000. */
  63001. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  63002. /**
  63003. * Creates a physics body using the plugin
  63004. * @param impostor the imposter to create the physics body on
  63005. */
  63006. generatePhysicsBody(impostor: PhysicsImpostor): void;
  63007. /**
  63008. * Removes the physics body from the imposter and disposes of the body's memory
  63009. * @param impostor imposter to remove the physics body from
  63010. */
  63011. removePhysicsBody(impostor: PhysicsImpostor): void;
  63012. /**
  63013. * Generates a joint
  63014. * @param impostorJoint the imposter joint to create the joint with
  63015. */
  63016. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  63017. /**
  63018. * Removes a joint
  63019. * @param impostorJoint the imposter joint to remove the joint from
  63020. */
  63021. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  63022. private _addMeshVerts;
  63023. /**
  63024. * Initialise the soft body vertices to match its object's (mesh) vertices
  63025. * Softbody vertices (nodes) are in world space and to match this
  63026. * The object's position and rotation is set to zero and so its vertices are also then set in world space
  63027. * @param impostor to create the softbody for
  63028. */
  63029. private _softVertexData;
  63030. /**
  63031. * Create an impostor's soft body
  63032. * @param impostor to create the softbody for
  63033. */
  63034. private _createSoftbody;
  63035. /**
  63036. * Create cloth for an impostor
  63037. * @param impostor to create the softbody for
  63038. */
  63039. private _createCloth;
  63040. /**
  63041. * Create rope for an impostor
  63042. * @param impostor to create the softbody for
  63043. */
  63044. private _createRope;
  63045. /**
  63046. * Create a custom physics impostor shape using the plugin's onCreateCustomShape handler
  63047. * @param impostor to create the custom physics shape for
  63048. */
  63049. private _createCustom;
  63050. private _addHullVerts;
  63051. private _createShape;
  63052. /**
  63053. * Sets the physics body position/rotation from the babylon mesh's position/rotation
  63054. * @param impostor imposter containing the physics body and babylon object
  63055. */
  63056. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  63057. /**
  63058. * Sets the babylon object's position/rotation from the physics body's position/rotation
  63059. * @param impostor imposter containing the physics body and babylon object
  63060. * @param newPosition new position
  63061. * @param newRotation new rotation
  63062. */
  63063. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  63064. /**
  63065. * If this plugin is supported
  63066. * @returns true if its supported
  63067. */
  63068. isSupported(): boolean;
  63069. /**
  63070. * Sets the linear velocity of the physics body
  63071. * @param impostor imposter to set the velocity on
  63072. * @param velocity velocity to set
  63073. */
  63074. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  63075. /**
  63076. * Sets the angular velocity of the physics body
  63077. * @param impostor imposter to set the velocity on
  63078. * @param velocity velocity to set
  63079. */
  63080. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  63081. /**
  63082. * gets the linear velocity
  63083. * @param impostor imposter to get linear velocity from
  63084. * @returns linear velocity
  63085. */
  63086. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  63087. /**
  63088. * gets the angular velocity
  63089. * @param impostor imposter to get angular velocity from
  63090. * @returns angular velocity
  63091. */
  63092. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  63093. /**
  63094. * Sets the mass of physics body
  63095. * @param impostor imposter to set the mass on
  63096. * @param mass mass to set
  63097. */
  63098. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  63099. /**
  63100. * Gets the mass of the physics body
  63101. * @param impostor imposter to get the mass from
  63102. * @returns mass
  63103. */
  63104. getBodyMass(impostor: PhysicsImpostor): number;
  63105. /**
  63106. * Gets friction of the impostor
  63107. * @param impostor impostor to get friction from
  63108. * @returns friction value
  63109. */
  63110. getBodyFriction(impostor: PhysicsImpostor): number;
  63111. /**
  63112. * Sets friction of the impostor
  63113. * @param impostor impostor to set friction on
  63114. * @param friction friction value
  63115. */
  63116. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  63117. /**
  63118. * Gets restitution of the impostor
  63119. * @param impostor impostor to get restitution from
  63120. * @returns restitution value
  63121. */
  63122. getBodyRestitution(impostor: PhysicsImpostor): number;
  63123. /**
  63124. * Sets resitution of the impostor
  63125. * @param impostor impostor to set resitution on
  63126. * @param restitution resitution value
  63127. */
  63128. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  63129. /**
  63130. * Gets pressure inside the impostor
  63131. * @param impostor impostor to get pressure from
  63132. * @returns pressure value
  63133. */
  63134. getBodyPressure(impostor: PhysicsImpostor): number;
  63135. /**
  63136. * Sets pressure inside a soft body impostor
  63137. * Cloth and rope must remain 0 pressure
  63138. * @param impostor impostor to set pressure on
  63139. * @param pressure pressure value
  63140. */
  63141. setBodyPressure(impostor: PhysicsImpostor, pressure: number): void;
  63142. /**
  63143. * Gets stiffness of the impostor
  63144. * @param impostor impostor to get stiffness from
  63145. * @returns pressure value
  63146. */
  63147. getBodyStiffness(impostor: PhysicsImpostor): number;
  63148. /**
  63149. * Sets stiffness of the impostor
  63150. * @param impostor impostor to set stiffness on
  63151. * @param stiffness stiffness value from 0 to 1
  63152. */
  63153. setBodyStiffness(impostor: PhysicsImpostor, stiffness: number): void;
  63154. /**
  63155. * Gets velocityIterations of the impostor
  63156. * @param impostor impostor to get velocity iterations from
  63157. * @returns velocityIterations value
  63158. */
  63159. getBodyVelocityIterations(impostor: PhysicsImpostor): number;
  63160. /**
  63161. * Sets velocityIterations of the impostor
  63162. * @param impostor impostor to set velocity iterations on
  63163. * @param velocityIterations velocityIterations value
  63164. */
  63165. setBodyVelocityIterations(impostor: PhysicsImpostor, velocityIterations: number): void;
  63166. /**
  63167. * Gets positionIterations of the impostor
  63168. * @param impostor impostor to get position iterations from
  63169. * @returns positionIterations value
  63170. */
  63171. getBodyPositionIterations(impostor: PhysicsImpostor): number;
  63172. /**
  63173. * Sets positionIterations of the impostor
  63174. * @param impostor impostor to set position on
  63175. * @param positionIterations positionIterations value
  63176. */
  63177. setBodyPositionIterations(impostor: PhysicsImpostor, positionIterations: number): void;
  63178. /**
  63179. * Append an anchor to a cloth object
  63180. * @param impostor is the cloth impostor to add anchor to
  63181. * @param otherImpostor is the rigid impostor to anchor to
  63182. * @param width ratio across width from 0 to 1
  63183. * @param height ratio up height from 0 to 1
  63184. * @param influence the elasticity between cloth impostor and anchor from 0, very stretchy to 1, little strech
  63185. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  63186. */
  63187. appendAnchor(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, width: number, height: number, influence?: number, noCollisionBetweenLinkedBodies?: boolean): void;
  63188. /**
  63189. * Append an hook to a rope object
  63190. * @param impostor is the rope impostor to add hook to
  63191. * @param otherImpostor is the rigid impostor to hook to
  63192. * @param length ratio along the rope from 0 to 1
  63193. * @param influence the elasticity between soft impostor and anchor from 0, very stretchy to 1, little strech
  63194. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  63195. */
  63196. appendHook(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, length: number, influence?: number, noCollisionBetweenLinkedBodies?: boolean): void;
  63197. /**
  63198. * Sleeps the physics body and stops it from being active
  63199. * @param impostor impostor to sleep
  63200. */
  63201. sleepBody(impostor: PhysicsImpostor): void;
  63202. /**
  63203. * Activates the physics body
  63204. * @param impostor impostor to activate
  63205. */
  63206. wakeUpBody(impostor: PhysicsImpostor): void;
  63207. /**
  63208. * Updates the distance parameters of the joint
  63209. * @param joint joint to update
  63210. * @param maxDistance maximum distance of the joint
  63211. * @param minDistance minimum distance of the joint
  63212. */
  63213. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  63214. /**
  63215. * Sets a motor on the joint
  63216. * @param joint joint to set motor on
  63217. * @param speed speed of the motor
  63218. * @param maxForce maximum force of the motor
  63219. * @param motorIndex index of the motor
  63220. */
  63221. setMotor(joint: IMotorEnabledJoint, speed?: number, maxForce?: number, motorIndex?: number): void;
  63222. /**
  63223. * Sets the motors limit
  63224. * @param joint joint to set limit on
  63225. * @param upperLimit upper limit
  63226. * @param lowerLimit lower limit
  63227. */
  63228. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number): void;
  63229. /**
  63230. * Syncs the position and rotation of a mesh with the impostor
  63231. * @param mesh mesh to sync
  63232. * @param impostor impostor to update the mesh with
  63233. */
  63234. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  63235. /**
  63236. * Gets the radius of the impostor
  63237. * @param impostor impostor to get radius from
  63238. * @returns the radius
  63239. */
  63240. getRadius(impostor: PhysicsImpostor): number;
  63241. /**
  63242. * Gets the box size of the impostor
  63243. * @param impostor impostor to get box size from
  63244. * @param result the resulting box size
  63245. */
  63246. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  63247. /**
  63248. * Disposes of the impostor
  63249. */
  63250. dispose(): void;
  63251. /**
  63252. * Does a raycast in the physics world
  63253. * @param from when should the ray start?
  63254. * @param to when should the ray end?
  63255. * @returns PhysicsRaycastResult
  63256. */
  63257. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  63258. }
  63259. }
  63260. declare module "babylonjs/Probes/reflectionProbe" {
  63261. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  63262. import { Vector3 } from "babylonjs/Maths/math.vector";
  63263. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  63264. import { Nullable } from "babylonjs/types";
  63265. import { Scene } from "babylonjs/scene";
  63266. module "babylonjs/abstractScene" {
  63267. interface AbstractScene {
  63268. /**
  63269. * The list of reflection probes added to the scene
  63270. * @see https://doc.babylonjs.com/how_to/how_to_use_reflection_probes
  63271. */
  63272. reflectionProbes: Array<ReflectionProbe>;
  63273. /**
  63274. * Removes the given reflection probe from this scene.
  63275. * @param toRemove The reflection probe to remove
  63276. * @returns The index of the removed reflection probe
  63277. */
  63278. removeReflectionProbe(toRemove: ReflectionProbe): number;
  63279. /**
  63280. * Adds the given reflection probe to this scene.
  63281. * @param newReflectionProbe The reflection probe to add
  63282. */
  63283. addReflectionProbe(newReflectionProbe: ReflectionProbe): void;
  63284. }
  63285. }
  63286. /**
  63287. * Class used to generate realtime reflection / refraction cube textures
  63288. * @see https://doc.babylonjs.com/how_to/how_to_use_reflection_probes
  63289. */
  63290. export class ReflectionProbe {
  63291. /** defines the name of the probe */
  63292. name: string;
  63293. private _scene;
  63294. private _renderTargetTexture;
  63295. private _projectionMatrix;
  63296. private _viewMatrix;
  63297. private _target;
  63298. private _add;
  63299. private _attachedMesh;
  63300. private _invertYAxis;
  63301. /** Gets or sets probe position (center of the cube map) */
  63302. position: Vector3;
  63303. /**
  63304. * Creates a new reflection probe
  63305. * @param name defines the name of the probe
  63306. * @param size defines the texture resolution (for each face)
  63307. * @param scene defines the hosting scene
  63308. * @param generateMipMaps defines if mip maps should be generated automatically (true by default)
  63309. * @param useFloat defines if HDR data (flaot data) should be used to store colors (false by default)
  63310. */
  63311. constructor(
  63312. /** defines the name of the probe */
  63313. name: string, size: number, scene: Scene, generateMipMaps?: boolean, useFloat?: boolean);
  63314. /** Gets or sets the number of samples to use for multi-sampling (0 by default). Required WebGL2 */
  63315. get samples(): number;
  63316. set samples(value: number);
  63317. /** Gets or sets the refresh rate to use (on every frame by default) */
  63318. get refreshRate(): number;
  63319. set refreshRate(value: number);
  63320. /**
  63321. * Gets the hosting scene
  63322. * @returns a Scene
  63323. */
  63324. getScene(): Scene;
  63325. /** Gets the internal CubeTexture used to render to */
  63326. get cubeTexture(): RenderTargetTexture;
  63327. /** Gets the list of meshes to render */
  63328. get renderList(): Nullable<AbstractMesh[]>;
  63329. /**
  63330. * Attach the probe to a specific mesh (Rendering will be done from attached mesh's position)
  63331. * @param mesh defines the mesh to attach to
  63332. */
  63333. attachToMesh(mesh: Nullable<AbstractMesh>): void;
  63334. /**
  63335. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups
  63336. * @param renderingGroupId The rendering group id corresponding to its index
  63337. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  63338. */
  63339. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean): void;
  63340. /**
  63341. * Clean all associated resources
  63342. */
  63343. dispose(): void;
  63344. /**
  63345. * Converts the reflection probe information to a readable string for debug purpose.
  63346. * @param fullDetails Supports for multiple levels of logging within scene loading
  63347. * @returns the human readable reflection probe info
  63348. */
  63349. toString(fullDetails?: boolean): string;
  63350. /**
  63351. * Get the class name of the relfection probe.
  63352. * @returns "ReflectionProbe"
  63353. */
  63354. getClassName(): string;
  63355. /**
  63356. * Serialize the reflection probe to a JSON representation we can easily use in the resepective Parse function.
  63357. * @returns The JSON representation of the texture
  63358. */
  63359. serialize(): any;
  63360. /**
  63361. * Parse the JSON representation of a reflection probe in order to recreate the reflection probe in the given scene.
  63362. * @param parsedReflectionProbe Define the JSON representation of the reflection probe
  63363. * @param scene Define the scene the parsed reflection probe should be instantiated in
  63364. * @param rootUrl Define the root url of the parsing sequence in the case of relative dependencies
  63365. * @returns The parsed reflection probe if successful
  63366. */
  63367. static Parse(parsedReflectionProbe: any, scene: Scene, rootUrl: string): Nullable<ReflectionProbe>;
  63368. }
  63369. }
  63370. declare module "babylonjs/Loading/Plugins/babylonFileLoader" {
  63371. /** @hidden */
  63372. export var _BabylonLoaderRegistered: boolean;
  63373. /**
  63374. * Helps setting up some configuration for the babylon file loader.
  63375. */
  63376. export class BabylonFileLoaderConfiguration {
  63377. /**
  63378. * The loader does not allow injecting custom physix engine into the plugins.
  63379. * Unfortunately in ES6, we need to manually inject them into the plugin.
  63380. * So you could set this variable to your engine import to make it work.
  63381. */
  63382. static LoaderInjectedPhysicsEngine: any;
  63383. }
  63384. }
  63385. declare module "babylonjs/Loading/Plugins/index" {
  63386. export * from "babylonjs/Loading/Plugins/babylonFileLoader";
  63387. }
  63388. declare module "babylonjs/Loading/index" {
  63389. export * from "babylonjs/Loading/loadingScreen";
  63390. export * from "babylonjs/Loading/Plugins/index";
  63391. export * from "babylonjs/Loading/sceneLoader";
  63392. export * from "babylonjs/Loading/sceneLoaderFlags";
  63393. }
  63394. declare module "babylonjs/Materials/Background/index" {
  63395. export * from "babylonjs/Materials/Background/backgroundMaterial";
  63396. }
  63397. declare module "babylonjs/Materials/PBR/pbrBaseSimpleMaterial" {
  63398. import { Scene } from "babylonjs/scene";
  63399. import { Color3 } from "babylonjs/Maths/math.color";
  63400. import { PBRBaseMaterial } from "babylonjs/Materials/PBR/pbrBaseMaterial";
  63401. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  63402. /**
  63403. * The Physically based simple base material of BJS.
  63404. *
  63405. * This enables better naming and convention enforcements on top of the pbrMaterial.
  63406. * It is used as the base class for both the specGloss and metalRough conventions.
  63407. */
  63408. export abstract class PBRBaseSimpleMaterial extends PBRBaseMaterial {
  63409. /**
  63410. * Number of Simultaneous lights allowed on the material.
  63411. */
  63412. maxSimultaneousLights: number;
  63413. /**
  63414. * If sets to true, disables all the lights affecting the material.
  63415. */
  63416. disableLighting: boolean;
  63417. /**
  63418. * Environment Texture used in the material (this is use for both reflection and environment lighting).
  63419. */
  63420. environmentTexture: BaseTexture;
  63421. /**
  63422. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  63423. */
  63424. invertNormalMapX: boolean;
  63425. /**
  63426. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  63427. */
  63428. invertNormalMapY: boolean;
  63429. /**
  63430. * Normal map used in the model.
  63431. */
  63432. normalTexture: BaseTexture;
  63433. /**
  63434. * Emissivie color used to self-illuminate the model.
  63435. */
  63436. emissiveColor: Color3;
  63437. /**
  63438. * Emissivie texture used to self-illuminate the model.
  63439. */
  63440. emissiveTexture: BaseTexture;
  63441. /**
  63442. * Occlusion Channel Strenght.
  63443. */
  63444. occlusionStrength: number;
  63445. /**
  63446. * Occlusion Texture of the material (adding extra occlusion effects).
  63447. */
  63448. occlusionTexture: BaseTexture;
  63449. /**
  63450. * Defines the alpha limits in alpha test mode.
  63451. */
  63452. alphaCutOff: number;
  63453. /**
  63454. * Gets the current double sided mode.
  63455. */
  63456. get doubleSided(): boolean;
  63457. /**
  63458. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  63459. */
  63460. set doubleSided(value: boolean);
  63461. /**
  63462. * Stores the pre-calculated light information of a mesh in a texture.
  63463. */
  63464. lightmapTexture: BaseTexture;
  63465. /**
  63466. * If true, the light map contains occlusion information instead of lighting info.
  63467. */
  63468. useLightmapAsShadowmap: boolean;
  63469. /**
  63470. * Instantiates a new PBRMaterial instance.
  63471. *
  63472. * @param name The material name
  63473. * @param scene The scene the material will be use in.
  63474. */
  63475. constructor(name: string, scene: Scene);
  63476. getClassName(): string;
  63477. }
  63478. }
  63479. declare module "babylonjs/Materials/PBR/pbrMetallicRoughnessMaterial" {
  63480. import { Scene } from "babylonjs/scene";
  63481. import { Color3 } from "babylonjs/Maths/math.color";
  63482. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  63483. import { PBRBaseSimpleMaterial } from "babylonjs/Materials/PBR/pbrBaseSimpleMaterial";
  63484. /**
  63485. * The PBR material of BJS following the metal roughness convention.
  63486. *
  63487. * This fits to the PBR convention in the GLTF definition:
  63488. * https://github.com/KhronosGroup/glTF/tree/2.0/specification/2.0
  63489. */
  63490. export class PBRMetallicRoughnessMaterial extends PBRBaseSimpleMaterial {
  63491. /**
  63492. * The base color has two different interpretations depending on the value of metalness.
  63493. * When the material is a metal, the base color is the specific measured reflectance value
  63494. * at normal incidence (F0). For a non-metal the base color represents the reflected diffuse color
  63495. * of the material.
  63496. */
  63497. baseColor: Color3;
  63498. /**
  63499. * Base texture of the metallic workflow. It contains both the baseColor information in RGB as
  63500. * well as opacity information in the alpha channel.
  63501. */
  63502. baseTexture: BaseTexture;
  63503. /**
  63504. * Specifies the metallic scalar value of the material.
  63505. * Can also be used to scale the metalness values of the metallic texture.
  63506. */
  63507. metallic: number;
  63508. /**
  63509. * Specifies the roughness scalar value of the material.
  63510. * Can also be used to scale the roughness values of the metallic texture.
  63511. */
  63512. roughness: number;
  63513. /**
  63514. * Texture containing both the metallic value in the B channel and the
  63515. * roughness value in the G channel to keep better precision.
  63516. */
  63517. metallicRoughnessTexture: BaseTexture;
  63518. /**
  63519. * Instantiates a new PBRMetalRoughnessMaterial instance.
  63520. *
  63521. * @param name The material name
  63522. * @param scene The scene the material will be use in.
  63523. */
  63524. constructor(name: string, scene: Scene);
  63525. /**
  63526. * Return the currrent class name of the material.
  63527. */
  63528. getClassName(): string;
  63529. /**
  63530. * Makes a duplicate of the current material.
  63531. * @param name - name to use for the new material.
  63532. */
  63533. clone(name: string): PBRMetallicRoughnessMaterial;
  63534. /**
  63535. * Serialize the material to a parsable JSON object.
  63536. */
  63537. serialize(): any;
  63538. /**
  63539. * Parses a JSON object correponding to the serialize function.
  63540. */
  63541. static Parse(source: any, scene: Scene, rootUrl: string): PBRMetallicRoughnessMaterial;
  63542. }
  63543. }
  63544. declare module "babylonjs/Materials/PBR/pbrSpecularGlossinessMaterial" {
  63545. import { Scene } from "babylonjs/scene";
  63546. import { Color3 } from "babylonjs/Maths/math.color";
  63547. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  63548. import { PBRBaseSimpleMaterial } from "babylonjs/Materials/PBR/pbrBaseSimpleMaterial";
  63549. /**
  63550. * The PBR material of BJS following the specular glossiness convention.
  63551. *
  63552. * This fits to the PBR convention in the GLTF definition:
  63553. * https://github.com/KhronosGroup/glTF/tree/2.0/extensions/Khronos/KHR_materials_pbrSpecularGlossiness
  63554. */
  63555. export class PBRSpecularGlossinessMaterial extends PBRBaseSimpleMaterial {
  63556. /**
  63557. * Specifies the diffuse color of the material.
  63558. */
  63559. diffuseColor: Color3;
  63560. /**
  63561. * Specifies the diffuse texture of the material. This can also contains the opcity value in its alpha
  63562. * channel.
  63563. */
  63564. diffuseTexture: BaseTexture;
  63565. /**
  63566. * Specifies the specular color of the material. This indicates how reflective is the material (none to mirror).
  63567. */
  63568. specularColor: Color3;
  63569. /**
  63570. * Specifies the glossiness of the material. This indicates "how sharp is the reflection".
  63571. */
  63572. glossiness: number;
  63573. /**
  63574. * Specifies both the specular color RGB and the glossiness A of the material per pixels.
  63575. */
  63576. specularGlossinessTexture: BaseTexture;
  63577. /**
  63578. * Instantiates a new PBRSpecularGlossinessMaterial instance.
  63579. *
  63580. * @param name The material name
  63581. * @param scene The scene the material will be use in.
  63582. */
  63583. constructor(name: string, scene: Scene);
  63584. /**
  63585. * Return the currrent class name of the material.
  63586. */
  63587. getClassName(): string;
  63588. /**
  63589. * Makes a duplicate of the current material.
  63590. * @param name - name to use for the new material.
  63591. */
  63592. clone(name: string): PBRSpecularGlossinessMaterial;
  63593. /**
  63594. * Serialize the material to a parsable JSON object.
  63595. */
  63596. serialize(): any;
  63597. /**
  63598. * Parses a JSON object correponding to the serialize function.
  63599. */
  63600. static Parse(source: any, scene: Scene, rootUrl: string): PBRSpecularGlossinessMaterial;
  63601. }
  63602. }
  63603. declare module "babylonjs/Materials/PBR/index" {
  63604. export * from "babylonjs/Materials/PBR/pbrBaseMaterial";
  63605. export * from "babylonjs/Materials/PBR/pbrBaseSimpleMaterial";
  63606. export * from "babylonjs/Materials/PBR/pbrMaterial";
  63607. export * from "babylonjs/Materials/PBR/pbrMetallicRoughnessMaterial";
  63608. export * from "babylonjs/Materials/PBR/pbrSpecularGlossinessMaterial";
  63609. }
  63610. declare module "babylonjs/Materials/Textures/colorGradingTexture" {
  63611. import { Nullable } from "babylonjs/types";
  63612. import { Scene } from "babylonjs/scene";
  63613. import { Matrix } from "babylonjs/Maths/math.vector";
  63614. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  63615. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  63616. import "babylonjs/Engines/Extensions/engine.rawTexture";
  63617. /**
  63618. * This represents a color grading texture. This acts as a lookup table LUT, useful during post process
  63619. * It can help converting any input color in a desired output one. This can then be used to create effects
  63620. * from sepia, black and white to sixties or futuristic rendering...
  63621. *
  63622. * The only supported format is currently 3dl.
  63623. * More information on LUT: https://en.wikipedia.org/wiki/3D_lookup_table
  63624. */
  63625. export class ColorGradingTexture extends BaseTexture {
  63626. /**
  63627. * The texture URL.
  63628. */
  63629. url: string;
  63630. /**
  63631. * Empty line regex stored for GC.
  63632. */
  63633. private static _noneEmptyLineRegex;
  63634. private _textureMatrix;
  63635. private _onLoad;
  63636. /**
  63637. * Instantiates a ColorGradingTexture from the following parameters.
  63638. *
  63639. * @param url The location of the color gradind data (currently only supporting 3dl)
  63640. * @param sceneOrEngine The scene or engine the texture will be used in
  63641. * @param onLoad defines a callback triggered when the texture has been loaded
  63642. */
  63643. constructor(url: string, sceneOrEngine: Scene | ThinEngine, onLoad?: Nullable<() => void>);
  63644. /**
  63645. * Fires the onload event from the constructor if requested.
  63646. */
  63647. private _triggerOnLoad;
  63648. /**
  63649. * Returns the texture matrix used in most of the material.
  63650. * This is not used in color grading but keep for troubleshooting purpose (easily swap diffuse by colorgrading to look in).
  63651. */
  63652. getTextureMatrix(): Matrix;
  63653. /**
  63654. * Occurs when the file being loaded is a .3dl LUT file.
  63655. */
  63656. private load3dlTexture;
  63657. /**
  63658. * Starts the loading process of the texture.
  63659. */
  63660. private loadTexture;
  63661. /**
  63662. * Clones the color gradind texture.
  63663. */
  63664. clone(): ColorGradingTexture;
  63665. /**
  63666. * Called during delayed load for textures.
  63667. */
  63668. delayLoad(): void;
  63669. /**
  63670. * Parses a color grading texture serialized by Babylon.
  63671. * @param parsedTexture The texture information being parsedTexture
  63672. * @param scene The scene to load the texture in
  63673. * @param rootUrl The root url of the data assets to load
  63674. * @return A color gradind texture
  63675. */
  63676. static Parse(parsedTexture: any, scene: Scene): Nullable<ColorGradingTexture>;
  63677. /**
  63678. * Serializes the LUT texture to json format.
  63679. */
  63680. serialize(): any;
  63681. }
  63682. }
  63683. declare module "babylonjs/Materials/Textures/equiRectangularCubeTexture" {
  63684. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  63685. import { Scene } from "babylonjs/scene";
  63686. import { Nullable } from "babylonjs/types";
  63687. import "babylonjs/Engines/Extensions/engine.rawTexture";
  63688. /**
  63689. * This represents a texture coming from an equirectangular image supported by the web browser canvas.
  63690. */
  63691. export class EquiRectangularCubeTexture extends BaseTexture {
  63692. /** The six faces of the cube. */
  63693. private static _FacesMapping;
  63694. private _noMipmap;
  63695. private _onLoad;
  63696. private _onError;
  63697. /** The size of the cubemap. */
  63698. private _size;
  63699. /** The buffer of the image. */
  63700. private _buffer;
  63701. /** The width of the input image. */
  63702. private _width;
  63703. /** The height of the input image. */
  63704. private _height;
  63705. /** The URL to the image. */
  63706. url: string;
  63707. /** The texture coordinates mode. As this texture is stored in a cube format, please modify carefully. */
  63708. coordinatesMode: number;
  63709. /**
  63710. * Instantiates an EquiRectangularCubeTexture from the following parameters.
  63711. * @param url The location of the image
  63712. * @param scene The scene the texture will be used in
  63713. * @param size The cubemap desired size (the more it increases the longer the generation will be)
  63714. * @param noMipmap Forces to not generate the mipmap if true
  63715. * @param gammaSpace Specifies if the texture will be used in gamma or linear space
  63716. * (the PBR material requires those textures in linear space, but the standard material would require them in Gamma space)
  63717. * @param onLoad — defines a callback called when texture is loaded
  63718. * @param onError — defines a callback called if there is an error
  63719. */
  63720. constructor(url: string, scene: Scene, size: number, noMipmap?: boolean, gammaSpace?: boolean, onLoad?: Nullable<() => void>, onError?: Nullable<(message?: string, exception?: any) => void>);
  63721. /**
  63722. * Load the image data, by putting the image on a canvas and extracting its buffer.
  63723. */
  63724. private loadImage;
  63725. /**
  63726. * Convert the image buffer into a cubemap and create a CubeTexture.
  63727. */
  63728. private loadTexture;
  63729. /**
  63730. * Convert the ArrayBuffer into a Float32Array and drop the transparency channel.
  63731. * @param buffer The ArrayBuffer that should be converted.
  63732. * @returns The buffer as Float32Array.
  63733. */
  63734. private getFloat32ArrayFromArrayBuffer;
  63735. /**
  63736. * Get the current class name of the texture useful for serialization or dynamic coding.
  63737. * @returns "EquiRectangularCubeTexture"
  63738. */
  63739. getClassName(): string;
  63740. /**
  63741. * Create a clone of the current EquiRectangularCubeTexture and return it.
  63742. * @returns A clone of the current EquiRectangularCubeTexture.
  63743. */
  63744. clone(): EquiRectangularCubeTexture;
  63745. }
  63746. }
  63747. declare module "babylonjs/Materials/Textures/htmlElementTexture" {
  63748. import { Nullable } from "babylonjs/types";
  63749. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  63750. import { Matrix } from "babylonjs/Maths/math.vector";
  63751. import "babylonjs/Engines/Extensions/engine.dynamicTexture";
  63752. import "babylonjs/Engines/Extensions/engine.videoTexture";
  63753. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  63754. import { Scene } from "babylonjs/scene";
  63755. /**
  63756. * Defines the options related to the creation of an HtmlElementTexture
  63757. */
  63758. export interface IHtmlElementTextureOptions {
  63759. /**
  63760. * Defines wether mip maps should be created or not.
  63761. */
  63762. generateMipMaps?: boolean;
  63763. /**
  63764. * Defines the sampling mode of the texture.
  63765. */
  63766. samplingMode?: number;
  63767. /**
  63768. * Defines the engine instance to use the texture with. It is not mandatory if you define a scene.
  63769. */
  63770. engine: Nullable<ThinEngine>;
  63771. /**
  63772. * Defines the scene the texture belongs to. It is not mandatory if you define an engine.
  63773. */
  63774. scene: Nullable<Scene>;
  63775. }
  63776. /**
  63777. * This represents the smallest workload to use an already existing element (Canvas or Video) as a texture.
  63778. * To be as efficient as possible depending on your constraints nothing aside the first upload
  63779. * is automatically managed.
  63780. * It is a cheap VideoTexture or DynamicTexture if you prefer to keep full control of the elements
  63781. * in your application.
  63782. *
  63783. * As the update is not automatic, you need to call them manually.
  63784. */
  63785. export class HtmlElementTexture extends BaseTexture {
  63786. /**
  63787. * The texture URL.
  63788. */
  63789. element: HTMLVideoElement | HTMLCanvasElement;
  63790. private static readonly DefaultOptions;
  63791. private _textureMatrix;
  63792. private _isVideo;
  63793. private _generateMipMaps;
  63794. private _samplingMode;
  63795. /**
  63796. * Instantiates a HtmlElementTexture from the following parameters.
  63797. *
  63798. * @param name Defines the name of the texture
  63799. * @param element Defines the video or canvas the texture is filled with
  63800. * @param options Defines the other none mandatory texture creation options
  63801. */
  63802. constructor(name: string, element: HTMLVideoElement | HTMLCanvasElement, options: IHtmlElementTextureOptions);
  63803. private _createInternalTexture;
  63804. /**
  63805. * Returns the texture matrix used in most of the material.
  63806. */
  63807. getTextureMatrix(): Matrix;
  63808. /**
  63809. * Updates the content of the texture.
  63810. * @param invertY Defines wether the texture should be inverted on Y (false by default on video and true on canvas)
  63811. */
  63812. update(invertY?: Nullable<boolean>): void;
  63813. }
  63814. }
  63815. declare module "babylonjs/Misc/tga" {
  63816. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  63817. /**
  63818. * Based on jsTGALoader - Javascript loader for TGA file
  63819. * By Vincent Thibault
  63820. * @see http://blog.robrowser.com/javascript-tga-loader.html
  63821. */
  63822. export class TGATools {
  63823. private static _TYPE_INDEXED;
  63824. private static _TYPE_RGB;
  63825. private static _TYPE_GREY;
  63826. private static _TYPE_RLE_INDEXED;
  63827. private static _TYPE_RLE_RGB;
  63828. private static _TYPE_RLE_GREY;
  63829. private static _ORIGIN_MASK;
  63830. private static _ORIGIN_SHIFT;
  63831. private static _ORIGIN_BL;
  63832. private static _ORIGIN_BR;
  63833. private static _ORIGIN_UL;
  63834. private static _ORIGIN_UR;
  63835. /**
  63836. * Gets the header of a TGA file
  63837. * @param data defines the TGA data
  63838. * @returns the header
  63839. */
  63840. static GetTGAHeader(data: Uint8Array): any;
  63841. /**
  63842. * Uploads TGA content to a Babylon Texture
  63843. * @hidden
  63844. */
  63845. static UploadContent(texture: InternalTexture, data: Uint8Array): void;
  63846. /** @hidden */
  63847. 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;
  63848. /** @hidden */
  63849. 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;
  63850. /** @hidden */
  63851. 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;
  63852. /** @hidden */
  63853. 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;
  63854. /** @hidden */
  63855. 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;
  63856. /** @hidden */
  63857. 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;
  63858. }
  63859. }
  63860. declare module "babylonjs/Materials/Textures/Loaders/tgaTextureLoader" {
  63861. import { Nullable } from "babylonjs/types";
  63862. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  63863. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  63864. /**
  63865. * Implementation of the TGA Texture Loader.
  63866. * @hidden
  63867. */
  63868. export class _TGATextureLoader implements IInternalTextureLoader {
  63869. /**
  63870. * Defines wether the loader supports cascade loading the different faces.
  63871. */
  63872. readonly supportCascades: boolean;
  63873. /**
  63874. * This returns if the loader support the current file information.
  63875. * @param extension defines the file extension of the file being loaded
  63876. * @returns true if the loader can load the specified file
  63877. */
  63878. canLoad(extension: string): boolean;
  63879. /**
  63880. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  63881. * @param data contains the texture data
  63882. * @param texture defines the BabylonJS internal texture
  63883. * @param createPolynomials will be true if polynomials have been requested
  63884. * @param onLoad defines the callback to trigger once the texture is ready
  63885. * @param onError defines the callback to trigger in case of error
  63886. */
  63887. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  63888. /**
  63889. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  63890. * @param data contains the texture data
  63891. * @param texture defines the BabylonJS internal texture
  63892. * @param callback defines the method to call once ready to upload
  63893. */
  63894. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  63895. }
  63896. }
  63897. declare module "babylonjs/Misc/basis" {
  63898. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  63899. /**
  63900. * Info about the .basis files
  63901. */
  63902. class BasisFileInfo {
  63903. /**
  63904. * If the file has alpha
  63905. */
  63906. hasAlpha: boolean;
  63907. /**
  63908. * Info about each image of the basis file
  63909. */
  63910. images: Array<{
  63911. levels: Array<{
  63912. width: number;
  63913. height: number;
  63914. transcodedPixels: ArrayBufferView;
  63915. }>;
  63916. }>;
  63917. }
  63918. /**
  63919. * Result of transcoding a basis file
  63920. */
  63921. class TranscodeResult {
  63922. /**
  63923. * Info about the .basis file
  63924. */
  63925. fileInfo: BasisFileInfo;
  63926. /**
  63927. * Format to use when loading the file
  63928. */
  63929. format: number;
  63930. }
  63931. /**
  63932. * Configuration options for the Basis transcoder
  63933. */
  63934. export class BasisTranscodeConfiguration {
  63935. /**
  63936. * Supported compression formats used to determine the supported output format of the transcoder
  63937. */
  63938. supportedCompressionFormats?: {
  63939. /**
  63940. * etc1 compression format
  63941. */
  63942. etc1?: boolean;
  63943. /**
  63944. * s3tc compression format
  63945. */
  63946. s3tc?: boolean;
  63947. /**
  63948. * pvrtc compression format
  63949. */
  63950. pvrtc?: boolean;
  63951. /**
  63952. * etc2 compression format
  63953. */
  63954. etc2?: boolean;
  63955. };
  63956. /**
  63957. * If mipmap levels should be loaded for transcoded images (Default: true)
  63958. */
  63959. loadMipmapLevels?: boolean;
  63960. /**
  63961. * Index of a single image to load (Default: all images)
  63962. */
  63963. loadSingleImage?: number;
  63964. }
  63965. /**
  63966. * Used to load .Basis files
  63967. * See https://github.com/BinomialLLC/basis_universal/tree/master/webgl
  63968. */
  63969. export class BasisTools {
  63970. private static _IgnoreSupportedFormats;
  63971. /**
  63972. * URL to use when loading the basis transcoder
  63973. */
  63974. static JSModuleURL: string;
  63975. /**
  63976. * URL to use when loading the wasm module for the transcoder
  63977. */
  63978. static WasmModuleURL: string;
  63979. /**
  63980. * Get the internal format to be passed to texImage2D corresponding to the .basis format value
  63981. * @param basisFormat format chosen from GetSupportedTranscodeFormat
  63982. * @returns internal format corresponding to the Basis format
  63983. */
  63984. static GetInternalFormatFromBasisFormat(basisFormat: number): number;
  63985. private static _WorkerPromise;
  63986. private static _Worker;
  63987. private static _actionId;
  63988. private static _CreateWorkerAsync;
  63989. /**
  63990. * Transcodes a loaded image file to compressed pixel data
  63991. * @param data image data to transcode
  63992. * @param config configuration options for the transcoding
  63993. * @returns a promise resulting in the transcoded image
  63994. */
  63995. static TranscodeAsync(data: ArrayBuffer | ArrayBufferView, config: BasisTranscodeConfiguration): Promise<TranscodeResult>;
  63996. /**
  63997. * Loads a texture from the transcode result
  63998. * @param texture texture load to
  63999. * @param transcodeResult the result of transcoding the basis file to load from
  64000. */
  64001. static LoadTextureFromTranscodeResult(texture: InternalTexture, transcodeResult: TranscodeResult): void;
  64002. }
  64003. }
  64004. declare module "babylonjs/Materials/Textures/Loaders/basisTextureLoader" {
  64005. import { Nullable } from "babylonjs/types";
  64006. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  64007. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  64008. /**
  64009. * Loader for .basis file format
  64010. */
  64011. export class _BasisTextureLoader implements IInternalTextureLoader {
  64012. /**
  64013. * Defines whether the loader supports cascade loading the different faces.
  64014. */
  64015. readonly supportCascades: boolean;
  64016. /**
  64017. * This returns if the loader support the current file information.
  64018. * @param extension defines the file extension of the file being loaded
  64019. * @returns true if the loader can load the specified file
  64020. */
  64021. canLoad(extension: string): boolean;
  64022. /**
  64023. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  64024. * @param data contains the texture data
  64025. * @param texture defines the BabylonJS internal texture
  64026. * @param createPolynomials will be true if polynomials have been requested
  64027. * @param onLoad defines the callback to trigger once the texture is ready
  64028. * @param onError defines the callback to trigger in case of error
  64029. */
  64030. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  64031. /**
  64032. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  64033. * @param data contains the texture data
  64034. * @param texture defines the BabylonJS internal texture
  64035. * @param callback defines the method to call once ready to upload
  64036. */
  64037. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  64038. }
  64039. }
  64040. declare module "babylonjs/Materials/Textures/Loaders/index" {
  64041. export * from "babylonjs/Materials/Textures/Loaders/ddsTextureLoader";
  64042. export * from "babylonjs/Materials/Textures/Loaders/envTextureLoader";
  64043. export * from "babylonjs/Materials/Textures/Loaders/ktxTextureLoader";
  64044. export * from "babylonjs/Materials/Textures/Loaders/tgaTextureLoader";
  64045. export * from "babylonjs/Materials/Textures/Loaders/basisTextureLoader";
  64046. }
  64047. declare module "babylonjs/Materials/Textures/Packer/frame" {
  64048. import { Vector2 } from "babylonjs/Maths/math.vector";
  64049. /**
  64050. * Defines the basic options interface of a TexturePacker Frame
  64051. */
  64052. export interface ITexturePackerFrame {
  64053. /**
  64054. * The frame ID
  64055. */
  64056. id: number;
  64057. /**
  64058. * The frames Scale
  64059. */
  64060. scale: Vector2;
  64061. /**
  64062. * The Frames offset
  64063. */
  64064. offset: Vector2;
  64065. }
  64066. /**
  64067. * This is a support class for frame Data on texture packer sets.
  64068. */
  64069. export class TexturePackerFrame implements ITexturePackerFrame {
  64070. /**
  64071. * The frame ID
  64072. */
  64073. id: number;
  64074. /**
  64075. * The frames Scale
  64076. */
  64077. scale: Vector2;
  64078. /**
  64079. * The Frames offset
  64080. */
  64081. offset: Vector2;
  64082. /**
  64083. * Initializes a texture package frame.
  64084. * @param id The numerical frame identifier
  64085. * @param scale Scalar Vector2 for UV frame
  64086. * @param offset Vector2 for the frame position in UV units.
  64087. * @returns TexturePackerFrame
  64088. */
  64089. constructor(id: number, scale: Vector2, offset: Vector2);
  64090. }
  64091. }
  64092. declare module "babylonjs/Materials/Textures/Packer/packer" {
  64093. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  64094. import { Scene } from "babylonjs/scene";
  64095. import { Nullable } from "babylonjs/types";
  64096. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  64097. import { TexturePackerFrame } from "babylonjs/Materials/Textures/Packer/frame";
  64098. /**
  64099. * Defines the basic options interface of a TexturePacker
  64100. */
  64101. export interface ITexturePackerOptions {
  64102. /**
  64103. * Custom targets for the channels of a texture packer. Default is all the channels of the Standard Material
  64104. */
  64105. map?: string[];
  64106. /**
  64107. * the UV input targets, as a single value for all meshes. Defaults to VertexBuffer.UVKind
  64108. */
  64109. uvsIn?: string;
  64110. /**
  64111. * the UV output targets, as a single value for all meshes. Defaults to VertexBuffer.UVKind
  64112. */
  64113. uvsOut?: string;
  64114. /**
  64115. * number representing the layout style. Defaults to LAYOUT_STRIP
  64116. */
  64117. layout?: number;
  64118. /**
  64119. * number of columns if using custom column count layout(2). This defaults to 4.
  64120. */
  64121. colnum?: number;
  64122. /**
  64123. * flag to update the input meshes to the new packed texture after compilation. Defaults to true.
  64124. */
  64125. updateInputMeshes?: boolean;
  64126. /**
  64127. * boolean flag to dispose all the source textures. Defaults to true.
  64128. */
  64129. disposeSources?: boolean;
  64130. /**
  64131. * Fills the blank cells in a set to the customFillColor. Defaults to true.
  64132. */
  64133. fillBlanks?: boolean;
  64134. /**
  64135. * string value representing the context fill style color. Defaults to 'black'.
  64136. */
  64137. customFillColor?: string;
  64138. /**
  64139. * Width and Height Value of each Frame in the TexturePacker Sets
  64140. */
  64141. frameSize?: number;
  64142. /**
  64143. * Ratio of the value to add padding wise to each cell. Defaults to 0.0115
  64144. */
  64145. paddingRatio?: number;
  64146. /**
  64147. * Number that declares the fill method for the padding gutter.
  64148. */
  64149. paddingMode?: number;
  64150. /**
  64151. * If in SUBUV_COLOR padding mode what color to use.
  64152. */
  64153. paddingColor?: Color3 | Color4;
  64154. }
  64155. /**
  64156. * Defines the basic interface of a TexturePacker JSON File
  64157. */
  64158. export interface ITexturePackerJSON {
  64159. /**
  64160. * The frame ID
  64161. */
  64162. name: string;
  64163. /**
  64164. * The base64 channel data
  64165. */
  64166. sets: any;
  64167. /**
  64168. * The options of the Packer
  64169. */
  64170. options: ITexturePackerOptions;
  64171. /**
  64172. * The frame data of the Packer
  64173. */
  64174. frames: Array<number>;
  64175. }
  64176. /**
  64177. * This is a support class that generates a series of packed texture sets.
  64178. * @see https://doc.babylonjs.com/babylon101/materials
  64179. */
  64180. export class TexturePacker {
  64181. /** Packer Layout Constant 0 */
  64182. static readonly LAYOUT_STRIP: number;
  64183. /** Packer Layout Constant 1 */
  64184. static readonly LAYOUT_POWER2: number;
  64185. /** Packer Layout Constant 2 */
  64186. static readonly LAYOUT_COLNUM: number;
  64187. /** Packer Layout Constant 0 */
  64188. static readonly SUBUV_WRAP: number;
  64189. /** Packer Layout Constant 1 */
  64190. static readonly SUBUV_EXTEND: number;
  64191. /** Packer Layout Constant 2 */
  64192. static readonly SUBUV_COLOR: number;
  64193. /** The Name of the Texture Package */
  64194. name: string;
  64195. /** The scene scope of the TexturePacker */
  64196. scene: Scene;
  64197. /** The Meshes to target */
  64198. meshes: AbstractMesh[];
  64199. /** Arguments passed with the Constructor */
  64200. options: ITexturePackerOptions;
  64201. /** The promise that is started upon initialization */
  64202. promise: Nullable<Promise<TexturePacker | string>>;
  64203. /** The Container object for the channel sets that are generated */
  64204. sets: object;
  64205. /** The Container array for the frames that are generated */
  64206. frames: TexturePackerFrame[];
  64207. /** The expected number of textures the system is parsing. */
  64208. private _expecting;
  64209. /** The padding value from Math.ceil(frameSize * paddingRatio) */
  64210. private _paddingValue;
  64211. /**
  64212. * Initializes a texture package series from an array of meshes or a single mesh.
  64213. * @param name The name of the package
  64214. * @param meshes The target meshes to compose the package from
  64215. * @param options The arguments that texture packer should follow while building.
  64216. * @param scene The scene which the textures are scoped to.
  64217. * @returns TexturePacker
  64218. */
  64219. constructor(name: string, meshes: AbstractMesh[], options: ITexturePackerOptions, scene: Scene);
  64220. /**
  64221. * Starts the package process
  64222. * @param resolve The promises resolution function
  64223. * @returns TexturePacker
  64224. */
  64225. private _createFrames;
  64226. /**
  64227. * Calculates the Size of the Channel Sets
  64228. * @returns Vector2
  64229. */
  64230. private _calculateSize;
  64231. /**
  64232. * Calculates the UV data for the frames.
  64233. * @param baseSize the base frameSize
  64234. * @param padding the base frame padding
  64235. * @param dtSize size of the Dynamic Texture for that channel
  64236. * @param dtUnits is 1/dtSize
  64237. * @param update flag to update the input meshes
  64238. */
  64239. private _calculateMeshUVFrames;
  64240. /**
  64241. * Calculates the frames Offset.
  64242. * @param index of the frame
  64243. * @returns Vector2
  64244. */
  64245. private _getFrameOffset;
  64246. /**
  64247. * Updates a Mesh to the frame data
  64248. * @param mesh that is the target
  64249. * @param frameID or the frame index
  64250. */
  64251. private _updateMeshUV;
  64252. /**
  64253. * Updates a Meshes materials to use the texture packer channels
  64254. * @param m is the mesh to target
  64255. * @param force all channels on the packer to be set.
  64256. */
  64257. private _updateTextureReferences;
  64258. /**
  64259. * Public method to set a Mesh to a frame
  64260. * @param m that is the target
  64261. * @param frameID or the frame index
  64262. * @param updateMaterial trigger for if the Meshes attached Material be updated?
  64263. */
  64264. setMeshToFrame(m: AbstractMesh, frameID: number, updateMaterial?: boolean): void;
  64265. /**
  64266. * Starts the async promise to compile the texture packer.
  64267. * @returns Promise<void>
  64268. */
  64269. processAsync(): Promise<void>;
  64270. /**
  64271. * Disposes all textures associated with this packer
  64272. */
  64273. dispose(): void;
  64274. /**
  64275. * Starts the download process for all the channels converting them to base64 data and embedding it all in a JSON file.
  64276. * @param imageType is the image type to use.
  64277. * @param quality of the image if downloading as jpeg, Ranges from >0 to 1.
  64278. */
  64279. download(imageType?: string, quality?: number): void;
  64280. /**
  64281. * Public method to load a texturePacker JSON file.
  64282. * @param data of the JSON file in string format.
  64283. */
  64284. updateFromJSON(data: string): void;
  64285. }
  64286. }
  64287. declare module "babylonjs/Materials/Textures/Packer/index" {
  64288. export * from "babylonjs/Materials/Textures/Packer/packer";
  64289. export * from "babylonjs/Materials/Textures/Packer/frame";
  64290. }
  64291. declare module "babylonjs/Materials/Textures/Procedurals/customProceduralTexture" {
  64292. import { Scene } from "babylonjs/scene";
  64293. import { Texture } from "babylonjs/Materials/Textures/texture";
  64294. import { ProceduralTexture } from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  64295. /**
  64296. * 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.
  64297. * Custom Procedural textures are the easiest way to create your own procedural in your application.
  64298. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures#creating-custom-procedural-textures
  64299. */
  64300. export class CustomProceduralTexture extends ProceduralTexture {
  64301. private _animate;
  64302. private _time;
  64303. private _config;
  64304. private _texturePath;
  64305. /**
  64306. * Instantiates a new Custom Procedural Texture.
  64307. * 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.
  64308. * Custom Procedural textures are the easiest way to create your own procedural in your application.
  64309. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures#creating-custom-procedural-textures
  64310. * @param name Define the name of the texture
  64311. * @param texturePath Define the folder path containing all the cutom texture related files (config, shaders...)
  64312. * @param size Define the size of the texture to create
  64313. * @param scene Define the scene the texture belongs to
  64314. * @param fallbackTexture Define a fallback texture in case there were issues to create the custom texture
  64315. * @param generateMipMaps Define if the texture should creates mip maps or not
  64316. */
  64317. constructor(name: string, texturePath: string, size: number, scene: Scene, fallbackTexture?: Texture, generateMipMaps?: boolean);
  64318. private _loadJson;
  64319. /**
  64320. * Is the texture ready to be used ? (rendered at least once)
  64321. * @returns true if ready, otherwise, false.
  64322. */
  64323. isReady(): boolean;
  64324. /**
  64325. * Render the texture to its associated render target.
  64326. * @param useCameraPostProcess Define if camera post process should be applied to the texture
  64327. */
  64328. render(useCameraPostProcess?: boolean): void;
  64329. /**
  64330. * Update the list of dependant textures samplers in the shader.
  64331. */
  64332. updateTextures(): void;
  64333. /**
  64334. * Update the uniform values of the procedural texture in the shader.
  64335. */
  64336. updateShaderUniforms(): void;
  64337. /**
  64338. * Define if the texture animates or not.
  64339. */
  64340. get animate(): boolean;
  64341. set animate(value: boolean);
  64342. }
  64343. }
  64344. declare module "babylonjs/Shaders/noise.fragment" {
  64345. /** @hidden */
  64346. export var noisePixelShader: {
  64347. name: string;
  64348. shader: string;
  64349. };
  64350. }
  64351. declare module "babylonjs/Materials/Textures/Procedurals/noiseProceduralTexture" {
  64352. import { Nullable } from "babylonjs/types";
  64353. import { Scene } from "babylonjs/scene";
  64354. import { Texture } from "babylonjs/Materials/Textures/texture";
  64355. import { ProceduralTexture } from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  64356. import "babylonjs/Shaders/noise.fragment";
  64357. /**
  64358. * Class used to generate noise procedural textures
  64359. */
  64360. export class NoiseProceduralTexture extends ProceduralTexture {
  64361. private _time;
  64362. /** Gets or sets a value between 0 and 1 indicating the overall brightness of the texture (default is 0.2) */
  64363. brightness: number;
  64364. /** Defines the number of octaves to process */
  64365. octaves: number;
  64366. /** Defines the level of persistence (0.8 by default) */
  64367. persistence: number;
  64368. /** Gets or sets animation speed factor (default is 1) */
  64369. animationSpeedFactor: number;
  64370. /**
  64371. * Creates a new NoiseProceduralTexture
  64372. * @param name defines the name fo the texture
  64373. * @param size defines the size of the texture (default is 256)
  64374. * @param scene defines the hosting scene
  64375. * @param fallbackTexture defines the texture to use if the NoiseProceduralTexture can't be created
  64376. * @param generateMipMaps defines if mipmaps must be generated (true by default)
  64377. */
  64378. constructor(name: string, size?: number, scene?: Nullable<Scene>, fallbackTexture?: Texture, generateMipMaps?: boolean);
  64379. private _updateShaderUniforms;
  64380. protected _getDefines(): string;
  64381. /** Generate the current state of the procedural texture */
  64382. render(useCameraPostProcess?: boolean): void;
  64383. /**
  64384. * Serializes this noise procedural texture
  64385. * @returns a serialized noise procedural texture object
  64386. */
  64387. serialize(): any;
  64388. /**
  64389. * Clone the texture.
  64390. * @returns the cloned texture
  64391. */
  64392. clone(): NoiseProceduralTexture;
  64393. /**
  64394. * Creates a NoiseProceduralTexture from parsed noise procedural texture data
  64395. * @param parsedTexture defines parsed texture data
  64396. * @param scene defines the current scene
  64397. * @param rootUrl defines the root URL containing noise procedural texture information
  64398. * @returns a parsed NoiseProceduralTexture
  64399. */
  64400. static Parse(parsedTexture: any, scene: Scene): NoiseProceduralTexture;
  64401. }
  64402. }
  64403. declare module "babylonjs/Materials/Textures/Procedurals/index" {
  64404. export * from "babylonjs/Materials/Textures/Procedurals/customProceduralTexture";
  64405. export * from "babylonjs/Materials/Textures/Procedurals/noiseProceduralTexture";
  64406. export * from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  64407. export * from "babylonjs/Materials/Textures/Procedurals/proceduralTextureSceneComponent";
  64408. }
  64409. declare module "babylonjs/Materials/Textures/rawCubeTexture" {
  64410. import { Nullable } from "babylonjs/types";
  64411. import { Scene } from "babylonjs/scene";
  64412. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  64413. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  64414. import { CubeTexture } from "babylonjs/Materials/Textures/cubeTexture";
  64415. import "babylonjs/Engines/Extensions/engine.rawTexture";
  64416. /**
  64417. * Raw cube texture where the raw buffers are passed in
  64418. */
  64419. export class RawCubeTexture extends CubeTexture {
  64420. /**
  64421. * Creates a cube texture where the raw buffers are passed in.
  64422. * @param scene defines the scene the texture is attached to
  64423. * @param data defines the array of data to use to create each face
  64424. * @param size defines the size of the textures
  64425. * @param format defines the format of the data
  64426. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  64427. * @param generateMipMaps defines if the engine should generate the mip levels
  64428. * @param invertY defines if data must be stored with Y axis inverted
  64429. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  64430. * @param compression defines the compression used (null by default)
  64431. */
  64432. constructor(scene: Scene, data: Nullable<ArrayBufferView[]>, size: number, format?: number, type?: number, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, compression?: Nullable<string>);
  64433. /**
  64434. * Updates the raw cube texture.
  64435. * @param data defines the data to store
  64436. * @param format defines the data format
  64437. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  64438. * @param invertY defines if data must be stored with Y axis inverted
  64439. * @param compression defines the compression used (null by default)
  64440. * @param level defines which level of the texture to update
  64441. */
  64442. update(data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression?: Nullable<string>): void;
  64443. /**
  64444. * Updates a raw cube texture with RGBD encoded data.
  64445. * @param data defines the array of data [mipmap][face] to use to create each face
  64446. * @param sphericalPolynomial defines the spherical polynomial for irradiance
  64447. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  64448. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  64449. * @returns a promsie that resolves when the operation is complete
  64450. */
  64451. updateRGBDAsync(data: ArrayBufferView[][], sphericalPolynomial?: Nullable<SphericalPolynomial>, lodScale?: number, lodOffset?: number): Promise<void>;
  64452. /**
  64453. * Clones the raw cube texture.
  64454. * @return a new cube texture
  64455. */
  64456. clone(): CubeTexture;
  64457. /** @hidden */
  64458. static _UpdateRGBDAsync(internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number): Promise<void>;
  64459. }
  64460. }
  64461. declare module "babylonjs/Materials/Textures/rawTexture2DArray" {
  64462. import { Scene } from "babylonjs/scene";
  64463. import { Texture } from "babylonjs/Materials/Textures/texture";
  64464. import "babylonjs/Engines/Extensions/engine.rawTexture";
  64465. /**
  64466. * Class used to store 2D array textures containing user data
  64467. */
  64468. export class RawTexture2DArray extends Texture {
  64469. /** Gets or sets the texture format to use */
  64470. format: number;
  64471. /**
  64472. * Create a new RawTexture2DArray
  64473. * @param data defines the data of the texture
  64474. * @param width defines the width of the texture
  64475. * @param height defines the height of the texture
  64476. * @param depth defines the number of layers of the texture
  64477. * @param format defines the texture format to use
  64478. * @param scene defines the hosting scene
  64479. * @param generateMipMaps defines a boolean indicating if mip levels should be generated (true by default)
  64480. * @param invertY defines if texture must be stored with Y axis inverted
  64481. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  64482. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  64483. */
  64484. constructor(data: ArrayBufferView, width: number, height: number, depth: number,
  64485. /** Gets or sets the texture format to use */
  64486. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, textureType?: number);
  64487. /**
  64488. * Update the texture with new data
  64489. * @param data defines the data to store in the texture
  64490. */
  64491. update(data: ArrayBufferView): void;
  64492. }
  64493. }
  64494. declare module "babylonjs/Materials/Textures/rawTexture3D" {
  64495. import { Scene } from "babylonjs/scene";
  64496. import { Texture } from "babylonjs/Materials/Textures/texture";
  64497. import "babylonjs/Engines/Extensions/engine.rawTexture";
  64498. /**
  64499. * Class used to store 3D textures containing user data
  64500. */
  64501. export class RawTexture3D extends Texture {
  64502. /** Gets or sets the texture format to use */
  64503. format: number;
  64504. /**
  64505. * Create a new RawTexture3D
  64506. * @param data defines the data of the texture
  64507. * @param width defines the width of the texture
  64508. * @param height defines the height of the texture
  64509. * @param depth defines the depth of the texture
  64510. * @param format defines the texture format to use
  64511. * @param scene defines the hosting scene
  64512. * @param generateMipMaps defines a boolean indicating if mip levels should be generated (true by default)
  64513. * @param invertY defines if texture must be stored with Y axis inverted
  64514. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  64515. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  64516. */
  64517. constructor(data: ArrayBufferView, width: number, height: number, depth: number,
  64518. /** Gets or sets the texture format to use */
  64519. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, textureType?: number);
  64520. /**
  64521. * Update the texture with new data
  64522. * @param data defines the data to store in the texture
  64523. */
  64524. update(data: ArrayBufferView): void;
  64525. }
  64526. }
  64527. declare module "babylonjs/Materials/Textures/refractionTexture" {
  64528. import { Scene } from "babylonjs/scene";
  64529. import { Plane } from "babylonjs/Maths/math.plane";
  64530. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  64531. /**
  64532. * Creates a refraction texture used by refraction channel of the standard material.
  64533. * It is like a mirror but to see through a material.
  64534. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  64535. */
  64536. export class RefractionTexture extends RenderTargetTexture {
  64537. /**
  64538. * Define the reflection plane we want to use. The refractionPlane is usually set to the constructed refractor.
  64539. * 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.
  64540. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  64541. */
  64542. refractionPlane: Plane;
  64543. /**
  64544. * Define how deep under the surface we should see.
  64545. */
  64546. depth: number;
  64547. /**
  64548. * Creates a refraction texture used by refraction channel of the standard material.
  64549. * It is like a mirror but to see through a material.
  64550. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  64551. * @param name Define the texture name
  64552. * @param size Define the size of the underlying texture
  64553. * @param scene Define the scene the refraction belongs to
  64554. * @param generateMipMaps Define if we need to generate mips level for the refraction
  64555. */
  64556. constructor(name: string, size: number, scene: Scene, generateMipMaps?: boolean);
  64557. /**
  64558. * Clone the refraction texture.
  64559. * @returns the cloned texture
  64560. */
  64561. clone(): RefractionTexture;
  64562. /**
  64563. * Serialize the texture to a JSON representation you could use in Parse later on
  64564. * @returns the serialized JSON representation
  64565. */
  64566. serialize(): any;
  64567. }
  64568. }
  64569. declare module "babylonjs/Materials/Textures/index" {
  64570. export * from "babylonjs/Materials/Textures/baseTexture";
  64571. export * from "babylonjs/Materials/Textures/baseTexture.polynomial";
  64572. export * from "babylonjs/Materials/Textures/colorGradingTexture";
  64573. export * from "babylonjs/Materials/Textures/cubeTexture";
  64574. export * from "babylonjs/Materials/Textures/dynamicTexture";
  64575. export * from "babylonjs/Materials/Textures/equiRectangularCubeTexture";
  64576. export * from "babylonjs/Materials/Textures/Filtering/hdrFiltering";
  64577. export * from "babylonjs/Materials/Textures/hdrCubeTexture";
  64578. export * from "babylonjs/Materials/Textures/htmlElementTexture";
  64579. export * from "babylonjs/Materials/Textures/internalTexture";
  64580. export * from "babylonjs/Materials/Textures/internalTextureLoader";
  64581. export * from "babylonjs/Materials/Textures/Loaders/index";
  64582. export * from "babylonjs/Materials/Textures/mirrorTexture";
  64583. export * from "babylonjs/Materials/Textures/multiRenderTarget";
  64584. export * from "babylonjs/Materials/Textures/Packer/index";
  64585. export * from "babylonjs/Materials/Textures/Procedurals/index";
  64586. export * from "babylonjs/Materials/Textures/rawCubeTexture";
  64587. export * from "babylonjs/Materials/Textures/rawTexture";
  64588. export * from "babylonjs/Materials/Textures/rawTexture2DArray";
  64589. export * from "babylonjs/Materials/Textures/rawTexture3D";
  64590. export * from "babylonjs/Materials/Textures/refractionTexture";
  64591. export * from "babylonjs/Materials/Textures/renderTargetTexture";
  64592. export * from "babylonjs/Materials/Textures/texture";
  64593. export * from "babylonjs/Materials/Textures/videoTexture";
  64594. }
  64595. declare module "babylonjs/Materials/Node/Enums/index" {
  64596. export * from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  64597. export * from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  64598. export * from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointMode";
  64599. export * from "babylonjs/Materials/Node/Enums/nodeMaterialSystemValues";
  64600. export * from "babylonjs/Materials/Node/Enums/nodeMaterialModes";
  64601. }
  64602. declare module "babylonjs/Materials/Node/Blocks/Vertex/bonesBlock" {
  64603. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  64604. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  64605. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  64606. import { Mesh } from "babylonjs/Meshes/mesh";
  64607. import { Effect } from "babylonjs/Materials/effect";
  64608. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  64609. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  64610. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  64611. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  64612. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  64613. /**
  64614. * Block used to add support for vertex skinning (bones)
  64615. */
  64616. export class BonesBlock extends NodeMaterialBlock {
  64617. /**
  64618. * Creates a new BonesBlock
  64619. * @param name defines the block name
  64620. */
  64621. constructor(name: string);
  64622. /**
  64623. * Initialize the block and prepare the context for build
  64624. * @param state defines the state that will be used for the build
  64625. */
  64626. initialize(state: NodeMaterialBuildState): void;
  64627. /**
  64628. * Gets the current class name
  64629. * @returns the class name
  64630. */
  64631. getClassName(): string;
  64632. /**
  64633. * Gets the matrix indices input component
  64634. */
  64635. get matricesIndices(): NodeMaterialConnectionPoint;
  64636. /**
  64637. * Gets the matrix weights input component
  64638. */
  64639. get matricesWeights(): NodeMaterialConnectionPoint;
  64640. /**
  64641. * Gets the extra matrix indices input component
  64642. */
  64643. get matricesIndicesExtra(): NodeMaterialConnectionPoint;
  64644. /**
  64645. * Gets the extra matrix weights input component
  64646. */
  64647. get matricesWeightsExtra(): NodeMaterialConnectionPoint;
  64648. /**
  64649. * Gets the world input component
  64650. */
  64651. get world(): NodeMaterialConnectionPoint;
  64652. /**
  64653. * Gets the output component
  64654. */
  64655. get output(): NodeMaterialConnectionPoint;
  64656. autoConfigure(material: NodeMaterial): void;
  64657. provideFallbacks(mesh: AbstractMesh, fallbacks: EffectFallbacks): void;
  64658. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  64659. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  64660. protected _buildBlock(state: NodeMaterialBuildState): this;
  64661. }
  64662. }
  64663. declare module "babylonjs/Materials/Node/Blocks/Vertex/instancesBlock" {
  64664. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  64665. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  64666. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  64667. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  64668. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  64669. import { SubMesh } from "babylonjs/Meshes/subMesh";
  64670. /**
  64671. * Block used to add support for instances
  64672. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  64673. */
  64674. export class InstancesBlock extends NodeMaterialBlock {
  64675. /**
  64676. * Creates a new InstancesBlock
  64677. * @param name defines the block name
  64678. */
  64679. constructor(name: string);
  64680. /**
  64681. * Gets the current class name
  64682. * @returns the class name
  64683. */
  64684. getClassName(): string;
  64685. /**
  64686. * Gets the first world row input component
  64687. */
  64688. get world0(): NodeMaterialConnectionPoint;
  64689. /**
  64690. * Gets the second world row input component
  64691. */
  64692. get world1(): NodeMaterialConnectionPoint;
  64693. /**
  64694. * Gets the third world row input component
  64695. */
  64696. get world2(): NodeMaterialConnectionPoint;
  64697. /**
  64698. * Gets the forth world row input component
  64699. */
  64700. get world3(): NodeMaterialConnectionPoint;
  64701. /**
  64702. * Gets the world input component
  64703. */
  64704. get world(): NodeMaterialConnectionPoint;
  64705. /**
  64706. * Gets the output component
  64707. */
  64708. get output(): NodeMaterialConnectionPoint;
  64709. /**
  64710. * Gets the isntanceID component
  64711. */
  64712. get instanceID(): NodeMaterialConnectionPoint;
  64713. autoConfigure(material: NodeMaterial): void;
  64714. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean, subMesh?: SubMesh): void;
  64715. protected _buildBlock(state: NodeMaterialBuildState): this;
  64716. }
  64717. }
  64718. declare module "babylonjs/Materials/Node/Blocks/Vertex/morphTargetsBlock" {
  64719. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  64720. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  64721. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  64722. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  64723. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  64724. import { Effect } from "babylonjs/Materials/effect";
  64725. import { Mesh } from "babylonjs/Meshes/mesh";
  64726. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  64727. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  64728. /**
  64729. * Block used to add morph targets support to vertex shader
  64730. */
  64731. export class MorphTargetsBlock extends NodeMaterialBlock {
  64732. private _repeatableContentAnchor;
  64733. /**
  64734. * Create a new MorphTargetsBlock
  64735. * @param name defines the block name
  64736. */
  64737. constructor(name: string);
  64738. /**
  64739. * Gets the current class name
  64740. * @returns the class name
  64741. */
  64742. getClassName(): string;
  64743. /**
  64744. * Gets the position input component
  64745. */
  64746. get position(): NodeMaterialConnectionPoint;
  64747. /**
  64748. * Gets the normal input component
  64749. */
  64750. get normal(): NodeMaterialConnectionPoint;
  64751. /**
  64752. * Gets the tangent input component
  64753. */
  64754. get tangent(): NodeMaterialConnectionPoint;
  64755. /**
  64756. * Gets the tangent input component
  64757. */
  64758. get uv(): NodeMaterialConnectionPoint;
  64759. /**
  64760. * Gets the position output component
  64761. */
  64762. get positionOutput(): NodeMaterialConnectionPoint;
  64763. /**
  64764. * Gets the normal output component
  64765. */
  64766. get normalOutput(): NodeMaterialConnectionPoint;
  64767. /**
  64768. * Gets the tangent output component
  64769. */
  64770. get tangentOutput(): NodeMaterialConnectionPoint;
  64771. /**
  64772. * Gets the tangent output component
  64773. */
  64774. get uvOutput(): NodeMaterialConnectionPoint;
  64775. initialize(state: NodeMaterialBuildState): void;
  64776. autoConfigure(material: NodeMaterial): void;
  64777. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  64778. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  64779. replaceRepeatableContent(vertexShaderState: NodeMaterialBuildState, fragmentShaderState: NodeMaterialBuildState, mesh: AbstractMesh, defines: NodeMaterialDefines): void;
  64780. protected _buildBlock(state: NodeMaterialBuildState): this;
  64781. }
  64782. }
  64783. declare module "babylonjs/Materials/Node/Blocks/Vertex/lightInformationBlock" {
  64784. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  64785. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  64786. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  64787. import { Nullable } from "babylonjs/types";
  64788. import { Scene } from "babylonjs/scene";
  64789. import { Effect } from "babylonjs/Materials/effect";
  64790. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  64791. import { Mesh } from "babylonjs/Meshes/mesh";
  64792. import { Light } from "babylonjs/Lights/light";
  64793. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  64794. /**
  64795. * Block used to get data information from a light
  64796. */
  64797. export class LightInformationBlock extends NodeMaterialBlock {
  64798. private _lightDataUniformName;
  64799. private _lightColorUniformName;
  64800. private _lightTypeDefineName;
  64801. /**
  64802. * Gets or sets the light associated with this block
  64803. */
  64804. light: Nullable<Light>;
  64805. /**
  64806. * Creates a new LightInformationBlock
  64807. * @param name defines the block name
  64808. */
  64809. constructor(name: string);
  64810. /**
  64811. * Gets the current class name
  64812. * @returns the class name
  64813. */
  64814. getClassName(): string;
  64815. /**
  64816. * Gets the world position input component
  64817. */
  64818. get worldPosition(): NodeMaterialConnectionPoint;
  64819. /**
  64820. * Gets the direction output component
  64821. */
  64822. get direction(): NodeMaterialConnectionPoint;
  64823. /**
  64824. * Gets the direction output component
  64825. */
  64826. get color(): NodeMaterialConnectionPoint;
  64827. /**
  64828. * Gets the direction output component
  64829. */
  64830. get intensity(): NodeMaterialConnectionPoint;
  64831. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  64832. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  64833. protected _buildBlock(state: NodeMaterialBuildState): this;
  64834. serialize(): any;
  64835. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  64836. }
  64837. }
  64838. declare module "babylonjs/Materials/Node/Blocks/Vertex/index" {
  64839. export * from "babylonjs/Materials/Node/Blocks/Vertex/vertexOutputBlock";
  64840. export * from "babylonjs/Materials/Node/Blocks/Vertex/bonesBlock";
  64841. export * from "babylonjs/Materials/Node/Blocks/Vertex/instancesBlock";
  64842. export * from "babylonjs/Materials/Node/Blocks/Vertex/morphTargetsBlock";
  64843. export * from "babylonjs/Materials/Node/Blocks/Vertex/lightInformationBlock";
  64844. }
  64845. declare module "babylonjs/Materials/Node/Blocks/Fragment/imageProcessingBlock" {
  64846. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  64847. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  64848. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  64849. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  64850. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  64851. import { Effect } from "babylonjs/Materials/effect";
  64852. import { Mesh } from "babylonjs/Meshes/mesh";
  64853. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  64854. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  64855. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  64856. /**
  64857. * Block used to add image processing support to fragment shader
  64858. */
  64859. export class ImageProcessingBlock extends NodeMaterialBlock {
  64860. /**
  64861. * Create a new ImageProcessingBlock
  64862. * @param name defines the block name
  64863. */
  64864. constructor(name: string);
  64865. /**
  64866. * Gets the current class name
  64867. * @returns the class name
  64868. */
  64869. getClassName(): string;
  64870. /**
  64871. * Gets the color input component
  64872. */
  64873. get color(): NodeMaterialConnectionPoint;
  64874. /**
  64875. * Gets the output component
  64876. */
  64877. get output(): NodeMaterialConnectionPoint;
  64878. /**
  64879. * Initialize the block and prepare the context for build
  64880. * @param state defines the state that will be used for the build
  64881. */
  64882. initialize(state: NodeMaterialBuildState): void;
  64883. isReady(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): boolean;
  64884. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  64885. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  64886. protected _buildBlock(state: NodeMaterialBuildState): this;
  64887. }
  64888. }
  64889. declare module "babylonjs/Materials/Node/Blocks/Fragment/perturbNormalBlock" {
  64890. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  64891. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  64892. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  64893. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  64894. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  64895. import { Effect } from "babylonjs/Materials/effect";
  64896. import { Mesh } from "babylonjs/Meshes/mesh";
  64897. import { Scene } from "babylonjs/scene";
  64898. import "babylonjs/Shaders/ShadersInclude/bumpFragmentMainFunctions";
  64899. import "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions";
  64900. import "babylonjs/Shaders/ShadersInclude/bumpFragment";
  64901. /**
  64902. * Block used to pertub normals based on a normal map
  64903. */
  64904. export class PerturbNormalBlock extends NodeMaterialBlock {
  64905. private _tangentSpaceParameterName;
  64906. /** Gets or sets a boolean indicating that normal should be inverted on X axis */
  64907. invertX: boolean;
  64908. /** Gets or sets a boolean indicating that normal should be inverted on Y axis */
  64909. invertY: boolean;
  64910. /**
  64911. * Create a new PerturbNormalBlock
  64912. * @param name defines the block name
  64913. */
  64914. constructor(name: string);
  64915. /**
  64916. * Gets the current class name
  64917. * @returns the class name
  64918. */
  64919. getClassName(): string;
  64920. /**
  64921. * Gets the world position input component
  64922. */
  64923. get worldPosition(): NodeMaterialConnectionPoint;
  64924. /**
  64925. * Gets the world normal input component
  64926. */
  64927. get worldNormal(): NodeMaterialConnectionPoint;
  64928. /**
  64929. * Gets the world tangent input component
  64930. */
  64931. get worldTangent(): NodeMaterialConnectionPoint;
  64932. /**
  64933. * Gets the uv input component
  64934. */
  64935. get uv(): NodeMaterialConnectionPoint;
  64936. /**
  64937. * Gets the normal map color input component
  64938. */
  64939. get normalMapColor(): NodeMaterialConnectionPoint;
  64940. /**
  64941. * Gets the strength input component
  64942. */
  64943. get strength(): NodeMaterialConnectionPoint;
  64944. /**
  64945. * Gets the output component
  64946. */
  64947. get output(): NodeMaterialConnectionPoint;
  64948. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  64949. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  64950. autoConfigure(material: NodeMaterial): void;
  64951. protected _buildBlock(state: NodeMaterialBuildState): this;
  64952. protected _dumpPropertiesCode(): string;
  64953. serialize(): any;
  64954. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  64955. }
  64956. }
  64957. declare module "babylonjs/Materials/Node/Blocks/Fragment/discardBlock" {
  64958. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  64959. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  64960. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  64961. /**
  64962. * Block used to discard a pixel if a value is smaller than a cutoff
  64963. */
  64964. export class DiscardBlock extends NodeMaterialBlock {
  64965. /**
  64966. * Create a new DiscardBlock
  64967. * @param name defines the block name
  64968. */
  64969. constructor(name: string);
  64970. /**
  64971. * Gets the current class name
  64972. * @returns the class name
  64973. */
  64974. getClassName(): string;
  64975. /**
  64976. * Gets the color input component
  64977. */
  64978. get value(): NodeMaterialConnectionPoint;
  64979. /**
  64980. * Gets the cutoff input component
  64981. */
  64982. get cutoff(): NodeMaterialConnectionPoint;
  64983. protected _buildBlock(state: NodeMaterialBuildState): this;
  64984. }
  64985. }
  64986. declare module "babylonjs/Materials/Node/Blocks/Fragment/frontFacingBlock" {
  64987. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  64988. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  64989. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  64990. /**
  64991. * Block used to test if the fragment shader is front facing
  64992. */
  64993. export class FrontFacingBlock extends NodeMaterialBlock {
  64994. /**
  64995. * Creates a new FrontFacingBlock
  64996. * @param name defines the block name
  64997. */
  64998. constructor(name: string);
  64999. /**
  65000. * Gets the current class name
  65001. * @returns the class name
  65002. */
  65003. getClassName(): string;
  65004. /**
  65005. * Gets the output component
  65006. */
  65007. get output(): NodeMaterialConnectionPoint;
  65008. protected _buildBlock(state: NodeMaterialBuildState): this;
  65009. }
  65010. }
  65011. declare module "babylonjs/Materials/Node/Blocks/Fragment/derivativeBlock" {
  65012. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65013. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65014. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65015. /**
  65016. * Block used to get the derivative value on x and y of a given input
  65017. */
  65018. export class DerivativeBlock extends NodeMaterialBlock {
  65019. /**
  65020. * Create a new DerivativeBlock
  65021. * @param name defines the block name
  65022. */
  65023. constructor(name: string);
  65024. /**
  65025. * Gets the current class name
  65026. * @returns the class name
  65027. */
  65028. getClassName(): string;
  65029. /**
  65030. * Gets the input component
  65031. */
  65032. get input(): NodeMaterialConnectionPoint;
  65033. /**
  65034. * Gets the derivative output on x
  65035. */
  65036. get dx(): NodeMaterialConnectionPoint;
  65037. /**
  65038. * Gets the derivative output on y
  65039. */
  65040. get dy(): NodeMaterialConnectionPoint;
  65041. protected _buildBlock(state: NodeMaterialBuildState): this;
  65042. }
  65043. }
  65044. declare module "babylonjs/Materials/Node/Blocks/Fragment/fragCoordBlock" {
  65045. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65046. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65047. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65048. /**
  65049. * Block used to make gl_FragCoord available
  65050. */
  65051. export class FragCoordBlock extends NodeMaterialBlock {
  65052. /**
  65053. * Creates a new FragCoordBlock
  65054. * @param name defines the block name
  65055. */
  65056. constructor(name: string);
  65057. /**
  65058. * Gets the current class name
  65059. * @returns the class name
  65060. */
  65061. getClassName(): string;
  65062. /**
  65063. * Gets the xy component
  65064. */
  65065. get xy(): NodeMaterialConnectionPoint;
  65066. /**
  65067. * Gets the xyz component
  65068. */
  65069. get xyz(): NodeMaterialConnectionPoint;
  65070. /**
  65071. * Gets the xyzw component
  65072. */
  65073. get xyzw(): NodeMaterialConnectionPoint;
  65074. /**
  65075. * Gets the x component
  65076. */
  65077. get x(): NodeMaterialConnectionPoint;
  65078. /**
  65079. * Gets the y component
  65080. */
  65081. get y(): NodeMaterialConnectionPoint;
  65082. /**
  65083. * Gets the z component
  65084. */
  65085. get z(): NodeMaterialConnectionPoint;
  65086. /**
  65087. * Gets the w component
  65088. */
  65089. get output(): NodeMaterialConnectionPoint;
  65090. protected writeOutputs(state: NodeMaterialBuildState): string;
  65091. protected _buildBlock(state: NodeMaterialBuildState): this;
  65092. }
  65093. }
  65094. declare module "babylonjs/Materials/Node/Blocks/Fragment/screenSizeBlock" {
  65095. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65096. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65097. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65098. import { Effect } from "babylonjs/Materials/effect";
  65099. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  65100. import { Mesh } from "babylonjs/Meshes/mesh";
  65101. /**
  65102. * Block used to get the screen sizes
  65103. */
  65104. export class ScreenSizeBlock extends NodeMaterialBlock {
  65105. private _varName;
  65106. private _scene;
  65107. /**
  65108. * Creates a new ScreenSizeBlock
  65109. * @param name defines the block name
  65110. */
  65111. constructor(name: string);
  65112. /**
  65113. * Gets the current class name
  65114. * @returns the class name
  65115. */
  65116. getClassName(): string;
  65117. /**
  65118. * Gets the xy component
  65119. */
  65120. get xy(): NodeMaterialConnectionPoint;
  65121. /**
  65122. * Gets the x component
  65123. */
  65124. get x(): NodeMaterialConnectionPoint;
  65125. /**
  65126. * Gets the y component
  65127. */
  65128. get y(): NodeMaterialConnectionPoint;
  65129. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  65130. protected writeOutputs(state: NodeMaterialBuildState, varName: string): string;
  65131. protected _buildBlock(state: NodeMaterialBuildState): this;
  65132. }
  65133. }
  65134. declare module "babylonjs/Materials/Node/Blocks/Fragment/index" {
  65135. export * from "babylonjs/Materials/Node/Blocks/Fragment/fragmentOutputBlock";
  65136. export * from "babylonjs/Materials/Node/Blocks/Fragment/imageProcessingBlock";
  65137. export * from "babylonjs/Materials/Node/Blocks/Fragment/perturbNormalBlock";
  65138. export * from "babylonjs/Materials/Node/Blocks/Fragment/discardBlock";
  65139. export * from "babylonjs/Materials/Node/Blocks/Fragment/frontFacingBlock";
  65140. export * from "babylonjs/Materials/Node/Blocks/Fragment/derivativeBlock";
  65141. export * from "babylonjs/Materials/Node/Blocks/Fragment/fragCoordBlock";
  65142. export * from "babylonjs/Materials/Node/Blocks/Fragment/screenSizeBlock";
  65143. }
  65144. declare module "babylonjs/Materials/Node/Blocks/Dual/fogBlock" {
  65145. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65146. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65147. import { Mesh } from "babylonjs/Meshes/mesh";
  65148. import { Effect } from "babylonjs/Materials/effect";
  65149. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65150. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65151. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  65152. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  65153. /**
  65154. * Block used to add support for scene fog
  65155. */
  65156. export class FogBlock extends NodeMaterialBlock {
  65157. private _fogDistanceName;
  65158. private _fogParameters;
  65159. /**
  65160. * Create a new FogBlock
  65161. * @param name defines the block name
  65162. */
  65163. constructor(name: string);
  65164. /**
  65165. * Gets the current class name
  65166. * @returns the class name
  65167. */
  65168. getClassName(): string;
  65169. /**
  65170. * Gets the world position input component
  65171. */
  65172. get worldPosition(): NodeMaterialConnectionPoint;
  65173. /**
  65174. * Gets the view input component
  65175. */
  65176. get view(): NodeMaterialConnectionPoint;
  65177. /**
  65178. * Gets the color input component
  65179. */
  65180. get input(): NodeMaterialConnectionPoint;
  65181. /**
  65182. * Gets the fog color input component
  65183. */
  65184. get fogColor(): NodeMaterialConnectionPoint;
  65185. /**
  65186. * Gets the output component
  65187. */
  65188. get output(): NodeMaterialConnectionPoint;
  65189. autoConfigure(material: NodeMaterial): void;
  65190. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  65191. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  65192. protected _buildBlock(state: NodeMaterialBuildState): this;
  65193. }
  65194. }
  65195. declare module "babylonjs/Materials/Node/Blocks/Dual/lightBlock" {
  65196. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65197. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65198. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65199. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65200. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  65201. import { Effect } from "babylonjs/Materials/effect";
  65202. import { Mesh } from "babylonjs/Meshes/mesh";
  65203. import { Light } from "babylonjs/Lights/light";
  65204. import { Nullable } from "babylonjs/types";
  65205. import { Scene } from "babylonjs/scene";
  65206. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  65207. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  65208. import "babylonjs/Shaders/ShadersInclude/lightFragment";
  65209. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  65210. import "babylonjs/Shaders/ShadersInclude/lightsFragmentFunctions";
  65211. import "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions";
  65212. import "babylonjs/Shaders/ShadersInclude/shadowsVertex";
  65213. /**
  65214. * Block used to add light in the fragment shader
  65215. */
  65216. export class LightBlock extends NodeMaterialBlock {
  65217. private _lightId;
  65218. /**
  65219. * Gets or sets the light associated with this block
  65220. */
  65221. light: Nullable<Light>;
  65222. /**
  65223. * Create a new LightBlock
  65224. * @param name defines the block name
  65225. */
  65226. constructor(name: string);
  65227. /**
  65228. * Gets the current class name
  65229. * @returns the class name
  65230. */
  65231. getClassName(): string;
  65232. /**
  65233. * Gets the world position input component
  65234. */
  65235. get worldPosition(): NodeMaterialConnectionPoint;
  65236. /**
  65237. * Gets the world normal input component
  65238. */
  65239. get worldNormal(): NodeMaterialConnectionPoint;
  65240. /**
  65241. * Gets the camera (or eye) position component
  65242. */
  65243. get cameraPosition(): NodeMaterialConnectionPoint;
  65244. /**
  65245. * Gets the glossiness component
  65246. */
  65247. get glossiness(): NodeMaterialConnectionPoint;
  65248. /**
  65249. * Gets the glossinness power component
  65250. */
  65251. get glossPower(): NodeMaterialConnectionPoint;
  65252. /**
  65253. * Gets the diffuse color component
  65254. */
  65255. get diffuseColor(): NodeMaterialConnectionPoint;
  65256. /**
  65257. * Gets the specular color component
  65258. */
  65259. get specularColor(): NodeMaterialConnectionPoint;
  65260. /**
  65261. * Gets the diffuse output component
  65262. */
  65263. get diffuseOutput(): NodeMaterialConnectionPoint;
  65264. /**
  65265. * Gets the specular output component
  65266. */
  65267. get specularOutput(): NodeMaterialConnectionPoint;
  65268. /**
  65269. * Gets the shadow output component
  65270. */
  65271. get shadow(): NodeMaterialConnectionPoint;
  65272. autoConfigure(material: NodeMaterial): void;
  65273. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  65274. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  65275. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  65276. private _injectVertexCode;
  65277. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  65278. serialize(): any;
  65279. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  65280. }
  65281. }
  65282. declare module "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBlock" {
  65283. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65284. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65285. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  65286. import { ReflectionTextureBaseBlock } from "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBaseBlock";
  65287. /**
  65288. * Block used to read a reflection texture from a sampler
  65289. */
  65290. export class ReflectionTextureBlock extends ReflectionTextureBaseBlock {
  65291. /**
  65292. * Create a new ReflectionTextureBlock
  65293. * @param name defines the block name
  65294. */
  65295. constructor(name: string);
  65296. /**
  65297. * Gets the current class name
  65298. * @returns the class name
  65299. */
  65300. getClassName(): string;
  65301. /**
  65302. * Gets the world position input component
  65303. */
  65304. get position(): NodeMaterialConnectionPoint;
  65305. /**
  65306. * Gets the world position input component
  65307. */
  65308. get worldPosition(): NodeMaterialConnectionPoint;
  65309. /**
  65310. * Gets the world normal input component
  65311. */
  65312. get worldNormal(): NodeMaterialConnectionPoint;
  65313. /**
  65314. * Gets the world input component
  65315. */
  65316. get world(): NodeMaterialConnectionPoint;
  65317. /**
  65318. * Gets the camera (or eye) position component
  65319. */
  65320. get cameraPosition(): NodeMaterialConnectionPoint;
  65321. /**
  65322. * Gets the view input component
  65323. */
  65324. get view(): NodeMaterialConnectionPoint;
  65325. /**
  65326. * Gets the rgb output component
  65327. */
  65328. get rgb(): NodeMaterialConnectionPoint;
  65329. /**
  65330. * Gets the rgba output component
  65331. */
  65332. get rgba(): NodeMaterialConnectionPoint;
  65333. /**
  65334. * Gets the r output component
  65335. */
  65336. get r(): NodeMaterialConnectionPoint;
  65337. /**
  65338. * Gets the g output component
  65339. */
  65340. get g(): NodeMaterialConnectionPoint;
  65341. /**
  65342. * Gets the b output component
  65343. */
  65344. get b(): NodeMaterialConnectionPoint;
  65345. /**
  65346. * Gets the a output component
  65347. */
  65348. get a(): NodeMaterialConnectionPoint;
  65349. autoConfigure(material: NodeMaterial): void;
  65350. protected _buildBlock(state: NodeMaterialBuildState): this;
  65351. }
  65352. }
  65353. declare module "babylonjs/Materials/Node/Blocks/Dual/index" {
  65354. export * from "babylonjs/Materials/Node/Blocks/Dual/fogBlock";
  65355. export * from "babylonjs/Materials/Node/Blocks/Dual/lightBlock";
  65356. export * from "babylonjs/Materials/Node/Blocks/Dual/textureBlock";
  65357. export * from "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBlock";
  65358. export * from "babylonjs/Materials/Node/Blocks/Dual/currentScreenBlock";
  65359. }
  65360. declare module "babylonjs/Materials/Node/Blocks/Input/index" {
  65361. export * from "babylonjs/Materials/Node/Blocks/Input/inputBlock";
  65362. export * from "babylonjs/Materials/Node/Blocks/Input/animatedInputBlockTypes";
  65363. }
  65364. declare module "babylonjs/Materials/Node/Blocks/addBlock" {
  65365. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65366. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65367. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65368. /**
  65369. * Block used to add 2 vectors
  65370. */
  65371. export class AddBlock extends NodeMaterialBlock {
  65372. /**
  65373. * Creates a new AddBlock
  65374. * @param name defines the block name
  65375. */
  65376. constructor(name: string);
  65377. /**
  65378. * Gets the current class name
  65379. * @returns the class name
  65380. */
  65381. getClassName(): string;
  65382. /**
  65383. * Gets the left operand input component
  65384. */
  65385. get left(): NodeMaterialConnectionPoint;
  65386. /**
  65387. * Gets the right operand input component
  65388. */
  65389. get right(): NodeMaterialConnectionPoint;
  65390. /**
  65391. * Gets the output component
  65392. */
  65393. get output(): NodeMaterialConnectionPoint;
  65394. protected _buildBlock(state: NodeMaterialBuildState): this;
  65395. }
  65396. }
  65397. declare module "babylonjs/Materials/Node/Blocks/scaleBlock" {
  65398. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65399. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65400. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65401. /**
  65402. * Block used to scale a vector by a float
  65403. */
  65404. export class ScaleBlock extends NodeMaterialBlock {
  65405. /**
  65406. * Creates a new ScaleBlock
  65407. * @param name defines the block name
  65408. */
  65409. constructor(name: string);
  65410. /**
  65411. * Gets the current class name
  65412. * @returns the class name
  65413. */
  65414. getClassName(): string;
  65415. /**
  65416. * Gets the input component
  65417. */
  65418. get input(): NodeMaterialConnectionPoint;
  65419. /**
  65420. * Gets the factor input component
  65421. */
  65422. get factor(): NodeMaterialConnectionPoint;
  65423. /**
  65424. * Gets the output component
  65425. */
  65426. get output(): NodeMaterialConnectionPoint;
  65427. protected _buildBlock(state: NodeMaterialBuildState): this;
  65428. }
  65429. }
  65430. declare module "babylonjs/Materials/Node/Blocks/clampBlock" {
  65431. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65432. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65433. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65434. import { Scene } from "babylonjs/scene";
  65435. /**
  65436. * Block used to clamp a float
  65437. */
  65438. export class ClampBlock extends NodeMaterialBlock {
  65439. /** Gets or sets the minimum range */
  65440. minimum: number;
  65441. /** Gets or sets the maximum range */
  65442. maximum: number;
  65443. /**
  65444. * Creates a new ClampBlock
  65445. * @param name defines the block name
  65446. */
  65447. constructor(name: string);
  65448. /**
  65449. * Gets the current class name
  65450. * @returns the class name
  65451. */
  65452. getClassName(): string;
  65453. /**
  65454. * Gets the value input component
  65455. */
  65456. get value(): NodeMaterialConnectionPoint;
  65457. /**
  65458. * Gets the output component
  65459. */
  65460. get output(): NodeMaterialConnectionPoint;
  65461. protected _buildBlock(state: NodeMaterialBuildState): this;
  65462. protected _dumpPropertiesCode(): string;
  65463. serialize(): any;
  65464. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  65465. }
  65466. }
  65467. declare module "babylonjs/Materials/Node/Blocks/crossBlock" {
  65468. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65469. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65470. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65471. /**
  65472. * Block used to apply a cross product between 2 vectors
  65473. */
  65474. export class CrossBlock extends NodeMaterialBlock {
  65475. /**
  65476. * Creates a new CrossBlock
  65477. * @param name defines the block name
  65478. */
  65479. constructor(name: string);
  65480. /**
  65481. * Gets the current class name
  65482. * @returns the class name
  65483. */
  65484. getClassName(): string;
  65485. /**
  65486. * Gets the left operand input component
  65487. */
  65488. get left(): NodeMaterialConnectionPoint;
  65489. /**
  65490. * Gets the right operand input component
  65491. */
  65492. get right(): NodeMaterialConnectionPoint;
  65493. /**
  65494. * Gets the output component
  65495. */
  65496. get output(): NodeMaterialConnectionPoint;
  65497. protected _buildBlock(state: NodeMaterialBuildState): this;
  65498. }
  65499. }
  65500. declare module "babylonjs/Materials/Node/Blocks/dotBlock" {
  65501. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65502. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65503. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65504. /**
  65505. * Block used to apply a dot product between 2 vectors
  65506. */
  65507. export class DotBlock extends NodeMaterialBlock {
  65508. /**
  65509. * Creates a new DotBlock
  65510. * @param name defines the block name
  65511. */
  65512. constructor(name: string);
  65513. /**
  65514. * Gets the current class name
  65515. * @returns the class name
  65516. */
  65517. getClassName(): string;
  65518. /**
  65519. * Gets the left operand input component
  65520. */
  65521. get left(): NodeMaterialConnectionPoint;
  65522. /**
  65523. * Gets the right operand input component
  65524. */
  65525. get right(): NodeMaterialConnectionPoint;
  65526. /**
  65527. * Gets the output component
  65528. */
  65529. get output(): NodeMaterialConnectionPoint;
  65530. protected _buildBlock(state: NodeMaterialBuildState): this;
  65531. }
  65532. }
  65533. declare module "babylonjs/Materials/Node/Blocks/normalizeBlock" {
  65534. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65535. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65536. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65537. /**
  65538. * Block used to normalize a vector
  65539. */
  65540. export class NormalizeBlock extends NodeMaterialBlock {
  65541. /**
  65542. * Creates a new NormalizeBlock
  65543. * @param name defines the block name
  65544. */
  65545. constructor(name: string);
  65546. /**
  65547. * Gets the current class name
  65548. * @returns the class name
  65549. */
  65550. getClassName(): string;
  65551. /**
  65552. * Gets the input component
  65553. */
  65554. get input(): NodeMaterialConnectionPoint;
  65555. /**
  65556. * Gets the output component
  65557. */
  65558. get output(): NodeMaterialConnectionPoint;
  65559. protected _buildBlock(state: NodeMaterialBuildState): this;
  65560. }
  65561. }
  65562. declare module "babylonjs/Materials/Node/Blocks/trigonometryBlock" {
  65563. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65564. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65565. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65566. import { Scene } from "babylonjs/scene";
  65567. /**
  65568. * Operations supported by the Trigonometry block
  65569. */
  65570. export enum TrigonometryBlockOperations {
  65571. /** Cos */
  65572. Cos = 0,
  65573. /** Sin */
  65574. Sin = 1,
  65575. /** Abs */
  65576. Abs = 2,
  65577. /** Exp */
  65578. Exp = 3,
  65579. /** Exp2 */
  65580. Exp2 = 4,
  65581. /** Round */
  65582. Round = 5,
  65583. /** Floor */
  65584. Floor = 6,
  65585. /** Ceiling */
  65586. Ceiling = 7,
  65587. /** Square root */
  65588. Sqrt = 8,
  65589. /** Log */
  65590. Log = 9,
  65591. /** Tangent */
  65592. Tan = 10,
  65593. /** Arc tangent */
  65594. ArcTan = 11,
  65595. /** Arc cosinus */
  65596. ArcCos = 12,
  65597. /** Arc sinus */
  65598. ArcSin = 13,
  65599. /** Fraction */
  65600. Fract = 14,
  65601. /** Sign */
  65602. Sign = 15,
  65603. /** To radians (from degrees) */
  65604. Radians = 16,
  65605. /** To degrees (from radians) */
  65606. Degrees = 17
  65607. }
  65608. /**
  65609. * Block used to apply trigonometry operation to floats
  65610. */
  65611. export class TrigonometryBlock extends NodeMaterialBlock {
  65612. /**
  65613. * Gets or sets the operation applied by the block
  65614. */
  65615. operation: TrigonometryBlockOperations;
  65616. /**
  65617. * Creates a new TrigonometryBlock
  65618. * @param name defines the block name
  65619. */
  65620. constructor(name: string);
  65621. /**
  65622. * Gets the current class name
  65623. * @returns the class name
  65624. */
  65625. getClassName(): string;
  65626. /**
  65627. * Gets the input component
  65628. */
  65629. get input(): NodeMaterialConnectionPoint;
  65630. /**
  65631. * Gets the output component
  65632. */
  65633. get output(): NodeMaterialConnectionPoint;
  65634. protected _buildBlock(state: NodeMaterialBuildState): this;
  65635. serialize(): any;
  65636. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  65637. protected _dumpPropertiesCode(): string;
  65638. }
  65639. }
  65640. declare module "babylonjs/Materials/Node/Blocks/colorMergerBlock" {
  65641. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65642. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65643. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65644. /**
  65645. * Block used to create a Color3/4 out of individual inputs (one for each component)
  65646. */
  65647. export class ColorMergerBlock extends NodeMaterialBlock {
  65648. /**
  65649. * Create a new ColorMergerBlock
  65650. * @param name defines the block name
  65651. */
  65652. constructor(name: string);
  65653. /**
  65654. * Gets the current class name
  65655. * @returns the class name
  65656. */
  65657. getClassName(): string;
  65658. /**
  65659. * Gets the rgb component (input)
  65660. */
  65661. get rgbIn(): NodeMaterialConnectionPoint;
  65662. /**
  65663. * Gets the r component (input)
  65664. */
  65665. get r(): NodeMaterialConnectionPoint;
  65666. /**
  65667. * Gets the g component (input)
  65668. */
  65669. get g(): NodeMaterialConnectionPoint;
  65670. /**
  65671. * Gets the b component (input)
  65672. */
  65673. get b(): NodeMaterialConnectionPoint;
  65674. /**
  65675. * Gets the a component (input)
  65676. */
  65677. get a(): NodeMaterialConnectionPoint;
  65678. /**
  65679. * Gets the rgba component (output)
  65680. */
  65681. get rgba(): NodeMaterialConnectionPoint;
  65682. /**
  65683. * Gets the rgb component (output)
  65684. */
  65685. get rgbOut(): NodeMaterialConnectionPoint;
  65686. /**
  65687. * Gets the rgb component (output)
  65688. * @deprecated Please use rgbOut instead.
  65689. */
  65690. get rgb(): NodeMaterialConnectionPoint;
  65691. protected _buildBlock(state: NodeMaterialBuildState): this;
  65692. }
  65693. }
  65694. declare module "babylonjs/Materials/Node/Blocks/vectorSplitterBlock" {
  65695. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65696. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65697. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65698. /**
  65699. * Block used to expand a Vector3/4 into 4 outputs (one for each component)
  65700. */
  65701. export class VectorSplitterBlock extends NodeMaterialBlock {
  65702. /**
  65703. * Create a new VectorSplitterBlock
  65704. * @param name defines the block name
  65705. */
  65706. constructor(name: string);
  65707. /**
  65708. * Gets the current class name
  65709. * @returns the class name
  65710. */
  65711. getClassName(): string;
  65712. /**
  65713. * Gets the xyzw component (input)
  65714. */
  65715. get xyzw(): NodeMaterialConnectionPoint;
  65716. /**
  65717. * Gets the xyz component (input)
  65718. */
  65719. get xyzIn(): NodeMaterialConnectionPoint;
  65720. /**
  65721. * Gets the xy component (input)
  65722. */
  65723. get xyIn(): NodeMaterialConnectionPoint;
  65724. /**
  65725. * Gets the xyz component (output)
  65726. */
  65727. get xyzOut(): NodeMaterialConnectionPoint;
  65728. /**
  65729. * Gets the xy component (output)
  65730. */
  65731. get xyOut(): NodeMaterialConnectionPoint;
  65732. /**
  65733. * Gets the x component (output)
  65734. */
  65735. get x(): NodeMaterialConnectionPoint;
  65736. /**
  65737. * Gets the y component (output)
  65738. */
  65739. get y(): NodeMaterialConnectionPoint;
  65740. /**
  65741. * Gets the z component (output)
  65742. */
  65743. get z(): NodeMaterialConnectionPoint;
  65744. /**
  65745. * Gets the w component (output)
  65746. */
  65747. get w(): NodeMaterialConnectionPoint;
  65748. protected _inputRename(name: string): string;
  65749. protected _outputRename(name: string): string;
  65750. protected _buildBlock(state: NodeMaterialBuildState): this;
  65751. }
  65752. }
  65753. declare module "babylonjs/Materials/Node/Blocks/lerpBlock" {
  65754. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65755. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65756. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65757. /**
  65758. * Block used to lerp between 2 values
  65759. */
  65760. export class LerpBlock extends NodeMaterialBlock {
  65761. /**
  65762. * Creates a new LerpBlock
  65763. * @param name defines the block name
  65764. */
  65765. constructor(name: string);
  65766. /**
  65767. * Gets the current class name
  65768. * @returns the class name
  65769. */
  65770. getClassName(): string;
  65771. /**
  65772. * Gets the left operand input component
  65773. */
  65774. get left(): NodeMaterialConnectionPoint;
  65775. /**
  65776. * Gets the right operand input component
  65777. */
  65778. get right(): NodeMaterialConnectionPoint;
  65779. /**
  65780. * Gets the gradient operand input component
  65781. */
  65782. get gradient(): NodeMaterialConnectionPoint;
  65783. /**
  65784. * Gets the output component
  65785. */
  65786. get output(): NodeMaterialConnectionPoint;
  65787. protected _buildBlock(state: NodeMaterialBuildState): this;
  65788. }
  65789. }
  65790. declare module "babylonjs/Materials/Node/Blocks/divideBlock" {
  65791. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65792. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65793. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65794. /**
  65795. * Block used to divide 2 vectors
  65796. */
  65797. export class DivideBlock extends NodeMaterialBlock {
  65798. /**
  65799. * Creates a new DivideBlock
  65800. * @param name defines the block name
  65801. */
  65802. constructor(name: string);
  65803. /**
  65804. * Gets the current class name
  65805. * @returns the class name
  65806. */
  65807. getClassName(): string;
  65808. /**
  65809. * Gets the left operand input component
  65810. */
  65811. get left(): NodeMaterialConnectionPoint;
  65812. /**
  65813. * Gets the right operand input component
  65814. */
  65815. get right(): NodeMaterialConnectionPoint;
  65816. /**
  65817. * Gets the output component
  65818. */
  65819. get output(): NodeMaterialConnectionPoint;
  65820. protected _buildBlock(state: NodeMaterialBuildState): this;
  65821. }
  65822. }
  65823. declare module "babylonjs/Materials/Node/Blocks/subtractBlock" {
  65824. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65825. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65826. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65827. /**
  65828. * Block used to subtract 2 vectors
  65829. */
  65830. export class SubtractBlock extends NodeMaterialBlock {
  65831. /**
  65832. * Creates a new SubtractBlock
  65833. * @param name defines the block name
  65834. */
  65835. constructor(name: string);
  65836. /**
  65837. * Gets the current class name
  65838. * @returns the class name
  65839. */
  65840. getClassName(): string;
  65841. /**
  65842. * Gets the left operand input component
  65843. */
  65844. get left(): NodeMaterialConnectionPoint;
  65845. /**
  65846. * Gets the right operand input component
  65847. */
  65848. get right(): NodeMaterialConnectionPoint;
  65849. /**
  65850. * Gets the output component
  65851. */
  65852. get output(): NodeMaterialConnectionPoint;
  65853. protected _buildBlock(state: NodeMaterialBuildState): this;
  65854. }
  65855. }
  65856. declare module "babylonjs/Materials/Node/Blocks/stepBlock" {
  65857. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65858. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65859. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65860. /**
  65861. * Block used to step a value
  65862. */
  65863. export class StepBlock extends NodeMaterialBlock {
  65864. /**
  65865. * Creates a new StepBlock
  65866. * @param name defines the block name
  65867. */
  65868. constructor(name: string);
  65869. /**
  65870. * Gets the current class name
  65871. * @returns the class name
  65872. */
  65873. getClassName(): string;
  65874. /**
  65875. * Gets the value operand input component
  65876. */
  65877. get value(): NodeMaterialConnectionPoint;
  65878. /**
  65879. * Gets the edge operand input component
  65880. */
  65881. get edge(): NodeMaterialConnectionPoint;
  65882. /**
  65883. * Gets the output component
  65884. */
  65885. get output(): NodeMaterialConnectionPoint;
  65886. protected _buildBlock(state: NodeMaterialBuildState): this;
  65887. }
  65888. }
  65889. declare module "babylonjs/Materials/Node/Blocks/oneMinusBlock" {
  65890. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65891. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65892. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65893. /**
  65894. * Block used to get the opposite (1 - x) of a value
  65895. */
  65896. export class OneMinusBlock extends NodeMaterialBlock {
  65897. /**
  65898. * Creates a new OneMinusBlock
  65899. * @param name defines the block name
  65900. */
  65901. constructor(name: string);
  65902. /**
  65903. * Gets the current class name
  65904. * @returns the class name
  65905. */
  65906. getClassName(): string;
  65907. /**
  65908. * Gets the input component
  65909. */
  65910. get input(): NodeMaterialConnectionPoint;
  65911. /**
  65912. * Gets the output component
  65913. */
  65914. get output(): NodeMaterialConnectionPoint;
  65915. protected _buildBlock(state: NodeMaterialBuildState): this;
  65916. }
  65917. }
  65918. declare module "babylonjs/Materials/Node/Blocks/viewDirectionBlock" {
  65919. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65920. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65921. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65922. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  65923. /**
  65924. * Block used to get the view direction
  65925. */
  65926. export class ViewDirectionBlock extends NodeMaterialBlock {
  65927. /**
  65928. * Creates a new ViewDirectionBlock
  65929. * @param name defines the block name
  65930. */
  65931. constructor(name: string);
  65932. /**
  65933. * Gets the current class name
  65934. * @returns the class name
  65935. */
  65936. getClassName(): string;
  65937. /**
  65938. * Gets the world position component
  65939. */
  65940. get worldPosition(): NodeMaterialConnectionPoint;
  65941. /**
  65942. * Gets the camera position component
  65943. */
  65944. get cameraPosition(): NodeMaterialConnectionPoint;
  65945. /**
  65946. * Gets the output component
  65947. */
  65948. get output(): NodeMaterialConnectionPoint;
  65949. autoConfigure(material: NodeMaterial): void;
  65950. protected _buildBlock(state: NodeMaterialBuildState): this;
  65951. }
  65952. }
  65953. declare module "babylonjs/Materials/Node/Blocks/fresnelBlock" {
  65954. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65955. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65956. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65957. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  65958. import "babylonjs/Shaders/ShadersInclude/fresnelFunction";
  65959. /**
  65960. * Block used to compute fresnel value
  65961. */
  65962. export class FresnelBlock extends NodeMaterialBlock {
  65963. /**
  65964. * Create a new FresnelBlock
  65965. * @param name defines the block name
  65966. */
  65967. constructor(name: string);
  65968. /**
  65969. * Gets the current class name
  65970. * @returns the class name
  65971. */
  65972. getClassName(): string;
  65973. /**
  65974. * Gets the world normal input component
  65975. */
  65976. get worldNormal(): NodeMaterialConnectionPoint;
  65977. /**
  65978. * Gets the view direction input component
  65979. */
  65980. get viewDirection(): NodeMaterialConnectionPoint;
  65981. /**
  65982. * Gets the bias input component
  65983. */
  65984. get bias(): NodeMaterialConnectionPoint;
  65985. /**
  65986. * Gets the camera (or eye) position component
  65987. */
  65988. get power(): NodeMaterialConnectionPoint;
  65989. /**
  65990. * Gets the fresnel output component
  65991. */
  65992. get fresnel(): NodeMaterialConnectionPoint;
  65993. autoConfigure(material: NodeMaterial): void;
  65994. protected _buildBlock(state: NodeMaterialBuildState): this;
  65995. }
  65996. }
  65997. declare module "babylonjs/Materials/Node/Blocks/maxBlock" {
  65998. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65999. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66000. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66001. /**
  66002. * Block used to get the max of 2 values
  66003. */
  66004. export class MaxBlock extends NodeMaterialBlock {
  66005. /**
  66006. * Creates a new MaxBlock
  66007. * @param name defines the block name
  66008. */
  66009. constructor(name: string);
  66010. /**
  66011. * Gets the current class name
  66012. * @returns the class name
  66013. */
  66014. getClassName(): string;
  66015. /**
  66016. * Gets the left operand input component
  66017. */
  66018. get left(): NodeMaterialConnectionPoint;
  66019. /**
  66020. * Gets the right operand input component
  66021. */
  66022. get right(): NodeMaterialConnectionPoint;
  66023. /**
  66024. * Gets the output component
  66025. */
  66026. get output(): NodeMaterialConnectionPoint;
  66027. protected _buildBlock(state: NodeMaterialBuildState): this;
  66028. }
  66029. }
  66030. declare module "babylonjs/Materials/Node/Blocks/minBlock" {
  66031. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66032. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66033. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66034. /**
  66035. * Block used to get the min of 2 values
  66036. */
  66037. export class MinBlock extends NodeMaterialBlock {
  66038. /**
  66039. * Creates a new MinBlock
  66040. * @param name defines the block name
  66041. */
  66042. constructor(name: string);
  66043. /**
  66044. * Gets the current class name
  66045. * @returns the class name
  66046. */
  66047. getClassName(): string;
  66048. /**
  66049. * Gets the left operand input component
  66050. */
  66051. get left(): NodeMaterialConnectionPoint;
  66052. /**
  66053. * Gets the right operand input component
  66054. */
  66055. get right(): NodeMaterialConnectionPoint;
  66056. /**
  66057. * Gets the output component
  66058. */
  66059. get output(): NodeMaterialConnectionPoint;
  66060. protected _buildBlock(state: NodeMaterialBuildState): this;
  66061. }
  66062. }
  66063. declare module "babylonjs/Materials/Node/Blocks/distanceBlock" {
  66064. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66065. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66066. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66067. /**
  66068. * Block used to get the distance between 2 values
  66069. */
  66070. export class DistanceBlock extends NodeMaterialBlock {
  66071. /**
  66072. * Creates a new DistanceBlock
  66073. * @param name defines the block name
  66074. */
  66075. constructor(name: string);
  66076. /**
  66077. * Gets the current class name
  66078. * @returns the class name
  66079. */
  66080. getClassName(): string;
  66081. /**
  66082. * Gets the left operand input component
  66083. */
  66084. get left(): NodeMaterialConnectionPoint;
  66085. /**
  66086. * Gets the right operand input component
  66087. */
  66088. get right(): NodeMaterialConnectionPoint;
  66089. /**
  66090. * Gets the output component
  66091. */
  66092. get output(): NodeMaterialConnectionPoint;
  66093. protected _buildBlock(state: NodeMaterialBuildState): this;
  66094. }
  66095. }
  66096. declare module "babylonjs/Materials/Node/Blocks/lengthBlock" {
  66097. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66098. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66099. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66100. /**
  66101. * Block used to get the length of a vector
  66102. */
  66103. export class LengthBlock extends NodeMaterialBlock {
  66104. /**
  66105. * Creates a new LengthBlock
  66106. * @param name defines the block name
  66107. */
  66108. constructor(name: string);
  66109. /**
  66110. * Gets the current class name
  66111. * @returns the class name
  66112. */
  66113. getClassName(): string;
  66114. /**
  66115. * Gets the value input component
  66116. */
  66117. get value(): NodeMaterialConnectionPoint;
  66118. /**
  66119. * Gets the output component
  66120. */
  66121. get output(): NodeMaterialConnectionPoint;
  66122. protected _buildBlock(state: NodeMaterialBuildState): this;
  66123. }
  66124. }
  66125. declare module "babylonjs/Materials/Node/Blocks/negateBlock" {
  66126. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66127. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66128. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66129. /**
  66130. * Block used to get negative version of a value (i.e. x * -1)
  66131. */
  66132. export class NegateBlock extends NodeMaterialBlock {
  66133. /**
  66134. * Creates a new NegateBlock
  66135. * @param name defines the block name
  66136. */
  66137. constructor(name: string);
  66138. /**
  66139. * Gets the current class name
  66140. * @returns the class name
  66141. */
  66142. getClassName(): string;
  66143. /**
  66144. * Gets the value input component
  66145. */
  66146. get value(): NodeMaterialConnectionPoint;
  66147. /**
  66148. * Gets the output component
  66149. */
  66150. get output(): NodeMaterialConnectionPoint;
  66151. protected _buildBlock(state: NodeMaterialBuildState): this;
  66152. }
  66153. }
  66154. declare module "babylonjs/Materials/Node/Blocks/powBlock" {
  66155. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66156. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66157. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66158. /**
  66159. * Block used to get the value of the first parameter raised to the power of the second
  66160. */
  66161. export class PowBlock extends NodeMaterialBlock {
  66162. /**
  66163. * Creates a new PowBlock
  66164. * @param name defines the block name
  66165. */
  66166. constructor(name: string);
  66167. /**
  66168. * Gets the current class name
  66169. * @returns the class name
  66170. */
  66171. getClassName(): string;
  66172. /**
  66173. * Gets the value operand input component
  66174. */
  66175. get value(): NodeMaterialConnectionPoint;
  66176. /**
  66177. * Gets the power operand input component
  66178. */
  66179. get power(): NodeMaterialConnectionPoint;
  66180. /**
  66181. * Gets the output component
  66182. */
  66183. get output(): NodeMaterialConnectionPoint;
  66184. protected _buildBlock(state: NodeMaterialBuildState): this;
  66185. }
  66186. }
  66187. declare module "babylonjs/Materials/Node/Blocks/randomNumberBlock" {
  66188. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66189. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66190. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66191. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  66192. /**
  66193. * Block used to get a random number
  66194. */
  66195. export class RandomNumberBlock extends NodeMaterialBlock {
  66196. /**
  66197. * Creates a new RandomNumberBlock
  66198. * @param name defines the block name
  66199. */
  66200. constructor(name: string);
  66201. /**
  66202. * Gets the current class name
  66203. * @returns the class name
  66204. */
  66205. getClassName(): string;
  66206. /**
  66207. * Gets the seed input component
  66208. */
  66209. get seed(): NodeMaterialConnectionPoint;
  66210. /**
  66211. * Gets the output component
  66212. */
  66213. get output(): NodeMaterialConnectionPoint;
  66214. protected _buildBlock(state: NodeMaterialBuildState): this;
  66215. }
  66216. }
  66217. declare module "babylonjs/Materials/Node/Blocks/arcTan2Block" {
  66218. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66219. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66220. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66221. /**
  66222. * Block used to compute arc tangent of 2 values
  66223. */
  66224. export class ArcTan2Block extends NodeMaterialBlock {
  66225. /**
  66226. * Creates a new ArcTan2Block
  66227. * @param name defines the block name
  66228. */
  66229. constructor(name: string);
  66230. /**
  66231. * Gets the current class name
  66232. * @returns the class name
  66233. */
  66234. getClassName(): string;
  66235. /**
  66236. * Gets the x operand input component
  66237. */
  66238. get x(): NodeMaterialConnectionPoint;
  66239. /**
  66240. * Gets the y operand input component
  66241. */
  66242. get y(): NodeMaterialConnectionPoint;
  66243. /**
  66244. * Gets the output component
  66245. */
  66246. get output(): NodeMaterialConnectionPoint;
  66247. protected _buildBlock(state: NodeMaterialBuildState): this;
  66248. }
  66249. }
  66250. declare module "babylonjs/Materials/Node/Blocks/smoothStepBlock" {
  66251. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66252. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66253. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66254. /**
  66255. * Block used to smooth step a value
  66256. */
  66257. export class SmoothStepBlock extends NodeMaterialBlock {
  66258. /**
  66259. * Creates a new SmoothStepBlock
  66260. * @param name defines the block name
  66261. */
  66262. constructor(name: string);
  66263. /**
  66264. * Gets the current class name
  66265. * @returns the class name
  66266. */
  66267. getClassName(): string;
  66268. /**
  66269. * Gets the value operand input component
  66270. */
  66271. get value(): NodeMaterialConnectionPoint;
  66272. /**
  66273. * Gets the first edge operand input component
  66274. */
  66275. get edge0(): NodeMaterialConnectionPoint;
  66276. /**
  66277. * Gets the second edge operand input component
  66278. */
  66279. get edge1(): NodeMaterialConnectionPoint;
  66280. /**
  66281. * Gets the output component
  66282. */
  66283. get output(): NodeMaterialConnectionPoint;
  66284. protected _buildBlock(state: NodeMaterialBuildState): this;
  66285. }
  66286. }
  66287. declare module "babylonjs/Materials/Node/Blocks/reciprocalBlock" {
  66288. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66289. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66290. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66291. /**
  66292. * Block used to get the reciprocal (1 / x) of a value
  66293. */
  66294. export class ReciprocalBlock extends NodeMaterialBlock {
  66295. /**
  66296. * Creates a new ReciprocalBlock
  66297. * @param name defines the block name
  66298. */
  66299. constructor(name: string);
  66300. /**
  66301. * Gets the current class name
  66302. * @returns the class name
  66303. */
  66304. getClassName(): string;
  66305. /**
  66306. * Gets the input component
  66307. */
  66308. get input(): NodeMaterialConnectionPoint;
  66309. /**
  66310. * Gets the output component
  66311. */
  66312. get output(): NodeMaterialConnectionPoint;
  66313. protected _buildBlock(state: NodeMaterialBuildState): this;
  66314. }
  66315. }
  66316. declare module "babylonjs/Materials/Node/Blocks/replaceColorBlock" {
  66317. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66318. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66319. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66320. /**
  66321. * Block used to replace a color by another one
  66322. */
  66323. export class ReplaceColorBlock extends NodeMaterialBlock {
  66324. /**
  66325. * Creates a new ReplaceColorBlock
  66326. * @param name defines the block name
  66327. */
  66328. constructor(name: string);
  66329. /**
  66330. * Gets the current class name
  66331. * @returns the class name
  66332. */
  66333. getClassName(): string;
  66334. /**
  66335. * Gets the value input component
  66336. */
  66337. get value(): NodeMaterialConnectionPoint;
  66338. /**
  66339. * Gets the reference input component
  66340. */
  66341. get reference(): NodeMaterialConnectionPoint;
  66342. /**
  66343. * Gets the distance input component
  66344. */
  66345. get distance(): NodeMaterialConnectionPoint;
  66346. /**
  66347. * Gets the replacement input component
  66348. */
  66349. get replacement(): NodeMaterialConnectionPoint;
  66350. /**
  66351. * Gets the output component
  66352. */
  66353. get output(): NodeMaterialConnectionPoint;
  66354. protected _buildBlock(state: NodeMaterialBuildState): this;
  66355. }
  66356. }
  66357. declare module "babylonjs/Materials/Node/Blocks/posterizeBlock" {
  66358. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66359. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66360. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66361. /**
  66362. * Block used to posterize a value
  66363. * @see https://en.wikipedia.org/wiki/Posterization
  66364. */
  66365. export class PosterizeBlock extends NodeMaterialBlock {
  66366. /**
  66367. * Creates a new PosterizeBlock
  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 value input component
  66378. */
  66379. get value(): NodeMaterialConnectionPoint;
  66380. /**
  66381. * Gets the steps input component
  66382. */
  66383. get steps(): 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/waveBlock" {
  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. import { Scene } from "babylonjs/scene";
  66396. /**
  66397. * Operations supported by the Wave block
  66398. */
  66399. export enum WaveBlockKind {
  66400. /** SawTooth */
  66401. SawTooth = 0,
  66402. /** Square */
  66403. Square = 1,
  66404. /** Triangle */
  66405. Triangle = 2
  66406. }
  66407. /**
  66408. * Block used to apply wave operation to floats
  66409. */
  66410. export class WaveBlock extends NodeMaterialBlock {
  66411. /**
  66412. * Gets or sets the kibnd of wave to be applied by the block
  66413. */
  66414. kind: WaveBlockKind;
  66415. /**
  66416. * Creates a new WaveBlock
  66417. * @param name defines the block name
  66418. */
  66419. constructor(name: string);
  66420. /**
  66421. * Gets the current class name
  66422. * @returns the class name
  66423. */
  66424. getClassName(): string;
  66425. /**
  66426. * Gets the input component
  66427. */
  66428. get input(): NodeMaterialConnectionPoint;
  66429. /**
  66430. * Gets the output component
  66431. */
  66432. get output(): NodeMaterialConnectionPoint;
  66433. protected _buildBlock(state: NodeMaterialBuildState): this;
  66434. serialize(): any;
  66435. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  66436. }
  66437. }
  66438. declare module "babylonjs/Materials/Node/Blocks/gradientBlock" {
  66439. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66440. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66441. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66442. import { Color3 } from "babylonjs/Maths/math.color";
  66443. import { Scene } from "babylonjs/scene";
  66444. /**
  66445. * Class used to store a color step for the GradientBlock
  66446. */
  66447. export class GradientBlockColorStep {
  66448. /**
  66449. * Gets or sets a value indicating which step this color is associated with (between 0 and 1)
  66450. */
  66451. step: number;
  66452. /**
  66453. * Gets or sets the color associated with this step
  66454. */
  66455. color: Color3;
  66456. /**
  66457. * Creates a new GradientBlockColorStep
  66458. * @param step defines a value indicating which step this color is associated with (between 0 and 1)
  66459. * @param color defines the color associated with this step
  66460. */
  66461. constructor(
  66462. /**
  66463. * Gets or sets a value indicating which step this color is associated with (between 0 and 1)
  66464. */
  66465. step: number,
  66466. /**
  66467. * Gets or sets the color associated with this step
  66468. */
  66469. color: Color3);
  66470. }
  66471. /**
  66472. * Block used to return a color from a gradient based on an input value between 0 and 1
  66473. */
  66474. export class GradientBlock extends NodeMaterialBlock {
  66475. /**
  66476. * Gets or sets the list of color steps
  66477. */
  66478. colorSteps: GradientBlockColorStep[];
  66479. /**
  66480. * Creates a new GradientBlock
  66481. * @param name defines the block name
  66482. */
  66483. constructor(name: string);
  66484. /**
  66485. * Gets the current class name
  66486. * @returns the class name
  66487. */
  66488. getClassName(): string;
  66489. /**
  66490. * Gets the gradient input component
  66491. */
  66492. get gradient(): NodeMaterialConnectionPoint;
  66493. /**
  66494. * Gets the output component
  66495. */
  66496. get output(): NodeMaterialConnectionPoint;
  66497. private _writeColorConstant;
  66498. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  66499. serialize(): any;
  66500. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  66501. protected _dumpPropertiesCode(): string;
  66502. }
  66503. }
  66504. declare module "babylonjs/Materials/Node/Blocks/nLerpBlock" {
  66505. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66506. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66507. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66508. /**
  66509. * Block used to normalize lerp between 2 values
  66510. */
  66511. export class NLerpBlock extends NodeMaterialBlock {
  66512. /**
  66513. * Creates a new NLerpBlock
  66514. * @param name defines the block name
  66515. */
  66516. constructor(name: string);
  66517. /**
  66518. * Gets the current class name
  66519. * @returns the class name
  66520. */
  66521. getClassName(): string;
  66522. /**
  66523. * Gets the left operand input component
  66524. */
  66525. get left(): NodeMaterialConnectionPoint;
  66526. /**
  66527. * Gets the right operand input component
  66528. */
  66529. get right(): NodeMaterialConnectionPoint;
  66530. /**
  66531. * Gets the gradient operand input component
  66532. */
  66533. get gradient(): NodeMaterialConnectionPoint;
  66534. /**
  66535. * Gets the output component
  66536. */
  66537. get output(): NodeMaterialConnectionPoint;
  66538. protected _buildBlock(state: NodeMaterialBuildState): this;
  66539. }
  66540. }
  66541. declare module "babylonjs/Materials/Node/Blocks/worleyNoise3DBlock" {
  66542. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66543. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66544. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66545. import { Scene } from "babylonjs/scene";
  66546. /**
  66547. * block used to Generate a Worley Noise 3D Noise Pattern
  66548. */
  66549. export class WorleyNoise3DBlock extends NodeMaterialBlock {
  66550. /** Gets or sets a boolean indicating that normal should be inverted on X axis */
  66551. manhattanDistance: boolean;
  66552. /**
  66553. * Creates a new WorleyNoise3DBlock
  66554. * @param name defines the block name
  66555. */
  66556. constructor(name: string);
  66557. /**
  66558. * Gets the current class name
  66559. * @returns the class name
  66560. */
  66561. getClassName(): string;
  66562. /**
  66563. * Gets the seed input component
  66564. */
  66565. get seed(): NodeMaterialConnectionPoint;
  66566. /**
  66567. * Gets the jitter input component
  66568. */
  66569. get jitter(): NodeMaterialConnectionPoint;
  66570. /**
  66571. * Gets the output component
  66572. */
  66573. get output(): NodeMaterialConnectionPoint;
  66574. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  66575. /**
  66576. * Exposes the properties to the UI?
  66577. */
  66578. protected _dumpPropertiesCode(): string;
  66579. /**
  66580. * Exposes the properties to the Seralize?
  66581. */
  66582. serialize(): any;
  66583. /**
  66584. * Exposes the properties to the deseralize?
  66585. */
  66586. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  66587. }
  66588. }
  66589. declare module "babylonjs/Materials/Node/Blocks/simplexPerlin3DBlock" {
  66590. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66591. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66592. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66593. /**
  66594. * block used to Generate a Simplex Perlin 3d Noise Pattern
  66595. */
  66596. export class SimplexPerlin3DBlock extends NodeMaterialBlock {
  66597. /**
  66598. * Creates a new SimplexPerlin3DBlock
  66599. * @param name defines the block name
  66600. */
  66601. constructor(name: string);
  66602. /**
  66603. * Gets the current class name
  66604. * @returns the class name
  66605. */
  66606. getClassName(): string;
  66607. /**
  66608. * Gets the seed operand input component
  66609. */
  66610. get seed(): NodeMaterialConnectionPoint;
  66611. /**
  66612. * Gets the output component
  66613. */
  66614. get output(): NodeMaterialConnectionPoint;
  66615. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  66616. }
  66617. }
  66618. declare module "babylonjs/Materials/Node/Blocks/normalBlendBlock" {
  66619. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66620. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66621. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66622. /**
  66623. * Block used to blend normals
  66624. */
  66625. export class NormalBlendBlock extends NodeMaterialBlock {
  66626. /**
  66627. * Creates a new NormalBlendBlock
  66628. * @param name defines the block name
  66629. */
  66630. constructor(name: string);
  66631. /**
  66632. * Gets the current class name
  66633. * @returns the class name
  66634. */
  66635. getClassName(): string;
  66636. /**
  66637. * Gets the first input component
  66638. */
  66639. get normalMap0(): NodeMaterialConnectionPoint;
  66640. /**
  66641. * Gets the second input component
  66642. */
  66643. get normalMap1(): NodeMaterialConnectionPoint;
  66644. /**
  66645. * Gets the output component
  66646. */
  66647. get output(): NodeMaterialConnectionPoint;
  66648. protected _buildBlock(state: NodeMaterialBuildState): this;
  66649. }
  66650. }
  66651. declare module "babylonjs/Materials/Node/Blocks/rotate2dBlock" {
  66652. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66653. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66654. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66655. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  66656. /**
  66657. * Block used to rotate a 2d vector by a given angle
  66658. */
  66659. export class Rotate2dBlock extends NodeMaterialBlock {
  66660. /**
  66661. * Creates a new Rotate2dBlock
  66662. * @param name defines the block name
  66663. */
  66664. constructor(name: string);
  66665. /**
  66666. * Gets the current class name
  66667. * @returns the class name
  66668. */
  66669. getClassName(): string;
  66670. /**
  66671. * Gets the input vector
  66672. */
  66673. get input(): NodeMaterialConnectionPoint;
  66674. /**
  66675. * Gets the input angle
  66676. */
  66677. get angle(): NodeMaterialConnectionPoint;
  66678. /**
  66679. * Gets the output component
  66680. */
  66681. get output(): NodeMaterialConnectionPoint;
  66682. autoConfigure(material: NodeMaterial): void;
  66683. protected _buildBlock(state: NodeMaterialBuildState): this;
  66684. }
  66685. }
  66686. declare module "babylonjs/Materials/Node/Blocks/reflectBlock" {
  66687. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66688. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66689. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66690. /**
  66691. * Block used to get the reflected vector from a direction and a normal
  66692. */
  66693. export class ReflectBlock extends NodeMaterialBlock {
  66694. /**
  66695. * Creates a new ReflectBlock
  66696. * @param name defines the block name
  66697. */
  66698. constructor(name: string);
  66699. /**
  66700. * Gets the current class name
  66701. * @returns the class name
  66702. */
  66703. getClassName(): string;
  66704. /**
  66705. * Gets the incident component
  66706. */
  66707. get incident(): NodeMaterialConnectionPoint;
  66708. /**
  66709. * Gets the normal component
  66710. */
  66711. get normal(): NodeMaterialConnectionPoint;
  66712. /**
  66713. * Gets the output component
  66714. */
  66715. get output(): NodeMaterialConnectionPoint;
  66716. protected _buildBlock(state: NodeMaterialBuildState): this;
  66717. }
  66718. }
  66719. declare module "babylonjs/Materials/Node/Blocks/refractBlock" {
  66720. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66721. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66722. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66723. /**
  66724. * Block used to get the refracted vector from a direction and a normal
  66725. */
  66726. export class RefractBlock extends NodeMaterialBlock {
  66727. /**
  66728. * Creates a new RefractBlock
  66729. * @param name defines the block name
  66730. */
  66731. constructor(name: string);
  66732. /**
  66733. * Gets the current class name
  66734. * @returns the class name
  66735. */
  66736. getClassName(): string;
  66737. /**
  66738. * Gets the incident component
  66739. */
  66740. get incident(): NodeMaterialConnectionPoint;
  66741. /**
  66742. * Gets the normal component
  66743. */
  66744. get normal(): NodeMaterialConnectionPoint;
  66745. /**
  66746. * Gets the index of refraction component
  66747. */
  66748. get ior(): NodeMaterialConnectionPoint;
  66749. /**
  66750. * Gets the output component
  66751. */
  66752. get output(): NodeMaterialConnectionPoint;
  66753. protected _buildBlock(state: NodeMaterialBuildState): this;
  66754. }
  66755. }
  66756. declare module "babylonjs/Materials/Node/Blocks/desaturateBlock" {
  66757. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66758. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66759. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66760. /**
  66761. * Block used to desaturate a color
  66762. */
  66763. export class DesaturateBlock extends NodeMaterialBlock {
  66764. /**
  66765. * Creates a new DesaturateBlock
  66766. * @param name defines the block name
  66767. */
  66768. constructor(name: string);
  66769. /**
  66770. * Gets the current class name
  66771. * @returns the class name
  66772. */
  66773. getClassName(): string;
  66774. /**
  66775. * Gets the color operand input component
  66776. */
  66777. get color(): NodeMaterialConnectionPoint;
  66778. /**
  66779. * Gets the level operand input component
  66780. */
  66781. get level(): NodeMaterialConnectionPoint;
  66782. /**
  66783. * Gets the output component
  66784. */
  66785. get output(): NodeMaterialConnectionPoint;
  66786. protected _buildBlock(state: NodeMaterialBuildState): this;
  66787. }
  66788. }
  66789. declare module "babylonjs/Materials/Node/Blocks/PBR/ambientOcclusionBlock" {
  66790. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66791. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66792. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66793. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  66794. import { Nullable } from "babylonjs/types";
  66795. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  66796. import { Scene } from "babylonjs/scene";
  66797. /**
  66798. * Block used to implement the ambient occlusion module of the PBR material
  66799. */
  66800. export class AmbientOcclusionBlock extends NodeMaterialBlock {
  66801. /**
  66802. * Create a new AmbientOcclusionBlock
  66803. * @param name defines the block name
  66804. */
  66805. constructor(name: string);
  66806. /**
  66807. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  66808. */
  66809. useAmbientInGrayScale: boolean;
  66810. /**
  66811. * Initialize the block and prepare the context for build
  66812. * @param state defines the state that will be used for the build
  66813. */
  66814. initialize(state: NodeMaterialBuildState): void;
  66815. /**
  66816. * Gets the current class name
  66817. * @returns the class name
  66818. */
  66819. getClassName(): string;
  66820. /**
  66821. * Gets the texture input component
  66822. */
  66823. get texture(): NodeMaterialConnectionPoint;
  66824. /**
  66825. * Gets the texture intensity component
  66826. */
  66827. get intensity(): NodeMaterialConnectionPoint;
  66828. /**
  66829. * Gets the direct light intensity input component
  66830. */
  66831. get directLightIntensity(): NodeMaterialConnectionPoint;
  66832. /**
  66833. * Gets the ambient occlusion object output component
  66834. */
  66835. get ambientOcclusion(): NodeMaterialConnectionPoint;
  66836. /**
  66837. * Gets the main code of the block (fragment side)
  66838. * @param block instance of an AmbientOcclusionBlock or null if the code must be generated without an active ambient occlusion module
  66839. * @returns the shader code
  66840. */
  66841. static GetCode(block: Nullable<AmbientOcclusionBlock>): string;
  66842. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  66843. protected _buildBlock(state: NodeMaterialBuildState): this;
  66844. protected _dumpPropertiesCode(): string;
  66845. serialize(): any;
  66846. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  66847. }
  66848. }
  66849. declare module "babylonjs/Materials/Node/Blocks/PBR/reflectionBlock" {
  66850. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66851. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66852. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  66853. import { ReflectionTextureBaseBlock } from "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBaseBlock";
  66854. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  66855. import { Nullable } from "babylonjs/types";
  66856. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  66857. import { Mesh } from "babylonjs/Meshes/mesh";
  66858. import { SubMesh } from "babylonjs/Meshes/subMesh";
  66859. import { Effect } from "babylonjs/Materials/effect";
  66860. import { Scene } from "babylonjs/scene";
  66861. /**
  66862. * Block used to implement the reflection module of the PBR material
  66863. */
  66864. export class ReflectionBlock extends ReflectionTextureBaseBlock {
  66865. /** @hidden */
  66866. _defineLODReflectionAlpha: string;
  66867. /** @hidden */
  66868. _defineLinearSpecularReflection: string;
  66869. private _vEnvironmentIrradianceName;
  66870. /** @hidden */
  66871. _vReflectionMicrosurfaceInfosName: string;
  66872. /** @hidden */
  66873. _vReflectionInfosName: string;
  66874. /** @hidden */
  66875. _vReflectionFilteringInfoName: string;
  66876. private _scene;
  66877. /**
  66878. * The three properties below are set by the main PBR block prior to calling methods of this class.
  66879. * This is to avoid having to add them as inputs here whereas they are already inputs of the main block, so already known.
  66880. * It's less burden on the user side in the editor part.
  66881. */
  66882. /** @hidden */
  66883. worldPositionConnectionPoint: NodeMaterialConnectionPoint;
  66884. /** @hidden */
  66885. worldNormalConnectionPoint: NodeMaterialConnectionPoint;
  66886. /** @hidden */
  66887. cameraPositionConnectionPoint: NodeMaterialConnectionPoint;
  66888. /**
  66889. * Defines if the material uses spherical harmonics vs spherical polynomials for the
  66890. * diffuse part of the IBL.
  66891. */
  66892. useSphericalHarmonics: boolean;
  66893. /**
  66894. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  66895. */
  66896. forceIrradianceInFragment: boolean;
  66897. /**
  66898. * Create a new ReflectionBlock
  66899. * @param name defines the block name
  66900. */
  66901. constructor(name: string);
  66902. /**
  66903. * Gets the current class name
  66904. * @returns the class name
  66905. */
  66906. getClassName(): string;
  66907. /**
  66908. * Gets the position input component
  66909. */
  66910. get position(): NodeMaterialConnectionPoint;
  66911. /**
  66912. * Gets the world position input component
  66913. */
  66914. get worldPosition(): NodeMaterialConnectionPoint;
  66915. /**
  66916. * Gets the world normal input component
  66917. */
  66918. get worldNormal(): NodeMaterialConnectionPoint;
  66919. /**
  66920. * Gets the world input component
  66921. */
  66922. get world(): NodeMaterialConnectionPoint;
  66923. /**
  66924. * Gets the camera (or eye) position component
  66925. */
  66926. get cameraPosition(): NodeMaterialConnectionPoint;
  66927. /**
  66928. * Gets the view input component
  66929. */
  66930. get view(): NodeMaterialConnectionPoint;
  66931. /**
  66932. * Gets the color input component
  66933. */
  66934. get color(): NodeMaterialConnectionPoint;
  66935. /**
  66936. * Gets the reflection object output component
  66937. */
  66938. get reflection(): NodeMaterialConnectionPoint;
  66939. /**
  66940. * Returns true if the block has a texture (either its own texture or the environment texture from the scene, if set)
  66941. */
  66942. get hasTexture(): boolean;
  66943. /**
  66944. * Gets the reflection color (either the name of the variable if the color input is connected, else a default value)
  66945. */
  66946. get reflectionColor(): string;
  66947. protected _getTexture(): Nullable<BaseTexture>;
  66948. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  66949. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  66950. /**
  66951. * Gets the code to inject in the vertex shader
  66952. * @param state current state of the node material building
  66953. * @returns the shader code
  66954. */
  66955. handleVertexSide(state: NodeMaterialBuildState): string;
  66956. /**
  66957. * Gets the main code of the block (fragment side)
  66958. * @param state current state of the node material building
  66959. * @param normalVarName name of the existing variable corresponding to the normal
  66960. * @returns the shader code
  66961. */
  66962. getCode(state: NodeMaterialBuildState, normalVarName: string): string;
  66963. protected _buildBlock(state: NodeMaterialBuildState): this;
  66964. protected _dumpPropertiesCode(): string;
  66965. serialize(): any;
  66966. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  66967. }
  66968. }
  66969. declare module "babylonjs/Materials/Node/Blocks/PBR/sheenBlock" {
  66970. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66971. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66972. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66973. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  66974. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  66975. import { ReflectionBlock } from "babylonjs/Materials/Node/Blocks/PBR/reflectionBlock";
  66976. import { Scene } from "babylonjs/scene";
  66977. import { Nullable } from "babylonjs/types";
  66978. /**
  66979. * Block used to implement the sheen module of the PBR material
  66980. */
  66981. export class SheenBlock extends NodeMaterialBlock {
  66982. /**
  66983. * Create a new SheenBlock
  66984. * @param name defines the block name
  66985. */
  66986. constructor(name: string);
  66987. /**
  66988. * If true, the sheen effect is layered above the base BRDF with the albedo-scaling technique.
  66989. * It allows the strength of the sheen effect to not depend on the base color of the material,
  66990. * making it easier to setup and tweak the effect
  66991. */
  66992. albedoScaling: boolean;
  66993. /**
  66994. * Defines if the sheen is linked to the sheen color.
  66995. */
  66996. linkSheenWithAlbedo: boolean;
  66997. /**
  66998. * Initialize the block and prepare the context for build
  66999. * @param state defines the state that will be used for the build
  67000. */
  67001. initialize(state: NodeMaterialBuildState): void;
  67002. /**
  67003. * Gets the current class name
  67004. * @returns the class name
  67005. */
  67006. getClassName(): string;
  67007. /**
  67008. * Gets the intensity input component
  67009. */
  67010. get intensity(): NodeMaterialConnectionPoint;
  67011. /**
  67012. * Gets the color input component
  67013. */
  67014. get color(): NodeMaterialConnectionPoint;
  67015. /**
  67016. * Gets the roughness input component
  67017. */
  67018. get roughness(): NodeMaterialConnectionPoint;
  67019. /**
  67020. * Gets the sheen object output component
  67021. */
  67022. get sheen(): NodeMaterialConnectionPoint;
  67023. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  67024. /**
  67025. * Gets the main code of the block (fragment side)
  67026. * @param reflectionBlock instance of a ReflectionBlock null if the code must be generated without an active reflection module
  67027. * @returns the shader code
  67028. */
  67029. getCode(reflectionBlock: Nullable<ReflectionBlock>): string;
  67030. protected _buildBlock(state: NodeMaterialBuildState): this;
  67031. protected _dumpPropertiesCode(): string;
  67032. serialize(): any;
  67033. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  67034. }
  67035. }
  67036. declare module "babylonjs/Materials/Node/Blocks/PBR/reflectivityBlock" {
  67037. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67038. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67039. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67040. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67041. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67042. import { Scene } from "babylonjs/scene";
  67043. import { Nullable } from "babylonjs/types";
  67044. import { Mesh } from "babylonjs/Meshes/mesh";
  67045. import { SubMesh } from "babylonjs/Meshes/subMesh";
  67046. import { Effect } from "babylonjs/Materials/effect";
  67047. /**
  67048. * Block used to implement the reflectivity module of the PBR material
  67049. */
  67050. export class ReflectivityBlock extends NodeMaterialBlock {
  67051. private _metallicReflectanceColor;
  67052. private _metallicF0Factor;
  67053. /** @hidden */
  67054. _vMetallicReflectanceFactorsName: string;
  67055. /**
  67056. * The property below is set by the main PBR block prior to calling methods of this class.
  67057. */
  67058. /** @hidden */
  67059. indexOfRefractionConnectionPoint: Nullable<NodeMaterialConnectionPoint>;
  67060. /**
  67061. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  67062. */
  67063. useAmbientOcclusionFromMetallicTextureRed: boolean;
  67064. /**
  67065. * Specifies if the metallic texture contains the metallness information in its blue channel.
  67066. */
  67067. useMetallnessFromMetallicTextureBlue: boolean;
  67068. /**
  67069. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  67070. */
  67071. useRoughnessFromMetallicTextureAlpha: boolean;
  67072. /**
  67073. * Specifies if the metallic texture contains the roughness information in its green channel.
  67074. */
  67075. useRoughnessFromMetallicTextureGreen: boolean;
  67076. /**
  67077. * Create a new ReflectivityBlock
  67078. * @param name defines the block name
  67079. */
  67080. constructor(name: string);
  67081. /**
  67082. * Initialize the block and prepare the context for build
  67083. * @param state defines the state that will be used for the build
  67084. */
  67085. initialize(state: NodeMaterialBuildState): void;
  67086. /**
  67087. * Gets the current class name
  67088. * @returns the class name
  67089. */
  67090. getClassName(): string;
  67091. /**
  67092. * Gets the metallic input component
  67093. */
  67094. get metallic(): NodeMaterialConnectionPoint;
  67095. /**
  67096. * Gets the roughness input component
  67097. */
  67098. get roughness(): NodeMaterialConnectionPoint;
  67099. /**
  67100. * Gets the texture input component
  67101. */
  67102. get texture(): NodeMaterialConnectionPoint;
  67103. /**
  67104. * Gets the reflectivity object output component
  67105. */
  67106. get reflectivity(): NodeMaterialConnectionPoint;
  67107. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  67108. /**
  67109. * Gets the main code of the block (fragment side)
  67110. * @param state current state of the node material building
  67111. * @param aoIntensityVarName name of the variable with the ambient occlusion intensity
  67112. * @returns the shader code
  67113. */
  67114. getCode(state: NodeMaterialBuildState, aoIntensityVarName: string): string;
  67115. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  67116. protected _buildBlock(state: NodeMaterialBuildState): this;
  67117. protected _dumpPropertiesCode(): string;
  67118. serialize(): any;
  67119. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  67120. }
  67121. }
  67122. declare module "babylonjs/Materials/Node/Blocks/PBR/anisotropyBlock" {
  67123. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67124. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67125. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67126. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67127. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67128. /**
  67129. * Block used to implement the anisotropy module of the PBR material
  67130. */
  67131. export class AnisotropyBlock extends NodeMaterialBlock {
  67132. /**
  67133. * The two properties below are set by the main PBR block prior to calling methods of this class.
  67134. * This is to avoid having to add them as inputs here whereas they are already inputs of the main block, so already known.
  67135. * It's less burden on the user side in the editor part.
  67136. */
  67137. /** @hidden */
  67138. worldPositionConnectionPoint: NodeMaterialConnectionPoint;
  67139. /** @hidden */
  67140. worldNormalConnectionPoint: NodeMaterialConnectionPoint;
  67141. /**
  67142. * Create a new AnisotropyBlock
  67143. * @param name defines the block name
  67144. */
  67145. constructor(name: string);
  67146. /**
  67147. * Initialize the block and prepare the context for build
  67148. * @param state defines the state that will be used for the build
  67149. */
  67150. initialize(state: NodeMaterialBuildState): void;
  67151. /**
  67152. * Gets the current class name
  67153. * @returns the class name
  67154. */
  67155. getClassName(): string;
  67156. /**
  67157. * Gets the intensity input component
  67158. */
  67159. get intensity(): NodeMaterialConnectionPoint;
  67160. /**
  67161. * Gets the direction input component
  67162. */
  67163. get direction(): NodeMaterialConnectionPoint;
  67164. /**
  67165. * Gets the texture input component
  67166. */
  67167. get texture(): NodeMaterialConnectionPoint;
  67168. /**
  67169. * Gets the uv input component
  67170. */
  67171. get uv(): NodeMaterialConnectionPoint;
  67172. /**
  67173. * Gets the worldTangent input component
  67174. */
  67175. get worldTangent(): NodeMaterialConnectionPoint;
  67176. /**
  67177. * Gets the anisotropy object output component
  67178. */
  67179. get anisotropy(): NodeMaterialConnectionPoint;
  67180. private _generateTBNSpace;
  67181. /**
  67182. * Gets the main code of the block (fragment side)
  67183. * @param state current state of the node material building
  67184. * @param generateTBNSpace if true, the code needed to create the TBN coordinate space is generated
  67185. * @returns the shader code
  67186. */
  67187. getCode(state: NodeMaterialBuildState, generateTBNSpace?: boolean): string;
  67188. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  67189. protected _buildBlock(state: NodeMaterialBuildState): this;
  67190. }
  67191. }
  67192. declare module "babylonjs/Materials/Node/Blocks/PBR/clearCoatBlock" {
  67193. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67194. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67195. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67196. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67197. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67198. import { ReflectionBlock } from "babylonjs/Materials/Node/Blocks/PBR/reflectionBlock";
  67199. import { Nullable } from "babylonjs/types";
  67200. import { Mesh } from "babylonjs/Meshes/mesh";
  67201. import { SubMesh } from "babylonjs/Meshes/subMesh";
  67202. import { Effect } from "babylonjs/Materials/effect";
  67203. /**
  67204. * Block used to implement the clear coat module of the PBR material
  67205. */
  67206. export class ClearCoatBlock extends NodeMaterialBlock {
  67207. private _scene;
  67208. /**
  67209. * Create a new ClearCoatBlock
  67210. * @param name defines the block name
  67211. */
  67212. constructor(name: string);
  67213. /**
  67214. * Initialize the block and prepare the context for build
  67215. * @param state defines the state that will be used for the build
  67216. */
  67217. initialize(state: NodeMaterialBuildState): void;
  67218. /**
  67219. * Gets the current class name
  67220. * @returns the class name
  67221. */
  67222. getClassName(): string;
  67223. /**
  67224. * Gets the intensity input component
  67225. */
  67226. get intensity(): NodeMaterialConnectionPoint;
  67227. /**
  67228. * Gets the roughness input component
  67229. */
  67230. get roughness(): NodeMaterialConnectionPoint;
  67231. /**
  67232. * Gets the ior input component
  67233. */
  67234. get ior(): NodeMaterialConnectionPoint;
  67235. /**
  67236. * Gets the texture input component
  67237. */
  67238. get texture(): NodeMaterialConnectionPoint;
  67239. /**
  67240. * Gets the bump texture input component
  67241. */
  67242. get bumpTexture(): NodeMaterialConnectionPoint;
  67243. /**
  67244. * Gets the uv input component
  67245. */
  67246. get uv(): NodeMaterialConnectionPoint;
  67247. /**
  67248. * Gets the tint color input component
  67249. */
  67250. get tintColor(): NodeMaterialConnectionPoint;
  67251. /**
  67252. * Gets the tint "at distance" input component
  67253. */
  67254. get tintAtDistance(): NodeMaterialConnectionPoint;
  67255. /**
  67256. * Gets the tint thickness input component
  67257. */
  67258. get tintThickness(): NodeMaterialConnectionPoint;
  67259. /**
  67260. * Gets the world tangent input component
  67261. */
  67262. get worldTangent(): NodeMaterialConnectionPoint;
  67263. /**
  67264. * Gets the clear coat object output component
  67265. */
  67266. get clearcoat(): NodeMaterialConnectionPoint;
  67267. autoConfigure(material: NodeMaterial): void;
  67268. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  67269. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  67270. private _generateTBNSpace;
  67271. /**
  67272. * Gets the main code of the block (fragment side)
  67273. * @param state current state of the node material building
  67274. * @param ccBlock instance of a ClearCoatBlock or null if the code must be generated without an active clear coat module
  67275. * @param reflectionBlock instance of a ReflectionBlock null if the code must be generated without an active reflection module
  67276. * @param worldPosVarName name of the variable holding the world position
  67277. * @param generateTBNSpace if true, the code needed to create the TBN coordinate space is generated
  67278. * @param vTBNAvailable indicate that the vTBN variable is already existing because it has already been generated by another block (PerturbNormal or Anisotropy)
  67279. * @param worldNormalVarName name of the variable holding the world normal
  67280. * @returns the shader code
  67281. */
  67282. static GetCode(state: NodeMaterialBuildState, ccBlock: Nullable<ClearCoatBlock>, reflectionBlock: Nullable<ReflectionBlock>, worldPosVarName: string, generateTBNSpace: boolean, vTBNAvailable: boolean, worldNormalVarName: string): string;
  67283. protected _buildBlock(state: NodeMaterialBuildState): this;
  67284. }
  67285. }
  67286. declare module "babylonjs/Materials/Node/Blocks/PBR/subSurfaceBlock" {
  67287. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67288. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67289. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67290. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67291. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67292. import { ReflectionBlock } from "babylonjs/Materials/Node/Blocks/PBR/reflectionBlock";
  67293. import { Nullable } from "babylonjs/types";
  67294. /**
  67295. * Block used to implement the sub surface module of the PBR material
  67296. */
  67297. export class SubSurfaceBlock extends NodeMaterialBlock {
  67298. /**
  67299. * Create a new SubSurfaceBlock
  67300. * @param name defines the block name
  67301. */
  67302. constructor(name: string);
  67303. /**
  67304. * Stores the intensity of the different subsurface effects in the thickness texture.
  67305. * * the green channel is the translucency intensity.
  67306. * * the blue channel is the scattering intensity.
  67307. * * the alpha channel is the refraction intensity.
  67308. */
  67309. useMaskFromThicknessTexture: boolean;
  67310. /**
  67311. * Initialize the block and prepare the context for build
  67312. * @param state defines the state that will be used for the build
  67313. */
  67314. initialize(state: NodeMaterialBuildState): void;
  67315. /**
  67316. * Gets the current class name
  67317. * @returns the class name
  67318. */
  67319. getClassName(): string;
  67320. /**
  67321. * Gets the min thickness input component
  67322. */
  67323. get minThickness(): NodeMaterialConnectionPoint;
  67324. /**
  67325. * Gets the max thickness input component
  67326. */
  67327. get maxThickness(): NodeMaterialConnectionPoint;
  67328. /**
  67329. * Gets the thickness texture component
  67330. */
  67331. get thicknessTexture(): NodeMaterialConnectionPoint;
  67332. /**
  67333. * Gets the tint color input component
  67334. */
  67335. get tintColor(): NodeMaterialConnectionPoint;
  67336. /**
  67337. * Gets the translucency intensity input component
  67338. */
  67339. get translucencyIntensity(): NodeMaterialConnectionPoint;
  67340. /**
  67341. * Gets the translucency diffusion distance input component
  67342. */
  67343. get translucencyDiffusionDistance(): NodeMaterialConnectionPoint;
  67344. /**
  67345. * Gets the refraction object parameters
  67346. */
  67347. get refraction(): NodeMaterialConnectionPoint;
  67348. /**
  67349. * Gets the sub surface object output component
  67350. */
  67351. get subsurface(): NodeMaterialConnectionPoint;
  67352. autoConfigure(material: NodeMaterial): void;
  67353. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  67354. /**
  67355. * Gets the main code of the block (fragment side)
  67356. * @param state current state of the node material building
  67357. * @param ssBlock instance of a SubSurfaceBlock or null if the code must be generated without an active sub surface module
  67358. * @param reflectionBlock instance of a ReflectionBlock null if the code must be generated without an active reflection module
  67359. * @param worldPosVarName name of the variable holding the world position
  67360. * @returns the shader code
  67361. */
  67362. static GetCode(state: NodeMaterialBuildState, ssBlock: Nullable<SubSurfaceBlock>, reflectionBlock: Nullable<ReflectionBlock>, worldPosVarName: string): string;
  67363. protected _buildBlock(state: NodeMaterialBuildState): this;
  67364. }
  67365. }
  67366. declare module "babylonjs/Materials/Node/Blocks/PBR/pbrMetallicRoughnessBlock" {
  67367. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67368. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67369. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67370. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67371. import { Light } from "babylonjs/Lights/light";
  67372. import { Nullable } from "babylonjs/types";
  67373. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67374. import { Effect } from "babylonjs/Materials/effect";
  67375. import { Mesh } from "babylonjs/Meshes/mesh";
  67376. import { Scene } from "babylonjs/scene";
  67377. /**
  67378. * Block used to implement the PBR metallic/roughness model
  67379. */
  67380. export class PBRMetallicRoughnessBlock extends NodeMaterialBlock {
  67381. /**
  67382. * Gets or sets the light associated with this block
  67383. */
  67384. light: Nullable<Light>;
  67385. private _lightId;
  67386. private _scene;
  67387. private _environmentBRDFTexture;
  67388. private _environmentBrdfSamplerName;
  67389. private _vNormalWName;
  67390. private _invertNormalName;
  67391. /**
  67392. * Create a new ReflectionBlock
  67393. * @param name defines the block name
  67394. */
  67395. constructor(name: string);
  67396. /**
  67397. * Intensity of the direct lights e.g. the four lights available in your scene.
  67398. * This impacts both the direct diffuse and specular highlights.
  67399. */
  67400. directIntensity: number;
  67401. /**
  67402. * Intensity of the environment e.g. how much the environment will light the object
  67403. * either through harmonics for rough material or through the refelction for shiny ones.
  67404. */
  67405. environmentIntensity: number;
  67406. /**
  67407. * This is a special control allowing the reduction of the specular highlights coming from the
  67408. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  67409. */
  67410. specularIntensity: number;
  67411. /**
  67412. * Defines the falloff type used in this material.
  67413. * It by default is Physical.
  67414. */
  67415. lightFalloff: number;
  67416. /**
  67417. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  67418. */
  67419. useAlphaFromAlbedoTexture: boolean;
  67420. /**
  67421. * Specifies that alpha test should be used
  67422. */
  67423. useAlphaTest: boolean;
  67424. /**
  67425. * Defines the alpha limits in alpha test mode.
  67426. */
  67427. alphaTestCutoff: number;
  67428. /**
  67429. * Specifies that alpha blending should be used
  67430. */
  67431. useAlphaBlending: boolean;
  67432. /**
  67433. * Defines if the alpha value should be determined via the rgb values.
  67434. * If true the luminance of the pixel might be used to find the corresponding alpha value.
  67435. */
  67436. opacityRGB: boolean;
  67437. /**
  67438. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most luminous ones).
  67439. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  67440. */
  67441. useRadianceOverAlpha: boolean;
  67442. /**
  67443. * Specifies that the material will keeps the specular highlights over a transparent surface (only the most luminous ones).
  67444. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  67445. */
  67446. useSpecularOverAlpha: boolean;
  67447. /**
  67448. * Enables specular anti aliasing in the PBR shader.
  67449. * It will both interacts on the Geometry for analytical and IBL lighting.
  67450. * It also prefilter the roughness map based on the bump values.
  67451. */
  67452. enableSpecularAntiAliasing: boolean;
  67453. /**
  67454. * Enables realtime filtering on the texture.
  67455. */
  67456. realTimeFiltering: boolean;
  67457. /**
  67458. * Quality switch for realtime filtering
  67459. */
  67460. realTimeFilteringQuality: number;
  67461. /**
  67462. * Defines if the material uses energy conservation.
  67463. */
  67464. useEnergyConservation: boolean;
  67465. /**
  67466. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  67467. * too much the area relying on ambient texture to define their ambient occlusion.
  67468. */
  67469. useRadianceOcclusion: boolean;
  67470. /**
  67471. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  67472. * makes the reflect vector face the model (under horizon).
  67473. */
  67474. useHorizonOcclusion: boolean;
  67475. /**
  67476. * If set to true, no lighting calculations will be applied.
  67477. */
  67478. unlit: boolean;
  67479. /**
  67480. * Force normal to face away from face.
  67481. */
  67482. forceNormalForward: boolean;
  67483. /**
  67484. * Defines the material debug mode.
  67485. * It helps seeing only some components of the material while troubleshooting.
  67486. */
  67487. debugMode: number;
  67488. /**
  67489. * Specify from where on screen the debug mode should start.
  67490. * The value goes from -1 (full screen) to 1 (not visible)
  67491. * It helps with side by side comparison against the final render
  67492. * This defaults to 0
  67493. */
  67494. debugLimit: number;
  67495. /**
  67496. * As the default viewing range might not be enough (if the ambient is really small for instance)
  67497. * You can use the factor to better multiply the final value.
  67498. */
  67499. debugFactor: number;
  67500. /**
  67501. * Initialize the block and prepare the context for build
  67502. * @param state defines the state that will be used for the build
  67503. */
  67504. initialize(state: NodeMaterialBuildState): void;
  67505. /**
  67506. * Gets the current class name
  67507. * @returns the class name
  67508. */
  67509. getClassName(): string;
  67510. /**
  67511. * Gets the world position input component
  67512. */
  67513. get worldPosition(): NodeMaterialConnectionPoint;
  67514. /**
  67515. * Gets the world normal input component
  67516. */
  67517. get worldNormal(): NodeMaterialConnectionPoint;
  67518. /**
  67519. * Gets the perturbed normal input component
  67520. */
  67521. get perturbedNormal(): NodeMaterialConnectionPoint;
  67522. /**
  67523. * Gets the camera position input component
  67524. */
  67525. get cameraPosition(): NodeMaterialConnectionPoint;
  67526. /**
  67527. * Gets the base color input component
  67528. */
  67529. get baseColor(): NodeMaterialConnectionPoint;
  67530. /**
  67531. * Gets the opacity texture input component
  67532. */
  67533. get opacityTexture(): NodeMaterialConnectionPoint;
  67534. /**
  67535. * Gets the ambient color input component
  67536. */
  67537. get ambientColor(): NodeMaterialConnectionPoint;
  67538. /**
  67539. * Gets the reflectivity object parameters
  67540. */
  67541. get reflectivity(): NodeMaterialConnectionPoint;
  67542. /**
  67543. * Gets the ambient occlusion object parameters
  67544. */
  67545. get ambientOcclusion(): NodeMaterialConnectionPoint;
  67546. /**
  67547. * Gets the reflection object parameters
  67548. */
  67549. get reflection(): NodeMaterialConnectionPoint;
  67550. /**
  67551. * Gets the sheen object parameters
  67552. */
  67553. get sheen(): NodeMaterialConnectionPoint;
  67554. /**
  67555. * Gets the clear coat object parameters
  67556. */
  67557. get clearcoat(): NodeMaterialConnectionPoint;
  67558. /**
  67559. * Gets the sub surface object parameters
  67560. */
  67561. get subsurface(): NodeMaterialConnectionPoint;
  67562. /**
  67563. * Gets the anisotropy object parameters
  67564. */
  67565. get anisotropy(): NodeMaterialConnectionPoint;
  67566. /**
  67567. * Gets the ambient output component
  67568. */
  67569. get ambient(): NodeMaterialConnectionPoint;
  67570. /**
  67571. * Gets the diffuse output component
  67572. */
  67573. get diffuse(): NodeMaterialConnectionPoint;
  67574. /**
  67575. * Gets the specular output component
  67576. */
  67577. get specular(): NodeMaterialConnectionPoint;
  67578. /**
  67579. * Gets the sheen output component
  67580. */
  67581. get sheenDir(): NodeMaterialConnectionPoint;
  67582. /**
  67583. * Gets the clear coat output component
  67584. */
  67585. get clearcoatDir(): NodeMaterialConnectionPoint;
  67586. /**
  67587. * Gets the indirect diffuse output component
  67588. */
  67589. get diffuseIndirect(): NodeMaterialConnectionPoint;
  67590. /**
  67591. * Gets the indirect specular output component
  67592. */
  67593. get specularIndirect(): NodeMaterialConnectionPoint;
  67594. /**
  67595. * Gets the indirect sheen output component
  67596. */
  67597. get sheenIndirect(): NodeMaterialConnectionPoint;
  67598. /**
  67599. * Gets the indirect clear coat output component
  67600. */
  67601. get clearcoatIndirect(): NodeMaterialConnectionPoint;
  67602. /**
  67603. * Gets the refraction output component
  67604. */
  67605. get refraction(): NodeMaterialConnectionPoint;
  67606. /**
  67607. * Gets the global lighting output component
  67608. */
  67609. get lighting(): NodeMaterialConnectionPoint;
  67610. /**
  67611. * Gets the shadow output component
  67612. */
  67613. get shadow(): NodeMaterialConnectionPoint;
  67614. /**
  67615. * Gets the alpha output component
  67616. */
  67617. get alpha(): NodeMaterialConnectionPoint;
  67618. autoConfigure(material: NodeMaterial): void;
  67619. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  67620. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  67621. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  67622. private _injectVertexCode;
  67623. /**
  67624. * Gets the code corresponding to the albedo/opacity module
  67625. * @returns the shader code
  67626. */
  67627. getAlbedoOpacityCode(): string;
  67628. protected _buildBlock(state: NodeMaterialBuildState): this;
  67629. protected _dumpPropertiesCode(): string;
  67630. serialize(): any;
  67631. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  67632. }
  67633. }
  67634. declare module "babylonjs/Materials/Node/Blocks/PBR/index" {
  67635. export * from "babylonjs/Materials/Node/Blocks/PBR/pbrMetallicRoughnessBlock";
  67636. export * from "babylonjs/Materials/Node/Blocks/PBR/sheenBlock";
  67637. export * from "babylonjs/Materials/Node/Blocks/PBR/ambientOcclusionBlock";
  67638. export * from "babylonjs/Materials/Node/Blocks/PBR/reflectivityBlock";
  67639. export * from "babylonjs/Materials/Node/Blocks/PBR/anisotropyBlock";
  67640. export * from "babylonjs/Materials/Node/Blocks/PBR/reflectionBlock";
  67641. export * from "babylonjs/Materials/Node/Blocks/PBR/clearCoatBlock";
  67642. export * from "babylonjs/Materials/Node/Blocks/PBR/refractionBlock";
  67643. export * from "babylonjs/Materials/Node/Blocks/PBR/subSurfaceBlock";
  67644. }
  67645. declare module "babylonjs/Materials/Node/Blocks/Particle/index" {
  67646. export * from "babylonjs/Materials/Node/Blocks/Particle/particleTextureBlock";
  67647. export * from "babylonjs/Materials/Node/Blocks/Particle/particleRampGradientBlock";
  67648. export * from "babylonjs/Materials/Node/Blocks/Particle/particleBlendMultiplyBlock";
  67649. }
  67650. declare module "babylonjs/Materials/Node/Blocks/modBlock" {
  67651. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67652. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67653. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67654. /**
  67655. * Block used to compute value of one parameter modulo another
  67656. */
  67657. export class ModBlock extends NodeMaterialBlock {
  67658. /**
  67659. * Creates a new ModBlock
  67660. * @param name defines the block name
  67661. */
  67662. constructor(name: string);
  67663. /**
  67664. * Gets the current class name
  67665. * @returns the class name
  67666. */
  67667. getClassName(): string;
  67668. /**
  67669. * Gets the left operand input component
  67670. */
  67671. get left(): NodeMaterialConnectionPoint;
  67672. /**
  67673. * Gets the right operand input component
  67674. */
  67675. get right(): NodeMaterialConnectionPoint;
  67676. /**
  67677. * Gets the output component
  67678. */
  67679. get output(): NodeMaterialConnectionPoint;
  67680. protected _buildBlock(state: NodeMaterialBuildState): this;
  67681. }
  67682. }
  67683. declare module "babylonjs/Materials/Node/Blocks/index" {
  67684. export * from "babylonjs/Materials/Node/Blocks/Vertex/index";
  67685. export * from "babylonjs/Materials/Node/Blocks/Fragment/index";
  67686. export * from "babylonjs/Materials/Node/Blocks/Dual/index";
  67687. export * from "babylonjs/Materials/Node/Blocks/Input/index";
  67688. export * from "babylonjs/Materials/Node/Blocks/multiplyBlock";
  67689. export * from "babylonjs/Materials/Node/Blocks/addBlock";
  67690. export * from "babylonjs/Materials/Node/Blocks/scaleBlock";
  67691. export * from "babylonjs/Materials/Node/Blocks/clampBlock";
  67692. export * from "babylonjs/Materials/Node/Blocks/crossBlock";
  67693. export * from "babylonjs/Materials/Node/Blocks/dotBlock";
  67694. export * from "babylonjs/Materials/Node/Blocks/transformBlock";
  67695. export * from "babylonjs/Materials/Node/Blocks/remapBlock";
  67696. export * from "babylonjs/Materials/Node/Blocks/normalizeBlock";
  67697. export * from "babylonjs/Materials/Node/Blocks/trigonometryBlock";
  67698. export * from "babylonjs/Materials/Node/Blocks/colorMergerBlock";
  67699. export * from "babylonjs/Materials/Node/Blocks/vectorMergerBlock";
  67700. export * from "babylonjs/Materials/Node/Blocks/colorSplitterBlock";
  67701. export * from "babylonjs/Materials/Node/Blocks/vectorSplitterBlock";
  67702. export * from "babylonjs/Materials/Node/Blocks/lerpBlock";
  67703. export * from "babylonjs/Materials/Node/Blocks/divideBlock";
  67704. export * from "babylonjs/Materials/Node/Blocks/subtractBlock";
  67705. export * from "babylonjs/Materials/Node/Blocks/stepBlock";
  67706. export * from "babylonjs/Materials/Node/Blocks/oneMinusBlock";
  67707. export * from "babylonjs/Materials/Node/Blocks/viewDirectionBlock";
  67708. export * from "babylonjs/Materials/Node/Blocks/fresnelBlock";
  67709. export * from "babylonjs/Materials/Node/Blocks/maxBlock";
  67710. export * from "babylonjs/Materials/Node/Blocks/minBlock";
  67711. export * from "babylonjs/Materials/Node/Blocks/distanceBlock";
  67712. export * from "babylonjs/Materials/Node/Blocks/lengthBlock";
  67713. export * from "babylonjs/Materials/Node/Blocks/negateBlock";
  67714. export * from "babylonjs/Materials/Node/Blocks/powBlock";
  67715. export * from "babylonjs/Materials/Node/Blocks/randomNumberBlock";
  67716. export * from "babylonjs/Materials/Node/Blocks/arcTan2Block";
  67717. export * from "babylonjs/Materials/Node/Blocks/smoothStepBlock";
  67718. export * from "babylonjs/Materials/Node/Blocks/reciprocalBlock";
  67719. export * from "babylonjs/Materials/Node/Blocks/replaceColorBlock";
  67720. export * from "babylonjs/Materials/Node/Blocks/posterizeBlock";
  67721. export * from "babylonjs/Materials/Node/Blocks/waveBlock";
  67722. export * from "babylonjs/Materials/Node/Blocks/gradientBlock";
  67723. export * from "babylonjs/Materials/Node/Blocks/nLerpBlock";
  67724. export * from "babylonjs/Materials/Node/Blocks/worleyNoise3DBlock";
  67725. export * from "babylonjs/Materials/Node/Blocks/simplexPerlin3DBlock";
  67726. export * from "babylonjs/Materials/Node/Blocks/normalBlendBlock";
  67727. export * from "babylonjs/Materials/Node/Blocks/rotate2dBlock";
  67728. export * from "babylonjs/Materials/Node/Blocks/reflectBlock";
  67729. export * from "babylonjs/Materials/Node/Blocks/refractBlock";
  67730. export * from "babylonjs/Materials/Node/Blocks/desaturateBlock";
  67731. export * from "babylonjs/Materials/Node/Blocks/PBR/index";
  67732. export * from "babylonjs/Materials/Node/Blocks/Particle/index";
  67733. export * from "babylonjs/Materials/Node/Blocks/modBlock";
  67734. }
  67735. declare module "babylonjs/Materials/Node/Optimizers/index" {
  67736. export * from "babylonjs/Materials/Node/Optimizers/nodeMaterialOptimizer";
  67737. }
  67738. declare module "babylonjs/Materials/Node/index" {
  67739. export * from "babylonjs/Materials/Node/Enums/index";
  67740. export * from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67741. export * from "babylonjs/Materials/Node/nodeMaterialBlock";
  67742. export * from "babylonjs/Materials/Node/nodeMaterial";
  67743. export * from "babylonjs/Materials/Node/Blocks/index";
  67744. export * from "babylonjs/Materials/Node/Optimizers/index";
  67745. export * from "babylonjs/Materials/Node/nodeMaterialDecorator";
  67746. }
  67747. declare module "babylonjs/Materials/index" {
  67748. export * from "babylonjs/Materials/Background/index";
  67749. export * from "babylonjs/Materials/colorCurves";
  67750. export * from "babylonjs/Materials/iEffectFallbacks";
  67751. export * from "babylonjs/Materials/effectFallbacks";
  67752. export * from "babylonjs/Materials/effect";
  67753. export * from "babylonjs/Materials/fresnelParameters";
  67754. export * from "babylonjs/Materials/imageProcessingConfiguration";
  67755. export * from "babylonjs/Materials/material";
  67756. export * from "babylonjs/Materials/materialDefines";
  67757. export * from "babylonjs/Materials/materialHelper";
  67758. export * from "babylonjs/Materials/multiMaterial";
  67759. export * from "babylonjs/Materials/PBR/index";
  67760. export * from "babylonjs/Materials/pushMaterial";
  67761. export * from "babylonjs/Materials/shaderMaterial";
  67762. export * from "babylonjs/Materials/standardMaterial";
  67763. export * from "babylonjs/Materials/Textures/index";
  67764. export * from "babylonjs/Materials/uniformBuffer";
  67765. export * from "babylonjs/Materials/materialFlags";
  67766. export * from "babylonjs/Materials/Node/index";
  67767. export * from "babylonjs/Materials/effectRenderer";
  67768. export * from "babylonjs/Materials/shadowDepthWrapper";
  67769. }
  67770. declare module "babylonjs/Maths/index" {
  67771. export * from "babylonjs/Maths/math.scalar";
  67772. export * from "babylonjs/Maths/math";
  67773. export * from "babylonjs/Maths/sphericalPolynomial";
  67774. }
  67775. declare module "babylonjs/Misc/workerPool" {
  67776. import { IDisposable } from "babylonjs/scene";
  67777. /**
  67778. * Helper class to push actions to a pool of workers.
  67779. */
  67780. export class WorkerPool implements IDisposable {
  67781. private _workerInfos;
  67782. private _pendingActions;
  67783. /**
  67784. * Constructor
  67785. * @param workers Array of workers to use for actions
  67786. */
  67787. constructor(workers: Array<Worker>);
  67788. /**
  67789. * Terminates all workers and clears any pending actions.
  67790. */
  67791. dispose(): void;
  67792. /**
  67793. * Pushes an action to the worker pool. If all the workers are active, the action will be
  67794. * pended until a worker has completed its action.
  67795. * @param action The action to perform. Call onComplete when the action is complete.
  67796. */
  67797. push(action: (worker: Worker, onComplete: () => void) => void): void;
  67798. private _execute;
  67799. }
  67800. }
  67801. declare module "babylonjs/Meshes/Compression/dracoCompression" {
  67802. import { IDisposable } from "babylonjs/scene";
  67803. import { VertexData } from "babylonjs/Meshes/mesh.vertexData";
  67804. /**
  67805. * Configuration for Draco compression
  67806. */
  67807. export interface IDracoCompressionConfiguration {
  67808. /**
  67809. * Configuration for the decoder.
  67810. */
  67811. decoder: {
  67812. /**
  67813. * The url to the WebAssembly module.
  67814. */
  67815. wasmUrl?: string;
  67816. /**
  67817. * The url to the WebAssembly binary.
  67818. */
  67819. wasmBinaryUrl?: string;
  67820. /**
  67821. * The url to the fallback JavaScript module.
  67822. */
  67823. fallbackUrl?: string;
  67824. };
  67825. }
  67826. /**
  67827. * Draco compression (https://google.github.io/draco/)
  67828. *
  67829. * This class wraps the Draco module.
  67830. *
  67831. * **Encoder**
  67832. *
  67833. * The encoder is not currently implemented.
  67834. *
  67835. * **Decoder**
  67836. *
  67837. * 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.
  67838. *
  67839. * To update the configuration, use the following code:
  67840. * ```javascript
  67841. * DracoCompression.Configuration = {
  67842. * decoder: {
  67843. * wasmUrl: "<url to the WebAssembly library>",
  67844. * wasmBinaryUrl: "<url to the WebAssembly binary>",
  67845. * fallbackUrl: "<url to the fallback JavaScript library>",
  67846. * }
  67847. * };
  67848. * ```
  67849. *
  67850. * 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.
  67851. * Decoding will automatically fallback to the JavaScript version if WebAssembly version is not configured or if WebAssembly is not supported by the browser.
  67852. * Use `DracoCompression.DecoderAvailable` to determine if the decoder configuration is available for the current context.
  67853. *
  67854. * To decode Draco compressed data, get the default DracoCompression object and call decodeMeshAsync:
  67855. * ```javascript
  67856. * var vertexData = await DracoCompression.Default.decodeMeshAsync(data);
  67857. * ```
  67858. *
  67859. * @see https://www.babylonjs-playground.com/#N3EK4B#0
  67860. */
  67861. export class DracoCompression implements IDisposable {
  67862. private _workerPoolPromise?;
  67863. private _decoderModulePromise?;
  67864. /**
  67865. * The configuration. Defaults to the following urls:
  67866. * - wasmUrl: "https://preview.babylonjs.com/draco_wasm_wrapper_gltf.js"
  67867. * - wasmBinaryUrl: "https://preview.babylonjs.com/draco_decoder_gltf.wasm"
  67868. * - fallbackUrl: "https://preview.babylonjs.com/draco_decoder_gltf.js"
  67869. */
  67870. static Configuration: IDracoCompressionConfiguration;
  67871. /**
  67872. * Returns true if the decoder configuration is available.
  67873. */
  67874. static get DecoderAvailable(): boolean;
  67875. /**
  67876. * Default number of workers to create when creating the draco compression object.
  67877. */
  67878. static DefaultNumWorkers: number;
  67879. private static GetDefaultNumWorkers;
  67880. private static _Default;
  67881. /**
  67882. * Default instance for the draco compression object.
  67883. */
  67884. static get Default(): DracoCompression;
  67885. /**
  67886. * Constructor
  67887. * @param numWorkers The number of workers for async operations. Specify `0` to disable web workers and run synchronously in the current context.
  67888. */
  67889. constructor(numWorkers?: number);
  67890. /**
  67891. * Stop all async operations and release resources.
  67892. */
  67893. dispose(): void;
  67894. /**
  67895. * Returns a promise that resolves when ready. Call this manually to ensure draco compression is ready before use.
  67896. * @returns a promise that resolves when ready
  67897. */
  67898. whenReadyAsync(): Promise<void>;
  67899. /**
  67900. * Decode Draco compressed mesh data to vertex data.
  67901. * @param data The ArrayBuffer or ArrayBufferView for the Draco compression data
  67902. * @param attributes A map of attributes from vertex buffer kinds to Draco unique ids
  67903. * @returns A promise that resolves with the decoded vertex data
  67904. */
  67905. decodeMeshAsync(data: ArrayBuffer | ArrayBufferView, attributes?: {
  67906. [kind: string]: number;
  67907. }): Promise<VertexData>;
  67908. }
  67909. }
  67910. declare module "babylonjs/Meshes/Compression/index" {
  67911. export * from "babylonjs/Meshes/Compression/dracoCompression";
  67912. }
  67913. declare module "babylonjs/Meshes/csg" {
  67914. import { Nullable } from "babylonjs/types";
  67915. import { Scene } from "babylonjs/scene";
  67916. import { Quaternion, Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  67917. import { Mesh } from "babylonjs/Meshes/mesh";
  67918. import { Material } from "babylonjs/Materials/material";
  67919. /**
  67920. * Class for building Constructive Solid Geometry
  67921. */
  67922. export class CSG {
  67923. private polygons;
  67924. /**
  67925. * The world matrix
  67926. */
  67927. matrix: Matrix;
  67928. /**
  67929. * Stores the position
  67930. */
  67931. position: Vector3;
  67932. /**
  67933. * Stores the rotation
  67934. */
  67935. rotation: Vector3;
  67936. /**
  67937. * Stores the rotation quaternion
  67938. */
  67939. rotationQuaternion: Nullable<Quaternion>;
  67940. /**
  67941. * Stores the scaling vector
  67942. */
  67943. scaling: Vector3;
  67944. /**
  67945. * Convert the Mesh to CSG
  67946. * @param mesh The Mesh to convert to CSG
  67947. * @returns A new CSG from the Mesh
  67948. */
  67949. static FromMesh(mesh: Mesh): CSG;
  67950. /**
  67951. * Construct a CSG solid from a list of `CSG.Polygon` instances.
  67952. * @param polygons Polygons used to construct a CSG solid
  67953. */
  67954. private static FromPolygons;
  67955. /**
  67956. * Clones, or makes a deep copy, of the CSG
  67957. * @returns A new CSG
  67958. */
  67959. clone(): CSG;
  67960. /**
  67961. * Unions this CSG with another CSG
  67962. * @param csg The CSG to union against this CSG
  67963. * @returns The unioned CSG
  67964. */
  67965. union(csg: CSG): CSG;
  67966. /**
  67967. * Unions this CSG with another CSG in place
  67968. * @param csg The CSG to union against this CSG
  67969. */
  67970. unionInPlace(csg: CSG): void;
  67971. /**
  67972. * Subtracts this CSG with another CSG
  67973. * @param csg The CSG to subtract against this CSG
  67974. * @returns A new CSG
  67975. */
  67976. subtract(csg: CSG): CSG;
  67977. /**
  67978. * Subtracts this CSG with another CSG in place
  67979. * @param csg The CSG to subtact against this CSG
  67980. */
  67981. subtractInPlace(csg: CSG): void;
  67982. /**
  67983. * Intersect this CSG with another CSG
  67984. * @param csg The CSG to intersect against this CSG
  67985. * @returns A new CSG
  67986. */
  67987. intersect(csg: CSG): CSG;
  67988. /**
  67989. * Intersects this CSG with another CSG in place
  67990. * @param csg The CSG to intersect against this CSG
  67991. */
  67992. intersectInPlace(csg: CSG): void;
  67993. /**
  67994. * Return a new CSG solid with solid and empty space switched. This solid is
  67995. * not modified.
  67996. * @returns A new CSG solid with solid and empty space switched
  67997. */
  67998. inverse(): CSG;
  67999. /**
  68000. * Inverses the CSG in place
  68001. */
  68002. inverseInPlace(): void;
  68003. /**
  68004. * This is used to keep meshes transformations so they can be restored
  68005. * when we build back a Babylon Mesh
  68006. * NB : All CSG operations are performed in world coordinates
  68007. * @param csg The CSG to copy the transform attributes from
  68008. * @returns This CSG
  68009. */
  68010. copyTransformAttributes(csg: CSG): CSG;
  68011. /**
  68012. * Build Raw mesh from CSG
  68013. * Coordinates here are in world space
  68014. * @param name The name of the mesh geometry
  68015. * @param scene The Scene
  68016. * @param keepSubMeshes Specifies if the submeshes should be kept
  68017. * @returns A new Mesh
  68018. */
  68019. buildMeshGeometry(name: string, scene?: Scene, keepSubMeshes?: boolean): Mesh;
  68020. /**
  68021. * Build Mesh from CSG taking material and transforms into account
  68022. * @param name The name of the Mesh
  68023. * @param material The material of the Mesh
  68024. * @param scene The Scene
  68025. * @param keepSubMeshes Specifies if submeshes should be kept
  68026. * @returns The new Mesh
  68027. */
  68028. toMesh(name: string, material?: Nullable<Material>, scene?: Scene, keepSubMeshes?: boolean): Mesh;
  68029. }
  68030. }
  68031. declare module "babylonjs/Meshes/trailMesh" {
  68032. import { Mesh } from "babylonjs/Meshes/mesh";
  68033. import { Scene } from "babylonjs/scene";
  68034. import { TransformNode } from "babylonjs/Meshes/transformNode";
  68035. /**
  68036. * Class used to create a trail following a mesh
  68037. */
  68038. export class TrailMesh extends Mesh {
  68039. private _generator;
  68040. private _autoStart;
  68041. private _running;
  68042. private _diameter;
  68043. private _length;
  68044. private _sectionPolygonPointsCount;
  68045. private _sectionVectors;
  68046. private _sectionNormalVectors;
  68047. private _beforeRenderObserver;
  68048. /**
  68049. * @constructor
  68050. * @param name The value used by scene.getMeshByName() to do a lookup.
  68051. * @param generator The mesh or transform node to generate a trail.
  68052. * @param scene The scene to add this mesh to.
  68053. * @param diameter Diameter of trailing mesh. Default is 1.
  68054. * @param length Length of trailing mesh. Default is 60.
  68055. * @param autoStart Automatically start trailing mesh. Default true.
  68056. */
  68057. constructor(name: string, generator: TransformNode, scene: Scene, diameter?: number, length?: number, autoStart?: boolean);
  68058. /**
  68059. * "TrailMesh"
  68060. * @returns "TrailMesh"
  68061. */
  68062. getClassName(): string;
  68063. private _createMesh;
  68064. /**
  68065. * Start trailing mesh.
  68066. */
  68067. start(): void;
  68068. /**
  68069. * Stop trailing mesh.
  68070. */
  68071. stop(): void;
  68072. /**
  68073. * Update trailing mesh geometry.
  68074. */
  68075. update(): void;
  68076. /**
  68077. * Returns a new TrailMesh object.
  68078. * @param name is a string, the name given to the new mesh
  68079. * @param newGenerator use new generator object for cloned trail mesh
  68080. * @returns a new mesh
  68081. */
  68082. clone(name: string | undefined, newGenerator: TransformNode): TrailMesh;
  68083. /**
  68084. * Serializes this trail mesh
  68085. * @param serializationObject object to write serialization to
  68086. */
  68087. serialize(serializationObject: any): void;
  68088. /**
  68089. * Parses a serialized trail mesh
  68090. * @param parsedMesh the serialized mesh
  68091. * @param scene the scene to create the trail mesh in
  68092. * @returns the created trail mesh
  68093. */
  68094. static Parse(parsedMesh: any, scene: Scene): TrailMesh;
  68095. }
  68096. }
  68097. declare module "babylonjs/Meshes/Builders/tiledBoxBuilder" {
  68098. import { Nullable } from "babylonjs/types";
  68099. import { Scene } from "babylonjs/scene";
  68100. import { Vector4 } from "babylonjs/Maths/math.vector";
  68101. import { Color4 } from "babylonjs/Maths/math.color";
  68102. import { Mesh } from "babylonjs/Meshes/mesh";
  68103. /**
  68104. * Class containing static functions to help procedurally build meshes
  68105. */
  68106. export class TiledBoxBuilder {
  68107. /**
  68108. * Creates a box mesh
  68109. * 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)
  68110. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  68111. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  68112. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  68113. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  68114. * @param name defines the name of the mesh
  68115. * @param options defines the options used to create the mesh
  68116. * @param scene defines the hosting scene
  68117. * @returns the box mesh
  68118. */
  68119. static CreateTiledBox(name: string, options: {
  68120. pattern?: number;
  68121. width?: number;
  68122. height?: number;
  68123. depth?: number;
  68124. tileSize?: number;
  68125. tileWidth?: number;
  68126. tileHeight?: number;
  68127. alignHorizontal?: number;
  68128. alignVertical?: number;
  68129. faceUV?: Vector4[];
  68130. faceColors?: Color4[];
  68131. sideOrientation?: number;
  68132. updatable?: boolean;
  68133. }, scene?: Nullable<Scene>): Mesh;
  68134. }
  68135. }
  68136. declare module "babylonjs/Meshes/Builders/torusKnotBuilder" {
  68137. import { Vector4 } from "babylonjs/Maths/math.vector";
  68138. import { Mesh } from "babylonjs/Meshes/mesh";
  68139. /**
  68140. * Class containing static functions to help procedurally build meshes
  68141. */
  68142. export class TorusKnotBuilder {
  68143. /**
  68144. * Creates a torus knot mesh
  68145. * * The parameter `radius` sets the global radius size (float) of the torus knot (default 2)
  68146. * * The parameter `radialSegments` sets the number of sides on each tube segments (positive integer, default 32)
  68147. * * The parameter `tubularSegments` sets the number of tubes to decompose the knot into (positive integer, default 32)
  68148. * * The parameters `p` and `q` are the number of windings on each axis (positive integers, default 2 and 3)
  68149. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  68150. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  68151. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  68152. * @param name defines the name of the mesh
  68153. * @param options defines the options used to create the mesh
  68154. * @param scene defines the hosting scene
  68155. * @returns the torus knot mesh
  68156. * @see https://doc.babylonjs.com/how_to/set_shapes#torus-knot
  68157. */
  68158. static CreateTorusKnot(name: string, options: {
  68159. radius?: number;
  68160. tube?: number;
  68161. radialSegments?: number;
  68162. tubularSegments?: number;
  68163. p?: number;
  68164. q?: number;
  68165. updatable?: boolean;
  68166. sideOrientation?: number;
  68167. frontUVs?: Vector4;
  68168. backUVs?: Vector4;
  68169. }, scene: any): Mesh;
  68170. }
  68171. }
  68172. declare module "babylonjs/Meshes/polygonMesh" {
  68173. import { Scene } from "babylonjs/scene";
  68174. import { Vector2 } from "babylonjs/Maths/math.vector";
  68175. import { Mesh } from "babylonjs/Meshes/mesh";
  68176. import { VertexData } from "babylonjs/Meshes/mesh.vertexData";
  68177. import { Path2 } from "babylonjs/Maths/math.path";
  68178. /**
  68179. * Polygon
  68180. * @see https://doc.babylonjs.com/how_to/parametric_shapes#non-regular-polygon
  68181. */
  68182. export class Polygon {
  68183. /**
  68184. * Creates a rectangle
  68185. * @param xmin bottom X coord
  68186. * @param ymin bottom Y coord
  68187. * @param xmax top X coord
  68188. * @param ymax top Y coord
  68189. * @returns points that make the resulting rectation
  68190. */
  68191. static Rectangle(xmin: number, ymin: number, xmax: number, ymax: number): Vector2[];
  68192. /**
  68193. * Creates a circle
  68194. * @param radius radius of circle
  68195. * @param cx scale in x
  68196. * @param cy scale in y
  68197. * @param numberOfSides number of sides that make up the circle
  68198. * @returns points that make the resulting circle
  68199. */
  68200. static Circle(radius: number, cx?: number, cy?: number, numberOfSides?: number): Vector2[];
  68201. /**
  68202. * Creates a polygon from input string
  68203. * @param input Input polygon data
  68204. * @returns the parsed points
  68205. */
  68206. static Parse(input: string): Vector2[];
  68207. /**
  68208. * Starts building a polygon from x and y coordinates
  68209. * @param x x coordinate
  68210. * @param y y coordinate
  68211. * @returns the started path2
  68212. */
  68213. static StartingAt(x: number, y: number): Path2;
  68214. }
  68215. /**
  68216. * Builds a polygon
  68217. * @see https://doc.babylonjs.com/how_to/polygonmeshbuilder
  68218. */
  68219. export class PolygonMeshBuilder {
  68220. private _points;
  68221. private _outlinepoints;
  68222. private _holes;
  68223. private _name;
  68224. private _scene;
  68225. private _epoints;
  68226. private _eholes;
  68227. private _addToepoint;
  68228. /**
  68229. * Babylon reference to the earcut plugin.
  68230. */
  68231. bjsEarcut: any;
  68232. /**
  68233. * Creates a PolygonMeshBuilder
  68234. * @param name name of the builder
  68235. * @param contours Path of the polygon
  68236. * @param scene scene to add to when creating the mesh
  68237. * @param earcutInjection can be used to inject your own earcut reference
  68238. */
  68239. constructor(name: string, contours: Path2 | Vector2[] | any, scene?: Scene, earcutInjection?: any);
  68240. /**
  68241. * Adds a whole within the polygon
  68242. * @param hole Array of points defining the hole
  68243. * @returns this
  68244. */
  68245. addHole(hole: Vector2[]): PolygonMeshBuilder;
  68246. /**
  68247. * Creates the polygon
  68248. * @param updatable If the mesh should be updatable
  68249. * @param depth The depth of the mesh created
  68250. * @returns the created mesh
  68251. */
  68252. build(updatable?: boolean, depth?: number): Mesh;
  68253. /**
  68254. * Creates the polygon
  68255. * @param depth The depth of the mesh created
  68256. * @returns the created VertexData
  68257. */
  68258. buildVertexData(depth?: number): VertexData;
  68259. /**
  68260. * Adds a side to the polygon
  68261. * @param positions points that make the polygon
  68262. * @param normals normals of the polygon
  68263. * @param uvs uvs of the polygon
  68264. * @param indices indices of the polygon
  68265. * @param bounds bounds of the polygon
  68266. * @param points points of the polygon
  68267. * @param depth depth of the polygon
  68268. * @param flip flip of the polygon
  68269. */
  68270. private addSide;
  68271. }
  68272. }
  68273. declare module "babylonjs/Meshes/Builders/polygonBuilder" {
  68274. import { Scene } from "babylonjs/scene";
  68275. import { Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  68276. import { Color4 } from "babylonjs/Maths/math.color";
  68277. import { Mesh } from "babylonjs/Meshes/mesh";
  68278. import { Nullable } from "babylonjs/types";
  68279. /**
  68280. * Class containing static functions to help procedurally build meshes
  68281. */
  68282. export class PolygonBuilder {
  68283. /**
  68284. * Creates a polygon mesh
  68285. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh
  68286. * * 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
  68287. * * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  68288. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  68289. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4)
  68290. * * Remember you can only change the shape positions, not their number when updating a polygon
  68291. * @param name defines the name of the mesh
  68292. * @param options defines the options used to create the mesh
  68293. * @param scene defines the hosting scene
  68294. * @param earcutInjection can be used to inject your own earcut reference
  68295. * @returns the polygon mesh
  68296. */
  68297. static CreatePolygon(name: string, options: {
  68298. shape: Vector3[];
  68299. holes?: Vector3[][];
  68300. depth?: number;
  68301. faceUV?: Vector4[];
  68302. faceColors?: Color4[];
  68303. updatable?: boolean;
  68304. sideOrientation?: number;
  68305. frontUVs?: Vector4;
  68306. backUVs?: Vector4;
  68307. wrap?: boolean;
  68308. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  68309. /**
  68310. * Creates an extruded polygon mesh, with depth in the Y direction.
  68311. * * 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)
  68312. * @see https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  68313. * @param name defines the name of the mesh
  68314. * @param options defines the options used to create the mesh
  68315. * @param scene defines the hosting scene
  68316. * @param earcutInjection can be used to inject your own earcut reference
  68317. * @returns the polygon mesh
  68318. */
  68319. static ExtrudePolygon(name: string, options: {
  68320. shape: Vector3[];
  68321. holes?: Vector3[][];
  68322. depth?: number;
  68323. faceUV?: Vector4[];
  68324. faceColors?: Color4[];
  68325. updatable?: boolean;
  68326. sideOrientation?: number;
  68327. frontUVs?: Vector4;
  68328. backUVs?: Vector4;
  68329. wrap?: boolean;
  68330. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  68331. }
  68332. }
  68333. declare module "babylonjs/Meshes/Builders/latheBuilder" {
  68334. import { Scene } from "babylonjs/scene";
  68335. import { Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  68336. import { Mesh } from "babylonjs/Meshes/mesh";
  68337. import { Nullable } from "babylonjs/types";
  68338. /**
  68339. * Class containing static functions to help procedurally build meshes
  68340. */
  68341. export class LatheBuilder {
  68342. /**
  68343. * Creates lathe mesh.
  68344. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe
  68345. * * 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
  68346. * * The parameter `radius` (positive float, default 1) is the radius value of the lathe
  68347. * * The parameter `tessellation` (positive integer, default 64) is the side number of the lathe
  68348. * * The parameter `clip` (positive integer, default 0) is the number of sides to not create without effecting the general shape of the sides
  68349. * * 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
  68350. * * The parameter `closed` (boolean, default true) opens/closes the lathe circumference. This should be set to false when used with the parameter "arc"
  68351. * * 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
  68352. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  68353. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  68354. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  68355. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  68356. * @param name defines the name of the mesh
  68357. * @param options defines the options used to create the mesh
  68358. * @param scene defines the hosting scene
  68359. * @returns the lathe mesh
  68360. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lathe
  68361. */
  68362. static CreateLathe(name: string, options: {
  68363. shape: Vector3[];
  68364. radius?: number;
  68365. tessellation?: number;
  68366. clip?: number;
  68367. arc?: number;
  68368. closed?: boolean;
  68369. updatable?: boolean;
  68370. sideOrientation?: number;
  68371. frontUVs?: Vector4;
  68372. backUVs?: Vector4;
  68373. cap?: number;
  68374. invertUV?: boolean;
  68375. }, scene?: Nullable<Scene>): Mesh;
  68376. }
  68377. }
  68378. declare module "babylonjs/Meshes/Builders/tiledPlaneBuilder" {
  68379. import { Nullable } from "babylonjs/types";
  68380. import { Scene } from "babylonjs/scene";
  68381. import { Vector4 } from "babylonjs/Maths/math.vector";
  68382. import { Mesh } from "babylonjs/Meshes/mesh";
  68383. /**
  68384. * Class containing static functions to help procedurally build meshes
  68385. */
  68386. export class TiledPlaneBuilder {
  68387. /**
  68388. * Creates a tiled plane mesh
  68389. * * The parameter `pattern` will, depending on value, do nothing or
  68390. * * * flip (reflect about central vertical) alternate tiles across and up
  68391. * * * flip every tile on alternate rows
  68392. * * * rotate (180 degs) alternate tiles across and up
  68393. * * * rotate every tile on alternate rows
  68394. * * * flip and rotate alternate tiles across and up
  68395. * * * flip and rotate every tile on alternate rows
  68396. * * The parameter `tileSize` sets the size (float) of each tile side (default 1)
  68397. * * You can set some different tile dimensions by using the parameters `tileWidth` and `tileHeight` (both by default have the same value of `tileSize`)
  68398. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  68399. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  68400. * * 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)
  68401. * * 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)
  68402. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  68403. * @param name defines the name of the mesh
  68404. * @param options defines the options used to create the mesh
  68405. * @param scene defines the hosting scene
  68406. * @returns the box mesh
  68407. */
  68408. static CreateTiledPlane(name: string, options: {
  68409. pattern?: number;
  68410. tileSize?: number;
  68411. tileWidth?: number;
  68412. tileHeight?: number;
  68413. size?: number;
  68414. width?: number;
  68415. height?: number;
  68416. alignHorizontal?: number;
  68417. alignVertical?: number;
  68418. sideOrientation?: number;
  68419. frontUVs?: Vector4;
  68420. backUVs?: Vector4;
  68421. updatable?: boolean;
  68422. }, scene?: Nullable<Scene>): Mesh;
  68423. }
  68424. }
  68425. declare module "babylonjs/Meshes/Builders/tubeBuilder" {
  68426. import { Nullable } from "babylonjs/types";
  68427. import { Scene } from "babylonjs/scene";
  68428. import { Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  68429. import { Mesh } from "babylonjs/Meshes/mesh";
  68430. /**
  68431. * Class containing static functions to help procedurally build meshes
  68432. */
  68433. export class TubeBuilder {
  68434. /**
  68435. * Creates a tube mesh.
  68436. * The tube is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  68437. * * The parameter `path` is a required array of successive Vector3. It is the curve used as the axis of the tube
  68438. * * The parameter `radius` (positive float, default 1) sets the tube radius size
  68439. * * The parameter `tessellation` (positive float, default 64) is the number of sides on the tubular surface
  68440. * * The parameter `radiusFunction` (javascript function, default null) is a vanilla javascript function. If it is not null, it overwrittes the parameter `radius`
  68441. * * 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)
  68442. * * The parameter `arc` (positive float, maximum 1, default 1) is the ratio to apply to the tube circumference : 2 x PI x arc
  68443. * * 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
  68444. * * 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
  68445. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  68446. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  68447. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  68448. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  68449. * @param name defines the name of the mesh
  68450. * @param options defines the options used to create the mesh
  68451. * @param scene defines the hosting scene
  68452. * @returns the tube mesh
  68453. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  68454. * @see https://doc.babylonjs.com/how_to/set_shapes#tube
  68455. */
  68456. static CreateTube(name: string, options: {
  68457. path: Vector3[];
  68458. radius?: number;
  68459. tessellation?: number;
  68460. radiusFunction?: {
  68461. (i: number, distance: number): number;
  68462. };
  68463. cap?: number;
  68464. arc?: number;
  68465. updatable?: boolean;
  68466. sideOrientation?: number;
  68467. frontUVs?: Vector4;
  68468. backUVs?: Vector4;
  68469. instance?: Mesh;
  68470. invertUV?: boolean;
  68471. }, scene?: Nullable<Scene>): Mesh;
  68472. }
  68473. }
  68474. declare module "babylonjs/Meshes/Builders/icoSphereBuilder" {
  68475. import { Scene } from "babylonjs/scene";
  68476. import { Vector4 } from "babylonjs/Maths/math.vector";
  68477. import { Mesh } from "babylonjs/Meshes/mesh";
  68478. import { Nullable } from "babylonjs/types";
  68479. /**
  68480. * Class containing static functions to help procedurally build meshes
  68481. */
  68482. export class IcoSphereBuilder {
  68483. /**
  68484. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  68485. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  68486. * * 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`)
  68487. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  68488. * * 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
  68489. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  68490. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  68491. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  68492. * @param name defines the name of the mesh
  68493. * @param options defines the options used to create the mesh
  68494. * @param scene defines the hosting scene
  68495. * @returns the icosahedron mesh
  68496. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  68497. */
  68498. static CreateIcoSphere(name: string, options: {
  68499. radius?: number;
  68500. radiusX?: number;
  68501. radiusY?: number;
  68502. radiusZ?: number;
  68503. flat?: boolean;
  68504. subdivisions?: number;
  68505. sideOrientation?: number;
  68506. frontUVs?: Vector4;
  68507. backUVs?: Vector4;
  68508. updatable?: boolean;
  68509. }, scene?: Nullable<Scene>): Mesh;
  68510. }
  68511. }
  68512. declare module "babylonjs/Meshes/Builders/decalBuilder" {
  68513. import { Vector3 } from "babylonjs/Maths/math.vector";
  68514. import { Mesh } from "babylonjs/Meshes/mesh";
  68515. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  68516. /**
  68517. * Class containing static functions to help procedurally build meshes
  68518. */
  68519. export class DecalBuilder {
  68520. /**
  68521. * Creates a decal mesh.
  68522. * 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
  68523. * * The parameter `position` (Vector3, default `(0, 0, 0)`) sets the position of the decal in World coordinates
  68524. * * The parameter `normal` (Vector3, default `Vector3.Up`) sets the normal of the mesh where the decal is applied onto in World coordinates
  68525. * * The parameter `size` (Vector3, default `(1, 1, 1)`) sets the decal scaling
  68526. * * The parameter `angle` (float in radian, default 0) sets the angle to rotate the decal
  68527. * @param name defines the name of the mesh
  68528. * @param sourceMesh defines the mesh where the decal must be applied
  68529. * @param options defines the options used to create the mesh
  68530. * @param scene defines the hosting scene
  68531. * @returns the decal mesh
  68532. * @see https://doc.babylonjs.com/how_to/decals
  68533. */
  68534. static CreateDecal(name: string, sourceMesh: AbstractMesh, options: {
  68535. position?: Vector3;
  68536. normal?: Vector3;
  68537. size?: Vector3;
  68538. angle?: number;
  68539. }): Mesh;
  68540. }
  68541. }
  68542. declare module "babylonjs/Meshes/meshBuilder" {
  68543. import { Vector4, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  68544. import { Nullable } from "babylonjs/types";
  68545. import { Scene } from "babylonjs/scene";
  68546. import { Mesh } from "babylonjs/Meshes/mesh";
  68547. import { LinesMesh } from "babylonjs/Meshes/linesMesh";
  68548. import { GroundMesh } from "babylonjs/Meshes/groundMesh";
  68549. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  68550. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  68551. import { Plane } from "babylonjs/Maths/math.plane";
  68552. /**
  68553. * Class containing static functions to help procedurally build meshes
  68554. */
  68555. export class MeshBuilder {
  68556. /**
  68557. * Creates a box mesh
  68558. * * The parameter `size` sets the size (float) of each box side (default 1)
  68559. * * You can set some different box dimensions by using the parameters `width`, `height` and `depth` (all by default have the same value of `size`)
  68560. * * 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)
  68561. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  68562. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  68563. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  68564. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  68565. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  68566. * @param name defines the name of the mesh
  68567. * @param options defines the options used to create the mesh
  68568. * @param scene defines the hosting scene
  68569. * @returns the box mesh
  68570. */
  68571. static CreateBox(name: string, options: {
  68572. size?: number;
  68573. width?: number;
  68574. height?: number;
  68575. depth?: number;
  68576. faceUV?: Vector4[];
  68577. faceColors?: Color4[];
  68578. sideOrientation?: number;
  68579. frontUVs?: Vector4;
  68580. backUVs?: Vector4;
  68581. wrap?: boolean;
  68582. topBaseAt?: number;
  68583. bottomBaseAt?: number;
  68584. updatable?: boolean;
  68585. }, scene?: Nullable<Scene>): Mesh;
  68586. /**
  68587. * Creates a tiled box mesh
  68588. * * faceTiles sets the pattern, tile size and number of tiles for a face
  68589. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  68590. * @param name defines the name of the mesh
  68591. * @param options defines the options used to create the mesh
  68592. * @param scene defines the hosting scene
  68593. * @returns the tiled box mesh
  68594. */
  68595. static CreateTiledBox(name: string, options: {
  68596. pattern?: number;
  68597. size?: number;
  68598. width?: number;
  68599. height?: number;
  68600. depth: number;
  68601. tileSize?: number;
  68602. tileWidth?: number;
  68603. tileHeight?: number;
  68604. faceUV?: Vector4[];
  68605. faceColors?: Color4[];
  68606. alignHorizontal?: number;
  68607. alignVertical?: number;
  68608. sideOrientation?: number;
  68609. updatable?: boolean;
  68610. }, scene?: Nullable<Scene>): Mesh;
  68611. /**
  68612. * Creates a sphere mesh
  68613. * * The parameter `diameter` sets the diameter size (float) of the sphere (default 1)
  68614. * * 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`)
  68615. * * The parameter `segments` sets the sphere number of horizontal stripes (positive integer, default 32)
  68616. * * 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
  68617. * * 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)
  68618. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  68619. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  68620. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  68621. * @param name defines the name of the mesh
  68622. * @param options defines the options used to create the mesh
  68623. * @param scene defines the hosting scene
  68624. * @returns the sphere mesh
  68625. * @see https://doc.babylonjs.com/how_to/set_shapes#sphere
  68626. */
  68627. static CreateSphere(name: string, options: {
  68628. segments?: number;
  68629. diameter?: number;
  68630. diameterX?: number;
  68631. diameterY?: number;
  68632. diameterZ?: number;
  68633. arc?: number;
  68634. slice?: number;
  68635. sideOrientation?: number;
  68636. frontUVs?: Vector4;
  68637. backUVs?: Vector4;
  68638. updatable?: boolean;
  68639. }, scene?: Nullable<Scene>): Mesh;
  68640. /**
  68641. * Creates a plane polygonal mesh. By default, this is a disc
  68642. * * The parameter `radius` sets the radius size (float) of the polygon (default 0.5)
  68643. * * 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
  68644. * * 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
  68645. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  68646. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  68647. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  68648. * @param name defines the name of the mesh
  68649. * @param options defines the options used to create the mesh
  68650. * @param scene defines the hosting scene
  68651. * @returns the plane polygonal mesh
  68652. * @see https://doc.babylonjs.com/how_to/set_shapes#disc-or-regular-polygon
  68653. */
  68654. static CreateDisc(name: string, options: {
  68655. radius?: number;
  68656. tessellation?: number;
  68657. arc?: number;
  68658. updatable?: boolean;
  68659. sideOrientation?: number;
  68660. frontUVs?: Vector4;
  68661. backUVs?: Vector4;
  68662. }, scene?: Nullable<Scene>): Mesh;
  68663. /**
  68664. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  68665. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  68666. * * 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`)
  68667. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  68668. * * 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
  68669. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  68670. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  68671. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  68672. * @param name defines the name of the mesh
  68673. * @param options defines the options used to create the mesh
  68674. * @param scene defines the hosting scene
  68675. * @returns the icosahedron mesh
  68676. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  68677. */
  68678. static CreateIcoSphere(name: string, options: {
  68679. radius?: number;
  68680. radiusX?: number;
  68681. radiusY?: number;
  68682. radiusZ?: number;
  68683. flat?: boolean;
  68684. subdivisions?: number;
  68685. sideOrientation?: number;
  68686. frontUVs?: Vector4;
  68687. backUVs?: Vector4;
  68688. updatable?: boolean;
  68689. }, scene?: Nullable<Scene>): Mesh;
  68690. /**
  68691. * Creates a ribbon mesh. The ribbon is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  68692. * * The parameter `pathArray` is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry
  68693. * * The parameter `closeArray` (boolean, default false) creates a seam between the first and the last paths of the path array
  68694. * * The parameter `closePath` (boolean, default false) creates a seam between the first and the last points of each path of the path array
  68695. * * 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
  68696. * * 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
  68697. * * 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
  68698. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  68699. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  68700. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  68701. * * 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
  68702. * * The parameters `colors` is an optional flat array of `Color4` to set/update each ribbon vertex with its own custom color values
  68703. * * 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
  68704. * * Moreover, you can use the parameter `color` with `instance` (to update the ribbon), only if you previously used it at creation time
  68705. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  68706. * @param name defines the name of the mesh
  68707. * @param options defines the options used to create the mesh
  68708. * @param scene defines the hosting scene
  68709. * @returns the ribbon mesh
  68710. * @see https://doc.babylonjs.com/how_to/ribbon_tutorial
  68711. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  68712. */
  68713. static CreateRibbon(name: string, options: {
  68714. pathArray: Vector3[][];
  68715. closeArray?: boolean;
  68716. closePath?: boolean;
  68717. offset?: number;
  68718. updatable?: boolean;
  68719. sideOrientation?: number;
  68720. frontUVs?: Vector4;
  68721. backUVs?: Vector4;
  68722. instance?: Mesh;
  68723. invertUV?: boolean;
  68724. uvs?: Vector2[];
  68725. colors?: Color4[];
  68726. }, scene?: Nullable<Scene>): Mesh;
  68727. /**
  68728. * Creates a cylinder or a cone mesh
  68729. * * The parameter `height` sets the height size (float) of the cylinder/cone (float, default 2).
  68730. * * The parameter `diameter` sets the diameter of the top and bottom cap at once (float, default 1).
  68731. * * 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.
  68732. * * The parameter `tessellation` sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance.
  68733. * * The parameter `subdivisions` sets the number of rings along the cylinder height (positive integer, default 1).
  68734. * * The parameter `hasRings` (boolean, default false) makes the subdivisions independent from each other, so they become different faces.
  68735. * * The parameter `enclose` (boolean, default false) adds two extra faces per subdivision to a sliced cylinder to close it around its height axis.
  68736. * * 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).
  68737. * * The parameter `arc` (float, default 1) is the ratio (max 1) to apply to the circumference to slice the cylinder.
  68738. * * 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).
  68739. * * 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
  68740. * * Now, if the cylinder has 5 independent subdivisions (hasRings = true), n equals : top face + 5 stripe surfaces + bottom face = 2 + 5 = 7
  68741. * * 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
  68742. * * 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.
  68743. * * If `enclose` is false, a ring surface is one element.
  68744. * * If `enclose` is true, a ring surface is 3 successive elements in the array : the tubular surface, then the two closing faces.
  68745. * * 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
  68746. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  68747. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  68748. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  68749. * @param name defines the name of the mesh
  68750. * @param options defines the options used to create the mesh
  68751. * @param scene defines the hosting scene
  68752. * @returns the cylinder mesh
  68753. * @see https://doc.babylonjs.com/how_to/set_shapes#cylinder-or-cone
  68754. */
  68755. static CreateCylinder(name: string, options: {
  68756. height?: number;
  68757. diameterTop?: number;
  68758. diameterBottom?: number;
  68759. diameter?: number;
  68760. tessellation?: number;
  68761. subdivisions?: number;
  68762. arc?: number;
  68763. faceColors?: Color4[];
  68764. faceUV?: Vector4[];
  68765. updatable?: boolean;
  68766. hasRings?: boolean;
  68767. enclose?: boolean;
  68768. cap?: number;
  68769. sideOrientation?: number;
  68770. frontUVs?: Vector4;
  68771. backUVs?: Vector4;
  68772. }, scene?: Nullable<Scene>): Mesh;
  68773. /**
  68774. * Creates a torus mesh
  68775. * * The parameter `diameter` sets the diameter size (float) of the torus (default 1)
  68776. * * The parameter `thickness` sets the diameter size of the tube of the torus (float, default 0.5)
  68777. * * The parameter `tessellation` sets the number of torus sides (postive integer, default 16)
  68778. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  68779. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  68780. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  68781. * @param name defines the name of the mesh
  68782. * @param options defines the options used to create the mesh
  68783. * @param scene defines the hosting scene
  68784. * @returns the torus mesh
  68785. * @see https://doc.babylonjs.com/how_to/set_shapes#torus
  68786. */
  68787. static CreateTorus(name: string, options: {
  68788. diameter?: number;
  68789. thickness?: number;
  68790. tessellation?: number;
  68791. updatable?: boolean;
  68792. sideOrientation?: number;
  68793. frontUVs?: Vector4;
  68794. backUVs?: Vector4;
  68795. }, scene?: Nullable<Scene>): Mesh;
  68796. /**
  68797. * Creates a torus knot mesh
  68798. * * The parameter `radius` sets the global radius size (float) of the torus knot (default 2)
  68799. * * The parameter `radialSegments` sets the number of sides on each tube segments (positive integer, default 32)
  68800. * * The parameter `tubularSegments` sets the number of tubes to decompose the knot into (positive integer, default 32)
  68801. * * The parameters `p` and `q` are the number of windings on each axis (positive integers, default 2 and 3)
  68802. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  68803. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  68804. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  68805. * @param name defines the name of the mesh
  68806. * @param options defines the options used to create the mesh
  68807. * @param scene defines the hosting scene
  68808. * @returns the torus knot mesh
  68809. * @see https://doc.babylonjs.com/how_to/set_shapes#torus-knot
  68810. */
  68811. static CreateTorusKnot(name: string, options: {
  68812. radius?: number;
  68813. tube?: number;
  68814. radialSegments?: number;
  68815. tubularSegments?: number;
  68816. p?: number;
  68817. q?: number;
  68818. updatable?: boolean;
  68819. sideOrientation?: number;
  68820. frontUVs?: Vector4;
  68821. backUVs?: Vector4;
  68822. }, scene?: Nullable<Scene>): Mesh;
  68823. /**
  68824. * Creates a line system mesh. A line system is a pool of many lines gathered in a single mesh
  68825. * * 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
  68826. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineSystem to this static function
  68827. * * The parameter `lines` is an array of lines, each line being an array of successive Vector3
  68828. * * The optional parameter `instance` is an instance of an existing LineSystem object to be updated with the passed `lines` parameter
  68829. * * The optional parameter `colors` is an array of line colors, each line colors being an array of successive Color4, one per line point
  68830. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  68831. * * 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
  68832. * * When updating an instance, remember that only line point positions can change, not the number of points, neither the number of lines
  68833. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  68834. * @see https://doc.babylonjs.com/how_to/parametric_shapes#line-system
  68835. * @param name defines the name of the new line system
  68836. * @param options defines the options used to create the line system
  68837. * @param scene defines the hosting scene
  68838. * @returns a new line system mesh
  68839. */
  68840. static CreateLineSystem(name: string, options: {
  68841. lines: Vector3[][];
  68842. updatable?: boolean;
  68843. instance?: Nullable<LinesMesh>;
  68844. colors?: Nullable<Color4[][]>;
  68845. useVertexAlpha?: boolean;
  68846. }, scene: Nullable<Scene>): LinesMesh;
  68847. /**
  68848. * Creates a line mesh
  68849. * 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
  68850. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  68851. * * The parameter `points` is an array successive Vector3
  68852. * * 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
  68853. * * The optional parameter `colors` is an array of successive Color4, one per line point
  68854. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need alpha blending (faster)
  68855. * * When updating an instance, remember that only point positions can change, not the number of points
  68856. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  68857. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lines
  68858. * @param name defines the name of the new line system
  68859. * @param options defines the options used to create the line system
  68860. * @param scene defines the hosting scene
  68861. * @returns a new line mesh
  68862. */
  68863. static CreateLines(name: string, options: {
  68864. points: Vector3[];
  68865. updatable?: boolean;
  68866. instance?: Nullable<LinesMesh>;
  68867. colors?: Color4[];
  68868. useVertexAlpha?: boolean;
  68869. }, scene?: Nullable<Scene>): LinesMesh;
  68870. /**
  68871. * Creates a dashed line mesh
  68872. * * 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
  68873. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  68874. * * The parameter `points` is an array successive Vector3
  68875. * * The parameter `dashNb` is the intended total number of dashes (positive integer, default 200)
  68876. * * The parameter `dashSize` is the size of the dashes relatively the dash number (positive float, default 3)
  68877. * * The parameter `gapSize` is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  68878. * * 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
  68879. * * When updating an instance, remember that only point positions can change, not the number of points
  68880. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  68881. * @param name defines the name of the mesh
  68882. * @param options defines the options used to create the mesh
  68883. * @param scene defines the hosting scene
  68884. * @returns the dashed line mesh
  68885. * @see https://doc.babylonjs.com/how_to/parametric_shapes#dashed-lines
  68886. */
  68887. static CreateDashedLines(name: string, options: {
  68888. points: Vector3[];
  68889. dashSize?: number;
  68890. gapSize?: number;
  68891. dashNb?: number;
  68892. updatable?: boolean;
  68893. instance?: LinesMesh;
  68894. }, scene?: Nullable<Scene>): LinesMesh;
  68895. /**
  68896. * 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.
  68897. * * 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.
  68898. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  68899. * * 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.
  68900. * * The parameter `scale` (float, default 1) is the value to scale the shape.
  68901. * * 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
  68902. * * 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
  68903. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape.
  68904. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  68905. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  68906. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture.
  68907. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  68908. * @param name defines the name of the mesh
  68909. * @param options defines the options used to create the mesh
  68910. * @param scene defines the hosting scene
  68911. * @returns the extruded shape mesh
  68912. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  68913. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  68914. */
  68915. static ExtrudeShape(name: string, options: {
  68916. shape: Vector3[];
  68917. path: Vector3[];
  68918. scale?: number;
  68919. rotation?: number;
  68920. cap?: number;
  68921. updatable?: boolean;
  68922. sideOrientation?: number;
  68923. frontUVs?: Vector4;
  68924. backUVs?: Vector4;
  68925. instance?: Mesh;
  68926. invertUV?: boolean;
  68927. }, scene?: Nullable<Scene>): Mesh;
  68928. /**
  68929. * Creates an custom extruded shape mesh.
  68930. * The custom extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
  68931. * * 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.
  68932. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  68933. * * 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
  68934. * * It must returns a float value that will be the rotation in radians applied to the shape on each path point.
  68935. * * 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
  68936. * * It must returns a float value that will be the scale value applied to the shape on each path point
  68937. * * The parameter `ribbonClosePath` (boolean, default false) forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  68938. * * The parameter `ribbonCloseArray` (boolean, default false) forces the extrusion underlying ribbon to close its `pathArray`
  68939. * * 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
  68940. * * 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
  68941. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape
  68942. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  68943. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  68944. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  68945. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  68946. * @param name defines the name of the mesh
  68947. * @param options defines the options used to create the mesh
  68948. * @param scene defines the hosting scene
  68949. * @returns the custom extruded shape mesh
  68950. * @see https://doc.babylonjs.com/how_to/parametric_shapes#custom-extruded-shapes
  68951. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  68952. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  68953. */
  68954. static ExtrudeShapeCustom(name: string, options: {
  68955. shape: Vector3[];
  68956. path: Vector3[];
  68957. scaleFunction?: any;
  68958. rotationFunction?: any;
  68959. ribbonCloseArray?: boolean;
  68960. ribbonClosePath?: boolean;
  68961. cap?: number;
  68962. updatable?: boolean;
  68963. sideOrientation?: number;
  68964. frontUVs?: Vector4;
  68965. backUVs?: Vector4;
  68966. instance?: Mesh;
  68967. invertUV?: boolean;
  68968. }, scene?: Nullable<Scene>): Mesh;
  68969. /**
  68970. * Creates lathe mesh.
  68971. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe
  68972. * * 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
  68973. * * The parameter `radius` (positive float, default 1) is the radius value of the lathe
  68974. * * The parameter `tessellation` (positive integer, default 64) is the side number of the lathe
  68975. * * The parameter `clip` (positive integer, default 0) is the number of sides to not create without effecting the general shape of the sides
  68976. * * 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
  68977. * * The parameter `closed` (boolean, default true) opens/closes the lathe circumference. This should be set to false when used with the parameter "arc"
  68978. * * 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
  68979. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  68980. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  68981. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  68982. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  68983. * @param name defines the name of the mesh
  68984. * @param options defines the options used to create the mesh
  68985. * @param scene defines the hosting scene
  68986. * @returns the lathe mesh
  68987. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lathe
  68988. */
  68989. static CreateLathe(name: string, options: {
  68990. shape: Vector3[];
  68991. radius?: number;
  68992. tessellation?: number;
  68993. clip?: number;
  68994. arc?: number;
  68995. closed?: boolean;
  68996. updatable?: boolean;
  68997. sideOrientation?: number;
  68998. frontUVs?: Vector4;
  68999. backUVs?: Vector4;
  69000. cap?: number;
  69001. invertUV?: boolean;
  69002. }, scene?: Nullable<Scene>): Mesh;
  69003. /**
  69004. * Creates a tiled plane mesh
  69005. * * You can set a limited pattern arrangement with the tiles
  69006. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69007. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69008. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69009. * @param name defines the name of the mesh
  69010. * @param options defines the options used to create the mesh
  69011. * @param scene defines the hosting scene
  69012. * @returns the plane mesh
  69013. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  69014. */
  69015. static CreateTiledPlane(name: string, options: {
  69016. pattern?: number;
  69017. tileSize?: number;
  69018. tileWidth?: number;
  69019. tileHeight?: number;
  69020. size?: number;
  69021. width?: number;
  69022. height?: number;
  69023. alignHorizontal?: number;
  69024. alignVertical?: number;
  69025. sideOrientation?: number;
  69026. frontUVs?: Vector4;
  69027. backUVs?: Vector4;
  69028. updatable?: boolean;
  69029. }, scene?: Nullable<Scene>): Mesh;
  69030. /**
  69031. * Creates a plane mesh
  69032. * * The parameter `size` sets the size (float) of both sides of the plane at once (default 1)
  69033. * * You can set some different plane dimensions by using the parameters `width` and `height` (both by default have the same value of `size`)
  69034. * * The parameter `sourcePlane` is a Plane instance. It builds a mesh plane from a Math plane
  69035. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69036. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69037. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69038. * @param name defines the name of the mesh
  69039. * @param options defines the options used to create the mesh
  69040. * @param scene defines the hosting scene
  69041. * @returns the plane mesh
  69042. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  69043. */
  69044. static CreatePlane(name: string, options: {
  69045. size?: number;
  69046. width?: number;
  69047. height?: number;
  69048. sideOrientation?: number;
  69049. frontUVs?: Vector4;
  69050. backUVs?: Vector4;
  69051. updatable?: boolean;
  69052. sourcePlane?: Plane;
  69053. }, scene?: Nullable<Scene>): Mesh;
  69054. /**
  69055. * Creates a ground mesh
  69056. * * The parameters `width` and `height` (floats, default 1) set the width and height sizes of the ground
  69057. * * The parameter `subdivisions` (positive integer) sets the number of subdivisions per side
  69058. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69059. * @param name defines the name of the mesh
  69060. * @param options defines the options used to create the mesh
  69061. * @param scene defines the hosting scene
  69062. * @returns the ground mesh
  69063. * @see https://doc.babylonjs.com/how_to/set_shapes#ground
  69064. */
  69065. static CreateGround(name: string, options: {
  69066. width?: number;
  69067. height?: number;
  69068. subdivisions?: number;
  69069. subdivisionsX?: number;
  69070. subdivisionsY?: number;
  69071. updatable?: boolean;
  69072. }, scene?: Nullable<Scene>): Mesh;
  69073. /**
  69074. * Creates a tiled ground mesh
  69075. * * The parameters `xmin` and `xmax` (floats, default -1 and 1) set the ground minimum and maximum X coordinates
  69076. * * The parameters `zmin` and `zmax` (floats, default -1 and 1) set the ground minimum and maximum Z coordinates
  69077. * * 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
  69078. * * 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
  69079. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  69080. * @param name defines the name of the mesh
  69081. * @param options defines the options used to create the mesh
  69082. * @param scene defines the hosting scene
  69083. * @returns the tiled ground mesh
  69084. * @see https://doc.babylonjs.com/how_to/set_shapes#tiled-ground
  69085. */
  69086. static CreateTiledGround(name: string, options: {
  69087. xmin: number;
  69088. zmin: number;
  69089. xmax: number;
  69090. zmax: number;
  69091. subdivisions?: {
  69092. w: number;
  69093. h: number;
  69094. };
  69095. precision?: {
  69096. w: number;
  69097. h: number;
  69098. };
  69099. updatable?: boolean;
  69100. }, scene?: Nullable<Scene>): Mesh;
  69101. /**
  69102. * Creates a ground mesh from a height map
  69103. * * The parameter `url` sets the URL of the height map image resource.
  69104. * * The parameters `width` and `height` (positive floats, default 10) set the ground width and height sizes.
  69105. * * The parameter `subdivisions` (positive integer, default 1) sets the number of subdivision per side.
  69106. * * The parameter `minHeight` (float, default 0) is the minimum altitude on the ground.
  69107. * * The parameter `maxHeight` (float, default 1) is the maximum altitude on the ground.
  69108. * * 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.
  69109. * * 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).
  69110. * * The parameter `alphaFilter` will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  69111. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  69112. * @param name defines the name of the mesh
  69113. * @param url defines the url to the height map
  69114. * @param options defines the options used to create the mesh
  69115. * @param scene defines the hosting scene
  69116. * @returns the ground mesh
  69117. * @see https://doc.babylonjs.com/babylon101/height_map
  69118. * @see https://doc.babylonjs.com/how_to/set_shapes#ground-from-a-height-map
  69119. */
  69120. static CreateGroundFromHeightMap(name: string, url: string, options: {
  69121. width?: number;
  69122. height?: number;
  69123. subdivisions?: number;
  69124. minHeight?: number;
  69125. maxHeight?: number;
  69126. colorFilter?: Color3;
  69127. alphaFilter?: number;
  69128. updatable?: boolean;
  69129. onReady?: (mesh: GroundMesh) => void;
  69130. }, scene?: Nullable<Scene>): GroundMesh;
  69131. /**
  69132. * Creates a polygon mesh
  69133. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh
  69134. * * 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
  69135. * * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  69136. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69137. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4)
  69138. * * Remember you can only change the shape positions, not their number when updating a polygon
  69139. * @param name defines the name of the mesh
  69140. * @param options defines the options used to create the mesh
  69141. * @param scene defines the hosting scene
  69142. * @param earcutInjection can be used to inject your own earcut reference
  69143. * @returns the polygon mesh
  69144. */
  69145. static CreatePolygon(name: string, options: {
  69146. shape: Vector3[];
  69147. holes?: Vector3[][];
  69148. depth?: number;
  69149. faceUV?: Vector4[];
  69150. faceColors?: Color4[];
  69151. updatable?: boolean;
  69152. sideOrientation?: number;
  69153. frontUVs?: Vector4;
  69154. backUVs?: Vector4;
  69155. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  69156. /**
  69157. * Creates an extruded polygon mesh, with depth in the Y direction.
  69158. * * 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)
  69159. * @see https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  69160. * @param name defines the name of the mesh
  69161. * @param options defines the options used to create the mesh
  69162. * @param scene defines the hosting scene
  69163. * @param earcutInjection can be used to inject your own earcut reference
  69164. * @returns the polygon mesh
  69165. */
  69166. static ExtrudePolygon(name: string, options: {
  69167. shape: Vector3[];
  69168. holes?: Vector3[][];
  69169. depth?: number;
  69170. faceUV?: Vector4[];
  69171. faceColors?: Color4[];
  69172. updatable?: boolean;
  69173. sideOrientation?: number;
  69174. frontUVs?: Vector4;
  69175. backUVs?: Vector4;
  69176. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  69177. /**
  69178. * Creates a tube mesh.
  69179. * The tube is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  69180. * * The parameter `path` is a required array of successive Vector3. It is the curve used as the axis of the tube
  69181. * * The parameter `radius` (positive float, default 1) sets the tube radius size
  69182. * * The parameter `tessellation` (positive float, default 64) is the number of sides on the tubular surface
  69183. * * The parameter `radiusFunction` (javascript function, default null) is a vanilla javascript function. If it is not null, it overwrittes the parameter `radius`
  69184. * * 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)
  69185. * * The parameter `arc` (positive float, maximum 1, default 1) is the ratio to apply to the tube circumference : 2 x PI x arc
  69186. * * 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
  69187. * * 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
  69188. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69189. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69190. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  69191. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69192. * @param name defines the name of the mesh
  69193. * @param options defines the options used to create the mesh
  69194. * @param scene defines the hosting scene
  69195. * @returns the tube mesh
  69196. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  69197. * @see https://doc.babylonjs.com/how_to/set_shapes#tube
  69198. */
  69199. static CreateTube(name: string, options: {
  69200. path: Vector3[];
  69201. radius?: number;
  69202. tessellation?: number;
  69203. radiusFunction?: {
  69204. (i: number, distance: number): number;
  69205. };
  69206. cap?: number;
  69207. arc?: number;
  69208. updatable?: boolean;
  69209. sideOrientation?: number;
  69210. frontUVs?: Vector4;
  69211. backUVs?: Vector4;
  69212. instance?: Mesh;
  69213. invertUV?: boolean;
  69214. }, scene?: Nullable<Scene>): Mesh;
  69215. /**
  69216. * Creates a polyhedron mesh
  69217. * * 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
  69218. * * The parameter `size` (positive float, default 1) sets the polygon size
  69219. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  69220. * * 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`
  69221. * * 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
  69222. * * 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)`)
  69223. * * 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
  69224. * * 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
  69225. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69226. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69227. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69228. * @param name defines the name of the mesh
  69229. * @param options defines the options used to create the mesh
  69230. * @param scene defines the hosting scene
  69231. * @returns the polyhedron mesh
  69232. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes
  69233. */
  69234. static CreatePolyhedron(name: string, options: {
  69235. type?: number;
  69236. size?: number;
  69237. sizeX?: number;
  69238. sizeY?: number;
  69239. sizeZ?: number;
  69240. custom?: any;
  69241. faceUV?: Vector4[];
  69242. faceColors?: Color4[];
  69243. flat?: boolean;
  69244. updatable?: boolean;
  69245. sideOrientation?: number;
  69246. frontUVs?: Vector4;
  69247. backUVs?: Vector4;
  69248. }, scene?: Nullable<Scene>): Mesh;
  69249. /**
  69250. * Creates a decal mesh.
  69251. * 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
  69252. * * The parameter `position` (Vector3, default `(0, 0, 0)`) sets the position of the decal in World coordinates
  69253. * * The parameter `normal` (Vector3, default `Vector3.Up`) sets the normal of the mesh where the decal is applied onto in World coordinates
  69254. * * The parameter `size` (Vector3, default `(1, 1, 1)`) sets the decal scaling
  69255. * * The parameter `angle` (float in radian, default 0) sets the angle to rotate the decal
  69256. * @param name defines the name of the mesh
  69257. * @param sourceMesh defines the mesh where the decal must be applied
  69258. * @param options defines the options used to create the mesh
  69259. * @param scene defines the hosting scene
  69260. * @returns the decal mesh
  69261. * @see https://doc.babylonjs.com/how_to/decals
  69262. */
  69263. static CreateDecal(name: string, sourceMesh: AbstractMesh, options: {
  69264. position?: Vector3;
  69265. normal?: Vector3;
  69266. size?: Vector3;
  69267. angle?: number;
  69268. }): Mesh;
  69269. }
  69270. }
  69271. declare module "babylonjs/Meshes/meshSimplification" {
  69272. import { Mesh } from "babylonjs/Meshes/mesh";
  69273. /**
  69274. * A simplifier interface for future simplification implementations
  69275. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  69276. */
  69277. export interface ISimplifier {
  69278. /**
  69279. * Simplification of a given mesh according to the given settings.
  69280. * Since this requires computation, it is assumed that the function runs async.
  69281. * @param settings The settings of the simplification, including quality and distance
  69282. * @param successCallback A callback that will be called after the mesh was simplified.
  69283. * @param errorCallback in case of an error, this callback will be called. optional.
  69284. */
  69285. simplify(settings: ISimplificationSettings, successCallback: (simplifiedMeshes: Mesh) => void, errorCallback?: () => void): void;
  69286. }
  69287. /**
  69288. * Expected simplification settings.
  69289. * Quality should be between 0 and 1 (1 being 100%, 0 being 0%)
  69290. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  69291. */
  69292. export interface ISimplificationSettings {
  69293. /**
  69294. * Gets or sets the expected quality
  69295. */
  69296. quality: number;
  69297. /**
  69298. * Gets or sets the distance when this optimized version should be used
  69299. */
  69300. distance: number;
  69301. /**
  69302. * Gets an already optimized mesh
  69303. */
  69304. optimizeMesh?: boolean;
  69305. }
  69306. /**
  69307. * Class used to specify simplification options
  69308. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  69309. */
  69310. export class SimplificationSettings implements ISimplificationSettings {
  69311. /** expected quality */
  69312. quality: number;
  69313. /** distance when this optimized version should be used */
  69314. distance: number;
  69315. /** already optimized mesh */
  69316. optimizeMesh?: boolean | undefined;
  69317. /**
  69318. * Creates a SimplificationSettings
  69319. * @param quality expected quality
  69320. * @param distance distance when this optimized version should be used
  69321. * @param optimizeMesh already optimized mesh
  69322. */
  69323. constructor(
  69324. /** expected quality */
  69325. quality: number,
  69326. /** distance when this optimized version should be used */
  69327. distance: number,
  69328. /** already optimized mesh */
  69329. optimizeMesh?: boolean | undefined);
  69330. }
  69331. /**
  69332. * Interface used to define a simplification task
  69333. */
  69334. export interface ISimplificationTask {
  69335. /**
  69336. * Array of settings
  69337. */
  69338. settings: Array<ISimplificationSettings>;
  69339. /**
  69340. * Simplification type
  69341. */
  69342. simplificationType: SimplificationType;
  69343. /**
  69344. * Mesh to simplify
  69345. */
  69346. mesh: Mesh;
  69347. /**
  69348. * Callback called on success
  69349. */
  69350. successCallback?: () => void;
  69351. /**
  69352. * Defines if parallel processing can be used
  69353. */
  69354. parallelProcessing: boolean;
  69355. }
  69356. /**
  69357. * Queue used to order the simplification tasks
  69358. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  69359. */
  69360. export class SimplificationQueue {
  69361. private _simplificationArray;
  69362. /**
  69363. * Gets a boolean indicating that the process is still running
  69364. */
  69365. running: boolean;
  69366. /**
  69367. * Creates a new queue
  69368. */
  69369. constructor();
  69370. /**
  69371. * Adds a new simplification task
  69372. * @param task defines a task to add
  69373. */
  69374. addTask(task: ISimplificationTask): void;
  69375. /**
  69376. * Execute next task
  69377. */
  69378. executeNext(): void;
  69379. /**
  69380. * Execute a simplification task
  69381. * @param task defines the task to run
  69382. */
  69383. runSimplification(task: ISimplificationTask): void;
  69384. private getSimplifier;
  69385. }
  69386. /**
  69387. * The implemented types of simplification
  69388. * At the moment only Quadratic Error Decimation is implemented
  69389. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  69390. */
  69391. export enum SimplificationType {
  69392. /** Quadratic error decimation */
  69393. QUADRATIC = 0
  69394. }
  69395. /**
  69396. * An implementation of the Quadratic Error simplification algorithm.
  69397. * Original paper : http://www1.cs.columbia.edu/~cs4162/html05s/garland97.pdf
  69398. * Ported mostly from QSlim and http://voxels.blogspot.de/2014/05/quadric-mesh-simplification-with-source.html to babylon JS
  69399. * @author RaananW
  69400. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  69401. */
  69402. export class QuadraticErrorSimplification implements ISimplifier {
  69403. private _mesh;
  69404. private triangles;
  69405. private vertices;
  69406. private references;
  69407. private _reconstructedMesh;
  69408. /** Gets or sets the number pf sync interations */
  69409. syncIterations: number;
  69410. /** Gets or sets the aggressiveness of the simplifier */
  69411. aggressiveness: number;
  69412. /** Gets or sets the number of allowed iterations for decimation */
  69413. decimationIterations: number;
  69414. /** Gets or sets the espilon to use for bounding box computation */
  69415. boundingBoxEpsilon: number;
  69416. /**
  69417. * Creates a new QuadraticErrorSimplification
  69418. * @param _mesh defines the target mesh
  69419. */
  69420. constructor(_mesh: Mesh);
  69421. /**
  69422. * Simplification of a given mesh according to the given settings.
  69423. * Since this requires computation, it is assumed that the function runs async.
  69424. * @param settings The settings of the simplification, including quality and distance
  69425. * @param successCallback A callback that will be called after the mesh was simplified.
  69426. */
  69427. simplify(settings: ISimplificationSettings, successCallback: (simplifiedMesh: Mesh) => void): void;
  69428. private runDecimation;
  69429. private initWithMesh;
  69430. private init;
  69431. private reconstructMesh;
  69432. private initDecimatedMesh;
  69433. private isFlipped;
  69434. private updateTriangles;
  69435. private identifyBorder;
  69436. private updateMesh;
  69437. private vertexError;
  69438. private calculateError;
  69439. }
  69440. }
  69441. declare module "babylonjs/Meshes/meshSimplificationSceneComponent" {
  69442. import { Scene } from "babylonjs/scene";
  69443. import { SimplificationQueue, ISimplificationSettings, SimplificationType } from "babylonjs/Meshes/meshSimplification";
  69444. import { ISceneComponent } from "babylonjs/sceneComponent";
  69445. module "babylonjs/scene" {
  69446. interface Scene {
  69447. /** @hidden (Backing field) */
  69448. _simplificationQueue: SimplificationQueue;
  69449. /**
  69450. * Gets or sets the simplification queue attached to the scene
  69451. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  69452. */
  69453. simplificationQueue: SimplificationQueue;
  69454. }
  69455. }
  69456. module "babylonjs/Meshes/mesh" {
  69457. interface Mesh {
  69458. /**
  69459. * Simplify the mesh according to the given array of settings.
  69460. * Function will return immediately and will simplify async
  69461. * @param settings a collection of simplification settings
  69462. * @param parallelProcessing should all levels calculate parallel or one after the other
  69463. * @param simplificationType the type of simplification to run
  69464. * @param successCallback optional success callback to be called after the simplification finished processing all settings
  69465. * @returns the current mesh
  69466. */
  69467. simplify(settings: Array<ISimplificationSettings>, parallelProcessing?: boolean, simplificationType?: SimplificationType, successCallback?: (mesh?: Mesh, submeshIndex?: number) => void): Mesh;
  69468. }
  69469. }
  69470. /**
  69471. * Defines the simplification queue scene component responsible to help scheduling the various simplification task
  69472. * created in a scene
  69473. */
  69474. export class SimplicationQueueSceneComponent implements ISceneComponent {
  69475. /**
  69476. * The component name helpfull to identify the component in the list of scene components.
  69477. */
  69478. readonly name: string;
  69479. /**
  69480. * The scene the component belongs to.
  69481. */
  69482. scene: Scene;
  69483. /**
  69484. * Creates a new instance of the component for the given scene
  69485. * @param scene Defines the scene to register the component in
  69486. */
  69487. constructor(scene: Scene);
  69488. /**
  69489. * Registers the component in a given scene
  69490. */
  69491. register(): void;
  69492. /**
  69493. * Rebuilds the elements related to this component in case of
  69494. * context lost for instance.
  69495. */
  69496. rebuild(): void;
  69497. /**
  69498. * Disposes the component and the associated ressources
  69499. */
  69500. dispose(): void;
  69501. private _beforeCameraUpdate;
  69502. }
  69503. }
  69504. declare module "babylonjs/Meshes/Builders/index" {
  69505. export * from "babylonjs/Meshes/Builders/boxBuilder";
  69506. export * from "babylonjs/Meshes/Builders/tiledBoxBuilder";
  69507. export * from "babylonjs/Meshes/Builders/discBuilder";
  69508. export * from "babylonjs/Meshes/Builders/ribbonBuilder";
  69509. export * from "babylonjs/Meshes/Builders/sphereBuilder";
  69510. export * from "babylonjs/Meshes/Builders/hemisphereBuilder";
  69511. export * from "babylonjs/Meshes/Builders/cylinderBuilder";
  69512. export * from "babylonjs/Meshes/Builders/torusBuilder";
  69513. export * from "babylonjs/Meshes/Builders/torusKnotBuilder";
  69514. export * from "babylonjs/Meshes/Builders/linesBuilder";
  69515. export * from "babylonjs/Meshes/Builders/polygonBuilder";
  69516. export * from "babylonjs/Meshes/Builders/shapeBuilder";
  69517. export * from "babylonjs/Meshes/Builders/latheBuilder";
  69518. export * from "babylonjs/Meshes/Builders/planeBuilder";
  69519. export * from "babylonjs/Meshes/Builders/tiledPlaneBuilder";
  69520. export * from "babylonjs/Meshes/Builders/groundBuilder";
  69521. export * from "babylonjs/Meshes/Builders/tubeBuilder";
  69522. export * from "babylonjs/Meshes/Builders/polyhedronBuilder";
  69523. export * from "babylonjs/Meshes/Builders/icoSphereBuilder";
  69524. export * from "babylonjs/Meshes/Builders/decalBuilder";
  69525. }
  69526. declare module "babylonjs/Meshes/thinInstanceMesh" {
  69527. import { Nullable, DeepImmutableObject } from "babylonjs/types";
  69528. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  69529. import { Matrix } from "babylonjs/Maths/math.vector";
  69530. module "babylonjs/Meshes/mesh" {
  69531. interface Mesh {
  69532. /**
  69533. * Creates a new thin instance
  69534. * @param matrix the matrix or array of matrices (position, rotation, scale) of the thin instance(s) to create
  69535. * @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
  69536. * @returns the thin instance index number. If you pass an array of matrices, other instance indexes are index+1, index+2, etc
  69537. */
  69538. thinInstanceAdd(matrix: DeepImmutableObject<Matrix> | Array<DeepImmutableObject<Matrix>>, refresh: boolean): number;
  69539. /**
  69540. * Adds the transformation (matrix) of the current mesh as a thin instance
  69541. * @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
  69542. * @returns the thin instance index number
  69543. */
  69544. thinInstanceAddSelf(refresh: boolean): number;
  69545. /**
  69546. * Registers a custom attribute to be used with thin instances
  69547. * @param kind name of the attribute
  69548. * @param stride size in floats of the attribute
  69549. */
  69550. thinInstanceRegisterAttribute(kind: string, stride: number): void;
  69551. /**
  69552. * Sets the matrix of a thin instance
  69553. * @param index index of the thin instance
  69554. * @param matrix matrix to set
  69555. * @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
  69556. */
  69557. thinInstanceSetMatrixAt(index: number, matrix: DeepImmutableObject<Matrix>, refresh: boolean): void;
  69558. /**
  69559. * Sets the value of a custom attribute for a thin instance
  69560. * @param kind name of the attribute
  69561. * @param index index of the thin instance
  69562. * @param value value to set
  69563. * @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
  69564. */
  69565. thinInstanceSetAttributeAt(kind: string, index: number, value: Array<number>, refresh: boolean): void;
  69566. /**
  69567. * 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.
  69568. */
  69569. thinInstanceCount: number;
  69570. /**
  69571. * Sets a buffer to be used with thin instances. This method is a faster way to setup multiple instances than calling thinInstanceAdd repeatedly
  69572. * @param kind name of the attribute. Use "matrix" to setup the buffer of matrices
  69573. * @param buffer buffer to set
  69574. * @param stride size in floats of each value of the buffer
  69575. * @param staticBuffer indicates that the buffer is static, so that you won't change it after it is set (better performances - false by default)
  69576. */
  69577. thinInstanceSetBuffer(kind: string, buffer: Nullable<Float32Array>, stride: number, staticBuffer: boolean): void;
  69578. /**
  69579. * Synchronize the gpu buffers with a thin instance buffer. Call this method if you update later on the buffers passed to thinInstanceSetBuffer
  69580. * @param kind name of the attribute to update. Use "matrix" to update the buffer of matrices
  69581. */
  69582. thinInstanceBufferUpdated(kind: string): void;
  69583. /**
  69584. * Refreshes the bounding info, taking into account all the thin instances defined
  69585. * @param forceRefreshParentInfo true to force recomputing the mesh bounding info and use it to compute the aggregated bounding info
  69586. */
  69587. thinInstanceRefreshBoundingInfo(forceRefreshParentInfo: boolean): void;
  69588. /** @hidden */
  69589. _thinInstanceInitializeUserStorage(): void;
  69590. /** @hidden */
  69591. _thinInstanceUpdateBufferSize(kind: string, numInstances: number): void;
  69592. /** @hidden */
  69593. _userThinInstanceBuffersStorage: {
  69594. data: {
  69595. [key: string]: Float32Array;
  69596. };
  69597. sizes: {
  69598. [key: string]: number;
  69599. };
  69600. vertexBuffers: {
  69601. [key: string]: Nullable<VertexBuffer>;
  69602. };
  69603. strides: {
  69604. [key: string]: number;
  69605. };
  69606. };
  69607. }
  69608. }
  69609. }
  69610. declare module "babylonjs/Meshes/index" {
  69611. export * from "babylonjs/Meshes/abstractMesh";
  69612. export * from "babylonjs/Meshes/buffer";
  69613. export * from "babylonjs/Meshes/Compression/index";
  69614. export * from "babylonjs/Meshes/csg";
  69615. export * from "babylonjs/Meshes/geometry";
  69616. export * from "babylonjs/Meshes/groundMesh";
  69617. export * from "babylonjs/Meshes/trailMesh";
  69618. export * from "babylonjs/Meshes/instancedMesh";
  69619. export * from "babylonjs/Meshes/linesMesh";
  69620. export * from "babylonjs/Meshes/mesh";
  69621. export * from "babylonjs/Meshes/mesh.vertexData";
  69622. export * from "babylonjs/Meshes/meshBuilder";
  69623. export * from "babylonjs/Meshes/meshSimplification";
  69624. export * from "babylonjs/Meshes/meshSimplificationSceneComponent";
  69625. export * from "babylonjs/Meshes/polygonMesh";
  69626. export * from "babylonjs/Meshes/subMesh";
  69627. export * from "babylonjs/Meshes/meshLODLevel";
  69628. export * from "babylonjs/Meshes/transformNode";
  69629. export * from "babylonjs/Meshes/Builders/index";
  69630. export * from "babylonjs/Meshes/dataBuffer";
  69631. export * from "babylonjs/Meshes/WebGL/webGLDataBuffer";
  69632. import "babylonjs/Meshes/thinInstanceMesh";
  69633. export * from "babylonjs/Meshes/thinInstanceMesh";
  69634. }
  69635. declare module "babylonjs/Morph/index" {
  69636. export * from "babylonjs/Morph/morphTarget";
  69637. export * from "babylonjs/Morph/morphTargetManager";
  69638. }
  69639. declare module "babylonjs/Navigation/INavigationEngine" {
  69640. import { TransformNode } from "babylonjs/Meshes/transformNode";
  69641. import { Vector3 } from "babylonjs/Maths/math";
  69642. import { Mesh } from "babylonjs/Meshes/mesh";
  69643. import { Scene } from "babylonjs/scene";
  69644. /**
  69645. * Navigation plugin interface to add navigation constrained by a navigation mesh
  69646. */
  69647. export interface INavigationEnginePlugin {
  69648. /**
  69649. * plugin name
  69650. */
  69651. name: string;
  69652. /**
  69653. * Creates a navigation mesh
  69654. * @param meshes array of all the geometry used to compute the navigatio mesh
  69655. * @param parameters bunch of parameters used to filter geometry
  69656. */
  69657. createNavMesh(meshes: Array<Mesh>, parameters: INavMeshParameters): void;
  69658. /**
  69659. * Create a navigation mesh debug mesh
  69660. * @param scene is where the mesh will be added
  69661. * @returns debug display mesh
  69662. */
  69663. createDebugNavMesh(scene: Scene): Mesh;
  69664. /**
  69665. * Get a navigation mesh constrained position, closest to the parameter position
  69666. * @param position world position
  69667. * @returns the closest point to position constrained by the navigation mesh
  69668. */
  69669. getClosestPoint(position: Vector3): Vector3;
  69670. /**
  69671. * Get a navigation mesh constrained position, closest to the parameter position
  69672. * @param position world position
  69673. * @param result output the closest point to position constrained by the navigation mesh
  69674. */
  69675. getClosestPointToRef(position: Vector3, result: Vector3): void;
  69676. /**
  69677. * Get a navigation mesh constrained position, within a particular radius
  69678. * @param position world position
  69679. * @param maxRadius the maximum distance to the constrained world position
  69680. * @returns the closest point to position constrained by the navigation mesh
  69681. */
  69682. getRandomPointAround(position: Vector3, maxRadius: number): Vector3;
  69683. /**
  69684. * Get a navigation mesh constrained position, within a particular radius
  69685. * @param position world position
  69686. * @param maxRadius the maximum distance to the constrained world position
  69687. * @param result output the closest point to position constrained by the navigation mesh
  69688. */
  69689. getRandomPointAroundToRef(position: Vector3, maxRadius: number, result: Vector3): void;
  69690. /**
  69691. * Compute the final position from a segment made of destination-position
  69692. * @param position world position
  69693. * @param destination world position
  69694. * @returns the resulting point along the navmesh
  69695. */
  69696. moveAlong(position: Vector3, destination: Vector3): Vector3;
  69697. /**
  69698. * Compute the final position from a segment made of destination-position
  69699. * @param position world position
  69700. * @param destination world position
  69701. * @param result output the resulting point along the navmesh
  69702. */
  69703. moveAlongToRef(position: Vector3, destination: Vector3, result: Vector3): void;
  69704. /**
  69705. * Compute a navigation path from start to end. Returns an empty array if no path can be computed
  69706. * @param start world position
  69707. * @param end world position
  69708. * @returns array containing world position composing the path
  69709. */
  69710. computePath(start: Vector3, end: Vector3): Vector3[];
  69711. /**
  69712. * If this plugin is supported
  69713. * @returns true if plugin is supported
  69714. */
  69715. isSupported(): boolean;
  69716. /**
  69717. * Create a new Crowd so you can add agents
  69718. * @param maxAgents the maximum agent count in the crowd
  69719. * @param maxAgentRadius the maximum radius an agent can have
  69720. * @param scene to attach the crowd to
  69721. * @returns the crowd you can add agents to
  69722. */
  69723. createCrowd(maxAgents: number, maxAgentRadius: number, scene: Scene): ICrowd;
  69724. /**
  69725. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  69726. * The queries will try to find a solution within those bounds
  69727. * default is (1,1,1)
  69728. * @param extent x,y,z value that define the extent around the queries point of reference
  69729. */
  69730. setDefaultQueryExtent(extent: Vector3): void;
  69731. /**
  69732. * Get the Bounding box extent specified by setDefaultQueryExtent
  69733. * @returns the box extent values
  69734. */
  69735. getDefaultQueryExtent(): Vector3;
  69736. /**
  69737. * build the navmesh from a previously saved state using getNavmeshData
  69738. * @param data the Uint8Array returned by getNavmeshData
  69739. */
  69740. buildFromNavmeshData(data: Uint8Array): void;
  69741. /**
  69742. * returns the navmesh data that can be used later. The navmesh must be built before retrieving the data
  69743. * @returns data the Uint8Array that can be saved and reused
  69744. */
  69745. getNavmeshData(): Uint8Array;
  69746. /**
  69747. * Get the Bounding box extent result specified by setDefaultQueryExtent
  69748. * @param result output the box extent values
  69749. */
  69750. getDefaultQueryExtentToRef(result: Vector3): void;
  69751. /**
  69752. * Release all resources
  69753. */
  69754. dispose(): void;
  69755. }
  69756. /**
  69757. * Crowd Interface. A Crowd is a collection of moving agents constrained by a navigation mesh
  69758. */
  69759. export interface ICrowd {
  69760. /**
  69761. * Add a new agent to the crowd with the specified parameter a corresponding transformNode.
  69762. * You can attach anything to that node. The node position is updated in the scene update tick.
  69763. * @param pos world position that will be constrained by the navigation mesh
  69764. * @param parameters agent parameters
  69765. * @param transform hooked to the agent that will be update by the scene
  69766. * @returns agent index
  69767. */
  69768. addAgent(pos: Vector3, parameters: IAgentParameters, transform: TransformNode): number;
  69769. /**
  69770. * Returns the agent position in world space
  69771. * @param index agent index returned by addAgent
  69772. * @returns world space position
  69773. */
  69774. getAgentPosition(index: number): Vector3;
  69775. /**
  69776. * Gets the agent position result in world space
  69777. * @param index agent index returned by addAgent
  69778. * @param result output world space position
  69779. */
  69780. getAgentPositionToRef(index: number, result: Vector3): void;
  69781. /**
  69782. * Gets the agent velocity in world space
  69783. * @param index agent index returned by addAgent
  69784. * @returns world space velocity
  69785. */
  69786. getAgentVelocity(index: number): Vector3;
  69787. /**
  69788. * Gets the agent velocity result in world space
  69789. * @param index agent index returned by addAgent
  69790. * @param result output world space velocity
  69791. */
  69792. getAgentVelocityToRef(index: number, result: Vector3): void;
  69793. /**
  69794. * remove a particular agent previously created
  69795. * @param index agent index returned by addAgent
  69796. */
  69797. removeAgent(index: number): void;
  69798. /**
  69799. * get the list of all agents attached to this crowd
  69800. * @returns list of agent indices
  69801. */
  69802. getAgents(): number[];
  69803. /**
  69804. * Tick update done by the Scene. Agent position/velocity/acceleration is updated by this function
  69805. * @param deltaTime in seconds
  69806. */
  69807. update(deltaTime: number): void;
  69808. /**
  69809. * Asks a particular agent to go to a destination. That destination is constrained by the navigation mesh
  69810. * @param index agent index returned by addAgent
  69811. * @param destination targeted world position
  69812. */
  69813. agentGoto(index: number, destination: Vector3): void;
  69814. /**
  69815. * Teleport the agent to a new position
  69816. * @param index agent index returned by addAgent
  69817. * @param destination targeted world position
  69818. */
  69819. agentTeleport(index: number, destination: Vector3): void;
  69820. /**
  69821. * Update agent parameters
  69822. * @param index agent index returned by addAgent
  69823. * @param parameters agent parameters
  69824. */
  69825. updateAgentParameters(index: number, parameters: IAgentParameters): void;
  69826. /**
  69827. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  69828. * The queries will try to find a solution within those bounds
  69829. * default is (1,1,1)
  69830. * @param extent x,y,z value that define the extent around the queries point of reference
  69831. */
  69832. setDefaultQueryExtent(extent: Vector3): void;
  69833. /**
  69834. * Get the Bounding box extent specified by setDefaultQueryExtent
  69835. * @returns the box extent values
  69836. */
  69837. getDefaultQueryExtent(): Vector3;
  69838. /**
  69839. * Get the Bounding box extent result specified by setDefaultQueryExtent
  69840. * @param result output the box extent values
  69841. */
  69842. getDefaultQueryExtentToRef(result: Vector3): void;
  69843. /**
  69844. * Release all resources
  69845. */
  69846. dispose(): void;
  69847. }
  69848. /**
  69849. * Configures an agent
  69850. */
  69851. export interface IAgentParameters {
  69852. /**
  69853. * Agent radius. [Limit: >= 0]
  69854. */
  69855. radius: number;
  69856. /**
  69857. * Agent height. [Limit: > 0]
  69858. */
  69859. height: number;
  69860. /**
  69861. * Maximum allowed acceleration. [Limit: >= 0]
  69862. */
  69863. maxAcceleration: number;
  69864. /**
  69865. * Maximum allowed speed. [Limit: >= 0]
  69866. */
  69867. maxSpeed: number;
  69868. /**
  69869. * Defines how close a collision element must be before it is considered for steering behaviors. [Limits: > 0]
  69870. */
  69871. collisionQueryRange: number;
  69872. /**
  69873. * The path visibility optimization range. [Limit: > 0]
  69874. */
  69875. pathOptimizationRange: number;
  69876. /**
  69877. * How aggresive the agent manager should be at avoiding collisions with this agent. [Limit: >= 0]
  69878. */
  69879. separationWeight: number;
  69880. }
  69881. /**
  69882. * Configures the navigation mesh creation
  69883. */
  69884. export interface INavMeshParameters {
  69885. /**
  69886. * The xz-plane cell size to use for fields. [Limit: > 0] [Units: wu]
  69887. */
  69888. cs: number;
  69889. /**
  69890. * The y-axis cell size to use for fields. [Limit: > 0] [Units: wu]
  69891. */
  69892. ch: number;
  69893. /**
  69894. * The maximum slope that is considered walkable. [Limits: 0 <= value < 90] [Units: Degrees]
  69895. */
  69896. walkableSlopeAngle: number;
  69897. /**
  69898. * Minimum floor to 'ceiling' height that will still allow the floor area to
  69899. * be considered walkable. [Limit: >= 3] [Units: vx]
  69900. */
  69901. walkableHeight: number;
  69902. /**
  69903. * Maximum ledge height that is considered to still be traversable. [Limit: >=0] [Units: vx]
  69904. */
  69905. walkableClimb: number;
  69906. /**
  69907. * The distance to erode/shrink the walkable area of the heightfield away from
  69908. * obstructions. [Limit: >=0] [Units: vx]
  69909. */
  69910. walkableRadius: number;
  69911. /**
  69912. * The maximum allowed length for contour edges along the border of the mesh. [Limit: >=0] [Units: vx]
  69913. */
  69914. maxEdgeLen: number;
  69915. /**
  69916. * The maximum distance a simplfied contour's border edges should deviate
  69917. * the original raw contour. [Limit: >=0] [Units: vx]
  69918. */
  69919. maxSimplificationError: number;
  69920. /**
  69921. * The minimum number of cells allowed to form isolated island areas. [Limit: >=0] [Units: vx]
  69922. */
  69923. minRegionArea: number;
  69924. /**
  69925. * Any regions with a span count smaller than this value will, if possible,
  69926. * be merged with larger regions. [Limit: >=0] [Units: vx]
  69927. */
  69928. mergeRegionArea: number;
  69929. /**
  69930. * The maximum number of vertices allowed for polygons generated during the
  69931. * contour to polygon conversion process. [Limit: >= 3]
  69932. */
  69933. maxVertsPerPoly: number;
  69934. /**
  69935. * Sets the sampling distance to use when generating the detail mesh.
  69936. * (For height detail only.) [Limits: 0 or >= 0.9] [Units: wu]
  69937. */
  69938. detailSampleDist: number;
  69939. /**
  69940. * The maximum distance the detail mesh surface should deviate from heightfield
  69941. * data. (For height detail only.) [Limit: >=0] [Units: wu]
  69942. */
  69943. detailSampleMaxError: number;
  69944. }
  69945. }
  69946. declare module "babylonjs/Navigation/Plugins/recastJSPlugin" {
  69947. import { INavigationEnginePlugin, ICrowd, IAgentParameters, INavMeshParameters } from "babylonjs/Navigation/INavigationEngine";
  69948. import { Mesh } from "babylonjs/Meshes/mesh";
  69949. import { Scene } from "babylonjs/scene";
  69950. import { Vector3 } from "babylonjs/Maths/math";
  69951. import { TransformNode } from "babylonjs/Meshes/transformNode";
  69952. /**
  69953. * RecastJS navigation plugin
  69954. */
  69955. export class RecastJSPlugin implements INavigationEnginePlugin {
  69956. /**
  69957. * Reference to the Recast library
  69958. */
  69959. bjsRECAST: any;
  69960. /**
  69961. * plugin name
  69962. */
  69963. name: string;
  69964. /**
  69965. * the first navmesh created. We might extend this to support multiple navmeshes
  69966. */
  69967. navMesh: any;
  69968. /**
  69969. * Initializes the recastJS plugin
  69970. * @param recastInjection can be used to inject your own recast reference
  69971. */
  69972. constructor(recastInjection?: any);
  69973. /**
  69974. * Creates a navigation mesh
  69975. * @param meshes array of all the geometry used to compute the navigatio mesh
  69976. * @param parameters bunch of parameters used to filter geometry
  69977. */
  69978. createNavMesh(meshes: Array<Mesh>, parameters: INavMeshParameters): void;
  69979. /**
  69980. * Create a navigation mesh debug mesh
  69981. * @param scene is where the mesh will be added
  69982. * @returns debug display mesh
  69983. */
  69984. createDebugNavMesh(scene: Scene): Mesh;
  69985. /**
  69986. * Get a navigation mesh constrained position, closest to the parameter position
  69987. * @param position world position
  69988. * @returns the closest point to position constrained by the navigation mesh
  69989. */
  69990. getClosestPoint(position: Vector3): Vector3;
  69991. /**
  69992. * Get a navigation mesh constrained position, closest to the parameter position
  69993. * @param position world position
  69994. * @param result output the closest point to position constrained by the navigation mesh
  69995. */
  69996. getClosestPointToRef(position: Vector3, result: Vector3): void;
  69997. /**
  69998. * Get a navigation mesh constrained position, within a particular radius
  69999. * @param position world position
  70000. * @param maxRadius the maximum distance to the constrained world position
  70001. * @returns the closest point to position constrained by the navigation mesh
  70002. */
  70003. getRandomPointAround(position: Vector3, maxRadius: number): Vector3;
  70004. /**
  70005. * Get a navigation mesh constrained position, within a particular radius
  70006. * @param position world position
  70007. * @param maxRadius the maximum distance to the constrained world position
  70008. * @param result output the closest point to position constrained by the navigation mesh
  70009. */
  70010. getRandomPointAroundToRef(position: Vector3, maxRadius: number, result: Vector3): void;
  70011. /**
  70012. * Compute the final position from a segment made of destination-position
  70013. * @param position world position
  70014. * @param destination world position
  70015. * @returns the resulting point along the navmesh
  70016. */
  70017. moveAlong(position: Vector3, destination: Vector3): Vector3;
  70018. /**
  70019. * Compute the final position from a segment made of destination-position
  70020. * @param position world position
  70021. * @param destination world position
  70022. * @param result output the resulting point along the navmesh
  70023. */
  70024. moveAlongToRef(position: Vector3, destination: Vector3, result: Vector3): void;
  70025. /**
  70026. * Compute a navigation path from start to end. Returns an empty array if no path can be computed
  70027. * @param start world position
  70028. * @param end world position
  70029. * @returns array containing world position composing the path
  70030. */
  70031. computePath(start: Vector3, end: Vector3): Vector3[];
  70032. /**
  70033. * Create a new Crowd so you can add agents
  70034. * @param maxAgents the maximum agent count in the crowd
  70035. * @param maxAgentRadius the maximum radius an agent can have
  70036. * @param scene to attach the crowd to
  70037. * @returns the crowd you can add agents to
  70038. */
  70039. createCrowd(maxAgents: number, maxAgentRadius: number, scene: Scene): ICrowd;
  70040. /**
  70041. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  70042. * The queries will try to find a solution within those bounds
  70043. * default is (1,1,1)
  70044. * @param extent x,y,z value that define the extent around the queries point of reference
  70045. */
  70046. setDefaultQueryExtent(extent: Vector3): void;
  70047. /**
  70048. * Get the Bounding box extent specified by setDefaultQueryExtent
  70049. * @returns the box extent values
  70050. */
  70051. getDefaultQueryExtent(): Vector3;
  70052. /**
  70053. * build the navmesh from a previously saved state using getNavmeshData
  70054. * @param data the Uint8Array returned by getNavmeshData
  70055. */
  70056. buildFromNavmeshData(data: Uint8Array): void;
  70057. /**
  70058. * returns the navmesh data that can be used later. The navmesh must be built before retrieving the data
  70059. * @returns data the Uint8Array that can be saved and reused
  70060. */
  70061. getNavmeshData(): Uint8Array;
  70062. /**
  70063. * Get the Bounding box extent result specified by setDefaultQueryExtent
  70064. * @param result output the box extent values
  70065. */
  70066. getDefaultQueryExtentToRef(result: Vector3): void;
  70067. /**
  70068. * Disposes
  70069. */
  70070. dispose(): void;
  70071. /**
  70072. * If this plugin is supported
  70073. * @returns true if plugin is supported
  70074. */
  70075. isSupported(): boolean;
  70076. }
  70077. /**
  70078. * Recast detour crowd implementation
  70079. */
  70080. export class RecastJSCrowd implements ICrowd {
  70081. /**
  70082. * Recast/detour plugin
  70083. */
  70084. bjsRECASTPlugin: RecastJSPlugin;
  70085. /**
  70086. * Link to the detour crowd
  70087. */
  70088. recastCrowd: any;
  70089. /**
  70090. * One transform per agent
  70091. */
  70092. transforms: TransformNode[];
  70093. /**
  70094. * All agents created
  70095. */
  70096. agents: number[];
  70097. /**
  70098. * Link to the scene is kept to unregister the crowd from the scene
  70099. */
  70100. private _scene;
  70101. /**
  70102. * Observer for crowd updates
  70103. */
  70104. private _onBeforeAnimationsObserver;
  70105. /**
  70106. * Constructor
  70107. * @param plugin recastJS plugin
  70108. * @param maxAgents the maximum agent count in the crowd
  70109. * @param maxAgentRadius the maximum radius an agent can have
  70110. * @param scene to attach the crowd to
  70111. * @returns the crowd you can add agents to
  70112. */
  70113. constructor(plugin: RecastJSPlugin, maxAgents: number, maxAgentRadius: number, scene: Scene);
  70114. /**
  70115. * Add a new agent to the crowd with the specified parameter a corresponding transformNode.
  70116. * You can attach anything to that node. The node position is updated in the scene update tick.
  70117. * @param pos world position that will be constrained by the navigation mesh
  70118. * @param parameters agent parameters
  70119. * @param transform hooked to the agent that will be update by the scene
  70120. * @returns agent index
  70121. */
  70122. addAgent(pos: Vector3, parameters: IAgentParameters, transform: TransformNode): number;
  70123. /**
  70124. * Returns the agent position in world space
  70125. * @param index agent index returned by addAgent
  70126. * @returns world space position
  70127. */
  70128. getAgentPosition(index: number): Vector3;
  70129. /**
  70130. * Returns the agent position result in world space
  70131. * @param index agent index returned by addAgent
  70132. * @param result output world space position
  70133. */
  70134. getAgentPositionToRef(index: number, result: Vector3): void;
  70135. /**
  70136. * Returns the agent velocity in world space
  70137. * @param index agent index returned by addAgent
  70138. * @returns world space velocity
  70139. */
  70140. getAgentVelocity(index: number): Vector3;
  70141. /**
  70142. * Returns the agent velocity result in world space
  70143. * @param index agent index returned by addAgent
  70144. * @param result output world space velocity
  70145. */
  70146. getAgentVelocityToRef(index: number, result: Vector3): void;
  70147. /**
  70148. * Asks a particular agent to go to a destination. That destination is constrained by the navigation mesh
  70149. * @param index agent index returned by addAgent
  70150. * @param destination targeted world position
  70151. */
  70152. agentGoto(index: number, destination: Vector3): void;
  70153. /**
  70154. * Teleport the agent to a new position
  70155. * @param index agent index returned by addAgent
  70156. * @param destination targeted world position
  70157. */
  70158. agentTeleport(index: number, destination: Vector3): void;
  70159. /**
  70160. * Update agent parameters
  70161. * @param index agent index returned by addAgent
  70162. * @param parameters agent parameters
  70163. */
  70164. updateAgentParameters(index: number, parameters: IAgentParameters): void;
  70165. /**
  70166. * remove a particular agent previously created
  70167. * @param index agent index returned by addAgent
  70168. */
  70169. removeAgent(index: number): void;
  70170. /**
  70171. * get the list of all agents attached to this crowd
  70172. * @returns list of agent indices
  70173. */
  70174. getAgents(): number[];
  70175. /**
  70176. * Tick update done by the Scene. Agent position/velocity/acceleration is updated by this function
  70177. * @param deltaTime in seconds
  70178. */
  70179. update(deltaTime: number): void;
  70180. /**
  70181. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  70182. * The queries will try to find a solution within those bounds
  70183. * default is (1,1,1)
  70184. * @param extent x,y,z value that define the extent around the queries point of reference
  70185. */
  70186. setDefaultQueryExtent(extent: Vector3): void;
  70187. /**
  70188. * Get the Bounding box extent specified by setDefaultQueryExtent
  70189. * @returns the box extent values
  70190. */
  70191. getDefaultQueryExtent(): Vector3;
  70192. /**
  70193. * Get the Bounding box extent result specified by setDefaultQueryExtent
  70194. * @param result output the box extent values
  70195. */
  70196. getDefaultQueryExtentToRef(result: Vector3): void;
  70197. /**
  70198. * Release all resources
  70199. */
  70200. dispose(): void;
  70201. }
  70202. }
  70203. declare module "babylonjs/Navigation/Plugins/index" {
  70204. export * from "babylonjs/Navigation/Plugins/recastJSPlugin";
  70205. }
  70206. declare module "babylonjs/Navigation/index" {
  70207. export * from "babylonjs/Navigation/INavigationEngine";
  70208. export * from "babylonjs/Navigation/Plugins/index";
  70209. }
  70210. declare module "babylonjs/Offline/database" {
  70211. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  70212. /**
  70213. * Class used to enable access to IndexedDB
  70214. * @see https://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  70215. */
  70216. export class Database implements IOfflineProvider {
  70217. private _callbackManifestChecked;
  70218. private _currentSceneUrl;
  70219. private _db;
  70220. private _enableSceneOffline;
  70221. private _enableTexturesOffline;
  70222. private _manifestVersionFound;
  70223. private _mustUpdateRessources;
  70224. private _hasReachedQuota;
  70225. private _isSupported;
  70226. private _idbFactory;
  70227. /** Gets a boolean indicating if the user agent supports blob storage (this value will be updated after creating the first Database object) */
  70228. private static IsUASupportingBlobStorage;
  70229. /**
  70230. * Gets a boolean indicating if Database storate is enabled (off by default)
  70231. */
  70232. static IDBStorageEnabled: boolean;
  70233. /**
  70234. * Gets a boolean indicating if scene must be saved in the database
  70235. */
  70236. get enableSceneOffline(): boolean;
  70237. /**
  70238. * Gets a boolean indicating if textures must be saved in the database
  70239. */
  70240. get enableTexturesOffline(): boolean;
  70241. /**
  70242. * Creates a new Database
  70243. * @param urlToScene defines the url to load the scene
  70244. * @param callbackManifestChecked defines the callback to use when manifest is checked
  70245. * @param disableManifestCheck defines a boolean indicating that we want to skip the manifest validation (it will be considered validated and up to date)
  70246. */
  70247. constructor(urlToScene: string, callbackManifestChecked: (checked: boolean) => any, disableManifestCheck?: boolean);
  70248. private static _ParseURL;
  70249. private static _ReturnFullUrlLocation;
  70250. private _checkManifestFile;
  70251. /**
  70252. * Open the database and make it available
  70253. * @param successCallback defines the callback to call on success
  70254. * @param errorCallback defines the callback to call on error
  70255. */
  70256. open(successCallback: () => void, errorCallback: () => void): void;
  70257. /**
  70258. * Loads an image from the database
  70259. * @param url defines the url to load from
  70260. * @param image defines the target DOM image
  70261. */
  70262. loadImage(url: string, image: HTMLImageElement): void;
  70263. private _loadImageFromDBAsync;
  70264. private _saveImageIntoDBAsync;
  70265. private _checkVersionFromDB;
  70266. private _loadVersionFromDBAsync;
  70267. private _saveVersionIntoDBAsync;
  70268. /**
  70269. * Loads a file from database
  70270. * @param url defines the URL to load from
  70271. * @param sceneLoaded defines a callback to call on success
  70272. * @param progressCallBack defines a callback to call when progress changed
  70273. * @param errorCallback defines a callback to call on error
  70274. * @param useArrayBuffer defines a boolean to use array buffer instead of text string
  70275. */
  70276. loadFile(url: string, sceneLoaded: (data: any) => void, progressCallBack?: (data: any) => void, errorCallback?: () => void, useArrayBuffer?: boolean): void;
  70277. private _loadFileAsync;
  70278. private _saveFileAsync;
  70279. /**
  70280. * Validates if xhr data is correct
  70281. * @param xhr defines the request to validate
  70282. * @param dataType defines the expected data type
  70283. * @returns true if data is correct
  70284. */
  70285. private static _ValidateXHRData;
  70286. }
  70287. }
  70288. declare module "babylonjs/Offline/index" {
  70289. export * from "babylonjs/Offline/database";
  70290. export * from "babylonjs/Offline/IOfflineProvider";
  70291. }
  70292. declare module "babylonjs/Shaders/gpuUpdateParticles.fragment" {
  70293. /** @hidden */
  70294. export var gpuUpdateParticlesPixelShader: {
  70295. name: string;
  70296. shader: string;
  70297. };
  70298. }
  70299. declare module "babylonjs/Shaders/gpuUpdateParticles.vertex" {
  70300. /** @hidden */
  70301. export var gpuUpdateParticlesVertexShader: {
  70302. name: string;
  70303. shader: string;
  70304. };
  70305. }
  70306. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration2" {
  70307. /** @hidden */
  70308. export var clipPlaneFragmentDeclaration2: {
  70309. name: string;
  70310. shader: string;
  70311. };
  70312. }
  70313. declare module "babylonjs/Shaders/gpuRenderParticles.fragment" {
  70314. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration2";
  70315. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  70316. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  70317. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  70318. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  70319. /** @hidden */
  70320. export var gpuRenderParticlesPixelShader: {
  70321. name: string;
  70322. shader: string;
  70323. };
  70324. }
  70325. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration2" {
  70326. /** @hidden */
  70327. export var clipPlaneVertexDeclaration2: {
  70328. name: string;
  70329. shader: string;
  70330. };
  70331. }
  70332. declare module "babylonjs/Shaders/gpuRenderParticles.vertex" {
  70333. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration2";
  70334. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  70335. /** @hidden */
  70336. export var gpuRenderParticlesVertexShader: {
  70337. name: string;
  70338. shader: string;
  70339. };
  70340. }
  70341. declare module "babylonjs/Particles/gpuParticleSystem" {
  70342. import { Nullable } from "babylonjs/types";
  70343. import { Color3Gradient, IValueGradient } from "babylonjs/Misc/gradients";
  70344. import { Observable } from "babylonjs/Misc/observable";
  70345. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  70346. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  70347. import { BaseParticleSystem } from "babylonjs/Particles/baseParticleSystem";
  70348. import { Scene, IDisposable } from "babylonjs/scene";
  70349. import { Effect } from "babylonjs/Materials/effect";
  70350. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  70351. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  70352. import "babylonjs/Shaders/gpuUpdateParticles.fragment";
  70353. import "babylonjs/Shaders/gpuUpdateParticles.vertex";
  70354. import "babylonjs/Shaders/gpuRenderParticles.fragment";
  70355. import "babylonjs/Shaders/gpuRenderParticles.vertex";
  70356. /**
  70357. * This represents a GPU particle system in Babylon
  70358. * This is the fastest particle system in Babylon as it uses the GPU to update the individual particle data
  70359. * @see https://www.babylonjs-playground.com/#PU4WYI#4
  70360. */
  70361. export class GPUParticleSystem extends BaseParticleSystem implements IDisposable, IParticleSystem, IAnimatable {
  70362. /**
  70363. * The layer mask we are rendering the particles through.
  70364. */
  70365. layerMask: number;
  70366. private _capacity;
  70367. private _activeCount;
  70368. private _currentActiveCount;
  70369. private _accumulatedCount;
  70370. private _renderEffect;
  70371. private _updateEffect;
  70372. private _buffer0;
  70373. private _buffer1;
  70374. private _spriteBuffer;
  70375. private _updateVAO;
  70376. private _renderVAO;
  70377. private _targetIndex;
  70378. private _sourceBuffer;
  70379. private _targetBuffer;
  70380. private _engine;
  70381. private _currentRenderId;
  70382. private _started;
  70383. private _stopped;
  70384. private _timeDelta;
  70385. private _randomTexture;
  70386. private _randomTexture2;
  70387. private _attributesStrideSize;
  70388. private _updateEffectOptions;
  70389. private _randomTextureSize;
  70390. private _actualFrame;
  70391. private _customEffect;
  70392. private readonly _rawTextureWidth;
  70393. /**
  70394. * Gets a boolean indicating if the GPU particles can be rendered on current browser
  70395. */
  70396. static get IsSupported(): boolean;
  70397. /**
  70398. * An event triggered when the system is disposed.
  70399. */
  70400. onDisposeObservable: Observable<IParticleSystem>;
  70401. /**
  70402. * Gets the maximum number of particles active at the same time.
  70403. * @returns The max number of active particles.
  70404. */
  70405. getCapacity(): number;
  70406. /**
  70407. * Forces the particle to write their depth information to the depth buffer. This can help preventing other draw calls
  70408. * to override the particles.
  70409. */
  70410. forceDepthWrite: boolean;
  70411. /**
  70412. * Gets or set the number of active particles
  70413. */
  70414. get activeParticleCount(): number;
  70415. set activeParticleCount(value: number);
  70416. private _preWarmDone;
  70417. /**
  70418. * Specifies if the particles are updated in emitter local space or world space.
  70419. */
  70420. isLocal: boolean;
  70421. /**
  70422. * Is this system ready to be used/rendered
  70423. * @return true if the system is ready
  70424. */
  70425. isReady(): boolean;
  70426. /**
  70427. * Gets if the system has been started. (Note: this will still be true after stop is called)
  70428. * @returns True if it has been started, otherwise false.
  70429. */
  70430. isStarted(): boolean;
  70431. /**
  70432. * Gets if the system has been stopped. (Note: rendering is still happening but the system is frozen)
  70433. * @returns True if it has been stopped, otherwise false.
  70434. */
  70435. isStopped(): boolean;
  70436. /**
  70437. * Gets a boolean indicating that the system is stopping
  70438. * @returns true if the system is currently stopping
  70439. */
  70440. isStopping(): boolean;
  70441. /**
  70442. * Gets the number of particles active at the same time.
  70443. * @returns The number of active particles.
  70444. */
  70445. getActiveCount(): number;
  70446. /**
  70447. * Starts the particle system and begins to emit
  70448. * @param delay defines the delay in milliseconds before starting the system (this.startDelay by default)
  70449. */
  70450. start(delay?: number): void;
  70451. /**
  70452. * Stops the particle system.
  70453. */
  70454. stop(): void;
  70455. /**
  70456. * Remove all active particles
  70457. */
  70458. reset(): void;
  70459. /**
  70460. * Returns the string "GPUParticleSystem"
  70461. * @returns a string containing the class name
  70462. */
  70463. getClassName(): string;
  70464. /**
  70465. * Gets the custom effect used to render the particles
  70466. * @param blendMode Blend mode for which the effect should be retrieved
  70467. * @returns The effect
  70468. */
  70469. getCustomEffect(blendMode?: number): Nullable<Effect>;
  70470. /**
  70471. * Sets the custom effect used to render the particles
  70472. * @param effect The effect to set
  70473. * @param blendMode Blend mode for which the effect should be set
  70474. */
  70475. setCustomEffect(effect: Nullable<Effect>, blendMode?: number): void;
  70476. /** @hidden */
  70477. protected _onBeforeDrawParticlesObservable: Nullable<Observable<Nullable<Effect>>>;
  70478. /**
  70479. * Observable that will be called just before the particles are drawn
  70480. */
  70481. get onBeforeDrawParticlesObservable(): Observable<Nullable<Effect>>;
  70482. /**
  70483. * Gets the name of the particle vertex shader
  70484. */
  70485. get vertexShaderName(): string;
  70486. private _colorGradientsTexture;
  70487. protected _removeGradientAndTexture(gradient: number, gradients: Nullable<IValueGradient[]>, texture: RawTexture): BaseParticleSystem;
  70488. /**
  70489. * Adds a new color gradient
  70490. * @param gradient defines the gradient to use (between 0 and 1)
  70491. * @param color1 defines the color to affect to the specified gradient
  70492. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  70493. * @returns the current particle system
  70494. */
  70495. addColorGradient(gradient: number, color1: Color4, color2?: Color4): GPUParticleSystem;
  70496. private _refreshColorGradient;
  70497. /** Force the system to rebuild all gradients that need to be resync */
  70498. forceRefreshGradients(): void;
  70499. /**
  70500. * Remove a specific color gradient
  70501. * @param gradient defines the gradient to remove
  70502. * @returns the current particle system
  70503. */
  70504. removeColorGradient(gradient: number): GPUParticleSystem;
  70505. private _angularSpeedGradientsTexture;
  70506. private _sizeGradientsTexture;
  70507. private _velocityGradientsTexture;
  70508. private _limitVelocityGradientsTexture;
  70509. private _dragGradientsTexture;
  70510. private _addFactorGradient;
  70511. /**
  70512. * Adds a new size gradient
  70513. * @param gradient defines the gradient to use (between 0 and 1)
  70514. * @param factor defines the size factor to affect to the specified gradient
  70515. * @returns the current particle system
  70516. */
  70517. addSizeGradient(gradient: number, factor: number): GPUParticleSystem;
  70518. /**
  70519. * Remove a specific size gradient
  70520. * @param gradient defines the gradient to remove
  70521. * @returns the current particle system
  70522. */
  70523. removeSizeGradient(gradient: number): GPUParticleSystem;
  70524. private _refreshFactorGradient;
  70525. /**
  70526. * Adds a new angular speed gradient
  70527. * @param gradient defines the gradient to use (between 0 and 1)
  70528. * @param factor defines the angular speed to affect to the specified gradient
  70529. * @returns the current particle system
  70530. */
  70531. addAngularSpeedGradient(gradient: number, factor: number): GPUParticleSystem;
  70532. /**
  70533. * Remove a specific angular speed gradient
  70534. * @param gradient defines the gradient to remove
  70535. * @returns the current particle system
  70536. */
  70537. removeAngularSpeedGradient(gradient: number): GPUParticleSystem;
  70538. /**
  70539. * Adds a new velocity gradient
  70540. * @param gradient defines the gradient to use (between 0 and 1)
  70541. * @param factor defines the velocity to affect to the specified gradient
  70542. * @returns the current particle system
  70543. */
  70544. addVelocityGradient(gradient: number, factor: number): GPUParticleSystem;
  70545. /**
  70546. * Remove a specific velocity gradient
  70547. * @param gradient defines the gradient to remove
  70548. * @returns the current particle system
  70549. */
  70550. removeVelocityGradient(gradient: number): GPUParticleSystem;
  70551. /**
  70552. * Adds a new limit velocity gradient
  70553. * @param gradient defines the gradient to use (between 0 and 1)
  70554. * @param factor defines the limit velocity value to affect to the specified gradient
  70555. * @returns the current particle system
  70556. */
  70557. addLimitVelocityGradient(gradient: number, factor: number): GPUParticleSystem;
  70558. /**
  70559. * Remove a specific limit velocity gradient
  70560. * @param gradient defines the gradient to remove
  70561. * @returns the current particle system
  70562. */
  70563. removeLimitVelocityGradient(gradient: number): GPUParticleSystem;
  70564. /**
  70565. * Adds a new drag gradient
  70566. * @param gradient defines the gradient to use (between 0 and 1)
  70567. * @param factor defines the drag value to affect to the specified gradient
  70568. * @returns the current particle system
  70569. */
  70570. addDragGradient(gradient: number, factor: number): GPUParticleSystem;
  70571. /**
  70572. * Remove a specific drag gradient
  70573. * @param gradient defines the gradient to remove
  70574. * @returns the current particle system
  70575. */
  70576. removeDragGradient(gradient: number): GPUParticleSystem;
  70577. /**
  70578. * Not supported by GPUParticleSystem
  70579. * @param gradient defines the gradient to use (between 0 and 1)
  70580. * @param factor defines the emit rate value to affect to the specified gradient
  70581. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  70582. * @returns the current particle system
  70583. */
  70584. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  70585. /**
  70586. * Not supported by GPUParticleSystem
  70587. * @param gradient defines the gradient to remove
  70588. * @returns the current particle system
  70589. */
  70590. removeEmitRateGradient(gradient: number): IParticleSystem;
  70591. /**
  70592. * Not supported by GPUParticleSystem
  70593. * @param gradient defines the gradient to use (between 0 and 1)
  70594. * @param factor defines the start size value to affect to the specified gradient
  70595. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  70596. * @returns the current particle system
  70597. */
  70598. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  70599. /**
  70600. * Not supported by GPUParticleSystem
  70601. * @param gradient defines the gradient to remove
  70602. * @returns the current particle system
  70603. */
  70604. removeStartSizeGradient(gradient: number): IParticleSystem;
  70605. /**
  70606. * Not supported by GPUParticleSystem
  70607. * @param gradient defines the gradient to use (between 0 and 1)
  70608. * @param min defines the color remap minimal range
  70609. * @param max defines the color remap maximal range
  70610. * @returns the current particle system
  70611. */
  70612. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  70613. /**
  70614. * Not supported by GPUParticleSystem
  70615. * @param gradient defines the gradient to remove
  70616. * @returns the current particle system
  70617. */
  70618. removeColorRemapGradient(): IParticleSystem;
  70619. /**
  70620. * Not supported by GPUParticleSystem
  70621. * @param gradient defines the gradient to use (between 0 and 1)
  70622. * @param min defines the alpha remap minimal range
  70623. * @param max defines the alpha remap maximal range
  70624. * @returns the current particle system
  70625. */
  70626. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  70627. /**
  70628. * Not supported by GPUParticleSystem
  70629. * @param gradient defines the gradient to remove
  70630. * @returns the current particle system
  70631. */
  70632. removeAlphaRemapGradient(): IParticleSystem;
  70633. /**
  70634. * Not supported by GPUParticleSystem
  70635. * @param gradient defines the gradient to use (between 0 and 1)
  70636. * @param color defines the color to affect to the specified gradient
  70637. * @returns the current particle system
  70638. */
  70639. addRampGradient(gradient: number, color: Color3): IParticleSystem;
  70640. /**
  70641. * Not supported by GPUParticleSystem
  70642. * @param gradient defines the gradient to remove
  70643. * @returns the current particle system
  70644. */
  70645. removeRampGradient(): IParticleSystem;
  70646. /**
  70647. * Not supported by GPUParticleSystem
  70648. * @returns the list of ramp gradients
  70649. */
  70650. getRampGradients(): Nullable<Array<Color3Gradient>>;
  70651. /**
  70652. * Not supported by GPUParticleSystem
  70653. * Gets or sets a boolean indicating that ramp gradients must be used
  70654. * @see https://doc.babylonjs.com/babylon101/particles#ramp-gradients
  70655. */
  70656. get useRampGradients(): boolean;
  70657. set useRampGradients(value: boolean);
  70658. /**
  70659. * Not supported by GPUParticleSystem
  70660. * @param gradient defines the gradient to use (between 0 and 1)
  70661. * @param factor defines the life time factor to affect to the specified gradient
  70662. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  70663. * @returns the current particle system
  70664. */
  70665. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  70666. /**
  70667. * Not supported by GPUParticleSystem
  70668. * @param gradient defines the gradient to remove
  70669. * @returns the current particle system
  70670. */
  70671. removeLifeTimeGradient(gradient: number): IParticleSystem;
  70672. /**
  70673. * Instantiates a GPU particle system.
  70674. * 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.
  70675. * @param name The name of the particle system
  70676. * @param options The options used to create the system
  70677. * @param scene The scene the particle system belongs to
  70678. * @param isAnimationSheetEnabled Must be true if using a spritesheet to animate the particles texture
  70679. * @param customEffect a custom effect used to change the way particles are rendered by default
  70680. */
  70681. constructor(name: string, options: Partial<{
  70682. capacity: number;
  70683. randomTextureSize: number;
  70684. }>, scene: Scene, isAnimationSheetEnabled?: boolean, customEffect?: Nullable<Effect>);
  70685. protected _reset(): void;
  70686. private _createUpdateVAO;
  70687. private _createRenderVAO;
  70688. private _initialize;
  70689. /** @hidden */
  70690. _recreateUpdateEffect(): void;
  70691. private _getEffect;
  70692. /**
  70693. * Fill the defines array according to the current settings of the particle system
  70694. * @param defines Array to be updated
  70695. * @param blendMode blend mode to take into account when updating the array
  70696. */
  70697. fillDefines(defines: Array<string>, blendMode?: number): void;
  70698. /**
  70699. * Fill the uniforms, attributes and samplers arrays according to the current settings of the particle system
  70700. * @param uniforms Uniforms array to fill
  70701. * @param attributes Attributes array to fill
  70702. * @param samplers Samplers array to fill
  70703. */
  70704. fillUniformsAttributesAndSamplerNames(uniforms: Array<string>, attributes: Array<string>, samplers: Array<string>): void;
  70705. /** @hidden */
  70706. _recreateRenderEffect(): Effect;
  70707. /**
  70708. * Animates the particle system for the current frame by emitting new particles and or animating the living ones.
  70709. * @param preWarm defines if we are in the pre-warmimg phase
  70710. */
  70711. animate(preWarm?: boolean): void;
  70712. private _createFactorGradientTexture;
  70713. private _createSizeGradientTexture;
  70714. private _createAngularSpeedGradientTexture;
  70715. private _createVelocityGradientTexture;
  70716. private _createLimitVelocityGradientTexture;
  70717. private _createDragGradientTexture;
  70718. private _createColorGradientTexture;
  70719. /**
  70720. * Renders the particle system in its current state
  70721. * @param preWarm defines if the system should only update the particles but not render them
  70722. * @returns the current number of particles
  70723. */
  70724. render(preWarm?: boolean): number;
  70725. /**
  70726. * Rebuilds the particle system
  70727. */
  70728. rebuild(): void;
  70729. private _releaseBuffers;
  70730. private _releaseVAOs;
  70731. /**
  70732. * Disposes the particle system and free the associated resources
  70733. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  70734. */
  70735. dispose(disposeTexture?: boolean): void;
  70736. /**
  70737. * Clones the particle system.
  70738. * @param name The name of the cloned object
  70739. * @param newEmitter The new emitter to use
  70740. * @returns the cloned particle system
  70741. */
  70742. clone(name: string, newEmitter: any): GPUParticleSystem;
  70743. /**
  70744. * Serializes the particle system to a JSON object
  70745. * @param serializeTexture defines if the texture must be serialized as well
  70746. * @returns the JSON object
  70747. */
  70748. serialize(serializeTexture?: boolean): any;
  70749. /**
  70750. * Parses a JSON object to create a GPU particle system.
  70751. * @param parsedParticleSystem The JSON object to parse
  70752. * @param scene The scene to create the particle system in
  70753. * @param rootUrl The root url to use to load external dependencies like texture
  70754. * @param doNotStart Ignore the preventAutoStart attribute and does not start
  70755. * @returns the parsed GPU particle system
  70756. */
  70757. static Parse(parsedParticleSystem: any, scene: Scene, rootUrl: string, doNotStart?: boolean): GPUParticleSystem;
  70758. }
  70759. }
  70760. declare module "babylonjs/Particles/particleSystemSet" {
  70761. import { Nullable } from "babylonjs/types";
  70762. import { Color3 } from "babylonjs/Maths/math.color";
  70763. import { TransformNode } from "babylonjs/Meshes/transformNode";
  70764. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  70765. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  70766. import { Scene, IDisposable } from "babylonjs/scene";
  70767. /**
  70768. * Represents a set of particle systems working together to create a specific effect
  70769. */
  70770. export class ParticleSystemSet implements IDisposable {
  70771. /**
  70772. * Gets or sets base Assets URL
  70773. */
  70774. static BaseAssetsUrl: string;
  70775. private _emitterCreationOptions;
  70776. private _emitterNode;
  70777. /**
  70778. * Gets the particle system list
  70779. */
  70780. systems: IParticleSystem[];
  70781. /**
  70782. * Gets the emitter node used with this set
  70783. */
  70784. get emitterNode(): Nullable<TransformNode>;
  70785. /**
  70786. * Creates a new emitter mesh as a sphere
  70787. * @param options defines the options used to create the sphere
  70788. * @param renderingGroupId defines the renderingGroupId to use for the sphere
  70789. * @param scene defines the hosting scene
  70790. */
  70791. setEmitterAsSphere(options: {
  70792. diameter: number;
  70793. segments: number;
  70794. color: Color3;
  70795. }, renderingGroupId: number, scene: Scene): void;
  70796. /**
  70797. * Starts all particle systems of the set
  70798. * @param emitter defines an optional mesh to use as emitter for the particle systems
  70799. */
  70800. start(emitter?: AbstractMesh): void;
  70801. /**
  70802. * Release all associated resources
  70803. */
  70804. dispose(): void;
  70805. /**
  70806. * Serialize the set into a JSON compatible object
  70807. * @param serializeTexture defines if the texture must be serialized as well
  70808. * @returns a JSON compatible representation of the set
  70809. */
  70810. serialize(serializeTexture?: boolean): any;
  70811. /**
  70812. * Parse a new ParticleSystemSet from a serialized source
  70813. * @param data defines a JSON compatible representation of the set
  70814. * @param scene defines the hosting scene
  70815. * @param gpu defines if we want GPU particles or CPU particles
  70816. * @returns a new ParticleSystemSet
  70817. */
  70818. static Parse(data: any, scene: Scene, gpu?: boolean): ParticleSystemSet;
  70819. }
  70820. }
  70821. declare module "babylonjs/Particles/particleHelper" {
  70822. import { Nullable } from "babylonjs/types";
  70823. import { Scene } from "babylonjs/scene";
  70824. import { Vector3 } from "babylonjs/Maths/math.vector";
  70825. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  70826. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  70827. import { ParticleSystemSet } from "babylonjs/Particles/particleSystemSet";
  70828. /**
  70829. * This class is made for on one-liner static method to help creating particle system set.
  70830. */
  70831. export class ParticleHelper {
  70832. /**
  70833. * Gets or sets base Assets URL
  70834. */
  70835. static BaseAssetsUrl: string;
  70836. /** Define the Url to load snippets */
  70837. static SnippetUrl: string;
  70838. /**
  70839. * Create a default particle system that you can tweak
  70840. * @param emitter defines the emitter to use
  70841. * @param capacity defines the system capacity (default is 500 particles)
  70842. * @param scene defines the hosting scene
  70843. * @param useGPU defines if a GPUParticleSystem must be created (default is false)
  70844. * @returns the new Particle system
  70845. */
  70846. static CreateDefault(emitter: Nullable<AbstractMesh | Vector3>, capacity?: number, scene?: Scene, useGPU?: boolean): IParticleSystem;
  70847. /**
  70848. * This is the main static method (one-liner) of this helper to create different particle systems
  70849. * @param type This string represents the type to the particle system to create
  70850. * @param scene The scene where the particle system should live
  70851. * @param gpu If the system will use gpu
  70852. * @returns the ParticleSystemSet created
  70853. */
  70854. static CreateAsync(type: string, scene: Nullable<Scene>, gpu?: boolean): Promise<ParticleSystemSet>;
  70855. /**
  70856. * Static function used to export a particle system to a ParticleSystemSet variable.
  70857. * Please note that the emitter shape is not exported
  70858. * @param systems defines the particle systems to export
  70859. * @returns the created particle system set
  70860. */
  70861. static ExportSet(systems: IParticleSystem[]): ParticleSystemSet;
  70862. /**
  70863. * Creates a particle system from a snippet saved in a remote file
  70864. * @param name defines the name of the particle system to create (can be null or empty to use the one from the json data)
  70865. * @param url defines the url to load from
  70866. * @param scene defines the hosting scene
  70867. * @param gpu If the system will use gpu
  70868. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  70869. * @returns a promise that will resolve to the new particle system
  70870. */
  70871. static ParseFromFileAsync(name: Nullable<string>, url: string, scene: Scene, gpu?: boolean, rootUrl?: string): Promise<IParticleSystem>;
  70872. /**
  70873. * Creates a particle system from a snippet saved by the particle system editor
  70874. * @param snippetId defines the snippet to load (can be set to _BLANK to create a default one)
  70875. * @param scene defines the hosting scene
  70876. * @param gpu If the system will use gpu
  70877. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  70878. * @returns a promise that will resolve to the new particle system
  70879. */
  70880. static CreateFromSnippetAsync(snippetId: string, scene: Scene, gpu?: boolean, rootUrl?: string): Promise<IParticleSystem>;
  70881. }
  70882. }
  70883. declare module "babylonjs/Particles/particleSystemComponent" {
  70884. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  70885. import { Effect } from "babylonjs/Materials/effect";
  70886. import "babylonjs/Shaders/particles.vertex";
  70887. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  70888. module "babylonjs/Engines/engine" {
  70889. interface Engine {
  70890. /**
  70891. * Create an effect to use with particle systems.
  70892. * Please note that some parameters like animation sheets or not being billboard are not supported in this configuration, except if you pass
  70893. * the particle system for which you want to create a custom effect in the last parameter
  70894. * @param fragmentName defines the base name of the effect (The name of file without .fragment.fx)
  70895. * @param uniformsNames defines a list of attribute names
  70896. * @param samplers defines an array of string used to represent textures
  70897. * @param defines defines the string containing the defines to use to compile the shaders
  70898. * @param fallbacks defines the list of potential fallbacks to use if shader conmpilation fails
  70899. * @param onCompiled defines a function to call when the effect creation is successful
  70900. * @param onError defines a function to call when the effect creation has failed
  70901. * @param particleSystem the particle system you want to create the effect for
  70902. * @returns the new Effect
  70903. */
  70904. createEffectForParticles(fragmentName: string, uniformsNames: string[], samplers: string[], defines: string, fallbacks?: EffectFallbacks, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void, particleSystem?: IParticleSystem): Effect;
  70905. }
  70906. }
  70907. module "babylonjs/Meshes/mesh" {
  70908. interface Mesh {
  70909. /**
  70910. * Returns an array populated with IParticleSystem objects whose the mesh is the emitter
  70911. * @returns an array of IParticleSystem
  70912. */
  70913. getEmittedParticleSystems(): IParticleSystem[];
  70914. /**
  70915. * Returns an array populated with IParticleSystem objects whose the mesh or its children are the emitter
  70916. * @returns an array of IParticleSystem
  70917. */
  70918. getHierarchyEmittedParticleSystems(): IParticleSystem[];
  70919. }
  70920. }
  70921. }
  70922. declare module "babylonjs/Particles/pointsCloudSystem" {
  70923. import { Color4 } from "babylonjs/Maths/math";
  70924. import { Mesh } from "babylonjs/Meshes/mesh";
  70925. import { Scene, IDisposable } from "babylonjs/scene";
  70926. import { CloudPoint } from "babylonjs/Particles/cloudPoint";
  70927. /** Defines the 4 color options */
  70928. export enum PointColor {
  70929. /** color value */
  70930. Color = 2,
  70931. /** uv value */
  70932. UV = 1,
  70933. /** random value */
  70934. Random = 0,
  70935. /** stated value */
  70936. Stated = 3
  70937. }
  70938. /**
  70939. * The PointCloudSystem (PCS) is a single updatable mesh. The points corresponding to the vertices of this big mesh.
  70940. * 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.
  70941. * The PointCloudSytem is also a particle system, with each point being a particle. It provides some methods to manage the particles.
  70942. * However it is behavior agnostic. This means it has no emitter, no particle physics, no particle recycler. You have to implement your own behavior.
  70943. *
  70944. * Full documentation here : TO BE ENTERED
  70945. */
  70946. export class PointsCloudSystem implements IDisposable {
  70947. /**
  70948. * The PCS array of cloud point objects. Just access each particle as with any classic array.
  70949. * Example : var p = SPS.particles[i];
  70950. */
  70951. particles: CloudPoint[];
  70952. /**
  70953. * The PCS total number of particles. Read only. Use PCS.counter instead if you need to set your own value.
  70954. */
  70955. nbParticles: number;
  70956. /**
  70957. * This a counter for your own usage. It's not set by any SPS functions.
  70958. */
  70959. counter: number;
  70960. /**
  70961. * The PCS name. This name is also given to the underlying mesh.
  70962. */
  70963. name: string;
  70964. /**
  70965. * The PCS mesh. It's a standard BJS Mesh, so all the methods from the Mesh class are avalaible.
  70966. */
  70967. mesh: Mesh;
  70968. /**
  70969. * This empty object is intended to store some PCS specific or temporary values in order to lower the Garbage Collector activity.
  70970. * Please read :
  70971. */
  70972. vars: any;
  70973. /**
  70974. * @hidden
  70975. */
  70976. _size: number;
  70977. private _scene;
  70978. private _promises;
  70979. private _positions;
  70980. private _indices;
  70981. private _normals;
  70982. private _colors;
  70983. private _uvs;
  70984. private _indices32;
  70985. private _positions32;
  70986. private _colors32;
  70987. private _uvs32;
  70988. private _updatable;
  70989. private _isVisibilityBoxLocked;
  70990. private _alwaysVisible;
  70991. private _groups;
  70992. private _groupCounter;
  70993. private _computeParticleColor;
  70994. private _computeParticleTexture;
  70995. private _computeParticleRotation;
  70996. private _computeBoundingBox;
  70997. private _isReady;
  70998. /**
  70999. * Creates a PCS (Points Cloud System) object
  71000. * @param name (String) is the PCS name, this will be the underlying mesh name
  71001. * @param pointSize (number) is the size for each point
  71002. * @param scene (Scene) is the scene in which the PCS is added
  71003. * @param options defines the options of the PCS e.g.
  71004. * * updatable (optional boolean, default true) : if the PCS must be updatable or immutable
  71005. */
  71006. constructor(name: string, pointSize: number, scene: Scene, options?: {
  71007. updatable?: boolean;
  71008. });
  71009. /**
  71010. * Builds the PCS underlying mesh. Returns a standard Mesh.
  71011. * If no points were added to the PCS, the returned mesh is just a single point.
  71012. * @returns a promise for the created mesh
  71013. */
  71014. buildMeshAsync(): Promise<Mesh>;
  71015. /**
  71016. * @hidden
  71017. */
  71018. private _buildMesh;
  71019. private _addParticle;
  71020. private _randomUnitVector;
  71021. private _getColorIndicesForCoord;
  71022. private _setPointsColorOrUV;
  71023. private _colorFromTexture;
  71024. private _calculateDensity;
  71025. /**
  71026. * Adds points to the PCS in random positions within a unit sphere
  71027. * @param nb (positive integer) the number of particles to be created from this model
  71028. * @param pointFunction is an optional javascript function to be called for each particle on PCS creation
  71029. * @returns the number of groups in the system
  71030. */
  71031. addPoints(nb: number, pointFunction?: any): number;
  71032. /**
  71033. * Adds points to the PCS from the surface of the model shape
  71034. * @param mesh is any Mesh object that will be used as a surface model for the points
  71035. * @param nb (positive integer) the number of particles to be created from this model
  71036. * @param colorWith determines whether a point is colored using color (default), uv, random, stated or none (invisible)
  71037. * @param color (color4) to be used when colorWith is stated or color (number) when used to specify texture position
  71038. * @param range (number from 0 to 1) to determine the variation in shape and tone for a stated color
  71039. * @returns the number of groups in the system
  71040. */
  71041. addSurfacePoints(mesh: Mesh, nb: number, colorWith?: number, color?: Color4 | number, range?: number): number;
  71042. /**
  71043. * Adds points to the PCS inside the model shape
  71044. * @param mesh is any Mesh object that will be used as a surface model for the points
  71045. * @param nb (positive integer) the number of particles to be created from this model
  71046. * @param colorWith determines whether a point is colored using color (default), uv, random, stated or none (invisible)
  71047. * @param color (color4) to be used when colorWith is stated or color (number) when used to specify texture position
  71048. * @param range (number from 0 to 1) to determine the variation in shape and tone for a stated color
  71049. * @returns the number of groups in the system
  71050. */
  71051. addVolumePoints(mesh: Mesh, nb: number, colorWith?: number, color?: Color4 | number, range?: number): number;
  71052. /**
  71053. * Sets all the particles : this method actually really updates the mesh according to the particle positions, rotations, colors, textures, etc.
  71054. * This method calls `updateParticle()` for each particle of the SPS.
  71055. * For an animated SPS, it is usually called within the render loop.
  71056. * @param start The particle index in the particle array where to start to compute the particle property values _(default 0)_
  71057. * @param end The particle index in the particle array where to stop to compute the particle property values _(default nbParticle - 1)_
  71058. * @param update If the mesh must be finally updated on this call after all the particle computations _(default true)_
  71059. * @returns the PCS.
  71060. */
  71061. setParticles(start?: number, end?: number, update?: boolean): PointsCloudSystem;
  71062. /**
  71063. * Disposes the PCS.
  71064. */
  71065. dispose(): void;
  71066. /**
  71067. * Visibilty helper : Recomputes the visible size according to the mesh bounding box
  71068. * doc :
  71069. * @returns the PCS.
  71070. */
  71071. refreshVisibleSize(): PointsCloudSystem;
  71072. /**
  71073. * Visibility helper : Sets the size of a visibility box, this sets the underlying mesh bounding box.
  71074. * @param size the size (float) of the visibility box
  71075. * note : this doesn't lock the PCS mesh bounding box.
  71076. * doc :
  71077. */
  71078. setVisibilityBox(size: number): void;
  71079. /**
  71080. * Gets whether the PCS is always visible or not
  71081. * doc :
  71082. */
  71083. get isAlwaysVisible(): boolean;
  71084. /**
  71085. * Sets the PCS as always visible or not
  71086. * doc :
  71087. */
  71088. set isAlwaysVisible(val: boolean);
  71089. /**
  71090. * Tells to `setParticles()` to compute the particle rotations or not
  71091. * Default value : false. The PCS is faster when it's set to false
  71092. * Note : particle rotations are only applied to parent particles
  71093. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate
  71094. */
  71095. set computeParticleRotation(val: boolean);
  71096. /**
  71097. * Tells to `setParticles()` to compute the particle colors or not.
  71098. * Default value : true. The PCS is faster when it's set to false.
  71099. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  71100. */
  71101. set computeParticleColor(val: boolean);
  71102. set computeParticleTexture(val: boolean);
  71103. /**
  71104. * Gets if `setParticles()` computes the particle colors or not.
  71105. * Default value : false. The PCS is faster when it's set to false.
  71106. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  71107. */
  71108. get computeParticleColor(): boolean;
  71109. /**
  71110. * Gets if `setParticles()` computes the particle textures or not.
  71111. * Default value : false. The PCS is faster when it's set to false.
  71112. * Note : the particle textures are stored values, so setting `computeParticleTexture` to false will keep yet the last colors set.
  71113. */
  71114. get computeParticleTexture(): boolean;
  71115. /**
  71116. * Tells to `setParticles()` to compute or not the mesh bounding box when computing the particle positions.
  71117. */
  71118. set computeBoundingBox(val: boolean);
  71119. /**
  71120. * Gets if `setParticles()` computes or not the mesh bounding box when computing the particle positions.
  71121. */
  71122. get computeBoundingBox(): boolean;
  71123. /**
  71124. * This function does nothing. It may be overwritten to set all the particle first values.
  71125. * The PCS doesn't call this function, you may have to call it by your own.
  71126. * doc :
  71127. */
  71128. initParticles(): void;
  71129. /**
  71130. * This function does nothing. It may be overwritten to recycle a particle
  71131. * The PCS doesn't call this function, you can to call it
  71132. * doc :
  71133. * @param particle The particle to recycle
  71134. * @returns the recycled particle
  71135. */
  71136. recycleParticle(particle: CloudPoint): CloudPoint;
  71137. /**
  71138. * Updates a particle : this function should be overwritten by the user.
  71139. * It is called on each particle by `setParticles()`. This is the place to code each particle behavior.
  71140. * doc :
  71141. * @example : just set a particle position or velocity and recycle conditions
  71142. * @param particle The particle to update
  71143. * @returns the updated particle
  71144. */
  71145. updateParticle(particle: CloudPoint): CloudPoint;
  71146. /**
  71147. * This will be called before any other treatment by `setParticles()` and will be passed three parameters.
  71148. * This does nothing and may be overwritten by the user.
  71149. * @param start the particle index in the particle array where to start to iterate, same than the value passed to setParticle()
  71150. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  71151. * @param update the boolean update value actually passed to setParticles()
  71152. */
  71153. beforeUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  71154. /**
  71155. * This will be called by `setParticles()` after all the other treatments and just before the actual mesh update.
  71156. * This will be passed three parameters.
  71157. * This does nothing and may be overwritten by the user.
  71158. * @param start the particle index in the particle array where to start to iterate, same than the value passed to setParticle()
  71159. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  71160. * @param update the boolean update value actually passed to setParticles()
  71161. */
  71162. afterUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  71163. }
  71164. }
  71165. declare module "babylonjs/Particles/cloudPoint" {
  71166. import { Nullable } from "babylonjs/types";
  71167. import { Color4, Vector2, Vector3, Matrix, Quaternion } from "babylonjs/Maths/math";
  71168. import { Mesh } from "babylonjs/Meshes/mesh";
  71169. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  71170. import { PointsCloudSystem } from "babylonjs/Particles/pointsCloudSystem";
  71171. /**
  71172. * Represents one particle of a points cloud system.
  71173. */
  71174. export class CloudPoint {
  71175. /**
  71176. * particle global index
  71177. */
  71178. idx: number;
  71179. /**
  71180. * The color of the particle
  71181. */
  71182. color: Nullable<Color4>;
  71183. /**
  71184. * The world space position of the particle.
  71185. */
  71186. position: Vector3;
  71187. /**
  71188. * The world space rotation of the particle. (Not use if rotationQuaternion is set)
  71189. */
  71190. rotation: Vector3;
  71191. /**
  71192. * The world space rotation quaternion of the particle.
  71193. */
  71194. rotationQuaternion: Nullable<Quaternion>;
  71195. /**
  71196. * The uv of the particle.
  71197. */
  71198. uv: Nullable<Vector2>;
  71199. /**
  71200. * The current speed of the particle.
  71201. */
  71202. velocity: Vector3;
  71203. /**
  71204. * The pivot point in the particle local space.
  71205. */
  71206. pivot: Vector3;
  71207. /**
  71208. * Must the particle be translated from its pivot point in its local space ?
  71209. * In this case, the pivot point is set at the origin of the particle local space and the particle is translated.
  71210. * Default : false
  71211. */
  71212. translateFromPivot: boolean;
  71213. /**
  71214. * Index of this particle in the global "positions" array (Internal use)
  71215. * @hidden
  71216. */
  71217. _pos: number;
  71218. /**
  71219. * @hidden Index of this particle in the global "indices" array (Internal use)
  71220. */
  71221. _ind: number;
  71222. /**
  71223. * Group this particle belongs to
  71224. */
  71225. _group: PointsGroup;
  71226. /**
  71227. * Group id of this particle
  71228. */
  71229. groupId: number;
  71230. /**
  71231. * Index of the particle in its group id (Internal use)
  71232. */
  71233. idxInGroup: number;
  71234. /**
  71235. * @hidden Particle BoundingInfo object (Internal use)
  71236. */
  71237. _boundingInfo: BoundingInfo;
  71238. /**
  71239. * @hidden Reference to the PCS that the particle belongs to (Internal use)
  71240. */
  71241. _pcs: PointsCloudSystem;
  71242. /**
  71243. * @hidden Still set as invisible in order to skip useless computations (Internal use)
  71244. */
  71245. _stillInvisible: boolean;
  71246. /**
  71247. * @hidden Last computed particle rotation matrix
  71248. */
  71249. _rotationMatrix: number[];
  71250. /**
  71251. * Parent particle Id, if any.
  71252. * Default null.
  71253. */
  71254. parentId: Nullable<number>;
  71255. /**
  71256. * @hidden Internal global position in the PCS.
  71257. */
  71258. _globalPosition: Vector3;
  71259. /**
  71260. * Creates a Point Cloud object.
  71261. * Don't create particles manually, use instead the PCS internal tools like _addParticle()
  71262. * @param particleIndex (integer) is the particle index in the PCS pool. It's also the particle identifier.
  71263. * @param group (PointsGroup) is the group the particle belongs to
  71264. * @param groupId (integer) is the group identifier in the PCS.
  71265. * @param idxInGroup (integer) is the index of the particle in the current point group (ex: the 10th point of addPoints(30))
  71266. * @param pcs defines the PCS it is associated to
  71267. */
  71268. constructor(particleIndex: number, group: PointsGroup, groupId: number, idxInGroup: number, pcs: PointsCloudSystem);
  71269. /**
  71270. * get point size
  71271. */
  71272. get size(): Vector3;
  71273. /**
  71274. * Set point size
  71275. */
  71276. set size(scale: Vector3);
  71277. /**
  71278. * Legacy support, changed quaternion to rotationQuaternion
  71279. */
  71280. get quaternion(): Nullable<Quaternion>;
  71281. /**
  71282. * Legacy support, changed quaternion to rotationQuaternion
  71283. */
  71284. set quaternion(q: Nullable<Quaternion>);
  71285. /**
  71286. * Returns a boolean. True if the particle intersects a mesh, else false
  71287. * The intersection is computed on the particle position and Axis Aligned Bounding Box (AABB) or Sphere
  71288. * @param target is the object (point or mesh) what the intersection is computed against
  71289. * @param isSphere is boolean flag when false (default) bounding box of mesh is used, when true the bouding sphere is used
  71290. * @returns true if it intersects
  71291. */
  71292. intersectsMesh(target: Mesh, isSphere: boolean): boolean;
  71293. /**
  71294. * get the rotation matrix of the particle
  71295. * @hidden
  71296. */
  71297. getRotationMatrix(m: Matrix): void;
  71298. }
  71299. /**
  71300. * Represents a group of points in a points cloud system
  71301. * * PCS internal tool, don't use it manually.
  71302. */
  71303. export class PointsGroup {
  71304. /**
  71305. * The group id
  71306. * @hidden
  71307. */
  71308. groupID: number;
  71309. /**
  71310. * image data for group (internal use)
  71311. * @hidden
  71312. */
  71313. _groupImageData: Nullable<ArrayBufferView>;
  71314. /**
  71315. * Image Width (internal use)
  71316. * @hidden
  71317. */
  71318. _groupImgWidth: number;
  71319. /**
  71320. * Image Height (internal use)
  71321. * @hidden
  71322. */
  71323. _groupImgHeight: number;
  71324. /**
  71325. * Custom position function (internal use)
  71326. * @hidden
  71327. */
  71328. _positionFunction: Nullable<(particle: CloudPoint, i?: number, s?: number) => void>;
  71329. /**
  71330. * density per facet for surface points
  71331. * @hidden
  71332. */
  71333. _groupDensity: number[];
  71334. /**
  71335. * Only when points are colored by texture carries pointer to texture list array
  71336. * @hidden
  71337. */
  71338. _textureNb: number;
  71339. /**
  71340. * Creates a points group object. This is an internal reference to produce particles for the PCS.
  71341. * PCS internal tool, don't use it manually.
  71342. * @hidden
  71343. */
  71344. constructor(id: number, posFunction: Nullable<(particle: CloudPoint, i?: number, s?: number) => void>);
  71345. }
  71346. }
  71347. declare module "babylonjs/Particles/index" {
  71348. export * from "babylonjs/Particles/baseParticleSystem";
  71349. export * from "babylonjs/Particles/EmitterTypes/index";
  71350. export * from "babylonjs/Particles/gpuParticleSystem";
  71351. export * from "babylonjs/Particles/IParticleSystem";
  71352. export * from "babylonjs/Particles/particle";
  71353. export * from "babylonjs/Particles/particleHelper";
  71354. export * from "babylonjs/Particles/particleSystem";
  71355. import "babylonjs/Particles/particleSystemComponent";
  71356. export * from "babylonjs/Particles/particleSystemComponent";
  71357. export * from "babylonjs/Particles/particleSystemSet";
  71358. export * from "babylonjs/Particles/solidParticle";
  71359. export * from "babylonjs/Particles/solidParticleSystem";
  71360. export * from "babylonjs/Particles/cloudPoint";
  71361. export * from "babylonjs/Particles/pointsCloudSystem";
  71362. export * from "babylonjs/Particles/subEmitter";
  71363. }
  71364. declare module "babylonjs/Physics/physicsEngineComponent" {
  71365. import { Nullable } from "babylonjs/types";
  71366. import { Observable, Observer } from "babylonjs/Misc/observable";
  71367. import { Vector3 } from "babylonjs/Maths/math.vector";
  71368. import { Mesh } from "babylonjs/Meshes/mesh";
  71369. import { ISceneComponent } from "babylonjs/sceneComponent";
  71370. import { Scene } from "babylonjs/scene";
  71371. import { Node } from "babylonjs/node";
  71372. import { IPhysicsEngine, IPhysicsEnginePlugin } from "babylonjs/Physics/IPhysicsEngine";
  71373. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  71374. module "babylonjs/scene" {
  71375. interface Scene {
  71376. /** @hidden (Backing field) */
  71377. _physicsEngine: Nullable<IPhysicsEngine>;
  71378. /** @hidden */
  71379. _physicsTimeAccumulator: number;
  71380. /**
  71381. * Gets the current physics engine
  71382. * @returns a IPhysicsEngine or null if none attached
  71383. */
  71384. getPhysicsEngine(): Nullable<IPhysicsEngine>;
  71385. /**
  71386. * Enables physics to the current scene
  71387. * @param gravity defines the scene's gravity for the physics engine
  71388. * @param plugin defines the physics engine to be used. defaults to OimoJS.
  71389. * @return a boolean indicating if the physics engine was initialized
  71390. */
  71391. enablePhysics(gravity: Nullable<Vector3>, plugin?: IPhysicsEnginePlugin): boolean;
  71392. /**
  71393. * Disables and disposes the physics engine associated with the scene
  71394. */
  71395. disablePhysicsEngine(): void;
  71396. /**
  71397. * Gets a boolean indicating if there is an active physics engine
  71398. * @returns a boolean indicating if there is an active physics engine
  71399. */
  71400. isPhysicsEnabled(): boolean;
  71401. /**
  71402. * Deletes a physics compound impostor
  71403. * @param compound defines the compound to delete
  71404. */
  71405. deleteCompoundImpostor(compound: any): void;
  71406. /**
  71407. * An event triggered when physic simulation is about to be run
  71408. */
  71409. onBeforePhysicsObservable: Observable<Scene>;
  71410. /**
  71411. * An event triggered when physic simulation has been done
  71412. */
  71413. onAfterPhysicsObservable: Observable<Scene>;
  71414. }
  71415. }
  71416. module "babylonjs/Meshes/abstractMesh" {
  71417. interface AbstractMesh {
  71418. /** @hidden */
  71419. _physicsImpostor: Nullable<PhysicsImpostor>;
  71420. /**
  71421. * Gets or sets impostor used for physic simulation
  71422. * @see https://doc.babylonjs.com/features/physics_engine
  71423. */
  71424. physicsImpostor: Nullable<PhysicsImpostor>;
  71425. /**
  71426. * Gets the current physics impostor
  71427. * @see https://doc.babylonjs.com/features/physics_engine
  71428. * @returns a physics impostor or null
  71429. */
  71430. getPhysicsImpostor(): Nullable<PhysicsImpostor>;
  71431. /** Apply a physic impulse to the mesh
  71432. * @param force defines the force to apply
  71433. * @param contactPoint defines where to apply the force
  71434. * @returns the current mesh
  71435. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  71436. */
  71437. applyImpulse(force: Vector3, contactPoint: Vector3): AbstractMesh;
  71438. /**
  71439. * Creates a physic joint between two meshes
  71440. * @param otherMesh defines the other mesh to use
  71441. * @param pivot1 defines the pivot to use on this mesh
  71442. * @param pivot2 defines the pivot to use on the other mesh
  71443. * @param options defines additional options (can be plugin dependent)
  71444. * @returns the current mesh
  71445. * @see https://www.babylonjs-playground.com/#0BS5U0#0
  71446. */
  71447. setPhysicsLinkWith(otherMesh: Mesh, pivot1: Vector3, pivot2: Vector3, options?: any): AbstractMesh;
  71448. /** @hidden */
  71449. _disposePhysicsObserver: Nullable<Observer<Node>>;
  71450. }
  71451. }
  71452. /**
  71453. * Defines the physics engine scene component responsible to manage a physics engine
  71454. */
  71455. export class PhysicsEngineSceneComponent implements ISceneComponent {
  71456. /**
  71457. * The component name helpful to identify the component in the list of scene components.
  71458. */
  71459. readonly name: string;
  71460. /**
  71461. * The scene the component belongs to.
  71462. */
  71463. scene: Scene;
  71464. /**
  71465. * Creates a new instance of the component for the given scene
  71466. * @param scene Defines the scene to register the component in
  71467. */
  71468. constructor(scene: Scene);
  71469. /**
  71470. * Registers the component in a given scene
  71471. */
  71472. register(): void;
  71473. /**
  71474. * Rebuilds the elements related to this component in case of
  71475. * context lost for instance.
  71476. */
  71477. rebuild(): void;
  71478. /**
  71479. * Disposes the component and the associated ressources
  71480. */
  71481. dispose(): void;
  71482. }
  71483. }
  71484. declare module "babylonjs/Physics/physicsHelper" {
  71485. import { Nullable } from "babylonjs/types";
  71486. import { Vector3 } from "babylonjs/Maths/math.vector";
  71487. import { Mesh } from "babylonjs/Meshes/mesh";
  71488. import { Scene } from "babylonjs/scene";
  71489. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  71490. /**
  71491. * A helper for physics simulations
  71492. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  71493. */
  71494. export class PhysicsHelper {
  71495. private _scene;
  71496. private _physicsEngine;
  71497. /**
  71498. * Initializes the Physics helper
  71499. * @param scene Babylon.js scene
  71500. */
  71501. constructor(scene: Scene);
  71502. /**
  71503. * Applies a radial explosion impulse
  71504. * @param origin the origin of the explosion
  71505. * @param radiusOrEventOptions the radius or the options of radial explosion
  71506. * @param strength the explosion strength
  71507. * @param falloff possible options: Constant & Linear. Defaults to Constant
  71508. * @returns A physics radial explosion event, or null
  71509. */
  71510. applyRadialExplosionImpulse(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsRadialExplosionEvent>;
  71511. /**
  71512. * Applies a radial explosion force
  71513. * @param origin the origin of the explosion
  71514. * @param radiusOrEventOptions the radius or the options of radial explosion
  71515. * @param strength the explosion strength
  71516. * @param falloff possible options: Constant & Linear. Defaults to Constant
  71517. * @returns A physics radial explosion event, or null
  71518. */
  71519. applyRadialExplosionForce(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsRadialExplosionEvent>;
  71520. /**
  71521. * Creates a gravitational field
  71522. * @param origin the origin of the explosion
  71523. * @param radiusOrEventOptions the radius or the options of radial explosion
  71524. * @param strength the explosion strength
  71525. * @param falloff possible options: Constant & Linear. Defaults to Constant
  71526. * @returns A physics gravitational field event, or null
  71527. */
  71528. gravitationalField(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsGravitationalFieldEvent>;
  71529. /**
  71530. * Creates a physics updraft event
  71531. * @param origin the origin of the updraft
  71532. * @param radiusOrEventOptions the radius or the options of the updraft
  71533. * @param strength the strength of the updraft
  71534. * @param height the height of the updraft
  71535. * @param updraftMode possible options: Center & Perpendicular. Defaults to Center
  71536. * @returns A physics updraft event, or null
  71537. */
  71538. updraft(origin: Vector3, radiusOrEventOptions: number | PhysicsUpdraftEventOptions, strength?: number, height?: number, updraftMode?: PhysicsUpdraftMode): Nullable<PhysicsUpdraftEvent>;
  71539. /**
  71540. * Creates a physics vortex event
  71541. * @param origin the of the vortex
  71542. * @param radiusOrEventOptions the radius or the options of the vortex
  71543. * @param strength the strength of the vortex
  71544. * @param height the height of the vortex
  71545. * @returns a Physics vortex event, or null
  71546. * A physics vortex event or null
  71547. */
  71548. vortex(origin: Vector3, radiusOrEventOptions: number | PhysicsVortexEventOptions, strength?: number, height?: number): Nullable<PhysicsVortexEvent>;
  71549. }
  71550. /**
  71551. * Represents a physics radial explosion event
  71552. */
  71553. class PhysicsRadialExplosionEvent {
  71554. private _scene;
  71555. private _options;
  71556. private _sphere;
  71557. private _dataFetched;
  71558. /**
  71559. * Initializes a radial explosioin event
  71560. * @param _scene BabylonJS scene
  71561. * @param _options The options for the vortex event
  71562. */
  71563. constructor(_scene: Scene, _options: PhysicsRadialExplosionEventOptions);
  71564. /**
  71565. * Returns the data related to the radial explosion event (sphere).
  71566. * @returns The radial explosion event data
  71567. */
  71568. getData(): PhysicsRadialExplosionEventData;
  71569. /**
  71570. * Returns the force and contact point of the impostor or false, if the impostor is not affected by the force/impulse.
  71571. * @param impostor A physics imposter
  71572. * @param origin the origin of the explosion
  71573. * @returns {Nullable<PhysicsHitData>} A physics force and contact point, or null
  71574. */
  71575. getImpostorHitData(impostor: PhysicsImpostor, origin: Vector3): Nullable<PhysicsHitData>;
  71576. /**
  71577. * Triggers affecterd impostors callbacks
  71578. * @param affectedImpostorsWithData defines the list of affected impostors (including associated data)
  71579. */
  71580. triggerAffectedImpostorsCallback(affectedImpostorsWithData: Array<PhysicsAffectedImpostorWithData>): void;
  71581. /**
  71582. * Disposes the sphere.
  71583. * @param force Specifies if the sphere should be disposed by force
  71584. */
  71585. dispose(force?: boolean): void;
  71586. /*** Helpers ***/
  71587. private _prepareSphere;
  71588. private _intersectsWithSphere;
  71589. }
  71590. /**
  71591. * Represents a gravitational field event
  71592. */
  71593. class PhysicsGravitationalFieldEvent {
  71594. private _physicsHelper;
  71595. private _scene;
  71596. private _origin;
  71597. private _options;
  71598. private _tickCallback;
  71599. private _sphere;
  71600. private _dataFetched;
  71601. /**
  71602. * Initializes the physics gravitational field event
  71603. * @param _physicsHelper A physics helper
  71604. * @param _scene BabylonJS scene
  71605. * @param _origin The origin position of the gravitational field event
  71606. * @param _options The options for the vortex event
  71607. */
  71608. constructor(_physicsHelper: PhysicsHelper, _scene: Scene, _origin: Vector3, _options: PhysicsRadialExplosionEventOptions);
  71609. /**
  71610. * Returns the data related to the gravitational field event (sphere).
  71611. * @returns A gravitational field event
  71612. */
  71613. getData(): PhysicsGravitationalFieldEventData;
  71614. /**
  71615. * Enables the gravitational field.
  71616. */
  71617. enable(): void;
  71618. /**
  71619. * Disables the gravitational field.
  71620. */
  71621. disable(): void;
  71622. /**
  71623. * Disposes the sphere.
  71624. * @param force The force to dispose from the gravitational field event
  71625. */
  71626. dispose(force?: boolean): void;
  71627. private _tick;
  71628. }
  71629. /**
  71630. * Represents a physics updraft event
  71631. */
  71632. class PhysicsUpdraftEvent {
  71633. private _scene;
  71634. private _origin;
  71635. private _options;
  71636. private _physicsEngine;
  71637. private _originTop;
  71638. private _originDirection;
  71639. private _tickCallback;
  71640. private _cylinder;
  71641. private _cylinderPosition;
  71642. private _dataFetched;
  71643. /**
  71644. * Initializes the physics updraft event
  71645. * @param _scene BabylonJS scene
  71646. * @param _origin The origin position of the updraft
  71647. * @param _options The options for the updraft event
  71648. */
  71649. constructor(_scene: Scene, _origin: Vector3, _options: PhysicsUpdraftEventOptions);
  71650. /**
  71651. * Returns the data related to the updraft event (cylinder).
  71652. * @returns A physics updraft event
  71653. */
  71654. getData(): PhysicsUpdraftEventData;
  71655. /**
  71656. * Enables the updraft.
  71657. */
  71658. enable(): void;
  71659. /**
  71660. * Disables the updraft.
  71661. */
  71662. disable(): void;
  71663. /**
  71664. * Disposes the cylinder.
  71665. * @param force Specifies if the updraft should be disposed by force
  71666. */
  71667. dispose(force?: boolean): void;
  71668. private getImpostorHitData;
  71669. private _tick;
  71670. /*** Helpers ***/
  71671. private _prepareCylinder;
  71672. private _intersectsWithCylinder;
  71673. }
  71674. /**
  71675. * Represents a physics vortex event
  71676. */
  71677. class PhysicsVortexEvent {
  71678. private _scene;
  71679. private _origin;
  71680. private _options;
  71681. private _physicsEngine;
  71682. private _originTop;
  71683. private _tickCallback;
  71684. private _cylinder;
  71685. private _cylinderPosition;
  71686. private _dataFetched;
  71687. /**
  71688. * Initializes the physics vortex event
  71689. * @param _scene The BabylonJS scene
  71690. * @param _origin The origin position of the vortex
  71691. * @param _options The options for the vortex event
  71692. */
  71693. constructor(_scene: Scene, _origin: Vector3, _options: PhysicsVortexEventOptions);
  71694. /**
  71695. * Returns the data related to the vortex event (cylinder).
  71696. * @returns The physics vortex event data
  71697. */
  71698. getData(): PhysicsVortexEventData;
  71699. /**
  71700. * Enables the vortex.
  71701. */
  71702. enable(): void;
  71703. /**
  71704. * Disables the cortex.
  71705. */
  71706. disable(): void;
  71707. /**
  71708. * Disposes the sphere.
  71709. * @param force
  71710. */
  71711. dispose(force?: boolean): void;
  71712. private getImpostorHitData;
  71713. private _tick;
  71714. /*** Helpers ***/
  71715. private _prepareCylinder;
  71716. private _intersectsWithCylinder;
  71717. }
  71718. /**
  71719. * Options fot the radial explosion event
  71720. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  71721. */
  71722. export class PhysicsRadialExplosionEventOptions {
  71723. /**
  71724. * The radius of the sphere for the radial explosion.
  71725. */
  71726. radius: number;
  71727. /**
  71728. * The strenth of the explosion.
  71729. */
  71730. strength: number;
  71731. /**
  71732. * The strenght of the force in correspondence to the distance of the affected object
  71733. */
  71734. falloff: PhysicsRadialImpulseFalloff;
  71735. /**
  71736. * Sphere options for the radial explosion.
  71737. */
  71738. sphere: {
  71739. segments: number;
  71740. diameter: number;
  71741. };
  71742. /**
  71743. * Sphere options for the radial explosion.
  71744. */
  71745. affectedImpostorsCallback: (affectedImpostorsWithData: Array<PhysicsAffectedImpostorWithData>) => void;
  71746. }
  71747. /**
  71748. * Options fot the updraft event
  71749. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  71750. */
  71751. export class PhysicsUpdraftEventOptions {
  71752. /**
  71753. * The radius of the cylinder for the vortex
  71754. */
  71755. radius: number;
  71756. /**
  71757. * The strenth of the updraft.
  71758. */
  71759. strength: number;
  71760. /**
  71761. * The height of the cylinder for the updraft.
  71762. */
  71763. height: number;
  71764. /**
  71765. * The mode for the the updraft.
  71766. */
  71767. updraftMode: PhysicsUpdraftMode;
  71768. }
  71769. /**
  71770. * Options fot the vortex event
  71771. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  71772. */
  71773. export class PhysicsVortexEventOptions {
  71774. /**
  71775. * The radius of the cylinder for the vortex
  71776. */
  71777. radius: number;
  71778. /**
  71779. * The strenth of the vortex.
  71780. */
  71781. strength: number;
  71782. /**
  71783. * The height of the cylinder for the vortex.
  71784. */
  71785. height: number;
  71786. /**
  71787. * At which distance, relative to the radius the centripetal forces should kick in? Range: 0-1
  71788. */
  71789. centripetalForceThreshold: number;
  71790. /**
  71791. * This multiplier determines with how much force the objects will be pushed sideways/around the vortex, when below the treshold.
  71792. */
  71793. centripetalForceMultiplier: number;
  71794. /**
  71795. * This multiplier determines with how much force the objects will be pushed sideways/around the vortex, when above the treshold.
  71796. */
  71797. centrifugalForceMultiplier: number;
  71798. /**
  71799. * This multiplier determines with how much force the objects will be pushed upwards, when in the vortex.
  71800. */
  71801. updraftForceMultiplier: number;
  71802. }
  71803. /**
  71804. * The strenght of the force in correspondence to the distance of the affected object
  71805. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  71806. */
  71807. export enum PhysicsRadialImpulseFalloff {
  71808. /** Defines that impulse is constant in strength across it's whole radius */
  71809. Constant = 0,
  71810. /** Defines that impulse gets weaker if it's further from the origin */
  71811. Linear = 1
  71812. }
  71813. /**
  71814. * The strength of the force in correspondence to the distance of the affected object
  71815. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  71816. */
  71817. export enum PhysicsUpdraftMode {
  71818. /** Defines that the upstream forces will pull towards the top center of the cylinder */
  71819. Center = 0,
  71820. /** Defines that once a impostor is inside the cylinder, it will shoot out perpendicular from the ground of the cylinder */
  71821. Perpendicular = 1
  71822. }
  71823. /**
  71824. * Interface for a physics hit data
  71825. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  71826. */
  71827. export interface PhysicsHitData {
  71828. /**
  71829. * The force applied at the contact point
  71830. */
  71831. force: Vector3;
  71832. /**
  71833. * The contact point
  71834. */
  71835. contactPoint: Vector3;
  71836. /**
  71837. * The distance from the origin to the contact point
  71838. */
  71839. distanceFromOrigin: number;
  71840. }
  71841. /**
  71842. * Interface for radial explosion event data
  71843. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  71844. */
  71845. export interface PhysicsRadialExplosionEventData {
  71846. /**
  71847. * A sphere used for the radial explosion event
  71848. */
  71849. sphere: Mesh;
  71850. }
  71851. /**
  71852. * Interface for gravitational field event data
  71853. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  71854. */
  71855. export interface PhysicsGravitationalFieldEventData {
  71856. /**
  71857. * A sphere mesh used for the gravitational field event
  71858. */
  71859. sphere: Mesh;
  71860. }
  71861. /**
  71862. * Interface for updraft event data
  71863. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  71864. */
  71865. export interface PhysicsUpdraftEventData {
  71866. /**
  71867. * A cylinder used for the updraft event
  71868. */
  71869. cylinder: Mesh;
  71870. }
  71871. /**
  71872. * Interface for vortex event data
  71873. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  71874. */
  71875. export interface PhysicsVortexEventData {
  71876. /**
  71877. * A cylinder used for the vortex event
  71878. */
  71879. cylinder: Mesh;
  71880. }
  71881. /**
  71882. * Interface for an affected physics impostor
  71883. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  71884. */
  71885. export interface PhysicsAffectedImpostorWithData {
  71886. /**
  71887. * The impostor affected by the effect
  71888. */
  71889. impostor: PhysicsImpostor;
  71890. /**
  71891. * The data about the hit/horce from the explosion
  71892. */
  71893. hitData: PhysicsHitData;
  71894. }
  71895. }
  71896. declare module "babylonjs/Physics/Plugins/index" {
  71897. export * from "babylonjs/Physics/Plugins/cannonJSPlugin";
  71898. export * from "babylonjs/Physics/Plugins/ammoJSPlugin";
  71899. export * from "babylonjs/Physics/Plugins/oimoJSPlugin";
  71900. }
  71901. declare module "babylonjs/Physics/index" {
  71902. export * from "babylonjs/Physics/IPhysicsEngine";
  71903. export * from "babylonjs/Physics/physicsEngine";
  71904. export * from "babylonjs/Physics/physicsEngineComponent";
  71905. export * from "babylonjs/Physics/physicsHelper";
  71906. export * from "babylonjs/Physics/physicsImpostor";
  71907. export * from "babylonjs/Physics/physicsJoint";
  71908. export * from "babylonjs/Physics/Plugins/index";
  71909. }
  71910. declare module "babylonjs/Shaders/blackAndWhite.fragment" {
  71911. /** @hidden */
  71912. export var blackAndWhitePixelShader: {
  71913. name: string;
  71914. shader: string;
  71915. };
  71916. }
  71917. declare module "babylonjs/PostProcesses/blackAndWhitePostProcess" {
  71918. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  71919. import { Camera } from "babylonjs/Cameras/camera";
  71920. import { Engine } from "babylonjs/Engines/engine";
  71921. import "babylonjs/Shaders/blackAndWhite.fragment";
  71922. /**
  71923. * Post process used to render in black and white
  71924. */
  71925. export class BlackAndWhitePostProcess extends PostProcess {
  71926. /**
  71927. * Linear about to convert he result to black and white (default: 1)
  71928. */
  71929. degree: number;
  71930. /**
  71931. * Creates a black and white post process
  71932. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#black-and-white
  71933. * @param name The name of the effect.
  71934. * @param options The required width/height ratio to downsize to before computing the render pass.
  71935. * @param camera The camera to apply the render pass to.
  71936. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  71937. * @param engine The engine which the post process will be applied. (default: current engine)
  71938. * @param reusable If the post process can be reused on the same frame. (default: false)
  71939. */
  71940. constructor(name: string, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  71941. }
  71942. }
  71943. declare module "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect" {
  71944. import { Nullable } from "babylonjs/types";
  71945. import { Camera } from "babylonjs/Cameras/camera";
  71946. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  71947. import { Engine } from "babylonjs/Engines/engine";
  71948. /**
  71949. * This represents a set of one or more post processes in Babylon.
  71950. * A post process can be used to apply a shader to a texture after it is rendered.
  71951. * @example https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  71952. */
  71953. export class PostProcessRenderEffect {
  71954. private _postProcesses;
  71955. private _getPostProcesses;
  71956. private _singleInstance;
  71957. private _cameras;
  71958. private _indicesForCamera;
  71959. /**
  71960. * Name of the effect
  71961. * @hidden
  71962. */
  71963. _name: string;
  71964. /**
  71965. * Instantiates a post process render effect.
  71966. * A post process can be used to apply a shader to a texture after it is rendered.
  71967. * @param engine The engine the effect is tied to
  71968. * @param name The name of the effect
  71969. * @param getPostProcesses A function that returns a set of post processes which the effect will run in order to be run.
  71970. * @param singleInstance False if this post process can be run on multiple cameras. (default: true)
  71971. */
  71972. constructor(engine: Engine, name: string, getPostProcesses: () => Nullable<PostProcess | Array<PostProcess>>, singleInstance?: boolean);
  71973. /**
  71974. * Checks if all the post processes in the effect are supported.
  71975. */
  71976. get isSupported(): boolean;
  71977. /**
  71978. * Updates the current state of the effect
  71979. * @hidden
  71980. */
  71981. _update(): void;
  71982. /**
  71983. * Attaches the effect on cameras
  71984. * @param cameras The camera to attach to.
  71985. * @hidden
  71986. */
  71987. _attachCameras(cameras: Camera): void;
  71988. /**
  71989. * Attaches the effect on cameras
  71990. * @param cameras The camera to attach to.
  71991. * @hidden
  71992. */
  71993. _attachCameras(cameras: Camera[]): void;
  71994. /**
  71995. * Detaches the effect on cameras
  71996. * @param cameras The camera to detatch from.
  71997. * @hidden
  71998. */
  71999. _detachCameras(cameras: Camera): void;
  72000. /**
  72001. * Detatches the effect on cameras
  72002. * @param cameras The camera to detatch from.
  72003. * @hidden
  72004. */
  72005. _detachCameras(cameras: Camera[]): void;
  72006. /**
  72007. * Enables the effect on given cameras
  72008. * @param cameras The camera to enable.
  72009. * @hidden
  72010. */
  72011. _enable(cameras: Camera): void;
  72012. /**
  72013. * Enables the effect on given cameras
  72014. * @param cameras The camera to enable.
  72015. * @hidden
  72016. */
  72017. _enable(cameras: Nullable<Camera[]>): void;
  72018. /**
  72019. * Disables the effect on the given cameras
  72020. * @param cameras The camera to disable.
  72021. * @hidden
  72022. */
  72023. _disable(cameras: Camera): void;
  72024. /**
  72025. * Disables the effect on the given cameras
  72026. * @param cameras The camera to disable.
  72027. * @hidden
  72028. */
  72029. _disable(cameras: Nullable<Camera[]>): void;
  72030. /**
  72031. * Gets a list of the post processes contained in the effect.
  72032. * @param camera The camera to get the post processes on.
  72033. * @returns The list of the post processes in the effect.
  72034. */
  72035. getPostProcesses(camera?: Camera): Nullable<Array<PostProcess>>;
  72036. }
  72037. }
  72038. declare module "babylonjs/Shaders/extractHighlights.fragment" {
  72039. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  72040. /** @hidden */
  72041. export var extractHighlightsPixelShader: {
  72042. name: string;
  72043. shader: string;
  72044. };
  72045. }
  72046. declare module "babylonjs/PostProcesses/extractHighlightsPostProcess" {
  72047. import { Nullable } from "babylonjs/types";
  72048. import { Camera } from "babylonjs/Cameras/camera";
  72049. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72050. import { Engine } from "babylonjs/Engines/engine";
  72051. import "babylonjs/Shaders/extractHighlights.fragment";
  72052. /**
  72053. * 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.
  72054. */
  72055. export class ExtractHighlightsPostProcess extends PostProcess {
  72056. /**
  72057. * The luminance threshold, pixels below this value will be set to black.
  72058. */
  72059. threshold: number;
  72060. /** @hidden */
  72061. _exposure: number;
  72062. /**
  72063. * Post process which has the input texture to be used when performing highlight extraction
  72064. * @hidden
  72065. */
  72066. _inputPostProcess: Nullable<PostProcess>;
  72067. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  72068. }
  72069. }
  72070. declare module "babylonjs/Shaders/bloomMerge.fragment" {
  72071. /** @hidden */
  72072. export var bloomMergePixelShader: {
  72073. name: string;
  72074. shader: string;
  72075. };
  72076. }
  72077. declare module "babylonjs/PostProcesses/bloomMergePostProcess" {
  72078. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72079. import { Nullable } from "babylonjs/types";
  72080. import { Engine } from "babylonjs/Engines/engine";
  72081. import { Camera } from "babylonjs/Cameras/camera";
  72082. import "babylonjs/Shaders/bloomMerge.fragment";
  72083. /**
  72084. * The BloomMergePostProcess merges blurred images with the original based on the values of the circle of confusion.
  72085. */
  72086. export class BloomMergePostProcess extends PostProcess {
  72087. /** Weight of the bloom to be added to the original input. */
  72088. weight: number;
  72089. /**
  72090. * Creates a new instance of @see BloomMergePostProcess
  72091. * @param name The name of the effect.
  72092. * @param originalFromInput Post process which's input will be used for the merge.
  72093. * @param blurred Blurred highlights post process which's output will be used.
  72094. * @param weight Weight of the bloom to be added to the original input.
  72095. * @param options The required width/height ratio to downsize to before computing the render pass.
  72096. * @param camera The camera to apply the render pass to.
  72097. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  72098. * @param engine The engine which the post process will be applied. (default: current engine)
  72099. * @param reusable If the post process can be reused on the same frame. (default: false)
  72100. * @param textureType Type of textures used when performing the post process. (default: 0)
  72101. * @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)
  72102. */
  72103. constructor(name: string, originalFromInput: PostProcess, blurred: PostProcess,
  72104. /** Weight of the bloom to be added to the original input. */
  72105. weight: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  72106. }
  72107. }
  72108. declare module "babylonjs/PostProcesses/bloomEffect" {
  72109. import { PostProcessRenderEffect } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect";
  72110. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  72111. import { ExtractHighlightsPostProcess } from "babylonjs/PostProcesses/extractHighlightsPostProcess";
  72112. import { Camera } from "babylonjs/Cameras/camera";
  72113. import { Scene } from "babylonjs/scene";
  72114. /**
  72115. * The bloom effect spreads bright areas of an image to simulate artifacts seen in cameras
  72116. */
  72117. export class BloomEffect extends PostProcessRenderEffect {
  72118. private bloomScale;
  72119. /**
  72120. * @hidden Internal
  72121. */
  72122. _effects: Array<PostProcess>;
  72123. /**
  72124. * @hidden Internal
  72125. */
  72126. _downscale: ExtractHighlightsPostProcess;
  72127. private _blurX;
  72128. private _blurY;
  72129. private _merge;
  72130. /**
  72131. * The luminance threshold to find bright areas of the image to bloom.
  72132. */
  72133. get threshold(): number;
  72134. set threshold(value: number);
  72135. /**
  72136. * The strength of the bloom.
  72137. */
  72138. get weight(): number;
  72139. set weight(value: number);
  72140. /**
  72141. * Specifies the size of the bloom blur kernel, relative to the final output size
  72142. */
  72143. get kernel(): number;
  72144. set kernel(value: number);
  72145. /**
  72146. * Creates a new instance of @see BloomEffect
  72147. * @param scene The scene the effect belongs to.
  72148. * @param bloomScale The ratio of the blur texture to the input texture that should be used to compute the bloom.
  72149. * @param bloomKernel The size of the kernel to be used when applying the blur.
  72150. * @param bloomWeight The the strength of bloom.
  72151. * @param pipelineTextureType The type of texture to be used when performing the post processing.
  72152. * @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)
  72153. */
  72154. constructor(scene: Scene, bloomScale: number, bloomWeight: number, bloomKernel: number, pipelineTextureType?: number, blockCompilation?: boolean);
  72155. /**
  72156. * Disposes each of the internal effects for a given camera.
  72157. * @param camera The camera to dispose the effect on.
  72158. */
  72159. disposeEffects(camera: Camera): void;
  72160. /**
  72161. * @hidden Internal
  72162. */
  72163. _updateEffects(): void;
  72164. /**
  72165. * Internal
  72166. * @returns if all the contained post processes are ready.
  72167. * @hidden
  72168. */
  72169. _isReady(): boolean;
  72170. }
  72171. }
  72172. declare module "babylonjs/Shaders/chromaticAberration.fragment" {
  72173. /** @hidden */
  72174. export var chromaticAberrationPixelShader: {
  72175. name: string;
  72176. shader: string;
  72177. };
  72178. }
  72179. declare module "babylonjs/PostProcesses/chromaticAberrationPostProcess" {
  72180. import { Vector2 } from "babylonjs/Maths/math.vector";
  72181. import { Nullable } from "babylonjs/types";
  72182. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72183. import { Camera } from "babylonjs/Cameras/camera";
  72184. import { Engine } from "babylonjs/Engines/engine";
  72185. import "babylonjs/Shaders/chromaticAberration.fragment";
  72186. /**
  72187. * The ChromaticAberrationPostProcess separates the rgb channels in an image to produce chromatic distortion around the edges of the screen
  72188. */
  72189. export class ChromaticAberrationPostProcess extends PostProcess {
  72190. /**
  72191. * The amount of seperation of rgb channels (default: 30)
  72192. */
  72193. aberrationAmount: number;
  72194. /**
  72195. * The amount the effect will increase for pixels closer to the edge of the screen. (default: 0)
  72196. */
  72197. radialIntensity: number;
  72198. /**
  72199. * 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))
  72200. */
  72201. direction: Vector2;
  72202. /**
  72203. * 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))
  72204. */
  72205. centerPosition: Vector2;
  72206. /**
  72207. * Creates a new instance ChromaticAberrationPostProcess
  72208. * @param name The name of the effect.
  72209. * @param screenWidth The width of the screen to apply the effect on.
  72210. * @param screenHeight The height of the screen to apply the effect on.
  72211. * @param options The required width/height ratio to downsize to before computing the render pass.
  72212. * @param camera The camera to apply the render pass to.
  72213. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  72214. * @param engine The engine which the post process will be applied. (default: current engine)
  72215. * @param reusable If the post process can be reused on the same frame. (default: false)
  72216. * @param textureType Type of textures used when performing the post process. (default: 0)
  72217. * @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)
  72218. */
  72219. constructor(name: string, screenWidth: number, screenHeight: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  72220. }
  72221. }
  72222. declare module "babylonjs/Shaders/circleOfConfusion.fragment" {
  72223. /** @hidden */
  72224. export var circleOfConfusionPixelShader: {
  72225. name: string;
  72226. shader: string;
  72227. };
  72228. }
  72229. declare module "babylonjs/PostProcesses/circleOfConfusionPostProcess" {
  72230. import { Nullable } from "babylonjs/types";
  72231. import { Engine } from "babylonjs/Engines/engine";
  72232. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72233. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  72234. import { Camera } from "babylonjs/Cameras/camera";
  72235. import "babylonjs/Shaders/circleOfConfusion.fragment";
  72236. /**
  72237. * The CircleOfConfusionPostProcess computes the circle of confusion value for each pixel given required lens parameters. See https://en.wikipedia.org/wiki/Circle_of_confusion
  72238. */
  72239. export class CircleOfConfusionPostProcess extends PostProcess {
  72240. /**
  72241. * 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.
  72242. */
  72243. lensSize: number;
  72244. /**
  72245. * F-Stop of the effect's camera. The diamater of the resulting aperture can be computed by lensSize/fStop. (default: 1.4)
  72246. */
  72247. fStop: number;
  72248. /**
  72249. * Distance away from the camera to focus on in scene units/1000 (eg. millimeter). (default: 2000)
  72250. */
  72251. focusDistance: number;
  72252. /**
  72253. * Focal length of the effect's camera in scene units/1000 (eg. millimeter). (default: 50)
  72254. */
  72255. focalLength: number;
  72256. private _depthTexture;
  72257. /**
  72258. * Creates a new instance CircleOfConfusionPostProcess
  72259. * @param name The name of the effect.
  72260. * @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.
  72261. * @param options The required width/height ratio to downsize to before computing the render pass.
  72262. * @param camera The camera to apply the render pass to.
  72263. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  72264. * @param engine The engine which the post process will be applied. (default: current engine)
  72265. * @param reusable If the post process can be reused on the same frame. (default: false)
  72266. * @param textureType Type of textures used when performing the post process. (default: 0)
  72267. * @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)
  72268. */
  72269. constructor(name: string, depthTexture: Nullable<RenderTargetTexture>, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  72270. /**
  72271. * 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.
  72272. */
  72273. set depthTexture(value: RenderTargetTexture);
  72274. }
  72275. }
  72276. declare module "babylonjs/Shaders/colorCorrection.fragment" {
  72277. /** @hidden */
  72278. export var colorCorrectionPixelShader: {
  72279. name: string;
  72280. shader: string;
  72281. };
  72282. }
  72283. declare module "babylonjs/PostProcesses/colorCorrectionPostProcess" {
  72284. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72285. import { Engine } from "babylonjs/Engines/engine";
  72286. import { Camera } from "babylonjs/Cameras/camera";
  72287. import "babylonjs/Shaders/colorCorrection.fragment";
  72288. /**
  72289. *
  72290. * This post-process allows the modification of rendered colors by using
  72291. * a 'look-up table' (LUT). This effect is also called Color Grading.
  72292. *
  72293. * The object needs to be provided an url to a texture containing the color
  72294. * look-up table: the texture must be 256 pixels wide and 16 pixels high.
  72295. * Use an image editing software to tweak the LUT to match your needs.
  72296. *
  72297. * For an example of a color LUT, see here:
  72298. * @see http://udn.epicgames.com/Three/rsrc/Three/ColorGrading/RGBTable16x1.png
  72299. * For explanations on color grading, see here:
  72300. * @see http://udn.epicgames.com/Three/ColorGrading.html
  72301. *
  72302. */
  72303. export class ColorCorrectionPostProcess extends PostProcess {
  72304. private _colorTableTexture;
  72305. constructor(name: string, colorTableUrl: string, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  72306. }
  72307. }
  72308. declare module "babylonjs/Shaders/convolution.fragment" {
  72309. /** @hidden */
  72310. export var convolutionPixelShader: {
  72311. name: string;
  72312. shader: string;
  72313. };
  72314. }
  72315. declare module "babylonjs/PostProcesses/convolutionPostProcess" {
  72316. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72317. import { Nullable } from "babylonjs/types";
  72318. import { Camera } from "babylonjs/Cameras/camera";
  72319. import { Engine } from "babylonjs/Engines/engine";
  72320. import "babylonjs/Shaders/convolution.fragment";
  72321. /**
  72322. * The ConvolutionPostProcess applies a 3x3 kernel to every pixel of the
  72323. * input texture to perform effects such as edge detection or sharpening
  72324. * See http://en.wikipedia.org/wiki/Kernel_(image_processing)
  72325. */
  72326. export class ConvolutionPostProcess extends PostProcess {
  72327. /** Array of 9 values corresponding to the 3x3 kernel to be applied */
  72328. kernel: number[];
  72329. /**
  72330. * Creates a new instance ConvolutionPostProcess
  72331. * @param name The name of the effect.
  72332. * @param kernel Array of 9 values corresponding to the 3x3 kernel to be applied
  72333. * @param options The required width/height ratio to downsize to before computing the render pass.
  72334. * @param camera The camera to apply the render pass to.
  72335. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  72336. * @param engine The engine which the post process will be applied. (default: current engine)
  72337. * @param reusable If the post process can be reused on the same frame. (default: false)
  72338. * @param textureType Type of textures used when performing the post process. (default: 0)
  72339. */
  72340. constructor(name: string,
  72341. /** Array of 9 values corresponding to the 3x3 kernel to be applied */
  72342. kernel: number[], options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  72343. /**
  72344. * Edge detection 0 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  72345. */
  72346. static EdgeDetect0Kernel: number[];
  72347. /**
  72348. * Edge detection 1 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  72349. */
  72350. static EdgeDetect1Kernel: number[];
  72351. /**
  72352. * Edge detection 2 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  72353. */
  72354. static EdgeDetect2Kernel: number[];
  72355. /**
  72356. * Kernel to sharpen an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  72357. */
  72358. static SharpenKernel: number[];
  72359. /**
  72360. * Kernel to emboss an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  72361. */
  72362. static EmbossKernel: number[];
  72363. /**
  72364. * Kernel to blur an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  72365. */
  72366. static GaussianKernel: number[];
  72367. }
  72368. }
  72369. declare module "babylonjs/PostProcesses/depthOfFieldBlurPostProcess" {
  72370. import { Nullable } from "babylonjs/types";
  72371. import { Vector2 } from "babylonjs/Maths/math.vector";
  72372. import { Camera } from "babylonjs/Cameras/camera";
  72373. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72374. import { BlurPostProcess } from "babylonjs/PostProcesses/blurPostProcess";
  72375. import { Engine } from "babylonjs/Engines/engine";
  72376. import { Scene } from "babylonjs/scene";
  72377. /**
  72378. * The DepthOfFieldBlurPostProcess applied a blur in a give direction.
  72379. * This blur differs from the standard BlurPostProcess as it attempts to avoid blurring pixels
  72380. * based on samples that have a large difference in distance than the center pixel.
  72381. * See section 2.6.2 http://fileadmin.cs.lth.se/cs/education/edan35/lectures/12dof.pdf
  72382. */
  72383. export class DepthOfFieldBlurPostProcess extends BlurPostProcess {
  72384. direction: Vector2;
  72385. /**
  72386. * Creates a new instance CircleOfConfusionPostProcess
  72387. * @param name The name of the effect.
  72388. * @param scene The scene the effect belongs to.
  72389. * @param direction The direction the blur should be applied.
  72390. * @param kernel The size of the kernel used to blur.
  72391. * @param options The required width/height ratio to downsize to before computing the render pass.
  72392. * @param camera The camera to apply the render pass to.
  72393. * @param circleOfConfusion The circle of confusion + depth map to be used to avoid blurring accross edges
  72394. * @param imageToBlur The image to apply the blur to (default: Current rendered frame)
  72395. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  72396. * @param engine The engine which the post process will be applied. (default: current engine)
  72397. * @param reusable If the post process can be reused on the same frame. (default: false)
  72398. * @param textureType Type of textures used when performing the post process. (default: 0)
  72399. * @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)
  72400. */
  72401. 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);
  72402. }
  72403. }
  72404. declare module "babylonjs/Shaders/depthOfFieldMerge.fragment" {
  72405. /** @hidden */
  72406. export var depthOfFieldMergePixelShader: {
  72407. name: string;
  72408. shader: string;
  72409. };
  72410. }
  72411. declare module "babylonjs/PostProcesses/depthOfFieldMergePostProcess" {
  72412. import { Nullable } from "babylonjs/types";
  72413. import { Camera } from "babylonjs/Cameras/camera";
  72414. import { Effect } from "babylonjs/Materials/effect";
  72415. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72416. import { Engine } from "babylonjs/Engines/engine";
  72417. import "babylonjs/Shaders/depthOfFieldMerge.fragment";
  72418. /**
  72419. * Options to be set when merging outputs from the default pipeline.
  72420. */
  72421. export class DepthOfFieldMergePostProcessOptions {
  72422. /**
  72423. * The original image to merge on top of
  72424. */
  72425. originalFromInput: PostProcess;
  72426. /**
  72427. * Parameters to perform the merge of the depth of field effect
  72428. */
  72429. depthOfField?: {
  72430. circleOfConfusion: PostProcess;
  72431. blurSteps: Array<PostProcess>;
  72432. };
  72433. /**
  72434. * Parameters to perform the merge of bloom effect
  72435. */
  72436. bloom?: {
  72437. blurred: PostProcess;
  72438. weight: number;
  72439. };
  72440. }
  72441. /**
  72442. * The DepthOfFieldMergePostProcess merges blurred images with the original based on the values of the circle of confusion.
  72443. */
  72444. export class DepthOfFieldMergePostProcess extends PostProcess {
  72445. private blurSteps;
  72446. /**
  72447. * Creates a new instance of DepthOfFieldMergePostProcess
  72448. * @param name The name of the effect.
  72449. * @param originalFromInput Post process which's input will be used for the merge.
  72450. * @param circleOfConfusion Circle of confusion post process which's output will be used to blur each pixel.
  72451. * @param blurSteps Blur post processes from low to high which will be mixed with the original image.
  72452. * @param options The required width/height ratio to downsize to before computing the render pass.
  72453. * @param camera The camera to apply the render pass to.
  72454. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  72455. * @param engine The engine which the post process will be applied. (default: current engine)
  72456. * @param reusable If the post process can be reused on the same frame. (default: false)
  72457. * @param textureType Type of textures used when performing the post process. (default: 0)
  72458. * @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)
  72459. */
  72460. 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);
  72461. /**
  72462. * Updates the effect with the current post process compile time values and recompiles the shader.
  72463. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  72464. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  72465. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  72466. * @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
  72467. * @param onCompiled Called when the shader has been compiled.
  72468. * @param onError Called if there is an error when compiling a shader.
  72469. */
  72470. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  72471. }
  72472. }
  72473. declare module "babylonjs/PostProcesses/depthOfFieldEffect" {
  72474. import { Nullable } from "babylonjs/types";
  72475. import { Camera } from "babylonjs/Cameras/camera";
  72476. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  72477. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  72478. import { PostProcessRenderEffect } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect";
  72479. import { DepthOfFieldBlurPostProcess } from "babylonjs/PostProcesses/depthOfFieldBlurPostProcess";
  72480. import { Scene } from "babylonjs/scene";
  72481. /**
  72482. * Specifies the level of max blur that should be applied when using the depth of field effect
  72483. */
  72484. export enum DepthOfFieldEffectBlurLevel {
  72485. /**
  72486. * Subtle blur
  72487. */
  72488. Low = 0,
  72489. /**
  72490. * Medium blur
  72491. */
  72492. Medium = 1,
  72493. /**
  72494. * Large blur
  72495. */
  72496. High = 2
  72497. }
  72498. /**
  72499. * The depth of field effect applies a blur to objects that are closer or further from where the camera is focusing.
  72500. */
  72501. export class DepthOfFieldEffect extends PostProcessRenderEffect {
  72502. private _circleOfConfusion;
  72503. /**
  72504. * @hidden Internal, blurs from high to low
  72505. */
  72506. _depthOfFieldBlurX: Array<DepthOfFieldBlurPostProcess>;
  72507. private _depthOfFieldBlurY;
  72508. private _dofMerge;
  72509. /**
  72510. * @hidden Internal post processes in depth of field effect
  72511. */
  72512. _effects: Array<PostProcess>;
  72513. /**
  72514. * The focal the length of the camera used in the effect in scene units/1000 (eg. millimeter)
  72515. */
  72516. set focalLength(value: number);
  72517. get focalLength(): number;
  72518. /**
  72519. * F-Stop of the effect's camera. The diameter of the resulting aperture can be computed by lensSize/fStop. (default: 1.4)
  72520. */
  72521. set fStop(value: number);
  72522. get fStop(): number;
  72523. /**
  72524. * Distance away from the camera to focus on in scene units/1000 (eg. millimeter). (default: 2000)
  72525. */
  72526. set focusDistance(value: number);
  72527. get focusDistance(): number;
  72528. /**
  72529. * 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.
  72530. */
  72531. set lensSize(value: number);
  72532. get lensSize(): number;
  72533. /**
  72534. * Creates a new instance DepthOfFieldEffect
  72535. * @param scene The scene the effect belongs to.
  72536. * @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.
  72537. * @param pipelineTextureType The type of texture to be used when performing the post processing.
  72538. * @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)
  72539. */
  72540. constructor(scene: Scene, depthTexture: Nullable<RenderTargetTexture>, blurLevel?: DepthOfFieldEffectBlurLevel, pipelineTextureType?: number, blockCompilation?: boolean);
  72541. /**
  72542. * Get the current class name of the current effet
  72543. * @returns "DepthOfFieldEffect"
  72544. */
  72545. getClassName(): string;
  72546. /**
  72547. * 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.
  72548. */
  72549. set depthTexture(value: RenderTargetTexture);
  72550. /**
  72551. * Disposes each of the internal effects for a given camera.
  72552. * @param camera The camera to dispose the effect on.
  72553. */
  72554. disposeEffects(camera: Camera): void;
  72555. /**
  72556. * @hidden Internal
  72557. */
  72558. _updateEffects(): void;
  72559. /**
  72560. * Internal
  72561. * @returns if all the contained post processes are ready.
  72562. * @hidden
  72563. */
  72564. _isReady(): boolean;
  72565. }
  72566. }
  72567. declare module "babylonjs/Shaders/displayPass.fragment" {
  72568. /** @hidden */
  72569. export var displayPassPixelShader: {
  72570. name: string;
  72571. shader: string;
  72572. };
  72573. }
  72574. declare module "babylonjs/PostProcesses/displayPassPostProcess" {
  72575. import { Nullable } from "babylonjs/types";
  72576. import { Camera } from "babylonjs/Cameras/camera";
  72577. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72578. import { Engine } from "babylonjs/Engines/engine";
  72579. import "babylonjs/Shaders/displayPass.fragment";
  72580. /**
  72581. * DisplayPassPostProcess which produces an output the same as it's input
  72582. */
  72583. export class DisplayPassPostProcess extends PostProcess {
  72584. /**
  72585. * Creates the DisplayPassPostProcess
  72586. * @param name The name of the effect.
  72587. * @param options The required width/height ratio to downsize to before computing the render pass.
  72588. * @param camera The camera to apply the render pass to.
  72589. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  72590. * @param engine The engine which the post process will be applied. (default: current engine)
  72591. * @param reusable If the post process can be reused on the same frame. (default: false)
  72592. */
  72593. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean);
  72594. }
  72595. }
  72596. declare module "babylonjs/Shaders/filter.fragment" {
  72597. /** @hidden */
  72598. export var filterPixelShader: {
  72599. name: string;
  72600. shader: string;
  72601. };
  72602. }
  72603. declare module "babylonjs/PostProcesses/filterPostProcess" {
  72604. import { Nullable } from "babylonjs/types";
  72605. import { Matrix } from "babylonjs/Maths/math.vector";
  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/filter.fragment";
  72610. /**
  72611. * Applies a kernel filter to the image
  72612. */
  72613. export class FilterPostProcess extends PostProcess {
  72614. /** The matrix to be applied to the image */
  72615. kernelMatrix: Matrix;
  72616. /**
  72617. *
  72618. * @param name The name of the effect.
  72619. * @param kernelMatrix The matrix to be applied to the image
  72620. * @param options The required width/height ratio to downsize to before computing the render pass.
  72621. * @param camera The camera to apply the render pass to.
  72622. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  72623. * @param engine The engine which the post process will be applied. (default: current engine)
  72624. * @param reusable If the post process can be reused on the same frame. (default: false)
  72625. */
  72626. constructor(name: string,
  72627. /** The matrix to be applied to the image */
  72628. kernelMatrix: Matrix, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean);
  72629. }
  72630. }
  72631. declare module "babylonjs/Shaders/fxaa.fragment" {
  72632. /** @hidden */
  72633. export var fxaaPixelShader: {
  72634. name: string;
  72635. shader: string;
  72636. };
  72637. }
  72638. declare module "babylonjs/Shaders/fxaa.vertex" {
  72639. /** @hidden */
  72640. export var fxaaVertexShader: {
  72641. name: string;
  72642. shader: string;
  72643. };
  72644. }
  72645. declare module "babylonjs/PostProcesses/fxaaPostProcess" {
  72646. import { Nullable } from "babylonjs/types";
  72647. import { Camera } from "babylonjs/Cameras/camera";
  72648. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72649. import { Engine } from "babylonjs/Engines/engine";
  72650. import "babylonjs/Shaders/fxaa.fragment";
  72651. import "babylonjs/Shaders/fxaa.vertex";
  72652. /**
  72653. * Fxaa post process
  72654. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#fxaa
  72655. */
  72656. export class FxaaPostProcess extends PostProcess {
  72657. /** @hidden */
  72658. texelWidth: number;
  72659. /** @hidden */
  72660. texelHeight: number;
  72661. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  72662. private _getDefines;
  72663. }
  72664. }
  72665. declare module "babylonjs/Shaders/grain.fragment" {
  72666. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  72667. /** @hidden */
  72668. export var grainPixelShader: {
  72669. name: string;
  72670. shader: string;
  72671. };
  72672. }
  72673. declare module "babylonjs/PostProcesses/grainPostProcess" {
  72674. import { Nullable } from "babylonjs/types";
  72675. import { Camera } from "babylonjs/Cameras/camera";
  72676. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72677. import { Engine } from "babylonjs/Engines/engine";
  72678. import "babylonjs/Shaders/grain.fragment";
  72679. /**
  72680. * The GrainPostProcess adds noise to the image at mid luminance levels
  72681. */
  72682. export class GrainPostProcess extends PostProcess {
  72683. /**
  72684. * The intensity of the grain added (default: 30)
  72685. */
  72686. intensity: number;
  72687. /**
  72688. * If the grain should be randomized on every frame
  72689. */
  72690. animated: boolean;
  72691. /**
  72692. * Creates a new instance of @see GrainPostProcess
  72693. * @param name The name of the effect.
  72694. * @param options The required width/height ratio to downsize to before computing the render pass.
  72695. * @param camera The camera to apply the render pass to.
  72696. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  72697. * @param engine The engine which the post process will be applied. (default: current engine)
  72698. * @param reusable If the post process can be reused on the same frame. (default: false)
  72699. * @param textureType Type of textures used when performing the post process. (default: 0)
  72700. * @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)
  72701. */
  72702. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  72703. }
  72704. }
  72705. declare module "babylonjs/Shaders/highlights.fragment" {
  72706. /** @hidden */
  72707. export var highlightsPixelShader: {
  72708. name: string;
  72709. shader: string;
  72710. };
  72711. }
  72712. declare module "babylonjs/PostProcesses/highlightsPostProcess" {
  72713. import { Nullable } from "babylonjs/types";
  72714. import { Camera } from "babylonjs/Cameras/camera";
  72715. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72716. import { Engine } from "babylonjs/Engines/engine";
  72717. import "babylonjs/Shaders/highlights.fragment";
  72718. /**
  72719. * Extracts highlights from the image
  72720. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  72721. */
  72722. export class HighlightsPostProcess extends PostProcess {
  72723. /**
  72724. * Extracts highlights from the image
  72725. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  72726. * @param name The name of the effect.
  72727. * @param options The required width/height ratio to downsize to before computing the render pass.
  72728. * @param camera The camera to apply the render pass to.
  72729. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  72730. * @param engine The engine which the post process will be applied. (default: current engine)
  72731. * @param reusable If the post process can be reused on the same frame. (default: false)
  72732. * @param textureType Type of texture for the post process (default: Engine.TEXTURETYPE_UNSIGNED_INT)
  72733. */
  72734. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  72735. }
  72736. }
  72737. declare module "babylonjs/Shaders/ShadersInclude/mrtFragmentDeclaration" {
  72738. /** @hidden */
  72739. export var mrtFragmentDeclaration: {
  72740. name: string;
  72741. shader: string;
  72742. };
  72743. }
  72744. declare module "babylonjs/Shaders/geometry.fragment" {
  72745. import "babylonjs/Shaders/ShadersInclude/mrtFragmentDeclaration";
  72746. import "babylonjs/Shaders/ShadersInclude/bumpFragmentMainFunctions";
  72747. import "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions";
  72748. import "babylonjs/Shaders/ShadersInclude/bumpFragment";
  72749. /** @hidden */
  72750. export var geometryPixelShader: {
  72751. name: string;
  72752. shader: string;
  72753. };
  72754. }
  72755. declare module "babylonjs/Shaders/geometry.vertex" {
  72756. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  72757. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  72758. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  72759. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  72760. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  72761. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  72762. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  72763. import "babylonjs/Shaders/ShadersInclude/bumpVertex";
  72764. /** @hidden */
  72765. export var geometryVertexShader: {
  72766. name: string;
  72767. shader: string;
  72768. };
  72769. }
  72770. declare module "babylonjs/Rendering/geometryBufferRenderer" {
  72771. import { Matrix } from "babylonjs/Maths/math.vector";
  72772. import { SubMesh } from "babylonjs/Meshes/subMesh";
  72773. import { Mesh } from "babylonjs/Meshes/mesh";
  72774. import { MultiRenderTarget } from "babylonjs/Materials/Textures/multiRenderTarget";
  72775. import { Effect } from "babylonjs/Materials/effect";
  72776. import { Scene } from "babylonjs/scene";
  72777. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  72778. import "babylonjs/Shaders/geometry.fragment";
  72779. import "babylonjs/Shaders/geometry.vertex";
  72780. /** @hidden */
  72781. interface ISavedTransformationMatrix {
  72782. world: Matrix;
  72783. viewProjection: Matrix;
  72784. }
  72785. /**
  72786. * This renderer is helpfull to fill one of the render target with a geometry buffer.
  72787. */
  72788. export class GeometryBufferRenderer {
  72789. /**
  72790. * Constant used to retrieve the position texture index in the G-Buffer textures array
  72791. * using getIndex(GeometryBufferRenderer.POSITION_TEXTURE_INDEX)
  72792. */
  72793. static readonly POSITION_TEXTURE_TYPE: number;
  72794. /**
  72795. * Constant used to retrieve the velocity texture index in the G-Buffer textures array
  72796. * using getIndex(GeometryBufferRenderer.VELOCITY_TEXTURE_INDEX)
  72797. */
  72798. static readonly VELOCITY_TEXTURE_TYPE: number;
  72799. /**
  72800. * Constant used to retrieve the reflectivity texture index in the G-Buffer textures array
  72801. * using the getIndex(GeometryBufferRenderer.REFLECTIVITY_TEXTURE_TYPE)
  72802. */
  72803. static readonly REFLECTIVITY_TEXTURE_TYPE: number;
  72804. /**
  72805. * Dictionary used to store the previous transformation matrices of each rendered mesh
  72806. * in order to compute objects velocities when enableVelocity is set to "true"
  72807. * @hidden
  72808. */
  72809. _previousTransformationMatrices: {
  72810. [index: number]: ISavedTransformationMatrix;
  72811. };
  72812. /**
  72813. * Dictionary used to store the previous bones transformation matrices of each rendered mesh
  72814. * in order to compute objects velocities when enableVelocity is set to "true"
  72815. * @hidden
  72816. */
  72817. _previousBonesTransformationMatrices: {
  72818. [index: number]: Float32Array;
  72819. };
  72820. /**
  72821. * Array used to store the ignored skinned meshes while computing velocity map (typically used by the motion blur post-process).
  72822. * Avoids computing bones velocities and computes only mesh's velocity itself (position, rotation, scaling).
  72823. */
  72824. excludedSkinnedMeshesFromVelocity: AbstractMesh[];
  72825. /** Gets or sets a boolean indicating if transparent meshes should be rendered */
  72826. renderTransparentMeshes: boolean;
  72827. private _scene;
  72828. private _resizeObserver;
  72829. private _multiRenderTarget;
  72830. private _ratio;
  72831. private _enablePosition;
  72832. private _enableVelocity;
  72833. private _enableReflectivity;
  72834. private _positionIndex;
  72835. private _velocityIndex;
  72836. private _reflectivityIndex;
  72837. protected _effect: Effect;
  72838. protected _cachedDefines: string;
  72839. /**
  72840. * Set the render list (meshes to be rendered) used in the G buffer.
  72841. */
  72842. set renderList(meshes: Mesh[]);
  72843. /**
  72844. * Gets wether or not G buffer are supported by the running hardware.
  72845. * This requires draw buffer supports
  72846. */
  72847. get isSupported(): boolean;
  72848. /**
  72849. * Returns the index of the given texture type in the G-Buffer textures array
  72850. * @param textureType The texture type constant. For example GeometryBufferRenderer.POSITION_TEXTURE_INDEX
  72851. * @returns the index of the given texture type in the G-Buffer textures array
  72852. */
  72853. getTextureIndex(textureType: number): number;
  72854. /**
  72855. * Gets a boolean indicating if objects positions are enabled for the G buffer.
  72856. */
  72857. get enablePosition(): boolean;
  72858. /**
  72859. * Sets whether or not objects positions are enabled for the G buffer.
  72860. */
  72861. set enablePosition(enable: boolean);
  72862. /**
  72863. * Gets a boolean indicating if objects velocities are enabled for the G buffer.
  72864. */
  72865. get enableVelocity(): boolean;
  72866. /**
  72867. * Sets wether or not objects velocities are enabled for the G buffer.
  72868. */
  72869. set enableVelocity(enable: boolean);
  72870. /**
  72871. * Gets a boolean indicating if objects roughness are enabled in the G buffer.
  72872. */
  72873. get enableReflectivity(): boolean;
  72874. /**
  72875. * Sets wether or not objects roughness are enabled for the G buffer.
  72876. */
  72877. set enableReflectivity(enable: boolean);
  72878. /**
  72879. * Gets the scene associated with the buffer.
  72880. */
  72881. get scene(): Scene;
  72882. /**
  72883. * Gets the ratio used by the buffer during its creation.
  72884. * How big is the buffer related to the main canvas.
  72885. */
  72886. get ratio(): number;
  72887. /** @hidden */
  72888. static _SceneComponentInitialization: (scene: Scene) => void;
  72889. /**
  72890. * Creates a new G Buffer for the scene
  72891. * @param scene The scene the buffer belongs to
  72892. * @param ratio How big is the buffer related to the main canvas.
  72893. */
  72894. constructor(scene: Scene, ratio?: number);
  72895. /**
  72896. * Checks wether everything is ready to render a submesh to the G buffer.
  72897. * @param subMesh the submesh to check readiness for
  72898. * @param useInstances is the mesh drawn using instance or not
  72899. * @returns true if ready otherwise false
  72900. */
  72901. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  72902. /**
  72903. * Gets the current underlying G Buffer.
  72904. * @returns the buffer
  72905. */
  72906. getGBuffer(): MultiRenderTarget;
  72907. /**
  72908. * Gets the number of samples used to render the buffer (anti aliasing).
  72909. */
  72910. get samples(): number;
  72911. /**
  72912. * Sets the number of samples used to render the buffer (anti aliasing).
  72913. */
  72914. set samples(value: number);
  72915. /**
  72916. * Disposes the renderer and frees up associated resources.
  72917. */
  72918. dispose(): void;
  72919. protected _createRenderTargets(): void;
  72920. private _copyBonesTransformationMatrices;
  72921. }
  72922. }
  72923. declare module "babylonjs/Rendering/geometryBufferRendererSceneComponent" {
  72924. import { Nullable } from "babylonjs/types";
  72925. import { Scene } from "babylonjs/scene";
  72926. import { ISceneComponent } from "babylonjs/sceneComponent";
  72927. import { GeometryBufferRenderer } from "babylonjs/Rendering/geometryBufferRenderer";
  72928. module "babylonjs/scene" {
  72929. interface Scene {
  72930. /** @hidden (Backing field) */
  72931. _geometryBufferRenderer: Nullable<GeometryBufferRenderer>;
  72932. /**
  72933. * Gets or Sets the current geometry buffer associated to the scene.
  72934. */
  72935. geometryBufferRenderer: Nullable<GeometryBufferRenderer>;
  72936. /**
  72937. * Enables a GeometryBufferRender and associates it with the scene
  72938. * @param ratio defines the scaling ratio to apply to the renderer (1 by default which means same resolution)
  72939. * @returns the GeometryBufferRenderer
  72940. */
  72941. enableGeometryBufferRenderer(ratio?: number): Nullable<GeometryBufferRenderer>;
  72942. /**
  72943. * Disables the GeometryBufferRender associated with the scene
  72944. */
  72945. disableGeometryBufferRenderer(): void;
  72946. }
  72947. }
  72948. /**
  72949. * Defines the Geometry Buffer scene component responsible to manage a G-Buffer useful
  72950. * in several rendering techniques.
  72951. */
  72952. export class GeometryBufferRendererSceneComponent implements ISceneComponent {
  72953. /**
  72954. * The component name helpful to identify the component in the list of scene components.
  72955. */
  72956. readonly name: string;
  72957. /**
  72958. * The scene the component belongs to.
  72959. */
  72960. scene: Scene;
  72961. /**
  72962. * Creates a new instance of the component for the given scene
  72963. * @param scene Defines the scene to register the component in
  72964. */
  72965. constructor(scene: Scene);
  72966. /**
  72967. * Registers the component in a given scene
  72968. */
  72969. register(): void;
  72970. /**
  72971. * Rebuilds the elements related to this component in case of
  72972. * context lost for instance.
  72973. */
  72974. rebuild(): void;
  72975. /**
  72976. * Disposes the component and the associated ressources
  72977. */
  72978. dispose(): void;
  72979. private _gatherRenderTargets;
  72980. }
  72981. }
  72982. declare module "babylonjs/Shaders/motionBlur.fragment" {
  72983. /** @hidden */
  72984. export var motionBlurPixelShader: {
  72985. name: string;
  72986. shader: string;
  72987. };
  72988. }
  72989. declare module "babylonjs/PostProcesses/motionBlurPostProcess" {
  72990. import { Nullable } from "babylonjs/types";
  72991. import { Camera } from "babylonjs/Cameras/camera";
  72992. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72993. import { Scene } from "babylonjs/scene";
  72994. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  72995. import "babylonjs/Animations/animatable";
  72996. import "babylonjs/Rendering/geometryBufferRendererSceneComponent";
  72997. import "babylonjs/Shaders/motionBlur.fragment";
  72998. import { Engine } from "babylonjs/Engines/engine";
  72999. /**
  73000. * The Motion Blur Post Process which blurs an image based on the objects velocity in scene.
  73001. * Velocity can be affected by each object's rotation, position and scale depending on the transformation speed.
  73002. * As an example, all you have to do is to create the post-process:
  73003. * var mb = new BABYLON.MotionBlurPostProcess(
  73004. * 'mb', // The name of the effect.
  73005. * scene, // The scene containing the objects to blur according to their velocity.
  73006. * 1.0, // The required width/height ratio to downsize to before computing the render pass.
  73007. * camera // The camera to apply the render pass to.
  73008. * );
  73009. * Then, all objects moving, rotating and/or scaling will be blurred depending on the transformation speed.
  73010. */
  73011. export class MotionBlurPostProcess extends PostProcess {
  73012. /**
  73013. * Defines how much the image is blurred by the movement. Default value is equal to 1
  73014. */
  73015. motionStrength: number;
  73016. /**
  73017. * Gets the number of iterations are used for motion blur quality. Default value is equal to 32
  73018. */
  73019. get motionBlurSamples(): number;
  73020. /**
  73021. * Sets the number of iterations to be used for motion blur quality
  73022. */
  73023. set motionBlurSamples(samples: number);
  73024. private _motionBlurSamples;
  73025. private _geometryBufferRenderer;
  73026. /**
  73027. * Creates a new instance MotionBlurPostProcess
  73028. * @param name The name of the effect.
  73029. * @param scene The scene containing the objects to blur according to their velocity.
  73030. * @param options The required width/height ratio to downsize to before computing the render pass.
  73031. * @param camera The camera to apply the render pass to.
  73032. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73033. * @param engine The engine which the post process will be applied. (default: current engine)
  73034. * @param reusable If the post process can be reused on the same frame. (default: false)
  73035. * @param textureType Type of textures used when performing the post process. (default: 0)
  73036. * @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)
  73037. */
  73038. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  73039. /**
  73040. * Excludes the given skinned mesh from computing bones velocities.
  73041. * 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.
  73042. * @param skinnedMesh The mesh containing the skeleton to ignore when computing the velocity map.
  73043. */
  73044. excludeSkinnedMesh(skinnedMesh: AbstractMesh): void;
  73045. /**
  73046. * Removes the given skinned mesh from the excluded meshes to integrate bones velocities while rendering the velocity map.
  73047. * @param skinnedMesh The mesh containing the skeleton that has been ignored previously.
  73048. * @see excludeSkinnedMesh to exclude a skinned mesh from bones velocity computation.
  73049. */
  73050. removeExcludedSkinnedMesh(skinnedMesh: AbstractMesh): void;
  73051. /**
  73052. * Disposes the post process.
  73053. * @param camera The camera to dispose the post process on.
  73054. */
  73055. dispose(camera?: Camera): void;
  73056. }
  73057. }
  73058. declare module "babylonjs/Shaders/refraction.fragment" {
  73059. /** @hidden */
  73060. export var refractionPixelShader: {
  73061. name: string;
  73062. shader: string;
  73063. };
  73064. }
  73065. declare module "babylonjs/PostProcesses/refractionPostProcess" {
  73066. import { Color3 } from "babylonjs/Maths/math.color";
  73067. import { Camera } from "babylonjs/Cameras/camera";
  73068. import { Texture } from "babylonjs/Materials/Textures/texture";
  73069. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73070. import { Engine } from "babylonjs/Engines/engine";
  73071. import "babylonjs/Shaders/refraction.fragment";
  73072. /**
  73073. * Post process which applies a refractin texture
  73074. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#refraction
  73075. */
  73076. export class RefractionPostProcess extends PostProcess {
  73077. /** the base color of the refraction (used to taint the rendering) */
  73078. color: Color3;
  73079. /** simulated refraction depth */
  73080. depth: number;
  73081. /** the coefficient of the base color (0 to remove base color tainting) */
  73082. colorLevel: number;
  73083. private _refTexture;
  73084. private _ownRefractionTexture;
  73085. /**
  73086. * Gets or sets the refraction texture
  73087. * Please note that you are responsible for disposing the texture if you set it manually
  73088. */
  73089. get refractionTexture(): Texture;
  73090. set refractionTexture(value: Texture);
  73091. /**
  73092. * Initializes the RefractionPostProcess
  73093. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#refraction
  73094. * @param name The name of the effect.
  73095. * @param refractionTextureUrl Url of the refraction texture to use
  73096. * @param color the base color of the refraction (used to taint the rendering)
  73097. * @param depth simulated refraction depth
  73098. * @param colorLevel the coefficient of the base color (0 to remove base color tainting)
  73099. * @param camera The camera to apply the render pass to.
  73100. * @param options The required width/height ratio to downsize to before computing the render pass.
  73101. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73102. * @param engine The engine which the post process will be applied. (default: current engine)
  73103. * @param reusable If the post process can be reused on the same frame. (default: false)
  73104. */
  73105. constructor(name: string, refractionTextureUrl: string,
  73106. /** the base color of the refraction (used to taint the rendering) */
  73107. color: Color3,
  73108. /** simulated refraction depth */
  73109. depth: number,
  73110. /** the coefficient of the base color (0 to remove base color tainting) */
  73111. colorLevel: number, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  73112. /**
  73113. * Disposes of the post process
  73114. * @param camera Camera to dispose post process on
  73115. */
  73116. dispose(camera: Camera): void;
  73117. }
  73118. }
  73119. declare module "babylonjs/Shaders/sharpen.fragment" {
  73120. /** @hidden */
  73121. export var sharpenPixelShader: {
  73122. name: string;
  73123. shader: string;
  73124. };
  73125. }
  73126. declare module "babylonjs/PostProcesses/sharpenPostProcess" {
  73127. import { Nullable } from "babylonjs/types";
  73128. import { Camera } from "babylonjs/Cameras/camera";
  73129. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73130. import "babylonjs/Shaders/sharpen.fragment";
  73131. import { Engine } from "babylonjs/Engines/engine";
  73132. /**
  73133. * The SharpenPostProcess applies a sharpen kernel to every pixel
  73134. * See http://en.wikipedia.org/wiki/Kernel_(image_processing)
  73135. */
  73136. export class SharpenPostProcess extends PostProcess {
  73137. /**
  73138. * How much of the original color should be applied. Setting this to 0 will display edge detection. (default: 1)
  73139. */
  73140. colorAmount: number;
  73141. /**
  73142. * How much sharpness should be applied (default: 0.3)
  73143. */
  73144. edgeAmount: number;
  73145. /**
  73146. * Creates a new instance ConvolutionPostProcess
  73147. * @param name The name of the effect.
  73148. * @param options The required width/height ratio to downsize to before computing the render pass.
  73149. * @param camera The camera to apply the render pass to.
  73150. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73151. * @param engine The engine which the post process will be applied. (default: current engine)
  73152. * @param reusable If the post process can be reused on the same frame. (default: false)
  73153. * @param textureType Type of textures used when performing the post process. (default: 0)
  73154. * @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)
  73155. */
  73156. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  73157. }
  73158. }
  73159. declare module "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline" {
  73160. import { Nullable } from "babylonjs/types";
  73161. import { Camera } from "babylonjs/Cameras/camera";
  73162. import { Engine } from "babylonjs/Engines/engine";
  73163. import { PostProcessRenderEffect } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect";
  73164. import { IInspectable } from "babylonjs/Misc/iInspectable";
  73165. import { PrePassRenderer } from "babylonjs/Rendering/prePassRenderer";
  73166. /**
  73167. * PostProcessRenderPipeline
  73168. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  73169. */
  73170. export class PostProcessRenderPipeline {
  73171. private engine;
  73172. private _renderEffects;
  73173. private _renderEffectsForIsolatedPass;
  73174. /**
  73175. * List of inspectable custom properties (used by the Inspector)
  73176. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  73177. */
  73178. inspectableCustomProperties: IInspectable[];
  73179. /**
  73180. * @hidden
  73181. */
  73182. protected _cameras: Camera[];
  73183. /** @hidden */
  73184. _name: string;
  73185. /**
  73186. * Gets pipeline name
  73187. */
  73188. get name(): string;
  73189. /** Gets the list of attached cameras */
  73190. get cameras(): Camera[];
  73191. /**
  73192. * Initializes a PostProcessRenderPipeline
  73193. * @param engine engine to add the pipeline to
  73194. * @param name name of the pipeline
  73195. */
  73196. constructor(engine: Engine, name: string);
  73197. /**
  73198. * Gets the class name
  73199. * @returns "PostProcessRenderPipeline"
  73200. */
  73201. getClassName(): string;
  73202. /**
  73203. * If all the render effects in the pipeline are supported
  73204. */
  73205. get isSupported(): boolean;
  73206. /**
  73207. * Adds an effect to the pipeline
  73208. * @param renderEffect the effect to add
  73209. */
  73210. addEffect(renderEffect: PostProcessRenderEffect): void;
  73211. /** @hidden */
  73212. _rebuild(): void;
  73213. /** @hidden */
  73214. _enableEffect(renderEffectName: string, cameras: Camera): void;
  73215. /** @hidden */
  73216. _enableEffect(renderEffectName: string, cameras: Camera[]): void;
  73217. /** @hidden */
  73218. _disableEffect(renderEffectName: string, cameras: Nullable<Camera[]>): void;
  73219. /** @hidden */
  73220. _disableEffect(renderEffectName: string, cameras: Nullable<Camera[]>): void;
  73221. /** @hidden */
  73222. _attachCameras(cameras: Camera, unique: boolean): void;
  73223. /** @hidden */
  73224. _attachCameras(cameras: Camera[], unique: boolean): void;
  73225. /** @hidden */
  73226. _detachCameras(cameras: Camera): void;
  73227. /** @hidden */
  73228. _detachCameras(cameras: Nullable<Camera[]>): void;
  73229. /** @hidden */
  73230. _update(): void;
  73231. /** @hidden */
  73232. _reset(): void;
  73233. protected _enableMSAAOnFirstPostProcess(sampleCount: number): boolean;
  73234. /**
  73235. * Sets the required values to the prepass renderer.
  73236. * @param prePassRenderer defines the prepass renderer to setup.
  73237. * @returns true if the pre pass is needed.
  73238. */
  73239. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  73240. /**
  73241. * Disposes of the pipeline
  73242. */
  73243. dispose(): void;
  73244. }
  73245. }
  73246. declare module "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManager" {
  73247. import { Camera } from "babylonjs/Cameras/camera";
  73248. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  73249. /**
  73250. * PostProcessRenderPipelineManager class
  73251. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  73252. */
  73253. export class PostProcessRenderPipelineManager {
  73254. private _renderPipelines;
  73255. /**
  73256. * Initializes a PostProcessRenderPipelineManager
  73257. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  73258. */
  73259. constructor();
  73260. /**
  73261. * Gets the list of supported render pipelines
  73262. */
  73263. get supportedPipelines(): PostProcessRenderPipeline[];
  73264. /**
  73265. * Adds a pipeline to the manager
  73266. * @param renderPipeline The pipeline to add
  73267. */
  73268. addPipeline(renderPipeline: PostProcessRenderPipeline): void;
  73269. /**
  73270. * Attaches a camera to the pipeline
  73271. * @param renderPipelineName The name of the pipeline to attach to
  73272. * @param cameras the camera to attach
  73273. * @param unique if the camera can be attached multiple times to the pipeline
  73274. */
  73275. attachCamerasToRenderPipeline(renderPipelineName: string, cameras: any | Camera[] | Camera, unique?: boolean): void;
  73276. /**
  73277. * Detaches a camera from the pipeline
  73278. * @param renderPipelineName The name of the pipeline to detach from
  73279. * @param cameras the camera to detach
  73280. */
  73281. detachCamerasFromRenderPipeline(renderPipelineName: string, cameras: any | Camera[] | Camera): void;
  73282. /**
  73283. * Enables an effect by name on a pipeline
  73284. * @param renderPipelineName the name of the pipeline to enable the effect in
  73285. * @param renderEffectName the name of the effect to enable
  73286. * @param cameras the cameras that the effect should be enabled on
  73287. */
  73288. enableEffectInPipeline(renderPipelineName: string, renderEffectName: string, cameras: any | Camera[] | Camera): void;
  73289. /**
  73290. * Disables an effect by name on a pipeline
  73291. * @param renderPipelineName the name of the pipeline to disable the effect in
  73292. * @param renderEffectName the name of the effect to disable
  73293. * @param cameras the cameras that the effect should be disabled on
  73294. */
  73295. disableEffectInPipeline(renderPipelineName: string, renderEffectName: string, cameras: any | Camera[] | Camera): void;
  73296. /**
  73297. * Updates the state of all contained render pipelines and disposes of any non supported pipelines
  73298. */
  73299. update(): void;
  73300. /** @hidden */
  73301. _rebuild(): void;
  73302. /**
  73303. * Disposes of the manager and pipelines
  73304. */
  73305. dispose(): void;
  73306. }
  73307. }
  73308. declare module "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent" {
  73309. import { ISceneComponent } from "babylonjs/sceneComponent";
  73310. import { PostProcessRenderPipelineManager } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManager";
  73311. import { Scene } from "babylonjs/scene";
  73312. module "babylonjs/scene" {
  73313. interface Scene {
  73314. /** @hidden (Backing field) */
  73315. _postProcessRenderPipelineManager: PostProcessRenderPipelineManager;
  73316. /**
  73317. * Gets the postprocess render pipeline manager
  73318. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  73319. * @see https://doc.babylonjs.com/how_to/using_default_rendering_pipeline
  73320. */
  73321. readonly postProcessRenderPipelineManager: PostProcessRenderPipelineManager;
  73322. }
  73323. }
  73324. /**
  73325. * Defines the Render Pipeline scene component responsible to rendering pipelines
  73326. */
  73327. export class PostProcessRenderPipelineManagerSceneComponent implements ISceneComponent {
  73328. /**
  73329. * The component name helpfull to identify the component in the list of scene components.
  73330. */
  73331. readonly name: string;
  73332. /**
  73333. * The scene the component belongs to.
  73334. */
  73335. scene: Scene;
  73336. /**
  73337. * Creates a new instance of the component for the given scene
  73338. * @param scene Defines the scene to register the component in
  73339. */
  73340. constructor(scene: Scene);
  73341. /**
  73342. * Registers the component in a given scene
  73343. */
  73344. register(): void;
  73345. /**
  73346. * Rebuilds the elements related to this component in case of
  73347. * context lost for instance.
  73348. */
  73349. rebuild(): void;
  73350. /**
  73351. * Disposes the component and the associated ressources
  73352. */
  73353. dispose(): void;
  73354. private _gatherRenderTargets;
  73355. }
  73356. }
  73357. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/defaultRenderingPipeline" {
  73358. import { Nullable } from "babylonjs/types";
  73359. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  73360. import { Camera } from "babylonjs/Cameras/camera";
  73361. import { IDisposable } from "babylonjs/scene";
  73362. import { GlowLayer } from "babylonjs/Layers/glowLayer";
  73363. import { Scene } from "babylonjs/scene";
  73364. import { SharpenPostProcess } from "babylonjs/PostProcesses/sharpenPostProcess";
  73365. import { ImageProcessingPostProcess } from "babylonjs/PostProcesses/imageProcessingPostProcess";
  73366. import { ChromaticAberrationPostProcess } from "babylonjs/PostProcesses/chromaticAberrationPostProcess";
  73367. import { GrainPostProcess } from "babylonjs/PostProcesses/grainPostProcess";
  73368. import { FxaaPostProcess } from "babylonjs/PostProcesses/fxaaPostProcess";
  73369. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  73370. import { DepthOfFieldEffect, DepthOfFieldEffectBlurLevel } from "babylonjs/PostProcesses/depthOfFieldEffect";
  73371. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  73372. import { Animation } from "babylonjs/Animations/animation";
  73373. /**
  73374. * The default rendering pipeline can be added to a scene to apply common post processing effects such as anti-aliasing or depth of field.
  73375. * See https://doc.babylonjs.com/how_to/using_default_rendering_pipeline
  73376. */
  73377. export class DefaultRenderingPipeline extends PostProcessRenderPipeline implements IDisposable, IAnimatable {
  73378. private _scene;
  73379. private _camerasToBeAttached;
  73380. /**
  73381. * ID of the sharpen post process,
  73382. */
  73383. private readonly SharpenPostProcessId;
  73384. /**
  73385. * @ignore
  73386. * ID of the image processing post process;
  73387. */
  73388. readonly ImageProcessingPostProcessId: string;
  73389. /**
  73390. * @ignore
  73391. * ID of the Fast Approximate Anti-Aliasing post process;
  73392. */
  73393. readonly FxaaPostProcessId: string;
  73394. /**
  73395. * ID of the chromatic aberration post process,
  73396. */
  73397. private readonly ChromaticAberrationPostProcessId;
  73398. /**
  73399. * ID of the grain post process
  73400. */
  73401. private readonly GrainPostProcessId;
  73402. /**
  73403. * Sharpen post process which will apply a sharpen convolution to enhance edges
  73404. */
  73405. sharpen: SharpenPostProcess;
  73406. private _sharpenEffect;
  73407. private bloom;
  73408. /**
  73409. * Depth of field effect, applies a blur based on how far away objects are from the focus distance.
  73410. */
  73411. depthOfField: DepthOfFieldEffect;
  73412. /**
  73413. * The Fast Approximate Anti-Aliasing post process which attemps to remove aliasing from an image.
  73414. */
  73415. fxaa: FxaaPostProcess;
  73416. /**
  73417. * Image post processing pass used to perform operations such as tone mapping or color grading.
  73418. */
  73419. imageProcessing: ImageProcessingPostProcess;
  73420. /**
  73421. * Chromatic aberration post process which will shift rgb colors in the image
  73422. */
  73423. chromaticAberration: ChromaticAberrationPostProcess;
  73424. private _chromaticAberrationEffect;
  73425. /**
  73426. * Grain post process which add noise to the image
  73427. */
  73428. grain: GrainPostProcess;
  73429. private _grainEffect;
  73430. /**
  73431. * Glow post process which adds a glow to emissive areas of the image
  73432. */
  73433. private _glowLayer;
  73434. /**
  73435. * Animations which can be used to tweak settings over a period of time
  73436. */
  73437. animations: Animation[];
  73438. private _imageProcessingConfigurationObserver;
  73439. private _sharpenEnabled;
  73440. private _bloomEnabled;
  73441. private _depthOfFieldEnabled;
  73442. private _depthOfFieldBlurLevel;
  73443. private _fxaaEnabled;
  73444. private _imageProcessingEnabled;
  73445. private _defaultPipelineTextureType;
  73446. private _bloomScale;
  73447. private _chromaticAberrationEnabled;
  73448. private _grainEnabled;
  73449. private _buildAllowed;
  73450. /**
  73451. * Gets active scene
  73452. */
  73453. get scene(): Scene;
  73454. /**
  73455. * Enable or disable the sharpen process from the pipeline
  73456. */
  73457. set sharpenEnabled(enabled: boolean);
  73458. get sharpenEnabled(): boolean;
  73459. private _resizeObserver;
  73460. private _hardwareScaleLevel;
  73461. private _bloomKernel;
  73462. /**
  73463. * Specifies the size of the bloom blur kernel, relative to the final output size
  73464. */
  73465. get bloomKernel(): number;
  73466. set bloomKernel(value: number);
  73467. /**
  73468. * Specifies the weight of the bloom in the final rendering
  73469. */
  73470. private _bloomWeight;
  73471. /**
  73472. * Specifies the luma threshold for the area that will be blurred by the bloom
  73473. */
  73474. private _bloomThreshold;
  73475. private _hdr;
  73476. /**
  73477. * The strength of the bloom.
  73478. */
  73479. set bloomWeight(value: number);
  73480. get bloomWeight(): number;
  73481. /**
  73482. * The strength of the bloom.
  73483. */
  73484. set bloomThreshold(value: number);
  73485. get bloomThreshold(): number;
  73486. /**
  73487. * The scale of the bloom, lower value will provide better performance.
  73488. */
  73489. set bloomScale(value: number);
  73490. get bloomScale(): number;
  73491. /**
  73492. * Enable or disable the bloom from the pipeline
  73493. */
  73494. set bloomEnabled(enabled: boolean);
  73495. get bloomEnabled(): boolean;
  73496. private _rebuildBloom;
  73497. /**
  73498. * If the depth of field is enabled.
  73499. */
  73500. get depthOfFieldEnabled(): boolean;
  73501. set depthOfFieldEnabled(enabled: boolean);
  73502. /**
  73503. * Blur level of the depth of field effect. (Higher blur will effect performance)
  73504. */
  73505. get depthOfFieldBlurLevel(): DepthOfFieldEffectBlurLevel;
  73506. set depthOfFieldBlurLevel(value: DepthOfFieldEffectBlurLevel);
  73507. /**
  73508. * If the anti aliasing is enabled.
  73509. */
  73510. set fxaaEnabled(enabled: boolean);
  73511. get fxaaEnabled(): boolean;
  73512. private _samples;
  73513. /**
  73514. * MSAA sample count, setting this to 4 will provide 4x anti aliasing. (default: 1)
  73515. */
  73516. set samples(sampleCount: number);
  73517. get samples(): number;
  73518. /**
  73519. * If image processing is enabled.
  73520. */
  73521. set imageProcessingEnabled(enabled: boolean);
  73522. get imageProcessingEnabled(): boolean;
  73523. /**
  73524. * If glow layer is enabled. (Adds a glow effect to emmissive materials)
  73525. */
  73526. set glowLayerEnabled(enabled: boolean);
  73527. get glowLayerEnabled(): boolean;
  73528. /**
  73529. * Gets the glow layer (or null if not defined)
  73530. */
  73531. get glowLayer(): Nullable<GlowLayer>;
  73532. /**
  73533. * Enable or disable the chromaticAberration process from the pipeline
  73534. */
  73535. set chromaticAberrationEnabled(enabled: boolean);
  73536. get chromaticAberrationEnabled(): boolean;
  73537. /**
  73538. * Enable or disable the grain process from the pipeline
  73539. */
  73540. set grainEnabled(enabled: boolean);
  73541. get grainEnabled(): boolean;
  73542. /**
  73543. * @constructor
  73544. * @param name - The rendering pipeline name (default: "")
  73545. * @param hdr - If high dynamic range textures should be used (default: true)
  73546. * @param scene - The scene linked to this pipeline (default: the last created scene)
  73547. * @param cameras - The array of cameras that the rendering pipeline will be attached to (default: scene.cameras)
  73548. * @param automaticBuild - if false, you will have to manually call prepare() to update the pipeline (default: true)
  73549. */
  73550. constructor(name?: string, hdr?: boolean, scene?: Scene, cameras?: Camera[], automaticBuild?: boolean);
  73551. /**
  73552. * Get the class name
  73553. * @returns "DefaultRenderingPipeline"
  73554. */
  73555. getClassName(): string;
  73556. /**
  73557. * Force the compilation of the entire pipeline.
  73558. */
  73559. prepare(): void;
  73560. private _hasCleared;
  73561. private _prevPostProcess;
  73562. private _prevPrevPostProcess;
  73563. private _setAutoClearAndTextureSharing;
  73564. private _depthOfFieldSceneObserver;
  73565. private _buildPipeline;
  73566. private _disposePostProcesses;
  73567. /**
  73568. * Adds a camera to the pipeline
  73569. * @param camera the camera to be added
  73570. */
  73571. addCamera(camera: Camera): void;
  73572. /**
  73573. * Removes a camera from the pipeline
  73574. * @param camera the camera to remove
  73575. */
  73576. removeCamera(camera: Camera): void;
  73577. /**
  73578. * Dispose of the pipeline and stop all post processes
  73579. */
  73580. dispose(): void;
  73581. /**
  73582. * Serialize the rendering pipeline (Used when exporting)
  73583. * @returns the serialized object
  73584. */
  73585. serialize(): any;
  73586. /**
  73587. * Parse the serialized pipeline
  73588. * @param source Source pipeline.
  73589. * @param scene The scene to load the pipeline to.
  73590. * @param rootUrl The URL of the serialized pipeline.
  73591. * @returns An instantiated pipeline from the serialized object.
  73592. */
  73593. static Parse(source: any, scene: Scene, rootUrl: string): DefaultRenderingPipeline;
  73594. }
  73595. }
  73596. declare module "babylonjs/Shaders/lensHighlights.fragment" {
  73597. /** @hidden */
  73598. export var lensHighlightsPixelShader: {
  73599. name: string;
  73600. shader: string;
  73601. };
  73602. }
  73603. declare module "babylonjs/Shaders/depthOfField.fragment" {
  73604. /** @hidden */
  73605. export var depthOfFieldPixelShader: {
  73606. name: string;
  73607. shader: string;
  73608. };
  73609. }
  73610. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/lensRenderingPipeline" {
  73611. import { Camera } from "babylonjs/Cameras/camera";
  73612. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  73613. import { Scene } from "babylonjs/scene";
  73614. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  73615. import "babylonjs/Shaders/chromaticAberration.fragment";
  73616. import "babylonjs/Shaders/lensHighlights.fragment";
  73617. import "babylonjs/Shaders/depthOfField.fragment";
  73618. /**
  73619. * BABYLON.JS Chromatic Aberration GLSL Shader
  73620. * Author: Olivier Guyot
  73621. * Separates very slightly R, G and B colors on the edges of the screen
  73622. * Inspired by Francois Tarlier & Martins Upitis
  73623. */
  73624. export class LensRenderingPipeline extends PostProcessRenderPipeline {
  73625. /**
  73626. * @ignore
  73627. * The chromatic aberration PostProcess id in the pipeline
  73628. */
  73629. LensChromaticAberrationEffect: string;
  73630. /**
  73631. * @ignore
  73632. * The highlights enhancing PostProcess id in the pipeline
  73633. */
  73634. HighlightsEnhancingEffect: string;
  73635. /**
  73636. * @ignore
  73637. * The depth-of-field PostProcess id in the pipeline
  73638. */
  73639. LensDepthOfFieldEffect: string;
  73640. private _scene;
  73641. private _depthTexture;
  73642. private _grainTexture;
  73643. private _chromaticAberrationPostProcess;
  73644. private _highlightsPostProcess;
  73645. private _depthOfFieldPostProcess;
  73646. private _edgeBlur;
  73647. private _grainAmount;
  73648. private _chromaticAberration;
  73649. private _distortion;
  73650. private _highlightsGain;
  73651. private _highlightsThreshold;
  73652. private _dofDistance;
  73653. private _dofAperture;
  73654. private _dofDarken;
  73655. private _dofPentagon;
  73656. private _blurNoise;
  73657. /**
  73658. * @constructor
  73659. *
  73660. * Effect parameters are as follow:
  73661. * {
  73662. * chromatic_aberration: number; // from 0 to x (1 for realism)
  73663. * edge_blur: number; // from 0 to x (1 for realism)
  73664. * distortion: number; // from 0 to x (1 for realism)
  73665. * grain_amount: number; // from 0 to 1
  73666. * grain_texture: BABYLON.Texture; // texture to use for grain effect; if unset, use random B&W noise
  73667. * dof_focus_distance: number; // depth-of-field: focus distance; unset to disable (disabled by default)
  73668. * dof_aperture: number; // depth-of-field: focus blur bias (default: 1)
  73669. * dof_darken: number; // depth-of-field: darken that which is out of focus (from 0 to 1, disabled by default)
  73670. * dof_pentagon: boolean; // depth-of-field: makes a pentagon-like "bokeh" effect
  73671. * dof_gain: number; // depth-of-field: highlights gain; unset to disable (disabled by default)
  73672. * dof_threshold: number; // depth-of-field: highlights threshold (default: 1)
  73673. * blur_noise: boolean; // add a little bit of noise to the blur (default: true)
  73674. * }
  73675. * Note: if an effect parameter is unset, effect is disabled
  73676. *
  73677. * @param name The rendering pipeline name
  73678. * @param parameters - An object containing all parameters (see above)
  73679. * @param scene The scene linked to this pipeline
  73680. * @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)
  73681. * @param cameras The array of cameras that the rendering pipeline will be attached to
  73682. */
  73683. constructor(name: string, parameters: any, scene: Scene, ratio?: number, cameras?: Camera[]);
  73684. /**
  73685. * Get the class name
  73686. * @returns "LensRenderingPipeline"
  73687. */
  73688. getClassName(): string;
  73689. /**
  73690. * Gets associated scene
  73691. */
  73692. get scene(): Scene;
  73693. /**
  73694. * Gets or sets the edge blur
  73695. */
  73696. get edgeBlur(): number;
  73697. set edgeBlur(value: number);
  73698. /**
  73699. * Gets or sets the grain amount
  73700. */
  73701. get grainAmount(): number;
  73702. set grainAmount(value: number);
  73703. /**
  73704. * Gets or sets the chromatic aberration amount
  73705. */
  73706. get chromaticAberration(): number;
  73707. set chromaticAberration(value: number);
  73708. /**
  73709. * Gets or sets the depth of field aperture
  73710. */
  73711. get dofAperture(): number;
  73712. set dofAperture(value: number);
  73713. /**
  73714. * Gets or sets the edge distortion
  73715. */
  73716. get edgeDistortion(): number;
  73717. set edgeDistortion(value: number);
  73718. /**
  73719. * Gets or sets the depth of field distortion
  73720. */
  73721. get dofDistortion(): number;
  73722. set dofDistortion(value: number);
  73723. /**
  73724. * Gets or sets the darken out of focus amount
  73725. */
  73726. get darkenOutOfFocus(): number;
  73727. set darkenOutOfFocus(value: number);
  73728. /**
  73729. * Gets or sets a boolean indicating if blur noise is enabled
  73730. */
  73731. get blurNoise(): boolean;
  73732. set blurNoise(value: boolean);
  73733. /**
  73734. * Gets or sets a boolean indicating if pentagon bokeh is enabled
  73735. */
  73736. get pentagonBokeh(): boolean;
  73737. set pentagonBokeh(value: boolean);
  73738. /**
  73739. * Gets or sets the highlight grain amount
  73740. */
  73741. get highlightsGain(): number;
  73742. set highlightsGain(value: number);
  73743. /**
  73744. * Gets or sets the highlight threshold
  73745. */
  73746. get highlightsThreshold(): number;
  73747. set highlightsThreshold(value: number);
  73748. /**
  73749. * Sets the amount of blur at the edges
  73750. * @param amount blur amount
  73751. */
  73752. setEdgeBlur(amount: number): void;
  73753. /**
  73754. * Sets edge blur to 0
  73755. */
  73756. disableEdgeBlur(): void;
  73757. /**
  73758. * Sets the amout of grain
  73759. * @param amount Amount of grain
  73760. */
  73761. setGrainAmount(amount: number): void;
  73762. /**
  73763. * Set grain amount to 0
  73764. */
  73765. disableGrain(): void;
  73766. /**
  73767. * Sets the chromatic aberration amount
  73768. * @param amount amount of chromatic aberration
  73769. */
  73770. setChromaticAberration(amount: number): void;
  73771. /**
  73772. * Sets chromatic aberration amount to 0
  73773. */
  73774. disableChromaticAberration(): void;
  73775. /**
  73776. * Sets the EdgeDistortion amount
  73777. * @param amount amount of EdgeDistortion
  73778. */
  73779. setEdgeDistortion(amount: number): void;
  73780. /**
  73781. * Sets edge distortion to 0
  73782. */
  73783. disableEdgeDistortion(): void;
  73784. /**
  73785. * Sets the FocusDistance amount
  73786. * @param amount amount of FocusDistance
  73787. */
  73788. setFocusDistance(amount: number): void;
  73789. /**
  73790. * Disables depth of field
  73791. */
  73792. disableDepthOfField(): void;
  73793. /**
  73794. * Sets the Aperture amount
  73795. * @param amount amount of Aperture
  73796. */
  73797. setAperture(amount: number): void;
  73798. /**
  73799. * Sets the DarkenOutOfFocus amount
  73800. * @param amount amount of DarkenOutOfFocus
  73801. */
  73802. setDarkenOutOfFocus(amount: number): void;
  73803. private _pentagonBokehIsEnabled;
  73804. /**
  73805. * Creates a pentagon bokeh effect
  73806. */
  73807. enablePentagonBokeh(): void;
  73808. /**
  73809. * Disables the pentagon bokeh effect
  73810. */
  73811. disablePentagonBokeh(): void;
  73812. /**
  73813. * Enables noise blur
  73814. */
  73815. enableNoiseBlur(): void;
  73816. /**
  73817. * Disables noise blur
  73818. */
  73819. disableNoiseBlur(): void;
  73820. /**
  73821. * Sets the HighlightsGain amount
  73822. * @param amount amount of HighlightsGain
  73823. */
  73824. setHighlightsGain(amount: number): void;
  73825. /**
  73826. * Sets the HighlightsThreshold amount
  73827. * @param amount amount of HighlightsThreshold
  73828. */
  73829. setHighlightsThreshold(amount: number): void;
  73830. /**
  73831. * Disables highlights
  73832. */
  73833. disableHighlights(): void;
  73834. /**
  73835. * Removes the internal pipeline assets and detaches the pipeline from the scene cameras
  73836. * @param disableDepthRender If the scens depth rendering should be disabled (default: false)
  73837. */
  73838. dispose(disableDepthRender?: boolean): void;
  73839. private _createChromaticAberrationPostProcess;
  73840. private _createHighlightsPostProcess;
  73841. private _createDepthOfFieldPostProcess;
  73842. private _createGrainTexture;
  73843. }
  73844. }
  73845. declare module "babylonjs/Shaders/ssao2.fragment" {
  73846. /** @hidden */
  73847. export var ssao2PixelShader: {
  73848. name: string;
  73849. shader: string;
  73850. };
  73851. }
  73852. declare module "babylonjs/Shaders/ssaoCombine.fragment" {
  73853. /** @hidden */
  73854. export var ssaoCombinePixelShader: {
  73855. name: string;
  73856. shader: string;
  73857. };
  73858. }
  73859. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/ssao2RenderingPipeline" {
  73860. import { Camera } from "babylonjs/Cameras/camera";
  73861. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  73862. import { Scene } from "babylonjs/scene";
  73863. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  73864. import "babylonjs/Shaders/ssao2.fragment";
  73865. import "babylonjs/Shaders/ssaoCombine.fragment";
  73866. import { PrePassRenderer } from "babylonjs/Rendering/prePassRenderer";
  73867. /**
  73868. * Render pipeline to produce ssao effect
  73869. */
  73870. export class SSAO2RenderingPipeline extends PostProcessRenderPipeline {
  73871. /**
  73872. * @ignore
  73873. * The PassPostProcess id in the pipeline that contains the original scene color
  73874. */
  73875. SSAOOriginalSceneColorEffect: string;
  73876. /**
  73877. * @ignore
  73878. * The SSAO PostProcess id in the pipeline
  73879. */
  73880. SSAORenderEffect: string;
  73881. /**
  73882. * @ignore
  73883. * The horizontal blur PostProcess id in the pipeline
  73884. */
  73885. SSAOBlurHRenderEffect: string;
  73886. /**
  73887. * @ignore
  73888. * The vertical blur PostProcess id in the pipeline
  73889. */
  73890. SSAOBlurVRenderEffect: string;
  73891. /**
  73892. * @ignore
  73893. * The PostProcess id in the pipeline that combines the SSAO-Blur output with the original scene color (SSAOOriginalSceneColorEffect)
  73894. */
  73895. SSAOCombineRenderEffect: string;
  73896. /**
  73897. * The output strength of the SSAO post-process. Default value is 1.0.
  73898. */
  73899. totalStrength: number;
  73900. /**
  73901. * Maximum depth value to still render AO. A smooth falloff makes the dimming more natural, so there will be no abrupt shading change.
  73902. */
  73903. maxZ: number;
  73904. /**
  73905. * In order to save performances, SSAO radius is clamped on close geometry. This ratio changes by how much
  73906. */
  73907. minZAspect: number;
  73908. private _samples;
  73909. /**
  73910. * Number of samples used for the SSAO calculations. Default value is 8
  73911. */
  73912. set samples(n: number);
  73913. get samples(): number;
  73914. private _textureSamples;
  73915. /**
  73916. * Number of samples to use for antialiasing
  73917. */
  73918. set textureSamples(n: number);
  73919. get textureSamples(): number;
  73920. /**
  73921. * Force rendering the geometry through geometry buffer
  73922. */
  73923. private _forceGeometryBuffer;
  73924. /**
  73925. * Ratio object used for SSAO ratio and blur ratio
  73926. */
  73927. private _ratio;
  73928. /**
  73929. * Dynamically generated sphere sampler.
  73930. */
  73931. private _sampleSphere;
  73932. /**
  73933. * Blur filter offsets
  73934. */
  73935. private _samplerOffsets;
  73936. private _expensiveBlur;
  73937. /**
  73938. * If bilateral blur should be used
  73939. */
  73940. set expensiveBlur(b: boolean);
  73941. get expensiveBlur(): boolean;
  73942. /**
  73943. * The radius around the analyzed pixel used by the SSAO post-process. Default value is 2.0
  73944. */
  73945. radius: number;
  73946. /**
  73947. * The base color of the SSAO post-process
  73948. * The final result is "base + ssao" between [0, 1]
  73949. */
  73950. base: number;
  73951. /**
  73952. * Support test.
  73953. */
  73954. static get IsSupported(): boolean;
  73955. private _scene;
  73956. private _randomTexture;
  73957. private _originalColorPostProcess;
  73958. private _ssaoPostProcess;
  73959. private _blurHPostProcess;
  73960. private _blurVPostProcess;
  73961. private _ssaoCombinePostProcess;
  73962. private _prePassRenderer;
  73963. /**
  73964. * Gets active scene
  73965. */
  73966. get scene(): Scene;
  73967. /**
  73968. * @constructor
  73969. * @param name The rendering pipeline name
  73970. * @param scene The scene linked to this pipeline
  73971. * @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 }
  73972. * @param cameras The array of cameras that the rendering pipeline will be attached to
  73973. * @param forceGeometryBuffer Set to true if you want to use the legacy geometry buffer renderer
  73974. */
  73975. constructor(name: string, scene: Scene, ratio: any, cameras?: Camera[], forceGeometryBuffer?: boolean);
  73976. /**
  73977. * Get the class name
  73978. * @returns "SSAO2RenderingPipeline"
  73979. */
  73980. getClassName(): string;
  73981. /**
  73982. * Removes the internal pipeline assets and detatches the pipeline from the scene cameras
  73983. */
  73984. dispose(disableGeometryBufferRenderer?: boolean): void;
  73985. private _createBlurPostProcess;
  73986. /** @hidden */
  73987. _rebuild(): void;
  73988. private _bits;
  73989. private _radicalInverse_VdC;
  73990. private _hammersley;
  73991. private _hemisphereSample_uniform;
  73992. private _generateHemisphere;
  73993. private _getDefinesForSSAO;
  73994. private _createSSAOPostProcess;
  73995. private _createSSAOCombinePostProcess;
  73996. private _createRandomTexture;
  73997. /**
  73998. * Serialize the rendering pipeline (Used when exporting)
  73999. * @returns the serialized object
  74000. */
  74001. serialize(): any;
  74002. /**
  74003. * Parse the serialized pipeline
  74004. * @param source Source pipeline.
  74005. * @param scene The scene to load the pipeline to.
  74006. * @param rootUrl The URL of the serialized pipeline.
  74007. * @returns An instantiated pipeline from the serialized object.
  74008. */
  74009. static Parse(source: any, scene: Scene, rootUrl: string): SSAO2RenderingPipeline;
  74010. /**
  74011. * Sets the required values to the prepass renderer.
  74012. * @param prePassRenderer defines the prepass renderer to setup
  74013. * @returns true if the pre pass is needed.
  74014. */
  74015. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  74016. }
  74017. }
  74018. declare module "babylonjs/Shaders/ssao.fragment" {
  74019. /** @hidden */
  74020. export var ssaoPixelShader: {
  74021. name: string;
  74022. shader: string;
  74023. };
  74024. }
  74025. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/ssaoRenderingPipeline" {
  74026. import { Camera } from "babylonjs/Cameras/camera";
  74027. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  74028. import { Scene } from "babylonjs/scene";
  74029. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  74030. import "babylonjs/Shaders/ssao.fragment";
  74031. import "babylonjs/Shaders/ssaoCombine.fragment";
  74032. /**
  74033. * Render pipeline to produce ssao effect
  74034. */
  74035. export class SSAORenderingPipeline extends PostProcessRenderPipeline {
  74036. /**
  74037. * @ignore
  74038. * The PassPostProcess id in the pipeline that contains the original scene color
  74039. */
  74040. SSAOOriginalSceneColorEffect: string;
  74041. /**
  74042. * @ignore
  74043. * The SSAO PostProcess id in the pipeline
  74044. */
  74045. SSAORenderEffect: string;
  74046. /**
  74047. * @ignore
  74048. * The horizontal blur PostProcess id in the pipeline
  74049. */
  74050. SSAOBlurHRenderEffect: string;
  74051. /**
  74052. * @ignore
  74053. * The vertical blur PostProcess id in the pipeline
  74054. */
  74055. SSAOBlurVRenderEffect: string;
  74056. /**
  74057. * @ignore
  74058. * The PostProcess id in the pipeline that combines the SSAO-Blur output with the original scene color (SSAOOriginalSceneColorEffect)
  74059. */
  74060. SSAOCombineRenderEffect: string;
  74061. /**
  74062. * The output strength of the SSAO post-process. Default value is 1.0.
  74063. */
  74064. totalStrength: number;
  74065. /**
  74066. * The radius around the analyzed pixel used by the SSAO post-process. Default value is 0.0006
  74067. */
  74068. radius: number;
  74069. /**
  74070. * Related to fallOff, used to interpolate SSAO samples (first interpolate function input) based on the occlusion difference of each pixel
  74071. * Must not be equal to fallOff and superior to fallOff.
  74072. * Default value is 0.0075
  74073. */
  74074. area: number;
  74075. /**
  74076. * Related to area, used to interpolate SSAO samples (second interpolate function input) based on the occlusion difference of each pixel
  74077. * Must not be equal to area and inferior to area.
  74078. * Default value is 0.000001
  74079. */
  74080. fallOff: number;
  74081. /**
  74082. * The base color of the SSAO post-process
  74083. * The final result is "base + ssao" between [0, 1]
  74084. */
  74085. base: number;
  74086. private _scene;
  74087. private _depthTexture;
  74088. private _randomTexture;
  74089. private _originalColorPostProcess;
  74090. private _ssaoPostProcess;
  74091. private _blurHPostProcess;
  74092. private _blurVPostProcess;
  74093. private _ssaoCombinePostProcess;
  74094. private _firstUpdate;
  74095. /**
  74096. * Gets active scene
  74097. */
  74098. get scene(): Scene;
  74099. /**
  74100. * @constructor
  74101. * @param name - The rendering pipeline name
  74102. * @param scene - The scene linked to this pipeline
  74103. * @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 }
  74104. * @param cameras - The array of cameras that the rendering pipeline will be attached to
  74105. */
  74106. constructor(name: string, scene: Scene, ratio: any, cameras?: Camera[]);
  74107. /**
  74108. * Get the class name
  74109. * @returns "SSAORenderingPipeline"
  74110. */
  74111. getClassName(): string;
  74112. /**
  74113. * Removes the internal pipeline assets and detatches the pipeline from the scene cameras
  74114. */
  74115. dispose(disableDepthRender?: boolean): void;
  74116. private _createBlurPostProcess;
  74117. /** @hidden */
  74118. _rebuild(): void;
  74119. private _createSSAOPostProcess;
  74120. private _createSSAOCombinePostProcess;
  74121. private _createRandomTexture;
  74122. }
  74123. }
  74124. declare module "babylonjs/Shaders/screenSpaceReflection.fragment" {
  74125. /** @hidden */
  74126. export var screenSpaceReflectionPixelShader: {
  74127. name: string;
  74128. shader: string;
  74129. };
  74130. }
  74131. declare module "babylonjs/PostProcesses/screenSpaceReflectionPostProcess" {
  74132. import { Nullable } from "babylonjs/types";
  74133. import { Camera } from "babylonjs/Cameras/camera";
  74134. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  74135. import { Scene } from "babylonjs/scene";
  74136. import "babylonjs/Shaders/screenSpaceReflection.fragment";
  74137. import { Engine } from "babylonjs/Engines/engine";
  74138. /**
  74139. * The ScreenSpaceReflectionPostProcess performs realtime reflections using only and only the available informations on the screen (positions and normals).
  74140. * Basically, the screen space reflection post-process will compute reflections according the material's reflectivity.
  74141. */
  74142. export class ScreenSpaceReflectionPostProcess extends PostProcess {
  74143. /**
  74144. * Gets or sets a reflection threshold mainly used to adjust the reflection's height.
  74145. */
  74146. threshold: number;
  74147. /**
  74148. * Gets or sets the current reflection strength. 1.0 is an ideal value but can be increased/decreased for particular results.
  74149. */
  74150. strength: number;
  74151. /**
  74152. * Gets or sets the falloff exponent used while computing fresnel. More the exponent is high, more the reflections will be discrete.
  74153. */
  74154. reflectionSpecularFalloffExponent: number;
  74155. /**
  74156. * 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]
  74157. */
  74158. step: number;
  74159. /**
  74160. * Gets or sets the factor applied when computing roughness. Default value is 0.2.
  74161. */
  74162. roughnessFactor: number;
  74163. private _geometryBufferRenderer;
  74164. private _enableSmoothReflections;
  74165. private _reflectionSamples;
  74166. private _smoothSteps;
  74167. /**
  74168. * Creates a new instance of ScreenSpaceReflectionPostProcess.
  74169. * @param name The name of the effect.
  74170. * @param scene The scene containing the objects to calculate reflections.
  74171. * @param options The required width/height ratio to downsize to before computing the render pass.
  74172. * @param camera The camera to apply the render pass to.
  74173. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  74174. * @param engine The engine which the post process will be applied. (default: current engine)
  74175. * @param reusable If the post process can be reused on the same frame. (default: false)
  74176. * @param textureType Type of textures used when performing the post process. (default: 0)
  74177. * @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)
  74178. */
  74179. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  74180. /**
  74181. * Gets wether or not smoothing reflections is enabled.
  74182. * Enabling smoothing will require more GPU power and can generate a drop in FPS.
  74183. */
  74184. get enableSmoothReflections(): boolean;
  74185. /**
  74186. * Sets wether or not smoothing reflections is enabled.
  74187. * Enabling smoothing will require more GPU power and can generate a drop in FPS.
  74188. */
  74189. set enableSmoothReflections(enabled: boolean);
  74190. /**
  74191. * Gets the number of samples taken while computing reflections. More samples count is high,
  74192. * more the post-process wil require GPU power and can generate a drop in FPS. Basically in interval [25, 100].
  74193. */
  74194. get reflectionSamples(): number;
  74195. /**
  74196. * Sets the number of samples taken while computing reflections. More samples count is high,
  74197. * more the post-process wil require GPU power and can generate a drop in FPS. Basically in interval [25, 100].
  74198. */
  74199. set reflectionSamples(samples: number);
  74200. /**
  74201. * Gets the number of samples taken while smoothing reflections. More samples count is high,
  74202. * more the post-process will require GPU power and can generate a drop in FPS.
  74203. * Default value (5.0) work pretty well in all cases but can be adjusted.
  74204. */
  74205. get smoothSteps(): number;
  74206. set smoothSteps(steps: number);
  74207. private _updateEffectDefines;
  74208. }
  74209. }
  74210. declare module "babylonjs/Shaders/standard.fragment" {
  74211. import "babylonjs/Shaders/ShadersInclude/packingFunctions";
  74212. /** @hidden */
  74213. export var standardPixelShader: {
  74214. name: string;
  74215. shader: string;
  74216. };
  74217. }
  74218. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/standardRenderingPipeline" {
  74219. import { Nullable } from "babylonjs/types";
  74220. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  74221. import { Camera } from "babylonjs/Cameras/camera";
  74222. import { Texture } from "babylonjs/Materials/Textures/texture";
  74223. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  74224. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  74225. import { BlurPostProcess } from "babylonjs/PostProcesses/blurPostProcess";
  74226. import { FxaaPostProcess } from "babylonjs/PostProcesses/fxaaPostProcess";
  74227. import { IDisposable } from "babylonjs/scene";
  74228. import { SpotLight } from "babylonjs/Lights/spotLight";
  74229. import { DirectionalLight } from "babylonjs/Lights/directionalLight";
  74230. import { Scene } from "babylonjs/scene";
  74231. import { ScreenSpaceReflectionPostProcess } from "babylonjs/PostProcesses/screenSpaceReflectionPostProcess";
  74232. import { Animation } from "babylonjs/Animations/animation";
  74233. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  74234. import "babylonjs/Shaders/standard.fragment";
  74235. /**
  74236. * Standard rendering pipeline
  74237. * Default pipeline should be used going forward but the standard pipeline will be kept for backwards compatibility.
  74238. * @see https://doc.babylonjs.com/how_to/using_standard_rendering_pipeline
  74239. */
  74240. export class StandardRenderingPipeline extends PostProcessRenderPipeline implements IDisposable, IAnimatable {
  74241. /**
  74242. * Public members
  74243. */
  74244. /**
  74245. * Post-process which contains the original scene color before the pipeline applies all the effects
  74246. */
  74247. originalPostProcess: Nullable<PostProcess>;
  74248. /**
  74249. * Post-process used to down scale an image x4
  74250. */
  74251. downSampleX4PostProcess: Nullable<PostProcess>;
  74252. /**
  74253. * Post-process used to calculate the illuminated surfaces controlled by a threshold
  74254. */
  74255. brightPassPostProcess: Nullable<PostProcess>;
  74256. /**
  74257. * Post-process array storing all the horizontal blur post-processes used by the pipeline
  74258. */
  74259. blurHPostProcesses: PostProcess[];
  74260. /**
  74261. * Post-process array storing all the vertical blur post-processes used by the pipeline
  74262. */
  74263. blurVPostProcesses: PostProcess[];
  74264. /**
  74265. * Post-process used to add colors of 2 textures (typically brightness + real scene color)
  74266. */
  74267. textureAdderPostProcess: Nullable<PostProcess>;
  74268. /**
  74269. * Post-process used to create volumetric lighting effect
  74270. */
  74271. volumetricLightPostProcess: Nullable<PostProcess>;
  74272. /**
  74273. * Post-process used to smooth the previous volumetric light post-process on the X axis
  74274. */
  74275. volumetricLightSmoothXPostProcess: Nullable<BlurPostProcess>;
  74276. /**
  74277. * Post-process used to smooth the previous volumetric light post-process on the Y axis
  74278. */
  74279. volumetricLightSmoothYPostProcess: Nullable<BlurPostProcess>;
  74280. /**
  74281. * Post-process used to merge the volumetric light effect and the real scene color
  74282. */
  74283. volumetricLightMergePostProces: Nullable<PostProcess>;
  74284. /**
  74285. * Post-process used to store the final volumetric light post-process (attach/detach for debug purpose)
  74286. */
  74287. volumetricLightFinalPostProcess: Nullable<PostProcess>;
  74288. /**
  74289. * Base post-process used to calculate the average luminance of the final image for HDR
  74290. */
  74291. luminancePostProcess: Nullable<PostProcess>;
  74292. /**
  74293. * Post-processes used to create down sample post-processes in order to get
  74294. * the average luminance of the final image for HDR
  74295. * Array of length "StandardRenderingPipeline.LuminanceSteps"
  74296. */
  74297. luminanceDownSamplePostProcesses: PostProcess[];
  74298. /**
  74299. * Post-process used to create a HDR effect (light adaptation)
  74300. */
  74301. hdrPostProcess: Nullable<PostProcess>;
  74302. /**
  74303. * Post-process used to store the final texture adder post-process (attach/detach for debug purpose)
  74304. */
  74305. textureAdderFinalPostProcess: Nullable<PostProcess>;
  74306. /**
  74307. * Post-process used to store the final lens flare post-process (attach/detach for debug purpose)
  74308. */
  74309. lensFlareFinalPostProcess: Nullable<PostProcess>;
  74310. /**
  74311. * Post-process used to merge the final HDR post-process and the real scene color
  74312. */
  74313. hdrFinalPostProcess: Nullable<PostProcess>;
  74314. /**
  74315. * Post-process used to create a lens flare effect
  74316. */
  74317. lensFlarePostProcess: Nullable<PostProcess>;
  74318. /**
  74319. * Post-process that merges the result of the lens flare post-process and the real scene color
  74320. */
  74321. lensFlareComposePostProcess: Nullable<PostProcess>;
  74322. /**
  74323. * Post-process used to create a motion blur effect
  74324. */
  74325. motionBlurPostProcess: Nullable<PostProcess>;
  74326. /**
  74327. * Post-process used to create a depth of field effect
  74328. */
  74329. depthOfFieldPostProcess: Nullable<PostProcess>;
  74330. /**
  74331. * The Fast Approximate Anti-Aliasing post process which attemps to remove aliasing from an image.
  74332. */
  74333. fxaaPostProcess: Nullable<FxaaPostProcess>;
  74334. /**
  74335. * Post-process used to simulate realtime reflections using the screen space and geometry renderer.
  74336. */
  74337. screenSpaceReflectionPostProcess: Nullable<ScreenSpaceReflectionPostProcess>;
  74338. /**
  74339. * Represents the brightness threshold in order to configure the illuminated surfaces
  74340. */
  74341. brightThreshold: number;
  74342. /**
  74343. * Configures the blur intensity used for surexposed surfaces are highlighted surfaces (light halo)
  74344. */
  74345. blurWidth: number;
  74346. /**
  74347. * Sets if the blur for highlighted surfaces must be only horizontal
  74348. */
  74349. horizontalBlur: boolean;
  74350. /**
  74351. * Gets the overall exposure used by the pipeline
  74352. */
  74353. get exposure(): number;
  74354. /**
  74355. * Sets the overall exposure used by the pipeline
  74356. */
  74357. set exposure(value: number);
  74358. /**
  74359. * Texture used typically to simulate "dirty" on camera lens
  74360. */
  74361. lensTexture: Nullable<Texture>;
  74362. /**
  74363. * Represents the offset coefficient based on Rayleigh principle. Typically in interval [-0.2, 0.2]
  74364. */
  74365. volumetricLightCoefficient: number;
  74366. /**
  74367. * The overall power of volumetric lights, typically in interval [0, 10] maximum
  74368. */
  74369. volumetricLightPower: number;
  74370. /**
  74371. * Used the set the blur intensity to smooth the volumetric lights
  74372. */
  74373. volumetricLightBlurScale: number;
  74374. /**
  74375. * Light (spot or directional) used to generate the volumetric lights rays
  74376. * The source light must have a shadow generate so the pipeline can get its
  74377. * depth map
  74378. */
  74379. sourceLight: Nullable<SpotLight | DirectionalLight>;
  74380. /**
  74381. * For eye adaptation, represents the minimum luminance the eye can see
  74382. */
  74383. hdrMinimumLuminance: number;
  74384. /**
  74385. * For eye adaptation, represents the decrease luminance speed
  74386. */
  74387. hdrDecreaseRate: number;
  74388. /**
  74389. * For eye adaptation, represents the increase luminance speed
  74390. */
  74391. hdrIncreaseRate: number;
  74392. /**
  74393. * Gets wether or not the exposure of the overall pipeline should be automatically adjusted by the HDR post-process
  74394. */
  74395. get hdrAutoExposure(): boolean;
  74396. /**
  74397. * Sets wether or not the exposure of the overall pipeline should be automatically adjusted by the HDR post-process
  74398. */
  74399. set hdrAutoExposure(value: boolean);
  74400. /**
  74401. * Lens color texture used by the lens flare effect. Mandatory if lens flare effect enabled
  74402. */
  74403. lensColorTexture: Nullable<Texture>;
  74404. /**
  74405. * The overall strengh for the lens flare effect
  74406. */
  74407. lensFlareStrength: number;
  74408. /**
  74409. * Dispersion coefficient for lens flare ghosts
  74410. */
  74411. lensFlareGhostDispersal: number;
  74412. /**
  74413. * Main lens flare halo width
  74414. */
  74415. lensFlareHaloWidth: number;
  74416. /**
  74417. * Based on the lens distortion effect, defines how much the lens flare result
  74418. * is distorted
  74419. */
  74420. lensFlareDistortionStrength: number;
  74421. /**
  74422. * Configures the blur intensity used for for lens flare (halo)
  74423. */
  74424. lensFlareBlurWidth: number;
  74425. /**
  74426. * Lens star texture must be used to simulate rays on the flares and is available
  74427. * in the documentation
  74428. */
  74429. lensStarTexture: Nullable<Texture>;
  74430. /**
  74431. * As the "lensTexture" (can be the same texture or different), it is used to apply the lens
  74432. * flare effect by taking account of the dirt texture
  74433. */
  74434. lensFlareDirtTexture: Nullable<Texture>;
  74435. /**
  74436. * Represents the focal length for the depth of field effect
  74437. */
  74438. depthOfFieldDistance: number;
  74439. /**
  74440. * Represents the blur intensity for the blurred part of the depth of field effect
  74441. */
  74442. depthOfFieldBlurWidth: number;
  74443. /**
  74444. * Gets how much the image is blurred by the movement while using the motion blur post-process
  74445. */
  74446. get motionStrength(): number;
  74447. /**
  74448. * Sets how much the image is blurred by the movement while using the motion blur post-process
  74449. */
  74450. set motionStrength(strength: number);
  74451. /**
  74452. * Gets wether or not the motion blur post-process is object based or screen based.
  74453. */
  74454. get objectBasedMotionBlur(): boolean;
  74455. /**
  74456. * Sets wether or not the motion blur post-process should be object based or screen based
  74457. */
  74458. set objectBasedMotionBlur(value: boolean);
  74459. /**
  74460. * List of animations for the pipeline (IAnimatable implementation)
  74461. */
  74462. animations: Animation[];
  74463. /**
  74464. * Private members
  74465. */
  74466. private _scene;
  74467. private _currentDepthOfFieldSource;
  74468. private _basePostProcess;
  74469. private _fixedExposure;
  74470. private _currentExposure;
  74471. private _hdrAutoExposure;
  74472. private _hdrCurrentLuminance;
  74473. private _motionStrength;
  74474. private _isObjectBasedMotionBlur;
  74475. private _floatTextureType;
  74476. private _camerasToBeAttached;
  74477. private _ratio;
  74478. private _bloomEnabled;
  74479. private _depthOfFieldEnabled;
  74480. private _vlsEnabled;
  74481. private _lensFlareEnabled;
  74482. private _hdrEnabled;
  74483. private _motionBlurEnabled;
  74484. private _fxaaEnabled;
  74485. private _screenSpaceReflectionsEnabled;
  74486. private _motionBlurSamples;
  74487. private _volumetricLightStepsCount;
  74488. private _samples;
  74489. /**
  74490. * @ignore
  74491. * Specifies if the bloom pipeline is enabled
  74492. */
  74493. get BloomEnabled(): boolean;
  74494. set BloomEnabled(enabled: boolean);
  74495. /**
  74496. * @ignore
  74497. * Specifies if the depth of field pipeline is enabed
  74498. */
  74499. get DepthOfFieldEnabled(): boolean;
  74500. set DepthOfFieldEnabled(enabled: boolean);
  74501. /**
  74502. * @ignore
  74503. * Specifies if the lens flare pipeline is enabed
  74504. */
  74505. get LensFlareEnabled(): boolean;
  74506. set LensFlareEnabled(enabled: boolean);
  74507. /**
  74508. * @ignore
  74509. * Specifies if the HDR pipeline is enabled
  74510. */
  74511. get HDREnabled(): boolean;
  74512. set HDREnabled(enabled: boolean);
  74513. /**
  74514. * @ignore
  74515. * Specifies if the volumetric lights scattering effect is enabled
  74516. */
  74517. get VLSEnabled(): boolean;
  74518. set VLSEnabled(enabled: boolean);
  74519. /**
  74520. * @ignore
  74521. * Specifies if the motion blur effect is enabled
  74522. */
  74523. get MotionBlurEnabled(): boolean;
  74524. set MotionBlurEnabled(enabled: boolean);
  74525. /**
  74526. * Specifies if anti-aliasing is enabled
  74527. */
  74528. get fxaaEnabled(): boolean;
  74529. set fxaaEnabled(enabled: boolean);
  74530. /**
  74531. * Specifies if screen space reflections are enabled.
  74532. */
  74533. get screenSpaceReflectionsEnabled(): boolean;
  74534. set screenSpaceReflectionsEnabled(enabled: boolean);
  74535. /**
  74536. * Specifies the number of steps used to calculate the volumetric lights
  74537. * Typically in interval [50, 200]
  74538. */
  74539. get volumetricLightStepsCount(): number;
  74540. set volumetricLightStepsCount(count: number);
  74541. /**
  74542. * Specifies the number of samples used for the motion blur effect
  74543. * Typically in interval [16, 64]
  74544. */
  74545. get motionBlurSamples(): number;
  74546. set motionBlurSamples(samples: number);
  74547. /**
  74548. * Specifies MSAA sample count, setting this to 4 will provide 4x anti aliasing. (default: 1)
  74549. */
  74550. get samples(): number;
  74551. set samples(sampleCount: number);
  74552. /**
  74553. * Default pipeline should be used going forward but the standard pipeline will be kept for backwards compatibility.
  74554. * @constructor
  74555. * @param name The rendering pipeline name
  74556. * @param scene The scene linked to this pipeline
  74557. * @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)
  74558. * @param originalPostProcess the custom original color post-process. Must be "reusable". Can be null.
  74559. * @param cameras The array of cameras that the rendering pipeline will be attached to
  74560. */
  74561. constructor(name: string, scene: Scene, ratio: number, originalPostProcess?: Nullable<PostProcess>, cameras?: Camera[]);
  74562. private _buildPipeline;
  74563. private _createDownSampleX4PostProcess;
  74564. private _createBrightPassPostProcess;
  74565. private _createBlurPostProcesses;
  74566. private _createTextureAdderPostProcess;
  74567. private _createVolumetricLightPostProcess;
  74568. private _createLuminancePostProcesses;
  74569. private _createHdrPostProcess;
  74570. private _createLensFlarePostProcess;
  74571. private _createDepthOfFieldPostProcess;
  74572. private _createMotionBlurPostProcess;
  74573. private _getDepthTexture;
  74574. private _disposePostProcesses;
  74575. /**
  74576. * Dispose of the pipeline and stop all post processes
  74577. */
  74578. dispose(): void;
  74579. /**
  74580. * Serialize the rendering pipeline (Used when exporting)
  74581. * @returns the serialized object
  74582. */
  74583. serialize(): any;
  74584. /**
  74585. * Parse the serialized pipeline
  74586. * @param source Source pipeline.
  74587. * @param scene The scene to load the pipeline to.
  74588. * @param rootUrl The URL of the serialized pipeline.
  74589. * @returns An instantiated pipeline from the serialized object.
  74590. */
  74591. static Parse(source: any, scene: Scene, rootUrl: string): StandardRenderingPipeline;
  74592. /**
  74593. * Luminance steps
  74594. */
  74595. static LuminanceSteps: number;
  74596. }
  74597. }
  74598. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/index" {
  74599. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/defaultRenderingPipeline";
  74600. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/lensRenderingPipeline";
  74601. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/ssao2RenderingPipeline";
  74602. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/ssaoRenderingPipeline";
  74603. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/standardRenderingPipeline";
  74604. }
  74605. declare module "babylonjs/PostProcesses/RenderPipeline/index" {
  74606. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/index";
  74607. export * from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect";
  74608. export * from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  74609. export * from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManager";
  74610. export * from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  74611. }
  74612. declare module "babylonjs/Shaders/stereoscopicInterlace.fragment" {
  74613. /** @hidden */
  74614. export var stereoscopicInterlacePixelShader: {
  74615. name: string;
  74616. shader: string;
  74617. };
  74618. }
  74619. declare module "babylonjs/PostProcesses/stereoscopicInterlacePostProcess" {
  74620. import { Camera } from "babylonjs/Cameras/camera";
  74621. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  74622. import { Engine } from "babylonjs/Engines/engine";
  74623. import "babylonjs/Shaders/stereoscopicInterlace.fragment";
  74624. /**
  74625. * StereoscopicInterlacePostProcessI used to render stereo views from a rigged camera with support for alternate line interlacing
  74626. */
  74627. export class StereoscopicInterlacePostProcessI extends PostProcess {
  74628. private _stepSize;
  74629. private _passedProcess;
  74630. /**
  74631. * Initializes a StereoscopicInterlacePostProcessI
  74632. * @param name The name of the effect.
  74633. * @param rigCameras The rig cameras to be appled to the post process
  74634. * @param isStereoscopicHoriz If the rendered results are horizontal or vertical
  74635. * @param isStereoscopicInterlaced If the rendered results are alternate line interlaced
  74636. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  74637. * @param engine The engine which the post process will be applied. (default: current engine)
  74638. * @param reusable If the post process can be reused on the same frame. (default: false)
  74639. */
  74640. constructor(name: string, rigCameras: Camera[], isStereoscopicHoriz: boolean, isStereoscopicInterlaced: boolean, samplingMode?: number, engine?: Engine, reusable?: boolean);
  74641. }
  74642. /**
  74643. * StereoscopicInterlacePostProcess used to render stereo views from a rigged camera
  74644. */
  74645. export class StereoscopicInterlacePostProcess extends PostProcess {
  74646. private _stepSize;
  74647. private _passedProcess;
  74648. /**
  74649. * Initializes a StereoscopicInterlacePostProcess
  74650. * @param name The name of the effect.
  74651. * @param rigCameras The rig cameras to be appled to the post process
  74652. * @param isStereoscopicHoriz If the rendered results are horizontal or verticle
  74653. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  74654. * @param engine The engine which the post process will be applied. (default: current engine)
  74655. * @param reusable If the post process can be reused on the same frame. (default: false)
  74656. */
  74657. constructor(name: string, rigCameras: Camera[], isStereoscopicHoriz: boolean, samplingMode?: number, engine?: Engine, reusable?: boolean);
  74658. }
  74659. }
  74660. declare module "babylonjs/Shaders/tonemap.fragment" {
  74661. /** @hidden */
  74662. export var tonemapPixelShader: {
  74663. name: string;
  74664. shader: string;
  74665. };
  74666. }
  74667. declare module "babylonjs/PostProcesses/tonemapPostProcess" {
  74668. import { Camera } from "babylonjs/Cameras/camera";
  74669. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  74670. import "babylonjs/Shaders/tonemap.fragment";
  74671. import { Engine } from "babylonjs/Engines/engine";
  74672. /** Defines operator used for tonemapping */
  74673. export enum TonemappingOperator {
  74674. /** Hable */
  74675. Hable = 0,
  74676. /** Reinhard */
  74677. Reinhard = 1,
  74678. /** HejiDawson */
  74679. HejiDawson = 2,
  74680. /** Photographic */
  74681. Photographic = 3
  74682. }
  74683. /**
  74684. * Defines a post process to apply tone mapping
  74685. */
  74686. export class TonemapPostProcess extends PostProcess {
  74687. private _operator;
  74688. /** Defines the required exposure adjustement */
  74689. exposureAdjustment: number;
  74690. /**
  74691. * Creates a new TonemapPostProcess
  74692. * @param name defines the name of the postprocess
  74693. * @param _operator defines the operator to use
  74694. * @param exposureAdjustment defines the required exposure adjustement
  74695. * @param camera defines the camera to use (can be null)
  74696. * @param samplingMode defines the required sampling mode (BABYLON.Texture.BILINEAR_SAMPLINGMODE by default)
  74697. * @param engine defines the hosting engine (can be ignore if camera is set)
  74698. * @param textureFormat defines the texture format to use (BABYLON.Engine.TEXTURETYPE_UNSIGNED_INT by default)
  74699. */
  74700. constructor(name: string, _operator: TonemappingOperator,
  74701. /** Defines the required exposure adjustement */
  74702. exposureAdjustment: number, camera: Camera, samplingMode?: number, engine?: Engine, textureFormat?: number);
  74703. }
  74704. }
  74705. declare module "babylonjs/Shaders/volumetricLightScattering.fragment" {
  74706. /** @hidden */
  74707. export var volumetricLightScatteringPixelShader: {
  74708. name: string;
  74709. shader: string;
  74710. };
  74711. }
  74712. declare module "babylonjs/Shaders/volumetricLightScatteringPass.vertex" {
  74713. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  74714. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  74715. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  74716. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  74717. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  74718. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  74719. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  74720. /** @hidden */
  74721. export var volumetricLightScatteringPassVertexShader: {
  74722. name: string;
  74723. shader: string;
  74724. };
  74725. }
  74726. declare module "babylonjs/Shaders/volumetricLightScatteringPass.fragment" {
  74727. /** @hidden */
  74728. export var volumetricLightScatteringPassPixelShader: {
  74729. name: string;
  74730. shader: string;
  74731. };
  74732. }
  74733. declare module "babylonjs/PostProcesses/volumetricLightScatteringPostProcess" {
  74734. import { Vector3 } from "babylonjs/Maths/math.vector";
  74735. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  74736. import { Mesh } from "babylonjs/Meshes/mesh";
  74737. import { Camera } from "babylonjs/Cameras/camera";
  74738. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  74739. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  74740. import { Scene } from "babylonjs/scene";
  74741. import "babylonjs/Meshes/Builders/planeBuilder";
  74742. import "babylonjs/Shaders/depth.vertex";
  74743. import "babylonjs/Shaders/volumetricLightScattering.fragment";
  74744. import "babylonjs/Shaders/volumetricLightScatteringPass.vertex";
  74745. import "babylonjs/Shaders/volumetricLightScatteringPass.fragment";
  74746. import { Engine } from "babylonjs/Engines/engine";
  74747. /**
  74748. * Inspired by http://http.developer.nvidia.com/GPUGems3/gpugems3_ch13.html
  74749. */
  74750. export class VolumetricLightScatteringPostProcess extends PostProcess {
  74751. private _volumetricLightScatteringPass;
  74752. private _volumetricLightScatteringRTT;
  74753. private _viewPort;
  74754. private _screenCoordinates;
  74755. private _cachedDefines;
  74756. /**
  74757. * If not undefined, the mesh position is computed from the attached node position
  74758. */
  74759. attachedNode: {
  74760. position: Vector3;
  74761. };
  74762. /**
  74763. * Custom position of the mesh. Used if "useCustomMeshPosition" is set to "true"
  74764. */
  74765. customMeshPosition: Vector3;
  74766. /**
  74767. * Set if the post-process should use a custom position for the light source (true) or the internal mesh position (false)
  74768. */
  74769. useCustomMeshPosition: boolean;
  74770. /**
  74771. * If the post-process should inverse the light scattering direction
  74772. */
  74773. invert: boolean;
  74774. /**
  74775. * The internal mesh used by the post-process
  74776. */
  74777. mesh: Mesh;
  74778. /**
  74779. * @hidden
  74780. * VolumetricLightScatteringPostProcess.useDiffuseColor is no longer used, use the mesh material directly instead
  74781. */
  74782. get useDiffuseColor(): boolean;
  74783. set useDiffuseColor(useDiffuseColor: boolean);
  74784. /**
  74785. * Array containing the excluded meshes not rendered in the internal pass
  74786. */
  74787. excludedMeshes: AbstractMesh[];
  74788. /**
  74789. * Controls the overall intensity of the post-process
  74790. */
  74791. exposure: number;
  74792. /**
  74793. * Dissipates each sample's contribution in range [0, 1]
  74794. */
  74795. decay: number;
  74796. /**
  74797. * Controls the overall intensity of each sample
  74798. */
  74799. weight: number;
  74800. /**
  74801. * Controls the density of each sample
  74802. */
  74803. density: number;
  74804. /**
  74805. * @constructor
  74806. * @param name The post-process name
  74807. * @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)
  74808. * @param camera The camera that the post-process will be attached to
  74809. * @param mesh The mesh used to create the light scattering
  74810. * @param samples The post-process quality, default 100
  74811. * @param samplingModeThe post-process filtering mode
  74812. * @param engine The babylon engine
  74813. * @param reusable If the post-process is reusable
  74814. * @param scene The constructor needs a scene reference to initialize internal components. If "camera" is null a "scene" must be provided
  74815. */
  74816. constructor(name: string, ratio: any, camera: Camera, mesh?: Mesh, samples?: number, samplingMode?: number, engine?: Engine, reusable?: boolean, scene?: Scene);
  74817. /**
  74818. * Returns the string "VolumetricLightScatteringPostProcess"
  74819. * @returns "VolumetricLightScatteringPostProcess"
  74820. */
  74821. getClassName(): string;
  74822. private _isReady;
  74823. /**
  74824. * Sets the new light position for light scattering effect
  74825. * @param position The new custom light position
  74826. */
  74827. setCustomMeshPosition(position: Vector3): void;
  74828. /**
  74829. * Returns the light position for light scattering effect
  74830. * @return Vector3 The custom light position
  74831. */
  74832. getCustomMeshPosition(): Vector3;
  74833. /**
  74834. * Disposes the internal assets and detaches the post-process from the camera
  74835. */
  74836. dispose(camera: Camera): void;
  74837. /**
  74838. * Returns the render target texture used by the post-process
  74839. * @return the render target texture used by the post-process
  74840. */
  74841. getPass(): RenderTargetTexture;
  74842. private _meshExcluded;
  74843. private _createPass;
  74844. private _updateMeshScreenCoordinates;
  74845. /**
  74846. * Creates a default mesh for the Volumeric Light Scattering post-process
  74847. * @param name The mesh name
  74848. * @param scene The scene where to create the mesh
  74849. * @return the default mesh
  74850. */
  74851. static CreateDefaultMesh(name: string, scene: Scene): Mesh;
  74852. }
  74853. }
  74854. declare module "babylonjs/Shaders/screenSpaceCurvature.fragment" {
  74855. /** @hidden */
  74856. export var screenSpaceCurvaturePixelShader: {
  74857. name: string;
  74858. shader: string;
  74859. };
  74860. }
  74861. declare module "babylonjs/PostProcesses/screenSpaceCurvaturePostProcess" {
  74862. import { Nullable } from "babylonjs/types";
  74863. import { Camera } from "babylonjs/Cameras/camera";
  74864. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  74865. import { Scene } from "babylonjs/scene";
  74866. import "babylonjs/Rendering/geometryBufferRendererSceneComponent";
  74867. import "babylonjs/Shaders/screenSpaceCurvature.fragment";
  74868. import { Engine } from "babylonjs/Engines/engine";
  74869. /**
  74870. * The Screen Space curvature effect can help highlighting ridge and valley of a model.
  74871. */
  74872. export class ScreenSpaceCurvaturePostProcess extends PostProcess {
  74873. /**
  74874. * Defines how much ridge the curvature effect displays.
  74875. */
  74876. ridge: number;
  74877. /**
  74878. * Defines how much valley the curvature effect displays.
  74879. */
  74880. valley: number;
  74881. private _geometryBufferRenderer;
  74882. /**
  74883. * Creates a new instance ScreenSpaceCurvaturePostProcess
  74884. * @param name The name of the effect.
  74885. * @param scene The scene containing the objects to blur according to their velocity.
  74886. * @param options The required width/height ratio to downsize to before computing the render pass.
  74887. * @param camera The camera to apply the render pass to.
  74888. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  74889. * @param engine The engine which the post process will be applied. (default: current engine)
  74890. * @param reusable If the post process can be reused on the same frame. (default: false)
  74891. * @param textureType Type of textures used when performing the post process. (default: 0)
  74892. * @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)
  74893. */
  74894. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  74895. /**
  74896. * Support test.
  74897. */
  74898. static get IsSupported(): boolean;
  74899. }
  74900. }
  74901. declare module "babylonjs/PostProcesses/index" {
  74902. export * from "babylonjs/PostProcesses/anaglyphPostProcess";
  74903. export * from "babylonjs/PostProcesses/blackAndWhitePostProcess";
  74904. export * from "babylonjs/PostProcesses/bloomEffect";
  74905. export * from "babylonjs/PostProcesses/bloomMergePostProcess";
  74906. export * from "babylonjs/PostProcesses/blurPostProcess";
  74907. export * from "babylonjs/PostProcesses/chromaticAberrationPostProcess";
  74908. export * from "babylonjs/PostProcesses/circleOfConfusionPostProcess";
  74909. export * from "babylonjs/PostProcesses/colorCorrectionPostProcess";
  74910. export * from "babylonjs/PostProcesses/convolutionPostProcess";
  74911. export * from "babylonjs/PostProcesses/depthOfFieldBlurPostProcess";
  74912. export * from "babylonjs/PostProcesses/depthOfFieldEffect";
  74913. export * from "babylonjs/PostProcesses/depthOfFieldMergePostProcess";
  74914. export * from "babylonjs/PostProcesses/displayPassPostProcess";
  74915. export * from "babylonjs/PostProcesses/extractHighlightsPostProcess";
  74916. export * from "babylonjs/PostProcesses/filterPostProcess";
  74917. export * from "babylonjs/PostProcesses/fxaaPostProcess";
  74918. export * from "babylonjs/PostProcesses/grainPostProcess";
  74919. export * from "babylonjs/PostProcesses/highlightsPostProcess";
  74920. export * from "babylonjs/PostProcesses/imageProcessingPostProcess";
  74921. export * from "babylonjs/PostProcesses/motionBlurPostProcess";
  74922. export * from "babylonjs/PostProcesses/passPostProcess";
  74923. export * from "babylonjs/PostProcesses/postProcess";
  74924. export * from "babylonjs/PostProcesses/postProcessManager";
  74925. export * from "babylonjs/PostProcesses/refractionPostProcess";
  74926. export * from "babylonjs/PostProcesses/RenderPipeline/index";
  74927. export * from "babylonjs/PostProcesses/sharpenPostProcess";
  74928. export * from "babylonjs/PostProcesses/stereoscopicInterlacePostProcess";
  74929. export * from "babylonjs/PostProcesses/tonemapPostProcess";
  74930. export * from "babylonjs/PostProcesses/volumetricLightScatteringPostProcess";
  74931. export * from "babylonjs/PostProcesses/vrDistortionCorrectionPostProcess";
  74932. export * from "babylonjs/PostProcesses/vrMultiviewToSingleviewPostProcess";
  74933. export * from "babylonjs/PostProcesses/screenSpaceReflectionPostProcess";
  74934. export * from "babylonjs/PostProcesses/screenSpaceCurvaturePostProcess";
  74935. }
  74936. declare module "babylonjs/Probes/index" {
  74937. export * from "babylonjs/Probes/reflectionProbe";
  74938. }
  74939. declare module "babylonjs/Rendering/boundingBoxRenderer" {
  74940. import { Scene } from "babylonjs/scene";
  74941. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  74942. import { SmartArray } from "babylonjs/Misc/smartArray";
  74943. import { ISceneComponent } from "babylonjs/sceneComponent";
  74944. import { BoundingBox } from "babylonjs/Culling/boundingBox";
  74945. import "babylonjs/Meshes/Builders/boxBuilder";
  74946. import "babylonjs/Shaders/color.fragment";
  74947. import "babylonjs/Shaders/color.vertex";
  74948. import { Color3 } from "babylonjs/Maths/math.color";
  74949. import { Observable } from "babylonjs/Misc/observable";
  74950. module "babylonjs/scene" {
  74951. interface Scene {
  74952. /** @hidden (Backing field) */
  74953. _boundingBoxRenderer: BoundingBoxRenderer;
  74954. /** @hidden (Backing field) */
  74955. _forceShowBoundingBoxes: boolean;
  74956. /**
  74957. * Gets or sets a boolean indicating if all bounding boxes must be rendered
  74958. */
  74959. forceShowBoundingBoxes: boolean;
  74960. /**
  74961. * Gets the bounding box renderer associated with the scene
  74962. * @returns a BoundingBoxRenderer
  74963. */
  74964. getBoundingBoxRenderer(): BoundingBoxRenderer;
  74965. }
  74966. }
  74967. module "babylonjs/Meshes/abstractMesh" {
  74968. interface AbstractMesh {
  74969. /** @hidden (Backing field) */
  74970. _showBoundingBox: boolean;
  74971. /**
  74972. * Gets or sets a boolean indicating if the bounding box must be rendered as well (false by default)
  74973. */
  74974. showBoundingBox: boolean;
  74975. }
  74976. }
  74977. /**
  74978. * Component responsible of rendering the bounding box of the meshes in a scene.
  74979. * This is usually used through the mesh.showBoundingBox or the scene.forceShowBoundingBoxes properties
  74980. */
  74981. export class BoundingBoxRenderer implements ISceneComponent {
  74982. /**
  74983. * The component name helpfull to identify the component in the list of scene components.
  74984. */
  74985. readonly name: string;
  74986. /**
  74987. * The scene the component belongs to.
  74988. */
  74989. scene: Scene;
  74990. /**
  74991. * Color of the bounding box lines placed in front of an object
  74992. */
  74993. frontColor: Color3;
  74994. /**
  74995. * Color of the bounding box lines placed behind an object
  74996. */
  74997. backColor: Color3;
  74998. /**
  74999. * Defines if the renderer should show the back lines or not
  75000. */
  75001. showBackLines: boolean;
  75002. /**
  75003. * Observable raised before rendering a bounding box
  75004. */
  75005. onBeforeBoxRenderingObservable: Observable<BoundingBox>;
  75006. /**
  75007. * Observable raised after rendering a bounding box
  75008. */
  75009. onAfterBoxRenderingObservable: Observable<BoundingBox>;
  75010. /**
  75011. * @hidden
  75012. */
  75013. renderList: SmartArray<BoundingBox>;
  75014. private _colorShader;
  75015. private _vertexBuffers;
  75016. private _indexBuffer;
  75017. private _fillIndexBuffer;
  75018. private _fillIndexData;
  75019. /**
  75020. * Instantiates a new bounding box renderer in a scene.
  75021. * @param scene the scene the renderer renders in
  75022. */
  75023. constructor(scene: Scene);
  75024. /**
  75025. * Registers the component in a given scene
  75026. */
  75027. register(): void;
  75028. private _evaluateSubMesh;
  75029. private _activeMesh;
  75030. private _prepareRessources;
  75031. private _createIndexBuffer;
  75032. /**
  75033. * Rebuilds the elements related to this component in case of
  75034. * context lost for instance.
  75035. */
  75036. rebuild(): void;
  75037. /**
  75038. * @hidden
  75039. */
  75040. reset(): void;
  75041. /**
  75042. * Render the bounding boxes of a specific rendering group
  75043. * @param renderingGroupId defines the rendering group to render
  75044. */
  75045. render(renderingGroupId: number): void;
  75046. /**
  75047. * In case of occlusion queries, we can render the occlusion bounding box through this method
  75048. * @param mesh Define the mesh to render the occlusion bounding box for
  75049. */
  75050. renderOcclusionBoundingBox(mesh: AbstractMesh): void;
  75051. /**
  75052. * Dispose and release the resources attached to this renderer.
  75053. */
  75054. dispose(): void;
  75055. }
  75056. }
  75057. declare module "babylonjs/Rendering/depthRendererSceneComponent" {
  75058. import { Nullable } from "babylonjs/types";
  75059. import { Scene } from "babylonjs/scene";
  75060. import { DepthRenderer } from "babylonjs/Rendering/depthRenderer";
  75061. import { Camera } from "babylonjs/Cameras/camera";
  75062. import { ISceneComponent } from "babylonjs/sceneComponent";
  75063. module "babylonjs/scene" {
  75064. interface Scene {
  75065. /** @hidden (Backing field) */
  75066. _depthRenderer: {
  75067. [id: string]: DepthRenderer;
  75068. };
  75069. /**
  75070. * Creates a depth renderer a given camera which contains a depth map which can be used for post processing.
  75071. * @param camera The camera to create the depth renderer on (default: scene's active camera)
  75072. * @param storeNonLinearDepth Defines whether the depth is stored linearly like in Babylon Shadows or directly like glFragCoord.z
  75073. * @returns the created depth renderer
  75074. */
  75075. enableDepthRenderer(camera?: Nullable<Camera>, storeNonLinearDepth?: boolean): DepthRenderer;
  75076. /**
  75077. * Disables a depth renderer for a given camera
  75078. * @param camera The camera to disable the depth renderer on (default: scene's active camera)
  75079. */
  75080. disableDepthRenderer(camera?: Nullable<Camera>): void;
  75081. }
  75082. }
  75083. /**
  75084. * Defines the Depth Renderer scene component responsible to manage a depth buffer useful
  75085. * in several rendering techniques.
  75086. */
  75087. export class DepthRendererSceneComponent implements ISceneComponent {
  75088. /**
  75089. * The component name helpfull to identify the component in the list of scene components.
  75090. */
  75091. readonly name: string;
  75092. /**
  75093. * The scene the component belongs to.
  75094. */
  75095. scene: Scene;
  75096. /**
  75097. * Creates a new instance of the component for the given scene
  75098. * @param scene Defines the scene to register the component in
  75099. */
  75100. constructor(scene: Scene);
  75101. /**
  75102. * Registers the component in a given scene
  75103. */
  75104. register(): void;
  75105. /**
  75106. * Rebuilds the elements related to this component in case of
  75107. * context lost for instance.
  75108. */
  75109. rebuild(): void;
  75110. /**
  75111. * Disposes the component and the associated ressources
  75112. */
  75113. dispose(): void;
  75114. private _gatherRenderTargets;
  75115. private _gatherActiveCameraRenderTargets;
  75116. }
  75117. }
  75118. declare module "babylonjs/Rendering/prePassRendererSceneComponent" {
  75119. import { Nullable } from "babylonjs/types";
  75120. import { Scene } from "babylonjs/scene";
  75121. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  75122. import { PrePassRenderer } from "babylonjs/Rendering/prePassRenderer";
  75123. import { AbstractScene } from "babylonjs/abstractScene";
  75124. module "babylonjs/abstractScene" {
  75125. interface AbstractScene {
  75126. /** @hidden (Backing field) */
  75127. _prePassRenderer: Nullable<PrePassRenderer>;
  75128. /**
  75129. * Gets or Sets the current prepass renderer associated to the scene.
  75130. */
  75131. prePassRenderer: Nullable<PrePassRenderer>;
  75132. /**
  75133. * Enables the prepass and associates it with the scene
  75134. * @returns the PrePassRenderer
  75135. */
  75136. enablePrePassRenderer(): Nullable<PrePassRenderer>;
  75137. /**
  75138. * Disables the prepass associated with the scene
  75139. */
  75140. disablePrePassRenderer(): void;
  75141. }
  75142. }
  75143. /**
  75144. * Defines the Geometry Buffer scene component responsible to manage a G-Buffer useful
  75145. * in several rendering techniques.
  75146. */
  75147. export class PrePassRendererSceneComponent implements ISceneSerializableComponent {
  75148. /**
  75149. * The component name helpful to identify the component in the list of scene components.
  75150. */
  75151. readonly name: string;
  75152. /**
  75153. * The scene the component belongs to.
  75154. */
  75155. scene: Scene;
  75156. /**
  75157. * Creates a new instance of the component for the given scene
  75158. * @param scene Defines the scene to register the component in
  75159. */
  75160. constructor(scene: Scene);
  75161. /**
  75162. * Registers the component in a given scene
  75163. */
  75164. register(): void;
  75165. private _beforeCameraDraw;
  75166. private _afterCameraDraw;
  75167. private _beforeClearStage;
  75168. /**
  75169. * Serializes the component data to the specified json object
  75170. * @param serializationObject The object to serialize to
  75171. */
  75172. serialize(serializationObject: any): void;
  75173. /**
  75174. * Adds all the elements from the container to the scene
  75175. * @param container the container holding the elements
  75176. */
  75177. addFromContainer(container: AbstractScene): void;
  75178. /**
  75179. * Removes all the elements in the container from the scene
  75180. * @param container contains the elements to remove
  75181. * @param dispose if the removed element should be disposed (default: false)
  75182. */
  75183. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  75184. /**
  75185. * Rebuilds the elements related to this component in case of
  75186. * context lost for instance.
  75187. */
  75188. rebuild(): void;
  75189. /**
  75190. * Disposes the component and the associated ressources
  75191. */
  75192. dispose(): void;
  75193. }
  75194. }
  75195. declare module "babylonjs/Shaders/outline.fragment" {
  75196. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  75197. import "babylonjs/Shaders/ShadersInclude/logDepthFragment";
  75198. /** @hidden */
  75199. export var outlinePixelShader: {
  75200. name: string;
  75201. shader: string;
  75202. };
  75203. }
  75204. declare module "babylonjs/Shaders/outline.vertex" {
  75205. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  75206. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  75207. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  75208. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  75209. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  75210. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  75211. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  75212. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  75213. import "babylonjs/Shaders/ShadersInclude/logDepthVertex";
  75214. /** @hidden */
  75215. export var outlineVertexShader: {
  75216. name: string;
  75217. shader: string;
  75218. };
  75219. }
  75220. declare module "babylonjs/Rendering/outlineRenderer" {
  75221. import { SubMesh } from "babylonjs/Meshes/subMesh";
  75222. import { _InstancesBatch } from "babylonjs/Meshes/mesh";
  75223. import { Scene } from "babylonjs/scene";
  75224. import { ISceneComponent } from "babylonjs/sceneComponent";
  75225. import "babylonjs/Shaders/outline.fragment";
  75226. import "babylonjs/Shaders/outline.vertex";
  75227. module "babylonjs/scene" {
  75228. interface Scene {
  75229. /** @hidden */
  75230. _outlineRenderer: OutlineRenderer;
  75231. /**
  75232. * Gets the outline renderer associated with the scene
  75233. * @returns a OutlineRenderer
  75234. */
  75235. getOutlineRenderer(): OutlineRenderer;
  75236. }
  75237. }
  75238. module "babylonjs/Meshes/abstractMesh" {
  75239. interface AbstractMesh {
  75240. /** @hidden (Backing field) */
  75241. _renderOutline: boolean;
  75242. /**
  75243. * Gets or sets a boolean indicating if the outline must be rendered as well
  75244. * @see https://www.babylonjs-playground.com/#10WJ5S#3
  75245. */
  75246. renderOutline: boolean;
  75247. /** @hidden (Backing field) */
  75248. _renderOverlay: boolean;
  75249. /**
  75250. * Gets or sets a boolean indicating if the overlay must be rendered as well
  75251. * @see https://www.babylonjs-playground.com/#10WJ5S#2
  75252. */
  75253. renderOverlay: boolean;
  75254. }
  75255. }
  75256. /**
  75257. * This class is responsible to draw bothe outline/overlay of meshes.
  75258. * It should not be used directly but through the available method on mesh.
  75259. */
  75260. export class OutlineRenderer implements ISceneComponent {
  75261. /**
  75262. * Stencil value used to avoid outline being seen within the mesh when the mesh is transparent
  75263. */
  75264. private static _StencilReference;
  75265. /**
  75266. * The name of the component. Each component must have a unique name.
  75267. */
  75268. name: string;
  75269. /**
  75270. * The scene the component belongs to.
  75271. */
  75272. scene: Scene;
  75273. /**
  75274. * Defines a zOffset to prevent zFighting between the overlay and the mesh.
  75275. */
  75276. zOffset: number;
  75277. private _engine;
  75278. private _effect;
  75279. private _cachedDefines;
  75280. private _savedDepthWrite;
  75281. /**
  75282. * Instantiates a new outline renderer. (There could be only one per scene).
  75283. * @param scene Defines the scene it belongs to
  75284. */
  75285. constructor(scene: Scene);
  75286. /**
  75287. * Register the component to one instance of a scene.
  75288. */
  75289. register(): void;
  75290. /**
  75291. * Rebuilds the elements related to this component in case of
  75292. * context lost for instance.
  75293. */
  75294. rebuild(): void;
  75295. /**
  75296. * Disposes the component and the associated ressources.
  75297. */
  75298. dispose(): void;
  75299. /**
  75300. * Renders the outline in the canvas.
  75301. * @param subMesh Defines the sumesh to render
  75302. * @param batch Defines the batch of meshes in case of instances
  75303. * @param useOverlay Defines if the rendering is for the overlay or the outline
  75304. */
  75305. render(subMesh: SubMesh, batch: _InstancesBatch, useOverlay?: boolean): void;
  75306. /**
  75307. * Returns whether or not the outline renderer is ready for a given submesh.
  75308. * All the dependencies e.g. submeshes, texture, effect... mus be ready
  75309. * @param subMesh Defines the submesh to check readyness for
  75310. * @param useInstances Defines wheter wee are trying to render instances or not
  75311. * @returns true if ready otherwise false
  75312. */
  75313. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  75314. private _beforeRenderingMesh;
  75315. private _afterRenderingMesh;
  75316. }
  75317. }
  75318. declare module "babylonjs/Rendering/index" {
  75319. export * from "babylonjs/Rendering/boundingBoxRenderer";
  75320. export * from "babylonjs/Rendering/depthRenderer";
  75321. export * from "babylonjs/Rendering/depthRendererSceneComponent";
  75322. export * from "babylonjs/Rendering/edgesRenderer";
  75323. export * from "babylonjs/Rendering/geometryBufferRenderer";
  75324. export * from "babylonjs/Rendering/geometryBufferRendererSceneComponent";
  75325. export * from "babylonjs/Rendering/prePassRenderer";
  75326. export * from "babylonjs/Rendering/prePassRendererSceneComponent";
  75327. export * from "babylonjs/Rendering/outlineRenderer";
  75328. export * from "babylonjs/Rendering/renderingGroup";
  75329. export * from "babylonjs/Rendering/renderingManager";
  75330. export * from "babylonjs/Rendering/utilityLayerRenderer";
  75331. }
  75332. declare module "babylonjs/Sprites/ISprites" {
  75333. /**
  75334. * Defines the basic options interface of a Sprite Frame Source Size.
  75335. */
  75336. export interface ISpriteJSONSpriteSourceSize {
  75337. /**
  75338. * number of the original width of the Frame
  75339. */
  75340. w: number;
  75341. /**
  75342. * number of the original height of the Frame
  75343. */
  75344. h: number;
  75345. }
  75346. /**
  75347. * Defines the basic options interface of a Sprite Frame Data.
  75348. */
  75349. export interface ISpriteJSONSpriteFrameData {
  75350. /**
  75351. * number of the x offset of the Frame
  75352. */
  75353. x: number;
  75354. /**
  75355. * number of the y offset of the Frame
  75356. */
  75357. y: number;
  75358. /**
  75359. * number of the width of the Frame
  75360. */
  75361. w: number;
  75362. /**
  75363. * number of the height of the Frame
  75364. */
  75365. h: number;
  75366. }
  75367. /**
  75368. * Defines the basic options interface of a JSON Sprite.
  75369. */
  75370. export interface ISpriteJSONSprite {
  75371. /**
  75372. * string name of the Frame
  75373. */
  75374. filename: string;
  75375. /**
  75376. * ISpriteJSONSpriteFrame basic object of the frame data
  75377. */
  75378. frame: ISpriteJSONSpriteFrameData;
  75379. /**
  75380. * boolean to flag is the frame was rotated.
  75381. */
  75382. rotated: boolean;
  75383. /**
  75384. * boolean to flag is the frame was trimmed.
  75385. */
  75386. trimmed: boolean;
  75387. /**
  75388. * ISpriteJSONSpriteFrame basic object of the source data
  75389. */
  75390. spriteSourceSize: ISpriteJSONSpriteFrameData;
  75391. /**
  75392. * ISpriteJSONSpriteFrame basic object of the source data
  75393. */
  75394. sourceSize: ISpriteJSONSpriteSourceSize;
  75395. }
  75396. /**
  75397. * Defines the basic options interface of a JSON atlas.
  75398. */
  75399. export interface ISpriteJSONAtlas {
  75400. /**
  75401. * Array of objects that contain the frame data.
  75402. */
  75403. frames: Array<ISpriteJSONSprite>;
  75404. /**
  75405. * object basic object containing the sprite meta data.
  75406. */
  75407. meta?: object;
  75408. }
  75409. }
  75410. declare module "babylonjs/Shaders/spriteMap.fragment" {
  75411. /** @hidden */
  75412. export var spriteMapPixelShader: {
  75413. name: string;
  75414. shader: string;
  75415. };
  75416. }
  75417. declare module "babylonjs/Shaders/spriteMap.vertex" {
  75418. /** @hidden */
  75419. export var spriteMapVertexShader: {
  75420. name: string;
  75421. shader: string;
  75422. };
  75423. }
  75424. declare module "babylonjs/Sprites/spriteMap" {
  75425. import { IDisposable, Scene } from "babylonjs/scene";
  75426. import { Vector2, Vector3 } from "babylonjs/Maths/math.vector";
  75427. import { Texture } from "babylonjs/Materials/Textures/texture";
  75428. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  75429. import { ISpriteJSONSprite, ISpriteJSONAtlas } from "babylonjs/Sprites/ISprites";
  75430. import "babylonjs/Meshes/Builders/planeBuilder";
  75431. import "babylonjs/Shaders/spriteMap.fragment";
  75432. import "babylonjs/Shaders/spriteMap.vertex";
  75433. /**
  75434. * Defines the basic options interface of a SpriteMap
  75435. */
  75436. export interface ISpriteMapOptions {
  75437. /**
  75438. * Vector2 of the number of cells in the grid.
  75439. */
  75440. stageSize?: Vector2;
  75441. /**
  75442. * Vector2 of the size of the output plane in World Units.
  75443. */
  75444. outputSize?: Vector2;
  75445. /**
  75446. * Vector3 of the position of the output plane in World Units.
  75447. */
  75448. outputPosition?: Vector3;
  75449. /**
  75450. * Vector3 of the rotation of the output plane.
  75451. */
  75452. outputRotation?: Vector3;
  75453. /**
  75454. * number of layers that the system will reserve in resources.
  75455. */
  75456. layerCount?: number;
  75457. /**
  75458. * number of max animation frames a single cell will reserve in resources.
  75459. */
  75460. maxAnimationFrames?: number;
  75461. /**
  75462. * number cell index of the base tile when the system compiles.
  75463. */
  75464. baseTile?: number;
  75465. /**
  75466. * boolean flip the sprite after its been repositioned by the framing data.
  75467. */
  75468. flipU?: boolean;
  75469. /**
  75470. * Vector3 scalar of the global RGB values of the SpriteMap.
  75471. */
  75472. colorMultiply?: Vector3;
  75473. }
  75474. /**
  75475. * Defines the IDisposable interface in order to be cleanable from resources.
  75476. */
  75477. export interface ISpriteMap extends IDisposable {
  75478. /**
  75479. * String name of the SpriteMap.
  75480. */
  75481. name: string;
  75482. /**
  75483. * The JSON Array file from a https://www.codeandweb.com/texturepacker export. Or similar structure.
  75484. */
  75485. atlasJSON: ISpriteJSONAtlas;
  75486. /**
  75487. * Texture of the SpriteMap.
  75488. */
  75489. spriteSheet: Texture;
  75490. /**
  75491. * The parameters to initialize the SpriteMap with.
  75492. */
  75493. options: ISpriteMapOptions;
  75494. }
  75495. /**
  75496. * Class used to manage a grid restricted sprite deployment on an Output plane.
  75497. */
  75498. export class SpriteMap implements ISpriteMap {
  75499. /** The Name of the spriteMap */
  75500. name: string;
  75501. /** The JSON file with the frame and meta data */
  75502. atlasJSON: ISpriteJSONAtlas;
  75503. /** The systems Sprite Sheet Texture */
  75504. spriteSheet: Texture;
  75505. /** Arguments passed with the Constructor */
  75506. options: ISpriteMapOptions;
  75507. /** Public Sprite Storage array, parsed from atlasJSON */
  75508. sprites: Array<ISpriteJSONSprite>;
  75509. /** Returns the Number of Sprites in the System */
  75510. get spriteCount(): number;
  75511. /** Returns the Position of Output Plane*/
  75512. get position(): Vector3;
  75513. /** Returns the Position of Output Plane*/
  75514. set position(v: Vector3);
  75515. /** Returns the Rotation of Output Plane*/
  75516. get rotation(): Vector3;
  75517. /** Returns the Rotation of Output Plane*/
  75518. set rotation(v: Vector3);
  75519. /** Sets the AnimationMap*/
  75520. get animationMap(): RawTexture;
  75521. /** Sets the AnimationMap*/
  75522. set animationMap(v: RawTexture);
  75523. /** Scene that the SpriteMap was created in */
  75524. private _scene;
  75525. /** Texture Buffer of Float32 that holds tile frame data*/
  75526. private _frameMap;
  75527. /** Texture Buffers of Float32 that holds tileMap data*/
  75528. private _tileMaps;
  75529. /** Texture Buffer of Float32 that holds Animation Data*/
  75530. private _animationMap;
  75531. /** Custom ShaderMaterial Central to the System*/
  75532. private _material;
  75533. /** Custom ShaderMaterial Central to the System*/
  75534. private _output;
  75535. /** Systems Time Ticker*/
  75536. private _time;
  75537. /**
  75538. * Creates a new SpriteMap
  75539. * @param name defines the SpriteMaps Name
  75540. * @param atlasJSON is the JSON file that controls the Sprites Frames and Meta
  75541. * @param spriteSheet is the Texture that the Sprites are on.
  75542. * @param options a basic deployment configuration
  75543. * @param scene The Scene that the map is deployed on
  75544. */
  75545. constructor(name: string, atlasJSON: ISpriteJSONAtlas, spriteSheet: Texture, options: ISpriteMapOptions, scene: Scene);
  75546. /**
  75547. * Returns tileID location
  75548. * @returns Vector2 the cell position ID
  75549. */
  75550. getTileID(): Vector2;
  75551. /**
  75552. * Gets the UV location of the mouse over the SpriteMap.
  75553. * @returns Vector2 the UV position of the mouse interaction
  75554. */
  75555. getMousePosition(): Vector2;
  75556. /**
  75557. * Creates the "frame" texture Buffer
  75558. * -------------------------------------
  75559. * Structure of frames
  75560. * "filename": "Falling-Water-2.png",
  75561. * "frame": {"x":69,"y":103,"w":24,"h":32},
  75562. * "rotated": true,
  75563. * "trimmed": true,
  75564. * "spriteSourceSize": {"x":4,"y":0,"w":24,"h":32},
  75565. * "sourceSize": {"w":32,"h":32}
  75566. * @returns RawTexture of the frameMap
  75567. */
  75568. private _createFrameBuffer;
  75569. /**
  75570. * Creates the tileMap texture Buffer
  75571. * @param buffer normally and array of numbers, or a false to generate from scratch
  75572. * @param _layer indicates what layer for a logic trigger dealing with the baseTile. The system uses this
  75573. * @returns RawTexture of the tileMap
  75574. */
  75575. private _createTileBuffer;
  75576. /**
  75577. * Modifies the data of the tileMaps
  75578. * @param _layer is the ID of the layer you want to edit on the SpriteMap
  75579. * @param pos is the iVector2 Coordinates of the Tile
  75580. * @param tile The SpriteIndex of the new Tile
  75581. */
  75582. changeTiles(_layer: number | undefined, pos: Vector2 | Vector2[], tile?: number): void;
  75583. /**
  75584. * Creates the animationMap texture Buffer
  75585. * @param buffer normally and array of numbers, or a false to generate from scratch
  75586. * @returns RawTexture of the animationMap
  75587. */
  75588. private _createTileAnimationBuffer;
  75589. /**
  75590. * Modifies the data of the animationMap
  75591. * @param cellID is the Index of the Sprite
  75592. * @param _frame is the target Animation frame
  75593. * @param toCell is the Target Index of the next frame of the animation
  75594. * @param time is a value between 0-1 that is the trigger for when the frame should change tiles
  75595. * @param speed is a global scalar of the time variable on the map.
  75596. */
  75597. addAnimationToTile(cellID?: number, _frame?: number, toCell?: number, time?: number, speed?: number): void;
  75598. /**
  75599. * Exports the .tilemaps file
  75600. */
  75601. saveTileMaps(): void;
  75602. /**
  75603. * Imports the .tilemaps file
  75604. * @param url of the .tilemaps file
  75605. */
  75606. loadTileMaps(url: string): void;
  75607. /**
  75608. * Release associated resources
  75609. */
  75610. dispose(): void;
  75611. }
  75612. }
  75613. declare module "babylonjs/Sprites/spritePackedManager" {
  75614. import { SpriteManager } from "babylonjs/Sprites/spriteManager";
  75615. import { Scene } from "babylonjs/scene";
  75616. /**
  75617. * Class used to manage multiple sprites of different sizes on the same spritesheet
  75618. * @see https://doc.babylonjs.com/babylon101/sprites
  75619. */
  75620. export class SpritePackedManager extends SpriteManager {
  75621. /** defines the packed manager's name */
  75622. name: string;
  75623. /**
  75624. * Creates a new sprite manager from a packed sprite sheet
  75625. * @param name defines the manager's name
  75626. * @param imgUrl defines the sprite sheet url
  75627. * @param capacity defines the maximum allowed number of sprites
  75628. * @param scene defines the hosting scene
  75629. * @param spriteJSON null otherwise a JSON object defining sprite sheet data
  75630. * @param epsilon defines the epsilon value to align texture (0.01 by default)
  75631. * @param samplingMode defines the smapling mode to use with spritesheet
  75632. * @param fromPacked set to true; do not alter
  75633. */
  75634. constructor(
  75635. /** defines the packed manager's name */
  75636. name: string, imgUrl: string, capacity: number, scene: Scene, spriteJSON?: string | null, epsilon?: number, samplingMode?: number);
  75637. }
  75638. }
  75639. declare module "babylonjs/Sprites/index" {
  75640. export * from "babylonjs/Sprites/sprite";
  75641. export * from "babylonjs/Sprites/ISprites";
  75642. export * from "babylonjs/Sprites/spriteManager";
  75643. export * from "babylonjs/Sprites/spriteMap";
  75644. export * from "babylonjs/Sprites/spritePackedManager";
  75645. export * from "babylonjs/Sprites/spriteSceneComponent";
  75646. }
  75647. declare module "babylonjs/States/index" {
  75648. export * from "babylonjs/States/alphaCullingState";
  75649. export * from "babylonjs/States/depthCullingState";
  75650. export * from "babylonjs/States/stencilState";
  75651. }
  75652. declare module "babylonjs/Misc/assetsManager" {
  75653. import { Scene } from "babylonjs/scene";
  75654. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  75655. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  75656. import { Skeleton } from "babylonjs/Bones/skeleton";
  75657. import { Observable } from "babylonjs/Misc/observable";
  75658. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  75659. import { Texture } from "babylonjs/Materials/Textures/texture";
  75660. import { CubeTexture } from "babylonjs/Materials/Textures/cubeTexture";
  75661. import { HDRCubeTexture } from "babylonjs/Materials/Textures/hdrCubeTexture";
  75662. import { EquiRectangularCubeTexture } from "babylonjs/Materials/Textures/equiRectangularCubeTexture";
  75663. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  75664. /**
  75665. * Defines the list of states available for a task inside a AssetsManager
  75666. */
  75667. export enum AssetTaskState {
  75668. /**
  75669. * Initialization
  75670. */
  75671. INIT = 0,
  75672. /**
  75673. * Running
  75674. */
  75675. RUNNING = 1,
  75676. /**
  75677. * Done
  75678. */
  75679. DONE = 2,
  75680. /**
  75681. * Error
  75682. */
  75683. ERROR = 3
  75684. }
  75685. /**
  75686. * Define an abstract asset task used with a AssetsManager class to load assets into a scene
  75687. */
  75688. export abstract class AbstractAssetTask {
  75689. /**
  75690. * Task name
  75691. */ name: string;
  75692. /**
  75693. * Callback called when the task is successful
  75694. */
  75695. onSuccess: (task: any) => void;
  75696. /**
  75697. * Callback called when the task is not successful
  75698. */
  75699. onError: (task: any, message?: string, exception?: any) => void;
  75700. /**
  75701. * Creates a new AssetsManager
  75702. * @param name defines the name of the task
  75703. */
  75704. constructor(
  75705. /**
  75706. * Task name
  75707. */ name: string);
  75708. private _isCompleted;
  75709. private _taskState;
  75710. private _errorObject;
  75711. /**
  75712. * Get if the task is completed
  75713. */
  75714. get isCompleted(): boolean;
  75715. /**
  75716. * Gets the current state of the task
  75717. */
  75718. get taskState(): AssetTaskState;
  75719. /**
  75720. * Gets the current error object (if task is in error)
  75721. */
  75722. get errorObject(): {
  75723. message?: string;
  75724. exception?: any;
  75725. };
  75726. /**
  75727. * Internal only
  75728. * @hidden
  75729. */
  75730. _setErrorObject(message?: string, exception?: any): void;
  75731. /**
  75732. * Execute the current task
  75733. * @param scene defines the scene where you want your assets to be loaded
  75734. * @param onSuccess is a callback called when the task is successfully executed
  75735. * @param onError is a callback called if an error occurs
  75736. */
  75737. run(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  75738. /**
  75739. * Execute the current task
  75740. * @param scene defines the scene where you want your assets to be loaded
  75741. * @param onSuccess is a callback called when the task is successfully executed
  75742. * @param onError is a callback called if an error occurs
  75743. */
  75744. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  75745. /**
  75746. * Reset will set the task state back to INIT, so the next load call of the assets manager will execute this task again.
  75747. * This can be used with failed tasks that have the reason for failure fixed.
  75748. */
  75749. reset(): void;
  75750. private onErrorCallback;
  75751. private onDoneCallback;
  75752. }
  75753. /**
  75754. * Define the interface used by progress events raised during assets loading
  75755. */
  75756. export interface IAssetsProgressEvent {
  75757. /**
  75758. * Defines the number of remaining tasks to process
  75759. */
  75760. remainingCount: number;
  75761. /**
  75762. * Defines the total number of tasks
  75763. */
  75764. totalCount: number;
  75765. /**
  75766. * Defines the task that was just processed
  75767. */
  75768. task: AbstractAssetTask;
  75769. }
  75770. /**
  75771. * Class used to share progress information about assets loading
  75772. */
  75773. export class AssetsProgressEvent implements IAssetsProgressEvent {
  75774. /**
  75775. * Defines the number of remaining tasks to process
  75776. */
  75777. remainingCount: number;
  75778. /**
  75779. * Defines the total number of tasks
  75780. */
  75781. totalCount: number;
  75782. /**
  75783. * Defines the task that was just processed
  75784. */
  75785. task: AbstractAssetTask;
  75786. /**
  75787. * Creates a AssetsProgressEvent
  75788. * @param remainingCount defines the number of remaining tasks to process
  75789. * @param totalCount defines the total number of tasks
  75790. * @param task defines the task that was just processed
  75791. */
  75792. constructor(remainingCount: number, totalCount: number, task: AbstractAssetTask);
  75793. }
  75794. /**
  75795. * Define a task used by AssetsManager to load meshes
  75796. */
  75797. export class MeshAssetTask extends AbstractAssetTask {
  75798. /**
  75799. * Defines the name of the task
  75800. */
  75801. name: string;
  75802. /**
  75803. * Defines the list of mesh's names you want to load
  75804. */
  75805. meshesNames: any;
  75806. /**
  75807. * Defines the root url to use as a base to load your meshes and associated resources
  75808. */
  75809. rootUrl: string;
  75810. /**
  75811. * Defines the filename or File of the scene to load from
  75812. */
  75813. sceneFilename: string | File;
  75814. /**
  75815. * Gets the list of loaded meshes
  75816. */
  75817. loadedMeshes: Array<AbstractMesh>;
  75818. /**
  75819. * Gets the list of loaded particle systems
  75820. */
  75821. loadedParticleSystems: Array<IParticleSystem>;
  75822. /**
  75823. * Gets the list of loaded skeletons
  75824. */
  75825. loadedSkeletons: Array<Skeleton>;
  75826. /**
  75827. * Gets the list of loaded animation groups
  75828. */
  75829. loadedAnimationGroups: Array<AnimationGroup>;
  75830. /**
  75831. * Callback called when the task is successful
  75832. */
  75833. onSuccess: (task: MeshAssetTask) => void;
  75834. /**
  75835. * Callback called when the task is successful
  75836. */
  75837. onError: (task: MeshAssetTask, message?: string, exception?: any) => void;
  75838. /**
  75839. * Creates a new MeshAssetTask
  75840. * @param name defines the name of the task
  75841. * @param meshesNames defines the list of mesh's names you want to load
  75842. * @param rootUrl defines the root url to use as a base to load your meshes and associated resources
  75843. * @param sceneFilename defines the filename or File of the scene to load from
  75844. */
  75845. constructor(
  75846. /**
  75847. * Defines the name of the task
  75848. */
  75849. name: string,
  75850. /**
  75851. * Defines the list of mesh's names you want to load
  75852. */
  75853. meshesNames: any,
  75854. /**
  75855. * Defines the root url to use as a base to load your meshes and associated resources
  75856. */
  75857. rootUrl: string,
  75858. /**
  75859. * Defines the filename or File of the scene to load from
  75860. */
  75861. sceneFilename: string | File);
  75862. /**
  75863. * Execute the current task
  75864. * @param scene defines the scene where you want your assets to be loaded
  75865. * @param onSuccess is a callback called when the task is successfully executed
  75866. * @param onError is a callback called if an error occurs
  75867. */
  75868. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  75869. }
  75870. /**
  75871. * Define a task used by AssetsManager to load text content
  75872. */
  75873. export class TextFileAssetTask extends AbstractAssetTask {
  75874. /**
  75875. * Defines the name of the task
  75876. */
  75877. name: string;
  75878. /**
  75879. * Defines the location of the file to load
  75880. */
  75881. url: string;
  75882. /**
  75883. * Gets the loaded text string
  75884. */
  75885. text: string;
  75886. /**
  75887. * Callback called when the task is successful
  75888. */
  75889. onSuccess: (task: TextFileAssetTask) => void;
  75890. /**
  75891. * Callback called when the task is successful
  75892. */
  75893. onError: (task: TextFileAssetTask, message?: string, exception?: any) => void;
  75894. /**
  75895. * Creates a new TextFileAssetTask object
  75896. * @param name defines the name of the task
  75897. * @param url defines the location of the file to load
  75898. */
  75899. constructor(
  75900. /**
  75901. * Defines the name of the task
  75902. */
  75903. name: string,
  75904. /**
  75905. * Defines the location of the file to load
  75906. */
  75907. url: string);
  75908. /**
  75909. * Execute the current task
  75910. * @param scene defines the scene where you want your assets to be loaded
  75911. * @param onSuccess is a callback called when the task is successfully executed
  75912. * @param onError is a callback called if an error occurs
  75913. */
  75914. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  75915. }
  75916. /**
  75917. * Define a task used by AssetsManager to load binary data
  75918. */
  75919. export class BinaryFileAssetTask extends AbstractAssetTask {
  75920. /**
  75921. * Defines the name of the task
  75922. */
  75923. name: string;
  75924. /**
  75925. * Defines the location of the file to load
  75926. */
  75927. url: string;
  75928. /**
  75929. * Gets the lodaded data (as an array buffer)
  75930. */
  75931. data: ArrayBuffer;
  75932. /**
  75933. * Callback called when the task is successful
  75934. */
  75935. onSuccess: (task: BinaryFileAssetTask) => void;
  75936. /**
  75937. * Callback called when the task is successful
  75938. */
  75939. onError: (task: BinaryFileAssetTask, message?: string, exception?: any) => void;
  75940. /**
  75941. * Creates a new BinaryFileAssetTask object
  75942. * @param name defines the name of the new task
  75943. * @param url defines the location of the file to load
  75944. */
  75945. constructor(
  75946. /**
  75947. * Defines the name of the task
  75948. */
  75949. name: string,
  75950. /**
  75951. * Defines the location of the file to load
  75952. */
  75953. url: string);
  75954. /**
  75955. * Execute the current task
  75956. * @param scene defines the scene where you want your assets to be loaded
  75957. * @param onSuccess is a callback called when the task is successfully executed
  75958. * @param onError is a callback called if an error occurs
  75959. */
  75960. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  75961. }
  75962. /**
  75963. * Define a task used by AssetsManager to load images
  75964. */
  75965. export class ImageAssetTask extends AbstractAssetTask {
  75966. /**
  75967. * Defines the name of the task
  75968. */
  75969. name: string;
  75970. /**
  75971. * Defines the location of the image to load
  75972. */
  75973. url: string;
  75974. /**
  75975. * Gets the loaded images
  75976. */
  75977. image: HTMLImageElement;
  75978. /**
  75979. * Callback called when the task is successful
  75980. */
  75981. onSuccess: (task: ImageAssetTask) => void;
  75982. /**
  75983. * Callback called when the task is successful
  75984. */
  75985. onError: (task: ImageAssetTask, message?: string, exception?: any) => void;
  75986. /**
  75987. * Creates a new ImageAssetTask
  75988. * @param name defines the name of the task
  75989. * @param url defines the location of the image to load
  75990. */
  75991. constructor(
  75992. /**
  75993. * Defines the name of the task
  75994. */
  75995. name: string,
  75996. /**
  75997. * Defines the location of the image to load
  75998. */
  75999. url: string);
  76000. /**
  76001. * Execute the current task
  76002. * @param scene defines the scene where you want your assets to be loaded
  76003. * @param onSuccess is a callback called when the task is successfully executed
  76004. * @param onError is a callback called if an error occurs
  76005. */
  76006. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76007. }
  76008. /**
  76009. * Defines the interface used by texture loading tasks
  76010. */
  76011. export interface ITextureAssetTask<TEX extends BaseTexture> {
  76012. /**
  76013. * Gets the loaded texture
  76014. */
  76015. texture: TEX;
  76016. }
  76017. /**
  76018. * Define a task used by AssetsManager to load 2D textures
  76019. */
  76020. export class TextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<Texture> {
  76021. /**
  76022. * Defines the name of the task
  76023. */
  76024. name: string;
  76025. /**
  76026. * Defines the location of the file to load
  76027. */
  76028. url: string;
  76029. /**
  76030. * Defines if mipmap should not be generated (default is false)
  76031. */
  76032. noMipmap?: boolean | undefined;
  76033. /**
  76034. * Defines if texture must be inverted on Y axis (default is true)
  76035. */
  76036. invertY: boolean;
  76037. /**
  76038. * Defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  76039. */
  76040. samplingMode: number;
  76041. /**
  76042. * Gets the loaded texture
  76043. */
  76044. texture: Texture;
  76045. /**
  76046. * Callback called when the task is successful
  76047. */
  76048. onSuccess: (task: TextureAssetTask) => void;
  76049. /**
  76050. * Callback called when the task is successful
  76051. */
  76052. onError: (task: TextureAssetTask, message?: string, exception?: any) => void;
  76053. /**
  76054. * Creates a new TextureAssetTask object
  76055. * @param name defines the name of the task
  76056. * @param url defines the location of the file to load
  76057. * @param noMipmap defines if mipmap should not be generated (default is false)
  76058. * @param invertY defines if texture must be inverted on Y axis (default is true)
  76059. * @param samplingMode defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  76060. */
  76061. constructor(
  76062. /**
  76063. * Defines the name of the task
  76064. */
  76065. name: string,
  76066. /**
  76067. * Defines the location of the file to load
  76068. */
  76069. url: string,
  76070. /**
  76071. * Defines if mipmap should not be generated (default is false)
  76072. */
  76073. noMipmap?: boolean | undefined,
  76074. /**
  76075. * Defines if texture must be inverted on Y axis (default is true)
  76076. */
  76077. invertY?: boolean,
  76078. /**
  76079. * Defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  76080. */
  76081. samplingMode?: number);
  76082. /**
  76083. * Execute the current task
  76084. * @param scene defines the scene where you want your assets to be loaded
  76085. * @param onSuccess is a callback called when the task is successfully executed
  76086. * @param onError is a callback called if an error occurs
  76087. */
  76088. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76089. }
  76090. /**
  76091. * Define a task used by AssetsManager to load cube textures
  76092. */
  76093. export class CubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<CubeTexture> {
  76094. /**
  76095. * Defines the name of the task
  76096. */
  76097. name: string;
  76098. /**
  76099. * Defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  76100. */
  76101. url: string;
  76102. /**
  76103. * Defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  76104. */
  76105. extensions?: string[] | undefined;
  76106. /**
  76107. * Defines if mipmaps should not be generated (default is false)
  76108. */
  76109. noMipmap?: boolean | undefined;
  76110. /**
  76111. * Defines the explicit list of files (undefined by default)
  76112. */
  76113. files?: string[] | undefined;
  76114. /**
  76115. * Gets the loaded texture
  76116. */
  76117. texture: CubeTexture;
  76118. /**
  76119. * Callback called when the task is successful
  76120. */
  76121. onSuccess: (task: CubeTextureAssetTask) => void;
  76122. /**
  76123. * Callback called when the task is successful
  76124. */
  76125. onError: (task: CubeTextureAssetTask, message?: string, exception?: any) => void;
  76126. /**
  76127. * Creates a new CubeTextureAssetTask
  76128. * @param name defines the name of the task
  76129. * @param url defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  76130. * @param extensions defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  76131. * @param noMipmap defines if mipmaps should not be generated (default is false)
  76132. * @param files defines the explicit list of files (undefined by default)
  76133. */
  76134. constructor(
  76135. /**
  76136. * Defines the name of the task
  76137. */
  76138. name: string,
  76139. /**
  76140. * Defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  76141. */
  76142. url: string,
  76143. /**
  76144. * Defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  76145. */
  76146. extensions?: string[] | undefined,
  76147. /**
  76148. * Defines if mipmaps should not be generated (default is false)
  76149. */
  76150. noMipmap?: boolean | undefined,
  76151. /**
  76152. * Defines the explicit list of files (undefined by default)
  76153. */
  76154. files?: string[] | undefined);
  76155. /**
  76156. * Execute the current task
  76157. * @param scene defines the scene where you want your assets to be loaded
  76158. * @param onSuccess is a callback called when the task is successfully executed
  76159. * @param onError is a callback called if an error occurs
  76160. */
  76161. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76162. }
  76163. /**
  76164. * Define a task used by AssetsManager to load HDR cube textures
  76165. */
  76166. export class HDRCubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<HDRCubeTexture> {
  76167. /**
  76168. * Defines the name of the task
  76169. */
  76170. name: string;
  76171. /**
  76172. * Defines the location of the file to load
  76173. */
  76174. url: string;
  76175. /**
  76176. * Defines the desired size (the more it increases the longer the generation will be)
  76177. */
  76178. size: number;
  76179. /**
  76180. * Defines if mipmaps should not be generated (default is false)
  76181. */
  76182. noMipmap: boolean;
  76183. /**
  76184. * Specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  76185. */
  76186. generateHarmonics: boolean;
  76187. /**
  76188. * 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)
  76189. */
  76190. gammaSpace: boolean;
  76191. /**
  76192. * Internal Use Only
  76193. */
  76194. reserved: boolean;
  76195. /**
  76196. * Gets the loaded texture
  76197. */
  76198. texture: HDRCubeTexture;
  76199. /**
  76200. * Callback called when the task is successful
  76201. */
  76202. onSuccess: (task: HDRCubeTextureAssetTask) => void;
  76203. /**
  76204. * Callback called when the task is successful
  76205. */
  76206. onError: (task: HDRCubeTextureAssetTask, message?: string, exception?: any) => void;
  76207. /**
  76208. * Creates a new HDRCubeTextureAssetTask object
  76209. * @param name defines the name of the task
  76210. * @param url defines the location of the file to load
  76211. * @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.
  76212. * @param noMipmap defines if mipmaps should not be generated (default is false)
  76213. * @param generateHarmonics specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  76214. * @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)
  76215. * @param reserved Internal use only
  76216. */
  76217. constructor(
  76218. /**
  76219. * Defines the name of the task
  76220. */
  76221. name: string,
  76222. /**
  76223. * Defines the location of the file to load
  76224. */
  76225. url: string,
  76226. /**
  76227. * Defines the desired size (the more it increases the longer the generation will be)
  76228. */
  76229. size: number,
  76230. /**
  76231. * Defines if mipmaps should not be generated (default is false)
  76232. */
  76233. noMipmap?: boolean,
  76234. /**
  76235. * Specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  76236. */
  76237. generateHarmonics?: boolean,
  76238. /**
  76239. * 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)
  76240. */
  76241. gammaSpace?: boolean,
  76242. /**
  76243. * Internal Use Only
  76244. */
  76245. reserved?: boolean);
  76246. /**
  76247. * Execute the current task
  76248. * @param scene defines the scene where you want your assets to be loaded
  76249. * @param onSuccess is a callback called when the task is successfully executed
  76250. * @param onError is a callback called if an error occurs
  76251. */
  76252. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76253. }
  76254. /**
  76255. * Define a task used by AssetsManager to load Equirectangular cube textures
  76256. */
  76257. export class EquiRectangularCubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<EquiRectangularCubeTexture> {
  76258. /**
  76259. * Defines the name of the task
  76260. */
  76261. name: string;
  76262. /**
  76263. * Defines the location of the file to load
  76264. */
  76265. url: string;
  76266. /**
  76267. * Defines the desired size (the more it increases the longer the generation will be)
  76268. */
  76269. size: number;
  76270. /**
  76271. * Defines if mipmaps should not be generated (default is false)
  76272. */
  76273. noMipmap: boolean;
  76274. /**
  76275. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space,
  76276. * but the standard material would require them in Gamma space) (default is true)
  76277. */
  76278. gammaSpace: boolean;
  76279. /**
  76280. * Gets the loaded texture
  76281. */
  76282. texture: EquiRectangularCubeTexture;
  76283. /**
  76284. * Callback called when the task is successful
  76285. */
  76286. onSuccess: (task: EquiRectangularCubeTextureAssetTask) => void;
  76287. /**
  76288. * Callback called when the task is successful
  76289. */
  76290. onError: (task: EquiRectangularCubeTextureAssetTask, message?: string, exception?: any) => void;
  76291. /**
  76292. * Creates a new EquiRectangularCubeTextureAssetTask object
  76293. * @param name defines the name of the task
  76294. * @param url defines the location of the file to load
  76295. * @param size defines the desired size (the more it increases the longer the generation will be)
  76296. * If the size is omitted this implies you are using a preprocessed cubemap.
  76297. * @param noMipmap defines if mipmaps should not be generated (default is false)
  76298. * @param gammaSpace specifies if the texture will be used in gamma or linear space
  76299. * (the PBR material requires those texture in linear space, but the standard material would require them in Gamma space)
  76300. * (default is true)
  76301. */
  76302. constructor(
  76303. /**
  76304. * Defines the name of the task
  76305. */
  76306. name: string,
  76307. /**
  76308. * Defines the location of the file to load
  76309. */
  76310. url: string,
  76311. /**
  76312. * Defines the desired size (the more it increases the longer the generation will be)
  76313. */
  76314. size: number,
  76315. /**
  76316. * Defines if mipmaps should not be generated (default is false)
  76317. */
  76318. noMipmap?: boolean,
  76319. /**
  76320. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space,
  76321. * but the standard material would require them in Gamma space) (default is true)
  76322. */
  76323. gammaSpace?: boolean);
  76324. /**
  76325. * Execute the current task
  76326. * @param scene defines the scene where you want your assets to be loaded
  76327. * @param onSuccess is a callback called when the task is successfully executed
  76328. * @param onError is a callback called if an error occurs
  76329. */
  76330. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76331. }
  76332. /**
  76333. * This class can be used to easily import assets into a scene
  76334. * @see https://doc.babylonjs.com/how_to/how_to_use_assetsmanager
  76335. */
  76336. export class AssetsManager {
  76337. private _scene;
  76338. private _isLoading;
  76339. protected _tasks: AbstractAssetTask[];
  76340. protected _waitingTasksCount: number;
  76341. protected _totalTasksCount: number;
  76342. /**
  76343. * Callback called when all tasks are processed
  76344. */
  76345. onFinish: (tasks: AbstractAssetTask[]) => void;
  76346. /**
  76347. * Callback called when a task is successful
  76348. */
  76349. onTaskSuccess: (task: AbstractAssetTask) => void;
  76350. /**
  76351. * Callback called when a task had an error
  76352. */
  76353. onTaskError: (task: AbstractAssetTask) => void;
  76354. /**
  76355. * Callback called when a task is done (whatever the result is)
  76356. */
  76357. onProgress: (remainingCount: number, totalCount: number, task: AbstractAssetTask) => void;
  76358. /**
  76359. * Observable called when all tasks are processed
  76360. */
  76361. onTaskSuccessObservable: Observable<AbstractAssetTask>;
  76362. /**
  76363. * Observable called when a task had an error
  76364. */
  76365. onTaskErrorObservable: Observable<AbstractAssetTask>;
  76366. /**
  76367. * Observable called when all tasks were executed
  76368. */
  76369. onTasksDoneObservable: Observable<AbstractAssetTask[]>;
  76370. /**
  76371. * Observable called when a task is done (whatever the result is)
  76372. */
  76373. onProgressObservable: Observable<IAssetsProgressEvent>;
  76374. /**
  76375. * Gets or sets a boolean defining if the AssetsManager should use the default loading screen
  76376. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  76377. */
  76378. useDefaultLoadingScreen: boolean;
  76379. /**
  76380. * Gets or sets a boolean defining if the AssetsManager should automatically hide the loading screen
  76381. * when all assets have been downloaded.
  76382. * If set to false, you need to manually call in hideLoadingUI() once your scene is ready.
  76383. */
  76384. autoHideLoadingUI: boolean;
  76385. /**
  76386. * Creates a new AssetsManager
  76387. * @param scene defines the scene to work on
  76388. */
  76389. constructor(scene: Scene);
  76390. /**
  76391. * Add a MeshAssetTask to the list of active tasks
  76392. * @param taskName defines the name of the new task
  76393. * @param meshesNames defines the name of meshes to load
  76394. * @param rootUrl defines the root url to use to locate files
  76395. * @param sceneFilename defines the filename of the scene file
  76396. * @returns a new MeshAssetTask object
  76397. */
  76398. addMeshTask(taskName: string, meshesNames: any, rootUrl: string, sceneFilename: string): MeshAssetTask;
  76399. /**
  76400. * Add a TextFileAssetTask to the list of active tasks
  76401. * @param taskName defines the name of the new task
  76402. * @param url defines the url of the file to load
  76403. * @returns a new TextFileAssetTask object
  76404. */
  76405. addTextFileTask(taskName: string, url: string): TextFileAssetTask;
  76406. /**
  76407. * Add a BinaryFileAssetTask to the list of active tasks
  76408. * @param taskName defines the name of the new task
  76409. * @param url defines the url of the file to load
  76410. * @returns a new BinaryFileAssetTask object
  76411. */
  76412. addBinaryFileTask(taskName: string, url: string): BinaryFileAssetTask;
  76413. /**
  76414. * Add a ImageAssetTask to the list of active tasks
  76415. * @param taskName defines the name of the new task
  76416. * @param url defines the url of the file to load
  76417. * @returns a new ImageAssetTask object
  76418. */
  76419. addImageTask(taskName: string, url: string): ImageAssetTask;
  76420. /**
  76421. * Add a TextureAssetTask to the list of active tasks
  76422. * @param taskName defines the name of the new task
  76423. * @param url defines the url of the file to load
  76424. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  76425. * @param invertY defines if you want to invert Y axis of the loaded texture (false by default)
  76426. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  76427. * @returns a new TextureAssetTask object
  76428. */
  76429. addTextureTask(taskName: string, url: string, noMipmap?: boolean, invertY?: boolean, samplingMode?: number): TextureAssetTask;
  76430. /**
  76431. * Add a CubeTextureAssetTask to the list of active tasks
  76432. * @param taskName defines the name of the new task
  76433. * @param url defines the url of the file to load
  76434. * @param extensions defines the extension to use to load the cube map (can be null)
  76435. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  76436. * @param files defines the list of files to load (can be null)
  76437. * @returns a new CubeTextureAssetTask object
  76438. */
  76439. addCubeTextureTask(taskName: string, url: string, extensions?: string[], noMipmap?: boolean, files?: string[]): CubeTextureAssetTask;
  76440. /**
  76441. *
  76442. * Add a HDRCubeTextureAssetTask to the list of active tasks
  76443. * @param taskName defines the name of the new task
  76444. * @param url defines the url of the file to load
  76445. * @param size defines the size you want for the cubemap (can be null)
  76446. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  76447. * @param generateHarmonics defines if you want to automatically generate (true by default)
  76448. * @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)
  76449. * @param reserved Internal use only
  76450. * @returns a new HDRCubeTextureAssetTask object
  76451. */
  76452. addHDRCubeTextureTask(taskName: string, url: string, size: number, noMipmap?: boolean, generateHarmonics?: boolean, gammaSpace?: boolean, reserved?: boolean): HDRCubeTextureAssetTask;
  76453. /**
  76454. *
  76455. * Add a EquiRectangularCubeTextureAssetTask to the list of active tasks
  76456. * @param taskName defines the name of the new task
  76457. * @param url defines the url of the file to load
  76458. * @param size defines the size you want for the cubemap (can be null)
  76459. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  76460. * @param gammaSpace Specifies if the texture will be used in gamma or linear space
  76461. * (the PBR material requires those textures in linear space, but the standard material would require them in Gamma space)
  76462. * @returns a new EquiRectangularCubeTextureAssetTask object
  76463. */
  76464. addEquiRectangularCubeTextureAssetTask(taskName: string, url: string, size: number, noMipmap?: boolean, gammaSpace?: boolean): EquiRectangularCubeTextureAssetTask;
  76465. /**
  76466. * Remove a task from the assets manager.
  76467. * @param task the task to remove
  76468. */
  76469. removeTask(task: AbstractAssetTask): void;
  76470. private _decreaseWaitingTasksCount;
  76471. private _runTask;
  76472. /**
  76473. * Reset the AssetsManager and remove all tasks
  76474. * @return the current instance of the AssetsManager
  76475. */
  76476. reset(): AssetsManager;
  76477. /**
  76478. * Start the loading process
  76479. * @return the current instance of the AssetsManager
  76480. */
  76481. load(): AssetsManager;
  76482. /**
  76483. * Start the loading process as an async operation
  76484. * @return a promise returning the list of failed tasks
  76485. */
  76486. loadAsync(): Promise<void>;
  76487. }
  76488. }
  76489. declare module "babylonjs/Misc/deferred" {
  76490. /**
  76491. * Wrapper class for promise with external resolve and reject.
  76492. */
  76493. export class Deferred<T> {
  76494. /**
  76495. * The promise associated with this deferred object.
  76496. */
  76497. readonly promise: Promise<T>;
  76498. private _resolve;
  76499. private _reject;
  76500. /**
  76501. * The resolve method of the promise associated with this deferred object.
  76502. */
  76503. get resolve(): (value?: T | PromiseLike<T> | undefined) => void;
  76504. /**
  76505. * The reject method of the promise associated with this deferred object.
  76506. */
  76507. get reject(): (reason?: any) => void;
  76508. /**
  76509. * Constructor for this deferred object.
  76510. */
  76511. constructor();
  76512. }
  76513. }
  76514. declare module "babylonjs/Misc/meshExploder" {
  76515. import { Mesh } from "babylonjs/Meshes/mesh";
  76516. /**
  76517. * Class used to explode meshes (ie. to have a center and move them away from that center to better see the overall organization)
  76518. */
  76519. export class MeshExploder {
  76520. private _centerMesh;
  76521. private _meshes;
  76522. private _meshesOrigins;
  76523. private _toCenterVectors;
  76524. private _scaledDirection;
  76525. private _newPosition;
  76526. private _centerPosition;
  76527. /**
  76528. * Explodes meshes from a center mesh.
  76529. * @param meshes The meshes to explode.
  76530. * @param centerMesh The mesh to be center of explosion.
  76531. */
  76532. constructor(meshes: Array<Mesh>, centerMesh?: Mesh);
  76533. private _setCenterMesh;
  76534. /**
  76535. * Get class name
  76536. * @returns "MeshExploder"
  76537. */
  76538. getClassName(): string;
  76539. /**
  76540. * "Exploded meshes"
  76541. * @returns Array of meshes with the centerMesh at index 0.
  76542. */
  76543. getMeshes(): Array<Mesh>;
  76544. /**
  76545. * Explodes meshes giving a specific direction
  76546. * @param direction Number to multiply distance of each mesh's origin from center. Use a negative number to implode, or zero to reset.
  76547. */
  76548. explode(direction?: number): void;
  76549. }
  76550. }
  76551. declare module "babylonjs/Misc/filesInput" {
  76552. import { Engine } from "babylonjs/Engines/engine";
  76553. import { Scene } from "babylonjs/scene";
  76554. import { ISceneLoaderProgressEvent } from "babylonjs/Loading/sceneLoader";
  76555. import { Nullable } from "babylonjs/types";
  76556. /**
  76557. * Class used to help managing file picking and drag'n'drop
  76558. */
  76559. export class FilesInput {
  76560. /**
  76561. * List of files ready to be loaded
  76562. */
  76563. static get FilesToLoad(): {
  76564. [key: string]: File;
  76565. };
  76566. /**
  76567. * Callback called when a file is processed
  76568. */
  76569. onProcessFileCallback: (file: File, name: string, extension: string) => boolean;
  76570. private _engine;
  76571. private _currentScene;
  76572. private _sceneLoadedCallback;
  76573. private _progressCallback;
  76574. private _additionalRenderLoopLogicCallback;
  76575. private _textureLoadingCallback;
  76576. private _startingProcessingFilesCallback;
  76577. private _onReloadCallback;
  76578. private _errorCallback;
  76579. private _elementToMonitor;
  76580. private _sceneFileToLoad;
  76581. private _filesToLoad;
  76582. /**
  76583. * Creates a new FilesInput
  76584. * @param engine defines the rendering engine
  76585. * @param scene defines the hosting scene
  76586. * @param sceneLoadedCallback callback called when scene is loaded
  76587. * @param progressCallback callback called to track progress
  76588. * @param additionalRenderLoopLogicCallback callback called to add user logic to the rendering loop
  76589. * @param textureLoadingCallback callback called when a texture is loading
  76590. * @param startingProcessingFilesCallback callback called when the system is about to process all files
  76591. * @param onReloadCallback callback called when a reload is requested
  76592. * @param errorCallback callback call if an error occurs
  76593. */
  76594. 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>);
  76595. private _dragEnterHandler;
  76596. private _dragOverHandler;
  76597. private _dropHandler;
  76598. /**
  76599. * Calls this function to listen to drag'n'drop events on a specific DOM element
  76600. * @param elementToMonitor defines the DOM element to track
  76601. */
  76602. monitorElementForDragNDrop(elementToMonitor: HTMLElement): void;
  76603. /** Gets the current list of files to load */
  76604. get filesToLoad(): File[];
  76605. /**
  76606. * Release all associated resources
  76607. */
  76608. dispose(): void;
  76609. private renderFunction;
  76610. private drag;
  76611. private drop;
  76612. private _traverseFolder;
  76613. private _processFiles;
  76614. /**
  76615. * Load files from a drop event
  76616. * @param event defines the drop event to use as source
  76617. */
  76618. loadFiles(event: any): void;
  76619. private _processReload;
  76620. /**
  76621. * Reload the current scene from the loaded files
  76622. */
  76623. reload(): void;
  76624. }
  76625. }
  76626. declare module "babylonjs/Misc/HighDynamicRange/index" {
  76627. export * from "babylonjs/Misc/HighDynamicRange/cubemapToSphericalPolynomial";
  76628. export * from "babylonjs/Misc/HighDynamicRange/hdr";
  76629. export * from "babylonjs/Misc/HighDynamicRange/panoramaToCubemap";
  76630. }
  76631. declare module "babylonjs/Misc/sceneOptimizer" {
  76632. import { Scene, IDisposable } from "babylonjs/scene";
  76633. import { Observable } from "babylonjs/Misc/observable";
  76634. /**
  76635. * Defines the root class used to create scene optimization to use with SceneOptimizer
  76636. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  76637. */
  76638. export class SceneOptimization {
  76639. /**
  76640. * Defines the priority of this optimization (0 by default which means first in the list)
  76641. */
  76642. priority: number;
  76643. /**
  76644. * Gets a string describing the action executed by the current optimization
  76645. * @returns description string
  76646. */
  76647. getDescription(): string;
  76648. /**
  76649. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  76650. * @param scene defines the current scene where to apply this optimization
  76651. * @param optimizer defines the current optimizer
  76652. * @returns true if everything that can be done was applied
  76653. */
  76654. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  76655. /**
  76656. * Creates the SceneOptimization object
  76657. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  76658. * @param desc defines the description associated with the optimization
  76659. */
  76660. constructor(
  76661. /**
  76662. * Defines the priority of this optimization (0 by default which means first in the list)
  76663. */
  76664. priority?: number);
  76665. }
  76666. /**
  76667. * Defines an optimization used to reduce the size of render target textures
  76668. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  76669. */
  76670. export class TextureOptimization extends SceneOptimization {
  76671. /**
  76672. * Defines the priority of this optimization (0 by default which means first in the list)
  76673. */
  76674. priority: number;
  76675. /**
  76676. * 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
  76677. */
  76678. maximumSize: number;
  76679. /**
  76680. * Defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  76681. */
  76682. step: number;
  76683. /**
  76684. * Gets a string describing the action executed by the current optimization
  76685. * @returns description string
  76686. */
  76687. getDescription(): string;
  76688. /**
  76689. * Creates the TextureOptimization object
  76690. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  76691. * @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
  76692. * @param step defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  76693. */
  76694. constructor(
  76695. /**
  76696. * Defines the priority of this optimization (0 by default which means first in the list)
  76697. */
  76698. priority?: number,
  76699. /**
  76700. * 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
  76701. */
  76702. maximumSize?: number,
  76703. /**
  76704. * Defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  76705. */
  76706. step?: number);
  76707. /**
  76708. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  76709. * @param scene defines the current scene where to apply this optimization
  76710. * @param optimizer defines the current optimizer
  76711. * @returns true if everything that can be done was applied
  76712. */
  76713. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  76714. }
  76715. /**
  76716. * Defines an optimization used to increase or decrease the rendering resolution
  76717. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  76718. */
  76719. export class HardwareScalingOptimization extends SceneOptimization {
  76720. /**
  76721. * Defines the priority of this optimization (0 by default which means first in the list)
  76722. */
  76723. priority: number;
  76724. /**
  76725. * Defines the maximum scale to use (2 by default)
  76726. */
  76727. maximumScale: number;
  76728. /**
  76729. * Defines the step to use between two passes (0.5 by default)
  76730. */
  76731. step: number;
  76732. private _currentScale;
  76733. private _directionOffset;
  76734. /**
  76735. * Gets a string describing the action executed by the current optimization
  76736. * @return description string
  76737. */
  76738. getDescription(): string;
  76739. /**
  76740. * Creates the HardwareScalingOptimization object
  76741. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  76742. * @param maximumScale defines the maximum scale to use (2 by default)
  76743. * @param step defines the step to use between two passes (0.5 by default)
  76744. */
  76745. constructor(
  76746. /**
  76747. * Defines the priority of this optimization (0 by default which means first in the list)
  76748. */
  76749. priority?: number,
  76750. /**
  76751. * Defines the maximum scale to use (2 by default)
  76752. */
  76753. maximumScale?: number,
  76754. /**
  76755. * Defines the step to use between two passes (0.5 by default)
  76756. */
  76757. step?: number);
  76758. /**
  76759. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  76760. * @param scene defines the current scene where to apply this optimization
  76761. * @param optimizer defines the current optimizer
  76762. * @returns true if everything that can be done was applied
  76763. */
  76764. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  76765. }
  76766. /**
  76767. * Defines an optimization used to remove shadows
  76768. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  76769. */
  76770. export class ShadowsOptimization extends SceneOptimization {
  76771. /**
  76772. * Gets a string describing the action executed by the current optimization
  76773. * @return description string
  76774. */
  76775. getDescription(): string;
  76776. /**
  76777. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  76778. * @param scene defines the current scene where to apply this optimization
  76779. * @param optimizer defines the current optimizer
  76780. * @returns true if everything that can be done was applied
  76781. */
  76782. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  76783. }
  76784. /**
  76785. * Defines an optimization used to turn post-processes off
  76786. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  76787. */
  76788. export class PostProcessesOptimization extends SceneOptimization {
  76789. /**
  76790. * Gets a string describing the action executed by the current optimization
  76791. * @return description string
  76792. */
  76793. getDescription(): string;
  76794. /**
  76795. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  76796. * @param scene defines the current scene where to apply this optimization
  76797. * @param optimizer defines the current optimizer
  76798. * @returns true if everything that can be done was applied
  76799. */
  76800. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  76801. }
  76802. /**
  76803. * Defines an optimization used to turn lens flares off
  76804. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  76805. */
  76806. export class LensFlaresOptimization extends SceneOptimization {
  76807. /**
  76808. * Gets a string describing the action executed by the current optimization
  76809. * @return description string
  76810. */
  76811. getDescription(): string;
  76812. /**
  76813. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  76814. * @param scene defines the current scene where to apply this optimization
  76815. * @param optimizer defines the current optimizer
  76816. * @returns true if everything that can be done was applied
  76817. */
  76818. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  76819. }
  76820. /**
  76821. * Defines an optimization based on user defined callback.
  76822. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  76823. */
  76824. export class CustomOptimization extends SceneOptimization {
  76825. /**
  76826. * Callback called to apply the custom optimization.
  76827. */
  76828. onApply: (scene: Scene, optimizer: SceneOptimizer) => boolean;
  76829. /**
  76830. * Callback called to get custom description
  76831. */
  76832. onGetDescription: () => string;
  76833. /**
  76834. * Gets a string describing the action executed by the current optimization
  76835. * @returns description string
  76836. */
  76837. getDescription(): string;
  76838. /**
  76839. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  76840. * @param scene defines the current scene where to apply this optimization
  76841. * @param optimizer defines the current optimizer
  76842. * @returns true if everything that can be done was applied
  76843. */
  76844. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  76845. }
  76846. /**
  76847. * Defines an optimization used to turn particles off
  76848. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  76849. */
  76850. export class ParticlesOptimization extends SceneOptimization {
  76851. /**
  76852. * Gets a string describing the action executed by the current optimization
  76853. * @return description string
  76854. */
  76855. getDescription(): string;
  76856. /**
  76857. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  76858. * @param scene defines the current scene where to apply this optimization
  76859. * @param optimizer defines the current optimizer
  76860. * @returns true if everything that can be done was applied
  76861. */
  76862. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  76863. }
  76864. /**
  76865. * Defines an optimization used to turn render targets off
  76866. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  76867. */
  76868. export class RenderTargetsOptimization extends SceneOptimization {
  76869. /**
  76870. * Gets a string describing the action executed by the current optimization
  76871. * @return description string
  76872. */
  76873. getDescription(): string;
  76874. /**
  76875. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  76876. * @param scene defines the current scene where to apply this optimization
  76877. * @param optimizer defines the current optimizer
  76878. * @returns true if everything that can be done was applied
  76879. */
  76880. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  76881. }
  76882. /**
  76883. * Defines an optimization used to merge meshes with compatible materials
  76884. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  76885. */
  76886. export class MergeMeshesOptimization extends SceneOptimization {
  76887. private static _UpdateSelectionTree;
  76888. /**
  76889. * Gets or sets a boolean which defines if optimization octree has to be updated
  76890. */
  76891. static get UpdateSelectionTree(): boolean;
  76892. /**
  76893. * Gets or sets a boolean which defines if optimization octree has to be updated
  76894. */
  76895. static set UpdateSelectionTree(value: boolean);
  76896. /**
  76897. * Gets a string describing the action executed by the current optimization
  76898. * @return description string
  76899. */
  76900. getDescription(): string;
  76901. private _canBeMerged;
  76902. /**
  76903. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  76904. * @param scene defines the current scene where to apply this optimization
  76905. * @param optimizer defines the current optimizer
  76906. * @param updateSelectionTree defines that the selection octree has to be updated (false by default)
  76907. * @returns true if everything that can be done was applied
  76908. */
  76909. apply(scene: Scene, optimizer: SceneOptimizer, updateSelectionTree?: boolean): boolean;
  76910. }
  76911. /**
  76912. * Defines a list of options used by SceneOptimizer
  76913. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  76914. */
  76915. export class SceneOptimizerOptions {
  76916. /**
  76917. * Defines the target frame rate to reach (60 by default)
  76918. */
  76919. targetFrameRate: number;
  76920. /**
  76921. * Defines the interval between two checkes (2000ms by default)
  76922. */
  76923. trackerDuration: number;
  76924. /**
  76925. * Gets the list of optimizations to apply
  76926. */
  76927. optimizations: SceneOptimization[];
  76928. /**
  76929. * Creates a new list of options used by SceneOptimizer
  76930. * @param targetFrameRate defines the target frame rate to reach (60 by default)
  76931. * @param trackerDuration defines the interval between two checkes (2000ms by default)
  76932. */
  76933. constructor(
  76934. /**
  76935. * Defines the target frame rate to reach (60 by default)
  76936. */
  76937. targetFrameRate?: number,
  76938. /**
  76939. * Defines the interval between two checkes (2000ms by default)
  76940. */
  76941. trackerDuration?: number);
  76942. /**
  76943. * Add a new optimization
  76944. * @param optimization defines the SceneOptimization to add to the list of active optimizations
  76945. * @returns the current SceneOptimizerOptions
  76946. */
  76947. addOptimization(optimization: SceneOptimization): SceneOptimizerOptions;
  76948. /**
  76949. * Add a new custom optimization
  76950. * @param onApply defines the callback called to apply the custom optimization (true if everything that can be done was applied)
  76951. * @param onGetDescription defines the callback called to get the description attached with the optimization.
  76952. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  76953. * @returns the current SceneOptimizerOptions
  76954. */
  76955. addCustomOptimization(onApply: (scene: Scene) => boolean, onGetDescription: () => string, priority?: number): SceneOptimizerOptions;
  76956. /**
  76957. * Creates a list of pre-defined optimizations aimed to reduce the visual impact on the scene
  76958. * @param targetFrameRate defines the target frame rate (60 by default)
  76959. * @returns a SceneOptimizerOptions object
  76960. */
  76961. static LowDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  76962. /**
  76963. * Creates a list of pre-defined optimizations aimed to have a moderate impact on the scene visual
  76964. * @param targetFrameRate defines the target frame rate (60 by default)
  76965. * @returns a SceneOptimizerOptions object
  76966. */
  76967. static ModerateDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  76968. /**
  76969. * Creates a list of pre-defined optimizations aimed to have a big impact on the scene visual
  76970. * @param targetFrameRate defines the target frame rate (60 by default)
  76971. * @returns a SceneOptimizerOptions object
  76972. */
  76973. static HighDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  76974. }
  76975. /**
  76976. * Class used to run optimizations in order to reach a target frame rate
  76977. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  76978. */
  76979. export class SceneOptimizer implements IDisposable {
  76980. private _isRunning;
  76981. private _options;
  76982. private _scene;
  76983. private _currentPriorityLevel;
  76984. private _targetFrameRate;
  76985. private _trackerDuration;
  76986. private _currentFrameRate;
  76987. private _sceneDisposeObserver;
  76988. private _improvementMode;
  76989. /**
  76990. * Defines an observable called when the optimizer reaches the target frame rate
  76991. */
  76992. onSuccessObservable: Observable<SceneOptimizer>;
  76993. /**
  76994. * Defines an observable called when the optimizer enables an optimization
  76995. */
  76996. onNewOptimizationAppliedObservable: Observable<SceneOptimization>;
  76997. /**
  76998. * Defines an observable called when the optimizer is not able to reach the target frame rate
  76999. */
  77000. onFailureObservable: Observable<SceneOptimizer>;
  77001. /**
  77002. * Gets a boolean indicating if the optimizer is in improvement mode
  77003. */
  77004. get isInImprovementMode(): boolean;
  77005. /**
  77006. * Gets the current priority level (0 at start)
  77007. */
  77008. get currentPriorityLevel(): number;
  77009. /**
  77010. * Gets the current frame rate checked by the SceneOptimizer
  77011. */
  77012. get currentFrameRate(): number;
  77013. /**
  77014. * Gets or sets the current target frame rate (60 by default)
  77015. */
  77016. get targetFrameRate(): number;
  77017. /**
  77018. * Gets or sets the current target frame rate (60 by default)
  77019. */
  77020. set targetFrameRate(value: number);
  77021. /**
  77022. * Gets or sets the current interval between two checks (every 2000ms by default)
  77023. */
  77024. get trackerDuration(): number;
  77025. /**
  77026. * Gets or sets the current interval between two checks (every 2000ms by default)
  77027. */
  77028. set trackerDuration(value: number);
  77029. /**
  77030. * Gets the list of active optimizations
  77031. */
  77032. get optimizations(): SceneOptimization[];
  77033. /**
  77034. * Creates a new SceneOptimizer
  77035. * @param scene defines the scene to work on
  77036. * @param options defines the options to use with the SceneOptimizer
  77037. * @param autoGeneratePriorities defines if priorities must be generated and not read from SceneOptimization property (true by default)
  77038. * @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)
  77039. */
  77040. constructor(scene: Scene, options?: SceneOptimizerOptions, autoGeneratePriorities?: boolean, improvementMode?: boolean);
  77041. /**
  77042. * Stops the current optimizer
  77043. */
  77044. stop(): void;
  77045. /**
  77046. * Reset the optimizer to initial step (current priority level = 0)
  77047. */
  77048. reset(): void;
  77049. /**
  77050. * Start the optimizer. By default it will try to reach a specific framerate
  77051. * but if the optimizer is set with improvementMode === true then it will run all optimiatiation while frame rate is above the target frame rate
  77052. */
  77053. start(): void;
  77054. private _checkCurrentState;
  77055. /**
  77056. * Release all resources
  77057. */
  77058. dispose(): void;
  77059. /**
  77060. * Helper function to create a SceneOptimizer with one single line of code
  77061. * @param scene defines the scene to work on
  77062. * @param options defines the options to use with the SceneOptimizer
  77063. * @param onSuccess defines a callback to call on success
  77064. * @param onFailure defines a callback to call on failure
  77065. * @returns the new SceneOptimizer object
  77066. */
  77067. static OptimizeAsync(scene: Scene, options?: SceneOptimizerOptions, onSuccess?: () => void, onFailure?: () => void): SceneOptimizer;
  77068. }
  77069. }
  77070. declare module "babylonjs/Misc/sceneSerializer" {
  77071. import { Scene } from "babylonjs/scene";
  77072. /**
  77073. * Class used to serialize a scene into a string
  77074. */
  77075. export class SceneSerializer {
  77076. /**
  77077. * Clear cache used by a previous serialization
  77078. */
  77079. static ClearCache(): void;
  77080. /**
  77081. * Serialize a scene into a JSON compatible object
  77082. * @param scene defines the scene to serialize
  77083. * @returns a JSON compatible object
  77084. */
  77085. static Serialize(scene: Scene): any;
  77086. /**
  77087. * Serialize a mesh into a JSON compatible object
  77088. * @param toSerialize defines the mesh to serialize
  77089. * @param withParents defines if parents must be serialized as well
  77090. * @param withChildren defines if children must be serialized as well
  77091. * @returns a JSON compatible object
  77092. */
  77093. static SerializeMesh(toSerialize: any, withParents?: boolean, withChildren?: boolean): any;
  77094. }
  77095. }
  77096. declare module "babylonjs/Misc/textureTools" {
  77097. import { Texture } from "babylonjs/Materials/Textures/texture";
  77098. /**
  77099. * Class used to host texture specific utilities
  77100. */
  77101. export class TextureTools {
  77102. /**
  77103. * Uses the GPU to create a copy texture rescaled at a given size
  77104. * @param texture Texture to copy from
  77105. * @param width defines the desired width
  77106. * @param height defines the desired height
  77107. * @param useBilinearMode defines if bilinear mode has to be used
  77108. * @return the generated texture
  77109. */
  77110. static CreateResizedCopy(texture: Texture, width: number, height: number, useBilinearMode?: boolean): Texture;
  77111. }
  77112. }
  77113. declare module "babylonjs/Misc/videoRecorder" {
  77114. import { Nullable } from "babylonjs/types";
  77115. import { Engine } from "babylonjs/Engines/engine";
  77116. /**
  77117. * This represents the different options available for the video capture.
  77118. */
  77119. export interface VideoRecorderOptions {
  77120. /** Defines the mime type of the video. */
  77121. mimeType: string;
  77122. /** Defines the FPS the video should be recorded at. */
  77123. fps: number;
  77124. /** Defines the chunk size for the recording data. */
  77125. recordChunckSize: number;
  77126. /** The audio tracks to attach to the recording. */
  77127. audioTracks?: MediaStreamTrack[];
  77128. }
  77129. /**
  77130. * This can help with recording videos from BabylonJS.
  77131. * This is based on the available WebRTC functionalities of the browser.
  77132. *
  77133. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_video
  77134. */
  77135. export class VideoRecorder {
  77136. private static readonly _defaultOptions;
  77137. /**
  77138. * Returns whether or not the VideoRecorder is available in your browser.
  77139. * @param engine Defines the Babylon Engine.
  77140. * @returns true if supported otherwise false.
  77141. */
  77142. static IsSupported(engine: Engine): boolean;
  77143. private readonly _options;
  77144. private _canvas;
  77145. private _mediaRecorder;
  77146. private _recordedChunks;
  77147. private _fileName;
  77148. private _resolve;
  77149. private _reject;
  77150. /**
  77151. * True when a recording is already in progress.
  77152. */
  77153. get isRecording(): boolean;
  77154. /**
  77155. * Create a new VideoCapture object which can help converting what you see in Babylon to a video file.
  77156. * @param engine Defines the BabylonJS Engine you wish to record.
  77157. * @param options Defines options that can be used to customize the capture.
  77158. */
  77159. constructor(engine: Engine, options?: Nullable<VideoRecorderOptions>);
  77160. /**
  77161. * Stops the current recording before the default capture timeout passed in the startRecording function.
  77162. */
  77163. stopRecording(): void;
  77164. /**
  77165. * Starts recording the canvas for a max duration specified in parameters.
  77166. * @param fileName Defines the name of the file to be downloaded when the recording stop.
  77167. * If null no automatic download will start and you can rely on the promise to get the data back.
  77168. * @param maxDuration Defines the maximum recording time in seconds.
  77169. * It defaults to 7 seconds. A value of zero will not stop automatically, you would need to call stopRecording manually.
  77170. * @return A promise callback at the end of the recording with the video data in Blob.
  77171. */
  77172. startRecording(fileName?: Nullable<string>, maxDuration?: number): Promise<Blob>;
  77173. /**
  77174. * Releases internal resources used during the recording.
  77175. */
  77176. dispose(): void;
  77177. private _handleDataAvailable;
  77178. private _handleError;
  77179. private _handleStop;
  77180. }
  77181. }
  77182. declare module "babylonjs/Misc/screenshotTools" {
  77183. import { Camera } from "babylonjs/Cameras/camera";
  77184. import { IScreenshotSize } from "babylonjs/Misc/interfaces/screenshotSize";
  77185. import { Engine } from "babylonjs/Engines/engine";
  77186. /**
  77187. * Class containing a set of static utilities functions for screenshots
  77188. */
  77189. export class ScreenshotTools {
  77190. /**
  77191. * Captures a screenshot of the current rendering
  77192. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  77193. * @param engine defines the rendering engine
  77194. * @param camera defines the source camera
  77195. * @param size This parameter can be set to a single number or to an object with the
  77196. * following (optional) properties: precision, width, height. If a single number is passed,
  77197. * it will be used for both width and height. If an object is passed, the screenshot size
  77198. * will be derived from the parameters. The precision property is a multiplier allowing
  77199. * rendering at a higher or lower resolution
  77200. * @param successCallback defines the callback receives a single parameter which contains the
  77201. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  77202. * src parameter of an <img> to display it
  77203. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  77204. * Check your browser for supported MIME types
  77205. */
  77206. static CreateScreenshot(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string): void;
  77207. /**
  77208. * Captures a screenshot of the current rendering
  77209. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  77210. * @param engine defines the rendering engine
  77211. * @param camera defines the source camera
  77212. * @param size This parameter can be set to a single number or to an object with the
  77213. * following (optional) properties: precision, width, height. If a single number is passed,
  77214. * it will be used for both width and height. If an object is passed, the screenshot size
  77215. * will be derived from the parameters. The precision property is a multiplier allowing
  77216. * rendering at a higher or lower resolution
  77217. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  77218. * Check your browser for supported MIME types
  77219. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  77220. * to the src parameter of an <img> to display it
  77221. */
  77222. static CreateScreenshotAsync(engine: Engine, camera: Camera, size: any, mimeType?: string): Promise<string>;
  77223. /**
  77224. * Generates an image screenshot from the specified camera.
  77225. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  77226. * @param engine The engine to use for rendering
  77227. * @param camera The camera to use for rendering
  77228. * @param size This parameter can be set to a single number or to an object with the
  77229. * following (optional) properties: precision, width, height. If a single number is passed,
  77230. * it will be used for both width and height. If an object is passed, the screenshot size
  77231. * will be derived from the parameters. The precision property is a multiplier allowing
  77232. * rendering at a higher or lower resolution
  77233. * @param successCallback The callback receives a single parameter which contains the
  77234. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  77235. * src parameter of an <img> to display it
  77236. * @param mimeType The MIME type of the screenshot image (default: image/png).
  77237. * Check your browser for supported MIME types
  77238. * @param samples Texture samples (default: 1)
  77239. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  77240. * @param fileName A name for for the downloaded file.
  77241. * @param renderSprites Whether the sprites should be rendered or not (default: false)
  77242. */
  77243. static CreateScreenshotUsingRenderTarget(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string, renderSprites?: boolean): void;
  77244. /**
  77245. * Generates an image screenshot from the specified camera.
  77246. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  77247. * @param engine The engine to use for rendering
  77248. * @param camera The camera to use for rendering
  77249. * @param size This parameter can be set to a single number or to an object with the
  77250. * following (optional) properties: precision, width, height. If a single number is passed,
  77251. * it will be used for both width and height. If an object is passed, the screenshot size
  77252. * will be derived from the parameters. The precision property is a multiplier allowing
  77253. * rendering at a higher or lower resolution
  77254. * @param mimeType The MIME type of the screenshot image (default: image/png).
  77255. * Check your browser for supported MIME types
  77256. * @param samples Texture samples (default: 1)
  77257. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  77258. * @param fileName A name for for the downloaded file.
  77259. * @param renderSprites Whether the sprites should be rendered or not (default: false)
  77260. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  77261. * to the src parameter of an <img> to display it
  77262. */
  77263. static CreateScreenshotUsingRenderTargetAsync(engine: Engine, camera: Camera, size: any, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string, renderSprites?: boolean): Promise<string>;
  77264. /**
  77265. * Gets height and width for screenshot size
  77266. * @private
  77267. */
  77268. private static _getScreenshotSize;
  77269. }
  77270. }
  77271. declare module "babylonjs/Misc/dataReader" {
  77272. /**
  77273. * Interface for a data buffer
  77274. */
  77275. export interface IDataBuffer {
  77276. /**
  77277. * Reads bytes from the data buffer.
  77278. * @param byteOffset The byte offset to read
  77279. * @param byteLength The byte length to read
  77280. * @returns A promise that resolves when the bytes are read
  77281. */
  77282. readAsync(byteOffset: number, byteLength: number): Promise<ArrayBufferView>;
  77283. /**
  77284. * The byte length of the buffer.
  77285. */
  77286. readonly byteLength: number;
  77287. }
  77288. /**
  77289. * Utility class for reading from a data buffer
  77290. */
  77291. export class DataReader {
  77292. /**
  77293. * The data buffer associated with this data reader.
  77294. */
  77295. readonly buffer: IDataBuffer;
  77296. /**
  77297. * The current byte offset from the beginning of the data buffer.
  77298. */
  77299. byteOffset: number;
  77300. private _dataView;
  77301. private _dataByteOffset;
  77302. /**
  77303. * Constructor
  77304. * @param buffer The buffer to read
  77305. */
  77306. constructor(buffer: IDataBuffer);
  77307. /**
  77308. * Loads the given byte length.
  77309. * @param byteLength The byte length to load
  77310. * @returns A promise that resolves when the load is complete
  77311. */
  77312. loadAsync(byteLength: number): Promise<void>;
  77313. /**
  77314. * Read a unsigned 32-bit integer from the currently loaded data range.
  77315. * @returns The 32-bit integer read
  77316. */
  77317. readUint32(): number;
  77318. /**
  77319. * Read a byte array from the currently loaded data range.
  77320. * @param byteLength The byte length to read
  77321. * @returns The byte array read
  77322. */
  77323. readUint8Array(byteLength: number): Uint8Array;
  77324. /**
  77325. * Read a string from the currently loaded data range.
  77326. * @param byteLength The byte length to read
  77327. * @returns The string read
  77328. */
  77329. readString(byteLength: number): string;
  77330. /**
  77331. * Skips the given byte length the currently loaded data range.
  77332. * @param byteLength The byte length to skip
  77333. */
  77334. skipBytes(byteLength: number): void;
  77335. }
  77336. }
  77337. declare module "babylonjs/Misc/dataStorage" {
  77338. /**
  77339. * Class for storing data to local storage if available or in-memory storage otherwise
  77340. */
  77341. export class DataStorage {
  77342. private static _Storage;
  77343. private static _GetStorage;
  77344. /**
  77345. * Reads a string from the data storage
  77346. * @param key The key to read
  77347. * @param defaultValue The value if the key doesn't exist
  77348. * @returns The string value
  77349. */
  77350. static ReadString(key: string, defaultValue: string): string;
  77351. /**
  77352. * Writes a string to the data storage
  77353. * @param key The key to write
  77354. * @param value The value to write
  77355. */
  77356. static WriteString(key: string, value: string): void;
  77357. /**
  77358. * Reads a boolean from the data storage
  77359. * @param key The key to read
  77360. * @param defaultValue The value if the key doesn't exist
  77361. * @returns The boolean value
  77362. */
  77363. static ReadBoolean(key: string, defaultValue: boolean): boolean;
  77364. /**
  77365. * Writes a boolean to the data storage
  77366. * @param key The key to write
  77367. * @param value The value to write
  77368. */
  77369. static WriteBoolean(key: string, value: boolean): void;
  77370. /**
  77371. * Reads a number from the data storage
  77372. * @param key The key to read
  77373. * @param defaultValue The value if the key doesn't exist
  77374. * @returns The number value
  77375. */
  77376. static ReadNumber(key: string, defaultValue: number): number;
  77377. /**
  77378. * Writes a number to the data storage
  77379. * @param key The key to write
  77380. * @param value The value to write
  77381. */
  77382. static WriteNumber(key: string, value: number): void;
  77383. }
  77384. }
  77385. declare module "babylonjs/Misc/index" {
  77386. export * from "babylonjs/Misc/andOrNotEvaluator";
  77387. export * from "babylonjs/Misc/assetsManager";
  77388. export * from "babylonjs/Misc/basis";
  77389. export * from "babylonjs/Misc/dds";
  77390. export * from "babylonjs/Misc/decorators";
  77391. export * from "babylonjs/Misc/deferred";
  77392. export * from "babylonjs/Misc/environmentTextureTools";
  77393. export * from "babylonjs/Misc/meshExploder";
  77394. export * from "babylonjs/Misc/filesInput";
  77395. export * from "babylonjs/Misc/HighDynamicRange/index";
  77396. export * from "babylonjs/Misc/khronosTextureContainer";
  77397. export * from "babylonjs/Misc/observable";
  77398. export * from "babylonjs/Misc/performanceMonitor";
  77399. export * from "babylonjs/Misc/promise";
  77400. export * from "babylonjs/Misc/sceneOptimizer";
  77401. export * from "babylonjs/Misc/sceneSerializer";
  77402. export * from "babylonjs/Misc/smartArray";
  77403. export * from "babylonjs/Misc/stringDictionary";
  77404. export * from "babylonjs/Misc/tags";
  77405. export * from "babylonjs/Misc/textureTools";
  77406. export * from "babylonjs/Misc/tga";
  77407. export * from "babylonjs/Misc/tools";
  77408. export * from "babylonjs/Misc/videoRecorder";
  77409. export * from "babylonjs/Misc/virtualJoystick";
  77410. export * from "babylonjs/Misc/workerPool";
  77411. export * from "babylonjs/Misc/logger";
  77412. export * from "babylonjs/Misc/typeStore";
  77413. export * from "babylonjs/Misc/filesInputStore";
  77414. export * from "babylonjs/Misc/deepCopier";
  77415. export * from "babylonjs/Misc/pivotTools";
  77416. export * from "babylonjs/Misc/precisionDate";
  77417. export * from "babylonjs/Misc/screenshotTools";
  77418. export * from "babylonjs/Misc/typeStore";
  77419. export * from "babylonjs/Misc/webRequest";
  77420. export * from "babylonjs/Misc/iInspectable";
  77421. export * from "babylonjs/Misc/brdfTextureTools";
  77422. export * from "babylonjs/Misc/rgbdTextureTools";
  77423. export * from "babylonjs/Misc/gradients";
  77424. export * from "babylonjs/Misc/perfCounter";
  77425. export * from "babylonjs/Misc/fileRequest";
  77426. export * from "babylonjs/Misc/customAnimationFrameRequester";
  77427. export * from "babylonjs/Misc/retryStrategy";
  77428. export * from "babylonjs/Misc/interfaces/screenshotSize";
  77429. export * from "babylonjs/Misc/canvasGenerator";
  77430. export * from "babylonjs/Misc/fileTools";
  77431. export * from "babylonjs/Misc/stringTools";
  77432. export * from "babylonjs/Misc/dataReader";
  77433. export * from "babylonjs/Misc/minMaxReducer";
  77434. export * from "babylonjs/Misc/depthReducer";
  77435. export * from "babylonjs/Misc/dataStorage";
  77436. }
  77437. declare module "babylonjs/XR/features/WebXRHitTestLegacy" {
  77438. import { IWebXRFeature } from "babylonjs/XR/webXRFeaturesManager";
  77439. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  77440. import { Observable } from "babylonjs/Misc/observable";
  77441. import { Matrix } from "babylonjs/Maths/math.vector";
  77442. import { TransformNode } from "babylonjs/Meshes/transformNode";
  77443. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  77444. /**
  77445. * An interface for all Hit test features
  77446. */
  77447. export interface IWebXRHitTestFeature<T extends IWebXRLegacyHitResult> extends IWebXRFeature {
  77448. /**
  77449. * Triggered when new babylon (transformed) hit test results are available
  77450. */
  77451. onHitTestResultObservable: Observable<T[]>;
  77452. }
  77453. /**
  77454. * Options used for hit testing
  77455. */
  77456. export interface IWebXRLegacyHitTestOptions {
  77457. /**
  77458. * Only test when user interacted with the scene. Default - hit test every frame
  77459. */
  77460. testOnPointerDownOnly?: boolean;
  77461. /**
  77462. * The node to use to transform the local results to world coordinates
  77463. */
  77464. worldParentNode?: TransformNode;
  77465. }
  77466. /**
  77467. * Interface defining the babylon result of raycasting/hit-test
  77468. */
  77469. export interface IWebXRLegacyHitResult {
  77470. /**
  77471. * Transformation matrix that can be applied to a node that will put it in the hit point location
  77472. */
  77473. transformationMatrix: Matrix;
  77474. /**
  77475. * The native hit test result
  77476. */
  77477. xrHitResult: XRHitResult | XRHitTestResult;
  77478. }
  77479. /**
  77480. * The currently-working hit-test module.
  77481. * Hit test (or Ray-casting) is used to interact with the real world.
  77482. * For further information read here - https://github.com/immersive-web/hit-test
  77483. */
  77484. export class WebXRHitTestLegacy extends WebXRAbstractFeature implements IWebXRHitTestFeature<IWebXRLegacyHitResult> {
  77485. /**
  77486. * options to use when constructing this feature
  77487. */
  77488. readonly options: IWebXRLegacyHitTestOptions;
  77489. private _direction;
  77490. private _mat;
  77491. private _onSelectEnabled;
  77492. private _origin;
  77493. /**
  77494. * The module's name
  77495. */
  77496. static readonly Name: string;
  77497. /**
  77498. * The (Babylon) version of this module.
  77499. * This is an integer representing the implementation version.
  77500. * This number does not correspond to the WebXR specs version
  77501. */
  77502. static readonly Version: number;
  77503. /**
  77504. * Populated with the last native XR Hit Results
  77505. */
  77506. lastNativeXRHitResults: XRHitResult[];
  77507. /**
  77508. * Triggered when new babylon (transformed) hit test results are available
  77509. */
  77510. onHitTestResultObservable: Observable<IWebXRLegacyHitResult[]>;
  77511. /**
  77512. * Creates a new instance of the (legacy version) hit test feature
  77513. * @param _xrSessionManager an instance of WebXRSessionManager
  77514. * @param options options to use when constructing this feature
  77515. */
  77516. constructor(_xrSessionManager: WebXRSessionManager,
  77517. /**
  77518. * options to use when constructing this feature
  77519. */
  77520. options?: IWebXRLegacyHitTestOptions);
  77521. /**
  77522. * execute a hit test with an XR Ray
  77523. *
  77524. * @param xrSession a native xrSession that will execute this hit test
  77525. * @param xrRay the ray (position and direction) to use for ray-casting
  77526. * @param referenceSpace native XR reference space to use for the hit-test
  77527. * @param filter filter function that will filter the results
  77528. * @returns a promise that resolves with an array of native XR hit result in xr coordinates system
  77529. */
  77530. static XRHitTestWithRay(xrSession: XRSession, xrRay: XRRay, referenceSpace: XRReferenceSpace, filter?: (result: XRHitResult) => boolean): Promise<XRHitResult[]>;
  77531. /**
  77532. * Execute a hit test on the current running session using a select event returned from a transient input (such as touch)
  77533. * @param event the (select) event to use to select with
  77534. * @param referenceSpace the reference space to use for this hit test
  77535. * @returns a promise that resolves with an array of native XR hit result in xr coordinates system
  77536. */
  77537. static XRHitTestWithSelectEvent(event: XRInputSourceEvent, referenceSpace: XRReferenceSpace): Promise<XRHitResult[]>;
  77538. /**
  77539. * attach this feature
  77540. * Will usually be called by the features manager
  77541. *
  77542. * @returns true if successful.
  77543. */
  77544. attach(): boolean;
  77545. /**
  77546. * detach this feature.
  77547. * Will usually be called by the features manager
  77548. *
  77549. * @returns true if successful.
  77550. */
  77551. detach(): boolean;
  77552. /**
  77553. * Dispose this feature and all of the resources attached
  77554. */
  77555. dispose(): void;
  77556. protected _onXRFrame(frame: XRFrame): void;
  77557. private _onHitTestResults;
  77558. private _onSelect;
  77559. }
  77560. }
  77561. declare module "babylonjs/XR/features/WebXRHitTest" {
  77562. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  77563. import { Observable } from "babylonjs/Misc/observable";
  77564. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  77565. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  77566. import { IWebXRLegacyHitTestOptions, IWebXRLegacyHitResult, IWebXRHitTestFeature } from "babylonjs/XR/features/WebXRHitTestLegacy";
  77567. /**
  77568. * Options used for hit testing (version 2)
  77569. */
  77570. export interface IWebXRHitTestOptions extends IWebXRLegacyHitTestOptions {
  77571. /**
  77572. * Do not create a permanent hit test. Will usually be used when only
  77573. * transient inputs are needed.
  77574. */
  77575. disablePermanentHitTest?: boolean;
  77576. /**
  77577. * Enable transient (for example touch-based) hit test inspections
  77578. */
  77579. enableTransientHitTest?: boolean;
  77580. /**
  77581. * Offset ray for the permanent hit test
  77582. */
  77583. offsetRay?: Vector3;
  77584. /**
  77585. * Offset ray for the transient hit test
  77586. */
  77587. transientOffsetRay?: Vector3;
  77588. /**
  77589. * Instead of using viewer space for hit tests, use the reference space defined in the session manager
  77590. */
  77591. useReferenceSpace?: boolean;
  77592. }
  77593. /**
  77594. * Interface defining the babylon result of hit-test
  77595. */
  77596. export interface IWebXRHitResult extends IWebXRLegacyHitResult {
  77597. /**
  77598. * The input source that generated this hit test (if transient)
  77599. */
  77600. inputSource?: XRInputSource;
  77601. /**
  77602. * Is this a transient hit test
  77603. */
  77604. isTransient?: boolean;
  77605. /**
  77606. * Position of the hit test result
  77607. */
  77608. position: Vector3;
  77609. /**
  77610. * Rotation of the hit test result
  77611. */
  77612. rotationQuaternion: Quaternion;
  77613. /**
  77614. * The native hit test result
  77615. */
  77616. xrHitResult: XRHitTestResult;
  77617. }
  77618. /**
  77619. * The currently-working hit-test module.
  77620. * Hit test (or Ray-casting) is used to interact with the real world.
  77621. * For further information read here - https://github.com/immersive-web/hit-test
  77622. *
  77623. * Tested on chrome (mobile) 80.
  77624. */
  77625. export class WebXRHitTest extends WebXRAbstractFeature implements IWebXRHitTestFeature<IWebXRHitResult> {
  77626. /**
  77627. * options to use when constructing this feature
  77628. */
  77629. readonly options: IWebXRHitTestOptions;
  77630. private _tmpMat;
  77631. private _tmpPos;
  77632. private _tmpQuat;
  77633. private _transientXrHitTestSource;
  77634. private _xrHitTestSource;
  77635. private initHitTestSource;
  77636. /**
  77637. * The module's name
  77638. */
  77639. static readonly Name: string;
  77640. /**
  77641. * The (Babylon) version of this module.
  77642. * This is an integer representing the implementation version.
  77643. * This number does not correspond to the WebXR specs version
  77644. */
  77645. static readonly Version: number;
  77646. /**
  77647. * When set to true, each hit test will have its own position/rotation objects
  77648. * When set to false, position and rotation objects will be reused for each hit test. It is expected that
  77649. * the developers will clone them or copy them as they see fit.
  77650. */
  77651. autoCloneTransformation: boolean;
  77652. /**
  77653. * Triggered when new babylon (transformed) hit test results are available
  77654. */
  77655. onHitTestResultObservable: Observable<IWebXRHitResult[]>;
  77656. /**
  77657. * Use this to temporarily pause hit test checks.
  77658. */
  77659. paused: boolean;
  77660. /**
  77661. * Creates a new instance of the hit test feature
  77662. * @param _xrSessionManager an instance of WebXRSessionManager
  77663. * @param options options to use when constructing this feature
  77664. */
  77665. constructor(_xrSessionManager: WebXRSessionManager,
  77666. /**
  77667. * options to use when constructing this feature
  77668. */
  77669. options?: IWebXRHitTestOptions);
  77670. /**
  77671. * attach this feature
  77672. * Will usually be called by the features manager
  77673. *
  77674. * @returns true if successful.
  77675. */
  77676. attach(): boolean;
  77677. /**
  77678. * detach this feature.
  77679. * Will usually be called by the features manager
  77680. *
  77681. * @returns true if successful.
  77682. */
  77683. detach(): boolean;
  77684. /**
  77685. * Dispose this feature and all of the resources attached
  77686. */
  77687. dispose(): void;
  77688. protected _onXRFrame(frame: XRFrame): void;
  77689. private _processWebXRHitTestResult;
  77690. }
  77691. }
  77692. declare module "babylonjs/XR/features/WebXRAnchorSystem" {
  77693. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  77694. import { Observable } from "babylonjs/Misc/observable";
  77695. import { Matrix, Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  77696. import { TransformNode } from "babylonjs/Meshes/transformNode";
  77697. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  77698. import { IWebXRHitResult } from "babylonjs/XR/features/WebXRHitTest";
  77699. /**
  77700. * Configuration options of the anchor system
  77701. */
  77702. export interface IWebXRAnchorSystemOptions {
  77703. /**
  77704. * a node that will be used to convert local to world coordinates
  77705. */
  77706. worldParentNode?: TransformNode;
  77707. /**
  77708. * If set to true a reference of the created anchors will be kept until the next session starts
  77709. * If not defined, anchors will be removed from the array when the feature is detached or the session ended.
  77710. */
  77711. doNotRemoveAnchorsOnSessionEnded?: boolean;
  77712. }
  77713. /**
  77714. * A babylon container for an XR Anchor
  77715. */
  77716. export interface IWebXRAnchor {
  77717. /**
  77718. * A babylon-assigned ID for this anchor
  77719. */
  77720. id: number;
  77721. /**
  77722. * Transformation matrix to apply to an object attached to this anchor
  77723. */
  77724. transformationMatrix: Matrix;
  77725. /**
  77726. * The native anchor object
  77727. */
  77728. xrAnchor: XRAnchor;
  77729. /**
  77730. * if defined, this object will be constantly updated by the anchor's position and rotation
  77731. */
  77732. attachedNode?: TransformNode;
  77733. }
  77734. /**
  77735. * An implementation of the anchor system for WebXR.
  77736. * For further information see https://github.com/immersive-web/anchors/
  77737. */
  77738. export class WebXRAnchorSystem extends WebXRAbstractFeature {
  77739. private _options;
  77740. private _lastFrameDetected;
  77741. private _trackedAnchors;
  77742. private _referenceSpaceForFrameAnchors;
  77743. private _futureAnchors;
  77744. /**
  77745. * The module's name
  77746. */
  77747. static readonly Name: string;
  77748. /**
  77749. * The (Babylon) version of this module.
  77750. * This is an integer representing the implementation version.
  77751. * This number does not correspond to the WebXR specs version
  77752. */
  77753. static readonly Version: number;
  77754. /**
  77755. * Observers registered here will be executed when a new anchor was added to the session
  77756. */
  77757. onAnchorAddedObservable: Observable<IWebXRAnchor>;
  77758. /**
  77759. * Observers registered here will be executed when an anchor was removed from the session
  77760. */
  77761. onAnchorRemovedObservable: Observable<IWebXRAnchor>;
  77762. /**
  77763. * Observers registered here will be executed when an existing anchor updates
  77764. * This can execute N times every frame
  77765. */
  77766. onAnchorUpdatedObservable: Observable<IWebXRAnchor>;
  77767. /**
  77768. * Set the reference space to use for anchor creation, when not using a hit test.
  77769. * Will default to the session's reference space if not defined
  77770. */
  77771. set referenceSpaceForFrameAnchors(referenceSpace: XRReferenceSpace);
  77772. /**
  77773. * constructs a new anchor system
  77774. * @param _xrSessionManager an instance of WebXRSessionManager
  77775. * @param _options configuration object for this feature
  77776. */
  77777. constructor(_xrSessionManager: WebXRSessionManager, _options?: IWebXRAnchorSystemOptions);
  77778. private _tmpVector;
  77779. private _tmpQuaternion;
  77780. private _populateTmpTransformation;
  77781. /**
  77782. * Create a new anchor point using a hit test result at a specific point in the scene
  77783. * An anchor is tracked only after it is added to the trackerAnchors in xrFrame. The promise returned here does not yet guaranty that.
  77784. * Use onAnchorAddedObservable to get newly added anchors if you require tracking guaranty.
  77785. *
  77786. * @param hitTestResult The hit test result to use for this anchor creation
  77787. * @param position an optional position offset for this anchor
  77788. * @param rotationQuaternion an optional rotation offset for this anchor
  77789. * @returns A promise that fulfills when the XR anchor was registered in the system (but not necessarily added to the tracked anchors)
  77790. */
  77791. addAnchorPointUsingHitTestResultAsync(hitTestResult: IWebXRHitResult, position?: Vector3, rotationQuaternion?: Quaternion): Promise<XRAnchor>;
  77792. /**
  77793. * Add a new anchor at a specific position and rotation
  77794. * This function will add a new anchor per default in the next available frame. Unless forced, the createAnchor function
  77795. * will be called in the next xrFrame loop to make sure that the anchor can be created correctly.
  77796. * An anchor is tracked only after it is added to the trackerAnchors in xrFrame. The promise returned here does not yet guaranty that.
  77797. * Use onAnchorAddedObservable to get newly added anchors if you require tracking guaranty.
  77798. *
  77799. * @param position the position in which to add an anchor
  77800. * @param rotationQuaternion an optional rotation for the anchor transformation
  77801. * @param forceCreateInCurrentFrame force the creation of this anchor in the current frame. Must be called inside xrFrame loop!
  77802. * @returns A promise that fulfills when the XR anchor was registered in the system (but not necessarily added to the tracked anchors)
  77803. */
  77804. addAnchorAtPositionAndRotationAsync(position: Vector3, rotationQuaternion?: Quaternion, forceCreateInCurrentFrame?: boolean): Promise<XRAnchor>;
  77805. /**
  77806. * detach this feature.
  77807. * Will usually be called by the features manager
  77808. *
  77809. * @returns true if successful.
  77810. */
  77811. detach(): boolean;
  77812. /**
  77813. * Dispose this feature and all of the resources attached
  77814. */
  77815. dispose(): void;
  77816. protected _onXRFrame(frame: XRFrame): void;
  77817. /**
  77818. * avoiding using Array.find for global support.
  77819. * @param xrAnchor the plane to find in the array
  77820. */
  77821. private _findIndexInAnchorArray;
  77822. private _updateAnchorWithXRFrame;
  77823. private _createAnchorAtTransformation;
  77824. }
  77825. }
  77826. declare module "babylonjs/XR/features/WebXRPlaneDetector" {
  77827. import { TransformNode } from "babylonjs/Meshes/transformNode";
  77828. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  77829. import { Observable } from "babylonjs/Misc/observable";
  77830. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  77831. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  77832. /**
  77833. * Options used in the plane detector module
  77834. */
  77835. export interface IWebXRPlaneDetectorOptions {
  77836. /**
  77837. * The node to use to transform the local results to world coordinates
  77838. */
  77839. worldParentNode?: TransformNode;
  77840. /**
  77841. * If set to true a reference of the created planes will be kept until the next session starts
  77842. * If not defined, planes will be removed from the array when the feature is detached or the session ended.
  77843. */
  77844. doNotRemovePlanesOnSessionEnded?: boolean;
  77845. }
  77846. /**
  77847. * A babylon interface for a WebXR plane.
  77848. * A Plane is actually a polygon, built from N points in space
  77849. *
  77850. * Supported in chrome 79, not supported in canary 81 ATM
  77851. */
  77852. export interface IWebXRPlane {
  77853. /**
  77854. * a babylon-assigned ID for this polygon
  77855. */
  77856. id: number;
  77857. /**
  77858. * an array of vector3 points in babylon space. right/left hand system is taken into account.
  77859. */
  77860. polygonDefinition: Array<Vector3>;
  77861. /**
  77862. * A transformation matrix to apply on the mesh that will be built using the polygonDefinition
  77863. * Local vs. World are decided if worldParentNode was provided or not in the options when constructing the module
  77864. */
  77865. transformationMatrix: Matrix;
  77866. /**
  77867. * the native xr-plane object
  77868. */
  77869. xrPlane: XRPlane;
  77870. }
  77871. /**
  77872. * The plane detector is used to detect planes in the real world when in AR
  77873. * For more information see https://github.com/immersive-web/real-world-geometry/
  77874. */
  77875. export class WebXRPlaneDetector extends WebXRAbstractFeature {
  77876. private _options;
  77877. private _detectedPlanes;
  77878. private _enabled;
  77879. private _lastFrameDetected;
  77880. /**
  77881. * The module's name
  77882. */
  77883. static readonly Name: string;
  77884. /**
  77885. * The (Babylon) version of this module.
  77886. * This is an integer representing the implementation version.
  77887. * This number does not correspond to the WebXR specs version
  77888. */
  77889. static readonly Version: number;
  77890. /**
  77891. * Observers registered here will be executed when a new plane was added to the session
  77892. */
  77893. onPlaneAddedObservable: Observable<IWebXRPlane>;
  77894. /**
  77895. * Observers registered here will be executed when a plane is no longer detected in the session
  77896. */
  77897. onPlaneRemovedObservable: Observable<IWebXRPlane>;
  77898. /**
  77899. * Observers registered here will be executed when an existing plane updates (for example - expanded)
  77900. * This can execute N times every frame
  77901. */
  77902. onPlaneUpdatedObservable: Observable<IWebXRPlane>;
  77903. /**
  77904. * construct a new Plane Detector
  77905. * @param _xrSessionManager an instance of xr Session manager
  77906. * @param _options configuration to use when constructing this feature
  77907. */
  77908. constructor(_xrSessionManager: WebXRSessionManager, _options?: IWebXRPlaneDetectorOptions);
  77909. /**
  77910. * detach this feature.
  77911. * Will usually be called by the features manager
  77912. *
  77913. * @returns true if successful.
  77914. */
  77915. detach(): boolean;
  77916. /**
  77917. * Dispose this feature and all of the resources attached
  77918. */
  77919. dispose(): void;
  77920. protected _onXRFrame(frame: XRFrame): void;
  77921. private _init;
  77922. private _updatePlaneWithXRPlane;
  77923. /**
  77924. * avoiding using Array.find for global support.
  77925. * @param xrPlane the plane to find in the array
  77926. */
  77927. private findIndexInPlaneArray;
  77928. }
  77929. }
  77930. declare module "babylonjs/XR/features/WebXRBackgroundRemover" {
  77931. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  77932. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  77933. import { Observable } from "babylonjs/Misc/observable";
  77934. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  77935. /**
  77936. * Options interface for the background remover plugin
  77937. */
  77938. export interface IWebXRBackgroundRemoverOptions {
  77939. /**
  77940. * Further background meshes to disable when entering AR
  77941. */
  77942. backgroundMeshes?: AbstractMesh[];
  77943. /**
  77944. * flags to configure the removal of the environment helper.
  77945. * If not set, the entire background will be removed. If set, flags should be set as well.
  77946. */
  77947. environmentHelperRemovalFlags?: {
  77948. /**
  77949. * Should the skybox be removed (default false)
  77950. */
  77951. skyBox?: boolean;
  77952. /**
  77953. * Should the ground be removed (default false)
  77954. */
  77955. ground?: boolean;
  77956. };
  77957. /**
  77958. * don't disable the environment helper
  77959. */
  77960. ignoreEnvironmentHelper?: boolean;
  77961. }
  77962. /**
  77963. * A module that will automatically disable background meshes when entering AR and will enable them when leaving AR.
  77964. */
  77965. export class WebXRBackgroundRemover extends WebXRAbstractFeature {
  77966. /**
  77967. * read-only options to be used in this module
  77968. */
  77969. readonly options: IWebXRBackgroundRemoverOptions;
  77970. /**
  77971. * The module's name
  77972. */
  77973. static readonly Name: string;
  77974. /**
  77975. * The (Babylon) version of this module.
  77976. * This is an integer representing the implementation version.
  77977. * This number does not correspond to the WebXR specs version
  77978. */
  77979. static readonly Version: number;
  77980. /**
  77981. * registered observers will be triggered when the background state changes
  77982. */
  77983. onBackgroundStateChangedObservable: Observable<boolean>;
  77984. /**
  77985. * constructs a new background remover module
  77986. * @param _xrSessionManager the session manager for this module
  77987. * @param options read-only options to be used in this module
  77988. */
  77989. constructor(_xrSessionManager: WebXRSessionManager,
  77990. /**
  77991. * read-only options to be used in this module
  77992. */
  77993. options?: IWebXRBackgroundRemoverOptions);
  77994. /**
  77995. * attach this feature
  77996. * Will usually be called by the features manager
  77997. *
  77998. * @returns true if successful.
  77999. */
  78000. attach(): boolean;
  78001. /**
  78002. * detach this feature.
  78003. * Will usually be called by the features manager
  78004. *
  78005. * @returns true if successful.
  78006. */
  78007. detach(): boolean;
  78008. /**
  78009. * Dispose this feature and all of the resources attached
  78010. */
  78011. dispose(): void;
  78012. protected _onXRFrame(_xrFrame: XRFrame): void;
  78013. private _setBackgroundState;
  78014. }
  78015. }
  78016. declare module "babylonjs/XR/features/WebXRControllerPhysics" {
  78017. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  78018. import { WebXRInputSource } from "babylonjs/XR/webXRInputSource";
  78019. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  78020. import { WebXRInput } from "babylonjs/XR/webXRInput";
  78021. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  78022. import { Nullable } from "babylonjs/types";
  78023. /**
  78024. * Options for the controller physics feature
  78025. */
  78026. export class IWebXRControllerPhysicsOptions {
  78027. /**
  78028. * Should the headset get its own impostor
  78029. */
  78030. enableHeadsetImpostor?: boolean;
  78031. /**
  78032. * Optional parameters for the headset impostor
  78033. */
  78034. headsetImpostorParams?: {
  78035. /**
  78036. * The type of impostor to create. Default is sphere
  78037. */
  78038. impostorType: number;
  78039. /**
  78040. * the size of the impostor. Defaults to 10cm
  78041. */
  78042. impostorSize?: number | {
  78043. width: number;
  78044. height: number;
  78045. depth: number;
  78046. };
  78047. /**
  78048. * Friction definitions
  78049. */
  78050. friction?: number;
  78051. /**
  78052. * Restitution
  78053. */
  78054. restitution?: number;
  78055. };
  78056. /**
  78057. * The physics properties of the future impostors
  78058. */
  78059. physicsProperties?: {
  78060. /**
  78061. * If set to true, a mesh impostor will be created when the controller mesh was loaded
  78062. * Note that this requires a physics engine that supports mesh impostors!
  78063. */
  78064. useControllerMesh?: boolean;
  78065. /**
  78066. * The type of impostor to create. Default is sphere
  78067. */
  78068. impostorType?: number;
  78069. /**
  78070. * the size of the impostor. Defaults to 10cm
  78071. */
  78072. impostorSize?: number | {
  78073. width: number;
  78074. height: number;
  78075. depth: number;
  78076. };
  78077. /**
  78078. * Friction definitions
  78079. */
  78080. friction?: number;
  78081. /**
  78082. * Restitution
  78083. */
  78084. restitution?: number;
  78085. };
  78086. /**
  78087. * the xr input to use with this pointer selection
  78088. */
  78089. xrInput: WebXRInput;
  78090. }
  78091. /**
  78092. * Add physics impostor to your webxr controllers,
  78093. * including naive calculation of their linear and angular velocity
  78094. */
  78095. export class WebXRControllerPhysics extends WebXRAbstractFeature {
  78096. private readonly _options;
  78097. private _attachController;
  78098. private _controllers;
  78099. private _debugMode;
  78100. private _delta;
  78101. private _headsetImpostor?;
  78102. private _headsetMesh?;
  78103. private _lastTimestamp;
  78104. private _tmpQuaternion;
  78105. private _tmpVector;
  78106. /**
  78107. * The module's name
  78108. */
  78109. static readonly Name: string;
  78110. /**
  78111. * The (Babylon) version of this module.
  78112. * This is an integer representing the implementation version.
  78113. * This number does not correspond to the webxr specs version
  78114. */
  78115. static readonly Version: number;
  78116. /**
  78117. * Construct a new Controller Physics Feature
  78118. * @param _xrSessionManager the corresponding xr session manager
  78119. * @param _options options to create this feature with
  78120. */
  78121. constructor(_xrSessionManager: WebXRSessionManager, _options: IWebXRControllerPhysicsOptions);
  78122. /**
  78123. * @hidden
  78124. * enable debugging - will show console outputs and the impostor mesh
  78125. */
  78126. _enablePhysicsDebug(): void;
  78127. /**
  78128. * Manually add a controller (if no xrInput was provided or physics engine was not enabled)
  78129. * @param xrController the controller to add
  78130. */
  78131. addController(xrController: WebXRInputSource): void;
  78132. /**
  78133. * attach this feature
  78134. * Will usually be called by the features manager
  78135. *
  78136. * @returns true if successful.
  78137. */
  78138. attach(): boolean;
  78139. /**
  78140. * detach this feature.
  78141. * Will usually be called by the features manager
  78142. *
  78143. * @returns true if successful.
  78144. */
  78145. detach(): boolean;
  78146. /**
  78147. * Get the headset impostor, if enabled
  78148. * @returns the impostor
  78149. */
  78150. getHeadsetImpostor(): PhysicsImpostor | undefined;
  78151. /**
  78152. * Get the physics impostor of a specific controller.
  78153. * The impostor is not attached to a mesh because a mesh for each controller is not obligatory
  78154. * @param controller the controller or the controller id of which to get the impostor
  78155. * @returns the impostor or null
  78156. */
  78157. getImpostorForController(controller: WebXRInputSource | string): Nullable<PhysicsImpostor>;
  78158. /**
  78159. * Update the physics properties provided in the constructor
  78160. * @param newProperties the new properties object
  78161. */
  78162. setPhysicsProperties(newProperties: {
  78163. impostorType?: number;
  78164. impostorSize?: number | {
  78165. width: number;
  78166. height: number;
  78167. depth: number;
  78168. };
  78169. friction?: number;
  78170. restitution?: number;
  78171. }): void;
  78172. protected _onXRFrame(_xrFrame: any): void;
  78173. private _detachController;
  78174. }
  78175. }
  78176. declare module "babylonjs/XR/features/index" {
  78177. export * from "babylonjs/XR/features/WebXRHitTestLegacy";
  78178. export * from "babylonjs/XR/features/WebXRAnchorSystem";
  78179. export * from "babylonjs/XR/features/WebXRPlaneDetector";
  78180. export * from "babylonjs/XR/features/WebXRBackgroundRemover";
  78181. export * from "babylonjs/XR/features/WebXRControllerTeleportation";
  78182. export * from "babylonjs/XR/features/WebXRControllerPointerSelection";
  78183. export * from "babylonjs/XR/features/WebXRControllerPhysics";
  78184. export * from "babylonjs/XR/features/WebXRHitTest";
  78185. }
  78186. declare module "babylonjs/XR/motionController/webXRMicrosoftMixedRealityController" {
  78187. import { WebXRAbstractMotionController, IMinimalMotionControllerObject, MotionControllerHandedness } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  78188. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  78189. import { Scene } from "babylonjs/scene";
  78190. /**
  78191. * The motion controller class for all microsoft mixed reality controllers
  78192. */
  78193. export class WebXRMicrosoftMixedRealityController extends WebXRAbstractMotionController {
  78194. protected readonly _mapping: {
  78195. defaultButton: {
  78196. valueNodeName: string;
  78197. unpressedNodeName: string;
  78198. pressedNodeName: string;
  78199. };
  78200. defaultAxis: {
  78201. valueNodeName: string;
  78202. minNodeName: string;
  78203. maxNodeName: string;
  78204. };
  78205. buttons: {
  78206. "xr-standard-trigger": {
  78207. rootNodeName: string;
  78208. componentProperty: string;
  78209. states: string[];
  78210. };
  78211. "xr-standard-squeeze": {
  78212. rootNodeName: string;
  78213. componentProperty: string;
  78214. states: string[];
  78215. };
  78216. "xr-standard-touchpad": {
  78217. rootNodeName: string;
  78218. labelAnchorNodeName: string;
  78219. touchPointNodeName: string;
  78220. };
  78221. "xr-standard-thumbstick": {
  78222. rootNodeName: string;
  78223. componentProperty: string;
  78224. states: string[];
  78225. };
  78226. };
  78227. axes: {
  78228. "xr-standard-touchpad": {
  78229. "x-axis": {
  78230. rootNodeName: string;
  78231. };
  78232. "y-axis": {
  78233. rootNodeName: string;
  78234. };
  78235. };
  78236. "xr-standard-thumbstick": {
  78237. "x-axis": {
  78238. rootNodeName: string;
  78239. };
  78240. "y-axis": {
  78241. rootNodeName: string;
  78242. };
  78243. };
  78244. };
  78245. };
  78246. /**
  78247. * The base url used to load the left and right controller models
  78248. */
  78249. static MODEL_BASE_URL: string;
  78250. /**
  78251. * The name of the left controller model file
  78252. */
  78253. static MODEL_LEFT_FILENAME: string;
  78254. /**
  78255. * The name of the right controller model file
  78256. */
  78257. static MODEL_RIGHT_FILENAME: string;
  78258. profileId: string;
  78259. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness);
  78260. protected _getFilenameAndPath(): {
  78261. filename: string;
  78262. path: string;
  78263. };
  78264. protected _getModelLoadingConstraints(): boolean;
  78265. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  78266. protected _setRootMesh(meshes: AbstractMesh[]): void;
  78267. protected _updateModel(): void;
  78268. }
  78269. }
  78270. declare module "babylonjs/XR/motionController/webXROculusTouchMotionController" {
  78271. import { WebXRAbstractMotionController, IMinimalMotionControllerObject, MotionControllerHandedness } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  78272. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  78273. import { Scene } from "babylonjs/scene";
  78274. /**
  78275. * The motion controller class for oculus touch (quest, rift).
  78276. * This class supports legacy mapping as well the standard xr mapping
  78277. */
  78278. export class WebXROculusTouchMotionController extends WebXRAbstractMotionController {
  78279. private _forceLegacyControllers;
  78280. private _modelRootNode;
  78281. /**
  78282. * The base url used to load the left and right controller models
  78283. */
  78284. static MODEL_BASE_URL: string;
  78285. /**
  78286. * The name of the left controller model file
  78287. */
  78288. static MODEL_LEFT_FILENAME: string;
  78289. /**
  78290. * The name of the right controller model file
  78291. */
  78292. static MODEL_RIGHT_FILENAME: string;
  78293. /**
  78294. * Base Url for the Quest controller model.
  78295. */
  78296. static QUEST_MODEL_BASE_URL: string;
  78297. profileId: string;
  78298. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness, legacyMapping?: boolean, _forceLegacyControllers?: boolean);
  78299. protected _getFilenameAndPath(): {
  78300. filename: string;
  78301. path: string;
  78302. };
  78303. protected _getModelLoadingConstraints(): boolean;
  78304. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  78305. protected _setRootMesh(meshes: AbstractMesh[]): void;
  78306. protected _updateModel(): void;
  78307. /**
  78308. * Is this the new type of oculus touch. At the moment both have the same profile and it is impossible to differentiate
  78309. * between the touch and touch 2.
  78310. */
  78311. private _isQuest;
  78312. }
  78313. }
  78314. declare module "babylonjs/XR/motionController/webXRHTCViveMotionController" {
  78315. import { IMinimalMotionControllerObject, MotionControllerHandedness, WebXRAbstractMotionController } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  78316. import { Scene } from "babylonjs/scene";
  78317. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  78318. /**
  78319. * The motion controller class for the standard HTC-Vive controllers
  78320. */
  78321. export class WebXRHTCViveMotionController extends WebXRAbstractMotionController {
  78322. private _modelRootNode;
  78323. /**
  78324. * The base url used to load the left and right controller models
  78325. */
  78326. static MODEL_BASE_URL: string;
  78327. /**
  78328. * File name for the controller model.
  78329. */
  78330. static MODEL_FILENAME: string;
  78331. profileId: string;
  78332. /**
  78333. * Create a new Vive motion controller object
  78334. * @param scene the scene to use to create this controller
  78335. * @param gamepadObject the corresponding gamepad object
  78336. * @param handedness the handedness of the controller
  78337. */
  78338. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness);
  78339. protected _getFilenameAndPath(): {
  78340. filename: string;
  78341. path: string;
  78342. };
  78343. protected _getModelLoadingConstraints(): boolean;
  78344. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  78345. protected _setRootMesh(meshes: AbstractMesh[]): void;
  78346. protected _updateModel(): void;
  78347. }
  78348. }
  78349. declare module "babylonjs/XR/motionController/index" {
  78350. export * from "babylonjs/XR/motionController/webXRAbstractMotionController";
  78351. export * from "babylonjs/XR/motionController/webXRControllerComponent";
  78352. export * from "babylonjs/XR/motionController/webXRGenericMotionController";
  78353. export * from "babylonjs/XR/motionController/webXRMicrosoftMixedRealityController";
  78354. export * from "babylonjs/XR/motionController/webXRMotionControllerManager";
  78355. export * from "babylonjs/XR/motionController/webXROculusTouchMotionController";
  78356. export * from "babylonjs/XR/motionController/webXRHTCViveMotionController";
  78357. export * from "babylonjs/XR/motionController/webXRProfiledMotionController";
  78358. }
  78359. declare module "babylonjs/XR/index" {
  78360. export * from "babylonjs/XR/webXRCamera";
  78361. export * from "babylonjs/XR/webXREnterExitUI";
  78362. export * from "babylonjs/XR/webXRExperienceHelper";
  78363. export * from "babylonjs/XR/webXRInput";
  78364. export * from "babylonjs/XR/webXRInputSource";
  78365. export * from "babylonjs/XR/webXRManagedOutputCanvas";
  78366. export * from "babylonjs/XR/webXRTypes";
  78367. export * from "babylonjs/XR/webXRSessionManager";
  78368. export * from "babylonjs/XR/webXRDefaultExperience";
  78369. export * from "babylonjs/XR/webXRFeaturesManager";
  78370. export * from "babylonjs/XR/features/index";
  78371. export * from "babylonjs/XR/motionController/index";
  78372. }
  78373. declare module "babylonjs/index" {
  78374. export * from "babylonjs/abstractScene";
  78375. export * from "babylonjs/Actions/index";
  78376. export * from "babylonjs/Animations/index";
  78377. export * from "babylonjs/assetContainer";
  78378. export * from "babylonjs/Audio/index";
  78379. export * from "babylonjs/Behaviors/index";
  78380. export * from "babylonjs/Bones/index";
  78381. export * from "babylonjs/Cameras/index";
  78382. export * from "babylonjs/Collisions/index";
  78383. export * from "babylonjs/Culling/index";
  78384. export * from "babylonjs/Debug/index";
  78385. export * from "babylonjs/DeviceInput/index";
  78386. export * from "babylonjs/Engines/index";
  78387. export * from "babylonjs/Events/index";
  78388. export * from "babylonjs/Gamepads/index";
  78389. export * from "babylonjs/Gizmos/index";
  78390. export * from "babylonjs/Helpers/index";
  78391. export * from "babylonjs/Instrumentation/index";
  78392. export * from "babylonjs/Layers/index";
  78393. export * from "babylonjs/LensFlares/index";
  78394. export * from "babylonjs/Lights/index";
  78395. export * from "babylonjs/Loading/index";
  78396. export * from "babylonjs/Materials/index";
  78397. export * from "babylonjs/Maths/index";
  78398. export * from "babylonjs/Meshes/index";
  78399. export * from "babylonjs/Morph/index";
  78400. export * from "babylonjs/Navigation/index";
  78401. export * from "babylonjs/node";
  78402. export * from "babylonjs/Offline/index";
  78403. export * from "babylonjs/Particles/index";
  78404. export * from "babylonjs/Physics/index";
  78405. export * from "babylonjs/PostProcesses/index";
  78406. export * from "babylonjs/Probes/index";
  78407. export * from "babylonjs/Rendering/index";
  78408. export * from "babylonjs/scene";
  78409. export * from "babylonjs/sceneComponent";
  78410. export * from "babylonjs/Sprites/index";
  78411. export * from "babylonjs/States/index";
  78412. export * from "babylonjs/Misc/index";
  78413. export * from "babylonjs/XR/index";
  78414. export * from "babylonjs/types";
  78415. }
  78416. declare module "babylonjs/Animations/pathCursor" {
  78417. import { Vector3 } from "babylonjs/Maths/math.vector";
  78418. import { Path2 } from "babylonjs/Maths/math.path";
  78419. /**
  78420. * A cursor which tracks a point on a path
  78421. */
  78422. export class PathCursor {
  78423. private path;
  78424. /**
  78425. * Stores path cursor callbacks for when an onchange event is triggered
  78426. */
  78427. private _onchange;
  78428. /**
  78429. * The value of the path cursor
  78430. */
  78431. value: number;
  78432. /**
  78433. * The animation array of the path cursor
  78434. */
  78435. animations: Animation[];
  78436. /**
  78437. * Initializes the path cursor
  78438. * @param path The path to track
  78439. */
  78440. constructor(path: Path2);
  78441. /**
  78442. * Gets the cursor point on the path
  78443. * @returns A point on the path cursor at the cursor location
  78444. */
  78445. getPoint(): Vector3;
  78446. /**
  78447. * Moves the cursor ahead by the step amount
  78448. * @param step The amount to move the cursor forward
  78449. * @returns This path cursor
  78450. */
  78451. moveAhead(step?: number): PathCursor;
  78452. /**
  78453. * Moves the cursor behind by the step amount
  78454. * @param step The amount to move the cursor back
  78455. * @returns This path cursor
  78456. */
  78457. moveBack(step?: number): PathCursor;
  78458. /**
  78459. * Moves the cursor by the step amount
  78460. * If the step amount is greater than one, an exception is thrown
  78461. * @param step The amount to move the cursor
  78462. * @returns This path cursor
  78463. */
  78464. move(step: number): PathCursor;
  78465. /**
  78466. * Ensures that the value is limited between zero and one
  78467. * @returns This path cursor
  78468. */
  78469. private ensureLimits;
  78470. /**
  78471. * Runs onchange callbacks on change (used by the animation engine)
  78472. * @returns This path cursor
  78473. */
  78474. private raiseOnChange;
  78475. /**
  78476. * Executes a function on change
  78477. * @param f A path cursor onchange callback
  78478. * @returns This path cursor
  78479. */
  78480. onchange(f: (cursor: PathCursor) => void): PathCursor;
  78481. }
  78482. }
  78483. declare module "babylonjs/Engines/Processors/Expressions/Operators/index" {
  78484. export * from "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineAndOperator";
  78485. export * from "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineArithmeticOperator";
  78486. export * from "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineIsDefinedOperator";
  78487. export * from "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineOrOperator";
  78488. }
  78489. declare module "babylonjs/Engines/Processors/Expressions/index" {
  78490. export * from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  78491. export * from "babylonjs/Engines/Processors/Expressions/Operators/index";
  78492. }
  78493. declare module "babylonjs/Engines/Processors/index" {
  78494. export * from "babylonjs/Engines/Processors/iShaderProcessor";
  78495. export * from "babylonjs/Engines/Processors/Expressions/index";
  78496. export * from "babylonjs/Engines/Processors/shaderCodeConditionNode";
  78497. export * from "babylonjs/Engines/Processors/shaderCodeCursor";
  78498. export * from "babylonjs/Engines/Processors/shaderCodeNode";
  78499. export * from "babylonjs/Engines/Processors/shaderCodeTestNode";
  78500. export * from "babylonjs/Engines/Processors/shaderProcessingOptions";
  78501. export * from "babylonjs/Engines/Processors/shaderProcessor";
  78502. export * from "babylonjs/Engines/Processors/shaderCodeInliner";
  78503. }
  78504. declare module "babylonjs/Legacy/legacy" {
  78505. import * as Babylon from "babylonjs/index";
  78506. export * from "babylonjs/index";
  78507. }
  78508. declare module "babylonjs/Shaders/blur.fragment" {
  78509. /** @hidden */
  78510. export var blurPixelShader: {
  78511. name: string;
  78512. shader: string;
  78513. };
  78514. }
  78515. declare module "babylonjs/Shaders/ShadersInclude/pointCloudVertexDeclaration" {
  78516. /** @hidden */
  78517. export var pointCloudVertexDeclaration: {
  78518. name: string;
  78519. shader: string;
  78520. };
  78521. }
  78522. declare module "babylonjs" {
  78523. export * from "babylonjs/Legacy/legacy";
  78524. }
  78525. declare module BABYLON {
  78526. /** Alias type for value that can be null */
  78527. export type Nullable<T> = T | null;
  78528. /**
  78529. * Alias type for number that are floats
  78530. * @ignorenaming
  78531. */
  78532. export type float = number;
  78533. /**
  78534. * Alias type for number that are doubles.
  78535. * @ignorenaming
  78536. */
  78537. export type double = number;
  78538. /**
  78539. * Alias type for number that are integer
  78540. * @ignorenaming
  78541. */
  78542. export type int = number;
  78543. /** Alias type for number array or Float32Array */
  78544. export type FloatArray = number[] | Float32Array;
  78545. /** Alias type for number array or Float32Array or Int32Array or Uint32Array or Uint16Array */
  78546. export type IndicesArray = number[] | Int32Array | Uint32Array | Uint16Array;
  78547. /**
  78548. * Alias for types that can be used by a Buffer or VertexBuffer.
  78549. */
  78550. export type DataArray = number[] | ArrayBuffer | ArrayBufferView;
  78551. /**
  78552. * Alias type for primitive types
  78553. * @ignorenaming
  78554. */
  78555. type Primitive = undefined | null | boolean | string | number | Function;
  78556. /**
  78557. * Type modifier to make all the properties of an object Readonly
  78558. */
  78559. export type Immutable<T> = T extends Primitive ? T : T extends Array<infer U> ? ReadonlyArray<U> : DeepImmutable<T>;
  78560. /**
  78561. * Type modifier to make all the properties of an object Readonly recursively
  78562. */
  78563. export type DeepImmutable<T> = T extends Primitive ? T : T extends Array<infer U> ? DeepImmutableArray<U> : DeepImmutableObject<T>;
  78564. /**
  78565. * Type modifier to make object properties readonly.
  78566. */
  78567. export type DeepImmutableObject<T> = {
  78568. readonly [K in keyof T]: DeepImmutable<T[K]>;
  78569. };
  78570. /** @hidden */
  78571. interface DeepImmutableArray<T> extends ReadonlyArray<DeepImmutable<T>> {
  78572. }
  78573. }
  78574. declare module BABYLON {
  78575. /**
  78576. * A class serves as a medium between the observable and its observers
  78577. */
  78578. export class EventState {
  78579. /**
  78580. * Create a new EventState
  78581. * @param mask defines the mask associated with this state
  78582. * @param skipNextObservers defines a flag which will instruct the observable to skip following observers when set to true
  78583. * @param target defines the original target of the state
  78584. * @param currentTarget defines the current target of the state
  78585. */
  78586. constructor(mask: number, skipNextObservers?: boolean, target?: any, currentTarget?: any);
  78587. /**
  78588. * Initialize the current event state
  78589. * @param mask defines the mask associated with this state
  78590. * @param skipNextObservers defines a flag which will instruct the observable to skip following observers when set to true
  78591. * @param target defines the original target of the state
  78592. * @param currentTarget defines the current target of the state
  78593. * @returns the current event state
  78594. */
  78595. initalize(mask: number, skipNextObservers?: boolean, target?: any, currentTarget?: any): EventState;
  78596. /**
  78597. * An Observer can set this property to true to prevent subsequent observers of being notified
  78598. */
  78599. skipNextObservers: boolean;
  78600. /**
  78601. * Get the mask value that were used to trigger the event corresponding to this EventState object
  78602. */
  78603. mask: number;
  78604. /**
  78605. * The object that originally notified the event
  78606. */
  78607. target?: any;
  78608. /**
  78609. * The current object in the bubbling phase
  78610. */
  78611. currentTarget?: any;
  78612. /**
  78613. * This will be populated with the return value of the last function that was executed.
  78614. * If it is the first function in the callback chain it will be the event data.
  78615. */
  78616. lastReturnValue?: any;
  78617. }
  78618. /**
  78619. * Represent an Observer registered to a given Observable object.
  78620. */
  78621. export class Observer<T> {
  78622. /**
  78623. * Defines the callback to call when the observer is notified
  78624. */
  78625. callback: (eventData: T, eventState: EventState) => void;
  78626. /**
  78627. * Defines the mask of the observer (used to filter notifications)
  78628. */
  78629. mask: number;
  78630. /**
  78631. * Defines the current scope used to restore the JS context
  78632. */
  78633. scope: any;
  78634. /** @hidden */
  78635. _willBeUnregistered: boolean;
  78636. /**
  78637. * Gets or sets a property defining that the observer as to be unregistered after the next notification
  78638. */
  78639. unregisterOnNextCall: boolean;
  78640. /**
  78641. * Creates a new observer
  78642. * @param callback defines the callback to call when the observer is notified
  78643. * @param mask defines the mask of the observer (used to filter notifications)
  78644. * @param scope defines the current scope used to restore the JS context
  78645. */
  78646. constructor(
  78647. /**
  78648. * Defines the callback to call when the observer is notified
  78649. */
  78650. callback: (eventData: T, eventState: EventState) => void,
  78651. /**
  78652. * Defines the mask of the observer (used to filter notifications)
  78653. */
  78654. mask: number,
  78655. /**
  78656. * Defines the current scope used to restore the JS context
  78657. */
  78658. scope?: any);
  78659. }
  78660. /**
  78661. * Represent a list of observers registered to multiple Observables object.
  78662. */
  78663. export class MultiObserver<T> {
  78664. private _observers;
  78665. private _observables;
  78666. /**
  78667. * Release associated resources
  78668. */
  78669. dispose(): void;
  78670. /**
  78671. * Raise a callback when one of the observable will notify
  78672. * @param observables defines a list of observables to watch
  78673. * @param callback defines the callback to call on notification
  78674. * @param mask defines the mask used to filter notifications
  78675. * @param scope defines the current scope used to restore the JS context
  78676. * @returns the new MultiObserver
  78677. */
  78678. static Watch<T>(observables: Observable<T>[], callback: (eventData: T, eventState: EventState) => void, mask?: number, scope?: any): MultiObserver<T>;
  78679. }
  78680. /**
  78681. * The Observable class is a simple implementation of the Observable pattern.
  78682. *
  78683. * 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.
  78684. * This enable a more fine grained execution without having to rely on multiple different Observable objects.
  78685. * 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).
  78686. * 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.
  78687. */
  78688. export class Observable<T> {
  78689. private _observers;
  78690. private _eventState;
  78691. private _onObserverAdded;
  78692. /**
  78693. * Gets the list of observers
  78694. */
  78695. get observers(): Array<Observer<T>>;
  78696. /**
  78697. * Creates a new observable
  78698. * @param onObserverAdded defines a callback to call when a new observer is added
  78699. */
  78700. constructor(onObserverAdded?: (observer: Observer<T>) => void);
  78701. /**
  78702. * Create a new Observer with the specified callback
  78703. * @param callback the callback that will be executed for that Observer
  78704. * @param mask the mask used to filter observers
  78705. * @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.
  78706. * @param scope optional scope for the callback to be called from
  78707. * @param unregisterOnFirstCall defines if the observer as to be unregistered after the next notification
  78708. * @returns the new observer created for the callback
  78709. */
  78710. add(callback: (eventData: T, eventState: EventState) => void, mask?: number, insertFirst?: boolean, scope?: any, unregisterOnFirstCall?: boolean): Nullable<Observer<T>>;
  78711. /**
  78712. * Create a new Observer with the specified callback and unregisters after the next notification
  78713. * @param callback the callback that will be executed for that Observer
  78714. * @returns the new observer created for the callback
  78715. */
  78716. addOnce(callback: (eventData: T, eventState: EventState) => void): Nullable<Observer<T>>;
  78717. /**
  78718. * Remove an Observer from the Observable object
  78719. * @param observer the instance of the Observer to remove
  78720. * @returns false if it doesn't belong to this Observable
  78721. */
  78722. remove(observer: Nullable<Observer<T>>): boolean;
  78723. /**
  78724. * Remove a callback from the Observable object
  78725. * @param callback the callback to remove
  78726. * @param scope optional scope. If used only the callbacks with this scope will be removed
  78727. * @returns false if it doesn't belong to this Observable
  78728. */
  78729. removeCallback(callback: (eventData: T, eventState: EventState) => void, scope?: any): boolean;
  78730. private _deferUnregister;
  78731. private _remove;
  78732. /**
  78733. * Moves the observable to the top of the observer list making it get called first when notified
  78734. * @param observer the observer to move
  78735. */
  78736. makeObserverTopPriority(observer: Observer<T>): void;
  78737. /**
  78738. * Moves the observable to the bottom of the observer list making it get called last when notified
  78739. * @param observer the observer to move
  78740. */
  78741. makeObserverBottomPriority(observer: Observer<T>): void;
  78742. /**
  78743. * Notify all Observers by calling their respective callback with the given data
  78744. * Will return true if all observers were executed, false if an observer set skipNextObservers to true, then prevent the subsequent ones to execute
  78745. * @param eventData defines the data to send to all observers
  78746. * @param mask defines the mask of the current notification (observers with incompatible mask (ie mask & observer.mask === 0) will not be notified)
  78747. * @param target defines the original target of the state
  78748. * @param currentTarget defines the current target of the state
  78749. * @returns false if the complete observer chain was not processed (because one observer set the skipNextObservers to true)
  78750. */
  78751. notifyObservers(eventData: T, mask?: number, target?: any, currentTarget?: any): boolean;
  78752. /**
  78753. * Calling this will execute each callback, expecting it to be a promise or return a value.
  78754. * If at any point in the chain one function fails, the promise will fail and the execution will not continue.
  78755. * This is useful when a chain of events (sometimes async events) is needed to initialize a certain object
  78756. * and it is crucial that all callbacks will be executed.
  78757. * The order of the callbacks is kept, callbacks are not executed parallel.
  78758. *
  78759. * @param eventData The data to be sent to each callback
  78760. * @param mask is used to filter observers defaults to -1
  78761. * @param target defines the callback target (see EventState)
  78762. * @param currentTarget defines he current object in the bubbling phase
  78763. * @returns {Promise<T>} will return a Promise than resolves when all callbacks executed successfully.
  78764. */
  78765. notifyObserversWithPromise(eventData: T, mask?: number, target?: any, currentTarget?: any): Promise<T>;
  78766. /**
  78767. * Notify a specific observer
  78768. * @param observer defines the observer to notify
  78769. * @param eventData defines the data to be sent to each callback
  78770. * @param mask is used to filter observers defaults to -1
  78771. */
  78772. notifyObserver(observer: Observer<T>, eventData: T, mask?: number): void;
  78773. /**
  78774. * Gets a boolean indicating if the observable has at least one observer
  78775. * @returns true is the Observable has at least one Observer registered
  78776. */
  78777. hasObservers(): boolean;
  78778. /**
  78779. * Clear the list of observers
  78780. */
  78781. clear(): void;
  78782. /**
  78783. * Clone the current observable
  78784. * @returns a new observable
  78785. */
  78786. clone(): Observable<T>;
  78787. /**
  78788. * Does this observable handles observer registered with a given mask
  78789. * @param mask defines the mask to be tested
  78790. * @return whether or not one observer registered with the given mask is handeled
  78791. **/
  78792. hasSpecificMask(mask?: number): boolean;
  78793. }
  78794. }
  78795. declare module BABYLON {
  78796. /**
  78797. * Sets of helpers dealing with the DOM and some of the recurrent functions needed in
  78798. * Babylon.js
  78799. */
  78800. export class DomManagement {
  78801. /**
  78802. * Checks if the window object exists
  78803. * @returns true if the window object exists
  78804. */
  78805. static IsWindowObjectExist(): boolean;
  78806. /**
  78807. * Checks if the navigator object exists
  78808. * @returns true if the navigator object exists
  78809. */
  78810. static IsNavigatorAvailable(): boolean;
  78811. /**
  78812. * Check if the document object exists
  78813. * @returns true if the document object exists
  78814. */
  78815. static IsDocumentAvailable(): boolean;
  78816. /**
  78817. * Extracts text content from a DOM element hierarchy
  78818. * @param element defines the root element
  78819. * @returns a string
  78820. */
  78821. static GetDOMTextContent(element: HTMLElement): string;
  78822. }
  78823. }
  78824. declare module BABYLON {
  78825. /**
  78826. * Logger used througouht the application to allow configuration of
  78827. * the log level required for the messages.
  78828. */
  78829. export class Logger {
  78830. /**
  78831. * No log
  78832. */
  78833. static readonly NoneLogLevel: number;
  78834. /**
  78835. * Only message logs
  78836. */
  78837. static readonly MessageLogLevel: number;
  78838. /**
  78839. * Only warning logs
  78840. */
  78841. static readonly WarningLogLevel: number;
  78842. /**
  78843. * Only error logs
  78844. */
  78845. static readonly ErrorLogLevel: number;
  78846. /**
  78847. * All logs
  78848. */
  78849. static readonly AllLogLevel: number;
  78850. private static _LogCache;
  78851. /**
  78852. * Gets a value indicating the number of loading errors
  78853. * @ignorenaming
  78854. */
  78855. static errorsCount: number;
  78856. /**
  78857. * Callback called when a new log is added
  78858. */
  78859. static OnNewCacheEntry: (entry: string) => void;
  78860. private static _AddLogEntry;
  78861. private static _FormatMessage;
  78862. private static _LogDisabled;
  78863. private static _LogEnabled;
  78864. private static _WarnDisabled;
  78865. private static _WarnEnabled;
  78866. private static _ErrorDisabled;
  78867. private static _ErrorEnabled;
  78868. /**
  78869. * Log a message to the console
  78870. */
  78871. static Log: (message: string) => void;
  78872. /**
  78873. * Write a warning message to the console
  78874. */
  78875. static Warn: (message: string) => void;
  78876. /**
  78877. * Write an error message to the console
  78878. */
  78879. static Error: (message: string) => void;
  78880. /**
  78881. * Gets current log cache (list of logs)
  78882. */
  78883. static get LogCache(): string;
  78884. /**
  78885. * Clears the log cache
  78886. */
  78887. static ClearLogCache(): void;
  78888. /**
  78889. * Sets the current log level (MessageLogLevel / WarningLogLevel / ErrorLogLevel)
  78890. */
  78891. static set LogLevels(level: number);
  78892. }
  78893. }
  78894. declare module BABYLON {
  78895. /** @hidden */
  78896. export class _TypeStore {
  78897. /** @hidden */
  78898. static RegisteredTypes: {
  78899. [key: string]: Object;
  78900. };
  78901. /** @hidden */
  78902. static GetClass(fqdn: string): any;
  78903. }
  78904. }
  78905. declare module BABYLON {
  78906. /**
  78907. * Helper to manipulate strings
  78908. */
  78909. export class StringTools {
  78910. /**
  78911. * Checks for a matching suffix at the end of a string (for ES5 and lower)
  78912. * @param str Source string
  78913. * @param suffix Suffix to search for in the source string
  78914. * @returns Boolean indicating whether the suffix was found (true) or not (false)
  78915. */
  78916. static EndsWith(str: string, suffix: string): boolean;
  78917. /**
  78918. * Checks for a matching suffix at the beginning of a string (for ES5 and lower)
  78919. * @param str Source string
  78920. * @param suffix Suffix to search for in the source string
  78921. * @returns Boolean indicating whether the suffix was found (true) or not (false)
  78922. */
  78923. static StartsWith(str: string, suffix: string): boolean;
  78924. /**
  78925. * Decodes a buffer into a string
  78926. * @param buffer The buffer to decode
  78927. * @returns The decoded string
  78928. */
  78929. static Decode(buffer: Uint8Array | Uint16Array): string;
  78930. /**
  78931. * Encode a buffer to a base64 string
  78932. * @param buffer defines the buffer to encode
  78933. * @returns the encoded string
  78934. */
  78935. static EncodeArrayBufferToBase64(buffer: ArrayBuffer | ArrayBufferView): string;
  78936. /**
  78937. * Converts a number to string and pads with preceeding zeroes until it is of specified length.
  78938. * @param num the number to convert and pad
  78939. * @param length the expected length of the string
  78940. * @returns the padded string
  78941. */
  78942. static PadNumber(num: number, length: number): string;
  78943. }
  78944. }
  78945. declare module BABYLON {
  78946. /**
  78947. * Class containing a set of static utilities functions for deep copy.
  78948. */
  78949. export class DeepCopier {
  78950. /**
  78951. * Tries to copy an object by duplicating every property
  78952. * @param source defines the source object
  78953. * @param destination defines the target object
  78954. * @param doNotCopyList defines a list of properties to avoid
  78955. * @param mustCopyList defines a list of properties to copy (even if they start with _)
  78956. */
  78957. static DeepCopy(source: any, destination: any, doNotCopyList?: string[], mustCopyList?: string[]): void;
  78958. }
  78959. }
  78960. declare module BABYLON {
  78961. /**
  78962. * Class containing a set of static utilities functions for precision date
  78963. */
  78964. export class PrecisionDate {
  78965. /**
  78966. * Gets either window.performance.now() if supported or Date.now() else
  78967. */
  78968. static get Now(): number;
  78969. }
  78970. }
  78971. declare module BABYLON {
  78972. /** @hidden */
  78973. export class _DevTools {
  78974. static WarnImport(name: string): string;
  78975. }
  78976. }
  78977. declare module BABYLON {
  78978. /**
  78979. * Interface used to define the mechanism to get data from the network
  78980. */
  78981. export interface IWebRequest {
  78982. /**
  78983. * Returns client's response url
  78984. */
  78985. responseURL: string;
  78986. /**
  78987. * Returns client's status
  78988. */
  78989. status: number;
  78990. /**
  78991. * Returns client's status as a text
  78992. */
  78993. statusText: string;
  78994. }
  78995. }
  78996. declare module BABYLON {
  78997. /**
  78998. * Extended version of XMLHttpRequest with support for customizations (headers, ...)
  78999. */
  79000. export class WebRequest implements IWebRequest {
  79001. private _xhr;
  79002. /**
  79003. * Custom HTTP Request Headers to be sent with XMLHttpRequests
  79004. * i.e. when loading files, where the server/service expects an Authorization header
  79005. */
  79006. static CustomRequestHeaders: {
  79007. [key: string]: string;
  79008. };
  79009. /**
  79010. * Add callback functions in this array to update all the requests before they get sent to the network
  79011. */
  79012. static CustomRequestModifiers: ((request: XMLHttpRequest, url: string) => void)[];
  79013. private _injectCustomRequestHeaders;
  79014. /**
  79015. * Gets or sets a function to be called when loading progress changes
  79016. */
  79017. get onprogress(): ((this: XMLHttpRequest, ev: ProgressEvent) => any) | null;
  79018. set onprogress(value: ((this: XMLHttpRequest, ev: ProgressEvent) => any) | null);
  79019. /**
  79020. * Returns client's state
  79021. */
  79022. get readyState(): number;
  79023. /**
  79024. * Returns client's status
  79025. */
  79026. get status(): number;
  79027. /**
  79028. * Returns client's status as a text
  79029. */
  79030. get statusText(): string;
  79031. /**
  79032. * Returns client's response
  79033. */
  79034. get response(): any;
  79035. /**
  79036. * Returns client's response url
  79037. */
  79038. get responseURL(): string;
  79039. /**
  79040. * Returns client's response as text
  79041. */
  79042. get responseText(): string;
  79043. /**
  79044. * Gets or sets the expected response type
  79045. */
  79046. get responseType(): XMLHttpRequestResponseType;
  79047. set responseType(value: XMLHttpRequestResponseType);
  79048. /** @hidden */
  79049. addEventListener<K extends keyof XMLHttpRequestEventMap>(type: K, listener: (this: XMLHttpRequest, ev: XMLHttpRequestEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
  79050. /** @hidden */
  79051. removeEventListener<K extends keyof XMLHttpRequestEventMap>(type: K, listener: (this: XMLHttpRequest, ev: XMLHttpRequestEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
  79052. /**
  79053. * Cancels any network activity
  79054. */
  79055. abort(): void;
  79056. /**
  79057. * Initiates the request. The optional argument provides the request body. The argument is ignored if request method is GET or HEAD
  79058. * @param body defines an optional request body
  79059. */
  79060. send(body?: Document | BodyInit | null): void;
  79061. /**
  79062. * Sets the request method, request URL
  79063. * @param method defines the method to use (GET, POST, etc..)
  79064. * @param url defines the url to connect with
  79065. */
  79066. open(method: string, url: string): void;
  79067. /**
  79068. * Sets the value of a request header.
  79069. * @param name The name of the header whose value is to be set
  79070. * @param value The value to set as the body of the header
  79071. */
  79072. setRequestHeader(name: string, value: string): void;
  79073. /**
  79074. * Get the string containing the text of a particular header's value.
  79075. * @param name The name of the header
  79076. * @returns The string containing the text of the given header name
  79077. */
  79078. getResponseHeader(name: string): Nullable<string>;
  79079. }
  79080. }
  79081. declare module BABYLON {
  79082. /**
  79083. * File request interface
  79084. */
  79085. export interface IFileRequest {
  79086. /**
  79087. * Raised when the request is complete (success or error).
  79088. */
  79089. onCompleteObservable: Observable<IFileRequest>;
  79090. /**
  79091. * Aborts the request for a file.
  79092. */
  79093. abort: () => void;
  79094. }
  79095. }
  79096. declare module BABYLON {
  79097. /**
  79098. * Define options used to create a render target texture
  79099. */
  79100. export class RenderTargetCreationOptions {
  79101. /**
  79102. * Specifies is mipmaps must be generated
  79103. */
  79104. generateMipMaps?: boolean;
  79105. /** Specifies whether or not a depth should be allocated in the texture (true by default) */
  79106. generateDepthBuffer?: boolean;
  79107. /** Specifies whether or not a stencil should be allocated in the texture (false by default)*/
  79108. generateStencilBuffer?: boolean;
  79109. /** Defines texture type (int by default) */
  79110. type?: number;
  79111. /** Defines sampling mode (trilinear by default) */
  79112. samplingMode?: number;
  79113. /** Defines format (RGBA by default) */
  79114. format?: number;
  79115. }
  79116. }
  79117. declare module BABYLON {
  79118. /** Defines the cross module used constants to avoid circular dependncies */
  79119. export class Constants {
  79120. /** Defines that alpha blending is disabled */
  79121. static readonly ALPHA_DISABLE: number;
  79122. /** Defines that alpha blending is SRC ALPHA * SRC + DEST */
  79123. static readonly ALPHA_ADD: number;
  79124. /** Defines that alpha blending is SRC ALPHA * SRC + (1 - SRC ALPHA) * DEST */
  79125. static readonly ALPHA_COMBINE: number;
  79126. /** Defines that alpha blending is DEST - SRC * DEST */
  79127. static readonly ALPHA_SUBTRACT: number;
  79128. /** Defines that alpha blending is SRC * DEST */
  79129. static readonly ALPHA_MULTIPLY: number;
  79130. /** Defines that alpha blending is SRC ALPHA * SRC + (1 - SRC) * DEST */
  79131. static readonly ALPHA_MAXIMIZED: number;
  79132. /** Defines that alpha blending is SRC + DEST */
  79133. static readonly ALPHA_ONEONE: number;
  79134. /** Defines that alpha blending is SRC + (1 - SRC ALPHA) * DEST */
  79135. static readonly ALPHA_PREMULTIPLIED: number;
  79136. /**
  79137. * Defines that alpha blending is SRC + (1 - SRC ALPHA) * DEST
  79138. * Alpha will be set to (1 - SRC ALPHA) * DEST ALPHA
  79139. */
  79140. static readonly ALPHA_PREMULTIPLIED_PORTERDUFF: number;
  79141. /** Defines that alpha blending is CST * SRC + (1 - CST) * DEST */
  79142. static readonly ALPHA_INTERPOLATE: number;
  79143. /**
  79144. * Defines that alpha blending is SRC + (1 - SRC) * DEST
  79145. * Alpha will be set to SRC ALPHA + (1 - SRC ALPHA) * DEST ALPHA
  79146. */
  79147. static readonly ALPHA_SCREENMODE: number;
  79148. /**
  79149. * Defines that alpha blending is SRC + DST
  79150. * Alpha will be set to SRC ALPHA + DST ALPHA
  79151. */
  79152. static readonly ALPHA_ONEONE_ONEONE: number;
  79153. /**
  79154. * Defines that alpha blending is SRC * DST ALPHA + DST
  79155. * Alpha will be set to 0
  79156. */
  79157. static readonly ALPHA_ALPHATOCOLOR: number;
  79158. /**
  79159. * Defines that alpha blending is SRC * (1 - DST) + DST * (1 - SRC)
  79160. */
  79161. static readonly ALPHA_REVERSEONEMINUS: number;
  79162. /**
  79163. * Defines that alpha blending is SRC + DST * (1 - SRC ALPHA)
  79164. * Alpha will be set to SRC ALPHA + DST ALPHA * (1 - SRC ALPHA)
  79165. */
  79166. static readonly ALPHA_SRC_DSTONEMINUSSRCALPHA: number;
  79167. /**
  79168. * Defines that alpha blending is SRC + DST
  79169. * Alpha will be set to SRC ALPHA
  79170. */
  79171. static readonly ALPHA_ONEONE_ONEZERO: number;
  79172. /**
  79173. * Defines that alpha blending is SRC * (1 - DST) + DST * (1 - SRC)
  79174. * Alpha will be set to DST ALPHA
  79175. */
  79176. static readonly ALPHA_EXCLUSION: number;
  79177. /** Defines that alpha blending equation a SUM */
  79178. static readonly ALPHA_EQUATION_ADD: number;
  79179. /** Defines that alpha blending equation a SUBSTRACTION */
  79180. static readonly ALPHA_EQUATION_SUBSTRACT: number;
  79181. /** Defines that alpha blending equation a REVERSE SUBSTRACTION */
  79182. static readonly ALPHA_EQUATION_REVERSE_SUBTRACT: number;
  79183. /** Defines that alpha blending equation a MAX operation */
  79184. static readonly ALPHA_EQUATION_MAX: number;
  79185. /** Defines that alpha blending equation a MIN operation */
  79186. static readonly ALPHA_EQUATION_MIN: number;
  79187. /**
  79188. * Defines that alpha blending equation a DARKEN operation:
  79189. * It takes the min of the src and sums the alpha channels.
  79190. */
  79191. static readonly ALPHA_EQUATION_DARKEN: number;
  79192. /** Defines that the ressource is not delayed*/
  79193. static readonly DELAYLOADSTATE_NONE: number;
  79194. /** Defines that the ressource was successfully delay loaded */
  79195. static readonly DELAYLOADSTATE_LOADED: number;
  79196. /** Defines that the ressource is currently delay loading */
  79197. static readonly DELAYLOADSTATE_LOADING: number;
  79198. /** Defines that the ressource is delayed and has not started loading */
  79199. static readonly DELAYLOADSTATE_NOTLOADED: number;
  79200. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will never pass. i.e. Nothing will be drawn */
  79201. static readonly NEVER: number;
  79202. /** 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 */
  79203. static readonly ALWAYS: number;
  79204. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than the stored value */
  79205. static readonly LESS: number;
  79206. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is equals to the stored value */
  79207. static readonly EQUAL: number;
  79208. /** 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 */
  79209. static readonly LEQUAL: number;
  79210. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than the stored value */
  79211. static readonly GREATER: number;
  79212. /** 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 */
  79213. static readonly GEQUAL: number;
  79214. /** 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 */
  79215. static readonly NOTEQUAL: number;
  79216. /** Passed to stencilOperation to specify that stencil value must be kept */
  79217. static readonly KEEP: number;
  79218. /** Passed to stencilOperation to specify that stencil value must be replaced */
  79219. static readonly REPLACE: number;
  79220. /** Passed to stencilOperation to specify that stencil value must be incremented */
  79221. static readonly INCR: number;
  79222. /** Passed to stencilOperation to specify that stencil value must be decremented */
  79223. static readonly DECR: number;
  79224. /** Passed to stencilOperation to specify that stencil value must be inverted */
  79225. static readonly INVERT: number;
  79226. /** Passed to stencilOperation to specify that stencil value must be incremented with wrapping */
  79227. static readonly INCR_WRAP: number;
  79228. /** Passed to stencilOperation to specify that stencil value must be decremented with wrapping */
  79229. static readonly DECR_WRAP: number;
  79230. /** Texture is not repeating outside of 0..1 UVs */
  79231. static readonly TEXTURE_CLAMP_ADDRESSMODE: number;
  79232. /** Texture is repeating outside of 0..1 UVs */
  79233. static readonly TEXTURE_WRAP_ADDRESSMODE: number;
  79234. /** Texture is repeating and mirrored */
  79235. static readonly TEXTURE_MIRROR_ADDRESSMODE: number;
  79236. /** ALPHA */
  79237. static readonly TEXTUREFORMAT_ALPHA: number;
  79238. /** LUMINANCE */
  79239. static readonly TEXTUREFORMAT_LUMINANCE: number;
  79240. /** LUMINANCE_ALPHA */
  79241. static readonly TEXTUREFORMAT_LUMINANCE_ALPHA: number;
  79242. /** RGB */
  79243. static readonly TEXTUREFORMAT_RGB: number;
  79244. /** RGBA */
  79245. static readonly TEXTUREFORMAT_RGBA: number;
  79246. /** RED */
  79247. static readonly TEXTUREFORMAT_RED: number;
  79248. /** RED (2nd reference) */
  79249. static readonly TEXTUREFORMAT_R: number;
  79250. /** RG */
  79251. static readonly TEXTUREFORMAT_RG: number;
  79252. /** RED_INTEGER */
  79253. static readonly TEXTUREFORMAT_RED_INTEGER: number;
  79254. /** RED_INTEGER (2nd reference) */
  79255. static readonly TEXTUREFORMAT_R_INTEGER: number;
  79256. /** RG_INTEGER */
  79257. static readonly TEXTUREFORMAT_RG_INTEGER: number;
  79258. /** RGB_INTEGER */
  79259. static readonly TEXTUREFORMAT_RGB_INTEGER: number;
  79260. /** RGBA_INTEGER */
  79261. static readonly TEXTUREFORMAT_RGBA_INTEGER: number;
  79262. /** UNSIGNED_BYTE */
  79263. static readonly TEXTURETYPE_UNSIGNED_BYTE: number;
  79264. /** UNSIGNED_BYTE (2nd reference) */
  79265. static readonly TEXTURETYPE_UNSIGNED_INT: number;
  79266. /** FLOAT */
  79267. static readonly TEXTURETYPE_FLOAT: number;
  79268. /** HALF_FLOAT */
  79269. static readonly TEXTURETYPE_HALF_FLOAT: number;
  79270. /** BYTE */
  79271. static readonly TEXTURETYPE_BYTE: number;
  79272. /** SHORT */
  79273. static readonly TEXTURETYPE_SHORT: number;
  79274. /** UNSIGNED_SHORT */
  79275. static readonly TEXTURETYPE_UNSIGNED_SHORT: number;
  79276. /** INT */
  79277. static readonly TEXTURETYPE_INT: number;
  79278. /** UNSIGNED_INT */
  79279. static readonly TEXTURETYPE_UNSIGNED_INTEGER: number;
  79280. /** UNSIGNED_SHORT_4_4_4_4 */
  79281. static readonly TEXTURETYPE_UNSIGNED_SHORT_4_4_4_4: number;
  79282. /** UNSIGNED_SHORT_5_5_5_1 */
  79283. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_5_5_1: number;
  79284. /** UNSIGNED_SHORT_5_6_5 */
  79285. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_6_5: number;
  79286. /** UNSIGNED_INT_2_10_10_10_REV */
  79287. static readonly TEXTURETYPE_UNSIGNED_INT_2_10_10_10_REV: number;
  79288. /** UNSIGNED_INT_24_8 */
  79289. static readonly TEXTURETYPE_UNSIGNED_INT_24_8: number;
  79290. /** UNSIGNED_INT_10F_11F_11F_REV */
  79291. static readonly TEXTURETYPE_UNSIGNED_INT_10F_11F_11F_REV: number;
  79292. /** UNSIGNED_INT_5_9_9_9_REV */
  79293. static readonly TEXTURETYPE_UNSIGNED_INT_5_9_9_9_REV: number;
  79294. /** FLOAT_32_UNSIGNED_INT_24_8_REV */
  79295. static readonly TEXTURETYPE_FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  79296. /** nearest is mag = nearest and min = nearest and no mip */
  79297. static readonly TEXTURE_NEAREST_SAMPLINGMODE: number;
  79298. /** mag = nearest and min = nearest and mip = none */
  79299. static readonly TEXTURE_NEAREST_NEAREST: number;
  79300. /** Bilinear is mag = linear and min = linear and no mip */
  79301. static readonly TEXTURE_BILINEAR_SAMPLINGMODE: number;
  79302. /** mag = linear and min = linear and mip = none */
  79303. static readonly TEXTURE_LINEAR_LINEAR: number;
  79304. /** Trilinear is mag = linear and min = linear and mip = linear */
  79305. static readonly TEXTURE_TRILINEAR_SAMPLINGMODE: number;
  79306. /** Trilinear is mag = linear and min = linear and mip = linear */
  79307. static readonly TEXTURE_LINEAR_LINEAR_MIPLINEAR: number;
  79308. /** mag = nearest and min = nearest and mip = nearest */
  79309. static readonly TEXTURE_NEAREST_NEAREST_MIPNEAREST: number;
  79310. /** mag = nearest and min = linear and mip = nearest */
  79311. static readonly TEXTURE_NEAREST_LINEAR_MIPNEAREST: number;
  79312. /** mag = nearest and min = linear and mip = linear */
  79313. static readonly TEXTURE_NEAREST_LINEAR_MIPLINEAR: number;
  79314. /** mag = nearest and min = linear and mip = none */
  79315. static readonly TEXTURE_NEAREST_LINEAR: number;
  79316. /** nearest is mag = nearest and min = nearest and mip = linear */
  79317. static readonly TEXTURE_NEAREST_NEAREST_MIPLINEAR: number;
  79318. /** mag = linear and min = nearest and mip = nearest */
  79319. static readonly TEXTURE_LINEAR_NEAREST_MIPNEAREST: number;
  79320. /** mag = linear and min = nearest and mip = linear */
  79321. static readonly TEXTURE_LINEAR_NEAREST_MIPLINEAR: number;
  79322. /** Bilinear is mag = linear and min = linear and mip = nearest */
  79323. static readonly TEXTURE_LINEAR_LINEAR_MIPNEAREST: number;
  79324. /** mag = linear and min = nearest and mip = none */
  79325. static readonly TEXTURE_LINEAR_NEAREST: number;
  79326. /** Explicit coordinates mode */
  79327. static readonly TEXTURE_EXPLICIT_MODE: number;
  79328. /** Spherical coordinates mode */
  79329. static readonly TEXTURE_SPHERICAL_MODE: number;
  79330. /** Planar coordinates mode */
  79331. static readonly TEXTURE_PLANAR_MODE: number;
  79332. /** Cubic coordinates mode */
  79333. static readonly TEXTURE_CUBIC_MODE: number;
  79334. /** Projection coordinates mode */
  79335. static readonly TEXTURE_PROJECTION_MODE: number;
  79336. /** Skybox coordinates mode */
  79337. static readonly TEXTURE_SKYBOX_MODE: number;
  79338. /** Inverse Cubic coordinates mode */
  79339. static readonly TEXTURE_INVCUBIC_MODE: number;
  79340. /** Equirectangular coordinates mode */
  79341. static readonly TEXTURE_EQUIRECTANGULAR_MODE: number;
  79342. /** Equirectangular Fixed coordinates mode */
  79343. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MODE: number;
  79344. /** Equirectangular Fixed Mirrored coordinates mode */
  79345. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  79346. /** Offline (baking) quality for texture filtering */
  79347. static readonly TEXTURE_FILTERING_QUALITY_OFFLINE: number;
  79348. /** High quality for texture filtering */
  79349. static readonly TEXTURE_FILTERING_QUALITY_HIGH: number;
  79350. /** Medium quality for texture filtering */
  79351. static readonly TEXTURE_FILTERING_QUALITY_MEDIUM: number;
  79352. /** Low quality for texture filtering */
  79353. static readonly TEXTURE_FILTERING_QUALITY_LOW: number;
  79354. /** Defines that texture rescaling will use a floor to find the closer power of 2 size */
  79355. static readonly SCALEMODE_FLOOR: number;
  79356. /** Defines that texture rescaling will look for the nearest power of 2 size */
  79357. static readonly SCALEMODE_NEAREST: number;
  79358. /** Defines that texture rescaling will use a ceil to find the closer power of 2 size */
  79359. static readonly SCALEMODE_CEILING: number;
  79360. /**
  79361. * The dirty texture flag value
  79362. */
  79363. static readonly MATERIAL_TextureDirtyFlag: number;
  79364. /**
  79365. * The dirty light flag value
  79366. */
  79367. static readonly MATERIAL_LightDirtyFlag: number;
  79368. /**
  79369. * The dirty fresnel flag value
  79370. */
  79371. static readonly MATERIAL_FresnelDirtyFlag: number;
  79372. /**
  79373. * The dirty attribute flag value
  79374. */
  79375. static readonly MATERIAL_AttributesDirtyFlag: number;
  79376. /**
  79377. * The dirty misc flag value
  79378. */
  79379. static readonly MATERIAL_MiscDirtyFlag: number;
  79380. /**
  79381. * The all dirty flag value
  79382. */
  79383. static readonly MATERIAL_AllDirtyFlag: number;
  79384. /**
  79385. * Returns the triangle fill mode
  79386. */
  79387. static readonly MATERIAL_TriangleFillMode: number;
  79388. /**
  79389. * Returns the wireframe mode
  79390. */
  79391. static readonly MATERIAL_WireFrameFillMode: number;
  79392. /**
  79393. * Returns the point fill mode
  79394. */
  79395. static readonly MATERIAL_PointFillMode: number;
  79396. /**
  79397. * Returns the point list draw mode
  79398. */
  79399. static readonly MATERIAL_PointListDrawMode: number;
  79400. /**
  79401. * Returns the line list draw mode
  79402. */
  79403. static readonly MATERIAL_LineListDrawMode: number;
  79404. /**
  79405. * Returns the line loop draw mode
  79406. */
  79407. static readonly MATERIAL_LineLoopDrawMode: number;
  79408. /**
  79409. * Returns the line strip draw mode
  79410. */
  79411. static readonly MATERIAL_LineStripDrawMode: number;
  79412. /**
  79413. * Returns the triangle strip draw mode
  79414. */
  79415. static readonly MATERIAL_TriangleStripDrawMode: number;
  79416. /**
  79417. * Returns the triangle fan draw mode
  79418. */
  79419. static readonly MATERIAL_TriangleFanDrawMode: number;
  79420. /**
  79421. * Stores the clock-wise side orientation
  79422. */
  79423. static readonly MATERIAL_ClockWiseSideOrientation: number;
  79424. /**
  79425. * Stores the counter clock-wise side orientation
  79426. */
  79427. static readonly MATERIAL_CounterClockWiseSideOrientation: number;
  79428. /**
  79429. * Nothing
  79430. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  79431. */
  79432. static readonly ACTION_NothingTrigger: number;
  79433. /**
  79434. * On pick
  79435. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  79436. */
  79437. static readonly ACTION_OnPickTrigger: number;
  79438. /**
  79439. * On left pick
  79440. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  79441. */
  79442. static readonly ACTION_OnLeftPickTrigger: number;
  79443. /**
  79444. * On right pick
  79445. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  79446. */
  79447. static readonly ACTION_OnRightPickTrigger: number;
  79448. /**
  79449. * On center pick
  79450. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  79451. */
  79452. static readonly ACTION_OnCenterPickTrigger: number;
  79453. /**
  79454. * On pick down
  79455. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  79456. */
  79457. static readonly ACTION_OnPickDownTrigger: number;
  79458. /**
  79459. * On double pick
  79460. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  79461. */
  79462. static readonly ACTION_OnDoublePickTrigger: number;
  79463. /**
  79464. * On pick up
  79465. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  79466. */
  79467. static readonly ACTION_OnPickUpTrigger: number;
  79468. /**
  79469. * On pick out.
  79470. * This trigger will only be raised if you also declared a OnPickDown
  79471. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  79472. */
  79473. static readonly ACTION_OnPickOutTrigger: number;
  79474. /**
  79475. * On long press
  79476. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  79477. */
  79478. static readonly ACTION_OnLongPressTrigger: number;
  79479. /**
  79480. * On pointer over
  79481. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  79482. */
  79483. static readonly ACTION_OnPointerOverTrigger: number;
  79484. /**
  79485. * On pointer out
  79486. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  79487. */
  79488. static readonly ACTION_OnPointerOutTrigger: number;
  79489. /**
  79490. * On every frame
  79491. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  79492. */
  79493. static readonly ACTION_OnEveryFrameTrigger: number;
  79494. /**
  79495. * On intersection enter
  79496. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  79497. */
  79498. static readonly ACTION_OnIntersectionEnterTrigger: number;
  79499. /**
  79500. * On intersection exit
  79501. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  79502. */
  79503. static readonly ACTION_OnIntersectionExitTrigger: number;
  79504. /**
  79505. * On key down
  79506. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  79507. */
  79508. static readonly ACTION_OnKeyDownTrigger: number;
  79509. /**
  79510. * On key up
  79511. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  79512. */
  79513. static readonly ACTION_OnKeyUpTrigger: number;
  79514. /**
  79515. * Billboard mode will only apply to Y axis
  79516. */
  79517. static readonly PARTICLES_BILLBOARDMODE_Y: number;
  79518. /**
  79519. * Billboard mode will apply to all axes
  79520. */
  79521. static readonly PARTICLES_BILLBOARDMODE_ALL: number;
  79522. /**
  79523. * Special billboard mode where the particle will be biilboard to the camera but rotated to align with direction
  79524. */
  79525. static readonly PARTICLES_BILLBOARDMODE_STRETCHED: number;
  79526. /** Default culling strategy : this is an exclusion test and it's the more accurate.
  79527. * Test order :
  79528. * Is the bounding sphere outside the frustum ?
  79529. * If not, are the bounding box vertices outside the frustum ?
  79530. * It not, then the cullable object is in the frustum.
  79531. */
  79532. static readonly MESHES_CULLINGSTRATEGY_STANDARD: number;
  79533. /** Culling strategy : Bounding Sphere Only.
  79534. * This is an exclusion test. It's faster than the standard strategy because the bounding box is not tested.
  79535. * It's also less accurate than the standard because some not visible objects can still be selected.
  79536. * Test : is the bounding sphere outside the frustum ?
  79537. * If not, then the cullable object is in the frustum.
  79538. */
  79539. static readonly MESHES_CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY: number;
  79540. /** Culling strategy : Optimistic Inclusion.
  79541. * This in an inclusion test first, then the standard exclusion test.
  79542. * This can be faster when a cullable object is expected to be almost always in the camera frustum.
  79543. * 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.
  79544. * Anyway, it's as accurate as the standard strategy.
  79545. * Test :
  79546. * Is the cullable object bounding sphere center in the frustum ?
  79547. * If not, apply the default culling strategy.
  79548. */
  79549. static readonly MESHES_CULLINGSTRATEGY_OPTIMISTIC_INCLUSION: number;
  79550. /** Culling strategy : Optimistic Inclusion then Bounding Sphere Only.
  79551. * This in an inclusion test first, then the bounding sphere only exclusion test.
  79552. * This can be the fastest test when a cullable object is expected to be almost always in the camera frustum.
  79553. * 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.
  79554. * It's less accurate than the standard strategy and as accurate as the BoundingSphereOnly strategy.
  79555. * Test :
  79556. * Is the cullable object bounding sphere center in the frustum ?
  79557. * If not, apply the Bounding Sphere Only strategy. No Bounding Box is tested here.
  79558. */
  79559. static readonly MESHES_CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY: number;
  79560. /**
  79561. * No logging while loading
  79562. */
  79563. static readonly SCENELOADER_NO_LOGGING: number;
  79564. /**
  79565. * Minimal logging while loading
  79566. */
  79567. static readonly SCENELOADER_MINIMAL_LOGGING: number;
  79568. /**
  79569. * Summary logging while loading
  79570. */
  79571. static readonly SCENELOADER_SUMMARY_LOGGING: number;
  79572. /**
  79573. * Detailled logging while loading
  79574. */
  79575. static readonly SCENELOADER_DETAILED_LOGGING: number;
  79576. /**
  79577. * Prepass texture index for color
  79578. */
  79579. static readonly PREPASS_COLOR_INDEX: number;
  79580. /**
  79581. * Prepass texture index for irradiance
  79582. */
  79583. static readonly PREPASS_IRRADIANCE_INDEX: number;
  79584. /**
  79585. * Prepass texture index for depth + normal
  79586. */
  79587. static readonly PREPASS_DEPTHNORMAL_INDEX: number;
  79588. /**
  79589. * Prepass texture index for albedo
  79590. */
  79591. static readonly PREPASS_ALBEDO_INDEX: number;
  79592. }
  79593. }
  79594. declare module BABYLON {
  79595. /**
  79596. * This represents the required contract to create a new type of texture loader.
  79597. */
  79598. export interface IInternalTextureLoader {
  79599. /**
  79600. * Defines wether the loader supports cascade loading the different faces.
  79601. */
  79602. supportCascades: boolean;
  79603. /**
  79604. * This returns if the loader support the current file information.
  79605. * @param extension defines the file extension of the file being loaded
  79606. * @param mimeType defines the optional mime type of the file being loaded
  79607. * @returns true if the loader can load the specified file
  79608. */
  79609. canLoad(extension: string, mimeType?: string): boolean;
  79610. /**
  79611. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  79612. * @param data contains the texture data
  79613. * @param texture defines the BabylonJS internal texture
  79614. * @param createPolynomials will be true if polynomials have been requested
  79615. * @param onLoad defines the callback to trigger once the texture is ready
  79616. * @param onError defines the callback to trigger in case of error
  79617. */
  79618. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  79619. /**
  79620. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  79621. * @param data contains the texture data
  79622. * @param texture defines the BabylonJS internal texture
  79623. * @param callback defines the method to call once ready to upload
  79624. */
  79625. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void, loadFailed?: boolean) => void): void;
  79626. }
  79627. }
  79628. declare module BABYLON {
  79629. /**
  79630. * Class used to store and describe the pipeline context associated with an effect
  79631. */
  79632. export interface IPipelineContext {
  79633. /**
  79634. * Gets a boolean indicating that this pipeline context is supporting asynchronous creating
  79635. */
  79636. isAsync: boolean;
  79637. /**
  79638. * Gets a boolean indicating that the context is ready to be used (like shaders / pipelines are compiled and ready for instance)
  79639. */
  79640. isReady: boolean;
  79641. /** @hidden */
  79642. _getVertexShaderCode(): string | null;
  79643. /** @hidden */
  79644. _getFragmentShaderCode(): string | null;
  79645. /** @hidden */
  79646. _handlesSpectorRebuildCallback(onCompiled: (compiledObject: any) => void): void;
  79647. }
  79648. }
  79649. declare module BABYLON {
  79650. /**
  79651. * Class used to store gfx data (like WebGLBuffer)
  79652. */
  79653. export class DataBuffer {
  79654. /**
  79655. * Gets or sets the number of objects referencing this buffer
  79656. */
  79657. references: number;
  79658. /** Gets or sets the size of the underlying buffer */
  79659. capacity: number;
  79660. /**
  79661. * Gets or sets a boolean indicating if the buffer contains 32bits indices
  79662. */
  79663. is32Bits: boolean;
  79664. /**
  79665. * Gets the underlying buffer
  79666. */
  79667. get underlyingResource(): any;
  79668. }
  79669. }
  79670. declare module BABYLON {
  79671. /** @hidden */
  79672. export interface IShaderProcessor {
  79673. attributeProcessor?: (attribute: string) => string;
  79674. varyingProcessor?: (varying: string, isFragment: boolean) => string;
  79675. uniformProcessor?: (uniform: string, isFragment: boolean) => string;
  79676. uniformBufferProcessor?: (uniformBuffer: string, isFragment: boolean) => string;
  79677. endOfUniformBufferProcessor?: (closingBracketLine: string, isFragment: boolean) => string;
  79678. lineProcessor?: (line: string, isFragment: boolean) => string;
  79679. preProcessor?: (code: string, defines: string[], isFragment: boolean) => string;
  79680. postProcessor?: (code: string, defines: string[], isFragment: boolean) => string;
  79681. }
  79682. }
  79683. declare module BABYLON {
  79684. /** @hidden */
  79685. export interface ProcessingOptions {
  79686. defines: string[];
  79687. indexParameters: any;
  79688. isFragment: boolean;
  79689. shouldUseHighPrecisionShader: boolean;
  79690. supportsUniformBuffers: boolean;
  79691. shadersRepository: string;
  79692. includesShadersStore: {
  79693. [key: string]: string;
  79694. };
  79695. processor?: IShaderProcessor;
  79696. version: string;
  79697. platformName: string;
  79698. lookForClosingBracketForUniformBuffer?: boolean;
  79699. }
  79700. }
  79701. declare module BABYLON {
  79702. /** @hidden */
  79703. export class ShaderCodeNode {
  79704. line: string;
  79705. children: ShaderCodeNode[];
  79706. additionalDefineKey?: string;
  79707. additionalDefineValue?: string;
  79708. isValid(preprocessors: {
  79709. [key: string]: string;
  79710. }): boolean;
  79711. process(preprocessors: {
  79712. [key: string]: string;
  79713. }, options: ProcessingOptions): string;
  79714. }
  79715. }
  79716. declare module BABYLON {
  79717. /** @hidden */
  79718. export class ShaderCodeCursor {
  79719. private _lines;
  79720. lineIndex: number;
  79721. get currentLine(): string;
  79722. get canRead(): boolean;
  79723. set lines(value: string[]);
  79724. }
  79725. }
  79726. declare module BABYLON {
  79727. /** @hidden */
  79728. export class ShaderCodeConditionNode extends ShaderCodeNode {
  79729. process(preprocessors: {
  79730. [key: string]: string;
  79731. }, options: ProcessingOptions): string;
  79732. }
  79733. }
  79734. declare module BABYLON {
  79735. /** @hidden */
  79736. export class ShaderDefineExpression {
  79737. isTrue(preprocessors: {
  79738. [key: string]: string;
  79739. }): boolean;
  79740. private static _OperatorPriority;
  79741. private static _Stack;
  79742. static postfixToInfix(postfix: string[]): string;
  79743. static infixToPostfix(infix: string): string[];
  79744. }
  79745. }
  79746. declare module BABYLON {
  79747. /** @hidden */
  79748. export class ShaderCodeTestNode extends ShaderCodeNode {
  79749. testExpression: ShaderDefineExpression;
  79750. isValid(preprocessors: {
  79751. [key: string]: string;
  79752. }): boolean;
  79753. }
  79754. }
  79755. declare module BABYLON {
  79756. /** @hidden */
  79757. export class ShaderDefineIsDefinedOperator extends ShaderDefineExpression {
  79758. define: string;
  79759. not: boolean;
  79760. constructor(define: string, not?: boolean);
  79761. isTrue(preprocessors: {
  79762. [key: string]: string;
  79763. }): boolean;
  79764. }
  79765. }
  79766. declare module BABYLON {
  79767. /** @hidden */
  79768. export class ShaderDefineOrOperator extends ShaderDefineExpression {
  79769. leftOperand: ShaderDefineExpression;
  79770. rightOperand: ShaderDefineExpression;
  79771. isTrue(preprocessors: {
  79772. [key: string]: string;
  79773. }): boolean;
  79774. }
  79775. }
  79776. declare module BABYLON {
  79777. /** @hidden */
  79778. export class ShaderDefineAndOperator extends ShaderDefineExpression {
  79779. leftOperand: ShaderDefineExpression;
  79780. rightOperand: ShaderDefineExpression;
  79781. isTrue(preprocessors: {
  79782. [key: string]: string;
  79783. }): boolean;
  79784. }
  79785. }
  79786. declare module BABYLON {
  79787. /** @hidden */
  79788. export class ShaderDefineArithmeticOperator extends ShaderDefineExpression {
  79789. define: string;
  79790. operand: string;
  79791. testValue: string;
  79792. constructor(define: string, operand: string, testValue: string);
  79793. isTrue(preprocessors: {
  79794. [key: string]: string;
  79795. }): boolean;
  79796. }
  79797. }
  79798. declare module BABYLON {
  79799. /**
  79800. * Class used to enable access to offline support
  79801. * @see https://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  79802. */
  79803. export interface IOfflineProvider {
  79804. /**
  79805. * Gets a boolean indicating if scene must be saved in the database
  79806. */
  79807. enableSceneOffline: boolean;
  79808. /**
  79809. * Gets a boolean indicating if textures must be saved in the database
  79810. */
  79811. enableTexturesOffline: boolean;
  79812. /**
  79813. * Open the offline support and make it available
  79814. * @param successCallback defines the callback to call on success
  79815. * @param errorCallback defines the callback to call on error
  79816. */
  79817. open(successCallback: () => void, errorCallback: () => void): void;
  79818. /**
  79819. * Loads an image from the offline support
  79820. * @param url defines the url to load from
  79821. * @param image defines the target DOM image
  79822. */
  79823. loadImage(url: string, image: HTMLImageElement): void;
  79824. /**
  79825. * Loads a file from offline support
  79826. * @param url defines the URL to load from
  79827. * @param sceneLoaded defines a callback to call on success
  79828. * @param progressCallBack defines a callback to call when progress changed
  79829. * @param errorCallback defines a callback to call on error
  79830. * @param useArrayBuffer defines a boolean to use array buffer instead of text string
  79831. */
  79832. loadFile(url: string, sceneLoaded: (data: any) => void, progressCallBack?: (data: any) => void, errorCallback?: () => void, useArrayBuffer?: boolean): void;
  79833. }
  79834. }
  79835. declare module BABYLON {
  79836. /**
  79837. * Class used to help managing file picking and drag'n'drop
  79838. * File Storage
  79839. */
  79840. export class FilesInputStore {
  79841. /**
  79842. * List of files ready to be loaded
  79843. */
  79844. static FilesToLoad: {
  79845. [key: string]: File;
  79846. };
  79847. }
  79848. }
  79849. declare module BABYLON {
  79850. /**
  79851. * Class used to define a retry strategy when error happens while loading assets
  79852. */
  79853. export class RetryStrategy {
  79854. /**
  79855. * Function used to defines an exponential back off strategy
  79856. * @param maxRetries defines the maximum number of retries (3 by default)
  79857. * @param baseInterval defines the interval between retries
  79858. * @returns the strategy function to use
  79859. */
  79860. static ExponentialBackoff(maxRetries?: number, baseInterval?: number): (url: string, request: WebRequest, retryIndex: number) => number;
  79861. }
  79862. }
  79863. declare module BABYLON {
  79864. /**
  79865. * @ignore
  79866. * Application error to support additional information when loading a file
  79867. */
  79868. export abstract class BaseError extends Error {
  79869. protected static _setPrototypeOf: (o: any, proto: object | null) => any;
  79870. }
  79871. }
  79872. declare module BABYLON {
  79873. /** @ignore */
  79874. export class LoadFileError extends BaseError {
  79875. request?: WebRequest;
  79876. file?: File;
  79877. /**
  79878. * Creates a new LoadFileError
  79879. * @param message defines the message of the error
  79880. * @param request defines the optional web request
  79881. * @param file defines the optional file
  79882. */
  79883. constructor(message: string, object?: WebRequest | File);
  79884. }
  79885. /** @ignore */
  79886. export class RequestFileError extends BaseError {
  79887. request: WebRequest;
  79888. /**
  79889. * Creates a new LoadFileError
  79890. * @param message defines the message of the error
  79891. * @param request defines the optional web request
  79892. */
  79893. constructor(message: string, request: WebRequest);
  79894. }
  79895. /** @ignore */
  79896. export class ReadFileError extends BaseError {
  79897. file: File;
  79898. /**
  79899. * Creates a new ReadFileError
  79900. * @param message defines the message of the error
  79901. * @param file defines the optional file
  79902. */
  79903. constructor(message: string, file: File);
  79904. }
  79905. /**
  79906. * @hidden
  79907. */
  79908. export class FileTools {
  79909. /**
  79910. * Gets or sets the retry strategy to apply when an error happens while loading an asset
  79911. */
  79912. static DefaultRetryStrategy: (url: string, request: WebRequest, retryIndex: number) => number;
  79913. /**
  79914. * Gets or sets the base URL to use to load assets
  79915. */
  79916. static BaseUrl: string;
  79917. /**
  79918. * Default behaviour for cors in the application.
  79919. * It can be a string if the expected behavior is identical in the entire app.
  79920. * Or a callback to be able to set it per url or on a group of them (in case of Video source for instance)
  79921. */
  79922. static CorsBehavior: string | ((url: string | string[]) => string);
  79923. /**
  79924. * Gets or sets a function used to pre-process url before using them to load assets
  79925. */
  79926. static PreprocessUrl: (url: string) => string;
  79927. /**
  79928. * Removes unwanted characters from an url
  79929. * @param url defines the url to clean
  79930. * @returns the cleaned url
  79931. */
  79932. private static _CleanUrl;
  79933. /**
  79934. * Sets the cors behavior on a dom element. This will add the required Tools.CorsBehavior to the element.
  79935. * @param url define the url we are trying
  79936. * @param element define the dom element where to configure the cors policy
  79937. */
  79938. static SetCorsBehavior(url: string | string[], element: {
  79939. crossOrigin: string | null;
  79940. }): void;
  79941. /**
  79942. * Loads an image as an HTMLImageElement.
  79943. * @param input url string, ArrayBuffer, or Blob to load
  79944. * @param onLoad callback called when the image successfully loads
  79945. * @param onError callback called when the image fails to load
  79946. * @param offlineProvider offline provider for caching
  79947. * @param mimeType optional mime type
  79948. * @returns the HTMLImageElement of the loaded image
  79949. */
  79950. 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>;
  79951. /**
  79952. * Reads a file from a File object
  79953. * @param file defines the file to load
  79954. * @param onSuccess defines the callback to call when data is loaded
  79955. * @param onProgress defines the callback to call during loading process
  79956. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  79957. * @param onError defines the callback to call when an error occurs
  79958. * @returns a file request object
  79959. */
  79960. static ReadFile(file: File, onSuccess: (data: any) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  79961. /**
  79962. * Loads a file from a url
  79963. * @param url url to load
  79964. * @param onSuccess callback called when the file successfully loads
  79965. * @param onProgress callback called while file is loading (if the server supports this mode)
  79966. * @param offlineProvider defines the offline provider for caching
  79967. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  79968. * @param onError callback called when the file fails to load
  79969. * @returns a file request object
  79970. */
  79971. 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;
  79972. /**
  79973. * Loads a file
  79974. * @param url url to load
  79975. * @param onSuccess callback called when the file successfully loads
  79976. * @param onProgress callback called while file is loading (if the server supports this mode)
  79977. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  79978. * @param onError callback called when the file fails to load
  79979. * @param onOpened callback called when the web request is opened
  79980. * @returns a file request object
  79981. */
  79982. 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;
  79983. /**
  79984. * Checks if the loaded document was accessed via `file:`-Protocol.
  79985. * @returns boolean
  79986. */
  79987. static IsFileURL(): boolean;
  79988. }
  79989. }
  79990. declare module BABYLON {
  79991. /** @hidden */
  79992. export class ShaderProcessor {
  79993. static Process(sourceCode: string, options: ProcessingOptions, callback: (migratedCode: string) => void): void;
  79994. private static _ProcessPrecision;
  79995. private static _ExtractOperation;
  79996. private static _BuildSubExpression;
  79997. private static _BuildExpression;
  79998. private static _MoveCursorWithinIf;
  79999. private static _MoveCursor;
  80000. private static _EvaluatePreProcessors;
  80001. private static _PreparePreProcessors;
  80002. private static _ProcessShaderConversion;
  80003. private static _ProcessIncludes;
  80004. /**
  80005. * Loads a file from a url
  80006. * @param url url to load
  80007. * @param onSuccess callback called when the file successfully loads
  80008. * @param onProgress callback called while file is loading (if the server supports this mode)
  80009. * @param offlineProvider defines the offline provider for caching
  80010. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  80011. * @param onError callback called when the file fails to load
  80012. * @returns a file request object
  80013. * @hidden
  80014. */
  80015. 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;
  80016. }
  80017. }
  80018. declare module BABYLON {
  80019. /**
  80020. * @hidden
  80021. */
  80022. export interface IColor4Like {
  80023. r: float;
  80024. g: float;
  80025. b: float;
  80026. a: float;
  80027. }
  80028. /**
  80029. * @hidden
  80030. */
  80031. export interface IColor3Like {
  80032. r: float;
  80033. g: float;
  80034. b: float;
  80035. }
  80036. /**
  80037. * @hidden
  80038. */
  80039. export interface IVector4Like {
  80040. x: float;
  80041. y: float;
  80042. z: float;
  80043. w: float;
  80044. }
  80045. /**
  80046. * @hidden
  80047. */
  80048. export interface IVector3Like {
  80049. x: float;
  80050. y: float;
  80051. z: float;
  80052. }
  80053. /**
  80054. * @hidden
  80055. */
  80056. export interface IVector2Like {
  80057. x: float;
  80058. y: float;
  80059. }
  80060. /**
  80061. * @hidden
  80062. */
  80063. export interface IMatrixLike {
  80064. toArray(): DeepImmutable<Float32Array | Array<number>>;
  80065. updateFlag: int;
  80066. }
  80067. /**
  80068. * @hidden
  80069. */
  80070. export interface IViewportLike {
  80071. x: float;
  80072. y: float;
  80073. width: float;
  80074. height: float;
  80075. }
  80076. /**
  80077. * @hidden
  80078. */
  80079. export interface IPlaneLike {
  80080. normal: IVector3Like;
  80081. d: float;
  80082. normalize(): void;
  80083. }
  80084. }
  80085. declare module BABYLON {
  80086. /**
  80087. * Interface used to define common properties for effect fallbacks
  80088. */
  80089. export interface IEffectFallbacks {
  80090. /**
  80091. * Removes the defines that should be removed when falling back.
  80092. * @param currentDefines defines the current define statements for the shader.
  80093. * @param effect defines the current effect we try to compile
  80094. * @returns The resulting defines with defines of the current rank removed.
  80095. */
  80096. reduce(currentDefines: string, effect: Effect): string;
  80097. /**
  80098. * Removes the fallback from the bound mesh.
  80099. */
  80100. unBindMesh(): void;
  80101. /**
  80102. * Checks to see if more fallbacks are still availible.
  80103. */
  80104. hasMoreFallbacks: boolean;
  80105. }
  80106. }
  80107. declare module BABYLON {
  80108. /**
  80109. * Class used to evalaute queries containing `and` and `or` operators
  80110. */
  80111. export class AndOrNotEvaluator {
  80112. /**
  80113. * Evaluate a query
  80114. * @param query defines the query to evaluate
  80115. * @param evaluateCallback defines the callback used to filter result
  80116. * @returns true if the query matches
  80117. */
  80118. static Eval(query: string, evaluateCallback: (val: any) => boolean): boolean;
  80119. private static _HandleParenthesisContent;
  80120. private static _SimplifyNegation;
  80121. }
  80122. }
  80123. declare module BABYLON {
  80124. /**
  80125. * Class used to store custom tags
  80126. */
  80127. export class Tags {
  80128. /**
  80129. * Adds support for tags on the given object
  80130. * @param obj defines the object to use
  80131. */
  80132. static EnableFor(obj: any): void;
  80133. /**
  80134. * Removes tags support
  80135. * @param obj defines the object to use
  80136. */
  80137. static DisableFor(obj: any): void;
  80138. /**
  80139. * Gets a boolean indicating if the given object has tags
  80140. * @param obj defines the object to use
  80141. * @returns a boolean
  80142. */
  80143. static HasTags(obj: any): boolean;
  80144. /**
  80145. * Gets the tags available on a given object
  80146. * @param obj defines the object to use
  80147. * @param asString defines if the tags must be returned as a string instead of an array of strings
  80148. * @returns the tags
  80149. */
  80150. static GetTags(obj: any, asString?: boolean): any;
  80151. /**
  80152. * Adds tags to an object
  80153. * @param obj defines the object to use
  80154. * @param tagsString defines the tag string. The tags 'true' and 'false' are reserved and cannot be used as tags.
  80155. * A tag cannot start with '||', '&&', and '!'. It cannot contain whitespaces
  80156. */
  80157. static AddTagsTo(obj: any, tagsString: string): void;
  80158. /**
  80159. * @hidden
  80160. */
  80161. static _AddTagTo(obj: any, tag: string): void;
  80162. /**
  80163. * Removes specific tags from a specific object
  80164. * @param obj defines the object to use
  80165. * @param tagsString defines the tags to remove
  80166. */
  80167. static RemoveTagsFrom(obj: any, tagsString: string): void;
  80168. /**
  80169. * @hidden
  80170. */
  80171. static _RemoveTagFrom(obj: any, tag: string): void;
  80172. /**
  80173. * Defines if tags hosted on an object match a given query
  80174. * @param obj defines the object to use
  80175. * @param tagsQuery defines the tag query
  80176. * @returns a boolean
  80177. */
  80178. static MatchesQuery(obj: any, tagsQuery: string): boolean;
  80179. }
  80180. }
  80181. declare module BABYLON {
  80182. /**
  80183. * Scalar computation library
  80184. */
  80185. export class Scalar {
  80186. /**
  80187. * Two pi constants convenient for computation.
  80188. */
  80189. static TwoPi: number;
  80190. /**
  80191. * Boolean : true if the absolute difference between a and b is lower than epsilon (default = 1.401298E-45)
  80192. * @param a number
  80193. * @param b number
  80194. * @param epsilon (default = 1.401298E-45)
  80195. * @returns true if the absolute difference between a and b is lower than epsilon (default = 1.401298E-45)
  80196. */
  80197. static WithinEpsilon(a: number, b: number, epsilon?: number): boolean;
  80198. /**
  80199. * Returns a string : the upper case translation of the number i to hexadecimal.
  80200. * @param i number
  80201. * @returns the upper case translation of the number i to hexadecimal.
  80202. */
  80203. static ToHex(i: number): string;
  80204. /**
  80205. * Returns -1 if value is negative and +1 is value is positive.
  80206. * @param value the value
  80207. * @returns the value itself if it's equal to zero.
  80208. */
  80209. static Sign(value: number): number;
  80210. /**
  80211. * Returns the value itself if it's between min and max.
  80212. * Returns min if the value is lower than min.
  80213. * Returns max if the value is greater than max.
  80214. * @param value the value to clmap
  80215. * @param min the min value to clamp to (default: 0)
  80216. * @param max the max value to clamp to (default: 1)
  80217. * @returns the clamped value
  80218. */
  80219. static Clamp(value: number, min?: number, max?: number): number;
  80220. /**
  80221. * the log2 of value.
  80222. * @param value the value to compute log2 of
  80223. * @returns the log2 of value.
  80224. */
  80225. static Log2(value: number): number;
  80226. /**
  80227. * Loops the value, so that it is never larger than length and never smaller than 0.
  80228. *
  80229. * This is similar to the modulo operator but it works with floating point numbers.
  80230. * For example, using 3.0 for t and 2.5 for length, the result would be 0.5.
  80231. * With t = 5 and length = 2.5, the result would be 0.0.
  80232. * Note, however, that the behaviour is not defined for negative numbers as it is for the modulo operator
  80233. * @param value the value
  80234. * @param length the length
  80235. * @returns the looped value
  80236. */
  80237. static Repeat(value: number, length: number): number;
  80238. /**
  80239. * Normalize the value between 0.0 and 1.0 using min and max values
  80240. * @param value value to normalize
  80241. * @param min max to normalize between
  80242. * @param max min to normalize between
  80243. * @returns the normalized value
  80244. */
  80245. static Normalize(value: number, min: number, max: number): number;
  80246. /**
  80247. * Denormalize the value from 0.0 and 1.0 using min and max values
  80248. * @param normalized value to denormalize
  80249. * @param min max to denormalize between
  80250. * @param max min to denormalize between
  80251. * @returns the denormalized value
  80252. */
  80253. static Denormalize(normalized: number, min: number, max: number): number;
  80254. /**
  80255. * Calculates the shortest difference between two given angles given in degrees.
  80256. * @param current current angle in degrees
  80257. * @param target target angle in degrees
  80258. * @returns the delta
  80259. */
  80260. static DeltaAngle(current: number, target: number): number;
  80261. /**
  80262. * PingPongs the value t, so that it is never larger than length and never smaller than 0.
  80263. * @param tx value
  80264. * @param length length
  80265. * @returns The returned value will move back and forth between 0 and length
  80266. */
  80267. static PingPong(tx: number, length: number): number;
  80268. /**
  80269. * Interpolates between min and max with smoothing at the limits.
  80270. *
  80271. * This function interpolates between min and max in a similar way to Lerp. However, the interpolation will gradually speed up
  80272. * from the start and slow down toward the end. This is useful for creating natural-looking animation, fading and other transitions.
  80273. * @param from from
  80274. * @param to to
  80275. * @param tx value
  80276. * @returns the smooth stepped value
  80277. */
  80278. static SmoothStep(from: number, to: number, tx: number): number;
  80279. /**
  80280. * Moves a value current towards target.
  80281. *
  80282. * This is essentially the same as Mathf.Lerp but instead the function will ensure that the speed never exceeds maxDelta.
  80283. * Negative values of maxDelta pushes the value away from target.
  80284. * @param current current value
  80285. * @param target target value
  80286. * @param maxDelta max distance to move
  80287. * @returns resulting value
  80288. */
  80289. static MoveTowards(current: number, target: number, maxDelta: number): number;
  80290. /**
  80291. * Same as MoveTowards but makes sure the values interpolate correctly when they wrap around 360 degrees.
  80292. *
  80293. * Variables current and target are assumed to be in degrees. For optimization reasons, negative values of maxDelta
  80294. * are not supported and may cause oscillation. To push current away from a target angle, add 180 to that angle instead.
  80295. * @param current current value
  80296. * @param target target value
  80297. * @param maxDelta max distance to move
  80298. * @returns resulting angle
  80299. */
  80300. static MoveTowardsAngle(current: number, target: number, maxDelta: number): number;
  80301. /**
  80302. * Creates a new scalar with values linearly interpolated of "amount" between the start scalar and the end scalar.
  80303. * @param start start value
  80304. * @param end target value
  80305. * @param amount amount to lerp between
  80306. * @returns the lerped value
  80307. */
  80308. static Lerp(start: number, end: number, amount: number): number;
  80309. /**
  80310. * Same as Lerp but makes sure the values interpolate correctly when they wrap around 360 degrees.
  80311. * The parameter t is clamped to the range [0, 1]. Variables a and b are assumed to be in degrees.
  80312. * @param start start value
  80313. * @param end target value
  80314. * @param amount amount to lerp between
  80315. * @returns the lerped value
  80316. */
  80317. static LerpAngle(start: number, end: number, amount: number): number;
  80318. /**
  80319. * Calculates the linear parameter t that produces the interpolant value within the range [a, b].
  80320. * @param a start value
  80321. * @param b target value
  80322. * @param value value between a and b
  80323. * @returns the inverseLerp value
  80324. */
  80325. static InverseLerp(a: number, b: number, value: number): number;
  80326. /**
  80327. * Returns a new scalar located for "amount" (float) on the Hermite spline defined by the scalars "value1", "value3", "tangent1", "tangent2".
  80328. * @see http://mathworld.wolfram.com/HermitePolynomial.html
  80329. * @param value1 spline value
  80330. * @param tangent1 spline value
  80331. * @param value2 spline value
  80332. * @param tangent2 spline value
  80333. * @param amount input value
  80334. * @returns hermite result
  80335. */
  80336. static Hermite(value1: number, tangent1: number, value2: number, tangent2: number, amount: number): number;
  80337. /**
  80338. * Returns a random float number between and min and max values
  80339. * @param min min value of random
  80340. * @param max max value of random
  80341. * @returns random value
  80342. */
  80343. static RandomRange(min: number, max: number): number;
  80344. /**
  80345. * This function returns percentage of a number in a given range.
  80346. *
  80347. * RangeToPercent(40,20,60) will return 0.5 (50%)
  80348. * RangeToPercent(34,0,100) will return 0.34 (34%)
  80349. * @param number to convert to percentage
  80350. * @param min min range
  80351. * @param max max range
  80352. * @returns the percentage
  80353. */
  80354. static RangeToPercent(number: number, min: number, max: number): number;
  80355. /**
  80356. * This function returns number that corresponds to the percentage in a given range.
  80357. *
  80358. * PercentToRange(0.34,0,100) will return 34.
  80359. * @param percent to convert to number
  80360. * @param min min range
  80361. * @param max max range
  80362. * @returns the number
  80363. */
  80364. static PercentToRange(percent: number, min: number, max: number): number;
  80365. /**
  80366. * Returns the angle converted to equivalent value between -Math.PI and Math.PI radians.
  80367. * @param angle The angle to normalize in radian.
  80368. * @return The converted angle.
  80369. */
  80370. static NormalizeRadians(angle: number): number;
  80371. }
  80372. }
  80373. declare module BABYLON {
  80374. /**
  80375. * Constant used to convert a value to gamma space
  80376. * @ignorenaming
  80377. */
  80378. export const ToGammaSpace: number;
  80379. /**
  80380. * Constant used to convert a value to linear space
  80381. * @ignorenaming
  80382. */
  80383. export const ToLinearSpace = 2.2;
  80384. /**
  80385. * Constant used to define the minimal number value in Babylon.js
  80386. * @ignorenaming
  80387. */
  80388. let Epsilon: number;
  80389. }
  80390. declare module BABYLON {
  80391. /**
  80392. * Class used to represent a viewport on screen
  80393. */
  80394. export class Viewport {
  80395. /** viewport left coordinate */
  80396. x: number;
  80397. /** viewport top coordinate */
  80398. y: number;
  80399. /**viewport width */
  80400. width: number;
  80401. /** viewport height */
  80402. height: number;
  80403. /**
  80404. * Creates a Viewport object located at (x, y) and sized (width, height)
  80405. * @param x defines viewport left coordinate
  80406. * @param y defines viewport top coordinate
  80407. * @param width defines the viewport width
  80408. * @param height defines the viewport height
  80409. */
  80410. constructor(
  80411. /** viewport left coordinate */
  80412. x: number,
  80413. /** viewport top coordinate */
  80414. y: number,
  80415. /**viewport width */
  80416. width: number,
  80417. /** viewport height */
  80418. height: number);
  80419. /**
  80420. * Creates a new viewport using absolute sizing (from 0-> width, 0-> height instead of 0->1)
  80421. * @param renderWidth defines the rendering width
  80422. * @param renderHeight defines the rendering height
  80423. * @returns a new Viewport
  80424. */
  80425. toGlobal(renderWidth: number, renderHeight: number): Viewport;
  80426. /**
  80427. * Stores absolute viewport value into a target viewport (from 0-> width, 0-> height instead of 0->1)
  80428. * @param renderWidth defines the rendering width
  80429. * @param renderHeight defines the rendering height
  80430. * @param ref defines the target viewport
  80431. * @returns the current viewport
  80432. */
  80433. toGlobalToRef(renderWidth: number, renderHeight: number, ref: Viewport): Viewport;
  80434. /**
  80435. * Returns a new Viewport copied from the current one
  80436. * @returns a new Viewport
  80437. */
  80438. clone(): Viewport;
  80439. }
  80440. }
  80441. declare module BABYLON {
  80442. /**
  80443. * Class containing a set of static utilities functions for arrays.
  80444. */
  80445. export class ArrayTools {
  80446. /**
  80447. * Returns an array of the given size filled with element built from the given constructor and the paramters
  80448. * @param size the number of element to construct and put in the array
  80449. * @param itemBuilder a callback responsible for creating new instance of item. Called once per array entry.
  80450. * @returns a new array filled with new objects
  80451. */
  80452. static BuildArray<T>(size: number, itemBuilder: () => T): Array<T>;
  80453. }
  80454. }
  80455. declare module BABYLON {
  80456. /**
  80457. * Represents a plane by the equation ax + by + cz + d = 0
  80458. */
  80459. export class Plane {
  80460. private static _TmpMatrix;
  80461. /**
  80462. * Normal of the plane (a,b,c)
  80463. */
  80464. normal: Vector3;
  80465. /**
  80466. * d component of the plane
  80467. */
  80468. d: number;
  80469. /**
  80470. * Creates a Plane object according to the given floats a, b, c, d and the plane equation : ax + by + cz + d = 0
  80471. * @param a a component of the plane
  80472. * @param b b component of the plane
  80473. * @param c c component of the plane
  80474. * @param d d component of the plane
  80475. */
  80476. constructor(a: number, b: number, c: number, d: number);
  80477. /**
  80478. * @returns the plane coordinates as a new array of 4 elements [a, b, c, d].
  80479. */
  80480. asArray(): number[];
  80481. /**
  80482. * @returns a new plane copied from the current Plane.
  80483. */
  80484. clone(): Plane;
  80485. /**
  80486. * @returns the string "Plane".
  80487. */
  80488. getClassName(): string;
  80489. /**
  80490. * @returns the Plane hash code.
  80491. */
  80492. getHashCode(): number;
  80493. /**
  80494. * Normalize the current Plane in place.
  80495. * @returns the updated Plane.
  80496. */
  80497. normalize(): Plane;
  80498. /**
  80499. * Applies a transformation the plane and returns the result
  80500. * @param transformation the transformation matrix to be applied to the plane
  80501. * @returns a new Plane as the result of the transformation of the current Plane by the given matrix.
  80502. */
  80503. transform(transformation: DeepImmutable<Matrix>): Plane;
  80504. /**
  80505. * Compute the dot product between the point and the plane normal
  80506. * @param point point to calculate the dot product with
  80507. * @returns the dot product (float) of the point coordinates and the plane normal.
  80508. */
  80509. dotCoordinate(point: DeepImmutable<Vector3>): number;
  80510. /**
  80511. * Updates the current Plane from the plane defined by the three given points.
  80512. * @param point1 one of the points used to contruct the plane
  80513. * @param point2 one of the points used to contruct the plane
  80514. * @param point3 one of the points used to contruct the plane
  80515. * @returns the updated Plane.
  80516. */
  80517. copyFromPoints(point1: DeepImmutable<Vector3>, point2: DeepImmutable<Vector3>, point3: DeepImmutable<Vector3>): Plane;
  80518. /**
  80519. * Checks if the plane is facing a given direction
  80520. * @param direction the direction to check if the plane is facing
  80521. * @param epsilon value the dot product is compared against (returns true if dot <= epsilon)
  80522. * @returns True is the vector "direction" is the same side than the plane normal.
  80523. */
  80524. isFrontFacingTo(direction: DeepImmutable<Vector3>, epsilon: number): boolean;
  80525. /**
  80526. * Calculates the distance to a point
  80527. * @param point point to calculate distance to
  80528. * @returns the signed distance (float) from the given point to the Plane.
  80529. */
  80530. signedDistanceTo(point: DeepImmutable<Vector3>): number;
  80531. /**
  80532. * Creates a plane from an array
  80533. * @param array the array to create a plane from
  80534. * @returns a new Plane from the given array.
  80535. */
  80536. static FromArray(array: DeepImmutable<ArrayLike<number>>): Plane;
  80537. /**
  80538. * Creates a plane from three points
  80539. * @param point1 point used to create the plane
  80540. * @param point2 point used to create the plane
  80541. * @param point3 point used to create the plane
  80542. * @returns a new Plane defined by the three given points.
  80543. */
  80544. static FromPoints(point1: DeepImmutable<Vector3>, point2: DeepImmutable<Vector3>, point3: DeepImmutable<Vector3>): Plane;
  80545. /**
  80546. * Creates a plane from an origin point and a normal
  80547. * @param origin origin of the plane to be constructed
  80548. * @param normal normal of the plane to be constructed
  80549. * @returns a new Plane the normal vector to this plane at the given origin point.
  80550. * Note : the vector "normal" is updated because normalized.
  80551. */
  80552. static FromPositionAndNormal(origin: DeepImmutable<Vector3>, normal: Vector3): Plane;
  80553. /**
  80554. * Calculates the distance from a plane and a point
  80555. * @param origin origin of the plane to be constructed
  80556. * @param normal normal of the plane to be constructed
  80557. * @param point point to calculate distance to
  80558. * @returns the signed distance between the plane defined by the normal vector at the "origin"" point and the given other point.
  80559. */
  80560. static SignedDistanceToPlaneFromPositionAndNormal(origin: DeepImmutable<Vector3>, normal: DeepImmutable<Vector3>, point: DeepImmutable<Vector3>): number;
  80561. }
  80562. }
  80563. declare module BABYLON {
  80564. /** @hidden */
  80565. export class PerformanceConfigurator {
  80566. /** @hidden */
  80567. static MatrixUse64Bits: boolean;
  80568. /** @hidden */
  80569. static MatrixTrackPrecisionChange: boolean;
  80570. /** @hidden */
  80571. static MatrixCurrentType: any;
  80572. /** @hidden */
  80573. static MatrixTrackedMatrices: Array<any> | null;
  80574. /** @hidden */
  80575. static SetMatrixPrecision(use64bits: boolean): void;
  80576. }
  80577. }
  80578. declare module BABYLON {
  80579. /**
  80580. * Class representing a vector containing 2 coordinates
  80581. */
  80582. export class Vector2 {
  80583. /** defines the first coordinate */
  80584. x: number;
  80585. /** defines the second coordinate */
  80586. y: number;
  80587. /**
  80588. * Creates a new Vector2 from the given x and y coordinates
  80589. * @param x defines the first coordinate
  80590. * @param y defines the second coordinate
  80591. */
  80592. constructor(
  80593. /** defines the first coordinate */
  80594. x?: number,
  80595. /** defines the second coordinate */
  80596. y?: number);
  80597. /**
  80598. * Gets a string with the Vector2 coordinates
  80599. * @returns a string with the Vector2 coordinates
  80600. */
  80601. toString(): string;
  80602. /**
  80603. * Gets class name
  80604. * @returns the string "Vector2"
  80605. */
  80606. getClassName(): string;
  80607. /**
  80608. * Gets current vector hash code
  80609. * @returns the Vector2 hash code as a number
  80610. */
  80611. getHashCode(): number;
  80612. /**
  80613. * Sets the Vector2 coordinates in the given array or Float32Array from the given index.
  80614. * @param array defines the source array
  80615. * @param index defines the offset in source array
  80616. * @returns the current Vector2
  80617. */
  80618. toArray(array: FloatArray, index?: number): Vector2;
  80619. /**
  80620. * Copy the current vector to an array
  80621. * @returns a new array with 2 elements: the Vector2 coordinates.
  80622. */
  80623. asArray(): number[];
  80624. /**
  80625. * Sets the Vector2 coordinates with the given Vector2 coordinates
  80626. * @param source defines the source Vector2
  80627. * @returns the current updated Vector2
  80628. */
  80629. copyFrom(source: DeepImmutable<Vector2>): Vector2;
  80630. /**
  80631. * Sets the Vector2 coordinates with the given floats
  80632. * @param x defines the first coordinate
  80633. * @param y defines the second coordinate
  80634. * @returns the current updated Vector2
  80635. */
  80636. copyFromFloats(x: number, y: number): Vector2;
  80637. /**
  80638. * Sets the Vector2 coordinates with the given floats
  80639. * @param x defines the first coordinate
  80640. * @param y defines the second coordinate
  80641. * @returns the current updated Vector2
  80642. */
  80643. set(x: number, y: number): Vector2;
  80644. /**
  80645. * Add another vector with the current one
  80646. * @param otherVector defines the other vector
  80647. * @returns a new Vector2 set with the addition of the current Vector2 and the given one coordinates
  80648. */
  80649. add(otherVector: DeepImmutable<Vector2>): Vector2;
  80650. /**
  80651. * Sets the "result" coordinates with the addition of the current Vector2 and the given one coordinates
  80652. * @param otherVector defines the other vector
  80653. * @param result defines the target vector
  80654. * @returns the unmodified current Vector2
  80655. */
  80656. addToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  80657. /**
  80658. * Set the Vector2 coordinates by adding the given Vector2 coordinates
  80659. * @param otherVector defines the other vector
  80660. * @returns the current updated Vector2
  80661. */
  80662. addInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  80663. /**
  80664. * Gets a new Vector2 by adding the current Vector2 coordinates to the given Vector3 x, y coordinates
  80665. * @param otherVector defines the other vector
  80666. * @returns a new Vector2
  80667. */
  80668. addVector3(otherVector: Vector3): Vector2;
  80669. /**
  80670. * Gets a new Vector2 set with the subtracted coordinates of the given one from the current Vector2
  80671. * @param otherVector defines the other vector
  80672. * @returns a new Vector2
  80673. */
  80674. subtract(otherVector: Vector2): Vector2;
  80675. /**
  80676. * Sets the "result" coordinates with the subtraction of the given one from the current Vector2 coordinates.
  80677. * @param otherVector defines the other vector
  80678. * @param result defines the target vector
  80679. * @returns the unmodified current Vector2
  80680. */
  80681. subtractToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  80682. /**
  80683. * Sets the current Vector2 coordinates by subtracting from it the given one coordinates
  80684. * @param otherVector defines the other vector
  80685. * @returns the current updated Vector2
  80686. */
  80687. subtractInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  80688. /**
  80689. * Multiplies in place the current Vector2 coordinates by the given ones
  80690. * @param otherVector defines the other vector
  80691. * @returns the current updated Vector2
  80692. */
  80693. multiplyInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  80694. /**
  80695. * Returns a new Vector2 set with the multiplication of the current Vector2 and the given one coordinates
  80696. * @param otherVector defines the other vector
  80697. * @returns a new Vector2
  80698. */
  80699. multiply(otherVector: DeepImmutable<Vector2>): Vector2;
  80700. /**
  80701. * Sets "result" coordinates with the multiplication of the current Vector2 and the given one coordinates
  80702. * @param otherVector defines the other vector
  80703. * @param result defines the target vector
  80704. * @returns the unmodified current Vector2
  80705. */
  80706. multiplyToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  80707. /**
  80708. * Gets a new Vector2 set with the Vector2 coordinates multiplied by the given floats
  80709. * @param x defines the first coordinate
  80710. * @param y defines the second coordinate
  80711. * @returns a new Vector2
  80712. */
  80713. multiplyByFloats(x: number, y: number): Vector2;
  80714. /**
  80715. * Returns a new Vector2 set with the Vector2 coordinates divided by the given one coordinates
  80716. * @param otherVector defines the other vector
  80717. * @returns a new Vector2
  80718. */
  80719. divide(otherVector: Vector2): Vector2;
  80720. /**
  80721. * Sets the "result" coordinates with the Vector2 divided by the given one coordinates
  80722. * @param otherVector defines the other vector
  80723. * @param result defines the target vector
  80724. * @returns the unmodified current Vector2
  80725. */
  80726. divideToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  80727. /**
  80728. * Divides the current Vector2 coordinates by the given ones
  80729. * @param otherVector defines the other vector
  80730. * @returns the current updated Vector2
  80731. */
  80732. divideInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  80733. /**
  80734. * Gets a new Vector2 with current Vector2 negated coordinates
  80735. * @returns a new Vector2
  80736. */
  80737. negate(): Vector2;
  80738. /**
  80739. * Negate this vector in place
  80740. * @returns this
  80741. */
  80742. negateInPlace(): Vector2;
  80743. /**
  80744. * Negate the current Vector2 and stores the result in the given vector "result" coordinates
  80745. * @param result defines the Vector3 object where to store the result
  80746. * @returns the current Vector2
  80747. */
  80748. negateToRef(result: Vector2): Vector2;
  80749. /**
  80750. * Multiply the Vector2 coordinates by scale
  80751. * @param scale defines the scaling factor
  80752. * @returns the current updated Vector2
  80753. */
  80754. scaleInPlace(scale: number): Vector2;
  80755. /**
  80756. * Returns a new Vector2 scaled by "scale" from the current Vector2
  80757. * @param scale defines the scaling factor
  80758. * @returns a new Vector2
  80759. */
  80760. scale(scale: number): Vector2;
  80761. /**
  80762. * Scale the current Vector2 values by a factor to a given Vector2
  80763. * @param scale defines the scale factor
  80764. * @param result defines the Vector2 object where to store the result
  80765. * @returns the unmodified current Vector2
  80766. */
  80767. scaleToRef(scale: number, result: Vector2): Vector2;
  80768. /**
  80769. * Scale the current Vector2 values by a factor and add the result to a given Vector2
  80770. * @param scale defines the scale factor
  80771. * @param result defines the Vector2 object where to store the result
  80772. * @returns the unmodified current Vector2
  80773. */
  80774. scaleAndAddToRef(scale: number, result: Vector2): Vector2;
  80775. /**
  80776. * Gets a boolean if two vectors are equals
  80777. * @param otherVector defines the other vector
  80778. * @returns true if the given vector coordinates strictly equal the current Vector2 ones
  80779. */
  80780. equals(otherVector: DeepImmutable<Vector2>): boolean;
  80781. /**
  80782. * Gets a boolean if two vectors are equals (using an epsilon value)
  80783. * @param otherVector defines the other vector
  80784. * @param epsilon defines the minimal distance to consider equality
  80785. * @returns true if the given vector coordinates are close to the current ones by a distance of epsilon.
  80786. */
  80787. equalsWithEpsilon(otherVector: DeepImmutable<Vector2>, epsilon?: number): boolean;
  80788. /**
  80789. * Gets a new Vector2 from current Vector2 floored values
  80790. * @returns a new Vector2
  80791. */
  80792. floor(): Vector2;
  80793. /**
  80794. * Gets a new Vector2 from current Vector2 floored values
  80795. * @returns a new Vector2
  80796. */
  80797. fract(): Vector2;
  80798. /**
  80799. * Gets the length of the vector
  80800. * @returns the vector length (float)
  80801. */
  80802. length(): number;
  80803. /**
  80804. * Gets the vector squared length
  80805. * @returns the vector squared length (float)
  80806. */
  80807. lengthSquared(): number;
  80808. /**
  80809. * Normalize the vector
  80810. * @returns the current updated Vector2
  80811. */
  80812. normalize(): Vector2;
  80813. /**
  80814. * Gets a new Vector2 copied from the Vector2
  80815. * @returns a new Vector2
  80816. */
  80817. clone(): Vector2;
  80818. /**
  80819. * Gets a new Vector2(0, 0)
  80820. * @returns a new Vector2
  80821. */
  80822. static Zero(): Vector2;
  80823. /**
  80824. * Gets a new Vector2(1, 1)
  80825. * @returns a new Vector2
  80826. */
  80827. static One(): Vector2;
  80828. /**
  80829. * Gets a new Vector2 set from the given index element of the given array
  80830. * @param array defines the data source
  80831. * @param offset defines the offset in the data source
  80832. * @returns a new Vector2
  80833. */
  80834. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector2;
  80835. /**
  80836. * Sets "result" from the given index element of the given array
  80837. * @param array defines the data source
  80838. * @param offset defines the offset in the data source
  80839. * @param result defines the target vector
  80840. */
  80841. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector2): void;
  80842. /**
  80843. * Gets a new Vector2 located for "amount" (float) on the CatmullRom spline defined by the given four Vector2
  80844. * @param value1 defines 1st point of control
  80845. * @param value2 defines 2nd point of control
  80846. * @param value3 defines 3rd point of control
  80847. * @param value4 defines 4th point of control
  80848. * @param amount defines the interpolation factor
  80849. * @returns a new Vector2
  80850. */
  80851. static CatmullRom(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>, value3: DeepImmutable<Vector2>, value4: DeepImmutable<Vector2>, amount: number): Vector2;
  80852. /**
  80853. * 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".
  80854. * If a coordinate of "value" is lower than "min" coordinates, the returned Vector2 is given this "min" coordinate.
  80855. * If a coordinate of "value" is greater than "max" coordinates, the returned Vector2 is given this "max" coordinate
  80856. * @param value defines the value to clamp
  80857. * @param min defines the lower limit
  80858. * @param max defines the upper limit
  80859. * @returns a new Vector2
  80860. */
  80861. static Clamp(value: DeepImmutable<Vector2>, min: DeepImmutable<Vector2>, max: DeepImmutable<Vector2>): Vector2;
  80862. /**
  80863. * Returns a new Vector2 located for "amount" (float) on the Hermite spline defined by the vectors "value1", "value3", "tangent1", "tangent2"
  80864. * @param value1 defines the 1st control point
  80865. * @param tangent1 defines the outgoing tangent
  80866. * @param value2 defines the 2nd control point
  80867. * @param tangent2 defines the incoming tangent
  80868. * @param amount defines the interpolation factor
  80869. * @returns a new Vector2
  80870. */
  80871. static Hermite(value1: DeepImmutable<Vector2>, tangent1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>, tangent2: DeepImmutable<Vector2>, amount: number): Vector2;
  80872. /**
  80873. * Returns a new Vector2 located for "amount" (float) on the linear interpolation between the vector "start" adn the vector "end".
  80874. * @param start defines the start vector
  80875. * @param end defines the end vector
  80876. * @param amount defines the interpolation factor
  80877. * @returns a new Vector2
  80878. */
  80879. static Lerp(start: DeepImmutable<Vector2>, end: DeepImmutable<Vector2>, amount: number): Vector2;
  80880. /**
  80881. * Gets the dot product of the vector "left" and the vector "right"
  80882. * @param left defines first vector
  80883. * @param right defines second vector
  80884. * @returns the dot product (float)
  80885. */
  80886. static Dot(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): number;
  80887. /**
  80888. * Returns a new Vector2 equal to the normalized given vector
  80889. * @param vector defines the vector to normalize
  80890. * @returns a new Vector2
  80891. */
  80892. static Normalize(vector: DeepImmutable<Vector2>): Vector2;
  80893. /**
  80894. * Gets a new Vector2 set with the minimal coordinate values from the "left" and "right" vectors
  80895. * @param left defines 1st vector
  80896. * @param right defines 2nd vector
  80897. * @returns a new Vector2
  80898. */
  80899. static Minimize(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): Vector2;
  80900. /**
  80901. * Gets a new Vecto2 set with the maximal coordinate values from the "left" and "right" vectors
  80902. * @param left defines 1st vector
  80903. * @param right defines 2nd vector
  80904. * @returns a new Vector2
  80905. */
  80906. static Maximize(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): Vector2;
  80907. /**
  80908. * Gets a new Vector2 set with the transformed coordinates of the given vector by the given transformation matrix
  80909. * @param vector defines the vector to transform
  80910. * @param transformation defines the matrix to apply
  80911. * @returns a new Vector2
  80912. */
  80913. static Transform(vector: DeepImmutable<Vector2>, transformation: DeepImmutable<Matrix>): Vector2;
  80914. /**
  80915. * Transforms the given vector coordinates by the given transformation matrix and stores the result in the vector "result" coordinates
  80916. * @param vector defines the vector to transform
  80917. * @param transformation defines the matrix to apply
  80918. * @param result defines the target vector
  80919. */
  80920. static TransformToRef(vector: DeepImmutable<Vector2>, transformation: DeepImmutable<Matrix>, result: Vector2): void;
  80921. /**
  80922. * Determines if a given vector is included in a triangle
  80923. * @param p defines the vector to test
  80924. * @param p0 defines 1st triangle point
  80925. * @param p1 defines 2nd triangle point
  80926. * @param p2 defines 3rd triangle point
  80927. * @returns true if the point "p" is in the triangle defined by the vertors "p0", "p1", "p2"
  80928. */
  80929. static PointInTriangle(p: DeepImmutable<Vector2>, p0: DeepImmutable<Vector2>, p1: DeepImmutable<Vector2>, p2: DeepImmutable<Vector2>): boolean;
  80930. /**
  80931. * Gets the distance between the vectors "value1" and "value2"
  80932. * @param value1 defines first vector
  80933. * @param value2 defines second vector
  80934. * @returns the distance between vectors
  80935. */
  80936. static Distance(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): number;
  80937. /**
  80938. * Returns the squared distance between the vectors "value1" and "value2"
  80939. * @param value1 defines first vector
  80940. * @param value2 defines second vector
  80941. * @returns the squared distance between vectors
  80942. */
  80943. static DistanceSquared(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): number;
  80944. /**
  80945. * Gets a new Vector2 located at the center of the vectors "value1" and "value2"
  80946. * @param value1 defines first vector
  80947. * @param value2 defines second vector
  80948. * @returns a new Vector2
  80949. */
  80950. static Center(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): Vector2;
  80951. /**
  80952. * Gets the shortest distance (float) between the point "p" and the segment defined by the two points "segA" and "segB".
  80953. * @param p defines the middle point
  80954. * @param segA defines one point of the segment
  80955. * @param segB defines the other point of the segment
  80956. * @returns the shortest distance
  80957. */
  80958. static DistanceOfPointFromSegment(p: DeepImmutable<Vector2>, segA: DeepImmutable<Vector2>, segB: DeepImmutable<Vector2>): number;
  80959. }
  80960. /**
  80961. * Class used to store (x,y,z) vector representation
  80962. * A Vector3 is the main object used in 3D geometry
  80963. * It can represent etiher the coordinates of a point the space, either a direction
  80964. * Reminder: js uses a left handed forward facing system
  80965. */
  80966. export class Vector3 {
  80967. private static _UpReadOnly;
  80968. private static _ZeroReadOnly;
  80969. /** @hidden */
  80970. _x: number;
  80971. /** @hidden */
  80972. _y: number;
  80973. /** @hidden */
  80974. _z: number;
  80975. /** @hidden */
  80976. _isDirty: boolean;
  80977. /** Gets or sets the x coordinate */
  80978. get x(): number;
  80979. set x(value: number);
  80980. /** Gets or sets the y coordinate */
  80981. get y(): number;
  80982. set y(value: number);
  80983. /** Gets or sets the z coordinate */
  80984. get z(): number;
  80985. set z(value: number);
  80986. /**
  80987. * Creates a new Vector3 object from the given x, y, z (floats) coordinates.
  80988. * @param x defines the first coordinates (on X axis)
  80989. * @param y defines the second coordinates (on Y axis)
  80990. * @param z defines the third coordinates (on Z axis)
  80991. */
  80992. constructor(x?: number, y?: number, z?: number);
  80993. /**
  80994. * Creates a string representation of the Vector3
  80995. * @returns a string with the Vector3 coordinates.
  80996. */
  80997. toString(): string;
  80998. /**
  80999. * Gets the class name
  81000. * @returns the string "Vector3"
  81001. */
  81002. getClassName(): string;
  81003. /**
  81004. * Creates the Vector3 hash code
  81005. * @returns a number which tends to be unique between Vector3 instances
  81006. */
  81007. getHashCode(): number;
  81008. /**
  81009. * Creates an array containing three elements : the coordinates of the Vector3
  81010. * @returns a new array of numbers
  81011. */
  81012. asArray(): number[];
  81013. /**
  81014. * Populates the given array or Float32Array from the given index with the successive coordinates of the Vector3
  81015. * @param array defines the destination array
  81016. * @param index defines the offset in the destination array
  81017. * @returns the current Vector3
  81018. */
  81019. toArray(array: FloatArray, index?: number): Vector3;
  81020. /**
  81021. * Converts the current Vector3 into a quaternion (considering that the Vector3 contains Euler angles representation of a rotation)
  81022. * @returns a new Quaternion object, computed from the Vector3 coordinates
  81023. */
  81024. toQuaternion(): Quaternion;
  81025. /**
  81026. * Adds the given vector to the current Vector3
  81027. * @param otherVector defines the second operand
  81028. * @returns the current updated Vector3
  81029. */
  81030. addInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  81031. /**
  81032. * Adds the given coordinates to the current Vector3
  81033. * @param x defines the x coordinate of the operand
  81034. * @param y defines the y coordinate of the operand
  81035. * @param z defines the z coordinate of the operand
  81036. * @returns the current updated Vector3
  81037. */
  81038. addInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  81039. /**
  81040. * Gets a new Vector3, result of the addition the current Vector3 and the given vector
  81041. * @param otherVector defines the second operand
  81042. * @returns the resulting Vector3
  81043. */
  81044. add(otherVector: DeepImmutable<Vector3>): Vector3;
  81045. /**
  81046. * Adds the current Vector3 to the given one and stores the result in the vector "result"
  81047. * @param otherVector defines the second operand
  81048. * @param result defines the Vector3 object where to store the result
  81049. * @returns the current Vector3
  81050. */
  81051. addToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  81052. /**
  81053. * Subtract the given vector from the current Vector3
  81054. * @param otherVector defines the second operand
  81055. * @returns the current updated Vector3
  81056. */
  81057. subtractInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  81058. /**
  81059. * Returns a new Vector3, result of the subtraction of the given vector from the current Vector3
  81060. * @param otherVector defines the second operand
  81061. * @returns the resulting Vector3
  81062. */
  81063. subtract(otherVector: DeepImmutable<Vector3>): Vector3;
  81064. /**
  81065. * Subtracts the given vector from the current Vector3 and stores the result in the vector "result".
  81066. * @param otherVector defines the second operand
  81067. * @param result defines the Vector3 object where to store the result
  81068. * @returns the current Vector3
  81069. */
  81070. subtractToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  81071. /**
  81072. * Returns a new Vector3 set with the subtraction of the given floats from the current Vector3 coordinates
  81073. * @param x defines the x coordinate of the operand
  81074. * @param y defines the y coordinate of the operand
  81075. * @param z defines the z coordinate of the operand
  81076. * @returns the resulting Vector3
  81077. */
  81078. subtractFromFloats(x: number, y: number, z: number): Vector3;
  81079. /**
  81080. * Subtracts the given floats from the current Vector3 coordinates and set the given vector "result" with this result
  81081. * @param x defines the x coordinate of the operand
  81082. * @param y defines the y coordinate of the operand
  81083. * @param z defines the z coordinate of the operand
  81084. * @param result defines the Vector3 object where to store the result
  81085. * @returns the current Vector3
  81086. */
  81087. subtractFromFloatsToRef(x: number, y: number, z: number, result: Vector3): Vector3;
  81088. /**
  81089. * Gets a new Vector3 set with the current Vector3 negated coordinates
  81090. * @returns a new Vector3
  81091. */
  81092. negate(): Vector3;
  81093. /**
  81094. * Negate this vector in place
  81095. * @returns this
  81096. */
  81097. negateInPlace(): Vector3;
  81098. /**
  81099. * Negate the current Vector3 and stores the result in the given vector "result" coordinates
  81100. * @param result defines the Vector3 object where to store the result
  81101. * @returns the current Vector3
  81102. */
  81103. negateToRef(result: Vector3): Vector3;
  81104. /**
  81105. * Multiplies the Vector3 coordinates by the float "scale"
  81106. * @param scale defines the multiplier factor
  81107. * @returns the current updated Vector3
  81108. */
  81109. scaleInPlace(scale: number): Vector3;
  81110. /**
  81111. * Returns a new Vector3 set with the current Vector3 coordinates multiplied by the float "scale"
  81112. * @param scale defines the multiplier factor
  81113. * @returns a new Vector3
  81114. */
  81115. scale(scale: number): Vector3;
  81116. /**
  81117. * Multiplies the current Vector3 coordinates by the float "scale" and stores the result in the given vector "result" coordinates
  81118. * @param scale defines the multiplier factor
  81119. * @param result defines the Vector3 object where to store the result
  81120. * @returns the current Vector3
  81121. */
  81122. scaleToRef(scale: number, result: Vector3): Vector3;
  81123. /**
  81124. * Scale the current Vector3 values by a factor and add the result to a given Vector3
  81125. * @param scale defines the scale factor
  81126. * @param result defines the Vector3 object where to store the result
  81127. * @returns the unmodified current Vector3
  81128. */
  81129. scaleAndAddToRef(scale: number, result: Vector3): Vector3;
  81130. /**
  81131. * Projects the current vector3 to a plane along a ray starting from a specified origin and directed towards the point.
  81132. * @param origin defines the origin of the projection ray
  81133. * @param plane defines the plane to project to
  81134. * @returns the projected vector3
  81135. */
  81136. projectOnPlane(plane: Plane, origin: Vector3): Vector3;
  81137. /**
  81138. * Projects the current vector3 to a plane along a ray starting from a specified origin and directed towards the point.
  81139. * @param origin defines the origin of the projection ray
  81140. * @param plane defines the plane to project to
  81141. * @param result defines the Vector3 where to store the result
  81142. */
  81143. projectOnPlaneToRef(plane: Plane, origin: Vector3, result: Vector3): void;
  81144. /**
  81145. * Returns true if the current Vector3 and the given vector coordinates are strictly equal
  81146. * @param otherVector defines the second operand
  81147. * @returns true if both vectors are equals
  81148. */
  81149. equals(otherVector: DeepImmutable<Vector3>): boolean;
  81150. /**
  81151. * Returns true if the current Vector3 and the given vector coordinates are distant less than epsilon
  81152. * @param otherVector defines the second operand
  81153. * @param epsilon defines the minimal distance to define values as equals
  81154. * @returns true if both vectors are distant less than epsilon
  81155. */
  81156. equalsWithEpsilon(otherVector: DeepImmutable<Vector3>, epsilon?: number): boolean;
  81157. /**
  81158. * Returns true if the current Vector3 coordinates equals the given floats
  81159. * @param x defines the x coordinate of the operand
  81160. * @param y defines the y coordinate of the operand
  81161. * @param z defines the z coordinate of the operand
  81162. * @returns true if both vectors are equals
  81163. */
  81164. equalsToFloats(x: number, y: number, z: number): boolean;
  81165. /**
  81166. * Multiplies the current Vector3 coordinates by the given ones
  81167. * @param otherVector defines the second operand
  81168. * @returns the current updated Vector3
  81169. */
  81170. multiplyInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  81171. /**
  81172. * Returns a new Vector3, result of the multiplication of the current Vector3 by the given vector
  81173. * @param otherVector defines the second operand
  81174. * @returns the new Vector3
  81175. */
  81176. multiply(otherVector: DeepImmutable<Vector3>): Vector3;
  81177. /**
  81178. * Multiplies the current Vector3 by the given one and stores the result in the given vector "result"
  81179. * @param otherVector defines the second operand
  81180. * @param result defines the Vector3 object where to store the result
  81181. * @returns the current Vector3
  81182. */
  81183. multiplyToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  81184. /**
  81185. * Returns a new Vector3 set with the result of the mulliplication of the current Vector3 coordinates by the given floats
  81186. * @param x defines the x coordinate of the operand
  81187. * @param y defines the y coordinate of the operand
  81188. * @param z defines the z coordinate of the operand
  81189. * @returns the new Vector3
  81190. */
  81191. multiplyByFloats(x: number, y: number, z: number): Vector3;
  81192. /**
  81193. * Returns a new Vector3 set with the result of the division of the current Vector3 coordinates by the given ones
  81194. * @param otherVector defines the second operand
  81195. * @returns the new Vector3
  81196. */
  81197. divide(otherVector: DeepImmutable<Vector3>): Vector3;
  81198. /**
  81199. * Divides the current Vector3 coordinates by the given ones and stores the result in the given vector "result"
  81200. * @param otherVector defines the second operand
  81201. * @param result defines the Vector3 object where to store the result
  81202. * @returns the current Vector3
  81203. */
  81204. divideToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  81205. /**
  81206. * Divides the current Vector3 coordinates by the given ones.
  81207. * @param otherVector defines the second operand
  81208. * @returns the current updated Vector3
  81209. */
  81210. divideInPlace(otherVector: Vector3): Vector3;
  81211. /**
  81212. * Updates the current Vector3 with the minimal coordinate values between its and the given vector ones
  81213. * @param other defines the second operand
  81214. * @returns the current updated Vector3
  81215. */
  81216. minimizeInPlace(other: DeepImmutable<Vector3>): Vector3;
  81217. /**
  81218. * Updates the current Vector3 with the maximal coordinate values between its and the given vector ones.
  81219. * @param other defines the second operand
  81220. * @returns the current updated Vector3
  81221. */
  81222. maximizeInPlace(other: DeepImmutable<Vector3>): Vector3;
  81223. /**
  81224. * Updates the current Vector3 with the minimal coordinate values between its and the given coordinates
  81225. * @param x defines the x coordinate of the operand
  81226. * @param y defines the y coordinate of the operand
  81227. * @param z defines the z coordinate of the operand
  81228. * @returns the current updated Vector3
  81229. */
  81230. minimizeInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  81231. /**
  81232. * Updates the current Vector3 with the maximal coordinate values between its and the given coordinates.
  81233. * @param x defines the x coordinate of the operand
  81234. * @param y defines the y coordinate of the operand
  81235. * @param z defines the z coordinate of the operand
  81236. * @returns the current updated Vector3
  81237. */
  81238. maximizeInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  81239. /**
  81240. * Due to float precision, scale of a mesh could be uniform but float values are off by a small fraction
  81241. * Check if is non uniform within a certain amount of decimal places to account for this
  81242. * @param epsilon the amount the values can differ
  81243. * @returns if the the vector is non uniform to a certain number of decimal places
  81244. */
  81245. isNonUniformWithinEpsilon(epsilon: number): boolean;
  81246. /**
  81247. * Gets a boolean indicating that the vector is non uniform meaning x, y or z are not all the same
  81248. */
  81249. get isNonUniform(): boolean;
  81250. /**
  81251. * Gets a new Vector3 from current Vector3 floored values
  81252. * @returns a new Vector3
  81253. */
  81254. floor(): Vector3;
  81255. /**
  81256. * Gets a new Vector3 from current Vector3 floored values
  81257. * @returns a new Vector3
  81258. */
  81259. fract(): Vector3;
  81260. /**
  81261. * Gets the length of the Vector3
  81262. * @returns the length of the Vector3
  81263. */
  81264. length(): number;
  81265. /**
  81266. * Gets the squared length of the Vector3
  81267. * @returns squared length of the Vector3
  81268. */
  81269. lengthSquared(): number;
  81270. /**
  81271. * Normalize the current Vector3.
  81272. * Please note that this is an in place operation.
  81273. * @returns the current updated Vector3
  81274. */
  81275. normalize(): Vector3;
  81276. /**
  81277. * Reorders the x y z properties of the vector in place
  81278. * @param order new ordering of the properties (eg. for vector 1,2,3 with "ZYX" will produce 3,2,1)
  81279. * @returns the current updated vector
  81280. */
  81281. reorderInPlace(order: string): this;
  81282. /**
  81283. * Rotates the vector around 0,0,0 by a quaternion
  81284. * @param quaternion the rotation quaternion
  81285. * @param result vector to store the result
  81286. * @returns the resulting vector
  81287. */
  81288. rotateByQuaternionToRef(quaternion: Quaternion, result: Vector3): Vector3;
  81289. /**
  81290. * Rotates a vector around a given point
  81291. * @param quaternion the rotation quaternion
  81292. * @param point the point to rotate around
  81293. * @param result vector to store the result
  81294. * @returns the resulting vector
  81295. */
  81296. rotateByQuaternionAroundPointToRef(quaternion: Quaternion, point: Vector3, result: Vector3): Vector3;
  81297. /**
  81298. * Returns a new Vector3 as the cross product of the current vector and the "other" one
  81299. * The cross product is then orthogonal to both current and "other"
  81300. * @param other defines the right operand
  81301. * @returns the cross product
  81302. */
  81303. cross(other: Vector3): Vector3;
  81304. /**
  81305. * Normalize the current Vector3 with the given input length.
  81306. * Please note that this is an in place operation.
  81307. * @param len the length of the vector
  81308. * @returns the current updated Vector3
  81309. */
  81310. normalizeFromLength(len: number): Vector3;
  81311. /**
  81312. * Normalize the current Vector3 to a new vector
  81313. * @returns the new Vector3
  81314. */
  81315. normalizeToNew(): Vector3;
  81316. /**
  81317. * Normalize the current Vector3 to the reference
  81318. * @param reference define the Vector3 to update
  81319. * @returns the updated Vector3
  81320. */
  81321. normalizeToRef(reference: Vector3): Vector3;
  81322. /**
  81323. * Creates a new Vector3 copied from the current Vector3
  81324. * @returns the new Vector3
  81325. */
  81326. clone(): Vector3;
  81327. /**
  81328. * Copies the given vector coordinates to the current Vector3 ones
  81329. * @param source defines the source Vector3
  81330. * @returns the current updated Vector3
  81331. */
  81332. copyFrom(source: DeepImmutable<Vector3>): Vector3;
  81333. /**
  81334. * Copies the given floats to the current Vector3 coordinates
  81335. * @param x defines the x coordinate of the operand
  81336. * @param y defines the y coordinate of the operand
  81337. * @param z defines the z coordinate of the operand
  81338. * @returns the current updated Vector3
  81339. */
  81340. copyFromFloats(x: number, y: number, z: number): Vector3;
  81341. /**
  81342. * Copies the given floats to the current Vector3 coordinates
  81343. * @param x defines the x coordinate of the operand
  81344. * @param y defines the y coordinate of the operand
  81345. * @param z defines the z coordinate of the operand
  81346. * @returns the current updated Vector3
  81347. */
  81348. set(x: number, y: number, z: number): Vector3;
  81349. /**
  81350. * Copies the given float to the current Vector3 coordinates
  81351. * @param v defines the x, y and z coordinates of the operand
  81352. * @returns the current updated Vector3
  81353. */
  81354. setAll(v: number): Vector3;
  81355. /**
  81356. * Get the clip factor between two vectors
  81357. * @param vector0 defines the first operand
  81358. * @param vector1 defines the second operand
  81359. * @param axis defines the axis to use
  81360. * @param size defines the size along the axis
  81361. * @returns the clip factor
  81362. */
  81363. static GetClipFactor(vector0: DeepImmutable<Vector3>, vector1: DeepImmutable<Vector3>, axis: DeepImmutable<Vector3>, size: number): number;
  81364. /**
  81365. * Get angle between two vectors
  81366. * @param vector0 angle between vector0 and vector1
  81367. * @param vector1 angle between vector0 and vector1
  81368. * @param normal direction of the normal
  81369. * @return the angle between vector0 and vector1
  81370. */
  81371. static GetAngleBetweenVectors(vector0: DeepImmutable<Vector3>, vector1: DeepImmutable<Vector3>, normal: DeepImmutable<Vector3>): number;
  81372. /**
  81373. * Returns a new Vector3 set from the index "offset" of the given array
  81374. * @param array defines the source array
  81375. * @param offset defines the offset in the source array
  81376. * @returns the new Vector3
  81377. */
  81378. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector3;
  81379. /**
  81380. * Returns a new Vector3 set from the index "offset" of the given Float32Array
  81381. * @param array defines the source array
  81382. * @param offset defines the offset in the source array
  81383. * @returns the new Vector3
  81384. * @deprecated Please use FromArray instead.
  81385. */
  81386. static FromFloatArray(array: DeepImmutable<Float32Array>, offset?: number): Vector3;
  81387. /**
  81388. * Sets the given vector "result" with the element values from the index "offset" of the given array
  81389. * @param array defines the source array
  81390. * @param offset defines the offset in the source array
  81391. * @param result defines the Vector3 where to store the result
  81392. */
  81393. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector3): void;
  81394. /**
  81395. * Sets the given vector "result" with the element values from the index "offset" of the given Float32Array
  81396. * @param array defines the source array
  81397. * @param offset defines the offset in the source array
  81398. * @param result defines the Vector3 where to store the result
  81399. * @deprecated Please use FromArrayToRef instead.
  81400. */
  81401. static FromFloatArrayToRef(array: DeepImmutable<Float32Array>, offset: number, result: Vector3): void;
  81402. /**
  81403. * Sets the given vector "result" with the given floats.
  81404. * @param x defines the x coordinate of the source
  81405. * @param y defines the y coordinate of the source
  81406. * @param z defines the z coordinate of the source
  81407. * @param result defines the Vector3 where to store the result
  81408. */
  81409. static FromFloatsToRef(x: number, y: number, z: number, result: Vector3): void;
  81410. /**
  81411. * Returns a new Vector3 set to (0.0, 0.0, 0.0)
  81412. * @returns a new empty Vector3
  81413. */
  81414. static Zero(): Vector3;
  81415. /**
  81416. * Returns a new Vector3 set to (1.0, 1.0, 1.0)
  81417. * @returns a new unit Vector3
  81418. */
  81419. static One(): Vector3;
  81420. /**
  81421. * Returns a new Vector3 set to (0.0, 1.0, 0.0)
  81422. * @returns a new up Vector3
  81423. */
  81424. static Up(): Vector3;
  81425. /**
  81426. * Gets a up Vector3 that must not be updated
  81427. */
  81428. static get UpReadOnly(): DeepImmutable<Vector3>;
  81429. /**
  81430. * Gets a zero Vector3 that must not be updated
  81431. */
  81432. static get ZeroReadOnly(): DeepImmutable<Vector3>;
  81433. /**
  81434. * Returns a new Vector3 set to (0.0, -1.0, 0.0)
  81435. * @returns a new down Vector3
  81436. */
  81437. static Down(): Vector3;
  81438. /**
  81439. * Returns a new Vector3 set to (0.0, 0.0, 1.0)
  81440. * @param rightHandedSystem is the scene right-handed (negative z)
  81441. * @returns a new forward Vector3
  81442. */
  81443. static Forward(rightHandedSystem?: boolean): Vector3;
  81444. /**
  81445. * Returns a new Vector3 set to (0.0, 0.0, -1.0)
  81446. * @param rightHandedSystem is the scene right-handed (negative-z)
  81447. * @returns a new forward Vector3
  81448. */
  81449. static Backward(rightHandedSystem?: boolean): Vector3;
  81450. /**
  81451. * Returns a new Vector3 set to (1.0, 0.0, 0.0)
  81452. * @returns a new right Vector3
  81453. */
  81454. static Right(): Vector3;
  81455. /**
  81456. * Returns a new Vector3 set to (-1.0, 0.0, 0.0)
  81457. * @returns a new left Vector3
  81458. */
  81459. static Left(): Vector3;
  81460. /**
  81461. * Returns a new Vector3 set with the result of the transformation by the given matrix of the given vector.
  81462. * This method computes tranformed coordinates only, not transformed direction vectors (ie. it takes translation in account)
  81463. * @param vector defines the Vector3 to transform
  81464. * @param transformation defines the transformation matrix
  81465. * @returns the transformed Vector3
  81466. */
  81467. static TransformCoordinates(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>): Vector3;
  81468. /**
  81469. * Sets the given vector "result" coordinates with the result of the transformation by the given matrix of the given vector
  81470. * This method computes tranformed coordinates only, not transformed direction vectors (ie. it takes translation in account)
  81471. * @param vector defines the Vector3 to transform
  81472. * @param transformation defines the transformation matrix
  81473. * @param result defines the Vector3 where to store the result
  81474. */
  81475. static TransformCoordinatesToRef(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  81476. /**
  81477. * Sets the given vector "result" coordinates with the result of the transformation by the given matrix of the given floats (x, y, z)
  81478. * This method computes tranformed coordinates only, not transformed direction vectors
  81479. * @param x define the x coordinate of the source vector
  81480. * @param y define the y coordinate of the source vector
  81481. * @param z define the z coordinate of the source vector
  81482. * @param transformation defines the transformation matrix
  81483. * @param result defines the Vector3 where to store the result
  81484. */
  81485. static TransformCoordinatesFromFloatsToRef(x: number, y: number, z: number, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  81486. /**
  81487. * Returns a new Vector3 set with the result of the normal transformation by the given matrix of the given vector
  81488. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  81489. * @param vector defines the Vector3 to transform
  81490. * @param transformation defines the transformation matrix
  81491. * @returns the new Vector3
  81492. */
  81493. static TransformNormal(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>): Vector3;
  81494. /**
  81495. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given vector
  81496. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  81497. * @param vector defines the Vector3 to transform
  81498. * @param transformation defines the transformation matrix
  81499. * @param result defines the Vector3 where to store the result
  81500. */
  81501. static TransformNormalToRef(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  81502. /**
  81503. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given floats (x, y, z)
  81504. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  81505. * @param x define the x coordinate of the source vector
  81506. * @param y define the y coordinate of the source vector
  81507. * @param z define the z coordinate of the source vector
  81508. * @param transformation defines the transformation matrix
  81509. * @param result defines the Vector3 where to store the result
  81510. */
  81511. static TransformNormalFromFloatsToRef(x: number, y: number, z: number, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  81512. /**
  81513. * Returns a new Vector3 located for "amount" on the CatmullRom interpolation spline defined by the vectors "value1", "value2", "value3", "value4"
  81514. * @param value1 defines the first control point
  81515. * @param value2 defines the second control point
  81516. * @param value3 defines the third control point
  81517. * @param value4 defines the fourth control point
  81518. * @param amount defines the amount on the spline to use
  81519. * @returns the new Vector3
  81520. */
  81521. static CatmullRom(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>, value3: DeepImmutable<Vector3>, value4: DeepImmutable<Vector3>, amount: number): Vector3;
  81522. /**
  81523. * 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"
  81524. * If a coordinate value of "value" is lower than one of the "min" coordinate, then this "value" coordinate is set with the "min" one
  81525. * If a coordinate value of "value" is greater than one of the "max" coordinate, then this "value" coordinate is set with the "max" one
  81526. * @param value defines the current value
  81527. * @param min defines the lower range value
  81528. * @param max defines the upper range value
  81529. * @returns the new Vector3
  81530. */
  81531. static Clamp(value: DeepImmutable<Vector3>, min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>): Vector3;
  81532. /**
  81533. * 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"
  81534. * If a coordinate value of "value" is lower than one of the "min" coordinate, then this "value" coordinate is set with the "min" one
  81535. * If a coordinate value of "value" is greater than one of the "max" coordinate, then this "value" coordinate is set with the "max" one
  81536. * @param value defines the current value
  81537. * @param min defines the lower range value
  81538. * @param max defines the upper range value
  81539. * @param result defines the Vector3 where to store the result
  81540. */
  81541. static ClampToRef(value: DeepImmutable<Vector3>, min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, result: Vector3): void;
  81542. /**
  81543. * Checks if a given vector is inside a specific range
  81544. * @param v defines the vector to test
  81545. * @param min defines the minimum range
  81546. * @param max defines the maximum range
  81547. */
  81548. static CheckExtends(v: Vector3, min: Vector3, max: Vector3): void;
  81549. /**
  81550. * Returns a new Vector3 located for "amount" (float) on the Hermite interpolation spline defined by the vectors "value1", "tangent1", "value2", "tangent2"
  81551. * @param value1 defines the first control point
  81552. * @param tangent1 defines the first tangent vector
  81553. * @param value2 defines the second control point
  81554. * @param tangent2 defines the second tangent vector
  81555. * @param amount defines the amount on the interpolation spline (between 0 and 1)
  81556. * @returns the new Vector3
  81557. */
  81558. static Hermite(value1: DeepImmutable<Vector3>, tangent1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>, tangent2: DeepImmutable<Vector3>, amount: number): Vector3;
  81559. /**
  81560. * Returns a new Vector3 located for "amount" (float) on the linear interpolation between the vectors "start" and "end"
  81561. * @param start defines the start value
  81562. * @param end defines the end value
  81563. * @param amount max defines amount between both (between 0 and 1)
  81564. * @returns the new Vector3
  81565. */
  81566. static Lerp(start: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, amount: number): Vector3;
  81567. /**
  81568. * Sets the given vector "result" with the result of the linear interpolation from the vector "start" for "amount" to the vector "end"
  81569. * @param start defines the start value
  81570. * @param end defines the end value
  81571. * @param amount max defines amount between both (between 0 and 1)
  81572. * @param result defines the Vector3 where to store the result
  81573. */
  81574. static LerpToRef(start: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, amount: number, result: Vector3): void;
  81575. /**
  81576. * Returns the dot product (float) between the vectors "left" and "right"
  81577. * @param left defines the left operand
  81578. * @param right defines the right operand
  81579. * @returns the dot product
  81580. */
  81581. static Dot(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): number;
  81582. /**
  81583. * Returns a new Vector3 as the cross product of the vectors "left" and "right"
  81584. * The cross product is then orthogonal to both "left" and "right"
  81585. * @param left defines the left operand
  81586. * @param right defines the right operand
  81587. * @returns the cross product
  81588. */
  81589. static Cross(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  81590. /**
  81591. * Sets the given vector "result" with the cross product of "left" and "right"
  81592. * The cross product is then orthogonal to both "left" and "right"
  81593. * @param left defines the left operand
  81594. * @param right defines the right operand
  81595. * @param result defines the Vector3 where to store the result
  81596. */
  81597. static CrossToRef(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>, result: Vector3): void;
  81598. /**
  81599. * Returns a new Vector3 as the normalization of the given vector
  81600. * @param vector defines the Vector3 to normalize
  81601. * @returns the new Vector3
  81602. */
  81603. static Normalize(vector: DeepImmutable<Vector3>): Vector3;
  81604. /**
  81605. * Sets the given vector "result" with the normalization of the given first vector
  81606. * @param vector defines the Vector3 to normalize
  81607. * @param result defines the Vector3 where to store the result
  81608. */
  81609. static NormalizeToRef(vector: DeepImmutable<Vector3>, result: Vector3): void;
  81610. /**
  81611. * Project a Vector3 onto screen space
  81612. * @param vector defines the Vector3 to project
  81613. * @param world defines the world matrix to use
  81614. * @param transform defines the transform (view x projection) matrix to use
  81615. * @param viewport defines the screen viewport to use
  81616. * @returns the new Vector3
  81617. */
  81618. static Project(vector: DeepImmutable<Vector3>, world: DeepImmutable<Matrix>, transform: DeepImmutable<Matrix>, viewport: DeepImmutable<Viewport>): Vector3;
  81619. /** @hidden */
  81620. static _UnprojectFromInvertedMatrixToRef(source: DeepImmutable<Vector3>, matrix: DeepImmutable<Matrix>, result: Vector3): void;
  81621. /**
  81622. * Unproject from screen space to object space
  81623. * @param source defines the screen space Vector3 to use
  81624. * @param viewportWidth defines the current width of the viewport
  81625. * @param viewportHeight defines the current height of the viewport
  81626. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  81627. * @param transform defines the transform (view x projection) matrix to use
  81628. * @returns the new Vector3
  81629. */
  81630. static UnprojectFromTransform(source: Vector3, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, transform: DeepImmutable<Matrix>): Vector3;
  81631. /**
  81632. * Unproject from screen space to object space
  81633. * @param source defines the screen space Vector3 to use
  81634. * @param viewportWidth defines the current width of the viewport
  81635. * @param viewportHeight defines the current height of the viewport
  81636. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  81637. * @param view defines the view matrix to use
  81638. * @param projection defines the projection matrix to use
  81639. * @returns the new Vector3
  81640. */
  81641. static Unproject(source: DeepImmutable<Vector3>, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Vector3;
  81642. /**
  81643. * Unproject from screen space to object space
  81644. * @param source defines the screen space Vector3 to use
  81645. * @param viewportWidth defines the current width of the viewport
  81646. * @param viewportHeight defines the current height of the viewport
  81647. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  81648. * @param view defines the view matrix to use
  81649. * @param projection defines the projection matrix to use
  81650. * @param result defines the Vector3 where to store the result
  81651. */
  81652. static UnprojectToRef(source: DeepImmutable<Vector3>, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, result: Vector3): void;
  81653. /**
  81654. * Unproject from screen space to object space
  81655. * @param sourceX defines the screen space x coordinate to use
  81656. * @param sourceY defines the screen space y coordinate to use
  81657. * @param sourceZ defines the screen space z coordinate to use
  81658. * @param viewportWidth defines the current width of the viewport
  81659. * @param viewportHeight defines the current height of the viewport
  81660. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  81661. * @param view defines the view matrix to use
  81662. * @param projection defines the projection matrix to use
  81663. * @param result defines the Vector3 where to store the result
  81664. */
  81665. static UnprojectFloatsToRef(sourceX: float, sourceY: float, sourceZ: float, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, result: Vector3): void;
  81666. /**
  81667. * Gets the minimal coordinate values between two Vector3
  81668. * @param left defines the first operand
  81669. * @param right defines the second operand
  81670. * @returns the new Vector3
  81671. */
  81672. static Minimize(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  81673. /**
  81674. * Gets the maximal coordinate values between two Vector3
  81675. * @param left defines the first operand
  81676. * @param right defines the second operand
  81677. * @returns the new Vector3
  81678. */
  81679. static Maximize(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  81680. /**
  81681. * Returns the distance between the vectors "value1" and "value2"
  81682. * @param value1 defines the first operand
  81683. * @param value2 defines the second operand
  81684. * @returns the distance
  81685. */
  81686. static Distance(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): number;
  81687. /**
  81688. * Returns the squared distance between the vectors "value1" and "value2"
  81689. * @param value1 defines the first operand
  81690. * @param value2 defines the second operand
  81691. * @returns the squared distance
  81692. */
  81693. static DistanceSquared(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): number;
  81694. /**
  81695. * Returns a new Vector3 located at the center between "value1" and "value2"
  81696. * @param value1 defines the first operand
  81697. * @param value2 defines the second operand
  81698. * @returns the new Vector3
  81699. */
  81700. static Center(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): Vector3;
  81701. /**
  81702. * Given three orthogonal normalized left-handed oriented Vector3 axis in space (target system),
  81703. * RotationFromAxis() returns the rotation Euler angles (ex : rotation.x, rotation.y, rotation.z) to apply
  81704. * to something in order to rotate it from its local system to the given target system
  81705. * Note: axis1, axis2 and axis3 are normalized during this operation
  81706. * @param axis1 defines the first axis
  81707. * @param axis2 defines the second axis
  81708. * @param axis3 defines the third axis
  81709. * @returns a new Vector3
  81710. */
  81711. static RotationFromAxis(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>): Vector3;
  81712. /**
  81713. * The same than RotationFromAxis but updates the given ref Vector3 parameter instead of returning a new Vector3
  81714. * @param axis1 defines the first axis
  81715. * @param axis2 defines the second axis
  81716. * @param axis3 defines the third axis
  81717. * @param ref defines the Vector3 where to store the result
  81718. */
  81719. static RotationFromAxisToRef(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>, ref: Vector3): void;
  81720. }
  81721. /**
  81722. * Vector4 class created for EulerAngle class conversion to Quaternion
  81723. */
  81724. export class Vector4 {
  81725. /** x value of the vector */
  81726. x: number;
  81727. /** y value of the vector */
  81728. y: number;
  81729. /** z value of the vector */
  81730. z: number;
  81731. /** w value of the vector */
  81732. w: number;
  81733. /**
  81734. * Creates a Vector4 object from the given floats.
  81735. * @param x x value of the vector
  81736. * @param y y value of the vector
  81737. * @param z z value of the vector
  81738. * @param w w value of the vector
  81739. */
  81740. constructor(
  81741. /** x value of the vector */
  81742. x: number,
  81743. /** y value of the vector */
  81744. y: number,
  81745. /** z value of the vector */
  81746. z: number,
  81747. /** w value of the vector */
  81748. w: number);
  81749. /**
  81750. * Returns the string with the Vector4 coordinates.
  81751. * @returns a string containing all the vector values
  81752. */
  81753. toString(): string;
  81754. /**
  81755. * Returns the string "Vector4".
  81756. * @returns "Vector4"
  81757. */
  81758. getClassName(): string;
  81759. /**
  81760. * Returns the Vector4 hash code.
  81761. * @returns a unique hash code
  81762. */
  81763. getHashCode(): number;
  81764. /**
  81765. * Returns a new array populated with 4 elements : the Vector4 coordinates.
  81766. * @returns the resulting array
  81767. */
  81768. asArray(): number[];
  81769. /**
  81770. * Populates the given array from the given index with the Vector4 coordinates.
  81771. * @param array array to populate
  81772. * @param index index of the array to start at (default: 0)
  81773. * @returns the Vector4.
  81774. */
  81775. toArray(array: FloatArray, index?: number): Vector4;
  81776. /**
  81777. * Adds the given vector to the current Vector4.
  81778. * @param otherVector the vector to add
  81779. * @returns the updated Vector4.
  81780. */
  81781. addInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  81782. /**
  81783. * Returns a new Vector4 as the result of the addition of the current Vector4 and the given one.
  81784. * @param otherVector the vector to add
  81785. * @returns the resulting vector
  81786. */
  81787. add(otherVector: DeepImmutable<Vector4>): Vector4;
  81788. /**
  81789. * Updates the given vector "result" with the result of the addition of the current Vector4 and the given one.
  81790. * @param otherVector the vector to add
  81791. * @param result the vector to store the result
  81792. * @returns the current Vector4.
  81793. */
  81794. addToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  81795. /**
  81796. * Subtract in place the given vector from the current Vector4.
  81797. * @param otherVector the vector to subtract
  81798. * @returns the updated Vector4.
  81799. */
  81800. subtractInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  81801. /**
  81802. * Returns a new Vector4 with the result of the subtraction of the given vector from the current Vector4.
  81803. * @param otherVector the vector to add
  81804. * @returns the new vector with the result
  81805. */
  81806. subtract(otherVector: DeepImmutable<Vector4>): Vector4;
  81807. /**
  81808. * Sets the given vector "result" with the result of the subtraction of the given vector from the current Vector4.
  81809. * @param otherVector the vector to subtract
  81810. * @param result the vector to store the result
  81811. * @returns the current Vector4.
  81812. */
  81813. subtractToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  81814. /**
  81815. * Returns a new Vector4 set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  81816. */
  81817. /**
  81818. * Returns a new Vector4 set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  81819. * @param x value to subtract
  81820. * @param y value to subtract
  81821. * @param z value to subtract
  81822. * @param w value to subtract
  81823. * @returns new vector containing the result
  81824. */
  81825. subtractFromFloats(x: number, y: number, z: number, w: number): Vector4;
  81826. /**
  81827. * Sets the given vector "result" set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  81828. * @param x value to subtract
  81829. * @param y value to subtract
  81830. * @param z value to subtract
  81831. * @param w value to subtract
  81832. * @param result the vector to store the result in
  81833. * @returns the current Vector4.
  81834. */
  81835. subtractFromFloatsToRef(x: number, y: number, z: number, w: number, result: Vector4): Vector4;
  81836. /**
  81837. * Returns a new Vector4 set with the current Vector4 negated coordinates.
  81838. * @returns a new vector with the negated values
  81839. */
  81840. negate(): Vector4;
  81841. /**
  81842. * Negate this vector in place
  81843. * @returns this
  81844. */
  81845. negateInPlace(): Vector4;
  81846. /**
  81847. * Negate the current Vector4 and stores the result in the given vector "result" coordinates
  81848. * @param result defines the Vector3 object where to store the result
  81849. * @returns the current Vector4
  81850. */
  81851. negateToRef(result: Vector4): Vector4;
  81852. /**
  81853. * Multiplies the current Vector4 coordinates by scale (float).
  81854. * @param scale the number to scale with
  81855. * @returns the updated Vector4.
  81856. */
  81857. scaleInPlace(scale: number): Vector4;
  81858. /**
  81859. * Returns a new Vector4 set with the current Vector4 coordinates multiplied by scale (float).
  81860. * @param scale the number to scale with
  81861. * @returns a new vector with the result
  81862. */
  81863. scale(scale: number): Vector4;
  81864. /**
  81865. * Sets the given vector "result" with the current Vector4 coordinates multiplied by scale (float).
  81866. * @param scale the number to scale with
  81867. * @param result a vector to store the result in
  81868. * @returns the current Vector4.
  81869. */
  81870. scaleToRef(scale: number, result: Vector4): Vector4;
  81871. /**
  81872. * Scale the current Vector4 values by a factor and add the result to a given Vector4
  81873. * @param scale defines the scale factor
  81874. * @param result defines the Vector4 object where to store the result
  81875. * @returns the unmodified current Vector4
  81876. */
  81877. scaleAndAddToRef(scale: number, result: Vector4): Vector4;
  81878. /**
  81879. * Boolean : True if the current Vector4 coordinates are stricly equal to the given ones.
  81880. * @param otherVector the vector to compare against
  81881. * @returns true if they are equal
  81882. */
  81883. equals(otherVector: DeepImmutable<Vector4>): boolean;
  81884. /**
  81885. * Boolean : True if the current Vector4 coordinates are each beneath the distance "epsilon" from the given vector ones.
  81886. * @param otherVector vector to compare against
  81887. * @param epsilon (Default: very small number)
  81888. * @returns true if they are equal
  81889. */
  81890. equalsWithEpsilon(otherVector: DeepImmutable<Vector4>, epsilon?: number): boolean;
  81891. /**
  81892. * Boolean : True if the given floats are strictly equal to the current Vector4 coordinates.
  81893. * @param x x value to compare against
  81894. * @param y y value to compare against
  81895. * @param z z value to compare against
  81896. * @param w w value to compare against
  81897. * @returns true if equal
  81898. */
  81899. equalsToFloats(x: number, y: number, z: number, w: number): boolean;
  81900. /**
  81901. * Multiplies in place the current Vector4 by the given one.
  81902. * @param otherVector vector to multiple with
  81903. * @returns the updated Vector4.
  81904. */
  81905. multiplyInPlace(otherVector: Vector4): Vector4;
  81906. /**
  81907. * Returns a new Vector4 set with the multiplication result of the current Vector4 and the given one.
  81908. * @param otherVector vector to multiple with
  81909. * @returns resulting new vector
  81910. */
  81911. multiply(otherVector: DeepImmutable<Vector4>): Vector4;
  81912. /**
  81913. * Updates the given vector "result" with the multiplication result of the current Vector4 and the given one.
  81914. * @param otherVector vector to multiple with
  81915. * @param result vector to store the result
  81916. * @returns the current Vector4.
  81917. */
  81918. multiplyToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  81919. /**
  81920. * Returns a new Vector4 set with the multiplication result of the given floats and the current Vector4 coordinates.
  81921. * @param x x value multiply with
  81922. * @param y y value multiply with
  81923. * @param z z value multiply with
  81924. * @param w w value multiply with
  81925. * @returns resulting new vector
  81926. */
  81927. multiplyByFloats(x: number, y: number, z: number, w: number): Vector4;
  81928. /**
  81929. * Returns a new Vector4 set with the division result of the current Vector4 by the given one.
  81930. * @param otherVector vector to devide with
  81931. * @returns resulting new vector
  81932. */
  81933. divide(otherVector: DeepImmutable<Vector4>): Vector4;
  81934. /**
  81935. * Updates the given vector "result" with the division result of the current Vector4 by the given one.
  81936. * @param otherVector vector to devide with
  81937. * @param result vector to store the result
  81938. * @returns the current Vector4.
  81939. */
  81940. divideToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  81941. /**
  81942. * Divides the current Vector3 coordinates by the given ones.
  81943. * @param otherVector vector to devide with
  81944. * @returns the updated Vector3.
  81945. */
  81946. divideInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  81947. /**
  81948. * Updates the Vector4 coordinates with the minimum values between its own and the given vector ones
  81949. * @param other defines the second operand
  81950. * @returns the current updated Vector4
  81951. */
  81952. minimizeInPlace(other: DeepImmutable<Vector4>): Vector4;
  81953. /**
  81954. * Updates the Vector4 coordinates with the maximum values between its own and the given vector ones
  81955. * @param other defines the second operand
  81956. * @returns the current updated Vector4
  81957. */
  81958. maximizeInPlace(other: DeepImmutable<Vector4>): Vector4;
  81959. /**
  81960. * Gets a new Vector4 from current Vector4 floored values
  81961. * @returns a new Vector4
  81962. */
  81963. floor(): Vector4;
  81964. /**
  81965. * Gets a new Vector4 from current Vector3 floored values
  81966. * @returns a new Vector4
  81967. */
  81968. fract(): Vector4;
  81969. /**
  81970. * Returns the Vector4 length (float).
  81971. * @returns the length
  81972. */
  81973. length(): number;
  81974. /**
  81975. * Returns the Vector4 squared length (float).
  81976. * @returns the length squared
  81977. */
  81978. lengthSquared(): number;
  81979. /**
  81980. * Normalizes in place the Vector4.
  81981. * @returns the updated Vector4.
  81982. */
  81983. normalize(): Vector4;
  81984. /**
  81985. * Returns a new Vector3 from the Vector4 (x, y, z) coordinates.
  81986. * @returns this converted to a new vector3
  81987. */
  81988. toVector3(): Vector3;
  81989. /**
  81990. * Returns a new Vector4 copied from the current one.
  81991. * @returns the new cloned vector
  81992. */
  81993. clone(): Vector4;
  81994. /**
  81995. * Updates the current Vector4 with the given one coordinates.
  81996. * @param source the source vector to copy from
  81997. * @returns the updated Vector4.
  81998. */
  81999. copyFrom(source: DeepImmutable<Vector4>): Vector4;
  82000. /**
  82001. * Updates the current Vector4 coordinates with the given floats.
  82002. * @param x float to copy from
  82003. * @param y float to copy from
  82004. * @param z float to copy from
  82005. * @param w float to copy from
  82006. * @returns the updated Vector4.
  82007. */
  82008. copyFromFloats(x: number, y: number, z: number, w: number): Vector4;
  82009. /**
  82010. * Updates the current Vector4 coordinates with the given floats.
  82011. * @param x float to set from
  82012. * @param y float to set from
  82013. * @param z float to set from
  82014. * @param w float to set from
  82015. * @returns the updated Vector4.
  82016. */
  82017. set(x: number, y: number, z: number, w: number): Vector4;
  82018. /**
  82019. * Copies the given float to the current Vector3 coordinates
  82020. * @param v defines the x, y, z and w coordinates of the operand
  82021. * @returns the current updated Vector3
  82022. */
  82023. setAll(v: number): Vector4;
  82024. /**
  82025. * Returns a new Vector4 set from the starting index of the given array.
  82026. * @param array the array to pull values from
  82027. * @param offset the offset into the array to start at
  82028. * @returns the new vector
  82029. */
  82030. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector4;
  82031. /**
  82032. * Updates the given vector "result" from the starting index of the given array.
  82033. * @param array the array to pull values from
  82034. * @param offset the offset into the array to start at
  82035. * @param result the vector to store the result in
  82036. */
  82037. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector4): void;
  82038. /**
  82039. * Updates the given vector "result" from the starting index of the given Float32Array.
  82040. * @param array the array to pull values from
  82041. * @param offset the offset into the array to start at
  82042. * @param result the vector to store the result in
  82043. */
  82044. static FromFloatArrayToRef(array: DeepImmutable<Float32Array>, offset: number, result: Vector4): void;
  82045. /**
  82046. * Updates the given vector "result" coordinates from the given floats.
  82047. * @param x float to set from
  82048. * @param y float to set from
  82049. * @param z float to set from
  82050. * @param w float to set from
  82051. * @param result the vector to the floats in
  82052. */
  82053. static FromFloatsToRef(x: number, y: number, z: number, w: number, result: Vector4): void;
  82054. /**
  82055. * Returns a new Vector4 set to (0.0, 0.0, 0.0, 0.0)
  82056. * @returns the new vector
  82057. */
  82058. static Zero(): Vector4;
  82059. /**
  82060. * Returns a new Vector4 set to (1.0, 1.0, 1.0, 1.0)
  82061. * @returns the new vector
  82062. */
  82063. static One(): Vector4;
  82064. /**
  82065. * Returns a new normalized Vector4 from the given one.
  82066. * @param vector the vector to normalize
  82067. * @returns the vector
  82068. */
  82069. static Normalize(vector: DeepImmutable<Vector4>): Vector4;
  82070. /**
  82071. * Updates the given vector "result" from the normalization of the given one.
  82072. * @param vector the vector to normalize
  82073. * @param result the vector to store the result in
  82074. */
  82075. static NormalizeToRef(vector: DeepImmutable<Vector4>, result: Vector4): void;
  82076. /**
  82077. * Returns a vector with the minimum values from the left and right vectors
  82078. * @param left left vector to minimize
  82079. * @param right right vector to minimize
  82080. * @returns a new vector with the minimum of the left and right vector values
  82081. */
  82082. static Minimize(left: DeepImmutable<Vector4>, right: DeepImmutable<Vector4>): Vector4;
  82083. /**
  82084. * Returns a vector with the maximum values from the left and right vectors
  82085. * @param left left vector to maximize
  82086. * @param right right vector to maximize
  82087. * @returns a new vector with the maximum of the left and right vector values
  82088. */
  82089. static Maximize(left: DeepImmutable<Vector4>, right: DeepImmutable<Vector4>): Vector4;
  82090. /**
  82091. * Returns the distance (float) between the vectors "value1" and "value2".
  82092. * @param value1 value to calulate the distance between
  82093. * @param value2 value to calulate the distance between
  82094. * @return the distance between the two vectors
  82095. */
  82096. static Distance(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): number;
  82097. /**
  82098. * Returns the squared distance (float) between the vectors "value1" and "value2".
  82099. * @param value1 value to calulate the distance between
  82100. * @param value2 value to calulate the distance between
  82101. * @return the distance between the two vectors squared
  82102. */
  82103. static DistanceSquared(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): number;
  82104. /**
  82105. * Returns a new Vector4 located at the center between the vectors "value1" and "value2".
  82106. * @param value1 value to calulate the center between
  82107. * @param value2 value to calulate the center between
  82108. * @return the center between the two vectors
  82109. */
  82110. static Center(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): Vector4;
  82111. /**
  82112. * Returns a new Vector4 set with the result of the normal transformation by the given matrix of the given vector.
  82113. * This methods computes transformed normalized direction vectors only.
  82114. * @param vector the vector to transform
  82115. * @param transformation the transformation matrix to apply
  82116. * @returns the new vector
  82117. */
  82118. static TransformNormal(vector: DeepImmutable<Vector4>, transformation: DeepImmutable<Matrix>): Vector4;
  82119. /**
  82120. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given vector.
  82121. * This methods computes transformed normalized direction vectors only.
  82122. * @param vector the vector to transform
  82123. * @param transformation the transformation matrix to apply
  82124. * @param result the vector to store the result in
  82125. */
  82126. static TransformNormalToRef(vector: DeepImmutable<Vector4>, transformation: DeepImmutable<Matrix>, result: Vector4): void;
  82127. /**
  82128. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given floats (x, y, z, w).
  82129. * This methods computes transformed normalized direction vectors only.
  82130. * @param x value to transform
  82131. * @param y value to transform
  82132. * @param z value to transform
  82133. * @param w value to transform
  82134. * @param transformation the transformation matrix to apply
  82135. * @param result the vector to store the results in
  82136. */
  82137. static TransformNormalFromFloatsToRef(x: number, y: number, z: number, w: number, transformation: DeepImmutable<Matrix>, result: Vector4): void;
  82138. /**
  82139. * Creates a new Vector4 from a Vector3
  82140. * @param source defines the source data
  82141. * @param w defines the 4th component (default is 0)
  82142. * @returns a new Vector4
  82143. */
  82144. static FromVector3(source: Vector3, w?: number): Vector4;
  82145. }
  82146. /**
  82147. * Class used to store quaternion data
  82148. * @see https://en.wikipedia.org/wiki/Quaternion
  82149. * @see https://doc.babylonjs.com/features/position,_rotation,_scaling
  82150. */
  82151. export class Quaternion {
  82152. /** @hidden */
  82153. _x: number;
  82154. /** @hidden */
  82155. _y: number;
  82156. /** @hidden */
  82157. _z: number;
  82158. /** @hidden */
  82159. _w: number;
  82160. /** @hidden */
  82161. _isDirty: boolean;
  82162. /** Gets or sets the x coordinate */
  82163. get x(): number;
  82164. set x(value: number);
  82165. /** Gets or sets the y coordinate */
  82166. get y(): number;
  82167. set y(value: number);
  82168. /** Gets or sets the z coordinate */
  82169. get z(): number;
  82170. set z(value: number);
  82171. /** Gets or sets the w coordinate */
  82172. get w(): number;
  82173. set w(value: number);
  82174. /**
  82175. * Creates a new Quaternion from the given floats
  82176. * @param x defines the first component (0 by default)
  82177. * @param y defines the second component (0 by default)
  82178. * @param z defines the third component (0 by default)
  82179. * @param w defines the fourth component (1.0 by default)
  82180. */
  82181. constructor(x?: number, y?: number, z?: number, w?: number);
  82182. /**
  82183. * Gets a string representation for the current quaternion
  82184. * @returns a string with the Quaternion coordinates
  82185. */
  82186. toString(): string;
  82187. /**
  82188. * Gets the class name of the quaternion
  82189. * @returns the string "Quaternion"
  82190. */
  82191. getClassName(): string;
  82192. /**
  82193. * Gets a hash code for this quaternion
  82194. * @returns the quaternion hash code
  82195. */
  82196. getHashCode(): number;
  82197. /**
  82198. * Copy the quaternion to an array
  82199. * @returns a new array populated with 4 elements from the quaternion coordinates
  82200. */
  82201. asArray(): number[];
  82202. /**
  82203. * Check if two quaternions are equals
  82204. * @param otherQuaternion defines the second operand
  82205. * @return true if the current quaternion and the given one coordinates are strictly equals
  82206. */
  82207. equals(otherQuaternion: DeepImmutable<Quaternion>): boolean;
  82208. /**
  82209. * Gets a boolean if two quaternions are equals (using an epsilon value)
  82210. * @param otherQuaternion defines the other quaternion
  82211. * @param epsilon defines the minimal distance to consider equality
  82212. * @returns true if the given quaternion coordinates are close to the current ones by a distance of epsilon.
  82213. */
  82214. equalsWithEpsilon(otherQuaternion: DeepImmutable<Quaternion>, epsilon?: number): boolean;
  82215. /**
  82216. * Clone the current quaternion
  82217. * @returns a new quaternion copied from the current one
  82218. */
  82219. clone(): Quaternion;
  82220. /**
  82221. * Copy a quaternion to the current one
  82222. * @param other defines the other quaternion
  82223. * @returns the updated current quaternion
  82224. */
  82225. copyFrom(other: DeepImmutable<Quaternion>): Quaternion;
  82226. /**
  82227. * Updates the current quaternion with the given float coordinates
  82228. * @param x defines the x coordinate
  82229. * @param y defines the y coordinate
  82230. * @param z defines the z coordinate
  82231. * @param w defines the w coordinate
  82232. * @returns the updated current quaternion
  82233. */
  82234. copyFromFloats(x: number, y: number, z: number, w: number): Quaternion;
  82235. /**
  82236. * Updates the current quaternion from the given float coordinates
  82237. * @param x defines the x coordinate
  82238. * @param y defines the y coordinate
  82239. * @param z defines the z coordinate
  82240. * @param w defines the w coordinate
  82241. * @returns the updated current quaternion
  82242. */
  82243. set(x: number, y: number, z: number, w: number): Quaternion;
  82244. /**
  82245. * Adds two quaternions
  82246. * @param other defines the second operand
  82247. * @returns a new quaternion as the addition result of the given one and the current quaternion
  82248. */
  82249. add(other: DeepImmutable<Quaternion>): Quaternion;
  82250. /**
  82251. * Add a quaternion to the current one
  82252. * @param other defines the quaternion to add
  82253. * @returns the current quaternion
  82254. */
  82255. addInPlace(other: DeepImmutable<Quaternion>): Quaternion;
  82256. /**
  82257. * Subtract two quaternions
  82258. * @param other defines the second operand
  82259. * @returns a new quaternion as the subtraction result of the given one from the current one
  82260. */
  82261. subtract(other: Quaternion): Quaternion;
  82262. /**
  82263. * Multiplies the current quaternion by a scale factor
  82264. * @param value defines the scale factor
  82265. * @returns a new quaternion set by multiplying the current quaternion coordinates by the float "scale"
  82266. */
  82267. scale(value: number): Quaternion;
  82268. /**
  82269. * Scale the current quaternion values by a factor and stores the result to a given quaternion
  82270. * @param scale defines the scale factor
  82271. * @param result defines the Quaternion object where to store the result
  82272. * @returns the unmodified current quaternion
  82273. */
  82274. scaleToRef(scale: number, result: Quaternion): Quaternion;
  82275. /**
  82276. * Multiplies in place the current quaternion by a scale factor
  82277. * @param value defines the scale factor
  82278. * @returns the current modified quaternion
  82279. */
  82280. scaleInPlace(value: number): Quaternion;
  82281. /**
  82282. * Scale the current quaternion values by a factor and add the result to a given quaternion
  82283. * @param scale defines the scale factor
  82284. * @param result defines the Quaternion object where to store the result
  82285. * @returns the unmodified current quaternion
  82286. */
  82287. scaleAndAddToRef(scale: number, result: Quaternion): Quaternion;
  82288. /**
  82289. * Multiplies two quaternions
  82290. * @param q1 defines the second operand
  82291. * @returns a new quaternion set as the multiplication result of the current one with the given one "q1"
  82292. */
  82293. multiply(q1: DeepImmutable<Quaternion>): Quaternion;
  82294. /**
  82295. * Sets the given "result" as the the multiplication result of the current one with the given one "q1"
  82296. * @param q1 defines the second operand
  82297. * @param result defines the target quaternion
  82298. * @returns the current quaternion
  82299. */
  82300. multiplyToRef(q1: DeepImmutable<Quaternion>, result: Quaternion): Quaternion;
  82301. /**
  82302. * Updates the current quaternion with the multiplication of itself with the given one "q1"
  82303. * @param q1 defines the second operand
  82304. * @returns the currentupdated quaternion
  82305. */
  82306. multiplyInPlace(q1: DeepImmutable<Quaternion>): Quaternion;
  82307. /**
  82308. * Conjugates (1-q) the current quaternion and stores the result in the given quaternion
  82309. * @param ref defines the target quaternion
  82310. * @returns the current quaternion
  82311. */
  82312. conjugateToRef(ref: Quaternion): Quaternion;
  82313. /**
  82314. * Conjugates in place (1-q) the current quaternion
  82315. * @returns the current updated quaternion
  82316. */
  82317. conjugateInPlace(): Quaternion;
  82318. /**
  82319. * Conjugates in place (1-q) the current quaternion
  82320. * @returns a new quaternion
  82321. */
  82322. conjugate(): Quaternion;
  82323. /**
  82324. * Gets length of current quaternion
  82325. * @returns the quaternion length (float)
  82326. */
  82327. length(): number;
  82328. /**
  82329. * Normalize in place the current quaternion
  82330. * @returns the current updated quaternion
  82331. */
  82332. normalize(): Quaternion;
  82333. /**
  82334. * Returns a new Vector3 set with the Euler angles translated from the current quaternion
  82335. * @param order is a reserved parameter and is ignore for now
  82336. * @returns a new Vector3 containing the Euler angles
  82337. */
  82338. toEulerAngles(order?: string): Vector3;
  82339. /**
  82340. * Sets the given vector3 "result" with the Euler angles translated from the current quaternion
  82341. * @param result defines the vector which will be filled with the Euler angles
  82342. * @param order is a reserved parameter and is ignore for now
  82343. * @returns the current unchanged quaternion
  82344. */
  82345. toEulerAnglesToRef(result: Vector3): Quaternion;
  82346. /**
  82347. * Updates the given rotation matrix with the current quaternion values
  82348. * @param result defines the target matrix
  82349. * @returns the current unchanged quaternion
  82350. */
  82351. toRotationMatrix(result: Matrix): Quaternion;
  82352. /**
  82353. * Updates the current quaternion from the given rotation matrix values
  82354. * @param matrix defines the source matrix
  82355. * @returns the current updated quaternion
  82356. */
  82357. fromRotationMatrix(matrix: DeepImmutable<Matrix>): Quaternion;
  82358. /**
  82359. * Creates a new quaternion from a rotation matrix
  82360. * @param matrix defines the source matrix
  82361. * @returns a new quaternion created from the given rotation matrix values
  82362. */
  82363. static FromRotationMatrix(matrix: DeepImmutable<Matrix>): Quaternion;
  82364. /**
  82365. * Updates the given quaternion with the given rotation matrix values
  82366. * @param matrix defines the source matrix
  82367. * @param result defines the target quaternion
  82368. */
  82369. static FromRotationMatrixToRef(matrix: DeepImmutable<Matrix>, result: Quaternion): void;
  82370. /**
  82371. * Returns the dot product (float) between the quaternions "left" and "right"
  82372. * @param left defines the left operand
  82373. * @param right defines the right operand
  82374. * @returns the dot product
  82375. */
  82376. static Dot(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>): number;
  82377. /**
  82378. * Checks if the two quaternions are close to each other
  82379. * @param quat0 defines the first quaternion to check
  82380. * @param quat1 defines the second quaternion to check
  82381. * @returns true if the two quaternions are close to each other
  82382. */
  82383. static AreClose(quat0: DeepImmutable<Quaternion>, quat1: DeepImmutable<Quaternion>): boolean;
  82384. /**
  82385. * Creates an empty quaternion
  82386. * @returns a new quaternion set to (0.0, 0.0, 0.0)
  82387. */
  82388. static Zero(): Quaternion;
  82389. /**
  82390. * Inverse a given quaternion
  82391. * @param q defines the source quaternion
  82392. * @returns a new quaternion as the inverted current quaternion
  82393. */
  82394. static Inverse(q: DeepImmutable<Quaternion>): Quaternion;
  82395. /**
  82396. * Inverse a given quaternion
  82397. * @param q defines the source quaternion
  82398. * @param result the quaternion the result will be stored in
  82399. * @returns the result quaternion
  82400. */
  82401. static InverseToRef(q: Quaternion, result: Quaternion): Quaternion;
  82402. /**
  82403. * Creates an identity quaternion
  82404. * @returns the identity quaternion
  82405. */
  82406. static Identity(): Quaternion;
  82407. /**
  82408. * Gets a boolean indicating if the given quaternion is identity
  82409. * @param quaternion defines the quaternion to check
  82410. * @returns true if the quaternion is identity
  82411. */
  82412. static IsIdentity(quaternion: DeepImmutable<Quaternion>): boolean;
  82413. /**
  82414. * Creates a quaternion from a rotation around an axis
  82415. * @param axis defines the axis to use
  82416. * @param angle defines the angle to use
  82417. * @returns a new quaternion created from the given axis (Vector3) and angle in radians (float)
  82418. */
  82419. static RotationAxis(axis: DeepImmutable<Vector3>, angle: number): Quaternion;
  82420. /**
  82421. * Creates a rotation around an axis and stores it into the given quaternion
  82422. * @param axis defines the axis to use
  82423. * @param angle defines the angle to use
  82424. * @param result defines the target quaternion
  82425. * @returns the target quaternion
  82426. */
  82427. static RotationAxisToRef(axis: DeepImmutable<Vector3>, angle: number, result: Quaternion): Quaternion;
  82428. /**
  82429. * Creates a new quaternion from data stored into an array
  82430. * @param array defines the data source
  82431. * @param offset defines the offset in the source array where the data starts
  82432. * @returns a new quaternion
  82433. */
  82434. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Quaternion;
  82435. /**
  82436. * Updates the given quaternion "result" from the starting index of the given array.
  82437. * @param array the array to pull values from
  82438. * @param offset the offset into the array to start at
  82439. * @param result the quaternion to store the result in
  82440. */
  82441. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Quaternion): void;
  82442. /**
  82443. * Create a quaternion from Euler rotation angles
  82444. * @param x Pitch
  82445. * @param y Yaw
  82446. * @param z Roll
  82447. * @returns the new Quaternion
  82448. */
  82449. static FromEulerAngles(x: number, y: number, z: number): Quaternion;
  82450. /**
  82451. * Updates a quaternion from Euler rotation angles
  82452. * @param x Pitch
  82453. * @param y Yaw
  82454. * @param z Roll
  82455. * @param result the quaternion to store the result
  82456. * @returns the updated quaternion
  82457. */
  82458. static FromEulerAnglesToRef(x: number, y: number, z: number, result: Quaternion): Quaternion;
  82459. /**
  82460. * Create a quaternion from Euler rotation vector
  82461. * @param vec the Euler vector (x Pitch, y Yaw, z Roll)
  82462. * @returns the new Quaternion
  82463. */
  82464. static FromEulerVector(vec: DeepImmutable<Vector3>): Quaternion;
  82465. /**
  82466. * Updates a quaternion from Euler rotation vector
  82467. * @param vec the Euler vector (x Pitch, y Yaw, z Roll)
  82468. * @param result the quaternion to store the result
  82469. * @returns the updated quaternion
  82470. */
  82471. static FromEulerVectorToRef(vec: DeepImmutable<Vector3>, result: Quaternion): Quaternion;
  82472. /**
  82473. * Creates a new quaternion from the given Euler float angles (y, x, z)
  82474. * @param yaw defines the rotation around Y axis
  82475. * @param pitch defines the rotation around X axis
  82476. * @param roll defines the rotation around Z axis
  82477. * @returns the new quaternion
  82478. */
  82479. static RotationYawPitchRoll(yaw: number, pitch: number, roll: number): Quaternion;
  82480. /**
  82481. * Creates a new rotation from the given Euler float angles (y, x, z) and stores it in the target quaternion
  82482. * @param yaw defines the rotation around Y axis
  82483. * @param pitch defines the rotation around X axis
  82484. * @param roll defines the rotation around Z axis
  82485. * @param result defines the target quaternion
  82486. */
  82487. static RotationYawPitchRollToRef(yaw: number, pitch: number, roll: number, result: Quaternion): void;
  82488. /**
  82489. * Creates a new quaternion from the given Euler float angles expressed in z-x-z orientation
  82490. * @param alpha defines the rotation around first axis
  82491. * @param beta defines the rotation around second axis
  82492. * @param gamma defines the rotation around third axis
  82493. * @returns the new quaternion
  82494. */
  82495. static RotationAlphaBetaGamma(alpha: number, beta: number, gamma: number): Quaternion;
  82496. /**
  82497. * Creates a new quaternion from the given Euler float angles expressed in z-x-z orientation and stores it in the target quaternion
  82498. * @param alpha defines the rotation around first axis
  82499. * @param beta defines the rotation around second axis
  82500. * @param gamma defines the rotation around third axis
  82501. * @param result defines the target quaternion
  82502. */
  82503. static RotationAlphaBetaGammaToRef(alpha: number, beta: number, gamma: number, result: Quaternion): void;
  82504. /**
  82505. * 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)
  82506. * @param axis1 defines the first axis
  82507. * @param axis2 defines the second axis
  82508. * @param axis3 defines the third axis
  82509. * @returns the new quaternion
  82510. */
  82511. static RotationQuaternionFromAxis(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>): Quaternion;
  82512. /**
  82513. * 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
  82514. * @param axis1 defines the first axis
  82515. * @param axis2 defines the second axis
  82516. * @param axis3 defines the third axis
  82517. * @param ref defines the target quaternion
  82518. */
  82519. static RotationQuaternionFromAxisToRef(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>, ref: Quaternion): void;
  82520. /**
  82521. * Interpolates between two quaternions
  82522. * @param left defines first quaternion
  82523. * @param right defines second quaternion
  82524. * @param amount defines the gradient to use
  82525. * @returns the new interpolated quaternion
  82526. */
  82527. static Slerp(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>, amount: number): Quaternion;
  82528. /**
  82529. * Interpolates between two quaternions and stores it into a target quaternion
  82530. * @param left defines first quaternion
  82531. * @param right defines second quaternion
  82532. * @param amount defines the gradient to use
  82533. * @param result defines the target quaternion
  82534. */
  82535. static SlerpToRef(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>, amount: number, result: Quaternion): void;
  82536. /**
  82537. * Interpolate between two quaternions using Hermite interpolation
  82538. * @param value1 defines first quaternion
  82539. * @param tangent1 defines the incoming tangent
  82540. * @param value2 defines second quaternion
  82541. * @param tangent2 defines the outgoing tangent
  82542. * @param amount defines the target quaternion
  82543. * @returns the new interpolated quaternion
  82544. */
  82545. static Hermite(value1: DeepImmutable<Quaternion>, tangent1: DeepImmutable<Quaternion>, value2: DeepImmutable<Quaternion>, tangent2: DeepImmutable<Quaternion>, amount: number): Quaternion;
  82546. }
  82547. /**
  82548. * Class used to store matrix data (4x4)
  82549. */
  82550. export class Matrix {
  82551. /**
  82552. * Gets the precision of matrix computations
  82553. */
  82554. static get Use64Bits(): boolean;
  82555. private static _updateFlagSeed;
  82556. private static _identityReadOnly;
  82557. private _isIdentity;
  82558. private _isIdentityDirty;
  82559. private _isIdentity3x2;
  82560. private _isIdentity3x2Dirty;
  82561. /**
  82562. * Gets the update flag of the matrix which is an unique number for the matrix.
  82563. * It will be incremented every time the matrix data change.
  82564. * You can use it to speed the comparison between two versions of the same matrix.
  82565. */
  82566. updateFlag: number;
  82567. private readonly _m;
  82568. /**
  82569. * Gets the internal data of the matrix
  82570. */
  82571. get m(): DeepImmutable<Float32Array | Array<number>>;
  82572. /** @hidden */
  82573. _markAsUpdated(): void;
  82574. /** @hidden */
  82575. private _updateIdentityStatus;
  82576. /**
  82577. * Creates an empty matrix (filled with zeros)
  82578. */
  82579. constructor();
  82580. /**
  82581. * Check if the current matrix is identity
  82582. * @returns true is the matrix is the identity matrix
  82583. */
  82584. isIdentity(): boolean;
  82585. /**
  82586. * Check if the current matrix is identity as a texture matrix (3x2 store in 4x4)
  82587. * @returns true is the matrix is the identity matrix
  82588. */
  82589. isIdentityAs3x2(): boolean;
  82590. /**
  82591. * Gets the determinant of the matrix
  82592. * @returns the matrix determinant
  82593. */
  82594. determinant(): number;
  82595. /**
  82596. * Returns the matrix as a Float32Array or Array<number>
  82597. * @returns the matrix underlying array
  82598. */
  82599. toArray(): DeepImmutable<Float32Array | Array<number>>;
  82600. /**
  82601. * Returns the matrix as a Float32Array or Array<number>
  82602. * @returns the matrix underlying array.
  82603. */
  82604. asArray(): DeepImmutable<Float32Array | Array<number>>;
  82605. /**
  82606. * Inverts the current matrix in place
  82607. * @returns the current inverted matrix
  82608. */
  82609. invert(): Matrix;
  82610. /**
  82611. * Sets all the matrix elements to zero
  82612. * @returns the current matrix
  82613. */
  82614. reset(): Matrix;
  82615. /**
  82616. * Adds the current matrix with a second one
  82617. * @param other defines the matrix to add
  82618. * @returns a new matrix as the addition of the current matrix and the given one
  82619. */
  82620. add(other: DeepImmutable<Matrix>): Matrix;
  82621. /**
  82622. * Sets the given matrix "result" to the addition of the current matrix and the given one
  82623. * @param other defines the matrix to add
  82624. * @param result defines the target matrix
  82625. * @returns the current matrix
  82626. */
  82627. addToRef(other: DeepImmutable<Matrix>, result: Matrix): Matrix;
  82628. /**
  82629. * Adds in place the given matrix to the current matrix
  82630. * @param other defines the second operand
  82631. * @returns the current updated matrix
  82632. */
  82633. addToSelf(other: DeepImmutable<Matrix>): Matrix;
  82634. /**
  82635. * Sets the given matrix to the current inverted Matrix
  82636. * @param other defines the target matrix
  82637. * @returns the unmodified current matrix
  82638. */
  82639. invertToRef(other: Matrix): Matrix;
  82640. /**
  82641. * add a value at the specified position in the current Matrix
  82642. * @param index the index of the value within the matrix. between 0 and 15.
  82643. * @param value the value to be added
  82644. * @returns the current updated matrix
  82645. */
  82646. addAtIndex(index: number, value: number): Matrix;
  82647. /**
  82648. * mutiply the specified position in the current Matrix by a value
  82649. * @param index the index of the value within the matrix. between 0 and 15.
  82650. * @param value the value to be added
  82651. * @returns the current updated matrix
  82652. */
  82653. multiplyAtIndex(index: number, value: number): Matrix;
  82654. /**
  82655. * Inserts the translation vector (using 3 floats) in the current matrix
  82656. * @param x defines the 1st component of the translation
  82657. * @param y defines the 2nd component of the translation
  82658. * @param z defines the 3rd component of the translation
  82659. * @returns the current updated matrix
  82660. */
  82661. setTranslationFromFloats(x: number, y: number, z: number): Matrix;
  82662. /**
  82663. * Adds the translation vector (using 3 floats) in the current matrix
  82664. * @param x defines the 1st component of the translation
  82665. * @param y defines the 2nd component of the translation
  82666. * @param z defines the 3rd component of the translation
  82667. * @returns the current updated matrix
  82668. */
  82669. addTranslationFromFloats(x: number, y: number, z: number): Matrix;
  82670. /**
  82671. * Inserts the translation vector in the current matrix
  82672. * @param vector3 defines the translation to insert
  82673. * @returns the current updated matrix
  82674. */
  82675. setTranslation(vector3: DeepImmutable<Vector3>): Matrix;
  82676. /**
  82677. * Gets the translation value of the current matrix
  82678. * @returns a new Vector3 as the extracted translation from the matrix
  82679. */
  82680. getTranslation(): Vector3;
  82681. /**
  82682. * Fill a Vector3 with the extracted translation from the matrix
  82683. * @param result defines the Vector3 where to store the translation
  82684. * @returns the current matrix
  82685. */
  82686. getTranslationToRef(result: Vector3): Matrix;
  82687. /**
  82688. * Remove rotation and scaling part from the matrix
  82689. * @returns the updated matrix
  82690. */
  82691. removeRotationAndScaling(): Matrix;
  82692. /**
  82693. * Multiply two matrices
  82694. * @param other defines the second operand
  82695. * @returns a new matrix set with the multiplication result of the current Matrix and the given one
  82696. */
  82697. multiply(other: DeepImmutable<Matrix>): Matrix;
  82698. /**
  82699. * Copy the current matrix from the given one
  82700. * @param other defines the source matrix
  82701. * @returns the current updated matrix
  82702. */
  82703. copyFrom(other: DeepImmutable<Matrix>): Matrix;
  82704. /**
  82705. * Populates the given array from the starting index with the current matrix values
  82706. * @param array defines the target array
  82707. * @param offset defines the offset in the target array where to start storing values
  82708. * @returns the current matrix
  82709. */
  82710. copyToArray(array: Float32Array | Array<number>, offset?: number): Matrix;
  82711. /**
  82712. * Sets the given matrix "result" with the multiplication result of the current Matrix and the given one
  82713. * @param other defines the second operand
  82714. * @param result defines the matrix where to store the multiplication
  82715. * @returns the current matrix
  82716. */
  82717. multiplyToRef(other: DeepImmutable<Matrix>, result: Matrix): Matrix;
  82718. /**
  82719. * Sets the Float32Array "result" from the given index "offset" with the multiplication of the current matrix and the given one
  82720. * @param other defines the second operand
  82721. * @param result defines the array where to store the multiplication
  82722. * @param offset defines the offset in the target array where to start storing values
  82723. * @returns the current matrix
  82724. */
  82725. multiplyToArray(other: DeepImmutable<Matrix>, result: Float32Array | Array<number>, offset: number): Matrix;
  82726. /**
  82727. * Check equality between this matrix and a second one
  82728. * @param value defines the second matrix to compare
  82729. * @returns true is the current matrix and the given one values are strictly equal
  82730. */
  82731. equals(value: DeepImmutable<Matrix>): boolean;
  82732. /**
  82733. * Clone the current matrix
  82734. * @returns a new matrix from the current matrix
  82735. */
  82736. clone(): Matrix;
  82737. /**
  82738. * Returns the name of the current matrix class
  82739. * @returns the string "Matrix"
  82740. */
  82741. getClassName(): string;
  82742. /**
  82743. * Gets the hash code of the current matrix
  82744. * @returns the hash code
  82745. */
  82746. getHashCode(): number;
  82747. /**
  82748. * Decomposes the current Matrix into a translation, rotation and scaling components
  82749. * @param scale defines the scale vector3 given as a reference to update
  82750. * @param rotation defines the rotation quaternion given as a reference to update
  82751. * @param translation defines the translation vector3 given as a reference to update
  82752. * @returns true if operation was successful
  82753. */
  82754. decompose(scale?: Vector3, rotation?: Quaternion, translation?: Vector3): boolean;
  82755. /**
  82756. * Gets specific row of the matrix
  82757. * @param index defines the number of the row to get
  82758. * @returns the index-th row of the current matrix as a new Vector4
  82759. */
  82760. getRow(index: number): Nullable<Vector4>;
  82761. /**
  82762. * Sets the index-th row of the current matrix to the vector4 values
  82763. * @param index defines the number of the row to set
  82764. * @param row defines the target vector4
  82765. * @returns the updated current matrix
  82766. */
  82767. setRow(index: number, row: Vector4): Matrix;
  82768. /**
  82769. * Compute the transpose of the matrix
  82770. * @returns the new transposed matrix
  82771. */
  82772. transpose(): Matrix;
  82773. /**
  82774. * Compute the transpose of the matrix and store it in a given matrix
  82775. * @param result defines the target matrix
  82776. * @returns the current matrix
  82777. */
  82778. transposeToRef(result: Matrix): Matrix;
  82779. /**
  82780. * Sets the index-th row of the current matrix with the given 4 x float values
  82781. * @param index defines the row index
  82782. * @param x defines the x component to set
  82783. * @param y defines the y component to set
  82784. * @param z defines the z component to set
  82785. * @param w defines the w component to set
  82786. * @returns the updated current matrix
  82787. */
  82788. setRowFromFloats(index: number, x: number, y: number, z: number, w: number): Matrix;
  82789. /**
  82790. * Compute a new matrix set with the current matrix values multiplied by scale (float)
  82791. * @param scale defines the scale factor
  82792. * @returns a new matrix
  82793. */
  82794. scale(scale: number): Matrix;
  82795. /**
  82796. * Scale the current matrix values by a factor to a given result matrix
  82797. * @param scale defines the scale factor
  82798. * @param result defines the matrix to store the result
  82799. * @returns the current matrix
  82800. */
  82801. scaleToRef(scale: number, result: Matrix): Matrix;
  82802. /**
  82803. * Scale the current matrix values by a factor and add the result to a given matrix
  82804. * @param scale defines the scale factor
  82805. * @param result defines the Matrix to store the result
  82806. * @returns the current matrix
  82807. */
  82808. scaleAndAddToRef(scale: number, result: Matrix): Matrix;
  82809. /**
  82810. * Writes to the given matrix a normal matrix, computed from this one (using values from identity matrix for fourth row and column).
  82811. * @param ref matrix to store the result
  82812. */
  82813. toNormalMatrix(ref: Matrix): void;
  82814. /**
  82815. * Gets only rotation part of the current matrix
  82816. * @returns a new matrix sets to the extracted rotation matrix from the current one
  82817. */
  82818. getRotationMatrix(): Matrix;
  82819. /**
  82820. * Extracts the rotation matrix from the current one and sets it as the given "result"
  82821. * @param result defines the target matrix to store data to
  82822. * @returns the current matrix
  82823. */
  82824. getRotationMatrixToRef(result: Matrix): Matrix;
  82825. /**
  82826. * Toggles model matrix from being right handed to left handed in place and vice versa
  82827. */
  82828. toggleModelMatrixHandInPlace(): void;
  82829. /**
  82830. * Toggles projection matrix from being right handed to left handed in place and vice versa
  82831. */
  82832. toggleProjectionMatrixHandInPlace(): void;
  82833. /**
  82834. * Creates a matrix from an array
  82835. * @param array defines the source array
  82836. * @param offset defines an offset in the source array
  82837. * @returns a new Matrix set from the starting index of the given array
  82838. */
  82839. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Matrix;
  82840. /**
  82841. * Copy the content of an array into a given matrix
  82842. * @param array defines the source array
  82843. * @param offset defines an offset in the source array
  82844. * @param result defines the target matrix
  82845. */
  82846. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Matrix): void;
  82847. /**
  82848. * Stores an array into a matrix after having multiplied each component by a given factor
  82849. * @param array defines the source array
  82850. * @param offset defines the offset in the source array
  82851. * @param scale defines the scaling factor
  82852. * @param result defines the target matrix
  82853. */
  82854. static FromFloat32ArrayToRefScaled(array: DeepImmutable<Float32Array | Array<number>>, offset: number, scale: number, result: Matrix): void;
  82855. /**
  82856. * Gets an identity matrix that must not be updated
  82857. */
  82858. static get IdentityReadOnly(): DeepImmutable<Matrix>;
  82859. /**
  82860. * Stores a list of values (16) inside a given matrix
  82861. * @param initialM11 defines 1st value of 1st row
  82862. * @param initialM12 defines 2nd value of 1st row
  82863. * @param initialM13 defines 3rd value of 1st row
  82864. * @param initialM14 defines 4th value of 1st row
  82865. * @param initialM21 defines 1st value of 2nd row
  82866. * @param initialM22 defines 2nd value of 2nd row
  82867. * @param initialM23 defines 3rd value of 2nd row
  82868. * @param initialM24 defines 4th value of 2nd row
  82869. * @param initialM31 defines 1st value of 3rd row
  82870. * @param initialM32 defines 2nd value of 3rd row
  82871. * @param initialM33 defines 3rd value of 3rd row
  82872. * @param initialM34 defines 4th value of 3rd row
  82873. * @param initialM41 defines 1st value of 4th row
  82874. * @param initialM42 defines 2nd value of 4th row
  82875. * @param initialM43 defines 3rd value of 4th row
  82876. * @param initialM44 defines 4th value of 4th row
  82877. * @param result defines the target matrix
  82878. */
  82879. 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;
  82880. /**
  82881. * Creates new matrix from a list of values (16)
  82882. * @param initialM11 defines 1st value of 1st row
  82883. * @param initialM12 defines 2nd value of 1st row
  82884. * @param initialM13 defines 3rd value of 1st row
  82885. * @param initialM14 defines 4th value of 1st row
  82886. * @param initialM21 defines 1st value of 2nd row
  82887. * @param initialM22 defines 2nd value of 2nd row
  82888. * @param initialM23 defines 3rd value of 2nd row
  82889. * @param initialM24 defines 4th value of 2nd row
  82890. * @param initialM31 defines 1st value of 3rd row
  82891. * @param initialM32 defines 2nd value of 3rd row
  82892. * @param initialM33 defines 3rd value of 3rd row
  82893. * @param initialM34 defines 4th value of 3rd row
  82894. * @param initialM41 defines 1st value of 4th row
  82895. * @param initialM42 defines 2nd value of 4th row
  82896. * @param initialM43 defines 3rd value of 4th row
  82897. * @param initialM44 defines 4th value of 4th row
  82898. * @returns the new matrix
  82899. */
  82900. 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;
  82901. /**
  82902. * Creates a new matrix composed by merging scale (vector3), rotation (quaternion) and translation (vector3)
  82903. * @param scale defines the scale vector3
  82904. * @param rotation defines the rotation quaternion
  82905. * @param translation defines the translation vector3
  82906. * @returns a new matrix
  82907. */
  82908. static Compose(scale: DeepImmutable<Vector3>, rotation: DeepImmutable<Quaternion>, translation: DeepImmutable<Vector3>): Matrix;
  82909. /**
  82910. * Sets a matrix to a value composed by merging scale (vector3), rotation (quaternion) and translation (vector3)
  82911. * @param scale defines the scale vector3
  82912. * @param rotation defines the rotation quaternion
  82913. * @param translation defines the translation vector3
  82914. * @param result defines the target matrix
  82915. */
  82916. static ComposeToRef(scale: DeepImmutable<Vector3>, rotation: DeepImmutable<Quaternion>, translation: DeepImmutable<Vector3>, result: Matrix): void;
  82917. /**
  82918. * Creates a new identity matrix
  82919. * @returns a new identity matrix
  82920. */
  82921. static Identity(): Matrix;
  82922. /**
  82923. * Creates a new identity matrix and stores the result in a given matrix
  82924. * @param result defines the target matrix
  82925. */
  82926. static IdentityToRef(result: Matrix): void;
  82927. /**
  82928. * Creates a new zero matrix
  82929. * @returns a new zero matrix
  82930. */
  82931. static Zero(): Matrix;
  82932. /**
  82933. * Creates a new rotation matrix for "angle" radians around the X axis
  82934. * @param angle defines the angle (in radians) to use
  82935. * @return the new matrix
  82936. */
  82937. static RotationX(angle: number): Matrix;
  82938. /**
  82939. * Creates a new matrix as the invert of a given matrix
  82940. * @param source defines the source matrix
  82941. * @returns the new matrix
  82942. */
  82943. static Invert(source: DeepImmutable<Matrix>): Matrix;
  82944. /**
  82945. * Creates a new rotation matrix for "angle" radians around the X axis and stores it in a given matrix
  82946. * @param angle defines the angle (in radians) to use
  82947. * @param result defines the target matrix
  82948. */
  82949. static RotationXToRef(angle: number, result: Matrix): void;
  82950. /**
  82951. * Creates a new rotation matrix for "angle" radians around the Y axis
  82952. * @param angle defines the angle (in radians) to use
  82953. * @return the new matrix
  82954. */
  82955. static RotationY(angle: number): Matrix;
  82956. /**
  82957. * Creates a new rotation matrix for "angle" radians around the Y axis and stores it in a given matrix
  82958. * @param angle defines the angle (in radians) to use
  82959. * @param result defines the target matrix
  82960. */
  82961. static RotationYToRef(angle: number, result: Matrix): void;
  82962. /**
  82963. * Creates a new rotation matrix for "angle" radians around the Z axis
  82964. * @param angle defines the angle (in radians) to use
  82965. * @return the new matrix
  82966. */
  82967. static RotationZ(angle: number): Matrix;
  82968. /**
  82969. * Creates a new rotation matrix for "angle" radians around the Z axis and stores it in a given matrix
  82970. * @param angle defines the angle (in radians) to use
  82971. * @param result defines the target matrix
  82972. */
  82973. static RotationZToRef(angle: number, result: Matrix): void;
  82974. /**
  82975. * Creates a new rotation matrix for "angle" radians around the given axis
  82976. * @param axis defines the axis to use
  82977. * @param angle defines the angle (in radians) to use
  82978. * @return the new matrix
  82979. */
  82980. static RotationAxis(axis: DeepImmutable<Vector3>, angle: number): Matrix;
  82981. /**
  82982. * Creates a new rotation matrix for "angle" radians around the given axis and stores it in a given matrix
  82983. * @param axis defines the axis to use
  82984. * @param angle defines the angle (in radians) to use
  82985. * @param result defines the target matrix
  82986. */
  82987. static RotationAxisToRef(axis: DeepImmutable<Vector3>, angle: number, result: Matrix): void;
  82988. /**
  82989. * Takes normalised vectors and returns a rotation matrix to align "from" with "to".
  82990. * Taken from http://www.iquilezles.org/www/articles/noacos/noacos.htm
  82991. * @param from defines the vector to align
  82992. * @param to defines the vector to align to
  82993. * @param result defines the target matrix
  82994. */
  82995. static RotationAlignToRef(from: DeepImmutable<Vector3>, to: DeepImmutable<Vector3>, result: Matrix): void;
  82996. /**
  82997. * Creates a rotation matrix
  82998. * @param yaw defines the yaw angle in radians (Y axis)
  82999. * @param pitch defines the pitch angle in radians (X axis)
  83000. * @param roll defines the roll angle in radians (Z axis)
  83001. * @returns the new rotation matrix
  83002. */
  83003. static RotationYawPitchRoll(yaw: number, pitch: number, roll: number): Matrix;
  83004. /**
  83005. * Creates a rotation matrix and stores it in a given matrix
  83006. * @param yaw defines the yaw angle in radians (Y axis)
  83007. * @param pitch defines the pitch angle in radians (X axis)
  83008. * @param roll defines the roll angle in radians (Z axis)
  83009. * @param result defines the target matrix
  83010. */
  83011. static RotationYawPitchRollToRef(yaw: number, pitch: number, roll: number, result: Matrix): void;
  83012. /**
  83013. * Creates a scaling matrix
  83014. * @param x defines the scale factor on X axis
  83015. * @param y defines the scale factor on Y axis
  83016. * @param z defines the scale factor on Z axis
  83017. * @returns the new matrix
  83018. */
  83019. static Scaling(x: number, y: number, z: number): Matrix;
  83020. /**
  83021. * Creates a scaling matrix and stores it in a given matrix
  83022. * @param x defines the scale factor on X axis
  83023. * @param y defines the scale factor on Y axis
  83024. * @param z defines the scale factor on Z axis
  83025. * @param result defines the target matrix
  83026. */
  83027. static ScalingToRef(x: number, y: number, z: number, result: Matrix): void;
  83028. /**
  83029. * Creates a translation matrix
  83030. * @param x defines the translation on X axis
  83031. * @param y defines the translation on Y axis
  83032. * @param z defines the translationon Z axis
  83033. * @returns the new matrix
  83034. */
  83035. static Translation(x: number, y: number, z: number): Matrix;
  83036. /**
  83037. * Creates a translation matrix and stores it in a given matrix
  83038. * @param x defines the translation on X axis
  83039. * @param y defines the translation on Y axis
  83040. * @param z defines the translationon Z axis
  83041. * @param result defines the target matrix
  83042. */
  83043. static TranslationToRef(x: number, y: number, z: number, result: Matrix): void;
  83044. /**
  83045. * Returns a new Matrix whose values are the interpolated values for "gradient" (float) between the ones of the matrices "startValue" and "endValue".
  83046. * @param startValue defines the start value
  83047. * @param endValue defines the end value
  83048. * @param gradient defines the gradient factor
  83049. * @returns the new matrix
  83050. */
  83051. static Lerp(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number): Matrix;
  83052. /**
  83053. * Set the given matrix "result" as the interpolated values for "gradient" (float) between the ones of the matrices "startValue" and "endValue".
  83054. * @param startValue defines the start value
  83055. * @param endValue defines the end value
  83056. * @param gradient defines the gradient factor
  83057. * @param result defines the Matrix object where to store data
  83058. */
  83059. static LerpToRef(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number, result: Matrix): void;
  83060. /**
  83061. * Builds a new matrix whose values are computed by:
  83062. * * decomposing the the "startValue" and "endValue" matrices into their respective scale, rotation and translation matrices
  83063. * * interpolating for "gradient" (float) the values between each of these decomposed matrices between the start and the end
  83064. * * recomposing a new matrix from these 3 interpolated scale, rotation and translation matrices
  83065. * @param startValue defines the first matrix
  83066. * @param endValue defines the second matrix
  83067. * @param gradient defines the gradient between the two matrices
  83068. * @returns the new matrix
  83069. */
  83070. static DecomposeLerp(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number): Matrix;
  83071. /**
  83072. * Update a matrix to values which are computed by:
  83073. * * decomposing the the "startValue" and "endValue" matrices into their respective scale, rotation and translation matrices
  83074. * * interpolating for "gradient" (float) the values between each of these decomposed matrices between the start and the end
  83075. * * recomposing a new matrix from these 3 interpolated scale, rotation and translation matrices
  83076. * @param startValue defines the first matrix
  83077. * @param endValue defines the second matrix
  83078. * @param gradient defines the gradient between the two matrices
  83079. * @param result defines the target matrix
  83080. */
  83081. static DecomposeLerpToRef(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number, result: Matrix): void;
  83082. /**
  83083. * 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"
  83084. * This function works in left handed mode
  83085. * @param eye defines the final position of the entity
  83086. * @param target defines where the entity should look at
  83087. * @param up defines the up vector for the entity
  83088. * @returns the new matrix
  83089. */
  83090. static LookAtLH(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>): Matrix;
  83091. /**
  83092. * 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".
  83093. * This function works in left handed mode
  83094. * @param eye defines the final position of the entity
  83095. * @param target defines where the entity should look at
  83096. * @param up defines the up vector for the entity
  83097. * @param result defines the target matrix
  83098. */
  83099. static LookAtLHToRef(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>, result: Matrix): void;
  83100. /**
  83101. * 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"
  83102. * This function works in right handed mode
  83103. * @param eye defines the final position of the entity
  83104. * @param target defines where the entity should look at
  83105. * @param up defines the up vector for the entity
  83106. * @returns the new matrix
  83107. */
  83108. static LookAtRH(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>): Matrix;
  83109. /**
  83110. * 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".
  83111. * This function works in right handed mode
  83112. * @param eye defines the final position of the entity
  83113. * @param target defines where the entity should look at
  83114. * @param up defines the up vector for the entity
  83115. * @param result defines the target matrix
  83116. */
  83117. static LookAtRHToRef(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>, result: Matrix): void;
  83118. /**
  83119. * Create a left-handed orthographic projection matrix
  83120. * @param width defines the viewport width
  83121. * @param height defines the viewport height
  83122. * @param znear defines the near clip plane
  83123. * @param zfar defines the far clip plane
  83124. * @returns a new matrix as a left-handed orthographic projection matrix
  83125. */
  83126. static OrthoLH(width: number, height: number, znear: number, zfar: number): Matrix;
  83127. /**
  83128. * Store a left-handed orthographic projection to a given matrix
  83129. * @param width defines the viewport width
  83130. * @param height defines the viewport height
  83131. * @param znear defines the near clip plane
  83132. * @param zfar defines the far clip plane
  83133. * @param result defines the target matrix
  83134. */
  83135. static OrthoLHToRef(width: number, height: number, znear: number, zfar: number, result: Matrix): void;
  83136. /**
  83137. * Create a left-handed orthographic projection matrix
  83138. * @param left defines the viewport left coordinate
  83139. * @param right defines the viewport right coordinate
  83140. * @param bottom defines the viewport bottom coordinate
  83141. * @param top defines the viewport top coordinate
  83142. * @param znear defines the near clip plane
  83143. * @param zfar defines the far clip plane
  83144. * @returns a new matrix as a left-handed orthographic projection matrix
  83145. */
  83146. static OrthoOffCenterLH(left: number, right: number, bottom: number, top: number, znear: number, zfar: number): Matrix;
  83147. /**
  83148. * Stores a left-handed orthographic projection into a given matrix
  83149. * @param left defines the viewport left coordinate
  83150. * @param right defines the viewport right coordinate
  83151. * @param bottom defines the viewport bottom coordinate
  83152. * @param top defines the viewport top coordinate
  83153. * @param znear defines the near clip plane
  83154. * @param zfar defines the far clip plane
  83155. * @param result defines the target matrix
  83156. */
  83157. static OrthoOffCenterLHToRef(left: number, right: number, bottom: number, top: number, znear: number, zfar: number, result: Matrix): void;
  83158. /**
  83159. * Creates a right-handed orthographic projection matrix
  83160. * @param left defines the viewport left coordinate
  83161. * @param right defines the viewport right coordinate
  83162. * @param bottom defines the viewport bottom coordinate
  83163. * @param top defines the viewport top coordinate
  83164. * @param znear defines the near clip plane
  83165. * @param zfar defines the far clip plane
  83166. * @returns a new matrix as a right-handed orthographic projection matrix
  83167. */
  83168. static OrthoOffCenterRH(left: number, right: number, bottom: number, top: number, znear: number, zfar: number): Matrix;
  83169. /**
  83170. * Stores a right-handed orthographic projection into a given matrix
  83171. * @param left defines the viewport left coordinate
  83172. * @param right defines the viewport right coordinate
  83173. * @param bottom defines the viewport bottom coordinate
  83174. * @param top defines the viewport top coordinate
  83175. * @param znear defines the near clip plane
  83176. * @param zfar defines the far clip plane
  83177. * @param result defines the target matrix
  83178. */
  83179. static OrthoOffCenterRHToRef(left: number, right: number, bottom: number, top: number, znear: number, zfar: number, result: Matrix): void;
  83180. /**
  83181. * Creates a left-handed perspective projection matrix
  83182. * @param width defines the viewport width
  83183. * @param height defines the viewport height
  83184. * @param znear defines the near clip plane
  83185. * @param zfar defines the far clip plane
  83186. * @returns a new matrix as a left-handed perspective projection matrix
  83187. */
  83188. static PerspectiveLH(width: number, height: number, znear: number, zfar: number): Matrix;
  83189. /**
  83190. * Creates a left-handed perspective projection matrix
  83191. * @param fov defines the horizontal field of view
  83192. * @param aspect defines the aspect ratio
  83193. * @param znear defines the near clip plane
  83194. * @param zfar defines the far clip plane
  83195. * @returns a new matrix as a left-handed perspective projection matrix
  83196. */
  83197. static PerspectiveFovLH(fov: number, aspect: number, znear: number, zfar: number): Matrix;
  83198. /**
  83199. * Stores a left-handed perspective projection into a given matrix
  83200. * @param fov defines the horizontal field of view
  83201. * @param aspect defines the aspect ratio
  83202. * @param znear defines the near clip plane
  83203. * @param zfar defines the far clip plane
  83204. * @param result defines the target matrix
  83205. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  83206. */
  83207. static PerspectiveFovLHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  83208. /**
  83209. * Stores a left-handed perspective projection into a given matrix with depth reversed
  83210. * @param fov defines the horizontal field of view
  83211. * @param aspect defines the aspect ratio
  83212. * @param znear defines the near clip plane
  83213. * @param zfar not used as infinity is used as far clip
  83214. * @param result defines the target matrix
  83215. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  83216. */
  83217. static PerspectiveFovReverseLHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  83218. /**
  83219. * Creates a right-handed perspective projection matrix
  83220. * @param fov defines the horizontal field of view
  83221. * @param aspect defines the aspect ratio
  83222. * @param znear defines the near clip plane
  83223. * @param zfar defines the far clip plane
  83224. * @returns a new matrix as a right-handed perspective projection matrix
  83225. */
  83226. static PerspectiveFovRH(fov: number, aspect: number, znear: number, zfar: number): Matrix;
  83227. /**
  83228. * Stores a right-handed perspective projection into a given matrix
  83229. * @param fov defines the horizontal field of view
  83230. * @param aspect defines the aspect ratio
  83231. * @param znear defines the near clip plane
  83232. * @param zfar defines the far clip plane
  83233. * @param result defines the target matrix
  83234. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  83235. */
  83236. static PerspectiveFovRHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  83237. /**
  83238. * Stores a right-handed perspective projection into a given matrix
  83239. * @param fov defines the horizontal field of view
  83240. * @param aspect defines the aspect ratio
  83241. * @param znear defines the near clip plane
  83242. * @param zfar not used as infinity is used as far clip
  83243. * @param result defines the target matrix
  83244. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  83245. */
  83246. static PerspectiveFovReverseRHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  83247. /**
  83248. * Stores a perspective projection for WebVR info a given matrix
  83249. * @param fov defines the field of view
  83250. * @param znear defines the near clip plane
  83251. * @param zfar defines the far clip plane
  83252. * @param result defines the target matrix
  83253. * @param rightHanded defines if the matrix must be in right-handed mode (false by default)
  83254. */
  83255. static PerspectiveFovWebVRToRef(fov: {
  83256. upDegrees: number;
  83257. downDegrees: number;
  83258. leftDegrees: number;
  83259. rightDegrees: number;
  83260. }, znear: number, zfar: number, result: Matrix, rightHanded?: boolean): void;
  83261. /**
  83262. * Computes a complete transformation matrix
  83263. * @param viewport defines the viewport to use
  83264. * @param world defines the world matrix
  83265. * @param view defines the view matrix
  83266. * @param projection defines the projection matrix
  83267. * @param zmin defines the near clip plane
  83268. * @param zmax defines the far clip plane
  83269. * @returns the transformation matrix
  83270. */
  83271. static GetFinalMatrix(viewport: DeepImmutable<Viewport>, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, zmin: number, zmax: number): Matrix;
  83272. /**
  83273. * Extracts a 2x2 matrix from a given matrix and store the result in a Float32Array
  83274. * @param matrix defines the matrix to use
  83275. * @returns a new Float32Array array with 4 elements : the 2x2 matrix extracted from the given matrix
  83276. */
  83277. static GetAsMatrix2x2(matrix: DeepImmutable<Matrix>): Float32Array | Array<number>;
  83278. /**
  83279. * Extracts a 3x3 matrix from a given matrix and store the result in a Float32Array
  83280. * @param matrix defines the matrix to use
  83281. * @returns a new Float32Array array with 9 elements : the 3x3 matrix extracted from the given matrix
  83282. */
  83283. static GetAsMatrix3x3(matrix: DeepImmutable<Matrix>): Float32Array | Array<number>;
  83284. /**
  83285. * Compute the transpose of a given matrix
  83286. * @param matrix defines the matrix to transpose
  83287. * @returns the new matrix
  83288. */
  83289. static Transpose(matrix: DeepImmutable<Matrix>): Matrix;
  83290. /**
  83291. * Compute the transpose of a matrix and store it in a target matrix
  83292. * @param matrix defines the matrix to transpose
  83293. * @param result defines the target matrix
  83294. */
  83295. static TransposeToRef(matrix: DeepImmutable<Matrix>, result: Matrix): void;
  83296. /**
  83297. * Computes a reflection matrix from a plane
  83298. * @param plane defines the reflection plane
  83299. * @returns a new matrix
  83300. */
  83301. static Reflection(plane: DeepImmutable<IPlaneLike>): Matrix;
  83302. /**
  83303. * Computes a reflection matrix from a plane
  83304. * @param plane defines the reflection plane
  83305. * @param result defines the target matrix
  83306. */
  83307. static ReflectionToRef(plane: DeepImmutable<IPlaneLike>, result: Matrix): void;
  83308. /**
  83309. * Sets the given matrix as a rotation matrix composed from the 3 left handed axes
  83310. * @param xaxis defines the value of the 1st axis
  83311. * @param yaxis defines the value of the 2nd axis
  83312. * @param zaxis defines the value of the 3rd axis
  83313. * @param result defines the target matrix
  83314. */
  83315. static FromXYZAxesToRef(xaxis: DeepImmutable<Vector3>, yaxis: DeepImmutable<Vector3>, zaxis: DeepImmutable<Vector3>, result: Matrix): void;
  83316. /**
  83317. * Creates a rotation matrix from a quaternion and stores it in a target matrix
  83318. * @param quat defines the quaternion to use
  83319. * @param result defines the target matrix
  83320. */
  83321. static FromQuaternionToRef(quat: DeepImmutable<Quaternion>, result: Matrix): void;
  83322. }
  83323. /**
  83324. * @hidden
  83325. */
  83326. export class TmpVectors {
  83327. static Vector2: Vector2[];
  83328. static Vector3: Vector3[];
  83329. static Vector4: Vector4[];
  83330. static Quaternion: Quaternion[];
  83331. static Matrix: Matrix[];
  83332. }
  83333. }
  83334. declare module BABYLON {
  83335. /**
  83336. * Defines potential orientation for back face culling
  83337. */
  83338. export enum Orientation {
  83339. /**
  83340. * Clockwise
  83341. */
  83342. CW = 0,
  83343. /** Counter clockwise */
  83344. CCW = 1
  83345. }
  83346. /** Class used to represent a Bezier curve */
  83347. export class BezierCurve {
  83348. /**
  83349. * Returns the cubic Bezier interpolated value (float) at "t" (float) from the given x1, y1, x2, y2 floats
  83350. * @param t defines the time
  83351. * @param x1 defines the left coordinate on X axis
  83352. * @param y1 defines the left coordinate on Y axis
  83353. * @param x2 defines the right coordinate on X axis
  83354. * @param y2 defines the right coordinate on Y axis
  83355. * @returns the interpolated value
  83356. */
  83357. static Interpolate(t: number, x1: number, y1: number, x2: number, y2: number): number;
  83358. }
  83359. /**
  83360. * Defines angle representation
  83361. */
  83362. export class Angle {
  83363. private _radians;
  83364. /**
  83365. * Creates an Angle object of "radians" radians (float).
  83366. * @param radians the angle in radians
  83367. */
  83368. constructor(radians: number);
  83369. /**
  83370. * Get value in degrees
  83371. * @returns the Angle value in degrees (float)
  83372. */
  83373. degrees(): number;
  83374. /**
  83375. * Get value in radians
  83376. * @returns the Angle value in radians (float)
  83377. */
  83378. radians(): number;
  83379. /**
  83380. * Gets a new Angle object valued with the gradient angle, in radians, of the line joining two points
  83381. * @param a defines first point as the origin
  83382. * @param b defines point
  83383. * @returns a new Angle
  83384. */
  83385. static BetweenTwoPoints(a: DeepImmutable<Vector2>, b: DeepImmutable<Vector2>): Angle;
  83386. /**
  83387. * Gets a new Angle object from the given float in radians
  83388. * @param radians defines the angle value in radians
  83389. * @returns a new Angle
  83390. */
  83391. static FromRadians(radians: number): Angle;
  83392. /**
  83393. * Gets a new Angle object from the given float in degrees
  83394. * @param degrees defines the angle value in degrees
  83395. * @returns a new Angle
  83396. */
  83397. static FromDegrees(degrees: number): Angle;
  83398. }
  83399. /**
  83400. * This represents an arc in a 2d space.
  83401. */
  83402. export class Arc2 {
  83403. /** Defines the start point of the arc */
  83404. startPoint: Vector2;
  83405. /** Defines the mid point of the arc */
  83406. midPoint: Vector2;
  83407. /** Defines the end point of the arc */
  83408. endPoint: Vector2;
  83409. /**
  83410. * Defines the center point of the arc.
  83411. */
  83412. centerPoint: Vector2;
  83413. /**
  83414. * Defines the radius of the arc.
  83415. */
  83416. radius: number;
  83417. /**
  83418. * Defines the angle of the arc (from mid point to end point).
  83419. */
  83420. angle: Angle;
  83421. /**
  83422. * Defines the start angle of the arc (from start point to middle point).
  83423. */
  83424. startAngle: Angle;
  83425. /**
  83426. * Defines the orientation of the arc (clock wise/counter clock wise).
  83427. */
  83428. orientation: Orientation;
  83429. /**
  83430. * Creates an Arc object from the three given points : start, middle and end.
  83431. * @param startPoint Defines the start point of the arc
  83432. * @param midPoint Defines the midlle point of the arc
  83433. * @param endPoint Defines the end point of the arc
  83434. */
  83435. constructor(
  83436. /** Defines the start point of the arc */
  83437. startPoint: Vector2,
  83438. /** Defines the mid point of the arc */
  83439. midPoint: Vector2,
  83440. /** Defines the end point of the arc */
  83441. endPoint: Vector2);
  83442. }
  83443. /**
  83444. * Represents a 2D path made up of multiple 2D points
  83445. */
  83446. export class Path2 {
  83447. private _points;
  83448. private _length;
  83449. /**
  83450. * If the path start and end point are the same
  83451. */
  83452. closed: boolean;
  83453. /**
  83454. * Creates a Path2 object from the starting 2D coordinates x and y.
  83455. * @param x the starting points x value
  83456. * @param y the starting points y value
  83457. */
  83458. constructor(x: number, y: number);
  83459. /**
  83460. * Adds a new segment until the given coordinates (x, y) to the current Path2.
  83461. * @param x the added points x value
  83462. * @param y the added points y value
  83463. * @returns the updated Path2.
  83464. */
  83465. addLineTo(x: number, y: number): Path2;
  83466. /**
  83467. * 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.
  83468. * @param midX middle point x value
  83469. * @param midY middle point y value
  83470. * @param endX end point x value
  83471. * @param endY end point y value
  83472. * @param numberOfSegments (default: 36)
  83473. * @returns the updated Path2.
  83474. */
  83475. addArcTo(midX: number, midY: number, endX: number, endY: number, numberOfSegments?: number): Path2;
  83476. /**
  83477. * Closes the Path2.
  83478. * @returns the Path2.
  83479. */
  83480. close(): Path2;
  83481. /**
  83482. * Gets the sum of the distance between each sequential point in the path
  83483. * @returns the Path2 total length (float).
  83484. */
  83485. length(): number;
  83486. /**
  83487. * Gets the points which construct the path
  83488. * @returns the Path2 internal array of points.
  83489. */
  83490. getPoints(): Vector2[];
  83491. /**
  83492. * Retreives the point at the distance aways from the starting point
  83493. * @param normalizedLengthPosition the length along the path to retreive the point from
  83494. * @returns a new Vector2 located at a percentage of the Path2 total length on this path.
  83495. */
  83496. getPointAtLengthPosition(normalizedLengthPosition: number): Vector2;
  83497. /**
  83498. * Creates a new path starting from an x and y position
  83499. * @param x starting x value
  83500. * @param y starting y value
  83501. * @returns a new Path2 starting at the coordinates (x, y).
  83502. */
  83503. static StartingAt(x: number, y: number): Path2;
  83504. }
  83505. /**
  83506. * Represents a 3D path made up of multiple 3D points
  83507. */
  83508. export class Path3D {
  83509. /**
  83510. * an array of Vector3, the curve axis of the Path3D
  83511. */
  83512. path: Vector3[];
  83513. private _curve;
  83514. private _distances;
  83515. private _tangents;
  83516. private _normals;
  83517. private _binormals;
  83518. private _raw;
  83519. private _alignTangentsWithPath;
  83520. private readonly _pointAtData;
  83521. /**
  83522. * new Path3D(path, normal, raw)
  83523. * Creates a Path3D. A Path3D is a logical math object, so not a mesh.
  83524. * please read the description in the tutorial : https://doc.babylonjs.com/how_to/how_to_use_path3d
  83525. * @param path an array of Vector3, the curve axis of the Path3D
  83526. * @param firstNormal (options) Vector3, the first wanted normal to the curve. Ex (0, 1, 0) for a vertical normal.
  83527. * @param raw (optional, default false) : boolean, if true the returned Path3D isn't normalized. Useful to depict path acceleration or speed.
  83528. * @param alignTangentsWithPath (optional, default false) : boolean, if true the tangents will be aligned with the path.
  83529. */
  83530. constructor(
  83531. /**
  83532. * an array of Vector3, the curve axis of the Path3D
  83533. */
  83534. path: Vector3[], firstNormal?: Nullable<Vector3>, raw?: boolean, alignTangentsWithPath?: boolean);
  83535. /**
  83536. * Returns the Path3D array of successive Vector3 designing its curve.
  83537. * @returns the Path3D array of successive Vector3 designing its curve.
  83538. */
  83539. getCurve(): Vector3[];
  83540. /**
  83541. * Returns the Path3D array of successive Vector3 designing its curve.
  83542. * @returns the Path3D array of successive Vector3 designing its curve.
  83543. */
  83544. getPoints(): Vector3[];
  83545. /**
  83546. * @returns the computed length (float) of the path.
  83547. */
  83548. length(): number;
  83549. /**
  83550. * Returns an array populated with tangent vectors on each Path3D curve point.
  83551. * @returns an array populated with tangent vectors on each Path3D curve point.
  83552. */
  83553. getTangents(): Vector3[];
  83554. /**
  83555. * Returns an array populated with normal vectors on each Path3D curve point.
  83556. * @returns an array populated with normal vectors on each Path3D curve point.
  83557. */
  83558. getNormals(): Vector3[];
  83559. /**
  83560. * Returns an array populated with binormal vectors on each Path3D curve point.
  83561. * @returns an array populated with binormal vectors on each Path3D curve point.
  83562. */
  83563. getBinormals(): Vector3[];
  83564. /**
  83565. * Returns an array populated with distances (float) of the i-th point from the first curve point.
  83566. * @returns an array populated with distances (float) of the i-th point from the first curve point.
  83567. */
  83568. getDistances(): number[];
  83569. /**
  83570. * Returns an interpolated point along this path
  83571. * @param position the position of the point along this path, from 0.0 to 1.0
  83572. * @returns a new Vector3 as the point
  83573. */
  83574. getPointAt(position: number): Vector3;
  83575. /**
  83576. * Returns the tangent vector of an interpolated Path3D curve point at the specified position along this path.
  83577. * @param position the position of the point along this path, from 0.0 to 1.0
  83578. * @param interpolated (optional, default false) : boolean, if true returns an interpolated tangent instead of the tangent of the previous path point.
  83579. * @returns a tangent vector corresponding to the interpolated Path3D curve point, if not interpolated, the tangent is taken from the precomputed tangents array.
  83580. */
  83581. getTangentAt(position: number, interpolated?: boolean): Vector3;
  83582. /**
  83583. * Returns the tangent vector of an interpolated Path3D curve point at the specified position along this path.
  83584. * @param position the position of the point along this path, from 0.0 to 1.0
  83585. * @param interpolated (optional, default false) : boolean, if true returns an interpolated normal instead of the normal of the previous path point.
  83586. * @returns a normal vector corresponding to the interpolated Path3D curve point, if not interpolated, the normal is taken from the precomputed normals array.
  83587. */
  83588. getNormalAt(position: number, interpolated?: boolean): Vector3;
  83589. /**
  83590. * Returns the binormal vector of an interpolated Path3D curve point at the specified position along this path.
  83591. * @param position the position of the point along this path, from 0.0 to 1.0
  83592. * @param interpolated (optional, default false) : boolean, if true returns an interpolated binormal instead of the binormal of the previous path point.
  83593. * @returns a binormal vector corresponding to the interpolated Path3D curve point, if not interpolated, the binormal is taken from the precomputed binormals array.
  83594. */
  83595. getBinormalAt(position: number, interpolated?: boolean): Vector3;
  83596. /**
  83597. * Returns the distance (float) of an interpolated Path3D curve point at the specified position along this path.
  83598. * @param position the position of the point along this path, from 0.0 to 1.0
  83599. * @returns the distance of the interpolated Path3D curve point at the specified position along this path.
  83600. */
  83601. getDistanceAt(position: number): number;
  83602. /**
  83603. * Returns the array index of the previous point of an interpolated point along this path
  83604. * @param position the position of the point to interpolate along this path, from 0.0 to 1.0
  83605. * @returns the array index
  83606. */
  83607. getPreviousPointIndexAt(position: number): number;
  83608. /**
  83609. * 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)
  83610. * @param position the position of the point to interpolate along this path, from 0.0 to 1.0
  83611. * @returns the sub position
  83612. */
  83613. getSubPositionAt(position: number): number;
  83614. /**
  83615. * Returns the position of the closest virtual point on this path to an arbitrary Vector3, from 0.0 to 1.0
  83616. * @param target the vector of which to get the closest position to
  83617. * @returns the position of the closest virtual point on this path to the target vector
  83618. */
  83619. getClosestPositionTo(target: Vector3): number;
  83620. /**
  83621. * Returns a sub path (slice) of this path
  83622. * @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
  83623. * @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
  83624. * @returns a sub path (slice) of this path
  83625. */
  83626. slice(start?: number, end?: number): Path3D;
  83627. /**
  83628. * Forces the Path3D tangent, normal, binormal and distance recomputation.
  83629. * @param path path which all values are copied into the curves points
  83630. * @param firstNormal which should be projected onto the curve
  83631. * @param alignTangentsWithPath (optional, default false) : boolean, if true the tangents will be aligned with the path
  83632. * @returns the same object updated.
  83633. */
  83634. update(path: Vector3[], firstNormal?: Nullable<Vector3>, alignTangentsWithPath?: boolean): Path3D;
  83635. private _compute;
  83636. private _getFirstNonNullVector;
  83637. private _getLastNonNullVector;
  83638. private _normalVector;
  83639. /**
  83640. * Updates the point at data for an interpolated point along this curve
  83641. * @param position the position of the point along this curve, from 0.0 to 1.0
  83642. * @interpolateTNB wether to compute the interpolated tangent, normal and binormal
  83643. * @returns the (updated) point at data
  83644. */
  83645. private _updatePointAtData;
  83646. /**
  83647. * Updates the point at data from the specified parameters
  83648. * @param position where along the path the interpolated point is, from 0.0 to 1.0
  83649. * @param point the interpolated point
  83650. * @param parentIndex the index of an existing curve point that is on, or else positionally the first behind, the interpolated point
  83651. */
  83652. private _setPointAtData;
  83653. /**
  83654. * Updates the point at interpolation matrix for the tangents, normals and binormals
  83655. */
  83656. private _updateInterpolationMatrix;
  83657. }
  83658. /**
  83659. * A Curve3 object is a logical object, so not a mesh, to handle curves in the 3D geometric space.
  83660. * A Curve3 is designed from a series of successive Vector3.
  83661. * @see https://doc.babylonjs.com/how_to/how_to_use_curve3
  83662. */
  83663. export class Curve3 {
  83664. private _points;
  83665. private _length;
  83666. /**
  83667. * Returns a Curve3 object along a Quadratic Bezier curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#quadratic-bezier-curve
  83668. * @param v0 (Vector3) the origin point of the Quadratic Bezier
  83669. * @param v1 (Vector3) the control point
  83670. * @param v2 (Vector3) the end point of the Quadratic Bezier
  83671. * @param nbPoints (integer) the wanted number of points in the curve
  83672. * @returns the created Curve3
  83673. */
  83674. static CreateQuadraticBezier(v0: DeepImmutable<Vector3>, v1: DeepImmutable<Vector3>, v2: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  83675. /**
  83676. * Returns a Curve3 object along a Cubic Bezier curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#cubic-bezier-curve
  83677. * @param v0 (Vector3) the origin point of the Cubic Bezier
  83678. * @param v1 (Vector3) the first control point
  83679. * @param v2 (Vector3) the second control point
  83680. * @param v3 (Vector3) the end point of the Cubic Bezier
  83681. * @param nbPoints (integer) the wanted number of points in the curve
  83682. * @returns the created Curve3
  83683. */
  83684. static CreateCubicBezier(v0: DeepImmutable<Vector3>, v1: DeepImmutable<Vector3>, v2: DeepImmutable<Vector3>, v3: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  83685. /**
  83686. * Returns a Curve3 object along a Hermite Spline curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#hermite-spline
  83687. * @param p1 (Vector3) the origin point of the Hermite Spline
  83688. * @param t1 (Vector3) the tangent vector at the origin point
  83689. * @param p2 (Vector3) the end point of the Hermite Spline
  83690. * @param t2 (Vector3) the tangent vector at the end point
  83691. * @param nbPoints (integer) the wanted number of points in the curve
  83692. * @returns the created Curve3
  83693. */
  83694. static CreateHermiteSpline(p1: DeepImmutable<Vector3>, t1: DeepImmutable<Vector3>, p2: DeepImmutable<Vector3>, t2: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  83695. /**
  83696. * Returns a Curve3 object along a CatmullRom Spline curve :
  83697. * @param points (array of Vector3) the points the spline must pass through. At least, four points required
  83698. * @param nbPoints (integer) the wanted number of points between each curve control points
  83699. * @param closed (boolean) optional with default false, when true forms a closed loop from the points
  83700. * @returns the created Curve3
  83701. */
  83702. static CreateCatmullRomSpline(points: DeepImmutable<Vector3[]>, nbPoints: number, closed?: boolean): Curve3;
  83703. /**
  83704. * A Curve3 object is a logical object, so not a mesh, to handle curves in the 3D geometric space.
  83705. * A Curve3 is designed from a series of successive Vector3.
  83706. * Tuto : https://doc.babylonjs.com/how_to/how_to_use_curve3#curve3-object
  83707. * @param points points which make up the curve
  83708. */
  83709. constructor(points: Vector3[]);
  83710. /**
  83711. * @returns the Curve3 stored array of successive Vector3
  83712. */
  83713. getPoints(): Vector3[];
  83714. /**
  83715. * @returns the computed length (float) of the curve.
  83716. */
  83717. length(): number;
  83718. /**
  83719. * Returns a new instance of Curve3 object : var curve = curveA.continue(curveB);
  83720. * This new Curve3 is built by translating and sticking the curveB at the end of the curveA.
  83721. * curveA and curveB keep unchanged.
  83722. * @param curve the curve to continue from this curve
  83723. * @returns the newly constructed curve
  83724. */
  83725. continue(curve: DeepImmutable<Curve3>): Curve3;
  83726. private _computeLength;
  83727. }
  83728. }
  83729. declare module BABYLON {
  83730. /**
  83731. * This represents the main contract an easing function should follow.
  83732. * Easing functions are used throughout the animation system.
  83733. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  83734. */
  83735. export interface IEasingFunction {
  83736. /**
  83737. * Given an input gradient between 0 and 1, this returns the corrseponding value
  83738. * of the easing function.
  83739. * The link below provides some of the most common examples of easing functions.
  83740. * @see https://easings.net/
  83741. * @param gradient Defines the value between 0 and 1 we want the easing value for
  83742. * @returns the corresponding value on the curve defined by the easing function
  83743. */
  83744. ease(gradient: number): number;
  83745. }
  83746. /**
  83747. * Base class used for every default easing function.
  83748. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  83749. */
  83750. export class EasingFunction implements IEasingFunction {
  83751. /**
  83752. * Interpolation follows the mathematical formula associated with the easing function.
  83753. */
  83754. static readonly EASINGMODE_EASEIN: number;
  83755. /**
  83756. * Interpolation follows 100% interpolation minus the output of the formula associated with the easing function.
  83757. */
  83758. static readonly EASINGMODE_EASEOUT: number;
  83759. /**
  83760. * Interpolation uses EaseIn for the first half of the animation and EaseOut for the second half.
  83761. */
  83762. static readonly EASINGMODE_EASEINOUT: number;
  83763. private _easingMode;
  83764. /**
  83765. * Sets the easing mode of the current function.
  83766. * @param easingMode Defines the willing mode (EASINGMODE_EASEIN, EASINGMODE_EASEOUT or EASINGMODE_EASEINOUT)
  83767. */
  83768. setEasingMode(easingMode: number): void;
  83769. /**
  83770. * Gets the current easing mode.
  83771. * @returns the easing mode
  83772. */
  83773. getEasingMode(): number;
  83774. /**
  83775. * @hidden
  83776. */
  83777. easeInCore(gradient: number): number;
  83778. /**
  83779. * Given an input gradient between 0 and 1, this returns the corresponding value
  83780. * of the easing function.
  83781. * @param gradient Defines the value between 0 and 1 we want the easing value for
  83782. * @returns the corresponding value on the curve defined by the easing function
  83783. */
  83784. ease(gradient: number): number;
  83785. }
  83786. /**
  83787. * Easing function with a circle shape (see link below).
  83788. * @see https://easings.net/#easeInCirc
  83789. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  83790. */
  83791. export class CircleEase extends EasingFunction implements IEasingFunction {
  83792. /** @hidden */
  83793. easeInCore(gradient: number): number;
  83794. }
  83795. /**
  83796. * Easing function with a ease back shape (see link below).
  83797. * @see https://easings.net/#easeInBack
  83798. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  83799. */
  83800. export class BackEase extends EasingFunction implements IEasingFunction {
  83801. /** Defines the amplitude of the function */
  83802. amplitude: number;
  83803. /**
  83804. * Instantiates a back ease easing
  83805. * @see https://easings.net/#easeInBack
  83806. * @param amplitude Defines the amplitude of the function
  83807. */
  83808. constructor(
  83809. /** Defines the amplitude of the function */
  83810. amplitude?: number);
  83811. /** @hidden */
  83812. easeInCore(gradient: number): number;
  83813. }
  83814. /**
  83815. * Easing function with a bouncing shape (see link below).
  83816. * @see https://easings.net/#easeInBounce
  83817. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  83818. */
  83819. export class BounceEase extends EasingFunction implements IEasingFunction {
  83820. /** Defines the number of bounces */
  83821. bounces: number;
  83822. /** Defines the amplitude of the bounce */
  83823. bounciness: number;
  83824. /**
  83825. * Instantiates a bounce easing
  83826. * @see https://easings.net/#easeInBounce
  83827. * @param bounces Defines the number of bounces
  83828. * @param bounciness Defines the amplitude of the bounce
  83829. */
  83830. constructor(
  83831. /** Defines the number of bounces */
  83832. bounces?: number,
  83833. /** Defines the amplitude of the bounce */
  83834. bounciness?: number);
  83835. /** @hidden */
  83836. easeInCore(gradient: number): number;
  83837. }
  83838. /**
  83839. * Easing function with a power of 3 shape (see link below).
  83840. * @see https://easings.net/#easeInCubic
  83841. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  83842. */
  83843. export class CubicEase extends EasingFunction implements IEasingFunction {
  83844. /** @hidden */
  83845. easeInCore(gradient: number): number;
  83846. }
  83847. /**
  83848. * Easing function with an elastic shape (see link below).
  83849. * @see https://easings.net/#easeInElastic
  83850. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  83851. */
  83852. export class ElasticEase extends EasingFunction implements IEasingFunction {
  83853. /** Defines the number of oscillations*/
  83854. oscillations: number;
  83855. /** Defines the amplitude of the oscillations*/
  83856. springiness: number;
  83857. /**
  83858. * Instantiates an elastic easing function
  83859. * @see https://easings.net/#easeInElastic
  83860. * @param oscillations Defines the number of oscillations
  83861. * @param springiness Defines the amplitude of the oscillations
  83862. */
  83863. constructor(
  83864. /** Defines the number of oscillations*/
  83865. oscillations?: number,
  83866. /** Defines the amplitude of the oscillations*/
  83867. springiness?: number);
  83868. /** @hidden */
  83869. easeInCore(gradient: number): number;
  83870. }
  83871. /**
  83872. * Easing function with an exponential shape (see link below).
  83873. * @see https://easings.net/#easeInExpo
  83874. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  83875. */
  83876. export class ExponentialEase extends EasingFunction implements IEasingFunction {
  83877. /** Defines the exponent of the function */
  83878. exponent: number;
  83879. /**
  83880. * Instantiates an exponential easing function
  83881. * @see https://easings.net/#easeInExpo
  83882. * @param exponent Defines the exponent of the function
  83883. */
  83884. constructor(
  83885. /** Defines the exponent of the function */
  83886. exponent?: number);
  83887. /** @hidden */
  83888. easeInCore(gradient: number): number;
  83889. }
  83890. /**
  83891. * Easing function with a power shape (see link below).
  83892. * @see https://easings.net/#easeInQuad
  83893. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  83894. */
  83895. export class PowerEase extends EasingFunction implements IEasingFunction {
  83896. /** Defines the power of the function */
  83897. power: number;
  83898. /**
  83899. * Instantiates an power base easing function
  83900. * @see https://easings.net/#easeInQuad
  83901. * @param power Defines the power of the function
  83902. */
  83903. constructor(
  83904. /** Defines the power of the function */
  83905. power?: number);
  83906. /** @hidden */
  83907. easeInCore(gradient: number): number;
  83908. }
  83909. /**
  83910. * Easing function with a power of 2 shape (see link below).
  83911. * @see https://easings.net/#easeInQuad
  83912. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  83913. */
  83914. export class QuadraticEase extends EasingFunction implements IEasingFunction {
  83915. /** @hidden */
  83916. easeInCore(gradient: number): number;
  83917. }
  83918. /**
  83919. * Easing function with a power of 4 shape (see link below).
  83920. * @see https://easings.net/#easeInQuart
  83921. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  83922. */
  83923. export class QuarticEase extends EasingFunction implements IEasingFunction {
  83924. /** @hidden */
  83925. easeInCore(gradient: number): number;
  83926. }
  83927. /**
  83928. * Easing function with a power of 5 shape (see link below).
  83929. * @see https://easings.net/#easeInQuint
  83930. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  83931. */
  83932. export class QuinticEase extends EasingFunction implements IEasingFunction {
  83933. /** @hidden */
  83934. easeInCore(gradient: number): number;
  83935. }
  83936. /**
  83937. * Easing function with a sin shape (see link below).
  83938. * @see https://easings.net/#easeInSine
  83939. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  83940. */
  83941. export class SineEase extends EasingFunction implements IEasingFunction {
  83942. /** @hidden */
  83943. easeInCore(gradient: number): number;
  83944. }
  83945. /**
  83946. * Easing function with a bezier shape (see link below).
  83947. * @see http://cubic-bezier.com/#.17,.67,.83,.67
  83948. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  83949. */
  83950. export class BezierCurveEase extends EasingFunction implements IEasingFunction {
  83951. /** Defines the x component of the start tangent in the bezier curve */
  83952. x1: number;
  83953. /** Defines the y component of the start tangent in the bezier curve */
  83954. y1: number;
  83955. /** Defines the x component of the end tangent in the bezier curve */
  83956. x2: number;
  83957. /** Defines the y component of the end tangent in the bezier curve */
  83958. y2: number;
  83959. /**
  83960. * Instantiates a bezier function
  83961. * @see http://cubic-bezier.com/#.17,.67,.83,.67
  83962. * @param x1 Defines the x component of the start tangent in the bezier curve
  83963. * @param y1 Defines the y component of the start tangent in the bezier curve
  83964. * @param x2 Defines the x component of the end tangent in the bezier curve
  83965. * @param y2 Defines the y component of the end tangent in the bezier curve
  83966. */
  83967. constructor(
  83968. /** Defines the x component of the start tangent in the bezier curve */
  83969. x1?: number,
  83970. /** Defines the y component of the start tangent in the bezier curve */
  83971. y1?: number,
  83972. /** Defines the x component of the end tangent in the bezier curve */
  83973. x2?: number,
  83974. /** Defines the y component of the end tangent in the bezier curve */
  83975. y2?: number);
  83976. /** @hidden */
  83977. easeInCore(gradient: number): number;
  83978. }
  83979. }
  83980. declare module BABYLON {
  83981. /**
  83982. * Class used to hold a RBG color
  83983. */
  83984. export class Color3 {
  83985. /**
  83986. * Defines the red component (between 0 and 1, default is 0)
  83987. */
  83988. r: number;
  83989. /**
  83990. * Defines the green component (between 0 and 1, default is 0)
  83991. */
  83992. g: number;
  83993. /**
  83994. * Defines the blue component (between 0 and 1, default is 0)
  83995. */
  83996. b: number;
  83997. /**
  83998. * Creates a new Color3 object from red, green, blue values, all between 0 and 1
  83999. * @param r defines the red component (between 0 and 1, default is 0)
  84000. * @param g defines the green component (between 0 and 1, default is 0)
  84001. * @param b defines the blue component (between 0 and 1, default is 0)
  84002. */
  84003. constructor(
  84004. /**
  84005. * Defines the red component (between 0 and 1, default is 0)
  84006. */
  84007. r?: number,
  84008. /**
  84009. * Defines the green component (between 0 and 1, default is 0)
  84010. */
  84011. g?: number,
  84012. /**
  84013. * Defines the blue component (between 0 and 1, default is 0)
  84014. */
  84015. b?: number);
  84016. /**
  84017. * Creates a string with the Color3 current values
  84018. * @returns the string representation of the Color3 object
  84019. */
  84020. toString(): string;
  84021. /**
  84022. * Returns the string "Color3"
  84023. * @returns "Color3"
  84024. */
  84025. getClassName(): string;
  84026. /**
  84027. * Compute the Color3 hash code
  84028. * @returns an unique number that can be used to hash Color3 objects
  84029. */
  84030. getHashCode(): number;
  84031. /**
  84032. * Stores in the given array from the given starting index the red, green, blue values as successive elements
  84033. * @param array defines the array where to store the r,g,b components
  84034. * @param index defines an optional index in the target array to define where to start storing values
  84035. * @returns the current Color3 object
  84036. */
  84037. toArray(array: FloatArray, index?: number): Color3;
  84038. /**
  84039. * Returns a new Color4 object from the current Color3 and the given alpha
  84040. * @param alpha defines the alpha component on the new Color4 object (default is 1)
  84041. * @returns a new Color4 object
  84042. */
  84043. toColor4(alpha?: number): Color4;
  84044. /**
  84045. * Returns a new array populated with 3 numeric elements : red, green and blue values
  84046. * @returns the new array
  84047. */
  84048. asArray(): number[];
  84049. /**
  84050. * Returns the luminance value
  84051. * @returns a float value
  84052. */
  84053. toLuminance(): number;
  84054. /**
  84055. * Multiply each Color3 rgb values by the given Color3 rgb values in a new Color3 object
  84056. * @param otherColor defines the second operand
  84057. * @returns the new Color3 object
  84058. */
  84059. multiply(otherColor: DeepImmutable<Color3>): Color3;
  84060. /**
  84061. * Multiply the rgb values of the Color3 and the given Color3 and stores the result in the object "result"
  84062. * @param otherColor defines the second operand
  84063. * @param result defines the Color3 object where to store the result
  84064. * @returns the current Color3
  84065. */
  84066. multiplyToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  84067. /**
  84068. * Determines equality between Color3 objects
  84069. * @param otherColor defines the second operand
  84070. * @returns true if the rgb values are equal to the given ones
  84071. */
  84072. equals(otherColor: DeepImmutable<Color3>): boolean;
  84073. /**
  84074. * Determines equality between the current Color3 object and a set of r,b,g values
  84075. * @param r defines the red component to check
  84076. * @param g defines the green component to check
  84077. * @param b defines the blue component to check
  84078. * @returns true if the rgb values are equal to the given ones
  84079. */
  84080. equalsFloats(r: number, g: number, b: number): boolean;
  84081. /**
  84082. * Multiplies in place each rgb value by scale
  84083. * @param scale defines the scaling factor
  84084. * @returns the updated Color3
  84085. */
  84086. scale(scale: number): Color3;
  84087. /**
  84088. * Multiplies the rgb values by scale and stores the result into "result"
  84089. * @param scale defines the scaling factor
  84090. * @param result defines the Color3 object where to store the result
  84091. * @returns the unmodified current Color3
  84092. */
  84093. scaleToRef(scale: number, result: Color3): Color3;
  84094. /**
  84095. * Scale the current Color3 values by a factor and add the result to a given Color3
  84096. * @param scale defines the scale factor
  84097. * @param result defines color to store the result into
  84098. * @returns the unmodified current Color3
  84099. */
  84100. scaleAndAddToRef(scale: number, result: Color3): Color3;
  84101. /**
  84102. * Clamps the rgb values by the min and max values and stores the result into "result"
  84103. * @param min defines minimum clamping value (default is 0)
  84104. * @param max defines maximum clamping value (default is 1)
  84105. * @param result defines color to store the result into
  84106. * @returns the original Color3
  84107. */
  84108. clampToRef(min: number | undefined, max: number | undefined, result: Color3): Color3;
  84109. /**
  84110. * Creates a new Color3 set with the added values of the current Color3 and of the given one
  84111. * @param otherColor defines the second operand
  84112. * @returns the new Color3
  84113. */
  84114. add(otherColor: DeepImmutable<Color3>): Color3;
  84115. /**
  84116. * Stores the result of the addition of the current Color3 and given one rgb values into "result"
  84117. * @param otherColor defines the second operand
  84118. * @param result defines Color3 object to store the result into
  84119. * @returns the unmodified current Color3
  84120. */
  84121. addToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  84122. /**
  84123. * Returns a new Color3 set with the subtracted values of the given one from the current Color3
  84124. * @param otherColor defines the second operand
  84125. * @returns the new Color3
  84126. */
  84127. subtract(otherColor: DeepImmutable<Color3>): Color3;
  84128. /**
  84129. * Stores the result of the subtraction of given one from the current Color3 rgb values into "result"
  84130. * @param otherColor defines the second operand
  84131. * @param result defines Color3 object to store the result into
  84132. * @returns the unmodified current Color3
  84133. */
  84134. subtractToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  84135. /**
  84136. * Copy the current object
  84137. * @returns a new Color3 copied the current one
  84138. */
  84139. clone(): Color3;
  84140. /**
  84141. * Copies the rgb values from the source in the current Color3
  84142. * @param source defines the source Color3 object
  84143. * @returns the updated Color3 object
  84144. */
  84145. copyFrom(source: DeepImmutable<Color3>): Color3;
  84146. /**
  84147. * Updates the Color3 rgb values from the given floats
  84148. * @param r defines the red component to read from
  84149. * @param g defines the green component to read from
  84150. * @param b defines the blue component to read from
  84151. * @returns the current Color3 object
  84152. */
  84153. copyFromFloats(r: number, g: number, b: number): Color3;
  84154. /**
  84155. * Updates the Color3 rgb values from the given floats
  84156. * @param r defines the red component to read from
  84157. * @param g defines the green component to read from
  84158. * @param b defines the blue component to read from
  84159. * @returns the current Color3 object
  84160. */
  84161. set(r: number, g: number, b: number): Color3;
  84162. /**
  84163. * Compute the Color3 hexadecimal code as a string
  84164. * @returns a string containing the hexadecimal representation of the Color3 object
  84165. */
  84166. toHexString(): string;
  84167. /**
  84168. * Computes a new Color3 converted from the current one to linear space
  84169. * @returns a new Color3 object
  84170. */
  84171. toLinearSpace(): Color3;
  84172. /**
  84173. * Converts current color in rgb space to HSV values
  84174. * @returns a new color3 representing the HSV values
  84175. */
  84176. toHSV(): Color3;
  84177. /**
  84178. * Converts current color in rgb space to HSV values
  84179. * @param result defines the Color3 where to store the HSV values
  84180. */
  84181. toHSVToRef(result: Color3): void;
  84182. /**
  84183. * Converts the Color3 values to linear space and stores the result in "convertedColor"
  84184. * @param convertedColor defines the Color3 object where to store the linear space version
  84185. * @returns the unmodified Color3
  84186. */
  84187. toLinearSpaceToRef(convertedColor: Color3): Color3;
  84188. /**
  84189. * Computes a new Color3 converted from the current one to gamma space
  84190. * @returns a new Color3 object
  84191. */
  84192. toGammaSpace(): Color3;
  84193. /**
  84194. * Converts the Color3 values to gamma space and stores the result in "convertedColor"
  84195. * @param convertedColor defines the Color3 object where to store the gamma space version
  84196. * @returns the unmodified Color3
  84197. */
  84198. toGammaSpaceToRef(convertedColor: Color3): Color3;
  84199. private static _BlackReadOnly;
  84200. /**
  84201. * Convert Hue, saturation and value to a Color3 (RGB)
  84202. * @param hue defines the hue
  84203. * @param saturation defines the saturation
  84204. * @param value defines the value
  84205. * @param result defines the Color3 where to store the RGB values
  84206. */
  84207. static HSVtoRGBToRef(hue: number, saturation: number, value: number, result: Color3): void;
  84208. /**
  84209. * Creates a new Color3 from the string containing valid hexadecimal values
  84210. * @param hex defines a string containing valid hexadecimal values
  84211. * @returns a new Color3 object
  84212. */
  84213. static FromHexString(hex: string): Color3;
  84214. /**
  84215. * Creates a new Color3 from the starting index of the given array
  84216. * @param array defines the source array
  84217. * @param offset defines an offset in the source array
  84218. * @returns a new Color3 object
  84219. */
  84220. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color3;
  84221. /**
  84222. * Creates a new Color3 from integer values (< 256)
  84223. * @param r defines the red component to read from (value between 0 and 255)
  84224. * @param g defines the green component to read from (value between 0 and 255)
  84225. * @param b defines the blue component to read from (value between 0 and 255)
  84226. * @returns a new Color3 object
  84227. */
  84228. static FromInts(r: number, g: number, b: number): Color3;
  84229. /**
  84230. * Creates a new Color3 with values linearly interpolated of "amount" between the start Color3 and the end Color3
  84231. * @param start defines the start Color3 value
  84232. * @param end defines the end Color3 value
  84233. * @param amount defines the gradient value between start and end
  84234. * @returns a new Color3 object
  84235. */
  84236. static Lerp(start: DeepImmutable<Color3>, end: DeepImmutable<Color3>, amount: number): Color3;
  84237. /**
  84238. * Creates a new Color3 with values linearly interpolated of "amount" between the start Color3 and the end Color3
  84239. * @param left defines the start value
  84240. * @param right defines the end value
  84241. * @param amount defines the gradient factor
  84242. * @param result defines the Color3 object where to store the result
  84243. */
  84244. static LerpToRef(left: DeepImmutable<Color3>, right: DeepImmutable<Color3>, amount: number, result: Color3): void;
  84245. /**
  84246. * Returns a Color3 value containing a red color
  84247. * @returns a new Color3 object
  84248. */
  84249. static Red(): Color3;
  84250. /**
  84251. * Returns a Color3 value containing a green color
  84252. * @returns a new Color3 object
  84253. */
  84254. static Green(): Color3;
  84255. /**
  84256. * Returns a Color3 value containing a blue color
  84257. * @returns a new Color3 object
  84258. */
  84259. static Blue(): Color3;
  84260. /**
  84261. * Returns a Color3 value containing a black color
  84262. * @returns a new Color3 object
  84263. */
  84264. static Black(): Color3;
  84265. /**
  84266. * Gets a Color3 value containing a black color that must not be updated
  84267. */
  84268. static get BlackReadOnly(): DeepImmutable<Color3>;
  84269. /**
  84270. * Returns a Color3 value containing a white color
  84271. * @returns a new Color3 object
  84272. */
  84273. static White(): Color3;
  84274. /**
  84275. * Returns a Color3 value containing a purple color
  84276. * @returns a new Color3 object
  84277. */
  84278. static Purple(): Color3;
  84279. /**
  84280. * Returns a Color3 value containing a magenta color
  84281. * @returns a new Color3 object
  84282. */
  84283. static Magenta(): Color3;
  84284. /**
  84285. * Returns a Color3 value containing a yellow color
  84286. * @returns a new Color3 object
  84287. */
  84288. static Yellow(): Color3;
  84289. /**
  84290. * Returns a Color3 value containing a gray color
  84291. * @returns a new Color3 object
  84292. */
  84293. static Gray(): Color3;
  84294. /**
  84295. * Returns a Color3 value containing a teal color
  84296. * @returns a new Color3 object
  84297. */
  84298. static Teal(): Color3;
  84299. /**
  84300. * Returns a Color3 value containing a random color
  84301. * @returns a new Color3 object
  84302. */
  84303. static Random(): Color3;
  84304. }
  84305. /**
  84306. * Class used to hold a RBGA color
  84307. */
  84308. export class Color4 {
  84309. /**
  84310. * Defines the red component (between 0 and 1, default is 0)
  84311. */
  84312. r: number;
  84313. /**
  84314. * Defines the green component (between 0 and 1, default is 0)
  84315. */
  84316. g: number;
  84317. /**
  84318. * Defines the blue component (between 0 and 1, default is 0)
  84319. */
  84320. b: number;
  84321. /**
  84322. * Defines the alpha component (between 0 and 1, default is 1)
  84323. */
  84324. a: number;
  84325. /**
  84326. * Creates a new Color4 object from red, green, blue values, all between 0 and 1
  84327. * @param r defines the red component (between 0 and 1, default is 0)
  84328. * @param g defines the green component (between 0 and 1, default is 0)
  84329. * @param b defines the blue component (between 0 and 1, default is 0)
  84330. * @param a defines the alpha component (between 0 and 1, default is 1)
  84331. */
  84332. constructor(
  84333. /**
  84334. * Defines the red component (between 0 and 1, default is 0)
  84335. */
  84336. r?: number,
  84337. /**
  84338. * Defines the green component (between 0 and 1, default is 0)
  84339. */
  84340. g?: number,
  84341. /**
  84342. * Defines the blue component (between 0 and 1, default is 0)
  84343. */
  84344. b?: number,
  84345. /**
  84346. * Defines the alpha component (between 0 and 1, default is 1)
  84347. */
  84348. a?: number);
  84349. /**
  84350. * Adds in place the given Color4 values to the current Color4 object
  84351. * @param right defines the second operand
  84352. * @returns the current updated Color4 object
  84353. */
  84354. addInPlace(right: DeepImmutable<Color4>): Color4;
  84355. /**
  84356. * Creates a new array populated with 4 numeric elements : red, green, blue, alpha values
  84357. * @returns the new array
  84358. */
  84359. asArray(): number[];
  84360. /**
  84361. * Stores from the starting index in the given array the Color4 successive values
  84362. * @param array defines the array where to store the r,g,b components
  84363. * @param index defines an optional index in the target array to define where to start storing values
  84364. * @returns the current Color4 object
  84365. */
  84366. toArray(array: number[], index?: number): Color4;
  84367. /**
  84368. * Determines equality between Color4 objects
  84369. * @param otherColor defines the second operand
  84370. * @returns true if the rgba values are equal to the given ones
  84371. */
  84372. equals(otherColor: DeepImmutable<Color4>): boolean;
  84373. /**
  84374. * Creates a new Color4 set with the added values of the current Color4 and of the given one
  84375. * @param right defines the second operand
  84376. * @returns a new Color4 object
  84377. */
  84378. add(right: DeepImmutable<Color4>): Color4;
  84379. /**
  84380. * Creates a new Color4 set with the subtracted values of the given one from the current Color4
  84381. * @param right defines the second operand
  84382. * @returns a new Color4 object
  84383. */
  84384. subtract(right: DeepImmutable<Color4>): Color4;
  84385. /**
  84386. * Subtracts the given ones from the current Color4 values and stores the results in "result"
  84387. * @param right defines the second operand
  84388. * @param result defines the Color4 object where to store the result
  84389. * @returns the current Color4 object
  84390. */
  84391. subtractToRef(right: DeepImmutable<Color4>, result: Color4): Color4;
  84392. /**
  84393. * Creates a new Color4 with the current Color4 values multiplied by scale
  84394. * @param scale defines the scaling factor to apply
  84395. * @returns a new Color4 object
  84396. */
  84397. scale(scale: number): Color4;
  84398. /**
  84399. * Multiplies the current Color4 values by scale and stores the result in "result"
  84400. * @param scale defines the scaling factor to apply
  84401. * @param result defines the Color4 object where to store the result
  84402. * @returns the current unmodified Color4
  84403. */
  84404. scaleToRef(scale: number, result: Color4): Color4;
  84405. /**
  84406. * Scale the current Color4 values by a factor and add the result to a given Color4
  84407. * @param scale defines the scale factor
  84408. * @param result defines the Color4 object where to store the result
  84409. * @returns the unmodified current Color4
  84410. */
  84411. scaleAndAddToRef(scale: number, result: Color4): Color4;
  84412. /**
  84413. * Clamps the rgb values by the min and max values and stores the result into "result"
  84414. * @param min defines minimum clamping value (default is 0)
  84415. * @param max defines maximum clamping value (default is 1)
  84416. * @param result defines color to store the result into.
  84417. * @returns the cuurent Color4
  84418. */
  84419. clampToRef(min: number | undefined, max: number | undefined, result: Color4): Color4;
  84420. /**
  84421. * Multipy an Color4 value by another and return a new Color4 object
  84422. * @param color defines the Color4 value to multiply by
  84423. * @returns a new Color4 object
  84424. */
  84425. multiply(color: Color4): Color4;
  84426. /**
  84427. * Multipy a Color4 value by another and push the result in a reference value
  84428. * @param color defines the Color4 value to multiply by
  84429. * @param result defines the Color4 to fill the result in
  84430. * @returns the result Color4
  84431. */
  84432. multiplyToRef(color: Color4, result: Color4): Color4;
  84433. /**
  84434. * Creates a string with the Color4 current values
  84435. * @returns the string representation of the Color4 object
  84436. */
  84437. toString(): string;
  84438. /**
  84439. * Returns the string "Color4"
  84440. * @returns "Color4"
  84441. */
  84442. getClassName(): string;
  84443. /**
  84444. * Compute the Color4 hash code
  84445. * @returns an unique number that can be used to hash Color4 objects
  84446. */
  84447. getHashCode(): number;
  84448. /**
  84449. * Creates a new Color4 copied from the current one
  84450. * @returns a new Color4 object
  84451. */
  84452. clone(): Color4;
  84453. /**
  84454. * Copies the given Color4 values into the current one
  84455. * @param source defines the source Color4 object
  84456. * @returns the current updated Color4 object
  84457. */
  84458. copyFrom(source: Color4): Color4;
  84459. /**
  84460. * Copies the given float values into the current one
  84461. * @param r defines the red component to read from
  84462. * @param g defines the green component to read from
  84463. * @param b defines the blue component to read from
  84464. * @param a defines the alpha component to read from
  84465. * @returns the current updated Color4 object
  84466. */
  84467. copyFromFloats(r: number, g: number, b: number, a: number): Color4;
  84468. /**
  84469. * Copies the given float values into the current one
  84470. * @param r defines the red component to read from
  84471. * @param g defines the green component to read from
  84472. * @param b defines the blue component to read from
  84473. * @param a defines the alpha component to read from
  84474. * @returns the current updated Color4 object
  84475. */
  84476. set(r: number, g: number, b: number, a: number): Color4;
  84477. /**
  84478. * Compute the Color4 hexadecimal code as a string
  84479. * @param returnAsColor3 defines if the string should only contains RGB values (off by default)
  84480. * @returns a string containing the hexadecimal representation of the Color4 object
  84481. */
  84482. toHexString(returnAsColor3?: boolean): string;
  84483. /**
  84484. * Computes a new Color4 converted from the current one to linear space
  84485. * @returns a new Color4 object
  84486. */
  84487. toLinearSpace(): Color4;
  84488. /**
  84489. * Converts the Color4 values to linear space and stores the result in "convertedColor"
  84490. * @param convertedColor defines the Color4 object where to store the linear space version
  84491. * @returns the unmodified Color4
  84492. */
  84493. toLinearSpaceToRef(convertedColor: Color4): Color4;
  84494. /**
  84495. * Computes a new Color4 converted from the current one to gamma space
  84496. * @returns a new Color4 object
  84497. */
  84498. toGammaSpace(): Color4;
  84499. /**
  84500. * Converts the Color4 values to gamma space and stores the result in "convertedColor"
  84501. * @param convertedColor defines the Color4 object where to store the gamma space version
  84502. * @returns the unmodified Color4
  84503. */
  84504. toGammaSpaceToRef(convertedColor: Color4): Color4;
  84505. /**
  84506. * Creates a new Color4 from the string containing valid hexadecimal values
  84507. * @param hex defines a string containing valid hexadecimal values
  84508. * @returns a new Color4 object
  84509. */
  84510. static FromHexString(hex: string): Color4;
  84511. /**
  84512. * Creates a new Color4 object set with the linearly interpolated values of "amount" between the left Color4 object and the right Color4 object
  84513. * @param left defines the start value
  84514. * @param right defines the end value
  84515. * @param amount defines the gradient factor
  84516. * @returns a new Color4 object
  84517. */
  84518. static Lerp(left: DeepImmutable<Color4>, right: DeepImmutable<Color4>, amount: number): Color4;
  84519. /**
  84520. * Set the given "result" with the linearly interpolated values of "amount" between the left Color4 object and the right Color4 object
  84521. * @param left defines the start value
  84522. * @param right defines the end value
  84523. * @param amount defines the gradient factor
  84524. * @param result defines the Color4 object where to store data
  84525. */
  84526. static LerpToRef(left: DeepImmutable<Color4>, right: DeepImmutable<Color4>, amount: number, result: Color4): void;
  84527. /**
  84528. * Creates a new Color4 from a Color3 and an alpha value
  84529. * @param color3 defines the source Color3 to read from
  84530. * @param alpha defines the alpha component (1.0 by default)
  84531. * @returns a new Color4 object
  84532. */
  84533. static FromColor3(color3: DeepImmutable<Color3>, alpha?: number): Color4;
  84534. /**
  84535. * Creates a new Color4 from the starting index element of the given array
  84536. * @param array defines the source array to read from
  84537. * @param offset defines the offset in the source array
  84538. * @returns a new Color4 object
  84539. */
  84540. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color4;
  84541. /**
  84542. * Creates a new Color3 from integer values (< 256)
  84543. * @param r defines the red component to read from (value between 0 and 255)
  84544. * @param g defines the green component to read from (value between 0 and 255)
  84545. * @param b defines the blue component to read from (value between 0 and 255)
  84546. * @param a defines the alpha component to read from (value between 0 and 255)
  84547. * @returns a new Color3 object
  84548. */
  84549. static FromInts(r: number, g: number, b: number, a: number): Color4;
  84550. /**
  84551. * Check the content of a given array and convert it to an array containing RGBA data
  84552. * If the original array was already containing count * 4 values then it is returned directly
  84553. * @param colors defines the array to check
  84554. * @param count defines the number of RGBA data to expect
  84555. * @returns an array containing count * 4 values (RGBA)
  84556. */
  84557. static CheckColors4(colors: number[], count: number): number[];
  84558. }
  84559. /**
  84560. * @hidden
  84561. */
  84562. export class TmpColors {
  84563. static Color3: Color3[];
  84564. static Color4: Color4[];
  84565. }
  84566. }
  84567. declare module BABYLON {
  84568. /**
  84569. * Defines an interface which represents an animation key frame
  84570. */
  84571. export interface IAnimationKey {
  84572. /**
  84573. * Frame of the key frame
  84574. */
  84575. frame: number;
  84576. /**
  84577. * Value at the specifies key frame
  84578. */
  84579. value: any;
  84580. /**
  84581. * The input tangent for the cubic hermite spline
  84582. */
  84583. inTangent?: any;
  84584. /**
  84585. * The output tangent for the cubic hermite spline
  84586. */
  84587. outTangent?: any;
  84588. /**
  84589. * The animation interpolation type
  84590. */
  84591. interpolation?: AnimationKeyInterpolation;
  84592. }
  84593. /**
  84594. * Enum for the animation key frame interpolation type
  84595. */
  84596. export enum AnimationKeyInterpolation {
  84597. /**
  84598. * Do not interpolate between keys and use the start key value only. Tangents are ignored
  84599. */
  84600. STEP = 1
  84601. }
  84602. }
  84603. declare module BABYLON {
  84604. /**
  84605. * Represents the range of an animation
  84606. */
  84607. export class AnimationRange {
  84608. /**The name of the animation range**/
  84609. name: string;
  84610. /**The starting frame of the animation */
  84611. from: number;
  84612. /**The ending frame of the animation*/
  84613. to: number;
  84614. /**
  84615. * Initializes the range of an animation
  84616. * @param name The name of the animation range
  84617. * @param from The starting frame of the animation
  84618. * @param to The ending frame of the animation
  84619. */
  84620. constructor(
  84621. /**The name of the animation range**/
  84622. name: string,
  84623. /**The starting frame of the animation */
  84624. from: number,
  84625. /**The ending frame of the animation*/
  84626. to: number);
  84627. /**
  84628. * Makes a copy of the animation range
  84629. * @returns A copy of the animation range
  84630. */
  84631. clone(): AnimationRange;
  84632. }
  84633. }
  84634. declare module BABYLON {
  84635. /**
  84636. * Composed of a frame, and an action function
  84637. */
  84638. export class AnimationEvent {
  84639. /** The frame for which the event is triggered **/
  84640. frame: number;
  84641. /** The event to perform when triggered **/
  84642. action: (currentFrame: number) => void;
  84643. /** Specifies if the event should be triggered only once**/
  84644. onlyOnce?: boolean | undefined;
  84645. /**
  84646. * Specifies if the animation event is done
  84647. */
  84648. isDone: boolean;
  84649. /**
  84650. * Initializes the animation event
  84651. * @param frame The frame for which the event is triggered
  84652. * @param action The event to perform when triggered
  84653. * @param onlyOnce Specifies if the event should be triggered only once
  84654. */
  84655. constructor(
  84656. /** The frame for which the event is triggered **/
  84657. frame: number,
  84658. /** The event to perform when triggered **/
  84659. action: (currentFrame: number) => void,
  84660. /** Specifies if the event should be triggered only once**/
  84661. onlyOnce?: boolean | undefined);
  84662. /** @hidden */
  84663. _clone(): AnimationEvent;
  84664. }
  84665. }
  84666. declare module BABYLON {
  84667. /**
  84668. * Interface used to define a behavior
  84669. */
  84670. export interface Behavior<T> {
  84671. /** gets or sets behavior's name */
  84672. name: string;
  84673. /**
  84674. * Function called when the behavior needs to be initialized (after attaching it to a target)
  84675. */
  84676. init(): void;
  84677. /**
  84678. * Called when the behavior is attached to a target
  84679. * @param target defines the target where the behavior is attached to
  84680. */
  84681. attach(target: T): void;
  84682. /**
  84683. * Called when the behavior is detached from its target
  84684. */
  84685. detach(): void;
  84686. }
  84687. /**
  84688. * Interface implemented by classes supporting behaviors
  84689. */
  84690. export interface IBehaviorAware<T> {
  84691. /**
  84692. * Attach a behavior
  84693. * @param behavior defines the behavior to attach
  84694. * @returns the current host
  84695. */
  84696. addBehavior(behavior: Behavior<T>): T;
  84697. /**
  84698. * Remove a behavior from the current object
  84699. * @param behavior defines the behavior to detach
  84700. * @returns the current host
  84701. */
  84702. removeBehavior(behavior: Behavior<T>): T;
  84703. /**
  84704. * Gets a behavior using its name to search
  84705. * @param name defines the name to search
  84706. * @returns the behavior or null if not found
  84707. */
  84708. getBehaviorByName(name: string): Nullable<Behavior<T>>;
  84709. }
  84710. }
  84711. declare module BABYLON {
  84712. /**
  84713. * Defines an array and its length.
  84714. * It can be helpfull to group result from both Arrays and smart arrays in one structure.
  84715. */
  84716. export interface ISmartArrayLike<T> {
  84717. /**
  84718. * The data of the array.
  84719. */
  84720. data: Array<T>;
  84721. /**
  84722. * The active length of the array.
  84723. */
  84724. length: number;
  84725. }
  84726. /**
  84727. * Defines an GC Friendly array where the backfield array do not shrink to prevent over allocations.
  84728. */
  84729. export class SmartArray<T> implements ISmartArrayLike<T> {
  84730. /**
  84731. * The full set of data from the array.
  84732. */
  84733. data: Array<T>;
  84734. /**
  84735. * The active length of the array.
  84736. */
  84737. length: number;
  84738. protected _id: number;
  84739. /**
  84740. * Instantiates a Smart Array.
  84741. * @param capacity defines the default capacity of the array.
  84742. */
  84743. constructor(capacity: number);
  84744. /**
  84745. * Pushes a value at the end of the active data.
  84746. * @param value defines the object to push in the array.
  84747. */
  84748. push(value: T): void;
  84749. /**
  84750. * Iterates over the active data and apply the lambda to them.
  84751. * @param func defines the action to apply on each value.
  84752. */
  84753. forEach(func: (content: T) => void): void;
  84754. /**
  84755. * Sorts the full sets of data.
  84756. * @param compareFn defines the comparison function to apply.
  84757. */
  84758. sort(compareFn: (a: T, b: T) => number): void;
  84759. /**
  84760. * Resets the active data to an empty array.
  84761. */
  84762. reset(): void;
  84763. /**
  84764. * Releases all the data from the array as well as the array.
  84765. */
  84766. dispose(): void;
  84767. /**
  84768. * Concats the active data with a given array.
  84769. * @param array defines the data to concatenate with.
  84770. */
  84771. concat(array: any): void;
  84772. /**
  84773. * Returns the position of a value in the active data.
  84774. * @param value defines the value to find the index for
  84775. * @returns the index if found in the active data otherwise -1
  84776. */
  84777. indexOf(value: T): number;
  84778. /**
  84779. * Returns whether an element is part of the active data.
  84780. * @param value defines the value to look for
  84781. * @returns true if found in the active data otherwise false
  84782. */
  84783. contains(value: T): boolean;
  84784. private static _GlobalId;
  84785. }
  84786. /**
  84787. * Defines an GC Friendly array where the backfield array do not shrink to prevent over allocations.
  84788. * The data in this array can only be present once
  84789. */
  84790. export class SmartArrayNoDuplicate<T> extends SmartArray<T> {
  84791. private _duplicateId;
  84792. /**
  84793. * Pushes a value at the end of the active data.
  84794. * THIS DOES NOT PREVENT DUPPLICATE DATA
  84795. * @param value defines the object to push in the array.
  84796. */
  84797. push(value: T): void;
  84798. /**
  84799. * Pushes a value at the end of the active data.
  84800. * If the data is already present, it won t be added again
  84801. * @param value defines the object to push in the array.
  84802. * @returns true if added false if it was already present
  84803. */
  84804. pushNoDuplicate(value: T): boolean;
  84805. /**
  84806. * Resets the active data to an empty array.
  84807. */
  84808. reset(): void;
  84809. /**
  84810. * Concats the active data with a given array.
  84811. * This ensures no dupplicate will be present in the result.
  84812. * @param array defines the data to concatenate with.
  84813. */
  84814. concatWithNoDuplicate(array: any): void;
  84815. }
  84816. }
  84817. declare module BABYLON {
  84818. /**
  84819. * @ignore
  84820. * This is a list of all the different input types that are available in the application.
  84821. * Fo instance: ArcRotateCameraGamepadInput...
  84822. */
  84823. export var CameraInputTypes: {};
  84824. /**
  84825. * This is the contract to implement in order to create a new input class.
  84826. * Inputs are dealing with listening to user actions and moving the camera accordingly.
  84827. */
  84828. export interface ICameraInput<TCamera extends Camera> {
  84829. /**
  84830. * Defines the camera the input is attached to.
  84831. */
  84832. camera: Nullable<TCamera>;
  84833. /**
  84834. * Gets the class name of the current intput.
  84835. * @returns the class name
  84836. */
  84837. getClassName(): string;
  84838. /**
  84839. * Get the friendly name associated with the input class.
  84840. * @returns the input friendly name
  84841. */
  84842. getSimpleName(): string;
  84843. /**
  84844. * Attach the input controls to a specific dom element to get the input from.
  84845. * @param element Defines the element the controls should be listened from
  84846. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  84847. */
  84848. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  84849. /**
  84850. * Detach the current controls from the specified dom element.
  84851. * @param element Defines the element to stop listening the inputs from
  84852. */
  84853. detachControl(element: Nullable<HTMLElement>): void;
  84854. /**
  84855. * Update the current camera state depending on the inputs that have been used this frame.
  84856. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  84857. */
  84858. checkInputs?: () => void;
  84859. }
  84860. /**
  84861. * Represents a map of input types to input instance or input index to input instance.
  84862. */
  84863. export interface CameraInputsMap<TCamera extends Camera> {
  84864. /**
  84865. * Accessor to the input by input type.
  84866. */
  84867. [name: string]: ICameraInput<TCamera>;
  84868. /**
  84869. * Accessor to the input by input index.
  84870. */
  84871. [idx: number]: ICameraInput<TCamera>;
  84872. }
  84873. /**
  84874. * This represents the input manager used within a camera.
  84875. * It helps dealing with all the different kind of input attached to a camera.
  84876. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  84877. */
  84878. export class CameraInputsManager<TCamera extends Camera> {
  84879. /**
  84880. * Defines the list of inputs attahed to the camera.
  84881. */
  84882. attached: CameraInputsMap<TCamera>;
  84883. /**
  84884. * Defines the dom element the camera is collecting inputs from.
  84885. * This is null if the controls have not been attached.
  84886. */
  84887. attachedElement: Nullable<HTMLElement>;
  84888. /**
  84889. * Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  84890. */
  84891. noPreventDefault: boolean;
  84892. /**
  84893. * Defined the camera the input manager belongs to.
  84894. */
  84895. camera: TCamera;
  84896. /**
  84897. * Update the current camera state depending on the inputs that have been used this frame.
  84898. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  84899. */
  84900. checkInputs: () => void;
  84901. /**
  84902. * Instantiate a new Camera Input Manager.
  84903. * @param camera Defines the camera the input manager blongs to
  84904. */
  84905. constructor(camera: TCamera);
  84906. /**
  84907. * Add an input method to a camera
  84908. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  84909. * @param input camera input method
  84910. */
  84911. add(input: ICameraInput<TCamera>): void;
  84912. /**
  84913. * Remove a specific input method from a camera
  84914. * example: camera.inputs.remove(camera.inputs.attached.mouse);
  84915. * @param inputToRemove camera input method
  84916. */
  84917. remove(inputToRemove: ICameraInput<TCamera>): void;
  84918. /**
  84919. * Remove a specific input type from a camera
  84920. * example: camera.inputs.remove("ArcRotateCameraGamepadInput");
  84921. * @param inputType the type of the input to remove
  84922. */
  84923. removeByType(inputType: string): void;
  84924. private _addCheckInputs;
  84925. /**
  84926. * Attach the input controls to the currently attached dom element to listen the events from.
  84927. * @param input Defines the input to attach
  84928. */
  84929. attachInput(input: ICameraInput<TCamera>): void;
  84930. /**
  84931. * Attach the current manager inputs controls to a specific dom element to listen the events from.
  84932. * @param element Defines the dom element to collect the events from
  84933. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  84934. */
  84935. attachElement(element: HTMLElement, noPreventDefault?: boolean): void;
  84936. /**
  84937. * Detach the current manager inputs controls from a specific dom element.
  84938. * @param element Defines the dom element to collect the events from
  84939. * @param disconnect Defines whether the input should be removed from the current list of attached inputs
  84940. */
  84941. detachElement(element: HTMLElement, disconnect?: boolean): void;
  84942. /**
  84943. * Rebuild the dynamic inputCheck function from the current list of
  84944. * defined inputs in the manager.
  84945. */
  84946. rebuildInputCheck(): void;
  84947. /**
  84948. * Remove all attached input methods from a camera
  84949. */
  84950. clear(): void;
  84951. /**
  84952. * Serialize the current input manager attached to a camera.
  84953. * This ensures than once parsed,
  84954. * the input associated to the camera will be identical to the current ones
  84955. * @param serializedCamera Defines the camera serialization JSON the input serialization should write to
  84956. */
  84957. serialize(serializedCamera: any): void;
  84958. /**
  84959. * Parses an input manager serialized JSON to restore the previous list of inputs
  84960. * and states associated to a camera.
  84961. * @param parsedCamera Defines the JSON to parse
  84962. */
  84963. parse(parsedCamera: any): void;
  84964. }
  84965. }
  84966. declare module BABYLON {
  84967. /**
  84968. * Class used to store data that will be store in GPU memory
  84969. */
  84970. export class Buffer {
  84971. private _engine;
  84972. private _buffer;
  84973. /** @hidden */
  84974. _data: Nullable<DataArray>;
  84975. private _updatable;
  84976. private _instanced;
  84977. private _divisor;
  84978. /**
  84979. * Gets the byte stride.
  84980. */
  84981. readonly byteStride: number;
  84982. /**
  84983. * Constructor
  84984. * @param engine the engine
  84985. * @param data the data to use for this buffer
  84986. * @param updatable whether the data is updatable
  84987. * @param stride the stride (optional)
  84988. * @param postponeInternalCreation whether to postpone creating the internal WebGL buffer (optional)
  84989. * @param instanced whether the buffer is instanced (optional)
  84990. * @param useBytes set to true if the stride in in bytes (optional)
  84991. * @param divisor sets an optional divisor for instances (1 by default)
  84992. */
  84993. constructor(engine: any, data: DataArray, updatable: boolean, stride?: number, postponeInternalCreation?: boolean, instanced?: boolean, useBytes?: boolean, divisor?: number);
  84994. /**
  84995. * Create a new VertexBuffer based on the current buffer
  84996. * @param kind defines the vertex buffer kind (position, normal, etc.)
  84997. * @param offset defines offset in the buffer (0 by default)
  84998. * @param size defines the size in floats of attributes (position is 3 for instance)
  84999. * @param stride defines the stride size in floats in the buffer (the offset to apply to reach next value when data is interleaved)
  85000. * @param instanced defines if the vertex buffer contains indexed data
  85001. * @param useBytes defines if the offset and stride are in bytes *
  85002. * @param divisor sets an optional divisor for instances (1 by default)
  85003. * @returns the new vertex buffer
  85004. */
  85005. createVertexBuffer(kind: string, offset: number, size: number, stride?: number, instanced?: boolean, useBytes?: boolean, divisor?: number): VertexBuffer;
  85006. /**
  85007. * Gets a boolean indicating if the Buffer is updatable?
  85008. * @returns true if the buffer is updatable
  85009. */
  85010. isUpdatable(): boolean;
  85011. /**
  85012. * Gets current buffer's data
  85013. * @returns a DataArray or null
  85014. */
  85015. getData(): Nullable<DataArray>;
  85016. /**
  85017. * Gets underlying native buffer
  85018. * @returns underlying native buffer
  85019. */
  85020. getBuffer(): Nullable<DataBuffer>;
  85021. /**
  85022. * Gets the stride in float32 units (i.e. byte stride / 4).
  85023. * May not be an integer if the byte stride is not divisible by 4.
  85024. * @returns the stride in float32 units
  85025. * @deprecated Please use byteStride instead.
  85026. */
  85027. getStrideSize(): number;
  85028. /**
  85029. * Store data into the buffer. If the buffer was already used it will be either recreated or updated depending on isUpdatable property
  85030. * @param data defines the data to store
  85031. */
  85032. create(data?: Nullable<DataArray>): void;
  85033. /** @hidden */
  85034. _rebuild(): void;
  85035. /**
  85036. * Update current buffer data
  85037. * @param data defines the data to store
  85038. */
  85039. update(data: DataArray): void;
  85040. /**
  85041. * Updates the data directly.
  85042. * @param data the new data
  85043. * @param offset the new offset
  85044. * @param vertexCount the vertex count (optional)
  85045. * @param useBytes set to true if the offset is in bytes
  85046. */
  85047. updateDirectly(data: DataArray, offset: number, vertexCount?: number, useBytes?: boolean): void;
  85048. /**
  85049. * Release all resources
  85050. */
  85051. dispose(): void;
  85052. }
  85053. /**
  85054. * Specialized buffer used to store vertex data
  85055. */
  85056. export class VertexBuffer {
  85057. /** @hidden */
  85058. _buffer: Buffer;
  85059. private _kind;
  85060. private _size;
  85061. private _ownsBuffer;
  85062. private _instanced;
  85063. private _instanceDivisor;
  85064. /**
  85065. * The byte type.
  85066. */
  85067. static readonly BYTE: number;
  85068. /**
  85069. * The unsigned byte type.
  85070. */
  85071. static readonly UNSIGNED_BYTE: number;
  85072. /**
  85073. * The short type.
  85074. */
  85075. static readonly SHORT: number;
  85076. /**
  85077. * The unsigned short type.
  85078. */
  85079. static readonly UNSIGNED_SHORT: number;
  85080. /**
  85081. * The integer type.
  85082. */
  85083. static readonly INT: number;
  85084. /**
  85085. * The unsigned integer type.
  85086. */
  85087. static readonly UNSIGNED_INT: number;
  85088. /**
  85089. * The float type.
  85090. */
  85091. static readonly FLOAT: number;
  85092. /**
  85093. * Gets or sets the instance divisor when in instanced mode
  85094. */
  85095. get instanceDivisor(): number;
  85096. set instanceDivisor(value: number);
  85097. /**
  85098. * Gets the byte stride.
  85099. */
  85100. readonly byteStride: number;
  85101. /**
  85102. * Gets the byte offset.
  85103. */
  85104. readonly byteOffset: number;
  85105. /**
  85106. * Gets whether integer data values should be normalized into a certain range when being casted to a float.
  85107. */
  85108. readonly normalized: boolean;
  85109. /**
  85110. * Gets the data type of each component in the array.
  85111. */
  85112. readonly type: number;
  85113. /**
  85114. * Constructor
  85115. * @param engine the engine
  85116. * @param data the data to use for this vertex buffer
  85117. * @param kind the vertex buffer kind
  85118. * @param updatable whether the data is updatable
  85119. * @param postponeInternalCreation whether to postpone creating the internal WebGL buffer (optional)
  85120. * @param stride the stride (optional)
  85121. * @param instanced whether the buffer is instanced (optional)
  85122. * @param offset the offset of the data (optional)
  85123. * @param size the number of components (optional)
  85124. * @param type the type of the component (optional)
  85125. * @param normalized whether the data contains normalized data (optional)
  85126. * @param useBytes set to true if stride and offset are in bytes (optional)
  85127. * @param divisor defines the instance divisor to use (1 by default)
  85128. */
  85129. 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);
  85130. /** @hidden */
  85131. _rebuild(): void;
  85132. /**
  85133. * Returns the kind of the VertexBuffer (string)
  85134. * @returns a string
  85135. */
  85136. getKind(): string;
  85137. /**
  85138. * Gets a boolean indicating if the VertexBuffer is updatable?
  85139. * @returns true if the buffer is updatable
  85140. */
  85141. isUpdatable(): boolean;
  85142. /**
  85143. * Gets current buffer's data
  85144. * @returns a DataArray or null
  85145. */
  85146. getData(): Nullable<DataArray>;
  85147. /**
  85148. * Gets underlying native buffer
  85149. * @returns underlying native buffer
  85150. */
  85151. getBuffer(): Nullable<DataBuffer>;
  85152. /**
  85153. * Gets the stride in float32 units (i.e. byte stride / 4).
  85154. * May not be an integer if the byte stride is not divisible by 4.
  85155. * @returns the stride in float32 units
  85156. * @deprecated Please use byteStride instead.
  85157. */
  85158. getStrideSize(): number;
  85159. /**
  85160. * Returns the offset as a multiple of the type byte length.
  85161. * @returns the offset in bytes
  85162. * @deprecated Please use byteOffset instead.
  85163. */
  85164. getOffset(): number;
  85165. /**
  85166. * Returns the number of components per vertex attribute (integer)
  85167. * @returns the size in float
  85168. */
  85169. getSize(): number;
  85170. /**
  85171. * Gets a boolean indicating is the internal buffer of the VertexBuffer is instanced
  85172. * @returns true if this buffer is instanced
  85173. */
  85174. getIsInstanced(): boolean;
  85175. /**
  85176. * Returns the instancing divisor, zero for non-instanced (integer).
  85177. * @returns a number
  85178. */
  85179. getInstanceDivisor(): number;
  85180. /**
  85181. * Store data into the buffer. If the buffer was already used it will be either recreated or updated depending on isUpdatable property
  85182. * @param data defines the data to store
  85183. */
  85184. create(data?: DataArray): void;
  85185. /**
  85186. * Updates the underlying buffer according to the passed numeric array or Float32Array.
  85187. * This function will create a new buffer if the current one is not updatable
  85188. * @param data defines the data to store
  85189. */
  85190. update(data: DataArray): void;
  85191. /**
  85192. * Updates directly the underlying WebGLBuffer according to the passed numeric array or Float32Array.
  85193. * Returns the directly updated WebGLBuffer.
  85194. * @param data the new data
  85195. * @param offset the new offset
  85196. * @param useBytes set to true if the offset is in bytes
  85197. */
  85198. updateDirectly(data: DataArray, offset: number, useBytes?: boolean): void;
  85199. /**
  85200. * Disposes the VertexBuffer and the underlying WebGLBuffer.
  85201. */
  85202. dispose(): void;
  85203. /**
  85204. * Enumerates each value of this vertex buffer as numbers.
  85205. * @param count the number of values to enumerate
  85206. * @param callback the callback function called for each value
  85207. */
  85208. forEach(count: number, callback: (value: number, index: number) => void): void;
  85209. /**
  85210. * Positions
  85211. */
  85212. static readonly PositionKind: string;
  85213. /**
  85214. * Normals
  85215. */
  85216. static readonly NormalKind: string;
  85217. /**
  85218. * Tangents
  85219. */
  85220. static readonly TangentKind: string;
  85221. /**
  85222. * Texture coordinates
  85223. */
  85224. static readonly UVKind: string;
  85225. /**
  85226. * Texture coordinates 2
  85227. */
  85228. static readonly UV2Kind: string;
  85229. /**
  85230. * Texture coordinates 3
  85231. */
  85232. static readonly UV3Kind: string;
  85233. /**
  85234. * Texture coordinates 4
  85235. */
  85236. static readonly UV4Kind: string;
  85237. /**
  85238. * Texture coordinates 5
  85239. */
  85240. static readonly UV5Kind: string;
  85241. /**
  85242. * Texture coordinates 6
  85243. */
  85244. static readonly UV6Kind: string;
  85245. /**
  85246. * Colors
  85247. */
  85248. static readonly ColorKind: string;
  85249. /**
  85250. * Matrix indices (for bones)
  85251. */
  85252. static readonly MatricesIndicesKind: string;
  85253. /**
  85254. * Matrix weights (for bones)
  85255. */
  85256. static readonly MatricesWeightsKind: string;
  85257. /**
  85258. * Additional matrix indices (for bones)
  85259. */
  85260. static readonly MatricesIndicesExtraKind: string;
  85261. /**
  85262. * Additional matrix weights (for bones)
  85263. */
  85264. static readonly MatricesWeightsExtraKind: string;
  85265. /**
  85266. * Deduces the stride given a kind.
  85267. * @param kind The kind string to deduce
  85268. * @returns The deduced stride
  85269. */
  85270. static DeduceStride(kind: string): number;
  85271. /**
  85272. * Gets the byte length of the given type.
  85273. * @param type the type
  85274. * @returns the number of bytes
  85275. */
  85276. static GetTypeByteLength(type: number): number;
  85277. /**
  85278. * Enumerates each value of the given parameters as numbers.
  85279. * @param data the data to enumerate
  85280. * @param byteOffset the byte offset of the data
  85281. * @param byteStride the byte stride of the data
  85282. * @param componentCount the number of components per element
  85283. * @param componentType the type of the component
  85284. * @param count the number of values to enumerate
  85285. * @param normalized whether the data is normalized
  85286. * @param callback the callback function called for each value
  85287. */
  85288. static ForEach(data: DataArray, byteOffset: number, byteStride: number, componentCount: number, componentType: number, count: number, normalized: boolean, callback: (value: number, index: number) => void): void;
  85289. private static _GetFloatValue;
  85290. }
  85291. }
  85292. declare module BABYLON {
  85293. /**
  85294. * @hidden
  85295. */
  85296. export class IntersectionInfo {
  85297. bu: Nullable<number>;
  85298. bv: Nullable<number>;
  85299. distance: number;
  85300. faceId: number;
  85301. subMeshId: number;
  85302. constructor(bu: Nullable<number>, bv: Nullable<number>, distance: number);
  85303. }
  85304. }
  85305. declare module BABYLON {
  85306. /**
  85307. * Class used to store bounding sphere information
  85308. */
  85309. export class BoundingSphere {
  85310. /**
  85311. * Gets the center of the bounding sphere in local space
  85312. */
  85313. readonly center: Vector3;
  85314. /**
  85315. * Radius of the bounding sphere in local space
  85316. */
  85317. radius: number;
  85318. /**
  85319. * Gets the center of the bounding sphere in world space
  85320. */
  85321. readonly centerWorld: Vector3;
  85322. /**
  85323. * Radius of the bounding sphere in world space
  85324. */
  85325. radiusWorld: number;
  85326. /**
  85327. * Gets the minimum vector in local space
  85328. */
  85329. readonly minimum: Vector3;
  85330. /**
  85331. * Gets the maximum vector in local space
  85332. */
  85333. readonly maximum: Vector3;
  85334. private _worldMatrix;
  85335. private static readonly TmpVector3;
  85336. /**
  85337. * Creates a new bounding sphere
  85338. * @param min defines the minimum vector (in local space)
  85339. * @param max defines the maximum vector (in local space)
  85340. * @param worldMatrix defines the new world matrix
  85341. */
  85342. constructor(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  85343. /**
  85344. * Recreates the entire bounding sphere from scratch as if we call the constructor in place
  85345. * @param min defines the new minimum vector (in local space)
  85346. * @param max defines the new maximum vector (in local space)
  85347. * @param worldMatrix defines the new world matrix
  85348. */
  85349. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  85350. /**
  85351. * Scale the current bounding sphere by applying a scale factor
  85352. * @param factor defines the scale factor to apply
  85353. * @returns the current bounding box
  85354. */
  85355. scale(factor: number): BoundingSphere;
  85356. /**
  85357. * Gets the world matrix of the bounding box
  85358. * @returns a matrix
  85359. */
  85360. getWorldMatrix(): DeepImmutable<Matrix>;
  85361. /** @hidden */
  85362. _update(worldMatrix: DeepImmutable<Matrix>): void;
  85363. /**
  85364. * Tests if the bounding sphere is intersecting the frustum planes
  85365. * @param frustumPlanes defines the frustum planes to test
  85366. * @returns true if there is an intersection
  85367. */
  85368. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  85369. /**
  85370. * Tests if the bounding sphere center is in between the frustum planes.
  85371. * Used for optimistic fast inclusion.
  85372. * @param frustumPlanes defines the frustum planes to test
  85373. * @returns true if the sphere center is in between the frustum planes
  85374. */
  85375. isCenterInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  85376. /**
  85377. * Tests if a point is inside the bounding sphere
  85378. * @param point defines the point to test
  85379. * @returns true if the point is inside the bounding sphere
  85380. */
  85381. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  85382. /**
  85383. * Checks if two sphere intersct
  85384. * @param sphere0 sphere 0
  85385. * @param sphere1 sphere 1
  85386. * @returns true if the speres intersect
  85387. */
  85388. static Intersects(sphere0: DeepImmutable<BoundingSphere>, sphere1: DeepImmutable<BoundingSphere>): boolean;
  85389. }
  85390. }
  85391. declare module BABYLON {
  85392. /**
  85393. * Class used to store bounding box information
  85394. */
  85395. export class BoundingBox implements ICullable {
  85396. /**
  85397. * Gets the 8 vectors representing the bounding box in local space
  85398. */
  85399. readonly vectors: Vector3[];
  85400. /**
  85401. * Gets the center of the bounding box in local space
  85402. */
  85403. readonly center: Vector3;
  85404. /**
  85405. * Gets the center of the bounding box in world space
  85406. */
  85407. readonly centerWorld: Vector3;
  85408. /**
  85409. * Gets the extend size in local space
  85410. */
  85411. readonly extendSize: Vector3;
  85412. /**
  85413. * Gets the extend size in world space
  85414. */
  85415. readonly extendSizeWorld: Vector3;
  85416. /**
  85417. * Gets the OBB (object bounding box) directions
  85418. */
  85419. readonly directions: Vector3[];
  85420. /**
  85421. * Gets the 8 vectors representing the bounding box in world space
  85422. */
  85423. readonly vectorsWorld: Vector3[];
  85424. /**
  85425. * Gets the minimum vector in world space
  85426. */
  85427. readonly minimumWorld: Vector3;
  85428. /**
  85429. * Gets the maximum vector in world space
  85430. */
  85431. readonly maximumWorld: Vector3;
  85432. /**
  85433. * Gets the minimum vector in local space
  85434. */
  85435. readonly minimum: Vector3;
  85436. /**
  85437. * Gets the maximum vector in local space
  85438. */
  85439. readonly maximum: Vector3;
  85440. private _worldMatrix;
  85441. private static readonly TmpVector3;
  85442. /**
  85443. * @hidden
  85444. */
  85445. _tag: number;
  85446. /**
  85447. * Creates a new bounding box
  85448. * @param min defines the minimum vector (in local space)
  85449. * @param max defines the maximum vector (in local space)
  85450. * @param worldMatrix defines the new world matrix
  85451. */
  85452. constructor(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  85453. /**
  85454. * Recreates the entire bounding box from scratch as if we call the constructor in place
  85455. * @param min defines the new minimum vector (in local space)
  85456. * @param max defines the new maximum vector (in local space)
  85457. * @param worldMatrix defines the new world matrix
  85458. */
  85459. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  85460. /**
  85461. * Scale the current bounding box by applying a scale factor
  85462. * @param factor defines the scale factor to apply
  85463. * @returns the current bounding box
  85464. */
  85465. scale(factor: number): BoundingBox;
  85466. /**
  85467. * Gets the world matrix of the bounding box
  85468. * @returns a matrix
  85469. */
  85470. getWorldMatrix(): DeepImmutable<Matrix>;
  85471. /** @hidden */
  85472. _update(world: DeepImmutable<Matrix>): void;
  85473. /**
  85474. * Tests if the bounding box is intersecting the frustum planes
  85475. * @param frustumPlanes defines the frustum planes to test
  85476. * @returns true if there is an intersection
  85477. */
  85478. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  85479. /**
  85480. * Tests if the bounding box is entirely inside the frustum planes
  85481. * @param frustumPlanes defines the frustum planes to test
  85482. * @returns true if there is an inclusion
  85483. */
  85484. isCompletelyInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  85485. /**
  85486. * Tests if a point is inside the bounding box
  85487. * @param point defines the point to test
  85488. * @returns true if the point is inside the bounding box
  85489. */
  85490. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  85491. /**
  85492. * Tests if the bounding box intersects with a bounding sphere
  85493. * @param sphere defines the sphere to test
  85494. * @returns true if there is an intersection
  85495. */
  85496. intersectsSphere(sphere: DeepImmutable<BoundingSphere>): boolean;
  85497. /**
  85498. * Tests if the bounding box intersects with a box defined by a min and max vectors
  85499. * @param min defines the min vector to use
  85500. * @param max defines the max vector to use
  85501. * @returns true if there is an intersection
  85502. */
  85503. intersectsMinMax(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>): boolean;
  85504. /**
  85505. * Tests if two bounding boxes are intersections
  85506. * @param box0 defines the first box to test
  85507. * @param box1 defines the second box to test
  85508. * @returns true if there is an intersection
  85509. */
  85510. static Intersects(box0: DeepImmutable<BoundingBox>, box1: DeepImmutable<BoundingBox>): boolean;
  85511. /**
  85512. * Tests if a bounding box defines by a min/max vectors intersects a sphere
  85513. * @param minPoint defines the minimum vector of the bounding box
  85514. * @param maxPoint defines the maximum vector of the bounding box
  85515. * @param sphereCenter defines the sphere center
  85516. * @param sphereRadius defines the sphere radius
  85517. * @returns true if there is an intersection
  85518. */
  85519. static IntersectsSphere(minPoint: DeepImmutable<Vector3>, maxPoint: DeepImmutable<Vector3>, sphereCenter: DeepImmutable<Vector3>, sphereRadius: number): boolean;
  85520. /**
  85521. * Tests if a bounding box defined with 8 vectors is entirely inside frustum planes
  85522. * @param boundingVectors defines an array of 8 vectors representing a bounding box
  85523. * @param frustumPlanes defines the frustum planes to test
  85524. * @return true if there is an inclusion
  85525. */
  85526. static IsCompletelyInFrustum(boundingVectors: Array<DeepImmutable<Vector3>>, frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  85527. /**
  85528. * Tests if a bounding box defined with 8 vectors intersects frustum planes
  85529. * @param boundingVectors defines an array of 8 vectors representing a bounding box
  85530. * @param frustumPlanes defines the frustum planes to test
  85531. * @return true if there is an intersection
  85532. */
  85533. static IsInFrustum(boundingVectors: Array<DeepImmutable<Vector3>>, frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  85534. }
  85535. }
  85536. declare module BABYLON {
  85537. /** @hidden */
  85538. export class Collider {
  85539. /** Define if a collision was found */
  85540. collisionFound: boolean;
  85541. /**
  85542. * Define last intersection point in local space
  85543. */
  85544. intersectionPoint: Vector3;
  85545. /**
  85546. * Define last collided mesh
  85547. */
  85548. collidedMesh: Nullable<AbstractMesh>;
  85549. private _collisionPoint;
  85550. private _planeIntersectionPoint;
  85551. private _tempVector;
  85552. private _tempVector2;
  85553. private _tempVector3;
  85554. private _tempVector4;
  85555. private _edge;
  85556. private _baseToVertex;
  85557. private _destinationPoint;
  85558. private _slidePlaneNormal;
  85559. private _displacementVector;
  85560. /** @hidden */
  85561. _radius: Vector3;
  85562. /** @hidden */
  85563. _retry: number;
  85564. private _velocity;
  85565. private _basePoint;
  85566. private _epsilon;
  85567. /** @hidden */
  85568. _velocityWorldLength: number;
  85569. /** @hidden */
  85570. _basePointWorld: Vector3;
  85571. private _velocityWorld;
  85572. private _normalizedVelocity;
  85573. /** @hidden */
  85574. _initialVelocity: Vector3;
  85575. /** @hidden */
  85576. _initialPosition: Vector3;
  85577. private _nearestDistance;
  85578. private _collisionMask;
  85579. get collisionMask(): number;
  85580. set collisionMask(mask: number);
  85581. /**
  85582. * Gets the plane normal used to compute the sliding response (in local space)
  85583. */
  85584. get slidePlaneNormal(): Vector3;
  85585. /** @hidden */
  85586. _initialize(source: Vector3, dir: Vector3, e: number): void;
  85587. /** @hidden */
  85588. _checkPointInTriangle(point: Vector3, pa: Vector3, pb: Vector3, pc: Vector3, n: Vector3): boolean;
  85589. /** @hidden */
  85590. _canDoCollision(sphereCenter: Vector3, sphereRadius: number, vecMin: Vector3, vecMax: Vector3): boolean;
  85591. /** @hidden */
  85592. _testTriangle(faceIndex: number, trianglePlaneArray: Array<Plane>, p1: Vector3, p2: Vector3, p3: Vector3, hasMaterial: boolean, hostMesh: AbstractMesh): void;
  85593. /** @hidden */
  85594. _collide(trianglePlaneArray: Array<Plane>, pts: Vector3[], indices: IndicesArray, indexStart: number, indexEnd: number, decal: number, hasMaterial: boolean, hostMesh: AbstractMesh): void;
  85595. /** @hidden */
  85596. _getResponse(pos: Vector3, vel: Vector3): void;
  85597. }
  85598. }
  85599. declare module BABYLON {
  85600. /**
  85601. * Interface for cullable objects
  85602. * @see https://doc.babylonjs.com/babylon101/materials#back-face-culling
  85603. */
  85604. export interface ICullable {
  85605. /**
  85606. * Checks if the object or part of the object is in the frustum
  85607. * @param frustumPlanes Camera near/planes
  85608. * @returns true if the object is in frustum otherwise false
  85609. */
  85610. isInFrustum(frustumPlanes: Plane[]): boolean;
  85611. /**
  85612. * Checks if a cullable object (mesh...) is in the camera frustum
  85613. * Unlike isInFrustum this cheks the full bounding box
  85614. * @param frustumPlanes Camera near/planes
  85615. * @returns true if the object is in frustum otherwise false
  85616. */
  85617. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  85618. }
  85619. /**
  85620. * Info for a bounding data of a mesh
  85621. */
  85622. export class BoundingInfo implements ICullable {
  85623. /**
  85624. * Bounding box for the mesh
  85625. */
  85626. readonly boundingBox: BoundingBox;
  85627. /**
  85628. * Bounding sphere for the mesh
  85629. */
  85630. readonly boundingSphere: BoundingSphere;
  85631. private _isLocked;
  85632. private static readonly TmpVector3;
  85633. /**
  85634. * Constructs bounding info
  85635. * @param minimum min vector of the bounding box/sphere
  85636. * @param maximum max vector of the bounding box/sphere
  85637. * @param worldMatrix defines the new world matrix
  85638. */
  85639. constructor(minimum: DeepImmutable<Vector3>, maximum: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  85640. /**
  85641. * Recreates the entire bounding info from scratch as if we call the constructor in place
  85642. * @param min defines the new minimum vector (in local space)
  85643. * @param max defines the new maximum vector (in local space)
  85644. * @param worldMatrix defines the new world matrix
  85645. */
  85646. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  85647. /**
  85648. * min vector of the bounding box/sphere
  85649. */
  85650. get minimum(): Vector3;
  85651. /**
  85652. * max vector of the bounding box/sphere
  85653. */
  85654. get maximum(): Vector3;
  85655. /**
  85656. * If the info is locked and won't be updated to avoid perf overhead
  85657. */
  85658. get isLocked(): boolean;
  85659. set isLocked(value: boolean);
  85660. /**
  85661. * Updates the bounding sphere and box
  85662. * @param world world matrix to be used to update
  85663. */
  85664. update(world: DeepImmutable<Matrix>): void;
  85665. /**
  85666. * Recreate the bounding info to be centered around a specific point given a specific extend.
  85667. * @param center New center of the bounding info
  85668. * @param extend New extend of the bounding info
  85669. * @returns the current bounding info
  85670. */
  85671. centerOn(center: DeepImmutable<Vector3>, extend: DeepImmutable<Vector3>): BoundingInfo;
  85672. /**
  85673. * Scale the current bounding info by applying a scale factor
  85674. * @param factor defines the scale factor to apply
  85675. * @returns the current bounding info
  85676. */
  85677. scale(factor: number): BoundingInfo;
  85678. /**
  85679. * Returns `true` if the bounding info is within the frustum defined by the passed array of planes.
  85680. * @param frustumPlanes defines the frustum to test
  85681. * @param strategy defines the strategy to use for the culling (default is BABYLON.AbstractMesh.CULLINGSTRATEGY_STANDARD)
  85682. * @returns true if the bounding info is in the frustum planes
  85683. */
  85684. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>, strategy?: number): boolean;
  85685. /**
  85686. * Gets the world distance between the min and max points of the bounding box
  85687. */
  85688. get diagonalLength(): number;
  85689. /**
  85690. * Checks if a cullable object (mesh...) is in the camera frustum
  85691. * Unlike isInFrustum this cheks the full bounding box
  85692. * @param frustumPlanes Camera near/planes
  85693. * @returns true if the object is in frustum otherwise false
  85694. */
  85695. isCompletelyInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  85696. /** @hidden */
  85697. _checkCollision(collider: Collider): boolean;
  85698. /**
  85699. * Checks if a point is inside the bounding box and bounding sphere or the mesh
  85700. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  85701. * @param point the point to check intersection with
  85702. * @returns if the point intersects
  85703. */
  85704. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  85705. /**
  85706. * Checks if another bounding info intersects the bounding box and bounding sphere or the mesh
  85707. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  85708. * @param boundingInfo the bounding info to check intersection with
  85709. * @param precise if the intersection should be done using OBB
  85710. * @returns if the bounding info intersects
  85711. */
  85712. intersects(boundingInfo: DeepImmutable<BoundingInfo>, precise: boolean): boolean;
  85713. }
  85714. }
  85715. declare module BABYLON {
  85716. /**
  85717. * Extracts minimum and maximum values from a list of indexed positions
  85718. * @param positions defines the positions to use
  85719. * @param indices defines the indices to the positions
  85720. * @param indexStart defines the start index
  85721. * @param indexCount defines the end index
  85722. * @param bias defines bias value to add to the result
  85723. * @return minimum and maximum values
  85724. */
  85725. export function extractMinAndMaxIndexed(positions: FloatArray, indices: IndicesArray, indexStart: number, indexCount: number, bias?: Nullable<Vector2>): {
  85726. minimum: Vector3;
  85727. maximum: Vector3;
  85728. };
  85729. /**
  85730. * Extracts minimum and maximum values from a list of positions
  85731. * @param positions defines the positions to use
  85732. * @param start defines the start index in the positions array
  85733. * @param count defines the number of positions to handle
  85734. * @param bias defines bias value to add to the result
  85735. * @param stride defines the stride size to use (distance between two positions in the positions array)
  85736. * @return minimum and maximum values
  85737. */
  85738. export function extractMinAndMax(positions: FloatArray, start: number, count: number, bias?: Nullable<Vector2>, stride?: number): {
  85739. minimum: Vector3;
  85740. maximum: Vector3;
  85741. };
  85742. }
  85743. declare module BABYLON {
  85744. /** @hidden */
  85745. export class WebGLDataBuffer extends DataBuffer {
  85746. private _buffer;
  85747. constructor(resource: WebGLBuffer);
  85748. get underlyingResource(): any;
  85749. }
  85750. }
  85751. declare module BABYLON {
  85752. /** @hidden */
  85753. export class WebGLPipelineContext implements IPipelineContext {
  85754. engine: ThinEngine;
  85755. program: Nullable<WebGLProgram>;
  85756. context?: WebGLRenderingContext;
  85757. vertexShader?: WebGLShader;
  85758. fragmentShader?: WebGLShader;
  85759. isParallelCompiled: boolean;
  85760. onCompiled?: () => void;
  85761. transformFeedback?: WebGLTransformFeedback | null;
  85762. vertexCompilationError: Nullable<string>;
  85763. fragmentCompilationError: Nullable<string>;
  85764. programLinkError: Nullable<string>;
  85765. programValidationError: Nullable<string>;
  85766. get isAsync(): boolean;
  85767. get isReady(): boolean;
  85768. _handlesSpectorRebuildCallback(onCompiled: (program: WebGLProgram) => void): void;
  85769. _getVertexShaderCode(): string | null;
  85770. _getFragmentShaderCode(): string | null;
  85771. }
  85772. }
  85773. declare module BABYLON {
  85774. interface ThinEngine {
  85775. /**
  85776. * Create an uniform buffer
  85777. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  85778. * @param elements defines the content of the uniform buffer
  85779. * @returns the webGL uniform buffer
  85780. */
  85781. createUniformBuffer(elements: FloatArray): DataBuffer;
  85782. /**
  85783. * Create a dynamic uniform buffer
  85784. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  85785. * @param elements defines the content of the uniform buffer
  85786. * @returns the webGL uniform buffer
  85787. */
  85788. createDynamicUniformBuffer(elements: FloatArray): DataBuffer;
  85789. /**
  85790. * Update an existing uniform buffer
  85791. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  85792. * @param uniformBuffer defines the target uniform buffer
  85793. * @param elements defines the content to update
  85794. * @param offset defines the offset in the uniform buffer where update should start
  85795. * @param count defines the size of the data to update
  85796. */
  85797. updateUniformBuffer(uniformBuffer: DataBuffer, elements: FloatArray, offset?: number, count?: number): void;
  85798. /**
  85799. * Bind an uniform buffer to the current webGL context
  85800. * @param buffer defines the buffer to bind
  85801. */
  85802. bindUniformBuffer(buffer: Nullable<DataBuffer>): void;
  85803. /**
  85804. * Bind a buffer to the current webGL context at a given location
  85805. * @param buffer defines the buffer to bind
  85806. * @param location defines the index where to bind the buffer
  85807. */
  85808. bindUniformBufferBase(buffer: DataBuffer, location: number): void;
  85809. /**
  85810. * Bind a specific block at a given index in a specific shader program
  85811. * @param pipelineContext defines the pipeline context to use
  85812. * @param blockName defines the block name
  85813. * @param index defines the index where to bind the block
  85814. */
  85815. bindUniformBlock(pipelineContext: IPipelineContext, blockName: string, index: number): void;
  85816. }
  85817. }
  85818. declare module BABYLON {
  85819. /**
  85820. * Uniform buffer objects.
  85821. *
  85822. * Handles blocks of uniform on the GPU.
  85823. *
  85824. * If WebGL 2 is not available, this class falls back on traditionnal setUniformXXX calls.
  85825. *
  85826. * For more information, please refer to :
  85827. * https://www.khronos.org/opengl/wiki/Uniform_Buffer_Object
  85828. */
  85829. export class UniformBuffer {
  85830. private _engine;
  85831. private _buffer;
  85832. private _data;
  85833. private _bufferData;
  85834. private _dynamic?;
  85835. private _uniformLocations;
  85836. private _uniformSizes;
  85837. private _uniformLocationPointer;
  85838. private _needSync;
  85839. private _noUBO;
  85840. private _currentEffect;
  85841. /** @hidden */
  85842. _alreadyBound: boolean;
  85843. private static _MAX_UNIFORM_SIZE;
  85844. private static _tempBuffer;
  85845. /**
  85846. * Lambda to Update a 3x3 Matrix in a uniform buffer.
  85847. * This is dynamic to allow compat with webgl 1 and 2.
  85848. * You will need to pass the name of the uniform as well as the value.
  85849. */
  85850. updateMatrix3x3: (name: string, matrix: Float32Array) => void;
  85851. /**
  85852. * Lambda to Update a 2x2 Matrix in a uniform buffer.
  85853. * This is dynamic to allow compat with webgl 1 and 2.
  85854. * You will need to pass the name of the uniform as well as the value.
  85855. */
  85856. updateMatrix2x2: (name: string, matrix: Float32Array) => void;
  85857. /**
  85858. * Lambda to Update a single float in a uniform buffer.
  85859. * This is dynamic to allow compat with webgl 1 and 2.
  85860. * You will need to pass the name of the uniform as well as the value.
  85861. */
  85862. updateFloat: (name: string, x: number) => void;
  85863. /**
  85864. * Lambda to Update a vec2 of float in a uniform buffer.
  85865. * This is dynamic to allow compat with webgl 1 and 2.
  85866. * You will need to pass the name of the uniform as well as the value.
  85867. */
  85868. updateFloat2: (name: string, x: number, y: number, suffix?: string) => void;
  85869. /**
  85870. * Lambda to Update a vec3 of float in a uniform buffer.
  85871. * This is dynamic to allow compat with webgl 1 and 2.
  85872. * You will need to pass the name of the uniform as well as the value.
  85873. */
  85874. updateFloat3: (name: string, x: number, y: number, z: number, suffix?: string) => void;
  85875. /**
  85876. * Lambda to Update a vec4 of float in a uniform buffer.
  85877. * This is dynamic to allow compat with webgl 1 and 2.
  85878. * You will need to pass the name of the uniform as well as the value.
  85879. */
  85880. updateFloat4: (name: string, x: number, y: number, z: number, w: number, suffix?: string) => void;
  85881. /**
  85882. * Lambda to Update a 4x4 Matrix in a uniform buffer.
  85883. * This is dynamic to allow compat with webgl 1 and 2.
  85884. * You will need to pass the name of the uniform as well as the value.
  85885. */
  85886. updateMatrix: (name: string, mat: Matrix) => void;
  85887. /**
  85888. * Lambda to Update vec3 of float from a Vector in a uniform buffer.
  85889. * This is dynamic to allow compat with webgl 1 and 2.
  85890. * You will need to pass the name of the uniform as well as the value.
  85891. */
  85892. updateVector3: (name: string, vector: Vector3) => void;
  85893. /**
  85894. * Lambda to Update vec4 of float from a Vector in a uniform buffer.
  85895. * This is dynamic to allow compat with webgl 1 and 2.
  85896. * You will need to pass the name of the uniform as well as the value.
  85897. */
  85898. updateVector4: (name: string, vector: Vector4) => void;
  85899. /**
  85900. * Lambda to Update vec3 of float from a Color in a uniform buffer.
  85901. * This is dynamic to allow compat with webgl 1 and 2.
  85902. * You will need to pass the name of the uniform as well as the value.
  85903. */
  85904. updateColor3: (name: string, color: Color3, suffix?: string) => void;
  85905. /**
  85906. * Lambda to Update vec4 of float from a Color in a uniform buffer.
  85907. * This is dynamic to allow compat with webgl 1 and 2.
  85908. * You will need to pass the name of the uniform as well as the value.
  85909. */
  85910. updateColor4: (name: string, color: Color3, alpha: number, suffix?: string) => void;
  85911. /**
  85912. * Instantiates a new Uniform buffer objects.
  85913. *
  85914. * Handles blocks of uniform on the GPU.
  85915. *
  85916. * If WebGL 2 is not available, this class falls back on traditionnal setUniformXXX calls.
  85917. *
  85918. * For more information, please refer to :
  85919. * @see https://www.khronos.org/opengl/wiki/Uniform_Buffer_Object
  85920. * @param engine Define the engine the buffer is associated with
  85921. * @param data Define the data contained in the buffer
  85922. * @param dynamic Define if the buffer is updatable
  85923. */
  85924. constructor(engine: Engine, data?: number[], dynamic?: boolean);
  85925. /**
  85926. * Indicates if the buffer is using the WebGL2 UBO implementation,
  85927. * or just falling back on setUniformXXX calls.
  85928. */
  85929. get useUbo(): boolean;
  85930. /**
  85931. * Indicates if the WebGL underlying uniform buffer is in sync
  85932. * with the javascript cache data.
  85933. */
  85934. get isSync(): boolean;
  85935. /**
  85936. * Indicates if the WebGL underlying uniform buffer is dynamic.
  85937. * Also, a dynamic UniformBuffer will disable cache verification and always
  85938. * update the underlying WebGL uniform buffer to the GPU.
  85939. * @returns if Dynamic, otherwise false
  85940. */
  85941. isDynamic(): boolean;
  85942. /**
  85943. * The data cache on JS side.
  85944. * @returns the underlying data as a float array
  85945. */
  85946. getData(): Float32Array;
  85947. /**
  85948. * The underlying WebGL Uniform buffer.
  85949. * @returns the webgl buffer
  85950. */
  85951. getBuffer(): Nullable<DataBuffer>;
  85952. /**
  85953. * std140 layout specifies how to align data within an UBO structure.
  85954. * See https://khronos.org/registry/OpenGL/specs/gl/glspec45.core.pdf#page=159
  85955. * for specs.
  85956. */
  85957. private _fillAlignment;
  85958. /**
  85959. * Adds an uniform in the buffer.
  85960. * Warning : the subsequents calls of this function must be in the same order as declared in the shader
  85961. * for the layout to be correct !
  85962. * @param name Name of the uniform, as used in the uniform block in the shader.
  85963. * @param size Data size, or data directly.
  85964. */
  85965. addUniform(name: string, size: number | number[]): void;
  85966. /**
  85967. * Adds a Matrix 4x4 to the uniform buffer.
  85968. * @param name Name of the uniform, as used in the uniform block in the shader.
  85969. * @param mat A 4x4 matrix.
  85970. */
  85971. addMatrix(name: string, mat: Matrix): void;
  85972. /**
  85973. * Adds a vec2 to the uniform buffer.
  85974. * @param name Name of the uniform, as used in the uniform block in the shader.
  85975. * @param x Define the x component value of the vec2
  85976. * @param y Define the y component value of the vec2
  85977. */
  85978. addFloat2(name: string, x: number, y: number): void;
  85979. /**
  85980. * Adds a vec3 to the uniform buffer.
  85981. * @param name Name of the uniform, as used in the uniform block in the shader.
  85982. * @param x Define the x component value of the vec3
  85983. * @param y Define the y component value of the vec3
  85984. * @param z Define the z component value of the vec3
  85985. */
  85986. addFloat3(name: string, x: number, y: number, z: number): void;
  85987. /**
  85988. * Adds a vec3 to the uniform buffer.
  85989. * @param name Name of the uniform, as used in the uniform block in the shader.
  85990. * @param color Define the vec3 from a Color
  85991. */
  85992. addColor3(name: string, color: Color3): void;
  85993. /**
  85994. * Adds a vec4 to the uniform buffer.
  85995. * @param name Name of the uniform, as used in the uniform block in the shader.
  85996. * @param color Define the rgb components from a Color
  85997. * @param alpha Define the a component of the vec4
  85998. */
  85999. addColor4(name: string, color: Color3, alpha: number): void;
  86000. /**
  86001. * Adds a vec3 to the uniform buffer.
  86002. * @param name Name of the uniform, as used in the uniform block in the shader.
  86003. * @param vector Define the vec3 components from a Vector
  86004. */
  86005. addVector3(name: string, vector: Vector3): void;
  86006. /**
  86007. * Adds a Matrix 3x3 to the uniform buffer.
  86008. * @param name Name of the uniform, as used in the uniform block in the shader.
  86009. */
  86010. addMatrix3x3(name: string): void;
  86011. /**
  86012. * Adds a Matrix 2x2 to the uniform buffer.
  86013. * @param name Name of the uniform, as used in the uniform block in the shader.
  86014. */
  86015. addMatrix2x2(name: string): void;
  86016. /**
  86017. * Effectively creates the WebGL Uniform Buffer, once layout is completed with `addUniform`.
  86018. */
  86019. create(): void;
  86020. /** @hidden */
  86021. _rebuild(): void;
  86022. /**
  86023. * Updates the WebGL Uniform Buffer on the GPU.
  86024. * If the `dynamic` flag is set to true, no cache comparison is done.
  86025. * Otherwise, the buffer will be updated only if the cache differs.
  86026. */
  86027. update(): void;
  86028. /**
  86029. * Updates the value of an uniform. The `update` method must be called afterwards to make it effective in the GPU.
  86030. * @param uniformName Define the name of the uniform, as used in the uniform block in the shader.
  86031. * @param data Define the flattened data
  86032. * @param size Define the size of the data.
  86033. */
  86034. updateUniform(uniformName: string, data: FloatArray, size: number): void;
  86035. private _valueCache;
  86036. private _cacheMatrix;
  86037. private _updateMatrix3x3ForUniform;
  86038. private _updateMatrix3x3ForEffect;
  86039. private _updateMatrix2x2ForEffect;
  86040. private _updateMatrix2x2ForUniform;
  86041. private _updateFloatForEffect;
  86042. private _updateFloatForUniform;
  86043. private _updateFloat2ForEffect;
  86044. private _updateFloat2ForUniform;
  86045. private _updateFloat3ForEffect;
  86046. private _updateFloat3ForUniform;
  86047. private _updateFloat4ForEffect;
  86048. private _updateFloat4ForUniform;
  86049. private _updateMatrixForEffect;
  86050. private _updateMatrixForUniform;
  86051. private _updateVector3ForEffect;
  86052. private _updateVector3ForUniform;
  86053. private _updateVector4ForEffect;
  86054. private _updateVector4ForUniform;
  86055. private _updateColor3ForEffect;
  86056. private _updateColor3ForUniform;
  86057. private _updateColor4ForEffect;
  86058. private _updateColor4ForUniform;
  86059. /**
  86060. * Sets a sampler uniform on the effect.
  86061. * @param name Define the name of the sampler.
  86062. * @param texture Define the texture to set in the sampler
  86063. */
  86064. setTexture(name: string, texture: Nullable<BaseTexture>): void;
  86065. /**
  86066. * Directly updates the value of the uniform in the cache AND on the GPU.
  86067. * @param uniformName Define the name of the uniform, as used in the uniform block in the shader.
  86068. * @param data Define the flattened data
  86069. */
  86070. updateUniformDirectly(uniformName: string, data: FloatArray): void;
  86071. /**
  86072. * Binds this uniform buffer to an effect.
  86073. * @param effect Define the effect to bind the buffer to
  86074. * @param name Name of the uniform block in the shader.
  86075. */
  86076. bindToEffect(effect: Effect, name: string): void;
  86077. /**
  86078. * Disposes the uniform buffer.
  86079. */
  86080. dispose(): void;
  86081. }
  86082. }
  86083. declare module BABYLON {
  86084. /**
  86085. * Enum that determines the text-wrapping mode to use.
  86086. */
  86087. export enum InspectableType {
  86088. /**
  86089. * Checkbox for booleans
  86090. */
  86091. Checkbox = 0,
  86092. /**
  86093. * Sliders for numbers
  86094. */
  86095. Slider = 1,
  86096. /**
  86097. * Vector3
  86098. */
  86099. Vector3 = 2,
  86100. /**
  86101. * Quaternions
  86102. */
  86103. Quaternion = 3,
  86104. /**
  86105. * Color3
  86106. */
  86107. Color3 = 4,
  86108. /**
  86109. * String
  86110. */
  86111. String = 5
  86112. }
  86113. /**
  86114. * Interface used to define custom inspectable properties.
  86115. * This interface is used by the inspector to display custom property grids
  86116. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  86117. */
  86118. export interface IInspectable {
  86119. /**
  86120. * Gets the label to display
  86121. */
  86122. label: string;
  86123. /**
  86124. * Gets the name of the property to edit
  86125. */
  86126. propertyName: string;
  86127. /**
  86128. * Gets the type of the editor to use
  86129. */
  86130. type: InspectableType;
  86131. /**
  86132. * Gets the minimum value of the property when using in "slider" mode
  86133. */
  86134. min?: number;
  86135. /**
  86136. * Gets the maximum value of the property when using in "slider" mode
  86137. */
  86138. max?: number;
  86139. /**
  86140. * Gets the setp to use when using in "slider" mode
  86141. */
  86142. step?: number;
  86143. }
  86144. }
  86145. declare module BABYLON {
  86146. /**
  86147. * Class used to provide helper for timing
  86148. */
  86149. export class TimingTools {
  86150. /**
  86151. * Polyfill for setImmediate
  86152. * @param action defines the action to execute after the current execution block
  86153. */
  86154. static SetImmediate(action: () => void): void;
  86155. }
  86156. }
  86157. declare module BABYLON {
  86158. /**
  86159. * Class used to enable instatition of objects by class name
  86160. */
  86161. export class InstantiationTools {
  86162. /**
  86163. * Use this object to register external classes like custom textures or material
  86164. * to allow the laoders to instantiate them
  86165. */
  86166. static RegisteredExternalClasses: {
  86167. [key: string]: Object;
  86168. };
  86169. /**
  86170. * Tries to instantiate a new object from a given class name
  86171. * @param className defines the class name to instantiate
  86172. * @returns the new object or null if the system was not able to do the instantiation
  86173. */
  86174. static Instantiate(className: string): any;
  86175. }
  86176. }
  86177. declare module BABYLON {
  86178. /**
  86179. * Define options used to create a depth texture
  86180. */
  86181. export class DepthTextureCreationOptions {
  86182. /** Specifies whether or not a stencil should be allocated in the texture */
  86183. generateStencil?: boolean;
  86184. /** Specifies whether or not bilinear filtering is enable on the texture */
  86185. bilinearFiltering?: boolean;
  86186. /** Specifies the comparison function to set on the texture. If 0 or undefined, the texture is not in comparison mode */
  86187. comparisonFunction?: number;
  86188. /** Specifies if the created texture is a cube texture */
  86189. isCube?: boolean;
  86190. }
  86191. }
  86192. declare module BABYLON {
  86193. interface ThinEngine {
  86194. /**
  86195. * Creates a depth stencil cube texture.
  86196. * This is only available in WebGL 2.
  86197. * @param size The size of face edge in the cube texture.
  86198. * @param options The options defining the cube texture.
  86199. * @returns The cube texture
  86200. */
  86201. _createDepthStencilCubeTexture(size: number, options: DepthTextureCreationOptions): InternalTexture;
  86202. /**
  86203. * Creates a cube texture
  86204. * @param rootUrl defines the url where the files to load is located
  86205. * @param scene defines the current scene
  86206. * @param files defines the list of files to load (1 per face)
  86207. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  86208. * @param onLoad defines an optional callback raised when the texture is loaded
  86209. * @param onError defines an optional callback raised if there is an issue to load the texture
  86210. * @param format defines the format of the data
  86211. * @param forcedExtension defines the extension to use to pick the right loader
  86212. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  86213. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  86214. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  86215. * @param fallback defines texture to use while falling back when (compressed) texture file not found.
  86216. * @returns the cube texture as an InternalTexture
  86217. */
  86218. 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;
  86219. /**
  86220. * Creates a cube texture
  86221. * @param rootUrl defines the url where the files to load is located
  86222. * @param scene defines the current scene
  86223. * @param files defines the list of files to load (1 per face)
  86224. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  86225. * @param onLoad defines an optional callback raised when the texture is loaded
  86226. * @param onError defines an optional callback raised if there is an issue to load the texture
  86227. * @param format defines the format of the data
  86228. * @param forcedExtension defines the extension to use to pick the right loader
  86229. * @returns the cube texture as an InternalTexture
  86230. */
  86231. 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;
  86232. /**
  86233. * Creates a cube texture
  86234. * @param rootUrl defines the url where the files to load is located
  86235. * @param scene defines the current scene
  86236. * @param files defines the list of files to load (1 per face)
  86237. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  86238. * @param onLoad defines an optional callback raised when the texture is loaded
  86239. * @param onError defines an optional callback raised if there is an issue to load the texture
  86240. * @param format defines the format of the data
  86241. * @param forcedExtension defines the extension to use to pick the right loader
  86242. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  86243. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  86244. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  86245. * @returns the cube texture as an InternalTexture
  86246. */
  86247. 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;
  86248. /** @hidden */
  86249. _partialLoadFile(url: string, index: number, loadedFiles: ArrayBuffer[], onfinish: (files: ArrayBuffer[]) => void, onErrorCallBack: Nullable<(message?: string, exception?: any) => void>): void;
  86250. /** @hidden */
  86251. _cascadeLoadFiles(scene: Nullable<Scene>, onfinish: (images: ArrayBuffer[]) => void, files: string[], onError: Nullable<(message?: string, exception?: any) => void>): void;
  86252. /** @hidden */
  86253. _cascadeLoadImgs(scene: Nullable<Scene>, onfinish: (images: HTMLImageElement[]) => void, files: string[], onError: Nullable<(message?: string, exception?: any) => void>, mimeType?: string): void;
  86254. /** @hidden */
  86255. _partialLoadImg(url: string, index: number, loadedImages: HTMLImageElement[], scene: Nullable<Scene>, onfinish: (images: HTMLImageElement[]) => void, onErrorCallBack: Nullable<(message?: string, exception?: any) => void>, mimeType?: string): void;
  86256. /**
  86257. * @hidden
  86258. */
  86259. _setCubeMapTextureParams(loadMipmap: boolean): void;
  86260. }
  86261. }
  86262. declare module BABYLON {
  86263. /**
  86264. * Class for creating a cube texture
  86265. */
  86266. export class CubeTexture extends BaseTexture {
  86267. private _delayedOnLoad;
  86268. /**
  86269. * Observable triggered once the texture has been loaded.
  86270. */
  86271. onLoadObservable: Observable<CubeTexture>;
  86272. /**
  86273. * The url of the texture
  86274. */
  86275. url: string;
  86276. /**
  86277. * Gets or sets the center of the bounding box associated with the cube texture.
  86278. * It must define where the camera used to render the texture was set
  86279. * @see https://doc.babylonjs.com/how_to/reflect#using-local-cubemap-mode
  86280. */
  86281. boundingBoxPosition: Vector3;
  86282. private _boundingBoxSize;
  86283. /**
  86284. * Gets or sets the size of the bounding box associated with the cube texture
  86285. * When defined, the cubemap will switch to local mode
  86286. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  86287. * @example https://www.babylonjs-playground.com/#RNASML
  86288. */
  86289. set boundingBoxSize(value: Vector3);
  86290. /**
  86291. * Returns the bounding box size
  86292. * @see https://doc.babylonjs.com/how_to/reflect#using-local-cubemap-mode
  86293. */
  86294. get boundingBoxSize(): Vector3;
  86295. protected _rotationY: number;
  86296. /**
  86297. * Sets texture matrix rotation angle around Y axis in radians.
  86298. */
  86299. set rotationY(value: number);
  86300. /**
  86301. * Gets texture matrix rotation angle around Y axis radians.
  86302. */
  86303. get rotationY(): number;
  86304. /**
  86305. * Are mip maps generated for this texture or not.
  86306. */
  86307. get noMipmap(): boolean;
  86308. private _noMipmap;
  86309. private _files;
  86310. protected _forcedExtension: Nullable<string>;
  86311. private _extensions;
  86312. private _textureMatrix;
  86313. private _format;
  86314. private _createPolynomials;
  86315. /**
  86316. * Creates a cube texture from an array of image urls
  86317. * @param files defines an array of image urls
  86318. * @param scene defines the hosting scene
  86319. * @param noMipmap specifies if mip maps are not used
  86320. * @returns a cube texture
  86321. */
  86322. static CreateFromImages(files: string[], scene: Scene, noMipmap?: boolean): CubeTexture;
  86323. /**
  86324. * Creates and return a texture created from prefilterd data by tools like IBL Baker or Lys.
  86325. * @param url defines the url of the prefiltered texture
  86326. * @param scene defines the scene the texture is attached to
  86327. * @param forcedExtension defines the extension of the file if different from the url
  86328. * @param createPolynomials defines whether or not to create polynomial harmonics from the texture data if necessary
  86329. * @return the prefiltered texture
  86330. */
  86331. static CreateFromPrefilteredData(url: string, scene: Scene, forcedExtension?: any, createPolynomials?: boolean): CubeTexture;
  86332. /**
  86333. * Creates a cube texture to use with reflection for instance. It can be based upon dds or six images as well
  86334. * as prefiltered data.
  86335. * @param rootUrl defines the url of the texture or the root name of the six images
  86336. * @param null defines the scene or engine the texture is attached to
  86337. * @param extensions defines the suffixes add to the picture name in case six images are in use like _px.jpg...
  86338. * @param noMipmap defines if mipmaps should be created or not
  86339. * @param files defines the six files to load for the different faces in that order: px, py, pz, nx, ny, nz
  86340. * @param onLoad defines a callback triggered at the end of the file load if no errors occured
  86341. * @param onError defines a callback triggered in case of error during load
  86342. * @param format defines the internal format to use for the texture once loaded
  86343. * @param prefiltered defines whether or not the texture is created from prefiltered data
  86344. * @param forcedExtension defines the extensions to use (force a special type of file to load) in case it is different from the file name
  86345. * @param createPolynomials defines whether or not to create polynomial harmonics from the texture data if necessary
  86346. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  86347. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  86348. * @return the cube texture
  86349. */
  86350. 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);
  86351. /**
  86352. * Get the current class name of the texture useful for serialization or dynamic coding.
  86353. * @returns "CubeTexture"
  86354. */
  86355. getClassName(): string;
  86356. /**
  86357. * Update the url (and optional buffer) of this texture if url was null during construction.
  86358. * @param url the url of the texture
  86359. * @param forcedExtension defines the extension to use
  86360. * @param onLoad callback called when the texture is loaded (defaults to null)
  86361. * @param prefiltered Defines whether the updated texture is prefiltered or not
  86362. */
  86363. updateURL(url: string, forcedExtension?: string, onLoad?: () => void, prefiltered?: boolean): void;
  86364. /**
  86365. * Delays loading of the cube texture
  86366. * @param forcedExtension defines the extension to use
  86367. */
  86368. delayLoad(forcedExtension?: string): void;
  86369. /**
  86370. * Returns the reflection texture matrix
  86371. * @returns the reflection texture matrix
  86372. */
  86373. getReflectionTextureMatrix(): Matrix;
  86374. /**
  86375. * Sets the reflection texture matrix
  86376. * @param value Reflection texture matrix
  86377. */
  86378. setReflectionTextureMatrix(value: Matrix): void;
  86379. /**
  86380. * Parses text to create a cube texture
  86381. * @param parsedTexture define the serialized text to read from
  86382. * @param scene defines the hosting scene
  86383. * @param rootUrl defines the root url of the cube texture
  86384. * @returns a cube texture
  86385. */
  86386. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): CubeTexture;
  86387. /**
  86388. * Makes a clone, or deep copy, of the cube texture
  86389. * @returns a new cube texture
  86390. */
  86391. clone(): CubeTexture;
  86392. }
  86393. }
  86394. declare module BABYLON {
  86395. /**
  86396. * Manages the defines for the Material
  86397. */
  86398. export class MaterialDefines {
  86399. /** @hidden */
  86400. protected _keys: string[];
  86401. private _isDirty;
  86402. /** @hidden */
  86403. _renderId: number;
  86404. /** @hidden */
  86405. _areLightsDirty: boolean;
  86406. /** @hidden */
  86407. _areLightsDisposed: boolean;
  86408. /** @hidden */
  86409. _areAttributesDirty: boolean;
  86410. /** @hidden */
  86411. _areTexturesDirty: boolean;
  86412. /** @hidden */
  86413. _areFresnelDirty: boolean;
  86414. /** @hidden */
  86415. _areMiscDirty: boolean;
  86416. /** @hidden */
  86417. _areImageProcessingDirty: boolean;
  86418. /** @hidden */
  86419. _normals: boolean;
  86420. /** @hidden */
  86421. _uvs: boolean;
  86422. /** @hidden */
  86423. _needNormals: boolean;
  86424. /** @hidden */
  86425. _needUVs: boolean;
  86426. [id: string]: any;
  86427. /**
  86428. * Specifies if the material needs to be re-calculated
  86429. */
  86430. get isDirty(): boolean;
  86431. /**
  86432. * Marks the material to indicate that it has been re-calculated
  86433. */
  86434. markAsProcessed(): void;
  86435. /**
  86436. * Marks the material to indicate that it needs to be re-calculated
  86437. */
  86438. markAsUnprocessed(): void;
  86439. /**
  86440. * Marks the material to indicate all of its defines need to be re-calculated
  86441. */
  86442. markAllAsDirty(): void;
  86443. /**
  86444. * Marks the material to indicate that image processing needs to be re-calculated
  86445. */
  86446. markAsImageProcessingDirty(): void;
  86447. /**
  86448. * Marks the material to indicate the lights need to be re-calculated
  86449. * @param disposed Defines whether the light is dirty due to dispose or not
  86450. */
  86451. markAsLightDirty(disposed?: boolean): void;
  86452. /**
  86453. * Marks the attribute state as changed
  86454. */
  86455. markAsAttributesDirty(): void;
  86456. /**
  86457. * Marks the texture state as changed
  86458. */
  86459. markAsTexturesDirty(): void;
  86460. /**
  86461. * Marks the fresnel state as changed
  86462. */
  86463. markAsFresnelDirty(): void;
  86464. /**
  86465. * Marks the misc state as changed
  86466. */
  86467. markAsMiscDirty(): void;
  86468. /**
  86469. * Rebuilds the material defines
  86470. */
  86471. rebuild(): void;
  86472. /**
  86473. * Specifies if two material defines are equal
  86474. * @param other - A material define instance to compare to
  86475. * @returns - Boolean indicating if the material defines are equal (true) or not (false)
  86476. */
  86477. isEqual(other: MaterialDefines): boolean;
  86478. /**
  86479. * Clones this instance's defines to another instance
  86480. * @param other - material defines to clone values to
  86481. */
  86482. cloneTo(other: MaterialDefines): void;
  86483. /**
  86484. * Resets the material define values
  86485. */
  86486. reset(): void;
  86487. /**
  86488. * Converts the material define values to a string
  86489. * @returns - String of material define information
  86490. */
  86491. toString(): string;
  86492. }
  86493. }
  86494. declare module BABYLON {
  86495. /**
  86496. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  86497. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  86498. * 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;
  86499. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  86500. */
  86501. export class ColorCurves {
  86502. private _dirty;
  86503. private _tempColor;
  86504. private _globalCurve;
  86505. private _highlightsCurve;
  86506. private _midtonesCurve;
  86507. private _shadowsCurve;
  86508. private _positiveCurve;
  86509. private _negativeCurve;
  86510. private _globalHue;
  86511. private _globalDensity;
  86512. private _globalSaturation;
  86513. private _globalExposure;
  86514. /**
  86515. * Gets the global Hue value.
  86516. * 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).
  86517. */
  86518. get globalHue(): number;
  86519. /**
  86520. * Sets the global Hue value.
  86521. * 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).
  86522. */
  86523. set globalHue(value: number);
  86524. /**
  86525. * Gets the global Density value.
  86526. * 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.
  86527. * Values less than zero provide a filter of opposite hue.
  86528. */
  86529. get globalDensity(): number;
  86530. /**
  86531. * Sets the global Density value.
  86532. * 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.
  86533. * Values less than zero provide a filter of opposite hue.
  86534. */
  86535. set globalDensity(value: number);
  86536. /**
  86537. * Gets the global Saturation value.
  86538. * 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.
  86539. */
  86540. get globalSaturation(): number;
  86541. /**
  86542. * Sets the global Saturation value.
  86543. * 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.
  86544. */
  86545. set globalSaturation(value: number);
  86546. /**
  86547. * Gets the global Exposure value.
  86548. * 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.
  86549. */
  86550. get globalExposure(): number;
  86551. /**
  86552. * Sets the global Exposure value.
  86553. * 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.
  86554. */
  86555. set globalExposure(value: number);
  86556. private _highlightsHue;
  86557. private _highlightsDensity;
  86558. private _highlightsSaturation;
  86559. private _highlightsExposure;
  86560. /**
  86561. * Gets the highlights Hue value.
  86562. * 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).
  86563. */
  86564. get highlightsHue(): number;
  86565. /**
  86566. * Sets the highlights Hue value.
  86567. * 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).
  86568. */
  86569. set highlightsHue(value: number);
  86570. /**
  86571. * Gets the highlights Density value.
  86572. * 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.
  86573. * Values less than zero provide a filter of opposite hue.
  86574. */
  86575. get highlightsDensity(): number;
  86576. /**
  86577. * Sets the highlights Density value.
  86578. * 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.
  86579. * Values less than zero provide a filter of opposite hue.
  86580. */
  86581. set highlightsDensity(value: number);
  86582. /**
  86583. * Gets the highlights Saturation value.
  86584. * 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.
  86585. */
  86586. get highlightsSaturation(): number;
  86587. /**
  86588. * Sets the highlights Saturation value.
  86589. * 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.
  86590. */
  86591. set highlightsSaturation(value: number);
  86592. /**
  86593. * Gets the highlights Exposure value.
  86594. * 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.
  86595. */
  86596. get highlightsExposure(): number;
  86597. /**
  86598. * Sets the highlights Exposure value.
  86599. * 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.
  86600. */
  86601. set highlightsExposure(value: number);
  86602. private _midtonesHue;
  86603. private _midtonesDensity;
  86604. private _midtonesSaturation;
  86605. private _midtonesExposure;
  86606. /**
  86607. * Gets the midtones Hue value.
  86608. * 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).
  86609. */
  86610. get midtonesHue(): number;
  86611. /**
  86612. * Sets the midtones Hue value.
  86613. * 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).
  86614. */
  86615. set midtonesHue(value: number);
  86616. /**
  86617. * Gets the midtones Density value.
  86618. * 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.
  86619. * Values less than zero provide a filter of opposite hue.
  86620. */
  86621. get midtonesDensity(): number;
  86622. /**
  86623. * Sets the midtones Density value.
  86624. * 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.
  86625. * Values less than zero provide a filter of opposite hue.
  86626. */
  86627. set midtonesDensity(value: number);
  86628. /**
  86629. * Gets the midtones Saturation value.
  86630. * 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.
  86631. */
  86632. get midtonesSaturation(): number;
  86633. /**
  86634. * Sets the midtones Saturation value.
  86635. * 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.
  86636. */
  86637. set midtonesSaturation(value: number);
  86638. /**
  86639. * Gets the midtones Exposure value.
  86640. * 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.
  86641. */
  86642. get midtonesExposure(): number;
  86643. /**
  86644. * Sets the midtones Exposure value.
  86645. * 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.
  86646. */
  86647. set midtonesExposure(value: number);
  86648. private _shadowsHue;
  86649. private _shadowsDensity;
  86650. private _shadowsSaturation;
  86651. private _shadowsExposure;
  86652. /**
  86653. * Gets the shadows Hue value.
  86654. * 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).
  86655. */
  86656. get shadowsHue(): number;
  86657. /**
  86658. * Sets the shadows Hue value.
  86659. * 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).
  86660. */
  86661. set shadowsHue(value: number);
  86662. /**
  86663. * Gets the shadows Density value.
  86664. * 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.
  86665. * Values less than zero provide a filter of opposite hue.
  86666. */
  86667. get shadowsDensity(): number;
  86668. /**
  86669. * Sets the shadows Density value.
  86670. * 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.
  86671. * Values less than zero provide a filter of opposite hue.
  86672. */
  86673. set shadowsDensity(value: number);
  86674. /**
  86675. * Gets the shadows Saturation value.
  86676. * 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.
  86677. */
  86678. get shadowsSaturation(): number;
  86679. /**
  86680. * Sets the shadows Saturation value.
  86681. * 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.
  86682. */
  86683. set shadowsSaturation(value: number);
  86684. /**
  86685. * Gets the shadows Exposure value.
  86686. * 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.
  86687. */
  86688. get shadowsExposure(): number;
  86689. /**
  86690. * Sets the shadows Exposure value.
  86691. * 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.
  86692. */
  86693. set shadowsExposure(value: number);
  86694. /**
  86695. * Returns the class name
  86696. * @returns The class name
  86697. */
  86698. getClassName(): string;
  86699. /**
  86700. * Binds the color curves to the shader.
  86701. * @param colorCurves The color curve to bind
  86702. * @param effect The effect to bind to
  86703. * @param positiveUniform The positive uniform shader parameter
  86704. * @param neutralUniform The neutral uniform shader parameter
  86705. * @param negativeUniform The negative uniform shader parameter
  86706. */
  86707. static Bind(colorCurves: ColorCurves, effect: Effect, positiveUniform?: string, neutralUniform?: string, negativeUniform?: string): void;
  86708. /**
  86709. * Prepare the list of uniforms associated with the ColorCurves effects.
  86710. * @param uniformsList The list of uniforms used in the effect
  86711. */
  86712. static PrepareUniforms(uniformsList: string[]): void;
  86713. /**
  86714. * Returns color grading data based on a hue, density, saturation and exposure value.
  86715. * @param filterHue The hue of the color filter.
  86716. * @param filterDensity The density of the color filter.
  86717. * @param saturation The saturation.
  86718. * @param exposure The exposure.
  86719. * @param result The result data container.
  86720. */
  86721. private getColorGradingDataToRef;
  86722. /**
  86723. * Takes an input slider value and returns an adjusted value that provides extra control near the centre.
  86724. * @param value The input slider value in range [-100,100].
  86725. * @returns Adjusted value.
  86726. */
  86727. private static applyColorGradingSliderNonlinear;
  86728. /**
  86729. * Returns an RGBA Color4 based on Hue, Saturation and Brightness (also referred to as value, HSV).
  86730. * @param hue The hue (H) input.
  86731. * @param saturation The saturation (S) input.
  86732. * @param brightness The brightness (B) input.
  86733. * @result An RGBA color represented as Vector4.
  86734. */
  86735. private static fromHSBToRef;
  86736. /**
  86737. * Returns a value clamped between min and max
  86738. * @param value The value to clamp
  86739. * @param min The minimum of value
  86740. * @param max The maximum of value
  86741. * @returns The clamped value.
  86742. */
  86743. private static clamp;
  86744. /**
  86745. * Clones the current color curve instance.
  86746. * @return The cloned curves
  86747. */
  86748. clone(): ColorCurves;
  86749. /**
  86750. * Serializes the current color curve instance to a json representation.
  86751. * @return a JSON representation
  86752. */
  86753. serialize(): any;
  86754. /**
  86755. * Parses the color curve from a json representation.
  86756. * @param source the JSON source to parse
  86757. * @return The parsed curves
  86758. */
  86759. static Parse(source: any): ColorCurves;
  86760. }
  86761. }
  86762. declare module BABYLON {
  86763. /**
  86764. * Interface to follow in your material defines to integrate easily the
  86765. * Image proccessing functions.
  86766. * @hidden
  86767. */
  86768. export interface IImageProcessingConfigurationDefines {
  86769. IMAGEPROCESSING: boolean;
  86770. VIGNETTE: boolean;
  86771. VIGNETTEBLENDMODEMULTIPLY: boolean;
  86772. VIGNETTEBLENDMODEOPAQUE: boolean;
  86773. TONEMAPPING: boolean;
  86774. TONEMAPPING_ACES: boolean;
  86775. CONTRAST: boolean;
  86776. EXPOSURE: boolean;
  86777. COLORCURVES: boolean;
  86778. COLORGRADING: boolean;
  86779. COLORGRADING3D: boolean;
  86780. SAMPLER3DGREENDEPTH: boolean;
  86781. SAMPLER3DBGRMAP: boolean;
  86782. IMAGEPROCESSINGPOSTPROCESS: boolean;
  86783. }
  86784. /**
  86785. * @hidden
  86786. */
  86787. export class ImageProcessingConfigurationDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  86788. IMAGEPROCESSING: boolean;
  86789. VIGNETTE: boolean;
  86790. VIGNETTEBLENDMODEMULTIPLY: boolean;
  86791. VIGNETTEBLENDMODEOPAQUE: boolean;
  86792. TONEMAPPING: boolean;
  86793. TONEMAPPING_ACES: boolean;
  86794. CONTRAST: boolean;
  86795. COLORCURVES: boolean;
  86796. COLORGRADING: boolean;
  86797. COLORGRADING3D: boolean;
  86798. SAMPLER3DGREENDEPTH: boolean;
  86799. SAMPLER3DBGRMAP: boolean;
  86800. IMAGEPROCESSINGPOSTPROCESS: boolean;
  86801. EXPOSURE: boolean;
  86802. constructor();
  86803. }
  86804. /**
  86805. * This groups together the common properties used for image processing either in direct forward pass
  86806. * or through post processing effect depending on the use of the image processing pipeline in your scene
  86807. * or not.
  86808. */
  86809. export class ImageProcessingConfiguration {
  86810. /**
  86811. * Default tone mapping applied in BabylonJS.
  86812. */
  86813. static readonly TONEMAPPING_STANDARD: number;
  86814. /**
  86815. * ACES Tone mapping (used by default in unreal and unity). This can help getting closer
  86816. * to other engines rendering to increase portability.
  86817. */
  86818. static readonly TONEMAPPING_ACES: number;
  86819. /**
  86820. * Color curves setup used in the effect if colorCurvesEnabled is set to true
  86821. */
  86822. colorCurves: Nullable<ColorCurves>;
  86823. private _colorCurvesEnabled;
  86824. /**
  86825. * Gets wether the color curves effect is enabled.
  86826. */
  86827. get colorCurvesEnabled(): boolean;
  86828. /**
  86829. * Sets wether the color curves effect is enabled.
  86830. */
  86831. set colorCurvesEnabled(value: boolean);
  86832. private _colorGradingTexture;
  86833. /**
  86834. * Color grading LUT texture used in the effect if colorGradingEnabled is set to true
  86835. */
  86836. get colorGradingTexture(): Nullable<BaseTexture>;
  86837. /**
  86838. * Color grading LUT texture used in the effect if colorGradingEnabled is set to true
  86839. */
  86840. set colorGradingTexture(value: Nullable<BaseTexture>);
  86841. private _colorGradingEnabled;
  86842. /**
  86843. * Gets wether the color grading effect is enabled.
  86844. */
  86845. get colorGradingEnabled(): boolean;
  86846. /**
  86847. * Sets wether the color grading effect is enabled.
  86848. */
  86849. set colorGradingEnabled(value: boolean);
  86850. private _colorGradingWithGreenDepth;
  86851. /**
  86852. * Gets wether the color grading effect is using a green depth for the 3d Texture.
  86853. */
  86854. get colorGradingWithGreenDepth(): boolean;
  86855. /**
  86856. * Sets wether the color grading effect is using a green depth for the 3d Texture.
  86857. */
  86858. set colorGradingWithGreenDepth(value: boolean);
  86859. private _colorGradingBGR;
  86860. /**
  86861. * Gets wether the color grading texture contains BGR values.
  86862. */
  86863. get colorGradingBGR(): boolean;
  86864. /**
  86865. * Sets wether the color grading texture contains BGR values.
  86866. */
  86867. set colorGradingBGR(value: boolean);
  86868. /** @hidden */
  86869. _exposure: number;
  86870. /**
  86871. * Gets the Exposure used in the effect.
  86872. */
  86873. get exposure(): number;
  86874. /**
  86875. * Sets the Exposure used in the effect.
  86876. */
  86877. set exposure(value: number);
  86878. private _toneMappingEnabled;
  86879. /**
  86880. * Gets wether the tone mapping effect is enabled.
  86881. */
  86882. get toneMappingEnabled(): boolean;
  86883. /**
  86884. * Sets wether the tone mapping effect is enabled.
  86885. */
  86886. set toneMappingEnabled(value: boolean);
  86887. private _toneMappingType;
  86888. /**
  86889. * Gets the type of tone mapping effect.
  86890. */
  86891. get toneMappingType(): number;
  86892. /**
  86893. * Sets the type of tone mapping effect used in BabylonJS.
  86894. */
  86895. set toneMappingType(value: number);
  86896. protected _contrast: number;
  86897. /**
  86898. * Gets the contrast used in the effect.
  86899. */
  86900. get contrast(): number;
  86901. /**
  86902. * Sets the contrast used in the effect.
  86903. */
  86904. set contrast(value: number);
  86905. /**
  86906. * Vignette stretch size.
  86907. */
  86908. vignetteStretch: number;
  86909. /**
  86910. * Vignette centre X Offset.
  86911. */
  86912. vignetteCentreX: number;
  86913. /**
  86914. * Vignette centre Y Offset.
  86915. */
  86916. vignetteCentreY: number;
  86917. /**
  86918. * Vignette weight or intensity of the vignette effect.
  86919. */
  86920. vignetteWeight: number;
  86921. /**
  86922. * Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  86923. * if vignetteEnabled is set to true.
  86924. */
  86925. vignetteColor: Color4;
  86926. /**
  86927. * Camera field of view used by the Vignette effect.
  86928. */
  86929. vignetteCameraFov: number;
  86930. private _vignetteBlendMode;
  86931. /**
  86932. * Gets the vignette blend mode allowing different kind of effect.
  86933. */
  86934. get vignetteBlendMode(): number;
  86935. /**
  86936. * Sets the vignette blend mode allowing different kind of effect.
  86937. */
  86938. set vignetteBlendMode(value: number);
  86939. private _vignetteEnabled;
  86940. /**
  86941. * Gets wether the vignette effect is enabled.
  86942. */
  86943. get vignetteEnabled(): boolean;
  86944. /**
  86945. * Sets wether the vignette effect is enabled.
  86946. */
  86947. set vignetteEnabled(value: boolean);
  86948. private _applyByPostProcess;
  86949. /**
  86950. * Gets wether the image processing is applied through a post process or not.
  86951. */
  86952. get applyByPostProcess(): boolean;
  86953. /**
  86954. * Sets wether the image processing is applied through a post process or not.
  86955. */
  86956. set applyByPostProcess(value: boolean);
  86957. private _isEnabled;
  86958. /**
  86959. * Gets wether the image processing is enabled or not.
  86960. */
  86961. get isEnabled(): boolean;
  86962. /**
  86963. * Sets wether the image processing is enabled or not.
  86964. */
  86965. set isEnabled(value: boolean);
  86966. /**
  86967. * An event triggered when the configuration changes and requires Shader to Update some parameters.
  86968. */
  86969. onUpdateParameters: Observable<ImageProcessingConfiguration>;
  86970. /**
  86971. * Method called each time the image processing information changes requires to recompile the effect.
  86972. */
  86973. protected _updateParameters(): void;
  86974. /**
  86975. * Gets the current class name.
  86976. * @return "ImageProcessingConfiguration"
  86977. */
  86978. getClassName(): string;
  86979. /**
  86980. * Prepare the list of uniforms associated with the Image Processing effects.
  86981. * @param uniforms The list of uniforms used in the effect
  86982. * @param defines the list of defines currently in use
  86983. */
  86984. static PrepareUniforms(uniforms: string[], defines: IImageProcessingConfigurationDefines): void;
  86985. /**
  86986. * Prepare the list of samplers associated with the Image Processing effects.
  86987. * @param samplersList The list of uniforms used in the effect
  86988. * @param defines the list of defines currently in use
  86989. */
  86990. static PrepareSamplers(samplersList: string[], defines: IImageProcessingConfigurationDefines): void;
  86991. /**
  86992. * Prepare the list of defines associated to the shader.
  86993. * @param defines the list of defines to complete
  86994. * @param forPostProcess Define if we are currently in post process mode or not
  86995. */
  86996. prepareDefines(defines: IImageProcessingConfigurationDefines, forPostProcess?: boolean): void;
  86997. /**
  86998. * Returns true if all the image processing information are ready.
  86999. * @returns True if ready, otherwise, false
  87000. */
  87001. isReady(): boolean;
  87002. /**
  87003. * Binds the image processing to the shader.
  87004. * @param effect The effect to bind to
  87005. * @param overrideAspectRatio Override the aspect ratio of the effect
  87006. */
  87007. bind(effect: Effect, overrideAspectRatio?: number): void;
  87008. /**
  87009. * Clones the current image processing instance.
  87010. * @return The cloned image processing
  87011. */
  87012. clone(): ImageProcessingConfiguration;
  87013. /**
  87014. * Serializes the current image processing instance to a json representation.
  87015. * @return a JSON representation
  87016. */
  87017. serialize(): any;
  87018. /**
  87019. * Parses the image processing from a json representation.
  87020. * @param source the JSON source to parse
  87021. * @return The parsed image processing
  87022. */
  87023. static Parse(source: any): ImageProcessingConfiguration;
  87024. private static _VIGNETTEMODE_MULTIPLY;
  87025. private static _VIGNETTEMODE_OPAQUE;
  87026. /**
  87027. * Used to apply the vignette as a mix with the pixel color.
  87028. */
  87029. static get VIGNETTEMODE_MULTIPLY(): number;
  87030. /**
  87031. * Used to apply the vignette as a replacement of the pixel color.
  87032. */
  87033. static get VIGNETTEMODE_OPAQUE(): number;
  87034. }
  87035. }
  87036. declare module BABYLON {
  87037. /** @hidden */
  87038. export var postprocessVertexShader: {
  87039. name: string;
  87040. shader: string;
  87041. };
  87042. }
  87043. declare module BABYLON {
  87044. interface ThinEngine {
  87045. /**
  87046. * Creates a new render target texture
  87047. * @param size defines the size of the texture
  87048. * @param options defines the options used to create the texture
  87049. * @returns a new render target texture stored in an InternalTexture
  87050. */
  87051. createRenderTargetTexture(size: number | {
  87052. width: number;
  87053. height: number;
  87054. layers?: number;
  87055. }, options: boolean | RenderTargetCreationOptions): InternalTexture;
  87056. /**
  87057. * Creates a depth stencil texture.
  87058. * This is only available in WebGL 2 or with the depth texture extension available.
  87059. * @param size The size of face edge in the texture.
  87060. * @param options The options defining the texture.
  87061. * @returns The texture
  87062. */
  87063. createDepthStencilTexture(size: number | {
  87064. width: number;
  87065. height: number;
  87066. layers?: number;
  87067. }, options: DepthTextureCreationOptions): InternalTexture;
  87068. /** @hidden */
  87069. _createDepthStencilTexture(size: number | {
  87070. width: number;
  87071. height: number;
  87072. layers?: number;
  87073. }, options: DepthTextureCreationOptions): InternalTexture;
  87074. }
  87075. }
  87076. declare module BABYLON {
  87077. /**
  87078. * Defines the kind of connection point for node based material
  87079. */
  87080. export enum NodeMaterialBlockConnectionPointTypes {
  87081. /** Float */
  87082. Float = 1,
  87083. /** Int */
  87084. Int = 2,
  87085. /** Vector2 */
  87086. Vector2 = 4,
  87087. /** Vector3 */
  87088. Vector3 = 8,
  87089. /** Vector4 */
  87090. Vector4 = 16,
  87091. /** Color3 */
  87092. Color3 = 32,
  87093. /** Color4 */
  87094. Color4 = 64,
  87095. /** Matrix */
  87096. Matrix = 128,
  87097. /** Custom object */
  87098. Object = 256,
  87099. /** Detect type based on connection */
  87100. AutoDetect = 1024,
  87101. /** Output type that will be defined by input type */
  87102. BasedOnInput = 2048
  87103. }
  87104. }
  87105. declare module BABYLON {
  87106. /**
  87107. * Enum used to define the target of a block
  87108. */
  87109. export enum NodeMaterialBlockTargets {
  87110. /** Vertex shader */
  87111. Vertex = 1,
  87112. /** Fragment shader */
  87113. Fragment = 2,
  87114. /** Neutral */
  87115. Neutral = 4,
  87116. /** Vertex and Fragment */
  87117. VertexAndFragment = 3
  87118. }
  87119. }
  87120. declare module BABYLON {
  87121. /**
  87122. * Enum defining the mode of a NodeMaterialBlockConnectionPoint
  87123. */
  87124. export enum NodeMaterialBlockConnectionPointMode {
  87125. /** Value is an uniform */
  87126. Uniform = 0,
  87127. /** Value is a mesh attribute */
  87128. Attribute = 1,
  87129. /** Value is a varying between vertex and fragment shaders */
  87130. Varying = 2,
  87131. /** Mode is undefined */
  87132. Undefined = 3
  87133. }
  87134. }
  87135. declare module BABYLON {
  87136. /**
  87137. * Enum used to define system values e.g. values automatically provided by the system
  87138. */
  87139. export enum NodeMaterialSystemValues {
  87140. /** World */
  87141. World = 1,
  87142. /** View */
  87143. View = 2,
  87144. /** Projection */
  87145. Projection = 3,
  87146. /** ViewProjection */
  87147. ViewProjection = 4,
  87148. /** WorldView */
  87149. WorldView = 5,
  87150. /** WorldViewProjection */
  87151. WorldViewProjection = 6,
  87152. /** CameraPosition */
  87153. CameraPosition = 7,
  87154. /** Fog Color */
  87155. FogColor = 8,
  87156. /** Delta time */
  87157. DeltaTime = 9
  87158. }
  87159. }
  87160. declare module BABYLON {
  87161. /** Defines supported spaces */
  87162. export enum Space {
  87163. /** Local (object) space */
  87164. LOCAL = 0,
  87165. /** World space */
  87166. WORLD = 1,
  87167. /** Bone space */
  87168. BONE = 2
  87169. }
  87170. /** Defines the 3 main axes */
  87171. export class Axis {
  87172. /** X axis */
  87173. static X: Vector3;
  87174. /** Y axis */
  87175. static Y: Vector3;
  87176. /** Z axis */
  87177. static Z: Vector3;
  87178. }
  87179. }
  87180. declare module BABYLON {
  87181. /**
  87182. * Represents a camera frustum
  87183. */
  87184. export class Frustum {
  87185. /**
  87186. * Gets the planes representing the frustum
  87187. * @param transform matrix to be applied to the returned planes
  87188. * @returns a new array of 6 Frustum planes computed by the given transformation matrix.
  87189. */
  87190. static GetPlanes(transform: DeepImmutable<Matrix>): Plane[];
  87191. /**
  87192. * Gets the near frustum plane transformed by the transform matrix
  87193. * @param transform transformation matrix to be applied to the resulting frustum plane
  87194. * @param frustumPlane the resuling frustum plane
  87195. */
  87196. static GetNearPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  87197. /**
  87198. * Gets the far frustum plane transformed by the transform matrix
  87199. * @param transform transformation matrix to be applied to the resulting frustum plane
  87200. * @param frustumPlane the resuling frustum plane
  87201. */
  87202. static GetFarPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  87203. /**
  87204. * Gets the left frustum plane transformed by the transform matrix
  87205. * @param transform transformation matrix to be applied to the resulting frustum plane
  87206. * @param frustumPlane the resuling frustum plane
  87207. */
  87208. static GetLeftPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  87209. /**
  87210. * Gets the right frustum plane transformed by the transform matrix
  87211. * @param transform transformation matrix to be applied to the resulting frustum plane
  87212. * @param frustumPlane the resuling frustum plane
  87213. */
  87214. static GetRightPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  87215. /**
  87216. * Gets the top frustum plane transformed by the transform matrix
  87217. * @param transform transformation matrix to be applied to the resulting frustum plane
  87218. * @param frustumPlane the resuling frustum plane
  87219. */
  87220. static GetTopPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  87221. /**
  87222. * Gets the bottom frustum plane transformed by the transform matrix
  87223. * @param transform transformation matrix to be applied to the resulting frustum plane
  87224. * @param frustumPlane the resuling frustum plane
  87225. */
  87226. static GetBottomPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  87227. /**
  87228. * Sets the given array "frustumPlanes" with the 6 Frustum planes computed by the given transformation matrix.
  87229. * @param transform transformation matrix to be applied to the resulting frustum planes
  87230. * @param frustumPlanes the resuling frustum planes
  87231. */
  87232. static GetPlanesToRef(transform: DeepImmutable<Matrix>, frustumPlanes: Plane[]): void;
  87233. }
  87234. }
  87235. declare module BABYLON {
  87236. /**
  87237. * Interface for the size containing width and height
  87238. */
  87239. export interface ISize {
  87240. /**
  87241. * Width
  87242. */
  87243. width: number;
  87244. /**
  87245. * Heighht
  87246. */
  87247. height: number;
  87248. }
  87249. /**
  87250. * Size containing widht and height
  87251. */
  87252. export class Size implements ISize {
  87253. /**
  87254. * Width
  87255. */
  87256. width: number;
  87257. /**
  87258. * Height
  87259. */
  87260. height: number;
  87261. /**
  87262. * Creates a Size object from the given width and height (floats).
  87263. * @param width width of the new size
  87264. * @param height height of the new size
  87265. */
  87266. constructor(width: number, height: number);
  87267. /**
  87268. * Returns a string with the Size width and height
  87269. * @returns a string with the Size width and height
  87270. */
  87271. toString(): string;
  87272. /**
  87273. * "Size"
  87274. * @returns the string "Size"
  87275. */
  87276. getClassName(): string;
  87277. /**
  87278. * Returns the Size hash code.
  87279. * @returns a hash code for a unique width and height
  87280. */
  87281. getHashCode(): number;
  87282. /**
  87283. * Updates the current size from the given one.
  87284. * @param src the given size
  87285. */
  87286. copyFrom(src: Size): void;
  87287. /**
  87288. * Updates in place the current Size from the given floats.
  87289. * @param width width of the new size
  87290. * @param height height of the new size
  87291. * @returns the updated Size.
  87292. */
  87293. copyFromFloats(width: number, height: number): Size;
  87294. /**
  87295. * Updates in place the current Size from the given floats.
  87296. * @param width width to set
  87297. * @param height height to set
  87298. * @returns the updated Size.
  87299. */
  87300. set(width: number, height: number): Size;
  87301. /**
  87302. * Multiplies the width and height by numbers
  87303. * @param w factor to multiple the width by
  87304. * @param h factor to multiple the height by
  87305. * @returns a new Size set with the multiplication result of the current Size and the given floats.
  87306. */
  87307. multiplyByFloats(w: number, h: number): Size;
  87308. /**
  87309. * Clones the size
  87310. * @returns a new Size copied from the given one.
  87311. */
  87312. clone(): Size;
  87313. /**
  87314. * True if the current Size and the given one width and height are strictly equal.
  87315. * @param other the other size to compare against
  87316. * @returns True if the current Size and the given one width and height are strictly equal.
  87317. */
  87318. equals(other: Size): boolean;
  87319. /**
  87320. * The surface of the Size : width * height (float).
  87321. */
  87322. get surface(): number;
  87323. /**
  87324. * Create a new size of zero
  87325. * @returns a new Size set to (0.0, 0.0)
  87326. */
  87327. static Zero(): Size;
  87328. /**
  87329. * Sums the width and height of two sizes
  87330. * @param otherSize size to add to this size
  87331. * @returns a new Size set as the addition result of the current Size and the given one.
  87332. */
  87333. add(otherSize: Size): Size;
  87334. /**
  87335. * Subtracts the width and height of two
  87336. * @param otherSize size to subtract to this size
  87337. * @returns a new Size set as the subtraction result of the given one from the current Size.
  87338. */
  87339. subtract(otherSize: Size): Size;
  87340. /**
  87341. * Creates a new Size set at the linear interpolation "amount" between "start" and "end"
  87342. * @param start starting size to lerp between
  87343. * @param end end size to lerp between
  87344. * @param amount amount to lerp between the start and end values
  87345. * @returns a new Size set at the linear interpolation "amount" between "start" and "end"
  87346. */
  87347. static Lerp(start: Size, end: Size, amount: number): Size;
  87348. }
  87349. }
  87350. declare module BABYLON {
  87351. /**
  87352. * Contains position and normal vectors for a vertex
  87353. */
  87354. export class PositionNormalVertex {
  87355. /** the position of the vertex (defaut: 0,0,0) */
  87356. position: Vector3;
  87357. /** the normal of the vertex (defaut: 0,1,0) */
  87358. normal: Vector3;
  87359. /**
  87360. * Creates a PositionNormalVertex
  87361. * @param position the position of the vertex (defaut: 0,0,0)
  87362. * @param normal the normal of the vertex (defaut: 0,1,0)
  87363. */
  87364. constructor(
  87365. /** the position of the vertex (defaut: 0,0,0) */
  87366. position?: Vector3,
  87367. /** the normal of the vertex (defaut: 0,1,0) */
  87368. normal?: Vector3);
  87369. /**
  87370. * Clones the PositionNormalVertex
  87371. * @returns the cloned PositionNormalVertex
  87372. */
  87373. clone(): PositionNormalVertex;
  87374. }
  87375. /**
  87376. * Contains position, normal and uv vectors for a vertex
  87377. */
  87378. export class PositionNormalTextureVertex {
  87379. /** the position of the vertex (defaut: 0,0,0) */
  87380. position: Vector3;
  87381. /** the normal of the vertex (defaut: 0,1,0) */
  87382. normal: Vector3;
  87383. /** the uv of the vertex (default: 0,0) */
  87384. uv: Vector2;
  87385. /**
  87386. * Creates a PositionNormalTextureVertex
  87387. * @param position the position of the vertex (defaut: 0,0,0)
  87388. * @param normal the normal of the vertex (defaut: 0,1,0)
  87389. * @param uv the uv of the vertex (default: 0,0)
  87390. */
  87391. constructor(
  87392. /** the position of the vertex (defaut: 0,0,0) */
  87393. position?: Vector3,
  87394. /** the normal of the vertex (defaut: 0,1,0) */
  87395. normal?: Vector3,
  87396. /** the uv of the vertex (default: 0,0) */
  87397. uv?: Vector2);
  87398. /**
  87399. * Clones the PositionNormalTextureVertex
  87400. * @returns the cloned PositionNormalTextureVertex
  87401. */
  87402. clone(): PositionNormalTextureVertex;
  87403. }
  87404. }
  87405. declare module BABYLON {
  87406. /**
  87407. * Enum defining the type of animations supported by InputBlock
  87408. */
  87409. export enum AnimatedInputBlockTypes {
  87410. /** No animation */
  87411. None = 0,
  87412. /** Time based animation. Will only work for floats */
  87413. Time = 1
  87414. }
  87415. }
  87416. declare module BABYLON {
  87417. /**
  87418. * Interface describing all the common properties and methods a shadow light needs to implement.
  87419. * This helps both the shadow generator and materials to genrate the corresponding shadow maps
  87420. * as well as binding the different shadow properties to the effects.
  87421. */
  87422. export interface IShadowLight extends Light {
  87423. /**
  87424. * The light id in the scene (used in scene.findLighById for instance)
  87425. */
  87426. id: string;
  87427. /**
  87428. * The position the shdow will be casted from.
  87429. */
  87430. position: Vector3;
  87431. /**
  87432. * In 2d mode (needCube being false), the direction used to cast the shadow.
  87433. */
  87434. direction: Vector3;
  87435. /**
  87436. * The transformed position. Position of the light in world space taking parenting in account.
  87437. */
  87438. transformedPosition: Vector3;
  87439. /**
  87440. * The transformed direction. Direction of the light in world space taking parenting in account.
  87441. */
  87442. transformedDirection: Vector3;
  87443. /**
  87444. * The friendly name of the light in the scene.
  87445. */
  87446. name: string;
  87447. /**
  87448. * Defines the shadow projection clipping minimum z value.
  87449. */
  87450. shadowMinZ: number;
  87451. /**
  87452. * Defines the shadow projection clipping maximum z value.
  87453. */
  87454. shadowMaxZ: number;
  87455. /**
  87456. * Computes the transformed information (transformedPosition and transformedDirection in World space) of the current light
  87457. * @returns true if the information has been computed, false if it does not need to (no parenting)
  87458. */
  87459. computeTransformedInformation(): boolean;
  87460. /**
  87461. * Gets the scene the light belongs to.
  87462. * @returns The scene
  87463. */
  87464. getScene(): Scene;
  87465. /**
  87466. * Callback defining a custom Projection Matrix Builder.
  87467. * This can be used to override the default projection matrix computation.
  87468. */
  87469. customProjectionMatrixBuilder: (viewMatrix: Matrix, renderList: Array<AbstractMesh>, result: Matrix) => void;
  87470. /**
  87471. * Sets the shadow projection matrix in parameter to the generated projection matrix.
  87472. * @param matrix The materix to updated with the projection information
  87473. * @param viewMatrix The transform matrix of the light
  87474. * @param renderList The list of mesh to render in the map
  87475. * @returns The current light
  87476. */
  87477. setShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): IShadowLight;
  87478. /**
  87479. * Gets the current depth scale used in ESM.
  87480. * @returns The scale
  87481. */
  87482. getDepthScale(): number;
  87483. /**
  87484. * Returns whether or not the shadow generation require a cube texture or a 2d texture.
  87485. * @returns true if a cube texture needs to be use
  87486. */
  87487. needCube(): boolean;
  87488. /**
  87489. * Detects if the projection matrix requires to be recomputed this frame.
  87490. * @returns true if it requires to be recomputed otherwise, false.
  87491. */
  87492. needProjectionMatrixCompute(): boolean;
  87493. /**
  87494. * Forces the shadow generator to recompute the projection matrix even if position and direction did not changed.
  87495. */
  87496. forceProjectionMatrixCompute(): void;
  87497. /**
  87498. * Get the direction to use to render the shadow map. In case of cube texture, the face index can be passed.
  87499. * @param faceIndex The index of the face we are computed the direction to generate shadow
  87500. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  87501. */
  87502. getShadowDirection(faceIndex?: number): Vector3;
  87503. /**
  87504. * Gets the minZ used for shadow according to both the scene and the light.
  87505. * @param activeCamera The camera we are returning the min for
  87506. * @returns the depth min z
  87507. */
  87508. getDepthMinZ(activeCamera: Camera): number;
  87509. /**
  87510. * Gets the maxZ used for shadow according to both the scene and the light.
  87511. * @param activeCamera The camera we are returning the max for
  87512. * @returns the depth max z
  87513. */
  87514. getDepthMaxZ(activeCamera: Camera): number;
  87515. }
  87516. /**
  87517. * Base implementation IShadowLight
  87518. * It groups all the common behaviour in order to reduce dupplication and better follow the DRY pattern.
  87519. */
  87520. export abstract class ShadowLight extends Light implements IShadowLight {
  87521. protected abstract _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  87522. protected _position: Vector3;
  87523. protected _setPosition(value: Vector3): void;
  87524. /**
  87525. * Sets the position the shadow will be casted from. Also use as the light position for both
  87526. * point and spot lights.
  87527. */
  87528. get position(): Vector3;
  87529. /**
  87530. * Sets the position the shadow will be casted from. Also use as the light position for both
  87531. * point and spot lights.
  87532. */
  87533. set position(value: Vector3);
  87534. protected _direction: Vector3;
  87535. protected _setDirection(value: Vector3): void;
  87536. /**
  87537. * In 2d mode (needCube being false), gets the direction used to cast the shadow.
  87538. * Also use as the light direction on spot and directional lights.
  87539. */
  87540. get direction(): Vector3;
  87541. /**
  87542. * In 2d mode (needCube being false), sets the direction used to cast the shadow.
  87543. * Also use as the light direction on spot and directional lights.
  87544. */
  87545. set direction(value: Vector3);
  87546. protected _shadowMinZ: number;
  87547. /**
  87548. * Gets the shadow projection clipping minimum z value.
  87549. */
  87550. get shadowMinZ(): number;
  87551. /**
  87552. * Sets the shadow projection clipping minimum z value.
  87553. */
  87554. set shadowMinZ(value: number);
  87555. protected _shadowMaxZ: number;
  87556. /**
  87557. * Sets the shadow projection clipping maximum z value.
  87558. */
  87559. get shadowMaxZ(): number;
  87560. /**
  87561. * Gets the shadow projection clipping maximum z value.
  87562. */
  87563. set shadowMaxZ(value: number);
  87564. /**
  87565. * Callback defining a custom Projection Matrix Builder.
  87566. * This can be used to override the default projection matrix computation.
  87567. */
  87568. customProjectionMatrixBuilder: (viewMatrix: Matrix, renderList: Array<AbstractMesh>, result: Matrix) => void;
  87569. /**
  87570. * The transformed position. Position of the light in world space taking parenting in account.
  87571. */
  87572. transformedPosition: Vector3;
  87573. /**
  87574. * The transformed direction. Direction of the light in world space taking parenting in account.
  87575. */
  87576. transformedDirection: Vector3;
  87577. private _needProjectionMatrixCompute;
  87578. /**
  87579. * Computes the transformed information (transformedPosition and transformedDirection in World space) of the current light
  87580. * @returns true if the information has been computed, false if it does not need to (no parenting)
  87581. */
  87582. computeTransformedInformation(): boolean;
  87583. /**
  87584. * Return the depth scale used for the shadow map.
  87585. * @returns the depth scale.
  87586. */
  87587. getDepthScale(): number;
  87588. /**
  87589. * Get the direction to use to render the shadow map. In case of cube texture, the face index can be passed.
  87590. * @param faceIndex The index of the face we are computed the direction to generate shadow
  87591. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  87592. */
  87593. getShadowDirection(faceIndex?: number): Vector3;
  87594. /**
  87595. * Returns the ShadowLight absolute position in the World.
  87596. * @returns the position vector in world space
  87597. */
  87598. getAbsolutePosition(): Vector3;
  87599. /**
  87600. * Sets the ShadowLight direction toward the passed target.
  87601. * @param target The point to target in local space
  87602. * @returns the updated ShadowLight direction
  87603. */
  87604. setDirectionToTarget(target: Vector3): Vector3;
  87605. /**
  87606. * Returns the light rotation in euler definition.
  87607. * @returns the x y z rotation in local space.
  87608. */
  87609. getRotation(): Vector3;
  87610. /**
  87611. * Returns whether or not the shadow generation require a cube texture or a 2d texture.
  87612. * @returns true if a cube texture needs to be use
  87613. */
  87614. needCube(): boolean;
  87615. /**
  87616. * Detects if the projection matrix requires to be recomputed this frame.
  87617. * @returns true if it requires to be recomputed otherwise, false.
  87618. */
  87619. needProjectionMatrixCompute(): boolean;
  87620. /**
  87621. * Forces the shadow generator to recompute the projection matrix even if position and direction did not changed.
  87622. */
  87623. forceProjectionMatrixCompute(): void;
  87624. /** @hidden */
  87625. _initCache(): void;
  87626. /** @hidden */
  87627. _isSynchronized(): boolean;
  87628. /**
  87629. * Computes the world matrix of the node
  87630. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  87631. * @returns the world matrix
  87632. */
  87633. computeWorldMatrix(force?: boolean): Matrix;
  87634. /**
  87635. * Gets the minZ used for shadow according to both the scene and the light.
  87636. * @param activeCamera The camera we are returning the min for
  87637. * @returns the depth min z
  87638. */
  87639. getDepthMinZ(activeCamera: Camera): number;
  87640. /**
  87641. * Gets the maxZ used for shadow according to both the scene and the light.
  87642. * @param activeCamera The camera we are returning the max for
  87643. * @returns the depth max z
  87644. */
  87645. getDepthMaxZ(activeCamera: Camera): number;
  87646. /**
  87647. * Sets the shadow projection matrix in parameter to the generated projection matrix.
  87648. * @param matrix The materix to updated with the projection information
  87649. * @param viewMatrix The transform matrix of the light
  87650. * @param renderList The list of mesh to render in the map
  87651. * @returns The current light
  87652. */
  87653. setShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): IShadowLight;
  87654. }
  87655. }
  87656. declare module BABYLON {
  87657. /** @hidden */
  87658. export var packingFunctions: {
  87659. name: string;
  87660. shader: string;
  87661. };
  87662. }
  87663. declare module BABYLON {
  87664. /** @hidden */
  87665. export var bayerDitherFunctions: {
  87666. name: string;
  87667. shader: string;
  87668. };
  87669. }
  87670. declare module BABYLON {
  87671. /** @hidden */
  87672. export var shadowMapFragmentDeclaration: {
  87673. name: string;
  87674. shader: string;
  87675. };
  87676. }
  87677. declare module BABYLON {
  87678. /** @hidden */
  87679. export var clipPlaneFragmentDeclaration: {
  87680. name: string;
  87681. shader: string;
  87682. };
  87683. }
  87684. declare module BABYLON {
  87685. /** @hidden */
  87686. export var clipPlaneFragment: {
  87687. name: string;
  87688. shader: string;
  87689. };
  87690. }
  87691. declare module BABYLON {
  87692. /** @hidden */
  87693. export var shadowMapFragment: {
  87694. name: string;
  87695. shader: string;
  87696. };
  87697. }
  87698. declare module BABYLON {
  87699. /** @hidden */
  87700. export var shadowMapPixelShader: {
  87701. name: string;
  87702. shader: string;
  87703. };
  87704. }
  87705. declare module BABYLON {
  87706. /** @hidden */
  87707. export var bonesDeclaration: {
  87708. name: string;
  87709. shader: string;
  87710. };
  87711. }
  87712. declare module BABYLON {
  87713. /** @hidden */
  87714. export var morphTargetsVertexGlobalDeclaration: {
  87715. name: string;
  87716. shader: string;
  87717. };
  87718. }
  87719. declare module BABYLON {
  87720. /** @hidden */
  87721. export var morphTargetsVertexDeclaration: {
  87722. name: string;
  87723. shader: string;
  87724. };
  87725. }
  87726. declare module BABYLON {
  87727. /** @hidden */
  87728. export var instancesDeclaration: {
  87729. name: string;
  87730. shader: string;
  87731. };
  87732. }
  87733. declare module BABYLON {
  87734. /** @hidden */
  87735. export var helperFunctions: {
  87736. name: string;
  87737. shader: string;
  87738. };
  87739. }
  87740. declare module BABYLON {
  87741. /** @hidden */
  87742. export var shadowMapVertexDeclaration: {
  87743. name: string;
  87744. shader: string;
  87745. };
  87746. }
  87747. declare module BABYLON {
  87748. /** @hidden */
  87749. export var clipPlaneVertexDeclaration: {
  87750. name: string;
  87751. shader: string;
  87752. };
  87753. }
  87754. declare module BABYLON {
  87755. /** @hidden */
  87756. export var morphTargetsVertex: {
  87757. name: string;
  87758. shader: string;
  87759. };
  87760. }
  87761. declare module BABYLON {
  87762. /** @hidden */
  87763. export var instancesVertex: {
  87764. name: string;
  87765. shader: string;
  87766. };
  87767. }
  87768. declare module BABYLON {
  87769. /** @hidden */
  87770. export var bonesVertex: {
  87771. name: string;
  87772. shader: string;
  87773. };
  87774. }
  87775. declare module BABYLON {
  87776. /** @hidden */
  87777. export var shadowMapVertexNormalBias: {
  87778. name: string;
  87779. shader: string;
  87780. };
  87781. }
  87782. declare module BABYLON {
  87783. /** @hidden */
  87784. export var shadowMapVertexMetric: {
  87785. name: string;
  87786. shader: string;
  87787. };
  87788. }
  87789. declare module BABYLON {
  87790. /** @hidden */
  87791. export var clipPlaneVertex: {
  87792. name: string;
  87793. shader: string;
  87794. };
  87795. }
  87796. declare module BABYLON {
  87797. /** @hidden */
  87798. export var shadowMapVertexShader: {
  87799. name: string;
  87800. shader: string;
  87801. };
  87802. }
  87803. declare module BABYLON {
  87804. /** @hidden */
  87805. export var depthBoxBlurPixelShader: {
  87806. name: string;
  87807. shader: string;
  87808. };
  87809. }
  87810. declare module BABYLON {
  87811. /** @hidden */
  87812. export var shadowMapFragmentSoftTransparentShadow: {
  87813. name: string;
  87814. shader: string;
  87815. };
  87816. }
  87817. declare module BABYLON {
  87818. /**
  87819. * EffectFallbacks can be used to add fallbacks (properties to disable) to certain properties when desired to improve performance.
  87820. * (Eg. Start at high quality with reflection and fog, if fps is low, remove reflection, if still low remove fog)
  87821. */
  87822. export class EffectFallbacks implements IEffectFallbacks {
  87823. private _defines;
  87824. private _currentRank;
  87825. private _maxRank;
  87826. private _mesh;
  87827. /**
  87828. * Removes the fallback from the bound mesh.
  87829. */
  87830. unBindMesh(): void;
  87831. /**
  87832. * Adds a fallback on the specified property.
  87833. * @param rank The rank of the fallback (Lower ranks will be fallbacked to first)
  87834. * @param define The name of the define in the shader
  87835. */
  87836. addFallback(rank: number, define: string): void;
  87837. /**
  87838. * Sets the mesh to use CPU skinning when needing to fallback.
  87839. * @param rank The rank of the fallback (Lower ranks will be fallbacked to first)
  87840. * @param mesh The mesh to use the fallbacks.
  87841. */
  87842. addCPUSkinningFallback(rank: number, mesh: AbstractMesh): void;
  87843. /**
  87844. * Checks to see if more fallbacks are still availible.
  87845. */
  87846. get hasMoreFallbacks(): boolean;
  87847. /**
  87848. * Removes the defines that should be removed when falling back.
  87849. * @param currentDefines defines the current define statements for the shader.
  87850. * @param effect defines the current effect we try to compile
  87851. * @returns The resulting defines with defines of the current rank removed.
  87852. */
  87853. reduce(currentDefines: string, effect: Effect): string;
  87854. }
  87855. }
  87856. declare module BABYLON {
  87857. /**
  87858. * Interface used to define Action
  87859. */
  87860. export interface IAction {
  87861. /**
  87862. * Trigger for the action
  87863. */
  87864. trigger: number;
  87865. /** Options of the trigger */
  87866. triggerOptions: any;
  87867. /**
  87868. * Gets the trigger parameters
  87869. * @returns the trigger parameters
  87870. */
  87871. getTriggerParameter(): any;
  87872. /**
  87873. * Internal only - executes current action event
  87874. * @hidden
  87875. */
  87876. _executeCurrent(evt?: ActionEvent): void;
  87877. /**
  87878. * Serialize placeholder for child classes
  87879. * @param parent of child
  87880. * @returns the serialized object
  87881. */
  87882. serialize(parent: any): any;
  87883. /**
  87884. * Internal only
  87885. * @hidden
  87886. */
  87887. _prepare(): void;
  87888. /**
  87889. * Internal only - manager for action
  87890. * @hidden
  87891. */
  87892. _actionManager: AbstractActionManager;
  87893. /**
  87894. * Adds action to chain of actions, may be a DoNothingAction
  87895. * @param action defines the next action to execute
  87896. * @returns The action passed in
  87897. * @see https://www.babylonjs-playground.com/#1T30HR#0
  87898. */
  87899. then(action: IAction): IAction;
  87900. }
  87901. /**
  87902. * The action to be carried out following a trigger
  87903. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#available-actions
  87904. */
  87905. export class Action implements IAction {
  87906. /** the trigger, with or without parameters, for the action */
  87907. triggerOptions: any;
  87908. /**
  87909. * Trigger for the action
  87910. */
  87911. trigger: number;
  87912. /**
  87913. * Internal only - manager for action
  87914. * @hidden
  87915. */
  87916. _actionManager: ActionManager;
  87917. private _nextActiveAction;
  87918. private _child;
  87919. private _condition?;
  87920. private _triggerParameter;
  87921. /**
  87922. * An event triggered prior to action being executed.
  87923. */
  87924. onBeforeExecuteObservable: Observable<Action>;
  87925. /**
  87926. * Creates a new Action
  87927. * @param triggerOptions the trigger, with or without parameters, for the action
  87928. * @param condition an optional determinant of action
  87929. */
  87930. constructor(
  87931. /** the trigger, with or without parameters, for the action */
  87932. triggerOptions: any, condition?: Condition);
  87933. /**
  87934. * Internal only
  87935. * @hidden
  87936. */
  87937. _prepare(): void;
  87938. /**
  87939. * Gets the trigger parameters
  87940. * @returns the trigger parameters
  87941. */
  87942. getTriggerParameter(): any;
  87943. /**
  87944. * Internal only - executes current action event
  87945. * @hidden
  87946. */
  87947. _executeCurrent(evt?: ActionEvent): void;
  87948. /**
  87949. * Execute placeholder for child classes
  87950. * @param evt optional action event
  87951. */
  87952. execute(evt?: ActionEvent): void;
  87953. /**
  87954. * Skips to next active action
  87955. */
  87956. skipToNextActiveAction(): void;
  87957. /**
  87958. * Adds action to chain of actions, may be a DoNothingAction
  87959. * @param action defines the next action to execute
  87960. * @returns The action passed in
  87961. * @see https://www.babylonjs-playground.com/#1T30HR#0
  87962. */
  87963. then(action: Action): Action;
  87964. /**
  87965. * Internal only
  87966. * @hidden
  87967. */
  87968. _getProperty(propertyPath: string): string;
  87969. /**
  87970. * Internal only
  87971. * @hidden
  87972. */
  87973. _getEffectiveTarget(target: any, propertyPath: string): any;
  87974. /**
  87975. * Serialize placeholder for child classes
  87976. * @param parent of child
  87977. * @returns the serialized object
  87978. */
  87979. serialize(parent: any): any;
  87980. /**
  87981. * Internal only called by serialize
  87982. * @hidden
  87983. */
  87984. protected _serialize(serializedAction: any, parent?: any): any;
  87985. /**
  87986. * Internal only
  87987. * @hidden
  87988. */
  87989. static _SerializeValueAsString: (value: any) => string;
  87990. /**
  87991. * Internal only
  87992. * @hidden
  87993. */
  87994. static _GetTargetProperty: (target: Scene | Node) => {
  87995. name: string;
  87996. targetType: string;
  87997. value: string;
  87998. };
  87999. }
  88000. }
  88001. declare module BABYLON {
  88002. /**
  88003. * A Condition applied to an Action
  88004. */
  88005. export class Condition {
  88006. /**
  88007. * Internal only - manager for action
  88008. * @hidden
  88009. */
  88010. _actionManager: ActionManager;
  88011. /**
  88012. * Internal only
  88013. * @hidden
  88014. */
  88015. _evaluationId: number;
  88016. /**
  88017. * Internal only
  88018. * @hidden
  88019. */
  88020. _currentResult: boolean;
  88021. /**
  88022. * Creates a new Condition
  88023. * @param actionManager the manager of the action the condition is applied to
  88024. */
  88025. constructor(actionManager: ActionManager);
  88026. /**
  88027. * Check if the current condition is valid
  88028. * @returns a boolean
  88029. */
  88030. isValid(): boolean;
  88031. /**
  88032. * Internal only
  88033. * @hidden
  88034. */
  88035. _getProperty(propertyPath: string): string;
  88036. /**
  88037. * Internal only
  88038. * @hidden
  88039. */
  88040. _getEffectiveTarget(target: any, propertyPath: string): any;
  88041. /**
  88042. * Serialize placeholder for child classes
  88043. * @returns the serialized object
  88044. */
  88045. serialize(): any;
  88046. /**
  88047. * Internal only
  88048. * @hidden
  88049. */
  88050. protected _serialize(serializedCondition: any): any;
  88051. }
  88052. /**
  88053. * Defines specific conditional operators as extensions of Condition
  88054. */
  88055. export class ValueCondition extends Condition {
  88056. /** path to specify the property of the target the conditional operator uses */
  88057. propertyPath: string;
  88058. /** the value compared by the conditional operator against the current value of the property */
  88059. value: any;
  88060. /** the conditional operator, default ValueCondition.IsEqual */
  88061. operator: number;
  88062. /**
  88063. * Internal only
  88064. * @hidden
  88065. */
  88066. private static _IsEqual;
  88067. /**
  88068. * Internal only
  88069. * @hidden
  88070. */
  88071. private static _IsDifferent;
  88072. /**
  88073. * Internal only
  88074. * @hidden
  88075. */
  88076. private static _IsGreater;
  88077. /**
  88078. * Internal only
  88079. * @hidden
  88080. */
  88081. private static _IsLesser;
  88082. /**
  88083. * returns the number for IsEqual
  88084. */
  88085. static get IsEqual(): number;
  88086. /**
  88087. * Returns the number for IsDifferent
  88088. */
  88089. static get IsDifferent(): number;
  88090. /**
  88091. * Returns the number for IsGreater
  88092. */
  88093. static get IsGreater(): number;
  88094. /**
  88095. * Returns the number for IsLesser
  88096. */
  88097. static get IsLesser(): number;
  88098. /**
  88099. * Internal only The action manager for the condition
  88100. * @hidden
  88101. */
  88102. _actionManager: ActionManager;
  88103. /**
  88104. * Internal only
  88105. * @hidden
  88106. */
  88107. private _target;
  88108. /**
  88109. * Internal only
  88110. * @hidden
  88111. */
  88112. private _effectiveTarget;
  88113. /**
  88114. * Internal only
  88115. * @hidden
  88116. */
  88117. private _property;
  88118. /**
  88119. * Creates a new ValueCondition
  88120. * @param actionManager manager for the action the condition applies to
  88121. * @param target for the action
  88122. * @param propertyPath path to specify the property of the target the conditional operator uses
  88123. * @param value the value compared by the conditional operator against the current value of the property
  88124. * @param operator the conditional operator, default ValueCondition.IsEqual
  88125. */
  88126. constructor(actionManager: ActionManager, target: any,
  88127. /** path to specify the property of the target the conditional operator uses */
  88128. propertyPath: string,
  88129. /** the value compared by the conditional operator against the current value of the property */
  88130. value: any,
  88131. /** the conditional operator, default ValueCondition.IsEqual */
  88132. operator?: number);
  88133. /**
  88134. * Compares the given value with the property value for the specified conditional operator
  88135. * @returns the result of the comparison
  88136. */
  88137. isValid(): boolean;
  88138. /**
  88139. * Serialize the ValueCondition into a JSON compatible object
  88140. * @returns serialization object
  88141. */
  88142. serialize(): any;
  88143. /**
  88144. * Gets the name of the conditional operator for the ValueCondition
  88145. * @param operator the conditional operator
  88146. * @returns the name
  88147. */
  88148. static GetOperatorName(operator: number): string;
  88149. }
  88150. /**
  88151. * Defines a predicate condition as an extension of Condition
  88152. */
  88153. export class PredicateCondition extends Condition {
  88154. /** defines the predicate function used to validate the condition */
  88155. predicate: () => boolean;
  88156. /**
  88157. * Internal only - manager for action
  88158. * @hidden
  88159. */
  88160. _actionManager: ActionManager;
  88161. /**
  88162. * Creates a new PredicateCondition
  88163. * @param actionManager manager for the action the condition applies to
  88164. * @param predicate defines the predicate function used to validate the condition
  88165. */
  88166. constructor(actionManager: ActionManager,
  88167. /** defines the predicate function used to validate the condition */
  88168. predicate: () => boolean);
  88169. /**
  88170. * @returns the validity of the predicate condition
  88171. */
  88172. isValid(): boolean;
  88173. }
  88174. /**
  88175. * Defines a state condition as an extension of Condition
  88176. */
  88177. export class StateCondition extends Condition {
  88178. /** Value to compare with target state */
  88179. value: string;
  88180. /**
  88181. * Internal only - manager for action
  88182. * @hidden
  88183. */
  88184. _actionManager: ActionManager;
  88185. /**
  88186. * Internal only
  88187. * @hidden
  88188. */
  88189. private _target;
  88190. /**
  88191. * Creates a new StateCondition
  88192. * @param actionManager manager for the action the condition applies to
  88193. * @param target of the condition
  88194. * @param value to compare with target state
  88195. */
  88196. constructor(actionManager: ActionManager, target: any,
  88197. /** Value to compare with target state */
  88198. value: string);
  88199. /**
  88200. * Gets a boolean indicating if the current condition is met
  88201. * @returns the validity of the state
  88202. */
  88203. isValid(): boolean;
  88204. /**
  88205. * Serialize the StateCondition into a JSON compatible object
  88206. * @returns serialization object
  88207. */
  88208. serialize(): any;
  88209. }
  88210. }
  88211. declare module BABYLON {
  88212. /**
  88213. * This defines an action responsible to toggle a boolean once triggered.
  88214. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  88215. */
  88216. export class SwitchBooleanAction extends Action {
  88217. /**
  88218. * The path to the boolean property in the target object
  88219. */
  88220. propertyPath: string;
  88221. private _target;
  88222. private _effectiveTarget;
  88223. private _property;
  88224. /**
  88225. * Instantiate the action
  88226. * @param triggerOptions defines the trigger options
  88227. * @param target defines the object containing the boolean
  88228. * @param propertyPath defines the path to the boolean property in the target object
  88229. * @param condition defines the trigger related conditions
  88230. */
  88231. constructor(triggerOptions: any, target: any, propertyPath: string, condition?: Condition);
  88232. /** @hidden */
  88233. _prepare(): void;
  88234. /**
  88235. * Execute the action toggle the boolean value.
  88236. */
  88237. execute(): void;
  88238. /**
  88239. * Serializes the actions and its related information.
  88240. * @param parent defines the object to serialize in
  88241. * @returns the serialized object
  88242. */
  88243. serialize(parent: any): any;
  88244. }
  88245. /**
  88246. * This defines an action responsible to set a the state field of the target
  88247. * to a desired value once triggered.
  88248. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  88249. */
  88250. export class SetStateAction extends Action {
  88251. /**
  88252. * The value to store in the state field.
  88253. */
  88254. value: string;
  88255. private _target;
  88256. /**
  88257. * Instantiate the action
  88258. * @param triggerOptions defines the trigger options
  88259. * @param target defines the object containing the state property
  88260. * @param value defines the value to store in the state field
  88261. * @param condition defines the trigger related conditions
  88262. */
  88263. constructor(triggerOptions: any, target: any, value: string, condition?: Condition);
  88264. /**
  88265. * Execute the action and store the value on the target state property.
  88266. */
  88267. execute(): void;
  88268. /**
  88269. * Serializes the actions and its related information.
  88270. * @param parent defines the object to serialize in
  88271. * @returns the serialized object
  88272. */
  88273. serialize(parent: any): any;
  88274. }
  88275. /**
  88276. * This defines an action responsible to set a property of the target
  88277. * to a desired value once triggered.
  88278. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  88279. */
  88280. export class SetValueAction extends Action {
  88281. /**
  88282. * The path of the property to set in the target.
  88283. */
  88284. propertyPath: string;
  88285. /**
  88286. * The value to set in the property
  88287. */
  88288. value: any;
  88289. private _target;
  88290. private _effectiveTarget;
  88291. private _property;
  88292. /**
  88293. * Instantiate the action
  88294. * @param triggerOptions defines the trigger options
  88295. * @param target defines the object containing the property
  88296. * @param propertyPath defines the path of the property to set in the target
  88297. * @param value defines the value to set in the property
  88298. * @param condition defines the trigger related conditions
  88299. */
  88300. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, condition?: Condition);
  88301. /** @hidden */
  88302. _prepare(): void;
  88303. /**
  88304. * Execute the action and set the targetted property to the desired value.
  88305. */
  88306. execute(): void;
  88307. /**
  88308. * Serializes the actions and its related information.
  88309. * @param parent defines the object to serialize in
  88310. * @returns the serialized object
  88311. */
  88312. serialize(parent: any): any;
  88313. }
  88314. /**
  88315. * This defines an action responsible to increment the target value
  88316. * to a desired value once triggered.
  88317. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  88318. */
  88319. export class IncrementValueAction extends Action {
  88320. /**
  88321. * The path of the property to increment in the target.
  88322. */
  88323. propertyPath: string;
  88324. /**
  88325. * The value we should increment the property by.
  88326. */
  88327. value: any;
  88328. private _target;
  88329. private _effectiveTarget;
  88330. private _property;
  88331. /**
  88332. * Instantiate the action
  88333. * @param triggerOptions defines the trigger options
  88334. * @param target defines the object containing the property
  88335. * @param propertyPath defines the path of the property to increment in the target
  88336. * @param value defines the value value we should increment the property by
  88337. * @param condition defines the trigger related conditions
  88338. */
  88339. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, condition?: Condition);
  88340. /** @hidden */
  88341. _prepare(): void;
  88342. /**
  88343. * Execute the action and increment the target of the value amount.
  88344. */
  88345. execute(): void;
  88346. /**
  88347. * Serializes the actions and its related information.
  88348. * @param parent defines the object to serialize in
  88349. * @returns the serialized object
  88350. */
  88351. serialize(parent: any): any;
  88352. }
  88353. /**
  88354. * This defines an action responsible to start an animation once triggered.
  88355. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  88356. */
  88357. export class PlayAnimationAction extends Action {
  88358. /**
  88359. * Where the animation should start (animation frame)
  88360. */
  88361. from: number;
  88362. /**
  88363. * Where the animation should stop (animation frame)
  88364. */
  88365. to: number;
  88366. /**
  88367. * Define if the animation should loop or stop after the first play.
  88368. */
  88369. loop?: boolean;
  88370. private _target;
  88371. /**
  88372. * Instantiate the action
  88373. * @param triggerOptions defines the trigger options
  88374. * @param target defines the target animation or animation name
  88375. * @param from defines from where the animation should start (animation frame)
  88376. * @param end defines where the animation should stop (animation frame)
  88377. * @param loop defines if the animation should loop or stop after the first play
  88378. * @param condition defines the trigger related conditions
  88379. */
  88380. constructor(triggerOptions: any, target: any, from: number, to: number, loop?: boolean, condition?: Condition);
  88381. /** @hidden */
  88382. _prepare(): void;
  88383. /**
  88384. * Execute the action and play the animation.
  88385. */
  88386. execute(): void;
  88387. /**
  88388. * Serializes the actions and its related information.
  88389. * @param parent defines the object to serialize in
  88390. * @returns the serialized object
  88391. */
  88392. serialize(parent: any): any;
  88393. }
  88394. /**
  88395. * This defines an action responsible to stop an animation once triggered.
  88396. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  88397. */
  88398. export class StopAnimationAction extends Action {
  88399. private _target;
  88400. /**
  88401. * Instantiate the action
  88402. * @param triggerOptions defines the trigger options
  88403. * @param target defines the target animation or animation name
  88404. * @param condition defines the trigger related conditions
  88405. */
  88406. constructor(triggerOptions: any, target: any, condition?: Condition);
  88407. /** @hidden */
  88408. _prepare(): void;
  88409. /**
  88410. * Execute the action and stop the animation.
  88411. */
  88412. execute(): void;
  88413. /**
  88414. * Serializes the actions and its related information.
  88415. * @param parent defines the object to serialize in
  88416. * @returns the serialized object
  88417. */
  88418. serialize(parent: any): any;
  88419. }
  88420. /**
  88421. * This defines an action responsible that does nothing once triggered.
  88422. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  88423. */
  88424. export class DoNothingAction extends Action {
  88425. /**
  88426. * Instantiate the action
  88427. * @param triggerOptions defines the trigger options
  88428. * @param condition defines the trigger related conditions
  88429. */
  88430. constructor(triggerOptions?: any, condition?: Condition);
  88431. /**
  88432. * Execute the action and do nothing.
  88433. */
  88434. execute(): void;
  88435. /**
  88436. * Serializes the actions and its related information.
  88437. * @param parent defines the object to serialize in
  88438. * @returns the serialized object
  88439. */
  88440. serialize(parent: any): any;
  88441. }
  88442. /**
  88443. * This defines an action responsible to trigger several actions once triggered.
  88444. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  88445. */
  88446. export class CombineAction extends Action {
  88447. /**
  88448. * The list of aggregated animations to run.
  88449. */
  88450. children: Action[];
  88451. /**
  88452. * Instantiate the action
  88453. * @param triggerOptions defines the trigger options
  88454. * @param children defines the list of aggregated animations to run
  88455. * @param condition defines the trigger related conditions
  88456. */
  88457. constructor(triggerOptions: any, children: Action[], condition?: Condition);
  88458. /** @hidden */
  88459. _prepare(): void;
  88460. /**
  88461. * Execute the action and executes all the aggregated actions.
  88462. */
  88463. execute(evt: ActionEvent): void;
  88464. /**
  88465. * Serializes the actions and its related information.
  88466. * @param parent defines the object to serialize in
  88467. * @returns the serialized object
  88468. */
  88469. serialize(parent: any): any;
  88470. }
  88471. /**
  88472. * This defines an action responsible to run code (external event) once triggered.
  88473. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  88474. */
  88475. export class ExecuteCodeAction extends Action {
  88476. /**
  88477. * The callback function to run.
  88478. */
  88479. func: (evt: ActionEvent) => void;
  88480. /**
  88481. * Instantiate the action
  88482. * @param triggerOptions defines the trigger options
  88483. * @param func defines the callback function to run
  88484. * @param condition defines the trigger related conditions
  88485. */
  88486. constructor(triggerOptions: any, func: (evt: ActionEvent) => void, condition?: Condition);
  88487. /**
  88488. * Execute the action and run the attached code.
  88489. */
  88490. execute(evt: ActionEvent): void;
  88491. }
  88492. /**
  88493. * This defines an action responsible to set the parent property of the target once triggered.
  88494. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  88495. */
  88496. export class SetParentAction extends Action {
  88497. private _parent;
  88498. private _target;
  88499. /**
  88500. * Instantiate the action
  88501. * @param triggerOptions defines the trigger options
  88502. * @param target defines the target containing the parent property
  88503. * @param parent defines from where the animation should start (animation frame)
  88504. * @param condition defines the trigger related conditions
  88505. */
  88506. constructor(triggerOptions: any, target: any, parent: any, condition?: Condition);
  88507. /** @hidden */
  88508. _prepare(): void;
  88509. /**
  88510. * Execute the action and set the parent property.
  88511. */
  88512. execute(): void;
  88513. /**
  88514. * Serializes the actions and its related information.
  88515. * @param parent defines the object to serialize in
  88516. * @returns the serialized object
  88517. */
  88518. serialize(parent: any): any;
  88519. }
  88520. }
  88521. declare module BABYLON {
  88522. /**
  88523. * Action Manager manages all events to be triggered on a given mesh or the global scene.
  88524. * A single scene can have many Action Managers to handle predefined actions on specific meshes.
  88525. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  88526. */
  88527. export class ActionManager extends AbstractActionManager {
  88528. /**
  88529. * Nothing
  88530. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  88531. */
  88532. static readonly NothingTrigger: number;
  88533. /**
  88534. * On pick
  88535. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  88536. */
  88537. static readonly OnPickTrigger: number;
  88538. /**
  88539. * On left pick
  88540. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  88541. */
  88542. static readonly OnLeftPickTrigger: number;
  88543. /**
  88544. * On right pick
  88545. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  88546. */
  88547. static readonly OnRightPickTrigger: number;
  88548. /**
  88549. * On center pick
  88550. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  88551. */
  88552. static readonly OnCenterPickTrigger: number;
  88553. /**
  88554. * On pick down
  88555. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  88556. */
  88557. static readonly OnPickDownTrigger: number;
  88558. /**
  88559. * On double pick
  88560. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  88561. */
  88562. static readonly OnDoublePickTrigger: number;
  88563. /**
  88564. * On pick up
  88565. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  88566. */
  88567. static readonly OnPickUpTrigger: number;
  88568. /**
  88569. * On pick out.
  88570. * This trigger will only be raised if you also declared a OnPickDown
  88571. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  88572. */
  88573. static readonly OnPickOutTrigger: number;
  88574. /**
  88575. * On long press
  88576. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  88577. */
  88578. static readonly OnLongPressTrigger: number;
  88579. /**
  88580. * On pointer over
  88581. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  88582. */
  88583. static readonly OnPointerOverTrigger: number;
  88584. /**
  88585. * On pointer out
  88586. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  88587. */
  88588. static readonly OnPointerOutTrigger: number;
  88589. /**
  88590. * On every frame
  88591. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  88592. */
  88593. static readonly OnEveryFrameTrigger: number;
  88594. /**
  88595. * On intersection enter
  88596. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  88597. */
  88598. static readonly OnIntersectionEnterTrigger: number;
  88599. /**
  88600. * On intersection exit
  88601. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  88602. */
  88603. static readonly OnIntersectionExitTrigger: number;
  88604. /**
  88605. * On key down
  88606. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  88607. */
  88608. static readonly OnKeyDownTrigger: number;
  88609. /**
  88610. * On key up
  88611. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  88612. */
  88613. static readonly OnKeyUpTrigger: number;
  88614. private _scene;
  88615. /**
  88616. * Creates a new action manager
  88617. * @param scene defines the hosting scene
  88618. */
  88619. constructor(scene: Scene);
  88620. /**
  88621. * Releases all associated resources
  88622. */
  88623. dispose(): void;
  88624. /**
  88625. * Gets hosting scene
  88626. * @returns the hosting scene
  88627. */
  88628. getScene(): Scene;
  88629. /**
  88630. * Does this action manager handles actions of any of the given triggers
  88631. * @param triggers defines the triggers to be tested
  88632. * @return a boolean indicating whether one (or more) of the triggers is handled
  88633. */
  88634. hasSpecificTriggers(triggers: number[]): boolean;
  88635. /**
  88636. * Does this action manager handles actions of any of the given triggers. This function takes two arguments for
  88637. * speed.
  88638. * @param triggerA defines the trigger to be tested
  88639. * @param triggerB defines the trigger to be tested
  88640. * @return a boolean indicating whether one (or more) of the triggers is handled
  88641. */
  88642. hasSpecificTriggers2(triggerA: number, triggerB: number): boolean;
  88643. /**
  88644. * Does this action manager handles actions of a given trigger
  88645. * @param trigger defines the trigger to be tested
  88646. * @param parameterPredicate defines an optional predicate to filter triggers by parameter
  88647. * @return whether the trigger is handled
  88648. */
  88649. hasSpecificTrigger(trigger: number, parameterPredicate?: (parameter: any) => boolean): boolean;
  88650. /**
  88651. * Does this action manager has pointer triggers
  88652. */
  88653. get hasPointerTriggers(): boolean;
  88654. /**
  88655. * Does this action manager has pick triggers
  88656. */
  88657. get hasPickTriggers(): boolean;
  88658. /**
  88659. * Registers an action to this action manager
  88660. * @param action defines the action to be registered
  88661. * @return the action amended (prepared) after registration
  88662. */
  88663. registerAction(action: IAction): Nullable<IAction>;
  88664. /**
  88665. * Unregisters an action to this action manager
  88666. * @param action defines the action to be unregistered
  88667. * @return a boolean indicating whether the action has been unregistered
  88668. */
  88669. unregisterAction(action: IAction): Boolean;
  88670. /**
  88671. * Process a specific trigger
  88672. * @param trigger defines the trigger to process
  88673. * @param evt defines the event details to be processed
  88674. */
  88675. processTrigger(trigger: number, evt?: IActionEvent): void;
  88676. /** @hidden */
  88677. _getEffectiveTarget(target: any, propertyPath: string): any;
  88678. /** @hidden */
  88679. _getProperty(propertyPath: string): string;
  88680. /**
  88681. * Serialize this manager to a JSON object
  88682. * @param name defines the property name to store this manager
  88683. * @returns a JSON representation of this manager
  88684. */
  88685. serialize(name: string): any;
  88686. /**
  88687. * Creates a new ActionManager from a JSON data
  88688. * @param parsedActions defines the JSON data to read from
  88689. * @param object defines the hosting mesh
  88690. * @param scene defines the hosting scene
  88691. */
  88692. static Parse(parsedActions: any, object: Nullable<AbstractMesh>, scene: Scene): void;
  88693. /**
  88694. * Get a trigger name by index
  88695. * @param trigger defines the trigger index
  88696. * @returns a trigger name
  88697. */
  88698. static GetTriggerName(trigger: number): string;
  88699. }
  88700. }
  88701. declare module BABYLON {
  88702. /**
  88703. * Class used to represent a sprite
  88704. * @see https://doc.babylonjs.com/babylon101/sprites
  88705. */
  88706. export class Sprite implements IAnimatable {
  88707. /** defines the name */
  88708. name: string;
  88709. /** Gets or sets the current world position */
  88710. position: Vector3;
  88711. /** Gets or sets the main color */
  88712. color: Color4;
  88713. /** Gets or sets the width */
  88714. width: number;
  88715. /** Gets or sets the height */
  88716. height: number;
  88717. /** Gets or sets rotation angle */
  88718. angle: number;
  88719. /** Gets or sets the cell index in the sprite sheet */
  88720. cellIndex: number;
  88721. /** Gets or sets the cell reference in the sprite sheet, uses sprite's filename when added to sprite sheet */
  88722. cellRef: string;
  88723. /** Gets or sets a boolean indicating if UV coordinates should be inverted in U axis */
  88724. invertU: boolean;
  88725. /** Gets or sets a boolean indicating if UV coordinates should be inverted in B axis */
  88726. invertV: boolean;
  88727. /** Gets or sets a boolean indicating that this sprite should be disposed after animation ends */
  88728. disposeWhenFinishedAnimating: boolean;
  88729. /** Gets the list of attached animations */
  88730. animations: Nullable<Array<Animation>>;
  88731. /** Gets or sets a boolean indicating if the sprite can be picked */
  88732. isPickable: boolean;
  88733. /** Gets or sets a boolean indicating that sprite texture alpha will be used for precise picking (false by default) */
  88734. useAlphaForPicking: boolean;
  88735. /** @hidden */
  88736. _xOffset: number;
  88737. /** @hidden */
  88738. _yOffset: number;
  88739. /** @hidden */
  88740. _xSize: number;
  88741. /** @hidden */
  88742. _ySize: number;
  88743. /**
  88744. * Gets or sets the associated action manager
  88745. */
  88746. actionManager: Nullable<ActionManager>;
  88747. /**
  88748. * An event triggered when the control has been disposed
  88749. */
  88750. onDisposeObservable: Observable<Sprite>;
  88751. private _animationStarted;
  88752. private _loopAnimation;
  88753. private _fromIndex;
  88754. private _toIndex;
  88755. private _delay;
  88756. private _direction;
  88757. private _manager;
  88758. private _time;
  88759. private _onAnimationEnd;
  88760. /**
  88761. * Gets or sets a boolean indicating if the sprite is visible (renderable). Default is true
  88762. */
  88763. isVisible: boolean;
  88764. /**
  88765. * Gets or sets the sprite size
  88766. */
  88767. get size(): number;
  88768. set size(value: number);
  88769. /**
  88770. * Returns a boolean indicating if the animation is started
  88771. */
  88772. get animationStarted(): boolean;
  88773. /**
  88774. * Gets or sets the unique id of the sprite
  88775. */
  88776. uniqueId: number;
  88777. /**
  88778. * Gets the manager of this sprite
  88779. */
  88780. get manager(): ISpriteManager;
  88781. /**
  88782. * Creates a new Sprite
  88783. * @param name defines the name
  88784. * @param manager defines the manager
  88785. */
  88786. constructor(
  88787. /** defines the name */
  88788. name: string, manager: ISpriteManager);
  88789. /**
  88790. * Returns the string "Sprite"
  88791. * @returns "Sprite"
  88792. */
  88793. getClassName(): string;
  88794. /** Gets or sets the initial key for the animation (setting it will restart the animation) */
  88795. get fromIndex(): number;
  88796. set fromIndex(value: number);
  88797. /** Gets or sets the end key for the animation (setting it will restart the animation) */
  88798. get toIndex(): number;
  88799. set toIndex(value: number);
  88800. /** Gets or sets a boolean indicating if the animation is looping (setting it will restart the animation) */
  88801. get loopAnimation(): boolean;
  88802. set loopAnimation(value: boolean);
  88803. /** Gets or sets the delay between cell changes (setting it will restart the animation) */
  88804. get delay(): number;
  88805. set delay(value: number);
  88806. /**
  88807. * Starts an animation
  88808. * @param from defines the initial key
  88809. * @param to defines the end key
  88810. * @param loop defines if the animation must loop
  88811. * @param delay defines the start delay (in ms)
  88812. * @param onAnimationEnd defines a callback to call when animation ends
  88813. */
  88814. playAnimation(from: number, to: number, loop: boolean, delay: number, onAnimationEnd?: Nullable<() => void>): void;
  88815. /** Stops current animation (if any) */
  88816. stopAnimation(): void;
  88817. /** @hidden */
  88818. _animate(deltaTime: number): void;
  88819. /** Release associated resources */
  88820. dispose(): void;
  88821. /**
  88822. * Serializes the sprite to a JSON object
  88823. * @returns the JSON object
  88824. */
  88825. serialize(): any;
  88826. /**
  88827. * Parses a JSON object to create a new sprite
  88828. * @param parsedSprite The JSON object to parse
  88829. * @param manager defines the hosting manager
  88830. * @returns the new sprite
  88831. */
  88832. static Parse(parsedSprite: any, manager: SpriteManager): Sprite;
  88833. }
  88834. }
  88835. declare module BABYLON {
  88836. /**
  88837. * Information about the result of picking within a scene
  88838. * @see https://doc.babylonjs.com/babylon101/picking_collisions
  88839. */
  88840. export class PickingInfo {
  88841. /** @hidden */
  88842. _pickingUnavailable: boolean;
  88843. /**
  88844. * If the pick collided with an object
  88845. */
  88846. hit: boolean;
  88847. /**
  88848. * Distance away where the pick collided
  88849. */
  88850. distance: number;
  88851. /**
  88852. * The location of pick collision
  88853. */
  88854. pickedPoint: Nullable<Vector3>;
  88855. /**
  88856. * The mesh corresponding the the pick collision
  88857. */
  88858. pickedMesh: Nullable<AbstractMesh>;
  88859. /** (See getTextureCoordinates) The barycentric U coordinate that is used when calculating the texture coordinates of the collision.*/
  88860. bu: number;
  88861. /** (See getTextureCoordinates) The barycentric V coordinate that is used when calculating the texture coordinates of the collision.*/
  88862. bv: number;
  88863. /** The index of the face on the mesh that was picked, or the index of the Line if the picked Mesh is a LinesMesh */
  88864. faceId: number;
  88865. /** The index of the face on the subMesh that was picked, or the index of the Line if the picked Mesh is a LinesMesh */
  88866. subMeshFaceId: number;
  88867. /** Id of the the submesh that was picked */
  88868. subMeshId: number;
  88869. /** If a sprite was picked, this will be the sprite the pick collided with */
  88870. pickedSprite: Nullable<Sprite>;
  88871. /**
  88872. * If a mesh was used to do the picking (eg. 6dof controller) this will be populated.
  88873. */
  88874. originMesh: Nullable<AbstractMesh>;
  88875. /**
  88876. * The ray that was used to perform the picking.
  88877. */
  88878. ray: Nullable<Ray>;
  88879. /**
  88880. * Gets the normal correspodning to the face the pick collided with
  88881. * @param useWorldCoordinates If the resulting normal should be relative to the world (default: false)
  88882. * @param useVerticesNormals If the vertices normals should be used to calculate the normal instead of the normal map
  88883. * @returns The normal correspodning to the face the pick collided with
  88884. */
  88885. getNormal(useWorldCoordinates?: boolean, useVerticesNormals?: boolean): Nullable<Vector3>;
  88886. /**
  88887. * Gets the texture coordinates of where the pick occured
  88888. * @returns the vector containing the coordnates of the texture
  88889. */
  88890. getTextureCoordinates(): Nullable<Vector2>;
  88891. }
  88892. }
  88893. declare module BABYLON {
  88894. /**
  88895. * Class representing a ray with position and direction
  88896. */
  88897. export class Ray {
  88898. /** origin point */
  88899. origin: Vector3;
  88900. /** direction */
  88901. direction: Vector3;
  88902. /** length of the ray */
  88903. length: number;
  88904. private static readonly TmpVector3;
  88905. private _tmpRay;
  88906. /**
  88907. * Creates a new ray
  88908. * @param origin origin point
  88909. * @param direction direction
  88910. * @param length length of the ray
  88911. */
  88912. constructor(
  88913. /** origin point */
  88914. origin: Vector3,
  88915. /** direction */
  88916. direction: Vector3,
  88917. /** length of the ray */
  88918. length?: number);
  88919. /**
  88920. * Checks if the ray intersects a box
  88921. * This does not account for the ray lenght by design to improve perfs.
  88922. * @param minimum bound of the box
  88923. * @param maximum bound of the box
  88924. * @param intersectionTreshold extra extend to be added to the box in all direction
  88925. * @returns if the box was hit
  88926. */
  88927. intersectsBoxMinMax(minimum: DeepImmutable<Vector3>, maximum: DeepImmutable<Vector3>, intersectionTreshold?: number): boolean;
  88928. /**
  88929. * Checks if the ray intersects a box
  88930. * This does not account for the ray lenght by design to improve perfs.
  88931. * @param box the bounding box to check
  88932. * @param intersectionTreshold extra extend to be added to the BoundingBox in all direction
  88933. * @returns if the box was hit
  88934. */
  88935. intersectsBox(box: DeepImmutable<BoundingBox>, intersectionTreshold?: number): boolean;
  88936. /**
  88937. * If the ray hits a sphere
  88938. * @param sphere the bounding sphere to check
  88939. * @param intersectionTreshold extra extend to be added to the BoundingSphere in all direction
  88940. * @returns true if it hits the sphere
  88941. */
  88942. intersectsSphere(sphere: DeepImmutable<BoundingSphere>, intersectionTreshold?: number): boolean;
  88943. /**
  88944. * If the ray hits a triange
  88945. * @param vertex0 triangle vertex
  88946. * @param vertex1 triangle vertex
  88947. * @param vertex2 triangle vertex
  88948. * @returns intersection information if hit
  88949. */
  88950. intersectsTriangle(vertex0: DeepImmutable<Vector3>, vertex1: DeepImmutable<Vector3>, vertex2: DeepImmutable<Vector3>): Nullable<IntersectionInfo>;
  88951. /**
  88952. * Checks if ray intersects a plane
  88953. * @param plane the plane to check
  88954. * @returns the distance away it was hit
  88955. */
  88956. intersectsPlane(plane: DeepImmutable<Plane>): Nullable<number>;
  88957. /**
  88958. * Calculate the intercept of a ray on a given axis
  88959. * @param axis to check 'x' | 'y' | 'z'
  88960. * @param offset from axis interception (i.e. an offset of 1y is intercepted above ground)
  88961. * @returns a vector containing the coordinates where 'axis' is equal to zero (else offset), or null if there is no intercept.
  88962. */
  88963. intersectsAxis(axis: string, offset?: number): Nullable<Vector3>;
  88964. /**
  88965. * Checks if ray intersects a mesh
  88966. * @param mesh the mesh to check
  88967. * @param fastCheck defines if the first intersection will be used (and not the closest)
  88968. * @returns picking info of the intersecton
  88969. */
  88970. intersectsMesh(mesh: DeepImmutable<AbstractMesh>, fastCheck?: boolean): PickingInfo;
  88971. /**
  88972. * Checks if ray intersects a mesh
  88973. * @param meshes the meshes to check
  88974. * @param fastCheck defines if the first intersection will be used (and not the closest)
  88975. * @param results array to store result in
  88976. * @returns Array of picking infos
  88977. */
  88978. intersectsMeshes(meshes: Array<DeepImmutable<AbstractMesh>>, fastCheck?: boolean, results?: Array<PickingInfo>): Array<PickingInfo>;
  88979. private _comparePickingInfo;
  88980. private static smallnum;
  88981. private static rayl;
  88982. /**
  88983. * Intersection test between the ray and a given segment whithin a given tolerance (threshold)
  88984. * @param sega the first point of the segment to test the intersection against
  88985. * @param segb the second point of the segment to test the intersection against
  88986. * @param threshold the tolerance margin, if the ray doesn't intersect the segment but is close to the given threshold, the intersection is successful
  88987. * @return the distance from the ray origin to the intersection point if there's intersection, or -1 if there's no intersection
  88988. */
  88989. intersectionSegment(sega: DeepImmutable<Vector3>, segb: DeepImmutable<Vector3>, threshold: number): number;
  88990. /**
  88991. * Update the ray from viewport position
  88992. * @param x position
  88993. * @param y y position
  88994. * @param viewportWidth viewport width
  88995. * @param viewportHeight viewport height
  88996. * @param world world matrix
  88997. * @param view view matrix
  88998. * @param projection projection matrix
  88999. * @returns this ray updated
  89000. */
  89001. update(x: number, y: number, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Ray;
  89002. /**
  89003. * Creates a ray with origin and direction of 0,0,0
  89004. * @returns the new ray
  89005. */
  89006. static Zero(): Ray;
  89007. /**
  89008. * Creates a new ray from screen space and viewport
  89009. * @param x position
  89010. * @param y y position
  89011. * @param viewportWidth viewport width
  89012. * @param viewportHeight viewport height
  89013. * @param world world matrix
  89014. * @param view view matrix
  89015. * @param projection projection matrix
  89016. * @returns new ray
  89017. */
  89018. static CreateNew(x: number, y: number, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Ray;
  89019. /**
  89020. * 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
  89021. * transformed to the given world matrix.
  89022. * @param origin The origin point
  89023. * @param end The end point
  89024. * @param world a matrix to transform the ray to. Default is the identity matrix.
  89025. * @returns the new ray
  89026. */
  89027. static CreateNewFromTo(origin: Vector3, end: Vector3, world?: DeepImmutable<Matrix>): Ray;
  89028. /**
  89029. * Transforms a ray by a matrix
  89030. * @param ray ray to transform
  89031. * @param matrix matrix to apply
  89032. * @returns the resulting new ray
  89033. */
  89034. static Transform(ray: DeepImmutable<Ray>, matrix: DeepImmutable<Matrix>): Ray;
  89035. /**
  89036. * Transforms a ray by a matrix
  89037. * @param ray ray to transform
  89038. * @param matrix matrix to apply
  89039. * @param result ray to store result in
  89040. */
  89041. static TransformToRef(ray: DeepImmutable<Ray>, matrix: DeepImmutable<Matrix>, result: Ray): void;
  89042. /**
  89043. * Unproject a ray from screen space to object space
  89044. * @param sourceX defines the screen space x coordinate to use
  89045. * @param sourceY defines the screen space y coordinate to use
  89046. * @param viewportWidth defines the current width of the viewport
  89047. * @param viewportHeight defines the current height of the viewport
  89048. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  89049. * @param view defines the view matrix to use
  89050. * @param projection defines the projection matrix to use
  89051. */
  89052. unprojectRayToRef(sourceX: float, sourceY: float, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): void;
  89053. }
  89054. /**
  89055. * Type used to define predicate used to select faces when a mesh intersection is detected
  89056. */
  89057. export type TrianglePickingPredicate = (p0: Vector3, p1: Vector3, p2: Vector3, ray: Ray) => boolean;
  89058. interface Scene {
  89059. /** @hidden */
  89060. _tempPickingRay: Nullable<Ray>;
  89061. /** @hidden */
  89062. _cachedRayForTransform: Ray;
  89063. /** @hidden */
  89064. _pickWithRayInverseMatrix: Matrix;
  89065. /** @hidden */
  89066. _internalPick(rayFunction: (world: Matrix) => Ray, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, onlyBoundingInfo?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  89067. /** @hidden */
  89068. _internalMultiPick(rayFunction: (world: Matrix) => Ray, predicate?: (mesh: AbstractMesh) => boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  89069. }
  89070. }
  89071. declare module BABYLON {
  89072. /**
  89073. * Groups all the scene component constants in one place to ease maintenance.
  89074. * @hidden
  89075. */
  89076. export class SceneComponentConstants {
  89077. static readonly NAME_EFFECTLAYER: string;
  89078. static readonly NAME_LAYER: string;
  89079. static readonly NAME_LENSFLARESYSTEM: string;
  89080. static readonly NAME_BOUNDINGBOXRENDERER: string;
  89081. static readonly NAME_PARTICLESYSTEM: string;
  89082. static readonly NAME_GAMEPAD: string;
  89083. static readonly NAME_SIMPLIFICATIONQUEUE: string;
  89084. static readonly NAME_GEOMETRYBUFFERRENDERER: string;
  89085. static readonly NAME_PREPASSRENDERER: string;
  89086. static readonly NAME_DEPTHRENDERER: string;
  89087. static readonly NAME_POSTPROCESSRENDERPIPELINEMANAGER: string;
  89088. static readonly NAME_SPRITE: string;
  89089. static readonly NAME_OUTLINERENDERER: string;
  89090. static readonly NAME_PROCEDURALTEXTURE: string;
  89091. static readonly NAME_SHADOWGENERATOR: string;
  89092. static readonly NAME_OCTREE: string;
  89093. static readonly NAME_PHYSICSENGINE: string;
  89094. static readonly NAME_AUDIO: string;
  89095. static readonly STEP_ISREADYFORMESH_EFFECTLAYER: number;
  89096. static readonly STEP_BEFOREEVALUATEACTIVEMESH_BOUNDINGBOXRENDERER: number;
  89097. static readonly STEP_EVALUATESUBMESH_BOUNDINGBOXRENDERER: number;
  89098. static readonly STEP_ACTIVEMESH_BOUNDINGBOXRENDERER: number;
  89099. static readonly STEP_CAMERADRAWRENDERTARGET_EFFECTLAYER: number;
  89100. static readonly STEP_BEFORECAMERADRAW_EFFECTLAYER: number;
  89101. static readonly STEP_BEFORECAMERADRAW_LAYER: number;
  89102. static readonly STEP_BEFORECAMERADRAW_PREPASS: number;
  89103. static readonly STEP_BEFORERENDERTARGETDRAW_LAYER: number;
  89104. static readonly STEP_BEFORERENDERINGMESH_OUTLINE: number;
  89105. static readonly STEP_AFTERRENDERINGMESH_OUTLINE: number;
  89106. static readonly STEP_AFTERRENDERINGGROUPDRAW_EFFECTLAYER_DRAW: number;
  89107. static readonly STEP_AFTERRENDERINGGROUPDRAW_BOUNDINGBOXRENDERER: number;
  89108. static readonly STEP_BEFORECAMERAUPDATE_SIMPLIFICATIONQUEUE: number;
  89109. static readonly STEP_BEFORECAMERAUPDATE_GAMEPAD: number;
  89110. static readonly STEP_BEFORECLEAR_PROCEDURALTEXTURE: number;
  89111. static readonly STEP_AFTERRENDERTARGETDRAW_LAYER: number;
  89112. static readonly STEP_AFTERCAMERADRAW_EFFECTLAYER: number;
  89113. static readonly STEP_AFTERCAMERADRAW_LENSFLARESYSTEM: number;
  89114. static readonly STEP_AFTERCAMERADRAW_EFFECTLAYER_DRAW: number;
  89115. static readonly STEP_AFTERCAMERADRAW_LAYER: number;
  89116. static readonly STEP_AFTERCAMERADRAW_PREPASS: number;
  89117. static readonly STEP_AFTERRENDER_AUDIO: number;
  89118. static readonly STEP_GATHERRENDERTARGETS_DEPTHRENDERER: number;
  89119. static readonly STEP_GATHERRENDERTARGETS_GEOMETRYBUFFERRENDERER: number;
  89120. static readonly STEP_GATHERRENDERTARGETS_SHADOWGENERATOR: number;
  89121. static readonly STEP_GATHERRENDERTARGETS_POSTPROCESSRENDERPIPELINEMANAGER: number;
  89122. static readonly STEP_GATHERACTIVECAMERARENDERTARGETS_DEPTHRENDERER: number;
  89123. static readonly STEP_BEFORECLEARSTAGE_PREPASS: number;
  89124. static readonly STEP_POINTERMOVE_SPRITE: number;
  89125. static readonly STEP_POINTERDOWN_SPRITE: number;
  89126. static readonly STEP_POINTERUP_SPRITE: number;
  89127. }
  89128. /**
  89129. * This represents a scene component.
  89130. *
  89131. * This is used to decouple the dependency the scene is having on the different workloads like
  89132. * layers, post processes...
  89133. */
  89134. export interface ISceneComponent {
  89135. /**
  89136. * The name of the component. Each component must have a unique name.
  89137. */
  89138. name: string;
  89139. /**
  89140. * The scene the component belongs to.
  89141. */
  89142. scene: Scene;
  89143. /**
  89144. * Register the component to one instance of a scene.
  89145. */
  89146. register(): void;
  89147. /**
  89148. * Rebuilds the elements related to this component in case of
  89149. * context lost for instance.
  89150. */
  89151. rebuild(): void;
  89152. /**
  89153. * Disposes the component and the associated ressources.
  89154. */
  89155. dispose(): void;
  89156. }
  89157. /**
  89158. * This represents a SERIALIZABLE scene component.
  89159. *
  89160. * This extends Scene Component to add Serialization methods on top.
  89161. */
  89162. export interface ISceneSerializableComponent extends ISceneComponent {
  89163. /**
  89164. * Adds all the elements from the container to the scene
  89165. * @param container the container holding the elements
  89166. */
  89167. addFromContainer(container: AbstractScene): void;
  89168. /**
  89169. * Removes all the elements in the container from the scene
  89170. * @param container contains the elements to remove
  89171. * @param dispose if the removed element should be disposed (default: false)
  89172. */
  89173. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  89174. /**
  89175. * Serializes the component data to the specified json object
  89176. * @param serializationObject The object to serialize to
  89177. */
  89178. serialize(serializationObject: any): void;
  89179. }
  89180. /**
  89181. * Strong typing of a Mesh related stage step action
  89182. */
  89183. export type MeshStageAction = (mesh: AbstractMesh, hardwareInstancedRendering: boolean) => boolean;
  89184. /**
  89185. * Strong typing of a Evaluate Sub Mesh related stage step action
  89186. */
  89187. export type EvaluateSubMeshStageAction = (mesh: AbstractMesh, subMesh: SubMesh) => void;
  89188. /**
  89189. * Strong typing of a Active Mesh related stage step action
  89190. */
  89191. export type ActiveMeshStageAction = (sourceMesh: AbstractMesh, mesh: AbstractMesh) => void;
  89192. /**
  89193. * Strong typing of a Camera related stage step action
  89194. */
  89195. export type CameraStageAction = (camera: Camera) => void;
  89196. /**
  89197. * Strong typing of a Camera Frame buffer related stage step action
  89198. */
  89199. export type CameraStageFrameBufferAction = (camera: Camera) => boolean;
  89200. /**
  89201. * Strong typing of a Render Target related stage step action
  89202. */
  89203. export type RenderTargetStageAction = (renderTarget: RenderTargetTexture) => void;
  89204. /**
  89205. * Strong typing of a RenderingGroup related stage step action
  89206. */
  89207. export type RenderingGroupStageAction = (renderingGroupId: number) => void;
  89208. /**
  89209. * Strong typing of a Mesh Render related stage step action
  89210. */
  89211. export type RenderingMeshStageAction = (mesh: Mesh, subMesh: SubMesh, batch: _InstancesBatch) => void;
  89212. /**
  89213. * Strong typing of a simple stage step action
  89214. */
  89215. export type SimpleStageAction = () => void;
  89216. /**
  89217. * Strong typing of a render target action.
  89218. */
  89219. export type RenderTargetsStageAction = (renderTargets: SmartArrayNoDuplicate<RenderTargetTexture>) => void;
  89220. /**
  89221. * Strong typing of a pointer move action.
  89222. */
  89223. export type PointerMoveStageAction = (unTranslatedPointerX: number, unTranslatedPointerY: number, pickResult: Nullable<PickingInfo>, isMeshPicked: boolean, element: HTMLElement) => Nullable<PickingInfo>;
  89224. /**
  89225. * Strong typing of a pointer up/down action.
  89226. */
  89227. export type PointerUpDownStageAction = (unTranslatedPointerX: number, unTranslatedPointerY: number, pickResult: Nullable<PickingInfo>, evt: PointerEvent) => Nullable<PickingInfo>;
  89228. /**
  89229. * Representation of a stage in the scene (Basically a list of ordered steps)
  89230. * @hidden
  89231. */
  89232. export class Stage<T extends Function> extends Array<{
  89233. index: number;
  89234. component: ISceneComponent;
  89235. action: T;
  89236. }> {
  89237. /**
  89238. * Hide ctor from the rest of the world.
  89239. * @param items The items to add.
  89240. */
  89241. private constructor();
  89242. /**
  89243. * Creates a new Stage.
  89244. * @returns A new instance of a Stage
  89245. */
  89246. static Create<T extends Function>(): Stage<T>;
  89247. /**
  89248. * Registers a step in an ordered way in the targeted stage.
  89249. * @param index Defines the position to register the step in
  89250. * @param component Defines the component attached to the step
  89251. * @param action Defines the action to launch during the step
  89252. */
  89253. registerStep(index: number, component: ISceneComponent, action: T): void;
  89254. /**
  89255. * Clears all the steps from the stage.
  89256. */
  89257. clear(): void;
  89258. }
  89259. }
  89260. declare module BABYLON {
  89261. interface Scene {
  89262. /** @hidden */
  89263. _pointerOverSprite: Nullable<Sprite>;
  89264. /** @hidden */
  89265. _pickedDownSprite: Nullable<Sprite>;
  89266. /** @hidden */
  89267. _tempSpritePickingRay: Nullable<Ray>;
  89268. /**
  89269. * All of the sprite managers added to this scene
  89270. * @see https://doc.babylonjs.com/babylon101/sprites
  89271. */
  89272. spriteManagers: Array<ISpriteManager>;
  89273. /**
  89274. * An event triggered when sprites rendering is about to start
  89275. * Note: This event can be trigger more than once per frame (because sprites can be rendered by render target textures as well)
  89276. */
  89277. onBeforeSpritesRenderingObservable: Observable<Scene>;
  89278. /**
  89279. * An event triggered when sprites rendering is done
  89280. * Note: This event can be trigger more than once per frame (because sprites can be rendered by render target textures as well)
  89281. */
  89282. onAfterSpritesRenderingObservable: Observable<Scene>;
  89283. /** @hidden */
  89284. _internalPickSprites(ray: Ray, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  89285. /** Launch a ray to try to pick a sprite in the scene
  89286. * @param x position on screen
  89287. * @param y position on screen
  89288. * @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
  89289. * @param fastCheck defines if the first intersection will be used (and not the closest)
  89290. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  89291. * @returns a PickingInfo
  89292. */
  89293. pickSprite(x: number, y: number, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  89294. /** Use the given ray to pick a sprite in the scene
  89295. * @param ray The ray (in world space) to use to pick meshes
  89296. * @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
  89297. * @param fastCheck defines if the first intersection will be used (and not the closest)
  89298. * @param camera camera to use. Can be set to null. In this case, the scene.activeCamera will be used
  89299. * @returns a PickingInfo
  89300. */
  89301. pickSpriteWithRay(ray: Ray, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  89302. /** @hidden */
  89303. _internalMultiPickSprites(ray: Ray, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  89304. /** Launch a ray to try to pick sprites in the scene
  89305. * @param x position on screen
  89306. * @param y position on screen
  89307. * @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
  89308. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  89309. * @returns a PickingInfo array
  89310. */
  89311. multiPickSprite(x: number, y: number, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  89312. /** Use the given ray to pick sprites in the scene
  89313. * @param ray The ray (in world space) to use to pick meshes
  89314. * @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
  89315. * @param camera camera to use. Can be set to null. In this case, the scene.activeCamera will be used
  89316. * @returns a PickingInfo array
  89317. */
  89318. multiPickSpriteWithRay(ray: Ray, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  89319. /**
  89320. * Force the sprite under the pointer
  89321. * @param sprite defines the sprite to use
  89322. */
  89323. setPointerOverSprite(sprite: Nullable<Sprite>): void;
  89324. /**
  89325. * Gets the sprite under the pointer
  89326. * @returns a Sprite or null if no sprite is under the pointer
  89327. */
  89328. getPointerOverSprite(): Nullable<Sprite>;
  89329. }
  89330. /**
  89331. * Defines the sprite scene component responsible to manage sprites
  89332. * in a given scene.
  89333. */
  89334. export class SpriteSceneComponent implements ISceneComponent {
  89335. /**
  89336. * The component name helpfull to identify the component in the list of scene components.
  89337. */
  89338. readonly name: string;
  89339. /**
  89340. * The scene the component belongs to.
  89341. */
  89342. scene: Scene;
  89343. /** @hidden */
  89344. private _spritePredicate;
  89345. /**
  89346. * Creates a new instance of the component for the given scene
  89347. * @param scene Defines the scene to register the component in
  89348. */
  89349. constructor(scene: Scene);
  89350. /**
  89351. * Registers the component in a given scene
  89352. */
  89353. register(): void;
  89354. /**
  89355. * Rebuilds the elements related to this component in case of
  89356. * context lost for instance.
  89357. */
  89358. rebuild(): void;
  89359. /**
  89360. * Disposes the component and the associated ressources.
  89361. */
  89362. dispose(): void;
  89363. private _pickSpriteButKeepRay;
  89364. private _pointerMove;
  89365. private _pointerDown;
  89366. private _pointerUp;
  89367. }
  89368. }
  89369. declare module BABYLON {
  89370. /** @hidden */
  89371. export var fogFragmentDeclaration: {
  89372. name: string;
  89373. shader: string;
  89374. };
  89375. }
  89376. declare module BABYLON {
  89377. /** @hidden */
  89378. export var fogFragment: {
  89379. name: string;
  89380. shader: string;
  89381. };
  89382. }
  89383. declare module BABYLON {
  89384. /** @hidden */
  89385. export var spritesPixelShader: {
  89386. name: string;
  89387. shader: string;
  89388. };
  89389. }
  89390. declare module BABYLON {
  89391. /** @hidden */
  89392. export var fogVertexDeclaration: {
  89393. name: string;
  89394. shader: string;
  89395. };
  89396. }
  89397. declare module BABYLON {
  89398. /** @hidden */
  89399. export var spritesVertexShader: {
  89400. name: string;
  89401. shader: string;
  89402. };
  89403. }
  89404. declare module BABYLON {
  89405. /**
  89406. * Defines the minimum interface to fullfil in order to be a sprite manager.
  89407. */
  89408. export interface ISpriteManager extends IDisposable {
  89409. /**
  89410. * Gets manager's name
  89411. */
  89412. name: string;
  89413. /**
  89414. * Restricts the camera to viewing objects with the same layerMask.
  89415. * A camera with a layerMask of 1 will render spriteManager.layerMask & camera.layerMask!== 0
  89416. */
  89417. layerMask: number;
  89418. /**
  89419. * Gets or sets a boolean indicating if the mesh can be picked (by scene.pick for instance or through actions). Default is true
  89420. */
  89421. isPickable: boolean;
  89422. /**
  89423. * Gets the hosting scene
  89424. */
  89425. scene: Scene;
  89426. /**
  89427. * Specifies the rendering group id for this mesh (0 by default)
  89428. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#rendering-groups
  89429. */
  89430. renderingGroupId: number;
  89431. /**
  89432. * Defines the list of sprites managed by the manager.
  89433. */
  89434. sprites: Array<Sprite>;
  89435. /**
  89436. * Gets or sets the spritesheet texture
  89437. */
  89438. texture: Texture;
  89439. /** Defines the default width of a cell in the spritesheet */
  89440. cellWidth: number;
  89441. /** Defines the default height of a cell in the spritesheet */
  89442. cellHeight: number;
  89443. /**
  89444. * Tests the intersection of a sprite with a specific ray.
  89445. * @param ray The ray we are sending to test the collision
  89446. * @param camera The camera space we are sending rays in
  89447. * @param predicate A predicate allowing excluding sprites from the list of object to test
  89448. * @param fastCheck defines if the first intersection will be used (and not the closest)
  89449. * @returns picking info or null.
  89450. */
  89451. intersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean): Nullable<PickingInfo>;
  89452. /**
  89453. * Intersects the sprites with a ray
  89454. * @param ray defines the ray to intersect with
  89455. * @param camera defines the current active camera
  89456. * @param predicate defines a predicate used to select candidate sprites
  89457. * @returns null if no hit or a PickingInfo array
  89458. */
  89459. multiIntersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean): Nullable<PickingInfo[]>;
  89460. /**
  89461. * Renders the list of sprites on screen.
  89462. */
  89463. render(): void;
  89464. }
  89465. /**
  89466. * Class used to manage multiple sprites on the same spritesheet
  89467. * @see https://doc.babylonjs.com/babylon101/sprites
  89468. */
  89469. export class SpriteManager implements ISpriteManager {
  89470. /** defines the manager's name */
  89471. name: string;
  89472. /** Define the Url to load snippets */
  89473. static SnippetUrl: string;
  89474. /** Snippet ID if the manager was created from the snippet server */
  89475. snippetId: string;
  89476. /** Gets the list of sprites */
  89477. sprites: Sprite[];
  89478. /** Gets or sets the rendering group id (0 by default) */
  89479. renderingGroupId: number;
  89480. /** Gets or sets camera layer mask */
  89481. layerMask: number;
  89482. /** Gets or sets a boolean indicating if the manager must consider scene fog when rendering */
  89483. fogEnabled: boolean;
  89484. /** Gets or sets a boolean indicating if the sprites are pickable */
  89485. isPickable: boolean;
  89486. /** Defines the default width of a cell in the spritesheet */
  89487. cellWidth: number;
  89488. /** Defines the default height of a cell in the spritesheet */
  89489. cellHeight: number;
  89490. /** Associative array from JSON sprite data file */
  89491. private _cellData;
  89492. /** Array of sprite names from JSON sprite data file */
  89493. private _spriteMap;
  89494. /** True when packed cell data from JSON file is ready*/
  89495. private _packedAndReady;
  89496. private _textureContent;
  89497. /**
  89498. * An event triggered when the manager is disposed.
  89499. */
  89500. onDisposeObservable: Observable<SpriteManager>;
  89501. private _onDisposeObserver;
  89502. /**
  89503. * Callback called when the manager is disposed
  89504. */
  89505. set onDispose(callback: () => void);
  89506. private _capacity;
  89507. private _fromPacked;
  89508. private _spriteTexture;
  89509. private _epsilon;
  89510. private _scene;
  89511. private _vertexData;
  89512. private _buffer;
  89513. private _vertexBuffers;
  89514. private _indexBuffer;
  89515. private _effectBase;
  89516. private _effectFog;
  89517. /**
  89518. * Gets or sets the unique id of the sprite
  89519. */
  89520. uniqueId: number;
  89521. /**
  89522. * Gets the array of sprites
  89523. */
  89524. get children(): Sprite[];
  89525. /**
  89526. * Gets the hosting scene
  89527. */
  89528. get scene(): Scene;
  89529. /**
  89530. * Gets the capacity of the manager
  89531. */
  89532. get capacity(): number;
  89533. /**
  89534. * Gets or sets the spritesheet texture
  89535. */
  89536. get texture(): Texture;
  89537. set texture(value: Texture);
  89538. private _blendMode;
  89539. /**
  89540. * Blend mode use to render the particle, it can be any of
  89541. * the static Constants.ALPHA_x properties provided in this class.
  89542. * Default value is Constants.ALPHA_COMBINE
  89543. */
  89544. get blendMode(): number;
  89545. set blendMode(blendMode: number);
  89546. /** Disables writing to the depth buffer when rendering the sprites.
  89547. * It can be handy to disable depth writing when using textures without alpha channel
  89548. * and setting some specific blend modes.
  89549. */
  89550. disableDepthWrite: boolean;
  89551. /**
  89552. * Creates a new sprite manager
  89553. * @param name defines the manager's name
  89554. * @param imgUrl defines the sprite sheet url
  89555. * @param capacity defines the maximum allowed number of sprites
  89556. * @param cellSize defines the size of a sprite cell
  89557. * @param scene defines the hosting scene
  89558. * @param epsilon defines the epsilon value to align texture (0.01 by default)
  89559. * @param samplingMode defines the smapling mode to use with spritesheet
  89560. * @param fromPacked set to false; do not alter
  89561. * @param spriteJSON null otherwise a JSON object defining sprite sheet data; do not alter
  89562. */
  89563. constructor(
  89564. /** defines the manager's name */
  89565. name: string, imgUrl: string, capacity: number, cellSize: any, scene: Scene, epsilon?: number, samplingMode?: number, fromPacked?: boolean, spriteJSON?: any | null);
  89566. /**
  89567. * Returns the string "SpriteManager"
  89568. * @returns "SpriteManager"
  89569. */
  89570. getClassName(): string;
  89571. private _makePacked;
  89572. private _appendSpriteVertex;
  89573. private _checkTextureAlpha;
  89574. /**
  89575. * Intersects the sprites with a ray
  89576. * @param ray defines the ray to intersect with
  89577. * @param camera defines the current active camera
  89578. * @param predicate defines a predicate used to select candidate sprites
  89579. * @param fastCheck defines if a fast check only must be done (the first potential sprite is will be used and not the closer)
  89580. * @returns null if no hit or a PickingInfo
  89581. */
  89582. intersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean): Nullable<PickingInfo>;
  89583. /**
  89584. * Intersects the sprites with a ray
  89585. * @param ray defines the ray to intersect with
  89586. * @param camera defines the current active camera
  89587. * @param predicate defines a predicate used to select candidate sprites
  89588. * @returns null if no hit or a PickingInfo array
  89589. */
  89590. multiIntersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean): Nullable<PickingInfo[]>;
  89591. /**
  89592. * Render all child sprites
  89593. */
  89594. render(): void;
  89595. /**
  89596. * Release associated resources
  89597. */
  89598. dispose(): void;
  89599. /**
  89600. * Serializes the sprite manager to a JSON object
  89601. * @param serializeTexture defines if the texture must be serialized as well
  89602. * @returns the JSON object
  89603. */
  89604. serialize(serializeTexture?: boolean): any;
  89605. /**
  89606. * Parses a JSON object to create a new sprite manager.
  89607. * @param parsedManager The JSON object to parse
  89608. * @param scene The scene to create the sprite managerin
  89609. * @param rootUrl The root url to use to load external dependencies like texture
  89610. * @returns the new sprite manager
  89611. */
  89612. static Parse(parsedManager: any, scene: Scene, rootUrl: string): SpriteManager;
  89613. /**
  89614. * Creates a sprite manager from a snippet saved in a remote file
  89615. * @param name defines the name of the sprite manager to create (can be null or empty to use the one from the json data)
  89616. * @param url defines the url to load from
  89617. * @param scene defines the hosting scene
  89618. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  89619. * @returns a promise that will resolve to the new sprite manager
  89620. */
  89621. static ParseFromFileAsync(name: Nullable<string>, url: string, scene: Scene, rootUrl?: string): Promise<SpriteManager>;
  89622. /**
  89623. * Creates a sprite manager from a snippet saved by the sprite editor
  89624. * @param snippetId defines the snippet to load (can be set to _BLANK to create a default one)
  89625. * @param scene defines the hosting scene
  89626. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  89627. * @returns a promise that will resolve to the new sprite manager
  89628. */
  89629. static CreateFromSnippetAsync(snippetId: string, scene: Scene, rootUrl?: string): Promise<SpriteManager>;
  89630. }
  89631. }
  89632. declare module BABYLON {
  89633. /** Interface used by value gradients (color, factor, ...) */
  89634. export interface IValueGradient {
  89635. /**
  89636. * Gets or sets the gradient value (between 0 and 1)
  89637. */
  89638. gradient: number;
  89639. }
  89640. /** Class used to store color4 gradient */
  89641. export class ColorGradient implements IValueGradient {
  89642. /**
  89643. * Gets or sets the gradient value (between 0 and 1)
  89644. */
  89645. gradient: number;
  89646. /**
  89647. * Gets or sets first associated color
  89648. */
  89649. color1: Color4;
  89650. /**
  89651. * Gets or sets second associated color
  89652. */
  89653. color2?: Color4 | undefined;
  89654. /**
  89655. * Creates a new color4 gradient
  89656. * @param gradient gets or sets the gradient value (between 0 and 1)
  89657. * @param color1 gets or sets first associated color
  89658. * @param color2 gets or sets first second color
  89659. */
  89660. constructor(
  89661. /**
  89662. * Gets or sets the gradient value (between 0 and 1)
  89663. */
  89664. gradient: number,
  89665. /**
  89666. * Gets or sets first associated color
  89667. */
  89668. color1: Color4,
  89669. /**
  89670. * Gets or sets second associated color
  89671. */
  89672. color2?: Color4 | undefined);
  89673. /**
  89674. * Will get a color picked randomly between color1 and color2.
  89675. * If color2 is undefined then color1 will be used
  89676. * @param result defines the target Color4 to store the result in
  89677. */
  89678. getColorToRef(result: Color4): void;
  89679. }
  89680. /** Class used to store color 3 gradient */
  89681. export class Color3Gradient implements IValueGradient {
  89682. /**
  89683. * Gets or sets the gradient value (between 0 and 1)
  89684. */
  89685. gradient: number;
  89686. /**
  89687. * Gets or sets the associated color
  89688. */
  89689. color: Color3;
  89690. /**
  89691. * Creates a new color3 gradient
  89692. * @param gradient gets or sets the gradient value (between 0 and 1)
  89693. * @param color gets or sets associated color
  89694. */
  89695. constructor(
  89696. /**
  89697. * Gets or sets the gradient value (between 0 and 1)
  89698. */
  89699. gradient: number,
  89700. /**
  89701. * Gets or sets the associated color
  89702. */
  89703. color: Color3);
  89704. }
  89705. /** Class used to store factor gradient */
  89706. export class FactorGradient implements IValueGradient {
  89707. /**
  89708. * Gets or sets the gradient value (between 0 and 1)
  89709. */
  89710. gradient: number;
  89711. /**
  89712. * Gets or sets first associated factor
  89713. */
  89714. factor1: number;
  89715. /**
  89716. * Gets or sets second associated factor
  89717. */
  89718. factor2?: number | undefined;
  89719. /**
  89720. * Creates a new factor gradient
  89721. * @param gradient gets or sets the gradient value (between 0 and 1)
  89722. * @param factor1 gets or sets first associated factor
  89723. * @param factor2 gets or sets second associated factor
  89724. */
  89725. constructor(
  89726. /**
  89727. * Gets or sets the gradient value (between 0 and 1)
  89728. */
  89729. gradient: number,
  89730. /**
  89731. * Gets or sets first associated factor
  89732. */
  89733. factor1: number,
  89734. /**
  89735. * Gets or sets second associated factor
  89736. */
  89737. factor2?: number | undefined);
  89738. /**
  89739. * Will get a number picked randomly between factor1 and factor2.
  89740. * If factor2 is undefined then factor1 will be used
  89741. * @returns the picked number
  89742. */
  89743. getFactor(): number;
  89744. }
  89745. /**
  89746. * Helper used to simplify some generic gradient tasks
  89747. */
  89748. export class GradientHelper {
  89749. /**
  89750. * Gets the current gradient from an array of IValueGradient
  89751. * @param ratio defines the current ratio to get
  89752. * @param gradients defines the array of IValueGradient
  89753. * @param updateFunc defines the callback function used to get the final value from the selected gradients
  89754. */
  89755. static GetCurrentGradient(ratio: number, gradients: IValueGradient[], updateFunc: (current: IValueGradient, next: IValueGradient, scale: number) => void): void;
  89756. }
  89757. }
  89758. declare module BABYLON {
  89759. interface ThinEngine {
  89760. /**
  89761. * Creates a raw texture
  89762. * @param data defines the data to store in the texture
  89763. * @param width defines the width of the texture
  89764. * @param height defines the height of the texture
  89765. * @param format defines the format of the data
  89766. * @param generateMipMaps defines if the engine should generate the mip levels
  89767. * @param invertY defines if data must be stored with Y axis inverted
  89768. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  89769. * @param compression defines the compression used (null by default)
  89770. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  89771. * @returns the raw texture inside an InternalTexture
  89772. */
  89773. createRawTexture(data: Nullable<ArrayBufferView>, width: number, height: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, type: number): InternalTexture;
  89774. /**
  89775. * Update a raw texture
  89776. * @param texture defines the texture to update
  89777. * @param data defines the data to store in the texture
  89778. * @param format defines the format of the data
  89779. * @param invertY defines if data must be stored with Y axis inverted
  89780. */
  89781. updateRawTexture(texture: Nullable<InternalTexture>, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  89782. /**
  89783. * Update a raw texture
  89784. * @param texture defines the texture to update
  89785. * @param data defines the data to store in the texture
  89786. * @param format defines the format of the data
  89787. * @param invertY defines if data must be stored with Y axis inverted
  89788. * @param compression defines the compression used (null by default)
  89789. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  89790. */
  89791. updateRawTexture(texture: Nullable<InternalTexture>, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, type: number): void;
  89792. /**
  89793. * Creates a new raw cube texture
  89794. * @param data defines the array of data to use to create each face
  89795. * @param size defines the size of the textures
  89796. * @param format defines the format of the data
  89797. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  89798. * @param generateMipMaps defines if the engine should generate the mip levels
  89799. * @param invertY defines if data must be stored with Y axis inverted
  89800. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  89801. * @param compression defines the compression used (null by default)
  89802. * @returns the cube texture as an InternalTexture
  89803. */
  89804. createRawCubeTexture(data: Nullable<ArrayBufferView[]>, size: number, format: number, type: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>): InternalTexture;
  89805. /**
  89806. * Update a raw cube texture
  89807. * @param texture defines the texture to udpdate
  89808. * @param data defines the data to store
  89809. * @param format defines the data format
  89810. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  89811. * @param invertY defines if data must be stored with Y axis inverted
  89812. */
  89813. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean): void;
  89814. /**
  89815. * Update a raw cube texture
  89816. * @param texture defines the texture to udpdate
  89817. * @param data defines the data to store
  89818. * @param format defines the data format
  89819. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  89820. * @param invertY defines if data must be stored with Y axis inverted
  89821. * @param compression defines the compression used (null by default)
  89822. */
  89823. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression: Nullable<string>): void;
  89824. /**
  89825. * Update a raw cube texture
  89826. * @param texture defines the texture to udpdate
  89827. * @param data defines the data to store
  89828. * @param format defines the data format
  89829. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  89830. * @param invertY defines if data must be stored with Y axis inverted
  89831. * @param compression defines the compression used (null by default)
  89832. * @param level defines which level of the texture to update
  89833. */
  89834. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression: Nullable<string>, level: number): void;
  89835. /**
  89836. * Creates a new raw cube texture from a specified url
  89837. * @param url defines the url where the data is located
  89838. * @param scene defines the current scene
  89839. * @param size defines the size of the textures
  89840. * @param format defines the format of the data
  89841. * @param type defines the type fo the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  89842. * @param noMipmap defines if the engine should avoid generating the mip levels
  89843. * @param callback defines a callback used to extract texture data from loaded data
  89844. * @param mipmapGenerator defines to provide an optional tool to generate mip levels
  89845. * @param onLoad defines a callback called when texture is loaded
  89846. * @param onError defines a callback called if there is an error
  89847. * @returns the cube texture as an InternalTexture
  89848. */
  89849. 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;
  89850. /**
  89851. * Creates a new raw cube texture from a specified url
  89852. * @param url defines the url where the data is located
  89853. * @param scene defines the current scene
  89854. * @param size defines the size of the textures
  89855. * @param format defines the format of the data
  89856. * @param type defines the type fo the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  89857. * @param noMipmap defines if the engine should avoid generating the mip levels
  89858. * @param callback defines a callback used to extract texture data from loaded data
  89859. * @param mipmapGenerator defines to provide an optional tool to generate mip levels
  89860. * @param onLoad defines a callback called when texture is loaded
  89861. * @param onError defines a callback called if there is an error
  89862. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  89863. * @param invertY defines if data must be stored with Y axis inverted
  89864. * @returns the cube texture as an InternalTexture
  89865. */
  89866. 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;
  89867. /**
  89868. * Creates a new raw 3D texture
  89869. * @param data defines the data used to create the texture
  89870. * @param width defines the width of the texture
  89871. * @param height defines the height of the texture
  89872. * @param depth defines the depth of the texture
  89873. * @param format defines the format of the texture
  89874. * @param generateMipMaps defines if the engine must generate mip levels
  89875. * @param invertY defines if data must be stored with Y axis inverted
  89876. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  89877. * @param compression defines the compressed used (can be null)
  89878. * @param textureType defines the compressed used (can be null)
  89879. * @returns a new raw 3D texture (stored in an InternalTexture)
  89880. */
  89881. createRawTexture3D(data: Nullable<ArrayBufferView>, width: number, height: number, depth: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, textureType: number): InternalTexture;
  89882. /**
  89883. * Update a raw 3D texture
  89884. * @param texture defines the texture to update
  89885. * @param data defines the data to store
  89886. * @param format defines the data format
  89887. * @param invertY defines if data must be stored with Y axis inverted
  89888. */
  89889. updateRawTexture3D(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  89890. /**
  89891. * Update a raw 3D texture
  89892. * @param texture defines the texture to update
  89893. * @param data defines the data to store
  89894. * @param format defines the data format
  89895. * @param invertY defines if data must be stored with Y axis inverted
  89896. * @param compression defines the used compression (can be null)
  89897. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  89898. */
  89899. updateRawTexture3D(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, textureType: number): void;
  89900. /**
  89901. * Creates a new raw 2D array texture
  89902. * @param data defines the data used to create the texture
  89903. * @param width defines the width of the texture
  89904. * @param height defines the height of the texture
  89905. * @param depth defines the number of layers of the texture
  89906. * @param format defines the format of the texture
  89907. * @param generateMipMaps defines if the engine must generate mip levels
  89908. * @param invertY defines if data must be stored with Y axis inverted
  89909. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  89910. * @param compression defines the compressed used (can be null)
  89911. * @param textureType defines the compressed used (can be null)
  89912. * @returns a new raw 2D array texture (stored in an InternalTexture)
  89913. */
  89914. createRawTexture2DArray(data: Nullable<ArrayBufferView>, width: number, height: number, depth: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, textureType: number): InternalTexture;
  89915. /**
  89916. * Update a raw 2D array texture
  89917. * @param texture defines the texture to update
  89918. * @param data defines the data to store
  89919. * @param format defines the data format
  89920. * @param invertY defines if data must be stored with Y axis inverted
  89921. */
  89922. updateRawTexture2DArray(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  89923. /**
  89924. * Update a raw 2D array texture
  89925. * @param texture defines the texture to update
  89926. * @param data defines the data to store
  89927. * @param format defines the data format
  89928. * @param invertY defines if data must be stored with Y axis inverted
  89929. * @param compression defines the used compression (can be null)
  89930. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  89931. */
  89932. updateRawTexture2DArray(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, textureType: number): void;
  89933. }
  89934. }
  89935. declare module BABYLON {
  89936. /**
  89937. * Raw texture can help creating a texture directly from an array of data.
  89938. * This can be super useful if you either get the data from an uncompressed source or
  89939. * if you wish to create your texture pixel by pixel.
  89940. */
  89941. export class RawTexture extends Texture {
  89942. /**
  89943. * Define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  89944. */
  89945. format: number;
  89946. /**
  89947. * Instantiates a new RawTexture.
  89948. * Raw texture can help creating a texture directly from an array of data.
  89949. * This can be super useful if you either get the data from an uncompressed source or
  89950. * if you wish to create your texture pixel by pixel.
  89951. * @param data define the array of data to use to create the texture
  89952. * @param width define the width of the texture
  89953. * @param height define the height of the texture
  89954. * @param format define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  89955. * @param scene define the scene the texture belongs to
  89956. * @param generateMipMaps define whether mip maps should be generated or not
  89957. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  89958. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  89959. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  89960. */
  89961. constructor(data: ArrayBufferView, width: number, height: number,
  89962. /**
  89963. * Define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  89964. */
  89965. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number);
  89966. /**
  89967. * Updates the texture underlying data.
  89968. * @param data Define the new data of the texture
  89969. */
  89970. update(data: ArrayBufferView): void;
  89971. /**
  89972. * Creates a luminance texture from some data.
  89973. * @param data Define the texture data
  89974. * @param width Define the width of the texture
  89975. * @param height Define the height of the texture
  89976. * @param scene Define the scene the texture belongs to
  89977. * @param generateMipMaps Define whether or not to create mip maps for the texture
  89978. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  89979. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  89980. * @returns the luminance texture
  89981. */
  89982. static CreateLuminanceTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  89983. /**
  89984. * Creates a luminance alpha texture from some data.
  89985. * @param data Define the texture data
  89986. * @param width Define the width of the texture
  89987. * @param height Define the height of the texture
  89988. * @param scene Define the scene the texture belongs to
  89989. * @param generateMipMaps Define whether or not to create mip maps for the texture
  89990. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  89991. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  89992. * @returns the luminance alpha texture
  89993. */
  89994. static CreateLuminanceAlphaTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  89995. /**
  89996. * Creates an alpha texture from some data.
  89997. * @param data Define the texture data
  89998. * @param width Define the width of the texture
  89999. * @param height Define the height of the texture
  90000. * @param scene Define the scene the texture belongs to
  90001. * @param generateMipMaps Define whether or not to create mip maps for the texture
  90002. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  90003. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  90004. * @returns the alpha texture
  90005. */
  90006. static CreateAlphaTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  90007. /**
  90008. * Creates a RGB texture from some data.
  90009. * @param data Define the texture data
  90010. * @param width Define the width of the texture
  90011. * @param height Define the height of the texture
  90012. * @param scene Define the scene the texture belongs to
  90013. * @param generateMipMaps Define whether or not to create mip maps for the texture
  90014. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  90015. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  90016. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  90017. * @returns the RGB alpha texture
  90018. */
  90019. static CreateRGBTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  90020. /**
  90021. * Creates a RGBA texture from some data.
  90022. * @param data Define the texture data
  90023. * @param width Define the width of the texture
  90024. * @param height Define the height of the texture
  90025. * @param scene Define the scene the texture belongs to
  90026. * @param generateMipMaps Define whether or not to create mip maps for the texture
  90027. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  90028. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  90029. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  90030. * @returns the RGBA texture
  90031. */
  90032. static CreateRGBATexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  90033. /**
  90034. * Creates a R texture from some data.
  90035. * @param data Define the texture data
  90036. * @param width Define the width of the texture
  90037. * @param height Define the height of the texture
  90038. * @param scene Define the scene the texture belongs to
  90039. * @param generateMipMaps Define whether or not to create mip maps for the texture
  90040. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  90041. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  90042. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  90043. * @returns the R texture
  90044. */
  90045. static CreateRTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  90046. }
  90047. }
  90048. declare module BABYLON {
  90049. interface AbstractScene {
  90050. /**
  90051. * The list of procedural textures added to the scene
  90052. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  90053. */
  90054. proceduralTextures: Array<ProceduralTexture>;
  90055. }
  90056. /**
  90057. * Defines the Procedural Texture scene component responsible to manage any Procedural Texture
  90058. * in a given scene.
  90059. */
  90060. export class ProceduralTextureSceneComponent implements ISceneComponent {
  90061. /**
  90062. * The component name helpfull to identify the component in the list of scene components.
  90063. */
  90064. readonly name: string;
  90065. /**
  90066. * The scene the component belongs to.
  90067. */
  90068. scene: Scene;
  90069. /**
  90070. * Creates a new instance of the component for the given scene
  90071. * @param scene Defines the scene to register the component in
  90072. */
  90073. constructor(scene: Scene);
  90074. /**
  90075. * Registers the component in a given scene
  90076. */
  90077. register(): void;
  90078. /**
  90079. * Rebuilds the elements related to this component in case of
  90080. * context lost for instance.
  90081. */
  90082. rebuild(): void;
  90083. /**
  90084. * Disposes the component and the associated ressources.
  90085. */
  90086. dispose(): void;
  90087. private _beforeClear;
  90088. }
  90089. }
  90090. declare module BABYLON {
  90091. interface ThinEngine {
  90092. /**
  90093. * Creates a new render target cube texture
  90094. * @param size defines the size of the texture
  90095. * @param options defines the options used to create the texture
  90096. * @returns a new render target cube texture stored in an InternalTexture
  90097. */
  90098. createRenderTargetCubeTexture(size: number, options?: Partial<RenderTargetCreationOptions>): InternalTexture;
  90099. }
  90100. }
  90101. declare module BABYLON {
  90102. /** @hidden */
  90103. export var proceduralVertexShader: {
  90104. name: string;
  90105. shader: string;
  90106. };
  90107. }
  90108. declare module BABYLON {
  90109. /**
  90110. * 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.
  90111. * This is the base class of any Procedural texture and contains most of the shareable code.
  90112. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  90113. */
  90114. export class ProceduralTexture extends Texture {
  90115. isCube: boolean;
  90116. /**
  90117. * Define if the texture is enabled or not (disabled texture will not render)
  90118. */
  90119. isEnabled: boolean;
  90120. /**
  90121. * Define if the texture must be cleared before rendering (default is true)
  90122. */
  90123. autoClear: boolean;
  90124. /**
  90125. * Callback called when the texture is generated
  90126. */
  90127. onGenerated: () => void;
  90128. /**
  90129. * Event raised when the texture is generated
  90130. */
  90131. onGeneratedObservable: Observable<ProceduralTexture>;
  90132. /** @hidden */
  90133. _generateMipMaps: boolean;
  90134. /** @hidden **/
  90135. _effect: Effect;
  90136. /** @hidden */
  90137. _textures: {
  90138. [key: string]: Texture;
  90139. };
  90140. /** @hidden */
  90141. protected _fallbackTexture: Nullable<Texture>;
  90142. private _size;
  90143. private _currentRefreshId;
  90144. private _frameId;
  90145. private _refreshRate;
  90146. private _vertexBuffers;
  90147. private _indexBuffer;
  90148. private _uniforms;
  90149. private _samplers;
  90150. private _fragment;
  90151. private _floats;
  90152. private _ints;
  90153. private _floatsArrays;
  90154. private _colors3;
  90155. private _colors4;
  90156. private _vectors2;
  90157. private _vectors3;
  90158. private _matrices;
  90159. private _fallbackTextureUsed;
  90160. private _fullEngine;
  90161. private _cachedDefines;
  90162. private _contentUpdateId;
  90163. private _contentData;
  90164. /**
  90165. * Instantiates a new procedural texture.
  90166. * 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.
  90167. * This is the base class of any Procedural texture and contains most of the shareable code.
  90168. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  90169. * @param name Define the name of the texture
  90170. * @param size Define the size of the texture to create
  90171. * @param fragment Define the fragment shader to use to generate the texture or null if it is defined later
  90172. * @param scene Define the scene the texture belongs to
  90173. * @param fallbackTexture Define a fallback texture in case there were issues to create the custom texture
  90174. * @param generateMipMaps Define if the texture should creates mip maps or not
  90175. * @param isCube Define if the texture is a cube texture or not (this will render each faces of the cube)
  90176. */
  90177. constructor(name: string, size: any, fragment: any, scene: Nullable<Scene>, fallbackTexture?: Nullable<Texture>, generateMipMaps?: boolean, isCube?: boolean);
  90178. /**
  90179. * The effect that is created when initializing the post process.
  90180. * @returns The created effect corresponding the the postprocess.
  90181. */
  90182. getEffect(): Effect;
  90183. /**
  90184. * Gets texture content (Use this function wisely as reading from a texture can be slow)
  90185. * @returns an ArrayBufferView (Uint8Array or Float32Array)
  90186. */
  90187. getContent(): Nullable<ArrayBufferView>;
  90188. private _createIndexBuffer;
  90189. /** @hidden */
  90190. _rebuild(): void;
  90191. /**
  90192. * Resets the texture in order to recreate its associated resources.
  90193. * This can be called in case of context loss
  90194. */
  90195. reset(): void;
  90196. protected _getDefines(): string;
  90197. /**
  90198. * Is the texture ready to be used ? (rendered at least once)
  90199. * @returns true if ready, otherwise, false.
  90200. */
  90201. isReady(): boolean;
  90202. /**
  90203. * Resets the refresh counter of the texture and start bak from scratch.
  90204. * Could be useful to regenerate the texture if it is setup to render only once.
  90205. */
  90206. resetRefreshCounter(): void;
  90207. /**
  90208. * Set the fragment shader to use in order to render the texture.
  90209. * @param fragment This can be set to a path (into the shader store) or to a json object containing a fragmentElement property.
  90210. */
  90211. setFragment(fragment: any): void;
  90212. /**
  90213. * Define the refresh rate of the texture or the rendering frequency.
  90214. * Use 0 to render just once, 1 to render on every frame, 2 to render every two frames and so on...
  90215. */
  90216. get refreshRate(): number;
  90217. set refreshRate(value: number);
  90218. /** @hidden */
  90219. _shouldRender(): boolean;
  90220. /**
  90221. * Get the size the texture is rendering at.
  90222. * @returns the size (texture is always squared)
  90223. */
  90224. getRenderSize(): number;
  90225. /**
  90226. * Resize the texture to new value.
  90227. * @param size Define the new size the texture should have
  90228. * @param generateMipMaps Define whether the new texture should create mip maps
  90229. */
  90230. resize(size: number, generateMipMaps: boolean): void;
  90231. private _checkUniform;
  90232. /**
  90233. * Set a texture in the shader program used to render.
  90234. * @param name Define the name of the uniform samplers as defined in the shader
  90235. * @param texture Define the texture to bind to this sampler
  90236. * @return the texture itself allowing "fluent" like uniform updates
  90237. */
  90238. setTexture(name: string, texture: Texture): ProceduralTexture;
  90239. /**
  90240. * Set a float in the shader.
  90241. * @param name Define the name of the uniform as defined in the shader
  90242. * @param value Define the value to give to the uniform
  90243. * @return the texture itself allowing "fluent" like uniform updates
  90244. */
  90245. setFloat(name: string, value: number): ProceduralTexture;
  90246. /**
  90247. * Set a int in the shader.
  90248. * @param name Define the name of the uniform as defined in the shader
  90249. * @param value Define the value to give to the uniform
  90250. * @return the texture itself allowing "fluent" like uniform updates
  90251. */
  90252. setInt(name: string, value: number): ProceduralTexture;
  90253. /**
  90254. * Set an array of floats in the shader.
  90255. * @param name Define the name of the uniform as defined in the shader
  90256. * @param value Define the value to give to the uniform
  90257. * @return the texture itself allowing "fluent" like uniform updates
  90258. */
  90259. setFloats(name: string, value: number[]): ProceduralTexture;
  90260. /**
  90261. * Set a vec3 in the shader from a Color3.
  90262. * @param name Define the name of the uniform as defined in the shader
  90263. * @param value Define the value to give to the uniform
  90264. * @return the texture itself allowing "fluent" like uniform updates
  90265. */
  90266. setColor3(name: string, value: Color3): ProceduralTexture;
  90267. /**
  90268. * Set a vec4 in the shader from a Color4.
  90269. * @param name Define the name of the uniform as defined in the shader
  90270. * @param value Define the value to give to the uniform
  90271. * @return the texture itself allowing "fluent" like uniform updates
  90272. */
  90273. setColor4(name: string, value: Color4): ProceduralTexture;
  90274. /**
  90275. * Set a vec2 in the shader from a Vector2.
  90276. * @param name Define the name of the uniform as defined in the shader
  90277. * @param value Define the value to give to the uniform
  90278. * @return the texture itself allowing "fluent" like uniform updates
  90279. */
  90280. setVector2(name: string, value: Vector2): ProceduralTexture;
  90281. /**
  90282. * Set a vec3 in the shader from a Vector3.
  90283. * @param name Define the name of the uniform as defined in the shader
  90284. * @param value Define the value to give to the uniform
  90285. * @return the texture itself allowing "fluent" like uniform updates
  90286. */
  90287. setVector3(name: string, value: Vector3): ProceduralTexture;
  90288. /**
  90289. * Set a mat4 in the shader from a MAtrix.
  90290. * @param name Define the name of the uniform as defined in the shader
  90291. * @param value Define the value to give to the uniform
  90292. * @return the texture itself allowing "fluent" like uniform updates
  90293. */
  90294. setMatrix(name: string, value: Matrix): ProceduralTexture;
  90295. /**
  90296. * Render the texture to its associated render target.
  90297. * @param useCameraPostProcess Define if camera post process should be applied to the texture
  90298. */
  90299. render(useCameraPostProcess?: boolean): void;
  90300. /**
  90301. * Clone the texture.
  90302. * @returns the cloned texture
  90303. */
  90304. clone(): ProceduralTexture;
  90305. /**
  90306. * Dispose the texture and release its asoociated resources.
  90307. */
  90308. dispose(): void;
  90309. }
  90310. }
  90311. declare module BABYLON {
  90312. /**
  90313. * This represents the base class for particle system in Babylon.
  90314. * 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.
  90315. * Particles can take different shapes while emitted like box, sphere, cone or you can write your custom function.
  90316. * @example https://doc.babylonjs.com/babylon101/particles
  90317. */
  90318. export class BaseParticleSystem {
  90319. /**
  90320. * Source color is added to the destination color without alpha affecting the result
  90321. */
  90322. static BLENDMODE_ONEONE: number;
  90323. /**
  90324. * Blend current color and particle color using particle’s alpha
  90325. */
  90326. static BLENDMODE_STANDARD: number;
  90327. /**
  90328. * Add current color and particle color multiplied by particle’s alpha
  90329. */
  90330. static BLENDMODE_ADD: number;
  90331. /**
  90332. * Multiply current color with particle color
  90333. */
  90334. static BLENDMODE_MULTIPLY: number;
  90335. /**
  90336. * Multiply current color with particle color then add current color and particle color multiplied by particle’s alpha
  90337. */
  90338. static BLENDMODE_MULTIPLYADD: number;
  90339. /**
  90340. * List of animations used by the particle system.
  90341. */
  90342. animations: Animation[];
  90343. /**
  90344. * Gets or sets the unique id of the particle system
  90345. */
  90346. uniqueId: number;
  90347. /**
  90348. * The id of the Particle system.
  90349. */
  90350. id: string;
  90351. /**
  90352. * The friendly name of the Particle system.
  90353. */
  90354. name: string;
  90355. /**
  90356. * Snippet ID if the particle system was created from the snippet server
  90357. */
  90358. snippetId: string;
  90359. /**
  90360. * The rendering group used by the Particle system to chose when to render.
  90361. */
  90362. renderingGroupId: number;
  90363. /**
  90364. * The emitter represents the Mesh or position we are attaching the particle system to.
  90365. */
  90366. emitter: Nullable<AbstractMesh | Vector3>;
  90367. /**
  90368. * The maximum number of particles to emit per frame
  90369. */
  90370. emitRate: number;
  90371. /**
  90372. * If you want to launch only a few particles at once, that can be done, as well.
  90373. */
  90374. manualEmitCount: number;
  90375. /**
  90376. * The overall motion speed (0.01 is default update speed, faster updates = faster animation)
  90377. */
  90378. updateSpeed: number;
  90379. /**
  90380. * The amount of time the particle system is running (depends of the overall update speed).
  90381. */
  90382. targetStopDuration: number;
  90383. /**
  90384. * Specifies whether the particle system will be disposed once it reaches the end of the animation.
  90385. */
  90386. disposeOnStop: boolean;
  90387. /**
  90388. * Minimum power of emitting particles.
  90389. */
  90390. minEmitPower: number;
  90391. /**
  90392. * Maximum power of emitting particles.
  90393. */
  90394. maxEmitPower: number;
  90395. /**
  90396. * Minimum life time of emitting particles.
  90397. */
  90398. minLifeTime: number;
  90399. /**
  90400. * Maximum life time of emitting particles.
  90401. */
  90402. maxLifeTime: number;
  90403. /**
  90404. * Minimum Size of emitting particles.
  90405. */
  90406. minSize: number;
  90407. /**
  90408. * Maximum Size of emitting particles.
  90409. */
  90410. maxSize: number;
  90411. /**
  90412. * Minimum scale of emitting particles on X axis.
  90413. */
  90414. minScaleX: number;
  90415. /**
  90416. * Maximum scale of emitting particles on X axis.
  90417. */
  90418. maxScaleX: number;
  90419. /**
  90420. * Minimum scale of emitting particles on Y axis.
  90421. */
  90422. minScaleY: number;
  90423. /**
  90424. * Maximum scale of emitting particles on Y axis.
  90425. */
  90426. maxScaleY: number;
  90427. /**
  90428. * Gets or sets the minimal initial rotation in radians.
  90429. */
  90430. minInitialRotation: number;
  90431. /**
  90432. * Gets or sets the maximal initial rotation in radians.
  90433. */
  90434. maxInitialRotation: number;
  90435. /**
  90436. * Minimum angular speed of emitting particles (Z-axis rotation for each particle).
  90437. */
  90438. minAngularSpeed: number;
  90439. /**
  90440. * Maximum angular speed of emitting particles (Z-axis rotation for each particle).
  90441. */
  90442. maxAngularSpeed: number;
  90443. /**
  90444. * The texture used to render each particle. (this can be a spritesheet)
  90445. */
  90446. particleTexture: Nullable<Texture>;
  90447. /**
  90448. * The layer mask we are rendering the particles through.
  90449. */
  90450. layerMask: number;
  90451. /**
  90452. * This can help using your own shader to render the particle system.
  90453. * The according effect will be created
  90454. */
  90455. customShader: any;
  90456. /**
  90457. * By default particle system starts as soon as they are created. This prevents the
  90458. * automatic start to happen and let you decide when to start emitting particles.
  90459. */
  90460. preventAutoStart: boolean;
  90461. private _noiseTexture;
  90462. /**
  90463. * Gets or sets a texture used to add random noise to particle positions
  90464. */
  90465. get noiseTexture(): Nullable<ProceduralTexture>;
  90466. set noiseTexture(value: Nullable<ProceduralTexture>);
  90467. /** Gets or sets the strength to apply to the noise value (default is (10, 10, 10)) */
  90468. noiseStrength: Vector3;
  90469. /**
  90470. * Callback triggered when the particle animation is ending.
  90471. */
  90472. onAnimationEnd: Nullable<() => void>;
  90473. /**
  90474. * Blend mode use to render the particle, it can be either ParticleSystem.BLENDMODE_ONEONE or ParticleSystem.BLENDMODE_STANDARD.
  90475. */
  90476. blendMode: number;
  90477. /**
  90478. * Forces the particle to write their depth information to the depth buffer. This can help preventing other draw calls
  90479. * to override the particles.
  90480. */
  90481. forceDepthWrite: boolean;
  90482. /** 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 */
  90483. preWarmCycles: number;
  90484. /** Gets or sets a value indicating the time step multiplier to use in pre-warm mode (default is 1) */
  90485. preWarmStepOffset: number;
  90486. /**
  90487. * 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)
  90488. */
  90489. spriteCellChangeSpeed: number;
  90490. /**
  90491. * If using a spritesheet (isAnimationSheetEnabled) defines the first sprite cell to display
  90492. */
  90493. startSpriteCellID: number;
  90494. /**
  90495. * If using a spritesheet (isAnimationSheetEnabled) defines the last sprite cell to display
  90496. */
  90497. endSpriteCellID: number;
  90498. /**
  90499. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell width to use
  90500. */
  90501. spriteCellWidth: number;
  90502. /**
  90503. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell height to use
  90504. */
  90505. spriteCellHeight: number;
  90506. /**
  90507. * This allows the system to random pick the start cell ID between startSpriteCellID and endSpriteCellID
  90508. */
  90509. spriteRandomStartCell: boolean;
  90510. /** Gets or sets a Vector2 used to move the pivot (by default (0,0)) */
  90511. translationPivot: Vector2;
  90512. /** @hidden */
  90513. protected _isAnimationSheetEnabled: boolean;
  90514. /**
  90515. * Gets or sets a boolean indicating that hosted animations (in the system.animations array) must be started when system.start() is called
  90516. */
  90517. beginAnimationOnStart: boolean;
  90518. /**
  90519. * Gets or sets the frame to start the animation from when beginAnimationOnStart is true
  90520. */
  90521. beginAnimationFrom: number;
  90522. /**
  90523. * Gets or sets the frame to end the animation on when beginAnimationOnStart is true
  90524. */
  90525. beginAnimationTo: number;
  90526. /**
  90527. * Gets or sets a boolean indicating if animations must loop when beginAnimationOnStart is true
  90528. */
  90529. beginAnimationLoop: boolean;
  90530. /**
  90531. * Gets or sets a world offset applied to all particles
  90532. */
  90533. worldOffset: Vector3;
  90534. /**
  90535. * Gets or sets whether an animation sprite sheet is enabled or not on the particle system
  90536. */
  90537. get isAnimationSheetEnabled(): boolean;
  90538. set isAnimationSheetEnabled(value: boolean);
  90539. /**
  90540. * Get hosting scene
  90541. * @returns the scene
  90542. */
  90543. getScene(): Scene;
  90544. /**
  90545. * You can use gravity if you want to give an orientation to your particles.
  90546. */
  90547. gravity: Vector3;
  90548. protected _colorGradients: Nullable<Array<ColorGradient>>;
  90549. protected _sizeGradients: Nullable<Array<FactorGradient>>;
  90550. protected _lifeTimeGradients: Nullable<Array<FactorGradient>>;
  90551. protected _angularSpeedGradients: Nullable<Array<FactorGradient>>;
  90552. protected _velocityGradients: Nullable<Array<FactorGradient>>;
  90553. protected _limitVelocityGradients: Nullable<Array<FactorGradient>>;
  90554. protected _dragGradients: Nullable<Array<FactorGradient>>;
  90555. protected _emitRateGradients: Nullable<Array<FactorGradient>>;
  90556. protected _startSizeGradients: Nullable<Array<FactorGradient>>;
  90557. protected _rampGradients: Nullable<Array<Color3Gradient>>;
  90558. protected _colorRemapGradients: Nullable<Array<FactorGradient>>;
  90559. protected _alphaRemapGradients: Nullable<Array<FactorGradient>>;
  90560. protected _hasTargetStopDurationDependantGradient(): boolean | null;
  90561. /**
  90562. * Defines the delay in milliseconds before starting the system (0 by default)
  90563. */
  90564. startDelay: number;
  90565. /**
  90566. * Gets the current list of drag gradients.
  90567. * You must use addDragGradient and removeDragGradient to udpate this list
  90568. * @returns the list of drag gradients
  90569. */
  90570. getDragGradients(): Nullable<Array<FactorGradient>>;
  90571. /** Gets or sets a value indicating the damping to apply if the limit velocity factor is reached */
  90572. limitVelocityDamping: number;
  90573. /**
  90574. * Gets the current list of limit velocity gradients.
  90575. * You must use addLimitVelocityGradient and removeLimitVelocityGradient to udpate this list
  90576. * @returns the list of limit velocity gradients
  90577. */
  90578. getLimitVelocityGradients(): Nullable<Array<FactorGradient>>;
  90579. /**
  90580. * Gets the current list of color gradients.
  90581. * You must use addColorGradient and removeColorGradient to udpate this list
  90582. * @returns the list of color gradients
  90583. */
  90584. getColorGradients(): Nullable<Array<ColorGradient>>;
  90585. /**
  90586. * Gets the current list of size gradients.
  90587. * You must use addSizeGradient and removeSizeGradient to udpate this list
  90588. * @returns the list of size gradients
  90589. */
  90590. getSizeGradients(): Nullable<Array<FactorGradient>>;
  90591. /**
  90592. * Gets the current list of color remap gradients.
  90593. * You must use addColorRemapGradient and removeColorRemapGradient to udpate this list
  90594. * @returns the list of color remap gradients
  90595. */
  90596. getColorRemapGradients(): Nullable<Array<FactorGradient>>;
  90597. /**
  90598. * Gets the current list of alpha remap gradients.
  90599. * You must use addAlphaRemapGradient and removeAlphaRemapGradient to udpate this list
  90600. * @returns the list of alpha remap gradients
  90601. */
  90602. getAlphaRemapGradients(): Nullable<Array<FactorGradient>>;
  90603. /**
  90604. * Gets the current list of life time gradients.
  90605. * You must use addLifeTimeGradient and removeLifeTimeGradient to udpate this list
  90606. * @returns the list of life time gradients
  90607. */
  90608. getLifeTimeGradients(): Nullable<Array<FactorGradient>>;
  90609. /**
  90610. * Gets the current list of angular speed gradients.
  90611. * You must use addAngularSpeedGradient and removeAngularSpeedGradient to udpate this list
  90612. * @returns the list of angular speed gradients
  90613. */
  90614. getAngularSpeedGradients(): Nullable<Array<FactorGradient>>;
  90615. /**
  90616. * Gets the current list of velocity gradients.
  90617. * You must use addVelocityGradient and removeVelocityGradient to udpate this list
  90618. * @returns the list of velocity gradients
  90619. */
  90620. getVelocityGradients(): Nullable<Array<FactorGradient>>;
  90621. /**
  90622. * Gets the current list of start size gradients.
  90623. * You must use addStartSizeGradient and removeStartSizeGradient to udpate this list
  90624. * @returns the list of start size gradients
  90625. */
  90626. getStartSizeGradients(): Nullable<Array<FactorGradient>>;
  90627. /**
  90628. * Gets the current list of emit rate gradients.
  90629. * You must use addEmitRateGradient and removeEmitRateGradient to udpate this list
  90630. * @returns the list of emit rate gradients
  90631. */
  90632. getEmitRateGradients(): Nullable<Array<FactorGradient>>;
  90633. /**
  90634. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  90635. * This only works when particleEmitterTyps is a BoxParticleEmitter
  90636. */
  90637. get direction1(): Vector3;
  90638. set direction1(value: Vector3);
  90639. /**
  90640. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  90641. * This only works when particleEmitterTyps is a BoxParticleEmitter
  90642. */
  90643. get direction2(): Vector3;
  90644. set direction2(value: Vector3);
  90645. /**
  90646. * 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.
  90647. * This only works when particleEmitterTyps is a BoxParticleEmitter
  90648. */
  90649. get minEmitBox(): Vector3;
  90650. set minEmitBox(value: Vector3);
  90651. /**
  90652. * 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.
  90653. * This only works when particleEmitterTyps is a BoxParticleEmitter
  90654. */
  90655. get maxEmitBox(): Vector3;
  90656. set maxEmitBox(value: Vector3);
  90657. /**
  90658. * Random color of each particle after it has been emitted, between color1 and color2 vectors
  90659. */
  90660. color1: Color4;
  90661. /**
  90662. * Random color of each particle after it has been emitted, between color1 and color2 vectors
  90663. */
  90664. color2: Color4;
  90665. /**
  90666. * Color the particle will have at the end of its lifetime
  90667. */
  90668. colorDead: Color4;
  90669. /**
  90670. * An optional mask to filter some colors out of the texture, or filter a part of the alpha channel
  90671. */
  90672. textureMask: Color4;
  90673. /**
  90674. * The particle emitter type defines the emitter used by the particle system.
  90675. * It can be for example box, sphere, or cone...
  90676. */
  90677. particleEmitterType: IParticleEmitterType;
  90678. /** @hidden */
  90679. _isSubEmitter: boolean;
  90680. /**
  90681. * Gets or sets the billboard mode to use when isBillboardBased = true.
  90682. * Value can be: ParticleSystem.BILLBOARDMODE_ALL, ParticleSystem.BILLBOARDMODE_Y, ParticleSystem.BILLBOARDMODE_STRETCHED
  90683. */
  90684. billboardMode: number;
  90685. protected _isBillboardBased: boolean;
  90686. /**
  90687. * Gets or sets a boolean indicating if the particles must be rendered as billboard or aligned with the direction
  90688. */
  90689. get isBillboardBased(): boolean;
  90690. set isBillboardBased(value: boolean);
  90691. /**
  90692. * The scene the particle system belongs to.
  90693. */
  90694. protected _scene: Scene;
  90695. /**
  90696. * Local cache of defines for image processing.
  90697. */
  90698. protected _imageProcessingConfigurationDefines: ImageProcessingConfigurationDefines;
  90699. /**
  90700. * Default configuration related to image processing available in the standard Material.
  90701. */
  90702. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  90703. /**
  90704. * Gets the image processing configuration used either in this material.
  90705. */
  90706. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  90707. /**
  90708. * Sets the Default image processing configuration used either in the this material.
  90709. *
  90710. * If sets to null, the scene one is in use.
  90711. */
  90712. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  90713. /**
  90714. * Attaches a new image processing configuration to the Standard Material.
  90715. * @param configuration
  90716. */
  90717. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  90718. /** @hidden */
  90719. protected _reset(): void;
  90720. /** @hidden */
  90721. protected _removeGradientAndTexture(gradient: number, gradients: Nullable<IValueGradient[]>, texture: Nullable<RawTexture>): BaseParticleSystem;
  90722. /**
  90723. * Instantiates a particle system.
  90724. * 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.
  90725. * @param name The name of the particle system
  90726. */
  90727. constructor(name: string);
  90728. /**
  90729. * Creates a Point Emitter for the particle system (emits directly from the emitter position)
  90730. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  90731. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  90732. * @returns the emitter
  90733. */
  90734. createPointEmitter(direction1: Vector3, direction2: Vector3): PointParticleEmitter;
  90735. /**
  90736. * Creates a Hemisphere Emitter for the particle system (emits along the hemisphere radius)
  90737. * @param radius The radius of the hemisphere to emit from
  90738. * @param radiusRange The range of the hemisphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  90739. * @returns the emitter
  90740. */
  90741. createHemisphericEmitter(radius?: number, radiusRange?: number): HemisphericParticleEmitter;
  90742. /**
  90743. * Creates a Sphere Emitter for the particle system (emits along the sphere radius)
  90744. * @param radius The radius of the sphere to emit from
  90745. * @param radiusRange The range of the sphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  90746. * @returns the emitter
  90747. */
  90748. createSphereEmitter(radius?: number, radiusRange?: number): SphereParticleEmitter;
  90749. /**
  90750. * Creates a Directed Sphere Emitter for the particle system (emits between direction1 and direction2)
  90751. * @param radius The radius of the sphere to emit from
  90752. * @param direction1 Particles are emitted between the direction1 and direction2 from within the sphere
  90753. * @param direction2 Particles are emitted between the direction1 and direction2 from within the sphere
  90754. * @returns the emitter
  90755. */
  90756. createDirectedSphereEmitter(radius?: number, direction1?: Vector3, direction2?: Vector3): SphereDirectedParticleEmitter;
  90757. /**
  90758. * Creates a Cylinder Emitter for the particle system (emits from the cylinder to the particle position)
  90759. * @param radius The radius of the emission cylinder
  90760. * @param height The height of the emission cylinder
  90761. * @param radiusRange The range of emission [0-1] 0 Surface only, 1 Entire Radius
  90762. * @param directionRandomizer How much to randomize the particle direction [0-1]
  90763. * @returns the emitter
  90764. */
  90765. createCylinderEmitter(radius?: number, height?: number, radiusRange?: number, directionRandomizer?: number): CylinderParticleEmitter;
  90766. /**
  90767. * Creates a Directed Cylinder Emitter for the particle system (emits between direction1 and direction2)
  90768. * @param radius The radius of the cylinder to emit from
  90769. * @param height The height of the emission cylinder
  90770. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  90771. * @param direction1 Particles are emitted between the direction1 and direction2 from within the cylinder
  90772. * @param direction2 Particles are emitted between the direction1 and direction2 from within the cylinder
  90773. * @returns the emitter
  90774. */
  90775. createDirectedCylinderEmitter(radius?: number, height?: number, radiusRange?: number, direction1?: Vector3, direction2?: Vector3): CylinderDirectedParticleEmitter;
  90776. /**
  90777. * Creates a Cone Emitter for the particle system (emits from the cone to the particle position)
  90778. * @param radius The radius of the cone to emit from
  90779. * @param angle The base angle of the cone
  90780. * @returns the emitter
  90781. */
  90782. createConeEmitter(radius?: number, angle?: number): ConeParticleEmitter;
  90783. /**
  90784. * Creates a Box Emitter for the particle system. (emits between direction1 and direction2 from withing the box defined by minEmitBox and maxEmitBox)
  90785. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  90786. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  90787. * @param minEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  90788. * @param maxEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  90789. * @returns the emitter
  90790. */
  90791. createBoxEmitter(direction1: Vector3, direction2: Vector3, minEmitBox: Vector3, maxEmitBox: Vector3): BoxParticleEmitter;
  90792. }
  90793. }
  90794. declare module BABYLON {
  90795. /**
  90796. * Type of sub emitter
  90797. */
  90798. export enum SubEmitterType {
  90799. /**
  90800. * Attached to the particle over it's lifetime
  90801. */
  90802. ATTACHED = 0,
  90803. /**
  90804. * Created when the particle dies
  90805. */
  90806. END = 1
  90807. }
  90808. /**
  90809. * Sub emitter class used to emit particles from an existing particle
  90810. */
  90811. export class SubEmitter {
  90812. /**
  90813. * the particle system to be used by the sub emitter
  90814. */
  90815. particleSystem: ParticleSystem;
  90816. /**
  90817. * Type of the submitter (Default: END)
  90818. */
  90819. type: SubEmitterType;
  90820. /**
  90821. * 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)
  90822. * Note: This only is supported when using an emitter of type Mesh
  90823. */
  90824. inheritDirection: boolean;
  90825. /**
  90826. * How much of the attached particles speed should be added to the sub emitted particle (default: 0)
  90827. */
  90828. inheritedVelocityAmount: number;
  90829. /**
  90830. * Creates a sub emitter
  90831. * @param particleSystem the particle system to be used by the sub emitter
  90832. */
  90833. constructor(
  90834. /**
  90835. * the particle system to be used by the sub emitter
  90836. */
  90837. particleSystem: ParticleSystem);
  90838. /**
  90839. * Clones the sub emitter
  90840. * @returns the cloned sub emitter
  90841. */
  90842. clone(): SubEmitter;
  90843. /**
  90844. * Serialize current object to a JSON object
  90845. * @returns the serialized object
  90846. */
  90847. serialize(): any;
  90848. /** @hidden */
  90849. static _ParseParticleSystem(system: any, scene: Scene, rootUrl: string): ParticleSystem;
  90850. /**
  90851. * Creates a new SubEmitter from a serialized JSON version
  90852. * @param serializationObject defines the JSON object to read from
  90853. * @param scene defines the hosting scene
  90854. * @param rootUrl defines the rootUrl for data loading
  90855. * @returns a new SubEmitter
  90856. */
  90857. static Parse(serializationObject: any, scene: Scene, rootUrl: string): SubEmitter;
  90858. /** Release associated resources */
  90859. dispose(): void;
  90860. }
  90861. }
  90862. declare module BABYLON {
  90863. /** @hidden */
  90864. export var imageProcessingDeclaration: {
  90865. name: string;
  90866. shader: string;
  90867. };
  90868. }
  90869. declare module BABYLON {
  90870. /** @hidden */
  90871. export var imageProcessingFunctions: {
  90872. name: string;
  90873. shader: string;
  90874. };
  90875. }
  90876. declare module BABYLON {
  90877. /** @hidden */
  90878. export var particlesPixelShader: {
  90879. name: string;
  90880. shader: string;
  90881. };
  90882. }
  90883. declare module BABYLON {
  90884. /** @hidden */
  90885. export var particlesVertexShader: {
  90886. name: string;
  90887. shader: string;
  90888. };
  90889. }
  90890. declare module BABYLON {
  90891. /**
  90892. * This represents a particle system in Babylon.
  90893. * 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.
  90894. * Particles can take different shapes while emitted like box, sphere, cone or you can write your custom function.
  90895. * @example https://doc.babylonjs.com/babylon101/particles
  90896. */
  90897. export class ParticleSystem extends BaseParticleSystem implements IDisposable, IAnimatable, IParticleSystem {
  90898. /**
  90899. * Billboard mode will only apply to Y axis
  90900. */
  90901. static readonly BILLBOARDMODE_Y: number;
  90902. /**
  90903. * Billboard mode will apply to all axes
  90904. */
  90905. static readonly BILLBOARDMODE_ALL: number;
  90906. /**
  90907. * Special billboard mode where the particle will be biilboard to the camera but rotated to align with direction
  90908. */
  90909. static readonly BILLBOARDMODE_STRETCHED: number;
  90910. /**
  90911. * This function can be defined to provide custom update for active particles.
  90912. * This function will be called instead of regular update (age, position, color, etc.).
  90913. * Do not forget that this function will be called on every frame so try to keep it simple and fast :)
  90914. */
  90915. updateFunction: (particles: Particle[]) => void;
  90916. private _emitterWorldMatrix;
  90917. /**
  90918. * This function can be defined to specify initial direction for every new particle.
  90919. * It by default use the emitterType defined function
  90920. */
  90921. startDirectionFunction: (worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean) => void;
  90922. /**
  90923. * This function can be defined to specify initial position for every new particle.
  90924. * It by default use the emitterType defined function
  90925. */
  90926. startPositionFunction: (worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean) => void;
  90927. /**
  90928. * @hidden
  90929. */
  90930. _inheritedVelocityOffset: Vector3;
  90931. /**
  90932. * An event triggered when the system is disposed
  90933. */
  90934. onDisposeObservable: Observable<IParticleSystem>;
  90935. private _onDisposeObserver;
  90936. /**
  90937. * Sets a callback that will be triggered when the system is disposed
  90938. */
  90939. set onDispose(callback: () => void);
  90940. private _particles;
  90941. private _epsilon;
  90942. private _capacity;
  90943. private _stockParticles;
  90944. private _newPartsExcess;
  90945. private _vertexData;
  90946. private _vertexBuffer;
  90947. private _vertexBuffers;
  90948. private _spriteBuffer;
  90949. private _indexBuffer;
  90950. private _effect;
  90951. private _customEffect;
  90952. private _cachedDefines;
  90953. private _scaledColorStep;
  90954. private _colorDiff;
  90955. private _scaledDirection;
  90956. private _scaledGravity;
  90957. private _currentRenderId;
  90958. private _alive;
  90959. private _useInstancing;
  90960. private _started;
  90961. private _stopped;
  90962. private _actualFrame;
  90963. private _scaledUpdateSpeed;
  90964. private _vertexBufferSize;
  90965. /** @hidden */
  90966. _currentEmitRateGradient: Nullable<FactorGradient>;
  90967. /** @hidden */
  90968. _currentEmitRate1: number;
  90969. /** @hidden */
  90970. _currentEmitRate2: number;
  90971. /** @hidden */
  90972. _currentStartSizeGradient: Nullable<FactorGradient>;
  90973. /** @hidden */
  90974. _currentStartSize1: number;
  90975. /** @hidden */
  90976. _currentStartSize2: number;
  90977. private readonly _rawTextureWidth;
  90978. private _rampGradientsTexture;
  90979. private _useRampGradients;
  90980. /** Gets or sets a boolean indicating that ramp gradients must be used
  90981. * @see https://doc.babylonjs.com/babylon101/particles#ramp-gradients
  90982. */
  90983. get useRampGradients(): boolean;
  90984. set useRampGradients(value: boolean);
  90985. /**
  90986. * 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.
  90987. * 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: [])
  90988. */
  90989. subEmitters: Array<ParticleSystem | SubEmitter | Array<SubEmitter>>;
  90990. private _subEmitters;
  90991. /**
  90992. * @hidden
  90993. * If the particle systems emitter should be disposed when the particle system is disposed
  90994. */
  90995. _disposeEmitterOnDispose: boolean;
  90996. /**
  90997. * The current active Sub-systems, this property is used by the root particle system only.
  90998. */
  90999. activeSubSystems: Array<ParticleSystem>;
  91000. /**
  91001. * Specifies if the particles are updated in emitter local space or world space
  91002. */
  91003. isLocal: boolean;
  91004. private _rootParticleSystem;
  91005. /**
  91006. * Gets the current list of active particles
  91007. */
  91008. get particles(): Particle[];
  91009. /**
  91010. * Gets the number of particles active at the same time.
  91011. * @returns The number of active particles.
  91012. */
  91013. getActiveCount(): number;
  91014. /**
  91015. * Returns the string "ParticleSystem"
  91016. * @returns a string containing the class name
  91017. */
  91018. getClassName(): string;
  91019. /**
  91020. * Gets a boolean indicating that the system is stopping
  91021. * @returns true if the system is currently stopping
  91022. */
  91023. isStopping(): boolean;
  91024. /**
  91025. * Gets the custom effect used to render the particles
  91026. * @param blendMode Blend mode for which the effect should be retrieved
  91027. * @returns The effect
  91028. */
  91029. getCustomEffect(blendMode?: number): Nullable<Effect>;
  91030. /**
  91031. * Sets the custom effect used to render the particles
  91032. * @param effect The effect to set
  91033. * @param blendMode Blend mode for which the effect should be set
  91034. */
  91035. setCustomEffect(effect: Nullable<Effect>, blendMode?: number): void;
  91036. /** @hidden */
  91037. private _onBeforeDrawParticlesObservable;
  91038. /**
  91039. * Observable that will be called just before the particles are drawn
  91040. */
  91041. get onBeforeDrawParticlesObservable(): Observable<Nullable<Effect>>;
  91042. /**
  91043. * Gets the name of the particle vertex shader
  91044. */
  91045. get vertexShaderName(): string;
  91046. /**
  91047. * Instantiates a particle system.
  91048. * 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.
  91049. * @param name The name of the particle system
  91050. * @param capacity The max number of particles alive at the same time
  91051. * @param scene The scene the particle system belongs to
  91052. * @param customEffect a custom effect used to change the way particles are rendered by default
  91053. * @param isAnimationSheetEnabled Must be true if using a spritesheet to animate the particles texture
  91054. * @param epsilon Offset used to render the particles
  91055. */
  91056. constructor(name: string, capacity: number, scene: Scene, customEffect?: Nullable<Effect>, isAnimationSheetEnabled?: boolean, epsilon?: number);
  91057. private _addFactorGradient;
  91058. private _removeFactorGradient;
  91059. /**
  91060. * Adds a new life time gradient
  91061. * @param gradient defines the gradient to use (between 0 and 1)
  91062. * @param factor defines the life time factor to affect to the specified gradient
  91063. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  91064. * @returns the current particle system
  91065. */
  91066. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  91067. /**
  91068. * Remove a specific life time gradient
  91069. * @param gradient defines the gradient to remove
  91070. * @returns the current particle system
  91071. */
  91072. removeLifeTimeGradient(gradient: number): IParticleSystem;
  91073. /**
  91074. * Adds a new size gradient
  91075. * @param gradient defines the gradient to use (between 0 and 1)
  91076. * @param factor defines the size factor to affect to the specified gradient
  91077. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  91078. * @returns the current particle system
  91079. */
  91080. addSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  91081. /**
  91082. * Remove a specific size gradient
  91083. * @param gradient defines the gradient to remove
  91084. * @returns the current particle system
  91085. */
  91086. removeSizeGradient(gradient: number): IParticleSystem;
  91087. /**
  91088. * Adds a new color remap gradient
  91089. * @param gradient defines the gradient to use (between 0 and 1)
  91090. * @param min defines the color remap minimal range
  91091. * @param max defines the color remap maximal range
  91092. * @returns the current particle system
  91093. */
  91094. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  91095. /**
  91096. * Remove a specific color remap gradient
  91097. * @param gradient defines the gradient to remove
  91098. * @returns the current particle system
  91099. */
  91100. removeColorRemapGradient(gradient: number): IParticleSystem;
  91101. /**
  91102. * Adds a new alpha remap gradient
  91103. * @param gradient defines the gradient to use (between 0 and 1)
  91104. * @param min defines the alpha remap minimal range
  91105. * @param max defines the alpha remap maximal range
  91106. * @returns the current particle system
  91107. */
  91108. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  91109. /**
  91110. * Remove a specific alpha remap gradient
  91111. * @param gradient defines the gradient to remove
  91112. * @returns the current particle system
  91113. */
  91114. removeAlphaRemapGradient(gradient: number): IParticleSystem;
  91115. /**
  91116. * Adds a new angular speed gradient
  91117. * @param gradient defines the gradient to use (between 0 and 1)
  91118. * @param factor defines the angular speed to affect to the specified gradient
  91119. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  91120. * @returns the current particle system
  91121. */
  91122. addAngularSpeedGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  91123. /**
  91124. * Remove a specific angular speed gradient
  91125. * @param gradient defines the gradient to remove
  91126. * @returns the current particle system
  91127. */
  91128. removeAngularSpeedGradient(gradient: number): IParticleSystem;
  91129. /**
  91130. * Adds a new velocity gradient
  91131. * @param gradient defines the gradient to use (between 0 and 1)
  91132. * @param factor defines the velocity to affect to the specified gradient
  91133. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  91134. * @returns the current particle system
  91135. */
  91136. addVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  91137. /**
  91138. * Remove a specific velocity gradient
  91139. * @param gradient defines the gradient to remove
  91140. * @returns the current particle system
  91141. */
  91142. removeVelocityGradient(gradient: number): IParticleSystem;
  91143. /**
  91144. * Adds a new limit velocity gradient
  91145. * @param gradient defines the gradient to use (between 0 and 1)
  91146. * @param factor defines the limit velocity value to affect to the specified gradient
  91147. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  91148. * @returns the current particle system
  91149. */
  91150. addLimitVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  91151. /**
  91152. * Remove a specific limit velocity gradient
  91153. * @param gradient defines the gradient to remove
  91154. * @returns the current particle system
  91155. */
  91156. removeLimitVelocityGradient(gradient: number): IParticleSystem;
  91157. /**
  91158. * Adds a new drag gradient
  91159. * @param gradient defines the gradient to use (between 0 and 1)
  91160. * @param factor defines the drag value to affect to the specified gradient
  91161. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  91162. * @returns the current particle system
  91163. */
  91164. addDragGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  91165. /**
  91166. * Remove a specific drag gradient
  91167. * @param gradient defines the gradient to remove
  91168. * @returns the current particle system
  91169. */
  91170. removeDragGradient(gradient: number): IParticleSystem;
  91171. /**
  91172. * Adds a new emit rate gradient (please note that this will only work if you set the targetStopDuration property)
  91173. * @param gradient defines the gradient to use (between 0 and 1)
  91174. * @param factor defines the emit rate value to affect to the specified gradient
  91175. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  91176. * @returns the current particle system
  91177. */
  91178. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  91179. /**
  91180. * Remove a specific emit rate gradient
  91181. * @param gradient defines the gradient to remove
  91182. * @returns the current particle system
  91183. */
  91184. removeEmitRateGradient(gradient: number): IParticleSystem;
  91185. /**
  91186. * Adds a new start size gradient (please note that this will only work if you set the targetStopDuration property)
  91187. * @param gradient defines the gradient to use (between 0 and 1)
  91188. * @param factor defines the start size value to affect to the specified gradient
  91189. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  91190. * @returns the current particle system
  91191. */
  91192. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  91193. /**
  91194. * Remove a specific start size gradient
  91195. * @param gradient defines the gradient to remove
  91196. * @returns the current particle system
  91197. */
  91198. removeStartSizeGradient(gradient: number): IParticleSystem;
  91199. private _createRampGradientTexture;
  91200. /**
  91201. * Gets the current list of ramp gradients.
  91202. * You must use addRampGradient and removeRampGradient to udpate this list
  91203. * @returns the list of ramp gradients
  91204. */
  91205. getRampGradients(): Nullable<Array<Color3Gradient>>;
  91206. /** Force the system to rebuild all gradients that need to be resync */
  91207. forceRefreshGradients(): void;
  91208. private _syncRampGradientTexture;
  91209. /**
  91210. * Adds a new ramp gradient used to remap particle colors
  91211. * @param gradient defines the gradient to use (between 0 and 1)
  91212. * @param color defines the color to affect to the specified gradient
  91213. * @returns the current particle system
  91214. */
  91215. addRampGradient(gradient: number, color: Color3): ParticleSystem;
  91216. /**
  91217. * Remove a specific ramp gradient
  91218. * @param gradient defines the gradient to remove
  91219. * @returns the current particle system
  91220. */
  91221. removeRampGradient(gradient: number): ParticleSystem;
  91222. /**
  91223. * Adds a new color gradient
  91224. * @param gradient defines the gradient to use (between 0 and 1)
  91225. * @param color1 defines the color to affect to the specified gradient
  91226. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  91227. * @returns this particle system
  91228. */
  91229. addColorGradient(gradient: number, color1: Color4, color2?: Color4): IParticleSystem;
  91230. /**
  91231. * Remove a specific color gradient
  91232. * @param gradient defines the gradient to remove
  91233. * @returns this particle system
  91234. */
  91235. removeColorGradient(gradient: number): IParticleSystem;
  91236. private _fetchR;
  91237. protected _reset(): void;
  91238. private _resetEffect;
  91239. private _createVertexBuffers;
  91240. private _createIndexBuffer;
  91241. /**
  91242. * Gets the maximum number of particles active at the same time.
  91243. * @returns The max number of active particles.
  91244. */
  91245. getCapacity(): number;
  91246. /**
  91247. * Gets whether there are still active particles in the system.
  91248. * @returns True if it is alive, otherwise false.
  91249. */
  91250. isAlive(): boolean;
  91251. /**
  91252. * Gets if the system has been started. (Note: this will still be true after stop is called)
  91253. * @returns True if it has been started, otherwise false.
  91254. */
  91255. isStarted(): boolean;
  91256. private _prepareSubEmitterInternalArray;
  91257. /**
  91258. * Starts the particle system and begins to emit
  91259. * @param delay defines the delay in milliseconds before starting the system (this.startDelay by default)
  91260. */
  91261. start(delay?: number): void;
  91262. /**
  91263. * Stops the particle system.
  91264. * @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.
  91265. */
  91266. stop(stopSubEmitters?: boolean): void;
  91267. /**
  91268. * Remove all active particles
  91269. */
  91270. reset(): void;
  91271. /**
  91272. * @hidden (for internal use only)
  91273. */
  91274. _appendParticleVertex(index: number, particle: Particle, offsetX: number, offsetY: number): void;
  91275. /**
  91276. * "Recycles" one of the particle by copying it back to the "stock" of particles and removing it from the active list.
  91277. * Its lifetime will start back at 0.
  91278. */
  91279. recycleParticle: (particle: Particle) => void;
  91280. private _stopSubEmitters;
  91281. private _createParticle;
  91282. private _removeFromRoot;
  91283. private _emitFromParticle;
  91284. private _update;
  91285. /** @hidden */
  91286. static _GetAttributeNamesOrOptions(isAnimationSheetEnabled?: boolean, isBillboardBased?: boolean, useRampGradients?: boolean): string[];
  91287. /** @hidden */
  91288. static _GetEffectCreationOptions(isAnimationSheetEnabled?: boolean): string[];
  91289. /**
  91290. * Fill the defines array according to the current settings of the particle system
  91291. * @param defines Array to be updated
  91292. * @param blendMode blend mode to take into account when updating the array
  91293. */
  91294. fillDefines(defines: Array<string>, blendMode: number): void;
  91295. /**
  91296. * Fill the uniforms, attributes and samplers arrays according to the current settings of the particle system
  91297. * @param uniforms Uniforms array to fill
  91298. * @param attributes Attributes array to fill
  91299. * @param samplers Samplers array to fill
  91300. */
  91301. fillUniformsAttributesAndSamplerNames(uniforms: Array<string>, attributes: Array<string>, samplers: Array<string>): void;
  91302. /** @hidden */
  91303. private _getEffect;
  91304. /**
  91305. * Animates the particle system for the current frame by emitting new particles and or animating the living ones.
  91306. * @param preWarmOnly will prevent the system from updating the vertex buffer (default is false)
  91307. */
  91308. animate(preWarmOnly?: boolean): void;
  91309. private _appendParticleVertices;
  91310. /**
  91311. * Rebuilds the particle system.
  91312. */
  91313. rebuild(): void;
  91314. /**
  91315. * Is this system ready to be used/rendered
  91316. * @return true if the system is ready
  91317. */
  91318. isReady(): boolean;
  91319. private _render;
  91320. /**
  91321. * Renders the particle system in its current state.
  91322. * @returns the current number of particles
  91323. */
  91324. render(): number;
  91325. /**
  91326. * Disposes the particle system and free the associated resources
  91327. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  91328. */
  91329. dispose(disposeTexture?: boolean): void;
  91330. /**
  91331. * Clones the particle system.
  91332. * @param name The name of the cloned object
  91333. * @param newEmitter The new emitter to use
  91334. * @returns the cloned particle system
  91335. */
  91336. clone(name: string, newEmitter: any): ParticleSystem;
  91337. /**
  91338. * Serializes the particle system to a JSON object
  91339. * @param serializeTexture defines if the texture must be serialized as well
  91340. * @returns the JSON object
  91341. */
  91342. serialize(serializeTexture?: boolean): any;
  91343. /** @hidden */
  91344. static _Serialize(serializationObject: any, particleSystem: IParticleSystem, serializeTexture: boolean): void;
  91345. /** @hidden */
  91346. static _Parse(parsedParticleSystem: any, particleSystem: IParticleSystem, scene: Scene, rootUrl: string): void;
  91347. /**
  91348. * Parses a JSON object to create a particle system.
  91349. * @param parsedParticleSystem The JSON object to parse
  91350. * @param scene The scene to create the particle system in
  91351. * @param rootUrl The root url to use to load external dependencies like texture
  91352. * @param doNotStart Ignore the preventAutoStart attribute and does not start
  91353. * @returns the Parsed particle system
  91354. */
  91355. static Parse(parsedParticleSystem: any, scene: Scene, rootUrl: string, doNotStart?: boolean): ParticleSystem;
  91356. }
  91357. }
  91358. declare module BABYLON {
  91359. /**
  91360. * A particle represents one of the element emitted by a particle system.
  91361. * This is mainly define by its coordinates, direction, velocity and age.
  91362. */
  91363. export class Particle {
  91364. /**
  91365. * The particle system the particle belongs to.
  91366. */
  91367. particleSystem: ParticleSystem;
  91368. private static _Count;
  91369. /**
  91370. * Unique ID of the particle
  91371. */
  91372. id: number;
  91373. /**
  91374. * The world position of the particle in the scene.
  91375. */
  91376. position: Vector3;
  91377. /**
  91378. * The world direction of the particle in the scene.
  91379. */
  91380. direction: Vector3;
  91381. /**
  91382. * The color of the particle.
  91383. */
  91384. color: Color4;
  91385. /**
  91386. * The color change of the particle per step.
  91387. */
  91388. colorStep: Color4;
  91389. /**
  91390. * Defines how long will the life of the particle be.
  91391. */
  91392. lifeTime: number;
  91393. /**
  91394. * The current age of the particle.
  91395. */
  91396. age: number;
  91397. /**
  91398. * The current size of the particle.
  91399. */
  91400. size: number;
  91401. /**
  91402. * The current scale of the particle.
  91403. */
  91404. scale: Vector2;
  91405. /**
  91406. * The current angle of the particle.
  91407. */
  91408. angle: number;
  91409. /**
  91410. * Defines how fast is the angle changing.
  91411. */
  91412. angularSpeed: number;
  91413. /**
  91414. * Defines the cell index used by the particle to be rendered from a sprite.
  91415. */
  91416. cellIndex: number;
  91417. /**
  91418. * The information required to support color remapping
  91419. */
  91420. remapData: Vector4;
  91421. /** @hidden */
  91422. _randomCellOffset?: number;
  91423. /** @hidden */
  91424. _initialDirection: Nullable<Vector3>;
  91425. /** @hidden */
  91426. _attachedSubEmitters: Nullable<Array<SubEmitter>>;
  91427. /** @hidden */
  91428. _initialStartSpriteCellID: number;
  91429. /** @hidden */
  91430. _initialEndSpriteCellID: number;
  91431. /** @hidden */
  91432. _currentColorGradient: Nullable<ColorGradient>;
  91433. /** @hidden */
  91434. _currentColor1: Color4;
  91435. /** @hidden */
  91436. _currentColor2: Color4;
  91437. /** @hidden */
  91438. _currentSizeGradient: Nullable<FactorGradient>;
  91439. /** @hidden */
  91440. _currentSize1: number;
  91441. /** @hidden */
  91442. _currentSize2: number;
  91443. /** @hidden */
  91444. _currentAngularSpeedGradient: Nullable<FactorGradient>;
  91445. /** @hidden */
  91446. _currentAngularSpeed1: number;
  91447. /** @hidden */
  91448. _currentAngularSpeed2: number;
  91449. /** @hidden */
  91450. _currentVelocityGradient: Nullable<FactorGradient>;
  91451. /** @hidden */
  91452. _currentVelocity1: number;
  91453. /** @hidden */
  91454. _currentVelocity2: number;
  91455. /** @hidden */
  91456. _currentLimitVelocityGradient: Nullable<FactorGradient>;
  91457. /** @hidden */
  91458. _currentLimitVelocity1: number;
  91459. /** @hidden */
  91460. _currentLimitVelocity2: number;
  91461. /** @hidden */
  91462. _currentDragGradient: Nullable<FactorGradient>;
  91463. /** @hidden */
  91464. _currentDrag1: number;
  91465. /** @hidden */
  91466. _currentDrag2: number;
  91467. /** @hidden */
  91468. _randomNoiseCoordinates1: Vector3;
  91469. /** @hidden */
  91470. _randomNoiseCoordinates2: Vector3;
  91471. /** @hidden */
  91472. _localPosition?: Vector3;
  91473. /**
  91474. * Creates a new instance Particle
  91475. * @param particleSystem the particle system the particle belongs to
  91476. */
  91477. constructor(
  91478. /**
  91479. * The particle system the particle belongs to.
  91480. */
  91481. particleSystem: ParticleSystem);
  91482. private updateCellInfoFromSystem;
  91483. /**
  91484. * Defines how the sprite cell index is updated for the particle
  91485. */
  91486. updateCellIndex(): void;
  91487. /** @hidden */
  91488. _inheritParticleInfoToSubEmitter(subEmitter: SubEmitter): void;
  91489. /** @hidden */
  91490. _inheritParticleInfoToSubEmitters(): void;
  91491. /** @hidden */
  91492. _reset(): void;
  91493. /**
  91494. * Copy the properties of particle to another one.
  91495. * @param other the particle to copy the information to.
  91496. */
  91497. copyTo(other: Particle): void;
  91498. }
  91499. }
  91500. declare module BABYLON {
  91501. /**
  91502. * Particle emitter represents a volume emitting particles.
  91503. * This is the responsibility of the implementation to define the volume shape like cone/sphere/box.
  91504. */
  91505. export interface IParticleEmitterType {
  91506. /**
  91507. * Called by the particle System when the direction is computed for the created particle.
  91508. * @param worldMatrix is the world matrix of the particle system
  91509. * @param directionToUpdate is the direction vector to update with the result
  91510. * @param particle is the particle we are computed the direction for
  91511. * @param isLocal defines if the direction should be set in local space
  91512. */
  91513. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  91514. /**
  91515. * Called by the particle System when the position is computed for the created particle.
  91516. * @param worldMatrix is the world matrix of the particle system
  91517. * @param positionToUpdate is the position vector to update with the result
  91518. * @param particle is the particle we are computed the position for
  91519. * @param isLocal defines if the position should be set in local space
  91520. */
  91521. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  91522. /**
  91523. * Clones the current emitter and returns a copy of it
  91524. * @returns the new emitter
  91525. */
  91526. clone(): IParticleEmitterType;
  91527. /**
  91528. * Called by the GPUParticleSystem to setup the update shader
  91529. * @param effect defines the update shader
  91530. */
  91531. applyToShader(effect: Effect): void;
  91532. /**
  91533. * Returns a string to use to update the GPU particles update shader
  91534. * @returns the effect defines string
  91535. */
  91536. getEffectDefines(): string;
  91537. /**
  91538. * Returns a string representing the class name
  91539. * @returns a string containing the class name
  91540. */
  91541. getClassName(): string;
  91542. /**
  91543. * Serializes the particle system to a JSON object.
  91544. * @returns the JSON object
  91545. */
  91546. serialize(): any;
  91547. /**
  91548. * Parse properties from a JSON object
  91549. * @param serializationObject defines the JSON object
  91550. * @param scene defines the hosting scene
  91551. */
  91552. parse(serializationObject: any, scene: Scene): void;
  91553. }
  91554. }
  91555. declare module BABYLON {
  91556. /**
  91557. * Particle emitter emitting particles from the inside of a box.
  91558. * It emits the particles randomly between 2 given directions.
  91559. */
  91560. export class BoxParticleEmitter implements IParticleEmitterType {
  91561. /**
  91562. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  91563. */
  91564. direction1: Vector3;
  91565. /**
  91566. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  91567. */
  91568. direction2: Vector3;
  91569. /**
  91570. * 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.
  91571. */
  91572. minEmitBox: Vector3;
  91573. /**
  91574. * 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.
  91575. */
  91576. maxEmitBox: Vector3;
  91577. /**
  91578. * Creates a new instance BoxParticleEmitter
  91579. */
  91580. constructor();
  91581. /**
  91582. * Called by the particle System when the direction is computed for the created particle.
  91583. * @param worldMatrix is the world matrix of the particle system
  91584. * @param directionToUpdate is the direction vector to update with the result
  91585. * @param particle is the particle we are computed the direction for
  91586. * @param isLocal defines if the direction should be set in local space
  91587. */
  91588. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  91589. /**
  91590. * Called by the particle System when the position is computed for the created particle.
  91591. * @param worldMatrix is the world matrix of the particle system
  91592. * @param positionToUpdate is the position vector to update with the result
  91593. * @param particle is the particle we are computed the position for
  91594. * @param isLocal defines if the position should be set in local space
  91595. */
  91596. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  91597. /**
  91598. * Clones the current emitter and returns a copy of it
  91599. * @returns the new emitter
  91600. */
  91601. clone(): BoxParticleEmitter;
  91602. /**
  91603. * Called by the GPUParticleSystem to setup the update shader
  91604. * @param effect defines the update shader
  91605. */
  91606. applyToShader(effect: Effect): void;
  91607. /**
  91608. * Returns a string to use to update the GPU particles update shader
  91609. * @returns a string containng the defines string
  91610. */
  91611. getEffectDefines(): string;
  91612. /**
  91613. * Returns the string "BoxParticleEmitter"
  91614. * @returns a string containing the class name
  91615. */
  91616. getClassName(): string;
  91617. /**
  91618. * Serializes the particle system to a JSON object.
  91619. * @returns the JSON object
  91620. */
  91621. serialize(): any;
  91622. /**
  91623. * Parse properties from a JSON object
  91624. * @param serializationObject defines the JSON object
  91625. */
  91626. parse(serializationObject: any): void;
  91627. }
  91628. }
  91629. declare module BABYLON {
  91630. /**
  91631. * Particle emitter emitting particles from the inside of a cone.
  91632. * It emits the particles alongside the cone volume from the base to the particle.
  91633. * The emission direction might be randomized.
  91634. */
  91635. export class ConeParticleEmitter implements IParticleEmitterType {
  91636. /** defines how much to randomize the particle direction [0-1] (default is 0) */
  91637. directionRandomizer: number;
  91638. private _radius;
  91639. private _angle;
  91640. private _height;
  91641. /**
  91642. * Gets or sets a value indicating where on the radius the start position should be picked (1 = everywhere, 0 = only surface)
  91643. */
  91644. radiusRange: number;
  91645. /**
  91646. * Gets or sets a value indicating where on the height the start position should be picked (1 = everywhere, 0 = only surface)
  91647. */
  91648. heightRange: number;
  91649. /**
  91650. * Gets or sets a value indicating if all the particles should be emitted from the spawn point only (the base of the cone)
  91651. */
  91652. emitFromSpawnPointOnly: boolean;
  91653. /**
  91654. * Gets or sets the radius of the emission cone
  91655. */
  91656. get radius(): number;
  91657. set radius(value: number);
  91658. /**
  91659. * Gets or sets the angle of the emission cone
  91660. */
  91661. get angle(): number;
  91662. set angle(value: number);
  91663. private _buildHeight;
  91664. /**
  91665. * Creates a new instance ConeParticleEmitter
  91666. * @param radius the radius of the emission cone (1 by default)
  91667. * @param angle the cone base angle (PI by default)
  91668. * @param directionRandomizer defines how much to randomize the particle direction [0-1] (default is 0)
  91669. */
  91670. constructor(radius?: number, angle?: number,
  91671. /** defines how much to randomize the particle direction [0-1] (default is 0) */
  91672. directionRandomizer?: number);
  91673. /**
  91674. * Called by the particle System when the direction is computed for the created particle.
  91675. * @param worldMatrix is the world matrix of the particle system
  91676. * @param directionToUpdate is the direction vector to update with the result
  91677. * @param particle is the particle we are computed the direction for
  91678. * @param isLocal defines if the direction should be set in local space
  91679. */
  91680. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  91681. /**
  91682. * Called by the particle System when the position is computed for the created particle.
  91683. * @param worldMatrix is the world matrix of the particle system
  91684. * @param positionToUpdate is the position vector to update with the result
  91685. * @param particle is the particle we are computed the position for
  91686. * @param isLocal defines if the position should be set in local space
  91687. */
  91688. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  91689. /**
  91690. * Clones the current emitter and returns a copy of it
  91691. * @returns the new emitter
  91692. */
  91693. clone(): ConeParticleEmitter;
  91694. /**
  91695. * Called by the GPUParticleSystem to setup the update shader
  91696. * @param effect defines the update shader
  91697. */
  91698. applyToShader(effect: Effect): void;
  91699. /**
  91700. * Returns a string to use to update the GPU particles update shader
  91701. * @returns a string containng the defines string
  91702. */
  91703. getEffectDefines(): string;
  91704. /**
  91705. * Returns the string "ConeParticleEmitter"
  91706. * @returns a string containing the class name
  91707. */
  91708. getClassName(): string;
  91709. /**
  91710. * Serializes the particle system to a JSON object.
  91711. * @returns the JSON object
  91712. */
  91713. serialize(): any;
  91714. /**
  91715. * Parse properties from a JSON object
  91716. * @param serializationObject defines the JSON object
  91717. */
  91718. parse(serializationObject: any): void;
  91719. }
  91720. }
  91721. declare module BABYLON {
  91722. /**
  91723. * Particle emitter emitting particles from the inside of a cylinder.
  91724. * It emits the particles alongside the cylinder radius. The emission direction might be randomized.
  91725. */
  91726. export class CylinderParticleEmitter implements IParticleEmitterType {
  91727. /**
  91728. * The radius of the emission cylinder.
  91729. */
  91730. radius: number;
  91731. /**
  91732. * The height of the emission cylinder.
  91733. */
  91734. height: number;
  91735. /**
  91736. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  91737. */
  91738. radiusRange: number;
  91739. /**
  91740. * How much to randomize the particle direction [0-1].
  91741. */
  91742. directionRandomizer: number;
  91743. /**
  91744. * Creates a new instance CylinderParticleEmitter
  91745. * @param radius the radius of the emission cylinder (1 by default)
  91746. * @param height the height of the emission cylinder (1 by default)
  91747. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  91748. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  91749. */
  91750. constructor(
  91751. /**
  91752. * The radius of the emission cylinder.
  91753. */
  91754. radius?: number,
  91755. /**
  91756. * The height of the emission cylinder.
  91757. */
  91758. height?: number,
  91759. /**
  91760. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  91761. */
  91762. radiusRange?: number,
  91763. /**
  91764. * How much to randomize the particle direction [0-1].
  91765. */
  91766. directionRandomizer?: number);
  91767. /**
  91768. * Called by the particle System when the direction is computed for the created particle.
  91769. * @param worldMatrix is the world matrix of the particle system
  91770. * @param directionToUpdate is the direction vector to update with the result
  91771. * @param particle is the particle we are computed the direction for
  91772. * @param isLocal defines if the direction should be set in local space
  91773. */
  91774. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  91775. /**
  91776. * Called by the particle System when the position is computed for the created particle.
  91777. * @param worldMatrix is the world matrix of the particle system
  91778. * @param positionToUpdate is the position vector to update with the result
  91779. * @param particle is the particle we are computed the position for
  91780. * @param isLocal defines if the position should be set in local space
  91781. */
  91782. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  91783. /**
  91784. * Clones the current emitter and returns a copy of it
  91785. * @returns the new emitter
  91786. */
  91787. clone(): CylinderParticleEmitter;
  91788. /**
  91789. * Called by the GPUParticleSystem to setup the update shader
  91790. * @param effect defines the update shader
  91791. */
  91792. applyToShader(effect: Effect): void;
  91793. /**
  91794. * Returns a string to use to update the GPU particles update shader
  91795. * @returns a string containng the defines string
  91796. */
  91797. getEffectDefines(): string;
  91798. /**
  91799. * Returns the string "CylinderParticleEmitter"
  91800. * @returns a string containing the class name
  91801. */
  91802. getClassName(): string;
  91803. /**
  91804. * Serializes the particle system to a JSON object.
  91805. * @returns the JSON object
  91806. */
  91807. serialize(): any;
  91808. /**
  91809. * Parse properties from a JSON object
  91810. * @param serializationObject defines the JSON object
  91811. */
  91812. parse(serializationObject: any): void;
  91813. }
  91814. /**
  91815. * Particle emitter emitting particles from the inside of a cylinder.
  91816. * It emits the particles randomly between two vectors.
  91817. */
  91818. export class CylinderDirectedParticleEmitter extends CylinderParticleEmitter {
  91819. /**
  91820. * The min limit of the emission direction.
  91821. */
  91822. direction1: Vector3;
  91823. /**
  91824. * The max limit of the emission direction.
  91825. */
  91826. direction2: Vector3;
  91827. /**
  91828. * Creates a new instance CylinderDirectedParticleEmitter
  91829. * @param radius the radius of the emission cylinder (1 by default)
  91830. * @param height the height of the emission cylinder (1 by default)
  91831. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  91832. * @param direction1 the min limit of the emission direction (up vector by default)
  91833. * @param direction2 the max limit of the emission direction (up vector by default)
  91834. */
  91835. constructor(radius?: number, height?: number, radiusRange?: number,
  91836. /**
  91837. * The min limit of the emission direction.
  91838. */
  91839. direction1?: Vector3,
  91840. /**
  91841. * The max limit of the emission direction.
  91842. */
  91843. direction2?: Vector3);
  91844. /**
  91845. * Called by the particle System when the direction is computed for the created particle.
  91846. * @param worldMatrix is the world matrix of the particle system
  91847. * @param directionToUpdate is the direction vector to update with the result
  91848. * @param particle is the particle we are computed the direction for
  91849. */
  91850. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  91851. /**
  91852. * Clones the current emitter and returns a copy of it
  91853. * @returns the new emitter
  91854. */
  91855. clone(): CylinderDirectedParticleEmitter;
  91856. /**
  91857. * Called by the GPUParticleSystem to setup the update shader
  91858. * @param effect defines the update shader
  91859. */
  91860. applyToShader(effect: Effect): void;
  91861. /**
  91862. * Returns a string to use to update the GPU particles update shader
  91863. * @returns a string containng the defines string
  91864. */
  91865. getEffectDefines(): string;
  91866. /**
  91867. * Returns the string "CylinderDirectedParticleEmitter"
  91868. * @returns a string containing the class name
  91869. */
  91870. getClassName(): string;
  91871. /**
  91872. * Serializes the particle system to a JSON object.
  91873. * @returns the JSON object
  91874. */
  91875. serialize(): any;
  91876. /**
  91877. * Parse properties from a JSON object
  91878. * @param serializationObject defines the JSON object
  91879. */
  91880. parse(serializationObject: any): void;
  91881. }
  91882. }
  91883. declare module BABYLON {
  91884. /**
  91885. * Particle emitter emitting particles from the inside of a hemisphere.
  91886. * It emits the particles alongside the hemisphere radius. The emission direction might be randomized.
  91887. */
  91888. export class HemisphericParticleEmitter implements IParticleEmitterType {
  91889. /**
  91890. * The radius of the emission hemisphere.
  91891. */
  91892. radius: number;
  91893. /**
  91894. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  91895. */
  91896. radiusRange: number;
  91897. /**
  91898. * How much to randomize the particle direction [0-1].
  91899. */
  91900. directionRandomizer: number;
  91901. /**
  91902. * Creates a new instance HemisphericParticleEmitter
  91903. * @param radius the radius of the emission hemisphere (1 by default)
  91904. * @param radiusRange the range of the emission hemisphere [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  91905. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  91906. */
  91907. constructor(
  91908. /**
  91909. * The radius of the emission hemisphere.
  91910. */
  91911. radius?: number,
  91912. /**
  91913. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  91914. */
  91915. radiusRange?: number,
  91916. /**
  91917. * How much to randomize the particle direction [0-1].
  91918. */
  91919. directionRandomizer?: number);
  91920. /**
  91921. * Called by the particle System when the direction is computed for the created particle.
  91922. * @param worldMatrix is the world matrix of the particle system
  91923. * @param directionToUpdate is the direction vector to update with the result
  91924. * @param particle is the particle we are computed the direction for
  91925. * @param isLocal defines if the direction should be set in local space
  91926. */
  91927. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  91928. /**
  91929. * Called by the particle System when the position is computed for the created particle.
  91930. * @param worldMatrix is the world matrix of the particle system
  91931. * @param positionToUpdate is the position vector to update with the result
  91932. * @param particle is the particle we are computed the position for
  91933. * @param isLocal defines if the position should be set in local space
  91934. */
  91935. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  91936. /**
  91937. * Clones the current emitter and returns a copy of it
  91938. * @returns the new emitter
  91939. */
  91940. clone(): HemisphericParticleEmitter;
  91941. /**
  91942. * Called by the GPUParticleSystem to setup the update shader
  91943. * @param effect defines the update shader
  91944. */
  91945. applyToShader(effect: Effect): void;
  91946. /**
  91947. * Returns a string to use to update the GPU particles update shader
  91948. * @returns a string containng the defines string
  91949. */
  91950. getEffectDefines(): string;
  91951. /**
  91952. * Returns the string "HemisphericParticleEmitter"
  91953. * @returns a string containing the class name
  91954. */
  91955. getClassName(): string;
  91956. /**
  91957. * Serializes the particle system to a JSON object.
  91958. * @returns the JSON object
  91959. */
  91960. serialize(): any;
  91961. /**
  91962. * Parse properties from a JSON object
  91963. * @param serializationObject defines the JSON object
  91964. */
  91965. parse(serializationObject: any): void;
  91966. }
  91967. }
  91968. declare module BABYLON {
  91969. /**
  91970. * Particle emitter emitting particles from a point.
  91971. * It emits the particles randomly between 2 given directions.
  91972. */
  91973. export class PointParticleEmitter implements IParticleEmitterType {
  91974. /**
  91975. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  91976. */
  91977. direction1: Vector3;
  91978. /**
  91979. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  91980. */
  91981. direction2: Vector3;
  91982. /**
  91983. * Creates a new instance PointParticleEmitter
  91984. */
  91985. constructor();
  91986. /**
  91987. * Called by the particle System when the direction is computed for the created particle.
  91988. * @param worldMatrix is the world matrix of the particle system
  91989. * @param directionToUpdate is the direction vector to update with the result
  91990. * @param particle is the particle we are computed the direction for
  91991. * @param isLocal defines if the direction should be set in local space
  91992. */
  91993. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  91994. /**
  91995. * Called by the particle System when the position is computed for the created particle.
  91996. * @param worldMatrix is the world matrix of the particle system
  91997. * @param positionToUpdate is the position vector to update with the result
  91998. * @param particle is the particle we are computed the position for
  91999. * @param isLocal defines if the position should be set in local space
  92000. */
  92001. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  92002. /**
  92003. * Clones the current emitter and returns a copy of it
  92004. * @returns the new emitter
  92005. */
  92006. clone(): PointParticleEmitter;
  92007. /**
  92008. * Called by the GPUParticleSystem to setup the update shader
  92009. * @param effect defines the update shader
  92010. */
  92011. applyToShader(effect: Effect): void;
  92012. /**
  92013. * Returns a string to use to update the GPU particles update shader
  92014. * @returns a string containng the defines string
  92015. */
  92016. getEffectDefines(): string;
  92017. /**
  92018. * Returns the string "PointParticleEmitter"
  92019. * @returns a string containing the class name
  92020. */
  92021. getClassName(): string;
  92022. /**
  92023. * Serializes the particle system to a JSON object.
  92024. * @returns the JSON object
  92025. */
  92026. serialize(): any;
  92027. /**
  92028. * Parse properties from a JSON object
  92029. * @param serializationObject defines the JSON object
  92030. */
  92031. parse(serializationObject: any): void;
  92032. }
  92033. }
  92034. declare module BABYLON {
  92035. /**
  92036. * Particle emitter emitting particles from the inside of a sphere.
  92037. * It emits the particles alongside the sphere radius. The emission direction might be randomized.
  92038. */
  92039. export class SphereParticleEmitter implements IParticleEmitterType {
  92040. /**
  92041. * The radius of the emission sphere.
  92042. */
  92043. radius: number;
  92044. /**
  92045. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  92046. */
  92047. radiusRange: number;
  92048. /**
  92049. * How much to randomize the particle direction [0-1].
  92050. */
  92051. directionRandomizer: number;
  92052. /**
  92053. * Creates a new instance SphereParticleEmitter
  92054. * @param radius the radius of the emission sphere (1 by default)
  92055. * @param radiusRange the range of the emission sphere [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  92056. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  92057. */
  92058. constructor(
  92059. /**
  92060. * The radius of the emission sphere.
  92061. */
  92062. radius?: number,
  92063. /**
  92064. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  92065. */
  92066. radiusRange?: number,
  92067. /**
  92068. * How much to randomize the particle direction [0-1].
  92069. */
  92070. directionRandomizer?: number);
  92071. /**
  92072. * Called by the particle System when the direction is computed for the created particle.
  92073. * @param worldMatrix is the world matrix of the particle system
  92074. * @param directionToUpdate is the direction vector to update with the result
  92075. * @param particle is the particle we are computed the direction for
  92076. * @param isLocal defines if the direction should be set in local space
  92077. */
  92078. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  92079. /**
  92080. * Called by the particle System when the position is computed for the created particle.
  92081. * @param worldMatrix is the world matrix of the particle system
  92082. * @param positionToUpdate is the position vector to update with the result
  92083. * @param particle is the particle we are computed the position for
  92084. * @param isLocal defines if the position should be set in local space
  92085. */
  92086. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  92087. /**
  92088. * Clones the current emitter and returns a copy of it
  92089. * @returns the new emitter
  92090. */
  92091. clone(): SphereParticleEmitter;
  92092. /**
  92093. * Called by the GPUParticleSystem to setup the update shader
  92094. * @param effect defines the update shader
  92095. */
  92096. applyToShader(effect: Effect): void;
  92097. /**
  92098. * Returns a string to use to update the GPU particles update shader
  92099. * @returns a string containng the defines string
  92100. */
  92101. getEffectDefines(): string;
  92102. /**
  92103. * Returns the string "SphereParticleEmitter"
  92104. * @returns a string containing the class name
  92105. */
  92106. getClassName(): string;
  92107. /**
  92108. * Serializes the particle system to a JSON object.
  92109. * @returns the JSON object
  92110. */
  92111. serialize(): any;
  92112. /**
  92113. * Parse properties from a JSON object
  92114. * @param serializationObject defines the JSON object
  92115. */
  92116. parse(serializationObject: any): void;
  92117. }
  92118. /**
  92119. * Particle emitter emitting particles from the inside of a sphere.
  92120. * It emits the particles randomly between two vectors.
  92121. */
  92122. export class SphereDirectedParticleEmitter extends SphereParticleEmitter {
  92123. /**
  92124. * The min limit of the emission direction.
  92125. */
  92126. direction1: Vector3;
  92127. /**
  92128. * The max limit of the emission direction.
  92129. */
  92130. direction2: Vector3;
  92131. /**
  92132. * Creates a new instance SphereDirectedParticleEmitter
  92133. * @param radius the radius of the emission sphere (1 by default)
  92134. * @param direction1 the min limit of the emission direction (up vector by default)
  92135. * @param direction2 the max limit of the emission direction (up vector by default)
  92136. */
  92137. constructor(radius?: number,
  92138. /**
  92139. * The min limit of the emission direction.
  92140. */
  92141. direction1?: Vector3,
  92142. /**
  92143. * The max limit of the emission direction.
  92144. */
  92145. direction2?: Vector3);
  92146. /**
  92147. * Called by the particle System when the direction is computed for the created particle.
  92148. * @param worldMatrix is the world matrix of the particle system
  92149. * @param directionToUpdate is the direction vector to update with the result
  92150. * @param particle is the particle we are computed the direction for
  92151. */
  92152. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  92153. /**
  92154. * Clones the current emitter and returns a copy of it
  92155. * @returns the new emitter
  92156. */
  92157. clone(): SphereDirectedParticleEmitter;
  92158. /**
  92159. * Called by the GPUParticleSystem to setup the update shader
  92160. * @param effect defines the update shader
  92161. */
  92162. applyToShader(effect: Effect): void;
  92163. /**
  92164. * Returns a string to use to update the GPU particles update shader
  92165. * @returns a string containng the defines string
  92166. */
  92167. getEffectDefines(): string;
  92168. /**
  92169. * Returns the string "SphereDirectedParticleEmitter"
  92170. * @returns a string containing the class name
  92171. */
  92172. getClassName(): string;
  92173. /**
  92174. * Serializes the particle system to a JSON object.
  92175. * @returns the JSON object
  92176. */
  92177. serialize(): any;
  92178. /**
  92179. * Parse properties from a JSON object
  92180. * @param serializationObject defines the JSON object
  92181. */
  92182. parse(serializationObject: any): void;
  92183. }
  92184. }
  92185. declare module BABYLON {
  92186. /**
  92187. * Particle emitter emitting particles from a custom list of positions.
  92188. */
  92189. export class CustomParticleEmitter implements IParticleEmitterType {
  92190. /**
  92191. * Gets or sets the position generator that will create the inital position of each particle.
  92192. * Index will be provided when used with GPU particle. Particle will be provided when used with CPU particles
  92193. */
  92194. particlePositionGenerator: (index: number, particle: Nullable<Particle>, outPosition: Vector3) => void;
  92195. /**
  92196. * Gets or sets the destination generator that will create the final destination of each particle.
  92197. * * Index will be provided when used with GPU particle. Particle will be provided when used with CPU particles
  92198. */
  92199. particleDestinationGenerator: (index: number, particle: Nullable<Particle>, outDestination: Vector3) => void;
  92200. /**
  92201. * Creates a new instance CustomParticleEmitter
  92202. */
  92203. constructor();
  92204. /**
  92205. * Called by the particle System when the direction is computed for the created particle.
  92206. * @param worldMatrix is the world matrix of the particle system
  92207. * @param directionToUpdate is the direction vector to update with the result
  92208. * @param particle is the particle we are computed the direction for
  92209. * @param isLocal defines if the direction should be set in local space
  92210. */
  92211. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  92212. /**
  92213. * Called by the particle System when the position is computed for the created particle.
  92214. * @param worldMatrix is the world matrix of the particle system
  92215. * @param positionToUpdate is the position vector to update with the result
  92216. * @param particle is the particle we are computed the position for
  92217. * @param isLocal defines if the position should be set in local space
  92218. */
  92219. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  92220. /**
  92221. * Clones the current emitter and returns a copy of it
  92222. * @returns the new emitter
  92223. */
  92224. clone(): CustomParticleEmitter;
  92225. /**
  92226. * Called by the GPUParticleSystem to setup the update shader
  92227. * @param effect defines the update shader
  92228. */
  92229. applyToShader(effect: Effect): void;
  92230. /**
  92231. * Returns a string to use to update the GPU particles update shader
  92232. * @returns a string containng the defines string
  92233. */
  92234. getEffectDefines(): string;
  92235. /**
  92236. * Returns the string "PointParticleEmitter"
  92237. * @returns a string containing the class name
  92238. */
  92239. getClassName(): string;
  92240. /**
  92241. * Serializes the particle system to a JSON object.
  92242. * @returns the JSON object
  92243. */
  92244. serialize(): any;
  92245. /**
  92246. * Parse properties from a JSON object
  92247. * @param serializationObject defines the JSON object
  92248. */
  92249. parse(serializationObject: any): void;
  92250. }
  92251. }
  92252. declare module BABYLON {
  92253. /**
  92254. * Particle emitter emitting particles from the inside of a box.
  92255. * It emits the particles randomly between 2 given directions.
  92256. */
  92257. export class MeshParticleEmitter implements IParticleEmitterType {
  92258. private _indices;
  92259. private _positions;
  92260. private _normals;
  92261. private _storedNormal;
  92262. private _mesh;
  92263. /**
  92264. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  92265. */
  92266. direction1: Vector3;
  92267. /**
  92268. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  92269. */
  92270. direction2: Vector3;
  92271. /**
  92272. * Gets or sets a boolean indicating that particle directions must be built from mesh face normals
  92273. */
  92274. useMeshNormalsForDirection: boolean;
  92275. /** Defines the mesh to use as source */
  92276. get mesh(): Nullable<AbstractMesh>;
  92277. set mesh(value: Nullable<AbstractMesh>);
  92278. /**
  92279. * Creates a new instance MeshParticleEmitter
  92280. * @param mesh defines the mesh to use as source
  92281. */
  92282. constructor(mesh?: Nullable<AbstractMesh>);
  92283. /**
  92284. * Called by the particle System when the direction is computed for the created particle.
  92285. * @param worldMatrix is the world matrix of the particle system
  92286. * @param directionToUpdate is the direction vector to update with the result
  92287. * @param particle is the particle we are computed the direction for
  92288. * @param isLocal defines if the direction should be set in local space
  92289. */
  92290. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  92291. /**
  92292. * Called by the particle System when the position is computed for the created particle.
  92293. * @param worldMatrix is the world matrix of the particle system
  92294. * @param positionToUpdate is the position vector to update with the result
  92295. * @param particle is the particle we are computed the position for
  92296. * @param isLocal defines if the position should be set in local space
  92297. */
  92298. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  92299. /**
  92300. * Clones the current emitter and returns a copy of it
  92301. * @returns the new emitter
  92302. */
  92303. clone(): MeshParticleEmitter;
  92304. /**
  92305. * Called by the GPUParticleSystem to setup the update shader
  92306. * @param effect defines the update shader
  92307. */
  92308. applyToShader(effect: Effect): void;
  92309. /**
  92310. * Returns a string to use to update the GPU particles update shader
  92311. * @returns a string containng the defines string
  92312. */
  92313. getEffectDefines(): string;
  92314. /**
  92315. * Returns the string "BoxParticleEmitter"
  92316. * @returns a string containing the class name
  92317. */
  92318. getClassName(): string;
  92319. /**
  92320. * Serializes the particle system to a JSON object.
  92321. * @returns the JSON object
  92322. */
  92323. serialize(): any;
  92324. /**
  92325. * Parse properties from a JSON object
  92326. * @param serializationObject defines the JSON object
  92327. * @param scene defines the hosting scene
  92328. */
  92329. parse(serializationObject: any, scene: Scene): void;
  92330. }
  92331. }
  92332. declare module BABYLON {
  92333. /**
  92334. * Interface representing a particle system in Babylon.js.
  92335. * This groups the common functionalities that needs to be implemented in order to create a particle system.
  92336. * A particle system represents a way to manage particles from their emission to their animation and rendering.
  92337. */
  92338. export interface IParticleSystem {
  92339. /**
  92340. * List of animations used by the particle system.
  92341. */
  92342. animations: Animation[];
  92343. /**
  92344. * The id of the Particle system.
  92345. */
  92346. id: string;
  92347. /**
  92348. * The name of the Particle system.
  92349. */
  92350. name: string;
  92351. /**
  92352. * The emitter represents the Mesh or position we are attaching the particle system to.
  92353. */
  92354. emitter: Nullable<AbstractMesh | Vector3>;
  92355. /**
  92356. * Gets or sets a boolean indicating if the particles must be rendered as billboard or aligned with the direction
  92357. */
  92358. isBillboardBased: boolean;
  92359. /**
  92360. * The rendering group used by the Particle system to chose when to render.
  92361. */
  92362. renderingGroupId: number;
  92363. /**
  92364. * The layer mask we are rendering the particles through.
  92365. */
  92366. layerMask: number;
  92367. /**
  92368. * The overall motion speed (0.01 is default update speed, faster updates = faster animation)
  92369. */
  92370. updateSpeed: number;
  92371. /**
  92372. * The amount of time the particle system is running (depends of the overall update speed).
  92373. */
  92374. targetStopDuration: number;
  92375. /**
  92376. * The texture used to render each particle. (this can be a spritesheet)
  92377. */
  92378. particleTexture: Nullable<Texture>;
  92379. /**
  92380. * Blend mode use to render the particle, it can be either ParticleSystem.BLENDMODE_ONEONE, ParticleSystem.BLENDMODE_STANDARD or ParticleSystem.BLENDMODE_ADD.
  92381. */
  92382. blendMode: number;
  92383. /**
  92384. * Minimum life time of emitting particles.
  92385. */
  92386. minLifeTime: number;
  92387. /**
  92388. * Maximum life time of emitting particles.
  92389. */
  92390. maxLifeTime: number;
  92391. /**
  92392. * Minimum Size of emitting particles.
  92393. */
  92394. minSize: number;
  92395. /**
  92396. * Maximum Size of emitting particles.
  92397. */
  92398. maxSize: number;
  92399. /**
  92400. * Minimum scale of emitting particles on X axis.
  92401. */
  92402. minScaleX: number;
  92403. /**
  92404. * Maximum scale of emitting particles on X axis.
  92405. */
  92406. maxScaleX: number;
  92407. /**
  92408. * Minimum scale of emitting particles on Y axis.
  92409. */
  92410. minScaleY: number;
  92411. /**
  92412. * Maximum scale of emitting particles on Y axis.
  92413. */
  92414. maxScaleY: number;
  92415. /**
  92416. * Random color of each particle after it has been emitted, between color1 and color2 vectors.
  92417. */
  92418. color1: Color4;
  92419. /**
  92420. * Random color of each particle after it has been emitted, between color1 and color2 vectors.
  92421. */
  92422. color2: Color4;
  92423. /**
  92424. * Color the particle will have at the end of its lifetime.
  92425. */
  92426. colorDead: Color4;
  92427. /**
  92428. * The maximum number of particles to emit per frame until we reach the activeParticleCount value
  92429. */
  92430. emitRate: number;
  92431. /**
  92432. * You can use gravity if you want to give an orientation to your particles.
  92433. */
  92434. gravity: Vector3;
  92435. /**
  92436. * Minimum power of emitting particles.
  92437. */
  92438. minEmitPower: number;
  92439. /**
  92440. * Maximum power of emitting particles.
  92441. */
  92442. maxEmitPower: number;
  92443. /**
  92444. * Minimum angular speed of emitting particles (Z-axis rotation for each particle).
  92445. */
  92446. minAngularSpeed: number;
  92447. /**
  92448. * Maximum angular speed of emitting particles (Z-axis rotation for each particle).
  92449. */
  92450. maxAngularSpeed: number;
  92451. /**
  92452. * Gets or sets the minimal initial rotation in radians.
  92453. */
  92454. minInitialRotation: number;
  92455. /**
  92456. * Gets or sets the maximal initial rotation in radians.
  92457. */
  92458. maxInitialRotation: number;
  92459. /**
  92460. * The particle emitter type defines the emitter used by the particle system.
  92461. * It can be for example box, sphere, or cone...
  92462. */
  92463. particleEmitterType: Nullable<IParticleEmitterType>;
  92464. /**
  92465. * Defines the delay in milliseconds before starting the system (0 by default)
  92466. */
  92467. startDelay: number;
  92468. /**
  92469. * 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
  92470. */
  92471. preWarmCycles: number;
  92472. /**
  92473. * Gets or sets a value indicating the time step multiplier to use in pre-warm mode (default is 1)
  92474. */
  92475. preWarmStepOffset: number;
  92476. /**
  92477. * 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)
  92478. */
  92479. spriteCellChangeSpeed: number;
  92480. /**
  92481. * If using a spritesheet (isAnimationSheetEnabled) defines the first sprite cell to display
  92482. */
  92483. startSpriteCellID: number;
  92484. /**
  92485. * If using a spritesheet (isAnimationSheetEnabled) defines the last sprite cell to display
  92486. */
  92487. endSpriteCellID: number;
  92488. /**
  92489. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell width to use
  92490. */
  92491. spriteCellWidth: number;
  92492. /**
  92493. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell height to use
  92494. */
  92495. spriteCellHeight: number;
  92496. /**
  92497. * This allows the system to random pick the start cell ID between startSpriteCellID and endSpriteCellID
  92498. */
  92499. spriteRandomStartCell: boolean;
  92500. /**
  92501. * Gets or sets a boolean indicating if a spritesheet is used to animate the particles texture
  92502. */
  92503. isAnimationSheetEnabled: boolean;
  92504. /** Gets or sets a Vector2 used to move the pivot (by default (0,0)) */
  92505. translationPivot: Vector2;
  92506. /**
  92507. * Gets or sets a texture used to add random noise to particle positions
  92508. */
  92509. noiseTexture: Nullable<BaseTexture>;
  92510. /** Gets or sets the strength to apply to the noise value (default is (10, 10, 10)) */
  92511. noiseStrength: Vector3;
  92512. /**
  92513. * Gets or sets the billboard mode to use when isBillboardBased = true.
  92514. * Value can be: ParticleSystem.BILLBOARDMODE_ALL, ParticleSystem.BILLBOARDMODE_Y, ParticleSystem.BILLBOARDMODE_STRETCHED
  92515. */
  92516. billboardMode: number;
  92517. /** Gets or sets a value indicating the damping to apply if the limit velocity factor is reached */
  92518. limitVelocityDamping: number;
  92519. /**
  92520. * Gets or sets a boolean indicating that hosted animations (in the system.animations array) must be started when system.start() is called
  92521. */
  92522. beginAnimationOnStart: boolean;
  92523. /**
  92524. * Gets or sets the frame to start the animation from when beginAnimationOnStart is true
  92525. */
  92526. beginAnimationFrom: number;
  92527. /**
  92528. * Gets or sets the frame to end the animation on when beginAnimationOnStart is true
  92529. */
  92530. beginAnimationTo: number;
  92531. /**
  92532. * Gets or sets a boolean indicating if animations must loop when beginAnimationOnStart is true
  92533. */
  92534. beginAnimationLoop: boolean;
  92535. /**
  92536. * Specifies whether the particle system will be disposed once it reaches the end of the animation.
  92537. */
  92538. disposeOnStop: boolean;
  92539. /**
  92540. * Specifies if the particles are updated in emitter local space or world space
  92541. */
  92542. isLocal: boolean;
  92543. /** Snippet ID if the particle system was created from the snippet server */
  92544. snippetId: string;
  92545. /**
  92546. * Gets the maximum number of particles active at the same time.
  92547. * @returns The max number of active particles.
  92548. */
  92549. getCapacity(): number;
  92550. /**
  92551. * Gets the number of particles active at the same time.
  92552. * @returns The number of active particles.
  92553. */
  92554. getActiveCount(): number;
  92555. /**
  92556. * Gets if the system has been started. (Note: this will still be true after stop is called)
  92557. * @returns True if it has been started, otherwise false.
  92558. */
  92559. isStarted(): boolean;
  92560. /**
  92561. * Animates the particle system for this frame.
  92562. */
  92563. animate(): void;
  92564. /**
  92565. * Renders the particle system in its current state.
  92566. * @returns the current number of particles
  92567. */
  92568. render(): number;
  92569. /**
  92570. * Dispose the particle system and frees its associated resources.
  92571. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  92572. */
  92573. dispose(disposeTexture?: boolean): void;
  92574. /**
  92575. * An event triggered when the system is disposed
  92576. */
  92577. onDisposeObservable: Observable<IParticleSystem>;
  92578. /**
  92579. * Clones the particle system.
  92580. * @param name The name of the cloned object
  92581. * @param newEmitter The new emitter to use
  92582. * @returns the cloned particle system
  92583. */
  92584. clone(name: string, newEmitter: any): Nullable<IParticleSystem>;
  92585. /**
  92586. * Serializes the particle system to a JSON object
  92587. * @param serializeTexture defines if the texture must be serialized as well
  92588. * @returns the JSON object
  92589. */
  92590. serialize(serializeTexture: boolean): any;
  92591. /**
  92592. * Rebuild the particle system
  92593. */
  92594. rebuild(): void;
  92595. /** Force the system to rebuild all gradients that need to be resync */
  92596. forceRefreshGradients(): void;
  92597. /**
  92598. * Starts the particle system and begins to emit
  92599. * @param delay defines the delay in milliseconds before starting the system (0 by default)
  92600. */
  92601. start(delay?: number): void;
  92602. /**
  92603. * Stops the particle system.
  92604. */
  92605. stop(): void;
  92606. /**
  92607. * Remove all active particles
  92608. */
  92609. reset(): void;
  92610. /**
  92611. * Gets a boolean indicating that the system is stopping
  92612. * @returns true if the system is currently stopping
  92613. */
  92614. isStopping(): boolean;
  92615. /**
  92616. * Is this system ready to be used/rendered
  92617. * @return true if the system is ready
  92618. */
  92619. isReady(): boolean;
  92620. /**
  92621. * Returns the string "ParticleSystem"
  92622. * @returns a string containing the class name
  92623. */
  92624. getClassName(): string;
  92625. /**
  92626. * Gets the custom effect used to render the particles
  92627. * @param blendMode Blend mode for which the effect should be retrieved
  92628. * @returns The effect
  92629. */
  92630. getCustomEffect(blendMode: number): Nullable<Effect>;
  92631. /**
  92632. * Sets the custom effect used to render the particles
  92633. * @param effect The effect to set
  92634. * @param blendMode Blend mode for which the effect should be set
  92635. */
  92636. setCustomEffect(effect: Nullable<Effect>, blendMode: number): void;
  92637. /**
  92638. * Fill the defines array according to the current settings of the particle system
  92639. * @param defines Array to be updated
  92640. * @param blendMode blend mode to take into account when updating the array
  92641. */
  92642. fillDefines(defines: Array<string>, blendMode: number): void;
  92643. /**
  92644. * Fill the uniforms, attributes and samplers arrays according to the current settings of the particle system
  92645. * @param uniforms Uniforms array to fill
  92646. * @param attributes Attributes array to fill
  92647. * @param samplers Samplers array to fill
  92648. */
  92649. fillUniformsAttributesAndSamplerNames(uniforms: Array<string>, attributes: Array<string>, samplers: Array<string>): void;
  92650. /**
  92651. * Observable that will be called just before the particles are drawn
  92652. */
  92653. onBeforeDrawParticlesObservable: Observable<Nullable<Effect>>;
  92654. /**
  92655. * Gets the name of the particle vertex shader
  92656. */
  92657. vertexShaderName: string;
  92658. /**
  92659. * Adds a new color gradient
  92660. * @param gradient defines the gradient to use (between 0 and 1)
  92661. * @param color1 defines the color to affect to the specified gradient
  92662. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  92663. * @returns the current particle system
  92664. */
  92665. addColorGradient(gradient: number, color1: Color4, color2?: Color4): IParticleSystem;
  92666. /**
  92667. * Remove a specific color gradient
  92668. * @param gradient defines the gradient to remove
  92669. * @returns the current particle system
  92670. */
  92671. removeColorGradient(gradient: number): IParticleSystem;
  92672. /**
  92673. * Adds a new size gradient
  92674. * @param gradient defines the gradient to use (between 0 and 1)
  92675. * @param factor defines the size factor to affect to the specified gradient
  92676. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  92677. * @returns the current particle system
  92678. */
  92679. addSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  92680. /**
  92681. * Remove a specific size gradient
  92682. * @param gradient defines the gradient to remove
  92683. * @returns the current particle system
  92684. */
  92685. removeSizeGradient(gradient: number): IParticleSystem;
  92686. /**
  92687. * Gets the current list of color gradients.
  92688. * You must use addColorGradient and removeColorGradient to udpate this list
  92689. * @returns the list of color gradients
  92690. */
  92691. getColorGradients(): Nullable<Array<ColorGradient>>;
  92692. /**
  92693. * Gets the current list of size gradients.
  92694. * You must use addSizeGradient and removeSizeGradient to udpate this list
  92695. * @returns the list of size gradients
  92696. */
  92697. getSizeGradients(): Nullable<Array<FactorGradient>>;
  92698. /**
  92699. * Gets the current list of angular speed gradients.
  92700. * You must use addAngularSpeedGradient and removeAngularSpeedGradient to udpate this list
  92701. * @returns the list of angular speed gradients
  92702. */
  92703. getAngularSpeedGradients(): Nullable<Array<FactorGradient>>;
  92704. /**
  92705. * Adds a new angular speed gradient
  92706. * @param gradient defines the gradient to use (between 0 and 1)
  92707. * @param factor defines the angular speed to affect to the specified gradient
  92708. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  92709. * @returns the current particle system
  92710. */
  92711. addAngularSpeedGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  92712. /**
  92713. * Remove a specific angular speed gradient
  92714. * @param gradient defines the gradient to remove
  92715. * @returns the current particle system
  92716. */
  92717. removeAngularSpeedGradient(gradient: number): IParticleSystem;
  92718. /**
  92719. * Gets the current list of velocity gradients.
  92720. * You must use addVelocityGradient and removeVelocityGradient to udpate this list
  92721. * @returns the list of velocity gradients
  92722. */
  92723. getVelocityGradients(): Nullable<Array<FactorGradient>>;
  92724. /**
  92725. * Adds a new velocity gradient
  92726. * @param gradient defines the gradient to use (between 0 and 1)
  92727. * @param factor defines the velocity to affect to the specified gradient
  92728. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  92729. * @returns the current particle system
  92730. */
  92731. addVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  92732. /**
  92733. * Remove a specific velocity gradient
  92734. * @param gradient defines the gradient to remove
  92735. * @returns the current particle system
  92736. */
  92737. removeVelocityGradient(gradient: number): IParticleSystem;
  92738. /**
  92739. * Gets the current list of limit velocity gradients.
  92740. * You must use addLimitVelocityGradient and removeLimitVelocityGradient to udpate this list
  92741. * @returns the list of limit velocity gradients
  92742. */
  92743. getLimitVelocityGradients(): Nullable<Array<FactorGradient>>;
  92744. /**
  92745. * Adds a new limit velocity gradient
  92746. * @param gradient defines the gradient to use (between 0 and 1)
  92747. * @param factor defines the limit velocity to affect to the specified gradient
  92748. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  92749. * @returns the current particle system
  92750. */
  92751. addLimitVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  92752. /**
  92753. * Remove a specific limit velocity gradient
  92754. * @param gradient defines the gradient to remove
  92755. * @returns the current particle system
  92756. */
  92757. removeLimitVelocityGradient(gradient: number): IParticleSystem;
  92758. /**
  92759. * Adds a new drag gradient
  92760. * @param gradient defines the gradient to use (between 0 and 1)
  92761. * @param factor defines the drag to affect to the specified gradient
  92762. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  92763. * @returns the current particle system
  92764. */
  92765. addDragGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  92766. /**
  92767. * Remove a specific drag gradient
  92768. * @param gradient defines the gradient to remove
  92769. * @returns the current particle system
  92770. */
  92771. removeDragGradient(gradient: number): IParticleSystem;
  92772. /**
  92773. * Gets the current list of drag gradients.
  92774. * You must use addDragGradient and removeDragGradient to udpate this list
  92775. * @returns the list of drag gradients
  92776. */
  92777. getDragGradients(): Nullable<Array<FactorGradient>>;
  92778. /**
  92779. * Adds a new emit rate gradient (please note that this will only work if you set the targetStopDuration property)
  92780. * @param gradient defines the gradient to use (between 0 and 1)
  92781. * @param factor defines the emit rate to affect to the specified gradient
  92782. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  92783. * @returns the current particle system
  92784. */
  92785. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  92786. /**
  92787. * Remove a specific emit rate gradient
  92788. * @param gradient defines the gradient to remove
  92789. * @returns the current particle system
  92790. */
  92791. removeEmitRateGradient(gradient: number): IParticleSystem;
  92792. /**
  92793. * Gets the current list of emit rate gradients.
  92794. * You must use addEmitRateGradient and removeEmitRateGradient to udpate this list
  92795. * @returns the list of emit rate gradients
  92796. */
  92797. getEmitRateGradients(): Nullable<Array<FactorGradient>>;
  92798. /**
  92799. * Adds a new start size gradient (please note that this will only work if you set the targetStopDuration property)
  92800. * @param gradient defines the gradient to use (between 0 and 1)
  92801. * @param factor defines the start size to affect to the specified gradient
  92802. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  92803. * @returns the current particle system
  92804. */
  92805. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  92806. /**
  92807. * Remove a specific start size gradient
  92808. * @param gradient defines the gradient to remove
  92809. * @returns the current particle system
  92810. */
  92811. removeStartSizeGradient(gradient: number): IParticleSystem;
  92812. /**
  92813. * Gets the current list of start size gradients.
  92814. * You must use addStartSizeGradient and removeStartSizeGradient to udpate this list
  92815. * @returns the list of start size gradients
  92816. */
  92817. getStartSizeGradients(): Nullable<Array<FactorGradient>>;
  92818. /**
  92819. * Adds a new life time gradient
  92820. * @param gradient defines the gradient to use (between 0 and 1)
  92821. * @param factor defines the life time factor to affect to the specified gradient
  92822. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  92823. * @returns the current particle system
  92824. */
  92825. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  92826. /**
  92827. * Remove a specific life time gradient
  92828. * @param gradient defines the gradient to remove
  92829. * @returns the current particle system
  92830. */
  92831. removeLifeTimeGradient(gradient: number): IParticleSystem;
  92832. /**
  92833. * Gets the current list of life time gradients.
  92834. * You must use addLifeTimeGradient and removeLifeTimeGradient to udpate this list
  92835. * @returns the list of life time gradients
  92836. */
  92837. getLifeTimeGradients(): Nullable<Array<FactorGradient>>;
  92838. /**
  92839. * Gets the current list of color gradients.
  92840. * You must use addColorGradient and removeColorGradient to udpate this list
  92841. * @returns the list of color gradients
  92842. */
  92843. getColorGradients(): Nullable<Array<ColorGradient>>;
  92844. /**
  92845. * Adds a new ramp gradient used to remap particle colors
  92846. * @param gradient defines the gradient to use (between 0 and 1)
  92847. * @param color defines the color to affect to the specified gradient
  92848. * @returns the current particle system
  92849. */
  92850. addRampGradient(gradient: number, color: Color3): IParticleSystem;
  92851. /**
  92852. * Gets the current list of ramp gradients.
  92853. * You must use addRampGradient and removeRampGradient to udpate this list
  92854. * @returns the list of ramp gradients
  92855. */
  92856. getRampGradients(): Nullable<Array<Color3Gradient>>;
  92857. /** Gets or sets a boolean indicating that ramp gradients must be used
  92858. * @see https://doc.babylonjs.com/babylon101/particles#ramp-gradients
  92859. */
  92860. useRampGradients: boolean;
  92861. /**
  92862. * Adds a new color remap gradient
  92863. * @param gradient defines the gradient to use (between 0 and 1)
  92864. * @param min defines the color remap minimal range
  92865. * @param max defines the color remap maximal range
  92866. * @returns the current particle system
  92867. */
  92868. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  92869. /**
  92870. * Gets the current list of color remap gradients.
  92871. * You must use addColorRemapGradient and removeColorRemapGradient to udpate this list
  92872. * @returns the list of color remap gradients
  92873. */
  92874. getColorRemapGradients(): Nullable<Array<FactorGradient>>;
  92875. /**
  92876. * Adds a new alpha remap gradient
  92877. * @param gradient defines the gradient to use (between 0 and 1)
  92878. * @param min defines the alpha remap minimal range
  92879. * @param max defines the alpha remap maximal range
  92880. * @returns the current particle system
  92881. */
  92882. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  92883. /**
  92884. * Gets the current list of alpha remap gradients.
  92885. * You must use addAlphaRemapGradient and removeAlphaRemapGradient to udpate this list
  92886. * @returns the list of alpha remap gradients
  92887. */
  92888. getAlphaRemapGradients(): Nullable<Array<FactorGradient>>;
  92889. /**
  92890. * Creates a Point Emitter for the particle system (emits directly from the emitter position)
  92891. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  92892. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  92893. * @returns the emitter
  92894. */
  92895. createPointEmitter(direction1: Vector3, direction2: Vector3): PointParticleEmitter;
  92896. /**
  92897. * Creates a Hemisphere Emitter for the particle system (emits along the hemisphere radius)
  92898. * @param radius The radius of the hemisphere to emit from
  92899. * @param radiusRange The range of the hemisphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  92900. * @returns the emitter
  92901. */
  92902. createHemisphericEmitter(radius: number, radiusRange: number): HemisphericParticleEmitter;
  92903. /**
  92904. * Creates a Sphere Emitter for the particle system (emits along the sphere radius)
  92905. * @param radius The radius of the sphere to emit from
  92906. * @param radiusRange The range of the sphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  92907. * @returns the emitter
  92908. */
  92909. createSphereEmitter(radius: number, radiusRange: number): SphereParticleEmitter;
  92910. /**
  92911. * Creates a Directed Sphere Emitter for the particle system (emits between direction1 and direction2)
  92912. * @param radius The radius of the sphere to emit from
  92913. * @param direction1 Particles are emitted between the direction1 and direction2 from within the sphere
  92914. * @param direction2 Particles are emitted between the direction1 and direction2 from within the sphere
  92915. * @returns the emitter
  92916. */
  92917. createDirectedSphereEmitter(radius: number, direction1: Vector3, direction2: Vector3): SphereDirectedParticleEmitter;
  92918. /**
  92919. * Creates a Cylinder Emitter for the particle system (emits from the cylinder to the particle position)
  92920. * @param radius The radius of the emission cylinder
  92921. * @param height The height of the emission cylinder
  92922. * @param radiusRange The range of emission [0-1] 0 Surface only, 1 Entire Radius
  92923. * @param directionRandomizer How much to randomize the particle direction [0-1]
  92924. * @returns the emitter
  92925. */
  92926. createCylinderEmitter(radius: number, height: number, radiusRange: number, directionRandomizer: number): CylinderParticleEmitter;
  92927. /**
  92928. * Creates a Directed Cylinder Emitter for the particle system (emits between direction1 and direction2)
  92929. * @param radius The radius of the cylinder to emit from
  92930. * @param height The height of the emission cylinder
  92931. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  92932. * @param direction1 Particles are emitted between the direction1 and direction2 from within the cylinder
  92933. * @param direction2 Particles are emitted between the direction1 and direction2 from within the cylinder
  92934. * @returns the emitter
  92935. */
  92936. createDirectedCylinderEmitter(radius: number, height: number, radiusRange: number, direction1: Vector3, direction2: Vector3): SphereDirectedParticleEmitter;
  92937. /**
  92938. * Creates a Cone Emitter for the particle system (emits from the cone to the particle position)
  92939. * @param radius The radius of the cone to emit from
  92940. * @param angle The base angle of the cone
  92941. * @returns the emitter
  92942. */
  92943. createConeEmitter(radius: number, angle: number): ConeParticleEmitter;
  92944. /**
  92945. * Creates a Box Emitter for the particle system. (emits between direction1 and direction2 from withing the box defined by minEmitBox and maxEmitBox)
  92946. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  92947. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  92948. * @param minEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  92949. * @param maxEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  92950. * @returns the emitter
  92951. */
  92952. createBoxEmitter(direction1: Vector3, direction2: Vector3, minEmitBox: Vector3, maxEmitBox: Vector3): BoxParticleEmitter;
  92953. /**
  92954. * Get hosting scene
  92955. * @returns the scene
  92956. */
  92957. getScene(): Scene;
  92958. }
  92959. }
  92960. declare module BABYLON {
  92961. /**
  92962. * 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.
  92963. * @see https://doc.babylonjs.com/how_to/transformnode
  92964. */
  92965. export class TransformNode extends Node {
  92966. /**
  92967. * Object will not rotate to face the camera
  92968. */
  92969. static BILLBOARDMODE_NONE: number;
  92970. /**
  92971. * Object will rotate to face the camera but only on the x axis
  92972. */
  92973. static BILLBOARDMODE_X: number;
  92974. /**
  92975. * Object will rotate to face the camera but only on the y axis
  92976. */
  92977. static BILLBOARDMODE_Y: number;
  92978. /**
  92979. * Object will rotate to face the camera but only on the z axis
  92980. */
  92981. static BILLBOARDMODE_Z: number;
  92982. /**
  92983. * Object will rotate to face the camera
  92984. */
  92985. static BILLBOARDMODE_ALL: number;
  92986. /**
  92987. * Object will rotate to face the camera's position instead of orientation
  92988. */
  92989. static BILLBOARDMODE_USE_POSITION: number;
  92990. private static _TmpRotation;
  92991. private static _TmpScaling;
  92992. private static _TmpTranslation;
  92993. private _forward;
  92994. private _forwardInverted;
  92995. private _up;
  92996. private _right;
  92997. private _rightInverted;
  92998. private _position;
  92999. private _rotation;
  93000. private _rotationQuaternion;
  93001. protected _scaling: Vector3;
  93002. protected _isDirty: boolean;
  93003. private _transformToBoneReferal;
  93004. private _isAbsoluteSynced;
  93005. private _billboardMode;
  93006. /**
  93007. * Gets or sets the billboard mode. Default is 0.
  93008. *
  93009. * | Value | Type | Description |
  93010. * | --- | --- | --- |
  93011. * | 0 | BILLBOARDMODE_NONE | |
  93012. * | 1 | BILLBOARDMODE_X | |
  93013. * | 2 | BILLBOARDMODE_Y | |
  93014. * | 4 | BILLBOARDMODE_Z | |
  93015. * | 7 | BILLBOARDMODE_ALL | |
  93016. *
  93017. */
  93018. get billboardMode(): number;
  93019. set billboardMode(value: number);
  93020. private _preserveParentRotationForBillboard;
  93021. /**
  93022. * Gets or sets a boolean indicating that parent rotation should be preserved when using billboards.
  93023. * This could be useful for glTF objects where parent rotation helps converting from right handed to left handed
  93024. */
  93025. get preserveParentRotationForBillboard(): boolean;
  93026. set preserveParentRotationForBillboard(value: boolean);
  93027. /**
  93028. * 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
  93029. */
  93030. scalingDeterminant: number;
  93031. private _infiniteDistance;
  93032. /**
  93033. * Gets or sets the distance of the object to max, often used by skybox
  93034. */
  93035. get infiniteDistance(): boolean;
  93036. set infiniteDistance(value: boolean);
  93037. /**
  93038. * Gets or sets a boolean indicating that non uniform scaling (when at least one component is different from others) should be ignored.
  93039. * By default the system will update normals to compensate
  93040. */
  93041. ignoreNonUniformScaling: boolean;
  93042. /**
  93043. * 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
  93044. */
  93045. reIntegrateRotationIntoRotationQuaternion: boolean;
  93046. /** @hidden */
  93047. _poseMatrix: Nullable<Matrix>;
  93048. /** @hidden */
  93049. _localMatrix: Matrix;
  93050. private _usePivotMatrix;
  93051. private _absolutePosition;
  93052. private _absoluteScaling;
  93053. private _absoluteRotationQuaternion;
  93054. private _pivotMatrix;
  93055. private _pivotMatrixInverse;
  93056. protected _postMultiplyPivotMatrix: boolean;
  93057. protected _isWorldMatrixFrozen: boolean;
  93058. /** @hidden */
  93059. _indexInSceneTransformNodesArray: number;
  93060. /**
  93061. * An event triggered after the world matrix is updated
  93062. */
  93063. onAfterWorldMatrixUpdateObservable: Observable<TransformNode>;
  93064. constructor(name: string, scene?: Nullable<Scene>, isPure?: boolean);
  93065. /**
  93066. * Gets a string identifying the name of the class
  93067. * @returns "TransformNode" string
  93068. */
  93069. getClassName(): string;
  93070. /**
  93071. * Gets or set the node position (default is (0.0, 0.0, 0.0))
  93072. */
  93073. get position(): Vector3;
  93074. set position(newPosition: Vector3);
  93075. /**
  93076. * 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)).
  93077. * If rotation quaternion is set, this Vector3 will be ignored and copy from the quaternion
  93078. */
  93079. get rotation(): Vector3;
  93080. set rotation(newRotation: Vector3);
  93081. /**
  93082. * 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)).
  93083. */
  93084. get scaling(): Vector3;
  93085. set scaling(newScaling: Vector3);
  93086. /**
  93087. * 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).
  93088. * If set, only the rotationQuaternion is then used to compute the node rotation (ie. node.rotation will be ignored)
  93089. */
  93090. get rotationQuaternion(): Nullable<Quaternion>;
  93091. set rotationQuaternion(quaternion: Nullable<Quaternion>);
  93092. /**
  93093. * The forward direction of that transform in world space.
  93094. */
  93095. get forward(): Vector3;
  93096. /**
  93097. * The up direction of that transform in world space.
  93098. */
  93099. get up(): Vector3;
  93100. /**
  93101. * The right direction of that transform in world space.
  93102. */
  93103. get right(): Vector3;
  93104. /**
  93105. * Copies the parameter passed Matrix into the mesh Pose matrix.
  93106. * @param matrix the matrix to copy the pose from
  93107. * @returns this TransformNode.
  93108. */
  93109. updatePoseMatrix(matrix: Matrix): TransformNode;
  93110. /**
  93111. * Returns the mesh Pose matrix.
  93112. * @returns the pose matrix
  93113. */
  93114. getPoseMatrix(): Matrix;
  93115. /** @hidden */
  93116. _isSynchronized(): boolean;
  93117. /** @hidden */
  93118. _initCache(): void;
  93119. /**
  93120. * Flag the transform node as dirty (Forcing it to update everything)
  93121. * @param property if set to "rotation" the objects rotationQuaternion will be set to null
  93122. * @returns this transform node
  93123. */
  93124. markAsDirty(property: string): TransformNode;
  93125. /**
  93126. * Returns the current mesh absolute position.
  93127. * Returns a Vector3.
  93128. */
  93129. get absolutePosition(): Vector3;
  93130. /**
  93131. * Returns the current mesh absolute scaling.
  93132. * Returns a Vector3.
  93133. */
  93134. get absoluteScaling(): Vector3;
  93135. /**
  93136. * Returns the current mesh absolute rotation.
  93137. * Returns a Quaternion.
  93138. */
  93139. get absoluteRotationQuaternion(): Quaternion;
  93140. /**
  93141. * Sets a new matrix to apply before all other transformation
  93142. * @param matrix defines the transform matrix
  93143. * @returns the current TransformNode
  93144. */
  93145. setPreTransformMatrix(matrix: Matrix): TransformNode;
  93146. /**
  93147. * Sets a new pivot matrix to the current node
  93148. * @param matrix defines the new pivot matrix to use
  93149. * @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
  93150. * @returns the current TransformNode
  93151. */
  93152. setPivotMatrix(matrix: DeepImmutable<Matrix>, postMultiplyPivotMatrix?: boolean): TransformNode;
  93153. /**
  93154. * Returns the mesh pivot matrix.
  93155. * Default : Identity.
  93156. * @returns the matrix
  93157. */
  93158. getPivotMatrix(): Matrix;
  93159. /**
  93160. * Instantiate (when possible) or clone that node with its hierarchy
  93161. * @param newParent defines the new parent to use for the instance (or clone)
  93162. * @param options defines options to configure how copy is done
  93163. * @param onNewNodeCreated defines an option callback to call when a clone or an instance is created
  93164. * @returns an instance (or a clone) of the current node with its hiearchy
  93165. */
  93166. instantiateHierarchy(newParent?: Nullable<TransformNode>, options?: {
  93167. doNotInstantiate: boolean;
  93168. }, onNewNodeCreated?: (source: TransformNode, clone: TransformNode) => void): Nullable<TransformNode>;
  93169. /**
  93170. * Prevents the World matrix to be computed any longer
  93171. * @param newWorldMatrix defines an optional matrix to use as world matrix
  93172. * @returns the TransformNode.
  93173. */
  93174. freezeWorldMatrix(newWorldMatrix?: Nullable<Matrix>): TransformNode;
  93175. /**
  93176. * Allows back the World matrix computation.
  93177. * @returns the TransformNode.
  93178. */
  93179. unfreezeWorldMatrix(): this;
  93180. /**
  93181. * True if the World matrix has been frozen.
  93182. */
  93183. get isWorldMatrixFrozen(): boolean;
  93184. /**
  93185. * Retuns the mesh absolute position in the World.
  93186. * @returns a Vector3.
  93187. */
  93188. getAbsolutePosition(): Vector3;
  93189. /**
  93190. * Sets the mesh absolute position in the World from a Vector3 or an Array(3).
  93191. * @param absolutePosition the absolute position to set
  93192. * @returns the TransformNode.
  93193. */
  93194. setAbsolutePosition(absolutePosition: Vector3): TransformNode;
  93195. /**
  93196. * Sets the mesh position in its local space.
  93197. * @param vector3 the position to set in localspace
  93198. * @returns the TransformNode.
  93199. */
  93200. setPositionWithLocalVector(vector3: Vector3): TransformNode;
  93201. /**
  93202. * Returns the mesh position in the local space from the current World matrix values.
  93203. * @returns a new Vector3.
  93204. */
  93205. getPositionExpressedInLocalSpace(): Vector3;
  93206. /**
  93207. * Translates the mesh along the passed Vector3 in its local space.
  93208. * @param vector3 the distance to translate in localspace
  93209. * @returns the TransformNode.
  93210. */
  93211. locallyTranslate(vector3: Vector3): TransformNode;
  93212. private static _lookAtVectorCache;
  93213. /**
  93214. * Orients a mesh towards a target point. Mesh must be drawn facing user.
  93215. * @param targetPoint the position (must be in same space as current mesh) to look at
  93216. * @param yawCor optional yaw (y-axis) correction in radians
  93217. * @param pitchCor optional pitch (x-axis) correction in radians
  93218. * @param rollCor optional roll (z-axis) correction in radians
  93219. * @param space the choosen space of the target
  93220. * @returns the TransformNode.
  93221. */
  93222. lookAt(targetPoint: Vector3, yawCor?: number, pitchCor?: number, rollCor?: number, space?: Space): TransformNode;
  93223. /**
  93224. * Returns a new Vector3 that is the localAxis, expressed in the mesh local space, rotated like the mesh.
  93225. * This Vector3 is expressed in the World space.
  93226. * @param localAxis axis to rotate
  93227. * @returns a new Vector3 that is the localAxis, expressed in the mesh local space, rotated like the mesh.
  93228. */
  93229. getDirection(localAxis: Vector3): Vector3;
  93230. /**
  93231. * Sets the Vector3 "result" as the rotated Vector3 "localAxis" in the same rotation than the mesh.
  93232. * localAxis is expressed in the mesh local space.
  93233. * result is computed in the Wordl space from the mesh World matrix.
  93234. * @param localAxis axis to rotate
  93235. * @param result the resulting transformnode
  93236. * @returns this TransformNode.
  93237. */
  93238. getDirectionToRef(localAxis: Vector3, result: Vector3): TransformNode;
  93239. /**
  93240. * Sets this transform node rotation to the given local axis.
  93241. * @param localAxis the axis in local space
  93242. * @param yawCor optional yaw (y-axis) correction in radians
  93243. * @param pitchCor optional pitch (x-axis) correction in radians
  93244. * @param rollCor optional roll (z-axis) correction in radians
  93245. * @returns this TransformNode
  93246. */
  93247. setDirection(localAxis: Vector3, yawCor?: number, pitchCor?: number, rollCor?: number): TransformNode;
  93248. /**
  93249. * Sets a new pivot point to the current node
  93250. * @param point defines the new pivot point to use
  93251. * @param space defines if the point is in world or local space (local by default)
  93252. * @returns the current TransformNode
  93253. */
  93254. setPivotPoint(point: Vector3, space?: Space): TransformNode;
  93255. /**
  93256. * Returns a new Vector3 set with the mesh pivot point coordinates in the local space.
  93257. * @returns the pivot point
  93258. */
  93259. getPivotPoint(): Vector3;
  93260. /**
  93261. * Sets the passed Vector3 "result" with the coordinates of the mesh pivot point in the local space.
  93262. * @param result the vector3 to store the result
  93263. * @returns this TransformNode.
  93264. */
  93265. getPivotPointToRef(result: Vector3): TransformNode;
  93266. /**
  93267. * Returns a new Vector3 set with the mesh pivot point World coordinates.
  93268. * @returns a new Vector3 set with the mesh pivot point World coordinates.
  93269. */
  93270. getAbsolutePivotPoint(): Vector3;
  93271. /**
  93272. * Sets the Vector3 "result" coordinates with the mesh pivot point World coordinates.
  93273. * @param result vector3 to store the result
  93274. * @returns this TransformNode.
  93275. */
  93276. getAbsolutePivotPointToRef(result: Vector3): TransformNode;
  93277. /**
  93278. * Defines the passed node as the parent of the current node.
  93279. * The node will remain exactly where it is and its position / rotation will be updated accordingly
  93280. * @see https://doc.babylonjs.com/how_to/parenting
  93281. * @param node the node ot set as the parent
  93282. * @returns this TransformNode.
  93283. */
  93284. setParent(node: Nullable<Node>): TransformNode;
  93285. private _nonUniformScaling;
  93286. /**
  93287. * True if the scaling property of this object is non uniform eg. (1,2,1)
  93288. */
  93289. get nonUniformScaling(): boolean;
  93290. /** @hidden */
  93291. _updateNonUniformScalingState(value: boolean): boolean;
  93292. /**
  93293. * Attach the current TransformNode to another TransformNode associated with a bone
  93294. * @param bone Bone affecting the TransformNode
  93295. * @param affectedTransformNode TransformNode associated with the bone
  93296. * @returns this object
  93297. */
  93298. attachToBone(bone: Bone, affectedTransformNode: TransformNode): TransformNode;
  93299. /**
  93300. * Detach the transform node if its associated with a bone
  93301. * @returns this object
  93302. */
  93303. detachFromBone(): TransformNode;
  93304. private static _rotationAxisCache;
  93305. /**
  93306. * Rotates the mesh around the axis vector for the passed angle (amount) expressed in radians, in the given space.
  93307. * space (default LOCAL) can be either Space.LOCAL, either Space.WORLD.
  93308. * Note that the property `rotationQuaternion` is then automatically updated and the property `rotation` is set to (0,0,0) and no longer used.
  93309. * The passed axis is also normalized.
  93310. * @param axis the axis to rotate around
  93311. * @param amount the amount to rotate in radians
  93312. * @param space Space to rotate in (Default: local)
  93313. * @returns the TransformNode.
  93314. */
  93315. rotate(axis: Vector3, amount: number, space?: Space): TransformNode;
  93316. /**
  93317. * Rotates the mesh around the axis vector for the passed angle (amount) expressed in radians, in world space.
  93318. * Note that the property `rotationQuaternion` is then automatically updated and the property `rotation` is set to (0,0,0) and no longer used.
  93319. * The passed axis is also normalized. .
  93320. * Method is based on http://www.euclideanspace.com/maths/geometry/affine/aroundPoint/index.htm
  93321. * @param point the point to rotate around
  93322. * @param axis the axis to rotate around
  93323. * @param amount the amount to rotate in radians
  93324. * @returns the TransformNode
  93325. */
  93326. rotateAround(point: Vector3, axis: Vector3, amount: number): TransformNode;
  93327. /**
  93328. * Translates the mesh along the axis vector for the passed distance in the given space.
  93329. * space (default LOCAL) can be either Space.LOCAL, either Space.WORLD.
  93330. * @param axis the axis to translate in
  93331. * @param distance the distance to translate
  93332. * @param space Space to rotate in (Default: local)
  93333. * @returns the TransformNode.
  93334. */
  93335. translate(axis: Vector3, distance: number, space?: Space): TransformNode;
  93336. /**
  93337. * Adds a rotation step to the mesh current rotation.
  93338. * x, y, z are Euler angles expressed in radians.
  93339. * This methods updates the current mesh rotation, either mesh.rotation, either mesh.rotationQuaternion if it's set.
  93340. * This means this rotation is made in the mesh local space only.
  93341. * It's useful to set a custom rotation order different from the BJS standard one YXZ.
  93342. * Example : this rotates the mesh first around its local X axis, then around its local Z axis, finally around its local Y axis.
  93343. * ```javascript
  93344. * mesh.addRotation(x1, 0, 0).addRotation(0, 0, z2).addRotation(0, 0, y3);
  93345. * ```
  93346. * Note that `addRotation()` accumulates the passed rotation values to the current ones and computes the .rotation or .rotationQuaternion updated values.
  93347. * 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.
  93348. * @param x Rotation to add
  93349. * @param y Rotation to add
  93350. * @param z Rotation to add
  93351. * @returns the TransformNode.
  93352. */
  93353. addRotation(x: number, y: number, z: number): TransformNode;
  93354. /**
  93355. * @hidden
  93356. */
  93357. protected _getEffectiveParent(): Nullable<Node>;
  93358. /**
  93359. * Computes the world matrix of the node
  93360. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  93361. * @returns the world matrix
  93362. */
  93363. computeWorldMatrix(force?: boolean): Matrix;
  93364. /**
  93365. * Resets this nodeTransform's local matrix to Matrix.Identity().
  93366. * @param independentOfChildren indicates if all child nodeTransform's world-space transform should be preserved.
  93367. */
  93368. resetLocalMatrix(independentOfChildren?: boolean): void;
  93369. protected _afterComputeWorldMatrix(): void;
  93370. /**
  93371. * If you'd like to be called back after the mesh position, rotation or scaling has been updated.
  93372. * @param func callback function to add
  93373. *
  93374. * @returns the TransformNode.
  93375. */
  93376. registerAfterWorldMatrixUpdate(func: (mesh: TransformNode) => void): TransformNode;
  93377. /**
  93378. * Removes a registered callback function.
  93379. * @param func callback function to remove
  93380. * @returns the TransformNode.
  93381. */
  93382. unregisterAfterWorldMatrixUpdate(func: (mesh: TransformNode) => void): TransformNode;
  93383. /**
  93384. * Gets the position of the current mesh in camera space
  93385. * @param camera defines the camera to use
  93386. * @returns a position
  93387. */
  93388. getPositionInCameraSpace(camera?: Nullable<Camera>): Vector3;
  93389. /**
  93390. * Returns the distance from the mesh to the active camera
  93391. * @param camera defines the camera to use
  93392. * @returns the distance
  93393. */
  93394. getDistanceToCamera(camera?: Nullable<Camera>): number;
  93395. /**
  93396. * Clone the current transform node
  93397. * @param name Name of the new clone
  93398. * @param newParent New parent for the clone
  93399. * @param doNotCloneChildren Do not clone children hierarchy
  93400. * @returns the new transform node
  93401. */
  93402. clone(name: string, newParent: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<TransformNode>;
  93403. /**
  93404. * Serializes the objects information.
  93405. * @param currentSerializationObject defines the object to serialize in
  93406. * @returns the serialized object
  93407. */
  93408. serialize(currentSerializationObject?: any): any;
  93409. /**
  93410. * Returns a new TransformNode object parsed from the source provided.
  93411. * @param parsedTransformNode is the source.
  93412. * @param scene the scne the object belongs to
  93413. * @param rootUrl is a string, it's the root URL to prefix the `delayLoadingFile` property with
  93414. * @returns a new TransformNode object parsed from the source provided.
  93415. */
  93416. static Parse(parsedTransformNode: any, scene: Scene, rootUrl: string): TransformNode;
  93417. /**
  93418. * Get all child-transformNodes of this node
  93419. * @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
  93420. * @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
  93421. * @returns an array of TransformNode
  93422. */
  93423. getChildTransformNodes(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): TransformNode[];
  93424. /**
  93425. * Releases resources associated with this transform node.
  93426. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  93427. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  93428. */
  93429. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  93430. /**
  93431. * Uniformly scales the mesh to fit inside of a unit cube (1 X 1 X 1 units)
  93432. * @param includeDescendants Use the hierarchy's bounding box instead of the mesh's bounding box. Default is false
  93433. * @param ignoreRotation ignore rotation when computing the scale (ie. object will be axis aligned). Default is false
  93434. * @param predicate predicate that is passed in to getHierarchyBoundingVectors when selecting which object should be included when scaling
  93435. * @returns the current mesh
  93436. */
  93437. normalizeToUnitCube(includeDescendants?: boolean, ignoreRotation?: boolean, predicate?: Nullable<(node: AbstractMesh) => boolean>): TransformNode;
  93438. private _syncAbsoluteScalingAndRotation;
  93439. }
  93440. }
  93441. declare module BABYLON {
  93442. /**
  93443. * Class used to override all child animations of a given target
  93444. */
  93445. export class AnimationPropertiesOverride {
  93446. /**
  93447. * Gets or sets a value indicating if animation blending must be used
  93448. */
  93449. enableBlending: boolean;
  93450. /**
  93451. * Gets or sets the blending speed to use when enableBlending is true
  93452. */
  93453. blendingSpeed: number;
  93454. /**
  93455. * Gets or sets the default loop mode to use
  93456. */
  93457. loopMode: number;
  93458. }
  93459. }
  93460. declare module BABYLON {
  93461. /**
  93462. * Class used to store bone information
  93463. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  93464. */
  93465. export class Bone extends Node {
  93466. /**
  93467. * defines the bone name
  93468. */
  93469. name: string;
  93470. private static _tmpVecs;
  93471. private static _tmpQuat;
  93472. private static _tmpMats;
  93473. /**
  93474. * Gets the list of child bones
  93475. */
  93476. children: Bone[];
  93477. /** Gets the animations associated with this bone */
  93478. animations: Animation[];
  93479. /**
  93480. * Gets or sets bone length
  93481. */
  93482. length: number;
  93483. /**
  93484. * @hidden Internal only
  93485. * Set this value to map this bone to a different index in the transform matrices
  93486. * Set this value to -1 to exclude the bone from the transform matrices
  93487. */
  93488. _index: Nullable<number>;
  93489. private _skeleton;
  93490. private _localMatrix;
  93491. private _restPose;
  93492. private _baseMatrix;
  93493. private _absoluteTransform;
  93494. private _invertedAbsoluteTransform;
  93495. private _parent;
  93496. private _scalingDeterminant;
  93497. private _worldTransform;
  93498. private _localScaling;
  93499. private _localRotation;
  93500. private _localPosition;
  93501. private _needToDecompose;
  93502. private _needToCompose;
  93503. /** @hidden */
  93504. _linkedTransformNode: Nullable<TransformNode>;
  93505. /** @hidden */
  93506. _waitingTransformNodeId: Nullable<string>;
  93507. /** @hidden */
  93508. get _matrix(): Matrix;
  93509. /** @hidden */
  93510. set _matrix(value: Matrix);
  93511. /**
  93512. * Create a new bone
  93513. * @param name defines the bone name
  93514. * @param skeleton defines the parent skeleton
  93515. * @param parentBone defines the parent (can be null if the bone is the root)
  93516. * @param localMatrix defines the local matrix
  93517. * @param restPose defines the rest pose matrix
  93518. * @param baseMatrix defines the base matrix
  93519. * @param index defines index of the bone in the hiearchy
  93520. */
  93521. constructor(
  93522. /**
  93523. * defines the bone name
  93524. */
  93525. name: string, skeleton: Skeleton, parentBone?: Nullable<Bone>, localMatrix?: Nullable<Matrix>, restPose?: Nullable<Matrix>, baseMatrix?: Nullable<Matrix>, index?: Nullable<number>);
  93526. /**
  93527. * Gets the current object class name.
  93528. * @return the class name
  93529. */
  93530. getClassName(): string;
  93531. /**
  93532. * Gets the parent skeleton
  93533. * @returns a skeleton
  93534. */
  93535. getSkeleton(): Skeleton;
  93536. /**
  93537. * Gets parent bone
  93538. * @returns a bone or null if the bone is the root of the bone hierarchy
  93539. */
  93540. getParent(): Nullable<Bone>;
  93541. /**
  93542. * Returns an array containing the root bones
  93543. * @returns an array containing the root bones
  93544. */
  93545. getChildren(): Array<Bone>;
  93546. /**
  93547. * Gets the node index in matrix array generated for rendering
  93548. * @returns the node index
  93549. */
  93550. getIndex(): number;
  93551. /**
  93552. * Sets the parent bone
  93553. * @param parent defines the parent (can be null if the bone is the root)
  93554. * @param updateDifferenceMatrix defines if the difference matrix must be updated
  93555. */
  93556. setParent(parent: Nullable<Bone>, updateDifferenceMatrix?: boolean): void;
  93557. /**
  93558. * Gets the local matrix
  93559. * @returns a matrix
  93560. */
  93561. getLocalMatrix(): Matrix;
  93562. /**
  93563. * Gets the base matrix (initial matrix which remains unchanged)
  93564. * @returns a matrix
  93565. */
  93566. getBaseMatrix(): Matrix;
  93567. /**
  93568. * Gets the rest pose matrix
  93569. * @returns a matrix
  93570. */
  93571. getRestPose(): Matrix;
  93572. /**
  93573. * Gets a matrix used to store world matrix (ie. the matrix sent to shaders)
  93574. */
  93575. getWorldMatrix(): Matrix;
  93576. /**
  93577. * Sets the local matrix to rest pose matrix
  93578. */
  93579. returnToRest(): void;
  93580. /**
  93581. * Gets the inverse of the absolute transform matrix.
  93582. * This matrix will be multiplied by local matrix to get the difference matrix (ie. the difference between original state and current state)
  93583. * @returns a matrix
  93584. */
  93585. getInvertedAbsoluteTransform(): Matrix;
  93586. /**
  93587. * Gets the absolute transform matrix (ie base matrix * parent world matrix)
  93588. * @returns a matrix
  93589. */
  93590. getAbsoluteTransform(): Matrix;
  93591. /**
  93592. * Links with the given transform node.
  93593. * The local matrix of this bone is copied from the transform node every frame.
  93594. * @param transformNode defines the transform node to link to
  93595. */
  93596. linkTransformNode(transformNode: Nullable<TransformNode>): void;
  93597. /**
  93598. * Gets the node used to drive the bone's transformation
  93599. * @returns a transform node or null
  93600. */
  93601. getTransformNode(): Nullable<TransformNode>;
  93602. /** Gets or sets current position (in local space) */
  93603. get position(): Vector3;
  93604. set position(newPosition: Vector3);
  93605. /** Gets or sets current rotation (in local space) */
  93606. get rotation(): Vector3;
  93607. set rotation(newRotation: Vector3);
  93608. /** Gets or sets current rotation quaternion (in local space) */
  93609. get rotationQuaternion(): Quaternion;
  93610. set rotationQuaternion(newRotation: Quaternion);
  93611. /** Gets or sets current scaling (in local space) */
  93612. get scaling(): Vector3;
  93613. set scaling(newScaling: Vector3);
  93614. /**
  93615. * Gets the animation properties override
  93616. */
  93617. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  93618. private _decompose;
  93619. private _compose;
  93620. /**
  93621. * Update the base and local matrices
  93622. * @param matrix defines the new base or local matrix
  93623. * @param updateDifferenceMatrix defines if the difference matrix must be updated
  93624. * @param updateLocalMatrix defines if the local matrix should be updated
  93625. */
  93626. updateMatrix(matrix: Matrix, updateDifferenceMatrix?: boolean, updateLocalMatrix?: boolean): void;
  93627. /** @hidden */
  93628. _updateDifferenceMatrix(rootMatrix?: Matrix, updateChildren?: boolean): void;
  93629. /**
  93630. * Flag the bone as dirty (Forcing it to update everything)
  93631. */
  93632. markAsDirty(): void;
  93633. /** @hidden */
  93634. _markAsDirtyAndCompose(): void;
  93635. private _markAsDirtyAndDecompose;
  93636. /**
  93637. * Translate the bone in local or world space
  93638. * @param vec The amount to translate the bone
  93639. * @param space The space that the translation is in
  93640. * @param mesh The mesh that this bone is attached to. This is only used in world space
  93641. */
  93642. translate(vec: Vector3, space?: Space, mesh?: AbstractMesh): void;
  93643. /**
  93644. * Set the postion of the bone in local or world space
  93645. * @param position The position to set the bone
  93646. * @param space The space that the position is in
  93647. * @param mesh The mesh that this bone is attached to. This is only used in world space
  93648. */
  93649. setPosition(position: Vector3, space?: Space, mesh?: AbstractMesh): void;
  93650. /**
  93651. * Set the absolute position of the bone (world space)
  93652. * @param position The position to set the bone
  93653. * @param mesh The mesh that this bone is attached to
  93654. */
  93655. setAbsolutePosition(position: Vector3, mesh?: AbstractMesh): void;
  93656. /**
  93657. * Scale the bone on the x, y and z axes (in local space)
  93658. * @param x The amount to scale the bone on the x axis
  93659. * @param y The amount to scale the bone on the y axis
  93660. * @param z The amount to scale the bone on the z axis
  93661. * @param scaleChildren sets this to true if children of the bone should be scaled as well (false by default)
  93662. */
  93663. scale(x: number, y: number, z: number, scaleChildren?: boolean): void;
  93664. /**
  93665. * Set the bone scaling in local space
  93666. * @param scale defines the scaling vector
  93667. */
  93668. setScale(scale: Vector3): void;
  93669. /**
  93670. * Gets the current scaling in local space
  93671. * @returns the current scaling vector
  93672. */
  93673. getScale(): Vector3;
  93674. /**
  93675. * Gets the current scaling in local space and stores it in a target vector
  93676. * @param result defines the target vector
  93677. */
  93678. getScaleToRef(result: Vector3): void;
  93679. /**
  93680. * Set the yaw, pitch, and roll of the bone in local or world space
  93681. * @param yaw The rotation of the bone on the y axis
  93682. * @param pitch The rotation of the bone on the x axis
  93683. * @param roll The rotation of the bone on the z axis
  93684. * @param space The space that the axes of rotation are in
  93685. * @param mesh The mesh that this bone is attached to. This is only used in world space
  93686. */
  93687. setYawPitchRoll(yaw: number, pitch: number, roll: number, space?: Space, mesh?: AbstractMesh): void;
  93688. /**
  93689. * Add a rotation to the bone on an axis in local or world space
  93690. * @param axis The axis to rotate the bone on
  93691. * @param amount The amount to rotate the bone
  93692. * @param space The space that the axis is in
  93693. * @param mesh The mesh that this bone is attached to. This is only used in world space
  93694. */
  93695. rotate(axis: Vector3, amount: number, space?: Space, mesh?: AbstractMesh): void;
  93696. /**
  93697. * Set the rotation of the bone to a particular axis angle in local or world space
  93698. * @param axis The axis to rotate the bone on
  93699. * @param angle The angle that the bone should be rotated to
  93700. * @param space The space that the axis is in
  93701. * @param mesh The mesh that this bone is attached to. This is only used in world space
  93702. */
  93703. setAxisAngle(axis: Vector3, angle: number, space?: Space, mesh?: AbstractMesh): void;
  93704. /**
  93705. * Set the euler rotation of the bone in local of world space
  93706. * @param rotation The euler rotation that the bone should be set to
  93707. * @param space The space that the rotation is in
  93708. * @param mesh The mesh that this bone is attached to. This is only used in world space
  93709. */
  93710. setRotation(rotation: Vector3, space?: Space, mesh?: AbstractMesh): void;
  93711. /**
  93712. * Set the quaternion rotation of the bone in local of world space
  93713. * @param quat The quaternion rotation that the bone should be set to
  93714. * @param space The space that the rotation is in
  93715. * @param mesh The mesh that this bone is attached to. This is only used in world space
  93716. */
  93717. setRotationQuaternion(quat: Quaternion, space?: Space, mesh?: AbstractMesh): void;
  93718. /**
  93719. * Set the rotation matrix of the bone in local of world space
  93720. * @param rotMat The rotation matrix that the bone should be set to
  93721. * @param space The space that the rotation is in
  93722. * @param mesh The mesh that this bone is attached to. This is only used in world space
  93723. */
  93724. setRotationMatrix(rotMat: Matrix, space?: Space, mesh?: AbstractMesh): void;
  93725. private _rotateWithMatrix;
  93726. private _getNegativeRotationToRef;
  93727. /**
  93728. * Get the position of the bone in local or world space
  93729. * @param space The space that the returned position is in
  93730. * @param mesh The mesh that this bone is attached to. This is only used in world space
  93731. * @returns The position of the bone
  93732. */
  93733. getPosition(space?: Space, mesh?: Nullable<AbstractMesh>): Vector3;
  93734. /**
  93735. * Copy the position of the bone to a vector3 in local or world space
  93736. * @param space The space that the returned position is in
  93737. * @param mesh The mesh that this bone is attached to. This is only used in world space
  93738. * @param result The vector3 to copy the position to
  93739. */
  93740. getPositionToRef(space: Space | undefined, mesh: Nullable<AbstractMesh>, result: Vector3): void;
  93741. /**
  93742. * Get the absolute position of the bone (world space)
  93743. * @param mesh The mesh that this bone is attached to
  93744. * @returns The absolute position of the bone
  93745. */
  93746. getAbsolutePosition(mesh?: Nullable<AbstractMesh>): Vector3;
  93747. /**
  93748. * Copy the absolute position of the bone (world space) to the result param
  93749. * @param mesh The mesh that this bone is attached to
  93750. * @param result The vector3 to copy the absolute position to
  93751. */
  93752. getAbsolutePositionToRef(mesh: AbstractMesh, result: Vector3): void;
  93753. /**
  93754. * Compute the absolute transforms of this bone and its children
  93755. */
  93756. computeAbsoluteTransforms(): void;
  93757. /**
  93758. * Get the world direction from an axis that is in the local space of the bone
  93759. * @param localAxis The local direction that is used to compute the world direction
  93760. * @param mesh The mesh that this bone is attached to
  93761. * @returns The world direction
  93762. */
  93763. getDirection(localAxis: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  93764. /**
  93765. * Copy the world direction to a vector3 from an axis that is in the local space of the bone
  93766. * @param localAxis The local direction that is used to compute the world direction
  93767. * @param mesh The mesh that this bone is attached to
  93768. * @param result The vector3 that the world direction will be copied to
  93769. */
  93770. getDirectionToRef(localAxis: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  93771. /**
  93772. * Get the euler rotation of the bone in local or world space
  93773. * @param space The space that the rotation should be in
  93774. * @param mesh The mesh that this bone is attached to. This is only used in world space
  93775. * @returns The euler rotation
  93776. */
  93777. getRotation(space?: Space, mesh?: Nullable<AbstractMesh>): Vector3;
  93778. /**
  93779. * Copy the euler rotation of the bone to a vector3. The rotation can be in either local or world space
  93780. * @param space The space that the rotation should be in
  93781. * @param mesh The mesh that this bone is attached to. This is only used in world space
  93782. * @param result The vector3 that the rotation should be copied to
  93783. */
  93784. getRotationToRef(space: Space | undefined, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  93785. /**
  93786. * Get the quaternion rotation of the bone in either local or world space
  93787. * @param space The space that the rotation should be in
  93788. * @param mesh The mesh that this bone is attached to. This is only used in world space
  93789. * @returns The quaternion rotation
  93790. */
  93791. getRotationQuaternion(space?: Space, mesh?: Nullable<AbstractMesh>): Quaternion;
  93792. /**
  93793. * Copy the quaternion rotation of the bone to a quaternion. The rotation can be in either local or world space
  93794. * @param space The space that the rotation should be in
  93795. * @param mesh The mesh that this bone is attached to. This is only used in world space
  93796. * @param result The quaternion that the rotation should be copied to
  93797. */
  93798. getRotationQuaternionToRef(space: Space | undefined, mesh: AbstractMesh | null | undefined, result: Quaternion): void;
  93799. /**
  93800. * Get the rotation matrix of the bone in local or world space
  93801. * @param space The space that the rotation should be in
  93802. * @param mesh The mesh that this bone is attached to. This is only used in world space
  93803. * @returns The rotation matrix
  93804. */
  93805. getRotationMatrix(space: Space | undefined, mesh: AbstractMesh): Matrix;
  93806. /**
  93807. * Copy the rotation matrix of the bone to a matrix. The rotation can be in either local or world space
  93808. * @param space The space that the rotation should be in
  93809. * @param mesh The mesh that this bone is attached to. This is only used in world space
  93810. * @param result The quaternion that the rotation should be copied to
  93811. */
  93812. getRotationMatrixToRef(space: Space | undefined, mesh: AbstractMesh, result: Matrix): void;
  93813. /**
  93814. * Get the world position of a point that is in the local space of the bone
  93815. * @param position The local position
  93816. * @param mesh The mesh that this bone is attached to
  93817. * @returns The world position
  93818. */
  93819. getAbsolutePositionFromLocal(position: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  93820. /**
  93821. * Get the world position of a point that is in the local space of the bone and copy it to the result param
  93822. * @param position The local position
  93823. * @param mesh The mesh that this bone is attached to
  93824. * @param result The vector3 that the world position should be copied to
  93825. */
  93826. getAbsolutePositionFromLocalToRef(position: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  93827. /**
  93828. * Get the local position of a point that is in world space
  93829. * @param position The world position
  93830. * @param mesh The mesh that this bone is attached to
  93831. * @returns The local position
  93832. */
  93833. getLocalPositionFromAbsolute(position: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  93834. /**
  93835. * Get the local position of a point that is in world space and copy it to the result param
  93836. * @param position The world position
  93837. * @param mesh The mesh that this bone is attached to
  93838. * @param result The vector3 that the local position should be copied to
  93839. */
  93840. getLocalPositionFromAbsoluteToRef(position: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  93841. }
  93842. }
  93843. declare module BABYLON {
  93844. /**
  93845. * Defines a runtime animation
  93846. */
  93847. export class RuntimeAnimation {
  93848. private _events;
  93849. /**
  93850. * The current frame of the runtime animation
  93851. */
  93852. private _currentFrame;
  93853. /**
  93854. * The animation used by the runtime animation
  93855. */
  93856. private _animation;
  93857. /**
  93858. * The target of the runtime animation
  93859. */
  93860. private _target;
  93861. /**
  93862. * The initiating animatable
  93863. */
  93864. private _host;
  93865. /**
  93866. * The original value of the runtime animation
  93867. */
  93868. private _originalValue;
  93869. /**
  93870. * The original blend value of the runtime animation
  93871. */
  93872. private _originalBlendValue;
  93873. /**
  93874. * The offsets cache of the runtime animation
  93875. */
  93876. private _offsetsCache;
  93877. /**
  93878. * The high limits cache of the runtime animation
  93879. */
  93880. private _highLimitsCache;
  93881. /**
  93882. * Specifies if the runtime animation has been stopped
  93883. */
  93884. private _stopped;
  93885. /**
  93886. * The blending factor of the runtime animation
  93887. */
  93888. private _blendingFactor;
  93889. /**
  93890. * The BabylonJS scene
  93891. */
  93892. private _scene;
  93893. /**
  93894. * The current value of the runtime animation
  93895. */
  93896. private _currentValue;
  93897. /** @hidden */
  93898. _animationState: _IAnimationState;
  93899. /**
  93900. * The active target of the runtime animation
  93901. */
  93902. private _activeTargets;
  93903. private _currentActiveTarget;
  93904. private _directTarget;
  93905. /**
  93906. * The target path of the runtime animation
  93907. */
  93908. private _targetPath;
  93909. /**
  93910. * The weight of the runtime animation
  93911. */
  93912. private _weight;
  93913. /**
  93914. * The ratio offset of the runtime animation
  93915. */
  93916. private _ratioOffset;
  93917. /**
  93918. * The previous delay of the runtime animation
  93919. */
  93920. private _previousDelay;
  93921. /**
  93922. * The previous ratio of the runtime animation
  93923. */
  93924. private _previousRatio;
  93925. private _enableBlending;
  93926. private _keys;
  93927. private _minFrame;
  93928. private _maxFrame;
  93929. private _minValue;
  93930. private _maxValue;
  93931. private _targetIsArray;
  93932. /**
  93933. * Gets the current frame of the runtime animation
  93934. */
  93935. get currentFrame(): number;
  93936. /**
  93937. * Gets the weight of the runtime animation
  93938. */
  93939. get weight(): number;
  93940. /**
  93941. * Gets the current value of the runtime animation
  93942. */
  93943. get currentValue(): any;
  93944. /**
  93945. * Gets the target path of the runtime animation
  93946. */
  93947. get targetPath(): string;
  93948. /**
  93949. * Gets the actual target of the runtime animation
  93950. */
  93951. get target(): any;
  93952. /**
  93953. * Gets the additive state of the runtime animation
  93954. */
  93955. get isAdditive(): boolean;
  93956. /** @hidden */
  93957. _onLoop: () => void;
  93958. /**
  93959. * Create a new RuntimeAnimation object
  93960. * @param target defines the target of the animation
  93961. * @param animation defines the source animation object
  93962. * @param scene defines the hosting scene
  93963. * @param host defines the initiating Animatable
  93964. */
  93965. constructor(target: any, animation: Animation, scene: Scene, host: Animatable);
  93966. private _preparePath;
  93967. /**
  93968. * Gets the animation from the runtime animation
  93969. */
  93970. get animation(): Animation;
  93971. /**
  93972. * Resets the runtime animation to the beginning
  93973. * @param restoreOriginal defines whether to restore the target property to the original value
  93974. */
  93975. reset(restoreOriginal?: boolean): void;
  93976. /**
  93977. * Specifies if the runtime animation is stopped
  93978. * @returns Boolean specifying if the runtime animation is stopped
  93979. */
  93980. isStopped(): boolean;
  93981. /**
  93982. * Disposes of the runtime animation
  93983. */
  93984. dispose(): void;
  93985. /**
  93986. * Apply the interpolated value to the target
  93987. * @param currentValue defines the value computed by the animation
  93988. * @param weight defines the weight to apply to this value (Defaults to 1.0)
  93989. */
  93990. setValue(currentValue: any, weight: number): void;
  93991. private _getOriginalValues;
  93992. private _setValue;
  93993. /**
  93994. * Gets the loop pmode of the runtime animation
  93995. * @returns Loop Mode
  93996. */
  93997. private _getCorrectLoopMode;
  93998. /**
  93999. * Move the current animation to a given frame
  94000. * @param frame defines the frame to move to
  94001. */
  94002. goToFrame(frame: number): void;
  94003. /**
  94004. * @hidden Internal use only
  94005. */
  94006. _prepareForSpeedRatioChange(newSpeedRatio: number): void;
  94007. /**
  94008. * Execute the current animation
  94009. * @param delay defines the delay to add to the current frame
  94010. * @param from defines the lower bound of the animation range
  94011. * @param to defines the upper bound of the animation range
  94012. * @param loop defines if the current animation must loop
  94013. * @param speedRatio defines the current speed ratio
  94014. * @param weight defines the weight of the animation (default is -1 so no weight)
  94015. * @param onLoop optional callback called when animation loops
  94016. * @returns a boolean indicating if the animation is running
  94017. */
  94018. animate(delay: number, from: number, to: number, loop: boolean, speedRatio: number, weight?: number): boolean;
  94019. }
  94020. }
  94021. declare module BABYLON {
  94022. /**
  94023. * Class used to store an actual running animation
  94024. */
  94025. export class Animatable {
  94026. /** defines the target object */
  94027. target: any;
  94028. /** defines the starting frame number (default is 0) */
  94029. fromFrame: number;
  94030. /** defines the ending frame number (default is 100) */
  94031. toFrame: number;
  94032. /** defines if the animation must loop (default is false) */
  94033. loopAnimation: boolean;
  94034. /** defines a callback to call when animation ends if it is not looping */
  94035. onAnimationEnd?: (() => void) | null | undefined;
  94036. /** defines a callback to call when animation loops */
  94037. onAnimationLoop?: (() => void) | null | undefined;
  94038. /** defines whether the animation should be evaluated additively */
  94039. isAdditive: boolean;
  94040. private _localDelayOffset;
  94041. private _pausedDelay;
  94042. private _runtimeAnimations;
  94043. private _paused;
  94044. private _scene;
  94045. private _speedRatio;
  94046. private _weight;
  94047. private _syncRoot;
  94048. /**
  94049. * Gets or sets a boolean indicating if the animatable must be disposed and removed at the end of the animation.
  94050. * This will only apply for non looping animation (default is true)
  94051. */
  94052. disposeOnEnd: boolean;
  94053. /**
  94054. * Gets a boolean indicating if the animation has started
  94055. */
  94056. animationStarted: boolean;
  94057. /**
  94058. * Observer raised when the animation ends
  94059. */
  94060. onAnimationEndObservable: Observable<Animatable>;
  94061. /**
  94062. * Observer raised when the animation loops
  94063. */
  94064. onAnimationLoopObservable: Observable<Animatable>;
  94065. /**
  94066. * Gets the root Animatable used to synchronize and normalize animations
  94067. */
  94068. get syncRoot(): Nullable<Animatable>;
  94069. /**
  94070. * Gets the current frame of the first RuntimeAnimation
  94071. * Used to synchronize Animatables
  94072. */
  94073. get masterFrame(): number;
  94074. /**
  94075. * Gets or sets the animatable weight (-1.0 by default meaning not weighted)
  94076. */
  94077. get weight(): number;
  94078. set weight(value: number);
  94079. /**
  94080. * Gets or sets the speed ratio to apply to the animatable (1.0 by default)
  94081. */
  94082. get speedRatio(): number;
  94083. set speedRatio(value: number);
  94084. /**
  94085. * Creates a new Animatable
  94086. * @param scene defines the hosting scene
  94087. * @param target defines the target object
  94088. * @param fromFrame defines the starting frame number (default is 0)
  94089. * @param toFrame defines the ending frame number (default is 100)
  94090. * @param loopAnimation defines if the animation must loop (default is false)
  94091. * @param speedRatio defines the factor to apply to animation speed (default is 1)
  94092. * @param onAnimationEnd defines a callback to call when animation ends if it is not looping
  94093. * @param animations defines a group of animation to add to the new Animatable
  94094. * @param onAnimationLoop defines a callback to call when animation loops
  94095. * @param isAdditive defines whether the animation should be evaluated additively
  94096. */
  94097. constructor(scene: Scene,
  94098. /** defines the target object */
  94099. target: any,
  94100. /** defines the starting frame number (default is 0) */
  94101. fromFrame?: number,
  94102. /** defines the ending frame number (default is 100) */
  94103. toFrame?: number,
  94104. /** defines if the animation must loop (default is false) */
  94105. loopAnimation?: boolean, speedRatio?: number,
  94106. /** defines a callback to call when animation ends if it is not looping */
  94107. onAnimationEnd?: (() => void) | null | undefined, animations?: Animation[],
  94108. /** defines a callback to call when animation loops */
  94109. onAnimationLoop?: (() => void) | null | undefined,
  94110. /** defines whether the animation should be evaluated additively */
  94111. isAdditive?: boolean);
  94112. /**
  94113. * Synchronize and normalize current Animatable with a source Animatable
  94114. * This is useful when using animation weights and when animations are not of the same length
  94115. * @param root defines the root Animatable to synchronize with
  94116. * @returns the current Animatable
  94117. */
  94118. syncWith(root: Animatable): Animatable;
  94119. /**
  94120. * Gets the list of runtime animations
  94121. * @returns an array of RuntimeAnimation
  94122. */
  94123. getAnimations(): RuntimeAnimation[];
  94124. /**
  94125. * Adds more animations to the current animatable
  94126. * @param target defines the target of the animations
  94127. * @param animations defines the new animations to add
  94128. */
  94129. appendAnimations(target: any, animations: Animation[]): void;
  94130. /**
  94131. * Gets the source animation for a specific property
  94132. * @param property defines the propertyu to look for
  94133. * @returns null or the source animation for the given property
  94134. */
  94135. getAnimationByTargetProperty(property: string): Nullable<Animation>;
  94136. /**
  94137. * Gets the runtime animation for a specific property
  94138. * @param property defines the propertyu to look for
  94139. * @returns null or the runtime animation for the given property
  94140. */
  94141. getRuntimeAnimationByTargetProperty(property: string): Nullable<RuntimeAnimation>;
  94142. /**
  94143. * Resets the animatable to its original state
  94144. */
  94145. reset(): void;
  94146. /**
  94147. * Allows the animatable to blend with current running animations
  94148. * @see https://doc.babylonjs.com/babylon101/animations#animation-blending
  94149. * @param blendingSpeed defines the blending speed to use
  94150. */
  94151. enableBlending(blendingSpeed: number): void;
  94152. /**
  94153. * Disable animation blending
  94154. * @see https://doc.babylonjs.com/babylon101/animations#animation-blending
  94155. */
  94156. disableBlending(): void;
  94157. /**
  94158. * Jump directly to a given frame
  94159. * @param frame defines the frame to jump to
  94160. */
  94161. goToFrame(frame: number): void;
  94162. /**
  94163. * Pause the animation
  94164. */
  94165. pause(): void;
  94166. /**
  94167. * Restart the animation
  94168. */
  94169. restart(): void;
  94170. private _raiseOnAnimationEnd;
  94171. /**
  94172. * Stop and delete the current animation
  94173. * @param animationName defines a string used to only stop some of the runtime animations instead of all
  94174. * @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)
  94175. */
  94176. stop(animationName?: string, targetMask?: (target: any) => boolean): void;
  94177. /**
  94178. * Wait asynchronously for the animation to end
  94179. * @returns a promise which will be fullfilled when the animation ends
  94180. */
  94181. waitAsync(): Promise<Animatable>;
  94182. /** @hidden */
  94183. _animate(delay: number): boolean;
  94184. }
  94185. interface Scene {
  94186. /** @hidden */
  94187. _registerTargetForLateAnimationBinding(runtimeAnimation: RuntimeAnimation, originalValue: any): void;
  94188. /** @hidden */
  94189. _processLateAnimationBindingsForMatrices(holder: {
  94190. totalWeight: number;
  94191. totalAdditiveWeight: number;
  94192. animations: RuntimeAnimation[];
  94193. additiveAnimations: RuntimeAnimation[];
  94194. originalValue: Matrix;
  94195. }): any;
  94196. /** @hidden */
  94197. _processLateAnimationBindingsForQuaternions(holder: {
  94198. totalWeight: number;
  94199. totalAdditiveWeight: number;
  94200. animations: RuntimeAnimation[];
  94201. additiveAnimations: RuntimeAnimation[];
  94202. originalValue: Quaternion;
  94203. }, refQuaternion: Quaternion): Quaternion;
  94204. /** @hidden */
  94205. _processLateAnimationBindings(): void;
  94206. /**
  94207. * Will start the animation sequence of a given target
  94208. * @param target defines the target
  94209. * @param from defines from which frame should animation start
  94210. * @param to defines until which frame should animation run.
  94211. * @param weight defines the weight to apply to the animation (1.0 by default)
  94212. * @param loop defines if the animation loops
  94213. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  94214. * @param onAnimationEnd defines the function to be executed when the animation ends
  94215. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  94216. * @param targetMask defines if the target should be animated if animations are present (this is called recursively on descendant animatables regardless of return value)
  94217. * @param onAnimationLoop defines the callback to call when an animation loops
  94218. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  94219. * @returns the animatable object created for this animation
  94220. */
  94221. 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;
  94222. /**
  94223. * Will start the animation sequence of a given target
  94224. * @param target defines the target
  94225. * @param from defines from which frame should animation start
  94226. * @param to defines until which frame should animation run.
  94227. * @param loop defines if the animation loops
  94228. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  94229. * @param onAnimationEnd defines the function to be executed when the animation ends
  94230. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  94231. * @param stopCurrent defines if the current animations must be stopped first (true by default)
  94232. * @param targetMask defines if the target should be animate if animations are present (this is called recursively on descendant animatables regardless of return value)
  94233. * @param onAnimationLoop defines the callback to call when an animation loops
  94234. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  94235. * @returns the animatable object created for this animation
  94236. */
  94237. 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;
  94238. /**
  94239. * Will start the animation sequence of a given target and its hierarchy
  94240. * @param target defines the target
  94241. * @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.
  94242. * @param from defines from which frame should animation start
  94243. * @param to defines until which frame should animation run.
  94244. * @param loop defines if the animation loops
  94245. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  94246. * @param onAnimationEnd defines the function to be executed when the animation ends
  94247. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  94248. * @param stopCurrent defines if the current animations must be stopped first (true by default)
  94249. * @param targetMask defines if the target should be animated if animations are present (this is called recursively on descendant animatables regardless of return value)
  94250. * @param onAnimationLoop defines the callback to call when an animation loops
  94251. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  94252. * @returns the list of created animatables
  94253. */
  94254. 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[];
  94255. /**
  94256. * Begin a new animation on a given node
  94257. * @param target defines the target where the animation will take place
  94258. * @param animations defines the list of animations to start
  94259. * @param from defines the initial value
  94260. * @param to defines the final value
  94261. * @param loop defines if you want animation to loop (off by default)
  94262. * @param speedRatio defines the speed ratio to apply to all animations
  94263. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  94264. * @param onAnimationLoop defines the callback to call when an animation loops
  94265. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  94266. * @returns the list of created animatables
  94267. */
  94268. beginDirectAnimation(target: any, animations: Animation[], from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, onAnimationLoop?: () => void, isAdditive?: boolean): Animatable;
  94269. /**
  94270. * Begin a new animation on a given node and its hierarchy
  94271. * @param target defines the root node where the animation will take place
  94272. * @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.
  94273. * @param animations defines the list of animations to start
  94274. * @param from defines the initial value
  94275. * @param to defines the final value
  94276. * @param loop defines if you want animation to loop (off by default)
  94277. * @param speedRatio defines the speed ratio to apply to all animations
  94278. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  94279. * @param onAnimationLoop defines the callback to call when an animation loops
  94280. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  94281. * @returns the list of animatables created for all nodes
  94282. */
  94283. beginDirectHierarchyAnimation(target: Node, directDescendantsOnly: boolean, animations: Animation[], from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, onAnimationLoop?: () => void, isAdditive?: boolean): Animatable[];
  94284. /**
  94285. * Gets the animatable associated with a specific target
  94286. * @param target defines the target of the animatable
  94287. * @returns the required animatable if found
  94288. */
  94289. getAnimatableByTarget(target: any): Nullable<Animatable>;
  94290. /**
  94291. * Gets all animatables associated with a given target
  94292. * @param target defines the target to look animatables for
  94293. * @returns an array of Animatables
  94294. */
  94295. getAllAnimatablesByTarget(target: any): Array<Animatable>;
  94296. /**
  94297. * Stops and removes all animations that have been applied to the scene
  94298. */
  94299. stopAllAnimations(): void;
  94300. /**
  94301. * Gets the current delta time used by animation engine
  94302. */
  94303. deltaTime: number;
  94304. }
  94305. interface Bone {
  94306. /**
  94307. * Copy an animation range from another bone
  94308. * @param source defines the source bone
  94309. * @param rangeName defines the range name to copy
  94310. * @param frameOffset defines the frame offset
  94311. * @param rescaleAsRequired defines if rescaling must be applied if required
  94312. * @param skelDimensionsRatio defines the scaling ratio
  94313. * @returns true if operation was successful
  94314. */
  94315. copyAnimationRange(source: Bone, rangeName: string, frameOffset: number, rescaleAsRequired: boolean, skelDimensionsRatio: Nullable<Vector3>): boolean;
  94316. }
  94317. }
  94318. declare module BABYLON {
  94319. /**
  94320. * Class used to handle skinning animations
  94321. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  94322. */
  94323. export class Skeleton implements IAnimatable {
  94324. /** defines the skeleton name */
  94325. name: string;
  94326. /** defines the skeleton Id */
  94327. id: string;
  94328. /**
  94329. * Defines the list of child bones
  94330. */
  94331. bones: Bone[];
  94332. /**
  94333. * Defines an estimate of the dimension of the skeleton at rest
  94334. */
  94335. dimensionsAtRest: Vector3;
  94336. /**
  94337. * Defines a boolean indicating if the root matrix is provided by meshes or by the current skeleton (this is the default value)
  94338. */
  94339. needInitialSkinMatrix: boolean;
  94340. /**
  94341. * Defines a mesh that override the matrix used to get the world matrix (null by default).
  94342. */
  94343. overrideMesh: Nullable<AbstractMesh>;
  94344. /**
  94345. * Gets the list of animations attached to this skeleton
  94346. */
  94347. animations: Array<Animation>;
  94348. private _scene;
  94349. private _isDirty;
  94350. private _transformMatrices;
  94351. private _transformMatrixTexture;
  94352. private _meshesWithPoseMatrix;
  94353. private _animatables;
  94354. private _identity;
  94355. private _synchronizedWithMesh;
  94356. private _ranges;
  94357. private _lastAbsoluteTransformsUpdateId;
  94358. private _canUseTextureForBones;
  94359. private _uniqueId;
  94360. /** @hidden */
  94361. _numBonesWithLinkedTransformNode: number;
  94362. /** @hidden */
  94363. _hasWaitingData: Nullable<boolean>;
  94364. /**
  94365. * Specifies if the skeleton should be serialized
  94366. */
  94367. doNotSerialize: boolean;
  94368. private _useTextureToStoreBoneMatrices;
  94369. /**
  94370. * Gets or sets a boolean indicating that bone matrices should be stored as a texture instead of using shader uniforms (default is true).
  94371. * Please note that this option is not available if the hardware does not support it
  94372. */
  94373. get useTextureToStoreBoneMatrices(): boolean;
  94374. set useTextureToStoreBoneMatrices(value: boolean);
  94375. private _animationPropertiesOverride;
  94376. /**
  94377. * Gets or sets the animation properties override
  94378. */
  94379. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  94380. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  94381. /**
  94382. * List of inspectable custom properties (used by the Inspector)
  94383. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  94384. */
  94385. inspectableCustomProperties: IInspectable[];
  94386. /**
  94387. * An observable triggered before computing the skeleton's matrices
  94388. */
  94389. onBeforeComputeObservable: Observable<Skeleton>;
  94390. /**
  94391. * Gets a boolean indicating that the skeleton effectively stores matrices into a texture
  94392. */
  94393. get isUsingTextureForMatrices(): boolean;
  94394. /**
  94395. * Gets the unique ID of this skeleton
  94396. */
  94397. get uniqueId(): number;
  94398. /**
  94399. * Creates a new skeleton
  94400. * @param name defines the skeleton name
  94401. * @param id defines the skeleton Id
  94402. * @param scene defines the hosting scene
  94403. */
  94404. constructor(
  94405. /** defines the skeleton name */
  94406. name: string,
  94407. /** defines the skeleton Id */
  94408. id: string, scene: Scene);
  94409. /**
  94410. * Gets the current object class name.
  94411. * @return the class name
  94412. */
  94413. getClassName(): string;
  94414. /**
  94415. * Returns an array containing the root bones
  94416. * @returns an array containing the root bones
  94417. */
  94418. getChildren(): Array<Bone>;
  94419. /**
  94420. * Gets the list of transform matrices to send to shaders (one matrix per bone)
  94421. * @param mesh defines the mesh to use to get the root matrix (if needInitialSkinMatrix === true)
  94422. * @returns a Float32Array containing matrices data
  94423. */
  94424. getTransformMatrices(mesh: AbstractMesh): Float32Array;
  94425. /**
  94426. * Gets the list of transform matrices to send to shaders inside a texture (one matrix per bone)
  94427. * @param mesh defines the mesh to use to get the root matrix (if needInitialSkinMatrix === true)
  94428. * @returns a raw texture containing the data
  94429. */
  94430. getTransformMatrixTexture(mesh: AbstractMesh): Nullable<RawTexture>;
  94431. /**
  94432. * Gets the current hosting scene
  94433. * @returns a scene object
  94434. */
  94435. getScene(): Scene;
  94436. /**
  94437. * Gets a string representing the current skeleton data
  94438. * @param fullDetails defines a boolean indicating if we want a verbose version
  94439. * @returns a string representing the current skeleton data
  94440. */
  94441. toString(fullDetails?: boolean): string;
  94442. /**
  94443. * Get bone's index searching by name
  94444. * @param name defines bone's name to search for
  94445. * @return the indice of the bone. Returns -1 if not found
  94446. */
  94447. getBoneIndexByName(name: string): number;
  94448. /**
  94449. * Creater a new animation range
  94450. * @param name defines the name of the range
  94451. * @param from defines the start key
  94452. * @param to defines the end key
  94453. */
  94454. createAnimationRange(name: string, from: number, to: number): void;
  94455. /**
  94456. * Delete a specific animation range
  94457. * @param name defines the name of the range
  94458. * @param deleteFrames defines if frames must be removed as well
  94459. */
  94460. deleteAnimationRange(name: string, deleteFrames?: boolean): void;
  94461. /**
  94462. * Gets a specific animation range
  94463. * @param name defines the name of the range to look for
  94464. * @returns the requested animation range or null if not found
  94465. */
  94466. getAnimationRange(name: string): Nullable<AnimationRange>;
  94467. /**
  94468. * Gets the list of all animation ranges defined on this skeleton
  94469. * @returns an array
  94470. */
  94471. getAnimationRanges(): Nullable<AnimationRange>[];
  94472. /**
  94473. * Copy animation range from a source skeleton.
  94474. * This is not for a complete retargeting, only between very similar skeleton's with only possible bone length differences
  94475. * @param source defines the source skeleton
  94476. * @param name defines the name of the range to copy
  94477. * @param rescaleAsRequired defines if rescaling must be applied if required
  94478. * @returns true if operation was successful
  94479. */
  94480. copyAnimationRange(source: Skeleton, name: string, rescaleAsRequired?: boolean): boolean;
  94481. /**
  94482. * Forces the skeleton to go to rest pose
  94483. */
  94484. returnToRest(): void;
  94485. private _getHighestAnimationFrame;
  94486. /**
  94487. * Begin a specific animation range
  94488. * @param name defines the name of the range to start
  94489. * @param loop defines if looping must be turned on (false by default)
  94490. * @param speedRatio defines the speed ratio to apply (1 by default)
  94491. * @param onAnimationEnd defines a callback which will be called when animation will end
  94492. * @returns a new animatable
  94493. */
  94494. beginAnimation(name: string, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void): Nullable<Animatable>;
  94495. /**
  94496. * Convert the keyframes for a range of animation on a skeleton to be relative to a given reference frame.
  94497. * @param skeleton defines the Skeleton containing the animation range to convert
  94498. * @param referenceFrame defines the frame that keyframes in the range will be relative to
  94499. * @param range defines the name of the AnimationRange belonging to the Skeleton to convert
  94500. * @returns the original skeleton
  94501. */
  94502. static MakeAnimationAdditive(skeleton: Skeleton, referenceFrame: number | undefined, range: string): Nullable<Skeleton>;
  94503. /** @hidden */
  94504. _markAsDirty(): void;
  94505. /** @hidden */
  94506. _registerMeshWithPoseMatrix(mesh: AbstractMesh): void;
  94507. /** @hidden */
  94508. _unregisterMeshWithPoseMatrix(mesh: AbstractMesh): void;
  94509. private _computeTransformMatrices;
  94510. /**
  94511. * Build all resources required to render a skeleton
  94512. */
  94513. prepare(): void;
  94514. /**
  94515. * Gets the list of animatables currently running for this skeleton
  94516. * @returns an array of animatables
  94517. */
  94518. getAnimatables(): IAnimatable[];
  94519. /**
  94520. * Clone the current skeleton
  94521. * @param name defines the name of the new skeleton
  94522. * @param id defines the id of the new skeleton
  94523. * @returns the new skeleton
  94524. */
  94525. clone(name: string, id?: string): Skeleton;
  94526. /**
  94527. * Enable animation blending for this skeleton
  94528. * @param blendingSpeed defines the blending speed to apply
  94529. * @see https://doc.babylonjs.com/babylon101/animations#animation-blending
  94530. */
  94531. enableBlending(blendingSpeed?: number): void;
  94532. /**
  94533. * Releases all resources associated with the current skeleton
  94534. */
  94535. dispose(): void;
  94536. /**
  94537. * Serialize the skeleton in a JSON object
  94538. * @returns a JSON object
  94539. */
  94540. serialize(): any;
  94541. /**
  94542. * Creates a new skeleton from serialized data
  94543. * @param parsedSkeleton defines the serialized data
  94544. * @param scene defines the hosting scene
  94545. * @returns a new skeleton
  94546. */
  94547. static Parse(parsedSkeleton: any, scene: Scene): Skeleton;
  94548. /**
  94549. * Compute all node absolute transforms
  94550. * @param forceUpdate defines if computation must be done even if cache is up to date
  94551. */
  94552. computeAbsoluteTransforms(forceUpdate?: boolean): void;
  94553. /**
  94554. * Gets the root pose matrix
  94555. * @returns a matrix
  94556. */
  94557. getPoseMatrix(): Nullable<Matrix>;
  94558. /**
  94559. * Sorts bones per internal index
  94560. */
  94561. sortBones(): void;
  94562. private _sortBones;
  94563. }
  94564. }
  94565. declare module BABYLON {
  94566. /**
  94567. * Creates an instance based on a source mesh.
  94568. */
  94569. export class InstancedMesh extends AbstractMesh {
  94570. private _sourceMesh;
  94571. private _currentLOD;
  94572. /** @hidden */
  94573. _indexInSourceMeshInstanceArray: number;
  94574. constructor(name: string, source: Mesh);
  94575. /**
  94576. * Returns the string "InstancedMesh".
  94577. */
  94578. getClassName(): string;
  94579. /** Gets the list of lights affecting that mesh */
  94580. get lightSources(): Light[];
  94581. _resyncLightSources(): void;
  94582. _resyncLightSource(light: Light): void;
  94583. _removeLightSource(light: Light, dispose: boolean): void;
  94584. /**
  94585. * If the source mesh receives shadows
  94586. */
  94587. get receiveShadows(): boolean;
  94588. /**
  94589. * The material of the source mesh
  94590. */
  94591. get material(): Nullable<Material>;
  94592. /**
  94593. * Visibility of the source mesh
  94594. */
  94595. get visibility(): number;
  94596. /**
  94597. * Skeleton of the source mesh
  94598. */
  94599. get skeleton(): Nullable<Skeleton>;
  94600. /**
  94601. * Rendering ground id of the source mesh
  94602. */
  94603. get renderingGroupId(): number;
  94604. set renderingGroupId(value: number);
  94605. /**
  94606. * Returns the total number of vertices (integer).
  94607. */
  94608. getTotalVertices(): number;
  94609. /**
  94610. * Returns a positive integer : the total number of indices in this mesh geometry.
  94611. * @returns the numner of indices or zero if the mesh has no geometry.
  94612. */
  94613. getTotalIndices(): number;
  94614. /**
  94615. * The source mesh of the instance
  94616. */
  94617. get sourceMesh(): Mesh;
  94618. /**
  94619. * Creates a new InstancedMesh object from the mesh model.
  94620. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  94621. * @param name defines the name of the new instance
  94622. * @returns a new InstancedMesh
  94623. */
  94624. createInstance(name: string): InstancedMesh;
  94625. /**
  94626. * Is this node ready to be used/rendered
  94627. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  94628. * @return {boolean} is it ready
  94629. */
  94630. isReady(completeCheck?: boolean): boolean;
  94631. /**
  94632. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  94633. * @param kind kind of verticies to retreive (eg. positons, normals, uvs, etc.)
  94634. * @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.
  94635. * @returns a float array or a Float32Array of the requested kind of data : positons, normals, uvs, etc.
  94636. */
  94637. getVerticesData(kind: string, copyWhenShared?: boolean): Nullable<FloatArray>;
  94638. /**
  94639. * Sets the vertex data of the mesh geometry for the requested `kind`.
  94640. * If the mesh has no geometry, a new Geometry object is set to the mesh and then passed this vertex data.
  94641. * The `data` are either a numeric array either a Float32Array.
  94642. * The parameter `updatable` is passed as is to the underlying Geometry object constructor (if initianilly none) or updater.
  94643. * 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).
  94644. * Note that a new underlying VertexBuffer object is created each call.
  94645. * If the `kind` is the `PositionKind`, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  94646. *
  94647. * Possible `kind` values :
  94648. * - VertexBuffer.PositionKind
  94649. * - VertexBuffer.UVKind
  94650. * - VertexBuffer.UV2Kind
  94651. * - VertexBuffer.UV3Kind
  94652. * - VertexBuffer.UV4Kind
  94653. * - VertexBuffer.UV5Kind
  94654. * - VertexBuffer.UV6Kind
  94655. * - VertexBuffer.ColorKind
  94656. * - VertexBuffer.MatricesIndicesKind
  94657. * - VertexBuffer.MatricesIndicesExtraKind
  94658. * - VertexBuffer.MatricesWeightsKind
  94659. * - VertexBuffer.MatricesWeightsExtraKind
  94660. *
  94661. * Returns the Mesh.
  94662. */
  94663. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  94664. /**
  94665. * Updates the existing vertex data of the mesh geometry for the requested `kind`.
  94666. * If the mesh has no geometry, it is simply returned as it is.
  94667. * The `data` are either a numeric array either a Float32Array.
  94668. * No new underlying VertexBuffer object is created.
  94669. * 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.
  94670. * If the parameter `makeItUnique` is true, a new global geometry is created from this positions and is set to the mesh.
  94671. *
  94672. * Possible `kind` values :
  94673. * - VertexBuffer.PositionKind
  94674. * - VertexBuffer.UVKind
  94675. * - VertexBuffer.UV2Kind
  94676. * - VertexBuffer.UV3Kind
  94677. * - VertexBuffer.UV4Kind
  94678. * - VertexBuffer.UV5Kind
  94679. * - VertexBuffer.UV6Kind
  94680. * - VertexBuffer.ColorKind
  94681. * - VertexBuffer.MatricesIndicesKind
  94682. * - VertexBuffer.MatricesIndicesExtraKind
  94683. * - VertexBuffer.MatricesWeightsKind
  94684. * - VertexBuffer.MatricesWeightsExtraKind
  94685. *
  94686. * Returns the Mesh.
  94687. */
  94688. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): Mesh;
  94689. /**
  94690. * Sets the mesh indices.
  94691. * Expects an array populated with integers or a typed array (Int32Array, Uint32Array, Uint16Array).
  94692. * If the mesh has no geometry, a new Geometry object is created and set to the mesh.
  94693. * This method creates a new index buffer each call.
  94694. * Returns the Mesh.
  94695. */
  94696. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>): Mesh;
  94697. /**
  94698. * Boolean : True if the mesh owns the requested kind of data.
  94699. */
  94700. isVerticesDataPresent(kind: string): boolean;
  94701. /**
  94702. * Returns an array of indices (IndicesArray).
  94703. */
  94704. getIndices(): Nullable<IndicesArray>;
  94705. get _positions(): Nullable<Vector3[]>;
  94706. /**
  94707. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  94708. * This means the mesh underlying bounding box and sphere are recomputed.
  94709. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  94710. * @returns the current mesh
  94711. */
  94712. refreshBoundingInfo(applySkeleton?: boolean): InstancedMesh;
  94713. /** @hidden */
  94714. _preActivate(): InstancedMesh;
  94715. /** @hidden */
  94716. _activate(renderId: number, intermediateRendering: boolean): boolean;
  94717. /** @hidden */
  94718. _postActivate(): void;
  94719. getWorldMatrix(): Matrix;
  94720. get isAnInstance(): boolean;
  94721. /**
  94722. * Returns the current associated LOD AbstractMesh.
  94723. */
  94724. getLOD(camera: Camera): AbstractMesh;
  94725. /** @hidden */
  94726. _preActivateForIntermediateRendering(renderId: number): Mesh;
  94727. /** @hidden */
  94728. _syncSubMeshes(): InstancedMesh;
  94729. /** @hidden */
  94730. _generatePointsArray(): boolean;
  94731. /**
  94732. * Creates a new InstancedMesh from the current mesh.
  94733. * - name (string) : the cloned mesh name
  94734. * - newParent (optional Node) : the optional Node to parent the clone to.
  94735. * - doNotCloneChildren (optional boolean, default `false`) : if `true` the model children aren't cloned.
  94736. *
  94737. * Returns the clone.
  94738. */
  94739. clone(name: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean): InstancedMesh;
  94740. /**
  94741. * Disposes the InstancedMesh.
  94742. * Returns nothing.
  94743. */
  94744. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  94745. }
  94746. interface Mesh {
  94747. /**
  94748. * Register a custom buffer that will be instanced
  94749. * @see https://doc.babylonjs.com/how_to/how_to_use_instances#custom-buffers
  94750. * @param kind defines the buffer kind
  94751. * @param stride defines the stride in floats
  94752. */
  94753. registerInstancedBuffer(kind: string, stride: number): void;
  94754. /**
  94755. * true to use the edge renderer for all instances of this mesh
  94756. */
  94757. edgesShareWithInstances: boolean;
  94758. /** @hidden */
  94759. _userInstancedBuffersStorage: {
  94760. data: {
  94761. [key: string]: Float32Array;
  94762. };
  94763. sizes: {
  94764. [key: string]: number;
  94765. };
  94766. vertexBuffers: {
  94767. [key: string]: Nullable<VertexBuffer>;
  94768. };
  94769. strides: {
  94770. [key: string]: number;
  94771. };
  94772. };
  94773. }
  94774. interface AbstractMesh {
  94775. /**
  94776. * Object used to store instanced buffers defined by user
  94777. * @see https://doc.babylonjs.com/how_to/how_to_use_instances#custom-buffers
  94778. */
  94779. instancedBuffers: {
  94780. [key: string]: any;
  94781. };
  94782. }
  94783. }
  94784. declare module BABYLON {
  94785. /**
  94786. * Defines the options associated with the creation of a shader material.
  94787. */
  94788. export interface IShaderMaterialOptions {
  94789. /**
  94790. * Does the material work in alpha blend mode
  94791. */
  94792. needAlphaBlending: boolean;
  94793. /**
  94794. * Does the material work in alpha test mode
  94795. */
  94796. needAlphaTesting: boolean;
  94797. /**
  94798. * The list of attribute names used in the shader
  94799. */
  94800. attributes: string[];
  94801. /**
  94802. * The list of unifrom names used in the shader
  94803. */
  94804. uniforms: string[];
  94805. /**
  94806. * The list of UBO names used in the shader
  94807. */
  94808. uniformBuffers: string[];
  94809. /**
  94810. * The list of sampler names used in the shader
  94811. */
  94812. samplers: string[];
  94813. /**
  94814. * The list of defines used in the shader
  94815. */
  94816. defines: string[];
  94817. }
  94818. /**
  94819. * 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.
  94820. *
  94821. * This returned material effects how the mesh will look based on the code in the shaders.
  94822. *
  94823. * @see https://doc.babylonjs.com/how_to/shader_material
  94824. */
  94825. export class ShaderMaterial extends Material {
  94826. private _shaderPath;
  94827. private _options;
  94828. private _textures;
  94829. private _textureArrays;
  94830. private _floats;
  94831. private _ints;
  94832. private _floatsArrays;
  94833. private _colors3;
  94834. private _colors3Arrays;
  94835. private _colors4;
  94836. private _colors4Arrays;
  94837. private _vectors2;
  94838. private _vectors3;
  94839. private _vectors4;
  94840. private _matrices;
  94841. private _matrixArrays;
  94842. private _matrices3x3;
  94843. private _matrices2x2;
  94844. private _vectors2Arrays;
  94845. private _vectors3Arrays;
  94846. private _vectors4Arrays;
  94847. private _cachedWorldViewMatrix;
  94848. private _cachedWorldViewProjectionMatrix;
  94849. private _renderId;
  94850. private _multiview;
  94851. private _cachedDefines;
  94852. /** Define the Url to load snippets */
  94853. static SnippetUrl: string;
  94854. /** Snippet ID if the material was created from the snippet server */
  94855. snippetId: string;
  94856. /**
  94857. * Instantiate a new shader material.
  94858. * 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.
  94859. * This returned material effects how the mesh will look based on the code in the shaders.
  94860. * @see https://doc.babylonjs.com/how_to/shader_material
  94861. * @param name Define the name of the material in the scene
  94862. * @param scene Define the scene the material belongs to
  94863. * @param shaderPath Defines the route to the shader code in one of three ways:
  94864. * * object: { vertex: "custom", fragment: "custom" }, used with Effect.ShadersStore["customVertexShader"] and Effect.ShadersStore["customFragmentShader"]
  94865. * * object: { vertexElement: "vertexShaderCode", fragmentElement: "fragmentShaderCode" }, used with shader code in script tags
  94866. * * object: { vertexSource: "vertex shader code string", fragmentSource: "fragment shader code string" } using with strings containing the shaders code
  94867. * * string: "./COMMON_NAME", used with external files COMMON_NAME.vertex.fx and COMMON_NAME.fragment.fx in index.html folder.
  94868. * @param options Define the options used to create the shader
  94869. */
  94870. constructor(name: string, scene: Scene, shaderPath: any, options?: Partial<IShaderMaterialOptions>);
  94871. /**
  94872. * Gets the shader path used to define the shader code
  94873. * It can be modified to trigger a new compilation
  94874. */
  94875. get shaderPath(): any;
  94876. /**
  94877. * Sets the shader path used to define the shader code
  94878. * It can be modified to trigger a new compilation
  94879. */
  94880. set shaderPath(shaderPath: any);
  94881. /**
  94882. * Gets the options used to compile the shader.
  94883. * They can be modified to trigger a new compilation
  94884. */
  94885. get options(): IShaderMaterialOptions;
  94886. /**
  94887. * Gets the current class name of the material e.g. "ShaderMaterial"
  94888. * Mainly use in serialization.
  94889. * @returns the class name
  94890. */
  94891. getClassName(): string;
  94892. /**
  94893. * Specifies if the material will require alpha blending
  94894. * @returns a boolean specifying if alpha blending is needed
  94895. */
  94896. needAlphaBlending(): boolean;
  94897. /**
  94898. * Specifies if this material should be rendered in alpha test mode
  94899. * @returns a boolean specifying if an alpha test is needed.
  94900. */
  94901. needAlphaTesting(): boolean;
  94902. private _checkUniform;
  94903. /**
  94904. * Set a texture in the shader.
  94905. * @param name Define the name of the uniform samplers as defined in the shader
  94906. * @param texture Define the texture to bind to this sampler
  94907. * @return the material itself allowing "fluent" like uniform updates
  94908. */
  94909. setTexture(name: string, texture: BaseTexture): ShaderMaterial;
  94910. /**
  94911. * Set a texture array in the shader.
  94912. * @param name Define the name of the uniform sampler array as defined in the shader
  94913. * @param textures Define the list of textures to bind to this sampler
  94914. * @return the material itself allowing "fluent" like uniform updates
  94915. */
  94916. setTextureArray(name: string, textures: BaseTexture[]): ShaderMaterial;
  94917. /**
  94918. * Set a float in the shader.
  94919. * @param name Define the name of the uniform as defined in the shader
  94920. * @param value Define the value to give to the uniform
  94921. * @return the material itself allowing "fluent" like uniform updates
  94922. */
  94923. setFloat(name: string, value: number): ShaderMaterial;
  94924. /**
  94925. * Set a int in the shader.
  94926. * @param name Define the name of the uniform as defined in the shader
  94927. * @param value Define the value to give to the uniform
  94928. * @return the material itself allowing "fluent" like uniform updates
  94929. */
  94930. setInt(name: string, value: number): ShaderMaterial;
  94931. /**
  94932. * Set an array of floats in the shader.
  94933. * @param name Define the name of the uniform as defined in the shader
  94934. * @param value Define the value to give to the uniform
  94935. * @return the material itself allowing "fluent" like uniform updates
  94936. */
  94937. setFloats(name: string, value: number[]): ShaderMaterial;
  94938. /**
  94939. * Set a vec3 in the shader from a Color3.
  94940. * @param name Define the name of the uniform as defined in the shader
  94941. * @param value Define the value to give to the uniform
  94942. * @return the material itself allowing "fluent" like uniform updates
  94943. */
  94944. setColor3(name: string, value: Color3): ShaderMaterial;
  94945. /**
  94946. * Set a vec3 array in the shader from a Color3 array.
  94947. * @param name Define the name of the uniform as defined in the shader
  94948. * @param value Define the value to give to the uniform
  94949. * @return the material itself allowing "fluent" like uniform updates
  94950. */
  94951. setColor3Array(name: string, value: Color3[]): ShaderMaterial;
  94952. /**
  94953. * Set a vec4 in the shader from a Color4.
  94954. * @param name Define the name of the uniform as defined in the shader
  94955. * @param value Define the value to give to the uniform
  94956. * @return the material itself allowing "fluent" like uniform updates
  94957. */
  94958. setColor4(name: string, value: Color4): ShaderMaterial;
  94959. /**
  94960. * Set a vec4 array in the shader from a Color4 array.
  94961. * @param name Define the name of the uniform as defined in the shader
  94962. * @param value Define the value to give to the uniform
  94963. * @return the material itself allowing "fluent" like uniform updates
  94964. */
  94965. setColor4Array(name: string, value: Color4[]): ShaderMaterial;
  94966. /**
  94967. * Set a vec2 in the shader from a Vector2.
  94968. * @param name Define the name of the uniform as defined in the shader
  94969. * @param value Define the value to give to the uniform
  94970. * @return the material itself allowing "fluent" like uniform updates
  94971. */
  94972. setVector2(name: string, value: Vector2): ShaderMaterial;
  94973. /**
  94974. * Set a vec3 in the shader from a Vector3.
  94975. * @param name Define the name of the uniform as defined in the shader
  94976. * @param value Define the value to give to the uniform
  94977. * @return the material itself allowing "fluent" like uniform updates
  94978. */
  94979. setVector3(name: string, value: Vector3): ShaderMaterial;
  94980. /**
  94981. * Set a vec4 in the shader from a Vector4.
  94982. * @param name Define the name of the uniform as defined in the shader
  94983. * @param value Define the value to give to the uniform
  94984. * @return the material itself allowing "fluent" like uniform updates
  94985. */
  94986. setVector4(name: string, value: Vector4): ShaderMaterial;
  94987. /**
  94988. * Set a mat4 in the shader from a Matrix.
  94989. * @param name Define the name of the uniform as defined in the shader
  94990. * @param value Define the value to give to the uniform
  94991. * @return the material itself allowing "fluent" like uniform updates
  94992. */
  94993. setMatrix(name: string, value: Matrix): ShaderMaterial;
  94994. /**
  94995. * Set a float32Array in the shader from a matrix array.
  94996. * @param name Define the name of the uniform as defined in the shader
  94997. * @param value Define the value to give to the uniform
  94998. * @return the material itself allowing "fluent" like uniform updates
  94999. */
  95000. setMatrices(name: string, value: Matrix[]): ShaderMaterial;
  95001. /**
  95002. * Set a mat3 in the shader from a Float32Array.
  95003. * @param name Define the name of the uniform as defined in the shader
  95004. * @param value Define the value to give to the uniform
  95005. * @return the material itself allowing "fluent" like uniform updates
  95006. */
  95007. setMatrix3x3(name: string, value: Float32Array | Array<number>): ShaderMaterial;
  95008. /**
  95009. * Set a mat2 in the shader from a Float32Array.
  95010. * @param name Define the name of the uniform as defined in the shader
  95011. * @param value Define the value to give to the uniform
  95012. * @return the material itself allowing "fluent" like uniform updates
  95013. */
  95014. setMatrix2x2(name: string, value: Float32Array | Array<number>): ShaderMaterial;
  95015. /**
  95016. * Set a vec2 array in the shader from a number array.
  95017. * @param name Define the name of the uniform as defined in the shader
  95018. * @param value Define the value to give to the uniform
  95019. * @return the material itself allowing "fluent" like uniform updates
  95020. */
  95021. setArray2(name: string, value: number[]): ShaderMaterial;
  95022. /**
  95023. * Set a vec3 array in the shader from a number array.
  95024. * @param name Define the name of the uniform as defined in the shader
  95025. * @param value Define the value to give to the uniform
  95026. * @return the material itself allowing "fluent" like uniform updates
  95027. */
  95028. setArray3(name: string, value: number[]): ShaderMaterial;
  95029. /**
  95030. * Set a vec4 array in the shader from a number array.
  95031. * @param name Define the name of the uniform as defined in the shader
  95032. * @param value Define the value to give to the uniform
  95033. * @return the material itself allowing "fluent" like uniform updates
  95034. */
  95035. setArray4(name: string, value: number[]): ShaderMaterial;
  95036. private _checkCache;
  95037. /**
  95038. * Specifies that the submesh is ready to be used
  95039. * @param mesh defines the mesh to check
  95040. * @param subMesh defines which submesh to check
  95041. * @param useInstances specifies that instances should be used
  95042. * @returns a boolean indicating that the submesh is ready or not
  95043. */
  95044. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  95045. /**
  95046. * Checks if the material is ready to render the requested mesh
  95047. * @param mesh Define the mesh to render
  95048. * @param useInstances Define whether or not the material is used with instances
  95049. * @returns true if ready, otherwise false
  95050. */
  95051. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  95052. /**
  95053. * Binds the world matrix to the material
  95054. * @param world defines the world transformation matrix
  95055. * @param effectOverride - If provided, use this effect instead of internal effect
  95056. */
  95057. bindOnlyWorldMatrix(world: Matrix, effectOverride?: Nullable<Effect>): void;
  95058. /**
  95059. * Binds the submesh to this material by preparing the effect and shader to draw
  95060. * @param world defines the world transformation matrix
  95061. * @param mesh defines the mesh containing the submesh
  95062. * @param subMesh defines the submesh to bind the material to
  95063. */
  95064. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  95065. /**
  95066. * Binds the material to the mesh
  95067. * @param world defines the world transformation matrix
  95068. * @param mesh defines the mesh to bind the material to
  95069. * @param effectOverride - If provided, use this effect instead of internal effect
  95070. */
  95071. bind(world: Matrix, mesh?: Mesh, effectOverride?: Nullable<Effect>): void;
  95072. protected _afterBind(mesh?: Mesh): void;
  95073. /**
  95074. * Gets the active textures from the material
  95075. * @returns an array of textures
  95076. */
  95077. getActiveTextures(): BaseTexture[];
  95078. /**
  95079. * Specifies if the material uses a texture
  95080. * @param texture defines the texture to check against the material
  95081. * @returns a boolean specifying if the material uses the texture
  95082. */
  95083. hasTexture(texture: BaseTexture): boolean;
  95084. /**
  95085. * Makes a duplicate of the material, and gives it a new name
  95086. * @param name defines the new name for the duplicated material
  95087. * @returns the cloned material
  95088. */
  95089. clone(name: string): ShaderMaterial;
  95090. /**
  95091. * Disposes the material
  95092. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  95093. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  95094. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  95095. */
  95096. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  95097. /**
  95098. * Serializes this material in a JSON representation
  95099. * @returns the serialized material object
  95100. */
  95101. serialize(): any;
  95102. /**
  95103. * Creates a shader material from parsed shader material data
  95104. * @param source defines the JSON represnetation of the material
  95105. * @param scene defines the hosting scene
  95106. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  95107. * @returns a new material
  95108. */
  95109. static Parse(source: any, scene: Scene, rootUrl: string): ShaderMaterial;
  95110. /**
  95111. * Creates a new ShaderMaterial from a snippet saved in a remote file
  95112. * @param name defines the name of the ShaderMaterial to create (can be null or empty to use the one from the json data)
  95113. * @param url defines the url to load from
  95114. * @param scene defines the hosting scene
  95115. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  95116. * @returns a promise that will resolve to the new ShaderMaterial
  95117. */
  95118. static ParseFromFileAsync(name: Nullable<string>, url: string, scene: Scene, rootUrl?: string): Promise<ShaderMaterial>;
  95119. /**
  95120. * Creates a ShaderMaterial from a snippet saved by the Inspector
  95121. * @param snippetId defines the snippet to load
  95122. * @param scene defines the hosting scene
  95123. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  95124. * @returns a promise that will resolve to the new ShaderMaterial
  95125. */
  95126. static CreateFromSnippetAsync(snippetId: string, scene: Scene, rootUrl?: string): Promise<ShaderMaterial>;
  95127. }
  95128. }
  95129. declare module BABYLON {
  95130. /** @hidden */
  95131. export var colorPixelShader: {
  95132. name: string;
  95133. shader: string;
  95134. };
  95135. }
  95136. declare module BABYLON {
  95137. /** @hidden */
  95138. export var colorVertexShader: {
  95139. name: string;
  95140. shader: string;
  95141. };
  95142. }
  95143. declare module BABYLON {
  95144. /**
  95145. * Line mesh
  95146. * @see https://doc.babylonjs.com/babylon101/parametric_shapes
  95147. */
  95148. export class LinesMesh extends Mesh {
  95149. /**
  95150. * If vertex color should be applied to the mesh
  95151. */
  95152. readonly useVertexColor?: boolean | undefined;
  95153. /**
  95154. * If vertex alpha should be applied to the mesh
  95155. */
  95156. readonly useVertexAlpha?: boolean | undefined;
  95157. /**
  95158. * Color of the line (Default: White)
  95159. */
  95160. color: Color3;
  95161. /**
  95162. * Alpha of the line (Default: 1)
  95163. */
  95164. alpha: number;
  95165. /**
  95166. * The intersection Threshold is the margin applied when intersection a segment of the LinesMesh with a Ray.
  95167. * This margin is expressed in world space coordinates, so its value may vary.
  95168. * Default value is 0.1
  95169. */
  95170. intersectionThreshold: number;
  95171. private _colorShader;
  95172. private color4;
  95173. /**
  95174. * Creates a new LinesMesh
  95175. * @param name defines the name
  95176. * @param scene defines the hosting scene
  95177. * @param parent defines the parent mesh if any
  95178. * @param source defines the optional source LinesMesh used to clone data from
  95179. * @param doNotCloneChildren When cloning, skip cloning child meshes of source, default False.
  95180. * When false, achieved by calling a clone(), also passing False.
  95181. * This will make creation of children, recursive.
  95182. * @param useVertexColor defines if this LinesMesh supports vertex color
  95183. * @param useVertexAlpha defines if this LinesMesh supports vertex alpha
  95184. */
  95185. constructor(name: string, scene?: Nullable<Scene>, parent?: Nullable<Node>, source?: Nullable<LinesMesh>, doNotCloneChildren?: boolean,
  95186. /**
  95187. * If vertex color should be applied to the mesh
  95188. */
  95189. useVertexColor?: boolean | undefined,
  95190. /**
  95191. * If vertex alpha should be applied to the mesh
  95192. */
  95193. useVertexAlpha?: boolean | undefined);
  95194. private _addClipPlaneDefine;
  95195. private _removeClipPlaneDefine;
  95196. isReady(): boolean;
  95197. /**
  95198. * Returns the string "LineMesh"
  95199. */
  95200. getClassName(): string;
  95201. /**
  95202. * @hidden
  95203. */
  95204. get material(): Material;
  95205. /**
  95206. * @hidden
  95207. */
  95208. set material(value: Material);
  95209. /**
  95210. * @hidden
  95211. */
  95212. get checkCollisions(): boolean;
  95213. /** @hidden */
  95214. _bind(subMesh: SubMesh, effect: Effect, fillMode: number): Mesh;
  95215. /** @hidden */
  95216. _draw(subMesh: SubMesh, fillMode: number, instancesCount?: number): Mesh;
  95217. /**
  95218. * Disposes of the line mesh
  95219. * @param doNotRecurse If children should be disposed
  95220. */
  95221. dispose(doNotRecurse?: boolean): void;
  95222. /**
  95223. * Returns a new LineMesh object cloned from the current one.
  95224. */
  95225. clone(name: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean): LinesMesh;
  95226. /**
  95227. * Creates a new InstancedLinesMesh object from the mesh model.
  95228. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  95229. * @param name defines the name of the new instance
  95230. * @returns a new InstancedLinesMesh
  95231. */
  95232. createInstance(name: string): InstancedLinesMesh;
  95233. }
  95234. /**
  95235. * Creates an instance based on a source LinesMesh
  95236. */
  95237. export class InstancedLinesMesh extends InstancedMesh {
  95238. /**
  95239. * The intersection Threshold is the margin applied when intersection a segment of the LinesMesh with a Ray.
  95240. * This margin is expressed in world space coordinates, so its value may vary.
  95241. * Initilized with the intersectionThreshold value of the source LinesMesh
  95242. */
  95243. intersectionThreshold: number;
  95244. constructor(name: string, source: LinesMesh);
  95245. /**
  95246. * Returns the string "InstancedLinesMesh".
  95247. */
  95248. getClassName(): string;
  95249. }
  95250. }
  95251. declare module BABYLON {
  95252. /** @hidden */
  95253. export var linePixelShader: {
  95254. name: string;
  95255. shader: string;
  95256. };
  95257. }
  95258. declare module BABYLON {
  95259. /** @hidden */
  95260. export var lineVertexShader: {
  95261. name: string;
  95262. shader: string;
  95263. };
  95264. }
  95265. declare module BABYLON {
  95266. interface Scene {
  95267. /** @hidden */
  95268. _edgeRenderLineShader: Nullable<ShaderMaterial>;
  95269. }
  95270. interface AbstractMesh {
  95271. /**
  95272. * Gets the edgesRenderer associated with the mesh
  95273. */
  95274. edgesRenderer: Nullable<EdgesRenderer>;
  95275. }
  95276. interface LinesMesh {
  95277. /**
  95278. * Enables the edge rendering mode on the mesh.
  95279. * This mode makes the mesh edges visible
  95280. * @param epsilon defines the maximal distance between two angles to detect a face
  95281. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  95282. * @returns the currentAbstractMesh
  95283. * @see https://www.babylonjs-playground.com/#19O9TU#0
  95284. */
  95285. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): AbstractMesh;
  95286. }
  95287. interface InstancedLinesMesh {
  95288. /**
  95289. * Enables the edge rendering mode on the mesh.
  95290. * This mode makes the mesh edges visible
  95291. * @param epsilon defines the maximal distance between two angles to detect a face
  95292. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  95293. * @returns the current InstancedLinesMesh
  95294. * @see https://www.babylonjs-playground.com/#19O9TU#0
  95295. */
  95296. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): InstancedLinesMesh;
  95297. }
  95298. /**
  95299. * Defines the minimum contract an Edges renderer should follow.
  95300. */
  95301. export interface IEdgesRenderer extends IDisposable {
  95302. /**
  95303. * Gets or sets a boolean indicating if the edgesRenderer is active
  95304. */
  95305. isEnabled: boolean;
  95306. /**
  95307. * Renders the edges of the attached mesh,
  95308. */
  95309. render(): void;
  95310. /**
  95311. * Checks wether or not the edges renderer is ready to render.
  95312. * @return true if ready, otherwise false.
  95313. */
  95314. isReady(): boolean;
  95315. /**
  95316. * List of instances to render in case the source mesh has instances
  95317. */
  95318. customInstances: SmartArray<Matrix>;
  95319. }
  95320. /**
  95321. * Defines the additional options of the edges renderer
  95322. */
  95323. export interface IEdgesRendererOptions {
  95324. /**
  95325. * Gets or sets a boolean indicating that the alternate edge finder algorithm must be used
  95326. * If not defined, the default value is true
  95327. */
  95328. useAlternateEdgeFinder?: boolean;
  95329. /**
  95330. * Gets or sets a boolean indicating that the vertex merger fast processing must be used.
  95331. * If not defined, the default value is true.
  95332. * 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)
  95333. * This option is used only if useAlternateEdgeFinder = true
  95334. */
  95335. useFastVertexMerger?: boolean;
  95336. /**
  95337. * During edges processing, the vertices are merged if they are close enough: epsilonVertexMerge is the limit whithin which vertices are considered to be equal.
  95338. * The default value is 1e-6
  95339. * This option is used only if useAlternateEdgeFinder = true
  95340. */
  95341. epsilonVertexMerge?: number;
  95342. /**
  95343. * 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
  95344. * 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.
  95345. * This option is used only if useAlternateEdgeFinder = true
  95346. */
  95347. applyTessellation?: boolean;
  95348. /**
  95349. * 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
  95350. * The default value is 1e-6
  95351. * This option is used only if useAlternateEdgeFinder = true
  95352. */
  95353. epsilonVertexAligned?: number;
  95354. }
  95355. /**
  95356. * This class is used to generate edges of the mesh that could then easily be rendered in a scene.
  95357. */
  95358. export class EdgesRenderer implements IEdgesRenderer {
  95359. /**
  95360. * Define the size of the edges with an orthographic camera
  95361. */
  95362. edgesWidthScalerForOrthographic: number;
  95363. /**
  95364. * Define the size of the edges with a perspective camera
  95365. */
  95366. edgesWidthScalerForPerspective: number;
  95367. protected _source: AbstractMesh;
  95368. protected _linesPositions: number[];
  95369. protected _linesNormals: number[];
  95370. protected _linesIndices: number[];
  95371. protected _epsilon: number;
  95372. protected _indicesCount: number;
  95373. protected _lineShader: ShaderMaterial;
  95374. protected _ib: DataBuffer;
  95375. protected _buffers: {
  95376. [key: string]: Nullable<VertexBuffer>;
  95377. };
  95378. protected _buffersForInstances: {
  95379. [key: string]: Nullable<VertexBuffer>;
  95380. };
  95381. protected _checkVerticesInsteadOfIndices: boolean;
  95382. protected _options: Nullable<IEdgesRendererOptions>;
  95383. private _meshRebuildObserver;
  95384. private _meshDisposeObserver;
  95385. /** Gets or sets a boolean indicating if the edgesRenderer is active */
  95386. isEnabled: boolean;
  95387. /**
  95388. * List of instances to render in case the source mesh has instances
  95389. */
  95390. customInstances: SmartArray<Matrix>;
  95391. private static GetShader;
  95392. /**
  95393. * Creates an instance of the EdgesRenderer. It is primarily use to display edges of a mesh.
  95394. * Beware when you use this class with complex objects as the adjacencies computation can be really long
  95395. * @param source Mesh used to create edges
  95396. * @param epsilon sum of angles in adjacency to check for edge
  95397. * @param checkVerticesInsteadOfIndices bases the edges detection on vertices vs indices. Note that this parameter is not used if options.useAlternateEdgeFinder = true
  95398. * @param generateEdgesLines - should generate Lines or only prepare resources.
  95399. * @param options The options to apply when generating the edges
  95400. */
  95401. constructor(source: AbstractMesh, epsilon?: number, checkVerticesInsteadOfIndices?: boolean, generateEdgesLines?: boolean, options?: IEdgesRendererOptions);
  95402. protected _prepareRessources(): void;
  95403. /** @hidden */
  95404. _rebuild(): void;
  95405. /**
  95406. * Releases the required resources for the edges renderer
  95407. */
  95408. dispose(): void;
  95409. protected _processEdgeForAdjacencies(pa: number, pb: number, p0: number, p1: number, p2: number): number;
  95410. protected _processEdgeForAdjacenciesWithVertices(pa: Vector3, pb: Vector3, p0: Vector3, p1: Vector3, p2: Vector3): number;
  95411. /**
  95412. * Checks if the pair of p0 and p1 is en edge
  95413. * @param faceIndex
  95414. * @param edge
  95415. * @param faceNormals
  95416. * @param p0
  95417. * @param p1
  95418. * @private
  95419. */
  95420. protected _checkEdge(faceIndex: number, edge: number, faceNormals: Array<Vector3>, p0: Vector3, p1: Vector3): void;
  95421. /**
  95422. * push line into the position, normal and index buffer
  95423. * @protected
  95424. */
  95425. protected createLine(p0: Vector3, p1: Vector3, offset: number): void;
  95426. /**
  95427. * See https://playground.babylonjs.com/#R3JR6V#1 for a visual display of the algorithm
  95428. */
  95429. private _tessellateTriangle;
  95430. private _generateEdgesLinesAlternate;
  95431. /**
  95432. * Generates lines edges from adjacencjes
  95433. * @private
  95434. */
  95435. _generateEdgesLines(): void;
  95436. /**
  95437. * Checks wether or not the edges renderer is ready to render.
  95438. * @return true if ready, otherwise false.
  95439. */
  95440. isReady(): boolean;
  95441. /**
  95442. * Renders the edges of the attached mesh,
  95443. */
  95444. render(): void;
  95445. }
  95446. /**
  95447. * LineEdgesRenderer for LineMeshes to remove unnecessary triangulation
  95448. */
  95449. export class LineEdgesRenderer extends EdgesRenderer {
  95450. /**
  95451. * This constructor turns off auto generating edges line in Edges Renderer to make it here.
  95452. * @param source LineMesh used to generate edges
  95453. * @param epsilon not important (specified angle for edge detection)
  95454. * @param checkVerticesInsteadOfIndices not important for LineMesh
  95455. */
  95456. constructor(source: AbstractMesh, epsilon?: number, checkVerticesInsteadOfIndices?: boolean);
  95457. /**
  95458. * Generate edges for each line in LinesMesh. Every Line should be rendered as edge.
  95459. */
  95460. _generateEdgesLines(): void;
  95461. }
  95462. }
  95463. declare module BABYLON {
  95464. /**
  95465. * This represents the object necessary to create a rendering group.
  95466. * This is exclusively used and created by the rendering manager.
  95467. * To modify the behavior, you use the available helpers in your scene or meshes.
  95468. * @hidden
  95469. */
  95470. export class RenderingGroup {
  95471. index: number;
  95472. private static _zeroVector;
  95473. private _scene;
  95474. private _opaqueSubMeshes;
  95475. private _transparentSubMeshes;
  95476. private _alphaTestSubMeshes;
  95477. private _depthOnlySubMeshes;
  95478. private _particleSystems;
  95479. private _spriteManagers;
  95480. private _opaqueSortCompareFn;
  95481. private _alphaTestSortCompareFn;
  95482. private _transparentSortCompareFn;
  95483. private _renderOpaque;
  95484. private _renderAlphaTest;
  95485. private _renderTransparent;
  95486. /** @hidden */
  95487. _edgesRenderers: SmartArrayNoDuplicate<IEdgesRenderer>;
  95488. onBeforeTransparentRendering: () => void;
  95489. /**
  95490. * Set the opaque sort comparison function.
  95491. * If null the sub meshes will be render in the order they were created
  95492. */
  95493. set opaqueSortCompareFn(value: Nullable<(a: SubMesh, b: SubMesh) => number>);
  95494. /**
  95495. * Set the alpha test sort comparison function.
  95496. * If null the sub meshes will be render in the order they were created
  95497. */
  95498. set alphaTestSortCompareFn(value: Nullable<(a: SubMesh, b: SubMesh) => number>);
  95499. /**
  95500. * Set the transparent sort comparison function.
  95501. * If null the sub meshes will be render in the order they were created
  95502. */
  95503. set transparentSortCompareFn(value: Nullable<(a: SubMesh, b: SubMesh) => number>);
  95504. /**
  95505. * Creates a new rendering group.
  95506. * @param index The rendering group index
  95507. * @param opaqueSortCompareFn The opaque sort comparison function. If null no order is applied
  95508. * @param alphaTestSortCompareFn The alpha test sort comparison function. If null no order is applied
  95509. * @param transparentSortCompareFn The transparent sort comparison function. If null back to front + alpha index sort is applied
  95510. */
  95511. 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>);
  95512. /**
  95513. * Render all the sub meshes contained in the group.
  95514. * @param customRenderFunction Used to override the default render behaviour of the group.
  95515. * @returns true if rendered some submeshes.
  95516. */
  95517. render(customRenderFunction: Nullable<(opaqueSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>) => void>, renderSprites: boolean, renderParticles: boolean, activeMeshes: Nullable<AbstractMesh[]>): void;
  95518. /**
  95519. * Renders the opaque submeshes in the order from the opaqueSortCompareFn.
  95520. * @param subMeshes The submeshes to render
  95521. */
  95522. private renderOpaqueSorted;
  95523. /**
  95524. * Renders the opaque submeshes in the order from the alphatestSortCompareFn.
  95525. * @param subMeshes The submeshes to render
  95526. */
  95527. private renderAlphaTestSorted;
  95528. /**
  95529. * Renders the opaque submeshes in the order from the transparentSortCompareFn.
  95530. * @param subMeshes The submeshes to render
  95531. */
  95532. private renderTransparentSorted;
  95533. /**
  95534. * Renders the submeshes in a specified order.
  95535. * @param subMeshes The submeshes to sort before render
  95536. * @param sortCompareFn The comparison function use to sort
  95537. * @param cameraPosition The camera position use to preprocess the submeshes to help sorting
  95538. * @param transparent Specifies to activate blending if true
  95539. */
  95540. private static renderSorted;
  95541. /**
  95542. * Renders the submeshes in the order they were dispatched (no sort applied).
  95543. * @param subMeshes The submeshes to render
  95544. */
  95545. private static renderUnsorted;
  95546. /**
  95547. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  95548. * are rendered back to front if in the same alpha index.
  95549. *
  95550. * @param a The first submesh
  95551. * @param b The second submesh
  95552. * @returns The result of the comparison
  95553. */
  95554. static defaultTransparentSortCompare(a: SubMesh, b: SubMesh): number;
  95555. /**
  95556. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  95557. * are rendered back to front.
  95558. *
  95559. * @param a The first submesh
  95560. * @param b The second submesh
  95561. * @returns The result of the comparison
  95562. */
  95563. static backToFrontSortCompare(a: SubMesh, b: SubMesh): number;
  95564. /**
  95565. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  95566. * are rendered front to back (prevent overdraw).
  95567. *
  95568. * @param a The first submesh
  95569. * @param b The second submesh
  95570. * @returns The result of the comparison
  95571. */
  95572. static frontToBackSortCompare(a: SubMesh, b: SubMesh): number;
  95573. /**
  95574. * Resets the different lists of submeshes to prepare a new frame.
  95575. */
  95576. prepare(): void;
  95577. dispose(): void;
  95578. /**
  95579. * Inserts the submesh in its correct queue depending on its material.
  95580. * @param subMesh The submesh to dispatch
  95581. * @param [mesh] Optional reference to the submeshes's mesh. Provide if you have an exiting reference to improve performance.
  95582. * @param [material] Optional reference to the submeshes's material. Provide if you have an exiting reference to improve performance.
  95583. */
  95584. dispatch(subMesh: SubMesh, mesh?: AbstractMesh, material?: Nullable<Material>): void;
  95585. dispatchSprites(spriteManager: ISpriteManager): void;
  95586. dispatchParticles(particleSystem: IParticleSystem): void;
  95587. private _renderParticles;
  95588. private _renderSprites;
  95589. }
  95590. }
  95591. declare module BABYLON {
  95592. /**
  95593. * Interface describing the different options available in the rendering manager
  95594. * regarding Auto Clear between groups.
  95595. */
  95596. export interface IRenderingManagerAutoClearSetup {
  95597. /**
  95598. * Defines whether or not autoclear is enable.
  95599. */
  95600. autoClear: boolean;
  95601. /**
  95602. * Defines whether or not to autoclear the depth buffer.
  95603. */
  95604. depth: boolean;
  95605. /**
  95606. * Defines whether or not to autoclear the stencil buffer.
  95607. */
  95608. stencil: boolean;
  95609. }
  95610. /**
  95611. * This class is used by the onRenderingGroupObservable
  95612. */
  95613. export class RenderingGroupInfo {
  95614. /**
  95615. * The Scene that being rendered
  95616. */
  95617. scene: Scene;
  95618. /**
  95619. * The camera currently used for the rendering pass
  95620. */
  95621. camera: Nullable<Camera>;
  95622. /**
  95623. * The ID of the renderingGroup being processed
  95624. */
  95625. renderingGroupId: number;
  95626. }
  95627. /**
  95628. * This is the manager responsible of all the rendering for meshes sprites and particles.
  95629. * It is enable to manage the different groups as well as the different necessary sort functions.
  95630. * This should not be used directly aside of the few static configurations
  95631. */
  95632. export class RenderingManager {
  95633. /**
  95634. * The max id used for rendering groups (not included)
  95635. */
  95636. static MAX_RENDERINGGROUPS: number;
  95637. /**
  95638. * The min id used for rendering groups (included)
  95639. */
  95640. static MIN_RENDERINGGROUPS: number;
  95641. /**
  95642. * Used to globally prevent autoclearing scenes.
  95643. */
  95644. static AUTOCLEAR: boolean;
  95645. /**
  95646. * @hidden
  95647. */
  95648. _useSceneAutoClearSetup: boolean;
  95649. private _scene;
  95650. private _renderingGroups;
  95651. private _depthStencilBufferAlreadyCleaned;
  95652. private _autoClearDepthStencil;
  95653. private _customOpaqueSortCompareFn;
  95654. private _customAlphaTestSortCompareFn;
  95655. private _customTransparentSortCompareFn;
  95656. private _renderingGroupInfo;
  95657. /**
  95658. * Instantiates a new rendering group for a particular scene
  95659. * @param scene Defines the scene the groups belongs to
  95660. */
  95661. constructor(scene: Scene);
  95662. private _clearDepthStencilBuffer;
  95663. /**
  95664. * Renders the entire managed groups. This is used by the scene or the different rennder targets.
  95665. * @hidden
  95666. */
  95667. render(customRenderFunction: Nullable<(opaqueSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>) => void>, activeMeshes: Nullable<AbstractMesh[]>, renderParticles: boolean, renderSprites: boolean): void;
  95668. /**
  95669. * Resets the different information of the group to prepare a new frame
  95670. * @hidden
  95671. */
  95672. reset(): void;
  95673. /**
  95674. * Dispose and release the group and its associated resources.
  95675. * @hidden
  95676. */
  95677. dispose(): void;
  95678. /**
  95679. * Clear the info related to rendering groups preventing retention points during dispose.
  95680. */
  95681. freeRenderingGroups(): void;
  95682. private _prepareRenderingGroup;
  95683. /**
  95684. * Add a sprite manager to the rendering manager in order to render it this frame.
  95685. * @param spriteManager Define the sprite manager to render
  95686. */
  95687. dispatchSprites(spriteManager: ISpriteManager): void;
  95688. /**
  95689. * Add a particle system to the rendering manager in order to render it this frame.
  95690. * @param particleSystem Define the particle system to render
  95691. */
  95692. dispatchParticles(particleSystem: IParticleSystem): void;
  95693. /**
  95694. * Add a submesh to the manager in order to render it this frame
  95695. * @param subMesh The submesh to dispatch
  95696. * @param mesh Optional reference to the submeshes's mesh. Provide if you have an exiting reference to improve performance.
  95697. * @param material Optional reference to the submeshes's material. Provide if you have an exiting reference to improve performance.
  95698. */
  95699. dispatch(subMesh: SubMesh, mesh?: AbstractMesh, material?: Nullable<Material>): void;
  95700. /**
  95701. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  95702. * This allowed control for front to back rendering or reversly depending of the special needs.
  95703. *
  95704. * @param renderingGroupId The rendering group id corresponding to its index
  95705. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  95706. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  95707. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  95708. */
  95709. 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;
  95710. /**
  95711. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  95712. *
  95713. * @param renderingGroupId The rendering group id corresponding to its index
  95714. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  95715. * @param depth Automatically clears depth between groups if true and autoClear is true.
  95716. * @param stencil Automatically clears stencil between groups if true and autoClear is true.
  95717. */
  95718. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean, depth?: boolean, stencil?: boolean): void;
  95719. /**
  95720. * Gets the current auto clear configuration for one rendering group of the rendering
  95721. * manager.
  95722. * @param index the rendering group index to get the information for
  95723. * @returns The auto clear setup for the requested rendering group
  95724. */
  95725. getAutoClearDepthStencilSetup(index: number): IRenderingManagerAutoClearSetup;
  95726. }
  95727. }
  95728. declare module BABYLON {
  95729. /**
  95730. * Defines the options associated with the creation of a custom shader for a shadow generator.
  95731. */
  95732. export interface ICustomShaderOptions {
  95733. /**
  95734. * Gets or sets the custom shader name to use
  95735. */
  95736. shaderName: string;
  95737. /**
  95738. * The list of attribute names used in the shader
  95739. */
  95740. attributes?: string[];
  95741. /**
  95742. * The list of unifrom names used in the shader
  95743. */
  95744. uniforms?: string[];
  95745. /**
  95746. * The list of sampler names used in the shader
  95747. */
  95748. samplers?: string[];
  95749. /**
  95750. * The list of defines used in the shader
  95751. */
  95752. defines?: string[];
  95753. }
  95754. /**
  95755. * Interface to implement to create a shadow generator compatible with BJS.
  95756. */
  95757. export interface IShadowGenerator {
  95758. /**
  95759. * Gets the main RTT containing the shadow map (usually storing depth from the light point of view).
  95760. * @returns The render target texture if present otherwise, null
  95761. */
  95762. getShadowMap(): Nullable<RenderTargetTexture>;
  95763. /**
  95764. * Determine wheter the shadow generator is ready or not (mainly all effects and related post processes needs to be ready).
  95765. * @param subMesh The submesh we want to render in the shadow map
  95766. * @param useInstances Defines wether will draw in the map using instances
  95767. * @param isTransparent Indicates that isReady is called for a transparent subMesh
  95768. * @returns true if ready otherwise, false
  95769. */
  95770. isReady(subMesh: SubMesh, useInstances: boolean, isTransparent: boolean): boolean;
  95771. /**
  95772. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  95773. * @param defines Defines of the material we want to update
  95774. * @param lightIndex Index of the light in the enabled light list of the material
  95775. */
  95776. prepareDefines(defines: MaterialDefines, lightIndex: number): void;
  95777. /**
  95778. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  95779. * defined in the generator but impacting the effect).
  95780. * It implies the unifroms available on the materials are the standard BJS ones.
  95781. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  95782. * @param effect The effect we are binfing the information for
  95783. */
  95784. bindShadowLight(lightIndex: string, effect: Effect): void;
  95785. /**
  95786. * Gets the transformation matrix used to project the meshes into the map from the light point of view.
  95787. * (eq to shadow prjection matrix * light transform matrix)
  95788. * @returns The transform matrix used to create the shadow map
  95789. */
  95790. getTransformMatrix(): Matrix;
  95791. /**
  95792. * Recreates the shadow map dependencies like RTT and post processes. This can be used during the switch between
  95793. * Cube and 2D textures for instance.
  95794. */
  95795. recreateShadowMap(): void;
  95796. /**
  95797. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  95798. * @param onCompiled Callback triggered at the and of the effects compilation
  95799. * @param options Sets of optional options forcing the compilation with different modes
  95800. */
  95801. forceCompilation(onCompiled?: (generator: IShadowGenerator) => void, options?: Partial<{
  95802. useInstances: boolean;
  95803. }>): void;
  95804. /**
  95805. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  95806. * @param options Sets of optional options forcing the compilation with different modes
  95807. * @returns A promise that resolves when the compilation completes
  95808. */
  95809. forceCompilationAsync(options?: Partial<{
  95810. useInstances: boolean;
  95811. }>): Promise<void>;
  95812. /**
  95813. * Serializes the shadow generator setup to a json object.
  95814. * @returns The serialized JSON object
  95815. */
  95816. serialize(): any;
  95817. /**
  95818. * Disposes the Shadow map and related Textures and effects.
  95819. */
  95820. dispose(): void;
  95821. }
  95822. /**
  95823. * Default implementation IShadowGenerator.
  95824. * This is the main object responsible of generating shadows in the framework.
  95825. * Documentation: https://doc.babylonjs.com/babylon101/shadows
  95826. */
  95827. export class ShadowGenerator implements IShadowGenerator {
  95828. /**
  95829. * Name of the shadow generator class
  95830. */
  95831. static CLASSNAME: string;
  95832. /**
  95833. * Shadow generator mode None: no filtering applied.
  95834. */
  95835. static readonly FILTER_NONE: number;
  95836. /**
  95837. * Shadow generator mode ESM: Exponential Shadow Mapping.
  95838. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  95839. */
  95840. static readonly FILTER_EXPONENTIALSHADOWMAP: number;
  95841. /**
  95842. * Shadow generator mode Poisson Sampling: Percentage Closer Filtering.
  95843. * (Multiple Tap around evenly distributed around the pixel are used to evaluate the shadow strength)
  95844. */
  95845. static readonly FILTER_POISSONSAMPLING: number;
  95846. /**
  95847. * Shadow generator mode ESM: Blurred Exponential Shadow Mapping.
  95848. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  95849. */
  95850. static readonly FILTER_BLUREXPONENTIALSHADOWMAP: number;
  95851. /**
  95852. * Shadow generator mode ESM: Exponential Shadow Mapping using the inverse of the exponential preventing
  95853. * edge artifacts on steep falloff.
  95854. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  95855. */
  95856. static readonly FILTER_CLOSEEXPONENTIALSHADOWMAP: number;
  95857. /**
  95858. * Shadow generator mode ESM: Blurred Exponential Shadow Mapping using the inverse of the exponential preventing
  95859. * edge artifacts on steep falloff.
  95860. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  95861. */
  95862. static readonly FILTER_BLURCLOSEEXPONENTIALSHADOWMAP: number;
  95863. /**
  95864. * Shadow generator mode PCF: Percentage Closer Filtering
  95865. * benefits from Webgl 2 shadow samplers. Fallback to Poisson Sampling in Webgl 1
  95866. * (https://developer.nvidia.com/gpugems/GPUGems/gpugems_ch11.html)
  95867. */
  95868. static readonly FILTER_PCF: number;
  95869. /**
  95870. * Shadow generator mode PCSS: Percentage Closering Soft Shadow.
  95871. * benefits from Webgl 2 shadow samplers. Fallback to Poisson Sampling in Webgl 1
  95872. * Contact Hardening
  95873. */
  95874. static readonly FILTER_PCSS: number;
  95875. /**
  95876. * Reserved for PCF and PCSS
  95877. * Highest Quality.
  95878. *
  95879. * Execute PCF on a 5*5 kernel improving a lot the shadow aliasing artifacts.
  95880. *
  95881. * Execute PCSS with 32 taps blocker search and 64 taps PCF.
  95882. */
  95883. static readonly QUALITY_HIGH: number;
  95884. /**
  95885. * Reserved for PCF and PCSS
  95886. * Good tradeoff for quality/perf cross devices
  95887. *
  95888. * Execute PCF on a 3*3 kernel.
  95889. *
  95890. * Execute PCSS with 16 taps blocker search and 32 taps PCF.
  95891. */
  95892. static readonly QUALITY_MEDIUM: number;
  95893. /**
  95894. * Reserved for PCF and PCSS
  95895. * The lowest quality but the fastest.
  95896. *
  95897. * Execute PCF on a 1*1 kernel.
  95898. *
  95899. * Execute PCSS with 16 taps blocker search and 16 taps PCF.
  95900. */
  95901. static readonly QUALITY_LOW: number;
  95902. /** Gets or sets the custom shader name to use */
  95903. customShaderOptions: ICustomShaderOptions;
  95904. /**
  95905. * Observable triggered before the shadow is rendered. Can be used to update internal effect state
  95906. */
  95907. onBeforeShadowMapRenderObservable: Observable<Effect>;
  95908. /**
  95909. * Observable triggered after the shadow is rendered. Can be used to restore internal effect state
  95910. */
  95911. onAfterShadowMapRenderObservable: Observable<Effect>;
  95912. /**
  95913. * Observable triggered before a mesh is rendered in the shadow map.
  95914. * Can be used to update internal effect state (that you can get from the onBeforeShadowMapRenderObservable)
  95915. */
  95916. onBeforeShadowMapRenderMeshObservable: Observable<Mesh>;
  95917. /**
  95918. * Observable triggered after a mesh is rendered in the shadow map.
  95919. * Can be used to update internal effect state (that you can get from the onAfterShadowMapRenderObservable)
  95920. */
  95921. onAfterShadowMapRenderMeshObservable: Observable<Mesh>;
  95922. protected _bias: number;
  95923. /**
  95924. * Gets the bias: offset applied on the depth preventing acnea (in light direction).
  95925. */
  95926. get bias(): number;
  95927. /**
  95928. * Sets the bias: offset applied on the depth preventing acnea (in light direction).
  95929. */
  95930. set bias(bias: number);
  95931. protected _normalBias: number;
  95932. /**
  95933. * Gets the normalBias: offset applied on the depth preventing acnea (along side the normal direction and proportinal to the light/normal angle).
  95934. */
  95935. get normalBias(): number;
  95936. /**
  95937. * Sets the normalBias: offset applied on the depth preventing acnea (along side the normal direction and proportinal to the light/normal angle).
  95938. */
  95939. set normalBias(normalBias: number);
  95940. protected _blurBoxOffset: number;
  95941. /**
  95942. * Gets the blur box offset: offset applied during the blur pass.
  95943. * Only useful if useKernelBlur = false
  95944. */
  95945. get blurBoxOffset(): number;
  95946. /**
  95947. * Sets the blur box offset: offset applied during the blur pass.
  95948. * Only useful if useKernelBlur = false
  95949. */
  95950. set blurBoxOffset(value: number);
  95951. protected _blurScale: number;
  95952. /**
  95953. * Gets the blur scale: scale of the blurred texture compared to the main shadow map.
  95954. * 2 means half of the size.
  95955. */
  95956. get blurScale(): number;
  95957. /**
  95958. * Sets the blur scale: scale of the blurred texture compared to the main shadow map.
  95959. * 2 means half of the size.
  95960. */
  95961. set blurScale(value: number);
  95962. protected _blurKernel: number;
  95963. /**
  95964. * Gets the blur kernel: kernel size of the blur pass.
  95965. * Only useful if useKernelBlur = true
  95966. */
  95967. get blurKernel(): number;
  95968. /**
  95969. * Sets the blur kernel: kernel size of the blur pass.
  95970. * Only useful if useKernelBlur = true
  95971. */
  95972. set blurKernel(value: number);
  95973. protected _useKernelBlur: boolean;
  95974. /**
  95975. * Gets whether the blur pass is a kernel blur (if true) or box blur.
  95976. * Only useful in filtered mode (useBlurExponentialShadowMap...)
  95977. */
  95978. get useKernelBlur(): boolean;
  95979. /**
  95980. * Sets whether the blur pass is a kernel blur (if true) or box blur.
  95981. * Only useful in filtered mode (useBlurExponentialShadowMap...)
  95982. */
  95983. set useKernelBlur(value: boolean);
  95984. protected _depthScale: number;
  95985. /**
  95986. * Gets the depth scale used in ESM mode.
  95987. */
  95988. get depthScale(): number;
  95989. /**
  95990. * Sets the depth scale used in ESM mode.
  95991. * This can override the scale stored on the light.
  95992. */
  95993. set depthScale(value: number);
  95994. protected _validateFilter(filter: number): number;
  95995. protected _filter: number;
  95996. /**
  95997. * Gets the current mode of the shadow generator (normal, PCF, ESM...).
  95998. * The returned value is a number equal to one of the available mode defined in ShadowMap.FILTER_x like _FILTER_NONE
  95999. */
  96000. get filter(): number;
  96001. /**
  96002. * Sets the current mode of the shadow generator (normal, PCF, ESM...).
  96003. * The returned value is a number equal to one of the available mode defined in ShadowMap.FILTER_x like _FILTER_NONE
  96004. */
  96005. set filter(value: number);
  96006. /**
  96007. * Gets if the current filter is set to Poisson Sampling.
  96008. */
  96009. get usePoissonSampling(): boolean;
  96010. /**
  96011. * Sets the current filter to Poisson Sampling.
  96012. */
  96013. set usePoissonSampling(value: boolean);
  96014. /**
  96015. * Gets if the current filter is set to ESM.
  96016. */
  96017. get useExponentialShadowMap(): boolean;
  96018. /**
  96019. * Sets the current filter is to ESM.
  96020. */
  96021. set useExponentialShadowMap(value: boolean);
  96022. /**
  96023. * Gets if the current filter is set to filtered ESM.
  96024. */
  96025. get useBlurExponentialShadowMap(): boolean;
  96026. /**
  96027. * Gets if the current filter is set to filtered ESM.
  96028. */
  96029. set useBlurExponentialShadowMap(value: boolean);
  96030. /**
  96031. * Gets if the current filter is set to "close ESM" (using the inverse of the
  96032. * exponential to prevent steep falloff artifacts).
  96033. */
  96034. get useCloseExponentialShadowMap(): boolean;
  96035. /**
  96036. * Sets the current filter to "close ESM" (using the inverse of the
  96037. * exponential to prevent steep falloff artifacts).
  96038. */
  96039. set useCloseExponentialShadowMap(value: boolean);
  96040. /**
  96041. * Gets if the current filter is set to filtered "close ESM" (using the inverse of the
  96042. * exponential to prevent steep falloff artifacts).
  96043. */
  96044. get useBlurCloseExponentialShadowMap(): boolean;
  96045. /**
  96046. * Sets the current filter to filtered "close ESM" (using the inverse of the
  96047. * exponential to prevent steep falloff artifacts).
  96048. */
  96049. set useBlurCloseExponentialShadowMap(value: boolean);
  96050. /**
  96051. * Gets if the current filter is set to "PCF" (percentage closer filtering).
  96052. */
  96053. get usePercentageCloserFiltering(): boolean;
  96054. /**
  96055. * Sets the current filter to "PCF" (percentage closer filtering).
  96056. */
  96057. set usePercentageCloserFiltering(value: boolean);
  96058. protected _filteringQuality: number;
  96059. /**
  96060. * Gets the PCF or PCSS Quality.
  96061. * Only valid if usePercentageCloserFiltering or usePercentageCloserFiltering is true.
  96062. */
  96063. get filteringQuality(): number;
  96064. /**
  96065. * Sets the PCF or PCSS Quality.
  96066. * Only valid if usePercentageCloserFiltering or usePercentageCloserFiltering is true.
  96067. */
  96068. set filteringQuality(filteringQuality: number);
  96069. /**
  96070. * Gets if the current filter is set to "PCSS" (contact hardening).
  96071. */
  96072. get useContactHardeningShadow(): boolean;
  96073. /**
  96074. * Sets the current filter to "PCSS" (contact hardening).
  96075. */
  96076. set useContactHardeningShadow(value: boolean);
  96077. protected _contactHardeningLightSizeUVRatio: number;
  96078. /**
  96079. * Gets the Light Size (in shadow map uv unit) used in PCSS to determine the blocker search area and the penumbra size.
  96080. * Using a ratio helps keeping shape stability independently of the map size.
  96081. *
  96082. * It does not account for the light projection as it was having too much
  96083. * instability during the light setup or during light position changes.
  96084. *
  96085. * Only valid if useContactHardeningShadow is true.
  96086. */
  96087. get contactHardeningLightSizeUVRatio(): number;
  96088. /**
  96089. * Sets the Light Size (in shadow map uv unit) used in PCSS to determine the blocker search area and the penumbra size.
  96090. * Using a ratio helps keeping shape stability independently of the map size.
  96091. *
  96092. * It does not account for the light projection as it was having too much
  96093. * instability during the light setup or during light position changes.
  96094. *
  96095. * Only valid if useContactHardeningShadow is true.
  96096. */
  96097. set contactHardeningLightSizeUVRatio(contactHardeningLightSizeUVRatio: number);
  96098. protected _darkness: number;
  96099. /** Gets or sets the actual darkness of a shadow */
  96100. get darkness(): number;
  96101. set darkness(value: number);
  96102. /**
  96103. * Returns the darkness value (float). This can only decrease the actual darkness of a shadow.
  96104. * 0 means strongest and 1 would means no shadow.
  96105. * @returns the darkness.
  96106. */
  96107. getDarkness(): number;
  96108. /**
  96109. * Sets the darkness value (float). This can only decrease the actual darkness of a shadow.
  96110. * @param darkness The darkness value 0 means strongest and 1 would means no shadow.
  96111. * @returns the shadow generator allowing fluent coding.
  96112. */
  96113. setDarkness(darkness: number): ShadowGenerator;
  96114. protected _transparencyShadow: boolean;
  96115. /** Gets or sets the ability to have transparent shadow */
  96116. get transparencyShadow(): boolean;
  96117. set transparencyShadow(value: boolean);
  96118. /**
  96119. * Sets the ability to have transparent shadow (boolean).
  96120. * @param transparent True if transparent else False
  96121. * @returns the shadow generator allowing fluent coding
  96122. */
  96123. setTransparencyShadow(transparent: boolean): ShadowGenerator;
  96124. /**
  96125. * Enables or disables shadows with varying strength based on the transparency
  96126. * When it is enabled, the strength of the shadow is taken equal to mesh.visibility
  96127. * If you enabled an alpha texture on your material, the alpha value red from the texture is also combined to compute the strength:
  96128. * mesh.visibility * alphaTexture.a
  96129. * Note that by definition transparencyShadow must be set to true for enableSoftTransparentShadow to work!
  96130. */
  96131. enableSoftTransparentShadow: boolean;
  96132. protected _shadowMap: Nullable<RenderTargetTexture>;
  96133. protected _shadowMap2: Nullable<RenderTargetTexture>;
  96134. /**
  96135. * Gets the main RTT containing the shadow map (usually storing depth from the light point of view).
  96136. * @returns The render target texture if present otherwise, null
  96137. */
  96138. getShadowMap(): Nullable<RenderTargetTexture>;
  96139. /**
  96140. * Gets the RTT used during rendering (can be a blurred version of the shadow map or the shadow map itself).
  96141. * @returns The render target texture if the shadow map is present otherwise, null
  96142. */
  96143. getShadowMapForRendering(): Nullable<RenderTargetTexture>;
  96144. /**
  96145. * Gets the class name of that object
  96146. * @returns "ShadowGenerator"
  96147. */
  96148. getClassName(): string;
  96149. /**
  96150. * Helper function to add a mesh and its descendants to the list of shadow casters.
  96151. * @param mesh Mesh to add
  96152. * @param includeDescendants boolean indicating if the descendants should be added. Default to true
  96153. * @returns the Shadow Generator itself
  96154. */
  96155. addShadowCaster(mesh: AbstractMesh, includeDescendants?: boolean): ShadowGenerator;
  96156. /**
  96157. * Helper function to remove a mesh and its descendants from the list of shadow casters
  96158. * @param mesh Mesh to remove
  96159. * @param includeDescendants boolean indicating if the descendants should be removed. Default to true
  96160. * @returns the Shadow Generator itself
  96161. */
  96162. removeShadowCaster(mesh: AbstractMesh, includeDescendants?: boolean): ShadowGenerator;
  96163. /**
  96164. * Controls the extent to which the shadows fade out at the edge of the frustum
  96165. */
  96166. frustumEdgeFalloff: number;
  96167. protected _light: IShadowLight;
  96168. /**
  96169. * Returns the associated light object.
  96170. * @returns the light generating the shadow
  96171. */
  96172. getLight(): IShadowLight;
  96173. /**
  96174. * If true the shadow map is generated by rendering the back face of the mesh instead of the front face.
  96175. * This can help with self-shadowing as the geometry making up the back of objects is slightly offset.
  96176. * It might on the other hand introduce peter panning.
  96177. */
  96178. forceBackFacesOnly: boolean;
  96179. protected _scene: Scene;
  96180. protected _lightDirection: Vector3;
  96181. protected _effect: Effect;
  96182. protected _viewMatrix: Matrix;
  96183. protected _projectionMatrix: Matrix;
  96184. protected _transformMatrix: Matrix;
  96185. protected _cachedPosition: Vector3;
  96186. protected _cachedDirection: Vector3;
  96187. protected _cachedDefines: string;
  96188. protected _currentRenderID: number;
  96189. protected _boxBlurPostprocess: Nullable<PostProcess>;
  96190. protected _kernelBlurXPostprocess: Nullable<PostProcess>;
  96191. protected _kernelBlurYPostprocess: Nullable<PostProcess>;
  96192. protected _blurPostProcesses: PostProcess[];
  96193. protected _mapSize: number;
  96194. protected _currentFaceIndex: number;
  96195. protected _currentFaceIndexCache: number;
  96196. protected _textureType: number;
  96197. protected _defaultTextureMatrix: Matrix;
  96198. protected _storedUniqueId: Nullable<number>;
  96199. /** @hidden */
  96200. static _SceneComponentInitialization: (scene: Scene) => void;
  96201. /**
  96202. * Creates a ShadowGenerator object.
  96203. * A ShadowGenerator is the required tool to use the shadows.
  96204. * Each light casting shadows needs to use its own ShadowGenerator.
  96205. * Documentation : https://doc.babylonjs.com/babylon101/shadows
  96206. * @param mapSize The size of the texture what stores the shadows. Example : 1024.
  96207. * @param light The light object generating the shadows.
  96208. * @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.
  96209. */
  96210. constructor(mapSize: number, light: IShadowLight, usefulFloatFirst?: boolean);
  96211. protected _initializeGenerator(): void;
  96212. protected _createTargetRenderTexture(): void;
  96213. protected _initializeShadowMap(): void;
  96214. protected _initializeBlurRTTAndPostProcesses(): void;
  96215. protected _renderForShadowMap(opaqueSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>): void;
  96216. protected _bindCustomEffectForRenderSubMeshForShadowMap(subMesh: SubMesh, effect: Effect, matriceNames: any, mesh: AbstractMesh): void;
  96217. protected _renderSubMeshForShadowMap(subMesh: SubMesh, isTransparent?: boolean): void;
  96218. protected _applyFilterValues(): void;
  96219. /**
  96220. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  96221. * @param onCompiled Callback triggered at the and of the effects compilation
  96222. * @param options Sets of optional options forcing the compilation with different modes
  96223. */
  96224. forceCompilation(onCompiled?: (generator: IShadowGenerator) => void, options?: Partial<{
  96225. useInstances: boolean;
  96226. }>): void;
  96227. /**
  96228. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  96229. * @param options Sets of optional options forcing the compilation with different modes
  96230. * @returns A promise that resolves when the compilation completes
  96231. */
  96232. forceCompilationAsync(options?: Partial<{
  96233. useInstances: boolean;
  96234. }>): Promise<void>;
  96235. protected _isReadyCustomDefines(defines: any, subMesh: SubMesh, useInstances: boolean): void;
  96236. private _prepareShadowDefines;
  96237. /**
  96238. * Determine wheter the shadow generator is ready or not (mainly all effects and related post processes needs to be ready).
  96239. * @param subMesh The submesh we want to render in the shadow map
  96240. * @param useInstances Defines wether will draw in the map using instances
  96241. * @param isTransparent Indicates that isReady is called for a transparent subMesh
  96242. * @returns true if ready otherwise, false
  96243. */
  96244. isReady(subMesh: SubMesh, useInstances: boolean, isTransparent: boolean): boolean;
  96245. /**
  96246. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  96247. * @param defines Defines of the material we want to update
  96248. * @param lightIndex Index of the light in the enabled light list of the material
  96249. */
  96250. prepareDefines(defines: any, lightIndex: number): void;
  96251. /**
  96252. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  96253. * defined in the generator but impacting the effect).
  96254. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  96255. * @param effect The effect we are binfing the information for
  96256. */
  96257. bindShadowLight(lightIndex: string, effect: Effect): void;
  96258. /**
  96259. * Gets the transformation matrix used to project the meshes into the map from the light point of view.
  96260. * (eq to shadow prjection matrix * light transform matrix)
  96261. * @returns The transform matrix used to create the shadow map
  96262. */
  96263. getTransformMatrix(): Matrix;
  96264. /**
  96265. * Recreates the shadow map dependencies like RTT and post processes. This can be used during the switch between
  96266. * Cube and 2D textures for instance.
  96267. */
  96268. recreateShadowMap(): void;
  96269. protected _disposeBlurPostProcesses(): void;
  96270. protected _disposeRTTandPostProcesses(): void;
  96271. /**
  96272. * Disposes the ShadowGenerator.
  96273. * Returns nothing.
  96274. */
  96275. dispose(): void;
  96276. /**
  96277. * Serializes the shadow generator setup to a json object.
  96278. * @returns The serialized JSON object
  96279. */
  96280. serialize(): any;
  96281. /**
  96282. * Parses a serialized ShadowGenerator and returns a new ShadowGenerator.
  96283. * @param parsedShadowGenerator The JSON object to parse
  96284. * @param scene The scene to create the shadow map for
  96285. * @param constr A function that builds a shadow generator or undefined to create an instance of the default shadow generator
  96286. * @returns The parsed shadow generator
  96287. */
  96288. static Parse(parsedShadowGenerator: any, scene: Scene, constr?: (mapSize: number, light: IShadowLight) => ShadowGenerator): ShadowGenerator;
  96289. }
  96290. }
  96291. declare module BABYLON {
  96292. /**
  96293. * Base class of all the lights in Babylon. It groups all the generic information about lights.
  96294. * Lights are used, as you would expect, to affect how meshes are seen, in terms of both illumination and colour.
  96295. * 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.
  96296. */
  96297. export abstract class Light extends Node {
  96298. /**
  96299. * Falloff Default: light is falling off following the material specification:
  96300. * standard material is using standard falloff whereas pbr material can request special falloff per materials.
  96301. */
  96302. static readonly FALLOFF_DEFAULT: number;
  96303. /**
  96304. * Falloff Physical: light is falling off following the inverse squared distance law.
  96305. */
  96306. static readonly FALLOFF_PHYSICAL: number;
  96307. /**
  96308. * Falloff gltf: light is falling off as described in the gltf moving to PBR document
  96309. * to enhance interoperability with other engines.
  96310. */
  96311. static readonly FALLOFF_GLTF: number;
  96312. /**
  96313. * Falloff Standard: light is falling off like in the standard material
  96314. * to enhance interoperability with other materials.
  96315. */
  96316. static readonly FALLOFF_STANDARD: number;
  96317. /**
  96318. * If every light affecting the material is in this lightmapMode,
  96319. * material.lightmapTexture adds or multiplies
  96320. * (depends on material.useLightmapAsShadowmap)
  96321. * after every other light calculations.
  96322. */
  96323. static readonly LIGHTMAP_DEFAULT: number;
  96324. /**
  96325. * material.lightmapTexture as only diffuse lighting from this light
  96326. * adds only specular lighting from this light
  96327. * adds dynamic shadows
  96328. */
  96329. static readonly LIGHTMAP_SPECULAR: number;
  96330. /**
  96331. * material.lightmapTexture as only lighting
  96332. * no light calculation from this light
  96333. * only adds dynamic shadows from this light
  96334. */
  96335. static readonly LIGHTMAP_SHADOWSONLY: number;
  96336. /**
  96337. * Each light type uses the default quantity according to its type:
  96338. * point/spot lights use luminous intensity
  96339. * directional lights use illuminance
  96340. */
  96341. static readonly INTENSITYMODE_AUTOMATIC: number;
  96342. /**
  96343. * lumen (lm)
  96344. */
  96345. static readonly INTENSITYMODE_LUMINOUSPOWER: number;
  96346. /**
  96347. * candela (lm/sr)
  96348. */
  96349. static readonly INTENSITYMODE_LUMINOUSINTENSITY: number;
  96350. /**
  96351. * lux (lm/m^2)
  96352. */
  96353. static readonly INTENSITYMODE_ILLUMINANCE: number;
  96354. /**
  96355. * nit (cd/m^2)
  96356. */
  96357. static readonly INTENSITYMODE_LUMINANCE: number;
  96358. /**
  96359. * Light type const id of the point light.
  96360. */
  96361. static readonly LIGHTTYPEID_POINTLIGHT: number;
  96362. /**
  96363. * Light type const id of the directional light.
  96364. */
  96365. static readonly LIGHTTYPEID_DIRECTIONALLIGHT: number;
  96366. /**
  96367. * Light type const id of the spot light.
  96368. */
  96369. static readonly LIGHTTYPEID_SPOTLIGHT: number;
  96370. /**
  96371. * Light type const id of the hemispheric light.
  96372. */
  96373. static readonly LIGHTTYPEID_HEMISPHERICLIGHT: number;
  96374. /**
  96375. * Diffuse gives the basic color to an object.
  96376. */
  96377. diffuse: Color3;
  96378. /**
  96379. * Specular produces a highlight color on an object.
  96380. * Note: This is note affecting PBR materials.
  96381. */
  96382. specular: Color3;
  96383. /**
  96384. * Defines the falloff type for this light. This lets overrriding how punctual light are
  96385. * falling off base on range or angle.
  96386. * This can be set to any values in Light.FALLOFF_x.
  96387. *
  96388. * Note: This is only useful for PBR Materials at the moment. This could be extended if required to
  96389. * other types of materials.
  96390. */
  96391. falloffType: number;
  96392. /**
  96393. * Strength of the light.
  96394. * Note: By default it is define in the framework own unit.
  96395. * Note: In PBR materials the intensityMode can be use to chose what unit the intensity is defined in.
  96396. */
  96397. intensity: number;
  96398. private _range;
  96399. protected _inverseSquaredRange: number;
  96400. /**
  96401. * Defines how far from the source the light is impacting in scene units.
  96402. * Note: Unused in PBR material as the distance light falloff is defined following the inverse squared falloff.
  96403. */
  96404. get range(): number;
  96405. /**
  96406. * Defines how far from the source the light is impacting in scene units.
  96407. * Note: Unused in PBR material as the distance light falloff is defined following the inverse squared falloff.
  96408. */
  96409. set range(value: number);
  96410. /**
  96411. * Cached photometric scale default to 1.0 as the automatic intensity mode defaults to 1.0 for every type
  96412. * of light.
  96413. */
  96414. private _photometricScale;
  96415. private _intensityMode;
  96416. /**
  96417. * Gets the photometric scale used to interpret the intensity.
  96418. * This is only relevant with PBR Materials where the light intensity can be defined in a physical way.
  96419. */
  96420. get intensityMode(): number;
  96421. /**
  96422. * Sets the photometric scale used to interpret the intensity.
  96423. * This is only relevant with PBR Materials where the light intensity can be defined in a physical way.
  96424. */
  96425. set intensityMode(value: number);
  96426. private _radius;
  96427. /**
  96428. * Gets the light radius used by PBR Materials to simulate soft area lights.
  96429. */
  96430. get radius(): number;
  96431. /**
  96432. * sets the light radius used by PBR Materials to simulate soft area lights.
  96433. */
  96434. set radius(value: number);
  96435. private _renderPriority;
  96436. /**
  96437. * Defines the rendering priority of the lights. It can help in case of fallback or number of lights
  96438. * exceeding the number allowed of the materials.
  96439. */
  96440. renderPriority: number;
  96441. private _shadowEnabled;
  96442. /**
  96443. * Gets wether or not the shadows are enabled for this light. This can help turning off/on shadow without detaching
  96444. * the current shadow generator.
  96445. */
  96446. get shadowEnabled(): boolean;
  96447. /**
  96448. * Sets wether or not the shadows are enabled for this light. This can help turning off/on shadow without detaching
  96449. * the current shadow generator.
  96450. */
  96451. set shadowEnabled(value: boolean);
  96452. private _includedOnlyMeshes;
  96453. /**
  96454. * Gets the only meshes impacted by this light.
  96455. */
  96456. get includedOnlyMeshes(): AbstractMesh[];
  96457. /**
  96458. * Sets the only meshes impacted by this light.
  96459. */
  96460. set includedOnlyMeshes(value: AbstractMesh[]);
  96461. private _excludedMeshes;
  96462. /**
  96463. * Gets the meshes not impacted by this light.
  96464. */
  96465. get excludedMeshes(): AbstractMesh[];
  96466. /**
  96467. * Sets the meshes not impacted by this light.
  96468. */
  96469. set excludedMeshes(value: AbstractMesh[]);
  96470. private _excludeWithLayerMask;
  96471. /**
  96472. * Gets the layer id use to find what meshes are not impacted by the light.
  96473. * Inactive if 0
  96474. */
  96475. get excludeWithLayerMask(): number;
  96476. /**
  96477. * Sets the layer id use to find what meshes are not impacted by the light.
  96478. * Inactive if 0
  96479. */
  96480. set excludeWithLayerMask(value: number);
  96481. private _includeOnlyWithLayerMask;
  96482. /**
  96483. * Gets the layer id use to find what meshes are impacted by the light.
  96484. * Inactive if 0
  96485. */
  96486. get includeOnlyWithLayerMask(): number;
  96487. /**
  96488. * Sets the layer id use to find what meshes are impacted by the light.
  96489. * Inactive if 0
  96490. */
  96491. set includeOnlyWithLayerMask(value: number);
  96492. private _lightmapMode;
  96493. /**
  96494. * Gets the lightmap mode of this light (should be one of the constants defined by Light.LIGHTMAP_x)
  96495. */
  96496. get lightmapMode(): number;
  96497. /**
  96498. * Sets the lightmap mode of this light (should be one of the constants defined by Light.LIGHTMAP_x)
  96499. */
  96500. set lightmapMode(value: number);
  96501. /**
  96502. * Shadow generator associted to the light.
  96503. * @hidden Internal use only.
  96504. */
  96505. _shadowGenerator: Nullable<IShadowGenerator>;
  96506. /**
  96507. * @hidden Internal use only.
  96508. */
  96509. _excludedMeshesIds: string[];
  96510. /**
  96511. * @hidden Internal use only.
  96512. */
  96513. _includedOnlyMeshesIds: string[];
  96514. /**
  96515. * The current light unifom buffer.
  96516. * @hidden Internal use only.
  96517. */
  96518. _uniformBuffer: UniformBuffer;
  96519. /** @hidden */
  96520. _renderId: number;
  96521. /**
  96522. * Creates a Light object in the scene.
  96523. * Documentation : https://doc.babylonjs.com/babylon101/lights
  96524. * @param name The firendly name of the light
  96525. * @param scene The scene the light belongs too
  96526. */
  96527. constructor(name: string, scene: Scene);
  96528. protected abstract _buildUniformLayout(): void;
  96529. /**
  96530. * Sets the passed Effect "effect" with the Light information.
  96531. * @param effect The effect to update
  96532. * @param lightIndex The index of the light in the effect to update
  96533. * @returns The light
  96534. */
  96535. abstract transferToEffect(effect: Effect, lightIndex: string): Light;
  96536. /**
  96537. * Sets the passed Effect "effect" with the Light textures.
  96538. * @param effect The effect to update
  96539. * @param lightIndex The index of the light in the effect to update
  96540. * @returns The light
  96541. */
  96542. transferTexturesToEffect(effect: Effect, lightIndex: string): Light;
  96543. /**
  96544. * Binds the lights information from the scene to the effect for the given mesh.
  96545. * @param lightIndex Light index
  96546. * @param scene The scene where the light belongs to
  96547. * @param effect The effect we are binding the data to
  96548. * @param useSpecular Defines if specular is supported
  96549. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  96550. */
  96551. _bindLight(lightIndex: number, scene: Scene, effect: Effect, useSpecular: boolean, rebuildInParallel?: boolean): void;
  96552. /**
  96553. * Sets the passed Effect "effect" with the Light information.
  96554. * @param effect The effect to update
  96555. * @param lightDataUniformName The uniform used to store light data (position or direction)
  96556. * @returns The light
  96557. */
  96558. abstract transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): Light;
  96559. /**
  96560. * Returns the string "Light".
  96561. * @returns the class name
  96562. */
  96563. getClassName(): string;
  96564. /** @hidden */
  96565. readonly _isLight: boolean;
  96566. /**
  96567. * Converts the light information to a readable string for debug purpose.
  96568. * @param fullDetails Supports for multiple levels of logging within scene loading
  96569. * @returns the human readable light info
  96570. */
  96571. toString(fullDetails?: boolean): string;
  96572. /** @hidden */
  96573. protected _syncParentEnabledState(): void;
  96574. /**
  96575. * Set the enabled state of this node.
  96576. * @param value - the new enabled state
  96577. */
  96578. setEnabled(value: boolean): void;
  96579. /**
  96580. * Returns the Light associated shadow generator if any.
  96581. * @return the associated shadow generator.
  96582. */
  96583. getShadowGenerator(): Nullable<IShadowGenerator>;
  96584. /**
  96585. * Returns a Vector3, the absolute light position in the World.
  96586. * @returns the world space position of the light
  96587. */
  96588. getAbsolutePosition(): Vector3;
  96589. /**
  96590. * Specifies if the light will affect the passed mesh.
  96591. * @param mesh The mesh to test against the light
  96592. * @return true the mesh is affected otherwise, false.
  96593. */
  96594. canAffectMesh(mesh: AbstractMesh): boolean;
  96595. /**
  96596. * Sort function to order lights for rendering.
  96597. * @param a First Light object to compare to second.
  96598. * @param b Second Light object to compare first.
  96599. * @return -1 to reduce's a's index relative to be, 0 for no change, 1 to increase a's index relative to b.
  96600. */
  96601. static CompareLightsPriority(a: Light, b: Light): number;
  96602. /**
  96603. * Releases resources associated with this node.
  96604. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  96605. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  96606. */
  96607. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  96608. /**
  96609. * Returns the light type ID (integer).
  96610. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  96611. */
  96612. getTypeID(): number;
  96613. /**
  96614. * Returns the intensity scaled by the Photometric Scale according to the light type and intensity mode.
  96615. * @returns the scaled intensity in intensity mode unit
  96616. */
  96617. getScaledIntensity(): number;
  96618. /**
  96619. * Returns a new Light object, named "name", from the current one.
  96620. * @param name The name of the cloned light
  96621. * @param newParent The parent of this light, if it has one
  96622. * @returns the new created light
  96623. */
  96624. clone(name: string, newParent?: Nullable<Node>): Nullable<Light>;
  96625. /**
  96626. * Serializes the current light into a Serialization object.
  96627. * @returns the serialized object.
  96628. */
  96629. serialize(): any;
  96630. /**
  96631. * Creates a new typed light from the passed type (integer) : point light = 0, directional light = 1, spot light = 2, hemispheric light = 3.
  96632. * This new light is named "name" and added to the passed scene.
  96633. * @param type Type according to the types available in Light.LIGHTTYPEID_x
  96634. * @param name The friendly name of the light
  96635. * @param scene The scene the new light will belong to
  96636. * @returns the constructor function
  96637. */
  96638. static GetConstructorFromName(type: number, name: string, scene: Scene): Nullable<() => Light>;
  96639. /**
  96640. * Parses the passed "parsedLight" and returns a new instanced Light from this parsing.
  96641. * @param parsedLight The JSON representation of the light
  96642. * @param scene The scene to create the parsed light in
  96643. * @returns the created light after parsing
  96644. */
  96645. static Parse(parsedLight: any, scene: Scene): Nullable<Light>;
  96646. private _hookArrayForExcluded;
  96647. private _hookArrayForIncludedOnly;
  96648. private _resyncMeshes;
  96649. /**
  96650. * Forces the meshes to update their light related information in their rendering used effects
  96651. * @hidden Internal Use Only
  96652. */
  96653. _markMeshesAsLightDirty(): void;
  96654. /**
  96655. * Recomputes the cached photometric scale if needed.
  96656. */
  96657. private _computePhotometricScale;
  96658. /**
  96659. * Returns the Photometric Scale according to the light type and intensity mode.
  96660. */
  96661. private _getPhotometricScale;
  96662. /**
  96663. * Reorder the light in the scene according to their defined priority.
  96664. * @hidden Internal Use Only
  96665. */
  96666. _reorderLightsInScene(): void;
  96667. /**
  96668. * Prepares the list of defines specific to the light type.
  96669. * @param defines the list of defines
  96670. * @param lightIndex defines the index of the light for the effect
  96671. */
  96672. abstract prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  96673. }
  96674. }
  96675. declare module BABYLON {
  96676. /**
  96677. * A target camera takes a mesh or position as a target and continues to look at it while it moves.
  96678. * This is the base of the follow, arc rotate cameras and Free camera
  96679. * @see https://doc.babylonjs.com/features/cameras
  96680. */
  96681. export class TargetCamera extends Camera {
  96682. private static _RigCamTransformMatrix;
  96683. private static _TargetTransformMatrix;
  96684. private static _TargetFocalPoint;
  96685. private _tmpUpVector;
  96686. private _tmpTargetVector;
  96687. /**
  96688. * Define the current direction the camera is moving to
  96689. */
  96690. cameraDirection: Vector3;
  96691. /**
  96692. * Define the current rotation the camera is rotating to
  96693. */
  96694. cameraRotation: Vector2;
  96695. /** Gets or sets a boolean indicating that the scaling of the parent hierarchy will not be taken in account by the camera */
  96696. ignoreParentScaling: boolean;
  96697. /**
  96698. * When set, the up vector of the camera will be updated by the rotation of the camera
  96699. */
  96700. updateUpVectorFromRotation: boolean;
  96701. private _tmpQuaternion;
  96702. /**
  96703. * Define the current rotation of the camera
  96704. */
  96705. rotation: Vector3;
  96706. /**
  96707. * Define the current rotation of the camera as a quaternion to prevent Gimbal lock
  96708. */
  96709. rotationQuaternion: Quaternion;
  96710. /**
  96711. * Define the current speed of the camera
  96712. */
  96713. speed: number;
  96714. /**
  96715. * Add constraint to the camera to prevent it to move freely in all directions and
  96716. * around all axis.
  96717. */
  96718. noRotationConstraint: boolean;
  96719. /**
  96720. * Reverses mouselook direction to 'natural' panning as opposed to traditional direct
  96721. * panning
  96722. */
  96723. invertRotation: boolean;
  96724. /**
  96725. * Speed multiplier for inverse camera panning
  96726. */
  96727. inverseRotationSpeed: number;
  96728. /**
  96729. * Define the current target of the camera as an object or a position.
  96730. */
  96731. lockedTarget: any;
  96732. /** @hidden */
  96733. _currentTarget: Vector3;
  96734. /** @hidden */
  96735. _initialFocalDistance: number;
  96736. /** @hidden */
  96737. _viewMatrix: Matrix;
  96738. /** @hidden */
  96739. _camMatrix: Matrix;
  96740. /** @hidden */
  96741. _cameraTransformMatrix: Matrix;
  96742. /** @hidden */
  96743. _cameraRotationMatrix: Matrix;
  96744. /** @hidden */
  96745. _referencePoint: Vector3;
  96746. /** @hidden */
  96747. _transformedReferencePoint: Vector3;
  96748. /** @hidden */
  96749. _reset: () => void;
  96750. private _defaultUp;
  96751. /**
  96752. * Instantiates a target camera that takes a mesh or position as a target and continues to look at it while it moves.
  96753. * This is the base of the follow, arc rotate cameras and Free camera
  96754. * @see https://doc.babylonjs.com/features/cameras
  96755. * @param name Defines the name of the camera in the scene
  96756. * @param position Defines the start position of the camera in the scene
  96757. * @param scene Defines the scene the camera belongs to
  96758. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  96759. */
  96760. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  96761. /**
  96762. * Gets the position in front of the camera at a given distance.
  96763. * @param distance The distance from the camera we want the position to be
  96764. * @returns the position
  96765. */
  96766. getFrontPosition(distance: number): Vector3;
  96767. /** @hidden */
  96768. _getLockedTargetPosition(): Nullable<Vector3>;
  96769. private _storedPosition;
  96770. private _storedRotation;
  96771. private _storedRotationQuaternion;
  96772. /**
  96773. * Store current camera state of the camera (fov, position, rotation, etc..)
  96774. * @returns the camera
  96775. */
  96776. storeState(): Camera;
  96777. /**
  96778. * Restored camera state. You must call storeState() first
  96779. * @returns whether it was successful or not
  96780. * @hidden
  96781. */
  96782. _restoreStateValues(): boolean;
  96783. /** @hidden */
  96784. _initCache(): void;
  96785. /** @hidden */
  96786. _updateCache(ignoreParentClass?: boolean): void;
  96787. /** @hidden */
  96788. _isSynchronizedViewMatrix(): boolean;
  96789. /** @hidden */
  96790. _computeLocalCameraSpeed(): number;
  96791. /**
  96792. * Defines the target the camera should look at.
  96793. * @param target Defines the new target as a Vector or a mesh
  96794. */
  96795. setTarget(target: Vector3): void;
  96796. /**
  96797. * Return the current target position of the camera. This value is expressed in local space.
  96798. * @returns the target position
  96799. */
  96800. getTarget(): Vector3;
  96801. /** @hidden */
  96802. _decideIfNeedsToMove(): boolean;
  96803. /** @hidden */
  96804. _updatePosition(): void;
  96805. /** @hidden */
  96806. _checkInputs(): void;
  96807. protected _updateCameraRotationMatrix(): void;
  96808. /**
  96809. * 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)
  96810. * @returns the current camera
  96811. */
  96812. private _rotateUpVectorWithCameraRotationMatrix;
  96813. private _cachedRotationZ;
  96814. private _cachedQuaternionRotationZ;
  96815. /** @hidden */
  96816. _getViewMatrix(): Matrix;
  96817. protected _computeViewMatrix(position: Vector3, target: Vector3, up: Vector3): void;
  96818. /**
  96819. * @hidden
  96820. */
  96821. createRigCamera(name: string, cameraIndex: number): Nullable<Camera>;
  96822. /**
  96823. * @hidden
  96824. */
  96825. _updateRigCameras(): void;
  96826. private _getRigCamPositionAndTarget;
  96827. /**
  96828. * Gets the current object class name.
  96829. * @return the class name
  96830. */
  96831. getClassName(): string;
  96832. }
  96833. }
  96834. declare module BABYLON {
  96835. /**
  96836. * Gather the list of keyboard event types as constants.
  96837. */
  96838. export class KeyboardEventTypes {
  96839. /**
  96840. * The keydown event is fired when a key becomes active (pressed).
  96841. */
  96842. static readonly KEYDOWN: number;
  96843. /**
  96844. * The keyup event is fired when a key has been released.
  96845. */
  96846. static readonly KEYUP: number;
  96847. }
  96848. /**
  96849. * This class is used to store keyboard related info for the onKeyboardObservable event.
  96850. */
  96851. export class KeyboardInfo {
  96852. /**
  96853. * Defines the type of event (KeyboardEventTypes)
  96854. */
  96855. type: number;
  96856. /**
  96857. * Defines the related dom event
  96858. */
  96859. event: KeyboardEvent;
  96860. /**
  96861. * Instantiates a new keyboard info.
  96862. * This class is used to store keyboard related info for the onKeyboardObservable event.
  96863. * @param type Defines the type of event (KeyboardEventTypes)
  96864. * @param event Defines the related dom event
  96865. */
  96866. constructor(
  96867. /**
  96868. * Defines the type of event (KeyboardEventTypes)
  96869. */
  96870. type: number,
  96871. /**
  96872. * Defines the related dom event
  96873. */
  96874. event: KeyboardEvent);
  96875. }
  96876. /**
  96877. * This class is used to store keyboard related info for the onPreKeyboardObservable event.
  96878. * Set the skipOnKeyboardObservable property to true if you want the engine to stop any process after this event is triggered, even not calling onKeyboardObservable
  96879. */
  96880. export class KeyboardInfoPre extends KeyboardInfo {
  96881. /**
  96882. * Defines the type of event (KeyboardEventTypes)
  96883. */
  96884. type: number;
  96885. /**
  96886. * Defines the related dom event
  96887. */
  96888. event: KeyboardEvent;
  96889. /**
  96890. * Defines whether the engine should skip the next onKeyboardObservable associated to this pre.
  96891. */
  96892. skipOnPointerObservable: boolean;
  96893. /**
  96894. * Instantiates a new keyboard pre info.
  96895. * This class is used to store keyboard related info for the onPreKeyboardObservable event.
  96896. * @param type Defines the type of event (KeyboardEventTypes)
  96897. * @param event Defines the related dom event
  96898. */
  96899. constructor(
  96900. /**
  96901. * Defines the type of event (KeyboardEventTypes)
  96902. */
  96903. type: number,
  96904. /**
  96905. * Defines the related dom event
  96906. */
  96907. event: KeyboardEvent);
  96908. }
  96909. }
  96910. declare module BABYLON {
  96911. /**
  96912. * Manage the keyboard inputs to control the movement of a free camera.
  96913. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  96914. */
  96915. export class FreeCameraKeyboardMoveInput implements ICameraInput<FreeCamera> {
  96916. /**
  96917. * Defines the camera the input is attached to.
  96918. */
  96919. camera: FreeCamera;
  96920. /**
  96921. * Gets or Set the list of keyboard keys used to control the forward move of the camera.
  96922. */
  96923. keysUp: number[];
  96924. /**
  96925. * Gets or Set the list of keyboard keys used to control the upward move of the camera.
  96926. */
  96927. keysUpward: number[];
  96928. /**
  96929. * Gets or Set the list of keyboard keys used to control the backward move of the camera.
  96930. */
  96931. keysDown: number[];
  96932. /**
  96933. * Gets or Set the list of keyboard keys used to control the downward move of the camera.
  96934. */
  96935. keysDownward: number[];
  96936. /**
  96937. * Gets or Set the list of keyboard keys used to control the left strafe move of the camera.
  96938. */
  96939. keysLeft: number[];
  96940. /**
  96941. * Gets or Set the list of keyboard keys used to control the right strafe move of the camera.
  96942. */
  96943. keysRight: number[];
  96944. private _keys;
  96945. private _onCanvasBlurObserver;
  96946. private _onKeyboardObserver;
  96947. private _engine;
  96948. private _scene;
  96949. /**
  96950. * Attach the input controls to a specific dom element to get the input from.
  96951. * @param element Defines the element the controls should be listened from
  96952. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  96953. */
  96954. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  96955. /**
  96956. * Detach the current controls from the specified dom element.
  96957. * @param element Defines the element to stop listening the inputs from
  96958. */
  96959. detachControl(element: Nullable<HTMLElement>): void;
  96960. /**
  96961. * Update the current camera state depending on the inputs that have been used this frame.
  96962. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  96963. */
  96964. checkInputs(): void;
  96965. /**
  96966. * Gets the class name of the current intput.
  96967. * @returns the class name
  96968. */
  96969. getClassName(): string;
  96970. /** @hidden */
  96971. _onLostFocus(): void;
  96972. /**
  96973. * Get the friendly name associated with the input class.
  96974. * @returns the input friendly name
  96975. */
  96976. getSimpleName(): string;
  96977. }
  96978. }
  96979. declare module BABYLON {
  96980. /**
  96981. * Gather the list of pointer event types as constants.
  96982. */
  96983. export class PointerEventTypes {
  96984. /**
  96985. * 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.
  96986. */
  96987. static readonly POINTERDOWN: number;
  96988. /**
  96989. * The pointerup event is fired when a pointer is no longer active.
  96990. */
  96991. static readonly POINTERUP: number;
  96992. /**
  96993. * The pointermove event is fired when a pointer changes coordinates.
  96994. */
  96995. static readonly POINTERMOVE: number;
  96996. /**
  96997. * The pointerwheel event is fired when a mouse wheel has been rotated.
  96998. */
  96999. static readonly POINTERWHEEL: number;
  97000. /**
  97001. * The pointerpick event is fired when a mesh or sprite has been picked by the pointer.
  97002. */
  97003. static readonly POINTERPICK: number;
  97004. /**
  97005. * The pointertap event is fired when a the object has been touched and released without drag.
  97006. */
  97007. static readonly POINTERTAP: number;
  97008. /**
  97009. * The pointerdoubletap event is fired when a the object has been touched and released twice without drag.
  97010. */
  97011. static readonly POINTERDOUBLETAP: number;
  97012. }
  97013. /**
  97014. * Base class of pointer info types.
  97015. */
  97016. export class PointerInfoBase {
  97017. /**
  97018. * Defines the type of event (PointerEventTypes)
  97019. */
  97020. type: number;
  97021. /**
  97022. * Defines the related dom event
  97023. */
  97024. event: PointerEvent | MouseWheelEvent;
  97025. /**
  97026. * Instantiates the base class of pointers info.
  97027. * @param type Defines the type of event (PointerEventTypes)
  97028. * @param event Defines the related dom event
  97029. */
  97030. constructor(
  97031. /**
  97032. * Defines the type of event (PointerEventTypes)
  97033. */
  97034. type: number,
  97035. /**
  97036. * Defines the related dom event
  97037. */
  97038. event: PointerEvent | MouseWheelEvent);
  97039. }
  97040. /**
  97041. * This class is used to store pointer related info for the onPrePointerObservable event.
  97042. * Set the skipOnPointerObservable property to true if you want the engine to stop any process after this event is triggered, even not calling onPointerObservable
  97043. */
  97044. export class PointerInfoPre extends PointerInfoBase {
  97045. /**
  97046. * Ray from a pointer if availible (eg. 6dof controller)
  97047. */
  97048. ray: Nullable<Ray>;
  97049. /**
  97050. * Defines the local position of the pointer on the canvas.
  97051. */
  97052. localPosition: Vector2;
  97053. /**
  97054. * Defines whether the engine should skip the next OnPointerObservable associated to this pre.
  97055. */
  97056. skipOnPointerObservable: boolean;
  97057. /**
  97058. * Instantiates a PointerInfoPre to store pointer related info to the onPrePointerObservable event.
  97059. * @param type Defines the type of event (PointerEventTypes)
  97060. * @param event Defines the related dom event
  97061. * @param localX Defines the local x coordinates of the pointer when the event occured
  97062. * @param localY Defines the local y coordinates of the pointer when the event occured
  97063. */
  97064. constructor(type: number, event: PointerEvent | MouseWheelEvent, localX: number, localY: number);
  97065. }
  97066. /**
  97067. * This type contains all the data related to a pointer event in Babylon.js.
  97068. * 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.
  97069. */
  97070. export class PointerInfo extends PointerInfoBase {
  97071. /**
  97072. * Defines the picking info associated to the info (if any)\
  97073. */
  97074. pickInfo: Nullable<PickingInfo>;
  97075. /**
  97076. * Instantiates a PointerInfo to store pointer related info to the onPointerObservable event.
  97077. * @param type Defines the type of event (PointerEventTypes)
  97078. * @param event Defines the related dom event
  97079. * @param pickInfo Defines the picking info associated to the info (if any)\
  97080. */
  97081. constructor(type: number, event: PointerEvent | MouseWheelEvent,
  97082. /**
  97083. * Defines the picking info associated to the info (if any)\
  97084. */
  97085. pickInfo: Nullable<PickingInfo>);
  97086. }
  97087. /**
  97088. * Data relating to a touch event on the screen.
  97089. */
  97090. export interface PointerTouch {
  97091. /**
  97092. * X coordinate of touch.
  97093. */
  97094. x: number;
  97095. /**
  97096. * Y coordinate of touch.
  97097. */
  97098. y: number;
  97099. /**
  97100. * Id of touch. Unique for each finger.
  97101. */
  97102. pointerId: number;
  97103. /**
  97104. * Event type passed from DOM.
  97105. */
  97106. type: any;
  97107. }
  97108. }
  97109. declare module BABYLON {
  97110. /**
  97111. * Manage the mouse inputs to control the movement of a free camera.
  97112. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  97113. */
  97114. export class FreeCameraMouseInput implements ICameraInput<FreeCamera> {
  97115. /**
  97116. * Define if touch is enabled in the mouse input
  97117. */
  97118. touchEnabled: boolean;
  97119. /**
  97120. * Defines the camera the input is attached to.
  97121. */
  97122. camera: FreeCamera;
  97123. /**
  97124. * Defines the buttons associated with the input to handle camera move.
  97125. */
  97126. buttons: number[];
  97127. /**
  97128. * Defines the pointer angular sensibility along the X and Y axis or how fast is the camera rotating.
  97129. */
  97130. angularSensibility: number;
  97131. private _pointerInput;
  97132. private _onMouseMove;
  97133. private _observer;
  97134. private previousPosition;
  97135. /**
  97136. * Observable for when a pointer move event occurs containing the move offset
  97137. */
  97138. onPointerMovedObservable: Observable<{
  97139. offsetX: number;
  97140. offsetY: number;
  97141. }>;
  97142. /**
  97143. * @hidden
  97144. * If the camera should be rotated automatically based on pointer movement
  97145. */
  97146. _allowCameraRotation: boolean;
  97147. /**
  97148. * Manage the mouse inputs to control the movement of a free camera.
  97149. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  97150. * @param touchEnabled Defines if touch is enabled or not
  97151. */
  97152. constructor(
  97153. /**
  97154. * Define if touch is enabled in the mouse input
  97155. */
  97156. touchEnabled?: boolean);
  97157. /**
  97158. * Attach the input controls to a specific dom element to get the input from.
  97159. * @param element Defines the element the controls should be listened from
  97160. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  97161. */
  97162. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  97163. /**
  97164. * Called on JS contextmenu event.
  97165. * Override this method to provide functionality.
  97166. */
  97167. protected onContextMenu(evt: PointerEvent): void;
  97168. /**
  97169. * Detach the current controls from the specified dom element.
  97170. * @param element Defines the element to stop listening the inputs from
  97171. */
  97172. detachControl(element: Nullable<HTMLElement>): void;
  97173. /**
  97174. * Gets the class name of the current intput.
  97175. * @returns the class name
  97176. */
  97177. getClassName(): string;
  97178. /**
  97179. * Get the friendly name associated with the input class.
  97180. * @returns the input friendly name
  97181. */
  97182. getSimpleName(): string;
  97183. }
  97184. }
  97185. declare module BABYLON {
  97186. /**
  97187. * Manage the touch inputs to control the movement of a free camera.
  97188. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  97189. */
  97190. export class FreeCameraTouchInput implements ICameraInput<FreeCamera> {
  97191. /**
  97192. * Defines the camera the input is attached to.
  97193. */
  97194. camera: FreeCamera;
  97195. /**
  97196. * Defines the touch sensibility for rotation.
  97197. * The higher the faster.
  97198. */
  97199. touchAngularSensibility: number;
  97200. /**
  97201. * Defines the touch sensibility for move.
  97202. * The higher the faster.
  97203. */
  97204. touchMoveSensibility: number;
  97205. private _offsetX;
  97206. private _offsetY;
  97207. private _pointerPressed;
  97208. private _pointerInput;
  97209. private _observer;
  97210. private _onLostFocus;
  97211. /**
  97212. * Attach the input controls to a specific dom element to get the input from.
  97213. * @param element Defines the element the controls should be listened from
  97214. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  97215. */
  97216. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  97217. /**
  97218. * Detach the current controls from the specified dom element.
  97219. * @param element Defines the element to stop listening the inputs from
  97220. */
  97221. detachControl(element: Nullable<HTMLElement>): void;
  97222. /**
  97223. * Update the current camera state depending on the inputs that have been used this frame.
  97224. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  97225. */
  97226. checkInputs(): void;
  97227. /**
  97228. * Gets the class name of the current intput.
  97229. * @returns the class name
  97230. */
  97231. getClassName(): string;
  97232. /**
  97233. * Get the friendly name associated with the input class.
  97234. * @returns the input friendly name
  97235. */
  97236. getSimpleName(): string;
  97237. }
  97238. }
  97239. declare module BABYLON {
  97240. /**
  97241. * Default Inputs manager for the FreeCamera.
  97242. * It groups all the default supported inputs for ease of use.
  97243. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  97244. */
  97245. export class FreeCameraInputsManager extends CameraInputsManager<FreeCamera> {
  97246. /**
  97247. * @hidden
  97248. */
  97249. _mouseInput: Nullable<FreeCameraMouseInput>;
  97250. /**
  97251. * Instantiates a new FreeCameraInputsManager.
  97252. * @param camera Defines the camera the inputs belong to
  97253. */
  97254. constructor(camera: FreeCamera);
  97255. /**
  97256. * Add keyboard input support to the input manager.
  97257. * @returns the current input manager
  97258. */
  97259. addKeyboard(): FreeCameraInputsManager;
  97260. /**
  97261. * Add mouse input support to the input manager.
  97262. * @param touchEnabled if the FreeCameraMouseInput should support touch (default: true)
  97263. * @returns the current input manager
  97264. */
  97265. addMouse(touchEnabled?: boolean): FreeCameraInputsManager;
  97266. /**
  97267. * Removes the mouse input support from the manager
  97268. * @returns the current input manager
  97269. */
  97270. removeMouse(): FreeCameraInputsManager;
  97271. /**
  97272. * Add touch input support to the input manager.
  97273. * @returns the current input manager
  97274. */
  97275. addTouch(): FreeCameraInputsManager;
  97276. /**
  97277. * Remove all attached input methods from a camera
  97278. */
  97279. clear(): void;
  97280. }
  97281. }
  97282. declare module BABYLON {
  97283. /**
  97284. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  97285. * Please consider using the new UniversalCamera instead as it adds more functionality like the gamepad.
  97286. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  97287. */
  97288. export class FreeCamera extends TargetCamera {
  97289. /**
  97290. * Define the collision ellipsoid of the camera.
  97291. * This is helpful to simulate a camera body like the player body around the camera
  97292. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  97293. */
  97294. ellipsoid: Vector3;
  97295. /**
  97296. * Define an offset for the position of the ellipsoid around the camera.
  97297. * This can be helpful to determine the center of the body near the gravity center of the body
  97298. * instead of its head.
  97299. */
  97300. ellipsoidOffset: Vector3;
  97301. /**
  97302. * Enable or disable collisions of the camera with the rest of the scene objects.
  97303. */
  97304. checkCollisions: boolean;
  97305. /**
  97306. * Enable or disable gravity on the camera.
  97307. */
  97308. applyGravity: boolean;
  97309. /**
  97310. * Define the input manager associated to the camera.
  97311. */
  97312. inputs: FreeCameraInputsManager;
  97313. /**
  97314. * Gets the input sensibility for a mouse input. (default is 2000.0)
  97315. * Higher values reduce sensitivity.
  97316. */
  97317. get angularSensibility(): number;
  97318. /**
  97319. * Sets the input sensibility for a mouse input. (default is 2000.0)
  97320. * Higher values reduce sensitivity.
  97321. */
  97322. set angularSensibility(value: number);
  97323. /**
  97324. * Gets or Set the list of keyboard keys used to control the forward move of the camera.
  97325. */
  97326. get keysUp(): number[];
  97327. set keysUp(value: number[]);
  97328. /**
  97329. * Gets or Set the list of keyboard keys used to control the upward move of the camera.
  97330. */
  97331. get keysUpward(): number[];
  97332. set keysUpward(value: number[]);
  97333. /**
  97334. * Gets or Set the list of keyboard keys used to control the backward move of the camera.
  97335. */
  97336. get keysDown(): number[];
  97337. set keysDown(value: number[]);
  97338. /**
  97339. * Gets or Set the list of keyboard keys used to control the downward move of the camera.
  97340. */
  97341. get keysDownward(): number[];
  97342. set keysDownward(value: number[]);
  97343. /**
  97344. * Gets or Set the list of keyboard keys used to control the left strafe move of the camera.
  97345. */
  97346. get keysLeft(): number[];
  97347. set keysLeft(value: number[]);
  97348. /**
  97349. * Gets or Set the list of keyboard keys used to control the right strafe move of the camera.
  97350. */
  97351. get keysRight(): number[];
  97352. set keysRight(value: number[]);
  97353. /**
  97354. * Event raised when the camera collide with a mesh in the scene.
  97355. */
  97356. onCollide: (collidedMesh: AbstractMesh) => void;
  97357. private _collider;
  97358. private _needMoveForGravity;
  97359. private _oldPosition;
  97360. private _diffPosition;
  97361. private _newPosition;
  97362. /** @hidden */
  97363. _localDirection: Vector3;
  97364. /** @hidden */
  97365. _transformedDirection: Vector3;
  97366. /**
  97367. * Instantiates a Free Camera.
  97368. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  97369. * Please consider using the new UniversalCamera instead as it adds more functionality like touch to this camera.
  97370. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  97371. * @param name Define the name of the camera in the scene
  97372. * @param position Define the start position of the camera in the scene
  97373. * @param scene Define the scene the camera belongs to
  97374. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  97375. */
  97376. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  97377. /**
  97378. * Attached controls to the current camera.
  97379. * @param element Defines the element the controls should be listened from
  97380. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  97381. */
  97382. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  97383. /**
  97384. * Detach the current controls from the camera.
  97385. * The camera will stop reacting to inputs.
  97386. * @param element Defines the element to stop listening the inputs from
  97387. */
  97388. detachControl(element: HTMLElement): void;
  97389. private _collisionMask;
  97390. /**
  97391. * Define a collision mask to limit the list of object the camera can collide with
  97392. */
  97393. get collisionMask(): number;
  97394. set collisionMask(mask: number);
  97395. /** @hidden */
  97396. _collideWithWorld(displacement: Vector3): void;
  97397. private _onCollisionPositionChange;
  97398. /** @hidden */
  97399. _checkInputs(): void;
  97400. /** @hidden */
  97401. _decideIfNeedsToMove(): boolean;
  97402. /** @hidden */
  97403. _updatePosition(): void;
  97404. /**
  97405. * Destroy the camera and release the current resources hold by it.
  97406. */
  97407. dispose(): void;
  97408. /**
  97409. * Gets the current object class name.
  97410. * @return the class name
  97411. */
  97412. getClassName(): string;
  97413. }
  97414. }
  97415. declare module BABYLON {
  97416. /**
  97417. * Represents a gamepad control stick position
  97418. */
  97419. export class StickValues {
  97420. /**
  97421. * The x component of the control stick
  97422. */
  97423. x: number;
  97424. /**
  97425. * The y component of the control stick
  97426. */
  97427. y: number;
  97428. /**
  97429. * Initializes the gamepad x and y control stick values
  97430. * @param x The x component of the gamepad control stick value
  97431. * @param y The y component of the gamepad control stick value
  97432. */
  97433. constructor(
  97434. /**
  97435. * The x component of the control stick
  97436. */
  97437. x: number,
  97438. /**
  97439. * The y component of the control stick
  97440. */
  97441. y: number);
  97442. }
  97443. /**
  97444. * An interface which manages callbacks for gamepad button changes
  97445. */
  97446. export interface GamepadButtonChanges {
  97447. /**
  97448. * Called when a gamepad has been changed
  97449. */
  97450. changed: boolean;
  97451. /**
  97452. * Called when a gamepad press event has been triggered
  97453. */
  97454. pressChanged: boolean;
  97455. /**
  97456. * Called when a touch event has been triggered
  97457. */
  97458. touchChanged: boolean;
  97459. /**
  97460. * Called when a value has changed
  97461. */
  97462. valueChanged: boolean;
  97463. }
  97464. /**
  97465. * Represents a gamepad
  97466. */
  97467. export class Gamepad {
  97468. /**
  97469. * The id of the gamepad
  97470. */
  97471. id: string;
  97472. /**
  97473. * The index of the gamepad
  97474. */
  97475. index: number;
  97476. /**
  97477. * The browser gamepad
  97478. */
  97479. browserGamepad: any;
  97480. /**
  97481. * Specifies what type of gamepad this represents
  97482. */
  97483. type: number;
  97484. private _leftStick;
  97485. private _rightStick;
  97486. /** @hidden */
  97487. _isConnected: boolean;
  97488. private _leftStickAxisX;
  97489. private _leftStickAxisY;
  97490. private _rightStickAxisX;
  97491. private _rightStickAxisY;
  97492. /**
  97493. * Triggered when the left control stick has been changed
  97494. */
  97495. private _onleftstickchanged;
  97496. /**
  97497. * Triggered when the right control stick has been changed
  97498. */
  97499. private _onrightstickchanged;
  97500. /**
  97501. * Represents a gamepad controller
  97502. */
  97503. static GAMEPAD: number;
  97504. /**
  97505. * Represents a generic controller
  97506. */
  97507. static GENERIC: number;
  97508. /**
  97509. * Represents an XBox controller
  97510. */
  97511. static XBOX: number;
  97512. /**
  97513. * Represents a pose-enabled controller
  97514. */
  97515. static POSE_ENABLED: number;
  97516. /**
  97517. * Represents an Dual Shock controller
  97518. */
  97519. static DUALSHOCK: number;
  97520. /**
  97521. * Specifies whether the left control stick should be Y-inverted
  97522. */
  97523. protected _invertLeftStickY: boolean;
  97524. /**
  97525. * Specifies if the gamepad has been connected
  97526. */
  97527. get isConnected(): boolean;
  97528. /**
  97529. * Initializes the gamepad
  97530. * @param id The id of the gamepad
  97531. * @param index The index of the gamepad
  97532. * @param browserGamepad The browser gamepad
  97533. * @param leftStickX The x component of the left joystick
  97534. * @param leftStickY The y component of the left joystick
  97535. * @param rightStickX The x component of the right joystick
  97536. * @param rightStickY The y component of the right joystick
  97537. */
  97538. constructor(
  97539. /**
  97540. * The id of the gamepad
  97541. */
  97542. id: string,
  97543. /**
  97544. * The index of the gamepad
  97545. */
  97546. index: number,
  97547. /**
  97548. * The browser gamepad
  97549. */
  97550. browserGamepad: any, leftStickX?: number, leftStickY?: number, rightStickX?: number, rightStickY?: number);
  97551. /**
  97552. * Callback triggered when the left joystick has changed
  97553. * @param callback
  97554. */
  97555. onleftstickchanged(callback: (values: StickValues) => void): void;
  97556. /**
  97557. * Callback triggered when the right joystick has changed
  97558. * @param callback
  97559. */
  97560. onrightstickchanged(callback: (values: StickValues) => void): void;
  97561. /**
  97562. * Gets the left joystick
  97563. */
  97564. get leftStick(): StickValues;
  97565. /**
  97566. * Sets the left joystick values
  97567. */
  97568. set leftStick(newValues: StickValues);
  97569. /**
  97570. * Gets the right joystick
  97571. */
  97572. get rightStick(): StickValues;
  97573. /**
  97574. * Sets the right joystick value
  97575. */
  97576. set rightStick(newValues: StickValues);
  97577. /**
  97578. * Updates the gamepad joystick positions
  97579. */
  97580. update(): void;
  97581. /**
  97582. * Disposes the gamepad
  97583. */
  97584. dispose(): void;
  97585. }
  97586. /**
  97587. * Represents a generic gamepad
  97588. */
  97589. export class GenericPad extends Gamepad {
  97590. private _buttons;
  97591. private _onbuttondown;
  97592. private _onbuttonup;
  97593. /**
  97594. * Observable triggered when a button has been pressed
  97595. */
  97596. onButtonDownObservable: Observable<number>;
  97597. /**
  97598. * Observable triggered when a button has been released
  97599. */
  97600. onButtonUpObservable: Observable<number>;
  97601. /**
  97602. * Callback triggered when a button has been pressed
  97603. * @param callback Called when a button has been pressed
  97604. */
  97605. onbuttondown(callback: (buttonPressed: number) => void): void;
  97606. /**
  97607. * Callback triggered when a button has been released
  97608. * @param callback Called when a button has been released
  97609. */
  97610. onbuttonup(callback: (buttonReleased: number) => void): void;
  97611. /**
  97612. * Initializes the generic gamepad
  97613. * @param id The id of the generic gamepad
  97614. * @param index The index of the generic gamepad
  97615. * @param browserGamepad The browser gamepad
  97616. */
  97617. constructor(id: string, index: number, browserGamepad: any);
  97618. private _setButtonValue;
  97619. /**
  97620. * Updates the generic gamepad
  97621. */
  97622. update(): void;
  97623. /**
  97624. * Disposes the generic gamepad
  97625. */
  97626. dispose(): void;
  97627. }
  97628. }
  97629. declare module BABYLON {
  97630. /**
  97631. * Defines the types of pose enabled controllers that are supported
  97632. */
  97633. export enum PoseEnabledControllerType {
  97634. /**
  97635. * HTC Vive
  97636. */
  97637. VIVE = 0,
  97638. /**
  97639. * Oculus Rift
  97640. */
  97641. OCULUS = 1,
  97642. /**
  97643. * Windows mixed reality
  97644. */
  97645. WINDOWS = 2,
  97646. /**
  97647. * Samsung gear VR
  97648. */
  97649. GEAR_VR = 3,
  97650. /**
  97651. * Google Daydream
  97652. */
  97653. DAYDREAM = 4,
  97654. /**
  97655. * Generic
  97656. */
  97657. GENERIC = 5
  97658. }
  97659. /**
  97660. * Defines the MutableGamepadButton interface for the state of a gamepad button
  97661. */
  97662. export interface MutableGamepadButton {
  97663. /**
  97664. * Value of the button/trigger
  97665. */
  97666. value: number;
  97667. /**
  97668. * If the button/trigger is currently touched
  97669. */
  97670. touched: boolean;
  97671. /**
  97672. * If the button/trigger is currently pressed
  97673. */
  97674. pressed: boolean;
  97675. }
  97676. /**
  97677. * Defines the ExtendedGamepadButton interface for a gamepad button which includes state provided by a pose controller
  97678. * @hidden
  97679. */
  97680. export interface ExtendedGamepadButton extends GamepadButton {
  97681. /**
  97682. * If the button/trigger is currently pressed
  97683. */
  97684. readonly pressed: boolean;
  97685. /**
  97686. * If the button/trigger is currently touched
  97687. */
  97688. readonly touched: boolean;
  97689. /**
  97690. * Value of the button/trigger
  97691. */
  97692. readonly value: number;
  97693. }
  97694. /** @hidden */
  97695. export interface _GamePadFactory {
  97696. /**
  97697. * Returns whether or not the current gamepad can be created for this type of controller.
  97698. * @param gamepadInfo Defines the gamepad info as received from the controller APIs.
  97699. * @returns true if it can be created, otherwise false
  97700. */
  97701. canCreate(gamepadInfo: any): boolean;
  97702. /**
  97703. * Creates a new instance of the Gamepad.
  97704. * @param gamepadInfo Defines the gamepad info as received from the controller APIs.
  97705. * @returns the new gamepad instance
  97706. */
  97707. create(gamepadInfo: any): Gamepad;
  97708. }
  97709. /**
  97710. * Defines the PoseEnabledControllerHelper object that is used initialize a gamepad as the controller type it is specified as (eg. windows mixed reality controller)
  97711. */
  97712. export class PoseEnabledControllerHelper {
  97713. /** @hidden */
  97714. static _ControllerFactories: _GamePadFactory[];
  97715. /** @hidden */
  97716. static _DefaultControllerFactory: Nullable<(gamepadInfo: any) => Gamepad>;
  97717. /**
  97718. * Initializes a gamepad as the controller type it is specified as (eg. windows mixed reality controller)
  97719. * @param vrGamepad the gamepad to initialized
  97720. * @returns a vr controller of the type the gamepad identified as
  97721. */
  97722. static InitiateController(vrGamepad: any): Gamepad;
  97723. }
  97724. /**
  97725. * Defines the PoseEnabledController object that contains state of a vr capable controller
  97726. */
  97727. export class PoseEnabledController extends Gamepad implements PoseControlled {
  97728. /**
  97729. * If the controller is used in a webXR session
  97730. */
  97731. isXR: boolean;
  97732. private _deviceRoomPosition;
  97733. private _deviceRoomRotationQuaternion;
  97734. /**
  97735. * The device position in babylon space
  97736. */
  97737. devicePosition: Vector3;
  97738. /**
  97739. * The device rotation in babylon space
  97740. */
  97741. deviceRotationQuaternion: Quaternion;
  97742. /**
  97743. * The scale factor of the device in babylon space
  97744. */
  97745. deviceScaleFactor: number;
  97746. /**
  97747. * (Likely devicePosition should be used instead) The device position in its room space
  97748. */
  97749. position: Vector3;
  97750. /**
  97751. * (Likely deviceRotationQuaternion should be used instead) The device rotation in its room space
  97752. */
  97753. rotationQuaternion: Quaternion;
  97754. /**
  97755. * The type of controller (Eg. Windows mixed reality)
  97756. */
  97757. controllerType: PoseEnabledControllerType;
  97758. protected _calculatedPosition: Vector3;
  97759. private _calculatedRotation;
  97760. /**
  97761. * The raw pose from the device
  97762. */
  97763. rawPose: DevicePose;
  97764. private _trackPosition;
  97765. private _maxRotationDistFromHeadset;
  97766. private _draggedRoomRotation;
  97767. /**
  97768. * @hidden
  97769. */
  97770. _disableTrackPosition(fixedPosition: Vector3): void;
  97771. /**
  97772. * Internal, the mesh attached to the controller
  97773. * @hidden
  97774. */
  97775. _mesh: Nullable<AbstractMesh>;
  97776. private _poseControlledCamera;
  97777. private _leftHandSystemQuaternion;
  97778. /**
  97779. * Internal, matrix used to convert room space to babylon space
  97780. * @hidden
  97781. */
  97782. _deviceToWorld: Matrix;
  97783. /**
  97784. * Node to be used when casting a ray from the controller
  97785. * @hidden
  97786. */
  97787. _pointingPoseNode: Nullable<TransformNode>;
  97788. /**
  97789. * Name of the child mesh that can be used to cast a ray from the controller
  97790. */
  97791. static readonly POINTING_POSE: string;
  97792. /**
  97793. * Creates a new PoseEnabledController from a gamepad
  97794. * @param browserGamepad the gamepad that the PoseEnabledController should be created from
  97795. */
  97796. constructor(browserGamepad: any);
  97797. private _workingMatrix;
  97798. /**
  97799. * Updates the state of the pose enbaled controller and mesh based on the current position and rotation of the controller
  97800. */
  97801. update(): void;
  97802. /**
  97803. * Updates only the pose device and mesh without doing any button event checking
  97804. */
  97805. protected _updatePoseAndMesh(): void;
  97806. /**
  97807. * Updates the state of the pose enbaled controller based on the raw pose data from the device
  97808. * @param poseData raw pose fromthe device
  97809. */
  97810. updateFromDevice(poseData: DevicePose): void;
  97811. /**
  97812. * @hidden
  97813. */
  97814. _meshAttachedObservable: Observable<AbstractMesh>;
  97815. /**
  97816. * Attaches a mesh to the controller
  97817. * @param mesh the mesh to be attached
  97818. */
  97819. attachToMesh(mesh: AbstractMesh): void;
  97820. /**
  97821. * Attaches the controllers mesh to a camera
  97822. * @param camera the camera the mesh should be attached to
  97823. */
  97824. attachToPoseControlledCamera(camera: TargetCamera): void;
  97825. /**
  97826. * Disposes of the controller
  97827. */
  97828. dispose(): void;
  97829. /**
  97830. * The mesh that is attached to the controller
  97831. */
  97832. get mesh(): Nullable<AbstractMesh>;
  97833. /**
  97834. * Gets the ray of the controller in the direction the controller is pointing
  97835. * @param length the length the resulting ray should be
  97836. * @returns a ray in the direction the controller is pointing
  97837. */
  97838. getForwardRay(length?: number): Ray;
  97839. }
  97840. }
  97841. declare module BABYLON {
  97842. /**
  97843. * Defines the WebVRController object that represents controllers tracked in 3D space
  97844. */
  97845. export abstract class WebVRController extends PoseEnabledController {
  97846. /**
  97847. * Internal, the default controller model for the controller
  97848. */
  97849. protected _defaultModel: Nullable<AbstractMesh>;
  97850. /**
  97851. * Fired when the trigger state has changed
  97852. */
  97853. onTriggerStateChangedObservable: Observable<ExtendedGamepadButton>;
  97854. /**
  97855. * Fired when the main button state has changed
  97856. */
  97857. onMainButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  97858. /**
  97859. * Fired when the secondary button state has changed
  97860. */
  97861. onSecondaryButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  97862. /**
  97863. * Fired when the pad state has changed
  97864. */
  97865. onPadStateChangedObservable: Observable<ExtendedGamepadButton>;
  97866. /**
  97867. * Fired when controllers stick values have changed
  97868. */
  97869. onPadValuesChangedObservable: Observable<StickValues>;
  97870. /**
  97871. * Array of button availible on the controller
  97872. */
  97873. protected _buttons: Array<MutableGamepadButton>;
  97874. private _onButtonStateChange;
  97875. /**
  97876. * Fired when a controller button's state has changed
  97877. * @param callback the callback containing the button that was modified
  97878. */
  97879. onButtonStateChange(callback: (controlledIndex: number, buttonIndex: number, state: ExtendedGamepadButton) => void): void;
  97880. /**
  97881. * X and Y axis corresponding to the controllers joystick
  97882. */
  97883. pad: StickValues;
  97884. /**
  97885. * 'left' or 'right', see https://w3c.github.io/gamepad/extensions.html#gamepadhand-enum
  97886. */
  97887. hand: string;
  97888. /**
  97889. * The default controller model for the controller
  97890. */
  97891. get defaultModel(): Nullable<AbstractMesh>;
  97892. /**
  97893. * Creates a new WebVRController from a gamepad
  97894. * @param vrGamepad the gamepad that the WebVRController should be created from
  97895. */
  97896. constructor(vrGamepad: any);
  97897. /**
  97898. * Updates the state of the controller and mesh based on the current position and rotation of the controller
  97899. */
  97900. update(): void;
  97901. /**
  97902. * Function to be called when a button is modified
  97903. */
  97904. protected abstract _handleButtonChange(buttonIdx: number, value: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  97905. /**
  97906. * Loads a mesh and attaches it to the controller
  97907. * @param scene the scene the mesh should be added to
  97908. * @param meshLoaded callback for when the mesh has been loaded
  97909. */
  97910. abstract initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  97911. private _setButtonValue;
  97912. private _changes;
  97913. private _checkChanges;
  97914. /**
  97915. * Disposes of th webVRCOntroller
  97916. */
  97917. dispose(): void;
  97918. }
  97919. }
  97920. declare module BABYLON {
  97921. /**
  97922. * The HemisphericLight simulates the ambient environment light,
  97923. * so the passed direction is the light reflection direction, not the incoming direction.
  97924. */
  97925. export class HemisphericLight extends Light {
  97926. /**
  97927. * The groundColor is the light in the opposite direction to the one specified during creation.
  97928. * 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.
  97929. */
  97930. groundColor: Color3;
  97931. /**
  97932. * The light reflection direction, not the incoming direction.
  97933. */
  97934. direction: Vector3;
  97935. /**
  97936. * Creates a HemisphericLight object in the scene according to the passed direction (Vector3).
  97937. * The HemisphericLight simulates the ambient environment light, so the passed direction is the light reflection direction, not the incoming direction.
  97938. * The HemisphericLight can't cast shadows.
  97939. * Documentation : https://doc.babylonjs.com/babylon101/lights
  97940. * @param name The friendly name of the light
  97941. * @param direction The direction of the light reflection
  97942. * @param scene The scene the light belongs to
  97943. */
  97944. constructor(name: string, direction: Vector3, scene: Scene);
  97945. protected _buildUniformLayout(): void;
  97946. /**
  97947. * Returns the string "HemisphericLight".
  97948. * @return The class name
  97949. */
  97950. getClassName(): string;
  97951. /**
  97952. * Sets the HemisphericLight direction towards the passed target (Vector3).
  97953. * Returns the updated direction.
  97954. * @param target The target the direction should point to
  97955. * @return The computed direction
  97956. */
  97957. setDirectionToTarget(target: Vector3): Vector3;
  97958. /**
  97959. * Returns the shadow generator associated to the light.
  97960. * @returns Always null for hemispheric lights because it does not support shadows.
  97961. */
  97962. getShadowGenerator(): Nullable<IShadowGenerator>;
  97963. /**
  97964. * Sets the passed Effect object with the HemisphericLight normalized direction and color and the passed name (string).
  97965. * @param effect The effect to update
  97966. * @param lightIndex The index of the light in the effect to update
  97967. * @returns The hemispheric light
  97968. */
  97969. transferToEffect(effect: Effect, lightIndex: string): HemisphericLight;
  97970. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  97971. /**
  97972. * Computes the world matrix of the node
  97973. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  97974. * @param useWasUpdatedFlag defines a reserved property
  97975. * @returns the world matrix
  97976. */
  97977. computeWorldMatrix(): Matrix;
  97978. /**
  97979. * Returns the integer 3.
  97980. * @return The light Type id as a constant defines in Light.LIGHTTYPEID_x
  97981. */
  97982. getTypeID(): number;
  97983. /**
  97984. * Prepares the list of defines specific to the light type.
  97985. * @param defines the list of defines
  97986. * @param lightIndex defines the index of the light for the effect
  97987. */
  97988. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  97989. }
  97990. }
  97991. declare module BABYLON {
  97992. /** @hidden */
  97993. export var vrMultiviewToSingleviewPixelShader: {
  97994. name: string;
  97995. shader: string;
  97996. };
  97997. }
  97998. declare module BABYLON {
  97999. /**
  98000. * Renders to multiple views with a single draw call
  98001. * @see https://www.khronos.org/registry/webgl/extensions/WEBGL_multiview/
  98002. */
  98003. export class MultiviewRenderTarget extends RenderTargetTexture {
  98004. /**
  98005. * Creates a multiview render target
  98006. * @param scene scene used with the render target
  98007. * @param size the size of the render target (used for each view)
  98008. */
  98009. constructor(scene: Scene, size?: number | {
  98010. width: number;
  98011. height: number;
  98012. } | {
  98013. ratio: number;
  98014. });
  98015. /**
  98016. * @hidden
  98017. * @param faceIndex the face index, if its a cube texture
  98018. */
  98019. _bindFrameBuffer(faceIndex?: number): void;
  98020. /**
  98021. * Gets the number of views the corresponding to the texture (eg. a MultiviewRenderTarget will have > 1)
  98022. * @returns the view count
  98023. */
  98024. getViewCount(): number;
  98025. }
  98026. }
  98027. declare module BABYLON {
  98028. interface Engine {
  98029. /**
  98030. * Creates a new multiview render target
  98031. * @param width defines the width of the texture
  98032. * @param height defines the height of the texture
  98033. * @returns the created multiview texture
  98034. */
  98035. createMultiviewRenderTargetTexture(width: number, height: number): InternalTexture;
  98036. /**
  98037. * Binds a multiview framebuffer to be drawn to
  98038. * @param multiviewTexture texture to bind
  98039. */
  98040. bindMultiviewFramebuffer(multiviewTexture: InternalTexture): void;
  98041. }
  98042. interface Camera {
  98043. /**
  98044. * @hidden
  98045. * 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)
  98046. */
  98047. _useMultiviewToSingleView: boolean;
  98048. /**
  98049. * @hidden
  98050. * 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)
  98051. */
  98052. _multiviewTexture: Nullable<RenderTargetTexture>;
  98053. /**
  98054. * @hidden
  98055. * ensures the multiview texture of the camera exists and has the specified width/height
  98056. * @param width height to set on the multiview texture
  98057. * @param height width to set on the multiview texture
  98058. */
  98059. _resizeOrCreateMultiviewTexture(width: number, height: number): void;
  98060. }
  98061. interface Scene {
  98062. /** @hidden */
  98063. _transformMatrixR: Matrix;
  98064. /** @hidden */
  98065. _multiviewSceneUbo: Nullable<UniformBuffer>;
  98066. /** @hidden */
  98067. _createMultiviewUbo(): void;
  98068. /** @hidden */
  98069. _updateMultiviewUbo(viewR?: Matrix, projectionR?: Matrix): void;
  98070. /** @hidden */
  98071. _renderMultiviewToSingleView(camera: Camera): void;
  98072. }
  98073. }
  98074. declare module BABYLON {
  98075. /**
  98076. * VRMultiviewToSingleview used to convert multiview texture arrays to standard textures for scenarios such as webVR
  98077. * This will not be used for webXR as it supports displaying texture arrays directly
  98078. */
  98079. export class VRMultiviewToSingleviewPostProcess extends PostProcess {
  98080. /**
  98081. * Initializes a VRMultiviewToSingleview
  98082. * @param name name of the post process
  98083. * @param camera camera to be applied to
  98084. * @param scaleFactor scaling factor to the size of the output texture
  98085. */
  98086. constructor(name: string, camera: Camera, scaleFactor: number);
  98087. }
  98088. }
  98089. declare module BABYLON {
  98090. /**
  98091. * Interface used to define additional presentation attributes
  98092. */
  98093. export interface IVRPresentationAttributes {
  98094. /**
  98095. * Defines a boolean indicating that we want to get 72hz mode on Oculus Browser (default is off eg. 60hz)
  98096. */
  98097. highRefreshRate: boolean;
  98098. /**
  98099. * Enables foveation in VR to improve perf. 0 none, 1 low, 2 medium, 3 high (Default is 1)
  98100. */
  98101. foveationLevel: number;
  98102. }
  98103. interface Engine {
  98104. /** @hidden */
  98105. _vrDisplay: any;
  98106. /** @hidden */
  98107. _vrSupported: boolean;
  98108. /** @hidden */
  98109. _oldSize: Size;
  98110. /** @hidden */
  98111. _oldHardwareScaleFactor: number;
  98112. /** @hidden */
  98113. _vrExclusivePointerMode: boolean;
  98114. /** @hidden */
  98115. _webVRInitPromise: Promise<IDisplayChangedEventArgs>;
  98116. /** @hidden */
  98117. _onVRDisplayPointerRestricted: () => void;
  98118. /** @hidden */
  98119. _onVRDisplayPointerUnrestricted: () => void;
  98120. /** @hidden */
  98121. _onVrDisplayConnect: Nullable<(display: any) => void>;
  98122. /** @hidden */
  98123. _onVrDisplayDisconnect: Nullable<() => void>;
  98124. /** @hidden */
  98125. _onVrDisplayPresentChange: Nullable<() => void>;
  98126. /**
  98127. * Observable signaled when VR display mode changes
  98128. */
  98129. onVRDisplayChangedObservable: Observable<IDisplayChangedEventArgs>;
  98130. /**
  98131. * Observable signaled when VR request present is complete
  98132. */
  98133. onVRRequestPresentComplete: Observable<boolean>;
  98134. /**
  98135. * Observable signaled when VR request present starts
  98136. */
  98137. onVRRequestPresentStart: Observable<Engine>;
  98138. /**
  98139. * Gets a boolean indicating that the engine is currently in VR exclusive mode for the pointers
  98140. * @see https://docs.microsoft.com/en-us/microsoft-edge/webvr/essentials#mouse-input
  98141. */
  98142. isInVRExclusivePointerMode: boolean;
  98143. /**
  98144. * Gets a boolean indicating if a webVR device was detected
  98145. * @returns true if a webVR device was detected
  98146. */
  98147. isVRDevicePresent(): boolean;
  98148. /**
  98149. * Gets the current webVR device
  98150. * @returns the current webVR device (or null)
  98151. */
  98152. getVRDevice(): any;
  98153. /**
  98154. * Initializes a webVR display and starts listening to display change events
  98155. * The onVRDisplayChangedObservable will be notified upon these changes
  98156. * @returns A promise containing a VRDisplay and if vr is supported
  98157. */
  98158. initWebVRAsync(): Promise<IDisplayChangedEventArgs>;
  98159. /** @hidden */
  98160. _getVRDisplaysAsync(): Promise<IDisplayChangedEventArgs>;
  98161. /**
  98162. * Gets or sets the presentation attributes used to configure VR rendering
  98163. */
  98164. vrPresentationAttributes?: IVRPresentationAttributes;
  98165. /**
  98166. * Call this function to switch to webVR mode
  98167. * Will do nothing if webVR is not supported or if there is no webVR device
  98168. * @param options the webvr options provided to the camera. mainly used for multiview
  98169. * @see https://doc.babylonjs.com/how_to/webvr_camera
  98170. */
  98171. enableVR(options: WebVROptions): void;
  98172. /** @hidden */
  98173. _onVRFullScreenTriggered(): void;
  98174. }
  98175. }
  98176. declare module BABYLON {
  98177. /**
  98178. * This is a copy of VRPose. See https://developer.mozilla.org/en-US/docs/Web/API/VRPose
  98179. * IMPORTANT!! The data is right-hand data.
  98180. * @export
  98181. * @interface DevicePose
  98182. */
  98183. export interface DevicePose {
  98184. /**
  98185. * The position of the device, values in array are [x,y,z].
  98186. */
  98187. readonly position: Nullable<Float32Array>;
  98188. /**
  98189. * The linearVelocity of the device, values in array are [x,y,z].
  98190. */
  98191. readonly linearVelocity: Nullable<Float32Array>;
  98192. /**
  98193. * The linearAcceleration of the device, values in array are [x,y,z].
  98194. */
  98195. readonly linearAcceleration: Nullable<Float32Array>;
  98196. /**
  98197. * The orientation of the device in a quaternion array, values in array are [x,y,z,w].
  98198. */
  98199. readonly orientation: Nullable<Float32Array>;
  98200. /**
  98201. * The angularVelocity of the device, values in array are [x,y,z].
  98202. */
  98203. readonly angularVelocity: Nullable<Float32Array>;
  98204. /**
  98205. * The angularAcceleration of the device, values in array are [x,y,z].
  98206. */
  98207. readonly angularAcceleration: Nullable<Float32Array>;
  98208. }
  98209. /**
  98210. * Interface representing a pose controlled object in Babylon.
  98211. * A pose controlled object has both regular pose values as well as pose values
  98212. * from an external device such as a VR head mounted display
  98213. */
  98214. export interface PoseControlled {
  98215. /**
  98216. * The position of the object in babylon space.
  98217. */
  98218. position: Vector3;
  98219. /**
  98220. * The rotation quaternion of the object in babylon space.
  98221. */
  98222. rotationQuaternion: Quaternion;
  98223. /**
  98224. * The position of the device in babylon space.
  98225. */
  98226. devicePosition?: Vector3;
  98227. /**
  98228. * The rotation quaternion of the device in babylon space.
  98229. */
  98230. deviceRotationQuaternion: Quaternion;
  98231. /**
  98232. * The raw pose coming from the device.
  98233. */
  98234. rawPose: Nullable<DevicePose>;
  98235. /**
  98236. * The scale of the device to be used when translating from device space to babylon space.
  98237. */
  98238. deviceScaleFactor: number;
  98239. /**
  98240. * Updates the poseControlled values based on the input device pose.
  98241. * @param poseData the pose data to update the object with
  98242. */
  98243. updateFromDevice(poseData: DevicePose): void;
  98244. }
  98245. /**
  98246. * Set of options to customize the webVRCamera
  98247. */
  98248. export interface WebVROptions {
  98249. /**
  98250. * Sets if the webVR camera should be tracked to the vrDevice. (default: true)
  98251. */
  98252. trackPosition?: boolean;
  98253. /**
  98254. * Sets the scale of the vrDevice in babylon space. (default: 1)
  98255. */
  98256. positionScale?: number;
  98257. /**
  98258. * If there are more than one VRDisplays, this will choose the display matching this name. (default: pick first vrDisplay)
  98259. */
  98260. displayName?: string;
  98261. /**
  98262. * Should the native controller meshes be initialized. (default: true)
  98263. */
  98264. controllerMeshes?: boolean;
  98265. /**
  98266. * Creating a default HemiLight only on controllers. (default: true)
  98267. */
  98268. defaultLightingOnControllers?: boolean;
  98269. /**
  98270. * If you don't want to use the default VR button of the helper. (default: false)
  98271. */
  98272. useCustomVRButton?: boolean;
  98273. /**
  98274. * If you'd like to provide your own button to the VRHelper. (default: standard babylon vr button)
  98275. */
  98276. customVRButton?: HTMLButtonElement;
  98277. /**
  98278. * To change the length of the ray for gaze/controllers. Will be scaled by positionScale. (default: 100)
  98279. */
  98280. rayLength?: number;
  98281. /**
  98282. * To change the default offset from the ground to account for user's height in meters. Will be scaled by positionScale. (default: 1.7)
  98283. */
  98284. defaultHeight?: number;
  98285. /**
  98286. * If multiview should be used if availible (default: false)
  98287. */
  98288. useMultiview?: boolean;
  98289. }
  98290. /**
  98291. * This represents a WebVR camera.
  98292. * The WebVR camera is Babylon's simple interface to interaction with Windows Mixed Reality, HTC Vive and Oculus Rift.
  98293. * @example https://doc.babylonjs.com/how_to/webvr_camera
  98294. */
  98295. export class WebVRFreeCamera extends FreeCamera implements PoseControlled {
  98296. private webVROptions;
  98297. /**
  98298. * @hidden
  98299. * The vrDisplay tied to the camera. See https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay
  98300. */
  98301. _vrDevice: any;
  98302. /**
  98303. * The rawPose of the vrDevice.
  98304. */
  98305. rawPose: Nullable<DevicePose>;
  98306. private _onVREnabled;
  98307. private _specsVersion;
  98308. private _attached;
  98309. private _frameData;
  98310. protected _descendants: Array<Node>;
  98311. private _deviceRoomPosition;
  98312. /** @hidden */
  98313. _deviceRoomRotationQuaternion: Quaternion;
  98314. private _standingMatrix;
  98315. /**
  98316. * Represents device position in babylon space.
  98317. */
  98318. devicePosition: Vector3;
  98319. /**
  98320. * Represents device rotation in babylon space.
  98321. */
  98322. deviceRotationQuaternion: Quaternion;
  98323. /**
  98324. * The scale of the device to be used when translating from device space to babylon space.
  98325. */
  98326. deviceScaleFactor: number;
  98327. private _deviceToWorld;
  98328. private _worldToDevice;
  98329. /**
  98330. * References to the webVR controllers for the vrDevice.
  98331. */
  98332. controllers: Array<WebVRController>;
  98333. /**
  98334. * Emits an event when a controller is attached.
  98335. */
  98336. onControllersAttachedObservable: Observable<WebVRController[]>;
  98337. /**
  98338. * Emits an event when a controller's mesh has been loaded;
  98339. */
  98340. onControllerMeshLoadedObservable: Observable<WebVRController>;
  98341. /**
  98342. * Emits an event when the HMD's pose has been updated.
  98343. */
  98344. onPoseUpdatedFromDeviceObservable: Observable<any>;
  98345. private _poseSet;
  98346. /**
  98347. * If the rig cameras be used as parent instead of this camera.
  98348. */
  98349. rigParenting: boolean;
  98350. private _lightOnControllers;
  98351. private _defaultHeight?;
  98352. /**
  98353. * Instantiates a WebVRFreeCamera.
  98354. * @param name The name of the WebVRFreeCamera
  98355. * @param position The starting anchor position for the camera
  98356. * @param scene The scene the camera belongs to
  98357. * @param webVROptions a set of customizable options for the webVRCamera
  98358. */
  98359. constructor(name: string, position: Vector3, scene: Scene, webVROptions?: WebVROptions);
  98360. /**
  98361. * Gets the device distance from the ground in meters.
  98362. * @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.
  98363. */
  98364. deviceDistanceToRoomGround(): number;
  98365. /**
  98366. * Enables the standing matrix when supported. This can be used to position the user's view the correct height from the ground.
  98367. * @param callback will be called when the standing matrix is set. Callback parameter is if the standing matrix is supported.
  98368. */
  98369. useStandingMatrix(callback?: (bool: boolean) => void): void;
  98370. /**
  98371. * Enables the standing matrix when supported. This can be used to position the user's view the correct height from the ground.
  98372. * @returns A promise with a boolean set to if the standing matrix is supported.
  98373. */
  98374. useStandingMatrixAsync(): Promise<boolean>;
  98375. /**
  98376. * Disposes the camera
  98377. */
  98378. dispose(): void;
  98379. /**
  98380. * Gets a vrController by name.
  98381. * @param name The name of the controller to retreive
  98382. * @returns the controller matching the name specified or null if not found
  98383. */
  98384. getControllerByName(name: string): Nullable<WebVRController>;
  98385. private _leftController;
  98386. /**
  98387. * The controller corresponding to the users left hand.
  98388. */
  98389. get leftController(): Nullable<WebVRController>;
  98390. private _rightController;
  98391. /**
  98392. * The controller corresponding to the users right hand.
  98393. */
  98394. get rightController(): Nullable<WebVRController>;
  98395. /**
  98396. * Casts a ray forward from the vrCamera's gaze.
  98397. * @param length Length of the ray (default: 100)
  98398. * @returns the ray corresponding to the gaze
  98399. */
  98400. getForwardRay(length?: number): Ray;
  98401. /**
  98402. * @hidden
  98403. * Updates the camera based on device's frame data
  98404. */
  98405. _checkInputs(): void;
  98406. /**
  98407. * Updates the poseControlled values based on the input device pose.
  98408. * @param poseData Pose coming from the device
  98409. */
  98410. updateFromDevice(poseData: DevicePose): void;
  98411. private _htmlElementAttached;
  98412. private _detachIfAttached;
  98413. /**
  98414. * WebVR's attach control will start broadcasting frames to the device.
  98415. * Note that in certain browsers (chrome for example) this function must be called
  98416. * within a user-interaction callback. Example:
  98417. * <pre> scene.onPointerDown = function() { camera.attachControl(canvas); }</pre>
  98418. *
  98419. * @param element html element to attach the vrDevice to
  98420. * @param noPreventDefault prevent the default html element operation when attaching the vrDevice
  98421. */
  98422. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  98423. /**
  98424. * Detaches the camera from the html element and disables VR
  98425. *
  98426. * @param element html element to detach from
  98427. */
  98428. detachControl(element: HTMLElement): void;
  98429. /**
  98430. * @returns the name of this class
  98431. */
  98432. getClassName(): string;
  98433. /**
  98434. * Calls resetPose on the vrDisplay
  98435. * See: https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay/resetPose
  98436. */
  98437. resetToCurrentRotation(): void;
  98438. /**
  98439. * @hidden
  98440. * Updates the rig cameras (left and right eye)
  98441. */
  98442. _updateRigCameras(): void;
  98443. private _workingVector;
  98444. private _oneVector;
  98445. private _workingMatrix;
  98446. private updateCacheCalled;
  98447. private _correctPositionIfNotTrackPosition;
  98448. /**
  98449. * @hidden
  98450. * Updates the cached values of the camera
  98451. * @param ignoreParentClass ignores updating the parent class's cache (default: false)
  98452. */
  98453. _updateCache(ignoreParentClass?: boolean): void;
  98454. /**
  98455. * @hidden
  98456. * Get current device position in babylon world
  98457. */
  98458. _computeDevicePosition(): void;
  98459. /**
  98460. * Updates the current device position and rotation in the babylon world
  98461. */
  98462. update(): void;
  98463. /**
  98464. * @hidden
  98465. * Gets the view matrix of this camera (Always set to identity as left and right eye cameras contain the actual view matrix)
  98466. * @returns an identity matrix
  98467. */
  98468. _getViewMatrix(): Matrix;
  98469. private _tmpMatrix;
  98470. /**
  98471. * This function is called by the two RIG cameras.
  98472. * 'this' is the left or right camera (and NOT (!!!) the WebVRFreeCamera instance)
  98473. * @hidden
  98474. */
  98475. _getWebVRViewMatrix(): Matrix;
  98476. /** @hidden */
  98477. _getWebVRProjectionMatrix(): Matrix;
  98478. private _onGamepadConnectedObserver;
  98479. private _onGamepadDisconnectedObserver;
  98480. private _updateCacheWhenTrackingDisabledObserver;
  98481. /**
  98482. * Initializes the controllers and their meshes
  98483. */
  98484. initControllers(): void;
  98485. }
  98486. }
  98487. declare module BABYLON {
  98488. /**
  98489. * "Static Class" containing the most commonly used helper while dealing with material for
  98490. * rendering purpose.
  98491. *
  98492. * It contains the basic tools to help defining defines, binding uniform for the common part of the materials.
  98493. *
  98494. * This works by convention in BabylonJS but is meant to be use only with shader following the in place naming rules and conventions.
  98495. */
  98496. export class MaterialHelper {
  98497. /**
  98498. * Bind the current view position to an effect.
  98499. * @param effect The effect to be bound
  98500. * @param scene The scene the eyes position is used from
  98501. * @param variableName name of the shader variable that will hold the eye position
  98502. */
  98503. static BindEyePosition(effect: Effect, scene: Scene, variableName?: string): void;
  98504. /**
  98505. * Helps preparing the defines values about the UVs in used in the effect.
  98506. * UVs are shared as much as we can accross channels in the shaders.
  98507. * @param texture The texture we are preparing the UVs for
  98508. * @param defines The defines to update
  98509. * @param key The channel key "diffuse", "specular"... used in the shader
  98510. */
  98511. static PrepareDefinesForMergedUV(texture: BaseTexture, defines: any, key: string): void;
  98512. /**
  98513. * Binds a texture matrix value to its corrsponding uniform
  98514. * @param texture The texture to bind the matrix for
  98515. * @param uniformBuffer The uniform buffer receivin the data
  98516. * @param key The channel key "diffuse", "specular"... used in the shader
  98517. */
  98518. static BindTextureMatrix(texture: BaseTexture, uniformBuffer: UniformBuffer, key: string): void;
  98519. /**
  98520. * Gets the current status of the fog (should it be enabled?)
  98521. * @param mesh defines the mesh to evaluate for fog support
  98522. * @param scene defines the hosting scene
  98523. * @returns true if fog must be enabled
  98524. */
  98525. static GetFogState(mesh: AbstractMesh, scene: Scene): boolean;
  98526. /**
  98527. * Helper used to prepare the list of defines associated with misc. values for shader compilation
  98528. * @param mesh defines the current mesh
  98529. * @param scene defines the current scene
  98530. * @param useLogarithmicDepth defines if logarithmic depth has to be turned on
  98531. * @param pointsCloud defines if point cloud rendering has to be turned on
  98532. * @param fogEnabled defines if fog has to be turned on
  98533. * @param alphaTest defines if alpha testing has to be turned on
  98534. * @param defines defines the current list of defines
  98535. */
  98536. static PrepareDefinesForMisc(mesh: AbstractMesh, scene: Scene, useLogarithmicDepth: boolean, pointsCloud: boolean, fogEnabled: boolean, alphaTest: boolean, defines: any): void;
  98537. /**
  98538. * Helper used to prepare the list of defines associated with frame values for shader compilation
  98539. * @param scene defines the current scene
  98540. * @param engine defines the current engine
  98541. * @param defines specifies the list of active defines
  98542. * @param useInstances defines if instances have to be turned on
  98543. * @param useClipPlane defines if clip plane have to be turned on
  98544. * @param useInstances defines if instances have to be turned on
  98545. * @param useThinInstances defines if thin instances have to be turned on
  98546. */
  98547. static PrepareDefinesForFrameBoundValues(scene: Scene, engine: Engine, defines: any, useInstances: boolean, useClipPlane?: Nullable<boolean>, useThinInstances?: boolean): void;
  98548. /**
  98549. * Prepares the defines for bones
  98550. * @param mesh The mesh containing the geometry data we will draw
  98551. * @param defines The defines to update
  98552. */
  98553. static PrepareDefinesForBones(mesh: AbstractMesh, defines: any): void;
  98554. /**
  98555. * Prepares the defines for morph targets
  98556. * @param mesh The mesh containing the geometry data we will draw
  98557. * @param defines The defines to update
  98558. */
  98559. static PrepareDefinesForMorphTargets(mesh: AbstractMesh, defines: any): void;
  98560. /**
  98561. * Prepares the defines used in the shader depending on the attributes data available in the mesh
  98562. * @param mesh The mesh containing the geometry data we will draw
  98563. * @param defines The defines to update
  98564. * @param useVertexColor Precise whether vertex colors should be used or not (override mesh info)
  98565. * @param useBones Precise whether bones should be used or not (override mesh info)
  98566. * @param useMorphTargets Precise whether morph targets should be used or not (override mesh info)
  98567. * @param useVertexAlpha Precise whether vertex alpha should be used or not (override mesh info)
  98568. * @returns false if defines are considered not dirty and have not been checked
  98569. */
  98570. static PrepareDefinesForAttributes(mesh: AbstractMesh, defines: any, useVertexColor: boolean, useBones: boolean, useMorphTargets?: boolean, useVertexAlpha?: boolean): boolean;
  98571. /**
  98572. * Prepares the defines related to multiview
  98573. * @param scene The scene we are intending to draw
  98574. * @param defines The defines to update
  98575. */
  98576. static PrepareDefinesForMultiview(scene: Scene, defines: any): void;
  98577. /**
  98578. * Prepares the defines related to the prepass
  98579. * @param scene The scene we are intending to draw
  98580. * @param defines The defines to update
  98581. * @param canRenderToMRT Indicates if this material renders to several textures in the prepass
  98582. */
  98583. static PrepareDefinesForPrePass(scene: Scene, defines: any, canRenderToMRT: boolean): void;
  98584. /**
  98585. * Prepares the defines related to the light information passed in parameter
  98586. * @param scene The scene we are intending to draw
  98587. * @param mesh The mesh the effect is compiling for
  98588. * @param light The light the effect is compiling for
  98589. * @param lightIndex The index of the light
  98590. * @param defines The defines to update
  98591. * @param specularSupported Specifies whether specular is supported or not (override lights data)
  98592. * @param state Defines the current state regarding what is needed (normals, etc...)
  98593. */
  98594. static PrepareDefinesForLight(scene: Scene, mesh: AbstractMesh, light: Light, lightIndex: number, defines: any, specularSupported: boolean, state: {
  98595. needNormals: boolean;
  98596. needRebuild: boolean;
  98597. shadowEnabled: boolean;
  98598. specularEnabled: boolean;
  98599. lightmapMode: boolean;
  98600. }): void;
  98601. /**
  98602. * Prepares the defines related to the light information passed in parameter
  98603. * @param scene The scene we are intending to draw
  98604. * @param mesh The mesh the effect is compiling for
  98605. * @param defines The defines to update
  98606. * @param specularSupported Specifies whether specular is supported or not (override lights data)
  98607. * @param maxSimultaneousLights Specfies how manuy lights can be added to the effect at max
  98608. * @param disableLighting Specifies whether the lighting is disabled (override scene and light)
  98609. * @returns true if normals will be required for the rest of the effect
  98610. */
  98611. static PrepareDefinesForLights(scene: Scene, mesh: AbstractMesh, defines: any, specularSupported: boolean, maxSimultaneousLights?: number, disableLighting?: boolean): boolean;
  98612. /**
  98613. * Prepares the uniforms and samplers list to be used in the effect (for a specific light)
  98614. * @param lightIndex defines the light index
  98615. * @param uniformsList The uniform list
  98616. * @param samplersList The sampler list
  98617. * @param projectedLightTexture defines if projected texture must be used
  98618. * @param uniformBuffersList defines an optional list of uniform buffers
  98619. */
  98620. static PrepareUniformsAndSamplersForLight(lightIndex: number, uniformsList: string[], samplersList: string[], projectedLightTexture?: any, uniformBuffersList?: Nullable<string[]>): void;
  98621. /**
  98622. * Prepares the uniforms and samplers list to be used in the effect
  98623. * @param uniformsListOrOptions The uniform names to prepare or an EffectCreationOptions containing the liist and extra information
  98624. * @param samplersList The sampler list
  98625. * @param defines The defines helping in the list generation
  98626. * @param maxSimultaneousLights The maximum number of simultanous light allowed in the effect
  98627. */
  98628. static PrepareUniformsAndSamplersList(uniformsListOrOptions: string[] | IEffectCreationOptions, samplersList?: string[], defines?: any, maxSimultaneousLights?: number): void;
  98629. /**
  98630. * This helps decreasing rank by rank the shadow quality (0 being the highest rank and quality)
  98631. * @param defines The defines to update while falling back
  98632. * @param fallbacks The authorized effect fallbacks
  98633. * @param maxSimultaneousLights The maximum number of lights allowed
  98634. * @param rank the current rank of the Effect
  98635. * @returns The newly affected rank
  98636. */
  98637. static HandleFallbacksForShadows(defines: any, fallbacks: EffectFallbacks, maxSimultaneousLights?: number, rank?: number): number;
  98638. private static _TmpMorphInfluencers;
  98639. /**
  98640. * Prepares the list of attributes required for morph targets according to the effect defines.
  98641. * @param attribs The current list of supported attribs
  98642. * @param mesh The mesh to prepare the morph targets attributes for
  98643. * @param influencers The number of influencers
  98644. */
  98645. static PrepareAttributesForMorphTargetsInfluencers(attribs: string[], mesh: AbstractMesh, influencers: number): void;
  98646. /**
  98647. * Prepares the list of attributes required for morph targets according to the effect defines.
  98648. * @param attribs The current list of supported attribs
  98649. * @param mesh The mesh to prepare the morph targets attributes for
  98650. * @param defines The current Defines of the effect
  98651. */
  98652. static PrepareAttributesForMorphTargets(attribs: string[], mesh: AbstractMesh, defines: any): void;
  98653. /**
  98654. * Prepares the list of attributes required for bones according to the effect defines.
  98655. * @param attribs The current list of supported attribs
  98656. * @param mesh The mesh to prepare the bones attributes for
  98657. * @param defines The current Defines of the effect
  98658. * @param fallbacks The current efffect fallback strategy
  98659. */
  98660. static PrepareAttributesForBones(attribs: string[], mesh: AbstractMesh, defines: any, fallbacks: EffectFallbacks): void;
  98661. /**
  98662. * Check and prepare the list of attributes required for instances according to the effect defines.
  98663. * @param attribs The current list of supported attribs
  98664. * @param defines The current MaterialDefines of the effect
  98665. */
  98666. static PrepareAttributesForInstances(attribs: string[], defines: MaterialDefines): void;
  98667. /**
  98668. * Add the list of attributes required for instances to the attribs array.
  98669. * @param attribs The current list of supported attribs
  98670. */
  98671. static PushAttributesForInstances(attribs: string[]): void;
  98672. /**
  98673. * Binds the light information to the effect.
  98674. * @param light The light containing the generator
  98675. * @param effect The effect we are binding the data to
  98676. * @param lightIndex The light index in the effect used to render
  98677. */
  98678. static BindLightProperties(light: Light, effect: Effect, lightIndex: number): void;
  98679. /**
  98680. * Binds the lights information from the scene to the effect for the given mesh.
  98681. * @param light Light to bind
  98682. * @param lightIndex Light index
  98683. * @param scene The scene where the light belongs to
  98684. * @param effect The effect we are binding the data to
  98685. * @param useSpecular Defines if specular is supported
  98686. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  98687. */
  98688. static BindLight(light: Light, lightIndex: number, scene: Scene, effect: Effect, useSpecular: boolean, rebuildInParallel?: boolean): void;
  98689. /**
  98690. * Binds the lights information from the scene to the effect for the given mesh.
  98691. * @param scene The scene the lights belongs to
  98692. * @param mesh The mesh we are binding the information to render
  98693. * @param effect The effect we are binding the data to
  98694. * @param defines The generated defines for the effect
  98695. * @param maxSimultaneousLights The maximum number of light that can be bound to the effect
  98696. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  98697. */
  98698. static BindLights(scene: Scene, mesh: AbstractMesh, effect: Effect, defines: any, maxSimultaneousLights?: number, rebuildInParallel?: boolean): void;
  98699. private static _tempFogColor;
  98700. /**
  98701. * Binds the fog information from the scene to the effect for the given mesh.
  98702. * @param scene The scene the lights belongs to
  98703. * @param mesh The mesh we are binding the information to render
  98704. * @param effect The effect we are binding the data to
  98705. * @param linearSpace Defines if the fog effect is applied in linear space
  98706. */
  98707. static BindFogParameters(scene: Scene, mesh: AbstractMesh, effect: Effect, linearSpace?: boolean): void;
  98708. /**
  98709. * Binds the bones information from the mesh to the effect.
  98710. * @param mesh The mesh we are binding the information to render
  98711. * @param effect The effect we are binding the data to
  98712. */
  98713. static BindBonesParameters(mesh?: AbstractMesh, effect?: Effect): void;
  98714. /**
  98715. * Binds the morph targets information from the mesh to the effect.
  98716. * @param abstractMesh The mesh we are binding the information to render
  98717. * @param effect The effect we are binding the data to
  98718. */
  98719. static BindMorphTargetParameters(abstractMesh: AbstractMesh, effect: Effect): void;
  98720. /**
  98721. * Binds the logarithmic depth information from the scene to the effect for the given defines.
  98722. * @param defines The generated defines used in the effect
  98723. * @param effect The effect we are binding the data to
  98724. * @param scene The scene we are willing to render with logarithmic scale for
  98725. */
  98726. static BindLogDepth(defines: any, effect: Effect, scene: Scene): void;
  98727. /**
  98728. * Binds the clip plane information from the scene to the effect.
  98729. * @param scene The scene the clip plane information are extracted from
  98730. * @param effect The effect we are binding the data to
  98731. */
  98732. static BindClipPlane(effect: Effect, scene: Scene): void;
  98733. }
  98734. }
  98735. declare module BABYLON {
  98736. /**
  98737. * Block used to expose an input value
  98738. */
  98739. export class InputBlock extends NodeMaterialBlock {
  98740. private _mode;
  98741. private _associatedVariableName;
  98742. private _storedValue;
  98743. private _valueCallback;
  98744. private _type;
  98745. private _animationType;
  98746. /** Gets or set a value used to limit the range of float values */
  98747. min: number;
  98748. /** Gets or set a value used to limit the range of float values */
  98749. max: number;
  98750. /** Gets or set a value indicating that this input can only get 0 and 1 values */
  98751. isBoolean: boolean;
  98752. /** Gets or sets a value used by the Node Material editor to determine how to configure the current value if it is a matrix */
  98753. matrixMode: number;
  98754. /** @hidden */
  98755. _systemValue: Nullable<NodeMaterialSystemValues>;
  98756. /** Gets or sets a boolean indicating that this input can be edited in the Inspector (false by default) */
  98757. visibleInInspector: boolean;
  98758. /** Gets or sets a boolean indicating that the value of this input will not change after a build */
  98759. isConstant: boolean;
  98760. /** Gets or sets the group to use to display this block in the Inspector */
  98761. groupInInspector: string;
  98762. /** Gets an observable raised when the value is changed */
  98763. onValueChangedObservable: Observable<InputBlock>;
  98764. /**
  98765. * Gets or sets the connection point type (default is float)
  98766. */
  98767. get type(): NodeMaterialBlockConnectionPointTypes;
  98768. /**
  98769. * Creates a new InputBlock
  98770. * @param name defines the block name
  98771. * @param target defines the target of that block (Vertex by default)
  98772. * @param type defines the type of the input (can be set to NodeMaterialBlockConnectionPointTypes.AutoDetect)
  98773. */
  98774. constructor(name: string, target?: NodeMaterialBlockTargets, type?: NodeMaterialBlockConnectionPointTypes);
  98775. /**
  98776. * Validates if a name is a reserve word.
  98777. * @param newName the new name to be given to the node.
  98778. * @returns false if the name is a reserve word, else true.
  98779. */
  98780. validateBlockName(newName: string): boolean;
  98781. /**
  98782. * Gets the output component
  98783. */
  98784. get output(): NodeMaterialConnectionPoint;
  98785. /**
  98786. * Set the source of this connection point to a vertex attribute
  98787. * @param attributeName defines the attribute name (position, uv, normal, etc...). If not specified it will take the connection point name
  98788. * @returns the current connection point
  98789. */
  98790. setAsAttribute(attributeName?: string): InputBlock;
  98791. /**
  98792. * Set the source of this connection point to a system value
  98793. * @param value define the system value to use (world, view, etc...) or null to switch to manual value
  98794. * @returns the current connection point
  98795. */
  98796. setAsSystemValue(value: Nullable<NodeMaterialSystemValues>): InputBlock;
  98797. /**
  98798. * Gets or sets the value of that point.
  98799. * Please note that this value will be ignored if valueCallback is defined
  98800. */
  98801. get value(): any;
  98802. set value(value: any);
  98803. /**
  98804. * Gets or sets a callback used to get the value of that point.
  98805. * Please note that setting this value will force the connection point to ignore the value property
  98806. */
  98807. get valueCallback(): () => any;
  98808. set valueCallback(value: () => any);
  98809. /**
  98810. * Gets or sets the associated variable name in the shader
  98811. */
  98812. get associatedVariableName(): string;
  98813. set associatedVariableName(value: string);
  98814. /** Gets or sets the type of animation applied to the input */
  98815. get animationType(): AnimatedInputBlockTypes;
  98816. set animationType(value: AnimatedInputBlockTypes);
  98817. /**
  98818. * Gets a boolean indicating that this connection point not defined yet
  98819. */
  98820. get isUndefined(): boolean;
  98821. /**
  98822. * Gets or sets a boolean indicating that this connection point is coming from an uniform.
  98823. * In this case the connection point name must be the name of the uniform to use.
  98824. * Can only be set on inputs
  98825. */
  98826. get isUniform(): boolean;
  98827. set isUniform(value: boolean);
  98828. /**
  98829. * Gets or sets a boolean indicating that this connection point is coming from an attribute.
  98830. * In this case the connection point name must be the name of the attribute to use
  98831. * Can only be set on inputs
  98832. */
  98833. get isAttribute(): boolean;
  98834. set isAttribute(value: boolean);
  98835. /**
  98836. * Gets or sets a boolean indicating that this connection point is generating a varying variable.
  98837. * Can only be set on exit points
  98838. */
  98839. get isVarying(): boolean;
  98840. set isVarying(value: boolean);
  98841. /**
  98842. * Gets a boolean indicating that the current connection point is a system value
  98843. */
  98844. get isSystemValue(): boolean;
  98845. /**
  98846. * Gets or sets the current well known value or null if not defined as a system value
  98847. */
  98848. get systemValue(): Nullable<NodeMaterialSystemValues>;
  98849. set systemValue(value: Nullable<NodeMaterialSystemValues>);
  98850. /**
  98851. * Gets the current class name
  98852. * @returns the class name
  98853. */
  98854. getClassName(): string;
  98855. /**
  98856. * Animate the input if animationType !== None
  98857. * @param scene defines the rendering scene
  98858. */
  98859. animate(scene: Scene): void;
  98860. private _emitDefine;
  98861. initialize(state: NodeMaterialBuildState): void;
  98862. /**
  98863. * Set the input block to its default value (based on its type)
  98864. */
  98865. setDefaultValue(): void;
  98866. private _emitConstant;
  98867. /** @hidden */
  98868. get _noContextSwitch(): boolean;
  98869. private _emit;
  98870. /** @hidden */
  98871. _transmitWorld(effect: Effect, world: Matrix, worldView: Matrix, worldViewProjection: Matrix): void;
  98872. /** @hidden */
  98873. _transmit(effect: Effect, scene: Scene): void;
  98874. protected _buildBlock(state: NodeMaterialBuildState): void;
  98875. protected _dumpPropertiesCode(): string;
  98876. dispose(): void;
  98877. serialize(): any;
  98878. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  98879. }
  98880. }
  98881. declare module BABYLON {
  98882. /**
  98883. * Enum used to define the compatibility state between two connection points
  98884. */
  98885. export enum NodeMaterialConnectionPointCompatibilityStates {
  98886. /** Points are compatibles */
  98887. Compatible = 0,
  98888. /** Points are incompatible because of their types */
  98889. TypeIncompatible = 1,
  98890. /** Points are incompatible because of their targets (vertex vs fragment) */
  98891. TargetIncompatible = 2
  98892. }
  98893. /**
  98894. * Defines the direction of a connection point
  98895. */
  98896. export enum NodeMaterialConnectionPointDirection {
  98897. /** Input */
  98898. Input = 0,
  98899. /** Output */
  98900. Output = 1
  98901. }
  98902. /**
  98903. * Defines a connection point for a block
  98904. */
  98905. export class NodeMaterialConnectionPoint {
  98906. /** @hidden */
  98907. _ownerBlock: NodeMaterialBlock;
  98908. /** @hidden */
  98909. _connectedPoint: Nullable<NodeMaterialConnectionPoint>;
  98910. private _endpoints;
  98911. private _associatedVariableName;
  98912. private _direction;
  98913. /** @hidden */
  98914. _typeConnectionSource: Nullable<NodeMaterialConnectionPoint>;
  98915. /** @hidden */
  98916. _linkedConnectionSource: Nullable<NodeMaterialConnectionPoint>;
  98917. private _type;
  98918. /** @hidden */
  98919. _enforceAssociatedVariableName: boolean;
  98920. /** Gets the direction of the point */
  98921. get direction(): NodeMaterialConnectionPointDirection;
  98922. /** Indicates that this connection point needs dual validation before being connected to another point */
  98923. needDualDirectionValidation: boolean;
  98924. /**
  98925. * Gets or sets the additional types supported by this connection point
  98926. */
  98927. acceptedConnectionPointTypes: NodeMaterialBlockConnectionPointTypes[];
  98928. /**
  98929. * Gets or sets the additional types excluded by this connection point
  98930. */
  98931. excludedConnectionPointTypes: NodeMaterialBlockConnectionPointTypes[];
  98932. /**
  98933. * Observable triggered when this point is connected
  98934. */
  98935. onConnectionObservable: Observable<NodeMaterialConnectionPoint>;
  98936. /**
  98937. * Gets or sets the associated variable name in the shader
  98938. */
  98939. get associatedVariableName(): string;
  98940. set associatedVariableName(value: string);
  98941. /** Get the inner type (ie AutoDetect for instance instead of the inferred one) */
  98942. get innerType(): NodeMaterialBlockConnectionPointTypes;
  98943. /**
  98944. * Gets or sets the connection point type (default is float)
  98945. */
  98946. get type(): NodeMaterialBlockConnectionPointTypes;
  98947. set type(value: NodeMaterialBlockConnectionPointTypes);
  98948. /**
  98949. * Gets or sets the connection point name
  98950. */
  98951. name: string;
  98952. /**
  98953. * Gets or sets the connection point name
  98954. */
  98955. displayName: string;
  98956. /**
  98957. * Gets or sets a boolean indicating that this connection point can be omitted
  98958. */
  98959. isOptional: boolean;
  98960. /**
  98961. * Gets or sets a boolean indicating that this connection point is exposed on a frame
  98962. */
  98963. isExposedOnFrame: boolean;
  98964. /**
  98965. * Gets or sets a string indicating that this uniform must be defined under a #ifdef
  98966. */
  98967. define: string;
  98968. /** @hidden */
  98969. _prioritizeVertex: boolean;
  98970. private _target;
  98971. /** Gets or sets the target of that connection point */
  98972. get target(): NodeMaterialBlockTargets;
  98973. set target(value: NodeMaterialBlockTargets);
  98974. /**
  98975. * Gets a boolean indicating that the current point is connected to another NodeMaterialBlock
  98976. */
  98977. get isConnected(): boolean;
  98978. /**
  98979. * Gets a boolean indicating that the current point is connected to an input block
  98980. */
  98981. get isConnectedToInputBlock(): boolean;
  98982. /**
  98983. * Gets a the connected input block (if any)
  98984. */
  98985. get connectInputBlock(): Nullable<InputBlock>;
  98986. /** Get the other side of the connection (if any) */
  98987. get connectedPoint(): Nullable<NodeMaterialConnectionPoint>;
  98988. /** Get the block that owns this connection point */
  98989. get ownerBlock(): NodeMaterialBlock;
  98990. /** Get the block connected on the other side of this connection (if any) */
  98991. get sourceBlock(): Nullable<NodeMaterialBlock>;
  98992. /** Get the block connected on the endpoints of this connection (if any) */
  98993. get connectedBlocks(): Array<NodeMaterialBlock>;
  98994. /** Gets the list of connected endpoints */
  98995. get endpoints(): NodeMaterialConnectionPoint[];
  98996. /** Gets a boolean indicating if that output point is connected to at least one input */
  98997. get hasEndpoints(): boolean;
  98998. /** Gets a boolean indicating that this connection will be used in the vertex shader */
  98999. get isConnectedInVertexShader(): boolean;
  99000. /** Gets a boolean indicating that this connection will be used in the fragment shader */
  99001. get isConnectedInFragmentShader(): boolean;
  99002. /**
  99003. * Creates a block suitable to be used as an input for this input point.
  99004. * If null is returned, a block based on the point type will be created.
  99005. * @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
  99006. */
  99007. createCustomInputBlock(): Nullable<[NodeMaterialBlock, string]>;
  99008. /**
  99009. * Creates a new connection point
  99010. * @param name defines the connection point name
  99011. * @param ownerBlock defines the block hosting this connection point
  99012. * @param direction defines the direction of the connection point
  99013. */
  99014. constructor(name: string, ownerBlock: NodeMaterialBlock, direction: NodeMaterialConnectionPointDirection);
  99015. /**
  99016. * Gets the current class name e.g. "NodeMaterialConnectionPoint"
  99017. * @returns the class name
  99018. */
  99019. getClassName(): string;
  99020. /**
  99021. * Gets a boolean indicating if the current point can be connected to another point
  99022. * @param connectionPoint defines the other connection point
  99023. * @returns a boolean
  99024. */
  99025. canConnectTo(connectionPoint: NodeMaterialConnectionPoint): boolean;
  99026. /**
  99027. * Gets a number indicating if the current point can be connected to another point
  99028. * @param connectionPoint defines the other connection point
  99029. * @returns a number defining the compatibility state
  99030. */
  99031. checkCompatibilityState(connectionPoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPointCompatibilityStates;
  99032. /**
  99033. * Connect this point to another connection point
  99034. * @param connectionPoint defines the other connection point
  99035. * @param ignoreConstraints defines if the system will ignore connection type constraints (default is false)
  99036. * @returns the current connection point
  99037. */
  99038. connectTo(connectionPoint: NodeMaterialConnectionPoint, ignoreConstraints?: boolean): NodeMaterialConnectionPoint;
  99039. /**
  99040. * Disconnect this point from one of his endpoint
  99041. * @param endpoint defines the other connection point
  99042. * @returns the current connection point
  99043. */
  99044. disconnectFrom(endpoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPoint;
  99045. /**
  99046. * Serializes this point in a JSON representation
  99047. * @param isInput defines if the connection point is an input (default is true)
  99048. * @returns the serialized point object
  99049. */
  99050. serialize(isInput?: boolean): any;
  99051. /**
  99052. * Release resources
  99053. */
  99054. dispose(): void;
  99055. }
  99056. }
  99057. declare module BABYLON {
  99058. /**
  99059. * Enum used to define the material modes
  99060. */
  99061. export enum NodeMaterialModes {
  99062. /** Regular material */
  99063. Material = 0,
  99064. /** For post process */
  99065. PostProcess = 1,
  99066. /** For particle system */
  99067. Particle = 2
  99068. }
  99069. }
  99070. declare module BABYLON {
  99071. /**
  99072. * Block used to read a texture from a sampler
  99073. */
  99074. export class TextureBlock extends NodeMaterialBlock {
  99075. private _defineName;
  99076. private _linearDefineName;
  99077. private _gammaDefineName;
  99078. private _tempTextureRead;
  99079. private _samplerName;
  99080. private _transformedUVName;
  99081. private _textureTransformName;
  99082. private _textureInfoName;
  99083. private _mainUVName;
  99084. private _mainUVDefineName;
  99085. private _fragmentOnly;
  99086. /**
  99087. * Gets or sets the texture associated with the node
  99088. */
  99089. texture: Nullable<Texture>;
  99090. /**
  99091. * Gets or sets a boolean indicating if content needs to be converted to gamma space
  99092. */
  99093. convertToGammaSpace: boolean;
  99094. /**
  99095. * Gets or sets a boolean indicating if content needs to be converted to linear space
  99096. */
  99097. convertToLinearSpace: boolean;
  99098. /**
  99099. * Create a new TextureBlock
  99100. * @param name defines the block name
  99101. */
  99102. constructor(name: string, fragmentOnly?: boolean);
  99103. /**
  99104. * Gets the current class name
  99105. * @returns the class name
  99106. */
  99107. getClassName(): string;
  99108. /**
  99109. * Gets the uv input component
  99110. */
  99111. get uv(): NodeMaterialConnectionPoint;
  99112. /**
  99113. * Gets the rgba output component
  99114. */
  99115. get rgba(): NodeMaterialConnectionPoint;
  99116. /**
  99117. * Gets the rgb output component
  99118. */
  99119. get rgb(): NodeMaterialConnectionPoint;
  99120. /**
  99121. * Gets the r output component
  99122. */
  99123. get r(): NodeMaterialConnectionPoint;
  99124. /**
  99125. * Gets the g output component
  99126. */
  99127. get g(): NodeMaterialConnectionPoint;
  99128. /**
  99129. * Gets the b output component
  99130. */
  99131. get b(): NodeMaterialConnectionPoint;
  99132. /**
  99133. * Gets the a output component
  99134. */
  99135. get a(): NodeMaterialConnectionPoint;
  99136. get target(): NodeMaterialBlockTargets;
  99137. autoConfigure(material: NodeMaterial): void;
  99138. initializeDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  99139. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  99140. isReady(): boolean;
  99141. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  99142. private get _isMixed();
  99143. private _injectVertexCode;
  99144. private _writeTextureRead;
  99145. private _writeOutput;
  99146. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  99147. protected _dumpPropertiesCode(): string;
  99148. serialize(): any;
  99149. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  99150. }
  99151. }
  99152. declare module BABYLON {
  99153. /** @hidden */
  99154. export var reflectionFunction: {
  99155. name: string;
  99156. shader: string;
  99157. };
  99158. }
  99159. declare module BABYLON {
  99160. /**
  99161. * Base block used to read a reflection texture from a sampler
  99162. */
  99163. export abstract class ReflectionTextureBaseBlock extends NodeMaterialBlock {
  99164. /** @hidden */
  99165. _define3DName: string;
  99166. /** @hidden */
  99167. _defineCubicName: string;
  99168. /** @hidden */
  99169. _defineExplicitName: string;
  99170. /** @hidden */
  99171. _defineProjectionName: string;
  99172. /** @hidden */
  99173. _defineLocalCubicName: string;
  99174. /** @hidden */
  99175. _defineSphericalName: string;
  99176. /** @hidden */
  99177. _definePlanarName: string;
  99178. /** @hidden */
  99179. _defineEquirectangularName: string;
  99180. /** @hidden */
  99181. _defineMirroredEquirectangularFixedName: string;
  99182. /** @hidden */
  99183. _defineEquirectangularFixedName: string;
  99184. /** @hidden */
  99185. _defineSkyboxName: string;
  99186. /** @hidden */
  99187. _defineOppositeZ: string;
  99188. /** @hidden */
  99189. _cubeSamplerName: string;
  99190. /** @hidden */
  99191. _2DSamplerName: string;
  99192. protected _positionUVWName: string;
  99193. protected _directionWName: string;
  99194. protected _reflectionVectorName: string;
  99195. /** @hidden */
  99196. _reflectionCoordsName: string;
  99197. /** @hidden */
  99198. _reflectionMatrixName: string;
  99199. protected _reflectionColorName: string;
  99200. /**
  99201. * Gets or sets the texture associated with the node
  99202. */
  99203. texture: Nullable<BaseTexture>;
  99204. /**
  99205. * Create a new ReflectionTextureBaseBlock
  99206. * @param name defines the block name
  99207. */
  99208. constructor(name: string);
  99209. /**
  99210. * Gets the current class name
  99211. * @returns the class name
  99212. */
  99213. getClassName(): string;
  99214. /**
  99215. * Gets the world position input component
  99216. */
  99217. abstract get position(): NodeMaterialConnectionPoint;
  99218. /**
  99219. * Gets the world position input component
  99220. */
  99221. abstract get worldPosition(): NodeMaterialConnectionPoint;
  99222. /**
  99223. * Gets the world normal input component
  99224. */
  99225. abstract get worldNormal(): NodeMaterialConnectionPoint;
  99226. /**
  99227. * Gets the world input component
  99228. */
  99229. abstract get world(): NodeMaterialConnectionPoint;
  99230. /**
  99231. * Gets the camera (or eye) position component
  99232. */
  99233. abstract get cameraPosition(): NodeMaterialConnectionPoint;
  99234. /**
  99235. * Gets the view input component
  99236. */
  99237. abstract get view(): NodeMaterialConnectionPoint;
  99238. protected _getTexture(): Nullable<BaseTexture>;
  99239. autoConfigure(material: NodeMaterial): void;
  99240. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  99241. isReady(): boolean;
  99242. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  99243. /**
  99244. * Gets the code to inject in the vertex shader
  99245. * @param state current state of the node material building
  99246. * @returns the shader code
  99247. */
  99248. handleVertexSide(state: NodeMaterialBuildState): string;
  99249. /**
  99250. * Handles the inits for the fragment code path
  99251. * @param state node material build state
  99252. */
  99253. handleFragmentSideInits(state: NodeMaterialBuildState): void;
  99254. /**
  99255. * Generates the reflection coords code for the fragment code path
  99256. * @param worldNormalVarName name of the world normal variable
  99257. * @param worldPos name of the world position variable. If not provided, will use the world position connected to this block
  99258. * @param onlyReflectionVector if true, generates code only for the reflection vector computation, not for the reflection coordinates
  99259. * @returns the shader code
  99260. */
  99261. handleFragmentSideCodeReflectionCoords(worldNormalVarName: string, worldPos?: string, onlyReflectionVector?: boolean): string;
  99262. /**
  99263. * Generates the reflection color code for the fragment code path
  99264. * @param lodVarName name of the lod variable
  99265. * @param swizzleLookupTexture swizzle to use for the final color variable
  99266. * @returns the shader code
  99267. */
  99268. handleFragmentSideCodeReflectionColor(lodVarName?: string, swizzleLookupTexture?: string): string;
  99269. /**
  99270. * Generates the code corresponding to the connected output points
  99271. * @param state node material build state
  99272. * @param varName name of the variable to output
  99273. * @returns the shader code
  99274. */
  99275. writeOutputs(state: NodeMaterialBuildState, varName: string): string;
  99276. protected _buildBlock(state: NodeMaterialBuildState): this;
  99277. protected _dumpPropertiesCode(): string;
  99278. serialize(): any;
  99279. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  99280. }
  99281. }
  99282. declare module BABYLON {
  99283. /**
  99284. * Defines a connection point to be used for points with a custom object type
  99285. */
  99286. export class NodeMaterialConnectionPointCustomObject<T extends NodeMaterialBlock> extends NodeMaterialConnectionPoint {
  99287. private _blockType;
  99288. private _blockName;
  99289. private _nameForCheking?;
  99290. /**
  99291. * Creates a new connection point
  99292. * @param name defines the connection point name
  99293. * @param ownerBlock defines the block hosting this connection point
  99294. * @param direction defines the direction of the connection point
  99295. */
  99296. constructor(name: string, ownerBlock: NodeMaterialBlock, direction: NodeMaterialConnectionPointDirection, _blockType: new (...args: any[]) => T, _blockName: string, _nameForCheking?: string | undefined);
  99297. /**
  99298. * Gets a number indicating if the current point can be connected to another point
  99299. * @param connectionPoint defines the other connection point
  99300. * @returns a number defining the compatibility state
  99301. */
  99302. checkCompatibilityState(connectionPoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPointCompatibilityStates;
  99303. /**
  99304. * Creates a block suitable to be used as an input for this input point.
  99305. * If null is returned, a block based on the point type will be created.
  99306. * @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
  99307. */
  99308. createCustomInputBlock(): Nullable<[NodeMaterialBlock, string]>;
  99309. }
  99310. }
  99311. declare module BABYLON {
  99312. /**
  99313. * Enum defining the type of properties that can be edited in the property pages in the NME
  99314. */
  99315. export enum PropertyTypeForEdition {
  99316. /** property is a boolean */
  99317. Boolean = 0,
  99318. /** property is a float */
  99319. Float = 1,
  99320. /** property is a Vector2 */
  99321. Vector2 = 2,
  99322. /** property is a list of values */
  99323. List = 3
  99324. }
  99325. /**
  99326. * Interface that defines an option in a variable of type list
  99327. */
  99328. export interface IEditablePropertyListOption {
  99329. /** label of the option */
  99330. "label": string;
  99331. /** value of the option */
  99332. "value": number;
  99333. }
  99334. /**
  99335. * Interface that defines the options available for an editable property
  99336. */
  99337. export interface IEditablePropertyOption {
  99338. /** min value */
  99339. "min"?: number;
  99340. /** max value */
  99341. "max"?: number;
  99342. /** notifiers: indicates which actions to take when the property is changed */
  99343. "notifiers"?: {
  99344. /** the material should be rebuilt */
  99345. "rebuild"?: boolean;
  99346. /** the preview should be updated */
  99347. "update"?: boolean;
  99348. };
  99349. /** list of the options for a variable of type list */
  99350. "options"?: IEditablePropertyListOption[];
  99351. }
  99352. /**
  99353. * Interface that describes an editable property
  99354. */
  99355. export interface IPropertyDescriptionForEdition {
  99356. /** name of the property */
  99357. "propertyName": string;
  99358. /** display name of the property */
  99359. "displayName": string;
  99360. /** type of the property */
  99361. "type": PropertyTypeForEdition;
  99362. /** group of the property - all properties with the same group value will be displayed in a specific section */
  99363. "groupName": string;
  99364. /** options for the property */
  99365. "options": IEditablePropertyOption;
  99366. }
  99367. /**
  99368. * Decorator that flags a property in a node material block as being editable
  99369. */
  99370. export function editableInPropertyPage(displayName: string, propertyType?: PropertyTypeForEdition, groupName?: string, options?: IEditablePropertyOption): (target: any, propertyKey: string) => void;
  99371. }
  99372. declare module BABYLON {
  99373. /**
  99374. * Block used to implement the refraction part of the sub surface module of the PBR material
  99375. */
  99376. export class RefractionBlock extends NodeMaterialBlock {
  99377. /** @hidden */
  99378. _define3DName: string;
  99379. /** @hidden */
  99380. _refractionMatrixName: string;
  99381. /** @hidden */
  99382. _defineLODRefractionAlpha: string;
  99383. /** @hidden */
  99384. _defineLinearSpecularRefraction: string;
  99385. /** @hidden */
  99386. _defineOppositeZ: string;
  99387. /** @hidden */
  99388. _cubeSamplerName: string;
  99389. /** @hidden */
  99390. _2DSamplerName: string;
  99391. /** @hidden */
  99392. _vRefractionMicrosurfaceInfosName: string;
  99393. /** @hidden */
  99394. _vRefractionInfosName: string;
  99395. private _scene;
  99396. /**
  99397. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  99398. * Materials half opaque for instance using refraction could benefit from this control.
  99399. */
  99400. linkRefractionWithTransparency: boolean;
  99401. /**
  99402. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  99403. */
  99404. invertRefractionY: boolean;
  99405. /**
  99406. * Gets or sets the texture associated with the node
  99407. */
  99408. texture: Nullable<BaseTexture>;
  99409. /**
  99410. * Create a new RefractionBlock
  99411. * @param name defines the block name
  99412. */
  99413. constructor(name: string);
  99414. /**
  99415. * Gets the current class name
  99416. * @returns the class name
  99417. */
  99418. getClassName(): string;
  99419. /**
  99420. * Gets the intensity input component
  99421. */
  99422. get intensity(): NodeMaterialConnectionPoint;
  99423. /**
  99424. * Gets the index of refraction input component
  99425. */
  99426. get indexOfRefraction(): NodeMaterialConnectionPoint;
  99427. /**
  99428. * Gets the tint at distance input component
  99429. */
  99430. get tintAtDistance(): NodeMaterialConnectionPoint;
  99431. /**
  99432. * Gets the view input component
  99433. */
  99434. get view(): NodeMaterialConnectionPoint;
  99435. /**
  99436. * Gets the refraction object output component
  99437. */
  99438. get refraction(): NodeMaterialConnectionPoint;
  99439. /**
  99440. * Returns true if the block has a texture
  99441. */
  99442. get hasTexture(): boolean;
  99443. protected _getTexture(): Nullable<BaseTexture>;
  99444. autoConfigure(material: NodeMaterial): void;
  99445. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  99446. isReady(): boolean;
  99447. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  99448. /**
  99449. * Gets the main code of the block (fragment side)
  99450. * @param state current state of the node material building
  99451. * @returns the shader code
  99452. */
  99453. getCode(state: NodeMaterialBuildState): string;
  99454. protected _buildBlock(state: NodeMaterialBuildState): this;
  99455. protected _dumpPropertiesCode(): string;
  99456. serialize(): any;
  99457. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  99458. }
  99459. }
  99460. declare module BABYLON {
  99461. /**
  99462. * Base block used as input for post process
  99463. */
  99464. export class CurrentScreenBlock extends NodeMaterialBlock {
  99465. private _samplerName;
  99466. private _linearDefineName;
  99467. private _gammaDefineName;
  99468. private _mainUVName;
  99469. private _tempTextureRead;
  99470. /**
  99471. * Gets or sets the texture associated with the node
  99472. */
  99473. texture: Nullable<BaseTexture>;
  99474. /**
  99475. * Gets or sets a boolean indicating if content needs to be converted to gamma space
  99476. */
  99477. convertToGammaSpace: boolean;
  99478. /**
  99479. * Gets or sets a boolean indicating if content needs to be converted to linear space
  99480. */
  99481. convertToLinearSpace: boolean;
  99482. /**
  99483. * Create a new CurrentScreenBlock
  99484. * @param name defines the block name
  99485. */
  99486. constructor(name: string);
  99487. /**
  99488. * Gets the current class name
  99489. * @returns the class name
  99490. */
  99491. getClassName(): string;
  99492. /**
  99493. * Gets the uv input component
  99494. */
  99495. get uv(): NodeMaterialConnectionPoint;
  99496. /**
  99497. * Gets the rgba output component
  99498. */
  99499. get rgba(): NodeMaterialConnectionPoint;
  99500. /**
  99501. * Gets the rgb output component
  99502. */
  99503. get rgb(): NodeMaterialConnectionPoint;
  99504. /**
  99505. * Gets the r output component
  99506. */
  99507. get r(): NodeMaterialConnectionPoint;
  99508. /**
  99509. * Gets the g output component
  99510. */
  99511. get g(): NodeMaterialConnectionPoint;
  99512. /**
  99513. * Gets the b output component
  99514. */
  99515. get b(): NodeMaterialConnectionPoint;
  99516. /**
  99517. * Gets the a output component
  99518. */
  99519. get a(): NodeMaterialConnectionPoint;
  99520. /**
  99521. * Initialize the block and prepare the context for build
  99522. * @param state defines the state that will be used for the build
  99523. */
  99524. initialize(state: NodeMaterialBuildState): void;
  99525. get target(): NodeMaterialBlockTargets;
  99526. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  99527. isReady(): boolean;
  99528. private _injectVertexCode;
  99529. private _writeTextureRead;
  99530. private _writeOutput;
  99531. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  99532. serialize(): any;
  99533. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  99534. }
  99535. }
  99536. declare module BABYLON {
  99537. /**
  99538. * Base block used for the particle texture
  99539. */
  99540. export class ParticleTextureBlock extends NodeMaterialBlock {
  99541. private _samplerName;
  99542. private _linearDefineName;
  99543. private _gammaDefineName;
  99544. private _tempTextureRead;
  99545. /**
  99546. * Gets or sets the texture associated with the node
  99547. */
  99548. texture: Nullable<BaseTexture>;
  99549. /**
  99550. * Gets or sets a boolean indicating if content needs to be converted to gamma space
  99551. */
  99552. convertToGammaSpace: boolean;
  99553. /**
  99554. * Gets or sets a boolean indicating if content needs to be converted to linear space
  99555. */
  99556. convertToLinearSpace: boolean;
  99557. /**
  99558. * Create a new ParticleTextureBlock
  99559. * @param name defines the block name
  99560. */
  99561. constructor(name: string);
  99562. /**
  99563. * Gets the current class name
  99564. * @returns the class name
  99565. */
  99566. getClassName(): string;
  99567. /**
  99568. * Gets the uv input component
  99569. */
  99570. get uv(): NodeMaterialConnectionPoint;
  99571. /**
  99572. * Gets the rgba output component
  99573. */
  99574. get rgba(): NodeMaterialConnectionPoint;
  99575. /**
  99576. * Gets the rgb output component
  99577. */
  99578. get rgb(): NodeMaterialConnectionPoint;
  99579. /**
  99580. * Gets the r output component
  99581. */
  99582. get r(): NodeMaterialConnectionPoint;
  99583. /**
  99584. * Gets the g output component
  99585. */
  99586. get g(): NodeMaterialConnectionPoint;
  99587. /**
  99588. * Gets the b output component
  99589. */
  99590. get b(): NodeMaterialConnectionPoint;
  99591. /**
  99592. * Gets the a output component
  99593. */
  99594. get a(): NodeMaterialConnectionPoint;
  99595. /**
  99596. * Initialize the block and prepare the context for build
  99597. * @param state defines the state that will be used for the build
  99598. */
  99599. initialize(state: NodeMaterialBuildState): void;
  99600. autoConfigure(material: NodeMaterial): void;
  99601. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  99602. isReady(): boolean;
  99603. private _writeOutput;
  99604. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  99605. serialize(): any;
  99606. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  99607. }
  99608. }
  99609. declare module BABYLON {
  99610. /**
  99611. * Class used to store shared data between 2 NodeMaterialBuildState
  99612. */
  99613. export class NodeMaterialBuildStateSharedData {
  99614. /**
  99615. * Gets the list of emitted varyings
  99616. */
  99617. temps: string[];
  99618. /**
  99619. * Gets the list of emitted varyings
  99620. */
  99621. varyings: string[];
  99622. /**
  99623. * Gets the varying declaration string
  99624. */
  99625. varyingDeclaration: string;
  99626. /**
  99627. * Input blocks
  99628. */
  99629. inputBlocks: InputBlock[];
  99630. /**
  99631. * Input blocks
  99632. */
  99633. textureBlocks: (TextureBlock | ReflectionTextureBaseBlock | RefractionBlock | CurrentScreenBlock | ParticleTextureBlock)[];
  99634. /**
  99635. * Bindable blocks (Blocks that need to set data to the effect)
  99636. */
  99637. bindableBlocks: NodeMaterialBlock[];
  99638. /**
  99639. * List of blocks that can provide a compilation fallback
  99640. */
  99641. blocksWithFallbacks: NodeMaterialBlock[];
  99642. /**
  99643. * List of blocks that can provide a define update
  99644. */
  99645. blocksWithDefines: NodeMaterialBlock[];
  99646. /**
  99647. * List of blocks that can provide a repeatable content
  99648. */
  99649. repeatableContentBlocks: NodeMaterialBlock[];
  99650. /**
  99651. * List of blocks that can provide a dynamic list of uniforms
  99652. */
  99653. dynamicUniformBlocks: NodeMaterialBlock[];
  99654. /**
  99655. * List of blocks that can block the isReady function for the material
  99656. */
  99657. blockingBlocks: NodeMaterialBlock[];
  99658. /**
  99659. * Gets the list of animated inputs
  99660. */
  99661. animatedInputs: InputBlock[];
  99662. /**
  99663. * Build Id used to avoid multiple recompilations
  99664. */
  99665. buildId: number;
  99666. /** List of emitted variables */
  99667. variableNames: {
  99668. [key: string]: number;
  99669. };
  99670. /** List of emitted defines */
  99671. defineNames: {
  99672. [key: string]: number;
  99673. };
  99674. /** Should emit comments? */
  99675. emitComments: boolean;
  99676. /** Emit build activity */
  99677. verbose: boolean;
  99678. /** Gets or sets the hosting scene */
  99679. scene: Scene;
  99680. /**
  99681. * Gets the compilation hints emitted at compilation time
  99682. */
  99683. hints: {
  99684. needWorldViewMatrix: boolean;
  99685. needWorldViewProjectionMatrix: boolean;
  99686. needAlphaBlending: boolean;
  99687. needAlphaTesting: boolean;
  99688. };
  99689. /**
  99690. * List of compilation checks
  99691. */
  99692. checks: {
  99693. emitVertex: boolean;
  99694. emitFragment: boolean;
  99695. notConnectedNonOptionalInputs: NodeMaterialConnectionPoint[];
  99696. };
  99697. /**
  99698. * Is vertex program allowed to be empty?
  99699. */
  99700. allowEmptyVertexProgram: boolean;
  99701. /** Creates a new shared data */
  99702. constructor();
  99703. /**
  99704. * Emits console errors and exceptions if there is a failing check
  99705. */
  99706. emitErrors(): void;
  99707. }
  99708. }
  99709. declare module BABYLON {
  99710. /**
  99711. * Class used to store node based material build state
  99712. */
  99713. export class NodeMaterialBuildState {
  99714. /** Gets or sets a boolean indicating if the current state can emit uniform buffers */
  99715. supportUniformBuffers: boolean;
  99716. /**
  99717. * Gets the list of emitted attributes
  99718. */
  99719. attributes: string[];
  99720. /**
  99721. * Gets the list of emitted uniforms
  99722. */
  99723. uniforms: string[];
  99724. /**
  99725. * Gets the list of emitted constants
  99726. */
  99727. constants: string[];
  99728. /**
  99729. * Gets the list of emitted samplers
  99730. */
  99731. samplers: string[];
  99732. /**
  99733. * Gets the list of emitted functions
  99734. */
  99735. functions: {
  99736. [key: string]: string;
  99737. };
  99738. /**
  99739. * Gets the list of emitted extensions
  99740. */
  99741. extensions: {
  99742. [key: string]: string;
  99743. };
  99744. /**
  99745. * Gets the target of the compilation state
  99746. */
  99747. target: NodeMaterialBlockTargets;
  99748. /**
  99749. * Gets the list of emitted counters
  99750. */
  99751. counters: {
  99752. [key: string]: number;
  99753. };
  99754. /**
  99755. * Shared data between multiple NodeMaterialBuildState instances
  99756. */
  99757. sharedData: NodeMaterialBuildStateSharedData;
  99758. /** @hidden */
  99759. _vertexState: NodeMaterialBuildState;
  99760. /** @hidden */
  99761. _attributeDeclaration: string;
  99762. /** @hidden */
  99763. _uniformDeclaration: string;
  99764. /** @hidden */
  99765. _constantDeclaration: string;
  99766. /** @hidden */
  99767. _samplerDeclaration: string;
  99768. /** @hidden */
  99769. _varyingTransfer: string;
  99770. /** @hidden */
  99771. _injectAtEnd: string;
  99772. private _repeatableContentAnchorIndex;
  99773. /** @hidden */
  99774. _builtCompilationString: string;
  99775. /**
  99776. * Gets the emitted compilation strings
  99777. */
  99778. compilationString: string;
  99779. /**
  99780. * Finalize the compilation strings
  99781. * @param state defines the current compilation state
  99782. */
  99783. finalize(state: NodeMaterialBuildState): void;
  99784. /** @hidden */
  99785. get _repeatableContentAnchor(): string;
  99786. /** @hidden */
  99787. _getFreeVariableName(prefix: string): string;
  99788. /** @hidden */
  99789. _getFreeDefineName(prefix: string): string;
  99790. /** @hidden */
  99791. _excludeVariableName(name: string): void;
  99792. /** @hidden */
  99793. _emit2DSampler(name: string): void;
  99794. /** @hidden */
  99795. _getGLType(type: NodeMaterialBlockConnectionPointTypes): string;
  99796. /** @hidden */
  99797. _emitExtension(name: string, extension: string, define?: string): void;
  99798. /** @hidden */
  99799. _emitFunction(name: string, code: string, comments: string): void;
  99800. /** @hidden */
  99801. _emitCodeFromInclude(includeName: string, comments: string, options?: {
  99802. replaceStrings?: {
  99803. search: RegExp;
  99804. replace: string;
  99805. }[];
  99806. repeatKey?: string;
  99807. }): string;
  99808. /** @hidden */
  99809. _emitFunctionFromInclude(includeName: string, comments: string, options?: {
  99810. repeatKey?: string;
  99811. removeAttributes?: boolean;
  99812. removeUniforms?: boolean;
  99813. removeVaryings?: boolean;
  99814. removeIfDef?: boolean;
  99815. replaceStrings?: {
  99816. search: RegExp;
  99817. replace: string;
  99818. }[];
  99819. }, storeKey?: string): void;
  99820. /** @hidden */
  99821. _registerTempVariable(name: string): boolean;
  99822. /** @hidden */
  99823. _emitVaryingFromString(name: string, type: string, define?: string, notDefine?: boolean): boolean;
  99824. /** @hidden */
  99825. _emitUniformFromString(name: string, type: string, define?: string, notDefine?: boolean): void;
  99826. /** @hidden */
  99827. _emitFloat(value: number): string;
  99828. }
  99829. }
  99830. declare module BABYLON {
  99831. /**
  99832. * Helper class used to generate session unique ID
  99833. */
  99834. export class UniqueIdGenerator {
  99835. private static _UniqueIdCounter;
  99836. /**
  99837. * Gets an unique (relatively to the current scene) Id
  99838. */
  99839. static get UniqueId(): number;
  99840. }
  99841. }
  99842. declare module BABYLON {
  99843. /**
  99844. * Defines a block that can be used inside a node based material
  99845. */
  99846. export class NodeMaterialBlock {
  99847. private _buildId;
  99848. private _buildTarget;
  99849. private _target;
  99850. private _isFinalMerger;
  99851. private _isInput;
  99852. private _name;
  99853. protected _isUnique: boolean;
  99854. /** Gets or sets a boolean indicating that only one input can be connected at a time */
  99855. inputsAreExclusive: boolean;
  99856. /** @hidden */
  99857. _codeVariableName: string;
  99858. /** @hidden */
  99859. _inputs: NodeMaterialConnectionPoint[];
  99860. /** @hidden */
  99861. _outputs: NodeMaterialConnectionPoint[];
  99862. /** @hidden */
  99863. _preparationId: number;
  99864. /**
  99865. * Gets the name of the block
  99866. */
  99867. get name(): string;
  99868. /**
  99869. * Sets the name of the block. Will check if the name is valid.
  99870. */
  99871. set name(newName: string);
  99872. /**
  99873. * Gets or sets the unique id of the node
  99874. */
  99875. uniqueId: number;
  99876. /**
  99877. * Gets or sets the comments associated with this block
  99878. */
  99879. comments: string;
  99880. /**
  99881. * Gets a boolean indicating that this block can only be used once per NodeMaterial
  99882. */
  99883. get isUnique(): boolean;
  99884. /**
  99885. * Gets a boolean indicating that this block is an end block (e.g. it is generating a system value)
  99886. */
  99887. get isFinalMerger(): boolean;
  99888. /**
  99889. * Gets a boolean indicating that this block is an input (e.g. it sends data to the shader)
  99890. */
  99891. get isInput(): boolean;
  99892. /**
  99893. * Gets or sets the build Id
  99894. */
  99895. get buildId(): number;
  99896. set buildId(value: number);
  99897. /**
  99898. * Gets or sets the target of the block
  99899. */
  99900. get target(): NodeMaterialBlockTargets;
  99901. set target(value: NodeMaterialBlockTargets);
  99902. /**
  99903. * Gets the list of input points
  99904. */
  99905. get inputs(): NodeMaterialConnectionPoint[];
  99906. /** Gets the list of output points */
  99907. get outputs(): NodeMaterialConnectionPoint[];
  99908. /**
  99909. * Find an input by its name
  99910. * @param name defines the name of the input to look for
  99911. * @returns the input or null if not found
  99912. */
  99913. getInputByName(name: string): Nullable<NodeMaterialConnectionPoint>;
  99914. /**
  99915. * Find an output by its name
  99916. * @param name defines the name of the outputto look for
  99917. * @returns the output or null if not found
  99918. */
  99919. getOutputByName(name: string): Nullable<NodeMaterialConnectionPoint>;
  99920. /**
  99921. * Creates a new NodeMaterialBlock
  99922. * @param name defines the block name
  99923. * @param target defines the target of that block (Vertex by default)
  99924. * @param isFinalMerger defines a boolean indicating that this block is an end block (e.g. it is generating a system value). Default is false
  99925. * @param isInput defines a boolean indicating that this block is an input (e.g. it sends data to the shader). Default is false
  99926. */
  99927. constructor(name: string, target?: NodeMaterialBlockTargets, isFinalMerger?: boolean, isInput?: boolean);
  99928. /**
  99929. * Initialize the block and prepare the context for build
  99930. * @param state defines the state that will be used for the build
  99931. */
  99932. initialize(state: NodeMaterialBuildState): void;
  99933. /**
  99934. * Bind data to effect. Will only be called for blocks with isBindable === true
  99935. * @param effect defines the effect to bind data to
  99936. * @param nodeMaterial defines the hosting NodeMaterial
  99937. * @param mesh defines the mesh that will be rendered
  99938. * @param subMesh defines the submesh that will be rendered
  99939. */
  99940. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  99941. protected _declareOutput(output: NodeMaterialConnectionPoint, state: NodeMaterialBuildState): string;
  99942. protected _writeVariable(currentPoint: NodeMaterialConnectionPoint): string;
  99943. protected _writeFloat(value: number): string;
  99944. /**
  99945. * Gets the current class name e.g. "NodeMaterialBlock"
  99946. * @returns the class name
  99947. */
  99948. getClassName(): string;
  99949. /**
  99950. * Register a new input. Must be called inside a block constructor
  99951. * @param name defines the connection point name
  99952. * @param type defines the connection point type
  99953. * @param isOptional defines a boolean indicating that this input can be omitted
  99954. * @param target defines the target to use to limit the connection point (will be VertexAndFragment by default)
  99955. * @param point an already created connection point. If not provided, create a new one
  99956. * @returns the current block
  99957. */
  99958. registerInput(name: string, type: NodeMaterialBlockConnectionPointTypes, isOptional?: boolean, target?: NodeMaterialBlockTargets, point?: NodeMaterialConnectionPoint): this;
  99959. /**
  99960. * Register a new output. Must be called inside a block constructor
  99961. * @param name defines the connection point name
  99962. * @param type defines the connection point type
  99963. * @param target defines the target to use to limit the connection point (will be VertexAndFragment by default)
  99964. * @param point an already created connection point. If not provided, create a new one
  99965. * @returns the current block
  99966. */
  99967. registerOutput(name: string, type: NodeMaterialBlockConnectionPointTypes, target?: NodeMaterialBlockTargets, point?: NodeMaterialConnectionPoint): this;
  99968. /**
  99969. * Will return the first available input e.g. the first one which is not an uniform or an attribute
  99970. * @param forOutput defines an optional connection point to check compatibility with
  99971. * @returns the first available input or null
  99972. */
  99973. getFirstAvailableInput(forOutput?: Nullable<NodeMaterialConnectionPoint>): Nullable<NodeMaterialConnectionPoint>;
  99974. /**
  99975. * Will return the first available output e.g. the first one which is not yet connected and not a varying
  99976. * @param forBlock defines an optional block to check compatibility with
  99977. * @returns the first available input or null
  99978. */
  99979. getFirstAvailableOutput(forBlock?: Nullable<NodeMaterialBlock>): Nullable<NodeMaterialConnectionPoint>;
  99980. /**
  99981. * Gets the sibling of the given output
  99982. * @param current defines the current output
  99983. * @returns the next output in the list or null
  99984. */
  99985. getSiblingOutput(current: NodeMaterialConnectionPoint): Nullable<NodeMaterialConnectionPoint>;
  99986. /**
  99987. * Connect current block with another block
  99988. * @param other defines the block to connect with
  99989. * @param options define the various options to help pick the right connections
  99990. * @returns the current block
  99991. */
  99992. connectTo(other: NodeMaterialBlock, options?: {
  99993. input?: string;
  99994. output?: string;
  99995. outputSwizzle?: string;
  99996. }): this | undefined;
  99997. protected _buildBlock(state: NodeMaterialBuildState): void;
  99998. /**
  99999. * Add uniforms, samplers and uniform buffers at compilation time
  100000. * @param state defines the state to update
  100001. * @param nodeMaterial defines the node material requesting the update
  100002. * @param defines defines the material defines to update
  100003. * @param uniformBuffers defines the list of uniform buffer names
  100004. */
  100005. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  100006. /**
  100007. * Add potential fallbacks if shader compilation fails
  100008. * @param mesh defines the mesh to be rendered
  100009. * @param fallbacks defines the current prioritized list of fallbacks
  100010. */
  100011. provideFallbacks(mesh: AbstractMesh, fallbacks: EffectFallbacks): void;
  100012. /**
  100013. * Initialize defines for shader compilation
  100014. * @param mesh defines the mesh to be rendered
  100015. * @param nodeMaterial defines the node material requesting the update
  100016. * @param defines defines the material defines to update
  100017. * @param useInstances specifies that instances should be used
  100018. */
  100019. initializeDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  100020. /**
  100021. * Update defines for shader compilation
  100022. * @param mesh defines the mesh to be rendered
  100023. * @param nodeMaterial defines the node material requesting the update
  100024. * @param defines defines the material defines to update
  100025. * @param useInstances specifies that instances should be used
  100026. * @param subMesh defines which submesh to render
  100027. */
  100028. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean, subMesh?: SubMesh): void;
  100029. /**
  100030. * Lets the block try to connect some inputs automatically
  100031. * @param material defines the hosting NodeMaterial
  100032. */
  100033. autoConfigure(material: NodeMaterial): void;
  100034. /**
  100035. * Function called when a block is declared as repeatable content generator
  100036. * @param vertexShaderState defines the current compilation state for the vertex shader
  100037. * @param fragmentShaderState defines the current compilation state for the fragment shader
  100038. * @param mesh defines the mesh to be rendered
  100039. * @param defines defines the material defines to update
  100040. */
  100041. replaceRepeatableContent(vertexShaderState: NodeMaterialBuildState, fragmentShaderState: NodeMaterialBuildState, mesh: AbstractMesh, defines: NodeMaterialDefines): void;
  100042. /**
  100043. * Checks if the block is ready
  100044. * @param mesh defines the mesh to be rendered
  100045. * @param nodeMaterial defines the node material requesting the update
  100046. * @param defines defines the material defines to update
  100047. * @param useInstances specifies that instances should be used
  100048. * @returns true if the block is ready
  100049. */
  100050. isReady(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): boolean;
  100051. protected _linkConnectionTypes(inputIndex0: number, inputIndex1: number): void;
  100052. private _processBuild;
  100053. /**
  100054. * Validates the new name for the block node.
  100055. * @param newName the new name to be given to the node.
  100056. * @returns false if the name is a reserve word, else true.
  100057. */
  100058. validateBlockName(newName: string): boolean;
  100059. /**
  100060. * Compile the current node and generate the shader code
  100061. * @param state defines the current compilation state (uniforms, samplers, current string)
  100062. * @param activeBlocks defines the list of active blocks (i.e. blocks to compile)
  100063. * @returns true if already built
  100064. */
  100065. build(state: NodeMaterialBuildState, activeBlocks: NodeMaterialBlock[]): boolean;
  100066. protected _inputRename(name: string): string;
  100067. protected _outputRename(name: string): string;
  100068. protected _dumpPropertiesCode(): string;
  100069. /** @hidden */
  100070. _dumpCode(uniqueNames: string[], alreadyDumped: NodeMaterialBlock[]): string;
  100071. /** @hidden */
  100072. _dumpCodeForOutputConnections(alreadyDumped: NodeMaterialBlock[]): string;
  100073. /**
  100074. * Clone the current block to a new identical block
  100075. * @param scene defines the hosting scene
  100076. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  100077. * @returns a copy of the current block
  100078. */
  100079. clone(scene: Scene, rootUrl?: string): Nullable<NodeMaterialBlock>;
  100080. /**
  100081. * Serializes this block in a JSON representation
  100082. * @returns the serialized block object
  100083. */
  100084. serialize(): any;
  100085. /** @hidden */
  100086. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  100087. private _deserializePortDisplayNamesAndExposedOnFrame;
  100088. /**
  100089. * Release resources
  100090. */
  100091. dispose(): void;
  100092. }
  100093. }
  100094. declare module BABYLON {
  100095. /**
  100096. * Base class of materials working in push mode in babylon JS
  100097. * @hidden
  100098. */
  100099. export class PushMaterial extends Material {
  100100. protected _activeEffect: Effect;
  100101. protected _normalMatrix: Matrix;
  100102. constructor(name: string, scene: Scene);
  100103. getEffect(): Effect;
  100104. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  100105. protected _isReadyForSubMesh(subMesh: SubMesh): boolean;
  100106. /**
  100107. * Binds the given world matrix to the active effect
  100108. *
  100109. * @param world the matrix to bind
  100110. */
  100111. bindOnlyWorldMatrix(world: Matrix): void;
  100112. /**
  100113. * Binds the given normal matrix to the active effect
  100114. *
  100115. * @param normalMatrix the matrix to bind
  100116. */
  100117. bindOnlyNormalMatrix(normalMatrix: Matrix): void;
  100118. bind(world: Matrix, mesh?: Mesh): void;
  100119. protected _afterBind(mesh: Mesh, effect?: Nullable<Effect>): void;
  100120. protected _mustRebind(scene: Scene, effect: Effect, visibility?: number): boolean;
  100121. }
  100122. }
  100123. declare module BABYLON {
  100124. /**
  100125. * Root class for all node material optimizers
  100126. */
  100127. export class NodeMaterialOptimizer {
  100128. /**
  100129. * Function used to optimize a NodeMaterial graph
  100130. * @param vertexOutputNodes defines the list of output nodes for the vertex shader
  100131. * @param fragmentOutputNodes defines the list of output nodes for the fragment shader
  100132. */
  100133. optimize(vertexOutputNodes: NodeMaterialBlock[], fragmentOutputNodes: NodeMaterialBlock[]): void;
  100134. }
  100135. }
  100136. declare module BABYLON {
  100137. /**
  100138. * Block used to transform a vector (2, 3 or 4) with a matrix. It will generate a Vector4
  100139. */
  100140. export class TransformBlock extends NodeMaterialBlock {
  100141. /**
  100142. * Defines the value to use to complement W value to transform it to a Vector4
  100143. */
  100144. complementW: number;
  100145. /**
  100146. * Defines the value to use to complement z value to transform it to a Vector4
  100147. */
  100148. complementZ: number;
  100149. /**
  100150. * Creates a new TransformBlock
  100151. * @param name defines the block name
  100152. */
  100153. constructor(name: string);
  100154. /**
  100155. * Gets the current class name
  100156. * @returns the class name
  100157. */
  100158. getClassName(): string;
  100159. /**
  100160. * Gets the vector input
  100161. */
  100162. get vector(): NodeMaterialConnectionPoint;
  100163. /**
  100164. * Gets the output component
  100165. */
  100166. get output(): NodeMaterialConnectionPoint;
  100167. /**
  100168. * Gets the xyz output component
  100169. */
  100170. get xyz(): NodeMaterialConnectionPoint;
  100171. /**
  100172. * Gets the matrix transform input
  100173. */
  100174. get transform(): NodeMaterialConnectionPoint;
  100175. protected _buildBlock(state: NodeMaterialBuildState): this;
  100176. /**
  100177. * Update defines for shader compilation
  100178. * @param mesh defines the mesh to be rendered
  100179. * @param nodeMaterial defines the node material requesting the update
  100180. * @param defines defines the material defines to update
  100181. * @param useInstances specifies that instances should be used
  100182. * @param subMesh defines which submesh to render
  100183. */
  100184. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean, subMesh?: SubMesh): void;
  100185. serialize(): any;
  100186. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  100187. protected _dumpPropertiesCode(): string;
  100188. }
  100189. }
  100190. declare module BABYLON {
  100191. /**
  100192. * Block used to output the vertex position
  100193. */
  100194. export class VertexOutputBlock extends NodeMaterialBlock {
  100195. /**
  100196. * Creates a new VertexOutputBlock
  100197. * @param name defines the block name
  100198. */
  100199. constructor(name: string);
  100200. /**
  100201. * Gets the current class name
  100202. * @returns the class name
  100203. */
  100204. getClassName(): string;
  100205. /**
  100206. * Gets the vector input component
  100207. */
  100208. get vector(): NodeMaterialConnectionPoint;
  100209. protected _buildBlock(state: NodeMaterialBuildState): this;
  100210. }
  100211. }
  100212. declare module BABYLON {
  100213. /**
  100214. * Block used to output the final color
  100215. */
  100216. export class FragmentOutputBlock extends NodeMaterialBlock {
  100217. /**
  100218. * Create a new FragmentOutputBlock
  100219. * @param name defines the block name
  100220. */
  100221. constructor(name: string);
  100222. /**
  100223. * Gets the current class name
  100224. * @returns the class name
  100225. */
  100226. getClassName(): string;
  100227. /**
  100228. * Gets the rgba input component
  100229. */
  100230. get rgba(): NodeMaterialConnectionPoint;
  100231. /**
  100232. * Gets the rgb input component
  100233. */
  100234. get rgb(): NodeMaterialConnectionPoint;
  100235. /**
  100236. * Gets the a input component
  100237. */
  100238. get a(): NodeMaterialConnectionPoint;
  100239. protected _buildBlock(state: NodeMaterialBuildState): this;
  100240. }
  100241. }
  100242. declare module BABYLON {
  100243. /**
  100244. * Block used for the particle ramp gradient section
  100245. */
  100246. export class ParticleRampGradientBlock extends NodeMaterialBlock {
  100247. /**
  100248. * Create a new ParticleRampGradientBlock
  100249. * @param name defines the block name
  100250. */
  100251. constructor(name: string);
  100252. /**
  100253. * Gets the current class name
  100254. * @returns the class name
  100255. */
  100256. getClassName(): string;
  100257. /**
  100258. * Gets the color input component
  100259. */
  100260. get color(): NodeMaterialConnectionPoint;
  100261. /**
  100262. * Gets the rampColor output component
  100263. */
  100264. get rampColor(): NodeMaterialConnectionPoint;
  100265. /**
  100266. * Initialize the block and prepare the context for build
  100267. * @param state defines the state that will be used for the build
  100268. */
  100269. initialize(state: NodeMaterialBuildState): void;
  100270. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  100271. }
  100272. }
  100273. declare module BABYLON {
  100274. /**
  100275. * Block used for the particle blend multiply section
  100276. */
  100277. export class ParticleBlendMultiplyBlock extends NodeMaterialBlock {
  100278. /**
  100279. * Create a new ParticleBlendMultiplyBlock
  100280. * @param name defines the block name
  100281. */
  100282. constructor(name: string);
  100283. /**
  100284. * Gets the current class name
  100285. * @returns the class name
  100286. */
  100287. getClassName(): string;
  100288. /**
  100289. * Gets the color input component
  100290. */
  100291. get color(): NodeMaterialConnectionPoint;
  100292. /**
  100293. * Gets the alphaTexture input component
  100294. */
  100295. get alphaTexture(): NodeMaterialConnectionPoint;
  100296. /**
  100297. * Gets the alphaColor input component
  100298. */
  100299. get alphaColor(): NodeMaterialConnectionPoint;
  100300. /**
  100301. * Gets the blendColor output component
  100302. */
  100303. get blendColor(): NodeMaterialConnectionPoint;
  100304. /**
  100305. * Initialize the block and prepare the context for build
  100306. * @param state defines the state that will be used for the build
  100307. */
  100308. initialize(state: NodeMaterialBuildState): void;
  100309. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  100310. }
  100311. }
  100312. declare module BABYLON {
  100313. /**
  100314. * Block used to create a Vector2/3/4 out of individual inputs (one for each component)
  100315. */
  100316. export class VectorMergerBlock extends NodeMaterialBlock {
  100317. /**
  100318. * Create a new VectorMergerBlock
  100319. * @param name defines the block name
  100320. */
  100321. constructor(name: string);
  100322. /**
  100323. * Gets the current class name
  100324. * @returns the class name
  100325. */
  100326. getClassName(): string;
  100327. /**
  100328. * Gets the xyz component (input)
  100329. */
  100330. get xyzIn(): NodeMaterialConnectionPoint;
  100331. /**
  100332. * Gets the xy component (input)
  100333. */
  100334. get xyIn(): NodeMaterialConnectionPoint;
  100335. /**
  100336. * Gets the x component (input)
  100337. */
  100338. get x(): NodeMaterialConnectionPoint;
  100339. /**
  100340. * Gets the y component (input)
  100341. */
  100342. get y(): NodeMaterialConnectionPoint;
  100343. /**
  100344. * Gets the z component (input)
  100345. */
  100346. get z(): NodeMaterialConnectionPoint;
  100347. /**
  100348. * Gets the w component (input)
  100349. */
  100350. get w(): NodeMaterialConnectionPoint;
  100351. /**
  100352. * Gets the xyzw component (output)
  100353. */
  100354. get xyzw(): NodeMaterialConnectionPoint;
  100355. /**
  100356. * Gets the xyz component (output)
  100357. */
  100358. get xyzOut(): NodeMaterialConnectionPoint;
  100359. /**
  100360. * Gets the xy component (output)
  100361. */
  100362. get xyOut(): NodeMaterialConnectionPoint;
  100363. /**
  100364. * Gets the xy component (output)
  100365. * @deprecated Please use xyOut instead.
  100366. */
  100367. get xy(): NodeMaterialConnectionPoint;
  100368. /**
  100369. * Gets the xyz component (output)
  100370. * @deprecated Please use xyzOut instead.
  100371. */
  100372. get xyz(): NodeMaterialConnectionPoint;
  100373. protected _buildBlock(state: NodeMaterialBuildState): this;
  100374. }
  100375. }
  100376. declare module BABYLON {
  100377. /**
  100378. * Block used to remap a float from a range to a new one
  100379. */
  100380. export class RemapBlock extends NodeMaterialBlock {
  100381. /**
  100382. * Gets or sets the source range
  100383. */
  100384. sourceRange: Vector2;
  100385. /**
  100386. * Gets or sets the target range
  100387. */
  100388. targetRange: Vector2;
  100389. /**
  100390. * Creates a new RemapBlock
  100391. * @param name defines the block name
  100392. */
  100393. constructor(name: string);
  100394. /**
  100395. * Gets the current class name
  100396. * @returns the class name
  100397. */
  100398. getClassName(): string;
  100399. /**
  100400. * Gets the input component
  100401. */
  100402. get input(): NodeMaterialConnectionPoint;
  100403. /**
  100404. * Gets the source min input component
  100405. */
  100406. get sourceMin(): NodeMaterialConnectionPoint;
  100407. /**
  100408. * Gets the source max input component
  100409. */
  100410. get sourceMax(): NodeMaterialConnectionPoint;
  100411. /**
  100412. * Gets the target min input component
  100413. */
  100414. get targetMin(): NodeMaterialConnectionPoint;
  100415. /**
  100416. * Gets the target max input component
  100417. */
  100418. get targetMax(): NodeMaterialConnectionPoint;
  100419. /**
  100420. * Gets the output component
  100421. */
  100422. get output(): NodeMaterialConnectionPoint;
  100423. protected _buildBlock(state: NodeMaterialBuildState): this;
  100424. protected _dumpPropertiesCode(): string;
  100425. serialize(): any;
  100426. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  100427. }
  100428. }
  100429. declare module BABYLON {
  100430. /**
  100431. * Block used to multiply 2 values
  100432. */
  100433. export class MultiplyBlock extends NodeMaterialBlock {
  100434. /**
  100435. * Creates a new MultiplyBlock
  100436. * @param name defines the block name
  100437. */
  100438. constructor(name: string);
  100439. /**
  100440. * Gets the current class name
  100441. * @returns the class name
  100442. */
  100443. getClassName(): string;
  100444. /**
  100445. * Gets the left operand input component
  100446. */
  100447. get left(): NodeMaterialConnectionPoint;
  100448. /**
  100449. * Gets the right operand input component
  100450. */
  100451. get right(): NodeMaterialConnectionPoint;
  100452. /**
  100453. * Gets the output component
  100454. */
  100455. get output(): NodeMaterialConnectionPoint;
  100456. protected _buildBlock(state: NodeMaterialBuildState): this;
  100457. }
  100458. }
  100459. declare module BABYLON {
  100460. /**
  100461. * Block used to expand a Color3/4 into 4 outputs (one for each component)
  100462. */
  100463. export class ColorSplitterBlock extends NodeMaterialBlock {
  100464. /**
  100465. * Create a new ColorSplitterBlock
  100466. * @param name defines the block name
  100467. */
  100468. constructor(name: string);
  100469. /**
  100470. * Gets the current class name
  100471. * @returns the class name
  100472. */
  100473. getClassName(): string;
  100474. /**
  100475. * Gets the rgba component (input)
  100476. */
  100477. get rgba(): NodeMaterialConnectionPoint;
  100478. /**
  100479. * Gets the rgb component (input)
  100480. */
  100481. get rgbIn(): NodeMaterialConnectionPoint;
  100482. /**
  100483. * Gets the rgb component (output)
  100484. */
  100485. get rgbOut(): NodeMaterialConnectionPoint;
  100486. /**
  100487. * Gets the r component (output)
  100488. */
  100489. get r(): NodeMaterialConnectionPoint;
  100490. /**
  100491. * Gets the g component (output)
  100492. */
  100493. get g(): NodeMaterialConnectionPoint;
  100494. /**
  100495. * Gets the b component (output)
  100496. */
  100497. get b(): NodeMaterialConnectionPoint;
  100498. /**
  100499. * Gets the a component (output)
  100500. */
  100501. get a(): NodeMaterialConnectionPoint;
  100502. protected _inputRename(name: string): string;
  100503. protected _outputRename(name: string): string;
  100504. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  100505. }
  100506. }
  100507. declare module BABYLON {
  100508. /**
  100509. * Interface used to configure the node material editor
  100510. */
  100511. export interface INodeMaterialEditorOptions {
  100512. /** Define the URl to load node editor script */
  100513. editorURL?: string;
  100514. }
  100515. /** @hidden */
  100516. export class NodeMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  100517. NORMAL: boolean;
  100518. TANGENT: boolean;
  100519. UV1: boolean;
  100520. /** BONES */
  100521. NUM_BONE_INFLUENCERS: number;
  100522. BonesPerMesh: number;
  100523. BONETEXTURE: boolean;
  100524. /** MORPH TARGETS */
  100525. MORPHTARGETS: boolean;
  100526. MORPHTARGETS_NORMAL: boolean;
  100527. MORPHTARGETS_TANGENT: boolean;
  100528. MORPHTARGETS_UV: boolean;
  100529. NUM_MORPH_INFLUENCERS: number;
  100530. /** IMAGE PROCESSING */
  100531. IMAGEPROCESSING: boolean;
  100532. VIGNETTE: boolean;
  100533. VIGNETTEBLENDMODEMULTIPLY: boolean;
  100534. VIGNETTEBLENDMODEOPAQUE: boolean;
  100535. TONEMAPPING: boolean;
  100536. TONEMAPPING_ACES: boolean;
  100537. CONTRAST: boolean;
  100538. EXPOSURE: boolean;
  100539. COLORCURVES: boolean;
  100540. COLORGRADING: boolean;
  100541. COLORGRADING3D: boolean;
  100542. SAMPLER3DGREENDEPTH: boolean;
  100543. SAMPLER3DBGRMAP: boolean;
  100544. IMAGEPROCESSINGPOSTPROCESS: boolean;
  100545. /** MISC. */
  100546. BUMPDIRECTUV: number;
  100547. constructor();
  100548. setValue(name: string, value: any, markAsUnprocessedIfDirty?: boolean): void;
  100549. }
  100550. /**
  100551. * Class used to configure NodeMaterial
  100552. */
  100553. export interface INodeMaterialOptions {
  100554. /**
  100555. * Defines if blocks should emit comments
  100556. */
  100557. emitComments: boolean;
  100558. }
  100559. /**
  100560. * Class used to create a node based material built by assembling shader blocks
  100561. */
  100562. export class NodeMaterial extends PushMaterial {
  100563. private static _BuildIdGenerator;
  100564. private _options;
  100565. private _vertexCompilationState;
  100566. private _fragmentCompilationState;
  100567. private _sharedData;
  100568. private _buildId;
  100569. private _buildWasSuccessful;
  100570. private _cachedWorldViewMatrix;
  100571. private _cachedWorldViewProjectionMatrix;
  100572. private _optimizers;
  100573. private _animationFrame;
  100574. /** Define the Url to load node editor script */
  100575. static EditorURL: string;
  100576. /** Define the Url to load snippets */
  100577. static SnippetUrl: string;
  100578. /** Gets or sets a boolean indicating that node materials should not deserialize textures from json / snippet content */
  100579. static IgnoreTexturesAtLoadTime: boolean;
  100580. private BJSNODEMATERIALEDITOR;
  100581. /** Get the inspector from bundle or global */
  100582. private _getGlobalNodeMaterialEditor;
  100583. /**
  100584. * Snippet ID if the material was created from the snippet server
  100585. */
  100586. snippetId: string;
  100587. /**
  100588. * Gets or sets data used by visual editor
  100589. * @see https://nme.babylonjs.com
  100590. */
  100591. editorData: any;
  100592. /**
  100593. * 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)
  100594. */
  100595. ignoreAlpha: boolean;
  100596. /**
  100597. * Defines the maximum number of lights that can be used in the material
  100598. */
  100599. maxSimultaneousLights: number;
  100600. /**
  100601. * Observable raised when the material is built
  100602. */
  100603. onBuildObservable: Observable<NodeMaterial>;
  100604. /**
  100605. * Gets or sets the root nodes of the material vertex shader
  100606. */
  100607. _vertexOutputNodes: NodeMaterialBlock[];
  100608. /**
  100609. * Gets or sets the root nodes of the material fragment (pixel) shader
  100610. */
  100611. _fragmentOutputNodes: NodeMaterialBlock[];
  100612. /** Gets or sets options to control the node material overall behavior */
  100613. get options(): INodeMaterialOptions;
  100614. set options(options: INodeMaterialOptions);
  100615. /**
  100616. * Default configuration related to image processing available in the standard Material.
  100617. */
  100618. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  100619. /**
  100620. * Gets the image processing configuration used either in this material.
  100621. */
  100622. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  100623. /**
  100624. * Sets the Default image processing configuration used either in the this material.
  100625. *
  100626. * If sets to null, the scene one is in use.
  100627. */
  100628. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  100629. /**
  100630. * Gets an array of blocks that needs to be serialized even if they are not yet connected
  100631. */
  100632. attachedBlocks: NodeMaterialBlock[];
  100633. /**
  100634. * Specifies the mode of the node material
  100635. * @hidden
  100636. */
  100637. _mode: NodeMaterialModes;
  100638. /**
  100639. * Gets the mode property
  100640. */
  100641. get mode(): NodeMaterialModes;
  100642. /**
  100643. * Create a new node based material
  100644. * @param name defines the material name
  100645. * @param scene defines the hosting scene
  100646. * @param options defines creation option
  100647. */
  100648. constructor(name: string, scene?: Scene, options?: Partial<INodeMaterialOptions>);
  100649. /**
  100650. * Gets the current class name of the material e.g. "NodeMaterial"
  100651. * @returns the class name
  100652. */
  100653. getClassName(): string;
  100654. /**
  100655. * Keep track of the image processing observer to allow dispose and replace.
  100656. */
  100657. private _imageProcessingObserver;
  100658. /**
  100659. * Attaches a new image processing configuration to the Standard Material.
  100660. * @param configuration
  100661. */
  100662. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  100663. /**
  100664. * Get a block by its name
  100665. * @param name defines the name of the block to retrieve
  100666. * @returns the required block or null if not found
  100667. */
  100668. getBlockByName(name: string): Nullable<NodeMaterialBlock>;
  100669. /**
  100670. * Get a block by its name
  100671. * @param predicate defines the predicate used to find the good candidate
  100672. * @returns the required block or null if not found
  100673. */
  100674. getBlockByPredicate(predicate: (block: NodeMaterialBlock) => boolean): Nullable<NodeMaterialBlock>;
  100675. /**
  100676. * Get an input block by its name
  100677. * @param predicate defines the predicate used to find the good candidate
  100678. * @returns the required input block or null if not found
  100679. */
  100680. getInputBlockByPredicate(predicate: (block: InputBlock) => boolean): Nullable<InputBlock>;
  100681. /**
  100682. * Gets the list of input blocks attached to this material
  100683. * @returns an array of InputBlocks
  100684. */
  100685. getInputBlocks(): InputBlock[];
  100686. /**
  100687. * Adds a new optimizer to the list of optimizers
  100688. * @param optimizer defines the optimizers to add
  100689. * @returns the current material
  100690. */
  100691. registerOptimizer(optimizer: NodeMaterialOptimizer): this | undefined;
  100692. /**
  100693. * Remove an optimizer from the list of optimizers
  100694. * @param optimizer defines the optimizers to remove
  100695. * @returns the current material
  100696. */
  100697. unregisterOptimizer(optimizer: NodeMaterialOptimizer): this | undefined;
  100698. /**
  100699. * Add a new block to the list of output nodes
  100700. * @param node defines the node to add
  100701. * @returns the current material
  100702. */
  100703. addOutputNode(node: NodeMaterialBlock): this;
  100704. /**
  100705. * Remove a block from the list of root nodes
  100706. * @param node defines the node to remove
  100707. * @returns the current material
  100708. */
  100709. removeOutputNode(node: NodeMaterialBlock): this;
  100710. private _addVertexOutputNode;
  100711. private _removeVertexOutputNode;
  100712. private _addFragmentOutputNode;
  100713. private _removeFragmentOutputNode;
  100714. /**
  100715. * Specifies if the material will require alpha blending
  100716. * @returns a boolean specifying if alpha blending is needed
  100717. */
  100718. needAlphaBlending(): boolean;
  100719. /**
  100720. * Specifies if this material should be rendered in alpha test mode
  100721. * @returns a boolean specifying if an alpha test is needed.
  100722. */
  100723. needAlphaTesting(): boolean;
  100724. private _initializeBlock;
  100725. private _resetDualBlocks;
  100726. /**
  100727. * Remove a block from the current node material
  100728. * @param block defines the block to remove
  100729. */
  100730. removeBlock(block: NodeMaterialBlock): void;
  100731. /**
  100732. * Build the material and generates the inner effect
  100733. * @param verbose defines if the build should log activity
  100734. */
  100735. build(verbose?: boolean): void;
  100736. /**
  100737. * Runs an otpimization phase to try to improve the shader code
  100738. */
  100739. optimize(): void;
  100740. private _prepareDefinesForAttributes;
  100741. /**
  100742. * Create a post process from the material
  100743. * @param camera The camera to apply the render pass to.
  100744. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  100745. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  100746. * @param engine The engine which the post process will be applied. (default: current engine)
  100747. * @param reusable If the post process can be reused on the same frame. (default: false)
  100748. * @param textureType Type of textures used when performing the post process. (default: 0)
  100749. * @param textureFormat Format of textures used when performing the post process. (default: TEXTUREFORMAT_RGBA)
  100750. * @returns the post process created
  100751. */
  100752. createPostProcess(camera: Nullable<Camera>, options?: number | PostProcessOptions, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, textureFormat?: number): PostProcess;
  100753. /**
  100754. * Create the post process effect from the material
  100755. * @param postProcess The post process to create the effect for
  100756. */
  100757. createEffectForPostProcess(postProcess: PostProcess): void;
  100758. private _createEffectOrPostProcess;
  100759. private _createEffectForParticles;
  100760. /**
  100761. * Create the effect to be used as the custom effect for a particle system
  100762. * @param particleSystem Particle system to create the effect for
  100763. * @param onCompiled defines a function to call when the effect creation is successful
  100764. * @param onError defines a function to call when the effect creation has failed
  100765. */
  100766. createEffectForParticles(particleSystem: IParticleSystem, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  100767. private _processDefines;
  100768. /**
  100769. * Get if the submesh is ready to be used and all its information available.
  100770. * Child classes can use it to update shaders
  100771. * @param mesh defines the mesh to check
  100772. * @param subMesh defines which submesh to check
  100773. * @param useInstances specifies that instances should be used
  100774. * @returns a boolean indicating that the submesh is ready or not
  100775. */
  100776. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  100777. /**
  100778. * Get a string representing the shaders built by the current node graph
  100779. */
  100780. get compiledShaders(): string;
  100781. /**
  100782. * Binds the world matrix to the material
  100783. * @param world defines the world transformation matrix
  100784. */
  100785. bindOnlyWorldMatrix(world: Matrix): void;
  100786. /**
  100787. * Binds the submesh to this material by preparing the effect and shader to draw
  100788. * @param world defines the world transformation matrix
  100789. * @param mesh defines the mesh containing the submesh
  100790. * @param subMesh defines the submesh to bind the material to
  100791. */
  100792. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  100793. /**
  100794. * Gets the active textures from the material
  100795. * @returns an array of textures
  100796. */
  100797. getActiveTextures(): BaseTexture[];
  100798. /**
  100799. * Gets the list of texture blocks
  100800. * @returns an array of texture blocks
  100801. */
  100802. getTextureBlocks(): (TextureBlock | ReflectionTextureBaseBlock | RefractionBlock | CurrentScreenBlock | ParticleTextureBlock)[];
  100803. /**
  100804. * Specifies if the material uses a texture
  100805. * @param texture defines the texture to check against the material
  100806. * @returns a boolean specifying if the material uses the texture
  100807. */
  100808. hasTexture(texture: BaseTexture): boolean;
  100809. /**
  100810. * Disposes the material
  100811. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  100812. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  100813. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  100814. */
  100815. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  100816. /** Creates the node editor window. */
  100817. private _createNodeEditor;
  100818. /**
  100819. * Launch the node material editor
  100820. * @param config Define the configuration of the editor
  100821. * @return a promise fulfilled when the node editor is visible
  100822. */
  100823. edit(config?: INodeMaterialEditorOptions): Promise<void>;
  100824. /**
  100825. * Clear the current material
  100826. */
  100827. clear(): void;
  100828. /**
  100829. * Clear the current material and set it to a default state
  100830. */
  100831. setToDefault(): void;
  100832. /**
  100833. * Clear the current material and set it to a default state for post process
  100834. */
  100835. setToDefaultPostProcess(): void;
  100836. /**
  100837. * Clear the current material and set it to a default state for particle
  100838. */
  100839. setToDefaultParticle(): void;
  100840. /**
  100841. * Loads the current Node Material from a url pointing to a file save by the Node Material Editor
  100842. * @param url defines the url to load from
  100843. * @returns a promise that will fullfil when the material is fully loaded
  100844. */
  100845. loadAsync(url: string): Promise<void>;
  100846. private _gatherBlocks;
  100847. /**
  100848. * Generate a string containing the code declaration required to create an equivalent of this material
  100849. * @returns a string
  100850. */
  100851. generateCode(): string;
  100852. /**
  100853. * Serializes this material in a JSON representation
  100854. * @returns the serialized material object
  100855. */
  100856. serialize(selectedBlocks?: NodeMaterialBlock[]): any;
  100857. private _restoreConnections;
  100858. /**
  100859. * Clear the current graph and load a new one from a serialization object
  100860. * @param source defines the JSON representation of the material
  100861. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  100862. * @param merge defines whether or not the source must be merged or replace the current content
  100863. */
  100864. loadFromSerialization(source: any, rootUrl?: string, merge?: boolean): void;
  100865. /**
  100866. * Makes a duplicate of the current material.
  100867. * @param name - name to use for the new material.
  100868. */
  100869. clone(name: string): NodeMaterial;
  100870. /**
  100871. * Creates a node material from parsed material data
  100872. * @param source defines the JSON representation of the material
  100873. * @param scene defines the hosting scene
  100874. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  100875. * @returns a new node material
  100876. */
  100877. static Parse(source: any, scene: Scene, rootUrl?: string): NodeMaterial;
  100878. /**
  100879. * Creates a node material from a snippet saved in a remote file
  100880. * @param name defines the name of the material to create
  100881. * @param url defines the url to load from
  100882. * @param scene defines the hosting scene
  100883. * @returns a promise that will resolve to the new node material
  100884. */
  100885. static ParseFromFileAsync(name: string, url: string, scene: Scene): Promise<NodeMaterial>;
  100886. /**
  100887. * Creates a node material from a snippet saved by the node material editor
  100888. * @param snippetId defines the snippet to load
  100889. * @param scene defines the hosting scene
  100890. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  100891. * @param nodeMaterial defines a node material to update (instead of creating a new one)
  100892. * @returns a promise that will resolve to the new node material
  100893. */
  100894. static ParseFromSnippetAsync(snippetId: string, scene: Scene, rootUrl?: string, nodeMaterial?: NodeMaterial): Promise<NodeMaterial>;
  100895. /**
  100896. * Creates a new node material set to default basic configuration
  100897. * @param name defines the name of the material
  100898. * @param scene defines the hosting scene
  100899. * @returns a new NodeMaterial
  100900. */
  100901. static CreateDefault(name: string, scene?: Scene): NodeMaterial;
  100902. }
  100903. }
  100904. declare module BABYLON {
  100905. /**
  100906. * Size options for a post process
  100907. */
  100908. export type PostProcessOptions = {
  100909. width: number;
  100910. height: number;
  100911. };
  100912. /**
  100913. * PostProcess can be used to apply a shader to a texture after it has been rendered
  100914. * See https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  100915. */
  100916. export class PostProcess {
  100917. /** Name of the PostProcess. */
  100918. name: string;
  100919. /**
  100920. * Gets or sets the unique id of the post process
  100921. */
  100922. uniqueId: number;
  100923. /**
  100924. * Width of the texture to apply the post process on
  100925. */
  100926. width: number;
  100927. /**
  100928. * Height of the texture to apply the post process on
  100929. */
  100930. height: number;
  100931. /**
  100932. * Gets the node material used to create this postprocess (null if the postprocess was manually created)
  100933. */
  100934. nodeMaterialSource: Nullable<NodeMaterial>;
  100935. /**
  100936. * Internal, reference to the location where this postprocess was output to. (Typically the texture on the next postprocess in the chain)
  100937. * @hidden
  100938. */
  100939. _outputTexture: Nullable<InternalTexture>;
  100940. /**
  100941. * Sampling mode used by the shader
  100942. * See https://doc.babylonjs.com/classes/3.1/texture
  100943. */
  100944. renderTargetSamplingMode: number;
  100945. /**
  100946. * Clear color to use when screen clearing
  100947. */
  100948. clearColor: Color4;
  100949. /**
  100950. * If the buffer needs to be cleared before applying the post process. (default: true)
  100951. * Should be set to false if shader will overwrite all previous pixels.
  100952. */
  100953. autoClear: boolean;
  100954. /**
  100955. * Type of alpha mode to use when performing the post process (default: Engine.ALPHA_DISABLE)
  100956. */
  100957. alphaMode: number;
  100958. /**
  100959. * Sets the setAlphaBlendConstants of the babylon engine
  100960. */
  100961. alphaConstants: Color4;
  100962. /**
  100963. * Animations to be used for the post processing
  100964. */
  100965. animations: Animation[];
  100966. /**
  100967. * Enable Pixel Perfect mode where texture is not scaled to be power of 2.
  100968. * Can only be used on a single postprocess or on the last one of a chain. (default: false)
  100969. */
  100970. enablePixelPerfectMode: boolean;
  100971. /**
  100972. * Force the postprocess to be applied without taking in account viewport
  100973. */
  100974. forceFullscreenViewport: boolean;
  100975. /**
  100976. * List of inspectable custom properties (used by the Inspector)
  100977. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  100978. */
  100979. inspectableCustomProperties: IInspectable[];
  100980. /**
  100981. * Scale mode for the post process (default: Engine.SCALEMODE_FLOOR)
  100982. *
  100983. * | Value | Type | Description |
  100984. * | ----- | ----------------------------------- | ----------- |
  100985. * | 1 | SCALEMODE_FLOOR | [engine.scalemode_floor](https://doc.babylonjs.com/api/classes/babylon.engine#scalemode_floor) |
  100986. * | 2 | SCALEMODE_NEAREST | [engine.scalemode_nearest](https://doc.babylonjs.com/api/classes/babylon.engine#scalemode_nearest) |
  100987. * | 3 | SCALEMODE_CEILING | [engine.scalemode_ceiling](https://doc.babylonjs.com/api/classes/babylon.engine#scalemode_ceiling) |
  100988. *
  100989. */
  100990. scaleMode: number;
  100991. /**
  100992. * Force textures to be a power of two (default: false)
  100993. */
  100994. alwaysForcePOT: boolean;
  100995. private _samples;
  100996. /**
  100997. * Number of sample textures (default: 1)
  100998. */
  100999. get samples(): number;
  101000. set samples(n: number);
  101001. /**
  101002. * Modify the scale of the post process to be the same as the viewport (default: false)
  101003. */
  101004. adaptScaleToCurrentViewport: boolean;
  101005. private _camera;
  101006. protected _scene: Scene;
  101007. private _engine;
  101008. private _options;
  101009. private _reusable;
  101010. private _textureType;
  101011. private _textureFormat;
  101012. /**
  101013. * Smart array of input and output textures for the post process.
  101014. * @hidden
  101015. */
  101016. _textures: SmartArray<InternalTexture>;
  101017. /**
  101018. * The index in _textures that corresponds to the output texture.
  101019. * @hidden
  101020. */
  101021. _currentRenderTextureInd: number;
  101022. private _effect;
  101023. private _samplers;
  101024. private _fragmentUrl;
  101025. private _vertexUrl;
  101026. private _parameters;
  101027. private _scaleRatio;
  101028. protected _indexParameters: any;
  101029. private _shareOutputWithPostProcess;
  101030. private _texelSize;
  101031. private _forcedOutputTexture;
  101032. /**
  101033. * Returns the fragment url or shader name used in the post process.
  101034. * @returns the fragment url or name in the shader store.
  101035. */
  101036. getEffectName(): string;
  101037. /**
  101038. * An event triggered when the postprocess is activated.
  101039. */
  101040. onActivateObservable: Observable<Camera>;
  101041. private _onActivateObserver;
  101042. /**
  101043. * A function that is added to the onActivateObservable
  101044. */
  101045. set onActivate(callback: Nullable<(camera: Camera) => void>);
  101046. /**
  101047. * An event triggered when the postprocess changes its size.
  101048. */
  101049. onSizeChangedObservable: Observable<PostProcess>;
  101050. private _onSizeChangedObserver;
  101051. /**
  101052. * A function that is added to the onSizeChangedObservable
  101053. */
  101054. set onSizeChanged(callback: (postProcess: PostProcess) => void);
  101055. /**
  101056. * An event triggered when the postprocess applies its effect.
  101057. */
  101058. onApplyObservable: Observable<Effect>;
  101059. private _onApplyObserver;
  101060. /**
  101061. * A function that is added to the onApplyObservable
  101062. */
  101063. set onApply(callback: (effect: Effect) => void);
  101064. /**
  101065. * An event triggered before rendering the postprocess
  101066. */
  101067. onBeforeRenderObservable: Observable<Effect>;
  101068. private _onBeforeRenderObserver;
  101069. /**
  101070. * A function that is added to the onBeforeRenderObservable
  101071. */
  101072. set onBeforeRender(callback: (effect: Effect) => void);
  101073. /**
  101074. * An event triggered after rendering the postprocess
  101075. */
  101076. onAfterRenderObservable: Observable<Effect>;
  101077. private _onAfterRenderObserver;
  101078. /**
  101079. * A function that is added to the onAfterRenderObservable
  101080. */
  101081. set onAfterRender(callback: (efect: Effect) => void);
  101082. /**
  101083. * 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
  101084. * render it's output into this texture and this texture will be used as textureSampler in the fragment shader of this post process.
  101085. */
  101086. get inputTexture(): InternalTexture;
  101087. set inputTexture(value: InternalTexture);
  101088. /**
  101089. * Since inputTexture should always be defined, if we previously manually set `inputTexture`,
  101090. * the only way to unset it is to use this function to restore its internal state
  101091. */
  101092. restoreDefaultInputTexture(): void;
  101093. /**
  101094. * Gets the camera which post process is applied to.
  101095. * @returns The camera the post process is applied to.
  101096. */
  101097. getCamera(): Camera;
  101098. /**
  101099. * Gets the texel size of the postprocess.
  101100. * See https://en.wikipedia.org/wiki/Texel_(graphics)
  101101. */
  101102. get texelSize(): Vector2;
  101103. /**
  101104. * Creates a new instance PostProcess
  101105. * @param name The name of the PostProcess.
  101106. * @param fragmentUrl The url of the fragment shader to be used.
  101107. * @param parameters Array of the names of uniform non-sampler2D variables that will be passed to the shader.
  101108. * @param samplers Array of the names of uniform sampler2D variables that will be passed to the shader.
  101109. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  101110. * @param camera The camera to apply the render pass to.
  101111. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  101112. * @param engine The engine which the post process will be applied. (default: current engine)
  101113. * @param reusable If the post process can be reused on the same frame. (default: false)
  101114. * @param defines String of defines that will be set when running the fragment shader. (default: null)
  101115. * @param textureType Type of textures used when performing the post process. (default: 0)
  101116. * @param vertexUrl The url of the vertex shader to be used. (default: "postprocess")
  101117. * @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
  101118. * @param blockCompilation If the shader should not be compiled imediatly. (default: false)
  101119. * @param textureFormat Format of textures used when performing the post process. (default: TEXTUREFORMAT_RGBA)
  101120. */
  101121. constructor(
  101122. /** Name of the PostProcess. */
  101123. 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);
  101124. /**
  101125. * Gets a string idenfifying the name of the class
  101126. * @returns "PostProcess" string
  101127. */
  101128. getClassName(): string;
  101129. /**
  101130. * Gets the engine which this post process belongs to.
  101131. * @returns The engine the post process was enabled with.
  101132. */
  101133. getEngine(): Engine;
  101134. /**
  101135. * The effect that is created when initializing the post process.
  101136. * @returns The created effect corresponding the the postprocess.
  101137. */
  101138. getEffect(): Effect;
  101139. /**
  101140. * To avoid multiple redundant textures for multiple post process, the output the output texture for this post process can be shared with another.
  101141. * @param postProcess The post process to share the output with.
  101142. * @returns This post process.
  101143. */
  101144. shareOutputWith(postProcess: PostProcess): PostProcess;
  101145. /**
  101146. * Reverses the effect of calling shareOutputWith and returns the post process back to its original state.
  101147. * This should be called if the post process that shares output with this post process is disabled/disposed.
  101148. */
  101149. useOwnOutput(): void;
  101150. /**
  101151. * Updates the effect with the current post process compile time values and recompiles the shader.
  101152. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  101153. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  101154. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  101155. * @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
  101156. * @param onCompiled Called when the shader has been compiled.
  101157. * @param onError Called if there is an error when compiling a shader.
  101158. * @param vertexUrl The url of the vertex shader to be used (default: the one given at construction time)
  101159. * @param fragmentUrl The url of the fragment shader to be used (default: the one given at construction time)
  101160. */
  101161. 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;
  101162. /**
  101163. * The post process is reusable if it can be used multiple times within one frame.
  101164. * @returns If the post process is reusable
  101165. */
  101166. isReusable(): boolean;
  101167. /** invalidate frameBuffer to hint the postprocess to create a depth buffer */
  101168. markTextureDirty(): void;
  101169. /**
  101170. * Activates the post process by intializing the textures to be used when executed. Notifies onActivateObservable.
  101171. * 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.
  101172. * @param camera The camera that will be used in the post process. This camera will be used when calling onActivateObservable.
  101173. * @param sourceTexture The source texture to be inspected to get the width and height if not specified in the post process constructor. (default: null)
  101174. * @param forceDepthStencil If true, a depth and stencil buffer will be generated. (default: false)
  101175. * @returns The target texture that was bound to be written to.
  101176. */
  101177. activate(camera: Nullable<Camera>, sourceTexture?: Nullable<InternalTexture>, forceDepthStencil?: boolean): InternalTexture;
  101178. /**
  101179. * If the post process is supported.
  101180. */
  101181. get isSupported(): boolean;
  101182. /**
  101183. * The aspect ratio of the output texture.
  101184. */
  101185. get aspectRatio(): number;
  101186. /**
  101187. * Get a value indicating if the post-process is ready to be used
  101188. * @returns true if the post-process is ready (shader is compiled)
  101189. */
  101190. isReady(): boolean;
  101191. /**
  101192. * Binds all textures and uniforms to the shader, this will be run on every pass.
  101193. * @returns the effect corresponding to this post process. Null if not compiled or not ready.
  101194. */
  101195. apply(): Nullable<Effect>;
  101196. private _disposeTextures;
  101197. /**
  101198. * Disposes the post process.
  101199. * @param camera The camera to dispose the post process on.
  101200. */
  101201. dispose(camera?: Camera): void;
  101202. }
  101203. }
  101204. declare module BABYLON {
  101205. /** @hidden */
  101206. export var kernelBlurVaryingDeclaration: {
  101207. name: string;
  101208. shader: string;
  101209. };
  101210. }
  101211. declare module BABYLON {
  101212. /** @hidden */
  101213. export var kernelBlurFragment: {
  101214. name: string;
  101215. shader: string;
  101216. };
  101217. }
  101218. declare module BABYLON {
  101219. /** @hidden */
  101220. export var kernelBlurFragment2: {
  101221. name: string;
  101222. shader: string;
  101223. };
  101224. }
  101225. declare module BABYLON {
  101226. /** @hidden */
  101227. export var kernelBlurPixelShader: {
  101228. name: string;
  101229. shader: string;
  101230. };
  101231. }
  101232. declare module BABYLON {
  101233. /** @hidden */
  101234. export var kernelBlurVertex: {
  101235. name: string;
  101236. shader: string;
  101237. };
  101238. }
  101239. declare module BABYLON {
  101240. /** @hidden */
  101241. export var kernelBlurVertexShader: {
  101242. name: string;
  101243. shader: string;
  101244. };
  101245. }
  101246. declare module BABYLON {
  101247. /**
  101248. * The Blur Post Process which blurs an image based on a kernel and direction.
  101249. * Can be used twice in x and y directions to perform a guassian blur in two passes.
  101250. */
  101251. export class BlurPostProcess extends PostProcess {
  101252. /** The direction in which to blur the image. */
  101253. direction: Vector2;
  101254. private blockCompilation;
  101255. protected _kernel: number;
  101256. protected _idealKernel: number;
  101257. protected _packedFloat: boolean;
  101258. private _staticDefines;
  101259. /**
  101260. * Sets the length in pixels of the blur sample region
  101261. */
  101262. set kernel(v: number);
  101263. /**
  101264. * Gets the length in pixels of the blur sample region
  101265. */
  101266. get kernel(): number;
  101267. /**
  101268. * Sets wether or not the blur needs to unpack/repack floats
  101269. */
  101270. set packedFloat(v: boolean);
  101271. /**
  101272. * Gets wether or not the blur is unpacking/repacking floats
  101273. */
  101274. get packedFloat(): boolean;
  101275. /**
  101276. * Creates a new instance BlurPostProcess
  101277. * @param name The name of the effect.
  101278. * @param direction The direction in which to blur the image.
  101279. * @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.
  101280. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  101281. * @param camera The camera to apply the render pass to.
  101282. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  101283. * @param engine The engine which the post process will be applied. (default: current engine)
  101284. * @param reusable If the post process can be reused on the same frame. (default: false)
  101285. * @param textureType Type of textures used when performing the post process. (default: 0)
  101286. * @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)
  101287. */
  101288. constructor(name: string,
  101289. /** The direction in which to blur the image. */
  101290. direction: Vector2, kernel: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, defines?: string, blockCompilation?: boolean);
  101291. /**
  101292. * Updates the effect with the current post process compile time values and recompiles the shader.
  101293. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  101294. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  101295. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  101296. * @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
  101297. * @param onCompiled Called when the shader has been compiled.
  101298. * @param onError Called if there is an error when compiling a shader.
  101299. */
  101300. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  101301. protected _updateParameters(onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  101302. /**
  101303. * Best kernels are odd numbers that when divided by 2, their integer part is even, so 5, 9 or 13.
  101304. * Other odd kernels optimize correctly but require proportionally more samples, even kernels are
  101305. * possible but will produce minor visual artifacts. Since each new kernel requires a new shader we
  101306. * want to minimize kernel changes, having gaps between physical kernels is helpful in that regard.
  101307. * The gaps between physical kernels are compensated for in the weighting of the samples
  101308. * @param idealKernel Ideal blur kernel.
  101309. * @return Nearest best kernel.
  101310. */
  101311. protected _nearestBestKernel(idealKernel: number): number;
  101312. /**
  101313. * Calculates the value of a Gaussian distribution with sigma 3 at a given point.
  101314. * @param x The point on the Gaussian distribution to sample.
  101315. * @return the value of the Gaussian function at x.
  101316. */
  101317. protected _gaussianWeight(x: number): number;
  101318. /**
  101319. * Generates a string that can be used as a floating point number in GLSL.
  101320. * @param x Value to print.
  101321. * @param decimalFigures Number of decimal places to print the number to (excluding trailing 0s).
  101322. * @return GLSL float string.
  101323. */
  101324. protected _glslFloat(x: number, decimalFigures?: number): string;
  101325. }
  101326. }
  101327. declare module BABYLON {
  101328. /**
  101329. * Mirror texture can be used to simulate the view from a mirror in a scene.
  101330. * It will dynamically be rendered every frame to adapt to the camera point of view.
  101331. * You can then easily use it as a reflectionTexture on a flat surface.
  101332. * In case the surface is not a plane, please consider relying on reflection probes.
  101333. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  101334. */
  101335. export class MirrorTexture extends RenderTargetTexture {
  101336. private scene;
  101337. /**
  101338. * Define the reflection plane we want to use. The mirrorPlane is usually set to the constructed reflector.
  101339. * 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.
  101340. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  101341. */
  101342. mirrorPlane: Plane;
  101343. /**
  101344. * Define the blur ratio used to blur the reflection if needed.
  101345. */
  101346. set blurRatio(value: number);
  101347. get blurRatio(): number;
  101348. /**
  101349. * Define the adaptive blur kernel used to blur the reflection if needed.
  101350. * This will autocompute the closest best match for the `blurKernel`
  101351. */
  101352. set adaptiveBlurKernel(value: number);
  101353. /**
  101354. * Define the blur kernel used to blur the reflection if needed.
  101355. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  101356. */
  101357. set blurKernel(value: number);
  101358. /**
  101359. * Define the blur kernel on the X Axis used to blur the reflection if needed.
  101360. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  101361. */
  101362. set blurKernelX(value: number);
  101363. get blurKernelX(): number;
  101364. /**
  101365. * Define the blur kernel on the Y Axis used to blur the reflection if needed.
  101366. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  101367. */
  101368. set blurKernelY(value: number);
  101369. get blurKernelY(): number;
  101370. private _autoComputeBlurKernel;
  101371. protected _onRatioRescale(): void;
  101372. private _updateGammaSpace;
  101373. private _imageProcessingConfigChangeObserver;
  101374. private _transformMatrix;
  101375. private _mirrorMatrix;
  101376. private _savedViewMatrix;
  101377. private _blurX;
  101378. private _blurY;
  101379. private _adaptiveBlurKernel;
  101380. private _blurKernelX;
  101381. private _blurKernelY;
  101382. private _blurRatio;
  101383. /**
  101384. * Instantiates a Mirror Texture.
  101385. * Mirror texture can be used to simulate the view from a mirror in a scene.
  101386. * It will dynamically be rendered every frame to adapt to the camera point of view.
  101387. * You can then easily use it as a reflectionTexture on a flat surface.
  101388. * In case the surface is not a plane, please consider relying on reflection probes.
  101389. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  101390. * @param name
  101391. * @param size
  101392. * @param scene
  101393. * @param generateMipMaps
  101394. * @param type
  101395. * @param samplingMode
  101396. * @param generateDepthBuffer
  101397. */
  101398. constructor(name: string, size: number | {
  101399. width: number;
  101400. height: number;
  101401. } | {
  101402. ratio: number;
  101403. }, scene: Scene, generateMipMaps?: boolean, type?: number, samplingMode?: number, generateDepthBuffer?: boolean);
  101404. private _preparePostProcesses;
  101405. /**
  101406. * Clone the mirror texture.
  101407. * @returns the cloned texture
  101408. */
  101409. clone(): MirrorTexture;
  101410. /**
  101411. * Serialize the texture to a JSON representation you could use in Parse later on
  101412. * @returns the serialized JSON representation
  101413. */
  101414. serialize(): any;
  101415. /**
  101416. * Dispose the texture and release its associated resources.
  101417. */
  101418. dispose(): void;
  101419. }
  101420. }
  101421. declare module BABYLON {
  101422. /**
  101423. * This represents a texture in babylon. It can be easily loaded from a network, base64 or html input.
  101424. * @see https://doc.babylonjs.com/babylon101/materials#texture
  101425. */
  101426. export class Texture extends BaseTexture {
  101427. /**
  101428. * Gets or sets a general boolean used to indicate that textures containing direct data (buffers) must be saved as part of the serialization process
  101429. */
  101430. static SerializeBuffers: boolean;
  101431. /** @hidden */
  101432. static _CubeTextureParser: (jsonTexture: any, scene: Scene, rootUrl: string) => CubeTexture;
  101433. /** @hidden */
  101434. static _CreateMirror: (name: string, renderTargetSize: number, scene: Scene, generateMipMaps: boolean) => MirrorTexture;
  101435. /** @hidden */
  101436. static _CreateRenderTargetTexture: (name: string, renderTargetSize: number, scene: Scene, generateMipMaps: boolean) => RenderTargetTexture;
  101437. /** nearest is mag = nearest and min = nearest and mip = linear */
  101438. static readonly NEAREST_SAMPLINGMODE: number;
  101439. /** nearest is mag = nearest and min = nearest and mip = linear */
  101440. static readonly NEAREST_NEAREST_MIPLINEAR: number;
  101441. /** Bilinear is mag = linear and min = linear and mip = nearest */
  101442. static readonly BILINEAR_SAMPLINGMODE: number;
  101443. /** Bilinear is mag = linear and min = linear and mip = nearest */
  101444. static readonly LINEAR_LINEAR_MIPNEAREST: number;
  101445. /** Trilinear is mag = linear and min = linear and mip = linear */
  101446. static readonly TRILINEAR_SAMPLINGMODE: number;
  101447. /** Trilinear is mag = linear and min = linear and mip = linear */
  101448. static readonly LINEAR_LINEAR_MIPLINEAR: number;
  101449. /** mag = nearest and min = nearest and mip = nearest */
  101450. static readonly NEAREST_NEAREST_MIPNEAREST: number;
  101451. /** mag = nearest and min = linear and mip = nearest */
  101452. static readonly NEAREST_LINEAR_MIPNEAREST: number;
  101453. /** mag = nearest and min = linear and mip = linear */
  101454. static readonly NEAREST_LINEAR_MIPLINEAR: number;
  101455. /** mag = nearest and min = linear and mip = none */
  101456. static readonly NEAREST_LINEAR: number;
  101457. /** mag = nearest and min = nearest and mip = none */
  101458. static readonly NEAREST_NEAREST: number;
  101459. /** mag = linear and min = nearest and mip = nearest */
  101460. static readonly LINEAR_NEAREST_MIPNEAREST: number;
  101461. /** mag = linear and min = nearest and mip = linear */
  101462. static readonly LINEAR_NEAREST_MIPLINEAR: number;
  101463. /** mag = linear and min = linear and mip = none */
  101464. static readonly LINEAR_LINEAR: number;
  101465. /** mag = linear and min = nearest and mip = none */
  101466. static readonly LINEAR_NEAREST: number;
  101467. /** Explicit coordinates mode */
  101468. static readonly EXPLICIT_MODE: number;
  101469. /** Spherical coordinates mode */
  101470. static readonly SPHERICAL_MODE: number;
  101471. /** Planar coordinates mode */
  101472. static readonly PLANAR_MODE: number;
  101473. /** Cubic coordinates mode */
  101474. static readonly CUBIC_MODE: number;
  101475. /** Projection coordinates mode */
  101476. static readonly PROJECTION_MODE: number;
  101477. /** Inverse Cubic coordinates mode */
  101478. static readonly SKYBOX_MODE: number;
  101479. /** Inverse Cubic coordinates mode */
  101480. static readonly INVCUBIC_MODE: number;
  101481. /** Equirectangular coordinates mode */
  101482. static readonly EQUIRECTANGULAR_MODE: number;
  101483. /** Equirectangular Fixed coordinates mode */
  101484. static readonly FIXED_EQUIRECTANGULAR_MODE: number;
  101485. /** Equirectangular Fixed Mirrored coordinates mode */
  101486. static readonly FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  101487. /** Texture is not repeating outside of 0..1 UVs */
  101488. static readonly CLAMP_ADDRESSMODE: number;
  101489. /** Texture is repeating outside of 0..1 UVs */
  101490. static readonly WRAP_ADDRESSMODE: number;
  101491. /** Texture is repeating and mirrored */
  101492. static readonly MIRROR_ADDRESSMODE: number;
  101493. /**
  101494. * 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
  101495. */
  101496. static UseSerializedUrlIfAny: boolean;
  101497. /**
  101498. * Define the url of the texture.
  101499. */
  101500. url: Nullable<string>;
  101501. /**
  101502. * Define an offset on the texture to offset the u coordinates of the UVs
  101503. * @see https://doc.babylonjs.com/how_to/more_materials#offsetting
  101504. */
  101505. uOffset: number;
  101506. /**
  101507. * Define an offset on the texture to offset the v coordinates of the UVs
  101508. * @see https://doc.babylonjs.com/how_to/more_materials#offsetting
  101509. */
  101510. vOffset: number;
  101511. /**
  101512. * Define an offset on the texture to scale the u coordinates of the UVs
  101513. * @see https://doc.babylonjs.com/how_to/more_materials#tiling
  101514. */
  101515. uScale: number;
  101516. /**
  101517. * Define an offset on the texture to scale the v coordinates of the UVs
  101518. * @see https://doc.babylonjs.com/how_to/more_materials#tiling
  101519. */
  101520. vScale: number;
  101521. /**
  101522. * Define an offset on the texture to rotate around the u coordinates of the UVs
  101523. * @see https://doc.babylonjs.com/how_to/more_materials
  101524. */
  101525. uAng: number;
  101526. /**
  101527. * Define an offset on the texture to rotate around the v coordinates of the UVs
  101528. * @see https://doc.babylonjs.com/how_to/more_materials
  101529. */
  101530. vAng: number;
  101531. /**
  101532. * Define an offset on the texture to rotate around the w coordinates of the UVs (in case of 3d texture)
  101533. * @see https://doc.babylonjs.com/how_to/more_materials
  101534. */
  101535. wAng: number;
  101536. /**
  101537. * Defines the center of rotation (U)
  101538. */
  101539. uRotationCenter: number;
  101540. /**
  101541. * Defines the center of rotation (V)
  101542. */
  101543. vRotationCenter: number;
  101544. /**
  101545. * Defines the center of rotation (W)
  101546. */
  101547. wRotationCenter: number;
  101548. /**
  101549. * Are mip maps generated for this texture or not.
  101550. */
  101551. get noMipmap(): boolean;
  101552. /**
  101553. * List of inspectable custom properties (used by the Inspector)
  101554. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  101555. */
  101556. inspectableCustomProperties: Nullable<IInspectable[]>;
  101557. private _noMipmap;
  101558. /** @hidden */
  101559. _invertY: boolean;
  101560. private _rowGenerationMatrix;
  101561. private _cachedTextureMatrix;
  101562. private _projectionModeMatrix;
  101563. private _t0;
  101564. private _t1;
  101565. private _t2;
  101566. private _cachedUOffset;
  101567. private _cachedVOffset;
  101568. private _cachedUScale;
  101569. private _cachedVScale;
  101570. private _cachedUAng;
  101571. private _cachedVAng;
  101572. private _cachedWAng;
  101573. private _cachedProjectionMatrixId;
  101574. private _cachedCoordinatesMode;
  101575. /** @hidden */
  101576. protected _initialSamplingMode: number;
  101577. /** @hidden */
  101578. _buffer: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>;
  101579. private _deleteBuffer;
  101580. protected _format: Nullable<number>;
  101581. private _delayedOnLoad;
  101582. private _delayedOnError;
  101583. private _mimeType?;
  101584. /**
  101585. * Observable triggered once the texture has been loaded.
  101586. */
  101587. onLoadObservable: Observable<Texture>;
  101588. protected _isBlocking: boolean;
  101589. /**
  101590. * Is the texture preventing material to render while loading.
  101591. * If false, a default texture will be used instead of the loading one during the preparation step.
  101592. */
  101593. set isBlocking(value: boolean);
  101594. get isBlocking(): boolean;
  101595. /**
  101596. * Get the current sampling mode associated with the texture.
  101597. */
  101598. get samplingMode(): number;
  101599. /**
  101600. * Gets a boolean indicating if the texture needs to be inverted on the y axis during loading
  101601. */
  101602. get invertY(): boolean;
  101603. /**
  101604. * Instantiates a new texture.
  101605. * This represents a texture in babylon. It can be easily loaded from a network, base64 or html input.
  101606. * @see https://doc.babylonjs.com/babylon101/materials#texture
  101607. * @param url defines the url of the picture to load as a texture
  101608. * @param sceneOrEngine defines the scene or engine the texture will belong to
  101609. * @param noMipmap defines if the texture will require mip maps or not
  101610. * @param invertY defines if the texture needs to be inverted on the y axis during loading
  101611. * @param samplingMode defines the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  101612. * @param onLoad defines a callback triggered when the texture has been loaded
  101613. * @param onError defines a callback triggered when an error occurred during the loading session
  101614. * @param buffer defines the buffer to load the texture from in case the texture is loaded from a buffer representation
  101615. * @param deleteBuffer defines if the buffer we are loading the texture from should be deleted after load
  101616. * @param format defines the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  101617. * @param mimeType defines an optional mime type information
  101618. */
  101619. 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);
  101620. /**
  101621. * Update the url (and optional buffer) of this texture if url was null during construction.
  101622. * @param url the url of the texture
  101623. * @param buffer the buffer of the texture (defaults to null)
  101624. * @param onLoad callback called when the texture is loaded (defaults to null)
  101625. */
  101626. updateURL(url: string, buffer?: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob>, onLoad?: () => void): void;
  101627. /**
  101628. * Finish the loading sequence of a texture flagged as delayed load.
  101629. * @hidden
  101630. */
  101631. delayLoad(): void;
  101632. private _prepareRowForTextureGeneration;
  101633. /**
  101634. * Get the current texture matrix which includes the requested offsetting, tiling and rotation components.
  101635. * @returns the transform matrix of the texture.
  101636. */
  101637. getTextureMatrix(uBase?: number): Matrix;
  101638. /**
  101639. * Get the current matrix used to apply reflection. This is useful to rotate an environment texture for instance.
  101640. * @returns The reflection texture transform
  101641. */
  101642. getReflectionTextureMatrix(): Matrix;
  101643. /**
  101644. * Clones the texture.
  101645. * @returns the cloned texture
  101646. */
  101647. clone(): Texture;
  101648. /**
  101649. * Serialize the texture to a JSON representation we can easily use in the resepective Parse function.
  101650. * @returns The JSON representation of the texture
  101651. */
  101652. serialize(): any;
  101653. /**
  101654. * Get the current class name of the texture useful for serialization or dynamic coding.
  101655. * @returns "Texture"
  101656. */
  101657. getClassName(): string;
  101658. /**
  101659. * Dispose the texture and release its associated resources.
  101660. */
  101661. dispose(): void;
  101662. /**
  101663. * Parse the JSON representation of a texture in order to recreate the texture in the given scene.
  101664. * @param parsedTexture Define the JSON representation of the texture
  101665. * @param scene Define the scene the parsed texture should be instantiated in
  101666. * @param rootUrl Define the root url of the parsing sequence in the case of relative dependencies
  101667. * @returns The parsed texture if successful
  101668. */
  101669. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): Nullable<BaseTexture>;
  101670. /**
  101671. * Creates a texture from its base 64 representation.
  101672. * @param data Define the base64 payload without the data: prefix
  101673. * @param name Define the name of the texture in the scene useful fo caching purpose for instance
  101674. * @param scene Define the scene the texture should belong to
  101675. * @param noMipmap Forces the texture to not create mip map information if true
  101676. * @param invertY define if the texture needs to be inverted on the y axis during loading
  101677. * @param samplingMode define the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  101678. * @param onLoad define a callback triggered when the texture has been loaded
  101679. * @param onError define a callback triggered when an error occurred during the loading session
  101680. * @param format define the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  101681. * @returns the created texture
  101682. */
  101683. static CreateFromBase64String(data: string, name: string, scene: Scene, noMipmap?: boolean, invertY?: boolean, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<() => void>, format?: number): Texture;
  101684. /**
  101685. * Creates a texture from its data: representation. (data: will be added in case only the payload has been passed in)
  101686. * @param data Define the base64 payload without the data: prefix
  101687. * @param name Define the name of the texture in the scene useful fo caching purpose for instance
  101688. * @param buffer define the buffer to load the texture from in case the texture is loaded from a buffer representation
  101689. * @param scene Define the scene the texture should belong to
  101690. * @param deleteBuffer define if the buffer we are loading the texture from should be deleted after load
  101691. * @param noMipmap Forces the texture to not create mip map information if true
  101692. * @param invertY define if the texture needs to be inverted on the y axis during loading
  101693. * @param samplingMode define the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  101694. * @param onLoad define a callback triggered when the texture has been loaded
  101695. * @param onError define a callback triggered when an error occurred during the loading session
  101696. * @param format define the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  101697. * @returns the created texture
  101698. */
  101699. 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;
  101700. }
  101701. }
  101702. declare module BABYLON {
  101703. /**
  101704. * PostProcessManager is used to manage one or more post processes or post process pipelines
  101705. * See https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  101706. */
  101707. export class PostProcessManager {
  101708. private _scene;
  101709. private _indexBuffer;
  101710. private _vertexBuffers;
  101711. /**
  101712. * Creates a new instance PostProcess
  101713. * @param scene The scene that the post process is associated with.
  101714. */
  101715. constructor(scene: Scene);
  101716. private _prepareBuffers;
  101717. private _buildIndexBuffer;
  101718. /**
  101719. * Rebuilds the vertex buffers of the manager.
  101720. * @hidden
  101721. */
  101722. _rebuild(): void;
  101723. /**
  101724. * Prepares a frame to be run through a post process.
  101725. * @param sourceTexture The input texture to the post procesess. (default: null)
  101726. * @param postProcesses An array of post processes to be run. (default: null)
  101727. * @returns True if the post processes were able to be run.
  101728. * @hidden
  101729. */
  101730. _prepareFrame(sourceTexture?: Nullable<InternalTexture>, postProcesses?: Nullable<PostProcess[]>): boolean;
  101731. /**
  101732. * Manually render a set of post processes to a texture.
  101733. * Please note, the frame buffer won't be unbound after the call in case you have more render to do.
  101734. * @param postProcesses An array of post processes to be run.
  101735. * @param targetTexture The target texture to render to.
  101736. * @param forceFullscreenViewport force gl.viewport to be full screen eg. 0,0,textureWidth,textureHeight
  101737. * @param faceIndex defines the face to render to if a cubemap is defined as the target
  101738. * @param lodLevel defines which lod of the texture to render to
  101739. * @param doNotBindFrambuffer If set to true, assumes that the framebuffer has been bound previously
  101740. */
  101741. directRender(postProcesses: PostProcess[], targetTexture?: Nullable<InternalTexture>, forceFullscreenViewport?: boolean, faceIndex?: number, lodLevel?: number, doNotBindFrambuffer?: boolean): void;
  101742. /**
  101743. * Finalize the result of the output of the postprocesses.
  101744. * @param doNotPresent If true the result will not be displayed to the screen.
  101745. * @param targetTexture The target texture to render to.
  101746. * @param faceIndex The index of the face to bind the target texture to.
  101747. * @param postProcesses The array of post processes to render.
  101748. * @param forceFullscreenViewport force gl.viewport to be full screen eg. 0,0,textureWidth,textureHeight (default: false)
  101749. * @hidden
  101750. */
  101751. _finalizeFrame(doNotPresent?: boolean, targetTexture?: InternalTexture, faceIndex?: number, postProcesses?: Array<PostProcess>, forceFullscreenViewport?: boolean): void;
  101752. /**
  101753. * Disposes of the post process manager.
  101754. */
  101755. dispose(): void;
  101756. }
  101757. }
  101758. declare module BABYLON {
  101759. /**
  101760. * This Helps creating a texture that will be created from a camera in your scene.
  101761. * It is basically a dynamic texture that could be used to create special effects for instance.
  101762. * Actually, It is the base of lot of effects in the framework like post process, shadows, effect layers and rendering pipelines...
  101763. */
  101764. export class RenderTargetTexture extends Texture {
  101765. isCube: boolean;
  101766. /**
  101767. * The texture will only be rendered once which can be useful to improve performance if everything in your render is static for instance.
  101768. */
  101769. static readonly REFRESHRATE_RENDER_ONCE: number;
  101770. /**
  101771. * The texture will only be rendered rendered every frame and is recomended for dynamic contents.
  101772. */
  101773. static readonly REFRESHRATE_RENDER_ONEVERYFRAME: number;
  101774. /**
  101775. * The texture will be rendered every 2 frames which could be enough if your dynamic objects are not
  101776. * the central point of your effect and can save a lot of performances.
  101777. */
  101778. static readonly REFRESHRATE_RENDER_ONEVERYTWOFRAMES: number;
  101779. /**
  101780. * Use this predicate to dynamically define the list of mesh you want to render.
  101781. * If set, the renderList property will be overwritten.
  101782. */
  101783. renderListPredicate: (AbstractMesh: AbstractMesh) => boolean;
  101784. private _renderList;
  101785. /**
  101786. * Use this list to define the list of mesh you want to render.
  101787. */
  101788. get renderList(): Nullable<Array<AbstractMesh>>;
  101789. set renderList(value: Nullable<Array<AbstractMesh>>);
  101790. /**
  101791. * Use this function to overload the renderList array at rendering time.
  101792. * Return null to render with the curent renderList, else return the list of meshes to use for rendering.
  101793. * For 2DArray RTT, layerOrFace is the index of the layer that is going to be rendered, else it is the faceIndex of
  101794. * the cube (if the RTT is a cube, else layerOrFace=0).
  101795. * The renderList passed to the function is the current render list (the one that will be used if the function returns null).
  101796. * The length of this list is passed through renderListLength: don't use renderList.length directly because the array can
  101797. * hold dummy elements!
  101798. */
  101799. getCustomRenderList: (layerOrFace: number, renderList: Nullable<Immutable<Array<AbstractMesh>>>, renderListLength: number) => Nullable<Array<AbstractMesh>>;
  101800. private _hookArray;
  101801. /**
  101802. * Define if particles should be rendered in your texture.
  101803. */
  101804. renderParticles: boolean;
  101805. /**
  101806. * Define if sprites should be rendered in your texture.
  101807. */
  101808. renderSprites: boolean;
  101809. /**
  101810. * Override the default coordinates mode to projection for RTT as it is the most common case for rendered textures.
  101811. */
  101812. coordinatesMode: number;
  101813. /**
  101814. * Define the camera used to render the texture.
  101815. */
  101816. activeCamera: Nullable<Camera>;
  101817. /**
  101818. * Override the mesh isReady function with your own one.
  101819. */
  101820. customIsReadyFunction: (mesh: AbstractMesh, refreshRate: number) => boolean;
  101821. /**
  101822. * Override the render function of the texture with your own one.
  101823. */
  101824. customRenderFunction: (opaqueSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>, beforeTransparents?: () => void) => void;
  101825. /**
  101826. * Define if camera post processes should be use while rendering the texture.
  101827. */
  101828. useCameraPostProcesses: boolean;
  101829. /**
  101830. * Define if the camera viewport should be respected while rendering the texture or if the render should be done to the entire texture.
  101831. */
  101832. ignoreCameraViewport: boolean;
  101833. private _postProcessManager;
  101834. private _postProcesses;
  101835. private _resizeObserver;
  101836. /**
  101837. * An event triggered when the texture is unbind.
  101838. */
  101839. onBeforeBindObservable: Observable<RenderTargetTexture>;
  101840. /**
  101841. * An event triggered when the texture is unbind.
  101842. */
  101843. onAfterUnbindObservable: Observable<RenderTargetTexture>;
  101844. private _onAfterUnbindObserver;
  101845. /**
  101846. * Set a after unbind callback in the texture.
  101847. * This has been kept for backward compatibility and use of onAfterUnbindObservable is recommended.
  101848. */
  101849. set onAfterUnbind(callback: () => void);
  101850. /**
  101851. * An event triggered before rendering the texture
  101852. */
  101853. onBeforeRenderObservable: Observable<number>;
  101854. private _onBeforeRenderObserver;
  101855. /**
  101856. * Set a before render callback in the texture.
  101857. * This has been kept for backward compatibility and use of onBeforeRenderObservable is recommended.
  101858. */
  101859. set onBeforeRender(callback: (faceIndex: number) => void);
  101860. /**
  101861. * An event triggered after rendering the texture
  101862. */
  101863. onAfterRenderObservable: Observable<number>;
  101864. private _onAfterRenderObserver;
  101865. /**
  101866. * Set a after render callback in the texture.
  101867. * This has been kept for backward compatibility and use of onAfterRenderObservable is recommended.
  101868. */
  101869. set onAfterRender(callback: (faceIndex: number) => void);
  101870. /**
  101871. * An event triggered after the texture clear
  101872. */
  101873. onClearObservable: Observable<Engine>;
  101874. private _onClearObserver;
  101875. /**
  101876. * Set a clear callback in the texture.
  101877. * This has been kept for backward compatibility and use of onClearObservable is recommended.
  101878. */
  101879. set onClear(callback: (Engine: Engine) => void);
  101880. /**
  101881. * An event triggered when the texture is resized.
  101882. */
  101883. onResizeObservable: Observable<RenderTargetTexture>;
  101884. /**
  101885. * Define the clear color of the Render Target if it should be different from the scene.
  101886. */
  101887. clearColor: Color4;
  101888. protected _size: number | {
  101889. width: number;
  101890. height: number;
  101891. layers?: number;
  101892. };
  101893. protected _initialSizeParameter: number | {
  101894. width: number;
  101895. height: number;
  101896. } | {
  101897. ratio: number;
  101898. };
  101899. protected _sizeRatio: Nullable<number>;
  101900. /** @hidden */
  101901. _generateMipMaps: boolean;
  101902. protected _renderingManager: RenderingManager;
  101903. /** @hidden */
  101904. _waitingRenderList: string[];
  101905. protected _doNotChangeAspectRatio: boolean;
  101906. protected _currentRefreshId: number;
  101907. protected _refreshRate: number;
  101908. protected _textureMatrix: Matrix;
  101909. protected _samples: number;
  101910. protected _renderTargetOptions: RenderTargetCreationOptions;
  101911. /**
  101912. * Gets render target creation options that were used.
  101913. */
  101914. get renderTargetOptions(): RenderTargetCreationOptions;
  101915. protected _onRatioRescale(): void;
  101916. /**
  101917. * Gets or sets the center of the bounding box associated with the texture (when in cube mode)
  101918. * It must define where the camera used to render the texture is set
  101919. */
  101920. boundingBoxPosition: Vector3;
  101921. private _boundingBoxSize;
  101922. /**
  101923. * Gets or sets the size of the bounding box associated with the texture (when in cube mode)
  101924. * When defined, the cubemap will switch to local mode
  101925. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  101926. * @example https://www.babylonjs-playground.com/#RNASML
  101927. */
  101928. set boundingBoxSize(value: Vector3);
  101929. get boundingBoxSize(): Vector3;
  101930. /**
  101931. * In case the RTT has been created with a depth texture, get the associated
  101932. * depth texture.
  101933. * Otherwise, return null.
  101934. */
  101935. get depthStencilTexture(): Nullable<InternalTexture>;
  101936. /**
  101937. * Instantiate a render target texture. This is mainly used to render of screen the scene to for instance apply post processse
  101938. * or used a shadow, depth texture...
  101939. * @param name The friendly name of the texture
  101940. * @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)
  101941. * @param scene The scene the RTT belongs to. The latest created scene will be used if not precised.
  101942. * @param generateMipMaps True if mip maps need to be generated after render.
  101943. * @param doNotChangeAspectRatio True to not change the aspect ratio of the scene in the RTT
  101944. * @param type The type of the buffer in the RTT (int, half float, float...)
  101945. * @param isCube True if a cube texture needs to be created
  101946. * @param samplingMode The sampling mode to be usedwith the render target (Linear, Nearest...)
  101947. * @param generateDepthBuffer True to generate a depth buffer
  101948. * @param generateStencilBuffer True to generate a stencil buffer
  101949. * @param isMulti True if multiple textures need to be created (Draw Buffers)
  101950. * @param format The internal format of the buffer in the RTT (RED, RG, RGB, RGBA, ALPHA...)
  101951. * @param delayAllocation if the texture allocation should be delayed (default: false)
  101952. */
  101953. constructor(name: string, size: number | {
  101954. width: number;
  101955. height: number;
  101956. layers?: number;
  101957. } | {
  101958. ratio: number;
  101959. }, scene: Nullable<Scene>, generateMipMaps?: boolean, doNotChangeAspectRatio?: boolean, type?: number, isCube?: boolean, samplingMode?: number, generateDepthBuffer?: boolean, generateStencilBuffer?: boolean, isMulti?: boolean, format?: number, delayAllocation?: boolean);
  101960. /**
  101961. * Creates a depth stencil texture.
  101962. * This is only available in WebGL 2 or with the depth texture extension available.
  101963. * @param comparisonFunction Specifies the comparison function to set on the texture. If 0 or undefined, the texture is not in comparison mode
  101964. * @param bilinearFiltering Specifies whether or not bilinear filtering is enable on the texture
  101965. * @param generateStencil Specifies whether or not a stencil should be allocated in the texture
  101966. */
  101967. createDepthStencilTexture(comparisonFunction?: number, bilinearFiltering?: boolean, generateStencil?: boolean): void;
  101968. private _processSizeParameter;
  101969. /**
  101970. * Define the number of samples to use in case of MSAA.
  101971. * It defaults to one meaning no MSAA has been enabled.
  101972. */
  101973. get samples(): number;
  101974. set samples(value: number);
  101975. /**
  101976. * Resets the refresh counter of the texture and start bak from scratch.
  101977. * Could be useful to regenerate the texture if it is setup to render only once.
  101978. */
  101979. resetRefreshCounter(): void;
  101980. /**
  101981. * Define the refresh rate of the texture or the rendering frequency.
  101982. * Use 0 to render just once, 1 to render on every frame, 2 to render every two frames and so on...
  101983. */
  101984. get refreshRate(): number;
  101985. set refreshRate(value: number);
  101986. /**
  101987. * Adds a post process to the render target rendering passes.
  101988. * @param postProcess define the post process to add
  101989. */
  101990. addPostProcess(postProcess: PostProcess): void;
  101991. /**
  101992. * Clear all the post processes attached to the render target
  101993. * @param dispose define if the cleared post processesshould also be disposed (false by default)
  101994. */
  101995. clearPostProcesses(dispose?: boolean): void;
  101996. /**
  101997. * Remove one of the post process from the list of attached post processes to the texture
  101998. * @param postProcess define the post process to remove from the list
  101999. */
  102000. removePostProcess(postProcess: PostProcess): void;
  102001. /** @hidden */
  102002. _shouldRender(): boolean;
  102003. /**
  102004. * Gets the actual render size of the texture.
  102005. * @returns the width of the render size
  102006. */
  102007. getRenderSize(): number;
  102008. /**
  102009. * Gets the actual render width of the texture.
  102010. * @returns the width of the render size
  102011. */
  102012. getRenderWidth(): number;
  102013. /**
  102014. * Gets the actual render height of the texture.
  102015. * @returns the height of the render size
  102016. */
  102017. getRenderHeight(): number;
  102018. /**
  102019. * Gets the actual number of layers of the texture.
  102020. * @returns the number of layers
  102021. */
  102022. getRenderLayers(): number;
  102023. /**
  102024. * Get if the texture can be rescaled or not.
  102025. */
  102026. get canRescale(): boolean;
  102027. /**
  102028. * Resize the texture using a ratio.
  102029. * @param ratio the ratio to apply to the texture size in order to compute the new target size
  102030. */
  102031. scale(ratio: number): void;
  102032. /**
  102033. * Get the texture reflection matrix used to rotate/transform the reflection.
  102034. * @returns the reflection matrix
  102035. */
  102036. getReflectionTextureMatrix(): Matrix;
  102037. /**
  102038. * Resize the texture to a new desired size.
  102039. * Be carrefull as it will recreate all the data in the new texture.
  102040. * @param size Define the new size. It can be:
  102041. * - a number for squared texture,
  102042. * - an object containing { width: number, height: number }
  102043. * - or an object containing a ratio { ratio: number }
  102044. */
  102045. resize(size: number | {
  102046. width: number;
  102047. height: number;
  102048. } | {
  102049. ratio: number;
  102050. }): void;
  102051. private _defaultRenderListPrepared;
  102052. /**
  102053. * Renders all the objects from the render list into the texture.
  102054. * @param useCameraPostProcess Define if camera post processes should be used during the rendering
  102055. * @param dumpForDebug Define if the rendering result should be dumped (copied) for debugging purpose
  102056. */
  102057. render(useCameraPostProcess?: boolean, dumpForDebug?: boolean): void;
  102058. private _bestReflectionRenderTargetDimension;
  102059. private _prepareRenderingManager;
  102060. /**
  102061. * @hidden
  102062. * @param faceIndex face index to bind to if this is a cubetexture
  102063. * @param layer defines the index of the texture to bind in the array
  102064. */
  102065. _bindFrameBuffer(faceIndex?: number, layer?: number): void;
  102066. protected unbindFrameBuffer(engine: Engine, faceIndex: number): void;
  102067. private renderToTarget;
  102068. /**
  102069. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  102070. * This allowed control for front to back rendering or reversly depending of the special needs.
  102071. *
  102072. * @param renderingGroupId The rendering group id corresponding to its index
  102073. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  102074. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  102075. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  102076. */
  102077. 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;
  102078. /**
  102079. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  102080. *
  102081. * @param renderingGroupId The rendering group id corresponding to its index
  102082. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  102083. */
  102084. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean): void;
  102085. /**
  102086. * Clones the texture.
  102087. * @returns the cloned texture
  102088. */
  102089. clone(): RenderTargetTexture;
  102090. /**
  102091. * Serialize the texture to a JSON representation we can easily use in the resepective Parse function.
  102092. * @returns The JSON representation of the texture
  102093. */
  102094. serialize(): any;
  102095. /**
  102096. * This will remove the attached framebuffer objects. The texture will not be able to be used as render target anymore
  102097. */
  102098. disposeFramebufferObjects(): void;
  102099. /**
  102100. * Dispose the texture and release its associated resources.
  102101. */
  102102. dispose(): void;
  102103. /** @hidden */
  102104. _rebuild(): void;
  102105. /**
  102106. * Clear the info related to rendering groups preventing retention point in material dispose.
  102107. */
  102108. freeRenderingGroups(): void;
  102109. /**
  102110. * Gets the number of views the corresponding to the texture (eg. a MultiviewRenderTarget will have > 1)
  102111. * @returns the view count
  102112. */
  102113. getViewCount(): number;
  102114. }
  102115. }
  102116. declare module BABYLON {
  102117. /**
  102118. * Class used to manipulate GUIDs
  102119. */
  102120. export class GUID {
  102121. /**
  102122. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  102123. * Be aware Math.random() could cause collisions, but:
  102124. * "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"
  102125. * @returns a pseudo random id
  102126. */
  102127. static RandomId(): string;
  102128. }
  102129. }
  102130. declare module BABYLON {
  102131. /**
  102132. * Options to be used when creating a shadow depth material
  102133. */
  102134. export interface IIOptionShadowDepthMaterial {
  102135. /** Variables in the vertex shader code that need to have their names remapped.
  102136. * The format is: ["var_name", "var_remapped_name", "var_name", "var_remapped_name", ...]
  102137. * "var_name" should be either: worldPos or vNormalW
  102138. * So, if the variable holding the world position in your vertex shader is not named worldPos, you must tell the system
  102139. * the name to use instead by using: ["worldPos", "myWorldPosVar"] assuming the variable is named myWorldPosVar in your code.
  102140. * If the normal must also be remapped: ["worldPos", "myWorldPosVar", "vNormalW", "myWorldNormal"]
  102141. */
  102142. remappedVariables?: string[];
  102143. /** Set standalone to true if the base material wrapped by ShadowDepthMaterial is not used for a regular object but for depth shadow generation only */
  102144. standalone?: boolean;
  102145. }
  102146. /**
  102147. * Class that can be used to wrap a base material to generate accurate shadows when using custom vertex/fragment code in the base material
  102148. */
  102149. export class ShadowDepthWrapper {
  102150. private _scene;
  102151. private _options?;
  102152. private _baseMaterial;
  102153. private _onEffectCreatedObserver;
  102154. private _subMeshToEffect;
  102155. private _subMeshToDepthEffect;
  102156. private _meshes;
  102157. /** @hidden */
  102158. _matriceNames: any;
  102159. /** Gets the standalone status of the wrapper */
  102160. get standalone(): boolean;
  102161. /** Gets the base material the wrapper is built upon */
  102162. get baseMaterial(): Material;
  102163. /**
  102164. * Instantiate a new shadow depth wrapper.
  102165. * It works by injecting some specific code in the vertex/fragment shaders of the base material and is used by a shadow generator to
  102166. * generate the shadow depth map. For more information, please refer to the documentation:
  102167. * https://doc.babylonjs.com/babylon101/shadows
  102168. * @param baseMaterial Material to wrap
  102169. * @param scene Define the scene the material belongs to
  102170. * @param options Options used to create the wrapper
  102171. */
  102172. constructor(baseMaterial: Material, scene: Scene, options?: IIOptionShadowDepthMaterial);
  102173. /**
  102174. * Gets the effect to use to generate the depth map
  102175. * @param subMesh subMesh to get the effect for
  102176. * @param shadowGenerator shadow generator to get the effect for
  102177. * @returns the effect to use to generate the depth map for the subMesh + shadow generator specified
  102178. */
  102179. getEffect(subMesh: Nullable<SubMesh>, shadowGenerator: ShadowGenerator): Nullable<Effect>;
  102180. /**
  102181. * Specifies that the submesh is ready to be used for depth rendering
  102182. * @param subMesh submesh to check
  102183. * @param defines the list of defines to take into account when checking the effect
  102184. * @param shadowGenerator combined with subMesh, it defines the effect to check
  102185. * @param useInstances specifies that instances should be used
  102186. * @returns a boolean indicating that the submesh is ready or not
  102187. */
  102188. isReadyForSubMesh(subMesh: SubMesh, defines: string[], shadowGenerator: ShadowGenerator, useInstances: boolean): boolean;
  102189. /**
  102190. * Disposes the resources
  102191. */
  102192. dispose(): void;
  102193. private _makeEffect;
  102194. }
  102195. }
  102196. declare module BABYLON {
  102197. interface ThinEngine {
  102198. /**
  102199. * Unbind a list of render target textures from the webGL context
  102200. * This is used only when drawBuffer extension or webGL2 are active
  102201. * @param textures defines the render target textures to unbind
  102202. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  102203. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  102204. */
  102205. unBindMultiColorAttachmentFramebuffer(textures: InternalTexture[], disableGenerateMipMaps: boolean, onBeforeUnbind?: () => void): void;
  102206. /**
  102207. * Create a multi render target texture
  102208. * @see https://doc.babylonjs.com/features/webgl2#multiple-render-target
  102209. * @param size defines the size of the texture
  102210. * @param options defines the creation options
  102211. * @returns the cube texture as an InternalTexture
  102212. */
  102213. createMultipleRenderTarget(size: any, options: IMultiRenderTargetOptions): InternalTexture[];
  102214. /**
  102215. * Update the sample count for a given multiple render target texture
  102216. * @see https://doc.babylonjs.com/features/webgl2#multisample-render-targets
  102217. * @param textures defines the textures to update
  102218. * @param samples defines the sample count to set
  102219. * @returns the effective sample count (could be 0 if multisample render targets are not supported)
  102220. */
  102221. updateMultipleRenderTargetTextureSampleCount(textures: Nullable<InternalTexture[]>, samples: number): number;
  102222. /**
  102223. * Select a subsets of attachments to draw to.
  102224. * @param attachments gl attachments
  102225. */
  102226. bindAttachments(attachments: number[]): void;
  102227. }
  102228. }
  102229. declare module BABYLON {
  102230. /**
  102231. * Creation options of the multi render target texture.
  102232. */
  102233. export interface IMultiRenderTargetOptions {
  102234. /**
  102235. * Define if the texture needs to create mip maps after render.
  102236. */
  102237. generateMipMaps?: boolean;
  102238. /**
  102239. * Define the types of all the draw buffers we want to create
  102240. */
  102241. types?: number[];
  102242. /**
  102243. * Define the sampling modes of all the draw buffers we want to create
  102244. */
  102245. samplingModes?: number[];
  102246. /**
  102247. * Define if a depth buffer is required
  102248. */
  102249. generateDepthBuffer?: boolean;
  102250. /**
  102251. * Define if a stencil buffer is required
  102252. */
  102253. generateStencilBuffer?: boolean;
  102254. /**
  102255. * Define if a depth texture is required instead of a depth buffer
  102256. */
  102257. generateDepthTexture?: boolean;
  102258. /**
  102259. * Define the number of desired draw buffers
  102260. */
  102261. textureCount?: number;
  102262. /**
  102263. * Define if aspect ratio should be adapted to the texture or stay the scene one
  102264. */
  102265. doNotChangeAspectRatio?: boolean;
  102266. /**
  102267. * Define the default type of the buffers we are creating
  102268. */
  102269. defaultType?: number;
  102270. }
  102271. /**
  102272. * A multi render target, like a render target provides the ability to render to a texture.
  102273. * Unlike the render target, it can render to several draw buffers in one draw.
  102274. * This is specially interesting in deferred rendering or for any effects requiring more than
  102275. * just one color from a single pass.
  102276. */
  102277. export class MultiRenderTarget extends RenderTargetTexture {
  102278. private _internalTextures;
  102279. private _textures;
  102280. private _multiRenderTargetOptions;
  102281. private _count;
  102282. /**
  102283. * Get if draw buffers are currently supported by the used hardware and browser.
  102284. */
  102285. get isSupported(): boolean;
  102286. /**
  102287. * Get the list of textures generated by the multi render target.
  102288. */
  102289. get textures(): Texture[];
  102290. /**
  102291. * Gets the number of textures in this MRT. This number can be different from `_textures.length` in case a depth texture is generated.
  102292. */
  102293. get count(): number;
  102294. /**
  102295. * Get the depth texture generated by the multi render target if options.generateDepthTexture has been set
  102296. */
  102297. get depthTexture(): Texture;
  102298. /**
  102299. * Set the wrapping mode on U of all the textures we are rendering to.
  102300. * Can be any of the Texture. (CLAMP_ADDRESSMODE, MIRROR_ADDRESSMODE or WRAP_ADDRESSMODE)
  102301. */
  102302. set wrapU(wrap: number);
  102303. /**
  102304. * Set the wrapping mode on V of all the textures we are rendering to.
  102305. * Can be any of the Texture. (CLAMP_ADDRESSMODE, MIRROR_ADDRESSMODE or WRAP_ADDRESSMODE)
  102306. */
  102307. set wrapV(wrap: number);
  102308. /**
  102309. * Instantiate a new multi render target texture.
  102310. * A multi render target, like a render target provides the ability to render to a texture.
  102311. * Unlike the render target, it can render to several draw buffers in one draw.
  102312. * This is specially interesting in deferred rendering or for any effects requiring more than
  102313. * just one color from a single pass.
  102314. * @param name Define the name of the texture
  102315. * @param size Define the size of the buffers to render to
  102316. * @param count Define the number of target we are rendering into
  102317. * @param scene Define the scene the texture belongs to
  102318. * @param options Define the options used to create the multi render target
  102319. */
  102320. constructor(name: string, size: any, count: number, scene: Scene, options?: IMultiRenderTargetOptions);
  102321. /** @hidden */
  102322. _rebuild(): void;
  102323. private _createInternalTextures;
  102324. private _createTextures;
  102325. /**
  102326. * Define the number of samples used if MSAA is enabled.
  102327. */
  102328. get samples(): number;
  102329. set samples(value: number);
  102330. /**
  102331. * Resize all the textures in the multi render target.
  102332. * Be carrefull as it will recreate all the data in the new texture.
  102333. * @param size Define the new size
  102334. */
  102335. resize(size: any): void;
  102336. protected unbindFrameBuffer(engine: Engine, faceIndex: number): void;
  102337. /**
  102338. * Dispose the render targets and their associated resources
  102339. */
  102340. dispose(): void;
  102341. /**
  102342. * Release all the underlying texture used as draw buffers.
  102343. */
  102344. releaseInternalTextures(): void;
  102345. }
  102346. }
  102347. declare module BABYLON {
  102348. /** @hidden */
  102349. export var imageProcessingPixelShader: {
  102350. name: string;
  102351. shader: string;
  102352. };
  102353. }
  102354. declare module BABYLON {
  102355. /**
  102356. * ImageProcessingPostProcess
  102357. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#imageprocessing
  102358. */
  102359. export class ImageProcessingPostProcess extends PostProcess {
  102360. /**
  102361. * Default configuration related to image processing available in the PBR Material.
  102362. */
  102363. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  102364. /**
  102365. * Gets the image processing configuration used either in this material.
  102366. */
  102367. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  102368. /**
  102369. * Sets the Default image processing configuration used either in the this material.
  102370. *
  102371. * If sets to null, the scene one is in use.
  102372. */
  102373. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  102374. /**
  102375. * Keep track of the image processing observer to allow dispose and replace.
  102376. */
  102377. private _imageProcessingObserver;
  102378. /**
  102379. * Attaches a new image processing configuration to the PBR Material.
  102380. * @param configuration
  102381. */
  102382. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>, doNotBuild?: boolean): void;
  102383. /**
  102384. * If the post process is supported.
  102385. */
  102386. get isSupported(): boolean;
  102387. /**
  102388. * Gets Color curves setup used in the effect if colorCurvesEnabled is set to true .
  102389. */
  102390. get colorCurves(): Nullable<ColorCurves>;
  102391. /**
  102392. * Sets Color curves setup used in the effect if colorCurvesEnabled is set to true .
  102393. */
  102394. set colorCurves(value: Nullable<ColorCurves>);
  102395. /**
  102396. * Gets wether the color curves effect is enabled.
  102397. */
  102398. get colorCurvesEnabled(): boolean;
  102399. /**
  102400. * Sets wether the color curves effect is enabled.
  102401. */
  102402. set colorCurvesEnabled(value: boolean);
  102403. /**
  102404. * Gets Color grading LUT texture used in the effect if colorGradingEnabled is set to true.
  102405. */
  102406. get colorGradingTexture(): Nullable<BaseTexture>;
  102407. /**
  102408. * Sets Color grading LUT texture used in the effect if colorGradingEnabled is set to true.
  102409. */
  102410. set colorGradingTexture(value: Nullable<BaseTexture>);
  102411. /**
  102412. * Gets wether the color grading effect is enabled.
  102413. */
  102414. get colorGradingEnabled(): boolean;
  102415. /**
  102416. * Gets wether the color grading effect is enabled.
  102417. */
  102418. set colorGradingEnabled(value: boolean);
  102419. /**
  102420. * Gets exposure used in the effect.
  102421. */
  102422. get exposure(): number;
  102423. /**
  102424. * Sets exposure used in the effect.
  102425. */
  102426. set exposure(value: number);
  102427. /**
  102428. * Gets wether tonemapping is enabled or not.
  102429. */
  102430. get toneMappingEnabled(): boolean;
  102431. /**
  102432. * Sets wether tonemapping is enabled or not
  102433. */
  102434. set toneMappingEnabled(value: boolean);
  102435. /**
  102436. * Gets the type of tone mapping effect.
  102437. */
  102438. get toneMappingType(): number;
  102439. /**
  102440. * Sets the type of tone mapping effect.
  102441. */
  102442. set toneMappingType(value: number);
  102443. /**
  102444. * Gets contrast used in the effect.
  102445. */
  102446. get contrast(): number;
  102447. /**
  102448. * Sets contrast used in the effect.
  102449. */
  102450. set contrast(value: number);
  102451. /**
  102452. * Gets Vignette stretch size.
  102453. */
  102454. get vignetteStretch(): number;
  102455. /**
  102456. * Sets Vignette stretch size.
  102457. */
  102458. set vignetteStretch(value: number);
  102459. /**
  102460. * Gets Vignette centre X Offset.
  102461. */
  102462. get vignetteCentreX(): number;
  102463. /**
  102464. * Sets Vignette centre X Offset.
  102465. */
  102466. set vignetteCentreX(value: number);
  102467. /**
  102468. * Gets Vignette centre Y Offset.
  102469. */
  102470. get vignetteCentreY(): number;
  102471. /**
  102472. * Sets Vignette centre Y Offset.
  102473. */
  102474. set vignetteCentreY(value: number);
  102475. /**
  102476. * Gets Vignette weight or intensity of the vignette effect.
  102477. */
  102478. get vignetteWeight(): number;
  102479. /**
  102480. * Sets Vignette weight or intensity of the vignette effect.
  102481. */
  102482. set vignetteWeight(value: number);
  102483. /**
  102484. * Gets Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  102485. * if vignetteEnabled is set to true.
  102486. */
  102487. get vignetteColor(): Color4;
  102488. /**
  102489. * Sets Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  102490. * if vignetteEnabled is set to true.
  102491. */
  102492. set vignetteColor(value: Color4);
  102493. /**
  102494. * Gets Camera field of view used by the Vignette effect.
  102495. */
  102496. get vignetteCameraFov(): number;
  102497. /**
  102498. * Sets Camera field of view used by the Vignette effect.
  102499. */
  102500. set vignetteCameraFov(value: number);
  102501. /**
  102502. * Gets the vignette blend mode allowing different kind of effect.
  102503. */
  102504. get vignetteBlendMode(): number;
  102505. /**
  102506. * Sets the vignette blend mode allowing different kind of effect.
  102507. */
  102508. set vignetteBlendMode(value: number);
  102509. /**
  102510. * Gets wether the vignette effect is enabled.
  102511. */
  102512. get vignetteEnabled(): boolean;
  102513. /**
  102514. * Sets wether the vignette effect is enabled.
  102515. */
  102516. set vignetteEnabled(value: boolean);
  102517. private _fromLinearSpace;
  102518. /**
  102519. * Gets wether the input of the processing is in Gamma or Linear Space.
  102520. */
  102521. get fromLinearSpace(): boolean;
  102522. /**
  102523. * Sets wether the input of the processing is in Gamma or Linear Space.
  102524. */
  102525. set fromLinearSpace(value: boolean);
  102526. /**
  102527. * Defines cache preventing GC.
  102528. */
  102529. private _defines;
  102530. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, imageProcessingConfiguration?: ImageProcessingConfiguration);
  102531. /**
  102532. * "ImageProcessingPostProcess"
  102533. * @returns "ImageProcessingPostProcess"
  102534. */
  102535. getClassName(): string;
  102536. /**
  102537. * @hidden
  102538. */
  102539. _updateParameters(): void;
  102540. dispose(camera?: Camera): void;
  102541. }
  102542. }
  102543. declare module BABYLON {
  102544. /** @hidden */
  102545. export var fibonacci: {
  102546. name: string;
  102547. shader: string;
  102548. };
  102549. }
  102550. declare module BABYLON {
  102551. /** @hidden */
  102552. export var subSurfaceScatteringFunctions: {
  102553. name: string;
  102554. shader: string;
  102555. };
  102556. }
  102557. declare module BABYLON {
  102558. /** @hidden */
  102559. export var diffusionProfile: {
  102560. name: string;
  102561. shader: string;
  102562. };
  102563. }
  102564. declare module BABYLON {
  102565. /** @hidden */
  102566. export var subSurfaceScatteringPixelShader: {
  102567. name: string;
  102568. shader: string;
  102569. };
  102570. }
  102571. declare module BABYLON {
  102572. /**
  102573. * Sub surface scattering post process
  102574. */
  102575. export class SubSurfaceScatteringPostProcess extends PostProcess {
  102576. /** @hidden */
  102577. texelWidth: number;
  102578. /** @hidden */
  102579. texelHeight: number;
  102580. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  102581. }
  102582. }
  102583. declare module BABYLON {
  102584. /**
  102585. * Interface for defining prepass effects in the prepass post-process pipeline
  102586. */
  102587. export interface PrePassEffectConfiguration {
  102588. /**
  102589. * Post process to attach for this effect
  102590. */
  102591. postProcess: PostProcess;
  102592. /**
  102593. * Is the effect enabled
  102594. */
  102595. enabled: boolean;
  102596. /**
  102597. * Disposes the effect configuration
  102598. */
  102599. dispose(): void;
  102600. /**
  102601. * Disposes the effect configuration
  102602. */
  102603. createPostProcess: () => PostProcess;
  102604. }
  102605. }
  102606. declare module BABYLON {
  102607. /**
  102608. * Contains all parameters needed for the prepass to perform
  102609. * screen space subsurface scattering
  102610. */
  102611. export class SubSurfaceConfiguration implements PrePassEffectConfiguration {
  102612. private _ssDiffusionS;
  102613. private _ssFilterRadii;
  102614. private _ssDiffusionD;
  102615. /**
  102616. * Post process to attach for screen space subsurface scattering
  102617. */
  102618. postProcess: SubSurfaceScatteringPostProcess;
  102619. /**
  102620. * Diffusion profile color for subsurface scattering
  102621. */
  102622. get ssDiffusionS(): number[];
  102623. /**
  102624. * Diffusion profile max color channel value for subsurface scattering
  102625. */
  102626. get ssDiffusionD(): number[];
  102627. /**
  102628. * Diffusion profile filter radius for subsurface scattering
  102629. */
  102630. get ssFilterRadii(): number[];
  102631. /**
  102632. * Is subsurface enabled
  102633. */
  102634. enabled: boolean;
  102635. /**
  102636. * Diffusion profile colors for subsurface scattering
  102637. * You can add one diffusion color using `addDiffusionProfile` on `scene.prePassRenderer`
  102638. * See ...
  102639. * Note that you can only store up to 5 of them
  102640. */
  102641. ssDiffusionProfileColors: Color3[];
  102642. /**
  102643. * Defines the ratio real world => scene units.
  102644. * Used for subsurface scattering
  102645. */
  102646. metersPerUnit: number;
  102647. private _scene;
  102648. /**
  102649. * Builds a subsurface configuration object
  102650. * @param scene The scene
  102651. */
  102652. constructor(scene: Scene);
  102653. /**
  102654. * Adds a new diffusion profile.
  102655. * Useful for more realistic subsurface scattering on diverse materials.
  102656. * @param color The color of the diffusion profile. Should be the average color of the material.
  102657. * @return The index of the diffusion profile for the material subsurface configuration
  102658. */
  102659. addDiffusionProfile(color: Color3): number;
  102660. /**
  102661. * Creates the sss post process
  102662. * @return The created post process
  102663. */
  102664. createPostProcess(): SubSurfaceScatteringPostProcess;
  102665. /**
  102666. * Deletes all diffusion profiles.
  102667. * Note that in order to render subsurface scattering, you should have at least 1 diffusion profile.
  102668. */
  102669. clearAllDiffusionProfiles(): void;
  102670. /**
  102671. * Disposes this object
  102672. */
  102673. dispose(): void;
  102674. /**
  102675. * @hidden
  102676. * https://zero-radiance.github.io/post/sampling-diffusion/
  102677. *
  102678. * Importance sample the normalized diffuse reflectance profile for the computed value of 's'.
  102679. * ------------------------------------------------------------------------------------
  102680. * R[r, phi, s] = s * (Exp[-r * s] + Exp[-r * s / 3]) / (8 * Pi * r)
  102681. * PDF[r, phi, s] = r * R[r, phi, s]
  102682. * CDF[r, s] = 1 - 1/4 * Exp[-r * s] - 3/4 * Exp[-r * s / 3]
  102683. * ------------------------------------------------------------------------------------
  102684. * We importance sample the color channel with the widest scattering distance.
  102685. */
  102686. getDiffusionProfileParameters(color: Color3): number;
  102687. /**
  102688. * Performs sampling of a Normalized Burley diffusion profile in polar coordinates.
  102689. * 'u' is the random number (the value of the CDF): [0, 1).
  102690. * rcp(s) = 1 / ShapeParam = ScatteringDistance.
  102691. * Returns the sampled radial distance, s.t. (u = 0 -> r = 0) and (u = 1 -> r = Inf).
  102692. */
  102693. private _sampleBurleyDiffusionProfile;
  102694. }
  102695. }
  102696. declare module BABYLON {
  102697. /**
  102698. * Renders a pre pass of the scene
  102699. * This means every mesh in the scene will be rendered to a render target texture
  102700. * And then this texture will be composited to the rendering canvas with post processes
  102701. * It is necessary for effects like subsurface scattering or deferred shading
  102702. */
  102703. export class PrePassRenderer {
  102704. /** @hidden */
  102705. static _SceneComponentInitialization: (scene: Scene) => void;
  102706. private _scene;
  102707. private _engine;
  102708. private _isDirty;
  102709. /**
  102710. * Number of textures in the multi render target texture where the scene is directly rendered
  102711. */
  102712. readonly mrtCount: number;
  102713. /**
  102714. * The render target where the scene is directly rendered
  102715. */
  102716. prePassRT: MultiRenderTarget;
  102717. private _mrtTypes;
  102718. private _multiRenderAttachments;
  102719. private _defaultAttachments;
  102720. private _clearAttachments;
  102721. private _postProcesses;
  102722. private readonly _clearColor;
  102723. /**
  102724. * Image processing post process for composition
  102725. */
  102726. imageProcessingPostProcess: ImageProcessingPostProcess;
  102727. /**
  102728. * Configuration for sub surface scattering post process
  102729. */
  102730. subSurfaceConfiguration: SubSurfaceConfiguration;
  102731. /**
  102732. * Should materials render their geometry on the MRT
  102733. */
  102734. materialsShouldRenderGeometry: boolean;
  102735. /**
  102736. * Should materials render the irradiance information on the MRT
  102737. */
  102738. materialsShouldRenderIrradiance: boolean;
  102739. private _enabled;
  102740. /**
  102741. * Indicates if the prepass is enabled
  102742. */
  102743. get enabled(): boolean;
  102744. /**
  102745. * How many samples are used for MSAA of the scene render target
  102746. */
  102747. get samples(): number;
  102748. set samples(n: number);
  102749. /**
  102750. * Instanciates a prepass renderer
  102751. * @param scene The scene
  102752. */
  102753. constructor(scene: Scene);
  102754. private _initializeAttachments;
  102755. private _createCompositionEffect;
  102756. /**
  102757. * Indicates if rendering a prepass is supported
  102758. */
  102759. get isSupported(): boolean;
  102760. /**
  102761. * Sets the proper output textures to draw in the engine.
  102762. * @param effect The effect that is drawn. It can be or not be compatible with drawing to several output textures.
  102763. */
  102764. bindAttachmentsForEffect(effect: Effect): void;
  102765. /**
  102766. * @hidden
  102767. */
  102768. _beforeCameraDraw(): void;
  102769. /**
  102770. * @hidden
  102771. */
  102772. _afterCameraDraw(): void;
  102773. private _checkRTSize;
  102774. private _bindFrameBuffer;
  102775. /**
  102776. * Clears the scene render target (in the sense of settings pixels to the scene clear color value)
  102777. */
  102778. clear(): void;
  102779. private _setState;
  102780. private _enable;
  102781. private _disable;
  102782. private _resetPostProcessChain;
  102783. private _bindPostProcessChain;
  102784. /**
  102785. * Marks the prepass renderer as dirty, triggering a check if the prepass is necessary for the next rendering.
  102786. */
  102787. markAsDirty(): void;
  102788. private _update;
  102789. /**
  102790. * Disposes the prepass renderer.
  102791. */
  102792. dispose(): void;
  102793. }
  102794. }
  102795. declare module BABYLON {
  102796. /**
  102797. * Options for compiling materials.
  102798. */
  102799. export interface IMaterialCompilationOptions {
  102800. /**
  102801. * Defines whether clip planes are enabled.
  102802. */
  102803. clipPlane: boolean;
  102804. /**
  102805. * Defines whether instances are enabled.
  102806. */
  102807. useInstances: boolean;
  102808. }
  102809. /**
  102810. * Options passed when calling customShaderNameResolve
  102811. */
  102812. export interface ICustomShaderNameResolveOptions {
  102813. /**
  102814. * 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
  102815. */
  102816. processFinalCode?: Nullable<(shaderType: string, code: string) => string>;
  102817. }
  102818. /**
  102819. * Base class for the main features of a material in Babylon.js
  102820. */
  102821. export class Material implements IAnimatable {
  102822. /**
  102823. * Returns the triangle fill mode
  102824. */
  102825. static readonly TriangleFillMode: number;
  102826. /**
  102827. * Returns the wireframe mode
  102828. */
  102829. static readonly WireFrameFillMode: number;
  102830. /**
  102831. * Returns the point fill mode
  102832. */
  102833. static readonly PointFillMode: number;
  102834. /**
  102835. * Returns the point list draw mode
  102836. */
  102837. static readonly PointListDrawMode: number;
  102838. /**
  102839. * Returns the line list draw mode
  102840. */
  102841. static readonly LineListDrawMode: number;
  102842. /**
  102843. * Returns the line loop draw mode
  102844. */
  102845. static readonly LineLoopDrawMode: number;
  102846. /**
  102847. * Returns the line strip draw mode
  102848. */
  102849. static readonly LineStripDrawMode: number;
  102850. /**
  102851. * Returns the triangle strip draw mode
  102852. */
  102853. static readonly TriangleStripDrawMode: number;
  102854. /**
  102855. * Returns the triangle fan draw mode
  102856. */
  102857. static readonly TriangleFanDrawMode: number;
  102858. /**
  102859. * Stores the clock-wise side orientation
  102860. */
  102861. static readonly ClockWiseSideOrientation: number;
  102862. /**
  102863. * Stores the counter clock-wise side orientation
  102864. */
  102865. static readonly CounterClockWiseSideOrientation: number;
  102866. /**
  102867. * The dirty texture flag value
  102868. */
  102869. static readonly TextureDirtyFlag: number;
  102870. /**
  102871. * The dirty light flag value
  102872. */
  102873. static readonly LightDirtyFlag: number;
  102874. /**
  102875. * The dirty fresnel flag value
  102876. */
  102877. static readonly FresnelDirtyFlag: number;
  102878. /**
  102879. * The dirty attribute flag value
  102880. */
  102881. static readonly AttributesDirtyFlag: number;
  102882. /**
  102883. * The dirty misc flag value
  102884. */
  102885. static readonly MiscDirtyFlag: number;
  102886. /**
  102887. * The all dirty flag value
  102888. */
  102889. static readonly AllDirtyFlag: number;
  102890. /**
  102891. * MaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  102892. */
  102893. static readonly MATERIAL_OPAQUE: number;
  102894. /**
  102895. * MaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  102896. */
  102897. static readonly MATERIAL_ALPHATEST: number;
  102898. /**
  102899. * MaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  102900. */
  102901. static readonly MATERIAL_ALPHABLEND: number;
  102902. /**
  102903. * MaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  102904. * They are also discarded below the alpha cutoff threshold to improve performances.
  102905. */
  102906. static readonly MATERIAL_ALPHATESTANDBLEND: number;
  102907. /**
  102908. * The Whiteout method is used to blend normals.
  102909. * Details of the algorithm can be found here: https://blog.selfshadow.com/publications/blending-in-detail/
  102910. */
  102911. static readonly MATERIAL_NORMALBLENDMETHOD_WHITEOUT: number;
  102912. /**
  102913. * The Reoriented Normal Mapping method is used to blend normals.
  102914. * Details of the algorithm can be found here: https://blog.selfshadow.com/publications/blending-in-detail/
  102915. */
  102916. static readonly MATERIAL_NORMALBLENDMETHOD_RNM: number;
  102917. /**
  102918. * Custom callback helping to override the default shader used in the material.
  102919. */
  102920. customShaderNameResolve: (shaderName: string, uniforms: string[], uniformBuffers: string[], samplers: string[], defines: MaterialDefines | string[], attributes?: string[], options?: ICustomShaderNameResolveOptions) => string;
  102921. /**
  102922. * Custom shadow depth material to use for shadow rendering instead of the in-built one
  102923. */
  102924. shadowDepthWrapper: Nullable<ShadowDepthWrapper>;
  102925. /**
  102926. * Gets or sets a boolean indicating that the material is allowed (if supported) to do shader hot swapping.
  102927. * This means that the material can keep using a previous shader while a new one is being compiled.
  102928. * This is mostly used when shader parallel compilation is supported (true by default)
  102929. */
  102930. allowShaderHotSwapping: boolean;
  102931. /**
  102932. * The ID of the material
  102933. */
  102934. id: string;
  102935. /**
  102936. * Gets or sets the unique id of the material
  102937. */
  102938. uniqueId: number;
  102939. /**
  102940. * The name of the material
  102941. */
  102942. name: string;
  102943. /**
  102944. * Gets or sets user defined metadata
  102945. */
  102946. metadata: any;
  102947. /**
  102948. * For internal use only. Please do not use.
  102949. */
  102950. reservedDataStore: any;
  102951. /**
  102952. * Specifies if the ready state should be checked on each call
  102953. */
  102954. checkReadyOnEveryCall: boolean;
  102955. /**
  102956. * Specifies if the ready state should be checked once
  102957. */
  102958. checkReadyOnlyOnce: boolean;
  102959. /**
  102960. * The state of the material
  102961. */
  102962. state: string;
  102963. /**
  102964. * If the material can be rendered to several textures with MRT extension
  102965. */
  102966. get canRenderToMRT(): boolean;
  102967. /**
  102968. * The alpha value of the material
  102969. */
  102970. protected _alpha: number;
  102971. /**
  102972. * List of inspectable custom properties (used by the Inspector)
  102973. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  102974. */
  102975. inspectableCustomProperties: IInspectable[];
  102976. /**
  102977. * Sets the alpha value of the material
  102978. */
  102979. set alpha(value: number);
  102980. /**
  102981. * Gets the alpha value of the material
  102982. */
  102983. get alpha(): number;
  102984. /**
  102985. * Specifies if back face culling is enabled
  102986. */
  102987. protected _backFaceCulling: boolean;
  102988. /**
  102989. * Sets the back-face culling state
  102990. */
  102991. set backFaceCulling(value: boolean);
  102992. /**
  102993. * Gets the back-face culling state
  102994. */
  102995. get backFaceCulling(): boolean;
  102996. /**
  102997. * Stores the value for side orientation
  102998. */
  102999. sideOrientation: number;
  103000. /**
  103001. * Callback triggered when the material is compiled
  103002. */
  103003. onCompiled: Nullable<(effect: Effect) => void>;
  103004. /**
  103005. * Callback triggered when an error occurs
  103006. */
  103007. onError: Nullable<(effect: Effect, errors: string) => void>;
  103008. /**
  103009. * Callback triggered to get the render target textures
  103010. */
  103011. getRenderTargetTextures: Nullable<() => SmartArray<RenderTargetTexture>>;
  103012. /**
  103013. * Gets a boolean indicating that current material needs to register RTT
  103014. */
  103015. get hasRenderTargetTextures(): boolean;
  103016. /**
  103017. * Specifies if the material should be serialized
  103018. */
  103019. doNotSerialize: boolean;
  103020. /**
  103021. * @hidden
  103022. */
  103023. _storeEffectOnSubMeshes: boolean;
  103024. /**
  103025. * Stores the animations for the material
  103026. */
  103027. animations: Nullable<Array<Animation>>;
  103028. /**
  103029. * An event triggered when the material is disposed
  103030. */
  103031. onDisposeObservable: Observable<Material>;
  103032. /**
  103033. * An observer which watches for dispose events
  103034. */
  103035. private _onDisposeObserver;
  103036. private _onUnBindObservable;
  103037. /**
  103038. * Called during a dispose event
  103039. */
  103040. set onDispose(callback: () => void);
  103041. private _onBindObservable;
  103042. /**
  103043. * An event triggered when the material is bound
  103044. */
  103045. get onBindObservable(): Observable<AbstractMesh>;
  103046. /**
  103047. * An observer which watches for bind events
  103048. */
  103049. private _onBindObserver;
  103050. /**
  103051. * Called during a bind event
  103052. */
  103053. set onBind(callback: (Mesh: AbstractMesh) => void);
  103054. /**
  103055. * An event triggered when the material is unbound
  103056. */
  103057. get onUnBindObservable(): Observable<Material>;
  103058. protected _onEffectCreatedObservable: Nullable<Observable<{
  103059. effect: Effect;
  103060. subMesh: Nullable<SubMesh>;
  103061. }>>;
  103062. /**
  103063. * An event triggered when the effect is (re)created
  103064. */
  103065. get onEffectCreatedObservable(): Observable<{
  103066. effect: Effect;
  103067. subMesh: Nullable<SubMesh>;
  103068. }>;
  103069. /**
  103070. * Stores the value of the alpha mode
  103071. */
  103072. private _alphaMode;
  103073. /**
  103074. * Sets the value of the alpha mode.
  103075. *
  103076. * | Value | Type | Description |
  103077. * | --- | --- | --- |
  103078. * | 0 | ALPHA_DISABLE | |
  103079. * | 1 | ALPHA_ADD | |
  103080. * | 2 | ALPHA_COMBINE | |
  103081. * | 3 | ALPHA_SUBTRACT | |
  103082. * | 4 | ALPHA_MULTIPLY | |
  103083. * | 5 | ALPHA_MAXIMIZED | |
  103084. * | 6 | ALPHA_ONEONE | |
  103085. * | 7 | ALPHA_PREMULTIPLIED | |
  103086. * | 8 | ALPHA_PREMULTIPLIED_PORTERDUFF | |
  103087. * | 9 | ALPHA_INTERPOLATE | |
  103088. * | 10 | ALPHA_SCREENMODE | |
  103089. *
  103090. */
  103091. set alphaMode(value: number);
  103092. /**
  103093. * Gets the value of the alpha mode
  103094. */
  103095. get alphaMode(): number;
  103096. /**
  103097. * Stores the state of the need depth pre-pass value
  103098. */
  103099. private _needDepthPrePass;
  103100. /**
  103101. * Sets the need depth pre-pass value
  103102. */
  103103. set needDepthPrePass(value: boolean);
  103104. /**
  103105. * Gets the depth pre-pass value
  103106. */
  103107. get needDepthPrePass(): boolean;
  103108. /**
  103109. * Specifies if depth writing should be disabled
  103110. */
  103111. disableDepthWrite: boolean;
  103112. /**
  103113. * Specifies if color writing should be disabled
  103114. */
  103115. disableColorWrite: boolean;
  103116. /**
  103117. * Specifies if depth writing should be forced
  103118. */
  103119. forceDepthWrite: boolean;
  103120. /**
  103121. * Specifies the depth function that should be used. 0 means the default engine function
  103122. */
  103123. depthFunction: number;
  103124. /**
  103125. * Specifies if there should be a separate pass for culling
  103126. */
  103127. separateCullingPass: boolean;
  103128. /**
  103129. * Stores the state specifing if fog should be enabled
  103130. */
  103131. private _fogEnabled;
  103132. /**
  103133. * Sets the state for enabling fog
  103134. */
  103135. set fogEnabled(value: boolean);
  103136. /**
  103137. * Gets the value of the fog enabled state
  103138. */
  103139. get fogEnabled(): boolean;
  103140. /**
  103141. * Stores the size of points
  103142. */
  103143. pointSize: number;
  103144. /**
  103145. * Stores the z offset value
  103146. */
  103147. zOffset: number;
  103148. get wireframe(): boolean;
  103149. /**
  103150. * Sets the state of wireframe mode
  103151. */
  103152. set wireframe(value: boolean);
  103153. /**
  103154. * Gets the value specifying if point clouds are enabled
  103155. */
  103156. get pointsCloud(): boolean;
  103157. /**
  103158. * Sets the state of point cloud mode
  103159. */
  103160. set pointsCloud(value: boolean);
  103161. /**
  103162. * Gets the material fill mode
  103163. */
  103164. get fillMode(): number;
  103165. /**
  103166. * Sets the material fill mode
  103167. */
  103168. set fillMode(value: number);
  103169. /**
  103170. * @hidden
  103171. * Stores the effects for the material
  103172. */
  103173. _effect: Nullable<Effect>;
  103174. /**
  103175. * Specifies if uniform buffers should be used
  103176. */
  103177. private _useUBO;
  103178. /**
  103179. * Stores a reference to the scene
  103180. */
  103181. private _scene;
  103182. /**
  103183. * Stores the fill mode state
  103184. */
  103185. private _fillMode;
  103186. /**
  103187. * Specifies if the depth write state should be cached
  103188. */
  103189. private _cachedDepthWriteState;
  103190. /**
  103191. * Specifies if the color write state should be cached
  103192. */
  103193. private _cachedColorWriteState;
  103194. /**
  103195. * Specifies if the depth function state should be cached
  103196. */
  103197. private _cachedDepthFunctionState;
  103198. /**
  103199. * Stores the uniform buffer
  103200. */
  103201. protected _uniformBuffer: UniformBuffer;
  103202. /** @hidden */
  103203. _indexInSceneMaterialArray: number;
  103204. /** @hidden */
  103205. meshMap: Nullable<{
  103206. [id: string]: AbstractMesh | undefined;
  103207. }>;
  103208. /**
  103209. * Creates a material instance
  103210. * @param name defines the name of the material
  103211. * @param scene defines the scene to reference
  103212. * @param doNotAdd specifies if the material should be added to the scene
  103213. */
  103214. constructor(name: string, scene: Scene, doNotAdd?: boolean);
  103215. /**
  103216. * Returns a string representation of the current material
  103217. * @param fullDetails defines a boolean indicating which levels of logging is desired
  103218. * @returns a string with material information
  103219. */
  103220. toString(fullDetails?: boolean): string;
  103221. /**
  103222. * Gets the class name of the material
  103223. * @returns a string with the class name of the material
  103224. */
  103225. getClassName(): string;
  103226. /**
  103227. * Specifies if updates for the material been locked
  103228. */
  103229. get isFrozen(): boolean;
  103230. /**
  103231. * Locks updates for the material
  103232. */
  103233. freeze(): void;
  103234. /**
  103235. * Unlocks updates for the material
  103236. */
  103237. unfreeze(): void;
  103238. /**
  103239. * Specifies if the material is ready to be used
  103240. * @param mesh defines the mesh to check
  103241. * @param useInstances specifies if instances should be used
  103242. * @returns a boolean indicating if the material is ready to be used
  103243. */
  103244. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  103245. /**
  103246. * Specifies that the submesh is ready to be used
  103247. * @param mesh defines the mesh to check
  103248. * @param subMesh defines which submesh to check
  103249. * @param useInstances specifies that instances should be used
  103250. * @returns a boolean indicating that the submesh is ready or not
  103251. */
  103252. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  103253. /**
  103254. * Returns the material effect
  103255. * @returns the effect associated with the material
  103256. */
  103257. getEffect(): Nullable<Effect>;
  103258. /**
  103259. * Returns the current scene
  103260. * @returns a Scene
  103261. */
  103262. getScene(): Scene;
  103263. /**
  103264. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  103265. */
  103266. protected _forceAlphaTest: boolean;
  103267. /**
  103268. * The transparency mode of the material.
  103269. */
  103270. protected _transparencyMode: Nullable<number>;
  103271. /**
  103272. * Gets the current transparency mode.
  103273. */
  103274. get transparencyMode(): Nullable<number>;
  103275. /**
  103276. * Sets the transparency mode of the material.
  103277. *
  103278. * | Value | Type | Description |
  103279. * | ----- | ----------------------------------- | ----------- |
  103280. * | 0 | OPAQUE | |
  103281. * | 1 | ALPHATEST | |
  103282. * | 2 | ALPHABLEND | |
  103283. * | 3 | ALPHATESTANDBLEND | |
  103284. *
  103285. */
  103286. set transparencyMode(value: Nullable<number>);
  103287. /**
  103288. * Returns true if alpha blending should be disabled.
  103289. */
  103290. protected get _disableAlphaBlending(): boolean;
  103291. /**
  103292. * Specifies whether or not this material should be rendered in alpha blend mode.
  103293. * @returns a boolean specifying if alpha blending is needed
  103294. */
  103295. needAlphaBlending(): boolean;
  103296. /**
  103297. * Specifies if the mesh will require alpha blending
  103298. * @param mesh defines the mesh to check
  103299. * @returns a boolean specifying if alpha blending is needed for the mesh
  103300. */
  103301. needAlphaBlendingForMesh(mesh: AbstractMesh): boolean;
  103302. /**
  103303. * Specifies whether or not this material should be rendered in alpha test mode.
  103304. * @returns a boolean specifying if an alpha test is needed.
  103305. */
  103306. needAlphaTesting(): boolean;
  103307. /**
  103308. * Specifies if material alpha testing should be turned on for the mesh
  103309. * @param mesh defines the mesh to check
  103310. */
  103311. protected _shouldTurnAlphaTestOn(mesh: AbstractMesh): boolean;
  103312. /**
  103313. * Gets the texture used for the alpha test
  103314. * @returns the texture to use for alpha testing
  103315. */
  103316. getAlphaTestTexture(): Nullable<BaseTexture>;
  103317. /**
  103318. * Marks the material to indicate that it needs to be re-calculated
  103319. */
  103320. markDirty(): void;
  103321. /** @hidden */
  103322. _preBind(effect?: Effect, overrideOrientation?: Nullable<number>): boolean;
  103323. /**
  103324. * Binds the material to the mesh
  103325. * @param world defines the world transformation matrix
  103326. * @param mesh defines the mesh to bind the material to
  103327. */
  103328. bind(world: Matrix, mesh?: Mesh): void;
  103329. /**
  103330. * Binds the submesh to the material
  103331. * @param world defines the world transformation matrix
  103332. * @param mesh defines the mesh containing the submesh
  103333. * @param subMesh defines the submesh to bind the material to
  103334. */
  103335. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  103336. /**
  103337. * Binds the world matrix to the material
  103338. * @param world defines the world transformation matrix
  103339. */
  103340. bindOnlyWorldMatrix(world: Matrix): void;
  103341. /**
  103342. * Binds the scene's uniform buffer to the effect.
  103343. * @param effect defines the effect to bind to the scene uniform buffer
  103344. * @param sceneUbo defines the uniform buffer storing scene data
  103345. */
  103346. bindSceneUniformBuffer(effect: Effect, sceneUbo: UniformBuffer): void;
  103347. /**
  103348. * Binds the view matrix to the effect
  103349. * @param effect defines the effect to bind the view matrix to
  103350. */
  103351. bindView(effect: Effect): void;
  103352. /**
  103353. * Binds the view projection matrix to the effect
  103354. * @param effect defines the effect to bind the view projection matrix to
  103355. */
  103356. bindViewProjection(effect: Effect): void;
  103357. /**
  103358. * Processes to execute after binding the material to a mesh
  103359. * @param mesh defines the rendered mesh
  103360. */
  103361. protected _afterBind(mesh?: Mesh): void;
  103362. /**
  103363. * Unbinds the material from the mesh
  103364. */
  103365. unbind(): void;
  103366. /**
  103367. * Gets the active textures from the material
  103368. * @returns an array of textures
  103369. */
  103370. getActiveTextures(): BaseTexture[];
  103371. /**
  103372. * Specifies if the material uses a texture
  103373. * @param texture defines the texture to check against the material
  103374. * @returns a boolean specifying if the material uses the texture
  103375. */
  103376. hasTexture(texture: BaseTexture): boolean;
  103377. /**
  103378. * Makes a duplicate of the material, and gives it a new name
  103379. * @param name defines the new name for the duplicated material
  103380. * @returns the cloned material
  103381. */
  103382. clone(name: string): Nullable<Material>;
  103383. /**
  103384. * Gets the meshes bound to the material
  103385. * @returns an array of meshes bound to the material
  103386. */
  103387. getBindedMeshes(): AbstractMesh[];
  103388. /**
  103389. * Force shader compilation
  103390. * @param mesh defines the mesh associated with this material
  103391. * @param onCompiled defines a function to execute once the material is compiled
  103392. * @param options defines the options to configure the compilation
  103393. * @param onError defines a function to execute if the material fails compiling
  103394. */
  103395. forceCompilation(mesh: AbstractMesh, onCompiled?: (material: Material) => void, options?: Partial<IMaterialCompilationOptions>, onError?: (reason: string) => void): void;
  103396. /**
  103397. * Force shader compilation
  103398. * @param mesh defines the mesh that will use this material
  103399. * @param options defines additional options for compiling the shaders
  103400. * @returns a promise that resolves when the compilation completes
  103401. */
  103402. forceCompilationAsync(mesh: AbstractMesh, options?: Partial<IMaterialCompilationOptions>): Promise<void>;
  103403. private static readonly _AllDirtyCallBack;
  103404. private static readonly _ImageProcessingDirtyCallBack;
  103405. private static readonly _TextureDirtyCallBack;
  103406. private static readonly _FresnelDirtyCallBack;
  103407. private static readonly _MiscDirtyCallBack;
  103408. private static readonly _LightsDirtyCallBack;
  103409. private static readonly _AttributeDirtyCallBack;
  103410. private static _FresnelAndMiscDirtyCallBack;
  103411. private static _TextureAndMiscDirtyCallBack;
  103412. private static readonly _DirtyCallbackArray;
  103413. private static readonly _RunDirtyCallBacks;
  103414. /**
  103415. * Marks a define in the material to indicate that it needs to be re-computed
  103416. * @param flag defines a flag used to determine which parts of the material have to be marked as dirty
  103417. */
  103418. markAsDirty(flag: number): void;
  103419. /**
  103420. * Marks all submeshes of a material to indicate that their material defines need to be re-calculated
  103421. * @param func defines a function which checks material defines against the submeshes
  103422. */
  103423. protected _markAllSubMeshesAsDirty(func: (defines: MaterialDefines) => void): void;
  103424. /**
  103425. * Indicates that the scene should check if the rendering now needs a prepass
  103426. */
  103427. protected _markScenePrePassDirty(): void;
  103428. /**
  103429. * Indicates that we need to re-calculated for all submeshes
  103430. */
  103431. protected _markAllSubMeshesAsAllDirty(): void;
  103432. /**
  103433. * Indicates that image processing needs to be re-calculated for all submeshes
  103434. */
  103435. protected _markAllSubMeshesAsImageProcessingDirty(): void;
  103436. /**
  103437. * Indicates that textures need to be re-calculated for all submeshes
  103438. */
  103439. protected _markAllSubMeshesAsTexturesDirty(): void;
  103440. /**
  103441. * Indicates that fresnel needs to be re-calculated for all submeshes
  103442. */
  103443. protected _markAllSubMeshesAsFresnelDirty(): void;
  103444. /**
  103445. * Indicates that fresnel and misc need to be re-calculated for all submeshes
  103446. */
  103447. protected _markAllSubMeshesAsFresnelAndMiscDirty(): void;
  103448. /**
  103449. * Indicates that lights need to be re-calculated for all submeshes
  103450. */
  103451. protected _markAllSubMeshesAsLightsDirty(): void;
  103452. /**
  103453. * Indicates that attributes need to be re-calculated for all submeshes
  103454. */
  103455. protected _markAllSubMeshesAsAttributesDirty(): void;
  103456. /**
  103457. * Indicates that misc needs to be re-calculated for all submeshes
  103458. */
  103459. protected _markAllSubMeshesAsMiscDirty(): void;
  103460. /**
  103461. * Indicates that textures and misc need to be re-calculated for all submeshes
  103462. */
  103463. protected _markAllSubMeshesAsTexturesAndMiscDirty(): void;
  103464. /**
  103465. * Sets the required values to the prepass renderer.
  103466. * @param prePassRenderer defines the prepass renderer to setup.
  103467. * @returns true if the pre pass is needed.
  103468. */
  103469. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  103470. /**
  103471. * Disposes the material
  103472. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  103473. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  103474. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  103475. */
  103476. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  103477. /** @hidden */
  103478. private releaseVertexArrayObject;
  103479. /**
  103480. * Serializes this material
  103481. * @returns the serialized material object
  103482. */
  103483. serialize(): any;
  103484. /**
  103485. * Creates a material from parsed material data
  103486. * @param parsedMaterial defines parsed material data
  103487. * @param scene defines the hosting scene
  103488. * @param rootUrl defines the root URL to use to load textures
  103489. * @returns a new material
  103490. */
  103491. static Parse(parsedMaterial: any, scene: Scene, rootUrl: string): Nullable<Material>;
  103492. }
  103493. }
  103494. declare module BABYLON {
  103495. /**
  103496. * A multi-material is used to apply different materials to different parts of the same object without the need of
  103497. * separate meshes. This can be use to improve performances.
  103498. * @see https://doc.babylonjs.com/how_to/multi_materials
  103499. */
  103500. export class MultiMaterial extends Material {
  103501. private _subMaterials;
  103502. /**
  103503. * Gets or Sets the list of Materials used within the multi material.
  103504. * They need to be ordered according to the submeshes order in the associated mesh
  103505. */
  103506. get subMaterials(): Nullable<Material>[];
  103507. set subMaterials(value: Nullable<Material>[]);
  103508. /**
  103509. * Function used to align with Node.getChildren()
  103510. * @returns the list of Materials used within the multi material
  103511. */
  103512. getChildren(): Nullable<Material>[];
  103513. /**
  103514. * Instantiates a new Multi Material
  103515. * A multi-material is used to apply different materials to different parts of the same object without the need of
  103516. * separate meshes. This can be use to improve performances.
  103517. * @see https://doc.babylonjs.com/how_to/multi_materials
  103518. * @param name Define the name in the scene
  103519. * @param scene Define the scene the material belongs to
  103520. */
  103521. constructor(name: string, scene: Scene);
  103522. private _hookArray;
  103523. /**
  103524. * Get one of the submaterial by its index in the submaterials array
  103525. * @param index The index to look the sub material at
  103526. * @returns The Material if the index has been defined
  103527. */
  103528. getSubMaterial(index: number): Nullable<Material>;
  103529. /**
  103530. * Get the list of active textures for the whole sub materials list.
  103531. * @returns All the textures that will be used during the rendering
  103532. */
  103533. getActiveTextures(): BaseTexture[];
  103534. /**
  103535. * Gets the current class name of the material e.g. "MultiMaterial"
  103536. * Mainly use in serialization.
  103537. * @returns the class name
  103538. */
  103539. getClassName(): string;
  103540. /**
  103541. * Checks if the material is ready to render the requested sub mesh
  103542. * @param mesh Define the mesh the submesh belongs to
  103543. * @param subMesh Define the sub mesh to look readyness for
  103544. * @param useInstances Define whether or not the material is used with instances
  103545. * @returns true if ready, otherwise false
  103546. */
  103547. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  103548. /**
  103549. * Clones the current material and its related sub materials
  103550. * @param name Define the name of the newly cloned material
  103551. * @param cloneChildren Define if submaterial will be cloned or shared with the parent instance
  103552. * @returns the cloned material
  103553. */
  103554. clone(name: string, cloneChildren?: boolean): MultiMaterial;
  103555. /**
  103556. * Serializes the materials into a JSON representation.
  103557. * @returns the JSON representation
  103558. */
  103559. serialize(): any;
  103560. /**
  103561. * Dispose the material and release its associated resources
  103562. * @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)
  103563. * @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)
  103564. * @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)
  103565. */
  103566. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, forceDisposeChildren?: boolean): void;
  103567. /**
  103568. * Creates a MultiMaterial from parsed MultiMaterial data.
  103569. * @param parsedMultiMaterial defines parsed MultiMaterial data.
  103570. * @param scene defines the hosting scene
  103571. * @returns a new MultiMaterial
  103572. */
  103573. static ParseMultiMaterial(parsedMultiMaterial: any, scene: Scene): MultiMaterial;
  103574. }
  103575. }
  103576. declare module BABYLON {
  103577. /**
  103578. * Defines a subdivision inside a mesh
  103579. */
  103580. export class SubMesh implements ICullable {
  103581. /** the material index to use */
  103582. materialIndex: number;
  103583. /** vertex index start */
  103584. verticesStart: number;
  103585. /** vertices count */
  103586. verticesCount: number;
  103587. /** index start */
  103588. indexStart: number;
  103589. /** indices count */
  103590. indexCount: number;
  103591. /** @hidden */
  103592. _materialDefines: Nullable<MaterialDefines>;
  103593. /** @hidden */
  103594. _materialEffect: Nullable<Effect>;
  103595. /** @hidden */
  103596. _effectOverride: Nullable<Effect>;
  103597. /**
  103598. * Gets material defines used by the effect associated to the sub mesh
  103599. */
  103600. get materialDefines(): Nullable<MaterialDefines>;
  103601. /**
  103602. * Sets material defines used by the effect associated to the sub mesh
  103603. */
  103604. set materialDefines(defines: Nullable<MaterialDefines>);
  103605. /**
  103606. * Gets associated effect
  103607. */
  103608. get effect(): Nullable<Effect>;
  103609. /**
  103610. * Sets associated effect (effect used to render this submesh)
  103611. * @param effect defines the effect to associate with
  103612. * @param defines defines the set of defines used to compile this effect
  103613. */
  103614. setEffect(effect: Nullable<Effect>, defines?: Nullable<MaterialDefines>): void;
  103615. /** @hidden */
  103616. _linesIndexCount: number;
  103617. private _mesh;
  103618. private _renderingMesh;
  103619. private _boundingInfo;
  103620. private _linesIndexBuffer;
  103621. /** @hidden */
  103622. _lastColliderWorldVertices: Nullable<Vector3[]>;
  103623. /** @hidden */
  103624. _trianglePlanes: Plane[];
  103625. /** @hidden */
  103626. _lastColliderTransformMatrix: Nullable<Matrix>;
  103627. /** @hidden */
  103628. _renderId: number;
  103629. /** @hidden */
  103630. _alphaIndex: number;
  103631. /** @hidden */
  103632. _distanceToCamera: number;
  103633. /** @hidden */
  103634. _id: number;
  103635. private _currentMaterial;
  103636. /**
  103637. * Add a new submesh to a mesh
  103638. * @param materialIndex defines the material index to use
  103639. * @param verticesStart defines vertex index start
  103640. * @param verticesCount defines vertices count
  103641. * @param indexStart defines index start
  103642. * @param indexCount defines indices count
  103643. * @param mesh defines the parent mesh
  103644. * @param renderingMesh defines an optional rendering mesh
  103645. * @param createBoundingBox defines if bounding box should be created for this submesh
  103646. * @returns the new submesh
  103647. */
  103648. static AddToMesh(materialIndex: number, verticesStart: number, verticesCount: number, indexStart: number, indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh, createBoundingBox?: boolean): SubMesh;
  103649. /**
  103650. * Creates a new submesh
  103651. * @param materialIndex defines the material index to use
  103652. * @param verticesStart defines vertex index start
  103653. * @param verticesCount defines vertices count
  103654. * @param indexStart defines index start
  103655. * @param indexCount defines indices count
  103656. * @param mesh defines the parent mesh
  103657. * @param renderingMesh defines an optional rendering mesh
  103658. * @param createBoundingBox defines if bounding box should be created for this submesh
  103659. * @param addToMesh defines a boolean indicating that the submesh must be added to the mesh.subMeshes array (true by default)
  103660. */
  103661. constructor(
  103662. /** the material index to use */
  103663. materialIndex: number,
  103664. /** vertex index start */
  103665. verticesStart: number,
  103666. /** vertices count */
  103667. verticesCount: number,
  103668. /** index start */
  103669. indexStart: number,
  103670. /** indices count */
  103671. indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh, createBoundingBox?: boolean, addToMesh?: boolean);
  103672. /**
  103673. * Returns true if this submesh covers the entire parent mesh
  103674. * @ignorenaming
  103675. */
  103676. get IsGlobal(): boolean;
  103677. /**
  103678. * Returns the submesh BoudingInfo object
  103679. * @returns current bounding info (or mesh's one if the submesh is global)
  103680. */
  103681. getBoundingInfo(): BoundingInfo;
  103682. /**
  103683. * Sets the submesh BoundingInfo
  103684. * @param boundingInfo defines the new bounding info to use
  103685. * @returns the SubMesh
  103686. */
  103687. setBoundingInfo(boundingInfo: BoundingInfo): SubMesh;
  103688. /**
  103689. * Returns the mesh of the current submesh
  103690. * @return the parent mesh
  103691. */
  103692. getMesh(): AbstractMesh;
  103693. /**
  103694. * Returns the rendering mesh of the submesh
  103695. * @returns the rendering mesh (could be different from parent mesh)
  103696. */
  103697. getRenderingMesh(): Mesh;
  103698. /**
  103699. * Returns the replacement mesh of the submesh
  103700. * @returns the replacement mesh (could be different from parent mesh)
  103701. */
  103702. getReplacementMesh(): Nullable<AbstractMesh>;
  103703. /**
  103704. * Returns the effective mesh of the submesh
  103705. * @returns the effective mesh (could be different from parent mesh)
  103706. */
  103707. getEffectiveMesh(): AbstractMesh;
  103708. /**
  103709. * Returns the submesh material
  103710. * @returns null or the current material
  103711. */
  103712. getMaterial(): Nullable<Material>;
  103713. private _IsMultiMaterial;
  103714. /**
  103715. * Sets a new updated BoundingInfo object to the submesh
  103716. * @param data defines an optional position array to use to determine the bounding info
  103717. * @returns the SubMesh
  103718. */
  103719. refreshBoundingInfo(data?: Nullable<FloatArray>): SubMesh;
  103720. /** @hidden */
  103721. _checkCollision(collider: Collider): boolean;
  103722. /**
  103723. * Updates the submesh BoundingInfo
  103724. * @param world defines the world matrix to use to update the bounding info
  103725. * @returns the submesh
  103726. */
  103727. updateBoundingInfo(world: DeepImmutable<Matrix>): SubMesh;
  103728. /**
  103729. * True is the submesh bounding box intersects the frustum defined by the passed array of planes.
  103730. * @param frustumPlanes defines the frustum planes
  103731. * @returns true if the submesh is intersecting with the frustum
  103732. */
  103733. isInFrustum(frustumPlanes: Plane[]): boolean;
  103734. /**
  103735. * True is the submesh bounding box is completely inside the frustum defined by the passed array of planes
  103736. * @param frustumPlanes defines the frustum planes
  103737. * @returns true if the submesh is inside the frustum
  103738. */
  103739. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  103740. /**
  103741. * Renders the submesh
  103742. * @param enableAlphaMode defines if alpha needs to be used
  103743. * @returns the submesh
  103744. */
  103745. render(enableAlphaMode: boolean): SubMesh;
  103746. /**
  103747. * @hidden
  103748. */
  103749. _getLinesIndexBuffer(indices: IndicesArray, engine: Engine): DataBuffer;
  103750. /**
  103751. * Checks if the submesh intersects with a ray
  103752. * @param ray defines the ray to test
  103753. * @returns true is the passed ray intersects the submesh bounding box
  103754. */
  103755. canIntersects(ray: Ray): boolean;
  103756. /**
  103757. * Intersects current submesh with a ray
  103758. * @param ray defines the ray to test
  103759. * @param positions defines mesh's positions array
  103760. * @param indices defines mesh's indices array
  103761. * @param fastCheck defines if the first intersection will be used (and not the closest)
  103762. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  103763. * @returns intersection info or null if no intersection
  103764. */
  103765. intersects(ray: Ray, positions: Vector3[], indices: IndicesArray, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<IntersectionInfo>;
  103766. /** @hidden */
  103767. private _intersectLines;
  103768. /** @hidden */
  103769. private _intersectUnIndexedLines;
  103770. /** @hidden */
  103771. private _intersectTriangles;
  103772. /** @hidden */
  103773. private _intersectUnIndexedTriangles;
  103774. /** @hidden */
  103775. _rebuild(): void;
  103776. /**
  103777. * Creates a new submesh from the passed mesh
  103778. * @param newMesh defines the new hosting mesh
  103779. * @param newRenderingMesh defines an optional rendering mesh
  103780. * @returns the new submesh
  103781. */
  103782. clone(newMesh: AbstractMesh, newRenderingMesh?: Mesh): SubMesh;
  103783. /**
  103784. * Release associated resources
  103785. */
  103786. dispose(): void;
  103787. /**
  103788. * Gets the class name
  103789. * @returns the string "SubMesh".
  103790. */
  103791. getClassName(): string;
  103792. /**
  103793. * Creates a new submesh from indices data
  103794. * @param materialIndex the index of the main mesh material
  103795. * @param startIndex the index where to start the copy in the mesh indices array
  103796. * @param indexCount the number of indices to copy then from the startIndex
  103797. * @param mesh the main mesh to create the submesh from
  103798. * @param renderingMesh the optional rendering mesh
  103799. * @returns a new submesh
  103800. */
  103801. static CreateFromIndices(materialIndex: number, startIndex: number, indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh): SubMesh;
  103802. }
  103803. }
  103804. declare module BABYLON {
  103805. /**
  103806. * Class used to represent data loading progression
  103807. */
  103808. export class SceneLoaderFlags {
  103809. private static _ForceFullSceneLoadingForIncremental;
  103810. private static _ShowLoadingScreen;
  103811. private static _CleanBoneMatrixWeights;
  103812. private static _loggingLevel;
  103813. /**
  103814. * Gets or sets a boolean indicating if entire scene must be loaded even if scene contains incremental data
  103815. */
  103816. static get ForceFullSceneLoadingForIncremental(): boolean;
  103817. static set ForceFullSceneLoadingForIncremental(value: boolean);
  103818. /**
  103819. * Gets or sets a boolean indicating if loading screen must be displayed while loading a scene
  103820. */
  103821. static get ShowLoadingScreen(): boolean;
  103822. static set ShowLoadingScreen(value: boolean);
  103823. /**
  103824. * Defines the current logging level (while loading the scene)
  103825. * @ignorenaming
  103826. */
  103827. static get loggingLevel(): number;
  103828. static set loggingLevel(value: number);
  103829. /**
  103830. * Gets or set a boolean indicating if matrix weights must be cleaned upon loading
  103831. */
  103832. static get CleanBoneMatrixWeights(): boolean;
  103833. static set CleanBoneMatrixWeights(value: boolean);
  103834. }
  103835. }
  103836. declare module BABYLON {
  103837. /**
  103838. * Class used to store geometry data (vertex buffers + index buffer)
  103839. */
  103840. export class Geometry implements IGetSetVerticesData {
  103841. /**
  103842. * Gets or sets the ID of the geometry
  103843. */
  103844. id: string;
  103845. /**
  103846. * Gets or sets the unique ID of the geometry
  103847. */
  103848. uniqueId: number;
  103849. /**
  103850. * Gets the delay loading state of the geometry (none by default which means not delayed)
  103851. */
  103852. delayLoadState: number;
  103853. /**
  103854. * Gets the file containing the data to load when running in delay load state
  103855. */
  103856. delayLoadingFile: Nullable<string>;
  103857. /**
  103858. * Callback called when the geometry is updated
  103859. */
  103860. onGeometryUpdated: (geometry: Geometry, kind?: string) => void;
  103861. private _scene;
  103862. private _engine;
  103863. private _meshes;
  103864. private _totalVertices;
  103865. /** @hidden */
  103866. _indices: IndicesArray;
  103867. /** @hidden */
  103868. _vertexBuffers: {
  103869. [key: string]: VertexBuffer;
  103870. };
  103871. private _isDisposed;
  103872. private _extend;
  103873. private _boundingBias;
  103874. /** @hidden */
  103875. _delayInfo: Array<string>;
  103876. private _indexBuffer;
  103877. private _indexBufferIsUpdatable;
  103878. /** @hidden */
  103879. _boundingInfo: Nullable<BoundingInfo>;
  103880. /** @hidden */
  103881. _delayLoadingFunction: Nullable<(any: any, geometry: Geometry) => void>;
  103882. /** @hidden */
  103883. _softwareSkinningFrameId: number;
  103884. private _vertexArrayObjects;
  103885. private _updatable;
  103886. /** @hidden */
  103887. _positions: Nullable<Vector3[]>;
  103888. /**
  103889. * 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
  103890. */
  103891. get boundingBias(): Vector2;
  103892. /**
  103893. * 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
  103894. */
  103895. set boundingBias(value: Vector2);
  103896. /**
  103897. * Static function used to attach a new empty geometry to a mesh
  103898. * @param mesh defines the mesh to attach the geometry to
  103899. * @returns the new Geometry
  103900. */
  103901. static CreateGeometryForMesh(mesh: Mesh): Geometry;
  103902. /** Get the list of meshes using this geometry */
  103903. get meshes(): Mesh[];
  103904. /**
  103905. * 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
  103906. * and won't be computed based on the vertex positions (which is what we get when useBoundingInfoFromGeometry = false)
  103907. */
  103908. useBoundingInfoFromGeometry: boolean;
  103909. /**
  103910. * Creates a new geometry
  103911. * @param id defines the unique ID
  103912. * @param scene defines the hosting scene
  103913. * @param vertexData defines the VertexData used to get geometry data
  103914. * @param updatable defines if geometry must be updatable (false by default)
  103915. * @param mesh defines the mesh that will be associated with the geometry
  103916. */
  103917. constructor(id: string, scene: Scene, vertexData?: VertexData, updatable?: boolean, mesh?: Nullable<Mesh>);
  103918. /**
  103919. * Gets the current extend of the geometry
  103920. */
  103921. get extend(): {
  103922. minimum: Vector3;
  103923. maximum: Vector3;
  103924. };
  103925. /**
  103926. * Gets the hosting scene
  103927. * @returns the hosting Scene
  103928. */
  103929. getScene(): Scene;
  103930. /**
  103931. * Gets the hosting engine
  103932. * @returns the hosting Engine
  103933. */
  103934. getEngine(): Engine;
  103935. /**
  103936. * Defines if the geometry is ready to use
  103937. * @returns true if the geometry is ready to be used
  103938. */
  103939. isReady(): boolean;
  103940. /**
  103941. * Gets a value indicating that the geometry should not be serialized
  103942. */
  103943. get doNotSerialize(): boolean;
  103944. /** @hidden */
  103945. _rebuild(): void;
  103946. /**
  103947. * Affects all geometry data in one call
  103948. * @param vertexData defines the geometry data
  103949. * @param updatable defines if the geometry must be flagged as updatable (false as default)
  103950. */
  103951. setAllVerticesData(vertexData: VertexData, updatable?: boolean): void;
  103952. /**
  103953. * Set specific vertex data
  103954. * @param kind defines the data kind (Position, normal, etc...)
  103955. * @param data defines the vertex data to use
  103956. * @param updatable defines if the vertex must be flagged as updatable (false as default)
  103957. * @param stride defines the stride to use (0 by default). This value is deduced from the kind value if not specified
  103958. */
  103959. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): void;
  103960. /**
  103961. * Removes a specific vertex data
  103962. * @param kind defines the data kind (Position, normal, etc...)
  103963. */
  103964. removeVerticesData(kind: string): void;
  103965. /**
  103966. * Affect a vertex buffer to the geometry. the vertexBuffer.getKind() function is used to determine where to store the data
  103967. * @param buffer defines the vertex buffer to use
  103968. * @param totalVertices defines the total number of vertices for position kind (could be null)
  103969. */
  103970. setVerticesBuffer(buffer: VertexBuffer, totalVertices?: Nullable<number>): void;
  103971. /**
  103972. * Update a specific vertex buffer
  103973. * This function will directly update the underlying DataBuffer according to the passed numeric array or Float32Array
  103974. * It will do nothing if the buffer is not updatable
  103975. * @param kind defines the data kind (Position, normal, etc...)
  103976. * @param data defines the data to use
  103977. * @param offset defines the offset in the target buffer where to store the data
  103978. * @param useBytes set to true if the offset is in bytes
  103979. */
  103980. updateVerticesDataDirectly(kind: string, data: DataArray, offset: number, useBytes?: boolean): void;
  103981. /**
  103982. * Update a specific vertex buffer
  103983. * This function will create a new buffer if the current one is not updatable
  103984. * @param kind defines the data kind (Position, normal, etc...)
  103985. * @param data defines the data to use
  103986. * @param updateExtends defines if the geometry extends must be recomputed (false by default)
  103987. */
  103988. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean): void;
  103989. private _updateBoundingInfo;
  103990. /** @hidden */
  103991. _bind(effect: Nullable<Effect>, indexToBind?: Nullable<DataBuffer>): void;
  103992. /**
  103993. * Gets total number of vertices
  103994. * @returns the total number of vertices
  103995. */
  103996. getTotalVertices(): number;
  103997. /**
  103998. * Gets a specific vertex data attached to this geometry. Float data is constructed if the vertex buffer data cannot be returned directly.
  103999. * @param kind defines the data kind (Position, normal, etc...)
  104000. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  104001. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  104002. * @returns a float array containing vertex data
  104003. */
  104004. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  104005. /**
  104006. * Returns a boolean defining if the vertex data for the requested `kind` is updatable
  104007. * @param kind defines the data kind (Position, normal, etc...)
  104008. * @returns true if the vertex buffer with the specified kind is updatable
  104009. */
  104010. isVertexBufferUpdatable(kind: string): boolean;
  104011. /**
  104012. * Gets a specific vertex buffer
  104013. * @param kind defines the data kind (Position, normal, etc...)
  104014. * @returns a VertexBuffer
  104015. */
  104016. getVertexBuffer(kind: string): Nullable<VertexBuffer>;
  104017. /**
  104018. * Returns all vertex buffers
  104019. * @return an object holding all vertex buffers indexed by kind
  104020. */
  104021. getVertexBuffers(): Nullable<{
  104022. [key: string]: VertexBuffer;
  104023. }>;
  104024. /**
  104025. * Gets a boolean indicating if specific vertex buffer is present
  104026. * @param kind defines the data kind (Position, normal, etc...)
  104027. * @returns true if data is present
  104028. */
  104029. isVerticesDataPresent(kind: string): boolean;
  104030. /**
  104031. * Gets a list of all attached data kinds (Position, normal, etc...)
  104032. * @returns a list of string containing all kinds
  104033. */
  104034. getVerticesDataKinds(): string[];
  104035. /**
  104036. * Update index buffer
  104037. * @param indices defines the indices to store in the index buffer
  104038. * @param offset defines the offset in the target buffer where to store the data
  104039. * @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)
  104040. */
  104041. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): void;
  104042. /**
  104043. * Creates a new index buffer
  104044. * @param indices defines the indices to store in the index buffer
  104045. * @param totalVertices defines the total number of vertices (could be null)
  104046. * @param updatable defines if the index buffer must be flagged as updatable (false by default)
  104047. */
  104048. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>, updatable?: boolean): void;
  104049. /**
  104050. * Return the total number of indices
  104051. * @returns the total number of indices
  104052. */
  104053. getTotalIndices(): number;
  104054. /**
  104055. * Gets the index buffer array
  104056. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  104057. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  104058. * @returns the index buffer array
  104059. */
  104060. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  104061. /**
  104062. * Gets the index buffer
  104063. * @return the index buffer
  104064. */
  104065. getIndexBuffer(): Nullable<DataBuffer>;
  104066. /** @hidden */
  104067. _releaseVertexArrayObject(effect?: Nullable<Effect>): void;
  104068. /**
  104069. * Release the associated resources for a specific mesh
  104070. * @param mesh defines the source mesh
  104071. * @param shouldDispose defines if the geometry must be disposed if there is no more mesh pointing to it
  104072. */
  104073. releaseForMesh(mesh: Mesh, shouldDispose?: boolean): void;
  104074. /**
  104075. * Apply current geometry to a given mesh
  104076. * @param mesh defines the mesh to apply geometry to
  104077. */
  104078. applyToMesh(mesh: Mesh): void;
  104079. private _updateExtend;
  104080. private _applyToMesh;
  104081. private notifyUpdate;
  104082. /**
  104083. * Load the geometry if it was flagged as delay loaded
  104084. * @param scene defines the hosting scene
  104085. * @param onLoaded defines a callback called when the geometry is loaded
  104086. */
  104087. load(scene: Scene, onLoaded?: () => void): void;
  104088. private _queueLoad;
  104089. /**
  104090. * Invert the geometry to move from a right handed system to a left handed one.
  104091. */
  104092. toLeftHanded(): void;
  104093. /** @hidden */
  104094. _resetPointsArrayCache(): void;
  104095. /** @hidden */
  104096. _generatePointsArray(): boolean;
  104097. /**
  104098. * Gets a value indicating if the geometry is disposed
  104099. * @returns true if the geometry was disposed
  104100. */
  104101. isDisposed(): boolean;
  104102. private _disposeVertexArrayObjects;
  104103. /**
  104104. * Free all associated resources
  104105. */
  104106. dispose(): void;
  104107. /**
  104108. * Clone the current geometry into a new geometry
  104109. * @param id defines the unique ID of the new geometry
  104110. * @returns a new geometry object
  104111. */
  104112. copy(id: string): Geometry;
  104113. /**
  104114. * Serialize the current geometry info (and not the vertices data) into a JSON object
  104115. * @return a JSON representation of the current geometry data (without the vertices data)
  104116. */
  104117. serialize(): any;
  104118. private toNumberArray;
  104119. /**
  104120. * Serialize all vertices data into a JSON oject
  104121. * @returns a JSON representation of the current geometry data
  104122. */
  104123. serializeVerticeData(): any;
  104124. /**
  104125. * Extracts a clone of a mesh geometry
  104126. * @param mesh defines the source mesh
  104127. * @param id defines the unique ID of the new geometry object
  104128. * @returns the new geometry object
  104129. */
  104130. static ExtractFromMesh(mesh: Mesh, id: string): Nullable<Geometry>;
  104131. /**
  104132. * You should now use Tools.RandomId(), this method is still here for legacy reasons.
  104133. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  104134. * Be aware Math.random() could cause collisions, but:
  104135. * "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"
  104136. * @returns a string containing a new GUID
  104137. */
  104138. static RandomId(): string;
  104139. /** @hidden */
  104140. static _ImportGeometry(parsedGeometry: any, mesh: Mesh): void;
  104141. private static _CleanMatricesWeights;
  104142. /**
  104143. * Create a new geometry from persisted data (Using .babylon file format)
  104144. * @param parsedVertexData defines the persisted data
  104145. * @param scene defines the hosting scene
  104146. * @param rootUrl defines the root url to use to load assets (like delayed data)
  104147. * @returns the new geometry object
  104148. */
  104149. static Parse(parsedVertexData: any, scene: Scene, rootUrl: string): Nullable<Geometry>;
  104150. }
  104151. }
  104152. declare module BABYLON {
  104153. /**
  104154. * Define an interface for all classes that will get and set the data on vertices
  104155. */
  104156. export interface IGetSetVerticesData {
  104157. /**
  104158. * Gets a boolean indicating if specific vertex data is present
  104159. * @param kind defines the vertex data kind to use
  104160. * @returns true is data kind is present
  104161. */
  104162. isVerticesDataPresent(kind: string): boolean;
  104163. /**
  104164. * Gets a specific vertex data attached to this geometry. Float data is constructed if the vertex buffer data cannot be returned directly.
  104165. * @param kind defines the data kind (Position, normal, etc...)
  104166. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  104167. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  104168. * @returns a float array containing vertex data
  104169. */
  104170. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  104171. /**
  104172. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  104173. * @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.
  104174. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  104175. * @returns the indices array or an empty array if the mesh has no geometry
  104176. */
  104177. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  104178. /**
  104179. * Set specific vertex data
  104180. * @param kind defines the data kind (Position, normal, etc...)
  104181. * @param data defines the vertex data to use
  104182. * @param updatable defines if the vertex must be flagged as updatable (false as default)
  104183. * @param stride defines the stride to use (0 by default). This value is deduced from the kind value if not specified
  104184. */
  104185. setVerticesData(kind: string, data: FloatArray, updatable: boolean): void;
  104186. /**
  104187. * Update a specific associated vertex buffer
  104188. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  104189. * - VertexBuffer.PositionKind
  104190. * - VertexBuffer.UVKind
  104191. * - VertexBuffer.UV2Kind
  104192. * - VertexBuffer.UV3Kind
  104193. * - VertexBuffer.UV4Kind
  104194. * - VertexBuffer.UV5Kind
  104195. * - VertexBuffer.UV6Kind
  104196. * - VertexBuffer.ColorKind
  104197. * - VertexBuffer.MatricesIndicesKind
  104198. * - VertexBuffer.MatricesIndicesExtraKind
  104199. * - VertexBuffer.MatricesWeightsKind
  104200. * - VertexBuffer.MatricesWeightsExtraKind
  104201. * @param data defines the data source
  104202. * @param updateExtends defines if extends info of the mesh must be updated (can be null). This is mostly useful for "position" kind
  104203. * @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)
  104204. */
  104205. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): void;
  104206. /**
  104207. * Creates a new index buffer
  104208. * @param indices defines the indices to store in the index buffer
  104209. * @param totalVertices defines the total number of vertices (could be null)
  104210. * @param updatable defines if the index buffer must be flagged as updatable (false by default)
  104211. */
  104212. setIndices(indices: IndicesArray, totalVertices: Nullable<number>, updatable?: boolean): void;
  104213. }
  104214. /**
  104215. * This class contains the various kinds of data on every vertex of a mesh used in determining its shape and appearance
  104216. */
  104217. export class VertexData {
  104218. /**
  104219. * Mesh side orientation : usually the external or front surface
  104220. */
  104221. static readonly FRONTSIDE: number;
  104222. /**
  104223. * Mesh side orientation : usually the internal or back surface
  104224. */
  104225. static readonly BACKSIDE: number;
  104226. /**
  104227. * Mesh side orientation : both internal and external or front and back surfaces
  104228. */
  104229. static readonly DOUBLESIDE: number;
  104230. /**
  104231. * Mesh side orientation : by default, `FRONTSIDE`
  104232. */
  104233. static readonly DEFAULTSIDE: number;
  104234. /**
  104235. * An array of the x, y, z position of each vertex [...., x, y, z, .....]
  104236. */
  104237. positions: Nullable<FloatArray>;
  104238. /**
  104239. * An array of the x, y, z normal vector of each vertex [...., x, y, z, .....]
  104240. */
  104241. normals: Nullable<FloatArray>;
  104242. /**
  104243. * An array of the x, y, z tangent vector of each vertex [...., x, y, z, .....]
  104244. */
  104245. tangents: Nullable<FloatArray>;
  104246. /**
  104247. * An array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  104248. */
  104249. uvs: Nullable<FloatArray>;
  104250. /**
  104251. * A second array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  104252. */
  104253. uvs2: Nullable<FloatArray>;
  104254. /**
  104255. * A third array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  104256. */
  104257. uvs3: Nullable<FloatArray>;
  104258. /**
  104259. * A fourth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  104260. */
  104261. uvs4: Nullable<FloatArray>;
  104262. /**
  104263. * A fifth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  104264. */
  104265. uvs5: Nullable<FloatArray>;
  104266. /**
  104267. * A sixth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  104268. */
  104269. uvs6: Nullable<FloatArray>;
  104270. /**
  104271. * An array of the r, g, b, a, color of each vertex [...., r, g, b, a, .....]
  104272. */
  104273. colors: Nullable<FloatArray>;
  104274. /**
  104275. * 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).
  104276. */
  104277. matricesIndices: Nullable<FloatArray>;
  104278. /**
  104279. * An array containing the list of weights defining the weight of each indexed matrix in the final computation
  104280. */
  104281. matricesWeights: Nullable<FloatArray>;
  104282. /**
  104283. * An array extending the number of possible indices
  104284. */
  104285. matricesIndicesExtra: Nullable<FloatArray>;
  104286. /**
  104287. * An array extending the number of possible weights when the number of indices is extended
  104288. */
  104289. matricesWeightsExtra: Nullable<FloatArray>;
  104290. /**
  104291. * An array of i, j, k the three vertex indices required for each triangular facet [...., i, j, k .....]
  104292. */
  104293. indices: Nullable<IndicesArray>;
  104294. /**
  104295. * Uses the passed data array to set the set the values for the specified kind of data
  104296. * @param data a linear array of floating numbers
  104297. * @param kind the type of data that is being set, eg positions, colors etc
  104298. */
  104299. set(data: FloatArray, kind: string): void;
  104300. /**
  104301. * Associates the vertexData to the passed Mesh.
  104302. * Sets it as updatable or not (default `false`)
  104303. * @param mesh the mesh the vertexData is applied to
  104304. * @param updatable when used and having the value true allows new data to update the vertexData
  104305. * @returns the VertexData
  104306. */
  104307. applyToMesh(mesh: Mesh, updatable?: boolean): VertexData;
  104308. /**
  104309. * Associates the vertexData to the passed Geometry.
  104310. * Sets it as updatable or not (default `false`)
  104311. * @param geometry the geometry the vertexData is applied to
  104312. * @param updatable when used and having the value true allows new data to update the vertexData
  104313. * @returns VertexData
  104314. */
  104315. applyToGeometry(geometry: Geometry, updatable?: boolean): VertexData;
  104316. /**
  104317. * Updates the associated mesh
  104318. * @param mesh the mesh to be updated
  104319. * @param updateExtends when true the mesh BoundingInfo will be renewed when and if position kind is updated, optional with default false
  104320. * @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
  104321. * @returns VertexData
  104322. */
  104323. updateMesh(mesh: Mesh): VertexData;
  104324. /**
  104325. * Updates the associated geometry
  104326. * @param geometry the geometry to be updated
  104327. * @param updateExtends when true BoundingInfo will be renewed when and if position kind is updated, optional with default false
  104328. * @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
  104329. * @returns VertexData.
  104330. */
  104331. updateGeometry(geometry: Geometry): VertexData;
  104332. private _applyTo;
  104333. private _update;
  104334. /**
  104335. * Transforms each position and each normal of the vertexData according to the passed Matrix
  104336. * @param matrix the transforming matrix
  104337. * @returns the VertexData
  104338. */
  104339. transform(matrix: Matrix): VertexData;
  104340. /**
  104341. * Merges the passed VertexData into the current one
  104342. * @param other the VertexData to be merged into the current one
  104343. * @param use32BitsIndices defines a boolean indicating if indices must be store in a 32 bits array
  104344. * @returns the modified VertexData
  104345. */
  104346. merge(other: VertexData, use32BitsIndices?: boolean): VertexData;
  104347. private _mergeElement;
  104348. private _validate;
  104349. /**
  104350. * Serializes the VertexData
  104351. * @returns a serialized object
  104352. */
  104353. serialize(): any;
  104354. /**
  104355. * Extracts the vertexData from a mesh
  104356. * @param mesh the mesh from which to extract the VertexData
  104357. * @param copyWhenShared defines if the VertexData must be cloned when shared between multiple meshes, optional, default false
  104358. * @param forceCopy indicating that the VertexData must be cloned, optional, default false
  104359. * @returns the object VertexData associated to the passed mesh
  104360. */
  104361. static ExtractFromMesh(mesh: Mesh, copyWhenShared?: boolean, forceCopy?: boolean): VertexData;
  104362. /**
  104363. * Extracts the vertexData from the geometry
  104364. * @param geometry the geometry from which to extract the VertexData
  104365. * @param copyWhenShared defines if the VertexData must be cloned when the geometrty is shared between multiple meshes, optional, default false
  104366. * @param forceCopy indicating that the VertexData must be cloned, optional, default false
  104367. * @returns the object VertexData associated to the passed mesh
  104368. */
  104369. static ExtractFromGeometry(geometry: Geometry, copyWhenShared?: boolean, forceCopy?: boolean): VertexData;
  104370. private static _ExtractFrom;
  104371. /**
  104372. * Creates the VertexData for a Ribbon
  104373. * @param options an object used to set the following optional parameters for the ribbon, required but can be empty
  104374. * * pathArray array of paths, each of which an array of successive Vector3
  104375. * * closeArray creates a seam between the first and the last paths of the pathArray, optional, default false
  104376. * * closePath creates a seam between the first and the last points of each path of the path array, optional, default false
  104377. * * 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
  104378. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  104379. * * 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)
  104380. * * 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)
  104381. * * invertUV swaps in the U and V coordinates when applying a texture, optional, default false
  104382. * * uvs a linear array, of length 2 * number of vertices, of custom UV values, optional
  104383. * * colors a linear array, of length 4 * number of vertices, of custom color values, optional
  104384. * @returns the VertexData of the ribbon
  104385. */
  104386. static CreateRibbon(options: {
  104387. pathArray: Vector3[][];
  104388. closeArray?: boolean;
  104389. closePath?: boolean;
  104390. offset?: number;
  104391. sideOrientation?: number;
  104392. frontUVs?: Vector4;
  104393. backUVs?: Vector4;
  104394. invertUV?: boolean;
  104395. uvs?: Vector2[];
  104396. colors?: Color4[];
  104397. }): VertexData;
  104398. /**
  104399. * Creates the VertexData for a box
  104400. * @param options an object used to set the following optional parameters for the box, required but can be empty
  104401. * * size sets the width, height and depth of the box to the value of size, optional default 1
  104402. * * width sets the width (x direction) of the box, overwrites the width set by size, optional, default size
  104403. * * height sets the height (y direction) of the box, overwrites the height set by size, optional, default size
  104404. * * depth sets the depth (z direction) of the box, overwrites the depth set by size, optional, default size
  104405. * * faceUV an array of 6 Vector4 elements used to set different images to each box side
  104406. * * faceColors an array of 6 Color3 elements used to set different colors to each box side
  104407. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  104408. * * 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)
  104409. * * 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)
  104410. * @returns the VertexData of the box
  104411. */
  104412. static CreateBox(options: {
  104413. size?: number;
  104414. width?: number;
  104415. height?: number;
  104416. depth?: number;
  104417. faceUV?: Vector4[];
  104418. faceColors?: Color4[];
  104419. sideOrientation?: number;
  104420. frontUVs?: Vector4;
  104421. backUVs?: Vector4;
  104422. }): VertexData;
  104423. /**
  104424. * Creates the VertexData for a tiled box
  104425. * @param options an object used to set the following optional parameters for the box, required but can be empty
  104426. * * faceTiles sets the pattern, tile size and number of tiles for a face
  104427. * * faceUV an array of 6 Vector4 elements used to set different images to each box side
  104428. * * faceColors an array of 6 Color3 elements used to set different colors to each box side
  104429. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  104430. * @returns the VertexData of the box
  104431. */
  104432. static CreateTiledBox(options: {
  104433. pattern?: number;
  104434. width?: number;
  104435. height?: number;
  104436. depth?: number;
  104437. tileSize?: number;
  104438. tileWidth?: number;
  104439. tileHeight?: number;
  104440. alignHorizontal?: number;
  104441. alignVertical?: number;
  104442. faceUV?: Vector4[];
  104443. faceColors?: Color4[];
  104444. sideOrientation?: number;
  104445. }): VertexData;
  104446. /**
  104447. * Creates the VertexData for a tiled plane
  104448. * @param options an object used to set the following optional parameters for the box, required but can be empty
  104449. * * pattern a limited pattern arrangement depending on the number
  104450. * * tileSize sets the width, height and depth of the tile to the value of size, optional default 1
  104451. * * tileWidth sets the width (x direction) of the tile, overwrites the width set by size, optional, default size
  104452. * * tileHeight sets the height (y direction) of the tile, overwrites the height set by size, optional, default size
  104453. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  104454. * * 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)
  104455. * * 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)
  104456. * @returns the VertexData of the tiled plane
  104457. */
  104458. static CreateTiledPlane(options: {
  104459. pattern?: number;
  104460. tileSize?: number;
  104461. tileWidth?: number;
  104462. tileHeight?: number;
  104463. size?: number;
  104464. width?: number;
  104465. height?: number;
  104466. alignHorizontal?: number;
  104467. alignVertical?: number;
  104468. sideOrientation?: number;
  104469. frontUVs?: Vector4;
  104470. backUVs?: Vector4;
  104471. }): VertexData;
  104472. /**
  104473. * Creates the VertexData for an ellipsoid, defaults to a sphere
  104474. * @param options an object used to set the following optional parameters for the box, required but can be empty
  104475. * * segments sets the number of horizontal strips optional, default 32
  104476. * * diameter sets the axes dimensions, diameterX, diameterY and diameterZ to the value of diameter, optional default 1
  104477. * * diameterX sets the diameterX (x direction) of the ellipsoid, overwrites the diameterX set by diameter, optional, default diameter
  104478. * * diameterY sets the diameterY (y direction) of the ellipsoid, overwrites the diameterY set by diameter, optional, default diameter
  104479. * * diameterZ sets the diameterZ (z direction) of the ellipsoid, overwrites the diameterZ set by diameter, optional, default diameter
  104480. * * 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
  104481. * * 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
  104482. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  104483. * * 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)
  104484. * * 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)
  104485. * @returns the VertexData of the ellipsoid
  104486. */
  104487. static CreateSphere(options: {
  104488. segments?: number;
  104489. diameter?: number;
  104490. diameterX?: number;
  104491. diameterY?: number;
  104492. diameterZ?: number;
  104493. arc?: number;
  104494. slice?: number;
  104495. sideOrientation?: number;
  104496. frontUVs?: Vector4;
  104497. backUVs?: Vector4;
  104498. }): VertexData;
  104499. /**
  104500. * Creates the VertexData for a cylinder, cone or prism
  104501. * @param options an object used to set the following optional parameters for the box, required but can be empty
  104502. * * height sets the height (y direction) of the cylinder, optional, default 2
  104503. * * diameterTop sets the diameter of the top of the cone, overwrites diameter, optional, default diameter
  104504. * * diameterBottom sets the diameter of the bottom of the cone, overwrites diameter, optional, default diameter
  104505. * * diameter sets the diameter of the top and bottom of the cone, optional default 1
  104506. * * tessellation the number of prism sides, 3 for a triangular prism, optional, default 24
  104507. * * subdivisions` the number of rings along the cylinder height, optional, default 1
  104508. * * 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
  104509. * * faceColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  104510. * * faceUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  104511. * * hasRings when true makes each subdivision independantly treated as a face for faceUV and faceColors, optional, default false
  104512. * * enclose when true closes an open cylinder by adding extra flat faces between the height axis and vertical edges, think cut cake
  104513. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  104514. * * 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)
  104515. * * 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)
  104516. * @returns the VertexData of the cylinder, cone or prism
  104517. */
  104518. static CreateCylinder(options: {
  104519. height?: number;
  104520. diameterTop?: number;
  104521. diameterBottom?: number;
  104522. diameter?: number;
  104523. tessellation?: number;
  104524. subdivisions?: number;
  104525. arc?: number;
  104526. faceColors?: Color4[];
  104527. faceUV?: Vector4[];
  104528. hasRings?: boolean;
  104529. enclose?: boolean;
  104530. sideOrientation?: number;
  104531. frontUVs?: Vector4;
  104532. backUVs?: Vector4;
  104533. }): VertexData;
  104534. /**
  104535. * Creates the VertexData for a torus
  104536. * @param options an object used to set the following optional parameters for the box, required but can be empty
  104537. * * diameter the diameter of the torus, optional default 1
  104538. * * thickness the diameter of the tube forming the torus, optional default 0.5
  104539. * * tessellation the number of prism sides, 3 for a triangular prism, optional, default 24
  104540. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  104541. * * 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)
  104542. * * 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)
  104543. * @returns the VertexData of the torus
  104544. */
  104545. static CreateTorus(options: {
  104546. diameter?: number;
  104547. thickness?: number;
  104548. tessellation?: number;
  104549. sideOrientation?: number;
  104550. frontUVs?: Vector4;
  104551. backUVs?: Vector4;
  104552. }): VertexData;
  104553. /**
  104554. * Creates the VertexData of the LineSystem
  104555. * @param options an object used to set the following optional parameters for the LineSystem, required but can be empty
  104556. * - lines an array of lines, each line being an array of successive Vector3
  104557. * - colors an array of line colors, each of the line colors being an array of successive Color4, one per line point
  104558. * @returns the VertexData of the LineSystem
  104559. */
  104560. static CreateLineSystem(options: {
  104561. lines: Vector3[][];
  104562. colors?: Nullable<Color4[][]>;
  104563. }): VertexData;
  104564. /**
  104565. * Create the VertexData for a DashedLines
  104566. * @param options an object used to set the following optional parameters for the DashedLines, required but can be empty
  104567. * - points an array successive Vector3
  104568. * - dashSize the size of the dashes relative to the dash number, optional, default 3
  104569. * - gapSize the size of the gap between two successive dashes relative to the dash number, optional, default 1
  104570. * - dashNb the intended total number of dashes, optional, default 200
  104571. * @returns the VertexData for the DashedLines
  104572. */
  104573. static CreateDashedLines(options: {
  104574. points: Vector3[];
  104575. dashSize?: number;
  104576. gapSize?: number;
  104577. dashNb?: number;
  104578. }): VertexData;
  104579. /**
  104580. * Creates the VertexData for a Ground
  104581. * @param options an object used to set the following optional parameters for the Ground, required but can be empty
  104582. * - width the width (x direction) of the ground, optional, default 1
  104583. * - height the height (z direction) of the ground, optional, default 1
  104584. * - subdivisions the number of subdivisions per side, optional, default 1
  104585. * @returns the VertexData of the Ground
  104586. */
  104587. static CreateGround(options: {
  104588. width?: number;
  104589. height?: number;
  104590. subdivisions?: number;
  104591. subdivisionsX?: number;
  104592. subdivisionsY?: number;
  104593. }): VertexData;
  104594. /**
  104595. * Creates the VertexData for a TiledGround by subdividing the ground into tiles
  104596. * @param options an object used to set the following optional parameters for the Ground, required but can be empty
  104597. * * xmin the ground minimum X coordinate, optional, default -1
  104598. * * zmin the ground minimum Z coordinate, optional, default -1
  104599. * * xmax the ground maximum X coordinate, optional, default 1
  104600. * * zmax the ground maximum Z coordinate, optional, default 1
  104601. * * 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}
  104602. * * 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}
  104603. * @returns the VertexData of the TiledGround
  104604. */
  104605. static CreateTiledGround(options: {
  104606. xmin: number;
  104607. zmin: number;
  104608. xmax: number;
  104609. zmax: number;
  104610. subdivisions?: {
  104611. w: number;
  104612. h: number;
  104613. };
  104614. precision?: {
  104615. w: number;
  104616. h: number;
  104617. };
  104618. }): VertexData;
  104619. /**
  104620. * Creates the VertexData of the Ground designed from a heightmap
  104621. * @param options an object used to set the following parameters for the Ground, required and provided by MeshBuilder.CreateGroundFromHeightMap
  104622. * * width the width (x direction) of the ground
  104623. * * height the height (z direction) of the ground
  104624. * * subdivisions the number of subdivisions per side
  104625. * * minHeight the minimum altitude on the ground, optional, default 0
  104626. * * maxHeight the maximum altitude on the ground, optional default 1
  104627. * * colorFilter the filter to apply to the image pixel colors to compute the height, optional Color3, default (0.3, 0.59, 0.11)
  104628. * * buffer the array holding the image color data
  104629. * * bufferWidth the width of image
  104630. * * bufferHeight the height of image
  104631. * * alphaFilter Remove any data where the alpha channel is below this value, defaults 0 (all data visible)
  104632. * @returns the VertexData of the Ground designed from a heightmap
  104633. */
  104634. static CreateGroundFromHeightMap(options: {
  104635. width: number;
  104636. height: number;
  104637. subdivisions: number;
  104638. minHeight: number;
  104639. maxHeight: number;
  104640. colorFilter: Color3;
  104641. buffer: Uint8Array;
  104642. bufferWidth: number;
  104643. bufferHeight: number;
  104644. alphaFilter: number;
  104645. }): VertexData;
  104646. /**
  104647. * Creates the VertexData for a Plane
  104648. * @param options an object used to set the following optional parameters for the plane, required but can be empty
  104649. * * size sets the width and height of the plane to the value of size, optional default 1
  104650. * * width sets the width (x direction) of the plane, overwrites the width set by size, optional, default size
  104651. * * height sets the height (y direction) of the plane, overwrites the height set by size, optional, default size
  104652. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  104653. * * 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)
  104654. * * 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)
  104655. * @returns the VertexData of the box
  104656. */
  104657. static CreatePlane(options: {
  104658. size?: number;
  104659. width?: number;
  104660. height?: number;
  104661. sideOrientation?: number;
  104662. frontUVs?: Vector4;
  104663. backUVs?: Vector4;
  104664. }): VertexData;
  104665. /**
  104666. * Creates the VertexData of the Disc or regular Polygon
  104667. * @param options an object used to set the following optional parameters for the disc, required but can be empty
  104668. * * radius the radius of the disc, optional default 0.5
  104669. * * tessellation the number of polygon sides, optional, default 64
  104670. * * 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
  104671. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  104672. * * 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)
  104673. * * 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)
  104674. * @returns the VertexData of the box
  104675. */
  104676. static CreateDisc(options: {
  104677. radius?: number;
  104678. tessellation?: number;
  104679. arc?: number;
  104680. sideOrientation?: number;
  104681. frontUVs?: Vector4;
  104682. backUVs?: Vector4;
  104683. }): VertexData;
  104684. /**
  104685. * Creates the VertexData for an irregular Polygon in the XoZ plane using a mesh built by polygonTriangulation.build()
  104686. * All parameters are provided by MeshBuilder.CreatePolygon as needed
  104687. * @param polygon a mesh built from polygonTriangulation.build()
  104688. * @param sideOrientation takes the values Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  104689. * @param fUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  104690. * @param fColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  104691. * @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)
  104692. * @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)
  104693. * @param wrap a boolean, default false, when true and fUVs used texture is wrapped around all sides, when false texture is applied side
  104694. * @returns the VertexData of the Polygon
  104695. */
  104696. static CreatePolygon(polygon: Mesh, sideOrientation: number, fUV?: Vector4[], fColors?: Color4[], frontUVs?: Vector4, backUVs?: Vector4, wrap?: boolean): VertexData;
  104697. /**
  104698. * Creates the VertexData of the IcoSphere
  104699. * @param options an object used to set the following optional parameters for the IcoSphere, required but can be empty
  104700. * * radius the radius of the IcoSphere, optional default 1
  104701. * * radiusX allows stretching in the x direction, optional, default radius
  104702. * * radiusY allows stretching in the y direction, optional, default radius
  104703. * * radiusZ allows stretching in the z direction, optional, default radius
  104704. * * flat when true creates a flat shaded mesh, optional, default true
  104705. * * subdivisions increasing the subdivisions increases the number of faces, optional, default 4
  104706. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  104707. * * 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)
  104708. * * 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)
  104709. * @returns the VertexData of the IcoSphere
  104710. */
  104711. static CreateIcoSphere(options: {
  104712. radius?: number;
  104713. radiusX?: number;
  104714. radiusY?: number;
  104715. radiusZ?: number;
  104716. flat?: boolean;
  104717. subdivisions?: number;
  104718. sideOrientation?: number;
  104719. frontUVs?: Vector4;
  104720. backUVs?: Vector4;
  104721. }): VertexData;
  104722. /**
  104723. * Creates the VertexData for a Polyhedron
  104724. * @param options an object used to set the following optional parameters for the polyhedron, required but can be empty
  104725. * * type provided types are:
  104726. * * 0 : Tetrahedron, 1 : Octahedron, 2 : Dodecahedron, 3 : Icosahedron, 4 : Rhombicuboctahedron, 5 : Triangular Prism, 6 : Pentagonal Prism, 7 : Hexagonal Prism, 8 : Square Pyramid (J1)
  104727. * * 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)
  104728. * * size the size of the IcoSphere, optional default 1
  104729. * * sizeX allows stretching in the x direction, optional, default size
  104730. * * sizeY allows stretching in the y direction, optional, default size
  104731. * * sizeZ allows stretching in the z direction, optional, default size
  104732. * * 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
  104733. * * faceUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  104734. * * faceColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  104735. * * flat when true creates a flat shaded mesh, optional, default true
  104736. * * subdivisions increasing the subdivisions increases the number of faces, optional, default 4
  104737. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  104738. * * 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)
  104739. * * 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)
  104740. * @returns the VertexData of the Polyhedron
  104741. */
  104742. static CreatePolyhedron(options: {
  104743. type?: number;
  104744. size?: number;
  104745. sizeX?: number;
  104746. sizeY?: number;
  104747. sizeZ?: number;
  104748. custom?: any;
  104749. faceUV?: Vector4[];
  104750. faceColors?: Color4[];
  104751. flat?: boolean;
  104752. sideOrientation?: number;
  104753. frontUVs?: Vector4;
  104754. backUVs?: Vector4;
  104755. }): VertexData;
  104756. /**
  104757. * Creates the VertexData for a TorusKnot
  104758. * @param options an object used to set the following optional parameters for the TorusKnot, required but can be empty
  104759. * * radius the radius of the torus knot, optional, default 2
  104760. * * tube the thickness of the tube, optional, default 0.5
  104761. * * radialSegments the number of sides on each tube segments, optional, default 32
  104762. * * tubularSegments the number of tubes to decompose the knot into, optional, default 32
  104763. * * p the number of windings around the z axis, optional, default 2
  104764. * * q the number of windings around the x axis, optional, default 3
  104765. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  104766. * * 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)
  104767. * * 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)
  104768. * @returns the VertexData of the Torus Knot
  104769. */
  104770. static CreateTorusKnot(options: {
  104771. radius?: number;
  104772. tube?: number;
  104773. radialSegments?: number;
  104774. tubularSegments?: number;
  104775. p?: number;
  104776. q?: number;
  104777. sideOrientation?: number;
  104778. frontUVs?: Vector4;
  104779. backUVs?: Vector4;
  104780. }): VertexData;
  104781. /**
  104782. * Compute normals for given positions and indices
  104783. * @param positions an array of vertex positions, [...., x, y, z, ......]
  104784. * @param indices an array of indices in groups of three for each triangular facet, [...., i, j, k, ......]
  104785. * @param normals an array of vertex normals, [...., x, y, z, ......]
  104786. * @param options an object used to set the following optional parameters for the TorusKnot, optional
  104787. * * facetNormals : optional array of facet normals (vector3)
  104788. * * facetPositions : optional array of facet positions (vector3)
  104789. * * facetPartitioning : optional partitioning array. facetPositions is required for facetPartitioning computation
  104790. * * ratio : optional partitioning ratio / bounding box, required for facetPartitioning computation
  104791. * * bInfo : optional bounding info, required for facetPartitioning computation
  104792. * * bbSize : optional bounding box size data, required for facetPartitioning computation
  104793. * * subDiv : optional partitioning data about subdivsions on each axis (int), required for facetPartitioning computation
  104794. * * useRightHandedSystem: optional boolean to for right handed system computation
  104795. * * depthSort : optional boolean to enable the facet depth sort computation
  104796. * * distanceTo : optional Vector3 to compute the facet depth from this location
  104797. * * depthSortedFacets : optional array of depthSortedFacets to store the facet distances from the reference location
  104798. */
  104799. static ComputeNormals(positions: any, indices: any, normals: any, options?: {
  104800. facetNormals?: any;
  104801. facetPositions?: any;
  104802. facetPartitioning?: any;
  104803. ratio?: number;
  104804. bInfo?: any;
  104805. bbSize?: Vector3;
  104806. subDiv?: any;
  104807. useRightHandedSystem?: boolean;
  104808. depthSort?: boolean;
  104809. distanceTo?: Vector3;
  104810. depthSortedFacets?: any;
  104811. }): void;
  104812. /** @hidden */
  104813. static _ComputeSides(sideOrientation: number, positions: FloatArray, indices: FloatArray, normals: FloatArray, uvs: FloatArray, frontUVs?: Vector4, backUVs?: Vector4): void;
  104814. /**
  104815. * Applies VertexData created from the imported parameters to the geometry
  104816. * @param parsedVertexData the parsed data from an imported file
  104817. * @param geometry the geometry to apply the VertexData to
  104818. */
  104819. static ImportVertexData(parsedVertexData: any, geometry: Geometry): void;
  104820. }
  104821. }
  104822. declare module BABYLON {
  104823. /**
  104824. * Defines a target to use with MorphTargetManager
  104825. * @see https://doc.babylonjs.com/how_to/how_to_use_morphtargets
  104826. */
  104827. export class MorphTarget implements IAnimatable {
  104828. /** defines the name of the target */
  104829. name: string;
  104830. /**
  104831. * Gets or sets the list of animations
  104832. */
  104833. animations: Animation[];
  104834. private _scene;
  104835. private _positions;
  104836. private _normals;
  104837. private _tangents;
  104838. private _uvs;
  104839. private _influence;
  104840. private _uniqueId;
  104841. /**
  104842. * Observable raised when the influence changes
  104843. */
  104844. onInfluenceChanged: Observable<boolean>;
  104845. /** @hidden */
  104846. _onDataLayoutChanged: Observable<void>;
  104847. /**
  104848. * Gets or sets the influence of this target (ie. its weight in the overall morphing)
  104849. */
  104850. get influence(): number;
  104851. set influence(influence: number);
  104852. /**
  104853. * Gets or sets the id of the morph Target
  104854. */
  104855. id: string;
  104856. private _animationPropertiesOverride;
  104857. /**
  104858. * Gets or sets the animation properties override
  104859. */
  104860. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  104861. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  104862. /**
  104863. * Creates a new MorphTarget
  104864. * @param name defines the name of the target
  104865. * @param influence defines the influence to use
  104866. * @param scene defines the scene the morphtarget belongs to
  104867. */
  104868. constructor(
  104869. /** defines the name of the target */
  104870. name: string, influence?: number, scene?: Nullable<Scene>);
  104871. /**
  104872. * Gets the unique ID of this manager
  104873. */
  104874. get uniqueId(): number;
  104875. /**
  104876. * Gets a boolean defining if the target contains position data
  104877. */
  104878. get hasPositions(): boolean;
  104879. /**
  104880. * Gets a boolean defining if the target contains normal data
  104881. */
  104882. get hasNormals(): boolean;
  104883. /**
  104884. * Gets a boolean defining if the target contains tangent data
  104885. */
  104886. get hasTangents(): boolean;
  104887. /**
  104888. * Gets a boolean defining if the target contains texture coordinates data
  104889. */
  104890. get hasUVs(): boolean;
  104891. /**
  104892. * Affects position data to this target
  104893. * @param data defines the position data to use
  104894. */
  104895. setPositions(data: Nullable<FloatArray>): void;
  104896. /**
  104897. * Gets the position data stored in this target
  104898. * @returns a FloatArray containing the position data (or null if not present)
  104899. */
  104900. getPositions(): Nullable<FloatArray>;
  104901. /**
  104902. * Affects normal data to this target
  104903. * @param data defines the normal data to use
  104904. */
  104905. setNormals(data: Nullable<FloatArray>): void;
  104906. /**
  104907. * Gets the normal data stored in this target
  104908. * @returns a FloatArray containing the normal data (or null if not present)
  104909. */
  104910. getNormals(): Nullable<FloatArray>;
  104911. /**
  104912. * Affects tangent data to this target
  104913. * @param data defines the tangent data to use
  104914. */
  104915. setTangents(data: Nullable<FloatArray>): void;
  104916. /**
  104917. * Gets the tangent data stored in this target
  104918. * @returns a FloatArray containing the tangent data (or null if not present)
  104919. */
  104920. getTangents(): Nullable<FloatArray>;
  104921. /**
  104922. * Affects texture coordinates data to this target
  104923. * @param data defines the texture coordinates data to use
  104924. */
  104925. setUVs(data: Nullable<FloatArray>): void;
  104926. /**
  104927. * Gets the texture coordinates data stored in this target
  104928. * @returns a FloatArray containing the texture coordinates data (or null if not present)
  104929. */
  104930. getUVs(): Nullable<FloatArray>;
  104931. /**
  104932. * Clone the current target
  104933. * @returns a new MorphTarget
  104934. */
  104935. clone(): MorphTarget;
  104936. /**
  104937. * Serializes the current target into a Serialization object
  104938. * @returns the serialized object
  104939. */
  104940. serialize(): any;
  104941. /**
  104942. * Returns the string "MorphTarget"
  104943. * @returns "MorphTarget"
  104944. */
  104945. getClassName(): string;
  104946. /**
  104947. * Creates a new target from serialized data
  104948. * @param serializationObject defines the serialized data to use
  104949. * @returns a new MorphTarget
  104950. */
  104951. static Parse(serializationObject: any): MorphTarget;
  104952. /**
  104953. * Creates a MorphTarget from mesh data
  104954. * @param mesh defines the source mesh
  104955. * @param name defines the name to use for the new target
  104956. * @param influence defines the influence to attach to the target
  104957. * @returns a new MorphTarget
  104958. */
  104959. static FromMesh(mesh: AbstractMesh, name?: string, influence?: number): MorphTarget;
  104960. }
  104961. }
  104962. declare module BABYLON {
  104963. /**
  104964. * This class is used to deform meshes using morphing between different targets
  104965. * @see https://doc.babylonjs.com/how_to/how_to_use_morphtargets
  104966. */
  104967. export class MorphTargetManager {
  104968. private _targets;
  104969. private _targetInfluenceChangedObservers;
  104970. private _targetDataLayoutChangedObservers;
  104971. private _activeTargets;
  104972. private _scene;
  104973. private _influences;
  104974. private _supportsNormals;
  104975. private _supportsTangents;
  104976. private _supportsUVs;
  104977. private _vertexCount;
  104978. private _uniqueId;
  104979. private _tempInfluences;
  104980. /**
  104981. * Gets or sets a boolean indicating if normals must be morphed
  104982. */
  104983. enableNormalMorphing: boolean;
  104984. /**
  104985. * Gets or sets a boolean indicating if tangents must be morphed
  104986. */
  104987. enableTangentMorphing: boolean;
  104988. /**
  104989. * Gets or sets a boolean indicating if UV must be morphed
  104990. */
  104991. enableUVMorphing: boolean;
  104992. /**
  104993. * Creates a new MorphTargetManager
  104994. * @param scene defines the current scene
  104995. */
  104996. constructor(scene?: Nullable<Scene>);
  104997. /**
  104998. * Gets the unique ID of this manager
  104999. */
  105000. get uniqueId(): number;
  105001. /**
  105002. * Gets the number of vertices handled by this manager
  105003. */
  105004. get vertexCount(): number;
  105005. /**
  105006. * Gets a boolean indicating if this manager supports morphing of normals
  105007. */
  105008. get supportsNormals(): boolean;
  105009. /**
  105010. * Gets a boolean indicating if this manager supports morphing of tangents
  105011. */
  105012. get supportsTangents(): boolean;
  105013. /**
  105014. * Gets a boolean indicating if this manager supports morphing of texture coordinates
  105015. */
  105016. get supportsUVs(): boolean;
  105017. /**
  105018. * Gets the number of targets stored in this manager
  105019. */
  105020. get numTargets(): number;
  105021. /**
  105022. * Gets the number of influencers (ie. the number of targets with influences > 0)
  105023. */
  105024. get numInfluencers(): number;
  105025. /**
  105026. * Gets the list of influences (one per target)
  105027. */
  105028. get influences(): Float32Array;
  105029. /**
  105030. * Gets the active target at specified index. An active target is a target with an influence > 0
  105031. * @param index defines the index to check
  105032. * @returns the requested target
  105033. */
  105034. getActiveTarget(index: number): MorphTarget;
  105035. /**
  105036. * Gets the target at specified index
  105037. * @param index defines the index to check
  105038. * @returns the requested target
  105039. */
  105040. getTarget(index: number): MorphTarget;
  105041. /**
  105042. * Add a new target to this manager
  105043. * @param target defines the target to add
  105044. */
  105045. addTarget(target: MorphTarget): void;
  105046. /**
  105047. * Removes a target from the manager
  105048. * @param target defines the target to remove
  105049. */
  105050. removeTarget(target: MorphTarget): void;
  105051. /**
  105052. * Clone the current manager
  105053. * @returns a new MorphTargetManager
  105054. */
  105055. clone(): MorphTargetManager;
  105056. /**
  105057. * Serializes the current manager into a Serialization object
  105058. * @returns the serialized object
  105059. */
  105060. serialize(): any;
  105061. private _syncActiveTargets;
  105062. /**
  105063. * Syncrhonize the targets with all the meshes using this morph target manager
  105064. */
  105065. synchronize(): void;
  105066. /**
  105067. * Creates a new MorphTargetManager from serialized data
  105068. * @param serializationObject defines the serialized data
  105069. * @param scene defines the hosting scene
  105070. * @returns the new MorphTargetManager
  105071. */
  105072. static Parse(serializationObject: any, scene: Scene): MorphTargetManager;
  105073. }
  105074. }
  105075. declare module BABYLON {
  105076. /**
  105077. * Class used to represent a specific level of detail of a mesh
  105078. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  105079. */
  105080. export class MeshLODLevel {
  105081. /** Defines the distance where this level should start being displayed */
  105082. distance: number;
  105083. /** Defines the mesh to use to render this level */
  105084. mesh: Nullable<Mesh>;
  105085. /**
  105086. * Creates a new LOD level
  105087. * @param distance defines the distance where this level should star being displayed
  105088. * @param mesh defines the mesh to use to render this level
  105089. */
  105090. constructor(
  105091. /** Defines the distance where this level should start being displayed */
  105092. distance: number,
  105093. /** Defines the mesh to use to render this level */
  105094. mesh: Nullable<Mesh>);
  105095. }
  105096. }
  105097. declare module BABYLON {
  105098. /**
  105099. * Helper class used to generate a canvas to manipulate images
  105100. */
  105101. export class CanvasGenerator {
  105102. /**
  105103. * Create a new canvas (or offscreen canvas depending on the context)
  105104. * @param width defines the expected width
  105105. * @param height defines the expected height
  105106. * @return a new canvas or offscreen canvas
  105107. */
  105108. static CreateCanvas(width: number, height: number): HTMLCanvasElement | OffscreenCanvas;
  105109. }
  105110. }
  105111. declare module BABYLON {
  105112. /**
  105113. * Mesh representing the gorund
  105114. */
  105115. export class GroundMesh extends Mesh {
  105116. /** If octree should be generated */
  105117. generateOctree: boolean;
  105118. private _heightQuads;
  105119. /** @hidden */
  105120. _subdivisionsX: number;
  105121. /** @hidden */
  105122. _subdivisionsY: number;
  105123. /** @hidden */
  105124. _width: number;
  105125. /** @hidden */
  105126. _height: number;
  105127. /** @hidden */
  105128. _minX: number;
  105129. /** @hidden */
  105130. _maxX: number;
  105131. /** @hidden */
  105132. _minZ: number;
  105133. /** @hidden */
  105134. _maxZ: number;
  105135. constructor(name: string, scene: Scene);
  105136. /**
  105137. * "GroundMesh"
  105138. * @returns "GroundMesh"
  105139. */
  105140. getClassName(): string;
  105141. /**
  105142. * The minimum of x and y subdivisions
  105143. */
  105144. get subdivisions(): number;
  105145. /**
  105146. * X subdivisions
  105147. */
  105148. get subdivisionsX(): number;
  105149. /**
  105150. * Y subdivisions
  105151. */
  105152. get subdivisionsY(): number;
  105153. /**
  105154. * This function will update an octree to help to select the right submeshes for rendering, picking and collision computations.
  105155. * Please note that you must have a decent number of submeshes to get performance improvements when using an octree
  105156. * @param chunksCount the number of subdivisions for x and y
  105157. * @param octreeBlocksSize (Default: 32)
  105158. */
  105159. optimize(chunksCount: number, octreeBlocksSize?: number): void;
  105160. /**
  105161. * Returns a height (y) value in the Worl system :
  105162. * the ground altitude at the coordinates (x, z) expressed in the World system.
  105163. * @param x x coordinate
  105164. * @param z z coordinate
  105165. * @returns the ground y position if (x, z) are outside the ground surface.
  105166. */
  105167. getHeightAtCoordinates(x: number, z: number): number;
  105168. /**
  105169. * Returns a normalized vector (Vector3) orthogonal to the ground
  105170. * at the ground coordinates (x, z) expressed in the World system.
  105171. * @param x x coordinate
  105172. * @param z z coordinate
  105173. * @returns Vector3(0.0, 1.0, 0.0) if (x, z) are outside the ground surface.
  105174. */
  105175. getNormalAtCoordinates(x: number, z: number): Vector3;
  105176. /**
  105177. * Updates the Vector3 passed a reference with a normalized vector orthogonal to the ground
  105178. * at the ground coordinates (x, z) expressed in the World system.
  105179. * Doesn't uptade the reference Vector3 if (x, z) are outside the ground surface.
  105180. * @param x x coordinate
  105181. * @param z z coordinate
  105182. * @param ref vector to store the result
  105183. * @returns the GroundMesh.
  105184. */
  105185. getNormalAtCoordinatesToRef(x: number, z: number, ref: Vector3): GroundMesh;
  105186. /**
  105187. * Force the heights to be recomputed for getHeightAtCoordinates() or getNormalAtCoordinates()
  105188. * if the ground has been updated.
  105189. * This can be used in the render loop.
  105190. * @returns the GroundMesh.
  105191. */
  105192. updateCoordinateHeights(): GroundMesh;
  105193. private _getFacetAt;
  105194. private _initHeightQuads;
  105195. private _computeHeightQuads;
  105196. /**
  105197. * Serializes this ground mesh
  105198. * @param serializationObject object to write serialization to
  105199. */
  105200. serialize(serializationObject: any): void;
  105201. /**
  105202. * Parses a serialized ground mesh
  105203. * @param parsedMesh the serialized mesh
  105204. * @param scene the scene to create the ground mesh in
  105205. * @returns the created ground mesh
  105206. */
  105207. static Parse(parsedMesh: any, scene: Scene): GroundMesh;
  105208. }
  105209. }
  105210. declare module BABYLON {
  105211. /**
  105212. * Interface for Physics-Joint data
  105213. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  105214. */
  105215. export interface PhysicsJointData {
  105216. /**
  105217. * The main pivot of the joint
  105218. */
  105219. mainPivot?: Vector3;
  105220. /**
  105221. * The connected pivot of the joint
  105222. */
  105223. connectedPivot?: Vector3;
  105224. /**
  105225. * The main axis of the joint
  105226. */
  105227. mainAxis?: Vector3;
  105228. /**
  105229. * The connected axis of the joint
  105230. */
  105231. connectedAxis?: Vector3;
  105232. /**
  105233. * The collision of the joint
  105234. */
  105235. collision?: boolean;
  105236. /**
  105237. * Native Oimo/Cannon/Energy data
  105238. */
  105239. nativeParams?: any;
  105240. }
  105241. /**
  105242. * This is a holder class for the physics joint created by the physics plugin
  105243. * It holds a set of functions to control the underlying joint
  105244. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  105245. */
  105246. export class PhysicsJoint {
  105247. /**
  105248. * The type of the physics joint
  105249. */
  105250. type: number;
  105251. /**
  105252. * The data for the physics joint
  105253. */
  105254. jointData: PhysicsJointData;
  105255. private _physicsJoint;
  105256. protected _physicsPlugin: IPhysicsEnginePlugin;
  105257. /**
  105258. * Initializes the physics joint
  105259. * @param type The type of the physics joint
  105260. * @param jointData The data for the physics joint
  105261. */
  105262. constructor(
  105263. /**
  105264. * The type of the physics joint
  105265. */
  105266. type: number,
  105267. /**
  105268. * The data for the physics joint
  105269. */
  105270. jointData: PhysicsJointData);
  105271. /**
  105272. * Gets the physics joint
  105273. */
  105274. get physicsJoint(): any;
  105275. /**
  105276. * Sets the physics joint
  105277. */
  105278. set physicsJoint(newJoint: any);
  105279. /**
  105280. * Sets the physics plugin
  105281. */
  105282. set physicsPlugin(physicsPlugin: IPhysicsEnginePlugin);
  105283. /**
  105284. * Execute a function that is physics-plugin specific.
  105285. * @param {Function} func the function that will be executed.
  105286. * It accepts two parameters: the physics world and the physics joint
  105287. */
  105288. executeNativeFunction(func: (world: any, physicsJoint: any) => void): void;
  105289. /**
  105290. * Distance-Joint type
  105291. */
  105292. static DistanceJoint: number;
  105293. /**
  105294. * Hinge-Joint type
  105295. */
  105296. static HingeJoint: number;
  105297. /**
  105298. * Ball-and-Socket joint type
  105299. */
  105300. static BallAndSocketJoint: number;
  105301. /**
  105302. * Wheel-Joint type
  105303. */
  105304. static WheelJoint: number;
  105305. /**
  105306. * Slider-Joint type
  105307. */
  105308. static SliderJoint: number;
  105309. /**
  105310. * Prismatic-Joint type
  105311. */
  105312. static PrismaticJoint: number;
  105313. /**
  105314. * Universal-Joint type
  105315. * ENERGY FTW! (compare with this - @see http://ode-wiki.org/wiki/index.php?title=Manual:_Joint_Types_and_Functions)
  105316. */
  105317. static UniversalJoint: number;
  105318. /**
  105319. * Hinge-Joint 2 type
  105320. */
  105321. static Hinge2Joint: number;
  105322. /**
  105323. * Point to Point Joint type. Similar to a Ball-Joint. Different in parameters
  105324. */
  105325. static PointToPointJoint: number;
  105326. /**
  105327. * Spring-Joint type
  105328. */
  105329. static SpringJoint: number;
  105330. /**
  105331. * Lock-Joint type
  105332. */
  105333. static LockJoint: number;
  105334. }
  105335. /**
  105336. * A class representing a physics distance joint
  105337. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  105338. */
  105339. export class DistanceJoint extends PhysicsJoint {
  105340. /**
  105341. *
  105342. * @param jointData The data for the Distance-Joint
  105343. */
  105344. constructor(jointData: DistanceJointData);
  105345. /**
  105346. * Update the predefined distance.
  105347. * @param maxDistance The maximum preferred distance
  105348. * @param minDistance The minimum preferred distance
  105349. */
  105350. updateDistance(maxDistance: number, minDistance?: number): void;
  105351. }
  105352. /**
  105353. * Represents a Motor-Enabled Joint
  105354. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  105355. */
  105356. export class MotorEnabledJoint extends PhysicsJoint implements IMotorEnabledJoint {
  105357. /**
  105358. * Initializes the Motor-Enabled Joint
  105359. * @param type The type of the joint
  105360. * @param jointData The physica joint data for the joint
  105361. */
  105362. constructor(type: number, jointData: PhysicsJointData);
  105363. /**
  105364. * Set the motor values.
  105365. * Attention, this function is plugin specific. Engines won't react 100% the same.
  105366. * @param force the force to apply
  105367. * @param maxForce max force for this motor.
  105368. */
  105369. setMotor(force?: number, maxForce?: number): void;
  105370. /**
  105371. * Set the motor's limits.
  105372. * Attention, this function is plugin specific. Engines won't react 100% the same.
  105373. * @param upperLimit The upper limit of the motor
  105374. * @param lowerLimit The lower limit of the motor
  105375. */
  105376. setLimit(upperLimit: number, lowerLimit?: number): void;
  105377. }
  105378. /**
  105379. * This class represents a single physics Hinge-Joint
  105380. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  105381. */
  105382. export class HingeJoint extends MotorEnabledJoint {
  105383. /**
  105384. * Initializes the Hinge-Joint
  105385. * @param jointData The joint data for the Hinge-Joint
  105386. */
  105387. constructor(jointData: PhysicsJointData);
  105388. /**
  105389. * Set the motor values.
  105390. * Attention, this function is plugin specific. Engines won't react 100% the same.
  105391. * @param {number} force the force to apply
  105392. * @param {number} maxForce max force for this motor.
  105393. */
  105394. setMotor(force?: number, maxForce?: number): void;
  105395. /**
  105396. * Set the motor's limits.
  105397. * Attention, this function is plugin specific. Engines won't react 100% the same.
  105398. * @param upperLimit The upper limit of the motor
  105399. * @param lowerLimit The lower limit of the motor
  105400. */
  105401. setLimit(upperLimit: number, lowerLimit?: number): void;
  105402. }
  105403. /**
  105404. * This class represents a dual hinge physics joint (same as wheel joint)
  105405. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  105406. */
  105407. export class Hinge2Joint extends MotorEnabledJoint {
  105408. /**
  105409. * Initializes the Hinge2-Joint
  105410. * @param jointData The joint data for the Hinge2-Joint
  105411. */
  105412. constructor(jointData: PhysicsJointData);
  105413. /**
  105414. * Set the motor values.
  105415. * Attention, this function is plugin specific. Engines won't react 100% the same.
  105416. * @param {number} targetSpeed the speed the motor is to reach
  105417. * @param {number} maxForce max force for this motor.
  105418. * @param {motorIndex} the motor's index, 0 or 1.
  105419. */
  105420. setMotor(targetSpeed?: number, maxForce?: number, motorIndex?: number): void;
  105421. /**
  105422. * Set the motor limits.
  105423. * Attention, this function is plugin specific. Engines won't react 100% the same.
  105424. * @param {number} upperLimit the upper limit
  105425. * @param {number} lowerLimit lower limit
  105426. * @param {motorIndex} the motor's index, 0 or 1.
  105427. */
  105428. setLimit(upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  105429. }
  105430. /**
  105431. * Interface for a motor enabled joint
  105432. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  105433. */
  105434. export interface IMotorEnabledJoint {
  105435. /**
  105436. * Physics joint
  105437. */
  105438. physicsJoint: any;
  105439. /**
  105440. * Sets the motor of the motor-enabled joint
  105441. * @param force The force of the motor
  105442. * @param maxForce The maximum force of the motor
  105443. * @param motorIndex The index of the motor
  105444. */
  105445. setMotor(force?: number, maxForce?: number, motorIndex?: number): void;
  105446. /**
  105447. * Sets the limit of the motor
  105448. * @param upperLimit The upper limit of the motor
  105449. * @param lowerLimit The lower limit of the motor
  105450. * @param motorIndex The index of the motor
  105451. */
  105452. setLimit(upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  105453. }
  105454. /**
  105455. * Joint data for a Distance-Joint
  105456. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  105457. */
  105458. export interface DistanceJointData extends PhysicsJointData {
  105459. /**
  105460. * Max distance the 2 joint objects can be apart
  105461. */
  105462. maxDistance: number;
  105463. }
  105464. /**
  105465. * Joint data from a spring joint
  105466. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  105467. */
  105468. export interface SpringJointData extends PhysicsJointData {
  105469. /**
  105470. * Length of the spring
  105471. */
  105472. length: number;
  105473. /**
  105474. * Stiffness of the spring
  105475. */
  105476. stiffness: number;
  105477. /**
  105478. * Damping of the spring
  105479. */
  105480. damping: number;
  105481. /** this callback will be called when applying the force to the impostors. */
  105482. forceApplicationCallback: () => void;
  105483. }
  105484. }
  105485. declare module BABYLON {
  105486. /**
  105487. * Holds the data for the raycast result
  105488. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  105489. */
  105490. export class PhysicsRaycastResult {
  105491. private _hasHit;
  105492. private _hitDistance;
  105493. private _hitNormalWorld;
  105494. private _hitPointWorld;
  105495. private _rayFromWorld;
  105496. private _rayToWorld;
  105497. /**
  105498. * Gets if there was a hit
  105499. */
  105500. get hasHit(): boolean;
  105501. /**
  105502. * Gets the distance from the hit
  105503. */
  105504. get hitDistance(): number;
  105505. /**
  105506. * Gets the hit normal/direction in the world
  105507. */
  105508. get hitNormalWorld(): Vector3;
  105509. /**
  105510. * Gets the hit point in the world
  105511. */
  105512. get hitPointWorld(): Vector3;
  105513. /**
  105514. * Gets the ray "start point" of the ray in the world
  105515. */
  105516. get rayFromWorld(): Vector3;
  105517. /**
  105518. * Gets the ray "end point" of the ray in the world
  105519. */
  105520. get rayToWorld(): Vector3;
  105521. /**
  105522. * Sets the hit data (normal & point in world space)
  105523. * @param hitNormalWorld defines the normal in world space
  105524. * @param hitPointWorld defines the point in world space
  105525. */
  105526. setHitData(hitNormalWorld: IXYZ, hitPointWorld: IXYZ): void;
  105527. /**
  105528. * Sets the distance from the start point to the hit point
  105529. * @param distance
  105530. */
  105531. setHitDistance(distance: number): void;
  105532. /**
  105533. * Calculates the distance manually
  105534. */
  105535. calculateHitDistance(): void;
  105536. /**
  105537. * Resets all the values to default
  105538. * @param from The from point on world space
  105539. * @param to The to point on world space
  105540. */
  105541. reset(from?: Vector3, to?: Vector3): void;
  105542. }
  105543. /**
  105544. * Interface for the size containing width and height
  105545. */
  105546. interface IXYZ {
  105547. /**
  105548. * X
  105549. */
  105550. x: number;
  105551. /**
  105552. * Y
  105553. */
  105554. y: number;
  105555. /**
  105556. * Z
  105557. */
  105558. z: number;
  105559. }
  105560. }
  105561. declare module BABYLON {
  105562. /**
  105563. * Interface used to describe a physics joint
  105564. */
  105565. export interface PhysicsImpostorJoint {
  105566. /** Defines the main impostor to which the joint is linked */
  105567. mainImpostor: PhysicsImpostor;
  105568. /** Defines the impostor that is connected to the main impostor using this joint */
  105569. connectedImpostor: PhysicsImpostor;
  105570. /** Defines the joint itself */
  105571. joint: PhysicsJoint;
  105572. }
  105573. /** @hidden */
  105574. export interface IPhysicsEnginePlugin {
  105575. world: any;
  105576. name: string;
  105577. setGravity(gravity: Vector3): void;
  105578. setTimeStep(timeStep: number): void;
  105579. getTimeStep(): number;
  105580. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  105581. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  105582. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  105583. generatePhysicsBody(impostor: PhysicsImpostor): void;
  105584. removePhysicsBody(impostor: PhysicsImpostor): void;
  105585. generateJoint(joint: PhysicsImpostorJoint): void;
  105586. removeJoint(joint: PhysicsImpostorJoint): void;
  105587. isSupported(): boolean;
  105588. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  105589. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  105590. setLinearVelocity(impostor: PhysicsImpostor, velocity: Nullable<Vector3>): void;
  105591. setAngularVelocity(impostor: PhysicsImpostor, velocity: Nullable<Vector3>): void;
  105592. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  105593. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  105594. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  105595. getBodyMass(impostor: PhysicsImpostor): number;
  105596. getBodyFriction(impostor: PhysicsImpostor): number;
  105597. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  105598. getBodyRestitution(impostor: PhysicsImpostor): number;
  105599. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  105600. getBodyPressure?(impostor: PhysicsImpostor): number;
  105601. setBodyPressure?(impostor: PhysicsImpostor, pressure: number): void;
  105602. getBodyStiffness?(impostor: PhysicsImpostor): number;
  105603. setBodyStiffness?(impostor: PhysicsImpostor, stiffness: number): void;
  105604. getBodyVelocityIterations?(impostor: PhysicsImpostor): number;
  105605. setBodyVelocityIterations?(impostor: PhysicsImpostor, velocityIterations: number): void;
  105606. getBodyPositionIterations?(impostor: PhysicsImpostor): number;
  105607. setBodyPositionIterations?(impostor: PhysicsImpostor, positionIterations: number): void;
  105608. appendAnchor?(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, width: number, height: number, influence: number, noCollisionBetweenLinkedBodies: boolean): void;
  105609. appendHook?(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, length: number, influence: number, noCollisionBetweenLinkedBodies: boolean): void;
  105610. sleepBody(impostor: PhysicsImpostor): void;
  105611. wakeUpBody(impostor: PhysicsImpostor): void;
  105612. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  105613. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  105614. setMotor(joint: IMotorEnabledJoint, speed: number, maxForce?: number, motorIndex?: number): void;
  105615. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  105616. getRadius(impostor: PhysicsImpostor): number;
  105617. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  105618. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  105619. dispose(): void;
  105620. }
  105621. /**
  105622. * Interface used to define a physics engine
  105623. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  105624. */
  105625. export interface IPhysicsEngine {
  105626. /**
  105627. * Gets the gravity vector used by the simulation
  105628. */
  105629. gravity: Vector3;
  105630. /**
  105631. * Sets the gravity vector used by the simulation
  105632. * @param gravity defines the gravity vector to use
  105633. */
  105634. setGravity(gravity: Vector3): void;
  105635. /**
  105636. * Set the time step of the physics engine.
  105637. * Default is 1/60.
  105638. * To slow it down, enter 1/600 for example.
  105639. * To speed it up, 1/30
  105640. * @param newTimeStep the new timestep to apply to this world.
  105641. */
  105642. setTimeStep(newTimeStep: number): void;
  105643. /**
  105644. * Get the time step of the physics engine.
  105645. * @returns the current time step
  105646. */
  105647. getTimeStep(): number;
  105648. /**
  105649. * Set the sub time step of the physics engine.
  105650. * Default is 0 meaning there is no sub steps
  105651. * To increase physics resolution precision, set a small value (like 1 ms)
  105652. * @param subTimeStep defines the new sub timestep used for physics resolution.
  105653. */
  105654. setSubTimeStep(subTimeStep: number): void;
  105655. /**
  105656. * Get the sub time step of the physics engine.
  105657. * @returns the current sub time step
  105658. */
  105659. getSubTimeStep(): number;
  105660. /**
  105661. * Release all resources
  105662. */
  105663. dispose(): void;
  105664. /**
  105665. * Gets the name of the current physics plugin
  105666. * @returns the name of the plugin
  105667. */
  105668. getPhysicsPluginName(): string;
  105669. /**
  105670. * Adding a new impostor for the impostor tracking.
  105671. * This will be done by the impostor itself.
  105672. * @param impostor the impostor to add
  105673. */
  105674. addImpostor(impostor: PhysicsImpostor): void;
  105675. /**
  105676. * Remove an impostor from the engine.
  105677. * This impostor and its mesh will not longer be updated by the physics engine.
  105678. * @param impostor the impostor to remove
  105679. */
  105680. removeImpostor(impostor: PhysicsImpostor): void;
  105681. /**
  105682. * Add a joint to the physics engine
  105683. * @param mainImpostor defines the main impostor to which the joint is added.
  105684. * @param connectedImpostor defines the impostor that is connected to the main impostor using this joint
  105685. * @param joint defines the joint that will connect both impostors.
  105686. */
  105687. addJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  105688. /**
  105689. * Removes a joint from the simulation
  105690. * @param mainImpostor defines the impostor used with the joint
  105691. * @param connectedImpostor defines the other impostor connected to the main one by the joint
  105692. * @param joint defines the joint to remove
  105693. */
  105694. removeJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  105695. /**
  105696. * Gets the current plugin used to run the simulation
  105697. * @returns current plugin
  105698. */
  105699. getPhysicsPlugin(): IPhysicsEnginePlugin;
  105700. /**
  105701. * Gets the list of physic impostors
  105702. * @returns an array of PhysicsImpostor
  105703. */
  105704. getImpostors(): Array<PhysicsImpostor>;
  105705. /**
  105706. * Gets the impostor for a physics enabled object
  105707. * @param object defines the object impersonated by the impostor
  105708. * @returns the PhysicsImpostor or null if not found
  105709. */
  105710. getImpostorForPhysicsObject(object: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  105711. /**
  105712. * Gets the impostor for a physics body object
  105713. * @param body defines physics body used by the impostor
  105714. * @returns the PhysicsImpostor or null if not found
  105715. */
  105716. getImpostorWithPhysicsBody(body: any): Nullable<PhysicsImpostor>;
  105717. /**
  105718. * Does a raycast in the physics world
  105719. * @param from when should the ray start?
  105720. * @param to when should the ray end?
  105721. * @returns PhysicsRaycastResult
  105722. */
  105723. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  105724. /**
  105725. * Called by the scene. No need to call it.
  105726. * @param delta defines the timespam between frames
  105727. */
  105728. _step(delta: number): void;
  105729. }
  105730. }
  105731. declare module BABYLON {
  105732. /**
  105733. * The interface for the physics imposter parameters
  105734. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  105735. */
  105736. export interface PhysicsImpostorParameters {
  105737. /**
  105738. * The mass of the physics imposter
  105739. */
  105740. mass: number;
  105741. /**
  105742. * The friction of the physics imposter
  105743. */
  105744. friction?: number;
  105745. /**
  105746. * The coefficient of restitution of the physics imposter
  105747. */
  105748. restitution?: number;
  105749. /**
  105750. * The native options of the physics imposter
  105751. */
  105752. nativeOptions?: any;
  105753. /**
  105754. * Specifies if the parent should be ignored
  105755. */
  105756. ignoreParent?: boolean;
  105757. /**
  105758. * Specifies if bi-directional transformations should be disabled
  105759. */
  105760. disableBidirectionalTransformation?: boolean;
  105761. /**
  105762. * The pressure inside the physics imposter, soft object only
  105763. */
  105764. pressure?: number;
  105765. /**
  105766. * The stiffness the physics imposter, soft object only
  105767. */
  105768. stiffness?: number;
  105769. /**
  105770. * The number of iterations used in maintaining consistent vertex velocities, soft object only
  105771. */
  105772. velocityIterations?: number;
  105773. /**
  105774. * The number of iterations used in maintaining consistent vertex positions, soft object only
  105775. */
  105776. positionIterations?: number;
  105777. /**
  105778. * The number used to fix points on a cloth (0, 1, 2, 4, 8) or rope (0, 1, 2) only
  105779. * 0 None, 1, back left or top, 2, back right or bottom, 4, front left, 8, front right
  105780. * Add to fix multiple points
  105781. */
  105782. fixedPoints?: number;
  105783. /**
  105784. * The collision margin around a soft object
  105785. */
  105786. margin?: number;
  105787. /**
  105788. * The collision margin around a soft object
  105789. */
  105790. damping?: number;
  105791. /**
  105792. * The path for a rope based on an extrusion
  105793. */
  105794. path?: any;
  105795. /**
  105796. * The shape of an extrusion used for a rope based on an extrusion
  105797. */
  105798. shape?: any;
  105799. }
  105800. /**
  105801. * Interface for a physics-enabled object
  105802. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  105803. */
  105804. export interface IPhysicsEnabledObject {
  105805. /**
  105806. * The position of the physics-enabled object
  105807. */
  105808. position: Vector3;
  105809. /**
  105810. * The rotation of the physics-enabled object
  105811. */
  105812. rotationQuaternion: Nullable<Quaternion>;
  105813. /**
  105814. * The scale of the physics-enabled object
  105815. */
  105816. scaling: Vector3;
  105817. /**
  105818. * The rotation of the physics-enabled object
  105819. */
  105820. rotation?: Vector3;
  105821. /**
  105822. * The parent of the physics-enabled object
  105823. */
  105824. parent?: any;
  105825. /**
  105826. * The bounding info of the physics-enabled object
  105827. * @returns The bounding info of the physics-enabled object
  105828. */
  105829. getBoundingInfo(): BoundingInfo;
  105830. /**
  105831. * Computes the world matrix
  105832. * @param force Specifies if the world matrix should be computed by force
  105833. * @returns A world matrix
  105834. */
  105835. computeWorldMatrix(force: boolean): Matrix;
  105836. /**
  105837. * Gets the world matrix
  105838. * @returns A world matrix
  105839. */
  105840. getWorldMatrix?(): Matrix;
  105841. /**
  105842. * Gets the child meshes
  105843. * @param directDescendantsOnly Specifies if only direct-descendants should be obtained
  105844. * @returns An array of abstract meshes
  105845. */
  105846. getChildMeshes?(directDescendantsOnly?: boolean): Array<AbstractMesh>;
  105847. /**
  105848. * Gets the vertex data
  105849. * @param kind The type of vertex data
  105850. * @returns A nullable array of numbers, or a float32 array
  105851. */
  105852. getVerticesData(kind: string): Nullable<Array<number> | Float32Array>;
  105853. /**
  105854. * Gets the indices from the mesh
  105855. * @returns A nullable array of index arrays
  105856. */
  105857. getIndices?(): Nullable<IndicesArray>;
  105858. /**
  105859. * Gets the scene from the mesh
  105860. * @returns the indices array or null
  105861. */
  105862. getScene?(): Scene;
  105863. /**
  105864. * Gets the absolute position from the mesh
  105865. * @returns the absolute position
  105866. */
  105867. getAbsolutePosition(): Vector3;
  105868. /**
  105869. * Gets the absolute pivot point from the mesh
  105870. * @returns the absolute pivot point
  105871. */
  105872. getAbsolutePivotPoint(): Vector3;
  105873. /**
  105874. * Rotates the mesh
  105875. * @param axis The axis of rotation
  105876. * @param amount The amount of rotation
  105877. * @param space The space of the rotation
  105878. * @returns The rotation transform node
  105879. */
  105880. rotate(axis: Vector3, amount: number, space?: Space): TransformNode;
  105881. /**
  105882. * Translates the mesh
  105883. * @param axis The axis of translation
  105884. * @param distance The distance of translation
  105885. * @param space The space of the translation
  105886. * @returns The transform node
  105887. */
  105888. translate(axis: Vector3, distance: number, space?: Space): TransformNode;
  105889. /**
  105890. * Sets the absolute position of the mesh
  105891. * @param absolutePosition The absolute position of the mesh
  105892. * @returns The transform node
  105893. */
  105894. setAbsolutePosition(absolutePosition: Vector3): TransformNode;
  105895. /**
  105896. * Gets the class name of the mesh
  105897. * @returns The class name
  105898. */
  105899. getClassName(): string;
  105900. }
  105901. /**
  105902. * Represents a physics imposter
  105903. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  105904. */
  105905. export class PhysicsImpostor {
  105906. /**
  105907. * The physics-enabled object used as the physics imposter
  105908. */
  105909. object: IPhysicsEnabledObject;
  105910. /**
  105911. * The type of the physics imposter
  105912. */
  105913. type: number;
  105914. private _options;
  105915. private _scene?;
  105916. /**
  105917. * The default object size of the imposter
  105918. */
  105919. static DEFAULT_OBJECT_SIZE: Vector3;
  105920. /**
  105921. * The identity quaternion of the imposter
  105922. */
  105923. static IDENTITY_QUATERNION: Quaternion;
  105924. /** @hidden */
  105925. _pluginData: any;
  105926. private _physicsEngine;
  105927. private _physicsBody;
  105928. private _bodyUpdateRequired;
  105929. private _onBeforePhysicsStepCallbacks;
  105930. private _onAfterPhysicsStepCallbacks;
  105931. /** @hidden */
  105932. _onPhysicsCollideCallbacks: Array<{
  105933. callback: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor) => void;
  105934. otherImpostors: Array<PhysicsImpostor>;
  105935. }>;
  105936. private _deltaPosition;
  105937. private _deltaRotation;
  105938. private _deltaRotationConjugated;
  105939. /** @hidden */
  105940. _isFromLine: boolean;
  105941. private _parent;
  105942. private _isDisposed;
  105943. private static _tmpVecs;
  105944. private static _tmpQuat;
  105945. /**
  105946. * Specifies if the physics imposter is disposed
  105947. */
  105948. get isDisposed(): boolean;
  105949. /**
  105950. * Gets the mass of the physics imposter
  105951. */
  105952. get mass(): number;
  105953. set mass(value: number);
  105954. /**
  105955. * Gets the coefficient of friction
  105956. */
  105957. get friction(): number;
  105958. /**
  105959. * Sets the coefficient of friction
  105960. */
  105961. set friction(value: number);
  105962. /**
  105963. * Gets the coefficient of restitution
  105964. */
  105965. get restitution(): number;
  105966. /**
  105967. * Sets the coefficient of restitution
  105968. */
  105969. set restitution(value: number);
  105970. /**
  105971. * Gets the pressure of a soft body; only supported by the AmmoJSPlugin
  105972. */
  105973. get pressure(): number;
  105974. /**
  105975. * Sets the pressure of a soft body; only supported by the AmmoJSPlugin
  105976. */
  105977. set pressure(value: number);
  105978. /**
  105979. * Gets the stiffness of a soft body; only supported by the AmmoJSPlugin
  105980. */
  105981. get stiffness(): number;
  105982. /**
  105983. * Sets the stiffness of a soft body; only supported by the AmmoJSPlugin
  105984. */
  105985. set stiffness(value: number);
  105986. /**
  105987. * Gets the velocityIterations of a soft body; only supported by the AmmoJSPlugin
  105988. */
  105989. get velocityIterations(): number;
  105990. /**
  105991. * Sets the velocityIterations of a soft body; only supported by the AmmoJSPlugin
  105992. */
  105993. set velocityIterations(value: number);
  105994. /**
  105995. * Gets the positionIterations of a soft body; only supported by the AmmoJSPlugin
  105996. */
  105997. get positionIterations(): number;
  105998. /**
  105999. * Sets the positionIterations of a soft body; only supported by the AmmoJSPlugin
  106000. */
  106001. set positionIterations(value: number);
  106002. /**
  106003. * The unique id of the physics imposter
  106004. * set by the physics engine when adding this impostor to the array
  106005. */
  106006. uniqueId: number;
  106007. /**
  106008. * @hidden
  106009. */
  106010. soft: boolean;
  106011. /**
  106012. * @hidden
  106013. */
  106014. segments: number;
  106015. private _joints;
  106016. /**
  106017. * Initializes the physics imposter
  106018. * @param object The physics-enabled object used as the physics imposter
  106019. * @param type The type of the physics imposter
  106020. * @param _options The options for the physics imposter
  106021. * @param _scene The Babylon scene
  106022. */
  106023. constructor(
  106024. /**
  106025. * The physics-enabled object used as the physics imposter
  106026. */
  106027. object: IPhysicsEnabledObject,
  106028. /**
  106029. * The type of the physics imposter
  106030. */
  106031. type: number, _options?: PhysicsImpostorParameters, _scene?: Scene | undefined);
  106032. /**
  106033. * This function will completly initialize this impostor.
  106034. * It will create a new body - but only if this mesh has no parent.
  106035. * If it has, this impostor will not be used other than to define the impostor
  106036. * of the child mesh.
  106037. * @hidden
  106038. */
  106039. _init(): void;
  106040. private _getPhysicsParent;
  106041. /**
  106042. * Should a new body be generated.
  106043. * @returns boolean specifying if body initialization is required
  106044. */
  106045. isBodyInitRequired(): boolean;
  106046. /**
  106047. * Sets the updated scaling
  106048. * @param updated Specifies if the scaling is updated
  106049. */
  106050. setScalingUpdated(): void;
  106051. /**
  106052. * Force a regeneration of this or the parent's impostor's body.
  106053. * Use under cautious - This will remove all joints already implemented.
  106054. */
  106055. forceUpdate(): void;
  106056. /**
  106057. * Gets the body that holds this impostor. Either its own, or its parent.
  106058. */
  106059. get physicsBody(): any;
  106060. /**
  106061. * Get the parent of the physics imposter
  106062. * @returns Physics imposter or null
  106063. */
  106064. get parent(): Nullable<PhysicsImpostor>;
  106065. /**
  106066. * Sets the parent of the physics imposter
  106067. */
  106068. set parent(value: Nullable<PhysicsImpostor>);
  106069. /**
  106070. * Set the physics body. Used mainly by the physics engine/plugin
  106071. */
  106072. set physicsBody(physicsBody: any);
  106073. /**
  106074. * Resets the update flags
  106075. */
  106076. resetUpdateFlags(): void;
  106077. /**
  106078. * Gets the object extend size
  106079. * @returns the object extend size
  106080. */
  106081. getObjectExtendSize(): Vector3;
  106082. /**
  106083. * Gets the object center
  106084. * @returns The object center
  106085. */
  106086. getObjectCenter(): Vector3;
  106087. /**
  106088. * Get a specific parameter from the options parameters
  106089. * @param paramName The object parameter name
  106090. * @returns The object parameter
  106091. */
  106092. getParam(paramName: string): any;
  106093. /**
  106094. * Sets a specific parameter in the options given to the physics plugin
  106095. * @param paramName The parameter name
  106096. * @param value The value of the parameter
  106097. */
  106098. setParam(paramName: string, value: number): void;
  106099. /**
  106100. * Specifically change the body's mass option. Won't recreate the physics body object
  106101. * @param mass The mass of the physics imposter
  106102. */
  106103. setMass(mass: number): void;
  106104. /**
  106105. * Gets the linear velocity
  106106. * @returns linear velocity or null
  106107. */
  106108. getLinearVelocity(): Nullable<Vector3>;
  106109. /**
  106110. * Sets the linear velocity
  106111. * @param velocity linear velocity or null
  106112. */
  106113. setLinearVelocity(velocity: Nullable<Vector3>): void;
  106114. /**
  106115. * Gets the angular velocity
  106116. * @returns angular velocity or null
  106117. */
  106118. getAngularVelocity(): Nullable<Vector3>;
  106119. /**
  106120. * Sets the angular velocity
  106121. * @param velocity The velocity or null
  106122. */
  106123. setAngularVelocity(velocity: Nullable<Vector3>): void;
  106124. /**
  106125. * Execute a function with the physics plugin native code
  106126. * Provide a function the will have two variables - the world object and the physics body object
  106127. * @param func The function to execute with the physics plugin native code
  106128. */
  106129. executeNativeFunction(func: (world: any, physicsBody: any) => void): void;
  106130. /**
  106131. * Register a function that will be executed before the physics world is stepping forward
  106132. * @param func The function to execute before the physics world is stepped forward
  106133. */
  106134. registerBeforePhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  106135. /**
  106136. * Unregister a function that will be executed before the physics world is stepping forward
  106137. * @param func The function to execute before the physics world is stepped forward
  106138. */
  106139. unregisterBeforePhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  106140. /**
  106141. * Register a function that will be executed after the physics step
  106142. * @param func The function to execute after physics step
  106143. */
  106144. registerAfterPhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  106145. /**
  106146. * Unregisters a function that will be executed after the physics step
  106147. * @param func The function to execute after physics step
  106148. */
  106149. unregisterAfterPhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  106150. /**
  106151. * register a function that will be executed when this impostor collides against a different body
  106152. * @param collideAgainst Physics imposter, or array of physics imposters to collide against
  106153. * @param func Callback that is executed on collision
  106154. */
  106155. registerOnPhysicsCollide(collideAgainst: PhysicsImpostor | Array<PhysicsImpostor>, func: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor) => void): void;
  106156. /**
  106157. * Unregisters the physics imposter on contact
  106158. * @param collideAgainst The physics object to collide against
  106159. * @param func Callback to execute on collision
  106160. */
  106161. unregisterOnPhysicsCollide(collideAgainst: PhysicsImpostor | Array<PhysicsImpostor>, func: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor | Array<PhysicsImpostor>) => void): void;
  106162. private _tmpQuat;
  106163. private _tmpQuat2;
  106164. /**
  106165. * Get the parent rotation
  106166. * @returns The parent rotation
  106167. */
  106168. getParentsRotation(): Quaternion;
  106169. /**
  106170. * this function is executed by the physics engine.
  106171. */
  106172. beforeStep: () => void;
  106173. /**
  106174. * this function is executed by the physics engine
  106175. */
  106176. afterStep: () => void;
  106177. /**
  106178. * Legacy collision detection event support
  106179. */
  106180. onCollideEvent: Nullable<(collider: PhysicsImpostor, collidedWith: PhysicsImpostor) => void>;
  106181. /**
  106182. * event and body object due to cannon's event-based architecture.
  106183. */
  106184. onCollide: (e: {
  106185. body: any;
  106186. }) => void;
  106187. /**
  106188. * Apply a force
  106189. * @param force The force to apply
  106190. * @param contactPoint The contact point for the force
  106191. * @returns The physics imposter
  106192. */
  106193. applyForce(force: Vector3, contactPoint: Vector3): PhysicsImpostor;
  106194. /**
  106195. * Apply an impulse
  106196. * @param force The impulse force
  106197. * @param contactPoint The contact point for the impulse force
  106198. * @returns The physics imposter
  106199. */
  106200. applyImpulse(force: Vector3, contactPoint: Vector3): PhysicsImpostor;
  106201. /**
  106202. * A help function to create a joint
  106203. * @param otherImpostor A physics imposter used to create a joint
  106204. * @param jointType The type of joint
  106205. * @param jointData The data for the joint
  106206. * @returns The physics imposter
  106207. */
  106208. createJoint(otherImpostor: PhysicsImpostor, jointType: number, jointData: PhysicsJointData): PhysicsImpostor;
  106209. /**
  106210. * Add a joint to this impostor with a different impostor
  106211. * @param otherImpostor A physics imposter used to add a joint
  106212. * @param joint The joint to add
  106213. * @returns The physics imposter
  106214. */
  106215. addJoint(otherImpostor: PhysicsImpostor, joint: PhysicsJoint): PhysicsImpostor;
  106216. /**
  106217. * Add an anchor to a cloth impostor
  106218. * @param otherImpostor rigid impostor to anchor to
  106219. * @param width ratio across width from 0 to 1
  106220. * @param height ratio up height from 0 to 1
  106221. * @param influence the elasticity between cloth impostor and anchor from 0, very stretchy to 1, little strech
  106222. * @param noCollisionBetweenLinkedBodies when true collisions between cloth impostor and anchor are ignored; default false
  106223. * @returns impostor the soft imposter
  106224. */
  106225. addAnchor(otherImpostor: PhysicsImpostor, width: number, height: number, influence: number, noCollisionBetweenLinkedBodies: boolean): PhysicsImpostor;
  106226. /**
  106227. * Add a hook to a rope impostor
  106228. * @param otherImpostor rigid impostor to anchor to
  106229. * @param length ratio across rope from 0 to 1
  106230. * @param influence the elasticity between rope impostor and anchor from 0, very stretchy to 1, little strech
  106231. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  106232. * @returns impostor the rope imposter
  106233. */
  106234. addHook(otherImpostor: PhysicsImpostor, length: number, influence: number, noCollisionBetweenLinkedBodies: boolean): PhysicsImpostor;
  106235. /**
  106236. * Will keep this body still, in a sleep mode.
  106237. * @returns the physics imposter
  106238. */
  106239. sleep(): PhysicsImpostor;
  106240. /**
  106241. * Wake the body up.
  106242. * @returns The physics imposter
  106243. */
  106244. wakeUp(): PhysicsImpostor;
  106245. /**
  106246. * Clones the physics imposter
  106247. * @param newObject The physics imposter clones to this physics-enabled object
  106248. * @returns A nullable physics imposter
  106249. */
  106250. clone(newObject: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  106251. /**
  106252. * Disposes the physics imposter
  106253. */
  106254. dispose(): void;
  106255. /**
  106256. * Sets the delta position
  106257. * @param position The delta position amount
  106258. */
  106259. setDeltaPosition(position: Vector3): void;
  106260. /**
  106261. * Sets the delta rotation
  106262. * @param rotation The delta rotation amount
  106263. */
  106264. setDeltaRotation(rotation: Quaternion): void;
  106265. /**
  106266. * Gets the box size of the physics imposter and stores the result in the input parameter
  106267. * @param result Stores the box size
  106268. * @returns The physics imposter
  106269. */
  106270. getBoxSizeToRef(result: Vector3): PhysicsImpostor;
  106271. /**
  106272. * Gets the radius of the physics imposter
  106273. * @returns Radius of the physics imposter
  106274. */
  106275. getRadius(): number;
  106276. /**
  106277. * Sync a bone with this impostor
  106278. * @param bone The bone to sync to the impostor.
  106279. * @param boneMesh The mesh that the bone is influencing.
  106280. * @param jointPivot The pivot of the joint / bone in local space.
  106281. * @param distToJoint Optional distance from the impostor to the joint.
  106282. * @param adjustRotation Optional quaternion for adjusting the local rotation of the bone.
  106283. */
  106284. syncBoneWithImpostor(bone: Bone, boneMesh: AbstractMesh, jointPivot: Vector3, distToJoint?: number, adjustRotation?: Quaternion): void;
  106285. /**
  106286. * Sync impostor to a bone
  106287. * @param bone The bone that the impostor will be synced to.
  106288. * @param boneMesh The mesh that the bone is influencing.
  106289. * @param jointPivot The pivot of the joint / bone in local space.
  106290. * @param distToJoint Optional distance from the impostor to the joint.
  106291. * @param adjustRotation Optional quaternion for adjusting the local rotation of the bone.
  106292. * @param boneAxis Optional vector3 axis the bone is aligned with
  106293. */
  106294. syncImpostorWithBone(bone: Bone, boneMesh: AbstractMesh, jointPivot: Vector3, distToJoint?: number, adjustRotation?: Quaternion, boneAxis?: Vector3): void;
  106295. /**
  106296. * No-Imposter type
  106297. */
  106298. static NoImpostor: number;
  106299. /**
  106300. * Sphere-Imposter type
  106301. */
  106302. static SphereImpostor: number;
  106303. /**
  106304. * Box-Imposter type
  106305. */
  106306. static BoxImpostor: number;
  106307. /**
  106308. * Plane-Imposter type
  106309. */
  106310. static PlaneImpostor: number;
  106311. /**
  106312. * Mesh-imposter type
  106313. */
  106314. static MeshImpostor: number;
  106315. /**
  106316. * Capsule-Impostor type (Ammo.js plugin only)
  106317. */
  106318. static CapsuleImpostor: number;
  106319. /**
  106320. * Cylinder-Imposter type
  106321. */
  106322. static CylinderImpostor: number;
  106323. /**
  106324. * Particle-Imposter type
  106325. */
  106326. static ParticleImpostor: number;
  106327. /**
  106328. * Heightmap-Imposter type
  106329. */
  106330. static HeightmapImpostor: number;
  106331. /**
  106332. * ConvexHull-Impostor type (Ammo.js plugin only)
  106333. */
  106334. static ConvexHullImpostor: number;
  106335. /**
  106336. * Custom-Imposter type (Ammo.js plugin only)
  106337. */
  106338. static CustomImpostor: number;
  106339. /**
  106340. * Rope-Imposter type
  106341. */
  106342. static RopeImpostor: number;
  106343. /**
  106344. * Cloth-Imposter type
  106345. */
  106346. static ClothImpostor: number;
  106347. /**
  106348. * Softbody-Imposter type
  106349. */
  106350. static SoftbodyImpostor: number;
  106351. }
  106352. }
  106353. declare module BABYLON {
  106354. /**
  106355. * @hidden
  106356. **/
  106357. export class _CreationDataStorage {
  106358. closePath?: boolean;
  106359. closeArray?: boolean;
  106360. idx: number[];
  106361. dashSize: number;
  106362. gapSize: number;
  106363. path3D: Path3D;
  106364. pathArray: Vector3[][];
  106365. arc: number;
  106366. radius: number;
  106367. cap: number;
  106368. tessellation: number;
  106369. }
  106370. /**
  106371. * @hidden
  106372. **/
  106373. class _InstanceDataStorage {
  106374. visibleInstances: any;
  106375. batchCache: _InstancesBatch;
  106376. instancesBufferSize: number;
  106377. instancesBuffer: Nullable<Buffer>;
  106378. instancesData: Float32Array;
  106379. overridenInstanceCount: number;
  106380. isFrozen: boolean;
  106381. previousBatch: Nullable<_InstancesBatch>;
  106382. hardwareInstancedRendering: boolean;
  106383. sideOrientation: number;
  106384. manualUpdate: boolean;
  106385. }
  106386. /**
  106387. * @hidden
  106388. **/
  106389. export class _InstancesBatch {
  106390. mustReturn: boolean;
  106391. visibleInstances: Nullable<InstancedMesh[]>[];
  106392. renderSelf: boolean[];
  106393. hardwareInstancedRendering: boolean[];
  106394. }
  106395. /**
  106396. * @hidden
  106397. **/
  106398. class _ThinInstanceDataStorage {
  106399. instancesCount: number;
  106400. matrixBuffer: Nullable<Buffer>;
  106401. matrixBufferSize: number;
  106402. matrixData: Nullable<Float32Array>;
  106403. boundingVectors: Array<Vector3>;
  106404. }
  106405. /**
  106406. * Class used to represent renderable models
  106407. */
  106408. export class Mesh extends AbstractMesh implements IGetSetVerticesData {
  106409. /**
  106410. * Mesh side orientation : usually the external or front surface
  106411. */
  106412. static readonly FRONTSIDE: number;
  106413. /**
  106414. * Mesh side orientation : usually the internal or back surface
  106415. */
  106416. static readonly BACKSIDE: number;
  106417. /**
  106418. * Mesh side orientation : both internal and external or front and back surfaces
  106419. */
  106420. static readonly DOUBLESIDE: number;
  106421. /**
  106422. * Mesh side orientation : by default, `FRONTSIDE`
  106423. */
  106424. static readonly DEFAULTSIDE: number;
  106425. /**
  106426. * Mesh cap setting : no cap
  106427. */
  106428. static readonly NO_CAP: number;
  106429. /**
  106430. * Mesh cap setting : one cap at the beginning of the mesh
  106431. */
  106432. static readonly CAP_START: number;
  106433. /**
  106434. * Mesh cap setting : one cap at the end of the mesh
  106435. */
  106436. static readonly CAP_END: number;
  106437. /**
  106438. * Mesh cap setting : two caps, one at the beginning and one at the end of the mesh
  106439. */
  106440. static readonly CAP_ALL: number;
  106441. /**
  106442. * Mesh pattern setting : no flip or rotate
  106443. */
  106444. static readonly NO_FLIP: number;
  106445. /**
  106446. * Mesh pattern setting : flip (reflect in y axis) alternate tiles on each row or column
  106447. */
  106448. static readonly FLIP_TILE: number;
  106449. /**
  106450. * Mesh pattern setting : rotate (180degs) alternate tiles on each row or column
  106451. */
  106452. static readonly ROTATE_TILE: number;
  106453. /**
  106454. * Mesh pattern setting : flip (reflect in y axis) all tiles on alternate rows
  106455. */
  106456. static readonly FLIP_ROW: number;
  106457. /**
  106458. * Mesh pattern setting : rotate (180degs) all tiles on alternate rows
  106459. */
  106460. static readonly ROTATE_ROW: number;
  106461. /**
  106462. * Mesh pattern setting : flip and rotate alternate tiles on each row or column
  106463. */
  106464. static readonly FLIP_N_ROTATE_TILE: number;
  106465. /**
  106466. * Mesh pattern setting : rotate pattern and rotate
  106467. */
  106468. static readonly FLIP_N_ROTATE_ROW: number;
  106469. /**
  106470. * Mesh tile positioning : part tiles same on left/right or top/bottom
  106471. */
  106472. static readonly CENTER: number;
  106473. /**
  106474. * Mesh tile positioning : part tiles on left
  106475. */
  106476. static readonly LEFT: number;
  106477. /**
  106478. * Mesh tile positioning : part tiles on right
  106479. */
  106480. static readonly RIGHT: number;
  106481. /**
  106482. * Mesh tile positioning : part tiles on top
  106483. */
  106484. static readonly TOP: number;
  106485. /**
  106486. * Mesh tile positioning : part tiles on bottom
  106487. */
  106488. static readonly BOTTOM: number;
  106489. /**
  106490. * Gets the default side orientation.
  106491. * @param orientation the orientation to value to attempt to get
  106492. * @returns the default orientation
  106493. * @hidden
  106494. */
  106495. static _GetDefaultSideOrientation(orientation?: number): number;
  106496. private _internalMeshDataInfo;
  106497. get computeBonesUsingShaders(): boolean;
  106498. set computeBonesUsingShaders(value: boolean);
  106499. /**
  106500. * An event triggered before rendering the mesh
  106501. */
  106502. get onBeforeRenderObservable(): Observable<Mesh>;
  106503. /**
  106504. * An event triggered before binding the mesh
  106505. */
  106506. get onBeforeBindObservable(): Observable<Mesh>;
  106507. /**
  106508. * An event triggered after rendering the mesh
  106509. */
  106510. get onAfterRenderObservable(): Observable<Mesh>;
  106511. /**
  106512. * An event triggered before drawing the mesh
  106513. */
  106514. get onBeforeDrawObservable(): Observable<Mesh>;
  106515. private _onBeforeDrawObserver;
  106516. /**
  106517. * Sets a callback to call before drawing the mesh. It is recommended to use onBeforeDrawObservable instead
  106518. */
  106519. set onBeforeDraw(callback: () => void);
  106520. get hasInstances(): boolean;
  106521. get hasThinInstances(): boolean;
  106522. /**
  106523. * Gets the delay loading state of the mesh (when delay loading is turned on)
  106524. * @see https://doc.babylonjs.com/how_to/using_the_incremental_loading_system
  106525. */
  106526. delayLoadState: number;
  106527. /**
  106528. * Gets the list of instances created from this mesh
  106529. * it is not supposed to be modified manually.
  106530. * Note also that the order of the InstancedMesh wihin the array is not significant and might change.
  106531. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  106532. */
  106533. instances: InstancedMesh[];
  106534. /**
  106535. * Gets the file containing delay loading data for this mesh
  106536. */
  106537. delayLoadingFile: string;
  106538. /** @hidden */
  106539. _binaryInfo: any;
  106540. /**
  106541. * User defined function used to change how LOD level selection is done
  106542. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  106543. */
  106544. onLODLevelSelection: (distance: number, mesh: Mesh, selectedLevel: Nullable<Mesh>) => void;
  106545. /**
  106546. * Gets or sets the morph target manager
  106547. * @see https://doc.babylonjs.com/how_to/how_to_use_morphtargets
  106548. */
  106549. get morphTargetManager(): Nullable<MorphTargetManager>;
  106550. set morphTargetManager(value: Nullable<MorphTargetManager>);
  106551. /** @hidden */
  106552. _creationDataStorage: Nullable<_CreationDataStorage>;
  106553. /** @hidden */
  106554. _geometry: Nullable<Geometry>;
  106555. /** @hidden */
  106556. _delayInfo: Array<string>;
  106557. /** @hidden */
  106558. _delayLoadingFunction: (any: any, mesh: Mesh) => void;
  106559. /** @hidden */
  106560. _instanceDataStorage: _InstanceDataStorage;
  106561. /** @hidden */
  106562. _thinInstanceDataStorage: _ThinInstanceDataStorage;
  106563. private _effectiveMaterial;
  106564. /** @hidden */
  106565. _shouldGenerateFlatShading: boolean;
  106566. /** @hidden */
  106567. _originalBuilderSideOrientation: number;
  106568. /**
  106569. * Use this property to change the original side orientation defined at construction time
  106570. */
  106571. overrideMaterialSideOrientation: Nullable<number>;
  106572. /**
  106573. * Gets the source mesh (the one used to clone this one from)
  106574. */
  106575. get source(): Nullable<Mesh>;
  106576. /**
  106577. * Gets or sets a boolean indicating that this mesh does not use index buffer
  106578. */
  106579. get isUnIndexed(): boolean;
  106580. set isUnIndexed(value: boolean);
  106581. /** Gets the array buffer used to store the instanced buffer used for instances' world matrices */
  106582. get worldMatrixInstancedBuffer(): Float32Array;
  106583. /** Gets or sets a boolean indicating that the update of the instance buffer of the world matrices is manual */
  106584. get manualUpdateOfWorldMatrixInstancedBuffer(): boolean;
  106585. set manualUpdateOfWorldMatrixInstancedBuffer(value: boolean);
  106586. /**
  106587. * @constructor
  106588. * @param name The value used by scene.getMeshByName() to do a lookup.
  106589. * @param scene The scene to add this mesh to.
  106590. * @param parent The parent of this mesh, if it has one
  106591. * @param source An optional Mesh from which geometry is shared, cloned.
  106592. * @param doNotCloneChildren When cloning, skip cloning child meshes of source, default False.
  106593. * When false, achieved by calling a clone(), also passing False.
  106594. * This will make creation of children, recursive.
  106595. * @param clonePhysicsImpostor When cloning, include cloning mesh physics impostor, default True.
  106596. */
  106597. constructor(name: string, scene?: Nullable<Scene>, parent?: Nullable<Node>, source?: Nullable<Mesh>, doNotCloneChildren?: boolean, clonePhysicsImpostor?: boolean);
  106598. instantiateHierarchy(newParent?: Nullable<TransformNode>, options?: {
  106599. doNotInstantiate: boolean;
  106600. }, onNewNodeCreated?: (source: TransformNode, clone: TransformNode) => void): Nullable<TransformNode>;
  106601. /**
  106602. * Gets the class name
  106603. * @returns the string "Mesh".
  106604. */
  106605. getClassName(): string;
  106606. /** @hidden */
  106607. get _isMesh(): boolean;
  106608. /**
  106609. * Returns a description of this mesh
  106610. * @param fullDetails define if full details about this mesh must be used
  106611. * @returns a descriptive string representing this mesh
  106612. */
  106613. toString(fullDetails?: boolean): string;
  106614. /** @hidden */
  106615. _unBindEffect(): void;
  106616. /**
  106617. * Gets a boolean indicating if this mesh has LOD
  106618. */
  106619. get hasLODLevels(): boolean;
  106620. /**
  106621. * Gets the list of MeshLODLevel associated with the current mesh
  106622. * @returns an array of MeshLODLevel
  106623. */
  106624. getLODLevels(): MeshLODLevel[];
  106625. private _sortLODLevels;
  106626. /**
  106627. * Add a mesh as LOD level triggered at the given distance.
  106628. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  106629. * @param distance The distance from the center of the object to show this level
  106630. * @param mesh The mesh to be added as LOD level (can be null)
  106631. * @return This mesh (for chaining)
  106632. */
  106633. addLODLevel(distance: number, mesh: Nullable<Mesh>): Mesh;
  106634. /**
  106635. * Returns the LOD level mesh at the passed distance or null if not found.
  106636. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  106637. * @param distance The distance from the center of the object to show this level
  106638. * @returns a Mesh or `null`
  106639. */
  106640. getLODLevelAtDistance(distance: number): Nullable<Mesh>;
  106641. /**
  106642. * Remove a mesh from the LOD array
  106643. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  106644. * @param mesh defines the mesh to be removed
  106645. * @return This mesh (for chaining)
  106646. */
  106647. removeLODLevel(mesh: Mesh): Mesh;
  106648. /**
  106649. * Returns the registered LOD mesh distant from the parameter `camera` position if any, else returns the current mesh.
  106650. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  106651. * @param camera defines the camera to use to compute distance
  106652. * @param boundingSphere defines a custom bounding sphere to use instead of the one from this mesh
  106653. * @return This mesh (for chaining)
  106654. */
  106655. getLOD(camera: Camera, boundingSphere?: BoundingSphere): Nullable<AbstractMesh>;
  106656. /**
  106657. * Gets the mesh internal Geometry object
  106658. */
  106659. get geometry(): Nullable<Geometry>;
  106660. /**
  106661. * Returns the total number of vertices within the mesh geometry or zero if the mesh has no geometry.
  106662. * @returns the total number of vertices
  106663. */
  106664. getTotalVertices(): number;
  106665. /**
  106666. * Returns the content of an associated vertex buffer
  106667. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  106668. * - VertexBuffer.PositionKind
  106669. * - VertexBuffer.UVKind
  106670. * - VertexBuffer.UV2Kind
  106671. * - VertexBuffer.UV3Kind
  106672. * - VertexBuffer.UV4Kind
  106673. * - VertexBuffer.UV5Kind
  106674. * - VertexBuffer.UV6Kind
  106675. * - VertexBuffer.ColorKind
  106676. * - VertexBuffer.MatricesIndicesKind
  106677. * - VertexBuffer.MatricesIndicesExtraKind
  106678. * - VertexBuffer.MatricesWeightsKind
  106679. * - VertexBuffer.MatricesWeightsExtraKind
  106680. * @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
  106681. * @param forceCopy defines a boolean forcing the copy of the buffer no matter what the value of copyWhenShared is
  106682. * @returns a FloatArray or null if the mesh has no geometry or no vertex buffer for this kind.
  106683. */
  106684. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  106685. /**
  106686. * Returns the mesh VertexBuffer object from the requested `kind`
  106687. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  106688. * - VertexBuffer.PositionKind
  106689. * - VertexBuffer.NormalKind
  106690. * - VertexBuffer.UVKind
  106691. * - VertexBuffer.UV2Kind
  106692. * - VertexBuffer.UV3Kind
  106693. * - VertexBuffer.UV4Kind
  106694. * - VertexBuffer.UV5Kind
  106695. * - VertexBuffer.UV6Kind
  106696. * - VertexBuffer.ColorKind
  106697. * - VertexBuffer.MatricesIndicesKind
  106698. * - VertexBuffer.MatricesIndicesExtraKind
  106699. * - VertexBuffer.MatricesWeightsKind
  106700. * - VertexBuffer.MatricesWeightsExtraKind
  106701. * @returns a FloatArray or null if the mesh has no vertex buffer for this kind.
  106702. */
  106703. getVertexBuffer(kind: string): Nullable<VertexBuffer>;
  106704. /**
  106705. * Tests if a specific vertex buffer is associated with this mesh
  106706. * @param kind defines which buffer to check (positions, indices, normals, etc). Possible `kind` values :
  106707. * - VertexBuffer.PositionKind
  106708. * - VertexBuffer.NormalKind
  106709. * - VertexBuffer.UVKind
  106710. * - VertexBuffer.UV2Kind
  106711. * - VertexBuffer.UV3Kind
  106712. * - VertexBuffer.UV4Kind
  106713. * - VertexBuffer.UV5Kind
  106714. * - VertexBuffer.UV6Kind
  106715. * - VertexBuffer.ColorKind
  106716. * - VertexBuffer.MatricesIndicesKind
  106717. * - VertexBuffer.MatricesIndicesExtraKind
  106718. * - VertexBuffer.MatricesWeightsKind
  106719. * - VertexBuffer.MatricesWeightsExtraKind
  106720. * @returns a boolean
  106721. */
  106722. isVerticesDataPresent(kind: string): boolean;
  106723. /**
  106724. * Returns a boolean defining if the vertex data for the requested `kind` is updatable.
  106725. * @param kind defines which buffer to check (positions, indices, normals, etc). Possible `kind` values :
  106726. * - VertexBuffer.PositionKind
  106727. * - VertexBuffer.UVKind
  106728. * - VertexBuffer.UV2Kind
  106729. * - VertexBuffer.UV3Kind
  106730. * - VertexBuffer.UV4Kind
  106731. * - VertexBuffer.UV5Kind
  106732. * - VertexBuffer.UV6Kind
  106733. * - VertexBuffer.ColorKind
  106734. * - VertexBuffer.MatricesIndicesKind
  106735. * - VertexBuffer.MatricesIndicesExtraKind
  106736. * - VertexBuffer.MatricesWeightsKind
  106737. * - VertexBuffer.MatricesWeightsExtraKind
  106738. * @returns a boolean
  106739. */
  106740. isVertexBufferUpdatable(kind: string): boolean;
  106741. /**
  106742. * Returns a string which contains the list of existing `kinds` of Vertex Data associated with this mesh.
  106743. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  106744. * - VertexBuffer.PositionKind
  106745. * - VertexBuffer.NormalKind
  106746. * - VertexBuffer.UVKind
  106747. * - VertexBuffer.UV2Kind
  106748. * - VertexBuffer.UV3Kind
  106749. * - VertexBuffer.UV4Kind
  106750. * - VertexBuffer.UV5Kind
  106751. * - VertexBuffer.UV6Kind
  106752. * - VertexBuffer.ColorKind
  106753. * - VertexBuffer.MatricesIndicesKind
  106754. * - VertexBuffer.MatricesIndicesExtraKind
  106755. * - VertexBuffer.MatricesWeightsKind
  106756. * - VertexBuffer.MatricesWeightsExtraKind
  106757. * @returns an array of strings
  106758. */
  106759. getVerticesDataKinds(): string[];
  106760. /**
  106761. * Returns a positive integer : the total number of indices in this mesh geometry.
  106762. * @returns the numner of indices or zero if the mesh has no geometry.
  106763. */
  106764. getTotalIndices(): number;
  106765. /**
  106766. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  106767. * @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.
  106768. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  106769. * @returns the indices array or an empty array if the mesh has no geometry
  106770. */
  106771. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  106772. get isBlocked(): boolean;
  106773. /**
  106774. * Determine if the current mesh is ready to be rendered
  106775. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  106776. * @param forceInstanceSupport will check if the mesh will be ready when used with instances (false by default)
  106777. * @returns true if all associated assets are ready (material, textures, shaders)
  106778. */
  106779. isReady(completeCheck?: boolean, forceInstanceSupport?: boolean): boolean;
  106780. /**
  106781. * 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.
  106782. */
  106783. get areNormalsFrozen(): boolean;
  106784. /**
  106785. * 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.
  106786. * @returns the current mesh
  106787. */
  106788. freezeNormals(): Mesh;
  106789. /**
  106790. * 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
  106791. * @returns the current mesh
  106792. */
  106793. unfreezeNormals(): Mesh;
  106794. /**
  106795. * Sets a value overriding the instance count. Only applicable when custom instanced InterleavedVertexBuffer are used rather than InstancedMeshs
  106796. */
  106797. set overridenInstanceCount(count: number);
  106798. /** @hidden */
  106799. _preActivate(): Mesh;
  106800. /** @hidden */
  106801. _preActivateForIntermediateRendering(renderId: number): Mesh;
  106802. /** @hidden */
  106803. _registerInstanceForRenderId(instance: InstancedMesh, renderId: number): Mesh;
  106804. protected _afterComputeWorldMatrix(): void;
  106805. /** @hidden */
  106806. _postActivate(): void;
  106807. /**
  106808. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  106809. * This means the mesh underlying bounding box and sphere are recomputed.
  106810. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  106811. * @returns the current mesh
  106812. */
  106813. refreshBoundingInfo(applySkeleton?: boolean): Mesh;
  106814. /** @hidden */
  106815. _createGlobalSubMesh(force: boolean): Nullable<SubMesh>;
  106816. /**
  106817. * This function will subdivide the mesh into multiple submeshes
  106818. * @param count defines the expected number of submeshes
  106819. */
  106820. subdivide(count: number): void;
  106821. /**
  106822. * Copy a FloatArray into a specific associated vertex buffer
  106823. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  106824. * - VertexBuffer.PositionKind
  106825. * - VertexBuffer.UVKind
  106826. * - VertexBuffer.UV2Kind
  106827. * - VertexBuffer.UV3Kind
  106828. * - VertexBuffer.UV4Kind
  106829. * - VertexBuffer.UV5Kind
  106830. * - VertexBuffer.UV6Kind
  106831. * - VertexBuffer.ColorKind
  106832. * - VertexBuffer.MatricesIndicesKind
  106833. * - VertexBuffer.MatricesIndicesExtraKind
  106834. * - VertexBuffer.MatricesWeightsKind
  106835. * - VertexBuffer.MatricesWeightsExtraKind
  106836. * @param data defines the data source
  106837. * @param updatable defines if the updated vertex buffer must be flagged as updatable
  106838. * @param stride defines the data stride size (can be null)
  106839. * @returns the current mesh
  106840. */
  106841. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  106842. /**
  106843. * Delete a vertex buffer associated with this mesh
  106844. * @param kind defines which buffer to delete (positions, indices, normals, etc). Possible `kind` values :
  106845. * - VertexBuffer.PositionKind
  106846. * - VertexBuffer.UVKind
  106847. * - VertexBuffer.UV2Kind
  106848. * - VertexBuffer.UV3Kind
  106849. * - VertexBuffer.UV4Kind
  106850. * - VertexBuffer.UV5Kind
  106851. * - VertexBuffer.UV6Kind
  106852. * - VertexBuffer.ColorKind
  106853. * - VertexBuffer.MatricesIndicesKind
  106854. * - VertexBuffer.MatricesIndicesExtraKind
  106855. * - VertexBuffer.MatricesWeightsKind
  106856. * - VertexBuffer.MatricesWeightsExtraKind
  106857. */
  106858. removeVerticesData(kind: string): void;
  106859. /**
  106860. * Flags an associated vertex buffer as updatable
  106861. * @param kind defines which buffer to use (positions, indices, normals, etc). Possible `kind` values :
  106862. * - VertexBuffer.PositionKind
  106863. * - VertexBuffer.UVKind
  106864. * - VertexBuffer.UV2Kind
  106865. * - VertexBuffer.UV3Kind
  106866. * - VertexBuffer.UV4Kind
  106867. * - VertexBuffer.UV5Kind
  106868. * - VertexBuffer.UV6Kind
  106869. * - VertexBuffer.ColorKind
  106870. * - VertexBuffer.MatricesIndicesKind
  106871. * - VertexBuffer.MatricesIndicesExtraKind
  106872. * - VertexBuffer.MatricesWeightsKind
  106873. * - VertexBuffer.MatricesWeightsExtraKind
  106874. * @param updatable defines if the updated vertex buffer must be flagged as updatable
  106875. */
  106876. markVerticesDataAsUpdatable(kind: string, updatable?: boolean): void;
  106877. /**
  106878. * Sets the mesh global Vertex Buffer
  106879. * @param buffer defines the buffer to use
  106880. * @returns the current mesh
  106881. */
  106882. setVerticesBuffer(buffer: VertexBuffer): Mesh;
  106883. /**
  106884. * Update a specific associated vertex buffer
  106885. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  106886. * - VertexBuffer.PositionKind
  106887. * - VertexBuffer.UVKind
  106888. * - VertexBuffer.UV2Kind
  106889. * - VertexBuffer.UV3Kind
  106890. * - VertexBuffer.UV4Kind
  106891. * - VertexBuffer.UV5Kind
  106892. * - VertexBuffer.UV6Kind
  106893. * - VertexBuffer.ColorKind
  106894. * - VertexBuffer.MatricesIndicesKind
  106895. * - VertexBuffer.MatricesIndicesExtraKind
  106896. * - VertexBuffer.MatricesWeightsKind
  106897. * - VertexBuffer.MatricesWeightsExtraKind
  106898. * @param data defines the data source
  106899. * @param updateExtends defines if extends info of the mesh must be updated (can be null). This is mostly useful for "position" kind
  106900. * @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)
  106901. * @returns the current mesh
  106902. */
  106903. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): AbstractMesh;
  106904. /**
  106905. * This method updates the vertex positions of an updatable mesh according to the `positionFunction` returned values.
  106906. * @see https://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh#other-shapes-updatemeshpositions
  106907. * @param positionFunction is a simple JS function what is passed the mesh `positions` array. It doesn't need to return anything
  106908. * @param computeNormals is a boolean (default true) to enable/disable the mesh normal recomputation after the vertex position update
  106909. * @returns the current mesh
  106910. */
  106911. updateMeshPositions(positionFunction: (data: FloatArray) => void, computeNormals?: boolean): Mesh;
  106912. /**
  106913. * Creates a un-shared specific occurence of the geometry for the mesh.
  106914. * @returns the current mesh
  106915. */
  106916. makeGeometryUnique(): Mesh;
  106917. /**
  106918. * Set the index buffer of this mesh
  106919. * @param indices defines the source data
  106920. * @param totalVertices defines the total number of vertices referenced by this index data (can be null)
  106921. * @param updatable defines if the updated index buffer must be flagged as updatable (default is false)
  106922. * @returns the current mesh
  106923. */
  106924. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>, updatable?: boolean): AbstractMesh;
  106925. /**
  106926. * Update the current index buffer
  106927. * @param indices defines the source data
  106928. * @param offset defines the offset in the index buffer where to store the new data (can be null)
  106929. * @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)
  106930. * @returns the current mesh
  106931. */
  106932. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): AbstractMesh;
  106933. /**
  106934. * Invert the geometry to move from a right handed system to a left handed one.
  106935. * @returns the current mesh
  106936. */
  106937. toLeftHanded(): Mesh;
  106938. /** @hidden */
  106939. _bind(subMesh: SubMesh, effect: Effect, fillMode: number): Mesh;
  106940. /** @hidden */
  106941. _draw(subMesh: SubMesh, fillMode: number, instancesCount?: number): Mesh;
  106942. /**
  106943. * Registers for this mesh a javascript function called just before the rendering process
  106944. * @param func defines the function to call before rendering this mesh
  106945. * @returns the current mesh
  106946. */
  106947. registerBeforeRender(func: (mesh: AbstractMesh) => void): Mesh;
  106948. /**
  106949. * Disposes a previously registered javascript function called before the rendering
  106950. * @param func defines the function to remove
  106951. * @returns the current mesh
  106952. */
  106953. unregisterBeforeRender(func: (mesh: AbstractMesh) => void): Mesh;
  106954. /**
  106955. * Registers for this mesh a javascript function called just after the rendering is complete
  106956. * @param func defines the function to call after rendering this mesh
  106957. * @returns the current mesh
  106958. */
  106959. registerAfterRender(func: (mesh: AbstractMesh) => void): Mesh;
  106960. /**
  106961. * Disposes a previously registered javascript function called after the rendering.
  106962. * @param func defines the function to remove
  106963. * @returns the current mesh
  106964. */
  106965. unregisterAfterRender(func: (mesh: AbstractMesh) => void): Mesh;
  106966. /** @hidden */
  106967. _getInstancesRenderList(subMeshId: number, isReplacementMode?: boolean): _InstancesBatch;
  106968. /** @hidden */
  106969. _renderWithInstances(subMesh: SubMesh, fillMode: number, batch: _InstancesBatch, effect: Effect, engine: Engine): Mesh;
  106970. /** @hidden */
  106971. _renderWithThinInstances(subMesh: SubMesh, fillMode: number, effect: Effect, engine: Engine): void;
  106972. /** @hidden */
  106973. _processInstancedBuffers(visibleInstances: InstancedMesh[], renderSelf: boolean): void;
  106974. /** @hidden */
  106975. _processRendering(renderingMesh: AbstractMesh, subMesh: SubMesh, effect: Effect, fillMode: number, batch: _InstancesBatch, hardwareInstancedRendering: boolean, onBeforeDraw: (isInstance: boolean, world: Matrix, effectiveMaterial?: Material) => void, effectiveMaterial?: Material): Mesh;
  106976. /** @hidden */
  106977. _rebuild(): void;
  106978. /** @hidden */
  106979. _freeze(): void;
  106980. /** @hidden */
  106981. _unFreeze(): void;
  106982. /**
  106983. * 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
  106984. * @param subMesh defines the subMesh to render
  106985. * @param enableAlphaMode defines if alpha mode can be changed
  106986. * @param effectiveMeshReplacement defines an optional mesh used to provide info for the rendering
  106987. * @returns the current mesh
  106988. */
  106989. render(subMesh: SubMesh, enableAlphaMode: boolean, effectiveMeshReplacement?: AbstractMesh): Mesh;
  106990. private _onBeforeDraw;
  106991. /**
  106992. * Renormalize the mesh and patch it up if there are no weights
  106993. * Similar to normalization by adding the weights compute the reciprocal and multiply all elements, this wil ensure that everything adds to 1.
  106994. * However in the case of zero weights then we set just a single influence to 1.
  106995. * We check in the function for extra's present and if so we use the normalizeSkinWeightsWithExtras rather than the FourWeights version.
  106996. */
  106997. cleanMatrixWeights(): void;
  106998. private normalizeSkinFourWeights;
  106999. private normalizeSkinWeightsAndExtra;
  107000. /**
  107001. * ValidateSkinning is used to determine that a mesh has valid skinning data along with skin metrics, if missing weights,
  107002. * or not normalized it is returned as invalid mesh the string can be used for console logs, or on screen messages to let
  107003. * the user know there was an issue with importing the mesh
  107004. * @returns a validation object with skinned, valid and report string
  107005. */
  107006. validateSkinning(): {
  107007. skinned: boolean;
  107008. valid: boolean;
  107009. report: string;
  107010. };
  107011. /** @hidden */
  107012. _checkDelayState(): Mesh;
  107013. private _queueLoad;
  107014. /**
  107015. * Returns `true` if the mesh is within the frustum defined by the passed array of planes.
  107016. * A mesh is in the frustum if its bounding box intersects the frustum
  107017. * @param frustumPlanes defines the frustum to test
  107018. * @returns true if the mesh is in the frustum planes
  107019. */
  107020. isInFrustum(frustumPlanes: Plane[]): boolean;
  107021. /**
  107022. * Sets the mesh material by the material or multiMaterial `id` property
  107023. * @param id is a string identifying the material or the multiMaterial
  107024. * @returns the current mesh
  107025. */
  107026. setMaterialByID(id: string): Mesh;
  107027. /**
  107028. * Returns as a new array populated with the mesh material and/or skeleton, if any.
  107029. * @returns an array of IAnimatable
  107030. */
  107031. getAnimatables(): IAnimatable[];
  107032. /**
  107033. * Modifies the mesh geometry according to the passed transformation matrix.
  107034. * This method returns nothing but it really modifies the mesh even if it's originally not set as updatable.
  107035. * The mesh normals are modified using the same transformation.
  107036. * Note that, under the hood, this method sets a new VertexBuffer each call.
  107037. * @param transform defines the transform matrix to use
  107038. * @see https://doc.babylonjs.com/resources/baking_transformations
  107039. * @returns the current mesh
  107040. */
  107041. bakeTransformIntoVertices(transform: Matrix): Mesh;
  107042. /**
  107043. * Modifies the mesh geometry according to its own current World Matrix.
  107044. * The mesh World Matrix is then reset.
  107045. * This method returns nothing but really modifies the mesh even if it's originally not set as updatable.
  107046. * Note that, under the hood, this method sets a new VertexBuffer each call.
  107047. * @see https://doc.babylonjs.com/resources/baking_transformations
  107048. * @param bakeIndependenlyOfChildren indicates whether to preserve all child nodes' World Matrix during baking
  107049. * @returns the current mesh
  107050. */
  107051. bakeCurrentTransformIntoVertices(bakeIndependenlyOfChildren?: boolean): Mesh;
  107052. /** @hidden */
  107053. get _positions(): Nullable<Vector3[]>;
  107054. /** @hidden */
  107055. _resetPointsArrayCache(): Mesh;
  107056. /** @hidden */
  107057. _generatePointsArray(): boolean;
  107058. /**
  107059. * Returns a new Mesh object generated from the current mesh properties.
  107060. * This method must not get confused with createInstance()
  107061. * @param name is a string, the name given to the new mesh
  107062. * @param newParent can be any Node object (default `null`)
  107063. * @param doNotCloneChildren allows/denies the recursive cloning of the original mesh children if any (default `false`)
  107064. * @param clonePhysicsImpostor allows/denies the cloning in the same time of the original mesh `body` used by the physics engine, if any (default `true`)
  107065. * @returns a new mesh
  107066. */
  107067. clone(name?: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean, clonePhysicsImpostor?: boolean): Mesh;
  107068. /**
  107069. * Releases resources associated with this mesh.
  107070. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  107071. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  107072. */
  107073. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  107074. /** @hidden */
  107075. _disposeInstanceSpecificData(): void;
  107076. /** @hidden */
  107077. _disposeThinInstanceSpecificData(): void;
  107078. /**
  107079. * Modifies the mesh geometry according to a displacement map.
  107080. * 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.
  107081. * The mesh must be set as updatable. Its internal geometry is directly modified, no new buffer are allocated.
  107082. * @param url is a string, the URL from the image file is to be downloaded.
  107083. * @param minHeight is the lower limit of the displacement.
  107084. * @param maxHeight is the upper limit of the displacement.
  107085. * @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.
  107086. * @param uvOffset is an optional vector2 used to offset UV.
  107087. * @param uvScale is an optional vector2 used to scale UV.
  107088. * @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.
  107089. * @returns the Mesh.
  107090. */
  107091. applyDisplacementMap(url: string, minHeight: number, maxHeight: number, onSuccess?: (mesh: Mesh) => void, uvOffset?: Vector2, uvScale?: Vector2, forceUpdate?: boolean): Mesh;
  107092. /**
  107093. * Modifies the mesh geometry according to a displacementMap buffer.
  107094. * 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.
  107095. * The mesh must be set as updatable. Its internal geometry is directly modified, no new buffer are allocated.
  107096. * @param buffer is a `Uint8Array` buffer containing series of `Uint8` lower than 255, the red, green, blue and alpha values of each successive pixel.
  107097. * @param heightMapWidth is the width of the buffer image.
  107098. * @param heightMapHeight is the height of the buffer image.
  107099. * @param minHeight is the lower limit of the displacement.
  107100. * @param maxHeight is the upper limit of the displacement.
  107101. * @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.
  107102. * @param uvOffset is an optional vector2 used to offset UV.
  107103. * @param uvScale is an optional vector2 used to scale UV.
  107104. * @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.
  107105. * @returns the Mesh.
  107106. */
  107107. applyDisplacementMapFromBuffer(buffer: Uint8Array, heightMapWidth: number, heightMapHeight: number, minHeight: number, maxHeight: number, uvOffset?: Vector2, uvScale?: Vector2, forceUpdate?: boolean): Mesh;
  107108. /**
  107109. * Modify the mesh to get a flat shading rendering.
  107110. * This means each mesh facet will then have its own normals. Usually new vertices are added in the mesh geometry to get this result.
  107111. * Warning : the mesh is really modified even if not set originally as updatable and, under the hood, a new VertexBuffer is allocated.
  107112. * @returns current mesh
  107113. */
  107114. convertToFlatShadedMesh(): Mesh;
  107115. /**
  107116. * This method removes all the mesh indices and add new vertices (duplication) in order to unfold facets into buffers.
  107117. * In other words, more vertices, no more indices and a single bigger VBO.
  107118. * The mesh is really modified even if not set originally as updatable. Under the hood, a new VertexBuffer is allocated.
  107119. * @returns current mesh
  107120. */
  107121. convertToUnIndexedMesh(): Mesh;
  107122. /**
  107123. * Inverses facet orientations.
  107124. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  107125. * @param flipNormals will also inverts the normals
  107126. * @returns current mesh
  107127. */
  107128. flipFaces(flipNormals?: boolean): Mesh;
  107129. /**
  107130. * Increase the number of facets and hence vertices in a mesh
  107131. * Vertex normals are interpolated from existing vertex normals
  107132. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  107133. * @param numberPerEdge the number of new vertices to add to each edge of a facet, optional default 1
  107134. */
  107135. increaseVertices(numberPerEdge: number): void;
  107136. /**
  107137. * Force adjacent facets to share vertices and remove any facets that have all vertices in a line
  107138. * This will undo any application of covertToFlatShadedMesh
  107139. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  107140. */
  107141. forceSharedVertices(): void;
  107142. /** @hidden */
  107143. static _instancedMeshFactory(name: string, mesh: Mesh): InstancedMesh;
  107144. /** @hidden */
  107145. static _PhysicsImpostorParser(scene: Scene, physicObject: IPhysicsEnabledObject, jsonObject: any): PhysicsImpostor;
  107146. /**
  107147. * Creates a new InstancedMesh object from the mesh model.
  107148. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  107149. * @param name defines the name of the new instance
  107150. * @returns a new InstancedMesh
  107151. */
  107152. createInstance(name: string): InstancedMesh;
  107153. /**
  107154. * Synchronises all the mesh instance submeshes to the current mesh submeshes, if any.
  107155. * After this call, all the mesh instances have the same submeshes than the current mesh.
  107156. * @returns the current mesh
  107157. */
  107158. synchronizeInstances(): Mesh;
  107159. /**
  107160. * Optimization of the mesh's indices, in case a mesh has duplicated vertices.
  107161. * The function will only reorder the indices and will not remove unused vertices to avoid problems with submeshes.
  107162. * This should be used together with the simplification to avoid disappearing triangles.
  107163. * @param successCallback an optional success callback to be called after the optimization finished.
  107164. * @returns the current mesh
  107165. */
  107166. optimizeIndices(successCallback?: (mesh?: Mesh) => void): Mesh;
  107167. /**
  107168. * Serialize current mesh
  107169. * @param serializationObject defines the object which will receive the serialization data
  107170. */
  107171. serialize(serializationObject: any): void;
  107172. /** @hidden */
  107173. _syncGeometryWithMorphTargetManager(): void;
  107174. /** @hidden */
  107175. static _GroundMeshParser: (parsedMesh: any, scene: Scene) => Mesh;
  107176. /**
  107177. * Returns a new Mesh object parsed from the source provided.
  107178. * @param parsedMesh is the source
  107179. * @param scene defines the hosting scene
  107180. * @param rootUrl is the root URL to prefix the `delayLoadingFile` property with
  107181. * @returns a new Mesh
  107182. */
  107183. static Parse(parsedMesh: any, scene: Scene, rootUrl: string): Mesh;
  107184. /**
  107185. * Creates a ribbon mesh. Please consider using the same method from the MeshBuilder class instead
  107186. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  107187. * @param name defines the name of the mesh to create
  107188. * @param pathArray is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry.
  107189. * @param closeArray creates a seam between the first and the last paths of the path array (default is false)
  107190. * @param closePath creates a seam between the first and the last points of each path of the path array
  107191. * @param offset is taken in account only if the `pathArray` is containing a single path
  107192. * @param scene defines the hosting scene
  107193. * @param updatable defines if the mesh must be flagged as updatable
  107194. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  107195. * @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)
  107196. * @returns a new Mesh
  107197. */
  107198. static CreateRibbon(name: string, pathArray: Vector3[][], closeArray: boolean, closePath: boolean, offset: number, scene?: Scene, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  107199. /**
  107200. * Creates a plane polygonal mesh. By default, this is a disc. Please consider using the same method from the MeshBuilder class instead
  107201. * @param name defines the name of the mesh to create
  107202. * @param radius sets the radius size (float) of the polygon (default 0.5)
  107203. * @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
  107204. * @param scene defines the hosting scene
  107205. * @param updatable defines if the mesh must be flagged as updatable
  107206. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  107207. * @returns a new Mesh
  107208. */
  107209. static CreateDisc(name: string, radius: number, tessellation: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number): Mesh;
  107210. /**
  107211. * Creates a box mesh. Please consider using the same method from the MeshBuilder class instead
  107212. * @param name defines the name of the mesh to create
  107213. * @param size sets the size (float) of each box side (default 1)
  107214. * @param scene defines the hosting scene
  107215. * @param updatable defines if the mesh must be flagged as updatable
  107216. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  107217. * @returns a new Mesh
  107218. */
  107219. static CreateBox(name: string, size: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number): Mesh;
  107220. /**
  107221. * Creates a sphere mesh. Please consider using the same method from the MeshBuilder class instead
  107222. * @param name defines the name of the mesh to create
  107223. * @param segments sets the sphere number of horizontal stripes (positive integer, default 32)
  107224. * @param diameter sets the diameter size (float) of the sphere (default 1)
  107225. * @param scene defines the hosting scene
  107226. * @param updatable defines if the mesh must be flagged as updatable
  107227. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  107228. * @returns a new Mesh
  107229. */
  107230. static CreateSphere(name: string, segments: number, diameter: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  107231. /**
  107232. * Creates a hemisphere mesh. Please consider using the same method from the MeshBuilder class instead
  107233. * @param name defines the name of the mesh to create
  107234. * @param segments sets the sphere number of horizontal stripes (positive integer, default 32)
  107235. * @param diameter sets the diameter size (float) of the sphere (default 1)
  107236. * @param scene defines the hosting scene
  107237. * @returns a new Mesh
  107238. */
  107239. static CreateHemisphere(name: string, segments: number, diameter: number, scene?: Scene): Mesh;
  107240. /**
  107241. * Creates a cylinder or a cone mesh. Please consider using the same method from the MeshBuilder class instead
  107242. * @param name defines the name of the mesh to create
  107243. * @param height sets the height size (float) of the cylinder/cone (float, default 2)
  107244. * @param diameterTop set the top cap diameter (floats, default 1)
  107245. * @param diameterBottom set the bottom cap diameter (floats, default 1). This value can't be zero
  107246. * @param tessellation sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance
  107247. * @param subdivisions sets the number of rings along the cylinder height (positive integer, default 1)
  107248. * @param scene defines the hosting scene
  107249. * @param updatable defines if the mesh must be flagged as updatable
  107250. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  107251. * @returns a new Mesh
  107252. */
  107253. static CreateCylinder(name: string, height: number, diameterTop: number, diameterBottom: number, tessellation: number, subdivisions: any, scene?: Scene, updatable?: any, sideOrientation?: number): Mesh;
  107254. /**
  107255. * Creates a torus mesh. Please consider using the same method from the MeshBuilder class instead
  107256. * @param name defines the name of the mesh to create
  107257. * @param diameter sets the diameter size (float) of the torus (default 1)
  107258. * @param thickness sets the diameter size of the tube of the torus (float, default 0.5)
  107259. * @param tessellation sets the number of torus sides (postive integer, default 16)
  107260. * @param scene defines the hosting scene
  107261. * @param updatable defines if the mesh must be flagged as updatable
  107262. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  107263. * @returns a new Mesh
  107264. */
  107265. static CreateTorus(name: string, diameter: number, thickness: number, tessellation: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  107266. /**
  107267. * Creates a torus knot mesh. Please consider using the same method from the MeshBuilder class instead
  107268. * @param name defines the name of the mesh to create
  107269. * @param radius sets the global radius size (float) of the torus knot (default 2)
  107270. * @param tube sets the diameter size of the tube of the torus (float, default 0.5)
  107271. * @param radialSegments sets the number of sides on each tube segments (positive integer, default 32)
  107272. * @param tubularSegments sets the number of tubes to decompose the knot into (positive integer, default 32)
  107273. * @param p the number of windings on X axis (positive integers, default 2)
  107274. * @param q the number of windings on Y axis (positive integers, default 3)
  107275. * @param scene defines the hosting scene
  107276. * @param updatable defines if the mesh must be flagged as updatable
  107277. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  107278. * @returns a new Mesh
  107279. */
  107280. static CreateTorusKnot(name: string, radius: number, tube: number, radialSegments: number, tubularSegments: number, p: number, q: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  107281. /**
  107282. * Creates a line mesh. Please consider using the same method from the MeshBuilder class instead.
  107283. * @param name defines the name of the mesh to create
  107284. * @param points is an array successive Vector3
  107285. * @param scene defines the hosting scene
  107286. * @param updatable defines if the mesh must be flagged as updatable
  107287. * @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).
  107288. * @returns a new Mesh
  107289. */
  107290. static CreateLines(name: string, points: Vector3[], scene?: Nullable<Scene>, updatable?: boolean, instance?: Nullable<LinesMesh>): LinesMesh;
  107291. /**
  107292. * Creates a dashed line mesh. Please consider using the same method from the MeshBuilder class instead
  107293. * @param name defines the name of the mesh to create
  107294. * @param points is an array successive Vector3
  107295. * @param dashSize is the size of the dashes relatively the dash number (positive float, default 3)
  107296. * @param gapSize is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  107297. * @param dashNb is the intended total number of dashes (positive integer, default 200)
  107298. * @param scene defines the hosting scene
  107299. * @param updatable defines if the mesh must be flagged as updatable
  107300. * @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)
  107301. * @returns a new Mesh
  107302. */
  107303. static CreateDashedLines(name: string, points: Vector3[], dashSize: number, gapSize: number, dashNb: number, scene?: Nullable<Scene>, updatable?: boolean, instance?: LinesMesh): LinesMesh;
  107304. /**
  107305. * Creates a polygon mesh.Please consider using the same method from the MeshBuilder class instead
  107306. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh.
  107307. * 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.
  107308. * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  107309. * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  107310. * Remember you can only change the shape positions, not their number when updating a polygon.
  107311. * @see https://doc.babylonjs.com/how_to/parametric_shapes#non-regular-polygon
  107312. * @param name defines the name of the mesh to create
  107313. * @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
  107314. * @param scene defines the hosting scene
  107315. * @param holes is a required array of arrays of successive Vector3 used to defines holes in the polygon
  107316. * @param updatable defines if the mesh must be flagged as updatable
  107317. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  107318. * @param earcutInjection can be used to inject your own earcut reference
  107319. * @returns a new Mesh
  107320. */
  107321. static CreatePolygon(name: string, shape: Vector3[], scene: Scene, holes?: Vector3[][], updatable?: boolean, sideOrientation?: number, earcutInjection?: any): Mesh;
  107322. /**
  107323. * Creates an extruded polygon mesh, with depth in the Y direction. Please consider using the same method from the MeshBuilder class instead.
  107324. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-non-regular-polygon
  107325. * @param name defines the name of the mesh to create
  107326. * @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
  107327. * @param depth defines the height of extrusion
  107328. * @param scene defines the hosting scene
  107329. * @param holes is a required array of arrays of successive Vector3 used to defines holes in the polygon
  107330. * @param updatable defines if the mesh must be flagged as updatable
  107331. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  107332. * @param earcutInjection can be used to inject your own earcut reference
  107333. * @returns a new Mesh
  107334. */
  107335. static ExtrudePolygon(name: string, shape: Vector3[], depth: number, scene: Scene, holes?: Vector3[][], updatable?: boolean, sideOrientation?: number, earcutInjection?: any): Mesh;
  107336. /**
  107337. * Creates an extruded shape mesh.
  107338. * 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
  107339. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  107340. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  107341. * @param name defines the name of the mesh to create
  107342. * @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
  107343. * @param path is a required array of successive Vector3. This is the axis curve the shape is extruded along
  107344. * @param scale is the value to scale the shape
  107345. * @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
  107346. * @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
  107347. * @param scene defines the hosting scene
  107348. * @param updatable defines if the mesh must be flagged as updatable
  107349. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  107350. * @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)
  107351. * @returns a new Mesh
  107352. */
  107353. static ExtrudeShape(name: string, shape: Vector3[], path: Vector3[], scale: number, rotation: number, cap: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  107354. /**
  107355. * Creates an custom extruded shape mesh.
  107356. * The custom extrusion is a parametric shape.
  107357. * It has no predefined shape. Its final shape will depend on the input parameters.
  107358. * Please consider using the same method from the MeshBuilder class instead
  107359. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  107360. * @param name defines the name of the mesh to create
  107361. * @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
  107362. * @param path is a required array of successive Vector3. This is the axis curve the shape is extruded along
  107363. * @param scaleFunction is a custom Javascript function called on each path point
  107364. * @param rotationFunction is a custom Javascript function called on each path point
  107365. * @param ribbonCloseArray forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  107366. * @param ribbonClosePath forces the extrusion underlying ribbon to close its `pathArray`
  107367. * @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
  107368. * @param scene defines the hosting scene
  107369. * @param updatable defines if the mesh must be flagged as updatable
  107370. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  107371. * @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)
  107372. * @returns a new Mesh
  107373. */
  107374. 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;
  107375. /**
  107376. * Creates lathe mesh.
  107377. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe.
  107378. * Please consider using the same method from the MeshBuilder class instead
  107379. * @param name defines the name of the mesh to create
  107380. * @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
  107381. * @param radius is the radius value of the lathe
  107382. * @param tessellation is the side number of the lathe.
  107383. * @param scene defines the hosting scene
  107384. * @param updatable defines if the mesh must be flagged as updatable
  107385. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  107386. * @returns a new Mesh
  107387. */
  107388. static CreateLathe(name: string, shape: Vector3[], radius: number, tessellation: number, scene: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  107389. /**
  107390. * Creates a plane mesh. Please consider using the same method from the MeshBuilder class instead
  107391. * @param name defines the name of the mesh to create
  107392. * @param size sets the size (float) of both sides of the plane at once (default 1)
  107393. * @param scene defines the hosting scene
  107394. * @param updatable defines if the mesh must be flagged as updatable
  107395. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  107396. * @returns a new Mesh
  107397. */
  107398. static CreatePlane(name: string, size: number, scene: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  107399. /**
  107400. * Creates a ground mesh.
  107401. * Please consider using the same method from the MeshBuilder class instead
  107402. * @param name defines the name of the mesh to create
  107403. * @param width set the width of the ground
  107404. * @param height set the height of the ground
  107405. * @param subdivisions sets the number of subdivisions per side
  107406. * @param scene defines the hosting scene
  107407. * @param updatable defines if the mesh must be flagged as updatable
  107408. * @returns a new Mesh
  107409. */
  107410. static CreateGround(name: string, width: number, height: number, subdivisions: number, scene?: Scene, updatable?: boolean): Mesh;
  107411. /**
  107412. * Creates a tiled ground mesh.
  107413. * Please consider using the same method from the MeshBuilder class instead
  107414. * @param name defines the name of the mesh to create
  107415. * @param xmin set the ground minimum X coordinate
  107416. * @param zmin set the ground minimum Y coordinate
  107417. * @param xmax set the ground maximum X coordinate
  107418. * @param zmax set the ground maximum Z coordinate
  107419. * @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
  107420. * @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
  107421. * @param scene defines the hosting scene
  107422. * @param updatable defines if the mesh must be flagged as updatable
  107423. * @returns a new Mesh
  107424. */
  107425. static CreateTiledGround(name: string, xmin: number, zmin: number, xmax: number, zmax: number, subdivisions: {
  107426. w: number;
  107427. h: number;
  107428. }, precision: {
  107429. w: number;
  107430. h: number;
  107431. }, scene: Scene, updatable?: boolean): Mesh;
  107432. /**
  107433. * Creates a ground mesh from a height map.
  107434. * Please consider using the same method from the MeshBuilder class instead
  107435. * @see https://doc.babylonjs.com/babylon101/height_map
  107436. * @param name defines the name of the mesh to create
  107437. * @param url sets the URL of the height map image resource
  107438. * @param width set the ground width size
  107439. * @param height set the ground height size
  107440. * @param subdivisions sets the number of subdivision per side
  107441. * @param minHeight is the minimum altitude on the ground
  107442. * @param maxHeight is the maximum altitude on the ground
  107443. * @param scene defines the hosting scene
  107444. * @param updatable defines if the mesh must be flagged as updatable
  107445. * @param onReady is a callback function that will be called once the mesh is built (the height map download can last some time)
  107446. * @param alphaFilter will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  107447. * @returns a new Mesh
  107448. */
  107449. 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;
  107450. /**
  107451. * Creates a tube mesh.
  107452. * The tube is a parametric shape.
  107453. * It has no predefined shape. Its final shape will depend on the input parameters.
  107454. * Please consider using the same method from the MeshBuilder class instead
  107455. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  107456. * @param name defines the name of the mesh to create
  107457. * @param path is a required array of successive Vector3. It is the curve used as the axis of the tube
  107458. * @param radius sets the tube radius size
  107459. * @param tessellation is the number of sides on the tubular surface
  107460. * @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
  107461. * @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
  107462. * @param scene defines the hosting scene
  107463. * @param updatable defines if the mesh must be flagged as updatable
  107464. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  107465. * @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)
  107466. * @returns a new Mesh
  107467. */
  107468. static CreateTube(name: string, path: Vector3[], radius: number, tessellation: number, radiusFunction: {
  107469. (i: number, distance: number): number;
  107470. }, cap: number, scene: Scene, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  107471. /**
  107472. * Creates a polyhedron mesh.
  107473. * Please consider using the same method from the MeshBuilder class instead.
  107474. * * 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
  107475. * * The parameter `size` (positive float, default 1) sets the polygon size
  107476. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  107477. * * 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`
  107478. * * 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
  107479. * * 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)`)
  107480. * * 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
  107481. * * 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
  107482. * * You can also set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  107483. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  107484. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  107485. * @param name defines the name of the mesh to create
  107486. * @param options defines the options used to create the mesh
  107487. * @param scene defines the hosting scene
  107488. * @returns a new Mesh
  107489. */
  107490. static CreatePolyhedron(name: string, options: {
  107491. type?: number;
  107492. size?: number;
  107493. sizeX?: number;
  107494. sizeY?: number;
  107495. sizeZ?: number;
  107496. custom?: any;
  107497. faceUV?: Vector4[];
  107498. faceColors?: Color4[];
  107499. updatable?: boolean;
  107500. sideOrientation?: number;
  107501. }, scene: Scene): Mesh;
  107502. /**
  107503. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  107504. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  107505. * * 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`)
  107506. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  107507. * * 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
  107508. * * You can also set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  107509. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  107510. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  107511. * @param name defines the name of the mesh
  107512. * @param options defines the options used to create the mesh
  107513. * @param scene defines the hosting scene
  107514. * @returns a new Mesh
  107515. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  107516. */
  107517. static CreateIcoSphere(name: string, options: {
  107518. radius?: number;
  107519. flat?: boolean;
  107520. subdivisions?: number;
  107521. sideOrientation?: number;
  107522. updatable?: boolean;
  107523. }, scene: Scene): Mesh;
  107524. /**
  107525. * Creates a decal mesh.
  107526. * Please consider using the same method from the MeshBuilder class instead.
  107527. * A decal is a mesh usually applied as a model onto the surface of another mesh
  107528. * @param name defines the name of the mesh
  107529. * @param sourceMesh defines the mesh receiving the decal
  107530. * @param position sets the position of the decal in world coordinates
  107531. * @param normal sets the normal of the mesh where the decal is applied onto in world coordinates
  107532. * @param size sets the decal scaling
  107533. * @param angle sets the angle to rotate the decal
  107534. * @returns a new Mesh
  107535. */
  107536. static CreateDecal(name: string, sourceMesh: AbstractMesh, position: Vector3, normal: Vector3, size: Vector3, angle: number): Mesh;
  107537. /**
  107538. * Prepare internal position array for software CPU skinning
  107539. * @returns original positions used for CPU skinning. Useful for integrating Morphing with skeletons in same mesh
  107540. */
  107541. setPositionsForCPUSkinning(): Float32Array;
  107542. /**
  107543. * Prepare internal normal array for software CPU skinning
  107544. * @returns original normals used for CPU skinning. Useful for integrating Morphing with skeletons in same mesh.
  107545. */
  107546. setNormalsForCPUSkinning(): Float32Array;
  107547. /**
  107548. * Updates the vertex buffer by applying transformation from the bones
  107549. * @param skeleton defines the skeleton to apply to current mesh
  107550. * @returns the current mesh
  107551. */
  107552. applySkeleton(skeleton: Skeleton): Mesh;
  107553. /**
  107554. * 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
  107555. * @param meshes defines the list of meshes to scan
  107556. * @returns an object `{min:` Vector3`, max:` Vector3`}`
  107557. */
  107558. static MinMax(meshes: AbstractMesh[]): {
  107559. min: Vector3;
  107560. max: Vector3;
  107561. };
  107562. /**
  107563. * Returns the center of the `{min:` Vector3`, max:` Vector3`}` or the center of MinMax vector3 computed from a mesh array
  107564. * @param meshesOrMinMaxVector could be an array of meshes or a `{min:` Vector3`, max:` Vector3`}` object
  107565. * @returns a vector3
  107566. */
  107567. static Center(meshesOrMinMaxVector: {
  107568. min: Vector3;
  107569. max: Vector3;
  107570. } | AbstractMesh[]): Vector3;
  107571. /**
  107572. * Merge the array of meshes into a single mesh for performance reasons.
  107573. * @param meshes defines he vertices source. They should all be of the same material. Entries can empty
  107574. * @param disposeSource when true (default), dispose of the vertices from the source meshes
  107575. * @param allow32BitsIndices when the sum of the vertices > 64k, this must be set to true
  107576. * @param meshSubclass when set, vertices inserted into this Mesh. Meshes can then be merged into a Mesh sub-class.
  107577. * @param subdivideWithSubMeshes when true (false default), subdivide mesh to his subMesh array with meshes source.
  107578. * @param multiMultiMaterials when true (false default), subdivide mesh and accept multiple multi materials, ignores subdivideWithSubMeshes.
  107579. * @returns a new mesh
  107580. */
  107581. static MergeMeshes(meshes: Array<Mesh>, disposeSource?: boolean, allow32BitsIndices?: boolean, meshSubclass?: Mesh, subdivideWithSubMeshes?: boolean, multiMultiMaterials?: boolean): Nullable<Mesh>;
  107582. /** @hidden */
  107583. addInstance(instance: InstancedMesh): void;
  107584. /** @hidden */
  107585. removeInstance(instance: InstancedMesh): void;
  107586. }
  107587. }
  107588. declare module BABYLON {
  107589. /**
  107590. * This is the base class of all the camera used in the application.
  107591. * @see https://doc.babylonjs.com/features/cameras
  107592. */
  107593. export class Camera extends Node {
  107594. /** @hidden */
  107595. static _createDefaultParsedCamera: (name: string, scene: Scene) => Camera;
  107596. /**
  107597. * This is the default projection mode used by the cameras.
  107598. * It helps recreating a feeling of perspective and better appreciate depth.
  107599. * This is the best way to simulate real life cameras.
  107600. */
  107601. static readonly PERSPECTIVE_CAMERA: number;
  107602. /**
  107603. * This helps creating camera with an orthographic mode.
  107604. * 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.
  107605. */
  107606. static readonly ORTHOGRAPHIC_CAMERA: number;
  107607. /**
  107608. * This is the default FOV mode for perspective cameras.
  107609. * This setting aligns the upper and lower bounds of the viewport to the upper and lower bounds of the camera frustum.
  107610. */
  107611. static readonly FOVMODE_VERTICAL_FIXED: number;
  107612. /**
  107613. * This setting aligns the left and right bounds of the viewport to the left and right bounds of the camera frustum.
  107614. */
  107615. static readonly FOVMODE_HORIZONTAL_FIXED: number;
  107616. /**
  107617. * This specifies ther is no need for a camera rig.
  107618. * Basically only one eye is rendered corresponding to the camera.
  107619. */
  107620. static readonly RIG_MODE_NONE: number;
  107621. /**
  107622. * Simulates a camera Rig with one blue eye and one red eye.
  107623. * This can be use with 3d blue and red glasses.
  107624. */
  107625. static readonly RIG_MODE_STEREOSCOPIC_ANAGLYPH: number;
  107626. /**
  107627. * Defines that both eyes of the camera will be rendered side by side with a parallel target.
  107628. */
  107629. static readonly RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_PARALLEL: number;
  107630. /**
  107631. * Defines that both eyes of the camera will be rendered side by side with a none parallel target.
  107632. */
  107633. static readonly RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_CROSSEYED: number;
  107634. /**
  107635. * Defines that both eyes of the camera will be rendered over under each other.
  107636. */
  107637. static readonly RIG_MODE_STEREOSCOPIC_OVERUNDER: number;
  107638. /**
  107639. * Defines that both eyes of the camera will be rendered on successive lines interlaced for passive 3d monitors.
  107640. */
  107641. static readonly RIG_MODE_STEREOSCOPIC_INTERLACED: number;
  107642. /**
  107643. * Defines that both eyes of the camera should be renderered in a VR mode (carbox).
  107644. */
  107645. static readonly RIG_MODE_VR: number;
  107646. /**
  107647. * Defines that both eyes of the camera should be renderered in a VR mode (webVR).
  107648. */
  107649. static readonly RIG_MODE_WEBVR: number;
  107650. /**
  107651. * Custom rig mode allowing rig cameras to be populated manually with any number of cameras
  107652. */
  107653. static readonly RIG_MODE_CUSTOM: number;
  107654. /**
  107655. * Defines if by default attaching controls should prevent the default javascript event to continue.
  107656. */
  107657. static ForceAttachControlToAlwaysPreventDefault: boolean;
  107658. /**
  107659. * Define the input manager associated with the camera.
  107660. */
  107661. inputs: CameraInputsManager<Camera>;
  107662. /** @hidden */
  107663. _position: Vector3;
  107664. /**
  107665. * Define the current local position of the camera in the scene
  107666. */
  107667. get position(): Vector3;
  107668. set position(newPosition: Vector3);
  107669. /**
  107670. * The vector the camera should consider as up.
  107671. * (default is Vector3(0, 1, 0) aka Vector3.Up())
  107672. */
  107673. upVector: Vector3;
  107674. /**
  107675. * Define the current limit on the left side for an orthographic camera
  107676. * In scene unit
  107677. */
  107678. orthoLeft: Nullable<number>;
  107679. /**
  107680. * Define the current limit on the right side for an orthographic camera
  107681. * In scene unit
  107682. */
  107683. orthoRight: Nullable<number>;
  107684. /**
  107685. * Define the current limit on the bottom side for an orthographic camera
  107686. * In scene unit
  107687. */
  107688. orthoBottom: Nullable<number>;
  107689. /**
  107690. * Define the current limit on the top side for an orthographic camera
  107691. * In scene unit
  107692. */
  107693. orthoTop: Nullable<number>;
  107694. /**
  107695. * Field Of View is set in Radians. (default is 0.8)
  107696. */
  107697. fov: number;
  107698. /**
  107699. * Define the minimum distance the camera can see from.
  107700. * This is important to note that the depth buffer are not infinite and the closer it starts
  107701. * the more your scene might encounter depth fighting issue.
  107702. */
  107703. minZ: number;
  107704. /**
  107705. * Define the maximum distance the camera can see to.
  107706. * This is important to note that the depth buffer are not infinite and the further it end
  107707. * the more your scene might encounter depth fighting issue.
  107708. */
  107709. maxZ: number;
  107710. /**
  107711. * Define the default inertia of the camera.
  107712. * This helps giving a smooth feeling to the camera movement.
  107713. */
  107714. inertia: number;
  107715. /**
  107716. * Define the mode of the camera (Camera.PERSPECTIVE_CAMERA or Camera.ORTHOGRAPHIC_CAMERA)
  107717. */
  107718. mode: number;
  107719. /**
  107720. * Define whether the camera is intermediate.
  107721. * This is useful to not present the output directly to the screen in case of rig without post process for instance
  107722. */
  107723. isIntermediate: boolean;
  107724. /**
  107725. * Define the viewport of the camera.
  107726. * This correspond to the portion of the screen the camera will render to in normalized 0 to 1 unit.
  107727. */
  107728. viewport: Viewport;
  107729. /**
  107730. * Restricts the camera to viewing objects with the same layerMask.
  107731. * A camera with a layerMask of 1 will render mesh.layerMask & camera.layerMask!== 0
  107732. */
  107733. layerMask: number;
  107734. /**
  107735. * fovMode sets the camera frustum bounds to the viewport bounds. (default is FOVMODE_VERTICAL_FIXED)
  107736. */
  107737. fovMode: number;
  107738. /**
  107739. * Rig mode of the camera.
  107740. * This is useful to create the camera with two "eyes" instead of one to create VR or stereoscopic scenes.
  107741. * This is normally controlled byt the camera themselves as internal use.
  107742. */
  107743. cameraRigMode: number;
  107744. /**
  107745. * Defines the distance between both "eyes" in case of a RIG
  107746. */
  107747. interaxialDistance: number;
  107748. /**
  107749. * Defines if stereoscopic rendering is done side by side or over under.
  107750. */
  107751. isStereoscopicSideBySide: boolean;
  107752. /**
  107753. * 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
  107754. * This is pretty helpfull if you wish to make a camera render to a texture you could reuse somewhere
  107755. * else in the scene. (Eg. security camera)
  107756. *
  107757. * 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)
  107758. */
  107759. customRenderTargets: RenderTargetTexture[];
  107760. /**
  107761. * When set, the camera will render to this render target instead of the default canvas
  107762. *
  107763. * If the desire is to use the output of a camera as a texture in the scene consider using camera.customRenderTargets instead
  107764. */
  107765. outputRenderTarget: Nullable<RenderTargetTexture>;
  107766. /**
  107767. * Observable triggered when the camera view matrix has changed.
  107768. */
  107769. onViewMatrixChangedObservable: Observable<Camera>;
  107770. /**
  107771. * Observable triggered when the camera Projection matrix has changed.
  107772. */
  107773. onProjectionMatrixChangedObservable: Observable<Camera>;
  107774. /**
  107775. * Observable triggered when the inputs have been processed.
  107776. */
  107777. onAfterCheckInputsObservable: Observable<Camera>;
  107778. /**
  107779. * Observable triggered when reset has been called and applied to the camera.
  107780. */
  107781. onRestoreStateObservable: Observable<Camera>;
  107782. /**
  107783. * Is this camera a part of a rig system?
  107784. */
  107785. isRigCamera: boolean;
  107786. /**
  107787. * If isRigCamera set to true this will be set with the parent camera.
  107788. * The parent camera is not (!) necessarily the .parent of this camera (like in the case of XR)
  107789. */
  107790. rigParent?: Camera;
  107791. /** @hidden */
  107792. _cameraRigParams: any;
  107793. /** @hidden */
  107794. _rigCameras: Camera[];
  107795. /** @hidden */
  107796. _rigPostProcess: Nullable<PostProcess>;
  107797. protected _webvrViewMatrix: Matrix;
  107798. /** @hidden */
  107799. _skipRendering: boolean;
  107800. /** @hidden */
  107801. _projectionMatrix: Matrix;
  107802. /** @hidden */
  107803. _postProcesses: Nullable<PostProcess>[];
  107804. /** @hidden */
  107805. _activeMeshes: SmartArray<AbstractMesh>;
  107806. protected _globalPosition: Vector3;
  107807. /** @hidden */
  107808. _computedViewMatrix: Matrix;
  107809. private _doNotComputeProjectionMatrix;
  107810. private _transformMatrix;
  107811. private _frustumPlanes;
  107812. private _refreshFrustumPlanes;
  107813. private _storedFov;
  107814. private _stateStored;
  107815. /**
  107816. * Instantiates a new camera object.
  107817. * This should not be used directly but through the inherited cameras: ArcRotate, Free...
  107818. * @see https://doc.babylonjs.com/features/cameras
  107819. * @param name Defines the name of the camera in the scene
  107820. * @param position Defines the position of the camera
  107821. * @param scene Defines the scene the camera belongs too
  107822. * @param setActiveOnSceneIfNoneActive Defines if the camera should be set as active after creation if no other camera have been defined in the scene
  107823. */
  107824. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  107825. /**
  107826. * Store current camera state (fov, position, etc..)
  107827. * @returns the camera
  107828. */
  107829. storeState(): Camera;
  107830. /**
  107831. * Restores the camera state values if it has been stored. You must call storeState() first
  107832. */
  107833. protected _restoreStateValues(): boolean;
  107834. /**
  107835. * Restored camera state. You must call storeState() first.
  107836. * @returns true if restored and false otherwise
  107837. */
  107838. restoreState(): boolean;
  107839. /**
  107840. * Gets the class name of the camera.
  107841. * @returns the class name
  107842. */
  107843. getClassName(): string;
  107844. /** @hidden */
  107845. readonly _isCamera: boolean;
  107846. /**
  107847. * Gets a string representation of the camera useful for debug purpose.
  107848. * @param fullDetails Defines that a more verboe level of logging is required
  107849. * @returns the string representation
  107850. */
  107851. toString(fullDetails?: boolean): string;
  107852. /**
  107853. * Gets the current world space position of the camera.
  107854. */
  107855. get globalPosition(): Vector3;
  107856. /**
  107857. * Gets the list of active meshes this frame (meshes no culled or excluded by lod s in the frame)
  107858. * @returns the active meshe list
  107859. */
  107860. getActiveMeshes(): SmartArray<AbstractMesh>;
  107861. /**
  107862. * Check whether a mesh is part of the current active mesh list of the camera
  107863. * @param mesh Defines the mesh to check
  107864. * @returns true if active, false otherwise
  107865. */
  107866. isActiveMesh(mesh: Mesh): boolean;
  107867. /**
  107868. * Is this camera ready to be used/rendered
  107869. * @param completeCheck defines if a complete check (including post processes) has to be done (false by default)
  107870. * @return true if the camera is ready
  107871. */
  107872. isReady(completeCheck?: boolean): boolean;
  107873. /** @hidden */
  107874. _initCache(): void;
  107875. /** @hidden */
  107876. _updateCache(ignoreParentClass?: boolean): void;
  107877. /** @hidden */
  107878. _isSynchronized(): boolean;
  107879. /** @hidden */
  107880. _isSynchronizedViewMatrix(): boolean;
  107881. /** @hidden */
  107882. _isSynchronizedProjectionMatrix(): boolean;
  107883. /**
  107884. * Attach the input controls to a specific dom element to get the input from.
  107885. * @param element Defines the element the controls should be listened from
  107886. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  107887. */
  107888. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  107889. /**
  107890. * Detach the current controls from the specified dom element.
  107891. * @param element Defines the element to stop listening the inputs from
  107892. */
  107893. detachControl(element: HTMLElement): void;
  107894. /**
  107895. * Update the camera state according to the different inputs gathered during the frame.
  107896. */
  107897. update(): void;
  107898. /** @hidden */
  107899. _checkInputs(): void;
  107900. /** @hidden */
  107901. get rigCameras(): Camera[];
  107902. /**
  107903. * Gets the post process used by the rig cameras
  107904. */
  107905. get rigPostProcess(): Nullable<PostProcess>;
  107906. /**
  107907. * Internal, gets the first post proces.
  107908. * @returns the first post process to be run on this camera.
  107909. */
  107910. _getFirstPostProcess(): Nullable<PostProcess>;
  107911. private _cascadePostProcessesToRigCams;
  107912. /**
  107913. * Attach a post process to the camera.
  107914. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#attach-postprocess
  107915. * @param postProcess The post process to attach to the camera
  107916. * @param insertAt The position of the post process in case several of them are in use in the scene
  107917. * @returns the position the post process has been inserted at
  107918. */
  107919. attachPostProcess(postProcess: PostProcess, insertAt?: Nullable<number>): number;
  107920. /**
  107921. * Detach a post process to the camera.
  107922. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#attach-postprocess
  107923. * @param postProcess The post process to detach from the camera
  107924. */
  107925. detachPostProcess(postProcess: PostProcess): void;
  107926. /**
  107927. * Gets the current world matrix of the camera
  107928. */
  107929. getWorldMatrix(): Matrix;
  107930. /** @hidden */
  107931. _getViewMatrix(): Matrix;
  107932. /**
  107933. * Gets the current view matrix of the camera.
  107934. * @param force forces the camera to recompute the matrix without looking at the cached state
  107935. * @returns the view matrix
  107936. */
  107937. getViewMatrix(force?: boolean): Matrix;
  107938. /**
  107939. * Freeze the projection matrix.
  107940. * It will prevent the cache check of the camera projection compute and can speed up perf
  107941. * if no parameter of the camera are meant to change
  107942. * @param projection Defines manually a projection if necessary
  107943. */
  107944. freezeProjectionMatrix(projection?: Matrix): void;
  107945. /**
  107946. * Unfreeze the projection matrix if it has previously been freezed by freezeProjectionMatrix.
  107947. */
  107948. unfreezeProjectionMatrix(): void;
  107949. /**
  107950. * Gets the current projection matrix of the camera.
  107951. * @param force forces the camera to recompute the matrix without looking at the cached state
  107952. * @returns the projection matrix
  107953. */
  107954. getProjectionMatrix(force?: boolean): Matrix;
  107955. /**
  107956. * Gets the transformation matrix (ie. the multiplication of view by projection matrices)
  107957. * @returns a Matrix
  107958. */
  107959. getTransformationMatrix(): Matrix;
  107960. private _updateFrustumPlanes;
  107961. /**
  107962. * Checks if a cullable object (mesh...) is in the camera frustum
  107963. * This checks the bounding box center. See isCompletelyInFrustum for a full bounding check
  107964. * @param target The object to check
  107965. * @param checkRigCameras If the rig cameras should be checked (eg. with webVR camera both eyes should be checked) (Default: false)
  107966. * @returns true if the object is in frustum otherwise false
  107967. */
  107968. isInFrustum(target: ICullable, checkRigCameras?: boolean): boolean;
  107969. /**
  107970. * Checks if a cullable object (mesh...) is in the camera frustum
  107971. * Unlike isInFrustum this cheks the full bounding box
  107972. * @param target The object to check
  107973. * @returns true if the object is in frustum otherwise false
  107974. */
  107975. isCompletelyInFrustum(target: ICullable): boolean;
  107976. /**
  107977. * Gets a ray in the forward direction from the camera.
  107978. * @param length Defines the length of the ray to create
  107979. * @param transform Defines the transform to apply to the ray, by default the world matrx is used to create a workd space ray
  107980. * @param origin Defines the start point of the ray which defaults to the camera position
  107981. * @returns the forward ray
  107982. */
  107983. getForwardRay(length?: number, transform?: Matrix, origin?: Vector3): Ray;
  107984. /**
  107985. * Releases resources associated with this node.
  107986. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  107987. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  107988. */
  107989. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  107990. /** @hidden */
  107991. _isLeftCamera: boolean;
  107992. /**
  107993. * Gets the left camera of a rig setup in case of Rigged Camera
  107994. */
  107995. get isLeftCamera(): boolean;
  107996. /** @hidden */
  107997. _isRightCamera: boolean;
  107998. /**
  107999. * Gets the right camera of a rig setup in case of Rigged Camera
  108000. */
  108001. get isRightCamera(): boolean;
  108002. /**
  108003. * Gets the left camera of a rig setup in case of Rigged Camera
  108004. */
  108005. get leftCamera(): Nullable<FreeCamera>;
  108006. /**
  108007. * Gets the right camera of a rig setup in case of Rigged Camera
  108008. */
  108009. get rightCamera(): Nullable<FreeCamera>;
  108010. /**
  108011. * Gets the left camera target of a rig setup in case of Rigged Camera
  108012. * @returns the target position
  108013. */
  108014. getLeftTarget(): Nullable<Vector3>;
  108015. /**
  108016. * Gets the right camera target of a rig setup in case of Rigged Camera
  108017. * @returns the target position
  108018. */
  108019. getRightTarget(): Nullable<Vector3>;
  108020. /**
  108021. * @hidden
  108022. */
  108023. setCameraRigMode(mode: number, rigParams: any): void;
  108024. /** @hidden */
  108025. static _setStereoscopicRigMode(camera: Camera): void;
  108026. /** @hidden */
  108027. static _setStereoscopicAnaglyphRigMode(camera: Camera): void;
  108028. /** @hidden */
  108029. static _setVRRigMode(camera: Camera, rigParams: any): void;
  108030. /** @hidden */
  108031. static _setWebVRRigMode(camera: Camera, rigParams: any): void;
  108032. /** @hidden */
  108033. _getVRProjectionMatrix(): Matrix;
  108034. protected _updateCameraRotationMatrix(): void;
  108035. protected _updateWebVRCameraRotationMatrix(): void;
  108036. /**
  108037. * This function MUST be overwritten by the different WebVR cameras available.
  108038. * The context in which it is running is the RIG camera. So 'this' is the TargetCamera, left or right.
  108039. * @hidden
  108040. */
  108041. _getWebVRProjectionMatrix(): Matrix;
  108042. /**
  108043. * This function MUST be overwritten by the different WebVR cameras available.
  108044. * The context in which it is running is the RIG camera. So 'this' is the TargetCamera, left or right.
  108045. * @hidden
  108046. */
  108047. _getWebVRViewMatrix(): Matrix;
  108048. /** @hidden */
  108049. setCameraRigParameter(name: string, value: any): void;
  108050. /**
  108051. * needs to be overridden by children so sub has required properties to be copied
  108052. * @hidden
  108053. */
  108054. createRigCamera(name: string, cameraIndex: number): Nullable<Camera>;
  108055. /**
  108056. * May need to be overridden by children
  108057. * @hidden
  108058. */
  108059. _updateRigCameras(): void;
  108060. /** @hidden */
  108061. _setupInputs(): void;
  108062. /**
  108063. * Serialiaze the camera setup to a json represention
  108064. * @returns the JSON representation
  108065. */
  108066. serialize(): any;
  108067. /**
  108068. * Clones the current camera.
  108069. * @param name The cloned camera name
  108070. * @returns the cloned camera
  108071. */
  108072. clone(name: string): Camera;
  108073. /**
  108074. * Gets the direction of the camera relative to a given local axis.
  108075. * @param localAxis Defines the reference axis to provide a relative direction.
  108076. * @return the direction
  108077. */
  108078. getDirection(localAxis: Vector3): Vector3;
  108079. /**
  108080. * Returns the current camera absolute rotation
  108081. */
  108082. get absoluteRotation(): Quaternion;
  108083. /**
  108084. * Gets the direction of the camera relative to a given local axis into a passed vector.
  108085. * @param localAxis Defines the reference axis to provide a relative direction.
  108086. * @param result Defines the vector to store the result in
  108087. */
  108088. getDirectionToRef(localAxis: Vector3, result: Vector3): void;
  108089. /**
  108090. * Gets a camera constructor for a given camera type
  108091. * @param type The type of the camera to construct (should be equal to one of the camera class name)
  108092. * @param name The name of the camera the result will be able to instantiate
  108093. * @param scene The scene the result will construct the camera in
  108094. * @param interaxial_distance In case of stereoscopic setup, the distance between both eyes
  108095. * @param isStereoscopicSideBySide In case of stereoscopic setup, should the sereo be side b side
  108096. * @returns a factory method to construc the camera
  108097. */
  108098. static GetConstructorFromName(type: string, name: string, scene: Scene, interaxial_distance?: number, isStereoscopicSideBySide?: boolean): () => Camera;
  108099. /**
  108100. * Compute the world matrix of the camera.
  108101. * @returns the camera world matrix
  108102. */
  108103. computeWorldMatrix(): Matrix;
  108104. /**
  108105. * Parse a JSON and creates the camera from the parsed information
  108106. * @param parsedCamera The JSON to parse
  108107. * @param scene The scene to instantiate the camera in
  108108. * @returns the newly constructed camera
  108109. */
  108110. static Parse(parsedCamera: any, scene: Scene): Camera;
  108111. }
  108112. }
  108113. declare module BABYLON {
  108114. /**
  108115. * Class containing static functions to help procedurally build meshes
  108116. */
  108117. export class DiscBuilder {
  108118. /**
  108119. * Creates a plane polygonal mesh. By default, this is a disc
  108120. * * The parameter `radius` sets the radius size (float) of the polygon (default 0.5)
  108121. * * 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
  108122. * * 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
  108123. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  108124. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  108125. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  108126. * @param name defines the name of the mesh
  108127. * @param options defines the options used to create the mesh
  108128. * @param scene defines the hosting scene
  108129. * @returns the plane polygonal mesh
  108130. * @see https://doc.babylonjs.com/how_to/set_shapes#disc-or-regular-polygon
  108131. */
  108132. static CreateDisc(name: string, options: {
  108133. radius?: number;
  108134. tessellation?: number;
  108135. arc?: number;
  108136. updatable?: boolean;
  108137. sideOrientation?: number;
  108138. frontUVs?: Vector4;
  108139. backUVs?: Vector4;
  108140. }, scene?: Nullable<Scene>): Mesh;
  108141. }
  108142. }
  108143. declare module BABYLON {
  108144. /**
  108145. * Options to be used when creating a FresnelParameters.
  108146. */
  108147. export type IFresnelParametersCreationOptions = {
  108148. /**
  108149. * Define the color used on edges (grazing angle)
  108150. */
  108151. leftColor?: Color3;
  108152. /**
  108153. * Define the color used on center
  108154. */
  108155. rightColor?: Color3;
  108156. /**
  108157. * Define bias applied to computed fresnel term
  108158. */
  108159. bias?: number;
  108160. /**
  108161. * Defined the power exponent applied to fresnel term
  108162. */
  108163. power?: number;
  108164. /**
  108165. * Define if the fresnel effect is enable or not.
  108166. */
  108167. isEnabled?: boolean;
  108168. };
  108169. /**
  108170. * Serialized format for FresnelParameters.
  108171. */
  108172. export type IFresnelParametersSerialized = {
  108173. /**
  108174. * Define the color used on edges (grazing angle) [as an array]
  108175. */
  108176. leftColor: number[];
  108177. /**
  108178. * Define the color used on center [as an array]
  108179. */
  108180. rightColor: number[];
  108181. /**
  108182. * Define bias applied to computed fresnel term
  108183. */
  108184. bias: number;
  108185. /**
  108186. * Defined the power exponent applied to fresnel term
  108187. */
  108188. power?: number;
  108189. /**
  108190. * Define if the fresnel effect is enable or not.
  108191. */
  108192. isEnabled: boolean;
  108193. };
  108194. /**
  108195. * This represents all the required information to add a fresnel effect on a material:
  108196. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  108197. */
  108198. export class FresnelParameters {
  108199. private _isEnabled;
  108200. /**
  108201. * Define if the fresnel effect is enable or not.
  108202. */
  108203. get isEnabled(): boolean;
  108204. set isEnabled(value: boolean);
  108205. /**
  108206. * Define the color used on edges (grazing angle)
  108207. */
  108208. leftColor: Color3;
  108209. /**
  108210. * Define the color used on center
  108211. */
  108212. rightColor: Color3;
  108213. /**
  108214. * Define bias applied to computed fresnel term
  108215. */
  108216. bias: number;
  108217. /**
  108218. * Defined the power exponent applied to fresnel term
  108219. */
  108220. power: number;
  108221. /**
  108222. * Creates a new FresnelParameters object.
  108223. *
  108224. * @param options provide your own settings to optionally to override defaults
  108225. */
  108226. constructor(options?: IFresnelParametersCreationOptions);
  108227. /**
  108228. * Clones the current fresnel and its valuues
  108229. * @returns a clone fresnel configuration
  108230. */
  108231. clone(): FresnelParameters;
  108232. /**
  108233. * Determines equality between FresnelParameters objects
  108234. * @param otherFresnelParameters defines the second operand
  108235. * @returns true if the power, bias, leftColor, rightColor and isEnabled values are equal to the given ones
  108236. */
  108237. equals(otherFresnelParameters: DeepImmutable<FresnelParameters>): boolean;
  108238. /**
  108239. * Serializes the current fresnel parameters to a JSON representation.
  108240. * @return the JSON serialization
  108241. */
  108242. serialize(): IFresnelParametersSerialized;
  108243. /**
  108244. * Parse a JSON object and deserialize it to a new Fresnel parameter object.
  108245. * @param parsedFresnelParameters Define the JSON representation
  108246. * @returns the parsed parameters
  108247. */
  108248. static Parse(parsedFresnelParameters: IFresnelParametersSerialized): FresnelParameters;
  108249. }
  108250. }
  108251. declare module BABYLON {
  108252. /**
  108253. * This groups all the flags used to control the materials channel.
  108254. */
  108255. export class MaterialFlags {
  108256. private static _DiffuseTextureEnabled;
  108257. /**
  108258. * Are diffuse textures enabled in the application.
  108259. */
  108260. static get DiffuseTextureEnabled(): boolean;
  108261. static set DiffuseTextureEnabled(value: boolean);
  108262. private static _DetailTextureEnabled;
  108263. /**
  108264. * Are detail textures enabled in the application.
  108265. */
  108266. static get DetailTextureEnabled(): boolean;
  108267. static set DetailTextureEnabled(value: boolean);
  108268. private static _AmbientTextureEnabled;
  108269. /**
  108270. * Are ambient textures enabled in the application.
  108271. */
  108272. static get AmbientTextureEnabled(): boolean;
  108273. static set AmbientTextureEnabled(value: boolean);
  108274. private static _OpacityTextureEnabled;
  108275. /**
  108276. * Are opacity textures enabled in the application.
  108277. */
  108278. static get OpacityTextureEnabled(): boolean;
  108279. static set OpacityTextureEnabled(value: boolean);
  108280. private static _ReflectionTextureEnabled;
  108281. /**
  108282. * Are reflection textures enabled in the application.
  108283. */
  108284. static get ReflectionTextureEnabled(): boolean;
  108285. static set ReflectionTextureEnabled(value: boolean);
  108286. private static _EmissiveTextureEnabled;
  108287. /**
  108288. * Are emissive textures enabled in the application.
  108289. */
  108290. static get EmissiveTextureEnabled(): boolean;
  108291. static set EmissiveTextureEnabled(value: boolean);
  108292. private static _SpecularTextureEnabled;
  108293. /**
  108294. * Are specular textures enabled in the application.
  108295. */
  108296. static get SpecularTextureEnabled(): boolean;
  108297. static set SpecularTextureEnabled(value: boolean);
  108298. private static _BumpTextureEnabled;
  108299. /**
  108300. * Are bump textures enabled in the application.
  108301. */
  108302. static get BumpTextureEnabled(): boolean;
  108303. static set BumpTextureEnabled(value: boolean);
  108304. private static _LightmapTextureEnabled;
  108305. /**
  108306. * Are lightmap textures enabled in the application.
  108307. */
  108308. static get LightmapTextureEnabled(): boolean;
  108309. static set LightmapTextureEnabled(value: boolean);
  108310. private static _RefractionTextureEnabled;
  108311. /**
  108312. * Are refraction textures enabled in the application.
  108313. */
  108314. static get RefractionTextureEnabled(): boolean;
  108315. static set RefractionTextureEnabled(value: boolean);
  108316. private static _ColorGradingTextureEnabled;
  108317. /**
  108318. * Are color grading textures enabled in the application.
  108319. */
  108320. static get ColorGradingTextureEnabled(): boolean;
  108321. static set ColorGradingTextureEnabled(value: boolean);
  108322. private static _FresnelEnabled;
  108323. /**
  108324. * Are fresnels enabled in the application.
  108325. */
  108326. static get FresnelEnabled(): boolean;
  108327. static set FresnelEnabled(value: boolean);
  108328. private static _ClearCoatTextureEnabled;
  108329. /**
  108330. * Are clear coat textures enabled in the application.
  108331. */
  108332. static get ClearCoatTextureEnabled(): boolean;
  108333. static set ClearCoatTextureEnabled(value: boolean);
  108334. private static _ClearCoatBumpTextureEnabled;
  108335. /**
  108336. * Are clear coat bump textures enabled in the application.
  108337. */
  108338. static get ClearCoatBumpTextureEnabled(): boolean;
  108339. static set ClearCoatBumpTextureEnabled(value: boolean);
  108340. private static _ClearCoatTintTextureEnabled;
  108341. /**
  108342. * Are clear coat tint textures enabled in the application.
  108343. */
  108344. static get ClearCoatTintTextureEnabled(): boolean;
  108345. static set ClearCoatTintTextureEnabled(value: boolean);
  108346. private static _SheenTextureEnabled;
  108347. /**
  108348. * Are sheen textures enabled in the application.
  108349. */
  108350. static get SheenTextureEnabled(): boolean;
  108351. static set SheenTextureEnabled(value: boolean);
  108352. private static _AnisotropicTextureEnabled;
  108353. /**
  108354. * Are anisotropic textures enabled in the application.
  108355. */
  108356. static get AnisotropicTextureEnabled(): boolean;
  108357. static set AnisotropicTextureEnabled(value: boolean);
  108358. private static _ThicknessTextureEnabled;
  108359. /**
  108360. * Are thickness textures enabled in the application.
  108361. */
  108362. static get ThicknessTextureEnabled(): boolean;
  108363. static set ThicknessTextureEnabled(value: boolean);
  108364. }
  108365. }
  108366. declare module BABYLON {
  108367. /** @hidden */
  108368. export var defaultFragmentDeclaration: {
  108369. name: string;
  108370. shader: string;
  108371. };
  108372. }
  108373. declare module BABYLON {
  108374. /** @hidden */
  108375. export var defaultUboDeclaration: {
  108376. name: string;
  108377. shader: string;
  108378. };
  108379. }
  108380. declare module BABYLON {
  108381. /** @hidden */
  108382. export var prePassDeclaration: {
  108383. name: string;
  108384. shader: string;
  108385. };
  108386. }
  108387. declare module BABYLON {
  108388. /** @hidden */
  108389. export var lightFragmentDeclaration: {
  108390. name: string;
  108391. shader: string;
  108392. };
  108393. }
  108394. declare module BABYLON {
  108395. /** @hidden */
  108396. export var lightUboDeclaration: {
  108397. name: string;
  108398. shader: string;
  108399. };
  108400. }
  108401. declare module BABYLON {
  108402. /** @hidden */
  108403. export var lightsFragmentFunctions: {
  108404. name: string;
  108405. shader: string;
  108406. };
  108407. }
  108408. declare module BABYLON {
  108409. /** @hidden */
  108410. export var shadowsFragmentFunctions: {
  108411. name: string;
  108412. shader: string;
  108413. };
  108414. }
  108415. declare module BABYLON {
  108416. /** @hidden */
  108417. export var fresnelFunction: {
  108418. name: string;
  108419. shader: string;
  108420. };
  108421. }
  108422. declare module BABYLON {
  108423. /** @hidden */
  108424. export var bumpFragmentMainFunctions: {
  108425. name: string;
  108426. shader: string;
  108427. };
  108428. }
  108429. declare module BABYLON {
  108430. /** @hidden */
  108431. export var bumpFragmentFunctions: {
  108432. name: string;
  108433. shader: string;
  108434. };
  108435. }
  108436. declare module BABYLON {
  108437. /** @hidden */
  108438. export var logDepthDeclaration: {
  108439. name: string;
  108440. shader: string;
  108441. };
  108442. }
  108443. declare module BABYLON {
  108444. /** @hidden */
  108445. export var bumpFragment: {
  108446. name: string;
  108447. shader: string;
  108448. };
  108449. }
  108450. declare module BABYLON {
  108451. /** @hidden */
  108452. export var depthPrePass: {
  108453. name: string;
  108454. shader: string;
  108455. };
  108456. }
  108457. declare module BABYLON {
  108458. /** @hidden */
  108459. export var lightFragment: {
  108460. name: string;
  108461. shader: string;
  108462. };
  108463. }
  108464. declare module BABYLON {
  108465. /** @hidden */
  108466. export var logDepthFragment: {
  108467. name: string;
  108468. shader: string;
  108469. };
  108470. }
  108471. declare module BABYLON {
  108472. /** @hidden */
  108473. export var defaultPixelShader: {
  108474. name: string;
  108475. shader: string;
  108476. };
  108477. }
  108478. declare module BABYLON {
  108479. /** @hidden */
  108480. export var defaultVertexDeclaration: {
  108481. name: string;
  108482. shader: string;
  108483. };
  108484. }
  108485. declare module BABYLON {
  108486. /** @hidden */
  108487. export var bumpVertexDeclaration: {
  108488. name: string;
  108489. shader: string;
  108490. };
  108491. }
  108492. declare module BABYLON {
  108493. /** @hidden */
  108494. export var bumpVertex: {
  108495. name: string;
  108496. shader: string;
  108497. };
  108498. }
  108499. declare module BABYLON {
  108500. /** @hidden */
  108501. export var fogVertex: {
  108502. name: string;
  108503. shader: string;
  108504. };
  108505. }
  108506. declare module BABYLON {
  108507. /** @hidden */
  108508. export var shadowsVertex: {
  108509. name: string;
  108510. shader: string;
  108511. };
  108512. }
  108513. declare module BABYLON {
  108514. /** @hidden */
  108515. export var pointCloudVertex: {
  108516. name: string;
  108517. shader: string;
  108518. };
  108519. }
  108520. declare module BABYLON {
  108521. /** @hidden */
  108522. export var logDepthVertex: {
  108523. name: string;
  108524. shader: string;
  108525. };
  108526. }
  108527. declare module BABYLON {
  108528. /** @hidden */
  108529. export var defaultVertexShader: {
  108530. name: string;
  108531. shader: string;
  108532. };
  108533. }
  108534. declare module BABYLON {
  108535. /**
  108536. * @hidden
  108537. */
  108538. export interface IMaterialDetailMapDefines {
  108539. DETAIL: boolean;
  108540. DETAILDIRECTUV: number;
  108541. DETAIL_NORMALBLENDMETHOD: number;
  108542. /** @hidden */
  108543. _areTexturesDirty: boolean;
  108544. }
  108545. /**
  108546. * Define the code related to the detail map parameters of a material
  108547. *
  108548. * Inspired from:
  108549. * 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
  108550. * Unreal: https://docs.unrealengine.com/en-US/Engine/Rendering/Materials/HowTo/DetailTexturing/index.html
  108551. * Cryengine: https://docs.cryengine.com/display/SDKDOC2/Detail+Maps
  108552. */
  108553. export class DetailMapConfiguration {
  108554. private _texture;
  108555. /**
  108556. * The detail texture of the material.
  108557. */
  108558. texture: Nullable<BaseTexture>;
  108559. /**
  108560. * Defines how strongly the detail diffuse/albedo channel is blended with the regular diffuse/albedo texture
  108561. * Bigger values mean stronger blending
  108562. */
  108563. diffuseBlendLevel: number;
  108564. /**
  108565. * Defines how strongly the detail roughness channel is blended with the regular roughness value
  108566. * Bigger values mean stronger blending. Only used with PBR materials
  108567. */
  108568. roughnessBlendLevel: number;
  108569. /**
  108570. * Defines how strong the bump effect from the detail map is
  108571. * Bigger values mean stronger effect
  108572. */
  108573. bumpLevel: number;
  108574. private _normalBlendMethod;
  108575. /**
  108576. * The method used to blend the bump and detail normals together
  108577. */
  108578. normalBlendMethod: number;
  108579. private _isEnabled;
  108580. /**
  108581. * Enable or disable the detail map on this material
  108582. */
  108583. isEnabled: boolean;
  108584. /** @hidden */
  108585. private _internalMarkAllSubMeshesAsTexturesDirty;
  108586. /** @hidden */
  108587. _markAllSubMeshesAsTexturesDirty(): void;
  108588. /**
  108589. * Instantiate a new detail map
  108590. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  108591. */
  108592. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  108593. /**
  108594. * Gets whether the submesh is ready to be used or not.
  108595. * @param defines the list of "defines" to update.
  108596. * @param scene defines the scene the material belongs to.
  108597. * @returns - boolean indicating that the submesh is ready or not.
  108598. */
  108599. isReadyForSubMesh(defines: IMaterialDetailMapDefines, scene: Scene): boolean;
  108600. /**
  108601. * Update the defines for detail map usage
  108602. * @param defines the list of "defines" to update.
  108603. * @param scene defines the scene the material belongs to.
  108604. */
  108605. prepareDefines(defines: IMaterialDetailMapDefines, scene: Scene): void;
  108606. /**
  108607. * Binds the material data.
  108608. * @param uniformBuffer defines the Uniform buffer to fill in.
  108609. * @param scene defines the scene the material belongs to.
  108610. * @param isFrozen defines whether the material is frozen or not.
  108611. */
  108612. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  108613. /**
  108614. * Checks to see if a texture is used in the material.
  108615. * @param texture - Base texture to use.
  108616. * @returns - Boolean specifying if a texture is used in the material.
  108617. */
  108618. hasTexture(texture: BaseTexture): boolean;
  108619. /**
  108620. * Returns an array of the actively used textures.
  108621. * @param activeTextures Array of BaseTextures
  108622. */
  108623. getActiveTextures(activeTextures: BaseTexture[]): void;
  108624. /**
  108625. * Returns the animatable textures.
  108626. * @param animatables Array of animatable textures.
  108627. */
  108628. getAnimatables(animatables: IAnimatable[]): void;
  108629. /**
  108630. * Disposes the resources of the material.
  108631. * @param forceDisposeTextures - Forces the disposal of all textures.
  108632. */
  108633. dispose(forceDisposeTextures?: boolean): void;
  108634. /**
  108635. * Get the current class name useful for serialization or dynamic coding.
  108636. * @returns "DetailMap"
  108637. */
  108638. getClassName(): string;
  108639. /**
  108640. * Add the required uniforms to the current list.
  108641. * @param uniforms defines the current uniform list.
  108642. */
  108643. static AddUniforms(uniforms: string[]): void;
  108644. /**
  108645. * Add the required samplers to the current list.
  108646. * @param samplers defines the current sampler list.
  108647. */
  108648. static AddSamplers(samplers: string[]): void;
  108649. /**
  108650. * Add the required uniforms to the current buffer.
  108651. * @param uniformBuffer defines the current uniform buffer.
  108652. */
  108653. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  108654. /**
  108655. * Makes a duplicate of the current instance into another one.
  108656. * @param detailMap define the instance where to copy the info
  108657. */
  108658. copyTo(detailMap: DetailMapConfiguration): void;
  108659. /**
  108660. * Serializes this detail map instance
  108661. * @returns - An object with the serialized instance.
  108662. */
  108663. serialize(): any;
  108664. /**
  108665. * Parses a detail map setting from a serialized object.
  108666. * @param source - Serialized object.
  108667. * @param scene Defines the scene we are parsing for
  108668. * @param rootUrl Defines the rootUrl to load from
  108669. */
  108670. parse(source: any, scene: Scene, rootUrl: string): void;
  108671. }
  108672. }
  108673. declare module BABYLON {
  108674. /** @hidden */
  108675. export class StandardMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines, IMaterialDetailMapDefines {
  108676. MAINUV1: boolean;
  108677. MAINUV2: boolean;
  108678. DIFFUSE: boolean;
  108679. DIFFUSEDIRECTUV: number;
  108680. DETAIL: boolean;
  108681. DETAILDIRECTUV: number;
  108682. DETAIL_NORMALBLENDMETHOD: number;
  108683. AMBIENT: boolean;
  108684. AMBIENTDIRECTUV: number;
  108685. OPACITY: boolean;
  108686. OPACITYDIRECTUV: number;
  108687. OPACITYRGB: boolean;
  108688. REFLECTION: boolean;
  108689. EMISSIVE: boolean;
  108690. EMISSIVEDIRECTUV: number;
  108691. SPECULAR: boolean;
  108692. SPECULARDIRECTUV: number;
  108693. BUMP: boolean;
  108694. BUMPDIRECTUV: number;
  108695. PARALLAX: boolean;
  108696. PARALLAXOCCLUSION: boolean;
  108697. SPECULAROVERALPHA: boolean;
  108698. CLIPPLANE: boolean;
  108699. CLIPPLANE2: boolean;
  108700. CLIPPLANE3: boolean;
  108701. CLIPPLANE4: boolean;
  108702. CLIPPLANE5: boolean;
  108703. CLIPPLANE6: boolean;
  108704. ALPHATEST: boolean;
  108705. DEPTHPREPASS: boolean;
  108706. ALPHAFROMDIFFUSE: boolean;
  108707. POINTSIZE: boolean;
  108708. FOG: boolean;
  108709. SPECULARTERM: boolean;
  108710. DIFFUSEFRESNEL: boolean;
  108711. OPACITYFRESNEL: boolean;
  108712. REFLECTIONFRESNEL: boolean;
  108713. REFRACTIONFRESNEL: boolean;
  108714. EMISSIVEFRESNEL: boolean;
  108715. FRESNEL: boolean;
  108716. NORMAL: boolean;
  108717. UV1: boolean;
  108718. UV2: boolean;
  108719. VERTEXCOLOR: boolean;
  108720. VERTEXALPHA: boolean;
  108721. NUM_BONE_INFLUENCERS: number;
  108722. BonesPerMesh: number;
  108723. BONETEXTURE: boolean;
  108724. INSTANCES: boolean;
  108725. THIN_INSTANCES: boolean;
  108726. GLOSSINESS: boolean;
  108727. ROUGHNESS: boolean;
  108728. EMISSIVEASILLUMINATION: boolean;
  108729. LINKEMISSIVEWITHDIFFUSE: boolean;
  108730. REFLECTIONFRESNELFROMSPECULAR: boolean;
  108731. LIGHTMAP: boolean;
  108732. LIGHTMAPDIRECTUV: number;
  108733. OBJECTSPACE_NORMALMAP: boolean;
  108734. USELIGHTMAPASSHADOWMAP: boolean;
  108735. REFLECTIONMAP_3D: boolean;
  108736. REFLECTIONMAP_SPHERICAL: boolean;
  108737. REFLECTIONMAP_PLANAR: boolean;
  108738. REFLECTIONMAP_CUBIC: boolean;
  108739. USE_LOCAL_REFLECTIONMAP_CUBIC: boolean;
  108740. REFLECTIONMAP_PROJECTION: boolean;
  108741. REFLECTIONMAP_SKYBOX: boolean;
  108742. REFLECTIONMAP_EXPLICIT: boolean;
  108743. REFLECTIONMAP_EQUIRECTANGULAR: boolean;
  108744. REFLECTIONMAP_EQUIRECTANGULAR_FIXED: boolean;
  108745. REFLECTIONMAP_MIRROREDEQUIRECTANGULAR_FIXED: boolean;
  108746. INVERTCUBICMAP: boolean;
  108747. LOGARITHMICDEPTH: boolean;
  108748. REFRACTION: boolean;
  108749. REFRACTIONMAP_3D: boolean;
  108750. REFLECTIONOVERALPHA: boolean;
  108751. TWOSIDEDLIGHTING: boolean;
  108752. SHADOWFLOAT: boolean;
  108753. MORPHTARGETS: boolean;
  108754. MORPHTARGETS_NORMAL: boolean;
  108755. MORPHTARGETS_TANGENT: boolean;
  108756. MORPHTARGETS_UV: boolean;
  108757. NUM_MORPH_INFLUENCERS: number;
  108758. NONUNIFORMSCALING: boolean;
  108759. PREMULTIPLYALPHA: boolean;
  108760. ALPHATEST_AFTERALLALPHACOMPUTATIONS: boolean;
  108761. ALPHABLEND: boolean;
  108762. PREPASS: boolean;
  108763. SCENE_MRT_COUNT: number;
  108764. RGBDLIGHTMAP: boolean;
  108765. RGBDREFLECTION: boolean;
  108766. RGBDREFRACTION: boolean;
  108767. IMAGEPROCESSING: boolean;
  108768. VIGNETTE: boolean;
  108769. VIGNETTEBLENDMODEMULTIPLY: boolean;
  108770. VIGNETTEBLENDMODEOPAQUE: boolean;
  108771. TONEMAPPING: boolean;
  108772. TONEMAPPING_ACES: boolean;
  108773. CONTRAST: boolean;
  108774. COLORCURVES: boolean;
  108775. COLORGRADING: boolean;
  108776. COLORGRADING3D: boolean;
  108777. SAMPLER3DGREENDEPTH: boolean;
  108778. SAMPLER3DBGRMAP: boolean;
  108779. IMAGEPROCESSINGPOSTPROCESS: boolean;
  108780. MULTIVIEW: boolean;
  108781. /**
  108782. * If the reflection texture on this material is in linear color space
  108783. * @hidden
  108784. */
  108785. IS_REFLECTION_LINEAR: boolean;
  108786. /**
  108787. * If the refraction texture on this material is in linear color space
  108788. * @hidden
  108789. */
  108790. IS_REFRACTION_LINEAR: boolean;
  108791. EXPOSURE: boolean;
  108792. constructor();
  108793. setReflectionMode(modeToEnable: string): void;
  108794. }
  108795. /**
  108796. * This is the default material used in Babylon. It is the best trade off between quality
  108797. * and performances.
  108798. * @see https://doc.babylonjs.com/babylon101/materials
  108799. */
  108800. export class StandardMaterial extends PushMaterial {
  108801. private _diffuseTexture;
  108802. /**
  108803. * The basic texture of the material as viewed under a light.
  108804. */
  108805. diffuseTexture: Nullable<BaseTexture>;
  108806. private _ambientTexture;
  108807. /**
  108808. * AKA Occlusion Texture in other nomenclature, it helps adding baked shadows into your material.
  108809. */
  108810. ambientTexture: Nullable<BaseTexture>;
  108811. private _opacityTexture;
  108812. /**
  108813. * Define the transparency of the material from a texture.
  108814. * The final alpha value can be read either from the red channel (if texture.getAlphaFromRGB is false)
  108815. * or from the luminance or the current texel (if texture.getAlphaFromRGB is true)
  108816. */
  108817. opacityTexture: Nullable<BaseTexture>;
  108818. private _reflectionTexture;
  108819. /**
  108820. * Define the texture used to display the reflection.
  108821. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  108822. */
  108823. reflectionTexture: Nullable<BaseTexture>;
  108824. private _emissiveTexture;
  108825. /**
  108826. * Define texture of the material as if self lit.
  108827. * This will be mixed in the final result even in the absence of light.
  108828. */
  108829. emissiveTexture: Nullable<BaseTexture>;
  108830. private _specularTexture;
  108831. /**
  108832. * Define how the color and intensity of the highlight given by the light in the material.
  108833. */
  108834. specularTexture: Nullable<BaseTexture>;
  108835. private _bumpTexture;
  108836. /**
  108837. * Bump mapping is a technique to simulate bump and dents on a rendered surface.
  108838. * 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.
  108839. * @see https://doc.babylonjs.com/how_to/more_materials#bump-map
  108840. */
  108841. bumpTexture: Nullable<BaseTexture>;
  108842. private _lightmapTexture;
  108843. /**
  108844. * Complex lighting can be computationally expensive to compute at runtime.
  108845. * To save on computation, lightmaps may be used to store calculated lighting in a texture which will be applied to a given mesh.
  108846. * @see https://doc.babylonjs.com/babylon101/lights#lightmaps
  108847. */
  108848. lightmapTexture: Nullable<BaseTexture>;
  108849. private _refractionTexture;
  108850. /**
  108851. * Define the texture used to display the refraction.
  108852. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  108853. */
  108854. refractionTexture: Nullable<BaseTexture>;
  108855. /**
  108856. * The color of the material lit by the environmental background lighting.
  108857. * @see https://doc.babylonjs.com/babylon101/materials#ambient-color-example
  108858. */
  108859. ambientColor: Color3;
  108860. /**
  108861. * The basic color of the material as viewed under a light.
  108862. */
  108863. diffuseColor: Color3;
  108864. /**
  108865. * Define how the color and intensity of the highlight given by the light in the material.
  108866. */
  108867. specularColor: Color3;
  108868. /**
  108869. * Define the color of the material as if self lit.
  108870. * This will be mixed in the final result even in the absence of light.
  108871. */
  108872. emissiveColor: Color3;
  108873. /**
  108874. * Defines how sharp are the highlights in the material.
  108875. * The bigger the value the sharper giving a more glossy feeling to the result.
  108876. * Reversely, the smaller the value the blurrier giving a more rough feeling to the result.
  108877. */
  108878. specularPower: number;
  108879. private _useAlphaFromDiffuseTexture;
  108880. /**
  108881. * Does the transparency come from the diffuse texture alpha channel.
  108882. */
  108883. useAlphaFromDiffuseTexture: boolean;
  108884. private _useEmissiveAsIllumination;
  108885. /**
  108886. * If true, the emissive value is added into the end result, otherwise it is multiplied in.
  108887. */
  108888. useEmissiveAsIllumination: boolean;
  108889. private _linkEmissiveWithDiffuse;
  108890. /**
  108891. * If true, some kind of energy conservation will prevent the end result to be more than 1 by reducing
  108892. * the emissive level when the final color is close to one.
  108893. */
  108894. linkEmissiveWithDiffuse: boolean;
  108895. private _useSpecularOverAlpha;
  108896. /**
  108897. * Specifies that the material will keep the specular highlights over a transparent surface (only the most limunous ones).
  108898. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  108899. */
  108900. useSpecularOverAlpha: boolean;
  108901. private _useReflectionOverAlpha;
  108902. /**
  108903. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  108904. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  108905. */
  108906. useReflectionOverAlpha: boolean;
  108907. private _disableLighting;
  108908. /**
  108909. * Does lights from the scene impacts this material.
  108910. * It can be a nice trick for performance to disable lighting on a fully emissive material.
  108911. */
  108912. disableLighting: boolean;
  108913. private _useObjectSpaceNormalMap;
  108914. /**
  108915. * Allows using an object space normal map (instead of tangent space).
  108916. */
  108917. useObjectSpaceNormalMap: boolean;
  108918. private _useParallax;
  108919. /**
  108920. * Is parallax enabled or not.
  108921. * @see https://doc.babylonjs.com/how_to/using_parallax_mapping
  108922. */
  108923. useParallax: boolean;
  108924. private _useParallaxOcclusion;
  108925. /**
  108926. * Is parallax occlusion enabled or not.
  108927. * If true, the outcome is way more realistic than traditional Parallax but you can expect a performance hit that worthes consideration.
  108928. * @see https://doc.babylonjs.com/how_to/using_parallax_mapping
  108929. */
  108930. useParallaxOcclusion: boolean;
  108931. /**
  108932. * 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.
  108933. */
  108934. parallaxScaleBias: number;
  108935. private _roughness;
  108936. /**
  108937. * Helps to define how blurry the reflections should appears in the material.
  108938. */
  108939. roughness: number;
  108940. /**
  108941. * In case of refraction, define the value of the index of refraction.
  108942. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  108943. */
  108944. indexOfRefraction: number;
  108945. /**
  108946. * Invert the refraction texture alongside the y axis.
  108947. * It can be useful with procedural textures or probe for instance.
  108948. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  108949. */
  108950. invertRefractionY: boolean;
  108951. /**
  108952. * Defines the alpha limits in alpha test mode.
  108953. */
  108954. alphaCutOff: number;
  108955. private _useLightmapAsShadowmap;
  108956. /**
  108957. * In case of light mapping, define whether the map contains light or shadow informations.
  108958. */
  108959. useLightmapAsShadowmap: boolean;
  108960. private _diffuseFresnelParameters;
  108961. /**
  108962. * Define the diffuse fresnel parameters of the material.
  108963. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  108964. */
  108965. diffuseFresnelParameters: FresnelParameters;
  108966. private _opacityFresnelParameters;
  108967. /**
  108968. * Define the opacity fresnel parameters of the material.
  108969. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  108970. */
  108971. opacityFresnelParameters: FresnelParameters;
  108972. private _reflectionFresnelParameters;
  108973. /**
  108974. * Define the reflection fresnel parameters of the material.
  108975. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  108976. */
  108977. reflectionFresnelParameters: FresnelParameters;
  108978. private _refractionFresnelParameters;
  108979. /**
  108980. * Define the refraction fresnel parameters of the material.
  108981. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  108982. */
  108983. refractionFresnelParameters: FresnelParameters;
  108984. private _emissiveFresnelParameters;
  108985. /**
  108986. * Define the emissive fresnel parameters of the material.
  108987. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  108988. */
  108989. emissiveFresnelParameters: FresnelParameters;
  108990. private _useReflectionFresnelFromSpecular;
  108991. /**
  108992. * If true automatically deducts the fresnels values from the material specularity.
  108993. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  108994. */
  108995. useReflectionFresnelFromSpecular: boolean;
  108996. private _useGlossinessFromSpecularMapAlpha;
  108997. /**
  108998. * Defines if the glossiness/roughness of the material should be read from the specular map alpha channel
  108999. */
  109000. useGlossinessFromSpecularMapAlpha: boolean;
  109001. private _maxSimultaneousLights;
  109002. /**
  109003. * Defines the maximum number of lights that can be used in the material
  109004. */
  109005. maxSimultaneousLights: number;
  109006. private _invertNormalMapX;
  109007. /**
  109008. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  109009. */
  109010. invertNormalMapX: boolean;
  109011. private _invertNormalMapY;
  109012. /**
  109013. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  109014. */
  109015. invertNormalMapY: boolean;
  109016. private _twoSidedLighting;
  109017. /**
  109018. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  109019. */
  109020. twoSidedLighting: boolean;
  109021. /**
  109022. * Default configuration related to image processing available in the standard Material.
  109023. */
  109024. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  109025. /**
  109026. * Gets the image processing configuration used either in this material.
  109027. */
  109028. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  109029. /**
  109030. * Sets the Default image processing configuration used either in the this material.
  109031. *
  109032. * If sets to null, the scene one is in use.
  109033. */
  109034. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  109035. /**
  109036. * Keep track of the image processing observer to allow dispose and replace.
  109037. */
  109038. private _imageProcessingObserver;
  109039. /**
  109040. * Attaches a new image processing configuration to the Standard Material.
  109041. * @param configuration
  109042. */
  109043. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  109044. /**
  109045. * Gets wether the color curves effect is enabled.
  109046. */
  109047. get cameraColorCurvesEnabled(): boolean;
  109048. /**
  109049. * Sets wether the color curves effect is enabled.
  109050. */
  109051. set cameraColorCurvesEnabled(value: boolean);
  109052. /**
  109053. * Gets wether the color grading effect is enabled.
  109054. */
  109055. get cameraColorGradingEnabled(): boolean;
  109056. /**
  109057. * Gets wether the color grading effect is enabled.
  109058. */
  109059. set cameraColorGradingEnabled(value: boolean);
  109060. /**
  109061. * Gets wether tonemapping is enabled or not.
  109062. */
  109063. get cameraToneMappingEnabled(): boolean;
  109064. /**
  109065. * Sets wether tonemapping is enabled or not
  109066. */
  109067. set cameraToneMappingEnabled(value: boolean);
  109068. /**
  109069. * The camera exposure used on this material.
  109070. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  109071. * This corresponds to a photographic exposure.
  109072. */
  109073. get cameraExposure(): number;
  109074. /**
  109075. * The camera exposure used on this material.
  109076. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  109077. * This corresponds to a photographic exposure.
  109078. */
  109079. set cameraExposure(value: number);
  109080. /**
  109081. * Gets The camera contrast used on this material.
  109082. */
  109083. get cameraContrast(): number;
  109084. /**
  109085. * Sets The camera contrast used on this material.
  109086. */
  109087. set cameraContrast(value: number);
  109088. /**
  109089. * Gets the Color Grading 2D Lookup Texture.
  109090. */
  109091. get cameraColorGradingTexture(): Nullable<BaseTexture>;
  109092. /**
  109093. * Sets the Color Grading 2D Lookup Texture.
  109094. */
  109095. set cameraColorGradingTexture(value: Nullable<BaseTexture>);
  109096. /**
  109097. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  109098. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  109099. * 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;
  109100. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  109101. */
  109102. get cameraColorCurves(): Nullable<ColorCurves>;
  109103. /**
  109104. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  109105. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  109106. * 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;
  109107. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  109108. */
  109109. set cameraColorCurves(value: Nullable<ColorCurves>);
  109110. /**
  109111. * Can this material render to several textures at once
  109112. */
  109113. get canRenderToMRT(): boolean;
  109114. /**
  109115. * Defines the detail map parameters for the material.
  109116. */
  109117. readonly detailMap: DetailMapConfiguration;
  109118. protected _renderTargets: SmartArray<RenderTargetTexture>;
  109119. protected _worldViewProjectionMatrix: Matrix;
  109120. protected _globalAmbientColor: Color3;
  109121. protected _useLogarithmicDepth: boolean;
  109122. protected _rebuildInParallel: boolean;
  109123. /**
  109124. * Instantiates a new standard material.
  109125. * This is the default material used in Babylon. It is the best trade off between quality
  109126. * and performances.
  109127. * @see https://doc.babylonjs.com/babylon101/materials
  109128. * @param name Define the name of the material in the scene
  109129. * @param scene Define the scene the material belong to
  109130. */
  109131. constructor(name: string, scene: Scene);
  109132. /**
  109133. * Gets a boolean indicating that current material needs to register RTT
  109134. */
  109135. get hasRenderTargetTextures(): boolean;
  109136. /**
  109137. * Gets the current class name of the material e.g. "StandardMaterial"
  109138. * Mainly use in serialization.
  109139. * @returns the class name
  109140. */
  109141. getClassName(): string;
  109142. /**
  109143. * In case the depth buffer does not allow enough depth precision for your scene (might be the case in large scenes)
  109144. * You can try switching to logarithmic depth.
  109145. * @see https://doc.babylonjs.com/how_to/using_logarithmic_depth_buffer
  109146. */
  109147. get useLogarithmicDepth(): boolean;
  109148. set useLogarithmicDepth(value: boolean);
  109149. /**
  109150. * Specifies if the material will require alpha blending
  109151. * @returns a boolean specifying if alpha blending is needed
  109152. */
  109153. needAlphaBlending(): boolean;
  109154. /**
  109155. * Specifies if this material should be rendered in alpha test mode
  109156. * @returns a boolean specifying if an alpha test is needed.
  109157. */
  109158. needAlphaTesting(): boolean;
  109159. protected _shouldUseAlphaFromDiffuseTexture(): boolean;
  109160. /**
  109161. * Get the texture used for alpha test purpose.
  109162. * @returns the diffuse texture in case of the standard material.
  109163. */
  109164. getAlphaTestTexture(): Nullable<BaseTexture>;
  109165. /**
  109166. * Get if the submesh is ready to be used and all its information available.
  109167. * Child classes can use it to update shaders
  109168. * @param mesh defines the mesh to check
  109169. * @param subMesh defines which submesh to check
  109170. * @param useInstances specifies that instances should be used
  109171. * @returns a boolean indicating that the submesh is ready or not
  109172. */
  109173. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  109174. /**
  109175. * Builds the material UBO layouts.
  109176. * Used internally during the effect preparation.
  109177. */
  109178. buildUniformLayout(): void;
  109179. /**
  109180. * Unbinds the material from the mesh
  109181. */
  109182. unbind(): void;
  109183. /**
  109184. * Binds the submesh to this material by preparing the effect and shader to draw
  109185. * @param world defines the world transformation matrix
  109186. * @param mesh defines the mesh containing the submesh
  109187. * @param subMesh defines the submesh to bind the material to
  109188. */
  109189. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  109190. /**
  109191. * Get the list of animatables in the material.
  109192. * @returns the list of animatables object used in the material
  109193. */
  109194. getAnimatables(): IAnimatable[];
  109195. /**
  109196. * Gets the active textures from the material
  109197. * @returns an array of textures
  109198. */
  109199. getActiveTextures(): BaseTexture[];
  109200. /**
  109201. * Specifies if the material uses a texture
  109202. * @param texture defines the texture to check against the material
  109203. * @returns a boolean specifying if the material uses the texture
  109204. */
  109205. hasTexture(texture: BaseTexture): boolean;
  109206. /**
  109207. * Disposes the material
  109208. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  109209. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  109210. */
  109211. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  109212. /**
  109213. * Makes a duplicate of the material, and gives it a new name
  109214. * @param name defines the new name for the duplicated material
  109215. * @returns the cloned material
  109216. */
  109217. clone(name: string): StandardMaterial;
  109218. /**
  109219. * Serializes this material in a JSON representation
  109220. * @returns the serialized material object
  109221. */
  109222. serialize(): any;
  109223. /**
  109224. * Creates a standard material from parsed material data
  109225. * @param source defines the JSON representation of the material
  109226. * @param scene defines the hosting scene
  109227. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  109228. * @returns a new standard material
  109229. */
  109230. static Parse(source: any, scene: Scene, rootUrl: string): StandardMaterial;
  109231. /**
  109232. * Are diffuse textures enabled in the application.
  109233. */
  109234. static get DiffuseTextureEnabled(): boolean;
  109235. static set DiffuseTextureEnabled(value: boolean);
  109236. /**
  109237. * Are detail textures enabled in the application.
  109238. */
  109239. static get DetailTextureEnabled(): boolean;
  109240. static set DetailTextureEnabled(value: boolean);
  109241. /**
  109242. * Are ambient textures enabled in the application.
  109243. */
  109244. static get AmbientTextureEnabled(): boolean;
  109245. static set AmbientTextureEnabled(value: boolean);
  109246. /**
  109247. * Are opacity textures enabled in the application.
  109248. */
  109249. static get OpacityTextureEnabled(): boolean;
  109250. static set OpacityTextureEnabled(value: boolean);
  109251. /**
  109252. * Are reflection textures enabled in the application.
  109253. */
  109254. static get ReflectionTextureEnabled(): boolean;
  109255. static set ReflectionTextureEnabled(value: boolean);
  109256. /**
  109257. * Are emissive textures enabled in the application.
  109258. */
  109259. static get EmissiveTextureEnabled(): boolean;
  109260. static set EmissiveTextureEnabled(value: boolean);
  109261. /**
  109262. * Are specular textures enabled in the application.
  109263. */
  109264. static get SpecularTextureEnabled(): boolean;
  109265. static set SpecularTextureEnabled(value: boolean);
  109266. /**
  109267. * Are bump textures enabled in the application.
  109268. */
  109269. static get BumpTextureEnabled(): boolean;
  109270. static set BumpTextureEnabled(value: boolean);
  109271. /**
  109272. * Are lightmap textures enabled in the application.
  109273. */
  109274. static get LightmapTextureEnabled(): boolean;
  109275. static set LightmapTextureEnabled(value: boolean);
  109276. /**
  109277. * Are refraction textures enabled in the application.
  109278. */
  109279. static get RefractionTextureEnabled(): boolean;
  109280. static set RefractionTextureEnabled(value: boolean);
  109281. /**
  109282. * Are color grading textures enabled in the application.
  109283. */
  109284. static get ColorGradingTextureEnabled(): boolean;
  109285. static set ColorGradingTextureEnabled(value: boolean);
  109286. /**
  109287. * Are fresnels enabled in the application.
  109288. */
  109289. static get FresnelEnabled(): boolean;
  109290. static set FresnelEnabled(value: boolean);
  109291. }
  109292. }
  109293. declare module BABYLON {
  109294. /**
  109295. * The SPS is a single updatable mesh. The solid particles are simply separate parts or faces fo this big mesh.
  109296. *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.
  109297. * The SPS is also a particle system. It provides some methods to manage the particles.
  109298. * However it is behavior agnostic. This means it has no emitter, no particle physics, no particle recycler. You have to implement your own behavior.
  109299. *
  109300. * Full documentation here : https://doc.babylonjs.com/how_to/Solid_Particle_System
  109301. */
  109302. export class SolidParticleSystem implements IDisposable {
  109303. /**
  109304. * The SPS array of Solid Particle objects. Just access each particle as with any classic array.
  109305. * Example : var p = SPS.particles[i];
  109306. */
  109307. particles: SolidParticle[];
  109308. /**
  109309. * The SPS total number of particles. Read only. Use SPS.counter instead if you need to set your own value.
  109310. */
  109311. nbParticles: number;
  109312. /**
  109313. * If the particles must ever face the camera (default false). Useful for planar particles.
  109314. */
  109315. billboard: boolean;
  109316. /**
  109317. * Recompute normals when adding a shape
  109318. */
  109319. recomputeNormals: boolean;
  109320. /**
  109321. * This a counter ofr your own usage. It's not set by any SPS functions.
  109322. */
  109323. counter: number;
  109324. /**
  109325. * The SPS name. This name is also given to the underlying mesh.
  109326. */
  109327. name: string;
  109328. /**
  109329. * The SPS mesh. It's a standard BJS Mesh, so all the methods from the Mesh class are avalaible.
  109330. */
  109331. mesh: Mesh;
  109332. /**
  109333. * This empty object is intended to store some SPS specific or temporary values in order to lower the Garbage Collector activity.
  109334. * Please read : https://doc.babylonjs.com/how_to/Solid_Particle_System#garbage-collector-concerns
  109335. */
  109336. vars: any;
  109337. /**
  109338. * This array is populated when the SPS is set as 'pickable'.
  109339. * Each key of this array is a `faceId` value that you can get from a pickResult object.
  109340. * Each element of this array is an object `{idx: int, faceId: int}`.
  109341. * `idx` is the picked particle index in the `SPS.particles` array
  109342. * `faceId` is the picked face index counted within this particle.
  109343. * This array is the first element of the pickedBySubMesh array : sps.pickBySubMesh[0].
  109344. * It's not pertinent to use it when using a SPS with the support for MultiMaterial enabled.
  109345. * Use the method SPS.pickedParticle(pickingInfo) instead.
  109346. * Please read : https://doc.babylonjs.com/how_to/Solid_Particle_System#pickable-particles
  109347. */
  109348. pickedParticles: {
  109349. idx: number;
  109350. faceId: number;
  109351. }[];
  109352. /**
  109353. * This array is populated when the SPS is set as 'pickable'
  109354. * Each key of this array is a submesh index.
  109355. * Each element of this array is a second array defined like this :
  109356. * Each key of this second array is a `faceId` value that you can get from a pickResult object.
  109357. * Each element of this second array is an object `{idx: int, faceId: int}`.
  109358. * `idx` is the picked particle index in the `SPS.particles` array
  109359. * `faceId` is the picked face index counted within this particle.
  109360. * It's better to use the method SPS.pickedParticle(pickingInfo) rather than using directly this array.
  109361. * Please read : https://doc.babylonjs.com/how_to/Solid_Particle_System#pickable-particles
  109362. */
  109363. pickedBySubMesh: {
  109364. idx: number;
  109365. faceId: number;
  109366. }[][];
  109367. /**
  109368. * This array is populated when `enableDepthSort` is set to true.
  109369. * Each element of this array is an instance of the class DepthSortedParticle.
  109370. */
  109371. depthSortedParticles: DepthSortedParticle[];
  109372. /**
  109373. * If the particle intersection must be computed only with the bounding sphere (no bounding box computation, so faster). (Internal use only)
  109374. * @hidden
  109375. */
  109376. _bSphereOnly: boolean;
  109377. /**
  109378. * A number to multiply the boundind sphere radius by in order to reduce it for instance. (Internal use only)
  109379. * @hidden
  109380. */
  109381. _bSphereRadiusFactor: number;
  109382. private _scene;
  109383. private _positions;
  109384. private _indices;
  109385. private _normals;
  109386. private _colors;
  109387. private _uvs;
  109388. private _indices32;
  109389. private _positions32;
  109390. private _normals32;
  109391. private _fixedNormal32;
  109392. private _colors32;
  109393. private _uvs32;
  109394. private _index;
  109395. private _updatable;
  109396. private _pickable;
  109397. private _isVisibilityBoxLocked;
  109398. private _alwaysVisible;
  109399. private _depthSort;
  109400. private _expandable;
  109401. private _shapeCounter;
  109402. private _copy;
  109403. private _color;
  109404. private _computeParticleColor;
  109405. private _computeParticleTexture;
  109406. private _computeParticleRotation;
  109407. private _computeParticleVertex;
  109408. private _computeBoundingBox;
  109409. private _depthSortParticles;
  109410. private _camera;
  109411. private _mustUnrotateFixedNormals;
  109412. private _particlesIntersect;
  109413. private _needs32Bits;
  109414. private _isNotBuilt;
  109415. private _lastParticleId;
  109416. private _idxOfId;
  109417. private _multimaterialEnabled;
  109418. private _useModelMaterial;
  109419. private _indicesByMaterial;
  109420. private _materialIndexes;
  109421. private _depthSortFunction;
  109422. private _materialSortFunction;
  109423. private _materials;
  109424. private _multimaterial;
  109425. private _materialIndexesById;
  109426. private _defaultMaterial;
  109427. private _autoUpdateSubMeshes;
  109428. private _tmpVertex;
  109429. /**
  109430. * Creates a SPS (Solid Particle System) object.
  109431. * @param name (String) is the SPS name, this will be the underlying mesh name.
  109432. * @param scene (Scene) is the scene in which the SPS is added.
  109433. * @param options defines the options of the sps e.g.
  109434. * * updatable (optional boolean, default true) : if the SPS must be updatable or immutable.
  109435. * * isPickable (optional boolean, default false) : if the solid particles must be pickable.
  109436. * * enableDepthSort (optional boolean, default false) : if the solid particles must be sorted in the geometry according to their distance to the camera.
  109437. * * 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.
  109438. * * enableMultiMaterial (optional boolean, default false) : if the solid particles can be given different materials.
  109439. * * expandable (optional boolean, default false) : if particles can still be added after the initial SPS mesh creation.
  109440. * * particleIntersection (optional boolean, default false) : if the solid particle intersections must be computed.
  109441. * * boundingSphereOnly (optional boolean, default false) : if the particle intersection must be computed only with the bounding sphere (no bounding box computation, so faster).
  109442. * * bSphereRadiusFactor (optional float, default 1.0) : a number to multiply the boundind sphere radius by in order to reduce it for instance.
  109443. * @example bSphereRadiusFactor = 1.0 / Math.sqrt(3.0) => the bounding sphere exactly matches a spherical mesh.
  109444. */
  109445. constructor(name: string, scene: Scene, options?: {
  109446. updatable?: boolean;
  109447. isPickable?: boolean;
  109448. enableDepthSort?: boolean;
  109449. particleIntersection?: boolean;
  109450. boundingSphereOnly?: boolean;
  109451. bSphereRadiusFactor?: number;
  109452. expandable?: boolean;
  109453. useModelMaterial?: boolean;
  109454. enableMultiMaterial?: boolean;
  109455. });
  109456. /**
  109457. * Builds the SPS underlying mesh. Returns a standard Mesh.
  109458. * If no model shape was added to the SPS, the returned mesh is just a single triangular plane.
  109459. * @returns the created mesh
  109460. */
  109461. buildMesh(): Mesh;
  109462. /**
  109463. * Digests the mesh and generates as many solid particles in the system as wanted. Returns the SPS.
  109464. * These particles will have the same geometry than the mesh parts and will be positioned at the same localisation than the mesh original places.
  109465. * Thus the particles generated from `digest()` have their property `position` set yet.
  109466. * @param mesh ( Mesh ) is the mesh to be digested
  109467. * @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
  109468. * {delta} (optional integer, default 0) is the random extra number of facets per particle , each particle will have between `facetNb` and `facetNb + delta` facets
  109469. * {number} (optional positive integer) is the wanted number of particles : each particle is built with `mesh_total_facets / number` facets
  109470. * {storage} (optional existing array) is an array where the particles will be stored for a further use instead of being inserted in the SPS.
  109471. * @returns the current SPS
  109472. */
  109473. digest(mesh: Mesh, options?: {
  109474. facetNb?: number;
  109475. number?: number;
  109476. delta?: number;
  109477. storage?: [];
  109478. }): SolidParticleSystem;
  109479. /**
  109480. * Unrotate the fixed normals in case the mesh was built with pre-rotated particles, ex : use of positionFunction in addShape()
  109481. * @hidden
  109482. */
  109483. private _unrotateFixedNormals;
  109484. /**
  109485. * Resets the temporary working copy particle
  109486. * @hidden
  109487. */
  109488. private _resetCopy;
  109489. /**
  109490. * Inserts the shape model geometry in the global SPS mesh by updating the positions, indices, normals, colors, uvs arrays
  109491. * @param p the current index in the positions array to be updated
  109492. * @param ind the current index in the indices array
  109493. * @param shape a Vector3 array, the shape geometry
  109494. * @param positions the positions array to be updated
  109495. * @param meshInd the shape indices array
  109496. * @param indices the indices array to be updated
  109497. * @param meshUV the shape uv array
  109498. * @param uvs the uv array to be updated
  109499. * @param meshCol the shape color array
  109500. * @param colors the color array to be updated
  109501. * @param meshNor the shape normals array
  109502. * @param normals the normals array to be updated
  109503. * @param idx the particle index
  109504. * @param idxInShape the particle index in its shape
  109505. * @param options the addShape() method passed options
  109506. * @model the particle model
  109507. * @hidden
  109508. */
  109509. private _meshBuilder;
  109510. /**
  109511. * Returns a shape Vector3 array from positions float array
  109512. * @param positions float array
  109513. * @returns a vector3 array
  109514. * @hidden
  109515. */
  109516. private _posToShape;
  109517. /**
  109518. * Returns a shapeUV array from a float uvs (array deep copy)
  109519. * @param uvs as a float array
  109520. * @returns a shapeUV array
  109521. * @hidden
  109522. */
  109523. private _uvsToShapeUV;
  109524. /**
  109525. * Adds a new particle object in the particles array
  109526. * @param idx particle index in particles array
  109527. * @param id particle id
  109528. * @param idxpos positionIndex : the starting index of the particle vertices in the SPS "positions" array
  109529. * @param idxind indiceIndex : he starting index of the particle indices in the SPS "indices" array
  109530. * @param model particle ModelShape object
  109531. * @param shapeId model shape identifier
  109532. * @param idxInShape index of the particle in the current model
  109533. * @param bInfo model bounding info object
  109534. * @param storage target storage array, if any
  109535. * @hidden
  109536. */
  109537. private _addParticle;
  109538. /**
  109539. * Adds some particles to the SPS from the model shape. Returns the shape id.
  109540. * Please read the doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#create-an-immutable-sps
  109541. * @param mesh is any Mesh object that will be used as a model for the solid particles.
  109542. * @param nb (positive integer) the number of particles to be created from this model
  109543. * @param options {positionFunction} is an optional javascript function to called for each particle on SPS creation.
  109544. * {vertexFunction} is an optional javascript function to called for each vertex of each particle on SPS creation
  109545. * {storage} (optional existing array) is an array where the particles will be stored for a further use instead of being inserted in the SPS.
  109546. * @returns the number of shapes in the system
  109547. */
  109548. addShape(mesh: Mesh, nb: number, options?: {
  109549. positionFunction?: any;
  109550. vertexFunction?: any;
  109551. storage?: [];
  109552. }): number;
  109553. /**
  109554. * Rebuilds a particle back to its just built status : if needed, recomputes the custom positions and vertices
  109555. * @hidden
  109556. */
  109557. private _rebuildParticle;
  109558. /**
  109559. * Rebuilds the whole mesh and updates the VBO : custom positions and vertices are recomputed if needed.
  109560. * @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.
  109561. * @returns the SPS.
  109562. */
  109563. rebuildMesh(reset?: boolean): SolidParticleSystem;
  109564. /** Removes the particles from the start-th to the end-th included from an expandable SPS (required).
  109565. * Returns an array with the removed particles.
  109566. * 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.
  109567. * The SPS can't be empty so at least one particle needs to remain in place.
  109568. * Under the hood, the VertexData array, so the VBO buffer, is recreated each call.
  109569. * @param start index of the first particle to remove
  109570. * @param end index of the last particle to remove (included)
  109571. * @returns an array populated with the removed particles
  109572. */
  109573. removeParticles(start: number, end: number): SolidParticle[];
  109574. /**
  109575. * Inserts some pre-created particles in the solid particle system so that they can be managed by setParticles().
  109576. * @param solidParticleArray an array populated with Solid Particles objects
  109577. * @returns the SPS
  109578. */
  109579. insertParticlesFromArray(solidParticleArray: SolidParticle[]): SolidParticleSystem;
  109580. /**
  109581. * Creates a new particle and modifies the SPS mesh geometry :
  109582. * - calls _meshBuilder() to increase the SPS mesh geometry step by step
  109583. * - calls _addParticle() to populate the particle array
  109584. * factorized code from addShape() and insertParticlesFromArray()
  109585. * @param idx particle index in the particles array
  109586. * @param i particle index in its shape
  109587. * @param modelShape particle ModelShape object
  109588. * @param shape shape vertex array
  109589. * @param meshInd shape indices array
  109590. * @param meshUV shape uv array
  109591. * @param meshCol shape color array
  109592. * @param meshNor shape normals array
  109593. * @param bbInfo shape bounding info
  109594. * @param storage target particle storage
  109595. * @options addShape() passed options
  109596. * @hidden
  109597. */
  109598. private _insertNewParticle;
  109599. /**
  109600. * Sets all the particles : this method actually really updates the mesh according to the particle positions, rotations, colors, textures, etc.
  109601. * This method calls `updateParticle()` for each particle of the SPS.
  109602. * For an animated SPS, it is usually called within the render loop.
  109603. * 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.
  109604. * @param start The particle index in the particle array where to start to compute the particle property values _(default 0)_
  109605. * @param end The particle index in the particle array where to stop to compute the particle property values _(default nbParticle - 1)_
  109606. * @param update If the mesh must be finally updated on this call after all the particle computations _(default true)_
  109607. * @returns the SPS.
  109608. */
  109609. setParticles(start?: number, end?: number, update?: boolean): SolidParticleSystem;
  109610. /**
  109611. * Disposes the SPS.
  109612. */
  109613. dispose(): void;
  109614. /** Returns an object {idx: numbern faceId: number} for the picked particle from the passed pickingInfo object.
  109615. * idx is the particle index in the SPS
  109616. * faceId is the picked face index counted within this particle.
  109617. * Returns null if the pickInfo can't identify a picked particle.
  109618. * @param pickingInfo (PickingInfo object)
  109619. * @returns {idx: number, faceId: number} or null
  109620. */
  109621. pickedParticle(pickingInfo: PickingInfo): Nullable<{
  109622. idx: number;
  109623. faceId: number;
  109624. }>;
  109625. /**
  109626. * Returns a SolidParticle object from its identifier : particle.id
  109627. * @param id (integer) the particle Id
  109628. * @returns the searched particle or null if not found in the SPS.
  109629. */
  109630. getParticleById(id: number): Nullable<SolidParticle>;
  109631. /**
  109632. * Returns a new array populated with the particles having the passed shapeId.
  109633. * @param shapeId (integer) the shape identifier
  109634. * @returns a new solid particle array
  109635. */
  109636. getParticlesByShapeId(shapeId: number): SolidParticle[];
  109637. /**
  109638. * Populates the passed array "ref" with the particles having the passed shapeId.
  109639. * @param shapeId the shape identifier
  109640. * @returns the SPS
  109641. * @param ref
  109642. */
  109643. getParticlesByShapeIdToRef(shapeId: number, ref: SolidParticle[]): SolidParticleSystem;
  109644. /**
  109645. * Computes the required SubMeshes according the materials assigned to the particles.
  109646. * @returns the solid particle system.
  109647. * Does nothing if called before the SPS mesh is built.
  109648. */
  109649. computeSubMeshes(): SolidParticleSystem;
  109650. /**
  109651. * Sorts the solid particles by material when MultiMaterial is enabled.
  109652. * Updates the indices32 array.
  109653. * Updates the indicesByMaterial array.
  109654. * Updates the mesh indices array.
  109655. * @returns the SPS
  109656. * @hidden
  109657. */
  109658. private _sortParticlesByMaterial;
  109659. /**
  109660. * Sets the material indexes by id materialIndexesById[id] = materialIndex
  109661. * @hidden
  109662. */
  109663. private _setMaterialIndexesById;
  109664. /**
  109665. * Returns an array with unique values of Materials from the passed array
  109666. * @param array the material array to be checked and filtered
  109667. * @hidden
  109668. */
  109669. private _filterUniqueMaterialId;
  109670. /**
  109671. * Sets a new Standard Material as _defaultMaterial if not already set.
  109672. * @hidden
  109673. */
  109674. private _setDefaultMaterial;
  109675. /**
  109676. * Visibilty helper : Recomputes the visible size according to the mesh bounding box
  109677. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  109678. * @returns the SPS.
  109679. */
  109680. refreshVisibleSize(): SolidParticleSystem;
  109681. /**
  109682. * Visibility helper : Sets the size of a visibility box, this sets the underlying mesh bounding box.
  109683. * @param size the size (float) of the visibility box
  109684. * note : this doesn't lock the SPS mesh bounding box.
  109685. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  109686. */
  109687. setVisibilityBox(size: number): void;
  109688. /**
  109689. * Gets whether the SPS as always visible or not
  109690. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  109691. */
  109692. get isAlwaysVisible(): boolean;
  109693. /**
  109694. * Sets the SPS as always visible or not
  109695. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  109696. */
  109697. set isAlwaysVisible(val: boolean);
  109698. /**
  109699. * Sets the SPS visibility box as locked or not. This enables/disables the underlying mesh bounding box updates.
  109700. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  109701. */
  109702. set isVisibilityBoxLocked(val: boolean);
  109703. /**
  109704. * Gets if the SPS visibility box as locked or not. This enables/disables the underlying mesh bounding box updates.
  109705. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  109706. */
  109707. get isVisibilityBoxLocked(): boolean;
  109708. /**
  109709. * Tells to `setParticles()` to compute the particle rotations or not.
  109710. * Default value : true. The SPS is faster when it's set to false.
  109711. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate.
  109712. */
  109713. set computeParticleRotation(val: boolean);
  109714. /**
  109715. * Tells to `setParticles()` to compute the particle colors or not.
  109716. * Default value : true. The SPS is faster when it's set to false.
  109717. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  109718. */
  109719. set computeParticleColor(val: boolean);
  109720. set computeParticleTexture(val: boolean);
  109721. /**
  109722. * Tells to `setParticles()` to call the vertex function for each vertex of each particle, or not.
  109723. * Default value : false. The SPS is faster when it's set to false.
  109724. * Note : the particle custom vertex positions aren't stored values.
  109725. */
  109726. set computeParticleVertex(val: boolean);
  109727. /**
  109728. * Tells to `setParticles()` to compute or not the mesh bounding box when computing the particle positions.
  109729. */
  109730. set computeBoundingBox(val: boolean);
  109731. /**
  109732. * Tells to `setParticles()` to sort or not the distance between each particle and the camera.
  109733. * Skipped when `enableDepthSort` is set to `false` (default) at construction time.
  109734. * Default : `true`
  109735. */
  109736. set depthSortParticles(val: boolean);
  109737. /**
  109738. * Gets if `setParticles()` computes the particle rotations or not.
  109739. * Default value : true. The SPS is faster when it's set to false.
  109740. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate.
  109741. */
  109742. get computeParticleRotation(): boolean;
  109743. /**
  109744. * Gets if `setParticles()` computes the particle colors or not.
  109745. * Default value : true. The SPS is faster when it's set to false.
  109746. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  109747. */
  109748. get computeParticleColor(): boolean;
  109749. /**
  109750. * Gets if `setParticles()` computes the particle textures or not.
  109751. * Default value : true. The SPS is faster when it's set to false.
  109752. * Note : the particle textures are stored values, so setting `computeParticleTexture` to false will keep yet the last colors set.
  109753. */
  109754. get computeParticleTexture(): boolean;
  109755. /**
  109756. * Gets if `setParticles()` calls the vertex function for each vertex of each particle, or not.
  109757. * Default value : false. The SPS is faster when it's set to false.
  109758. * Note : the particle custom vertex positions aren't stored values.
  109759. */
  109760. get computeParticleVertex(): boolean;
  109761. /**
  109762. * Gets if `setParticles()` computes or not the mesh bounding box when computing the particle positions.
  109763. */
  109764. get computeBoundingBox(): boolean;
  109765. /**
  109766. * Gets if `setParticles()` sorts or not the distance between each particle and the camera.
  109767. * Skipped when `enableDepthSort` is set to `false` (default) at construction time.
  109768. * Default : `true`
  109769. */
  109770. get depthSortParticles(): boolean;
  109771. /**
  109772. * Gets if the SPS is created as expandable at construction time.
  109773. * Default : `false`
  109774. */
  109775. get expandable(): boolean;
  109776. /**
  109777. * Gets if the SPS supports the Multi Materials
  109778. */
  109779. get multimaterialEnabled(): boolean;
  109780. /**
  109781. * Gets if the SPS uses the model materials for its own multimaterial.
  109782. */
  109783. get useModelMaterial(): boolean;
  109784. /**
  109785. * The SPS used material array.
  109786. */
  109787. get materials(): Material[];
  109788. /**
  109789. * Sets the SPS MultiMaterial from the passed materials.
  109790. * Note : the passed array is internally copied and not used then by reference.
  109791. * @param materials an array of material objects. This array indexes are the materialIndex values of the particles.
  109792. */
  109793. setMultiMaterial(materials: Material[]): void;
  109794. /**
  109795. * The SPS computed multimaterial object
  109796. */
  109797. get multimaterial(): MultiMaterial;
  109798. set multimaterial(mm: MultiMaterial);
  109799. /**
  109800. * If the subMeshes must be updated on the next call to setParticles()
  109801. */
  109802. get autoUpdateSubMeshes(): boolean;
  109803. set autoUpdateSubMeshes(val: boolean);
  109804. /**
  109805. * This function does nothing. It may be overwritten to set all the particle first values.
  109806. * The SPS doesn't call this function, you may have to call it by your own.
  109807. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  109808. */
  109809. initParticles(): void;
  109810. /**
  109811. * This function does nothing. It may be overwritten to recycle a particle.
  109812. * The SPS doesn't call this function, you may have to call it by your own.
  109813. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  109814. * @param particle The particle to recycle
  109815. * @returns the recycled particle
  109816. */
  109817. recycleParticle(particle: SolidParticle): SolidParticle;
  109818. /**
  109819. * Updates a particle : this function should be overwritten by the user.
  109820. * It is called on each particle by `setParticles()`. This is the place to code each particle behavior.
  109821. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  109822. * @example : just set a particle position or velocity and recycle conditions
  109823. * @param particle The particle to update
  109824. * @returns the updated particle
  109825. */
  109826. updateParticle(particle: SolidParticle): SolidParticle;
  109827. /**
  109828. * Updates a vertex of a particle : it can be overwritten by the user.
  109829. * This will be called on each vertex particle by `setParticles()` if `computeParticleVertex` is set to true only.
  109830. * @param particle the current particle
  109831. * @param vertex the current vertex of the current particle : a SolidParticleVertex object
  109832. * @param pt the index of the current vertex in the particle shape
  109833. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#update-each-particle-shape
  109834. * @example : just set a vertex particle position or color
  109835. * @returns the sps
  109836. */
  109837. updateParticleVertex(particle: SolidParticle, vertex: SolidParticleVertex, pt: number): SolidParticleSystem;
  109838. /**
  109839. * This will be called before any other treatment by `setParticles()` and will be passed three parameters.
  109840. * This does nothing and may be overwritten by the user.
  109841. * @param start the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  109842. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  109843. * @param update the boolean update value actually passed to setParticles()
  109844. */
  109845. beforeUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  109846. /**
  109847. * This will be called by `setParticles()` after all the other treatments and just before the actual mesh update.
  109848. * This will be passed three parameters.
  109849. * This does nothing and may be overwritten by the user.
  109850. * @param start the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  109851. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  109852. * @param update the boolean update value actually passed to setParticles()
  109853. */
  109854. afterUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  109855. }
  109856. }
  109857. declare module BABYLON {
  109858. /**
  109859. * Represents one particle of a solid particle system.
  109860. */
  109861. export class SolidParticle {
  109862. /**
  109863. * particle global index
  109864. */
  109865. idx: number;
  109866. /**
  109867. * particle identifier
  109868. */
  109869. id: number;
  109870. /**
  109871. * The color of the particle
  109872. */
  109873. color: Nullable<Color4>;
  109874. /**
  109875. * The world space position of the particle.
  109876. */
  109877. position: Vector3;
  109878. /**
  109879. * The world space rotation of the particle. (Not use if rotationQuaternion is set)
  109880. */
  109881. rotation: Vector3;
  109882. /**
  109883. * The world space rotation quaternion of the particle.
  109884. */
  109885. rotationQuaternion: Nullable<Quaternion>;
  109886. /**
  109887. * The scaling of the particle.
  109888. */
  109889. scaling: Vector3;
  109890. /**
  109891. * The uvs of the particle.
  109892. */
  109893. uvs: Vector4;
  109894. /**
  109895. * The current speed of the particle.
  109896. */
  109897. velocity: Vector3;
  109898. /**
  109899. * The pivot point in the particle local space.
  109900. */
  109901. pivot: Vector3;
  109902. /**
  109903. * Must the particle be translated from its pivot point in its local space ?
  109904. * In this case, the pivot point is set at the origin of the particle local space and the particle is translated.
  109905. * Default : false
  109906. */
  109907. translateFromPivot: boolean;
  109908. /**
  109909. * Is the particle active or not ?
  109910. */
  109911. alive: boolean;
  109912. /**
  109913. * Is the particle visible or not ?
  109914. */
  109915. isVisible: boolean;
  109916. /**
  109917. * Index of this particle in the global "positions" array (Internal use)
  109918. * @hidden
  109919. */
  109920. _pos: number;
  109921. /**
  109922. * @hidden Index of this particle in the global "indices" array (Internal use)
  109923. */
  109924. _ind: number;
  109925. /**
  109926. * @hidden ModelShape of this particle (Internal use)
  109927. */
  109928. _model: ModelShape;
  109929. /**
  109930. * ModelShape id of this particle
  109931. */
  109932. shapeId: number;
  109933. /**
  109934. * Index of the particle in its shape id
  109935. */
  109936. idxInShape: number;
  109937. /**
  109938. * @hidden Reference to the shape model BoundingInfo object (Internal use)
  109939. */
  109940. _modelBoundingInfo: BoundingInfo;
  109941. /**
  109942. * @hidden Particle BoundingInfo object (Internal use)
  109943. */
  109944. _boundingInfo: BoundingInfo;
  109945. /**
  109946. * @hidden Reference to the SPS what the particle belongs to (Internal use)
  109947. */
  109948. _sps: SolidParticleSystem;
  109949. /**
  109950. * @hidden Still set as invisible in order to skip useless computations (Internal use)
  109951. */
  109952. _stillInvisible: boolean;
  109953. /**
  109954. * @hidden Last computed particle rotation matrix
  109955. */
  109956. _rotationMatrix: number[];
  109957. /**
  109958. * Parent particle Id, if any.
  109959. * Default null.
  109960. */
  109961. parentId: Nullable<number>;
  109962. /**
  109963. * The particle material identifier (integer) when MultiMaterials are enabled in the SPS.
  109964. */
  109965. materialIndex: Nullable<number>;
  109966. /**
  109967. * Custom object or properties.
  109968. */
  109969. props: Nullable<any>;
  109970. /**
  109971. * The culling strategy to use to check whether the solid particle must be culled or not when using isInFrustum().
  109972. * The possible values are :
  109973. * - AbstractMesh.CULLINGSTRATEGY_STANDARD
  109974. * - AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  109975. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION
  109976. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY
  109977. * The default value for solid particles is AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  109978. * Please read each static variable documentation in the class AbstractMesh to get details about the culling process.
  109979. * */
  109980. cullingStrategy: number;
  109981. /**
  109982. * @hidden Internal global position in the SPS.
  109983. */
  109984. _globalPosition: Vector3;
  109985. /**
  109986. * Creates a Solid Particle object.
  109987. * Don't create particles manually, use instead the Solid Particle System internal tools like _addParticle()
  109988. * @param particleIndex (integer) is the particle index in the Solid Particle System pool.
  109989. * @param particleId (integer) is the particle identifier. Unless some particles are removed from the SPS, it's the same value than the particle idx.
  109990. * @param positionIndex (integer) is the starting index of the particle vertices in the SPS "positions" array.
  109991. * @param indiceIndex (integer) is the starting index of the particle indices in the SPS "indices" array.
  109992. * @param model (ModelShape) is a reference to the model shape on what the particle is designed.
  109993. * @param shapeId (integer) is the model shape identifier in the SPS.
  109994. * @param idxInShape (integer) is the index of the particle in the current model (ex: the 10th box of addShape(box, 30))
  109995. * @param sps defines the sps it is associated to
  109996. * @param modelBoundingInfo is the reference to the model BoundingInfo used for intersection computations.
  109997. * @param materialIndex is the particle material identifier (integer) when the MultiMaterials are enabled in the SPS.
  109998. */
  109999. constructor(particleIndex: number, particleId: number, positionIndex: number, indiceIndex: number, model: Nullable<ModelShape>, shapeId: number, idxInShape: number, sps: SolidParticleSystem, modelBoundingInfo?: Nullable<BoundingInfo>, materialIndex?: Nullable<number>);
  110000. /**
  110001. * Copies the particle property values into the existing target : position, rotation, scaling, uvs, colors, pivot, parent, visibility, alive
  110002. * @param target the particle target
  110003. * @returns the current particle
  110004. */
  110005. copyToRef(target: SolidParticle): SolidParticle;
  110006. /**
  110007. * Legacy support, changed scale to scaling
  110008. */
  110009. get scale(): Vector3;
  110010. /**
  110011. * Legacy support, changed scale to scaling
  110012. */
  110013. set scale(scale: Vector3);
  110014. /**
  110015. * Legacy support, changed quaternion to rotationQuaternion
  110016. */
  110017. get quaternion(): Nullable<Quaternion>;
  110018. /**
  110019. * Legacy support, changed quaternion to rotationQuaternion
  110020. */
  110021. set quaternion(q: Nullable<Quaternion>);
  110022. /**
  110023. * Returns a boolean. True if the particle intersects another particle or another mesh, else false.
  110024. * The intersection is computed on the particle bounding sphere and Axis Aligned Bounding Box (AABB)
  110025. * @param target is the object (solid particle or mesh) what the intersection is computed against.
  110026. * @returns true if it intersects
  110027. */
  110028. intersectsMesh(target: Mesh | SolidParticle): boolean;
  110029. /**
  110030. * Returns `true` if the solid particle is within the frustum defined by the passed array of planes.
  110031. * A particle is in the frustum if its bounding box intersects the frustum
  110032. * @param frustumPlanes defines the frustum to test
  110033. * @returns true if the particle is in the frustum planes
  110034. */
  110035. isInFrustum(frustumPlanes: Plane[]): boolean;
  110036. /**
  110037. * get the rotation matrix of the particle
  110038. * @hidden
  110039. */
  110040. getRotationMatrix(m: Matrix): void;
  110041. }
  110042. /**
  110043. * Represents the shape of the model used by one particle of a solid particle system.
  110044. * SPS internal tool, don't use it manually.
  110045. */
  110046. export class ModelShape {
  110047. /**
  110048. * The shape id
  110049. * @hidden
  110050. */
  110051. shapeID: number;
  110052. /**
  110053. * flat array of model positions (internal use)
  110054. * @hidden
  110055. */
  110056. _shape: Vector3[];
  110057. /**
  110058. * flat array of model UVs (internal use)
  110059. * @hidden
  110060. */
  110061. _shapeUV: number[];
  110062. /**
  110063. * color array of the model
  110064. * @hidden
  110065. */
  110066. _shapeColors: number[];
  110067. /**
  110068. * indices array of the model
  110069. * @hidden
  110070. */
  110071. _indices: number[];
  110072. /**
  110073. * normals array of the model
  110074. * @hidden
  110075. */
  110076. _normals: number[];
  110077. /**
  110078. * length of the shape in the model indices array (internal use)
  110079. * @hidden
  110080. */
  110081. _indicesLength: number;
  110082. /**
  110083. * Custom position function (internal use)
  110084. * @hidden
  110085. */
  110086. _positionFunction: Nullable<(particle: SolidParticle, i: number, s: number) => void>;
  110087. /**
  110088. * Custom vertex function (internal use)
  110089. * @hidden
  110090. */
  110091. _vertexFunction: Nullable<(particle: SolidParticle, vertex: Vector3, i: number) => void>;
  110092. /**
  110093. * Model material (internal use)
  110094. * @hidden
  110095. */
  110096. _material: Nullable<Material>;
  110097. /**
  110098. * 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.
  110099. * SPS internal tool, don't use it manually.
  110100. * @hidden
  110101. */
  110102. 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>);
  110103. }
  110104. /**
  110105. * Represents a Depth Sorted Particle in the solid particle system.
  110106. * @hidden
  110107. */
  110108. export class DepthSortedParticle {
  110109. /**
  110110. * Particle index
  110111. */
  110112. idx: number;
  110113. /**
  110114. * Index of the particle in the "indices" array
  110115. */
  110116. ind: number;
  110117. /**
  110118. * Length of the particle shape in the "indices" array
  110119. */
  110120. indicesLength: number;
  110121. /**
  110122. * Squared distance from the particle to the camera
  110123. */
  110124. sqDistance: number;
  110125. /**
  110126. * Material index when used with MultiMaterials
  110127. */
  110128. materialIndex: number;
  110129. /**
  110130. * Creates a new sorted particle
  110131. * @param materialIndex
  110132. */
  110133. constructor(idx: number, ind: number, indLength: number, materialIndex: number);
  110134. }
  110135. /**
  110136. * Represents a solid particle vertex
  110137. */
  110138. export class SolidParticleVertex {
  110139. /**
  110140. * Vertex position
  110141. */
  110142. position: Vector3;
  110143. /**
  110144. * Vertex color
  110145. */
  110146. color: Color4;
  110147. /**
  110148. * Vertex UV
  110149. */
  110150. uv: Vector2;
  110151. /**
  110152. * Creates a new solid particle vertex
  110153. */
  110154. constructor();
  110155. /** Vertex x coordinate */
  110156. get x(): number;
  110157. set x(val: number);
  110158. /** Vertex y coordinate */
  110159. get y(): number;
  110160. set y(val: number);
  110161. /** Vertex z coordinate */
  110162. get z(): number;
  110163. set z(val: number);
  110164. }
  110165. }
  110166. declare module BABYLON {
  110167. /**
  110168. * @hidden
  110169. */
  110170. export class _MeshCollisionData {
  110171. _checkCollisions: boolean;
  110172. _collisionMask: number;
  110173. _collisionGroup: number;
  110174. _surroundingMeshes: Nullable<AbstractMesh[]>;
  110175. _collider: Nullable<Collider>;
  110176. _oldPositionForCollisions: Vector3;
  110177. _diffPositionForCollisions: Vector3;
  110178. _onCollideObserver: Nullable<Observer<AbstractMesh>>;
  110179. _onCollisionPositionChangeObserver: Nullable<Observer<Vector3>>;
  110180. }
  110181. }
  110182. declare module BABYLON {
  110183. /** @hidden */
  110184. class _FacetDataStorage {
  110185. facetPositions: Vector3[];
  110186. facetNormals: Vector3[];
  110187. facetPartitioning: number[][];
  110188. facetNb: number;
  110189. partitioningSubdivisions: number;
  110190. partitioningBBoxRatio: number;
  110191. facetDataEnabled: boolean;
  110192. facetParameters: any;
  110193. bbSize: Vector3;
  110194. subDiv: {
  110195. max: number;
  110196. X: number;
  110197. Y: number;
  110198. Z: number;
  110199. };
  110200. facetDepthSort: boolean;
  110201. facetDepthSortEnabled: boolean;
  110202. depthSortedIndices: IndicesArray;
  110203. depthSortedFacets: {
  110204. ind: number;
  110205. sqDistance: number;
  110206. }[];
  110207. facetDepthSortFunction: (f1: {
  110208. ind: number;
  110209. sqDistance: number;
  110210. }, f2: {
  110211. ind: number;
  110212. sqDistance: number;
  110213. }) => number;
  110214. facetDepthSortFrom: Vector3;
  110215. facetDepthSortOrigin: Vector3;
  110216. invertedMatrix: Matrix;
  110217. }
  110218. /**
  110219. * @hidden
  110220. **/
  110221. class _InternalAbstractMeshDataInfo {
  110222. _hasVertexAlpha: boolean;
  110223. _useVertexColors: boolean;
  110224. _numBoneInfluencers: number;
  110225. _applyFog: boolean;
  110226. _receiveShadows: boolean;
  110227. _facetData: _FacetDataStorage;
  110228. _visibility: number;
  110229. _skeleton: Nullable<Skeleton>;
  110230. _layerMask: number;
  110231. _computeBonesUsingShaders: boolean;
  110232. _isActive: boolean;
  110233. _onlyForInstances: boolean;
  110234. _isActiveIntermediate: boolean;
  110235. _onlyForInstancesIntermediate: boolean;
  110236. _actAsRegularMesh: boolean;
  110237. }
  110238. /**
  110239. * Class used to store all common mesh properties
  110240. */
  110241. export class AbstractMesh extends TransformNode implements IDisposable, ICullable, IGetSetVerticesData {
  110242. /** No occlusion */
  110243. static OCCLUSION_TYPE_NONE: number;
  110244. /** Occlusion set to optimisitic */
  110245. static OCCLUSION_TYPE_OPTIMISTIC: number;
  110246. /** Occlusion set to strict */
  110247. static OCCLUSION_TYPE_STRICT: number;
  110248. /** Use an accurante occlusion algorithm */
  110249. static OCCLUSION_ALGORITHM_TYPE_ACCURATE: number;
  110250. /** Use a conservative occlusion algorithm */
  110251. static OCCLUSION_ALGORITHM_TYPE_CONSERVATIVE: number;
  110252. /** Default culling strategy : this is an exclusion test and it's the more accurate.
  110253. * Test order :
  110254. * Is the bounding sphere outside the frustum ?
  110255. * If not, are the bounding box vertices outside the frustum ?
  110256. * It not, then the cullable object is in the frustum.
  110257. */
  110258. static readonly CULLINGSTRATEGY_STANDARD: number;
  110259. /** Culling strategy : Bounding Sphere Only.
  110260. * This is an exclusion test. It's faster than the standard strategy because the bounding box is not tested.
  110261. * It's also less accurate than the standard because some not visible objects can still be selected.
  110262. * Test : is the bounding sphere outside the frustum ?
  110263. * If not, then the cullable object is in the frustum.
  110264. */
  110265. static readonly CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY: number;
  110266. /** Culling strategy : Optimistic Inclusion.
  110267. * This in an inclusion test first, then the standard exclusion test.
  110268. * This can be faster when a cullable object is expected to be almost always in the camera frustum.
  110269. * 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.
  110270. * Anyway, it's as accurate as the standard strategy.
  110271. * Test :
  110272. * Is the cullable object bounding sphere center in the frustum ?
  110273. * If not, apply the default culling strategy.
  110274. */
  110275. static readonly CULLINGSTRATEGY_OPTIMISTIC_INCLUSION: number;
  110276. /** Culling strategy : Optimistic Inclusion then Bounding Sphere Only.
  110277. * This in an inclusion test first, then the bounding sphere only exclusion test.
  110278. * This can be the fastest test when a cullable object is expected to be almost always in the camera frustum.
  110279. * 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.
  110280. * It's less accurate than the standard strategy and as accurate as the BoundingSphereOnly strategy.
  110281. * Test :
  110282. * Is the cullable object bounding sphere center in the frustum ?
  110283. * If not, apply the Bounding Sphere Only strategy. No Bounding Box is tested here.
  110284. */
  110285. static readonly CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY: number;
  110286. /**
  110287. * No billboard
  110288. */
  110289. static get BILLBOARDMODE_NONE(): number;
  110290. /** Billboard on X axis */
  110291. static get BILLBOARDMODE_X(): number;
  110292. /** Billboard on Y axis */
  110293. static get BILLBOARDMODE_Y(): number;
  110294. /** Billboard on Z axis */
  110295. static get BILLBOARDMODE_Z(): number;
  110296. /** Billboard on all axes */
  110297. static get BILLBOARDMODE_ALL(): number;
  110298. /** Billboard on using position instead of orientation */
  110299. static get BILLBOARDMODE_USE_POSITION(): number;
  110300. /** @hidden */
  110301. _internalAbstractMeshDataInfo: _InternalAbstractMeshDataInfo;
  110302. /**
  110303. * The culling strategy to use to check whether the mesh must be rendered or not.
  110304. * This value can be changed at any time and will be used on the next render mesh selection.
  110305. * The possible values are :
  110306. * - AbstractMesh.CULLINGSTRATEGY_STANDARD
  110307. * - AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  110308. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION
  110309. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY
  110310. * Please read each static variable documentation to get details about the culling process.
  110311. * */
  110312. cullingStrategy: number;
  110313. /**
  110314. * Gets the number of facets in the mesh
  110315. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#what-is-a-mesh-facet
  110316. */
  110317. get facetNb(): number;
  110318. /**
  110319. * Gets or set the number (integer) of subdivisions per axis in the partioning space
  110320. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#tweaking-the-partitioning
  110321. */
  110322. get partitioningSubdivisions(): number;
  110323. set partitioningSubdivisions(nb: number);
  110324. /**
  110325. * The ratio (float) to apply to the bouding box size to set to the partioning space.
  110326. * Ex : 1.01 (default) the partioning space is 1% bigger than the bounding box
  110327. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#tweaking-the-partitioning
  110328. */
  110329. get partitioningBBoxRatio(): number;
  110330. set partitioningBBoxRatio(ratio: number);
  110331. /**
  110332. * Gets or sets a boolean indicating that the facets must be depth sorted on next call to `updateFacetData()`.
  110333. * Works only for updatable meshes.
  110334. * Doesn't work with multi-materials
  110335. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#facet-depth-sort
  110336. */
  110337. get mustDepthSortFacets(): boolean;
  110338. set mustDepthSortFacets(sort: boolean);
  110339. /**
  110340. * The location (Vector3) where the facet depth sort must be computed from.
  110341. * By default, the active camera position.
  110342. * Used only when facet depth sort is enabled
  110343. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#facet-depth-sort
  110344. */
  110345. get facetDepthSortFrom(): Vector3;
  110346. set facetDepthSortFrom(location: Vector3);
  110347. /**
  110348. * gets a boolean indicating if facetData is enabled
  110349. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#what-is-a-mesh-facet
  110350. */
  110351. get isFacetDataEnabled(): boolean;
  110352. /** @hidden */
  110353. _updateNonUniformScalingState(value: boolean): boolean;
  110354. /**
  110355. * An event triggered when this mesh collides with another one
  110356. */
  110357. onCollideObservable: Observable<AbstractMesh>;
  110358. /** Set a function to call when this mesh collides with another one */
  110359. set onCollide(callback: () => void);
  110360. /**
  110361. * An event triggered when the collision's position changes
  110362. */
  110363. onCollisionPositionChangeObservable: Observable<Vector3>;
  110364. /** Set a function to call when the collision's position changes */
  110365. set onCollisionPositionChange(callback: () => void);
  110366. /**
  110367. * An event triggered when material is changed
  110368. */
  110369. onMaterialChangedObservable: Observable<AbstractMesh>;
  110370. /**
  110371. * Gets or sets the orientation for POV movement & rotation
  110372. */
  110373. definedFacingForward: boolean;
  110374. /** @hidden */
  110375. _occlusionQuery: Nullable<WebGLQuery>;
  110376. /** @hidden */
  110377. _renderingGroup: Nullable<RenderingGroup>;
  110378. /**
  110379. * Gets or sets mesh visibility between 0 and 1 (default is 1)
  110380. */
  110381. get visibility(): number;
  110382. /**
  110383. * Gets or sets mesh visibility between 0 and 1 (default is 1)
  110384. */
  110385. set visibility(value: number);
  110386. /** Gets or sets the alpha index used to sort transparent meshes
  110387. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#alpha-index
  110388. */
  110389. alphaIndex: number;
  110390. /**
  110391. * Gets or sets a boolean indicating if the mesh is visible (renderable). Default is true
  110392. */
  110393. isVisible: boolean;
  110394. /**
  110395. * Gets or sets a boolean indicating if the mesh can be picked (by scene.pick for instance or through actions). Default is true
  110396. */
  110397. isPickable: boolean;
  110398. /** Gets or sets a boolean indicating that bounding boxes of subMeshes must be rendered as well (false by default) */
  110399. showSubMeshesBoundingBox: boolean;
  110400. /** Gets or sets a boolean indicating if the mesh must be considered as a ray blocker for lens flares (false by default)
  110401. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  110402. */
  110403. isBlocker: boolean;
  110404. /**
  110405. * Gets or sets a boolean indicating that pointer move events must be supported on this mesh (false by default)
  110406. */
  110407. enablePointerMoveEvents: boolean;
  110408. /**
  110409. * Specifies the rendering group id for this mesh (0 by default)
  110410. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#rendering-groups
  110411. */
  110412. renderingGroupId: number;
  110413. private _material;
  110414. /** Gets or sets current material */
  110415. get material(): Nullable<Material>;
  110416. set material(value: Nullable<Material>);
  110417. /**
  110418. * Gets or sets a boolean indicating that this mesh can receive realtime shadows
  110419. * @see https://doc.babylonjs.com/babylon101/shadows
  110420. */
  110421. get receiveShadows(): boolean;
  110422. set receiveShadows(value: boolean);
  110423. /** Defines color to use when rendering outline */
  110424. outlineColor: Color3;
  110425. /** Define width to use when rendering outline */
  110426. outlineWidth: number;
  110427. /** Defines color to use when rendering overlay */
  110428. overlayColor: Color3;
  110429. /** Defines alpha to use when rendering overlay */
  110430. overlayAlpha: number;
  110431. /** Gets or sets a boolean indicating that this mesh contains vertex color data with alpha values */
  110432. get hasVertexAlpha(): boolean;
  110433. set hasVertexAlpha(value: boolean);
  110434. /** 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) */
  110435. get useVertexColors(): boolean;
  110436. set useVertexColors(value: boolean);
  110437. /**
  110438. * Gets or sets a boolean indicating that bone animations must be computed by the CPU (false by default)
  110439. */
  110440. get computeBonesUsingShaders(): boolean;
  110441. set computeBonesUsingShaders(value: boolean);
  110442. /** Gets or sets the number of allowed bone influences per vertex (4 by default) */
  110443. get numBoneInfluencers(): number;
  110444. set numBoneInfluencers(value: number);
  110445. /** Gets or sets a boolean indicating that this mesh will allow fog to be rendered on it (true by default) */
  110446. get applyFog(): boolean;
  110447. set applyFog(value: boolean);
  110448. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes selection (true by default) */
  110449. useOctreeForRenderingSelection: boolean;
  110450. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes picking (true by default) */
  110451. useOctreeForPicking: boolean;
  110452. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes collision (true by default) */
  110453. useOctreeForCollisions: boolean;
  110454. /**
  110455. * Gets or sets the current layer mask (default is 0x0FFFFFFF)
  110456. * @see https://doc.babylonjs.com/how_to/layermasks_and_multi-cam_textures
  110457. */
  110458. get layerMask(): number;
  110459. set layerMask(value: number);
  110460. /**
  110461. * True if the mesh must be rendered in any case (this will shortcut the frustum clipping phase)
  110462. */
  110463. alwaysSelectAsActiveMesh: boolean;
  110464. /**
  110465. * Gets or sets a boolean indicating that the bounding info does not need to be kept in sync (for performance reason)
  110466. */
  110467. doNotSyncBoundingInfo: boolean;
  110468. /**
  110469. * Gets or sets the current action manager
  110470. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  110471. */
  110472. actionManager: Nullable<AbstractActionManager>;
  110473. private _meshCollisionData;
  110474. /**
  110475. * Gets or sets the ellipsoid used to impersonate this mesh when using collision engine (default is (0.5, 1, 0.5))
  110476. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  110477. */
  110478. ellipsoid: Vector3;
  110479. /**
  110480. * Gets or sets the ellipsoid offset used to impersonate this mesh when using collision engine (default is (0, 0, 0))
  110481. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  110482. */
  110483. ellipsoidOffset: Vector3;
  110484. /**
  110485. * Gets or sets a collision mask used to mask collisions (default is -1).
  110486. * A collision between A and B will happen if A.collisionGroup & b.collisionMask !== 0
  110487. */
  110488. get collisionMask(): number;
  110489. set collisionMask(mask: number);
  110490. /**
  110491. * Gets or sets the current collision group mask (-1 by default).
  110492. * A collision between A and B will happen if A.collisionGroup & b.collisionMask !== 0
  110493. */
  110494. get collisionGroup(): number;
  110495. set collisionGroup(mask: number);
  110496. /**
  110497. * Gets or sets current surrounding meshes (null by default).
  110498. *
  110499. * By default collision detection is tested against every mesh in the scene.
  110500. * It is possible to set surroundingMeshes to a defined list of meshes and then only these specified
  110501. * meshes will be tested for the collision.
  110502. *
  110503. * Note: if set to an empty array no collision will happen when this mesh is moved.
  110504. */
  110505. get surroundingMeshes(): Nullable<AbstractMesh[]>;
  110506. set surroundingMeshes(meshes: Nullable<AbstractMesh[]>);
  110507. /**
  110508. * Defines edge width used when edgesRenderer is enabled
  110509. * @see https://www.babylonjs-playground.com/#10OJSG#13
  110510. */
  110511. edgesWidth: number;
  110512. /**
  110513. * Defines edge color used when edgesRenderer is enabled
  110514. * @see https://www.babylonjs-playground.com/#10OJSG#13
  110515. */
  110516. edgesColor: Color4;
  110517. /** @hidden */
  110518. _edgesRenderer: Nullable<IEdgesRenderer>;
  110519. /** @hidden */
  110520. _masterMesh: Nullable<AbstractMesh>;
  110521. /** @hidden */
  110522. _boundingInfo: Nullable<BoundingInfo>;
  110523. /** @hidden */
  110524. _renderId: number;
  110525. /**
  110526. * Gets or sets the list of subMeshes
  110527. * @see https://doc.babylonjs.com/how_to/multi_materials
  110528. */
  110529. subMeshes: SubMesh[];
  110530. /** @hidden */
  110531. _intersectionsInProgress: AbstractMesh[];
  110532. /** @hidden */
  110533. _unIndexed: boolean;
  110534. /** @hidden */
  110535. _lightSources: Light[];
  110536. /** Gets the list of lights affecting that mesh */
  110537. get lightSources(): Light[];
  110538. /** @hidden */
  110539. get _positions(): Nullable<Vector3[]>;
  110540. /** @hidden */
  110541. _waitingData: {
  110542. lods: Nullable<any>;
  110543. actions: Nullable<any>;
  110544. freezeWorldMatrix: Nullable<boolean>;
  110545. };
  110546. /** @hidden */
  110547. _bonesTransformMatrices: Nullable<Float32Array>;
  110548. /** @hidden */
  110549. _transformMatrixTexture: Nullable<RawTexture>;
  110550. /**
  110551. * Gets or sets a skeleton to apply skining transformations
  110552. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  110553. */
  110554. set skeleton(value: Nullable<Skeleton>);
  110555. get skeleton(): Nullable<Skeleton>;
  110556. /**
  110557. * An event triggered when the mesh is rebuilt.
  110558. */
  110559. onRebuildObservable: Observable<AbstractMesh>;
  110560. /**
  110561. * Creates a new AbstractMesh
  110562. * @param name defines the name of the mesh
  110563. * @param scene defines the hosting scene
  110564. */
  110565. constructor(name: string, scene?: Nullable<Scene>);
  110566. /**
  110567. * Returns the string "AbstractMesh"
  110568. * @returns "AbstractMesh"
  110569. */
  110570. getClassName(): string;
  110571. /**
  110572. * Gets a string representation of the current mesh
  110573. * @param fullDetails defines a boolean indicating if full details must be included
  110574. * @returns a string representation of the current mesh
  110575. */
  110576. toString(fullDetails?: boolean): string;
  110577. /**
  110578. * @hidden
  110579. */
  110580. protected _getEffectiveParent(): Nullable<Node>;
  110581. /** @hidden */
  110582. _getActionManagerForTrigger(trigger?: number, initialCall?: boolean): Nullable<AbstractActionManager>;
  110583. /** @hidden */
  110584. _rebuild(): void;
  110585. /** @hidden */
  110586. _resyncLightSources(): void;
  110587. /** @hidden */
  110588. _resyncLightSource(light: Light): void;
  110589. /** @hidden */
  110590. _unBindEffect(): void;
  110591. /** @hidden */
  110592. _removeLightSource(light: Light, dispose: boolean): void;
  110593. private _markSubMeshesAsDirty;
  110594. /** @hidden */
  110595. _markSubMeshesAsLightDirty(dispose?: boolean): void;
  110596. /** @hidden */
  110597. _markSubMeshesAsAttributesDirty(): void;
  110598. /** @hidden */
  110599. _markSubMeshesAsMiscDirty(): void;
  110600. /**
  110601. * Gets or sets a Vector3 depicting the mesh scaling along each local axis X, Y, Z. Default is (1.0, 1.0, 1.0)
  110602. */
  110603. get scaling(): Vector3;
  110604. set scaling(newScaling: Vector3);
  110605. /**
  110606. * Returns true if the mesh is blocked. Implemented by child classes
  110607. */
  110608. get isBlocked(): boolean;
  110609. /**
  110610. * Returns the mesh itself by default. Implemented by child classes
  110611. * @param camera defines the camera to use to pick the right LOD level
  110612. * @returns the currentAbstractMesh
  110613. */
  110614. getLOD(camera: Camera): Nullable<AbstractMesh>;
  110615. /**
  110616. * Returns 0 by default. Implemented by child classes
  110617. * @returns an integer
  110618. */
  110619. getTotalVertices(): number;
  110620. /**
  110621. * Returns a positive integer : the total number of indices in this mesh geometry.
  110622. * @returns the numner of indices or zero if the mesh has no geometry.
  110623. */
  110624. getTotalIndices(): number;
  110625. /**
  110626. * Returns null by default. Implemented by child classes
  110627. * @returns null
  110628. */
  110629. getIndices(): Nullable<IndicesArray>;
  110630. /**
  110631. * Returns the array of the requested vertex data kind. Implemented by child classes
  110632. * @param kind defines the vertex data kind to use
  110633. * @returns null
  110634. */
  110635. getVerticesData(kind: string): Nullable<FloatArray>;
  110636. /**
  110637. * Sets the vertex data of the mesh geometry for the requested `kind`.
  110638. * If the mesh has no geometry, a new Geometry object is set to the mesh and then passed this vertex data.
  110639. * Note that a new underlying VertexBuffer object is created each call.
  110640. * If the `kind` is the `PositionKind`, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  110641. * @param kind defines vertex data kind:
  110642. * * VertexBuffer.PositionKind
  110643. * * VertexBuffer.UVKind
  110644. * * VertexBuffer.UV2Kind
  110645. * * VertexBuffer.UV3Kind
  110646. * * VertexBuffer.UV4Kind
  110647. * * VertexBuffer.UV5Kind
  110648. * * VertexBuffer.UV6Kind
  110649. * * VertexBuffer.ColorKind
  110650. * * VertexBuffer.MatricesIndicesKind
  110651. * * VertexBuffer.MatricesIndicesExtraKind
  110652. * * VertexBuffer.MatricesWeightsKind
  110653. * * VertexBuffer.MatricesWeightsExtraKind
  110654. * @param data defines the data source
  110655. * @param updatable defines if the data must be flagged as updatable (or static)
  110656. * @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
  110657. * @returns the current mesh
  110658. */
  110659. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  110660. /**
  110661. * Updates the existing vertex data of the mesh geometry for the requested `kind`.
  110662. * If the mesh has no geometry, it is simply returned as it is.
  110663. * @param kind defines vertex data kind:
  110664. * * VertexBuffer.PositionKind
  110665. * * VertexBuffer.UVKind
  110666. * * VertexBuffer.UV2Kind
  110667. * * VertexBuffer.UV3Kind
  110668. * * VertexBuffer.UV4Kind
  110669. * * VertexBuffer.UV5Kind
  110670. * * VertexBuffer.UV6Kind
  110671. * * VertexBuffer.ColorKind
  110672. * * VertexBuffer.MatricesIndicesKind
  110673. * * VertexBuffer.MatricesIndicesExtraKind
  110674. * * VertexBuffer.MatricesWeightsKind
  110675. * * VertexBuffer.MatricesWeightsExtraKind
  110676. * @param data defines the data source
  110677. * @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
  110678. * @param makeItUnique If true, a new global geometry is created from this data and is set to the mesh
  110679. * @returns the current mesh
  110680. */
  110681. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): AbstractMesh;
  110682. /**
  110683. * Sets the mesh indices,
  110684. * If the mesh has no geometry, a new Geometry object is created and set to the mesh.
  110685. * @param indices Expects an array populated with integers or a typed array (Int32Array, Uint32Array, Uint16Array)
  110686. * @param totalVertices Defines the total number of vertices
  110687. * @returns the current mesh
  110688. */
  110689. setIndices(indices: IndicesArray, totalVertices: Nullable<number>): AbstractMesh;
  110690. /**
  110691. * Gets a boolean indicating if specific vertex data is present
  110692. * @param kind defines the vertex data kind to use
  110693. * @returns true is data kind is present
  110694. */
  110695. isVerticesDataPresent(kind: string): boolean;
  110696. /**
  110697. * Returns the mesh BoundingInfo object or creates a new one and returns if it was undefined.
  110698. * Note that it returns a shallow bounding of the mesh (i.e. it does not include children).
  110699. * To get the full bounding of all children, call `getHierarchyBoundingVectors` instead.
  110700. * @returns a BoundingInfo
  110701. */
  110702. getBoundingInfo(): BoundingInfo;
  110703. /**
  110704. * Uniformly scales the mesh to fit inside of a unit cube (1 X 1 X 1 units)
  110705. * @param includeDescendants Use the hierarchy's bounding box instead of the mesh's bounding box. Default is false
  110706. * @param ignoreRotation ignore rotation when computing the scale (ie. object will be axis aligned). Default is false
  110707. * @param predicate predicate that is passed in to getHierarchyBoundingVectors when selecting which object should be included when scaling
  110708. * @returns the current mesh
  110709. */
  110710. normalizeToUnitCube(includeDescendants?: boolean, ignoreRotation?: boolean, predicate?: Nullable<(node: AbstractMesh) => boolean>): AbstractMesh;
  110711. /**
  110712. * Overwrite the current bounding info
  110713. * @param boundingInfo defines the new bounding info
  110714. * @returns the current mesh
  110715. */
  110716. setBoundingInfo(boundingInfo: BoundingInfo): AbstractMesh;
  110717. /** Gets a boolean indicating if this mesh has skinning data and an attached skeleton */
  110718. get useBones(): boolean;
  110719. /** @hidden */
  110720. _preActivate(): void;
  110721. /** @hidden */
  110722. _preActivateForIntermediateRendering(renderId: number): void;
  110723. /** @hidden */
  110724. _activate(renderId: number, intermediateRendering: boolean): boolean;
  110725. /** @hidden */
  110726. _postActivate(): void;
  110727. /** @hidden */
  110728. _freeze(): void;
  110729. /** @hidden */
  110730. _unFreeze(): void;
  110731. /**
  110732. * Gets the current world matrix
  110733. * @returns a Matrix
  110734. */
  110735. getWorldMatrix(): Matrix;
  110736. /** @hidden */
  110737. _getWorldMatrixDeterminant(): number;
  110738. /**
  110739. * Gets a boolean indicating if this mesh is an instance or a regular mesh
  110740. */
  110741. get isAnInstance(): boolean;
  110742. /**
  110743. * Gets a boolean indicating if this mesh has instances
  110744. */
  110745. get hasInstances(): boolean;
  110746. /**
  110747. * Gets a boolean indicating if this mesh has thin instances
  110748. */
  110749. get hasThinInstances(): boolean;
  110750. /**
  110751. * Perform relative position change from the point of view of behind the front of the mesh.
  110752. * This is performed taking into account the meshes current rotation, so you do not have to care.
  110753. * Supports definition of mesh facing forward or backward
  110754. * @param amountRight defines the distance on the right axis
  110755. * @param amountUp defines the distance on the up axis
  110756. * @param amountForward defines the distance on the forward axis
  110757. * @returns the current mesh
  110758. */
  110759. movePOV(amountRight: number, amountUp: number, amountForward: number): AbstractMesh;
  110760. /**
  110761. * Calculate relative position change from the point of view of behind the front of the mesh.
  110762. * This is performed taking into account the meshes current rotation, so you do not have to care.
  110763. * Supports definition of mesh facing forward or backward
  110764. * @param amountRight defines the distance on the right axis
  110765. * @param amountUp defines the distance on the up axis
  110766. * @param amountForward defines the distance on the forward axis
  110767. * @returns the new displacement vector
  110768. */
  110769. calcMovePOV(amountRight: number, amountUp: number, amountForward: number): Vector3;
  110770. /**
  110771. * Perform relative rotation change from the point of view of behind the front of the mesh.
  110772. * Supports definition of mesh facing forward or backward
  110773. * @param flipBack defines the flip
  110774. * @param twirlClockwise defines the twirl
  110775. * @param tiltRight defines the tilt
  110776. * @returns the current mesh
  110777. */
  110778. rotatePOV(flipBack: number, twirlClockwise: number, tiltRight: number): AbstractMesh;
  110779. /**
  110780. * Calculate relative rotation change from the point of view of behind the front of the mesh.
  110781. * Supports definition of mesh facing forward or backward.
  110782. * @param flipBack defines the flip
  110783. * @param twirlClockwise defines the twirl
  110784. * @param tiltRight defines the tilt
  110785. * @returns the new rotation vector
  110786. */
  110787. calcRotatePOV(flipBack: number, twirlClockwise: number, tiltRight: number): Vector3;
  110788. /**
  110789. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  110790. * This means the mesh underlying bounding box and sphere are recomputed.
  110791. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  110792. * @returns the current mesh
  110793. */
  110794. refreshBoundingInfo(applySkeleton?: boolean): AbstractMesh;
  110795. /** @hidden */
  110796. _refreshBoundingInfo(data: Nullable<FloatArray>, bias: Nullable<Vector2>): void;
  110797. /** @hidden */
  110798. _getPositionData(applySkeleton: boolean): Nullable<FloatArray>;
  110799. /** @hidden */
  110800. _updateBoundingInfo(): AbstractMesh;
  110801. /** @hidden */
  110802. _updateSubMeshesBoundingInfo(matrix: DeepImmutable<Matrix>): AbstractMesh;
  110803. /** @hidden */
  110804. protected _afterComputeWorldMatrix(): void;
  110805. /** @hidden */
  110806. get _effectiveMesh(): AbstractMesh;
  110807. /**
  110808. * Returns `true` if the mesh is within the frustum defined by the passed array of planes.
  110809. * A mesh is in the frustum if its bounding box intersects the frustum
  110810. * @param frustumPlanes defines the frustum to test
  110811. * @returns true if the mesh is in the frustum planes
  110812. */
  110813. isInFrustum(frustumPlanes: Plane[]): boolean;
  110814. /**
  110815. * Returns `true` if the mesh is completely in the frustum defined be the passed array of planes.
  110816. * A mesh is completely in the frustum if its bounding box it completely inside the frustum.
  110817. * @param frustumPlanes defines the frustum to test
  110818. * @returns true if the mesh is completely in the frustum planes
  110819. */
  110820. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  110821. /**
  110822. * True if the mesh intersects another mesh or a SolidParticle object
  110823. * @param mesh defines a target mesh or SolidParticle to test
  110824. * @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)
  110825. * @param includeDescendants Can be set to true to test if the mesh defined in parameters intersects with the current mesh or any child meshes
  110826. * @returns true if there is an intersection
  110827. */
  110828. intersectsMesh(mesh: AbstractMesh | SolidParticle, precise?: boolean, includeDescendants?: boolean): boolean;
  110829. /**
  110830. * Returns true if the passed point (Vector3) is inside the mesh bounding box
  110831. * @param point defines the point to test
  110832. * @returns true if there is an intersection
  110833. */
  110834. intersectsPoint(point: Vector3): boolean;
  110835. /**
  110836. * Gets or sets a boolean indicating that this mesh can be used in the collision engine
  110837. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  110838. */
  110839. get checkCollisions(): boolean;
  110840. set checkCollisions(collisionEnabled: boolean);
  110841. /**
  110842. * Gets Collider object used to compute collisions (not physics)
  110843. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  110844. */
  110845. get collider(): Nullable<Collider>;
  110846. /**
  110847. * Move the mesh using collision engine
  110848. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  110849. * @param displacement defines the requested displacement vector
  110850. * @returns the current mesh
  110851. */
  110852. moveWithCollisions(displacement: Vector3): AbstractMesh;
  110853. private _onCollisionPositionChange;
  110854. /** @hidden */
  110855. _collideForSubMesh(subMesh: SubMesh, transformMatrix: Matrix, collider: Collider): AbstractMesh;
  110856. /** @hidden */
  110857. _processCollisionsForSubMeshes(collider: Collider, transformMatrix: Matrix): AbstractMesh;
  110858. /** @hidden */
  110859. _checkCollision(collider: Collider): AbstractMesh;
  110860. /** @hidden */
  110861. _generatePointsArray(): boolean;
  110862. /**
  110863. * Checks if the passed Ray intersects with the mesh
  110864. * @param ray defines the ray to use
  110865. * @param fastCheck defines if fast mode (but less precise) must be used (false by default)
  110866. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  110867. * @param onlyBoundingInfo defines a boolean indicating if picking should only happen using bounding info (false by default)
  110868. * @returns the picking info
  110869. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  110870. */
  110871. intersects(ray: Ray, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate, onlyBoundingInfo?: boolean): PickingInfo;
  110872. /**
  110873. * Clones the current mesh
  110874. * @param name defines the mesh name
  110875. * @param newParent defines the new mesh parent
  110876. * @param doNotCloneChildren defines a boolean indicating that children must not be cloned (false by default)
  110877. * @returns the new mesh
  110878. */
  110879. clone(name: string, newParent: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<AbstractMesh>;
  110880. /**
  110881. * Disposes all the submeshes of the current meshnp
  110882. * @returns the current mesh
  110883. */
  110884. releaseSubMeshes(): AbstractMesh;
  110885. /**
  110886. * Releases resources associated with this abstract mesh.
  110887. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  110888. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  110889. */
  110890. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  110891. /**
  110892. * Adds the passed mesh as a child to the current mesh
  110893. * @param mesh defines the child mesh
  110894. * @returns the current mesh
  110895. */
  110896. addChild(mesh: AbstractMesh): AbstractMesh;
  110897. /**
  110898. * Removes the passed mesh from the current mesh children list
  110899. * @param mesh defines the child mesh
  110900. * @returns the current mesh
  110901. */
  110902. removeChild(mesh: AbstractMesh): AbstractMesh;
  110903. /** @hidden */
  110904. private _initFacetData;
  110905. /**
  110906. * Updates the mesh facetData arrays and the internal partitioning when the mesh is morphed or updated.
  110907. * This method can be called within the render loop.
  110908. * 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
  110909. * @returns the current mesh
  110910. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  110911. */
  110912. updateFacetData(): AbstractMesh;
  110913. /**
  110914. * Returns the facetLocalNormals array.
  110915. * The normals are expressed in the mesh local spac
  110916. * @returns an array of Vector3
  110917. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  110918. */
  110919. getFacetLocalNormals(): Vector3[];
  110920. /**
  110921. * Returns the facetLocalPositions array.
  110922. * The facet positions are expressed in the mesh local space
  110923. * @returns an array of Vector3
  110924. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  110925. */
  110926. getFacetLocalPositions(): Vector3[];
  110927. /**
  110928. * Returns the facetLocalPartioning array
  110929. * @returns an array of array of numbers
  110930. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  110931. */
  110932. getFacetLocalPartitioning(): number[][];
  110933. /**
  110934. * Returns the i-th facet position in the world system.
  110935. * This method allocates a new Vector3 per call
  110936. * @param i defines the facet index
  110937. * @returns a new Vector3
  110938. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  110939. */
  110940. getFacetPosition(i: number): Vector3;
  110941. /**
  110942. * Sets the reference Vector3 with the i-th facet position in the world system
  110943. * @param i defines the facet index
  110944. * @param ref defines the target vector
  110945. * @returns the current mesh
  110946. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  110947. */
  110948. getFacetPositionToRef(i: number, ref: Vector3): AbstractMesh;
  110949. /**
  110950. * Returns the i-th facet normal in the world system.
  110951. * This method allocates a new Vector3 per call
  110952. * @param i defines the facet index
  110953. * @returns a new Vector3
  110954. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  110955. */
  110956. getFacetNormal(i: number): Vector3;
  110957. /**
  110958. * Sets the reference Vector3 with the i-th facet normal in the world system
  110959. * @param i defines the facet index
  110960. * @param ref defines the target vector
  110961. * @returns the current mesh
  110962. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  110963. */
  110964. getFacetNormalToRef(i: number, ref: Vector3): this;
  110965. /**
  110966. * 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)
  110967. * @param x defines x coordinate
  110968. * @param y defines y coordinate
  110969. * @param z defines z coordinate
  110970. * @returns the array of facet indexes
  110971. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  110972. */
  110973. getFacetsAtLocalCoordinates(x: number, y: number, z: number): Nullable<number[]>;
  110974. /**
  110975. * Returns the closest mesh facet index at (x,y,z) World coordinates, null if not found
  110976. * @param projected sets as the (x,y,z) world projection on the facet
  110977. * @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
  110978. * @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
  110979. * @param x defines x coordinate
  110980. * @param y defines y coordinate
  110981. * @param z defines z coordinate
  110982. * @returns the face index if found (or null instead)
  110983. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  110984. */
  110985. getClosestFacetAtCoordinates(x: number, y: number, z: number, projected?: Vector3, checkFace?: boolean, facing?: boolean): Nullable<number>;
  110986. /**
  110987. * Returns the closest mesh facet index at (x,y,z) local coordinates, null if not found
  110988. * @param projected sets as the (x,y,z) local projection on the facet
  110989. * @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
  110990. * @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
  110991. * @param x defines x coordinate
  110992. * @param y defines y coordinate
  110993. * @param z defines z coordinate
  110994. * @returns the face index if found (or null instead)
  110995. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  110996. */
  110997. getClosestFacetAtLocalCoordinates(x: number, y: number, z: number, projected?: Vector3, checkFace?: boolean, facing?: boolean): Nullable<number>;
  110998. /**
  110999. * Returns the object "parameter" set with all the expected parameters for facetData computation by ComputeNormals()
  111000. * @returns the parameters
  111001. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  111002. */
  111003. getFacetDataParameters(): any;
  111004. /**
  111005. * Disables the feature FacetData and frees the related memory
  111006. * @returns the current mesh
  111007. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  111008. */
  111009. disableFacetData(): AbstractMesh;
  111010. /**
  111011. * Updates the AbstractMesh indices array
  111012. * @param indices defines the data source
  111013. * @param offset defines the offset in the index buffer where to store the new data (can be null)
  111014. * @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)
  111015. * @returns the current mesh
  111016. */
  111017. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): AbstractMesh;
  111018. /**
  111019. * Creates new normals data for the mesh
  111020. * @param updatable defines if the normal vertex buffer must be flagged as updatable
  111021. * @returns the current mesh
  111022. */
  111023. createNormals(updatable: boolean): AbstractMesh;
  111024. /**
  111025. * Align the mesh with a normal
  111026. * @param normal defines the normal to use
  111027. * @param upDirection can be used to redefined the up vector to use (will use the (0, 1, 0) by default)
  111028. * @returns the current mesh
  111029. */
  111030. alignWithNormal(normal: Vector3, upDirection?: Vector3): AbstractMesh;
  111031. /** @hidden */
  111032. _checkOcclusionQuery(): boolean;
  111033. /**
  111034. * Disables the mesh edge rendering mode
  111035. * @returns the currentAbstractMesh
  111036. */
  111037. disableEdgesRendering(): AbstractMesh;
  111038. /**
  111039. * Enables the edge rendering mode on the mesh.
  111040. * This mode makes the mesh edges visible
  111041. * @param epsilon defines the maximal distance between two angles to detect a face
  111042. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  111043. * @returns the currentAbstractMesh
  111044. * @see https://www.babylonjs-playground.com/#19O9TU#0
  111045. */
  111046. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): AbstractMesh;
  111047. /**
  111048. * This function returns all of the particle systems in the scene that use the mesh as an emitter.
  111049. * @returns an array of particle systems in the scene that use the mesh as an emitter
  111050. */
  111051. getConnectedParticleSystems(): IParticleSystem[];
  111052. }
  111053. }
  111054. declare module BABYLON {
  111055. /**
  111056. * Interface used to define ActionEvent
  111057. */
  111058. export interface IActionEvent {
  111059. /** The mesh or sprite that triggered the action */
  111060. source: any;
  111061. /** The X mouse cursor position at the time of the event */
  111062. pointerX: number;
  111063. /** The Y mouse cursor position at the time of the event */
  111064. pointerY: number;
  111065. /** The mesh that is currently pointed at (can be null) */
  111066. meshUnderPointer: Nullable<AbstractMesh>;
  111067. /** the original (browser) event that triggered the ActionEvent */
  111068. sourceEvent?: any;
  111069. /** additional data for the event */
  111070. additionalData?: any;
  111071. }
  111072. /**
  111073. * ActionEvent is the event being sent when an action is triggered.
  111074. */
  111075. export class ActionEvent implements IActionEvent {
  111076. /** The mesh or sprite that triggered the action */
  111077. source: any;
  111078. /** The X mouse cursor position at the time of the event */
  111079. pointerX: number;
  111080. /** The Y mouse cursor position at the time of the event */
  111081. pointerY: number;
  111082. /** The mesh that is currently pointed at (can be null) */
  111083. meshUnderPointer: Nullable<AbstractMesh>;
  111084. /** the original (browser) event that triggered the ActionEvent */
  111085. sourceEvent?: any;
  111086. /** additional data for the event */
  111087. additionalData?: any;
  111088. /**
  111089. * Creates a new ActionEvent
  111090. * @param source The mesh or sprite that triggered the action
  111091. * @param pointerX The X mouse cursor position at the time of the event
  111092. * @param pointerY The Y mouse cursor position at the time of the event
  111093. * @param meshUnderPointer The mesh that is currently pointed at (can be null)
  111094. * @param sourceEvent the original (browser) event that triggered the ActionEvent
  111095. * @param additionalData additional data for the event
  111096. */
  111097. constructor(
  111098. /** The mesh or sprite that triggered the action */
  111099. source: any,
  111100. /** The X mouse cursor position at the time of the event */
  111101. pointerX: number,
  111102. /** The Y mouse cursor position at the time of the event */
  111103. pointerY: number,
  111104. /** The mesh that is currently pointed at (can be null) */
  111105. meshUnderPointer: Nullable<AbstractMesh>,
  111106. /** the original (browser) event that triggered the ActionEvent */
  111107. sourceEvent?: any,
  111108. /** additional data for the event */
  111109. additionalData?: any);
  111110. /**
  111111. * Helper function to auto-create an ActionEvent from a source mesh.
  111112. * @param source The source mesh that triggered the event
  111113. * @param evt The original (browser) event
  111114. * @param additionalData additional data for the event
  111115. * @returns the new ActionEvent
  111116. */
  111117. static CreateNew(source: AbstractMesh, evt?: Event, additionalData?: any): ActionEvent;
  111118. /**
  111119. * Helper function to auto-create an ActionEvent from a source sprite
  111120. * @param source The source sprite that triggered the event
  111121. * @param scene Scene associated with the sprite
  111122. * @param evt The original (browser) event
  111123. * @param additionalData additional data for the event
  111124. * @returns the new ActionEvent
  111125. */
  111126. static CreateNewFromSprite(source: Sprite, scene: Scene, evt?: Event, additionalData?: any): ActionEvent;
  111127. /**
  111128. * Helper function to auto-create an ActionEvent from a scene. If triggered by a mesh use ActionEvent.CreateNew
  111129. * @param scene the scene where the event occurred
  111130. * @param evt The original (browser) event
  111131. * @returns the new ActionEvent
  111132. */
  111133. static CreateNewFromScene(scene: Scene, evt: Event): ActionEvent;
  111134. /**
  111135. * Helper function to auto-create an ActionEvent from a primitive
  111136. * @param prim defines the target primitive
  111137. * @param pointerPos defines the pointer position
  111138. * @param evt The original (browser) event
  111139. * @param additionalData additional data for the event
  111140. * @returns the new ActionEvent
  111141. */
  111142. static CreateNewFromPrimitive(prim: any, pointerPos: Vector2, evt?: Event, additionalData?: any): ActionEvent;
  111143. }
  111144. }
  111145. declare module BABYLON {
  111146. /**
  111147. * Abstract class used to decouple action Manager from scene and meshes.
  111148. * Do not instantiate.
  111149. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  111150. */
  111151. export abstract class AbstractActionManager implements IDisposable {
  111152. /** Gets the list of active triggers */
  111153. static Triggers: {
  111154. [key: string]: number;
  111155. };
  111156. /** Gets the cursor to use when hovering items */
  111157. hoverCursor: string;
  111158. /** Gets the list of actions */
  111159. actions: IAction[];
  111160. /**
  111161. * Gets or sets a boolean indicating that the manager is recursive meaning that it can trigger action from children
  111162. */
  111163. isRecursive: boolean;
  111164. /**
  111165. * Releases all associated resources
  111166. */
  111167. abstract dispose(): void;
  111168. /**
  111169. * Does this action manager has pointer triggers
  111170. */
  111171. abstract get hasPointerTriggers(): boolean;
  111172. /**
  111173. * Does this action manager has pick triggers
  111174. */
  111175. abstract get hasPickTriggers(): boolean;
  111176. /**
  111177. * Process a specific trigger
  111178. * @param trigger defines the trigger to process
  111179. * @param evt defines the event details to be processed
  111180. */
  111181. abstract processTrigger(trigger: number, evt?: IActionEvent): void;
  111182. /**
  111183. * Does this action manager handles actions of any of the given triggers
  111184. * @param triggers defines the triggers to be tested
  111185. * @return a boolean indicating whether one (or more) of the triggers is handled
  111186. */
  111187. abstract hasSpecificTriggers(triggers: number[]): boolean;
  111188. /**
  111189. * Does this action manager handles actions of any of the given triggers. This function takes two arguments for
  111190. * speed.
  111191. * @param triggerA defines the trigger to be tested
  111192. * @param triggerB defines the trigger to be tested
  111193. * @return a boolean indicating whether one (or more) of the triggers is handled
  111194. */
  111195. abstract hasSpecificTriggers2(triggerA: number, triggerB: number): boolean;
  111196. /**
  111197. * Does this action manager handles actions of a given trigger
  111198. * @param trigger defines the trigger to be tested
  111199. * @param parameterPredicate defines an optional predicate to filter triggers by parameter
  111200. * @return whether the trigger is handled
  111201. */
  111202. abstract hasSpecificTrigger(trigger: number, parameterPredicate?: (parameter: any) => boolean): boolean;
  111203. /**
  111204. * Serialize this manager to a JSON object
  111205. * @param name defines the property name to store this manager
  111206. * @returns a JSON representation of this manager
  111207. */
  111208. abstract serialize(name: string): any;
  111209. /**
  111210. * Registers an action to this action manager
  111211. * @param action defines the action to be registered
  111212. * @return the action amended (prepared) after registration
  111213. */
  111214. abstract registerAction(action: IAction): Nullable<IAction>;
  111215. /**
  111216. * Unregisters an action to this action manager
  111217. * @param action defines the action to be unregistered
  111218. * @return a boolean indicating whether the action has been unregistered
  111219. */
  111220. abstract unregisterAction(action: IAction): Boolean;
  111221. /**
  111222. * Does exist one action manager with at least one trigger
  111223. **/
  111224. static get HasTriggers(): boolean;
  111225. /**
  111226. * Does exist one action manager with at least one pick trigger
  111227. **/
  111228. static get HasPickTriggers(): boolean;
  111229. /**
  111230. * Does exist one action manager that handles actions of a given trigger
  111231. * @param trigger defines the trigger to be tested
  111232. * @return a boolean indicating whether the trigger is handeled by at least one action manager
  111233. **/
  111234. static HasSpecificTrigger(trigger: number): boolean;
  111235. }
  111236. }
  111237. declare module BABYLON {
  111238. /**
  111239. * Defines how a node can be built from a string name.
  111240. */
  111241. export type NodeConstructor = (name: string, scene: Scene, options?: any) => () => Node;
  111242. /**
  111243. * Node is the basic class for all scene objects (Mesh, Light, Camera.)
  111244. */
  111245. export class Node implements IBehaviorAware<Node> {
  111246. /** @hidden */
  111247. static _AnimationRangeFactory: (name: string, from: number, to: number) => AnimationRange;
  111248. private static _NodeConstructors;
  111249. /**
  111250. * Add a new node constructor
  111251. * @param type defines the type name of the node to construct
  111252. * @param constructorFunc defines the constructor function
  111253. */
  111254. static AddNodeConstructor(type: string, constructorFunc: NodeConstructor): void;
  111255. /**
  111256. * Returns a node constructor based on type name
  111257. * @param type defines the type name
  111258. * @param name defines the new node name
  111259. * @param scene defines the hosting scene
  111260. * @param options defines optional options to transmit to constructors
  111261. * @returns the new constructor or null
  111262. */
  111263. static Construct(type: string, name: string, scene: Scene, options?: any): Nullable<() => Node>;
  111264. /**
  111265. * Gets or sets the name of the node
  111266. */
  111267. name: string;
  111268. /**
  111269. * Gets or sets the id of the node
  111270. */
  111271. id: string;
  111272. /**
  111273. * Gets or sets the unique id of the node
  111274. */
  111275. uniqueId: number;
  111276. /**
  111277. * Gets or sets a string used to store user defined state for the node
  111278. */
  111279. state: string;
  111280. /**
  111281. * Gets or sets an object used to store user defined information for the node
  111282. */
  111283. metadata: any;
  111284. /**
  111285. * For internal use only. Please do not use.
  111286. */
  111287. reservedDataStore: any;
  111288. /**
  111289. * List of inspectable custom properties (used by the Inspector)
  111290. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  111291. */
  111292. inspectableCustomProperties: IInspectable[];
  111293. private _doNotSerialize;
  111294. /**
  111295. * Gets or sets a boolean used to define if the node must be serialized
  111296. */
  111297. get doNotSerialize(): boolean;
  111298. set doNotSerialize(value: boolean);
  111299. /** @hidden */
  111300. _isDisposed: boolean;
  111301. /**
  111302. * Gets a list of Animations associated with the node
  111303. */
  111304. animations: Animation[];
  111305. protected _ranges: {
  111306. [name: string]: Nullable<AnimationRange>;
  111307. };
  111308. /**
  111309. * Callback raised when the node is ready to be used
  111310. */
  111311. onReady: Nullable<(node: Node) => void>;
  111312. private _isEnabled;
  111313. private _isParentEnabled;
  111314. private _isReady;
  111315. /** @hidden */
  111316. _currentRenderId: number;
  111317. private _parentUpdateId;
  111318. /** @hidden */
  111319. _childUpdateId: number;
  111320. /** @hidden */
  111321. _waitingParentId: Nullable<string>;
  111322. /** @hidden */
  111323. _scene: Scene;
  111324. /** @hidden */
  111325. _cache: any;
  111326. private _parentNode;
  111327. private _children;
  111328. /** @hidden */
  111329. _worldMatrix: Matrix;
  111330. /** @hidden */
  111331. _worldMatrixDeterminant: number;
  111332. /** @hidden */
  111333. _worldMatrixDeterminantIsDirty: boolean;
  111334. /** @hidden */
  111335. private _sceneRootNodesIndex;
  111336. /**
  111337. * Gets a boolean indicating if the node has been disposed
  111338. * @returns true if the node was disposed
  111339. */
  111340. isDisposed(): boolean;
  111341. /**
  111342. * Gets or sets the parent of the node (without keeping the current position in the scene)
  111343. * @see https://doc.babylonjs.com/how_to/parenting
  111344. */
  111345. set parent(parent: Nullable<Node>);
  111346. get parent(): Nullable<Node>;
  111347. /** @hidden */
  111348. _addToSceneRootNodes(): void;
  111349. /** @hidden */
  111350. _removeFromSceneRootNodes(): void;
  111351. private _animationPropertiesOverride;
  111352. /**
  111353. * Gets or sets the animation properties override
  111354. */
  111355. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  111356. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  111357. /**
  111358. * Gets a string idenfifying the name of the class
  111359. * @returns "Node" string
  111360. */
  111361. getClassName(): string;
  111362. /** @hidden */
  111363. readonly _isNode: boolean;
  111364. /**
  111365. * An event triggered when the mesh is disposed
  111366. */
  111367. onDisposeObservable: Observable<Node>;
  111368. private _onDisposeObserver;
  111369. /**
  111370. * Sets a callback that will be raised when the node will be disposed
  111371. */
  111372. set onDispose(callback: () => void);
  111373. /**
  111374. * Creates a new Node
  111375. * @param name the name and id to be given to this node
  111376. * @param scene the scene this node will be added to
  111377. */
  111378. constructor(name: string, scene?: Nullable<Scene>);
  111379. /**
  111380. * Gets the scene of the node
  111381. * @returns a scene
  111382. */
  111383. getScene(): Scene;
  111384. /**
  111385. * Gets the engine of the node
  111386. * @returns a Engine
  111387. */
  111388. getEngine(): Engine;
  111389. private _behaviors;
  111390. /**
  111391. * Attach a behavior to the node
  111392. * @see https://doc.babylonjs.com/features/behaviour
  111393. * @param behavior defines the behavior to attach
  111394. * @param attachImmediately defines that the behavior must be attached even if the scene is still loading
  111395. * @returns the current Node
  111396. */
  111397. addBehavior(behavior: Behavior<Node>, attachImmediately?: boolean): Node;
  111398. /**
  111399. * Remove an attached behavior
  111400. * @see https://doc.babylonjs.com/features/behaviour
  111401. * @param behavior defines the behavior to attach
  111402. * @returns the current Node
  111403. */
  111404. removeBehavior(behavior: Behavior<Node>): Node;
  111405. /**
  111406. * Gets the list of attached behaviors
  111407. * @see https://doc.babylonjs.com/features/behaviour
  111408. */
  111409. get behaviors(): Behavior<Node>[];
  111410. /**
  111411. * Gets an attached behavior by name
  111412. * @param name defines the name of the behavior to look for
  111413. * @see https://doc.babylonjs.com/features/behaviour
  111414. * @returns null if behavior was not found else the requested behavior
  111415. */
  111416. getBehaviorByName(name: string): Nullable<Behavior<Node>>;
  111417. /**
  111418. * Returns the latest update of the World matrix
  111419. * @returns a Matrix
  111420. */
  111421. getWorldMatrix(): Matrix;
  111422. /** @hidden */
  111423. _getWorldMatrixDeterminant(): number;
  111424. /**
  111425. * Returns directly the latest state of the mesh World matrix.
  111426. * A Matrix is returned.
  111427. */
  111428. get worldMatrixFromCache(): Matrix;
  111429. /** @hidden */
  111430. _initCache(): void;
  111431. /** @hidden */
  111432. updateCache(force?: boolean): void;
  111433. /** @hidden */
  111434. _getActionManagerForTrigger(trigger?: number, initialCall?: boolean): Nullable<AbstractActionManager>;
  111435. /** @hidden */
  111436. _updateCache(ignoreParentClass?: boolean): void;
  111437. /** @hidden */
  111438. _isSynchronized(): boolean;
  111439. /** @hidden */
  111440. _markSyncedWithParent(): void;
  111441. /** @hidden */
  111442. isSynchronizedWithParent(): boolean;
  111443. /** @hidden */
  111444. isSynchronized(): boolean;
  111445. /**
  111446. * Is this node ready to be used/rendered
  111447. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  111448. * @return true if the node is ready
  111449. */
  111450. isReady(completeCheck?: boolean): boolean;
  111451. /**
  111452. * Is this node enabled?
  111453. * 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
  111454. * @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
  111455. * @return whether this node (and its parent) is enabled
  111456. */
  111457. isEnabled(checkAncestors?: boolean): boolean;
  111458. /** @hidden */
  111459. protected _syncParentEnabledState(): void;
  111460. /**
  111461. * Set the enabled state of this node
  111462. * @param value defines the new enabled state
  111463. */
  111464. setEnabled(value: boolean): void;
  111465. /**
  111466. * Is this node a descendant of the given node?
  111467. * The function will iterate up the hierarchy until the ancestor was found or no more parents defined
  111468. * @param ancestor defines the parent node to inspect
  111469. * @returns a boolean indicating if this node is a descendant of the given node
  111470. */
  111471. isDescendantOf(ancestor: Node): boolean;
  111472. /** @hidden */
  111473. _getDescendants(results: Node[], directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): void;
  111474. /**
  111475. * Will return all nodes that have this node as ascendant
  111476. * @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
  111477. * @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
  111478. * @return all children nodes of all types
  111479. */
  111480. getDescendants(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): Node[];
  111481. /**
  111482. * Get all child-meshes of this node
  111483. * @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)
  111484. * @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
  111485. * @returns an array of AbstractMesh
  111486. */
  111487. getChildMeshes(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): AbstractMesh[];
  111488. /**
  111489. * Get all direct children of this node
  111490. * @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
  111491. * @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)
  111492. * @returns an array of Node
  111493. */
  111494. getChildren(predicate?: (node: Node) => boolean, directDescendantsOnly?: boolean): Node[];
  111495. /** @hidden */
  111496. _setReady(state: boolean): void;
  111497. /**
  111498. * Get an animation by name
  111499. * @param name defines the name of the animation to look for
  111500. * @returns null if not found else the requested animation
  111501. */
  111502. getAnimationByName(name: string): Nullable<Animation>;
  111503. /**
  111504. * Creates an animation range for this node
  111505. * @param name defines the name of the range
  111506. * @param from defines the starting key
  111507. * @param to defines the end key
  111508. */
  111509. createAnimationRange(name: string, from: number, to: number): void;
  111510. /**
  111511. * Delete a specific animation range
  111512. * @param name defines the name of the range to delete
  111513. * @param deleteFrames defines if animation frames from the range must be deleted as well
  111514. */
  111515. deleteAnimationRange(name: string, deleteFrames?: boolean): void;
  111516. /**
  111517. * Get an animation range by name
  111518. * @param name defines the name of the animation range to look for
  111519. * @returns null if not found else the requested animation range
  111520. */
  111521. getAnimationRange(name: string): Nullable<AnimationRange>;
  111522. /**
  111523. * Gets the list of all animation ranges defined on this node
  111524. * @returns an array
  111525. */
  111526. getAnimationRanges(): Nullable<AnimationRange>[];
  111527. /**
  111528. * Will start the animation sequence
  111529. * @param name defines the range frames for animation sequence
  111530. * @param loop defines if the animation should loop (false by default)
  111531. * @param speedRatio defines the speed factor in which to run the animation (1 by default)
  111532. * @param onAnimationEnd defines a function to be executed when the animation ended (undefined by default)
  111533. * @returns the object created for this animation. If range does not exist, it will return null
  111534. */
  111535. beginAnimation(name: string, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void): Nullable<Animatable>;
  111536. /**
  111537. * Serialize animation ranges into a JSON compatible object
  111538. * @returns serialization object
  111539. */
  111540. serializeAnimationRanges(): any;
  111541. /**
  111542. * Computes the world matrix of the node
  111543. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  111544. * @returns the world matrix
  111545. */
  111546. computeWorldMatrix(force?: boolean): Matrix;
  111547. /**
  111548. * Releases resources associated with this node.
  111549. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  111550. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  111551. */
  111552. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  111553. /**
  111554. * Parse animation range data from a serialization object and store them into a given node
  111555. * @param node defines where to store the animation ranges
  111556. * @param parsedNode defines the serialization object to read data from
  111557. * @param scene defines the hosting scene
  111558. */
  111559. static ParseAnimationRanges(node: Node, parsedNode: any, scene: Scene): void;
  111560. /**
  111561. * Return the minimum and maximum world vectors of the entire hierarchy under current node
  111562. * @param includeDescendants Include bounding info from descendants as well (true by default)
  111563. * @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
  111564. * @returns the new bounding vectors
  111565. */
  111566. getHierarchyBoundingVectors(includeDescendants?: boolean, predicate?: Nullable<(abstractMesh: AbstractMesh) => boolean>): {
  111567. min: Vector3;
  111568. max: Vector3;
  111569. };
  111570. }
  111571. }
  111572. declare module BABYLON {
  111573. /**
  111574. * @hidden
  111575. */
  111576. export class _IAnimationState {
  111577. key: number;
  111578. repeatCount: number;
  111579. workValue?: any;
  111580. loopMode?: number;
  111581. offsetValue?: any;
  111582. highLimitValue?: any;
  111583. }
  111584. /**
  111585. * Class used to store any kind of animation
  111586. */
  111587. export class Animation {
  111588. /**Name of the animation */
  111589. name: string;
  111590. /**Property to animate */
  111591. targetProperty: string;
  111592. /**The frames per second of the animation */
  111593. framePerSecond: number;
  111594. /**The data type of the animation */
  111595. dataType: number;
  111596. /**The loop mode of the animation */
  111597. loopMode?: number | undefined;
  111598. /**Specifies if blending should be enabled */
  111599. enableBlending?: boolean | undefined;
  111600. /**
  111601. * Use matrix interpolation instead of using direct key value when animating matrices
  111602. */
  111603. static AllowMatricesInterpolation: boolean;
  111604. /**
  111605. * When matrix interpolation is enabled, this boolean forces the system to use Matrix.DecomposeLerp instead of Matrix.Lerp. Interpolation is more precise but slower
  111606. */
  111607. static AllowMatrixDecomposeForInterpolation: boolean;
  111608. /** Define the Url to load snippets */
  111609. static SnippetUrl: string;
  111610. /** Snippet ID if the animation was created from the snippet server */
  111611. snippetId: string;
  111612. /**
  111613. * Stores the key frames of the animation
  111614. */
  111615. private _keys;
  111616. /**
  111617. * Stores the easing function of the animation
  111618. */
  111619. private _easingFunction;
  111620. /**
  111621. * @hidden Internal use only
  111622. */
  111623. _runtimeAnimations: RuntimeAnimation[];
  111624. /**
  111625. * The set of event that will be linked to this animation
  111626. */
  111627. private _events;
  111628. /**
  111629. * Stores an array of target property paths
  111630. */
  111631. targetPropertyPath: string[];
  111632. /**
  111633. * Stores the blending speed of the animation
  111634. */
  111635. blendingSpeed: number;
  111636. /**
  111637. * Stores the animation ranges for the animation
  111638. */
  111639. private _ranges;
  111640. /**
  111641. * @hidden Internal use
  111642. */
  111643. static _PrepareAnimation(name: string, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction): Nullable<Animation>;
  111644. /**
  111645. * Sets up an animation
  111646. * @param property The property to animate
  111647. * @param animationType The animation type to apply
  111648. * @param framePerSecond The frames per second of the animation
  111649. * @param easingFunction The easing function used in the animation
  111650. * @returns The created animation
  111651. */
  111652. static CreateAnimation(property: string, animationType: number, framePerSecond: number, easingFunction: EasingFunction): Animation;
  111653. /**
  111654. * Create and start an animation on a node
  111655. * @param name defines the name of the global animation that will be run on all nodes
  111656. * @param node defines the root node where the animation will take place
  111657. * @param targetProperty defines property to animate
  111658. * @param framePerSecond defines the number of frame per second yo use
  111659. * @param totalFrame defines the number of frames in total
  111660. * @param from defines the initial value
  111661. * @param to defines the final value
  111662. * @param loopMode defines which loop mode you want to use (off by default)
  111663. * @param easingFunction defines the easing function to use (linear by default)
  111664. * @param onAnimationEnd defines the callback to call when animation end
  111665. * @returns the animatable created for this animation
  111666. */
  111667. static CreateAndStartAnimation(name: string, node: Node, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction, onAnimationEnd?: () => void): Nullable<Animatable>;
  111668. /**
  111669. * Create and start an animation on a node and its descendants
  111670. * @param name defines the name of the global animation that will be run on all nodes
  111671. * @param node defines the root node where the animation will take place
  111672. * @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
  111673. * @param targetProperty defines property to animate
  111674. * @param framePerSecond defines the number of frame per second to use
  111675. * @param totalFrame defines the number of frames in total
  111676. * @param from defines the initial value
  111677. * @param to defines the final value
  111678. * @param loopMode defines which loop mode you want to use (off by default)
  111679. * @param easingFunction defines the easing function to use (linear by default)
  111680. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  111681. * @returns the list of animatables created for all nodes
  111682. * @example https://www.babylonjs-playground.com/#MH0VLI
  111683. */
  111684. 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[]>;
  111685. /**
  111686. * Creates a new animation, merges it with the existing animations and starts it
  111687. * @param name Name of the animation
  111688. * @param node Node which contains the scene that begins the animations
  111689. * @param targetProperty Specifies which property to animate
  111690. * @param framePerSecond The frames per second of the animation
  111691. * @param totalFrame The total number of frames
  111692. * @param from The frame at the beginning of the animation
  111693. * @param to The frame at the end of the animation
  111694. * @param loopMode Specifies the loop mode of the animation
  111695. * @param easingFunction (Optional) The easing function of the animation, which allow custom mathematical formulas for animations
  111696. * @param onAnimationEnd Callback to run once the animation is complete
  111697. * @returns Nullable animation
  111698. */
  111699. static CreateMergeAndStartAnimation(name: string, node: Node, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction, onAnimationEnd?: () => void): Nullable<Animatable>;
  111700. /**
  111701. * Convert the keyframes for all animations belonging to the group to be relative to a given reference frame.
  111702. * @param sourceAnimation defines the Animation containing keyframes to convert
  111703. * @param referenceFrame defines the frame that keyframes in the range will be relative to
  111704. * @param range defines the name of the AnimationRange belonging to the Animation to convert
  111705. * @param cloneOriginal defines whether or not to clone the animation and convert the clone or convert the original animation (default is false)
  111706. * @param clonedName defines the name of the resulting cloned Animation if cloneOriginal is true
  111707. * @returns a new Animation if cloneOriginal is true or the original Animation if cloneOriginal is false
  111708. */
  111709. static MakeAnimationAdditive(sourceAnimation: Animation, referenceFrame?: number, range?: string, cloneOriginal?: boolean, clonedName?: string): Animation;
  111710. /**
  111711. * Transition property of an host to the target Value
  111712. * @param property The property to transition
  111713. * @param targetValue The target Value of the property
  111714. * @param host The object where the property to animate belongs
  111715. * @param scene Scene used to run the animation
  111716. * @param frameRate Framerate (in frame/s) to use
  111717. * @param transition The transition type we want to use
  111718. * @param duration The duration of the animation, in milliseconds
  111719. * @param onAnimationEnd Callback trigger at the end of the animation
  111720. * @returns Nullable animation
  111721. */
  111722. static TransitionTo(property: string, targetValue: any, host: any, scene: Scene, frameRate: number, transition: Animation, duration: number, onAnimationEnd?: Nullable<() => void>): Nullable<Animatable>;
  111723. /**
  111724. * Return the array of runtime animations currently using this animation
  111725. */
  111726. get runtimeAnimations(): RuntimeAnimation[];
  111727. /**
  111728. * Specifies if any of the runtime animations are currently running
  111729. */
  111730. get hasRunningRuntimeAnimations(): boolean;
  111731. /**
  111732. * Initializes the animation
  111733. * @param name Name of the animation
  111734. * @param targetProperty Property to animate
  111735. * @param framePerSecond The frames per second of the animation
  111736. * @param dataType The data type of the animation
  111737. * @param loopMode The loop mode of the animation
  111738. * @param enableBlending Specifies if blending should be enabled
  111739. */
  111740. constructor(
  111741. /**Name of the animation */
  111742. name: string,
  111743. /**Property to animate */
  111744. targetProperty: string,
  111745. /**The frames per second of the animation */
  111746. framePerSecond: number,
  111747. /**The data type of the animation */
  111748. dataType: number,
  111749. /**The loop mode of the animation */
  111750. loopMode?: number | undefined,
  111751. /**Specifies if blending should be enabled */
  111752. enableBlending?: boolean | undefined);
  111753. /**
  111754. * Converts the animation to a string
  111755. * @param fullDetails support for multiple levels of logging within scene loading
  111756. * @returns String form of the animation
  111757. */
  111758. toString(fullDetails?: boolean): string;
  111759. /**
  111760. * Add an event to this animation
  111761. * @param event Event to add
  111762. */
  111763. addEvent(event: AnimationEvent): void;
  111764. /**
  111765. * Remove all events found at the given frame
  111766. * @param frame The frame to remove events from
  111767. */
  111768. removeEvents(frame: number): void;
  111769. /**
  111770. * Retrieves all the events from the animation
  111771. * @returns Events from the animation
  111772. */
  111773. getEvents(): AnimationEvent[];
  111774. /**
  111775. * Creates an animation range
  111776. * @param name Name of the animation range
  111777. * @param from Starting frame of the animation range
  111778. * @param to Ending frame of the animation
  111779. */
  111780. createRange(name: string, from: number, to: number): void;
  111781. /**
  111782. * Deletes an animation range by name
  111783. * @param name Name of the animation range to delete
  111784. * @param deleteFrames Specifies if the key frames for the range should also be deleted (true) or not (false)
  111785. */
  111786. deleteRange(name: string, deleteFrames?: boolean): void;
  111787. /**
  111788. * Gets the animation range by name, or null if not defined
  111789. * @param name Name of the animation range
  111790. * @returns Nullable animation range
  111791. */
  111792. getRange(name: string): Nullable<AnimationRange>;
  111793. /**
  111794. * Gets the key frames from the animation
  111795. * @returns The key frames of the animation
  111796. */
  111797. getKeys(): Array<IAnimationKey>;
  111798. /**
  111799. * Gets the highest frame rate of the animation
  111800. * @returns Highest frame rate of the animation
  111801. */
  111802. getHighestFrame(): number;
  111803. /**
  111804. * Gets the easing function of the animation
  111805. * @returns Easing function of the animation
  111806. */
  111807. getEasingFunction(): IEasingFunction;
  111808. /**
  111809. * Sets the easing function of the animation
  111810. * @param easingFunction A custom mathematical formula for animation
  111811. */
  111812. setEasingFunction(easingFunction: EasingFunction): void;
  111813. /**
  111814. * Interpolates a scalar linearly
  111815. * @param startValue Start value of the animation curve
  111816. * @param endValue End value of the animation curve
  111817. * @param gradient Scalar amount to interpolate
  111818. * @returns Interpolated scalar value
  111819. */
  111820. floatInterpolateFunction(startValue: number, endValue: number, gradient: number): number;
  111821. /**
  111822. * Interpolates a scalar cubically
  111823. * @param startValue Start value of the animation curve
  111824. * @param outTangent End tangent of the animation
  111825. * @param endValue End value of the animation curve
  111826. * @param inTangent Start tangent of the animation curve
  111827. * @param gradient Scalar amount to interpolate
  111828. * @returns Interpolated scalar value
  111829. */
  111830. floatInterpolateFunctionWithTangents(startValue: number, outTangent: number, endValue: number, inTangent: number, gradient: number): number;
  111831. /**
  111832. * Interpolates a quaternion using a spherical linear interpolation
  111833. * @param startValue Start value of the animation curve
  111834. * @param endValue End value of the animation curve
  111835. * @param gradient Scalar amount to interpolate
  111836. * @returns Interpolated quaternion value
  111837. */
  111838. quaternionInterpolateFunction(startValue: Quaternion, endValue: Quaternion, gradient: number): Quaternion;
  111839. /**
  111840. * Interpolates a quaternion cubically
  111841. * @param startValue Start value of the animation curve
  111842. * @param outTangent End tangent of the animation curve
  111843. * @param endValue End value of the animation curve
  111844. * @param inTangent Start tangent of the animation curve
  111845. * @param gradient Scalar amount to interpolate
  111846. * @returns Interpolated quaternion value
  111847. */
  111848. quaternionInterpolateFunctionWithTangents(startValue: Quaternion, outTangent: Quaternion, endValue: Quaternion, inTangent: Quaternion, gradient: number): Quaternion;
  111849. /**
  111850. * Interpolates a Vector3 linearl
  111851. * @param startValue Start value of the animation curve
  111852. * @param endValue End value of the animation curve
  111853. * @param gradient Scalar amount to interpolate
  111854. * @returns Interpolated scalar value
  111855. */
  111856. vector3InterpolateFunction(startValue: Vector3, endValue: Vector3, gradient: number): Vector3;
  111857. /**
  111858. * Interpolates a Vector3 cubically
  111859. * @param startValue Start value of the animation curve
  111860. * @param outTangent End tangent of the animation
  111861. * @param endValue End value of the animation curve
  111862. * @param inTangent Start tangent of the animation curve
  111863. * @param gradient Scalar amount to interpolate
  111864. * @returns InterpolatedVector3 value
  111865. */
  111866. vector3InterpolateFunctionWithTangents(startValue: Vector3, outTangent: Vector3, endValue: Vector3, inTangent: Vector3, gradient: number): Vector3;
  111867. /**
  111868. * Interpolates a Vector2 linearly
  111869. * @param startValue Start value of the animation curve
  111870. * @param endValue End value of the animation curve
  111871. * @param gradient Scalar amount to interpolate
  111872. * @returns Interpolated Vector2 value
  111873. */
  111874. vector2InterpolateFunction(startValue: Vector2, endValue: Vector2, gradient: number): Vector2;
  111875. /**
  111876. * Interpolates a Vector2 cubically
  111877. * @param startValue Start value of the animation curve
  111878. * @param outTangent End tangent of the animation
  111879. * @param endValue End value of the animation curve
  111880. * @param inTangent Start tangent of the animation curve
  111881. * @param gradient Scalar amount to interpolate
  111882. * @returns Interpolated Vector2 value
  111883. */
  111884. vector2InterpolateFunctionWithTangents(startValue: Vector2, outTangent: Vector2, endValue: Vector2, inTangent: Vector2, gradient: number): Vector2;
  111885. /**
  111886. * Interpolates a size linearly
  111887. * @param startValue Start value of the animation curve
  111888. * @param endValue End value of the animation curve
  111889. * @param gradient Scalar amount to interpolate
  111890. * @returns Interpolated Size value
  111891. */
  111892. sizeInterpolateFunction(startValue: Size, endValue: Size, gradient: number): Size;
  111893. /**
  111894. * Interpolates a Color3 linearly
  111895. * @param startValue Start value of the animation curve
  111896. * @param endValue End value of the animation curve
  111897. * @param gradient Scalar amount to interpolate
  111898. * @returns Interpolated Color3 value
  111899. */
  111900. color3InterpolateFunction(startValue: Color3, endValue: Color3, gradient: number): Color3;
  111901. /**
  111902. * Interpolates a Color4 linearly
  111903. * @param startValue Start value of the animation curve
  111904. * @param endValue End value of the animation curve
  111905. * @param gradient Scalar amount to interpolate
  111906. * @returns Interpolated Color3 value
  111907. */
  111908. color4InterpolateFunction(startValue: Color4, endValue: Color4, gradient: number): Color4;
  111909. /**
  111910. * @hidden Internal use only
  111911. */
  111912. _getKeyValue(value: any): any;
  111913. /**
  111914. * @hidden Internal use only
  111915. */
  111916. _interpolate(currentFrame: number, state: _IAnimationState): any;
  111917. /**
  111918. * Defines the function to use to interpolate matrices
  111919. * @param startValue defines the start matrix
  111920. * @param endValue defines the end matrix
  111921. * @param gradient defines the gradient between both matrices
  111922. * @param result defines an optional target matrix where to store the interpolation
  111923. * @returns the interpolated matrix
  111924. */
  111925. matrixInterpolateFunction(startValue: Matrix, endValue: Matrix, gradient: number, result?: Matrix): Matrix;
  111926. /**
  111927. * Makes a copy of the animation
  111928. * @returns Cloned animation
  111929. */
  111930. clone(): Animation;
  111931. /**
  111932. * Sets the key frames of the animation
  111933. * @param values The animation key frames to set
  111934. */
  111935. setKeys(values: Array<IAnimationKey>): void;
  111936. /**
  111937. * Serializes the animation to an object
  111938. * @returns Serialized object
  111939. */
  111940. serialize(): any;
  111941. /**
  111942. * Float animation type
  111943. */
  111944. static readonly ANIMATIONTYPE_FLOAT: number;
  111945. /**
  111946. * Vector3 animation type
  111947. */
  111948. static readonly ANIMATIONTYPE_VECTOR3: number;
  111949. /**
  111950. * Quaternion animation type
  111951. */
  111952. static readonly ANIMATIONTYPE_QUATERNION: number;
  111953. /**
  111954. * Matrix animation type
  111955. */
  111956. static readonly ANIMATIONTYPE_MATRIX: number;
  111957. /**
  111958. * Color3 animation type
  111959. */
  111960. static readonly ANIMATIONTYPE_COLOR3: number;
  111961. /**
  111962. * Color3 animation type
  111963. */
  111964. static readonly ANIMATIONTYPE_COLOR4: number;
  111965. /**
  111966. * Vector2 animation type
  111967. */
  111968. static readonly ANIMATIONTYPE_VECTOR2: number;
  111969. /**
  111970. * Size animation type
  111971. */
  111972. static readonly ANIMATIONTYPE_SIZE: number;
  111973. /**
  111974. * Relative Loop Mode
  111975. */
  111976. static readonly ANIMATIONLOOPMODE_RELATIVE: number;
  111977. /**
  111978. * Cycle Loop Mode
  111979. */
  111980. static readonly ANIMATIONLOOPMODE_CYCLE: number;
  111981. /**
  111982. * Constant Loop Mode
  111983. */
  111984. static readonly ANIMATIONLOOPMODE_CONSTANT: number;
  111985. /** @hidden */
  111986. static _UniversalLerp(left: any, right: any, amount: number): any;
  111987. /**
  111988. * Parses an animation object and creates an animation
  111989. * @param parsedAnimation Parsed animation object
  111990. * @returns Animation object
  111991. */
  111992. static Parse(parsedAnimation: any): Animation;
  111993. /**
  111994. * Appends the serialized animations from the source animations
  111995. * @param source Source containing the animations
  111996. * @param destination Target to store the animations
  111997. */
  111998. static AppendSerializedAnimations(source: IAnimatable, destination: any): void;
  111999. /**
  112000. * Creates a new animation or an array of animations from a snippet saved in a remote file
  112001. * @param name defines the name of the animation to create (can be null or empty to use the one from the json data)
  112002. * @param url defines the url to load from
  112003. * @returns a promise that will resolve to the new animation or an array of animations
  112004. */
  112005. static ParseFromFileAsync(name: Nullable<string>, url: string): Promise<Animation | Array<Animation>>;
  112006. /**
  112007. * Creates an animation or an array of animations from a snippet saved by the Inspector
  112008. * @param snippetId defines the snippet to load
  112009. * @returns a promise that will resolve to the new animation or a new array of animations
  112010. */
  112011. static CreateFromSnippetAsync(snippetId: string): Promise<Animation | Array<Animation>>;
  112012. }
  112013. }
  112014. declare module BABYLON {
  112015. /**
  112016. * Interface containing an array of animations
  112017. */
  112018. export interface IAnimatable {
  112019. /**
  112020. * Array of animations
  112021. */
  112022. animations: Nullable<Array<Animation>>;
  112023. }
  112024. }
  112025. declare module BABYLON {
  112026. export function expandToProperty(callback: string, targetKey?: Nullable<string>): (target: any, propertyKey: string) => void;
  112027. export function serialize(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  112028. export function serializeAsTexture(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  112029. export function serializeAsColor3(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  112030. export function serializeAsFresnelParameters(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  112031. export function serializeAsVector2(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  112032. export function serializeAsVector3(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  112033. export function serializeAsMeshReference(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  112034. export function serializeAsColorCurves(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  112035. export function serializeAsColor4(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  112036. export function serializeAsImageProcessingConfiguration(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  112037. export function serializeAsQuaternion(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  112038. export function serializeAsMatrix(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  112039. /**
  112040. * Decorator used to define property that can be serialized as reference to a camera
  112041. * @param sourceName defines the name of the property to decorate
  112042. */
  112043. export function serializeAsCameraReference(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  112044. /**
  112045. * Class used to help serialization objects
  112046. */
  112047. export class SerializationHelper {
  112048. /** @hidden */
  112049. static _ImageProcessingConfigurationParser: (sourceProperty: any) => ImageProcessingConfiguration;
  112050. /** @hidden */
  112051. static _FresnelParametersParser: (sourceProperty: any) => FresnelParameters;
  112052. /** @hidden */
  112053. static _ColorCurvesParser: (sourceProperty: any) => ColorCurves;
  112054. /** @hidden */
  112055. static _TextureParser: (sourceProperty: any, scene: Scene, rootUrl: string) => Nullable<BaseTexture>;
  112056. /**
  112057. * Appends the serialized animations from the source animations
  112058. * @param source Source containing the animations
  112059. * @param destination Target to store the animations
  112060. */
  112061. static AppendSerializedAnimations(source: IAnimatable, destination: any): void;
  112062. /**
  112063. * Static function used to serialized a specific entity
  112064. * @param entity defines the entity to serialize
  112065. * @param serializationObject defines the optional target obecjt where serialization data will be stored
  112066. * @returns a JSON compatible object representing the serialization of the entity
  112067. */
  112068. static Serialize<T>(entity: T, serializationObject?: any): any;
  112069. /**
  112070. * Creates a new entity from a serialization data object
  112071. * @param creationFunction defines a function used to instanciated the new entity
  112072. * @param source defines the source serialization data
  112073. * @param scene defines the hosting scene
  112074. * @param rootUrl defines the root url for resources
  112075. * @returns a new entity
  112076. */
  112077. static Parse<T>(creationFunction: () => T, source: any, scene: Nullable<Scene>, rootUrl?: Nullable<string>): T;
  112078. /**
  112079. * Clones an object
  112080. * @param creationFunction defines the function used to instanciate the new object
  112081. * @param source defines the source object
  112082. * @returns the cloned object
  112083. */
  112084. static Clone<T>(creationFunction: () => T, source: T): T;
  112085. /**
  112086. * Instanciates a new object based on a source one (some data will be shared between both object)
  112087. * @param creationFunction defines the function used to instanciate the new object
  112088. * @param source defines the source object
  112089. * @returns the new object
  112090. */
  112091. static Instanciate<T>(creationFunction: () => T, source: T): T;
  112092. }
  112093. }
  112094. declare module BABYLON {
  112095. /**
  112096. * Base class of all the textures in babylon.
  112097. * It groups all the common properties the materials, post process, lights... might need
  112098. * in order to make a correct use of the texture.
  112099. */
  112100. export class BaseTexture implements IAnimatable {
  112101. /**
  112102. * Default anisotropic filtering level for the application.
  112103. * It is set to 4 as a good tradeoff between perf and quality.
  112104. */
  112105. static DEFAULT_ANISOTROPIC_FILTERING_LEVEL: number;
  112106. /**
  112107. * Gets or sets the unique id of the texture
  112108. */
  112109. uniqueId: number;
  112110. /**
  112111. * Define the name of the texture.
  112112. */
  112113. name: string;
  112114. /**
  112115. * Gets or sets an object used to store user defined information.
  112116. */
  112117. metadata: any;
  112118. /**
  112119. * For internal use only. Please do not use.
  112120. */
  112121. reservedDataStore: any;
  112122. private _hasAlpha;
  112123. /**
  112124. * Define if the texture is having a usable alpha value (can be use for transparency or glossiness for instance).
  112125. */
  112126. set hasAlpha(value: boolean);
  112127. get hasAlpha(): boolean;
  112128. /**
  112129. * Defines if the alpha value should be determined via the rgb values.
  112130. * If true the luminance of the pixel might be used to find the corresponding alpha value.
  112131. */
  112132. getAlphaFromRGB: boolean;
  112133. /**
  112134. * Intensity or strength of the texture.
  112135. * It is commonly used by materials to fine tune the intensity of the texture
  112136. */
  112137. level: number;
  112138. /**
  112139. * Define the UV chanel to use starting from 0 and defaulting to 0.
  112140. * This is part of the texture as textures usually maps to one uv set.
  112141. */
  112142. coordinatesIndex: number;
  112143. private _coordinatesMode;
  112144. /**
  112145. * How a texture is mapped.
  112146. *
  112147. * | Value | Type | Description |
  112148. * | ----- | ----------------------------------- | ----------- |
  112149. * | 0 | EXPLICIT_MODE | |
  112150. * | 1 | SPHERICAL_MODE | |
  112151. * | 2 | PLANAR_MODE | |
  112152. * | 3 | CUBIC_MODE | |
  112153. * | 4 | PROJECTION_MODE | |
  112154. * | 5 | SKYBOX_MODE | |
  112155. * | 6 | INVCUBIC_MODE | |
  112156. * | 7 | EQUIRECTANGULAR_MODE | |
  112157. * | 8 | FIXED_EQUIRECTANGULAR_MODE | |
  112158. * | 9 | FIXED_EQUIRECTANGULAR_MIRRORED_MODE | |
  112159. */
  112160. set coordinatesMode(value: number);
  112161. get coordinatesMode(): number;
  112162. /**
  112163. * | Value | Type | Description |
  112164. * | ----- | ------------------ | ----------- |
  112165. * | 0 | CLAMP_ADDRESSMODE | |
  112166. * | 1 | WRAP_ADDRESSMODE | |
  112167. * | 2 | MIRROR_ADDRESSMODE | |
  112168. */
  112169. wrapU: number;
  112170. /**
  112171. * | Value | Type | Description |
  112172. * | ----- | ------------------ | ----------- |
  112173. * | 0 | CLAMP_ADDRESSMODE | |
  112174. * | 1 | WRAP_ADDRESSMODE | |
  112175. * | 2 | MIRROR_ADDRESSMODE | |
  112176. */
  112177. wrapV: number;
  112178. /**
  112179. * | Value | Type | Description |
  112180. * | ----- | ------------------ | ----------- |
  112181. * | 0 | CLAMP_ADDRESSMODE | |
  112182. * | 1 | WRAP_ADDRESSMODE | |
  112183. * | 2 | MIRROR_ADDRESSMODE | |
  112184. */
  112185. wrapR: number;
  112186. /**
  112187. * With compliant hardware and browser (supporting anisotropic filtering)
  112188. * this defines the level of anisotropic filtering in the texture.
  112189. * The higher the better but the slower. This defaults to 4 as it seems to be the best tradeoff.
  112190. */
  112191. anisotropicFilteringLevel: number;
  112192. /**
  112193. * Define if the texture is a cube texture or if false a 2d texture.
  112194. */
  112195. get isCube(): boolean;
  112196. set isCube(value: boolean);
  112197. /**
  112198. * Define if the texture is a 3d texture (webgl 2) or if false a 2d texture.
  112199. */
  112200. get is3D(): boolean;
  112201. set is3D(value: boolean);
  112202. /**
  112203. * Define if the texture is a 2d array texture (webgl 2) or if false a 2d texture.
  112204. */
  112205. get is2DArray(): boolean;
  112206. set is2DArray(value: boolean);
  112207. /**
  112208. * Define if the texture contains data in gamma space (most of the png/jpg aside bump).
  112209. * HDR texture are usually stored in linear space.
  112210. * This only impacts the PBR and Background materials
  112211. */
  112212. gammaSpace: boolean;
  112213. /**
  112214. * Gets or sets whether or not the texture contains RGBD data.
  112215. */
  112216. get isRGBD(): boolean;
  112217. set isRGBD(value: boolean);
  112218. /**
  112219. * Is Z inverted in the texture (useful in a cube texture).
  112220. */
  112221. invertZ: boolean;
  112222. /**
  112223. * Are mip maps generated for this texture or not.
  112224. */
  112225. get noMipmap(): boolean;
  112226. /**
  112227. * @hidden
  112228. */
  112229. lodLevelInAlpha: boolean;
  112230. /**
  112231. * With prefiltered texture, defined the offset used during the prefiltering steps.
  112232. */
  112233. get lodGenerationOffset(): number;
  112234. set lodGenerationOffset(value: number);
  112235. /**
  112236. * With prefiltered texture, defined the scale used during the prefiltering steps.
  112237. */
  112238. get lodGenerationScale(): number;
  112239. set lodGenerationScale(value: number);
  112240. /**
  112241. * With prefiltered texture, defined if the specular generation is based on a linear ramp.
  112242. * By default we are using a log2 of the linear roughness helping to keep a better resolution for
  112243. * average roughness values.
  112244. */
  112245. get linearSpecularLOD(): boolean;
  112246. set linearSpecularLOD(value: boolean);
  112247. /**
  112248. * In case a better definition than spherical harmonics is required for the diffuse part of the environment.
  112249. * You can set the irradiance texture to rely on a texture instead of the spherical approach.
  112250. * This texture need to have the same characteristics than its parent (Cube vs 2d, coordinates mode, Gamma/Linear, RGBD).
  112251. */
  112252. get irradianceTexture(): Nullable<BaseTexture>;
  112253. set irradianceTexture(value: Nullable<BaseTexture>);
  112254. /**
  112255. * Define if the texture is a render target.
  112256. */
  112257. isRenderTarget: boolean;
  112258. /**
  112259. * Define the unique id of the texture in the scene.
  112260. */
  112261. get uid(): string;
  112262. /** @hidden */
  112263. _prefiltered: boolean;
  112264. /**
  112265. * Return a string representation of the texture.
  112266. * @returns the texture as a string
  112267. */
  112268. toString(): string;
  112269. /**
  112270. * Get the class name of the texture.
  112271. * @returns "BaseTexture"
  112272. */
  112273. getClassName(): string;
  112274. /**
  112275. * Define the list of animation attached to the texture.
  112276. */
  112277. animations: Animation[];
  112278. /**
  112279. * An event triggered when the texture is disposed.
  112280. */
  112281. onDisposeObservable: Observable<BaseTexture>;
  112282. private _onDisposeObserver;
  112283. /**
  112284. * Callback triggered when the texture has been disposed.
  112285. * Kept for back compatibility, you can use the onDisposeObservable instead.
  112286. */
  112287. set onDispose(callback: () => void);
  112288. /**
  112289. * Define the current state of the loading sequence when in delayed load mode.
  112290. */
  112291. delayLoadState: number;
  112292. private _scene;
  112293. private _engine;
  112294. /** @hidden */
  112295. _texture: Nullable<InternalTexture>;
  112296. private _uid;
  112297. /**
  112298. * Define if the texture is preventinga material to render or not.
  112299. * If not and the texture is not ready, the engine will use a default black texture instead.
  112300. */
  112301. get isBlocking(): boolean;
  112302. /**
  112303. * Instantiates a new BaseTexture.
  112304. * Base class of all the textures in babylon.
  112305. * It groups all the common properties the materials, post process, lights... might need
  112306. * in order to make a correct use of the texture.
  112307. * @param sceneOrEngine Define the scene or engine the texture blongs to
  112308. */
  112309. constructor(sceneOrEngine: Nullable<Scene | ThinEngine>);
  112310. /**
  112311. * Get the scene the texture belongs to.
  112312. * @returns the scene or null if undefined
  112313. */
  112314. getScene(): Nullable<Scene>;
  112315. /** @hidden */
  112316. protected _getEngine(): Nullable<ThinEngine>;
  112317. /**
  112318. * Get the texture transform matrix used to offset tile the texture for istance.
  112319. * @returns the transformation matrix
  112320. */
  112321. getTextureMatrix(): Matrix;
  112322. /**
  112323. * Get the texture reflection matrix used to rotate/transform the reflection.
  112324. * @returns the reflection matrix
  112325. */
  112326. getReflectionTextureMatrix(): Matrix;
  112327. /**
  112328. * Get the underlying lower level texture from Babylon.
  112329. * @returns the insternal texture
  112330. */
  112331. getInternalTexture(): Nullable<InternalTexture>;
  112332. /**
  112333. * Get if the texture is ready to be consumed (either it is ready or it is not blocking)
  112334. * @returns true if ready or not blocking
  112335. */
  112336. isReadyOrNotBlocking(): boolean;
  112337. /**
  112338. * Get if the texture is ready to be used (downloaded, converted, mip mapped...).
  112339. * @returns true if fully ready
  112340. */
  112341. isReady(): boolean;
  112342. private _cachedSize;
  112343. /**
  112344. * Get the size of the texture.
  112345. * @returns the texture size.
  112346. */
  112347. getSize(): ISize;
  112348. /**
  112349. * Get the base size of the texture.
  112350. * It can be different from the size if the texture has been resized for POT for instance
  112351. * @returns the base size
  112352. */
  112353. getBaseSize(): ISize;
  112354. /**
  112355. * Update the sampling mode of the texture.
  112356. * Default is Trilinear mode.
  112357. *
  112358. * | Value | Type | Description |
  112359. * | ----- | ------------------ | ----------- |
  112360. * | 1 | NEAREST_SAMPLINGMODE or NEAREST_NEAREST_MIPLINEAR | Nearest is: mag = nearest, min = nearest, mip = linear |
  112361. * | 2 | BILINEAR_SAMPLINGMODE or LINEAR_LINEAR_MIPNEAREST | Bilinear is: mag = linear, min = linear, mip = nearest |
  112362. * | 3 | TRILINEAR_SAMPLINGMODE or LINEAR_LINEAR_MIPLINEAR | Trilinear is: mag = linear, min = linear, mip = linear |
  112363. * | 4 | NEAREST_NEAREST_MIPNEAREST | |
  112364. * | 5 | NEAREST_LINEAR_MIPNEAREST | |
  112365. * | 6 | NEAREST_LINEAR_MIPLINEAR | |
  112366. * | 7 | NEAREST_LINEAR | |
  112367. * | 8 | NEAREST_NEAREST | |
  112368. * | 9 | LINEAR_NEAREST_MIPNEAREST | |
  112369. * | 10 | LINEAR_NEAREST_MIPLINEAR | |
  112370. * | 11 | LINEAR_LINEAR | |
  112371. * | 12 | LINEAR_NEAREST | |
  112372. *
  112373. * > _mag_: magnification filter (close to the viewer)
  112374. * > _min_: minification filter (far from the viewer)
  112375. * > _mip_: filter used between mip map levels
  112376. *@param samplingMode Define the new sampling mode of the texture
  112377. */
  112378. updateSamplingMode(samplingMode: number): void;
  112379. /**
  112380. * Scales the texture if is `canRescale()`
  112381. * @param ratio the resize factor we want to use to rescale
  112382. */
  112383. scale(ratio: number): void;
  112384. /**
  112385. * Get if the texture can rescale.
  112386. */
  112387. get canRescale(): boolean;
  112388. /** @hidden */
  112389. _getFromCache(url: Nullable<string>, noMipmap: boolean, sampling?: number, invertY?: boolean): Nullable<InternalTexture>;
  112390. /** @hidden */
  112391. _rebuild(): void;
  112392. /**
  112393. * Triggers the load sequence in delayed load mode.
  112394. */
  112395. delayLoad(): void;
  112396. /**
  112397. * Clones the texture.
  112398. * @returns the cloned texture
  112399. */
  112400. clone(): Nullable<BaseTexture>;
  112401. /**
  112402. * Get the texture underlying type (INT, FLOAT...)
  112403. */
  112404. get textureType(): number;
  112405. /**
  112406. * Get the texture underlying format (RGB, RGBA...)
  112407. */
  112408. get textureFormat(): number;
  112409. /**
  112410. * Indicates that textures need to be re-calculated for all materials
  112411. */
  112412. protected _markAllSubMeshesAsTexturesDirty(): void;
  112413. /**
  112414. * Reads the pixels stored in the webgl texture and returns them as an ArrayBuffer.
  112415. * This will returns an RGBA array buffer containing either in values (0-255) or
  112416. * float values (0-1) depending of the underlying buffer type.
  112417. * @param faceIndex defines the face of the texture to read (in case of cube texture)
  112418. * @param level defines the LOD level of the texture to read (in case of Mip Maps)
  112419. * @param buffer defines a user defined buffer to fill with data (can be null)
  112420. * @returns The Array buffer containing the pixels data.
  112421. */
  112422. readPixels(faceIndex?: number, level?: number, buffer?: Nullable<ArrayBufferView>): Nullable<ArrayBufferView>;
  112423. /**
  112424. * Release and destroy the underlying lower level texture aka internalTexture.
  112425. */
  112426. releaseInternalTexture(): void;
  112427. /** @hidden */
  112428. get _lodTextureHigh(): Nullable<BaseTexture>;
  112429. /** @hidden */
  112430. get _lodTextureMid(): Nullable<BaseTexture>;
  112431. /** @hidden */
  112432. get _lodTextureLow(): Nullable<BaseTexture>;
  112433. /**
  112434. * Dispose the texture and release its associated resources.
  112435. */
  112436. dispose(): void;
  112437. /**
  112438. * Serialize the texture into a JSON representation that can be parsed later on.
  112439. * @returns the JSON representation of the texture
  112440. */
  112441. serialize(): any;
  112442. /**
  112443. * Helper function to be called back once a list of texture contains only ready textures.
  112444. * @param textures Define the list of textures to wait for
  112445. * @param callback Define the callback triggered once the entire list will be ready
  112446. */
  112447. static WhenAllReady(textures: BaseTexture[], callback: () => void): void;
  112448. private static _isScene;
  112449. }
  112450. }
  112451. declare module BABYLON {
  112452. /**
  112453. * Options to be used when creating an effect.
  112454. */
  112455. export interface IEffectCreationOptions {
  112456. /**
  112457. * Atrributes that will be used in the shader.
  112458. */
  112459. attributes: string[];
  112460. /**
  112461. * Uniform varible names that will be set in the shader.
  112462. */
  112463. uniformsNames: string[];
  112464. /**
  112465. * Uniform buffer variable names that will be set in the shader.
  112466. */
  112467. uniformBuffersNames: string[];
  112468. /**
  112469. * Sampler texture variable names that will be set in the shader.
  112470. */
  112471. samplers: string[];
  112472. /**
  112473. * Define statements that will be set in the shader.
  112474. */
  112475. defines: any;
  112476. /**
  112477. * Possible fallbacks for this effect to improve performance when needed.
  112478. */
  112479. fallbacks: Nullable<IEffectFallbacks>;
  112480. /**
  112481. * Callback that will be called when the shader is compiled.
  112482. */
  112483. onCompiled: Nullable<(effect: Effect) => void>;
  112484. /**
  112485. * Callback that will be called if an error occurs during shader compilation.
  112486. */
  112487. onError: Nullable<(effect: Effect, errors: string) => void>;
  112488. /**
  112489. * Parameters to be used with Babylons include syntax to iterate over an array (eg. {lights: 10})
  112490. */
  112491. indexParameters?: any;
  112492. /**
  112493. * Max number of lights that can be used in the shader.
  112494. */
  112495. maxSimultaneousLights?: number;
  112496. /**
  112497. * See https://developer.mozilla.org/en-US/docs/Web/API/WebGL2RenderingContext/transformFeedbackVaryings
  112498. */
  112499. transformFeedbackVaryings?: Nullable<string[]>;
  112500. /**
  112501. * 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
  112502. */
  112503. processFinalCode?: Nullable<(shaderType: string, code: string) => string>;
  112504. /**
  112505. * Is this effect rendering to several color attachments ?
  112506. */
  112507. multiTarget?: boolean;
  112508. }
  112509. /**
  112510. * Effect containing vertex and fragment shader that can be executed on an object.
  112511. */
  112512. export class Effect implements IDisposable {
  112513. /**
  112514. * Gets or sets the relative url used to load shaders if using the engine in non-minified mode
  112515. */
  112516. static ShadersRepository: string;
  112517. /**
  112518. * Enable logging of the shader code when a compilation error occurs
  112519. */
  112520. static LogShaderCodeOnCompilationError: boolean;
  112521. /**
  112522. * Name of the effect.
  112523. */
  112524. name: any;
  112525. /**
  112526. * String container all the define statements that should be set on the shader.
  112527. */
  112528. defines: string;
  112529. /**
  112530. * Callback that will be called when the shader is compiled.
  112531. */
  112532. onCompiled: Nullable<(effect: Effect) => void>;
  112533. /**
  112534. * Callback that will be called if an error occurs during shader compilation.
  112535. */
  112536. onError: Nullable<(effect: Effect, errors: string) => void>;
  112537. /**
  112538. * Callback that will be called when effect is bound.
  112539. */
  112540. onBind: Nullable<(effect: Effect) => void>;
  112541. /**
  112542. * Unique ID of the effect.
  112543. */
  112544. uniqueId: number;
  112545. /**
  112546. * Observable that will be called when the shader is compiled.
  112547. * It is recommended to use executeWhenCompile() or to make sure that scene.isReady() is called to get this observable raised.
  112548. */
  112549. onCompileObservable: Observable<Effect>;
  112550. /**
  112551. * Observable that will be called if an error occurs during shader compilation.
  112552. */
  112553. onErrorObservable: Observable<Effect>;
  112554. /** @hidden */
  112555. _onBindObservable: Nullable<Observable<Effect>>;
  112556. /**
  112557. * @hidden
  112558. * Specifies if the effect was previously ready
  112559. */
  112560. _wasPreviouslyReady: boolean;
  112561. /**
  112562. * Observable that will be called when effect is bound.
  112563. */
  112564. get onBindObservable(): Observable<Effect>;
  112565. /** @hidden */
  112566. _bonesComputationForcedToCPU: boolean;
  112567. /** @hidden */
  112568. _multiTarget: boolean;
  112569. private static _uniqueIdSeed;
  112570. private _engine;
  112571. private _uniformBuffersNames;
  112572. private _uniformBuffersNamesList;
  112573. private _uniformsNames;
  112574. private _samplerList;
  112575. private _samplers;
  112576. private _isReady;
  112577. private _compilationError;
  112578. private _allFallbacksProcessed;
  112579. private _attributesNames;
  112580. private _attributes;
  112581. private _attributeLocationByName;
  112582. private _uniforms;
  112583. /**
  112584. * Key for the effect.
  112585. * @hidden
  112586. */
  112587. _key: string;
  112588. private _indexParameters;
  112589. private _fallbacks;
  112590. private _vertexSourceCode;
  112591. private _fragmentSourceCode;
  112592. private _vertexSourceCodeOverride;
  112593. private _fragmentSourceCodeOverride;
  112594. private _transformFeedbackVaryings;
  112595. /**
  112596. * Compiled shader to webGL program.
  112597. * @hidden
  112598. */
  112599. _pipelineContext: Nullable<IPipelineContext>;
  112600. private _valueCache;
  112601. private static _baseCache;
  112602. /**
  112603. * Instantiates an effect.
  112604. * An effect can be used to create/manage/execute vertex and fragment shaders.
  112605. * @param baseName Name of the effect.
  112606. * @param attributesNamesOrOptions List of attribute names that will be passed to the shader or set of all options to create the effect.
  112607. * @param uniformsNamesOrEngine List of uniform variable names that will be passed to the shader or the engine that will be used to render effect.
  112608. * @param samplers List of sampler variables that will be passed to the shader.
  112609. * @param engine Engine to be used to render the effect
  112610. * @param defines Define statements to be added to the shader.
  112611. * @param fallbacks Possible fallbacks for this effect to improve performance when needed.
  112612. * @param onCompiled Callback that will be called when the shader is compiled.
  112613. * @param onError Callback that will be called if an error occurs during shader compilation.
  112614. * @param indexParameters Parameters to be used with Babylons include syntax to iterate over an array (eg. {lights: 10})
  112615. */
  112616. 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);
  112617. private _useFinalCode;
  112618. /**
  112619. * Unique key for this effect
  112620. */
  112621. get key(): string;
  112622. /**
  112623. * If the effect has been compiled and prepared.
  112624. * @returns if the effect is compiled and prepared.
  112625. */
  112626. isReady(): boolean;
  112627. private _isReadyInternal;
  112628. /**
  112629. * The engine the effect was initialized with.
  112630. * @returns the engine.
  112631. */
  112632. getEngine(): Engine;
  112633. /**
  112634. * The pipeline context for this effect
  112635. * @returns the associated pipeline context
  112636. */
  112637. getPipelineContext(): Nullable<IPipelineContext>;
  112638. /**
  112639. * The set of names of attribute variables for the shader.
  112640. * @returns An array of attribute names.
  112641. */
  112642. getAttributesNames(): string[];
  112643. /**
  112644. * Returns the attribute at the given index.
  112645. * @param index The index of the attribute.
  112646. * @returns The location of the attribute.
  112647. */
  112648. getAttributeLocation(index: number): number;
  112649. /**
  112650. * Returns the attribute based on the name of the variable.
  112651. * @param name of the attribute to look up.
  112652. * @returns the attribute location.
  112653. */
  112654. getAttributeLocationByName(name: string): number;
  112655. /**
  112656. * The number of attributes.
  112657. * @returns the numnber of attributes.
  112658. */
  112659. getAttributesCount(): number;
  112660. /**
  112661. * Gets the index of a uniform variable.
  112662. * @param uniformName of the uniform to look up.
  112663. * @returns the index.
  112664. */
  112665. getUniformIndex(uniformName: string): number;
  112666. /**
  112667. * Returns the attribute based on the name of the variable.
  112668. * @param uniformName of the uniform to look up.
  112669. * @returns the location of the uniform.
  112670. */
  112671. getUniform(uniformName: string): Nullable<WebGLUniformLocation>;
  112672. /**
  112673. * Returns an array of sampler variable names
  112674. * @returns The array of sampler variable names.
  112675. */
  112676. getSamplers(): string[];
  112677. /**
  112678. * Returns an array of uniform variable names
  112679. * @returns The array of uniform variable names.
  112680. */
  112681. getUniformNames(): string[];
  112682. /**
  112683. * Returns an array of uniform buffer variable names
  112684. * @returns The array of uniform buffer variable names.
  112685. */
  112686. getUniformBuffersNames(): string[];
  112687. /**
  112688. * Returns the index parameters used to create the effect
  112689. * @returns The index parameters object
  112690. */
  112691. getIndexParameters(): any;
  112692. /**
  112693. * The error from the last compilation.
  112694. * @returns the error string.
  112695. */
  112696. getCompilationError(): string;
  112697. /**
  112698. * Gets a boolean indicating that all fallbacks were used during compilation
  112699. * @returns true if all fallbacks were used
  112700. */
  112701. allFallbacksProcessed(): boolean;
  112702. /**
  112703. * Adds a callback to the onCompiled observable and call the callback imediatly if already ready.
  112704. * @param func The callback to be used.
  112705. */
  112706. executeWhenCompiled(func: (effect: Effect) => void): void;
  112707. private _checkIsReady;
  112708. private _loadShader;
  112709. /**
  112710. * Gets the vertex shader source code of this effect
  112711. */
  112712. get vertexSourceCode(): string;
  112713. /**
  112714. * Gets the fragment shader source code of this effect
  112715. */
  112716. get fragmentSourceCode(): string;
  112717. /**
  112718. * Recompiles the webGL program
  112719. * @param vertexSourceCode The source code for the vertex shader.
  112720. * @param fragmentSourceCode The source code for the fragment shader.
  112721. * @param onCompiled Callback called when completed.
  112722. * @param onError Callback called on error.
  112723. * @hidden
  112724. */
  112725. _rebuildProgram(vertexSourceCode: string, fragmentSourceCode: string, onCompiled: (pipelineContext: IPipelineContext) => void, onError: (message: string) => void): void;
  112726. /**
  112727. * Prepares the effect
  112728. * @hidden
  112729. */
  112730. _prepareEffect(): void;
  112731. private _getShaderCodeAndErrorLine;
  112732. private _processCompilationErrors;
  112733. /**
  112734. * Checks if the effect is supported. (Must be called after compilation)
  112735. */
  112736. get isSupported(): boolean;
  112737. /**
  112738. * Binds a texture to the engine to be used as output of the shader.
  112739. * @param channel Name of the output variable.
  112740. * @param texture Texture to bind.
  112741. * @hidden
  112742. */
  112743. _bindTexture(channel: string, texture: Nullable<InternalTexture>): void;
  112744. /**
  112745. * Sets a texture on the engine to be used in the shader.
  112746. * @param channel Name of the sampler variable.
  112747. * @param texture Texture to set.
  112748. */
  112749. setTexture(channel: string, texture: Nullable<BaseTexture>): void;
  112750. /**
  112751. * Sets a depth stencil texture from a render target on the engine to be used in the shader.
  112752. * @param channel Name of the sampler variable.
  112753. * @param texture Texture to set.
  112754. */
  112755. setDepthStencilTexture(channel: string, texture: Nullable<RenderTargetTexture>): void;
  112756. /**
  112757. * Sets an array of textures on the engine to be used in the shader.
  112758. * @param channel Name of the variable.
  112759. * @param textures Textures to set.
  112760. */
  112761. setTextureArray(channel: string, textures: BaseTexture[]): void;
  112762. /**
  112763. * 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)
  112764. * @param channel Name of the sampler variable.
  112765. * @param postProcess Post process to get the input texture from.
  112766. */
  112767. setTextureFromPostProcess(channel: string, postProcess: Nullable<PostProcess>): void;
  112768. /**
  112769. * (Warning! setTextureFromPostProcessOutput may be desired instead)
  112770. * 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)
  112771. * @param channel Name of the sampler variable.
  112772. * @param postProcess Post process to get the output texture from.
  112773. */
  112774. setTextureFromPostProcessOutput(channel: string, postProcess: Nullable<PostProcess>): void;
  112775. /** @hidden */
  112776. _cacheMatrix(uniformName: string, matrix: IMatrixLike): boolean;
  112777. /** @hidden */
  112778. _cacheFloat2(uniformName: string, x: number, y: number): boolean;
  112779. /** @hidden */
  112780. _cacheFloat3(uniformName: string, x: number, y: number, z: number): boolean;
  112781. /** @hidden */
  112782. _cacheFloat4(uniformName: string, x: number, y: number, z: number, w: number): boolean;
  112783. /**
  112784. * Binds a buffer to a uniform.
  112785. * @param buffer Buffer to bind.
  112786. * @param name Name of the uniform variable to bind to.
  112787. */
  112788. bindUniformBuffer(buffer: DataBuffer, name: string): void;
  112789. /**
  112790. * Binds block to a uniform.
  112791. * @param blockName Name of the block to bind.
  112792. * @param index Index to bind.
  112793. */
  112794. bindUniformBlock(blockName: string, index: number): void;
  112795. /**
  112796. * Sets an interger value on a uniform variable.
  112797. * @param uniformName Name of the variable.
  112798. * @param value Value to be set.
  112799. * @returns this effect.
  112800. */
  112801. setInt(uniformName: string, value: number): Effect;
  112802. /**
  112803. * Sets an int array on a uniform variable.
  112804. * @param uniformName Name of the variable.
  112805. * @param array array to be set.
  112806. * @returns this effect.
  112807. */
  112808. setIntArray(uniformName: string, array: Int32Array): Effect;
  112809. /**
  112810. * 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)
  112811. * @param uniformName Name of the variable.
  112812. * @param array array to be set.
  112813. * @returns this effect.
  112814. */
  112815. setIntArray2(uniformName: string, array: Int32Array): Effect;
  112816. /**
  112817. * 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)
  112818. * @param uniformName Name of the variable.
  112819. * @param array array to be set.
  112820. * @returns this effect.
  112821. */
  112822. setIntArray3(uniformName: string, array: Int32Array): Effect;
  112823. /**
  112824. * 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)
  112825. * @param uniformName Name of the variable.
  112826. * @param array array to be set.
  112827. * @returns this effect.
  112828. */
  112829. setIntArray4(uniformName: string, array: Int32Array): Effect;
  112830. /**
  112831. * Sets an float array on a uniform variable.
  112832. * @param uniformName Name of the variable.
  112833. * @param array array to be set.
  112834. * @returns this effect.
  112835. */
  112836. setFloatArray(uniformName: string, array: Float32Array): Effect;
  112837. /**
  112838. * 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)
  112839. * @param uniformName Name of the variable.
  112840. * @param array array to be set.
  112841. * @returns this effect.
  112842. */
  112843. setFloatArray2(uniformName: string, array: Float32Array): Effect;
  112844. /**
  112845. * 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)
  112846. * @param uniformName Name of the variable.
  112847. * @param array array to be set.
  112848. * @returns this effect.
  112849. */
  112850. setFloatArray3(uniformName: string, array: Float32Array): Effect;
  112851. /**
  112852. * 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)
  112853. * @param uniformName Name of the variable.
  112854. * @param array array to be set.
  112855. * @returns this effect.
  112856. */
  112857. setFloatArray4(uniformName: string, array: Float32Array): Effect;
  112858. /**
  112859. * Sets an array on a uniform variable.
  112860. * @param uniformName Name of the variable.
  112861. * @param array array to be set.
  112862. * @returns this effect.
  112863. */
  112864. setArray(uniformName: string, array: number[]): Effect;
  112865. /**
  112866. * 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)
  112867. * @param uniformName Name of the variable.
  112868. * @param array array to be set.
  112869. * @returns this effect.
  112870. */
  112871. setArray2(uniformName: string, array: number[]): Effect;
  112872. /**
  112873. * 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)
  112874. * @param uniformName Name of the variable.
  112875. * @param array array to be set.
  112876. * @returns this effect.
  112877. */
  112878. setArray3(uniformName: string, array: number[]): Effect;
  112879. /**
  112880. * 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)
  112881. * @param uniformName Name of the variable.
  112882. * @param array array to be set.
  112883. * @returns this effect.
  112884. */
  112885. setArray4(uniformName: string, array: number[]): Effect;
  112886. /**
  112887. * Sets matrices on a uniform variable.
  112888. * @param uniformName Name of the variable.
  112889. * @param matrices matrices to be set.
  112890. * @returns this effect.
  112891. */
  112892. setMatrices(uniformName: string, matrices: Float32Array | Array<number>): Effect;
  112893. /**
  112894. * Sets matrix on a uniform variable.
  112895. * @param uniformName Name of the variable.
  112896. * @param matrix matrix to be set.
  112897. * @returns this effect.
  112898. */
  112899. setMatrix(uniformName: string, matrix: IMatrixLike): Effect;
  112900. /**
  112901. * 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)
  112902. * @param uniformName Name of the variable.
  112903. * @param matrix matrix to be set.
  112904. * @returns this effect.
  112905. */
  112906. setMatrix3x3(uniformName: string, matrix: Float32Array | Array<number>): Effect;
  112907. /**
  112908. * Sets a 2x2 matrix on a uniform variable. (Speicified as [1,2,3,4] will result in [1,2][3,4] matrix)
  112909. * @param uniformName Name of the variable.
  112910. * @param matrix matrix to be set.
  112911. * @returns this effect.
  112912. */
  112913. setMatrix2x2(uniformName: string, matrix: Float32Array | Array<number>): Effect;
  112914. /**
  112915. * Sets a float on a uniform variable.
  112916. * @param uniformName Name of the variable.
  112917. * @param value value to be set.
  112918. * @returns this effect.
  112919. */
  112920. setFloat(uniformName: string, value: number): Effect;
  112921. /**
  112922. * Sets a boolean on a uniform variable.
  112923. * @param uniformName Name of the variable.
  112924. * @param bool value to be set.
  112925. * @returns this effect.
  112926. */
  112927. setBool(uniformName: string, bool: boolean): Effect;
  112928. /**
  112929. * Sets a Vector2 on a uniform variable.
  112930. * @param uniformName Name of the variable.
  112931. * @param vector2 vector2 to be set.
  112932. * @returns this effect.
  112933. */
  112934. setVector2(uniformName: string, vector2: IVector2Like): Effect;
  112935. /**
  112936. * Sets a float2 on a uniform variable.
  112937. * @param uniformName Name of the variable.
  112938. * @param x First float in float2.
  112939. * @param y Second float in float2.
  112940. * @returns this effect.
  112941. */
  112942. setFloat2(uniformName: string, x: number, y: number): Effect;
  112943. /**
  112944. * Sets a Vector3 on a uniform variable.
  112945. * @param uniformName Name of the variable.
  112946. * @param vector3 Value to be set.
  112947. * @returns this effect.
  112948. */
  112949. setVector3(uniformName: string, vector3: IVector3Like): Effect;
  112950. /**
  112951. * Sets a float3 on a uniform variable.
  112952. * @param uniformName Name of the variable.
  112953. * @param x First float in float3.
  112954. * @param y Second float in float3.
  112955. * @param z Third float in float3.
  112956. * @returns this effect.
  112957. */
  112958. setFloat3(uniformName: string, x: number, y: number, z: number): Effect;
  112959. /**
  112960. * Sets a Vector4 on a uniform variable.
  112961. * @param uniformName Name of the variable.
  112962. * @param vector4 Value to be set.
  112963. * @returns this effect.
  112964. */
  112965. setVector4(uniformName: string, vector4: IVector4Like): Effect;
  112966. /**
  112967. * Sets a float4 on a uniform variable.
  112968. * @param uniformName Name of the variable.
  112969. * @param x First float in float4.
  112970. * @param y Second float in float4.
  112971. * @param z Third float in float4.
  112972. * @param w Fourth float in float4.
  112973. * @returns this effect.
  112974. */
  112975. setFloat4(uniformName: string, x: number, y: number, z: number, w: number): Effect;
  112976. /**
  112977. * Sets a Color3 on a uniform variable.
  112978. * @param uniformName Name of the variable.
  112979. * @param color3 Value to be set.
  112980. * @returns this effect.
  112981. */
  112982. setColor3(uniformName: string, color3: IColor3Like): Effect;
  112983. /**
  112984. * Sets a Color4 on a uniform variable.
  112985. * @param uniformName Name of the variable.
  112986. * @param color3 Value to be set.
  112987. * @param alpha Alpha value to be set.
  112988. * @returns this effect.
  112989. */
  112990. setColor4(uniformName: string, color3: IColor3Like, alpha: number): Effect;
  112991. /**
  112992. * Sets a Color4 on a uniform variable
  112993. * @param uniformName defines the name of the variable
  112994. * @param color4 defines the value to be set
  112995. * @returns this effect.
  112996. */
  112997. setDirectColor4(uniformName: string, color4: IColor4Like): Effect;
  112998. /** Release all associated resources */
  112999. dispose(): void;
  113000. /**
  113001. * This function will add a new shader to the shader store
  113002. * @param name the name of the shader
  113003. * @param pixelShader optional pixel shader content
  113004. * @param vertexShader optional vertex shader content
  113005. */
  113006. static RegisterShader(name: string, pixelShader?: string, vertexShader?: string): void;
  113007. /**
  113008. * Store of each shader (The can be looked up using effect.key)
  113009. */
  113010. static ShadersStore: {
  113011. [key: string]: string;
  113012. };
  113013. /**
  113014. * Store of each included file for a shader (The can be looked up using effect.key)
  113015. */
  113016. static IncludesShadersStore: {
  113017. [key: string]: string;
  113018. };
  113019. /**
  113020. * Resets the cache of effects.
  113021. */
  113022. static ResetCache(): void;
  113023. }
  113024. }
  113025. declare module BABYLON {
  113026. /**
  113027. * Interface used to describe the capabilities of the engine relatively to the current browser
  113028. */
  113029. export interface EngineCapabilities {
  113030. /** Maximum textures units per fragment shader */
  113031. maxTexturesImageUnits: number;
  113032. /** Maximum texture units per vertex shader */
  113033. maxVertexTextureImageUnits: number;
  113034. /** Maximum textures units in the entire pipeline */
  113035. maxCombinedTexturesImageUnits: number;
  113036. /** Maximum texture size */
  113037. maxTextureSize: number;
  113038. /** Maximum texture samples */
  113039. maxSamples?: number;
  113040. /** Maximum cube texture size */
  113041. maxCubemapTextureSize: number;
  113042. /** Maximum render texture size */
  113043. maxRenderTextureSize: number;
  113044. /** Maximum number of vertex attributes */
  113045. maxVertexAttribs: number;
  113046. /** Maximum number of varyings */
  113047. maxVaryingVectors: number;
  113048. /** Maximum number of uniforms per vertex shader */
  113049. maxVertexUniformVectors: number;
  113050. /** Maximum number of uniforms per fragment shader */
  113051. maxFragmentUniformVectors: number;
  113052. /** Defines if standard derivates (dx/dy) are supported */
  113053. standardDerivatives: boolean;
  113054. /** Defines if s3tc texture compression is supported */
  113055. s3tc?: WEBGL_compressed_texture_s3tc;
  113056. /** Defines if pvrtc texture compression is supported */
  113057. pvrtc: any;
  113058. /** Defines if etc1 texture compression is supported */
  113059. etc1: any;
  113060. /** Defines if etc2 texture compression is supported */
  113061. etc2: any;
  113062. /** Defines if astc texture compression is supported */
  113063. astc: any;
  113064. /** Defines if float textures are supported */
  113065. textureFloat: boolean;
  113066. /** Defines if vertex array objects are supported */
  113067. vertexArrayObject: boolean;
  113068. /** Gets the webgl extension for anisotropic filtering (null if not supported) */
  113069. textureAnisotropicFilterExtension?: EXT_texture_filter_anisotropic;
  113070. /** Gets the maximum level of anisotropy supported */
  113071. maxAnisotropy: number;
  113072. /** Defines if instancing is supported */
  113073. instancedArrays: boolean;
  113074. /** Defines if 32 bits indices are supported */
  113075. uintIndices: boolean;
  113076. /** Defines if high precision shaders are supported */
  113077. highPrecisionShaderSupported: boolean;
  113078. /** Defines if depth reading in the fragment shader is supported */
  113079. fragmentDepthSupported: boolean;
  113080. /** Defines if float texture linear filtering is supported*/
  113081. textureFloatLinearFiltering: boolean;
  113082. /** Defines if rendering to float textures is supported */
  113083. textureFloatRender: boolean;
  113084. /** Defines if half float textures are supported*/
  113085. textureHalfFloat: boolean;
  113086. /** Defines if half float texture linear filtering is supported*/
  113087. textureHalfFloatLinearFiltering: boolean;
  113088. /** Defines if rendering to half float textures is supported */
  113089. textureHalfFloatRender: boolean;
  113090. /** Defines if textureLOD shader command is supported */
  113091. textureLOD: boolean;
  113092. /** Defines if draw buffers extension is supported */
  113093. drawBuffersExtension: boolean;
  113094. /** Defines if depth textures are supported */
  113095. depthTextureExtension: boolean;
  113096. /** Defines if float color buffer are supported */
  113097. colorBufferFloat: boolean;
  113098. /** Gets disjoint timer query extension (null if not supported) */
  113099. timerQuery?: EXT_disjoint_timer_query;
  113100. /** Defines if timestamp can be used with timer query */
  113101. canUseTimestampForTimerQuery: boolean;
  113102. /** Defines if multiview is supported (https://www.khronos.org/registry/webgl/extensions/WEBGL_multiview/) */
  113103. multiview?: any;
  113104. /** Defines if oculus multiview is supported (https://developer.oculus.com/documentation/oculus-browser/latest/concepts/browser-multiview/) */
  113105. oculusMultiview?: any;
  113106. /** Function used to let the system compiles shaders in background */
  113107. parallelShaderCompile?: {
  113108. COMPLETION_STATUS_KHR: number;
  113109. };
  113110. /** Max number of texture samples for MSAA */
  113111. maxMSAASamples: number;
  113112. /** Defines if the blend min max extension is supported */
  113113. blendMinMax: boolean;
  113114. }
  113115. }
  113116. declare module BABYLON {
  113117. /**
  113118. * @hidden
  113119. **/
  113120. export class DepthCullingState {
  113121. private _isDepthTestDirty;
  113122. private _isDepthMaskDirty;
  113123. private _isDepthFuncDirty;
  113124. private _isCullFaceDirty;
  113125. private _isCullDirty;
  113126. private _isZOffsetDirty;
  113127. private _isFrontFaceDirty;
  113128. private _depthTest;
  113129. private _depthMask;
  113130. private _depthFunc;
  113131. private _cull;
  113132. private _cullFace;
  113133. private _zOffset;
  113134. private _frontFace;
  113135. /**
  113136. * Initializes the state.
  113137. */
  113138. constructor();
  113139. get isDirty(): boolean;
  113140. get zOffset(): number;
  113141. set zOffset(value: number);
  113142. get cullFace(): Nullable<number>;
  113143. set cullFace(value: Nullable<number>);
  113144. get cull(): Nullable<boolean>;
  113145. set cull(value: Nullable<boolean>);
  113146. get depthFunc(): Nullable<number>;
  113147. set depthFunc(value: Nullable<number>);
  113148. get depthMask(): boolean;
  113149. set depthMask(value: boolean);
  113150. get depthTest(): boolean;
  113151. set depthTest(value: boolean);
  113152. get frontFace(): Nullable<number>;
  113153. set frontFace(value: Nullable<number>);
  113154. reset(): void;
  113155. apply(gl: WebGLRenderingContext): void;
  113156. }
  113157. }
  113158. declare module BABYLON {
  113159. /**
  113160. * @hidden
  113161. **/
  113162. export class StencilState {
  113163. /** 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 */
  113164. static readonly ALWAYS: number;
  113165. /** Passed to stencilOperation to specify that stencil value must be kept */
  113166. static readonly KEEP: number;
  113167. /** Passed to stencilOperation to specify that stencil value must be replaced */
  113168. static readonly REPLACE: number;
  113169. private _isStencilTestDirty;
  113170. private _isStencilMaskDirty;
  113171. private _isStencilFuncDirty;
  113172. private _isStencilOpDirty;
  113173. private _stencilTest;
  113174. private _stencilMask;
  113175. private _stencilFunc;
  113176. private _stencilFuncRef;
  113177. private _stencilFuncMask;
  113178. private _stencilOpStencilFail;
  113179. private _stencilOpDepthFail;
  113180. private _stencilOpStencilDepthPass;
  113181. get isDirty(): boolean;
  113182. get stencilFunc(): number;
  113183. set stencilFunc(value: number);
  113184. get stencilFuncRef(): number;
  113185. set stencilFuncRef(value: number);
  113186. get stencilFuncMask(): number;
  113187. set stencilFuncMask(value: number);
  113188. get stencilOpStencilFail(): number;
  113189. set stencilOpStencilFail(value: number);
  113190. get stencilOpDepthFail(): number;
  113191. set stencilOpDepthFail(value: number);
  113192. get stencilOpStencilDepthPass(): number;
  113193. set stencilOpStencilDepthPass(value: number);
  113194. get stencilMask(): number;
  113195. set stencilMask(value: number);
  113196. get stencilTest(): boolean;
  113197. set stencilTest(value: boolean);
  113198. constructor();
  113199. reset(): void;
  113200. apply(gl: WebGLRenderingContext): void;
  113201. }
  113202. }
  113203. declare module BABYLON {
  113204. /**
  113205. * @hidden
  113206. **/
  113207. export class AlphaState {
  113208. private _isAlphaBlendDirty;
  113209. private _isBlendFunctionParametersDirty;
  113210. private _isBlendEquationParametersDirty;
  113211. private _isBlendConstantsDirty;
  113212. private _alphaBlend;
  113213. private _blendFunctionParameters;
  113214. private _blendEquationParameters;
  113215. private _blendConstants;
  113216. /**
  113217. * Initializes the state.
  113218. */
  113219. constructor();
  113220. get isDirty(): boolean;
  113221. get alphaBlend(): boolean;
  113222. set alphaBlend(value: boolean);
  113223. setAlphaBlendConstants(r: number, g: number, b: number, a: number): void;
  113224. setAlphaBlendFunctionParameters(value0: number, value1: number, value2: number, value3: number): void;
  113225. setAlphaEquationParameters(rgb: number, alpha: number): void;
  113226. reset(): void;
  113227. apply(gl: WebGLRenderingContext): void;
  113228. }
  113229. }
  113230. declare module BABYLON {
  113231. /** @hidden */
  113232. export class WebGL2ShaderProcessor implements IShaderProcessor {
  113233. attributeProcessor(attribute: string): string;
  113234. varyingProcessor(varying: string, isFragment: boolean): string;
  113235. postProcessor(code: string, defines: string[], isFragment: boolean): string;
  113236. }
  113237. }
  113238. declare module BABYLON {
  113239. /**
  113240. * Interface for attribute information associated with buffer instanciation
  113241. */
  113242. export interface InstancingAttributeInfo {
  113243. /**
  113244. * Name of the GLSL attribute
  113245. * if attribute index is not specified, this is used to retrieve the index from the effect
  113246. */
  113247. attributeName: string;
  113248. /**
  113249. * Index/offset of the attribute in the vertex shader
  113250. * if not specified, this will be computes from the name.
  113251. */
  113252. index?: number;
  113253. /**
  113254. * size of the attribute, 1, 2, 3 or 4
  113255. */
  113256. attributeSize: number;
  113257. /**
  113258. * Offset of the data in the Vertex Buffer acting as the instancing buffer
  113259. */
  113260. offset: number;
  113261. /**
  113262. * Modifies the rate at which generic vertex attributes advance when rendering multiple instances
  113263. * default to 1
  113264. */
  113265. divisor?: number;
  113266. /**
  113267. * type of the attribute, gl.BYTE, gl.UNSIGNED_BYTE, gl.SHORT, gl.UNSIGNED_SHORT, gl.FIXED, gl.FLOAT.
  113268. * default is FLOAT
  113269. */
  113270. attributeType?: number;
  113271. /**
  113272. * normalization of fixed-point data. behavior unclear, use FALSE, default is FALSE
  113273. */
  113274. normalized?: boolean;
  113275. }
  113276. }
  113277. declare module BABYLON {
  113278. interface ThinEngine {
  113279. /**
  113280. * Update a video texture
  113281. * @param texture defines the texture to update
  113282. * @param video defines the video element to use
  113283. * @param invertY defines if data must be stored with Y axis inverted
  113284. */
  113285. updateVideoTexture(texture: Nullable<InternalTexture>, video: HTMLVideoElement, invertY: boolean): void;
  113286. }
  113287. }
  113288. declare module BABYLON {
  113289. interface ThinEngine {
  113290. /**
  113291. * Creates a dynamic texture
  113292. * @param width defines the width of the texture
  113293. * @param height defines the height of the texture
  113294. * @param generateMipMaps defines if the engine should generate the mip levels
  113295. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  113296. * @returns the dynamic texture inside an InternalTexture
  113297. */
  113298. createDynamicTexture(width: number, height: number, generateMipMaps: boolean, samplingMode: number): InternalTexture;
  113299. /**
  113300. * Update the content of a dynamic texture
  113301. * @param texture defines the texture to update
  113302. * @param canvas defines the canvas containing the source
  113303. * @param invertY defines if data must be stored with Y axis inverted
  113304. * @param premulAlpha defines if alpha is stored as premultiplied
  113305. * @param format defines the format of the data
  113306. * @param forceBindTexture if the texture should be forced to be bound eg. after a graphics context loss (Default: false)
  113307. */
  113308. updateDynamicTexture(texture: Nullable<InternalTexture>, canvas: HTMLCanvasElement | OffscreenCanvas, invertY: boolean, premulAlpha?: boolean, format?: number, forceBindTexture?: boolean): void;
  113309. }
  113310. }
  113311. declare module BABYLON {
  113312. /**
  113313. * Settings for finer control over video usage
  113314. */
  113315. export interface VideoTextureSettings {
  113316. /**
  113317. * Applies `autoplay` to video, if specified
  113318. */
  113319. autoPlay?: boolean;
  113320. /**
  113321. * Applies `loop` to video, if specified
  113322. */
  113323. loop?: boolean;
  113324. /**
  113325. * Automatically updates internal texture from video at every frame in the render loop
  113326. */
  113327. autoUpdateTexture: boolean;
  113328. /**
  113329. * Image src displayed during the video loading or until the user interacts with the video.
  113330. */
  113331. poster?: string;
  113332. }
  113333. /**
  113334. * If you want to display a video in your scene, this is the special texture for that.
  113335. * This special texture works similar to other textures, with the exception of a few parameters.
  113336. * @see https://doc.babylonjs.com/how_to/video_texture
  113337. */
  113338. export class VideoTexture extends Texture {
  113339. /**
  113340. * Tells whether textures will be updated automatically or user is required to call `updateTexture` manually
  113341. */
  113342. readonly autoUpdateTexture: boolean;
  113343. /**
  113344. * The video instance used by the texture internally
  113345. */
  113346. readonly video: HTMLVideoElement;
  113347. private _onUserActionRequestedObservable;
  113348. /**
  113349. * Event triggerd when a dom action is required by the user to play the video.
  113350. * This happens due to recent changes in browser policies preventing video to auto start.
  113351. */
  113352. get onUserActionRequestedObservable(): Observable<Texture>;
  113353. private _generateMipMaps;
  113354. private _stillImageCaptured;
  113355. private _displayingPosterTexture;
  113356. private _settings;
  113357. private _createInternalTextureOnEvent;
  113358. private _frameId;
  113359. private _currentSrc;
  113360. /**
  113361. * Creates a video texture.
  113362. * If you want to display a video in your scene, this is the special texture for that.
  113363. * This special texture works similar to other textures, with the exception of a few parameters.
  113364. * @see https://doc.babylonjs.com/how_to/video_texture
  113365. * @param name optional name, will detect from video source, if not defined
  113366. * @param src can be used to provide an url, array of urls or an already setup HTML video element.
  113367. * @param scene is obviously the current scene.
  113368. * @param generateMipMaps can be used to turn on mipmaps (Can be expensive for videoTextures because they are often updated).
  113369. * @param invertY is false by default but can be used to invert video on Y axis
  113370. * @param samplingMode controls the sampling method and is set to TRILINEAR_SAMPLINGMODE by default
  113371. * @param settings allows finer control over video usage
  113372. */
  113373. constructor(name: Nullable<string>, src: string | string[] | HTMLVideoElement, scene: Nullable<Scene>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, settings?: VideoTextureSettings);
  113374. private _getName;
  113375. private _getVideo;
  113376. private _createInternalTexture;
  113377. private reset;
  113378. /**
  113379. * @hidden Internal method to initiate `update`.
  113380. */
  113381. _rebuild(): void;
  113382. /**
  113383. * Update Texture in the `auto` mode. Does not do anything if `settings.autoUpdateTexture` is false.
  113384. */
  113385. update(): void;
  113386. /**
  113387. * Update Texture in `manual` mode. Does not do anything if not visible or paused.
  113388. * @param isVisible Visibility state, detected by user using `scene.getActiveMeshes()` or othervise.
  113389. */
  113390. updateTexture(isVisible: boolean): void;
  113391. protected _updateInternalTexture: () => void;
  113392. /**
  113393. * Change video content. Changing video instance or setting multiple urls (as in constructor) is not supported.
  113394. * @param url New url.
  113395. */
  113396. updateURL(url: string): void;
  113397. /**
  113398. * Clones the texture.
  113399. * @returns the cloned texture
  113400. */
  113401. clone(): VideoTexture;
  113402. /**
  113403. * Dispose the texture and release its associated resources.
  113404. */
  113405. dispose(): void;
  113406. /**
  113407. * Creates a video texture straight from a stream.
  113408. * @param scene Define the scene the texture should be created in
  113409. * @param stream Define the stream the texture should be created from
  113410. * @returns The created video texture as a promise
  113411. */
  113412. static CreateFromStreamAsync(scene: Scene, stream: MediaStream): Promise<VideoTexture>;
  113413. /**
  113414. * Creates a video texture straight from your WebCam video feed.
  113415. * @param scene Define the scene the texture should be created in
  113416. * @param constraints Define the constraints to use to create the web cam feed from WebRTC
  113417. * @param audioConstaints Define the audio constraints to use to create the web cam feed from WebRTC
  113418. * @returns The created video texture as a promise
  113419. */
  113420. static CreateFromWebCamAsync(scene: Scene, constraints: {
  113421. minWidth: number;
  113422. maxWidth: number;
  113423. minHeight: number;
  113424. maxHeight: number;
  113425. deviceId: string;
  113426. } & MediaTrackConstraints, audioConstaints?: boolean | MediaTrackConstraints): Promise<VideoTexture>;
  113427. /**
  113428. * Creates a video texture straight from your WebCam video feed.
  113429. * @param scene Define the scene the texture should be created in
  113430. * @param onReady Define a callback to triggered once the texture will be ready
  113431. * @param constraints Define the constraints to use to create the web cam feed from WebRTC
  113432. * @param audioConstaints Define the audio constraints to use to create the web cam feed from WebRTC
  113433. */
  113434. static CreateFromWebCam(scene: Scene, onReady: (videoTexture: VideoTexture) => void, constraints: {
  113435. minWidth: number;
  113436. maxWidth: number;
  113437. minHeight: number;
  113438. maxHeight: number;
  113439. deviceId: string;
  113440. } & MediaTrackConstraints, audioConstaints?: boolean | MediaTrackConstraints): void;
  113441. }
  113442. }
  113443. declare module BABYLON {
  113444. /**
  113445. * Defines the interface used by objects working like Scene
  113446. * @hidden
  113447. */
  113448. export interface ISceneLike {
  113449. _addPendingData(data: any): void;
  113450. _removePendingData(data: any): void;
  113451. offlineProvider: IOfflineProvider;
  113452. }
  113453. /** Interface defining initialization parameters for Engine class */
  113454. export interface EngineOptions extends WebGLContextAttributes {
  113455. /**
  113456. * Defines if the engine should no exceed a specified device ratio
  113457. * @see https://developer.mozilla.org/en-US/docs/Web/API/Window/devicePixelRatio
  113458. */
  113459. limitDeviceRatio?: number;
  113460. /**
  113461. * Defines if webvr should be enabled automatically
  113462. * @see https://doc.babylonjs.com/how_to/webvr_camera
  113463. */
  113464. autoEnableWebVR?: boolean;
  113465. /**
  113466. * Defines if webgl2 should be turned off even if supported
  113467. * @see https://doc.babylonjs.com/features/webgl2
  113468. */
  113469. disableWebGL2Support?: boolean;
  113470. /**
  113471. * Defines if webaudio should be initialized as well
  113472. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  113473. */
  113474. audioEngine?: boolean;
  113475. /**
  113476. * Defines if animations should run using a deterministic lock step
  113477. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  113478. */
  113479. deterministicLockstep?: boolean;
  113480. /** Defines the maximum steps to use with deterministic lock step mode */
  113481. lockstepMaxSteps?: number;
  113482. /** Defines the seconds between each deterministic lock step */
  113483. timeStep?: number;
  113484. /**
  113485. * Defines that engine should ignore context lost events
  113486. * If this event happens when this parameter is true, you will have to reload the page to restore rendering
  113487. */
  113488. doNotHandleContextLost?: boolean;
  113489. /**
  113490. * Defines that engine should ignore modifying touch action attribute and style
  113491. * If not handle, you might need to set it up on your side for expected touch devices behavior.
  113492. */
  113493. doNotHandleTouchAction?: boolean;
  113494. /**
  113495. * Defines that engine should compile shaders with high precision floats (if supported). True by default
  113496. */
  113497. useHighPrecisionFloats?: boolean;
  113498. /**
  113499. * Make the canvas XR Compatible for XR sessions
  113500. */
  113501. xrCompatible?: boolean;
  113502. /**
  113503. * Make the matrix computations to be performed in 64 bits instead of 32 bits. False by default
  113504. */
  113505. useHighPrecisionMatrix?: boolean;
  113506. }
  113507. /**
  113508. * The base engine class (root of all engines)
  113509. */
  113510. export class ThinEngine {
  113511. /** Use this array to turn off some WebGL2 features on known buggy browsers version */
  113512. static ExceptionList: ({
  113513. key: string;
  113514. capture: string;
  113515. captureConstraint: number;
  113516. targets: string[];
  113517. } | {
  113518. key: string;
  113519. capture: null;
  113520. captureConstraint: null;
  113521. targets: string[];
  113522. })[];
  113523. /** @hidden */
  113524. static _TextureLoaders: IInternalTextureLoader[];
  113525. /**
  113526. * Returns the current npm package of the sdk
  113527. */
  113528. static get NpmPackage(): string;
  113529. /**
  113530. * Returns the current version of the framework
  113531. */
  113532. static get Version(): string;
  113533. /**
  113534. * Returns a string describing the current engine
  113535. */
  113536. get description(): string;
  113537. /**
  113538. * Gets or sets the epsilon value used by collision engine
  113539. */
  113540. static CollisionsEpsilon: number;
  113541. /**
  113542. * Gets or sets the relative url used to load shaders if using the engine in non-minified mode
  113543. */
  113544. static get ShadersRepository(): string;
  113545. static set ShadersRepository(value: string);
  113546. /** @hidden */
  113547. _shaderProcessor: IShaderProcessor;
  113548. /**
  113549. * Gets or sets a boolean that indicates if textures must be forced to power of 2 size even if not required
  113550. */
  113551. forcePOTTextures: boolean;
  113552. /**
  113553. * Gets a boolean indicating if the engine is currently rendering in fullscreen mode
  113554. */
  113555. isFullscreen: boolean;
  113556. /**
  113557. * Gets or sets a boolean indicating if back faces must be culled (true by default)
  113558. */
  113559. cullBackFaces: boolean;
  113560. /**
  113561. * Gets or sets a boolean indicating if the engine must keep rendering even if the window is not in foregroun
  113562. */
  113563. renderEvenInBackground: boolean;
  113564. /**
  113565. * Gets or sets a boolean indicating that cache can be kept between frames
  113566. */
  113567. preventCacheWipeBetweenFrames: boolean;
  113568. /** Gets or sets a boolean indicating if the engine should validate programs after compilation */
  113569. validateShaderPrograms: boolean;
  113570. /**
  113571. * Gets or sets a boolean indicating if depth buffer should be reverse, going from far to near.
  113572. * This can provide greater z depth for distant objects.
  113573. */
  113574. useReverseDepthBuffer: boolean;
  113575. /**
  113576. * Gets or sets a boolean indicating that uniform buffers must be disabled even if they are supported
  113577. */
  113578. disableUniformBuffers: boolean;
  113579. /** @hidden */
  113580. _uniformBuffers: UniformBuffer[];
  113581. /**
  113582. * Gets a boolean indicating that the engine supports uniform buffers
  113583. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  113584. */
  113585. get supportsUniformBuffers(): boolean;
  113586. /** @hidden */
  113587. _gl: WebGLRenderingContext;
  113588. /** @hidden */
  113589. _webGLVersion: number;
  113590. protected _renderingCanvas: Nullable<HTMLCanvasElement>;
  113591. protected _windowIsBackground: boolean;
  113592. protected _creationOptions: EngineOptions;
  113593. protected _highPrecisionShadersAllowed: boolean;
  113594. /** @hidden */
  113595. get _shouldUseHighPrecisionShader(): boolean;
  113596. /**
  113597. * Gets a boolean indicating that only power of 2 textures are supported
  113598. * Please note that you can still use non power of 2 textures but in this case the engine will forcefully convert them
  113599. */
  113600. get needPOTTextures(): boolean;
  113601. /** @hidden */
  113602. _badOS: boolean;
  113603. /** @hidden */
  113604. _badDesktopOS: boolean;
  113605. private _hardwareScalingLevel;
  113606. /** @hidden */
  113607. _caps: EngineCapabilities;
  113608. private _isStencilEnable;
  113609. private _glVersion;
  113610. private _glRenderer;
  113611. private _glVendor;
  113612. /** @hidden */
  113613. _videoTextureSupported: boolean;
  113614. protected _renderingQueueLaunched: boolean;
  113615. protected _activeRenderLoops: (() => void)[];
  113616. /**
  113617. * Observable signaled when a context lost event is raised
  113618. */
  113619. onContextLostObservable: Observable<ThinEngine>;
  113620. /**
  113621. * Observable signaled when a context restored event is raised
  113622. */
  113623. onContextRestoredObservable: Observable<ThinEngine>;
  113624. private _onContextLost;
  113625. private _onContextRestored;
  113626. protected _contextWasLost: boolean;
  113627. /** @hidden */
  113628. _doNotHandleContextLost: boolean;
  113629. /**
  113630. * Gets or sets a boolean indicating if resources should be retained to be able to handle context lost events
  113631. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#handling-webgl-context-lost
  113632. */
  113633. get doNotHandleContextLost(): boolean;
  113634. set doNotHandleContextLost(value: boolean);
  113635. /**
  113636. * Gets or sets a boolean indicating that vertex array object must be disabled even if they are supported
  113637. */
  113638. disableVertexArrayObjects: boolean;
  113639. /** @hidden */
  113640. protected _colorWrite: boolean;
  113641. /** @hidden */
  113642. protected _colorWriteChanged: boolean;
  113643. /** @hidden */
  113644. protected _depthCullingState: DepthCullingState;
  113645. /** @hidden */
  113646. protected _stencilState: StencilState;
  113647. /** @hidden */
  113648. _alphaState: AlphaState;
  113649. /** @hidden */
  113650. _alphaMode: number;
  113651. /** @hidden */
  113652. _alphaEquation: number;
  113653. /** @hidden */
  113654. _internalTexturesCache: InternalTexture[];
  113655. /** @hidden */
  113656. protected _activeChannel: number;
  113657. private _currentTextureChannel;
  113658. /** @hidden */
  113659. protected _boundTexturesCache: {
  113660. [key: string]: Nullable<InternalTexture>;
  113661. };
  113662. /** @hidden */
  113663. protected _currentEffect: Nullable<Effect>;
  113664. /** @hidden */
  113665. protected _currentProgram: Nullable<WebGLProgram>;
  113666. private _compiledEffects;
  113667. private _vertexAttribArraysEnabled;
  113668. /** @hidden */
  113669. protected _cachedViewport: Nullable<IViewportLike>;
  113670. private _cachedVertexArrayObject;
  113671. /** @hidden */
  113672. protected _cachedVertexBuffers: any;
  113673. /** @hidden */
  113674. protected _cachedIndexBuffer: Nullable<DataBuffer>;
  113675. /** @hidden */
  113676. protected _cachedEffectForVertexBuffers: Nullable<Effect>;
  113677. /** @hidden */
  113678. _currentRenderTarget: Nullable<InternalTexture>;
  113679. private _uintIndicesCurrentlySet;
  113680. protected _currentBoundBuffer: Nullable<WebGLBuffer>[];
  113681. /** @hidden */
  113682. _currentFramebuffer: Nullable<WebGLFramebuffer>;
  113683. /** @hidden */
  113684. _dummyFramebuffer: Nullable<WebGLFramebuffer>;
  113685. private _currentBufferPointers;
  113686. private _currentInstanceLocations;
  113687. private _currentInstanceBuffers;
  113688. private _textureUnits;
  113689. /** @hidden */
  113690. _workingCanvas: Nullable<HTMLCanvasElement | OffscreenCanvas>;
  113691. /** @hidden */
  113692. _workingContext: Nullable<CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D>;
  113693. /** @hidden */
  113694. _boundRenderFunction: any;
  113695. private _vaoRecordInProgress;
  113696. private _mustWipeVertexAttributes;
  113697. private _emptyTexture;
  113698. private _emptyCubeTexture;
  113699. private _emptyTexture3D;
  113700. private _emptyTexture2DArray;
  113701. /** @hidden */
  113702. _frameHandler: number;
  113703. private _nextFreeTextureSlots;
  113704. private _maxSimultaneousTextures;
  113705. private _activeRequests;
  113706. /** @hidden */
  113707. _transformTextureUrl: Nullable<(url: string) => string>;
  113708. protected get _supportsHardwareTextureRescaling(): boolean;
  113709. private _framebufferDimensionsObject;
  113710. /**
  113711. * sets the object from which width and height will be taken from when getting render width and height
  113712. * Will fallback to the gl object
  113713. * @param dimensions the framebuffer width and height that will be used.
  113714. */
  113715. set framebufferDimensionsObject(dimensions: Nullable<{
  113716. framebufferWidth: number;
  113717. framebufferHeight: number;
  113718. }>);
  113719. /**
  113720. * Gets the current viewport
  113721. */
  113722. get currentViewport(): Nullable<IViewportLike>;
  113723. /**
  113724. * Gets the default empty texture
  113725. */
  113726. get emptyTexture(): InternalTexture;
  113727. /**
  113728. * Gets the default empty 3D texture
  113729. */
  113730. get emptyTexture3D(): InternalTexture;
  113731. /**
  113732. * Gets the default empty 2D array texture
  113733. */
  113734. get emptyTexture2DArray(): InternalTexture;
  113735. /**
  113736. * Gets the default empty cube texture
  113737. */
  113738. get emptyCubeTexture(): InternalTexture;
  113739. /**
  113740. * Defines whether the engine has been created with the premultipliedAlpha option on or not.
  113741. */
  113742. readonly premultipliedAlpha: boolean;
  113743. /**
  113744. * Observable event triggered before each texture is initialized
  113745. */
  113746. onBeforeTextureInitObservable: Observable<Texture>;
  113747. /**
  113748. * Creates a new engine
  113749. * @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
  113750. * @param antialias defines enable antialiasing (default: false)
  113751. * @param options defines further options to be sent to the getContext() function
  113752. * @param adaptToDeviceRatio defines whether to adapt to the device's viewport characteristics (default: false)
  113753. */
  113754. constructor(canvasOrContext: Nullable<HTMLCanvasElement | WebGLRenderingContext | WebGL2RenderingContext>, antialias?: boolean, options?: EngineOptions, adaptToDeviceRatio?: boolean);
  113755. private _rebuildInternalTextures;
  113756. private _rebuildEffects;
  113757. /**
  113758. * Gets a boolean indicating if all created effects are ready
  113759. * @returns true if all effects are ready
  113760. */
  113761. areAllEffectsReady(): boolean;
  113762. protected _rebuildBuffers(): void;
  113763. protected _initGLContext(): void;
  113764. /**
  113765. * Gets version of the current webGL context
  113766. */
  113767. get webGLVersion(): number;
  113768. /**
  113769. * Gets a string idenfifying the name of the class
  113770. * @returns "Engine" string
  113771. */
  113772. getClassName(): string;
  113773. /**
  113774. * Returns true if the stencil buffer has been enabled through the creation option of the context.
  113775. */
  113776. get isStencilEnable(): boolean;
  113777. /** @hidden */
  113778. _prepareWorkingCanvas(): void;
  113779. /**
  113780. * Reset the texture cache to empty state
  113781. */
  113782. resetTextureCache(): void;
  113783. /**
  113784. * Gets an object containing information about the current webGL context
  113785. * @returns an object containing the vender, the renderer and the version of the current webGL context
  113786. */
  113787. getGlInfo(): {
  113788. vendor: string;
  113789. renderer: string;
  113790. version: string;
  113791. };
  113792. /**
  113793. * Defines the hardware scaling level.
  113794. * By default the hardware scaling level is computed from the window device ratio.
  113795. * 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.
  113796. * @param level defines the level to use
  113797. */
  113798. setHardwareScalingLevel(level: number): void;
  113799. /**
  113800. * Gets the current hardware scaling level.
  113801. * By default the hardware scaling level is computed from the window device ratio.
  113802. * 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.
  113803. * @returns a number indicating the current hardware scaling level
  113804. */
  113805. getHardwareScalingLevel(): number;
  113806. /**
  113807. * Gets the list of loaded textures
  113808. * @returns an array containing all loaded textures
  113809. */
  113810. getLoadedTexturesCache(): InternalTexture[];
  113811. /**
  113812. * Gets the object containing all engine capabilities
  113813. * @returns the EngineCapabilities object
  113814. */
  113815. getCaps(): EngineCapabilities;
  113816. /**
  113817. * stop executing a render loop function and remove it from the execution array
  113818. * @param renderFunction defines the function to be removed. If not provided all functions will be removed.
  113819. */
  113820. stopRenderLoop(renderFunction?: () => void): void;
  113821. /** @hidden */
  113822. _renderLoop(): void;
  113823. /**
  113824. * Gets the HTML canvas attached with the current webGL context
  113825. * @returns a HTML canvas
  113826. */
  113827. getRenderingCanvas(): Nullable<HTMLCanvasElement>;
  113828. /**
  113829. * Gets host window
  113830. * @returns the host window object
  113831. */
  113832. getHostWindow(): Nullable<Window>;
  113833. /**
  113834. * Gets the current render width
  113835. * @param useScreen defines if screen size must be used (or the current render target if any)
  113836. * @returns a number defining the current render width
  113837. */
  113838. getRenderWidth(useScreen?: boolean): number;
  113839. /**
  113840. * Gets the current render height
  113841. * @param useScreen defines if screen size must be used (or the current render target if any)
  113842. * @returns a number defining the current render height
  113843. */
  113844. getRenderHeight(useScreen?: boolean): number;
  113845. /**
  113846. * Can be used to override the current requestAnimationFrame requester.
  113847. * @hidden
  113848. */
  113849. protected _queueNewFrame(bindedRenderFunction: any, requester?: any): number;
  113850. /**
  113851. * Register and execute a render loop. The engine can have more than one render function
  113852. * @param renderFunction defines the function to continuously execute
  113853. */
  113854. runRenderLoop(renderFunction: () => void): void;
  113855. /**
  113856. * Clear the current render buffer or the current render target (if any is set up)
  113857. * @param color defines the color to use
  113858. * @param backBuffer defines if the back buffer must be cleared
  113859. * @param depth defines if the depth buffer must be cleared
  113860. * @param stencil defines if the stencil buffer must be cleared
  113861. */
  113862. clear(color: Nullable<IColor4Like>, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  113863. private _viewportCached;
  113864. /** @hidden */
  113865. _viewport(x: number, y: number, width: number, height: number): void;
  113866. /**
  113867. * Set the WebGL's viewport
  113868. * @param viewport defines the viewport element to be used
  113869. * @param requiredWidth defines the width required for rendering. If not provided the rendering canvas' width is used
  113870. * @param requiredHeight defines the height required for rendering. If not provided the rendering canvas' height is used
  113871. */
  113872. setViewport(viewport: IViewportLike, requiredWidth?: number, requiredHeight?: number): void;
  113873. /**
  113874. * Begin a new frame
  113875. */
  113876. beginFrame(): void;
  113877. /**
  113878. * Enf the current frame
  113879. */
  113880. endFrame(): void;
  113881. /**
  113882. * Resize the view according to the canvas' size
  113883. */
  113884. resize(): void;
  113885. /**
  113886. * Force a specific size of the canvas
  113887. * @param width defines the new canvas' width
  113888. * @param height defines the new canvas' height
  113889. * @returns true if the size was changed
  113890. */
  113891. setSize(width: number, height: number): boolean;
  113892. /**
  113893. * Binds the frame buffer to the specified texture.
  113894. * @param texture The texture to render to or null for the default canvas
  113895. * @param faceIndex The face of the texture to render to in case of cube texture
  113896. * @param requiredWidth The width of the target to render to
  113897. * @param requiredHeight The height of the target to render to
  113898. * @param forceFullscreenViewport Forces the viewport to be the entire texture/screen if true
  113899. * @param lodLevel defines the lod level to bind to the frame buffer
  113900. * @param layer defines the 2d array index to bind to frame buffer to
  113901. */
  113902. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean, lodLevel?: number, layer?: number): void;
  113903. /** @hidden */
  113904. _bindUnboundFramebuffer(framebuffer: Nullable<WebGLFramebuffer>): void;
  113905. /**
  113906. * Unbind the current render target texture from the webGL context
  113907. * @param texture defines the render target texture to unbind
  113908. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  113909. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  113910. */
  113911. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  113912. /**
  113913. * Force a webGL flush (ie. a flush of all waiting webGL commands)
  113914. */
  113915. flushFramebuffer(): void;
  113916. /**
  113917. * Unbind the current render target and bind the default framebuffer
  113918. */
  113919. restoreDefaultFramebuffer(): void;
  113920. /** @hidden */
  113921. protected _resetVertexBufferBinding(): void;
  113922. /**
  113923. * Creates a vertex buffer
  113924. * @param data the data for the vertex buffer
  113925. * @returns the new WebGL static buffer
  113926. */
  113927. createVertexBuffer(data: DataArray): DataBuffer;
  113928. private _createVertexBuffer;
  113929. /**
  113930. * Creates a dynamic vertex buffer
  113931. * @param data the data for the dynamic vertex buffer
  113932. * @returns the new WebGL dynamic buffer
  113933. */
  113934. createDynamicVertexBuffer(data: DataArray): DataBuffer;
  113935. protected _resetIndexBufferBinding(): void;
  113936. /**
  113937. * Creates a new index buffer
  113938. * @param indices defines the content of the index buffer
  113939. * @param updatable defines if the index buffer must be updatable
  113940. * @returns a new webGL buffer
  113941. */
  113942. createIndexBuffer(indices: IndicesArray, updatable?: boolean): DataBuffer;
  113943. protected _normalizeIndexData(indices: IndicesArray): Uint16Array | Uint32Array;
  113944. /**
  113945. * Bind a webGL buffer to the webGL context
  113946. * @param buffer defines the buffer to bind
  113947. */
  113948. bindArrayBuffer(buffer: Nullable<DataBuffer>): void;
  113949. protected bindIndexBuffer(buffer: Nullable<DataBuffer>): void;
  113950. private bindBuffer;
  113951. /**
  113952. * update the bound buffer with the given data
  113953. * @param data defines the data to update
  113954. */
  113955. updateArrayBuffer(data: Float32Array): void;
  113956. private _vertexAttribPointer;
  113957. /** @hidden */
  113958. _bindIndexBufferWithCache(indexBuffer: Nullable<DataBuffer>): void;
  113959. private _bindVertexBuffersAttributes;
  113960. /**
  113961. * Records a vertex array object
  113962. * @see https://doc.babylonjs.com/features/webgl2#vertex-array-objects
  113963. * @param vertexBuffers defines the list of vertex buffers to store
  113964. * @param indexBuffer defines the index buffer to store
  113965. * @param effect defines the effect to store
  113966. * @returns the new vertex array object
  113967. */
  113968. recordVertexArrayObject(vertexBuffers: {
  113969. [key: string]: VertexBuffer;
  113970. }, indexBuffer: Nullable<DataBuffer>, effect: Effect): WebGLVertexArrayObject;
  113971. /**
  113972. * Bind a specific vertex array object
  113973. * @see https://doc.babylonjs.com/features/webgl2#vertex-array-objects
  113974. * @param vertexArrayObject defines the vertex array object to bind
  113975. * @param indexBuffer defines the index buffer to bind
  113976. */
  113977. bindVertexArrayObject(vertexArrayObject: WebGLVertexArrayObject, indexBuffer: Nullable<DataBuffer>): void;
  113978. /**
  113979. * Bind webGl buffers directly to the webGL context
  113980. * @param vertexBuffer defines the vertex buffer to bind
  113981. * @param indexBuffer defines the index buffer to bind
  113982. * @param vertexDeclaration defines the vertex declaration to use with the vertex buffer
  113983. * @param vertexStrideSize defines the vertex stride of the vertex buffer
  113984. * @param effect defines the effect associated with the vertex buffer
  113985. */
  113986. bindBuffersDirectly(vertexBuffer: DataBuffer, indexBuffer: DataBuffer, vertexDeclaration: number[], vertexStrideSize: number, effect: Effect): void;
  113987. private _unbindVertexArrayObject;
  113988. /**
  113989. * Bind a list of vertex buffers to the webGL context
  113990. * @param vertexBuffers defines the list of vertex buffers to bind
  113991. * @param indexBuffer defines the index buffer to bind
  113992. * @param effect defines the effect associated with the vertex buffers
  113993. */
  113994. bindBuffers(vertexBuffers: {
  113995. [key: string]: Nullable<VertexBuffer>;
  113996. }, indexBuffer: Nullable<DataBuffer>, effect: Effect): void;
  113997. /**
  113998. * Unbind all instance attributes
  113999. */
  114000. unbindInstanceAttributes(): void;
  114001. /**
  114002. * Release and free the memory of a vertex array object
  114003. * @param vao defines the vertex array object to delete
  114004. */
  114005. releaseVertexArrayObject(vao: WebGLVertexArrayObject): void;
  114006. /** @hidden */
  114007. _releaseBuffer(buffer: DataBuffer): boolean;
  114008. protected _deleteBuffer(buffer: DataBuffer): void;
  114009. /**
  114010. * Update the content of a webGL buffer used with instanciation and bind it to the webGL context
  114011. * @param instancesBuffer defines the webGL buffer to update and bind
  114012. * @param data defines the data to store in the buffer
  114013. * @param offsetLocations defines the offsets or attributes information used to determine where data must be stored in the buffer
  114014. */
  114015. updateAndBindInstancesBuffer(instancesBuffer: DataBuffer, data: Float32Array, offsetLocations: number[] | InstancingAttributeInfo[]): void;
  114016. /**
  114017. * Bind the content of a webGL buffer used with instantiation
  114018. * @param instancesBuffer defines the webGL buffer to bind
  114019. * @param attributesInfo defines the offsets or attributes information used to determine where data must be stored in the buffer
  114020. * @param computeStride defines Whether to compute the strides from the info or use the default 0
  114021. */
  114022. bindInstancesBuffer(instancesBuffer: DataBuffer, attributesInfo: InstancingAttributeInfo[], computeStride?: boolean): void;
  114023. /**
  114024. * Disable the instance attribute corresponding to the name in parameter
  114025. * @param name defines the name of the attribute to disable
  114026. */
  114027. disableInstanceAttributeByName(name: string): void;
  114028. /**
  114029. * Disable the instance attribute corresponding to the location in parameter
  114030. * @param attributeLocation defines the attribute location of the attribute to disable
  114031. */
  114032. disableInstanceAttribute(attributeLocation: number): void;
  114033. /**
  114034. * Disable the attribute corresponding to the location in parameter
  114035. * @param attributeLocation defines the attribute location of the attribute to disable
  114036. */
  114037. disableAttributeByIndex(attributeLocation: number): void;
  114038. /**
  114039. * Send a draw order
  114040. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  114041. * @param indexStart defines the starting index
  114042. * @param indexCount defines the number of index to draw
  114043. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  114044. */
  114045. draw(useTriangles: boolean, indexStart: number, indexCount: number, instancesCount?: number): void;
  114046. /**
  114047. * Draw a list of points
  114048. * @param verticesStart defines the index of first vertex to draw
  114049. * @param verticesCount defines the count of vertices to draw
  114050. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  114051. */
  114052. drawPointClouds(verticesStart: number, verticesCount: number, instancesCount?: number): void;
  114053. /**
  114054. * Draw a list of unindexed primitives
  114055. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  114056. * @param verticesStart defines the index of first vertex to draw
  114057. * @param verticesCount defines the count of vertices to draw
  114058. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  114059. */
  114060. drawUnIndexed(useTriangles: boolean, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  114061. /**
  114062. * Draw a list of indexed primitives
  114063. * @param fillMode defines the primitive to use
  114064. * @param indexStart defines the starting index
  114065. * @param indexCount defines the number of index to draw
  114066. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  114067. */
  114068. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  114069. /**
  114070. * Draw a list of unindexed primitives
  114071. * @param fillMode defines the primitive to use
  114072. * @param verticesStart defines the index of first vertex to draw
  114073. * @param verticesCount defines the count of vertices to draw
  114074. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  114075. */
  114076. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  114077. private _drawMode;
  114078. /** @hidden */
  114079. protected _reportDrawCall(): void;
  114080. /** @hidden */
  114081. _releaseEffect(effect: Effect): void;
  114082. /** @hidden */
  114083. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  114084. /**
  114085. * Create a new effect (used to store vertex/fragment shaders)
  114086. * @param baseName defines the base name of the effect (The name of file without .fragment.fx or .vertex.fx)
  114087. * @param attributesNamesOrOptions defines either a list of attribute names or an IEffectCreationOptions object
  114088. * @param uniformsNamesOrEngine defines either a list of uniform names or the engine to use
  114089. * @param samplers defines an array of string used to represent textures
  114090. * @param defines defines the string containing the defines to use to compile the shaders
  114091. * @param fallbacks defines the list of potential fallbacks to use if shader conmpilation fails
  114092. * @param onCompiled defines a function to call when the effect creation is successful
  114093. * @param onError defines a function to call when the effect creation has failed
  114094. * @param indexParameters defines an object containing the index values to use to compile shaders (like the maximum number of simultaneous lights)
  114095. * @returns the new Effect
  114096. */
  114097. 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;
  114098. protected static _ConcatenateShader(source: string, defines: Nullable<string>, shaderVersion?: string): string;
  114099. private _compileShader;
  114100. private _compileRawShader;
  114101. /** @hidden */
  114102. _getShaderSource(shader: WebGLShader): Nullable<string>;
  114103. /**
  114104. * Directly creates a webGL program
  114105. * @param pipelineContext defines the pipeline context to attach to
  114106. * @param vertexCode defines the vertex shader code to use
  114107. * @param fragmentCode defines the fragment shader code to use
  114108. * @param context defines the webGL context to use (if not set, the current one will be used)
  114109. * @param transformFeedbackVaryings defines the list of transform feedback varyings to use
  114110. * @returns the new webGL program
  114111. */
  114112. createRawShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  114113. /**
  114114. * Creates a webGL program
  114115. * @param pipelineContext defines the pipeline context to attach to
  114116. * @param vertexCode defines the vertex shader code to use
  114117. * @param fragmentCode defines the fragment shader code to use
  114118. * @param defines defines the string containing the defines to use to compile the shaders
  114119. * @param context defines the webGL context to use (if not set, the current one will be used)
  114120. * @param transformFeedbackVaryings defines the list of transform feedback varyings to use
  114121. * @returns the new webGL program
  114122. */
  114123. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  114124. /**
  114125. * Creates a new pipeline context
  114126. * @returns the new pipeline
  114127. */
  114128. createPipelineContext(): IPipelineContext;
  114129. protected _createShaderProgram(pipelineContext: WebGLPipelineContext, vertexShader: WebGLShader, fragmentShader: WebGLShader, context: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  114130. protected _finalizePipelineContext(pipelineContext: WebGLPipelineContext): void;
  114131. /** @hidden */
  114132. _preparePipelineContext(pipelineContext: IPipelineContext, vertexSourceCode: string, fragmentSourceCode: string, createAsRaw: boolean, rebuildRebind: any, defines: Nullable<string>, transformFeedbackVaryings: Nullable<string[]>): void;
  114133. /** @hidden */
  114134. _isRenderingStateCompiled(pipelineContext: IPipelineContext): boolean;
  114135. /** @hidden */
  114136. _executeWhenRenderingStateIsCompiled(pipelineContext: IPipelineContext, action: () => void): void;
  114137. /**
  114138. * Gets the list of webGL uniform locations associated with a specific program based on a list of uniform names
  114139. * @param pipelineContext defines the pipeline context to use
  114140. * @param uniformsNames defines the list of uniform names
  114141. * @returns an array of webGL uniform locations
  114142. */
  114143. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): Nullable<WebGLUniformLocation>[];
  114144. /**
  114145. * Gets the lsit of active attributes for a given webGL program
  114146. * @param pipelineContext defines the pipeline context to use
  114147. * @param attributesNames defines the list of attribute names to get
  114148. * @returns an array of indices indicating the offset of each attribute
  114149. */
  114150. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  114151. /**
  114152. * Activates an effect, mkaing it the current one (ie. the one used for rendering)
  114153. * @param effect defines the effect to activate
  114154. */
  114155. enableEffect(effect: Nullable<Effect>): void;
  114156. /**
  114157. * Set the value of an uniform to a number (int)
  114158. * @param uniform defines the webGL uniform location where to store the value
  114159. * @param value defines the int number to store
  114160. */
  114161. setInt(uniform: Nullable<WebGLUniformLocation>, value: number): void;
  114162. /**
  114163. * Set the value of an uniform to an array of int32
  114164. * @param uniform defines the webGL uniform location where to store the value
  114165. * @param array defines the array of int32 to store
  114166. */
  114167. setIntArray(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  114168. /**
  114169. * Set the value of an uniform to an array of int32 (stored as vec2)
  114170. * @param uniform defines the webGL uniform location where to store the value
  114171. * @param array defines the array of int32 to store
  114172. */
  114173. setIntArray2(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  114174. /**
  114175. * Set the value of an uniform to an array of int32 (stored as vec3)
  114176. * @param uniform defines the webGL uniform location where to store the value
  114177. * @param array defines the array of int32 to store
  114178. */
  114179. setIntArray3(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  114180. /**
  114181. * Set the value of an uniform to an array of int32 (stored as vec4)
  114182. * @param uniform defines the webGL uniform location where to store the value
  114183. * @param array defines the array of int32 to store
  114184. */
  114185. setIntArray4(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  114186. /**
  114187. * Set the value of an uniform to an array of number
  114188. * @param uniform defines the webGL uniform location where to store the value
  114189. * @param array defines the array of number to store
  114190. */
  114191. setArray(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  114192. /**
  114193. * Set the value of an uniform to an array of number (stored as vec2)
  114194. * @param uniform defines the webGL uniform location where to store the value
  114195. * @param array defines the array of number to store
  114196. */
  114197. setArray2(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  114198. /**
  114199. * Set the value of an uniform to an array of number (stored as vec3)
  114200. * @param uniform defines the webGL uniform location where to store the value
  114201. * @param array defines the array of number to store
  114202. */
  114203. setArray3(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  114204. /**
  114205. * Set the value of an uniform to an array of number (stored as vec4)
  114206. * @param uniform defines the webGL uniform location where to store the value
  114207. * @param array defines the array of number to store
  114208. */
  114209. setArray4(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  114210. /**
  114211. * Set the value of an uniform to an array of float32 (stored as matrices)
  114212. * @param uniform defines the webGL uniform location where to store the value
  114213. * @param matrices defines the array of float32 to store
  114214. */
  114215. setMatrices(uniform: Nullable<WebGLUniformLocation>, matrices: Float32Array): void;
  114216. /**
  114217. * Set the value of an uniform to a matrix (3x3)
  114218. * @param uniform defines the webGL uniform location where to store the value
  114219. * @param matrix defines the Float32Array representing the 3x3 matrix to store
  114220. */
  114221. setMatrix3x3(uniform: Nullable<WebGLUniformLocation>, matrix: Float32Array): void;
  114222. /**
  114223. * Set the value of an uniform to a matrix (2x2)
  114224. * @param uniform defines the webGL uniform location where to store the value
  114225. * @param matrix defines the Float32Array representing the 2x2 matrix to store
  114226. */
  114227. setMatrix2x2(uniform: Nullable<WebGLUniformLocation>, matrix: Float32Array): void;
  114228. /**
  114229. * Set the value of an uniform to a number (float)
  114230. * @param uniform defines the webGL uniform location where to store the value
  114231. * @param value defines the float number to store
  114232. */
  114233. setFloat(uniform: Nullable<WebGLUniformLocation>, value: number): void;
  114234. /**
  114235. * Set the value of an uniform to a vec2
  114236. * @param uniform defines the webGL uniform location where to store the value
  114237. * @param x defines the 1st component of the value
  114238. * @param y defines the 2nd component of the value
  114239. */
  114240. setFloat2(uniform: Nullable<WebGLUniformLocation>, x: number, y: number): void;
  114241. /**
  114242. * Set the value of an uniform to a vec3
  114243. * @param uniform defines the webGL uniform location where to store the value
  114244. * @param x defines the 1st component of the value
  114245. * @param y defines the 2nd component of the value
  114246. * @param z defines the 3rd component of the value
  114247. */
  114248. setFloat3(uniform: Nullable<WebGLUniformLocation>, x: number, y: number, z: number): void;
  114249. /**
  114250. * Set the value of an uniform to a vec4
  114251. * @param uniform defines the webGL uniform location where to store the value
  114252. * @param x defines the 1st component of the value
  114253. * @param y defines the 2nd component of the value
  114254. * @param z defines the 3rd component of the value
  114255. * @param w defines the 4th component of the value
  114256. */
  114257. setFloat4(uniform: Nullable<WebGLUniformLocation>, x: number, y: number, z: number, w: number): void;
  114258. /**
  114259. * Apply all cached states (depth, culling, stencil and alpha)
  114260. */
  114261. applyStates(): void;
  114262. /**
  114263. * Enable or disable color writing
  114264. * @param enable defines the state to set
  114265. */
  114266. setColorWrite(enable: boolean): void;
  114267. /**
  114268. * Gets a boolean indicating if color writing is enabled
  114269. * @returns the current color writing state
  114270. */
  114271. getColorWrite(): boolean;
  114272. /**
  114273. * Gets the depth culling state manager
  114274. */
  114275. get depthCullingState(): DepthCullingState;
  114276. /**
  114277. * Gets the alpha state manager
  114278. */
  114279. get alphaState(): AlphaState;
  114280. /**
  114281. * Gets the stencil state manager
  114282. */
  114283. get stencilState(): StencilState;
  114284. /**
  114285. * Clears the list of texture accessible through engine.
  114286. * This can help preventing texture load conflict due to name collision.
  114287. */
  114288. clearInternalTexturesCache(): void;
  114289. /**
  114290. * Force the entire cache to be cleared
  114291. * You should not have to use this function unless your engine needs to share the webGL context with another engine
  114292. * @param bruteForce defines a boolean to force clearing ALL caches (including stencil, detoh and alpha states)
  114293. */
  114294. wipeCaches(bruteForce?: boolean): void;
  114295. /** @hidden */
  114296. _getSamplingParameters(samplingMode: number, generateMipMaps: boolean): {
  114297. min: number;
  114298. mag: number;
  114299. };
  114300. /** @hidden */
  114301. _createTexture(): WebGLTexture;
  114302. /**
  114303. * Usually called from Texture.ts.
  114304. * Passed information to create a WebGLTexture
  114305. * @param url defines a value which contains one of the following:
  114306. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  114307. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  114308. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  114309. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  114310. * @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)
  114311. * @param scene needed for loading to the correct scene
  114312. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  114313. * @param onLoad optional callback to be called upon successful completion
  114314. * @param onError optional callback to be called upon failure
  114315. * @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
  114316. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  114317. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  114318. * @param forcedExtension defines the extension to use to pick the right loader
  114319. * @param mimeType defines an optional mime type
  114320. * @returns a InternalTexture for assignment back into BABYLON.Texture
  114321. */
  114322. 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;
  114323. /**
  114324. * Loads an image as an HTMLImageElement.
  114325. * @param input url string, ArrayBuffer, or Blob to load
  114326. * @param onLoad callback called when the image successfully loads
  114327. * @param onError callback called when the image fails to load
  114328. * @param offlineProvider offline provider for caching
  114329. * @param mimeType optional mime type
  114330. * @returns the HTMLImageElement of the loaded image
  114331. * @hidden
  114332. */
  114333. 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>;
  114334. /**
  114335. * @hidden
  114336. */
  114337. _rescaleTexture(source: InternalTexture, destination: InternalTexture, scene: Nullable<any>, internalFormat: number, onComplete: () => void): void;
  114338. private _unpackFlipYCached;
  114339. /**
  114340. * In case you are sharing the context with other applications, it might
  114341. * be interested to not cache the unpack flip y state to ensure a consistent
  114342. * value would be set.
  114343. */
  114344. enableUnpackFlipYCached: boolean;
  114345. /** @hidden */
  114346. _unpackFlipY(value: boolean): void;
  114347. /** @hidden */
  114348. _getUnpackAlignement(): number;
  114349. private _getTextureTarget;
  114350. /**
  114351. * Update the sampling mode of a given texture
  114352. * @param samplingMode defines the required sampling mode
  114353. * @param texture defines the texture to update
  114354. * @param generateMipMaps defines whether to generate mipmaps for the texture
  114355. */
  114356. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture, generateMipMaps?: boolean): void;
  114357. /**
  114358. * Update the sampling mode of a given texture
  114359. * @param texture defines the texture to update
  114360. * @param wrapU defines the texture wrap mode of the u coordinates
  114361. * @param wrapV defines the texture wrap mode of the v coordinates
  114362. * @param wrapR defines the texture wrap mode of the r coordinates
  114363. */
  114364. updateTextureWrappingMode(texture: InternalTexture, wrapU: Nullable<number>, wrapV?: Nullable<number>, wrapR?: Nullable<number>): void;
  114365. /** @hidden */
  114366. _setupDepthStencilTexture(internalTexture: InternalTexture, size: number | {
  114367. width: number;
  114368. height: number;
  114369. layers?: number;
  114370. }, generateStencil: boolean, bilinearFiltering: boolean, comparisonFunction: number): void;
  114371. /** @hidden */
  114372. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  114373. /** @hidden */
  114374. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number, babylonInternalFormat?: number, useTextureWidthAndHeight?: boolean): void;
  114375. /**
  114376. * Update a portion of an internal texture
  114377. * @param texture defines the texture to update
  114378. * @param imageData defines the data to store into the texture
  114379. * @param xOffset defines the x coordinates of the update rectangle
  114380. * @param yOffset defines the y coordinates of the update rectangle
  114381. * @param width defines the width of the update rectangle
  114382. * @param height defines the height of the update rectangle
  114383. * @param faceIndex defines the face index if texture is a cube (0 by default)
  114384. * @param lod defines the lod level to update (0 by default)
  114385. */
  114386. updateTextureData(texture: InternalTexture, imageData: ArrayBufferView, xOffset: number, yOffset: number, width: number, height: number, faceIndex?: number, lod?: number): void;
  114387. /** @hidden */
  114388. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  114389. protected _prepareWebGLTextureContinuation(texture: InternalTexture, scene: Nullable<ISceneLike>, noMipmap: boolean, isCompressed: boolean, samplingMode: number): void;
  114390. private _prepareWebGLTexture;
  114391. /** @hidden */
  114392. _setupFramebufferDepthAttachments(generateStencilBuffer: boolean, generateDepthBuffer: boolean, width: number, height: number, samples?: number): Nullable<WebGLRenderbuffer>;
  114393. private _getDepthStencilBuffer;
  114394. /** @hidden */
  114395. _releaseFramebufferObjects(texture: InternalTexture): void;
  114396. /** @hidden */
  114397. _releaseTexture(texture: InternalTexture): void;
  114398. protected _deleteTexture(texture: Nullable<WebGLTexture>): void;
  114399. protected _setProgram(program: WebGLProgram): void;
  114400. protected _boundUniforms: {
  114401. [key: number]: WebGLUniformLocation;
  114402. };
  114403. /**
  114404. * Binds an effect to the webGL context
  114405. * @param effect defines the effect to bind
  114406. */
  114407. bindSamplers(effect: Effect): void;
  114408. private _activateCurrentTexture;
  114409. /** @hidden */
  114410. _bindTextureDirectly(target: number, texture: Nullable<InternalTexture>, forTextureDataUpdate?: boolean, force?: boolean): boolean;
  114411. /** @hidden */
  114412. _bindTexture(channel: number, texture: Nullable<InternalTexture>): void;
  114413. /**
  114414. * Unbind all textures from the webGL context
  114415. */
  114416. unbindAllTextures(): void;
  114417. /**
  114418. * Sets a texture to the according uniform.
  114419. * @param channel The texture channel
  114420. * @param uniform The uniform to set
  114421. * @param texture The texture to apply
  114422. */
  114423. setTexture(channel: number, uniform: Nullable<WebGLUniformLocation>, texture: Nullable<BaseTexture>): void;
  114424. private _bindSamplerUniformToChannel;
  114425. private _getTextureWrapMode;
  114426. protected _setTexture(channel: number, texture: Nullable<BaseTexture>, isPartOfTextureArray?: boolean, depthStencilTexture?: boolean): boolean;
  114427. /**
  114428. * Sets an array of texture to the webGL context
  114429. * @param channel defines the channel where the texture array must be set
  114430. * @param uniform defines the associated uniform location
  114431. * @param textures defines the array of textures to bind
  114432. */
  114433. setTextureArray(channel: number, uniform: Nullable<WebGLUniformLocation>, textures: BaseTexture[]): void;
  114434. /** @hidden */
  114435. _setAnisotropicLevel(target: number, internalTexture: InternalTexture, anisotropicFilteringLevel: number): void;
  114436. private _setTextureParameterFloat;
  114437. private _setTextureParameterInteger;
  114438. /**
  114439. * Unbind all vertex attributes from the webGL context
  114440. */
  114441. unbindAllAttributes(): void;
  114442. /**
  114443. * 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
  114444. */
  114445. releaseEffects(): void;
  114446. /**
  114447. * Dispose and release all associated resources
  114448. */
  114449. dispose(): void;
  114450. /**
  114451. * Attach a new callback raised when context lost event is fired
  114452. * @param callback defines the callback to call
  114453. */
  114454. attachContextLostEvent(callback: ((event: WebGLContextEvent) => void)): void;
  114455. /**
  114456. * Attach a new callback raised when context restored event is fired
  114457. * @param callback defines the callback to call
  114458. */
  114459. attachContextRestoredEvent(callback: ((event: WebGLContextEvent) => void)): void;
  114460. /**
  114461. * Get the current error code of the webGL context
  114462. * @returns the error code
  114463. * @see https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/getError
  114464. */
  114465. getError(): number;
  114466. private _canRenderToFloatFramebuffer;
  114467. private _canRenderToHalfFloatFramebuffer;
  114468. private _canRenderToFramebuffer;
  114469. /** @hidden */
  114470. _getWebGLTextureType(type: number): number;
  114471. /** @hidden */
  114472. _getInternalFormat(format: number): number;
  114473. /** @hidden */
  114474. _getRGBABufferInternalSizedFormat(type: number, format?: number): number;
  114475. /** @hidden */
  114476. _getRGBAMultiSampleBufferFormat(type: number): number;
  114477. /** @hidden */
  114478. _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;
  114479. /**
  114480. * Loads a file from a url
  114481. * @param url url to load
  114482. * @param onSuccess callback called when the file successfully loads
  114483. * @param onProgress callback called while file is loading (if the server supports this mode)
  114484. * @param offlineProvider defines the offline provider for caching
  114485. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  114486. * @param onError callback called when the file fails to load
  114487. * @returns a file request object
  114488. * @hidden
  114489. */
  114490. 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;
  114491. /**
  114492. * Reads pixels from the current frame buffer. Please note that this function can be slow
  114493. * @param x defines the x coordinate of the rectangle where pixels must be read
  114494. * @param y defines the y coordinate of the rectangle where pixels must be read
  114495. * @param width defines the width of the rectangle where pixels must be read
  114496. * @param height defines the height of the rectangle where pixels must be read
  114497. * @param hasAlpha defines whether the output should have alpha or not (defaults to true)
  114498. * @returns a Uint8Array containing RGBA colors
  114499. */
  114500. readPixels(x: number, y: number, width: number, height: number, hasAlpha?: boolean): Uint8Array;
  114501. private static _isSupported;
  114502. /**
  114503. * Gets a boolean indicating if the engine can be instanciated (ie. if a webGL context can be found)
  114504. * @returns true if the engine can be created
  114505. * @ignorenaming
  114506. */
  114507. static isSupported(): boolean;
  114508. /**
  114509. * Find the next highest power of two.
  114510. * @param x Number to start search from.
  114511. * @return Next highest power of two.
  114512. */
  114513. static CeilingPOT(x: number): number;
  114514. /**
  114515. * Find the next lowest power of two.
  114516. * @param x Number to start search from.
  114517. * @return Next lowest power of two.
  114518. */
  114519. static FloorPOT(x: number): number;
  114520. /**
  114521. * Find the nearest power of two.
  114522. * @param x Number to start search from.
  114523. * @return Next nearest power of two.
  114524. */
  114525. static NearestPOT(x: number): number;
  114526. /**
  114527. * Get the closest exponent of two
  114528. * @param value defines the value to approximate
  114529. * @param max defines the maximum value to return
  114530. * @param mode defines how to define the closest value
  114531. * @returns closest exponent of two of the given value
  114532. */
  114533. static GetExponentOfTwo(value: number, max: number, mode?: number): number;
  114534. /**
  114535. * Queue a new function into the requested animation frame pool (ie. this function will be executed byt the browser for the next frame)
  114536. * @param func - the function to be called
  114537. * @param requester - the object that will request the next frame. Falls back to window.
  114538. * @returns frame number
  114539. */
  114540. static QueueNewFrame(func: () => void, requester?: any): number;
  114541. /**
  114542. * Gets host document
  114543. * @returns the host document object
  114544. */
  114545. getHostDocument(): Nullable<Document>;
  114546. }
  114547. }
  114548. declare module BABYLON {
  114549. /**
  114550. * Class representing spherical harmonics coefficients to the 3rd degree
  114551. */
  114552. export class SphericalHarmonics {
  114553. /**
  114554. * Defines whether or not the harmonics have been prescaled for rendering.
  114555. */
  114556. preScaled: boolean;
  114557. /**
  114558. * The l0,0 coefficients of the spherical harmonics
  114559. */
  114560. l00: Vector3;
  114561. /**
  114562. * The l1,-1 coefficients of the spherical harmonics
  114563. */
  114564. l1_1: Vector3;
  114565. /**
  114566. * The l1,0 coefficients of the spherical harmonics
  114567. */
  114568. l10: Vector3;
  114569. /**
  114570. * The l1,1 coefficients of the spherical harmonics
  114571. */
  114572. l11: Vector3;
  114573. /**
  114574. * The l2,-2 coefficients of the spherical harmonics
  114575. */
  114576. l2_2: Vector3;
  114577. /**
  114578. * The l2,-1 coefficients of the spherical harmonics
  114579. */
  114580. l2_1: Vector3;
  114581. /**
  114582. * The l2,0 coefficients of the spherical harmonics
  114583. */
  114584. l20: Vector3;
  114585. /**
  114586. * The l2,1 coefficients of the spherical harmonics
  114587. */
  114588. l21: Vector3;
  114589. /**
  114590. * The l2,2 coefficients of the spherical harmonics
  114591. */
  114592. l22: Vector3;
  114593. /**
  114594. * Adds a light to the spherical harmonics
  114595. * @param direction the direction of the light
  114596. * @param color the color of the light
  114597. * @param deltaSolidAngle the delta solid angle of the light
  114598. */
  114599. addLight(direction: Vector3, color: Color3, deltaSolidAngle: number): void;
  114600. /**
  114601. * Scales the spherical harmonics by the given amount
  114602. * @param scale the amount to scale
  114603. */
  114604. scaleInPlace(scale: number): void;
  114605. /**
  114606. * Convert from incident radiance (Li) to irradiance (E) by applying convolution with the cosine-weighted hemisphere.
  114607. *
  114608. * ```
  114609. * E_lm = A_l * L_lm
  114610. * ```
  114611. *
  114612. * In spherical harmonics this convolution amounts to scaling factors for each frequency band.
  114613. * This corresponds to equation 5 in "An Efficient Representation for Irradiance Environment Maps", where
  114614. * the scaling factors are given in equation 9.
  114615. */
  114616. convertIncidentRadianceToIrradiance(): void;
  114617. /**
  114618. * Convert from irradiance to outgoing radiance for Lambertian BDRF, suitable for efficient shader evaluation.
  114619. *
  114620. * ```
  114621. * L = (1/pi) * E * rho
  114622. * ```
  114623. *
  114624. * This is done by an additional scale by 1/pi, so is a fairly trivial operation but important conceptually.
  114625. */
  114626. convertIrradianceToLambertianRadiance(): void;
  114627. /**
  114628. * Integrates the reconstruction coefficients directly in to the SH preventing further
  114629. * required operations at run time.
  114630. *
  114631. * This is simply done by scaling back the SH with Ylm constants parameter.
  114632. * The trigonometric part being applied by the shader at run time.
  114633. */
  114634. preScaleForRendering(): void;
  114635. /**
  114636. * Constructs a spherical harmonics from an array.
  114637. * @param data defines the 9x3 coefficients (l00, l1-1, l10, l11, l2-2, l2-1, l20, l21, l22)
  114638. * @returns the spherical harmonics
  114639. */
  114640. static FromArray(data: ArrayLike<ArrayLike<number>>): SphericalHarmonics;
  114641. /**
  114642. * Gets the spherical harmonics from polynomial
  114643. * @param polynomial the spherical polynomial
  114644. * @returns the spherical harmonics
  114645. */
  114646. static FromPolynomial(polynomial: SphericalPolynomial): SphericalHarmonics;
  114647. }
  114648. /**
  114649. * Class representing spherical polynomial coefficients to the 3rd degree
  114650. */
  114651. export class SphericalPolynomial {
  114652. private _harmonics;
  114653. /**
  114654. * The spherical harmonics used to create the polynomials.
  114655. */
  114656. get preScaledHarmonics(): SphericalHarmonics;
  114657. /**
  114658. * The x coefficients of the spherical polynomial
  114659. */
  114660. x: Vector3;
  114661. /**
  114662. * The y coefficients of the spherical polynomial
  114663. */
  114664. y: Vector3;
  114665. /**
  114666. * The z coefficients of the spherical polynomial
  114667. */
  114668. z: Vector3;
  114669. /**
  114670. * The xx coefficients of the spherical polynomial
  114671. */
  114672. xx: Vector3;
  114673. /**
  114674. * The yy coefficients of the spherical polynomial
  114675. */
  114676. yy: Vector3;
  114677. /**
  114678. * The zz coefficients of the spherical polynomial
  114679. */
  114680. zz: Vector3;
  114681. /**
  114682. * The xy coefficients of the spherical polynomial
  114683. */
  114684. xy: Vector3;
  114685. /**
  114686. * The yz coefficients of the spherical polynomial
  114687. */
  114688. yz: Vector3;
  114689. /**
  114690. * The zx coefficients of the spherical polynomial
  114691. */
  114692. zx: Vector3;
  114693. /**
  114694. * Adds an ambient color to the spherical polynomial
  114695. * @param color the color to add
  114696. */
  114697. addAmbient(color: Color3): void;
  114698. /**
  114699. * Scales the spherical polynomial by the given amount
  114700. * @param scale the amount to scale
  114701. */
  114702. scaleInPlace(scale: number): void;
  114703. /**
  114704. * Gets the spherical polynomial from harmonics
  114705. * @param harmonics the spherical harmonics
  114706. * @returns the spherical polynomial
  114707. */
  114708. static FromHarmonics(harmonics: SphericalHarmonics): SphericalPolynomial;
  114709. /**
  114710. * Constructs a spherical polynomial from an array.
  114711. * @param data defines the 9x3 coefficients (x, y, z, xx, yy, zz, yz, zx, xy)
  114712. * @returns the spherical polynomial
  114713. */
  114714. static FromArray(data: ArrayLike<ArrayLike<number>>): SphericalPolynomial;
  114715. }
  114716. }
  114717. declare module BABYLON {
  114718. /**
  114719. * Defines the source of the internal texture
  114720. */
  114721. export enum InternalTextureSource {
  114722. /**
  114723. * The source of the texture data is unknown
  114724. */
  114725. Unknown = 0,
  114726. /**
  114727. * Texture data comes from an URL
  114728. */
  114729. Url = 1,
  114730. /**
  114731. * Texture data is only used for temporary storage
  114732. */
  114733. Temp = 2,
  114734. /**
  114735. * Texture data comes from raw data (ArrayBuffer)
  114736. */
  114737. Raw = 3,
  114738. /**
  114739. * Texture content is dynamic (video or dynamic texture)
  114740. */
  114741. Dynamic = 4,
  114742. /**
  114743. * Texture content is generated by rendering to it
  114744. */
  114745. RenderTarget = 5,
  114746. /**
  114747. * Texture content is part of a multi render target process
  114748. */
  114749. MultiRenderTarget = 6,
  114750. /**
  114751. * Texture data comes from a cube data file
  114752. */
  114753. Cube = 7,
  114754. /**
  114755. * Texture data comes from a raw cube data
  114756. */
  114757. CubeRaw = 8,
  114758. /**
  114759. * Texture data come from a prefiltered cube data file
  114760. */
  114761. CubePrefiltered = 9,
  114762. /**
  114763. * Texture content is raw 3D data
  114764. */
  114765. Raw3D = 10,
  114766. /**
  114767. * Texture content is raw 2D array data
  114768. */
  114769. Raw2DArray = 11,
  114770. /**
  114771. * Texture content is a depth texture
  114772. */
  114773. Depth = 12,
  114774. /**
  114775. * Texture data comes from a raw cube data encoded with RGBD
  114776. */
  114777. CubeRawRGBD = 13
  114778. }
  114779. /**
  114780. * Class used to store data associated with WebGL texture data for the engine
  114781. * This class should not be used directly
  114782. */
  114783. export class InternalTexture {
  114784. /** @hidden */
  114785. static _UpdateRGBDAsync: (internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number) => Promise<void>;
  114786. /**
  114787. * Defines if the texture is ready
  114788. */
  114789. isReady: boolean;
  114790. /**
  114791. * Defines if the texture is a cube texture
  114792. */
  114793. isCube: boolean;
  114794. /**
  114795. * Defines if the texture contains 3D data
  114796. */
  114797. is3D: boolean;
  114798. /**
  114799. * Defines if the texture contains 2D array data
  114800. */
  114801. is2DArray: boolean;
  114802. /**
  114803. * Defines if the texture contains multiview data
  114804. */
  114805. isMultiview: boolean;
  114806. /**
  114807. * Gets the URL used to load this texture
  114808. */
  114809. url: string;
  114810. /**
  114811. * Gets the sampling mode of the texture
  114812. */
  114813. samplingMode: number;
  114814. /**
  114815. * Gets a boolean indicating if the texture needs mipmaps generation
  114816. */
  114817. generateMipMaps: boolean;
  114818. /**
  114819. * Gets the number of samples used by the texture (WebGL2+ only)
  114820. */
  114821. samples: number;
  114822. /**
  114823. * Gets the type of the texture (int, float...)
  114824. */
  114825. type: number;
  114826. /**
  114827. * Gets the format of the texture (RGB, RGBA...)
  114828. */
  114829. format: number;
  114830. /**
  114831. * Observable called when the texture is loaded
  114832. */
  114833. onLoadedObservable: Observable<InternalTexture>;
  114834. /**
  114835. * Gets the width of the texture
  114836. */
  114837. width: number;
  114838. /**
  114839. * Gets the height of the texture
  114840. */
  114841. height: number;
  114842. /**
  114843. * Gets the depth of the texture
  114844. */
  114845. depth: number;
  114846. /**
  114847. * Gets the initial width of the texture (It could be rescaled if the current system does not support non power of two textures)
  114848. */
  114849. baseWidth: number;
  114850. /**
  114851. * Gets the initial height of the texture (It could be rescaled if the current system does not support non power of two textures)
  114852. */
  114853. baseHeight: number;
  114854. /**
  114855. * Gets the initial depth of the texture (It could be rescaled if the current system does not support non power of two textures)
  114856. */
  114857. baseDepth: number;
  114858. /**
  114859. * Gets a boolean indicating if the texture is inverted on Y axis
  114860. */
  114861. invertY: boolean;
  114862. /** @hidden */
  114863. _invertVScale: boolean;
  114864. /** @hidden */
  114865. _associatedChannel: number;
  114866. /** @hidden */
  114867. _source: InternalTextureSource;
  114868. /** @hidden */
  114869. _buffer: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>;
  114870. /** @hidden */
  114871. _bufferView: Nullable<ArrayBufferView>;
  114872. /** @hidden */
  114873. _bufferViewArray: Nullable<ArrayBufferView[]>;
  114874. /** @hidden */
  114875. _bufferViewArrayArray: Nullable<ArrayBufferView[][]>;
  114876. /** @hidden */
  114877. _size: number;
  114878. /** @hidden */
  114879. _extension: string;
  114880. /** @hidden */
  114881. _files: Nullable<string[]>;
  114882. /** @hidden */
  114883. _workingCanvas: Nullable<HTMLCanvasElement | OffscreenCanvas>;
  114884. /** @hidden */
  114885. _workingContext: Nullable<CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D>;
  114886. /** @hidden */
  114887. _framebuffer: Nullable<WebGLFramebuffer>;
  114888. /** @hidden */
  114889. _depthStencilBuffer: Nullable<WebGLRenderbuffer>;
  114890. /** @hidden */
  114891. _MSAAFramebuffer: Nullable<WebGLFramebuffer>;
  114892. /** @hidden */
  114893. _MSAARenderBuffer: Nullable<WebGLRenderbuffer>;
  114894. /** @hidden */
  114895. _attachments: Nullable<number[]>;
  114896. /** @hidden */
  114897. _textureArray: Nullable<InternalTexture[]>;
  114898. /** @hidden */
  114899. _cachedCoordinatesMode: Nullable<number>;
  114900. /** @hidden */
  114901. _cachedWrapU: Nullable<number>;
  114902. /** @hidden */
  114903. _cachedWrapV: Nullable<number>;
  114904. /** @hidden */
  114905. _cachedWrapR: Nullable<number>;
  114906. /** @hidden */
  114907. _cachedAnisotropicFilteringLevel: Nullable<number>;
  114908. /** @hidden */
  114909. _isDisabled: boolean;
  114910. /** @hidden */
  114911. _compression: Nullable<string>;
  114912. /** @hidden */
  114913. _generateStencilBuffer: boolean;
  114914. /** @hidden */
  114915. _generateDepthBuffer: boolean;
  114916. /** @hidden */
  114917. _comparisonFunction: number;
  114918. /** @hidden */
  114919. _sphericalPolynomial: Nullable<SphericalPolynomial>;
  114920. /** @hidden */
  114921. _lodGenerationScale: number;
  114922. /** @hidden */
  114923. _lodGenerationOffset: number;
  114924. /** @hidden */
  114925. _depthStencilTexture: Nullable<InternalTexture>;
  114926. /** @hidden */
  114927. _colorTextureArray: Nullable<WebGLTexture>;
  114928. /** @hidden */
  114929. _depthStencilTextureArray: Nullable<WebGLTexture>;
  114930. /** @hidden */
  114931. _lodTextureHigh: Nullable<BaseTexture>;
  114932. /** @hidden */
  114933. _lodTextureMid: Nullable<BaseTexture>;
  114934. /** @hidden */
  114935. _lodTextureLow: Nullable<BaseTexture>;
  114936. /** @hidden */
  114937. _isRGBD: boolean;
  114938. /** @hidden */
  114939. _linearSpecularLOD: boolean;
  114940. /** @hidden */
  114941. _irradianceTexture: Nullable<BaseTexture>;
  114942. /** @hidden */
  114943. _webGLTexture: Nullable<WebGLTexture>;
  114944. /** @hidden */
  114945. _references: number;
  114946. private _engine;
  114947. /**
  114948. * Gets the Engine the texture belongs to.
  114949. * @returns The babylon engine
  114950. */
  114951. getEngine(): ThinEngine;
  114952. /**
  114953. * Gets the data source type of the texture
  114954. */
  114955. get source(): InternalTextureSource;
  114956. /**
  114957. * Creates a new InternalTexture
  114958. * @param engine defines the engine to use
  114959. * @param source defines the type of data that will be used
  114960. * @param delayAllocation if the texture allocation should be delayed (default: false)
  114961. */
  114962. constructor(engine: ThinEngine, source: InternalTextureSource, delayAllocation?: boolean);
  114963. /**
  114964. * Increments the number of references (ie. the number of Texture that point to it)
  114965. */
  114966. incrementReferences(): void;
  114967. /**
  114968. * Change the size of the texture (not the size of the content)
  114969. * @param width defines the new width
  114970. * @param height defines the new height
  114971. * @param depth defines the new depth (1 by default)
  114972. */
  114973. updateSize(width: int, height: int, depth?: int): void;
  114974. /** @hidden */
  114975. _rebuild(): void;
  114976. /** @hidden */
  114977. _swapAndDie(target: InternalTexture): void;
  114978. /**
  114979. * Dispose the current allocated resources
  114980. */
  114981. dispose(): void;
  114982. }
  114983. }
  114984. declare module BABYLON {
  114985. /**
  114986. * Class used to work with sound analyzer using fast fourier transform (FFT)
  114987. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  114988. */
  114989. export class Analyser {
  114990. /**
  114991. * Gets or sets the smoothing
  114992. * @ignorenaming
  114993. */
  114994. SMOOTHING: number;
  114995. /**
  114996. * Gets or sets the FFT table size
  114997. * @ignorenaming
  114998. */
  114999. FFT_SIZE: number;
  115000. /**
  115001. * Gets or sets the bar graph amplitude
  115002. * @ignorenaming
  115003. */
  115004. BARGRAPHAMPLITUDE: number;
  115005. /**
  115006. * Gets or sets the position of the debug canvas
  115007. * @ignorenaming
  115008. */
  115009. DEBUGCANVASPOS: {
  115010. x: number;
  115011. y: number;
  115012. };
  115013. /**
  115014. * Gets or sets the debug canvas size
  115015. * @ignorenaming
  115016. */
  115017. DEBUGCANVASSIZE: {
  115018. width: number;
  115019. height: number;
  115020. };
  115021. private _byteFreqs;
  115022. private _byteTime;
  115023. private _floatFreqs;
  115024. private _webAudioAnalyser;
  115025. private _debugCanvas;
  115026. private _debugCanvasContext;
  115027. private _scene;
  115028. private _registerFunc;
  115029. private _audioEngine;
  115030. /**
  115031. * Creates a new analyser
  115032. * @param scene defines hosting scene
  115033. */
  115034. constructor(scene: Scene);
  115035. /**
  115036. * Get the number of data values you will have to play with for the visualization
  115037. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/frequencyBinCount
  115038. * @returns a number
  115039. */
  115040. getFrequencyBinCount(): number;
  115041. /**
  115042. * Gets the current frequency data as a byte array
  115043. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteFrequencyData
  115044. * @returns a Uint8Array
  115045. */
  115046. getByteFrequencyData(): Uint8Array;
  115047. /**
  115048. * Gets the current waveform as a byte array
  115049. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteTimeDomainData
  115050. * @returns a Uint8Array
  115051. */
  115052. getByteTimeDomainData(): Uint8Array;
  115053. /**
  115054. * Gets the current frequency data as a float array
  115055. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteFrequencyData
  115056. * @returns a Float32Array
  115057. */
  115058. getFloatFrequencyData(): Float32Array;
  115059. /**
  115060. * Renders the debug canvas
  115061. */
  115062. drawDebugCanvas(): void;
  115063. /**
  115064. * Stops rendering the debug canvas and removes it
  115065. */
  115066. stopDebugCanvas(): void;
  115067. /**
  115068. * Connects two audio nodes
  115069. * @param inputAudioNode defines first node to connect
  115070. * @param outputAudioNode defines second node to connect
  115071. */
  115072. connectAudioNodes(inputAudioNode: AudioNode, outputAudioNode: AudioNode): void;
  115073. /**
  115074. * Releases all associated resources
  115075. */
  115076. dispose(): void;
  115077. }
  115078. }
  115079. declare module BABYLON {
  115080. /**
  115081. * This represents an audio engine and it is responsible
  115082. * to play, synchronize and analyse sounds throughout the application.
  115083. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  115084. */
  115085. export interface IAudioEngine extends IDisposable {
  115086. /**
  115087. * Gets whether the current host supports Web Audio and thus could create AudioContexts.
  115088. */
  115089. readonly canUseWebAudio: boolean;
  115090. /**
  115091. * Gets the current AudioContext if available.
  115092. */
  115093. readonly audioContext: Nullable<AudioContext>;
  115094. /**
  115095. * The master gain node defines the global audio volume of your audio engine.
  115096. */
  115097. readonly masterGain: GainNode;
  115098. /**
  115099. * Gets whether or not mp3 are supported by your browser.
  115100. */
  115101. readonly isMP3supported: boolean;
  115102. /**
  115103. * Gets whether or not ogg are supported by your browser.
  115104. */
  115105. readonly isOGGsupported: boolean;
  115106. /**
  115107. * Defines if Babylon should emit a warning if WebAudio is not supported.
  115108. * @ignoreNaming
  115109. */
  115110. WarnedWebAudioUnsupported: boolean;
  115111. /**
  115112. * Defines if the audio engine relies on a custom unlocked button.
  115113. * In this case, the embedded button will not be displayed.
  115114. */
  115115. useCustomUnlockedButton: boolean;
  115116. /**
  115117. * Gets whether or not the audio engine is unlocked (require first a user gesture on some browser).
  115118. */
  115119. readonly unlocked: boolean;
  115120. /**
  115121. * Event raised when audio has been unlocked on the browser.
  115122. */
  115123. onAudioUnlockedObservable: Observable<AudioEngine>;
  115124. /**
  115125. * Event raised when audio has been locked on the browser.
  115126. */
  115127. onAudioLockedObservable: Observable<AudioEngine>;
  115128. /**
  115129. * Flags the audio engine in Locked state.
  115130. * This happens due to new browser policies preventing audio to autoplay.
  115131. */
  115132. lock(): void;
  115133. /**
  115134. * Unlocks the audio engine once a user action has been done on the dom.
  115135. * This is helpful to resume play once browser policies have been satisfied.
  115136. */
  115137. unlock(): void;
  115138. /**
  115139. * Gets the global volume sets on the master gain.
  115140. * @returns the global volume if set or -1 otherwise
  115141. */
  115142. getGlobalVolume(): number;
  115143. /**
  115144. * Sets the global volume of your experience (sets on the master gain).
  115145. * @param newVolume Defines the new global volume of the application
  115146. */
  115147. setGlobalVolume(newVolume: number): void;
  115148. /**
  115149. * Connect the audio engine to an audio analyser allowing some amazing
  115150. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  115151. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  115152. * @param analyser The analyser to connect to the engine
  115153. */
  115154. connectToAnalyser(analyser: Analyser): void;
  115155. }
  115156. /**
  115157. * This represents the default audio engine used in babylon.
  115158. * It is responsible to play, synchronize and analyse sounds throughout the application.
  115159. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  115160. */
  115161. export class AudioEngine implements IAudioEngine {
  115162. private _audioContext;
  115163. private _audioContextInitialized;
  115164. private _muteButton;
  115165. private _hostElement;
  115166. /**
  115167. * Gets whether the current host supports Web Audio and thus could create AudioContexts.
  115168. */
  115169. canUseWebAudio: boolean;
  115170. /**
  115171. * The master gain node defines the global audio volume of your audio engine.
  115172. */
  115173. masterGain: GainNode;
  115174. /**
  115175. * Defines if Babylon should emit a warning if WebAudio is not supported.
  115176. * @ignoreNaming
  115177. */
  115178. WarnedWebAudioUnsupported: boolean;
  115179. /**
  115180. * Gets whether or not mp3 are supported by your browser.
  115181. */
  115182. isMP3supported: boolean;
  115183. /**
  115184. * Gets whether or not ogg are supported by your browser.
  115185. */
  115186. isOGGsupported: boolean;
  115187. /**
  115188. * Gets whether audio has been unlocked on the device.
  115189. * Some Browsers have strong restrictions about Audio and won t autoplay unless
  115190. * a user interaction has happened.
  115191. */
  115192. unlocked: boolean;
  115193. /**
  115194. * Defines if the audio engine relies on a custom unlocked button.
  115195. * In this case, the embedded button will not be displayed.
  115196. */
  115197. useCustomUnlockedButton: boolean;
  115198. /**
  115199. * Event raised when audio has been unlocked on the browser.
  115200. */
  115201. onAudioUnlockedObservable: Observable<AudioEngine>;
  115202. /**
  115203. * Event raised when audio has been locked on the browser.
  115204. */
  115205. onAudioLockedObservable: Observable<AudioEngine>;
  115206. /**
  115207. * Gets the current AudioContext if available.
  115208. */
  115209. get audioContext(): Nullable<AudioContext>;
  115210. private _connectedAnalyser;
  115211. /**
  115212. * Instantiates a new audio engine.
  115213. *
  115214. * There should be only one per page as some browsers restrict the number
  115215. * of audio contexts you can create.
  115216. * @param hostElement defines the host element where to display the mute icon if necessary
  115217. */
  115218. constructor(hostElement?: Nullable<HTMLElement>);
  115219. /**
  115220. * Flags the audio engine in Locked state.
  115221. * This happens due to new browser policies preventing audio to autoplay.
  115222. */
  115223. lock(): void;
  115224. /**
  115225. * Unlocks the audio engine once a user action has been done on the dom.
  115226. * This is helpful to resume play once browser policies have been satisfied.
  115227. */
  115228. unlock(): void;
  115229. private _resumeAudioContext;
  115230. private _initializeAudioContext;
  115231. private _tryToRun;
  115232. private _triggerRunningState;
  115233. private _triggerSuspendedState;
  115234. private _displayMuteButton;
  115235. private _moveButtonToTopLeft;
  115236. private _onResize;
  115237. private _hideMuteButton;
  115238. /**
  115239. * Destroy and release the resources associated with the audio ccontext.
  115240. */
  115241. dispose(): void;
  115242. /**
  115243. * Gets the global volume sets on the master gain.
  115244. * @returns the global volume if set or -1 otherwise
  115245. */
  115246. getGlobalVolume(): number;
  115247. /**
  115248. * Sets the global volume of your experience (sets on the master gain).
  115249. * @param newVolume Defines the new global volume of the application
  115250. */
  115251. setGlobalVolume(newVolume: number): void;
  115252. /**
  115253. * Connect the audio engine to an audio analyser allowing some amazing
  115254. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  115255. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  115256. * @param analyser The analyser to connect to the engine
  115257. */
  115258. connectToAnalyser(analyser: Analyser): void;
  115259. }
  115260. }
  115261. declare module BABYLON {
  115262. /**
  115263. * Interface used to present a loading screen while loading a scene
  115264. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  115265. */
  115266. export interface ILoadingScreen {
  115267. /**
  115268. * Function called to display the loading screen
  115269. */
  115270. displayLoadingUI: () => void;
  115271. /**
  115272. * Function called to hide the loading screen
  115273. */
  115274. hideLoadingUI: () => void;
  115275. /**
  115276. * Gets or sets the color to use for the background
  115277. */
  115278. loadingUIBackgroundColor: string;
  115279. /**
  115280. * Gets or sets the text to display while loading
  115281. */
  115282. loadingUIText: string;
  115283. }
  115284. /**
  115285. * Class used for the default loading screen
  115286. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  115287. */
  115288. export class DefaultLoadingScreen implements ILoadingScreen {
  115289. private _renderingCanvas;
  115290. private _loadingText;
  115291. private _loadingDivBackgroundColor;
  115292. private _loadingDiv;
  115293. private _loadingTextDiv;
  115294. /** Gets or sets the logo url to use for the default loading screen */
  115295. static DefaultLogoUrl: string;
  115296. /** Gets or sets the spinner url to use for the default loading screen */
  115297. static DefaultSpinnerUrl: string;
  115298. /**
  115299. * Creates a new default loading screen
  115300. * @param _renderingCanvas defines the canvas used to render the scene
  115301. * @param _loadingText defines the default text to display
  115302. * @param _loadingDivBackgroundColor defines the default background color
  115303. */
  115304. constructor(_renderingCanvas: HTMLCanvasElement, _loadingText?: string, _loadingDivBackgroundColor?: string);
  115305. /**
  115306. * Function called to display the loading screen
  115307. */
  115308. displayLoadingUI(): void;
  115309. /**
  115310. * Function called to hide the loading screen
  115311. */
  115312. hideLoadingUI(): void;
  115313. /**
  115314. * Gets or sets the text to display while loading
  115315. */
  115316. set loadingUIText(text: string);
  115317. get loadingUIText(): string;
  115318. /**
  115319. * Gets or sets the color to use for the background
  115320. */
  115321. get loadingUIBackgroundColor(): string;
  115322. set loadingUIBackgroundColor(color: string);
  115323. private _resizeLoadingUI;
  115324. }
  115325. }
  115326. declare module BABYLON {
  115327. /**
  115328. * Interface for any object that can request an animation frame
  115329. */
  115330. export interface ICustomAnimationFrameRequester {
  115331. /**
  115332. * This function will be called when the render loop is ready. If this is not populated, the engine's renderloop function will be called
  115333. */
  115334. renderFunction?: Function;
  115335. /**
  115336. * Called to request the next frame to render to
  115337. * @see https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame
  115338. */
  115339. requestAnimationFrame: Function;
  115340. /**
  115341. * You can pass this value to cancelAnimationFrame() to cancel the refresh callback request
  115342. * @see https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame#Return_value
  115343. */
  115344. requestID?: number;
  115345. }
  115346. }
  115347. declare module BABYLON {
  115348. /**
  115349. * Performance monitor tracks rolling average frame-time and frame-time variance over a user defined sliding-window
  115350. */
  115351. export class PerformanceMonitor {
  115352. private _enabled;
  115353. private _rollingFrameTime;
  115354. private _lastFrameTimeMs;
  115355. /**
  115356. * constructor
  115357. * @param frameSampleSize The number of samples required to saturate the sliding window
  115358. */
  115359. constructor(frameSampleSize?: number);
  115360. /**
  115361. * Samples current frame
  115362. * @param timeMs A timestamp in milliseconds of the current frame to compare with other frames
  115363. */
  115364. sampleFrame(timeMs?: number): void;
  115365. /**
  115366. * Returns the average frame time in milliseconds over the sliding window (or the subset of frames sampled so far)
  115367. */
  115368. get averageFrameTime(): number;
  115369. /**
  115370. * Returns the variance frame time in milliseconds over the sliding window (or the subset of frames sampled so far)
  115371. */
  115372. get averageFrameTimeVariance(): number;
  115373. /**
  115374. * Returns the frame time of the most recent frame
  115375. */
  115376. get instantaneousFrameTime(): number;
  115377. /**
  115378. * Returns the average framerate in frames per second over the sliding window (or the subset of frames sampled so far)
  115379. */
  115380. get averageFPS(): number;
  115381. /**
  115382. * Returns the average framerate in frames per second using the most recent frame time
  115383. */
  115384. get instantaneousFPS(): number;
  115385. /**
  115386. * Returns true if enough samples have been taken to completely fill the sliding window
  115387. */
  115388. get isSaturated(): boolean;
  115389. /**
  115390. * Enables contributions to the sliding window sample set
  115391. */
  115392. enable(): void;
  115393. /**
  115394. * Disables contributions to the sliding window sample set
  115395. * Samples will not be interpolated over the disabled period
  115396. */
  115397. disable(): void;
  115398. /**
  115399. * Returns true if sampling is enabled
  115400. */
  115401. get isEnabled(): boolean;
  115402. /**
  115403. * Resets performance monitor
  115404. */
  115405. reset(): void;
  115406. }
  115407. /**
  115408. * RollingAverage
  115409. *
  115410. * Utility to efficiently compute the rolling average and variance over a sliding window of samples
  115411. */
  115412. export class RollingAverage {
  115413. /**
  115414. * Current average
  115415. */
  115416. average: number;
  115417. /**
  115418. * Current variance
  115419. */
  115420. variance: number;
  115421. protected _samples: Array<number>;
  115422. protected _sampleCount: number;
  115423. protected _pos: number;
  115424. protected _m2: number;
  115425. /**
  115426. * constructor
  115427. * @param length The number of samples required to saturate the sliding window
  115428. */
  115429. constructor(length: number);
  115430. /**
  115431. * Adds a sample to the sample set
  115432. * @param v The sample value
  115433. */
  115434. add(v: number): void;
  115435. /**
  115436. * Returns previously added values or null if outside of history or outside the sliding window domain
  115437. * @param i Index in history. For example, pass 0 for the most recent value and 1 for the value before that
  115438. * @return Value previously recorded with add() or null if outside of range
  115439. */
  115440. history(i: number): number;
  115441. /**
  115442. * Returns true if enough samples have been taken to completely fill the sliding window
  115443. * @return true if sample-set saturated
  115444. */
  115445. isSaturated(): boolean;
  115446. /**
  115447. * Resets the rolling average (equivalent to 0 samples taken so far)
  115448. */
  115449. reset(): void;
  115450. /**
  115451. * Wraps a value around the sample range boundaries
  115452. * @param i Position in sample range, for example if the sample length is 5, and i is -3, then 2 will be returned.
  115453. * @return Wrapped position in sample range
  115454. */
  115455. protected _wrapPosition(i: number): number;
  115456. }
  115457. }
  115458. declare module BABYLON {
  115459. /**
  115460. * This class is used to track a performance counter which is number based.
  115461. * The user has access to many properties which give statistics of different nature.
  115462. *
  115463. * The implementer can track two kinds of Performance Counter: time and count.
  115464. * 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.
  115465. * 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.
  115466. */
  115467. export class PerfCounter {
  115468. /**
  115469. * Gets or sets a global boolean to turn on and off all the counters
  115470. */
  115471. static Enabled: boolean;
  115472. /**
  115473. * Returns the smallest value ever
  115474. */
  115475. get min(): number;
  115476. /**
  115477. * Returns the biggest value ever
  115478. */
  115479. get max(): number;
  115480. /**
  115481. * Returns the average value since the performance counter is running
  115482. */
  115483. get average(): number;
  115484. /**
  115485. * Returns the average value of the last second the counter was monitored
  115486. */
  115487. get lastSecAverage(): number;
  115488. /**
  115489. * Returns the current value
  115490. */
  115491. get current(): number;
  115492. /**
  115493. * Gets the accumulated total
  115494. */
  115495. get total(): number;
  115496. /**
  115497. * Gets the total value count
  115498. */
  115499. get count(): number;
  115500. /**
  115501. * Creates a new counter
  115502. */
  115503. constructor();
  115504. /**
  115505. * Call this method to start monitoring a new frame.
  115506. * 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.
  115507. */
  115508. fetchNewFrame(): void;
  115509. /**
  115510. * Call this method to monitor a count of something (e.g. mesh drawn in viewport count)
  115511. * @param newCount the count value to add to the monitored count
  115512. * @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.
  115513. */
  115514. addCount(newCount: number, fetchResult: boolean): void;
  115515. /**
  115516. * Start monitoring this performance counter
  115517. */
  115518. beginMonitoring(): void;
  115519. /**
  115520. * Compute the time lapsed since the previous beginMonitoring() call.
  115521. * @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
  115522. */
  115523. endMonitoring(newFrame?: boolean): void;
  115524. private _fetchResult;
  115525. private _startMonitoringTime;
  115526. private _min;
  115527. private _max;
  115528. private _average;
  115529. private _current;
  115530. private _totalValueCount;
  115531. private _totalAccumulated;
  115532. private _lastSecAverage;
  115533. private _lastSecAccumulated;
  115534. private _lastSecTime;
  115535. private _lastSecValueCount;
  115536. }
  115537. }
  115538. declare module BABYLON {
  115539. interface ThinEngine {
  115540. /**
  115541. * Sets alpha constants used by some alpha blending modes
  115542. * @param r defines the red component
  115543. * @param g defines the green component
  115544. * @param b defines the blue component
  115545. * @param a defines the alpha component
  115546. */
  115547. setAlphaConstants(r: number, g: number, b: number, a: number): void;
  115548. /**
  115549. * Sets the current alpha mode
  115550. * @param mode defines the mode to use (one of the Engine.ALPHA_XXX)
  115551. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  115552. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  115553. */
  115554. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  115555. /**
  115556. * Gets the current alpha mode
  115557. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  115558. * @returns the current alpha mode
  115559. */
  115560. getAlphaMode(): number;
  115561. /**
  115562. * Sets the current alpha equation
  115563. * @param equation defines the equation to use (one of the Engine.ALPHA_EQUATION_XXX)
  115564. */
  115565. setAlphaEquation(equation: number): void;
  115566. /**
  115567. * Gets the current alpha equation.
  115568. * @returns the current alpha equation
  115569. */
  115570. getAlphaEquation(): number;
  115571. }
  115572. }
  115573. declare module BABYLON {
  115574. interface ThinEngine {
  115575. /** @hidden */
  115576. _readTexturePixels(texture: InternalTexture, width: number, height: number, faceIndex?: number, level?: number, buffer?: Nullable<ArrayBufferView>): ArrayBufferView;
  115577. }
  115578. }
  115579. declare module BABYLON {
  115580. /**
  115581. * Defines the interface used by display changed events
  115582. */
  115583. export interface IDisplayChangedEventArgs {
  115584. /** Gets the vrDisplay object (if any) */
  115585. vrDisplay: Nullable<any>;
  115586. /** Gets a boolean indicating if webVR is supported */
  115587. vrSupported: boolean;
  115588. }
  115589. /**
  115590. * Defines the interface used by objects containing a viewport (like a camera)
  115591. */
  115592. interface IViewportOwnerLike {
  115593. /**
  115594. * Gets or sets the viewport
  115595. */
  115596. viewport: IViewportLike;
  115597. }
  115598. /**
  115599. * The engine class is responsible for interfacing with all lower-level APIs such as WebGL and Audio
  115600. */
  115601. export class Engine extends ThinEngine {
  115602. /** Defines that alpha blending is disabled */
  115603. static readonly ALPHA_DISABLE: number;
  115604. /** Defines that alpha blending to SRC ALPHA * SRC + DEST */
  115605. static readonly ALPHA_ADD: number;
  115606. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC ALPHA) * DEST */
  115607. static readonly ALPHA_COMBINE: number;
  115608. /** Defines that alpha blending to DEST - SRC * DEST */
  115609. static readonly ALPHA_SUBTRACT: number;
  115610. /** Defines that alpha blending to SRC * DEST */
  115611. static readonly ALPHA_MULTIPLY: number;
  115612. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC) * DEST */
  115613. static readonly ALPHA_MAXIMIZED: number;
  115614. /** Defines that alpha blending to SRC + DEST */
  115615. static readonly ALPHA_ONEONE: number;
  115616. /** Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST */
  115617. static readonly ALPHA_PREMULTIPLIED: number;
  115618. /**
  115619. * Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST
  115620. * Alpha will be set to (1 - SRC ALPHA) * DEST ALPHA
  115621. */
  115622. static readonly ALPHA_PREMULTIPLIED_PORTERDUFF: number;
  115623. /** Defines that alpha blending to CST * SRC + (1 - CST) * DEST */
  115624. static readonly ALPHA_INTERPOLATE: number;
  115625. /**
  115626. * Defines that alpha blending to SRC + (1 - SRC) * DEST
  115627. * Alpha will be set to SRC ALPHA + (1 - SRC ALPHA) * DEST ALPHA
  115628. */
  115629. static readonly ALPHA_SCREENMODE: number;
  115630. /** Defines that the ressource is not delayed*/
  115631. static readonly DELAYLOADSTATE_NONE: number;
  115632. /** Defines that the ressource was successfully delay loaded */
  115633. static readonly DELAYLOADSTATE_LOADED: number;
  115634. /** Defines that the ressource is currently delay loading */
  115635. static readonly DELAYLOADSTATE_LOADING: number;
  115636. /** Defines that the ressource is delayed and has not started loading */
  115637. static readonly DELAYLOADSTATE_NOTLOADED: number;
  115638. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will never pass. i.e. Nothing will be drawn */
  115639. static readonly NEVER: number;
  115640. /** 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 */
  115641. static readonly ALWAYS: number;
  115642. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than the stored value */
  115643. static readonly LESS: number;
  115644. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is equals to the stored value */
  115645. static readonly EQUAL: number;
  115646. /** 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 */
  115647. static readonly LEQUAL: number;
  115648. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than the stored value */
  115649. static readonly GREATER: number;
  115650. /** 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 */
  115651. static readonly GEQUAL: number;
  115652. /** 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 */
  115653. static readonly NOTEQUAL: number;
  115654. /** Passed to stencilOperation to specify that stencil value must be kept */
  115655. static readonly KEEP: number;
  115656. /** Passed to stencilOperation to specify that stencil value must be replaced */
  115657. static readonly REPLACE: number;
  115658. /** Passed to stencilOperation to specify that stencil value must be incremented */
  115659. static readonly INCR: number;
  115660. /** Passed to stencilOperation to specify that stencil value must be decremented */
  115661. static readonly DECR: number;
  115662. /** Passed to stencilOperation to specify that stencil value must be inverted */
  115663. static readonly INVERT: number;
  115664. /** Passed to stencilOperation to specify that stencil value must be incremented with wrapping */
  115665. static readonly INCR_WRAP: number;
  115666. /** Passed to stencilOperation to specify that stencil value must be decremented with wrapping */
  115667. static readonly DECR_WRAP: number;
  115668. /** Texture is not repeating outside of 0..1 UVs */
  115669. static readonly TEXTURE_CLAMP_ADDRESSMODE: number;
  115670. /** Texture is repeating outside of 0..1 UVs */
  115671. static readonly TEXTURE_WRAP_ADDRESSMODE: number;
  115672. /** Texture is repeating and mirrored */
  115673. static readonly TEXTURE_MIRROR_ADDRESSMODE: number;
  115674. /** ALPHA */
  115675. static readonly TEXTUREFORMAT_ALPHA: number;
  115676. /** LUMINANCE */
  115677. static readonly TEXTUREFORMAT_LUMINANCE: number;
  115678. /** LUMINANCE_ALPHA */
  115679. static readonly TEXTUREFORMAT_LUMINANCE_ALPHA: number;
  115680. /** RGB */
  115681. static readonly TEXTUREFORMAT_RGB: number;
  115682. /** RGBA */
  115683. static readonly TEXTUREFORMAT_RGBA: number;
  115684. /** RED */
  115685. static readonly TEXTUREFORMAT_RED: number;
  115686. /** RED (2nd reference) */
  115687. static readonly TEXTUREFORMAT_R: number;
  115688. /** RG */
  115689. static readonly TEXTUREFORMAT_RG: number;
  115690. /** RED_INTEGER */
  115691. static readonly TEXTUREFORMAT_RED_INTEGER: number;
  115692. /** RED_INTEGER (2nd reference) */
  115693. static readonly TEXTUREFORMAT_R_INTEGER: number;
  115694. /** RG_INTEGER */
  115695. static readonly TEXTUREFORMAT_RG_INTEGER: number;
  115696. /** RGB_INTEGER */
  115697. static readonly TEXTUREFORMAT_RGB_INTEGER: number;
  115698. /** RGBA_INTEGER */
  115699. static readonly TEXTUREFORMAT_RGBA_INTEGER: number;
  115700. /** UNSIGNED_BYTE */
  115701. static readonly TEXTURETYPE_UNSIGNED_BYTE: number;
  115702. /** UNSIGNED_BYTE (2nd reference) */
  115703. static readonly TEXTURETYPE_UNSIGNED_INT: number;
  115704. /** FLOAT */
  115705. static readonly TEXTURETYPE_FLOAT: number;
  115706. /** HALF_FLOAT */
  115707. static readonly TEXTURETYPE_HALF_FLOAT: number;
  115708. /** BYTE */
  115709. static readonly TEXTURETYPE_BYTE: number;
  115710. /** SHORT */
  115711. static readonly TEXTURETYPE_SHORT: number;
  115712. /** UNSIGNED_SHORT */
  115713. static readonly TEXTURETYPE_UNSIGNED_SHORT: number;
  115714. /** INT */
  115715. static readonly TEXTURETYPE_INT: number;
  115716. /** UNSIGNED_INT */
  115717. static readonly TEXTURETYPE_UNSIGNED_INTEGER: number;
  115718. /** UNSIGNED_SHORT_4_4_4_4 */
  115719. static readonly TEXTURETYPE_UNSIGNED_SHORT_4_4_4_4: number;
  115720. /** UNSIGNED_SHORT_5_5_5_1 */
  115721. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_5_5_1: number;
  115722. /** UNSIGNED_SHORT_5_6_5 */
  115723. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_6_5: number;
  115724. /** UNSIGNED_INT_2_10_10_10_REV */
  115725. static readonly TEXTURETYPE_UNSIGNED_INT_2_10_10_10_REV: number;
  115726. /** UNSIGNED_INT_24_8 */
  115727. static readonly TEXTURETYPE_UNSIGNED_INT_24_8: number;
  115728. /** UNSIGNED_INT_10F_11F_11F_REV */
  115729. static readonly TEXTURETYPE_UNSIGNED_INT_10F_11F_11F_REV: number;
  115730. /** UNSIGNED_INT_5_9_9_9_REV */
  115731. static readonly TEXTURETYPE_UNSIGNED_INT_5_9_9_9_REV: number;
  115732. /** FLOAT_32_UNSIGNED_INT_24_8_REV */
  115733. static readonly TEXTURETYPE_FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  115734. /** nearest is mag = nearest and min = nearest and mip = linear */
  115735. static readonly TEXTURE_NEAREST_SAMPLINGMODE: number;
  115736. /** Bilinear is mag = linear and min = linear and mip = nearest */
  115737. static readonly TEXTURE_BILINEAR_SAMPLINGMODE: number;
  115738. /** Trilinear is mag = linear and min = linear and mip = linear */
  115739. static readonly TEXTURE_TRILINEAR_SAMPLINGMODE: number;
  115740. /** nearest is mag = nearest and min = nearest and mip = linear */
  115741. static readonly TEXTURE_NEAREST_NEAREST_MIPLINEAR: number;
  115742. /** Bilinear is mag = linear and min = linear and mip = nearest */
  115743. static readonly TEXTURE_LINEAR_LINEAR_MIPNEAREST: number;
  115744. /** Trilinear is mag = linear and min = linear and mip = linear */
  115745. static readonly TEXTURE_LINEAR_LINEAR_MIPLINEAR: number;
  115746. /** mag = nearest and min = nearest and mip = nearest */
  115747. static readonly TEXTURE_NEAREST_NEAREST_MIPNEAREST: number;
  115748. /** mag = nearest and min = linear and mip = nearest */
  115749. static readonly TEXTURE_NEAREST_LINEAR_MIPNEAREST: number;
  115750. /** mag = nearest and min = linear and mip = linear */
  115751. static readonly TEXTURE_NEAREST_LINEAR_MIPLINEAR: number;
  115752. /** mag = nearest and min = linear and mip = none */
  115753. static readonly TEXTURE_NEAREST_LINEAR: number;
  115754. /** mag = nearest and min = nearest and mip = none */
  115755. static readonly TEXTURE_NEAREST_NEAREST: number;
  115756. /** mag = linear and min = nearest and mip = nearest */
  115757. static readonly TEXTURE_LINEAR_NEAREST_MIPNEAREST: number;
  115758. /** mag = linear and min = nearest and mip = linear */
  115759. static readonly TEXTURE_LINEAR_NEAREST_MIPLINEAR: number;
  115760. /** mag = linear and min = linear and mip = none */
  115761. static readonly TEXTURE_LINEAR_LINEAR: number;
  115762. /** mag = linear and min = nearest and mip = none */
  115763. static readonly TEXTURE_LINEAR_NEAREST: number;
  115764. /** Explicit coordinates mode */
  115765. static readonly TEXTURE_EXPLICIT_MODE: number;
  115766. /** Spherical coordinates mode */
  115767. static readonly TEXTURE_SPHERICAL_MODE: number;
  115768. /** Planar coordinates mode */
  115769. static readonly TEXTURE_PLANAR_MODE: number;
  115770. /** Cubic coordinates mode */
  115771. static readonly TEXTURE_CUBIC_MODE: number;
  115772. /** Projection coordinates mode */
  115773. static readonly TEXTURE_PROJECTION_MODE: number;
  115774. /** Skybox coordinates mode */
  115775. static readonly TEXTURE_SKYBOX_MODE: number;
  115776. /** Inverse Cubic coordinates mode */
  115777. static readonly TEXTURE_INVCUBIC_MODE: number;
  115778. /** Equirectangular coordinates mode */
  115779. static readonly TEXTURE_EQUIRECTANGULAR_MODE: number;
  115780. /** Equirectangular Fixed coordinates mode */
  115781. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MODE: number;
  115782. /** Equirectangular Fixed Mirrored coordinates mode */
  115783. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  115784. /** Defines that texture rescaling will use a floor to find the closer power of 2 size */
  115785. static readonly SCALEMODE_FLOOR: number;
  115786. /** Defines that texture rescaling will look for the nearest power of 2 size */
  115787. static readonly SCALEMODE_NEAREST: number;
  115788. /** Defines that texture rescaling will use a ceil to find the closer power of 2 size */
  115789. static readonly SCALEMODE_CEILING: number;
  115790. /**
  115791. * Returns the current npm package of the sdk
  115792. */
  115793. static get NpmPackage(): string;
  115794. /**
  115795. * Returns the current version of the framework
  115796. */
  115797. static get Version(): string;
  115798. /** Gets the list of created engines */
  115799. static get Instances(): Engine[];
  115800. /**
  115801. * Gets the latest created engine
  115802. */
  115803. static get LastCreatedEngine(): Nullable<Engine>;
  115804. /**
  115805. * Gets the latest created scene
  115806. */
  115807. static get LastCreatedScene(): Nullable<Scene>;
  115808. /**
  115809. * Will flag all materials in all scenes in all engines as dirty to trigger new shader compilation
  115810. * @param flag defines which part of the materials must be marked as dirty
  115811. * @param predicate defines a predicate used to filter which materials should be affected
  115812. */
  115813. static MarkAllMaterialsAsDirty(flag: number, predicate?: (mat: Material) => boolean): void;
  115814. /**
  115815. * Method called to create the default loading screen.
  115816. * This can be overriden in your own app.
  115817. * @param canvas The rendering canvas element
  115818. * @returns The loading screen
  115819. */
  115820. static DefaultLoadingScreenFactory(canvas: HTMLCanvasElement): ILoadingScreen;
  115821. /**
  115822. * Method called to create the default rescale post process on each engine.
  115823. */
  115824. static _RescalePostProcessFactory: Nullable<(engine: Engine) => PostProcess>;
  115825. /**
  115826. * Gets or sets a boolean to enable/disable IndexedDB support and avoid XHR on .manifest
  115827. **/
  115828. enableOfflineSupport: boolean;
  115829. /**
  115830. * 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)
  115831. **/
  115832. disableManifestCheck: boolean;
  115833. /**
  115834. * Gets the list of created scenes
  115835. */
  115836. scenes: Scene[];
  115837. /**
  115838. * Event raised when a new scene is created
  115839. */
  115840. onNewSceneAddedObservable: Observable<Scene>;
  115841. /**
  115842. * Gets the list of created postprocesses
  115843. */
  115844. postProcesses: PostProcess[];
  115845. /**
  115846. * Gets a boolean indicating if the pointer is currently locked
  115847. */
  115848. isPointerLock: boolean;
  115849. /**
  115850. * Observable event triggered each time the rendering canvas is resized
  115851. */
  115852. onResizeObservable: Observable<Engine>;
  115853. /**
  115854. * Observable event triggered each time the canvas loses focus
  115855. */
  115856. onCanvasBlurObservable: Observable<Engine>;
  115857. /**
  115858. * Observable event triggered each time the canvas gains focus
  115859. */
  115860. onCanvasFocusObservable: Observable<Engine>;
  115861. /**
  115862. * Observable event triggered each time the canvas receives pointerout event
  115863. */
  115864. onCanvasPointerOutObservable: Observable<PointerEvent>;
  115865. /**
  115866. * Observable raised when the engine begins a new frame
  115867. */
  115868. onBeginFrameObservable: Observable<Engine>;
  115869. /**
  115870. * If set, will be used to request the next animation frame for the render loop
  115871. */
  115872. customAnimationFrameRequester: Nullable<ICustomAnimationFrameRequester>;
  115873. /**
  115874. * Observable raised when the engine ends the current frame
  115875. */
  115876. onEndFrameObservable: Observable<Engine>;
  115877. /**
  115878. * Observable raised when the engine is about to compile a shader
  115879. */
  115880. onBeforeShaderCompilationObservable: Observable<Engine>;
  115881. /**
  115882. * Observable raised when the engine has jsut compiled a shader
  115883. */
  115884. onAfterShaderCompilationObservable: Observable<Engine>;
  115885. /**
  115886. * Gets the audio engine
  115887. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  115888. * @ignorenaming
  115889. */
  115890. static audioEngine: IAudioEngine;
  115891. /**
  115892. * Default AudioEngine factory responsible of creating the Audio Engine.
  115893. * By default, this will create a BabylonJS Audio Engine if the workload has been embedded.
  115894. */
  115895. static AudioEngineFactory: (hostElement: Nullable<HTMLElement>) => IAudioEngine;
  115896. /**
  115897. * Default offline support factory responsible of creating a tool used to store data locally.
  115898. * By default, this will create a Database object if the workload has been embedded.
  115899. */
  115900. static OfflineProviderFactory: (urlToScene: string, callbackManifestChecked: (checked: boolean) => any, disableManifestCheck: boolean) => IOfflineProvider;
  115901. private _loadingScreen;
  115902. private _pointerLockRequested;
  115903. private _rescalePostProcess;
  115904. private _deterministicLockstep;
  115905. private _lockstepMaxSteps;
  115906. private _timeStep;
  115907. protected get _supportsHardwareTextureRescaling(): boolean;
  115908. private _fps;
  115909. private _deltaTime;
  115910. /** @hidden */
  115911. _drawCalls: PerfCounter;
  115912. /** 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 */
  115913. canvasTabIndex: number;
  115914. /**
  115915. * Turn this value on if you want to pause FPS computation when in background
  115916. */
  115917. disablePerformanceMonitorInBackground: boolean;
  115918. private _performanceMonitor;
  115919. /**
  115920. * Gets the performance monitor attached to this engine
  115921. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  115922. */
  115923. get performanceMonitor(): PerformanceMonitor;
  115924. private _onFocus;
  115925. private _onBlur;
  115926. private _onCanvasPointerOut;
  115927. private _onCanvasBlur;
  115928. private _onCanvasFocus;
  115929. private _onFullscreenChange;
  115930. private _onPointerLockChange;
  115931. /**
  115932. * Gets the HTML element used to attach event listeners
  115933. * @returns a HTML element
  115934. */
  115935. getInputElement(): Nullable<HTMLElement>;
  115936. /**
  115937. * Creates a new engine
  115938. * @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
  115939. * @param antialias defines enable antialiasing (default: false)
  115940. * @param options defines further options to be sent to the getContext() function
  115941. * @param adaptToDeviceRatio defines whether to adapt to the device's viewport characteristics (default: false)
  115942. */
  115943. constructor(canvasOrContext: Nullable<HTMLCanvasElement | WebGLRenderingContext>, antialias?: boolean, options?: EngineOptions, adaptToDeviceRatio?: boolean);
  115944. /**
  115945. * Gets current aspect ratio
  115946. * @param viewportOwner defines the camera to use to get the aspect ratio
  115947. * @param useScreen defines if screen size must be used (or the current render target if any)
  115948. * @returns a number defining the aspect ratio
  115949. */
  115950. getAspectRatio(viewportOwner: IViewportOwnerLike, useScreen?: boolean): number;
  115951. /**
  115952. * Gets current screen aspect ratio
  115953. * @returns a number defining the aspect ratio
  115954. */
  115955. getScreenAspectRatio(): number;
  115956. /**
  115957. * Gets the client rect of the HTML canvas attached with the current webGL context
  115958. * @returns a client rectanglee
  115959. */
  115960. getRenderingCanvasClientRect(): Nullable<ClientRect>;
  115961. /**
  115962. * Gets the client rect of the HTML element used for events
  115963. * @returns a client rectanglee
  115964. */
  115965. getInputElementClientRect(): Nullable<ClientRect>;
  115966. /**
  115967. * Gets a boolean indicating that the engine is running in deterministic lock step mode
  115968. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  115969. * @returns true if engine is in deterministic lock step mode
  115970. */
  115971. isDeterministicLockStep(): boolean;
  115972. /**
  115973. * Gets the max steps when engine is running in deterministic lock step
  115974. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  115975. * @returns the max steps
  115976. */
  115977. getLockstepMaxSteps(): number;
  115978. /**
  115979. * Returns the time in ms between steps when using deterministic lock step.
  115980. * @returns time step in (ms)
  115981. */
  115982. getTimeStep(): number;
  115983. /**
  115984. * Force the mipmap generation for the given render target texture
  115985. * @param texture defines the render target texture to use
  115986. * @param unbind defines whether or not to unbind the texture after generation. Defaults to true.
  115987. */
  115988. generateMipMapsForCubemap(texture: InternalTexture, unbind?: boolean): void;
  115989. /** States */
  115990. /**
  115991. * Set various states to the webGL context
  115992. * @param culling defines backface culling state
  115993. * @param zOffset defines the value to apply to zOffset (0 by default)
  115994. * @param force defines if states must be applied even if cache is up to date
  115995. * @param reverseSide defines if culling must be reversed (CCW instead of CW and CW instead of CCW)
  115996. */
  115997. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  115998. /**
  115999. * Set the z offset to apply to current rendering
  116000. * @param value defines the offset to apply
  116001. */
  116002. setZOffset(value: number): void;
  116003. /**
  116004. * Gets the current value of the zOffset
  116005. * @returns the current zOffset state
  116006. */
  116007. getZOffset(): number;
  116008. /**
  116009. * Enable or disable depth buffering
  116010. * @param enable defines the state to set
  116011. */
  116012. setDepthBuffer(enable: boolean): void;
  116013. /**
  116014. * Gets a boolean indicating if depth writing is enabled
  116015. * @returns the current depth writing state
  116016. */
  116017. getDepthWrite(): boolean;
  116018. /**
  116019. * Enable or disable depth writing
  116020. * @param enable defines the state to set
  116021. */
  116022. setDepthWrite(enable: boolean): void;
  116023. /**
  116024. * Gets a boolean indicating if stencil buffer is enabled
  116025. * @returns the current stencil buffer state
  116026. */
  116027. getStencilBuffer(): boolean;
  116028. /**
  116029. * Enable or disable the stencil buffer
  116030. * @param enable defines if the stencil buffer must be enabled or disabled
  116031. */
  116032. setStencilBuffer(enable: boolean): void;
  116033. /**
  116034. * Gets the current stencil mask
  116035. * @returns a number defining the new stencil mask to use
  116036. */
  116037. getStencilMask(): number;
  116038. /**
  116039. * Sets the current stencil mask
  116040. * @param mask defines the new stencil mask to use
  116041. */
  116042. setStencilMask(mask: number): void;
  116043. /**
  116044. * Gets the current stencil function
  116045. * @returns a number defining the stencil function to use
  116046. */
  116047. getStencilFunction(): number;
  116048. /**
  116049. * Gets the current stencil reference value
  116050. * @returns a number defining the stencil reference value to use
  116051. */
  116052. getStencilFunctionReference(): number;
  116053. /**
  116054. * Gets the current stencil mask
  116055. * @returns a number defining the stencil mask to use
  116056. */
  116057. getStencilFunctionMask(): number;
  116058. /**
  116059. * Sets the current stencil function
  116060. * @param stencilFunc defines the new stencil function to use
  116061. */
  116062. setStencilFunction(stencilFunc: number): void;
  116063. /**
  116064. * Sets the current stencil reference
  116065. * @param reference defines the new stencil reference to use
  116066. */
  116067. setStencilFunctionReference(reference: number): void;
  116068. /**
  116069. * Sets the current stencil mask
  116070. * @param mask defines the new stencil mask to use
  116071. */
  116072. setStencilFunctionMask(mask: number): void;
  116073. /**
  116074. * Gets the current stencil operation when stencil fails
  116075. * @returns a number defining stencil operation to use when stencil fails
  116076. */
  116077. getStencilOperationFail(): number;
  116078. /**
  116079. * Gets the current stencil operation when depth fails
  116080. * @returns a number defining stencil operation to use when depth fails
  116081. */
  116082. getStencilOperationDepthFail(): number;
  116083. /**
  116084. * Gets the current stencil operation when stencil passes
  116085. * @returns a number defining stencil operation to use when stencil passes
  116086. */
  116087. getStencilOperationPass(): number;
  116088. /**
  116089. * Sets the stencil operation to use when stencil fails
  116090. * @param operation defines the stencil operation to use when stencil fails
  116091. */
  116092. setStencilOperationFail(operation: number): void;
  116093. /**
  116094. * Sets the stencil operation to use when depth fails
  116095. * @param operation defines the stencil operation to use when depth fails
  116096. */
  116097. setStencilOperationDepthFail(operation: number): void;
  116098. /**
  116099. * Sets the stencil operation to use when stencil passes
  116100. * @param operation defines the stencil operation to use when stencil passes
  116101. */
  116102. setStencilOperationPass(operation: number): void;
  116103. /**
  116104. * Sets a boolean indicating if the dithering state is enabled or disabled
  116105. * @param value defines the dithering state
  116106. */
  116107. setDitheringState(value: boolean): void;
  116108. /**
  116109. * Sets a boolean indicating if the rasterizer state is enabled or disabled
  116110. * @param value defines the rasterizer state
  116111. */
  116112. setRasterizerState(value: boolean): void;
  116113. /**
  116114. * Gets the current depth function
  116115. * @returns a number defining the depth function
  116116. */
  116117. getDepthFunction(): Nullable<number>;
  116118. /**
  116119. * Sets the current depth function
  116120. * @param depthFunc defines the function to use
  116121. */
  116122. setDepthFunction(depthFunc: number): void;
  116123. /**
  116124. * Sets the current depth function to GREATER
  116125. */
  116126. setDepthFunctionToGreater(): void;
  116127. /**
  116128. * Sets the current depth function to GEQUAL
  116129. */
  116130. setDepthFunctionToGreaterOrEqual(): void;
  116131. /**
  116132. * Sets the current depth function to LESS
  116133. */
  116134. setDepthFunctionToLess(): void;
  116135. /**
  116136. * Sets the current depth function to LEQUAL
  116137. */
  116138. setDepthFunctionToLessOrEqual(): void;
  116139. private _cachedStencilBuffer;
  116140. private _cachedStencilFunction;
  116141. private _cachedStencilMask;
  116142. private _cachedStencilOperationPass;
  116143. private _cachedStencilOperationFail;
  116144. private _cachedStencilOperationDepthFail;
  116145. private _cachedStencilReference;
  116146. /**
  116147. * Caches the the state of the stencil buffer
  116148. */
  116149. cacheStencilState(): void;
  116150. /**
  116151. * Restores the state of the stencil buffer
  116152. */
  116153. restoreStencilState(): void;
  116154. /**
  116155. * Directly set the WebGL Viewport
  116156. * @param x defines the x coordinate of the viewport (in screen space)
  116157. * @param y defines the y coordinate of the viewport (in screen space)
  116158. * @param width defines the width of the viewport (in screen space)
  116159. * @param height defines the height of the viewport (in screen space)
  116160. * @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
  116161. */
  116162. setDirectViewport(x: number, y: number, width: number, height: number): Nullable<IViewportLike>;
  116163. /**
  116164. * Executes a scissor clear (ie. a clear on a specific portion of the screen)
  116165. * @param x defines the x-coordinate of the top left corner of the clear rectangle
  116166. * @param y defines the y-coordinate of the corner of the clear rectangle
  116167. * @param width defines the width of the clear rectangle
  116168. * @param height defines the height of the clear rectangle
  116169. * @param clearColor defines the clear color
  116170. */
  116171. scissorClear(x: number, y: number, width: number, height: number, clearColor: IColor4Like): void;
  116172. /**
  116173. * Enable scissor test on a specific rectangle (ie. render will only be executed on a specific portion of the screen)
  116174. * @param x defines the x-coordinate of the top left corner of the clear rectangle
  116175. * @param y defines the y-coordinate of the corner of the clear rectangle
  116176. * @param width defines the width of the clear rectangle
  116177. * @param height defines the height of the clear rectangle
  116178. */
  116179. enableScissor(x: number, y: number, width: number, height: number): void;
  116180. /**
  116181. * Disable previously set scissor test rectangle
  116182. */
  116183. disableScissor(): void;
  116184. protected _reportDrawCall(): void;
  116185. /**
  116186. * Initializes a webVR display and starts listening to display change events
  116187. * The onVRDisplayChangedObservable will be notified upon these changes
  116188. * @returns The onVRDisplayChangedObservable
  116189. */
  116190. initWebVR(): Observable<IDisplayChangedEventArgs>;
  116191. /** @hidden */
  116192. _prepareVRComponent(): void;
  116193. /** @hidden */
  116194. _connectVREvents(canvas?: HTMLCanvasElement, document?: any): void;
  116195. /** @hidden */
  116196. _submitVRFrame(): void;
  116197. /**
  116198. * Call this function to leave webVR mode
  116199. * Will do nothing if webVR is not supported or if there is no webVR device
  116200. * @see https://doc.babylonjs.com/how_to/webvr_camera
  116201. */
  116202. disableVR(): void;
  116203. /**
  116204. * Gets a boolean indicating that the system is in VR mode and is presenting
  116205. * @returns true if VR mode is engaged
  116206. */
  116207. isVRPresenting(): boolean;
  116208. /** @hidden */
  116209. _requestVRFrame(): void;
  116210. /** @hidden */
  116211. _loadFileAsync(url: string, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  116212. /**
  116213. * Gets the source code of the vertex shader associated with a specific webGL program
  116214. * @param program defines the program to use
  116215. * @returns a string containing the source code of the vertex shader associated with the program
  116216. */
  116217. getVertexShaderSource(program: WebGLProgram): Nullable<string>;
  116218. /**
  116219. * Gets the source code of the fragment shader associated with a specific webGL program
  116220. * @param program defines the program to use
  116221. * @returns a string containing the source code of the fragment shader associated with the program
  116222. */
  116223. getFragmentShaderSource(program: WebGLProgram): Nullable<string>;
  116224. /**
  116225. * Sets a depth stencil texture from a render target to the according uniform.
  116226. * @param channel The texture channel
  116227. * @param uniform The uniform to set
  116228. * @param texture The render target texture containing the depth stencil texture to apply
  116229. */
  116230. setDepthStencilTexture(channel: number, uniform: Nullable<WebGLUniformLocation>, texture: Nullable<RenderTargetTexture>): void;
  116231. /**
  116232. * Sets a texture to the webGL context from a postprocess
  116233. * @param channel defines the channel to use
  116234. * @param postProcess defines the source postprocess
  116235. */
  116236. setTextureFromPostProcess(channel: number, postProcess: Nullable<PostProcess>): void;
  116237. /**
  116238. * Binds the output of the passed in post process to the texture channel specified
  116239. * @param channel The channel the texture should be bound to
  116240. * @param postProcess The post process which's output should be bound
  116241. */
  116242. setTextureFromPostProcessOutput(channel: number, postProcess: Nullable<PostProcess>): void;
  116243. protected _rebuildBuffers(): void;
  116244. /** @hidden */
  116245. _renderFrame(): void;
  116246. _renderLoop(): void;
  116247. /** @hidden */
  116248. _renderViews(): boolean;
  116249. /**
  116250. * Toggle full screen mode
  116251. * @param requestPointerLock defines if a pointer lock should be requested from the user
  116252. */
  116253. switchFullscreen(requestPointerLock: boolean): void;
  116254. /**
  116255. * Enters full screen mode
  116256. * @param requestPointerLock defines if a pointer lock should be requested from the user
  116257. */
  116258. enterFullscreen(requestPointerLock: boolean): void;
  116259. /**
  116260. * Exits full screen mode
  116261. */
  116262. exitFullscreen(): void;
  116263. /**
  116264. * Enters Pointerlock mode
  116265. */
  116266. enterPointerlock(): void;
  116267. /**
  116268. * Exits Pointerlock mode
  116269. */
  116270. exitPointerlock(): void;
  116271. /**
  116272. * Begin a new frame
  116273. */
  116274. beginFrame(): void;
  116275. /**
  116276. * Enf the current frame
  116277. */
  116278. endFrame(): void;
  116279. resize(): void;
  116280. /**
  116281. * Force a specific size of the canvas
  116282. * @param width defines the new canvas' width
  116283. * @param height defines the new canvas' height
  116284. * @returns true if the size was changed
  116285. */
  116286. setSize(width: number, height: number): boolean;
  116287. /**
  116288. * Updates a dynamic vertex buffer.
  116289. * @param vertexBuffer the vertex buffer to update
  116290. * @param data the data used to update the vertex buffer
  116291. * @param byteOffset the byte offset of the data
  116292. * @param byteLength the byte length of the data
  116293. */
  116294. updateDynamicVertexBuffer(vertexBuffer: DataBuffer, data: DataArray, byteOffset?: number, byteLength?: number): void;
  116295. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  116296. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  116297. protected _createShaderProgram(pipelineContext: WebGLPipelineContext, vertexShader: WebGLShader, fragmentShader: WebGLShader, context: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  116298. _releaseTexture(texture: InternalTexture): void;
  116299. /**
  116300. * @hidden
  116301. * Rescales a texture
  116302. * @param source input texutre
  116303. * @param destination destination texture
  116304. * @param scene scene to use to render the resize
  116305. * @param internalFormat format to use when resizing
  116306. * @param onComplete callback to be called when resize has completed
  116307. */
  116308. _rescaleTexture(source: InternalTexture, destination: InternalTexture, scene: Nullable<any>, internalFormat: number, onComplete: () => void): void;
  116309. /**
  116310. * Gets the current framerate
  116311. * @returns a number representing the framerate
  116312. */
  116313. getFps(): number;
  116314. /**
  116315. * Gets the time spent between current and previous frame
  116316. * @returns a number representing the delta time in ms
  116317. */
  116318. getDeltaTime(): number;
  116319. private _measureFps;
  116320. /** @hidden */
  116321. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement | ImageBitmap, faceIndex?: number, lod?: number): void;
  116322. /**
  116323. * Update a dynamic index buffer
  116324. * @param indexBuffer defines the target index buffer
  116325. * @param indices defines the data to update
  116326. * @param offset defines the offset in the target index buffer where update should start
  116327. */
  116328. updateDynamicIndexBuffer(indexBuffer: DataBuffer, indices: IndicesArray, offset?: number): void;
  116329. /**
  116330. * Updates the sample count of a render target texture
  116331. * @see https://doc.babylonjs.com/features/webgl2#multisample-render-targets
  116332. * @param texture defines the texture to update
  116333. * @param samples defines the sample count to set
  116334. * @returns the effective sample count (could be 0 if multisample render targets are not supported)
  116335. */
  116336. updateRenderTargetTextureSampleCount(texture: Nullable<InternalTexture>, samples: number): number;
  116337. /**
  116338. * Updates a depth texture Comparison Mode and Function.
  116339. * If the comparison Function is equal to 0, the mode will be set to none.
  116340. * Otherwise, this only works in webgl 2 and requires a shadow sampler in the shader.
  116341. * @param texture The texture to set the comparison function for
  116342. * @param comparisonFunction The comparison function to set, 0 if no comparison required
  116343. */
  116344. updateTextureComparisonFunction(texture: InternalTexture, comparisonFunction: number): void;
  116345. /**
  116346. * Creates a webGL buffer to use with instanciation
  116347. * @param capacity defines the size of the buffer
  116348. * @returns the webGL buffer
  116349. */
  116350. createInstancesBuffer(capacity: number): DataBuffer;
  116351. /**
  116352. * Delete a webGL buffer used with instanciation
  116353. * @param buffer defines the webGL buffer to delete
  116354. */
  116355. deleteInstancesBuffer(buffer: WebGLBuffer): void;
  116356. private _clientWaitAsync;
  116357. /** @hidden */
  116358. _readPixelsAsync(x: number, y: number, w: number, h: number, format: number, type: number, outputBuffer: ArrayBufferView): Promise<ArrayBufferView> | null;
  116359. dispose(): void;
  116360. private _disableTouchAction;
  116361. /**
  116362. * Display the loading screen
  116363. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  116364. */
  116365. displayLoadingUI(): void;
  116366. /**
  116367. * Hide the loading screen
  116368. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  116369. */
  116370. hideLoadingUI(): void;
  116371. /**
  116372. * Gets the current loading screen object
  116373. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  116374. */
  116375. get loadingScreen(): ILoadingScreen;
  116376. /**
  116377. * Sets the current loading screen object
  116378. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  116379. */
  116380. set loadingScreen(loadingScreen: ILoadingScreen);
  116381. /**
  116382. * Sets the current loading screen text
  116383. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  116384. */
  116385. set loadingUIText(text: string);
  116386. /**
  116387. * Sets the current loading screen background color
  116388. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  116389. */
  116390. set loadingUIBackgroundColor(color: string);
  116391. /** Pointerlock and fullscreen */
  116392. /**
  116393. * Ask the browser to promote the current element to pointerlock mode
  116394. * @param element defines the DOM element to promote
  116395. */
  116396. static _RequestPointerlock(element: HTMLElement): void;
  116397. /**
  116398. * Asks the browser to exit pointerlock mode
  116399. */
  116400. static _ExitPointerlock(): void;
  116401. /**
  116402. * Ask the browser to promote the current element to fullscreen rendering mode
  116403. * @param element defines the DOM element to promote
  116404. */
  116405. static _RequestFullscreen(element: HTMLElement): void;
  116406. /**
  116407. * Asks the browser to exit fullscreen mode
  116408. */
  116409. static _ExitFullscreen(): void;
  116410. }
  116411. }
  116412. declare module BABYLON {
  116413. /**
  116414. * The engine store class is responsible to hold all the instances of Engine and Scene created
  116415. * during the life time of the application.
  116416. */
  116417. export class EngineStore {
  116418. /** Gets the list of created engines */
  116419. static Instances: Engine[];
  116420. /** @hidden */
  116421. static _LastCreatedScene: Nullable<Scene>;
  116422. /**
  116423. * Gets the latest created engine
  116424. */
  116425. static get LastCreatedEngine(): Nullable<Engine>;
  116426. /**
  116427. * Gets the latest created scene
  116428. */
  116429. static get LastCreatedScene(): Nullable<Scene>;
  116430. /**
  116431. * Gets or sets a global variable indicating if fallback texture must be used when a texture cannot be loaded
  116432. * @ignorenaming
  116433. */
  116434. static UseFallbackTexture: boolean;
  116435. /**
  116436. * Texture content used if a texture cannot loaded
  116437. * @ignorenaming
  116438. */
  116439. static FallbackTexture: string;
  116440. }
  116441. }
  116442. declare module BABYLON {
  116443. /**
  116444. * Helper class that provides a small promise polyfill
  116445. */
  116446. export class PromisePolyfill {
  116447. /**
  116448. * Static function used to check if the polyfill is required
  116449. * If this is the case then the function will inject the polyfill to window.Promise
  116450. * @param force defines a boolean used to force the injection (mostly for testing purposes)
  116451. */
  116452. static Apply(force?: boolean): void;
  116453. }
  116454. }
  116455. declare module BABYLON {
  116456. /**
  116457. * Interface for screenshot methods with describe argument called `size` as object with options
  116458. * @link https://doc.babylonjs.com/api/classes/babylon.screenshottools
  116459. */
  116460. export interface IScreenshotSize {
  116461. /**
  116462. * number in pixels for canvas height
  116463. */
  116464. height?: number;
  116465. /**
  116466. * multiplier allowing render at a higher or lower resolution
  116467. * If value is defined then height and width will be ignored and taken from camera
  116468. */
  116469. precision?: number;
  116470. /**
  116471. * number in pixels for canvas width
  116472. */
  116473. width?: number;
  116474. }
  116475. }
  116476. declare module BABYLON {
  116477. interface IColor4Like {
  116478. r: float;
  116479. g: float;
  116480. b: float;
  116481. a: float;
  116482. }
  116483. /**
  116484. * Class containing a set of static utilities functions
  116485. */
  116486. export class Tools {
  116487. /**
  116488. * Gets or sets the base URL to use to load assets
  116489. */
  116490. static get BaseUrl(): string;
  116491. static set BaseUrl(value: string);
  116492. /**
  116493. * Enable/Disable Custom HTTP Request Headers globally.
  116494. * default = false
  116495. * @see CustomRequestHeaders
  116496. */
  116497. static UseCustomRequestHeaders: boolean;
  116498. /**
  116499. * Custom HTTP Request Headers to be sent with XMLHttpRequests
  116500. * i.e. when loading files, where the server/service expects an Authorization header
  116501. */
  116502. static CustomRequestHeaders: {
  116503. [key: string]: string;
  116504. };
  116505. /**
  116506. * Gets or sets the retry strategy to apply when an error happens while loading an asset
  116507. */
  116508. static get DefaultRetryStrategy(): (url: string, request: WebRequest, retryIndex: number) => number;
  116509. static set DefaultRetryStrategy(strategy: (url: string, request: WebRequest, retryIndex: number) => number);
  116510. /**
  116511. * Default behaviour for cors in the application.
  116512. * It can be a string if the expected behavior is identical in the entire app.
  116513. * Or a callback to be able to set it per url or on a group of them (in case of Video source for instance)
  116514. */
  116515. static get CorsBehavior(): string | ((url: string | string[]) => string);
  116516. static set CorsBehavior(value: string | ((url: string | string[]) => string));
  116517. /**
  116518. * Gets or sets a global variable indicating if fallback texture must be used when a texture cannot be loaded
  116519. * @ignorenaming
  116520. */
  116521. static get UseFallbackTexture(): boolean;
  116522. static set UseFallbackTexture(value: boolean);
  116523. /**
  116524. * Use this object to register external classes like custom textures or material
  116525. * to allow the laoders to instantiate them
  116526. */
  116527. static get RegisteredExternalClasses(): {
  116528. [key: string]: Object;
  116529. };
  116530. static set RegisteredExternalClasses(classes: {
  116531. [key: string]: Object;
  116532. });
  116533. /**
  116534. * Texture content used if a texture cannot loaded
  116535. * @ignorenaming
  116536. */
  116537. static get fallbackTexture(): string;
  116538. static set fallbackTexture(value: string);
  116539. /**
  116540. * Read the content of a byte array at a specified coordinates (taking in account wrapping)
  116541. * @param u defines the coordinate on X axis
  116542. * @param v defines the coordinate on Y axis
  116543. * @param width defines the width of the source data
  116544. * @param height defines the height of the source data
  116545. * @param pixels defines the source byte array
  116546. * @param color defines the output color
  116547. */
  116548. static FetchToRef(u: number, v: number, width: number, height: number, pixels: Uint8Array, color: IColor4Like): void;
  116549. /**
  116550. * Interpolates between a and b via alpha
  116551. * @param a The lower value (returned when alpha = 0)
  116552. * @param b The upper value (returned when alpha = 1)
  116553. * @param alpha The interpolation-factor
  116554. * @return The mixed value
  116555. */
  116556. static Mix(a: number, b: number, alpha: number): number;
  116557. /**
  116558. * Tries to instantiate a new object from a given class name
  116559. * @param className defines the class name to instantiate
  116560. * @returns the new object or null if the system was not able to do the instantiation
  116561. */
  116562. static Instantiate(className: string): any;
  116563. /**
  116564. * Provides a slice function that will work even on IE
  116565. * @param data defines the array to slice
  116566. * @param start defines the start of the data (optional)
  116567. * @param end defines the end of the data (optional)
  116568. * @returns the new sliced array
  116569. */
  116570. static Slice<T>(data: T, start?: number, end?: number): T;
  116571. /**
  116572. * Polyfill for setImmediate
  116573. * @param action defines the action to execute after the current execution block
  116574. */
  116575. static SetImmediate(action: () => void): void;
  116576. /**
  116577. * Function indicating if a number is an exponent of 2
  116578. * @param value defines the value to test
  116579. * @returns true if the value is an exponent of 2
  116580. */
  116581. static IsExponentOfTwo(value: number): boolean;
  116582. private static _tmpFloatArray;
  116583. /**
  116584. * Returns the nearest 32-bit single precision float representation of a Number
  116585. * @param value A Number. If the parameter is of a different type, it will get converted
  116586. * to a number or to NaN if it cannot be converted
  116587. * @returns number
  116588. */
  116589. static FloatRound(value: number): number;
  116590. /**
  116591. * Extracts the filename from a path
  116592. * @param path defines the path to use
  116593. * @returns the filename
  116594. */
  116595. static GetFilename(path: string): string;
  116596. /**
  116597. * Extracts the "folder" part of a path (everything before the filename).
  116598. * @param uri The URI to extract the info from
  116599. * @param returnUnchangedIfNoSlash Do not touch the URI if no slashes are present
  116600. * @returns The "folder" part of the path
  116601. */
  116602. static GetFolderPath(uri: string, returnUnchangedIfNoSlash?: boolean): string;
  116603. /**
  116604. * Extracts text content from a DOM element hierarchy
  116605. * Back Compat only, please use DomManagement.GetDOMTextContent instead.
  116606. */
  116607. static GetDOMTextContent: typeof DomManagement.GetDOMTextContent;
  116608. /**
  116609. * Convert an angle in radians to degrees
  116610. * @param angle defines the angle to convert
  116611. * @returns the angle in degrees
  116612. */
  116613. static ToDegrees(angle: number): number;
  116614. /**
  116615. * Convert an angle in degrees to radians
  116616. * @param angle defines the angle to convert
  116617. * @returns the angle in radians
  116618. */
  116619. static ToRadians(angle: number): number;
  116620. /**
  116621. * Returns an array if obj is not an array
  116622. * @param obj defines the object to evaluate as an array
  116623. * @param allowsNullUndefined defines a boolean indicating if obj is allowed to be null or undefined
  116624. * @returns either obj directly if obj is an array or a new array containing obj
  116625. */
  116626. static MakeArray(obj: any, allowsNullUndefined?: boolean): Nullable<Array<any>>;
  116627. /**
  116628. * Gets the pointer prefix to use
  116629. * @param engine defines the engine we are finding the prefix for
  116630. * @returns "pointer" if touch is enabled. Else returns "mouse"
  116631. */
  116632. static GetPointerPrefix(engine: Engine): string;
  116633. /**
  116634. * Sets the cors behavior on a dom element. This will add the required Tools.CorsBehavior to the element.
  116635. * @param url define the url we are trying
  116636. * @param element define the dom element where to configure the cors policy
  116637. */
  116638. static SetCorsBehavior(url: string | string[], element: {
  116639. crossOrigin: string | null;
  116640. }): void;
  116641. /**
  116642. * Removes unwanted characters from an url
  116643. * @param url defines the url to clean
  116644. * @returns the cleaned url
  116645. */
  116646. static CleanUrl(url: string): string;
  116647. /**
  116648. * Gets or sets a function used to pre-process url before using them to load assets
  116649. */
  116650. static get PreprocessUrl(): (url: string) => string;
  116651. static set PreprocessUrl(processor: (url: string) => string);
  116652. /**
  116653. * Loads an image as an HTMLImageElement.
  116654. * @param input url string, ArrayBuffer, or Blob to load
  116655. * @param onLoad callback called when the image successfully loads
  116656. * @param onError callback called when the image fails to load
  116657. * @param offlineProvider offline provider for caching
  116658. * @param mimeType optional mime type
  116659. * @returns the HTMLImageElement of the loaded image
  116660. */
  116661. static LoadImage(input: string | ArrayBuffer | Blob, onLoad: (img: HTMLImageElement | ImageBitmap) => void, onError: (message?: string, exception?: any) => void, offlineProvider: Nullable<IOfflineProvider>, mimeType?: string): Nullable<HTMLImageElement>;
  116662. /**
  116663. * Loads a file from a url
  116664. * @param url url string, ArrayBuffer, or Blob to load
  116665. * @param onSuccess callback called when the file successfully loads
  116666. * @param onProgress callback called while file is loading (if the server supports this mode)
  116667. * @param offlineProvider defines the offline provider for caching
  116668. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  116669. * @param onError callback called when the file fails to load
  116670. * @returns a file request object
  116671. */
  116672. 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;
  116673. /**
  116674. * Loads a file from a url
  116675. * @param url the file url to load
  116676. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  116677. * @returns a promise containing an ArrayBuffer corresponding to the loaded file
  116678. */
  116679. static LoadFileAsync(url: string, useArrayBuffer?: boolean): Promise<ArrayBuffer | string>;
  116680. /**
  116681. * Load a script (identified by an url). When the url returns, the
  116682. * content of this file is added into a new script element, attached to the DOM (body element)
  116683. * @param scriptUrl defines the url of the script to laod
  116684. * @param onSuccess defines the callback called when the script is loaded
  116685. * @param onError defines the callback to call if an error occurs
  116686. * @param scriptId defines the id of the script element
  116687. */
  116688. static LoadScript(scriptUrl: string, onSuccess: () => void, onError?: (message?: string, exception?: any) => void, scriptId?: string): void;
  116689. /**
  116690. * Load an asynchronous script (identified by an url). When the url returns, the
  116691. * content of this file is added into a new script element, attached to the DOM (body element)
  116692. * @param scriptUrl defines the url of the script to laod
  116693. * @param scriptId defines the id of the script element
  116694. * @returns a promise request object
  116695. */
  116696. static LoadScriptAsync(scriptUrl: string, scriptId?: string): Promise<void>;
  116697. /**
  116698. * Loads a file from a blob
  116699. * @param fileToLoad defines the blob to use
  116700. * @param callback defines the callback to call when data is loaded
  116701. * @param progressCallback defines the callback to call during loading process
  116702. * @returns a file request object
  116703. */
  116704. static ReadFileAsDataURL(fileToLoad: Blob, callback: (data: any) => void, progressCallback: (ev: ProgressEvent) => any): IFileRequest;
  116705. /**
  116706. * Reads a file from a File object
  116707. * @param file defines the file to load
  116708. * @param onSuccess defines the callback to call when data is loaded
  116709. * @param onProgress defines the callback to call during loading process
  116710. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  116711. * @param onError defines the callback to call when an error occurs
  116712. * @returns a file request object
  116713. */
  116714. static ReadFile(file: File, onSuccess: (data: any) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  116715. /**
  116716. * Creates a data url from a given string content
  116717. * @param content defines the content to convert
  116718. * @returns the new data url link
  116719. */
  116720. static FileAsURL(content: string): string;
  116721. /**
  116722. * Format the given number to a specific decimal format
  116723. * @param value defines the number to format
  116724. * @param decimals defines the number of decimals to use
  116725. * @returns the formatted string
  116726. */
  116727. static Format(value: number, decimals?: number): string;
  116728. /**
  116729. * Tries to copy an object by duplicating every property
  116730. * @param source defines the source object
  116731. * @param destination defines the target object
  116732. * @param doNotCopyList defines a list of properties to avoid
  116733. * @param mustCopyList defines a list of properties to copy (even if they start with _)
  116734. */
  116735. static DeepCopy(source: any, destination: any, doNotCopyList?: string[], mustCopyList?: string[]): void;
  116736. /**
  116737. * Gets a boolean indicating if the given object has no own property
  116738. * @param obj defines the object to test
  116739. * @returns true if object has no own property
  116740. */
  116741. static IsEmpty(obj: any): boolean;
  116742. /**
  116743. * Function used to register events at window level
  116744. * @param windowElement defines the Window object to use
  116745. * @param events defines the events to register
  116746. */
  116747. static RegisterTopRootEvents(windowElement: Window, events: {
  116748. name: string;
  116749. handler: Nullable<(e: FocusEvent) => any>;
  116750. }[]): void;
  116751. /**
  116752. * Function used to unregister events from window level
  116753. * @param windowElement defines the Window object to use
  116754. * @param events defines the events to unregister
  116755. */
  116756. static UnregisterTopRootEvents(windowElement: Window, events: {
  116757. name: string;
  116758. handler: Nullable<(e: FocusEvent) => any>;
  116759. }[]): void;
  116760. /**
  116761. * @ignore
  116762. */
  116763. static _ScreenshotCanvas: HTMLCanvasElement;
  116764. /**
  116765. * Dumps the current bound framebuffer
  116766. * @param width defines the rendering width
  116767. * @param height defines the rendering height
  116768. * @param engine defines the hosting engine
  116769. * @param successCallback defines the callback triggered once the data are available
  116770. * @param mimeType defines the mime type of the result
  116771. * @param fileName defines the filename to download. If present, the result will automatically be downloaded
  116772. */
  116773. static DumpFramebuffer(width: number, height: number, engine: Engine, successCallback?: (data: string) => void, mimeType?: string, fileName?: string): void;
  116774. /**
  116775. * Converts the canvas data to blob.
  116776. * This acts as a polyfill for browsers not supporting the to blob function.
  116777. * @param canvas Defines the canvas to extract the data from
  116778. * @param successCallback Defines the callback triggered once the data are available
  116779. * @param mimeType Defines the mime type of the result
  116780. */
  116781. static ToBlob(canvas: HTMLCanvasElement, successCallback: (blob: Nullable<Blob>) => void, mimeType?: string): void;
  116782. /**
  116783. * Encodes the canvas data to base 64 or automatically download the result if filename is defined
  116784. * @param successCallback defines the callback triggered once the data are available
  116785. * @param mimeType defines the mime type of the result
  116786. * @param fileName defines he filename to download. If present, the result will automatically be downloaded
  116787. */
  116788. static EncodeScreenshotCanvasData(successCallback?: (data: string) => void, mimeType?: string, fileName?: string): void;
  116789. /**
  116790. * Downloads a blob in the browser
  116791. * @param blob defines the blob to download
  116792. * @param fileName defines the name of the downloaded file
  116793. */
  116794. static Download(blob: Blob, fileName: string): void;
  116795. /**
  116796. * Captures a screenshot of the current rendering
  116797. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  116798. * @param engine defines the rendering engine
  116799. * @param camera defines the source camera
  116800. * @param size This parameter can be set to a single number or to an object with the
  116801. * following (optional) properties: precision, width, height. If a single number is passed,
  116802. * it will be used for both width and height. If an object is passed, the screenshot size
  116803. * will be derived from the parameters. The precision property is a multiplier allowing
  116804. * rendering at a higher or lower resolution
  116805. * @param successCallback defines the callback receives a single parameter which contains the
  116806. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  116807. * src parameter of an <img> to display it
  116808. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  116809. * Check your browser for supported MIME types
  116810. */
  116811. static CreateScreenshot(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string): void;
  116812. /**
  116813. * Captures a screenshot of the current rendering
  116814. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  116815. * @param engine defines the rendering engine
  116816. * @param camera defines the source camera
  116817. * @param size This parameter can be set to a single number or to an object with the
  116818. * following (optional) properties: precision, width, height. If a single number is passed,
  116819. * it will be used for both width and height. If an object is passed, the screenshot size
  116820. * will be derived from the parameters. The precision property is a multiplier allowing
  116821. * rendering at a higher or lower resolution
  116822. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  116823. * Check your browser for supported MIME types
  116824. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  116825. * to the src parameter of an <img> to display it
  116826. */
  116827. static CreateScreenshotAsync(engine: Engine, camera: Camera, size: IScreenshotSize | number, mimeType?: string): Promise<string>;
  116828. /**
  116829. * Generates an image screenshot from the specified camera.
  116830. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  116831. * @param engine The engine to use for rendering
  116832. * @param camera The camera to use for rendering
  116833. * @param size This parameter can be set to a single number or to an object with the
  116834. * following (optional) properties: precision, width, height. If a single number is passed,
  116835. * it will be used for both width and height. If an object is passed, the screenshot size
  116836. * will be derived from the parameters. The precision property is a multiplier allowing
  116837. * rendering at a higher or lower resolution
  116838. * @param successCallback The callback receives a single parameter which contains the
  116839. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  116840. * src parameter of an <img> to display it
  116841. * @param mimeType The MIME type of the screenshot image (default: image/png).
  116842. * Check your browser for supported MIME types
  116843. * @param samples Texture samples (default: 1)
  116844. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  116845. * @param fileName A name for for the downloaded file.
  116846. */
  116847. static CreateScreenshotUsingRenderTarget(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): void;
  116848. /**
  116849. * Generates an image screenshot from the specified camera.
  116850. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  116851. * @param engine The engine to use for rendering
  116852. * @param camera The camera to use for rendering
  116853. * @param size This parameter can be set to a single number or to an object with the
  116854. * following (optional) properties: precision, width, height. If a single number is passed,
  116855. * it will be used for both width and height. If an object is passed, the screenshot size
  116856. * will be derived from the parameters. The precision property is a multiplier allowing
  116857. * rendering at a higher or lower resolution
  116858. * @param mimeType The MIME type of the screenshot image (default: image/png).
  116859. * Check your browser for supported MIME types
  116860. * @param samples Texture samples (default: 1)
  116861. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  116862. * @param fileName A name for for the downloaded file.
  116863. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  116864. * to the src parameter of an <img> to display it
  116865. */
  116866. static CreateScreenshotUsingRenderTargetAsync(engine: Engine, camera: Camera, size: IScreenshotSize | number, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): Promise<string>;
  116867. /**
  116868. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  116869. * Be aware Math.random() could cause collisions, but:
  116870. * "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"
  116871. * @returns a pseudo random id
  116872. */
  116873. static RandomId(): string;
  116874. /**
  116875. * Test if the given uri is a base64 string
  116876. * @param uri The uri to test
  116877. * @return True if the uri is a base64 string or false otherwise
  116878. */
  116879. static IsBase64(uri: string): boolean;
  116880. /**
  116881. * Decode the given base64 uri.
  116882. * @param uri The uri to decode
  116883. * @return The decoded base64 data.
  116884. */
  116885. static DecodeBase64(uri: string): ArrayBuffer;
  116886. /**
  116887. * Gets the absolute url.
  116888. * @param url the input url
  116889. * @return the absolute url
  116890. */
  116891. static GetAbsoluteUrl(url: string): string;
  116892. /**
  116893. * No log
  116894. */
  116895. static readonly NoneLogLevel: number;
  116896. /**
  116897. * Only message logs
  116898. */
  116899. static readonly MessageLogLevel: number;
  116900. /**
  116901. * Only warning logs
  116902. */
  116903. static readonly WarningLogLevel: number;
  116904. /**
  116905. * Only error logs
  116906. */
  116907. static readonly ErrorLogLevel: number;
  116908. /**
  116909. * All logs
  116910. */
  116911. static readonly AllLogLevel: number;
  116912. /**
  116913. * Gets a value indicating the number of loading errors
  116914. * @ignorenaming
  116915. */
  116916. static get errorsCount(): number;
  116917. /**
  116918. * Callback called when a new log is added
  116919. */
  116920. static OnNewCacheEntry: (entry: string) => void;
  116921. /**
  116922. * Log a message to the console
  116923. * @param message defines the message to log
  116924. */
  116925. static Log(message: string): void;
  116926. /**
  116927. * Write a warning message to the console
  116928. * @param message defines the message to log
  116929. */
  116930. static Warn(message: string): void;
  116931. /**
  116932. * Write an error message to the console
  116933. * @param message defines the message to log
  116934. */
  116935. static Error(message: string): void;
  116936. /**
  116937. * Gets current log cache (list of logs)
  116938. */
  116939. static get LogCache(): string;
  116940. /**
  116941. * Clears the log cache
  116942. */
  116943. static ClearLogCache(): void;
  116944. /**
  116945. * Sets the current log level (MessageLogLevel / WarningLogLevel / ErrorLogLevel)
  116946. */
  116947. static set LogLevels(level: number);
  116948. /**
  116949. * Checks if the window object exists
  116950. * Back Compat only, please use DomManagement.IsWindowObjectExist instead.
  116951. */
  116952. static IsWindowObjectExist: typeof DomManagement.IsWindowObjectExist;
  116953. /**
  116954. * No performance log
  116955. */
  116956. static readonly PerformanceNoneLogLevel: number;
  116957. /**
  116958. * Use user marks to log performance
  116959. */
  116960. static readonly PerformanceUserMarkLogLevel: number;
  116961. /**
  116962. * Log performance to the console
  116963. */
  116964. static readonly PerformanceConsoleLogLevel: number;
  116965. private static _performance;
  116966. /**
  116967. * Sets the current performance log level
  116968. */
  116969. static set PerformanceLogLevel(level: number);
  116970. private static _StartPerformanceCounterDisabled;
  116971. private static _EndPerformanceCounterDisabled;
  116972. private static _StartUserMark;
  116973. private static _EndUserMark;
  116974. private static _StartPerformanceConsole;
  116975. private static _EndPerformanceConsole;
  116976. /**
  116977. * Starts a performance counter
  116978. */
  116979. static StartPerformanceCounter: (counterName: string, condition?: boolean) => void;
  116980. /**
  116981. * Ends a specific performance coutner
  116982. */
  116983. static EndPerformanceCounter: (counterName: string, condition?: boolean) => void;
  116984. /**
  116985. * Gets either window.performance.now() if supported or Date.now() else
  116986. */
  116987. static get Now(): number;
  116988. /**
  116989. * This method will return the name of the class used to create the instance of the given object.
  116990. * It will works only on Javascript basic data types (number, string, ...) and instance of class declared with the @className decorator.
  116991. * @param object the object to get the class name from
  116992. * @param isType defines if the object is actually a type
  116993. * @returns the name of the class, will be "object" for a custom data type not using the @className decorator
  116994. */
  116995. static GetClassName(object: any, isType?: boolean): string;
  116996. /**
  116997. * Gets the first element of an array satisfying a given predicate
  116998. * @param array defines the array to browse
  116999. * @param predicate defines the predicate to use
  117000. * @returns null if not found or the element
  117001. */
  117002. static First<T>(array: Array<T>, predicate: (item: T) => boolean): Nullable<T>;
  117003. /**
  117004. * This method will return the name of the full name of the class, including its owning module (if any).
  117005. * 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).
  117006. * @param object the object to get the class name from
  117007. * @param isType defines if the object is actually a type
  117008. * @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.
  117009. * @ignorenaming
  117010. */
  117011. static getFullClassName(object: any, isType?: boolean): Nullable<string>;
  117012. /**
  117013. * Returns a promise that resolves after the given amount of time.
  117014. * @param delay Number of milliseconds to delay
  117015. * @returns Promise that resolves after the given amount of time
  117016. */
  117017. static DelayAsync(delay: number): Promise<void>;
  117018. /**
  117019. * Utility function to detect if the current user agent is Safari
  117020. * @returns whether or not the current user agent is safari
  117021. */
  117022. static IsSafari(): boolean;
  117023. }
  117024. /**
  117025. * Use this className as a decorator on a given class definition to add it a name and optionally its module.
  117026. * You can then use the Tools.getClassName(obj) on an instance to retrieve its class name.
  117027. * This method is the only way to get it done in all cases, even if the .js file declaring the class is minified
  117028. * @param name The name of the class, case should be preserved
  117029. * @param module The name of the Module hosting the class, optional, but strongly recommended to specify if possible. Case should be preserved.
  117030. */
  117031. export function className(name: string, module?: string): (target: Object) => void;
  117032. /**
  117033. * An implementation of a loop for asynchronous functions.
  117034. */
  117035. export class AsyncLoop {
  117036. /**
  117037. * Defines the number of iterations for the loop
  117038. */
  117039. iterations: number;
  117040. /**
  117041. * Defines the current index of the loop.
  117042. */
  117043. index: number;
  117044. private _done;
  117045. private _fn;
  117046. private _successCallback;
  117047. /**
  117048. * Constructor.
  117049. * @param iterations the number of iterations.
  117050. * @param func the function to run each iteration
  117051. * @param successCallback the callback that will be called upon succesful execution
  117052. * @param offset starting offset.
  117053. */
  117054. constructor(
  117055. /**
  117056. * Defines the number of iterations for the loop
  117057. */
  117058. iterations: number, func: (asyncLoop: AsyncLoop) => void, successCallback: () => void, offset?: number);
  117059. /**
  117060. * Execute the next iteration. Must be called after the last iteration was finished.
  117061. */
  117062. executeNext(): void;
  117063. /**
  117064. * Break the loop and run the success callback.
  117065. */
  117066. breakLoop(): void;
  117067. /**
  117068. * Create and run an async loop.
  117069. * @param iterations the number of iterations.
  117070. * @param fn the function to run each iteration
  117071. * @param successCallback the callback that will be called upon succesful execution
  117072. * @param offset starting offset.
  117073. * @returns the created async loop object
  117074. */
  117075. static Run(iterations: number, fn: (asyncLoop: AsyncLoop) => void, successCallback: () => void, offset?: number): AsyncLoop;
  117076. /**
  117077. * A for-loop that will run a given number of iterations synchronous and the rest async.
  117078. * @param iterations total number of iterations
  117079. * @param syncedIterations number of synchronous iterations in each async iteration.
  117080. * @param fn the function to call each iteration.
  117081. * @param callback a success call back that will be called when iterating stops.
  117082. * @param breakFunction a break condition (optional)
  117083. * @param timeout timeout settings for the setTimeout function. default - 0.
  117084. * @returns the created async loop object
  117085. */
  117086. static SyncAsyncForLoop(iterations: number, syncedIterations: number, fn: (iteration: number) => void, callback: () => void, breakFunction?: () => boolean, timeout?: number): AsyncLoop;
  117087. }
  117088. }
  117089. declare module BABYLON {
  117090. /**
  117091. * This class implement a typical dictionary using a string as key and the generic type T as value.
  117092. * The underlying implementation relies on an associative array to ensure the best performances.
  117093. * The value can be anything including 'null' but except 'undefined'
  117094. */
  117095. export class StringDictionary<T> {
  117096. /**
  117097. * This will clear this dictionary and copy the content from the 'source' one.
  117098. * If the T value is a custom object, it won't be copied/cloned, the same object will be used
  117099. * @param source the dictionary to take the content from and copy to this dictionary
  117100. */
  117101. copyFrom(source: StringDictionary<T>): void;
  117102. /**
  117103. * Get a value based from its key
  117104. * @param key the given key to get the matching value from
  117105. * @return the value if found, otherwise undefined is returned
  117106. */
  117107. get(key: string): T | undefined;
  117108. /**
  117109. * Get a value from its key or add it if it doesn't exist.
  117110. * This method will ensure you that a given key/data will be present in the dictionary.
  117111. * @param key the given key to get the matching value from
  117112. * @param factory the factory that will create the value if the key is not present in the dictionary.
  117113. * The factory will only be invoked if there's no data for the given key.
  117114. * @return the value corresponding to the key.
  117115. */
  117116. getOrAddWithFactory(key: string, factory: (key: string) => T): T;
  117117. /**
  117118. * Get a value from its key if present in the dictionary otherwise add it
  117119. * @param key the key to get the value from
  117120. * @param val if there's no such key/value pair in the dictionary add it with this value
  117121. * @return the value corresponding to the key
  117122. */
  117123. getOrAdd(key: string, val: T): T;
  117124. /**
  117125. * Check if there's a given key in the dictionary
  117126. * @param key the key to check for
  117127. * @return true if the key is present, false otherwise
  117128. */
  117129. contains(key: string): boolean;
  117130. /**
  117131. * Add a new key and its corresponding value
  117132. * @param key the key to add
  117133. * @param value the value corresponding to the key
  117134. * @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
  117135. */
  117136. add(key: string, value: T): boolean;
  117137. /**
  117138. * Update a specific value associated to a key
  117139. * @param key defines the key to use
  117140. * @param value defines the value to store
  117141. * @returns true if the value was updated (or false if the key was not found)
  117142. */
  117143. set(key: string, value: T): boolean;
  117144. /**
  117145. * Get the element of the given key and remove it from the dictionary
  117146. * @param key defines the key to search
  117147. * @returns the value associated with the key or null if not found
  117148. */
  117149. getAndRemove(key: string): Nullable<T>;
  117150. /**
  117151. * Remove a key/value from the dictionary.
  117152. * @param key the key to remove
  117153. * @return true if the item was successfully deleted, false if no item with such key exist in the dictionary
  117154. */
  117155. remove(key: string): boolean;
  117156. /**
  117157. * Clear the whole content of the dictionary
  117158. */
  117159. clear(): void;
  117160. /**
  117161. * Gets the current count
  117162. */
  117163. get count(): number;
  117164. /**
  117165. * Execute a callback on each key/val of the dictionary.
  117166. * Note that you can remove any element in this dictionary in the callback implementation
  117167. * @param callback the callback to execute on a given key/value pair
  117168. */
  117169. forEach(callback: (key: string, val: T) => void): void;
  117170. /**
  117171. * Execute a callback on every occurrence of the dictionary until it returns a valid TRes object.
  117172. * If the callback returns null or undefined the method will iterate to the next key/value pair
  117173. * Note that you can remove any element in this dictionary in the callback implementation
  117174. * @param callback the callback to execute, if it return a valid T instanced object the enumeration will stop and the object will be returned
  117175. * @returns the first item
  117176. */
  117177. first<TRes>(callback: (key: string, val: T) => TRes): TRes | null;
  117178. private _count;
  117179. private _data;
  117180. }
  117181. }
  117182. declare module BABYLON {
  117183. /** @hidden */
  117184. export interface ICollisionCoordinator {
  117185. createCollider(): Collider;
  117186. getNewPosition(position: Vector3, displacement: Vector3, collider: Collider, maximumRetry: number, excludedMesh: Nullable<AbstractMesh>, onNewPosition: (collisionIndex: number, newPosition: Vector3, collidedMesh: Nullable<AbstractMesh>) => void, collisionIndex: number): void;
  117187. init(scene: Scene): void;
  117188. }
  117189. /** @hidden */
  117190. export class DefaultCollisionCoordinator implements ICollisionCoordinator {
  117191. private _scene;
  117192. private _scaledPosition;
  117193. private _scaledVelocity;
  117194. private _finalPosition;
  117195. getNewPosition(position: Vector3, displacement: Vector3, collider: Collider, maximumRetry: number, excludedMesh: AbstractMesh, onNewPosition: (collisionIndex: number, newPosition: Vector3, collidedMesh: Nullable<AbstractMesh>) => void, collisionIndex: number): void;
  117196. createCollider(): Collider;
  117197. init(scene: Scene): void;
  117198. private _collideWithWorld;
  117199. }
  117200. }
  117201. declare module BABYLON {
  117202. /**
  117203. * Class used to manage all inputs for the scene.
  117204. */
  117205. export class InputManager {
  117206. /** The distance in pixel that you have to move to prevent some events */
  117207. static DragMovementThreshold: number;
  117208. /** Time in milliseconds to wait to raise long press events if button is still pressed */
  117209. static LongPressDelay: number;
  117210. /** Time in milliseconds with two consecutive clicks will be considered as a double click */
  117211. static DoubleClickDelay: number;
  117212. /** If you need to check double click without raising a single click at first click, enable this flag */
  117213. static ExclusiveDoubleClickMode: boolean;
  117214. private _wheelEventName;
  117215. private _onPointerMove;
  117216. private _onPointerDown;
  117217. private _onPointerUp;
  117218. private _initClickEvent;
  117219. private _initActionManager;
  117220. private _delayedSimpleClick;
  117221. private _delayedSimpleClickTimeout;
  117222. private _previousDelayedSimpleClickTimeout;
  117223. private _meshPickProceed;
  117224. private _previousButtonPressed;
  117225. private _currentPickResult;
  117226. private _previousPickResult;
  117227. private _totalPointersPressed;
  117228. private _doubleClickOccured;
  117229. private _pointerOverMesh;
  117230. private _pickedDownMesh;
  117231. private _pickedUpMesh;
  117232. private _pointerX;
  117233. private _pointerY;
  117234. private _unTranslatedPointerX;
  117235. private _unTranslatedPointerY;
  117236. private _startingPointerPosition;
  117237. private _previousStartingPointerPosition;
  117238. private _startingPointerTime;
  117239. private _previousStartingPointerTime;
  117240. private _pointerCaptures;
  117241. private _onKeyDown;
  117242. private _onKeyUp;
  117243. private _onCanvasFocusObserver;
  117244. private _onCanvasBlurObserver;
  117245. private _scene;
  117246. /**
  117247. * Creates a new InputManager
  117248. * @param scene defines the hosting scene
  117249. */
  117250. constructor(scene: Scene);
  117251. /**
  117252. * Gets the mesh that is currently under the pointer
  117253. */
  117254. get meshUnderPointer(): Nullable<AbstractMesh>;
  117255. /**
  117256. * Gets the pointer coordinates in 2D without any translation (ie. straight out of the pointer event)
  117257. */
  117258. get unTranslatedPointer(): Vector2;
  117259. /**
  117260. * Gets or sets the current on-screen X position of the pointer
  117261. */
  117262. get pointerX(): number;
  117263. set pointerX(value: number);
  117264. /**
  117265. * Gets or sets the current on-screen Y position of the pointer
  117266. */
  117267. get pointerY(): number;
  117268. set pointerY(value: number);
  117269. private _updatePointerPosition;
  117270. private _processPointerMove;
  117271. private _setRayOnPointerInfo;
  117272. private _checkPrePointerObservable;
  117273. /**
  117274. * Use this method to simulate a pointer move on a mesh
  117275. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  117276. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  117277. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  117278. */
  117279. simulatePointerMove(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): void;
  117280. /**
  117281. * Use this method to simulate a pointer down on a mesh
  117282. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  117283. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  117284. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  117285. */
  117286. simulatePointerDown(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): void;
  117287. private _processPointerDown;
  117288. /** @hidden */
  117289. _isPointerSwiping(): boolean;
  117290. /**
  117291. * Use this method to simulate a pointer up on a mesh
  117292. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  117293. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  117294. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  117295. * @param doubleTap indicates that the pointer up event should be considered as part of a double click (false by default)
  117296. */
  117297. simulatePointerUp(pickResult: PickingInfo, pointerEventInit?: PointerEventInit, doubleTap?: boolean): void;
  117298. private _processPointerUp;
  117299. /**
  117300. * Gets a boolean indicating if the current pointer event is captured (meaning that the scene has already handled the pointer down)
  117301. * @param pointerId defines the pointer id to use in a multi-touch scenario (0 by default)
  117302. * @returns true if the pointer was captured
  117303. */
  117304. isPointerCaptured(pointerId?: number): boolean;
  117305. /**
  117306. * Attach events to the canvas (To handle actionManagers triggers and raise onPointerMove, onPointerDown and onPointerUp
  117307. * @param attachUp defines if you want to attach events to pointerup
  117308. * @param attachDown defines if you want to attach events to pointerdown
  117309. * @param attachMove defines if you want to attach events to pointermove
  117310. * @param elementToAttachTo defines the target DOM element to attach to (will use the canvas by default)
  117311. */
  117312. attachControl(attachUp?: boolean, attachDown?: boolean, attachMove?: boolean, elementToAttachTo?: Nullable<HTMLElement>): void;
  117313. /**
  117314. * Detaches all event handlers
  117315. */
  117316. detachControl(): void;
  117317. /**
  117318. * Force the value of meshUnderPointer
  117319. * @param mesh defines the mesh to use
  117320. */
  117321. setPointerOverMesh(mesh: Nullable<AbstractMesh>): void;
  117322. /**
  117323. * Gets the mesh under the pointer
  117324. * @returns a Mesh or null if no mesh is under the pointer
  117325. */
  117326. getPointerOverMesh(): Nullable<AbstractMesh>;
  117327. }
  117328. }
  117329. declare module BABYLON {
  117330. /**
  117331. * This class defines the direct association between an animation and a target
  117332. */
  117333. export class TargetedAnimation {
  117334. /**
  117335. * Animation to perform
  117336. */
  117337. animation: Animation;
  117338. /**
  117339. * Target to animate
  117340. */
  117341. target: any;
  117342. /**
  117343. * Returns the string "TargetedAnimation"
  117344. * @returns "TargetedAnimation"
  117345. */
  117346. getClassName(): string;
  117347. /**
  117348. * Serialize the object
  117349. * @returns the JSON object representing the current entity
  117350. */
  117351. serialize(): any;
  117352. }
  117353. /**
  117354. * Use this class to create coordinated animations on multiple targets
  117355. */
  117356. export class AnimationGroup implements IDisposable {
  117357. /** The name of the animation group */
  117358. name: string;
  117359. private _scene;
  117360. private _targetedAnimations;
  117361. private _animatables;
  117362. private _from;
  117363. private _to;
  117364. private _isStarted;
  117365. private _isPaused;
  117366. private _speedRatio;
  117367. private _loopAnimation;
  117368. private _isAdditive;
  117369. /**
  117370. * Gets or sets the unique id of the node
  117371. */
  117372. uniqueId: number;
  117373. /**
  117374. * This observable will notify when one animation have ended
  117375. */
  117376. onAnimationEndObservable: Observable<TargetedAnimation>;
  117377. /**
  117378. * Observer raised when one animation loops
  117379. */
  117380. onAnimationLoopObservable: Observable<TargetedAnimation>;
  117381. /**
  117382. * Observer raised when all animations have looped
  117383. */
  117384. onAnimationGroupLoopObservable: Observable<AnimationGroup>;
  117385. /**
  117386. * This observable will notify when all animations have ended.
  117387. */
  117388. onAnimationGroupEndObservable: Observable<AnimationGroup>;
  117389. /**
  117390. * This observable will notify when all animations have paused.
  117391. */
  117392. onAnimationGroupPauseObservable: Observable<AnimationGroup>;
  117393. /**
  117394. * This observable will notify when all animations are playing.
  117395. */
  117396. onAnimationGroupPlayObservable: Observable<AnimationGroup>;
  117397. /**
  117398. * Gets the first frame
  117399. */
  117400. get from(): number;
  117401. /**
  117402. * Gets the last frame
  117403. */
  117404. get to(): number;
  117405. /**
  117406. * Define if the animations are started
  117407. */
  117408. get isStarted(): boolean;
  117409. /**
  117410. * Gets a value indicating that the current group is playing
  117411. */
  117412. get isPlaying(): boolean;
  117413. /**
  117414. * Gets or sets the speed ratio to use for all animations
  117415. */
  117416. get speedRatio(): number;
  117417. /**
  117418. * Gets or sets the speed ratio to use for all animations
  117419. */
  117420. set speedRatio(value: number);
  117421. /**
  117422. * Gets or sets if all animations should loop or not
  117423. */
  117424. get loopAnimation(): boolean;
  117425. set loopAnimation(value: boolean);
  117426. /**
  117427. * Gets or sets if all animations should be evaluated additively
  117428. */
  117429. get isAdditive(): boolean;
  117430. set isAdditive(value: boolean);
  117431. /**
  117432. * Gets the targeted animations for this animation group
  117433. */
  117434. get targetedAnimations(): Array<TargetedAnimation>;
  117435. /**
  117436. * returning the list of animatables controlled by this animation group.
  117437. */
  117438. get animatables(): Array<Animatable>;
  117439. /**
  117440. * Gets the list of target animations
  117441. */
  117442. get children(): TargetedAnimation[];
  117443. /**
  117444. * Instantiates a new Animation Group.
  117445. * This helps managing several animations at once.
  117446. * @see https://doc.babylonjs.com/how_to/group
  117447. * @param name Defines the name of the group
  117448. * @param scene Defines the scene the group belongs to
  117449. */
  117450. constructor(
  117451. /** The name of the animation group */
  117452. name: string, scene?: Nullable<Scene>);
  117453. /**
  117454. * Add an animation (with its target) in the group
  117455. * @param animation defines the animation we want to add
  117456. * @param target defines the target of the animation
  117457. * @returns the TargetedAnimation object
  117458. */
  117459. addTargetedAnimation(animation: Animation, target: any): TargetedAnimation;
  117460. /**
  117461. * This function will normalize every animation in the group to make sure they all go from beginFrame to endFrame
  117462. * It can add constant keys at begin or end
  117463. * @param beginFrame defines the new begin frame for all animations or the smallest begin frame of all animations if null (defaults to null)
  117464. * @param endFrame defines the new end frame for all animations or the largest end frame of all animations if null (defaults to null)
  117465. * @returns the animation group
  117466. */
  117467. normalize(beginFrame?: Nullable<number>, endFrame?: Nullable<number>): AnimationGroup;
  117468. private _animationLoopCount;
  117469. private _animationLoopFlags;
  117470. private _processLoop;
  117471. /**
  117472. * Start all animations on given targets
  117473. * @param loop defines if animations must loop
  117474. * @param speedRatio defines the ratio to apply to animation speed (1 by default)
  117475. * @param from defines the from key (optional)
  117476. * @param to defines the to key (optional)
  117477. * @param isAdditive defines the additive state for the resulting animatables (optional)
  117478. * @returns the current animation group
  117479. */
  117480. start(loop?: boolean, speedRatio?: number, from?: number, to?: number, isAdditive?: boolean): AnimationGroup;
  117481. /**
  117482. * Pause all animations
  117483. * @returns the animation group
  117484. */
  117485. pause(): AnimationGroup;
  117486. /**
  117487. * Play all animations to initial state
  117488. * This function will start() the animations if they were not started or will restart() them if they were paused
  117489. * @param loop defines if animations must loop
  117490. * @returns the animation group
  117491. */
  117492. play(loop?: boolean): AnimationGroup;
  117493. /**
  117494. * Reset all animations to initial state
  117495. * @returns the animation group
  117496. */
  117497. reset(): AnimationGroup;
  117498. /**
  117499. * Restart animations from key 0
  117500. * @returns the animation group
  117501. */
  117502. restart(): AnimationGroup;
  117503. /**
  117504. * Stop all animations
  117505. * @returns the animation group
  117506. */
  117507. stop(): AnimationGroup;
  117508. /**
  117509. * Set animation weight for all animatables
  117510. * @param weight defines the weight to use
  117511. * @return the animationGroup
  117512. * @see https://doc.babylonjs.com/babylon101/animations#animation-weights
  117513. */
  117514. setWeightForAllAnimatables(weight: number): AnimationGroup;
  117515. /**
  117516. * Synchronize and normalize all animatables with a source animatable
  117517. * @param root defines the root animatable to synchronize with
  117518. * @return the animationGroup
  117519. * @see https://doc.babylonjs.com/babylon101/animations#animation-weights
  117520. */
  117521. syncAllAnimationsWith(root: Animatable): AnimationGroup;
  117522. /**
  117523. * Goes to a specific frame in this animation group
  117524. * @param frame the frame number to go to
  117525. * @return the animationGroup
  117526. */
  117527. goToFrame(frame: number): AnimationGroup;
  117528. /**
  117529. * Dispose all associated resources
  117530. */
  117531. dispose(): void;
  117532. private _checkAnimationGroupEnded;
  117533. /**
  117534. * Clone the current animation group and returns a copy
  117535. * @param newName defines the name of the new group
  117536. * @param targetConverter defines an optional function used to convert current animation targets to new ones
  117537. * @returns the new aniamtion group
  117538. */
  117539. clone(newName: string, targetConverter?: (oldTarget: any) => any): AnimationGroup;
  117540. /**
  117541. * Serializes the animationGroup to an object
  117542. * @returns Serialized object
  117543. */
  117544. serialize(): any;
  117545. /**
  117546. * Returns a new AnimationGroup object parsed from the source provided.
  117547. * @param parsedAnimationGroup defines the source
  117548. * @param scene defines the scene that will receive the animationGroup
  117549. * @returns a new AnimationGroup
  117550. */
  117551. static Parse(parsedAnimationGroup: any, scene: Scene): AnimationGroup;
  117552. /**
  117553. * Convert the keyframes for all animations belonging to the group to be relative to a given reference frame.
  117554. * @param sourceAnimationGroup defines the AnimationGroup containing animations to convert
  117555. * @param referenceFrame defines the frame that keyframes in the range will be relative to
  117556. * @param range defines the name of the AnimationRange belonging to the animations in the group to convert
  117557. * @param cloneOriginal defines whether or not to clone the group and convert the clone or convert the original group (default is false)
  117558. * @param clonedName defines the name of the resulting cloned AnimationGroup if cloneOriginal is true
  117559. * @returns a new AnimationGroup if cloneOriginal is true or the original AnimationGroup if cloneOriginal is false
  117560. */
  117561. static MakeAnimationAdditive(sourceAnimationGroup: AnimationGroup, referenceFrame?: number, range?: string, cloneOriginal?: boolean, clonedName?: string): AnimationGroup;
  117562. /**
  117563. * Returns the string "AnimationGroup"
  117564. * @returns "AnimationGroup"
  117565. */
  117566. getClassName(): string;
  117567. /**
  117568. * Creates a detailled string about the object
  117569. * @param fullDetails defines if the output string will support multiple levels of logging within scene loading
  117570. * @returns a string representing the object
  117571. */
  117572. toString(fullDetails?: boolean): string;
  117573. }
  117574. }
  117575. declare module BABYLON {
  117576. /**
  117577. * Define an interface for all classes that will hold resources
  117578. */
  117579. export interface IDisposable {
  117580. /**
  117581. * Releases all held resources
  117582. */
  117583. dispose(): void;
  117584. }
  117585. /** Interface defining initialization parameters for Scene class */
  117586. export interface SceneOptions {
  117587. /**
  117588. * Defines that scene should keep up-to-date a map of geometry to enable fast look-up by uniqueId
  117589. * It will improve performance when the number of geometries becomes important.
  117590. */
  117591. useGeometryUniqueIdsMap?: boolean;
  117592. /**
  117593. * Defines that each material of the scene should keep up-to-date a map of referencing meshes for fast diposing
  117594. * It will improve performance when the number of mesh becomes important, but might consume a bit more memory
  117595. */
  117596. useMaterialMeshMap?: boolean;
  117597. /**
  117598. * Defines that each mesh of the scene should keep up-to-date a map of referencing cloned meshes for fast diposing
  117599. * It will improve performance when the number of mesh becomes important, but might consume a bit more memory
  117600. */
  117601. useClonedMeshMap?: boolean;
  117602. /** Defines if the creation of the scene should impact the engine (Eg. UtilityLayer's scene) */
  117603. virtual?: boolean;
  117604. }
  117605. /**
  117606. * Represents a scene to be rendered by the engine.
  117607. * @see https://doc.babylonjs.com/features/scene
  117608. */
  117609. export class Scene extends AbstractScene implements IAnimatable {
  117610. /** The fog is deactivated */
  117611. static readonly FOGMODE_NONE: number;
  117612. /** The fog density is following an exponential function */
  117613. static readonly FOGMODE_EXP: number;
  117614. /** The fog density is following an exponential function faster than FOGMODE_EXP */
  117615. static readonly FOGMODE_EXP2: number;
  117616. /** The fog density is following a linear function. */
  117617. static readonly FOGMODE_LINEAR: number;
  117618. /**
  117619. * Gets or sets the minimum deltatime when deterministic lock step is enabled
  117620. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  117621. */
  117622. static MinDeltaTime: number;
  117623. /**
  117624. * Gets or sets the maximum deltatime when deterministic lock step is enabled
  117625. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  117626. */
  117627. static MaxDeltaTime: number;
  117628. /**
  117629. * Factory used to create the default material.
  117630. * @param name The name of the material to create
  117631. * @param scene The scene to create the material for
  117632. * @returns The default material
  117633. */
  117634. static DefaultMaterialFactory(scene: Scene): Material;
  117635. /**
  117636. * Factory used to create the a collision coordinator.
  117637. * @returns The collision coordinator
  117638. */
  117639. static CollisionCoordinatorFactory(): ICollisionCoordinator;
  117640. /** @hidden */
  117641. _inputManager: InputManager;
  117642. /** Define this parameter if you are using multiple cameras and you want to specify which one should be used for pointer position */
  117643. cameraToUseForPointers: Nullable<Camera>;
  117644. /** @hidden */
  117645. readonly _isScene: boolean;
  117646. /** @hidden */
  117647. _blockEntityCollection: boolean;
  117648. /**
  117649. * Gets or sets a boolean that indicates if the scene must clear the render buffer before rendering a frame
  117650. */
  117651. autoClear: boolean;
  117652. /**
  117653. * Gets or sets a boolean that indicates if the scene must clear the depth and stencil buffers before rendering a frame
  117654. */
  117655. autoClearDepthAndStencil: boolean;
  117656. /**
  117657. * Defines the color used to clear the render buffer (Default is (0.2, 0.2, 0.3, 1.0))
  117658. */
  117659. clearColor: Color4;
  117660. /**
  117661. * Defines the color used to simulate the ambient color (Default is (0, 0, 0))
  117662. */
  117663. ambientColor: Color3;
  117664. /**
  117665. * This is use to store the default BRDF lookup for PBR materials in your scene.
  117666. * It should only be one of the following (if not the default embedded one):
  117667. * * For uncorrelated BRDF (pbr.brdf.useEnergyConservation = false and pbr.brdf.useSmithVisibilityHeightCorrelated = false) : https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds
  117668. * * For correlated BRDF (pbr.brdf.useEnergyConservation = false and pbr.brdf.useSmithVisibilityHeightCorrelated = true) : https://assets.babylonjs.com/environments/correlatedBRDF.dds
  117669. * * For correlated multi scattering BRDF (pbr.brdf.useEnergyConservation = true and pbr.brdf.useSmithVisibilityHeightCorrelated = true) : https://assets.babylonjs.com/environments/correlatedMSBRDF.dds
  117670. * The material properties need to be setup according to the type of texture in use.
  117671. */
  117672. environmentBRDFTexture: BaseTexture;
  117673. /** @hidden */
  117674. protected _environmentTexture: Nullable<BaseTexture>;
  117675. /**
  117676. * Texture used in all pbr material as the reflection texture.
  117677. * As in the majority of the scene they are the same (exception for multi room and so on),
  117678. * this is easier to reference from here than from all the materials.
  117679. */
  117680. get environmentTexture(): Nullable<BaseTexture>;
  117681. /**
  117682. * Texture used in all pbr material as the reflection texture.
  117683. * As in the majority of the scene they are the same (exception for multi room and so on),
  117684. * this is easier to set here than in all the materials.
  117685. */
  117686. set environmentTexture(value: Nullable<BaseTexture>);
  117687. /** @hidden */
  117688. protected _environmentIntensity: number;
  117689. /**
  117690. * Intensity of the environment in all pbr material.
  117691. * This dims or reinforces the IBL lighting overall (reflection and diffuse).
  117692. * As in the majority of the scene they are the same (exception for multi room and so on),
  117693. * this is easier to reference from here than from all the materials.
  117694. */
  117695. get environmentIntensity(): number;
  117696. /**
  117697. * Intensity of the environment in all pbr material.
  117698. * This dims or reinforces the IBL lighting overall (reflection and diffuse).
  117699. * As in the majority of the scene they are the same (exception for multi room and so on),
  117700. * this is easier to set here than in all the materials.
  117701. */
  117702. set environmentIntensity(value: number);
  117703. /** @hidden */
  117704. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  117705. /**
  117706. * Default image processing configuration used either in the rendering
  117707. * Forward main pass or through the imageProcessingPostProcess if present.
  117708. * As in the majority of the scene they are the same (exception for multi camera),
  117709. * this is easier to reference from here than from all the materials and post process.
  117710. *
  117711. * No setter as we it is a shared configuration, you can set the values instead.
  117712. */
  117713. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  117714. private _forceWireframe;
  117715. /**
  117716. * Gets or sets a boolean indicating if all rendering must be done in wireframe
  117717. */
  117718. set forceWireframe(value: boolean);
  117719. get forceWireframe(): boolean;
  117720. private _skipFrustumClipping;
  117721. /**
  117722. * Gets or sets a boolean indicating if we should skip the frustum clipping part of the active meshes selection
  117723. */
  117724. set skipFrustumClipping(value: boolean);
  117725. get skipFrustumClipping(): boolean;
  117726. private _forcePointsCloud;
  117727. /**
  117728. * Gets or sets a boolean indicating if all rendering must be done in point cloud
  117729. */
  117730. set forcePointsCloud(value: boolean);
  117731. get forcePointsCloud(): boolean;
  117732. /**
  117733. * Gets or sets the active clipplane 1
  117734. */
  117735. clipPlane: Nullable<Plane>;
  117736. /**
  117737. * Gets or sets the active clipplane 2
  117738. */
  117739. clipPlane2: Nullable<Plane>;
  117740. /**
  117741. * Gets or sets the active clipplane 3
  117742. */
  117743. clipPlane3: Nullable<Plane>;
  117744. /**
  117745. * Gets or sets the active clipplane 4
  117746. */
  117747. clipPlane4: Nullable<Plane>;
  117748. /**
  117749. * Gets or sets the active clipplane 5
  117750. */
  117751. clipPlane5: Nullable<Plane>;
  117752. /**
  117753. * Gets or sets the active clipplane 6
  117754. */
  117755. clipPlane6: Nullable<Plane>;
  117756. /**
  117757. * Gets or sets a boolean indicating if animations are enabled
  117758. */
  117759. animationsEnabled: boolean;
  117760. private _animationPropertiesOverride;
  117761. /**
  117762. * Gets or sets the animation properties override
  117763. */
  117764. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  117765. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  117766. /**
  117767. * Gets or sets a boolean indicating if a constant deltatime has to be used
  117768. * This is mostly useful for testing purposes when you do not want the animations to scale with the framerate
  117769. */
  117770. useConstantAnimationDeltaTime: boolean;
  117771. /**
  117772. * Gets or sets a boolean indicating if the scene must keep the meshUnderPointer property updated
  117773. * Please note that it requires to run a ray cast through the scene on every frame
  117774. */
  117775. constantlyUpdateMeshUnderPointer: boolean;
  117776. /**
  117777. * Defines the HTML cursor to use when hovering over interactive elements
  117778. */
  117779. hoverCursor: string;
  117780. /**
  117781. * Defines the HTML default cursor to use (empty by default)
  117782. */
  117783. defaultCursor: string;
  117784. /**
  117785. * Defines whether cursors are handled by the scene.
  117786. */
  117787. doNotHandleCursors: boolean;
  117788. /**
  117789. * This is used to call preventDefault() on pointer down
  117790. * in order to block unwanted artifacts like system double clicks
  117791. */
  117792. preventDefaultOnPointerDown: boolean;
  117793. /**
  117794. * This is used to call preventDefault() on pointer up
  117795. * in order to block unwanted artifacts like system double clicks
  117796. */
  117797. preventDefaultOnPointerUp: boolean;
  117798. /**
  117799. * Gets or sets user defined metadata
  117800. */
  117801. metadata: any;
  117802. /**
  117803. * For internal use only. Please do not use.
  117804. */
  117805. reservedDataStore: any;
  117806. /**
  117807. * Gets the name of the plugin used to load this scene (null by default)
  117808. */
  117809. loadingPluginName: string;
  117810. /**
  117811. * Use this array to add regular expressions used to disable offline support for specific urls
  117812. */
  117813. disableOfflineSupportExceptionRules: RegExp[];
  117814. /**
  117815. * An event triggered when the scene is disposed.
  117816. */
  117817. onDisposeObservable: Observable<Scene>;
  117818. private _onDisposeObserver;
  117819. /** Sets a function to be executed when this scene is disposed. */
  117820. set onDispose(callback: () => void);
  117821. /**
  117822. * An event triggered before rendering the scene (right after animations and physics)
  117823. */
  117824. onBeforeRenderObservable: Observable<Scene>;
  117825. private _onBeforeRenderObserver;
  117826. /** Sets a function to be executed before rendering this scene */
  117827. set beforeRender(callback: Nullable<() => void>);
  117828. /**
  117829. * An event triggered after rendering the scene
  117830. */
  117831. onAfterRenderObservable: Observable<Scene>;
  117832. /**
  117833. * An event triggered after rendering the scene for an active camera (When scene.render is called this will be called after each camera)
  117834. */
  117835. onAfterRenderCameraObservable: Observable<Camera>;
  117836. private _onAfterRenderObserver;
  117837. /** Sets a function to be executed after rendering this scene */
  117838. set afterRender(callback: Nullable<() => void>);
  117839. /**
  117840. * An event triggered before animating the scene
  117841. */
  117842. onBeforeAnimationsObservable: Observable<Scene>;
  117843. /**
  117844. * An event triggered after animations processing
  117845. */
  117846. onAfterAnimationsObservable: Observable<Scene>;
  117847. /**
  117848. * An event triggered before draw calls are ready to be sent
  117849. */
  117850. onBeforeDrawPhaseObservable: Observable<Scene>;
  117851. /**
  117852. * An event triggered after draw calls have been sent
  117853. */
  117854. onAfterDrawPhaseObservable: Observable<Scene>;
  117855. /**
  117856. * An event triggered when the scene is ready
  117857. */
  117858. onReadyObservable: Observable<Scene>;
  117859. /**
  117860. * An event triggered before rendering a camera
  117861. */
  117862. onBeforeCameraRenderObservable: Observable<Camera>;
  117863. private _onBeforeCameraRenderObserver;
  117864. /** Sets a function to be executed before rendering a camera*/
  117865. set beforeCameraRender(callback: () => void);
  117866. /**
  117867. * An event triggered after rendering a camera
  117868. */
  117869. onAfterCameraRenderObservable: Observable<Camera>;
  117870. private _onAfterCameraRenderObserver;
  117871. /** Sets a function to be executed after rendering a camera*/
  117872. set afterCameraRender(callback: () => void);
  117873. /**
  117874. * An event triggered when active meshes evaluation is about to start
  117875. */
  117876. onBeforeActiveMeshesEvaluationObservable: Observable<Scene>;
  117877. /**
  117878. * An event triggered when active meshes evaluation is done
  117879. */
  117880. onAfterActiveMeshesEvaluationObservable: Observable<Scene>;
  117881. /**
  117882. * An event triggered when particles rendering is about to start
  117883. * Note: This event can be trigger more than once per frame (because particles can be rendered by render target textures as well)
  117884. */
  117885. onBeforeParticlesRenderingObservable: Observable<Scene>;
  117886. /**
  117887. * An event triggered when particles rendering is done
  117888. * Note: This event can be trigger more than once per frame (because particles can be rendered by render target textures as well)
  117889. */
  117890. onAfterParticlesRenderingObservable: Observable<Scene>;
  117891. /**
  117892. * An event triggered when SceneLoader.Append or SceneLoader.Load or SceneLoader.ImportMesh were successfully executed
  117893. */
  117894. onDataLoadedObservable: Observable<Scene>;
  117895. /**
  117896. * An event triggered when a camera is created
  117897. */
  117898. onNewCameraAddedObservable: Observable<Camera>;
  117899. /**
  117900. * An event triggered when a camera is removed
  117901. */
  117902. onCameraRemovedObservable: Observable<Camera>;
  117903. /**
  117904. * An event triggered when a light is created
  117905. */
  117906. onNewLightAddedObservable: Observable<Light>;
  117907. /**
  117908. * An event triggered when a light is removed
  117909. */
  117910. onLightRemovedObservable: Observable<Light>;
  117911. /**
  117912. * An event triggered when a geometry is created
  117913. */
  117914. onNewGeometryAddedObservable: Observable<Geometry>;
  117915. /**
  117916. * An event triggered when a geometry is removed
  117917. */
  117918. onGeometryRemovedObservable: Observable<Geometry>;
  117919. /**
  117920. * An event triggered when a transform node is created
  117921. */
  117922. onNewTransformNodeAddedObservable: Observable<TransformNode>;
  117923. /**
  117924. * An event triggered when a transform node is removed
  117925. */
  117926. onTransformNodeRemovedObservable: Observable<TransformNode>;
  117927. /**
  117928. * An event triggered when a mesh is created
  117929. */
  117930. onNewMeshAddedObservable: Observable<AbstractMesh>;
  117931. /**
  117932. * An event triggered when a mesh is removed
  117933. */
  117934. onMeshRemovedObservable: Observable<AbstractMesh>;
  117935. /**
  117936. * An event triggered when a skeleton is created
  117937. */
  117938. onNewSkeletonAddedObservable: Observable<Skeleton>;
  117939. /**
  117940. * An event triggered when a skeleton is removed
  117941. */
  117942. onSkeletonRemovedObservable: Observable<Skeleton>;
  117943. /**
  117944. * An event triggered when a material is created
  117945. */
  117946. onNewMaterialAddedObservable: Observable<Material>;
  117947. /**
  117948. * An event triggered when a material is removed
  117949. */
  117950. onMaterialRemovedObservable: Observable<Material>;
  117951. /**
  117952. * An event triggered when a texture is created
  117953. */
  117954. onNewTextureAddedObservable: Observable<BaseTexture>;
  117955. /**
  117956. * An event triggered when a texture is removed
  117957. */
  117958. onTextureRemovedObservable: Observable<BaseTexture>;
  117959. /**
  117960. * An event triggered when render targets are about to be rendered
  117961. * Can happen multiple times per frame.
  117962. */
  117963. onBeforeRenderTargetsRenderObservable: Observable<Scene>;
  117964. /**
  117965. * An event triggered when render targets were rendered.
  117966. * Can happen multiple times per frame.
  117967. */
  117968. onAfterRenderTargetsRenderObservable: Observable<Scene>;
  117969. /**
  117970. * An event triggered before calculating deterministic simulation step
  117971. */
  117972. onBeforeStepObservable: Observable<Scene>;
  117973. /**
  117974. * An event triggered after calculating deterministic simulation step
  117975. */
  117976. onAfterStepObservable: Observable<Scene>;
  117977. /**
  117978. * An event triggered when the activeCamera property is updated
  117979. */
  117980. onActiveCameraChanged: Observable<Scene>;
  117981. /**
  117982. * This Observable will be triggered before rendering each renderingGroup of each rendered camera.
  117983. * The RenderinGroupInfo class contains all the information about the context in which the observable is called
  117984. * 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)
  117985. */
  117986. onBeforeRenderingGroupObservable: Observable<RenderingGroupInfo>;
  117987. /**
  117988. * This Observable will be triggered after rendering each renderingGroup of each rendered camera.
  117989. * The RenderinGroupInfo class contains all the information about the context in which the observable is called
  117990. * 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)
  117991. */
  117992. onAfterRenderingGroupObservable: Observable<RenderingGroupInfo>;
  117993. /**
  117994. * This Observable will when a mesh has been imported into the scene.
  117995. */
  117996. onMeshImportedObservable: Observable<AbstractMesh>;
  117997. /**
  117998. * This Observable will when an animation file has been imported into the scene.
  117999. */
  118000. onAnimationFileImportedObservable: Observable<Scene>;
  118001. /**
  118002. * Gets or sets a user defined funtion to select LOD from a mesh and a camera.
  118003. * By default this function is undefined and Babylon.js will select LOD based on distance to camera
  118004. */
  118005. customLODSelector: (mesh: AbstractMesh, camera: Camera) => Nullable<AbstractMesh>;
  118006. /** @hidden */
  118007. _registeredForLateAnimationBindings: SmartArrayNoDuplicate<any>;
  118008. /**
  118009. * Gets or sets a predicate used to select candidate meshes for a pointer down event
  118010. */
  118011. pointerDownPredicate: (Mesh: AbstractMesh) => boolean;
  118012. /**
  118013. * Gets or sets a predicate used to select candidate meshes for a pointer up event
  118014. */
  118015. pointerUpPredicate: (Mesh: AbstractMesh) => boolean;
  118016. /**
  118017. * Gets or sets a predicate used to select candidate meshes for a pointer move event
  118018. */
  118019. pointerMovePredicate: (Mesh: AbstractMesh) => boolean;
  118020. /** Callback called when a pointer move is detected */
  118021. onPointerMove: (evt: PointerEvent, pickInfo: PickingInfo, type: PointerEventTypes) => void;
  118022. /** Callback called when a pointer down is detected */
  118023. onPointerDown: (evt: PointerEvent, pickInfo: PickingInfo, type: PointerEventTypes) => void;
  118024. /** Callback called when a pointer up is detected */
  118025. onPointerUp: (evt: PointerEvent, pickInfo: Nullable<PickingInfo>, type: PointerEventTypes) => void;
  118026. /** Callback called when a pointer pick is detected */
  118027. onPointerPick: (evt: PointerEvent, pickInfo: PickingInfo) => void;
  118028. /**
  118029. * 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).
  118030. * You have the possibility to skip the process and the call to onPointerObservable by setting PointerInfoPre.skipOnPointerObservable to true
  118031. */
  118032. onPrePointerObservable: Observable<PointerInfoPre>;
  118033. /**
  118034. * Observable event triggered each time an input event is received from the rendering canvas
  118035. */
  118036. onPointerObservable: Observable<PointerInfo>;
  118037. /**
  118038. * Gets the pointer coordinates without any translation (ie. straight out of the pointer event)
  118039. */
  118040. get unTranslatedPointer(): Vector2;
  118041. /**
  118042. * Gets or sets the distance in pixel that you have to move to prevent some events. Default is 10 pixels
  118043. */
  118044. static get DragMovementThreshold(): number;
  118045. static set DragMovementThreshold(value: number);
  118046. /**
  118047. * Time in milliseconds to wait to raise long press events if button is still pressed. Default is 500 ms
  118048. */
  118049. static get LongPressDelay(): number;
  118050. static set LongPressDelay(value: number);
  118051. /**
  118052. * Time in milliseconds to wait to raise long press events if button is still pressed. Default is 300 ms
  118053. */
  118054. static get DoubleClickDelay(): number;
  118055. static set DoubleClickDelay(value: number);
  118056. /** If you need to check double click without raising a single click at first click, enable this flag */
  118057. static get ExclusiveDoubleClickMode(): boolean;
  118058. static set ExclusiveDoubleClickMode(value: boolean);
  118059. /** @hidden */
  118060. _mirroredCameraPosition: Nullable<Vector3>;
  118061. /**
  118062. * This observable event is triggered when any keyboard event si raised and registered during Scene.attachControl()
  118063. * You have the possibility to skip the process and the call to onKeyboardObservable by setting KeyboardInfoPre.skipOnPointerObservable to true
  118064. */
  118065. onPreKeyboardObservable: Observable<KeyboardInfoPre>;
  118066. /**
  118067. * Observable event triggered each time an keyboard event is received from the hosting window
  118068. */
  118069. onKeyboardObservable: Observable<KeyboardInfo>;
  118070. private _useRightHandedSystem;
  118071. /**
  118072. * Gets or sets a boolean indicating if the scene must use right-handed coordinates system
  118073. */
  118074. set useRightHandedSystem(value: boolean);
  118075. get useRightHandedSystem(): boolean;
  118076. private _timeAccumulator;
  118077. private _currentStepId;
  118078. private _currentInternalStep;
  118079. /**
  118080. * Sets the step Id used by deterministic lock step
  118081. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  118082. * @param newStepId defines the step Id
  118083. */
  118084. setStepId(newStepId: number): void;
  118085. /**
  118086. * Gets the step Id used by deterministic lock step
  118087. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  118088. * @returns the step Id
  118089. */
  118090. getStepId(): number;
  118091. /**
  118092. * Gets the internal step used by deterministic lock step
  118093. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  118094. * @returns the internal step
  118095. */
  118096. getInternalStep(): number;
  118097. private _fogEnabled;
  118098. /**
  118099. * Gets or sets a boolean indicating if fog is enabled on this scene
  118100. * @see https://doc.babylonjs.com/babylon101/environment#fog
  118101. * (Default is true)
  118102. */
  118103. set fogEnabled(value: boolean);
  118104. get fogEnabled(): boolean;
  118105. private _fogMode;
  118106. /**
  118107. * Gets or sets the fog mode to use
  118108. * @see https://doc.babylonjs.com/babylon101/environment#fog
  118109. * | mode | value |
  118110. * | --- | --- |
  118111. * | FOGMODE_NONE | 0 |
  118112. * | FOGMODE_EXP | 1 |
  118113. * | FOGMODE_EXP2 | 2 |
  118114. * | FOGMODE_LINEAR | 3 |
  118115. */
  118116. set fogMode(value: number);
  118117. get fogMode(): number;
  118118. /**
  118119. * Gets or sets the fog color to use
  118120. * @see https://doc.babylonjs.com/babylon101/environment#fog
  118121. * (Default is Color3(0.2, 0.2, 0.3))
  118122. */
  118123. fogColor: Color3;
  118124. /**
  118125. * Gets or sets the fog density to use
  118126. * @see https://doc.babylonjs.com/babylon101/environment#fog
  118127. * (Default is 0.1)
  118128. */
  118129. fogDensity: number;
  118130. /**
  118131. * Gets or sets the fog start distance to use
  118132. * @see https://doc.babylonjs.com/babylon101/environment#fog
  118133. * (Default is 0)
  118134. */
  118135. fogStart: number;
  118136. /**
  118137. * Gets or sets the fog end distance to use
  118138. * @see https://doc.babylonjs.com/babylon101/environment#fog
  118139. * (Default is 1000)
  118140. */
  118141. fogEnd: number;
  118142. /**
  118143. * Flag indicating that the frame buffer binding is handled by another component
  118144. */
  118145. prePass: boolean;
  118146. private _shadowsEnabled;
  118147. /**
  118148. * Gets or sets a boolean indicating if shadows are enabled on this scene
  118149. */
  118150. set shadowsEnabled(value: boolean);
  118151. get shadowsEnabled(): boolean;
  118152. private _lightsEnabled;
  118153. /**
  118154. * Gets or sets a boolean indicating if lights are enabled on this scene
  118155. */
  118156. set lightsEnabled(value: boolean);
  118157. get lightsEnabled(): boolean;
  118158. /** All of the active cameras added to this scene. */
  118159. activeCameras: Camera[];
  118160. /** @hidden */
  118161. _activeCamera: Nullable<Camera>;
  118162. /** Gets or sets the current active camera */
  118163. get activeCamera(): Nullable<Camera>;
  118164. set activeCamera(value: Nullable<Camera>);
  118165. private _defaultMaterial;
  118166. /** The default material used on meshes when no material is affected */
  118167. get defaultMaterial(): Material;
  118168. /** The default material used on meshes when no material is affected */
  118169. set defaultMaterial(value: Material);
  118170. private _texturesEnabled;
  118171. /**
  118172. * Gets or sets a boolean indicating if textures are enabled on this scene
  118173. */
  118174. set texturesEnabled(value: boolean);
  118175. get texturesEnabled(): boolean;
  118176. /**
  118177. * Gets or sets a boolean indicating if physic engines are enabled on this scene
  118178. */
  118179. physicsEnabled: boolean;
  118180. /**
  118181. * Gets or sets a boolean indicating if particles are enabled on this scene
  118182. */
  118183. particlesEnabled: boolean;
  118184. /**
  118185. * Gets or sets a boolean indicating if sprites are enabled on this scene
  118186. */
  118187. spritesEnabled: boolean;
  118188. private _skeletonsEnabled;
  118189. /**
  118190. * Gets or sets a boolean indicating if skeletons are enabled on this scene
  118191. */
  118192. set skeletonsEnabled(value: boolean);
  118193. get skeletonsEnabled(): boolean;
  118194. /**
  118195. * Gets or sets a boolean indicating if lens flares are enabled on this scene
  118196. */
  118197. lensFlaresEnabled: boolean;
  118198. /**
  118199. * Gets or sets a boolean indicating if collisions are enabled on this scene
  118200. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  118201. */
  118202. collisionsEnabled: boolean;
  118203. private _collisionCoordinator;
  118204. /** @hidden */
  118205. get collisionCoordinator(): ICollisionCoordinator;
  118206. /**
  118207. * Defines the gravity applied to this scene (used only for collisions)
  118208. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  118209. */
  118210. gravity: Vector3;
  118211. /**
  118212. * Gets or sets a boolean indicating if postprocesses are enabled on this scene
  118213. */
  118214. postProcessesEnabled: boolean;
  118215. /**
  118216. * The list of postprocesses added to the scene
  118217. */
  118218. postProcesses: PostProcess[];
  118219. /**
  118220. * Gets the current postprocess manager
  118221. */
  118222. postProcessManager: PostProcessManager;
  118223. /**
  118224. * Gets or sets a boolean indicating if render targets are enabled on this scene
  118225. */
  118226. renderTargetsEnabled: boolean;
  118227. /**
  118228. * Gets or sets a boolean indicating if next render targets must be dumped as image for debugging purposes
  118229. * We recommend not using it and instead rely on Spector.js: http://spector.babylonjs.com
  118230. */
  118231. dumpNextRenderTargets: boolean;
  118232. /**
  118233. * The list of user defined render targets added to the scene
  118234. */
  118235. customRenderTargets: RenderTargetTexture[];
  118236. /**
  118237. * Defines if texture loading must be delayed
  118238. * If true, textures will only be loaded when they need to be rendered
  118239. */
  118240. useDelayedTextureLoading: boolean;
  118241. /**
  118242. * Gets the list of meshes imported to the scene through SceneLoader
  118243. */
  118244. importedMeshesFiles: String[];
  118245. /**
  118246. * Gets or sets a boolean indicating if probes are enabled on this scene
  118247. */
  118248. probesEnabled: boolean;
  118249. /**
  118250. * Gets or sets the current offline provider to use to store scene data
  118251. * @see https://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  118252. */
  118253. offlineProvider: IOfflineProvider;
  118254. /**
  118255. * Gets or sets the action manager associated with the scene
  118256. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  118257. */
  118258. actionManager: AbstractActionManager;
  118259. private _meshesForIntersections;
  118260. /**
  118261. * Gets or sets a boolean indicating if procedural textures are enabled on this scene
  118262. */
  118263. proceduralTexturesEnabled: boolean;
  118264. private _engine;
  118265. private _totalVertices;
  118266. /** @hidden */
  118267. _activeIndices: PerfCounter;
  118268. /** @hidden */
  118269. _activeParticles: PerfCounter;
  118270. /** @hidden */
  118271. _activeBones: PerfCounter;
  118272. private _animationRatio;
  118273. /** @hidden */
  118274. _animationTimeLast: number;
  118275. /** @hidden */
  118276. _animationTime: number;
  118277. /**
  118278. * Gets or sets a general scale for animation speed
  118279. * @see https://www.babylonjs-playground.com/#IBU2W7#3
  118280. */
  118281. animationTimeScale: number;
  118282. /** @hidden */
  118283. _cachedMaterial: Nullable<Material>;
  118284. /** @hidden */
  118285. _cachedEffect: Nullable<Effect>;
  118286. /** @hidden */
  118287. _cachedVisibility: Nullable<number>;
  118288. private _renderId;
  118289. private _frameId;
  118290. private _executeWhenReadyTimeoutId;
  118291. private _intermediateRendering;
  118292. private _viewUpdateFlag;
  118293. private _projectionUpdateFlag;
  118294. /** @hidden */
  118295. _toBeDisposed: Nullable<IDisposable>[];
  118296. private _activeRequests;
  118297. /** @hidden */
  118298. _pendingData: any[];
  118299. private _isDisposed;
  118300. /**
  118301. * Gets or sets a boolean indicating that all submeshes of active meshes must be rendered
  118302. * Use this boolean to avoid computing frustum clipping on submeshes (This could help when you are CPU bound)
  118303. */
  118304. dispatchAllSubMeshesOfActiveMeshes: boolean;
  118305. private _activeMeshes;
  118306. private _processedMaterials;
  118307. private _renderTargets;
  118308. /** @hidden */
  118309. _activeParticleSystems: SmartArray<IParticleSystem>;
  118310. private _activeSkeletons;
  118311. private _softwareSkinnedMeshes;
  118312. private _renderingManager;
  118313. /** @hidden */
  118314. _activeAnimatables: Animatable[];
  118315. private _transformMatrix;
  118316. private _sceneUbo;
  118317. /** @hidden */
  118318. _viewMatrix: Matrix;
  118319. private _projectionMatrix;
  118320. /** @hidden */
  118321. _forcedViewPosition: Nullable<Vector3>;
  118322. /** @hidden */
  118323. _frustumPlanes: Plane[];
  118324. /**
  118325. * Gets the list of frustum planes (built from the active camera)
  118326. */
  118327. get frustumPlanes(): Plane[];
  118328. /**
  118329. * Gets or sets a boolean indicating if lights must be sorted by priority (off by default)
  118330. * This is useful if there are more lights that the maximum simulteanous authorized
  118331. */
  118332. requireLightSorting: boolean;
  118333. /** @hidden */
  118334. readonly useMaterialMeshMap: boolean;
  118335. /** @hidden */
  118336. readonly useClonedMeshMap: boolean;
  118337. private _externalData;
  118338. private _uid;
  118339. /**
  118340. * @hidden
  118341. * Backing store of defined scene components.
  118342. */
  118343. _components: ISceneComponent[];
  118344. /**
  118345. * @hidden
  118346. * Backing store of defined scene components.
  118347. */
  118348. _serializableComponents: ISceneSerializableComponent[];
  118349. /**
  118350. * List of components to register on the next registration step.
  118351. */
  118352. private _transientComponents;
  118353. /**
  118354. * Registers the transient components if needed.
  118355. */
  118356. private _registerTransientComponents;
  118357. /**
  118358. * @hidden
  118359. * Add a component to the scene.
  118360. * Note that the ccomponent could be registered on th next frame if this is called after
  118361. * the register component stage.
  118362. * @param component Defines the component to add to the scene
  118363. */
  118364. _addComponent(component: ISceneComponent): void;
  118365. /**
  118366. * @hidden
  118367. * Gets a component from the scene.
  118368. * @param name defines the name of the component to retrieve
  118369. * @returns the component or null if not present
  118370. */
  118371. _getComponent(name: string): Nullable<ISceneComponent>;
  118372. /**
  118373. * @hidden
  118374. * Defines the actions happening before camera updates.
  118375. */
  118376. _beforeCameraUpdateStage: Stage<SimpleStageAction>;
  118377. /**
  118378. * @hidden
  118379. * Defines the actions happening before clear the canvas.
  118380. */
  118381. _beforeClearStage: Stage<SimpleStageAction>;
  118382. /**
  118383. * @hidden
  118384. * Defines the actions when collecting render targets for the frame.
  118385. */
  118386. _gatherRenderTargetsStage: Stage<RenderTargetsStageAction>;
  118387. /**
  118388. * @hidden
  118389. * Defines the actions happening for one camera in the frame.
  118390. */
  118391. _gatherActiveCameraRenderTargetsStage: Stage<RenderTargetsStageAction>;
  118392. /**
  118393. * @hidden
  118394. * Defines the actions happening during the per mesh ready checks.
  118395. */
  118396. _isReadyForMeshStage: Stage<MeshStageAction>;
  118397. /**
  118398. * @hidden
  118399. * Defines the actions happening before evaluate active mesh checks.
  118400. */
  118401. _beforeEvaluateActiveMeshStage: Stage<SimpleStageAction>;
  118402. /**
  118403. * @hidden
  118404. * Defines the actions happening during the evaluate sub mesh checks.
  118405. */
  118406. _evaluateSubMeshStage: Stage<EvaluateSubMeshStageAction>;
  118407. /**
  118408. * @hidden
  118409. * Defines the actions happening during the active mesh stage.
  118410. */
  118411. _activeMeshStage: Stage<ActiveMeshStageAction>;
  118412. /**
  118413. * @hidden
  118414. * Defines the actions happening during the per camera render target step.
  118415. */
  118416. _cameraDrawRenderTargetStage: Stage<CameraStageFrameBufferAction>;
  118417. /**
  118418. * @hidden
  118419. * Defines the actions happening just before the active camera is drawing.
  118420. */
  118421. _beforeCameraDrawStage: Stage<CameraStageAction>;
  118422. /**
  118423. * @hidden
  118424. * Defines the actions happening just before a render target is drawing.
  118425. */
  118426. _beforeRenderTargetDrawStage: Stage<RenderTargetStageAction>;
  118427. /**
  118428. * @hidden
  118429. * Defines the actions happening just before a rendering group is drawing.
  118430. */
  118431. _beforeRenderingGroupDrawStage: Stage<RenderingGroupStageAction>;
  118432. /**
  118433. * @hidden
  118434. * Defines the actions happening just before a mesh is drawing.
  118435. */
  118436. _beforeRenderingMeshStage: Stage<RenderingMeshStageAction>;
  118437. /**
  118438. * @hidden
  118439. * Defines the actions happening just after a mesh has been drawn.
  118440. */
  118441. _afterRenderingMeshStage: Stage<RenderingMeshStageAction>;
  118442. /**
  118443. * @hidden
  118444. * Defines the actions happening just after a rendering group has been drawn.
  118445. */
  118446. _afterRenderingGroupDrawStage: Stage<RenderingGroupStageAction>;
  118447. /**
  118448. * @hidden
  118449. * Defines the actions happening just after the active camera has been drawn.
  118450. */
  118451. _afterCameraDrawStage: Stage<CameraStageAction>;
  118452. /**
  118453. * @hidden
  118454. * Defines the actions happening just after a render target has been drawn.
  118455. */
  118456. _afterRenderTargetDrawStage: Stage<RenderTargetStageAction>;
  118457. /**
  118458. * @hidden
  118459. * Defines the actions happening just after rendering all cameras and computing intersections.
  118460. */
  118461. _afterRenderStage: Stage<SimpleStageAction>;
  118462. /**
  118463. * @hidden
  118464. * Defines the actions happening when a pointer move event happens.
  118465. */
  118466. _pointerMoveStage: Stage<PointerMoveStageAction>;
  118467. /**
  118468. * @hidden
  118469. * Defines the actions happening when a pointer down event happens.
  118470. */
  118471. _pointerDownStage: Stage<PointerUpDownStageAction>;
  118472. /**
  118473. * @hidden
  118474. * Defines the actions happening when a pointer up event happens.
  118475. */
  118476. _pointerUpStage: Stage<PointerUpDownStageAction>;
  118477. /**
  118478. * an optional map from Geometry Id to Geometry index in the 'geometries' array
  118479. */
  118480. private geometriesByUniqueId;
  118481. /**
  118482. * Creates a new Scene
  118483. * @param engine defines the engine to use to render this scene
  118484. * @param options defines the scene options
  118485. */
  118486. constructor(engine: Engine, options?: SceneOptions);
  118487. /**
  118488. * Gets a string idenfifying the name of the class
  118489. * @returns "Scene" string
  118490. */
  118491. getClassName(): string;
  118492. private _defaultMeshCandidates;
  118493. /**
  118494. * @hidden
  118495. */
  118496. _getDefaultMeshCandidates(): ISmartArrayLike<AbstractMesh>;
  118497. private _defaultSubMeshCandidates;
  118498. /**
  118499. * @hidden
  118500. */
  118501. _getDefaultSubMeshCandidates(mesh: AbstractMesh): ISmartArrayLike<SubMesh>;
  118502. /**
  118503. * Sets the default candidate providers for the scene.
  118504. * This sets the getActiveMeshCandidates, getActiveSubMeshCandidates, getIntersectingSubMeshCandidates
  118505. * and getCollidingSubMeshCandidates to their default function
  118506. */
  118507. setDefaultCandidateProviders(): void;
  118508. /**
  118509. * Gets the mesh that is currently under the pointer
  118510. */
  118511. get meshUnderPointer(): Nullable<AbstractMesh>;
  118512. /**
  118513. * Gets or sets the current on-screen X position of the pointer
  118514. */
  118515. get pointerX(): number;
  118516. set pointerX(value: number);
  118517. /**
  118518. * Gets or sets the current on-screen Y position of the pointer
  118519. */
  118520. get pointerY(): number;
  118521. set pointerY(value: number);
  118522. /**
  118523. * Gets the cached material (ie. the latest rendered one)
  118524. * @returns the cached material
  118525. */
  118526. getCachedMaterial(): Nullable<Material>;
  118527. /**
  118528. * Gets the cached effect (ie. the latest rendered one)
  118529. * @returns the cached effect
  118530. */
  118531. getCachedEffect(): Nullable<Effect>;
  118532. /**
  118533. * Gets the cached visibility state (ie. the latest rendered one)
  118534. * @returns the cached visibility state
  118535. */
  118536. getCachedVisibility(): Nullable<number>;
  118537. /**
  118538. * Gets a boolean indicating if the current material / effect / visibility must be bind again
  118539. * @param material defines the current material
  118540. * @param effect defines the current effect
  118541. * @param visibility defines the current visibility state
  118542. * @returns true if one parameter is not cached
  118543. */
  118544. isCachedMaterialInvalid(material: Material, effect: Effect, visibility?: number): boolean;
  118545. /**
  118546. * Gets the engine associated with the scene
  118547. * @returns an Engine
  118548. */
  118549. getEngine(): Engine;
  118550. /**
  118551. * Gets the total number of vertices rendered per frame
  118552. * @returns the total number of vertices rendered per frame
  118553. */
  118554. getTotalVertices(): number;
  118555. /**
  118556. * Gets the performance counter for total vertices
  118557. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  118558. */
  118559. get totalVerticesPerfCounter(): PerfCounter;
  118560. /**
  118561. * Gets the total number of active indices rendered per frame (You can deduce the number of rendered triangles by dividing this number by 3)
  118562. * @returns the total number of active indices rendered per frame
  118563. */
  118564. getActiveIndices(): number;
  118565. /**
  118566. * Gets the performance counter for active indices
  118567. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  118568. */
  118569. get totalActiveIndicesPerfCounter(): PerfCounter;
  118570. /**
  118571. * Gets the total number of active particles rendered per frame
  118572. * @returns the total number of active particles rendered per frame
  118573. */
  118574. getActiveParticles(): number;
  118575. /**
  118576. * Gets the performance counter for active particles
  118577. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  118578. */
  118579. get activeParticlesPerfCounter(): PerfCounter;
  118580. /**
  118581. * Gets the total number of active bones rendered per frame
  118582. * @returns the total number of active bones rendered per frame
  118583. */
  118584. getActiveBones(): number;
  118585. /**
  118586. * Gets the performance counter for active bones
  118587. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  118588. */
  118589. get activeBonesPerfCounter(): PerfCounter;
  118590. /**
  118591. * Gets the array of active meshes
  118592. * @returns an array of AbstractMesh
  118593. */
  118594. getActiveMeshes(): SmartArray<AbstractMesh>;
  118595. /**
  118596. * Gets the animation ratio (which is 1.0 is the scene renders at 60fps and 2 if the scene renders at 30fps, etc.)
  118597. * @returns a number
  118598. */
  118599. getAnimationRatio(): number;
  118600. /**
  118601. * Gets an unique Id for the current render phase
  118602. * @returns a number
  118603. */
  118604. getRenderId(): number;
  118605. /**
  118606. * Gets an unique Id for the current frame
  118607. * @returns a number
  118608. */
  118609. getFrameId(): number;
  118610. /** Call this function if you want to manually increment the render Id*/
  118611. incrementRenderId(): void;
  118612. private _createUbo;
  118613. /**
  118614. * Use this method to simulate a pointer move on a mesh
  118615. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  118616. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  118617. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  118618. * @returns the current scene
  118619. */
  118620. simulatePointerMove(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): Scene;
  118621. /**
  118622. * Use this method to simulate a pointer down on a mesh
  118623. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  118624. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  118625. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  118626. * @returns the current scene
  118627. */
  118628. simulatePointerDown(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): Scene;
  118629. /**
  118630. * Use this method to simulate a pointer up on a mesh
  118631. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  118632. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  118633. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  118634. * @param doubleTap indicates that the pointer up event should be considered as part of a double click (false by default)
  118635. * @returns the current scene
  118636. */
  118637. simulatePointerUp(pickResult: PickingInfo, pointerEventInit?: PointerEventInit, doubleTap?: boolean): Scene;
  118638. /**
  118639. * Gets a boolean indicating if the current pointer event is captured (meaning that the scene has already handled the pointer down)
  118640. * @param pointerId defines the pointer id to use in a multi-touch scenario (0 by default)
  118641. * @returns true if the pointer was captured
  118642. */
  118643. isPointerCaptured(pointerId?: number): boolean;
  118644. /**
  118645. * Attach events to the canvas (To handle actionManagers triggers and raise onPointerMove, onPointerDown and onPointerUp
  118646. * @param attachUp defines if you want to attach events to pointerup
  118647. * @param attachDown defines if you want to attach events to pointerdown
  118648. * @param attachMove defines if you want to attach events to pointermove
  118649. */
  118650. attachControl(attachUp?: boolean, attachDown?: boolean, attachMove?: boolean): void;
  118651. /** Detaches all event handlers*/
  118652. detachControl(): void;
  118653. /**
  118654. * This function will check if the scene can be rendered (textures are loaded, shaders are compiled)
  118655. * Delay loaded resources are not taking in account
  118656. * @return true if all required resources are ready
  118657. */
  118658. isReady(): boolean;
  118659. /** Resets all cached information relative to material (including effect and visibility) */
  118660. resetCachedMaterial(): void;
  118661. /**
  118662. * Registers a function to be called before every frame render
  118663. * @param func defines the function to register
  118664. */
  118665. registerBeforeRender(func: () => void): void;
  118666. /**
  118667. * Unregisters a function called before every frame render
  118668. * @param func defines the function to unregister
  118669. */
  118670. unregisterBeforeRender(func: () => void): void;
  118671. /**
  118672. * Registers a function to be called after every frame render
  118673. * @param func defines the function to register
  118674. */
  118675. registerAfterRender(func: () => void): void;
  118676. /**
  118677. * Unregisters a function called after every frame render
  118678. * @param func defines the function to unregister
  118679. */
  118680. unregisterAfterRender(func: () => void): void;
  118681. private _executeOnceBeforeRender;
  118682. /**
  118683. * The provided function will run before render once and will be disposed afterwards.
  118684. * A timeout delay can be provided so that the function will be executed in N ms.
  118685. * The timeout is using the browser's native setTimeout so time percision cannot be guaranteed.
  118686. * @param func The function to be executed.
  118687. * @param timeout optional delay in ms
  118688. */
  118689. executeOnceBeforeRender(func: () => void, timeout?: number): void;
  118690. /** @hidden */
  118691. _addPendingData(data: any): void;
  118692. /** @hidden */
  118693. _removePendingData(data: any): void;
  118694. /**
  118695. * Returns the number of items waiting to be loaded
  118696. * @returns the number of items waiting to be loaded
  118697. */
  118698. getWaitingItemsCount(): number;
  118699. /**
  118700. * Returns a boolean indicating if the scene is still loading data
  118701. */
  118702. get isLoading(): boolean;
  118703. /**
  118704. * Registers a function to be executed when the scene is ready
  118705. * @param {Function} func - the function to be executed
  118706. */
  118707. executeWhenReady(func: () => void): void;
  118708. /**
  118709. * Returns a promise that resolves when the scene is ready
  118710. * @returns A promise that resolves when the scene is ready
  118711. */
  118712. whenReadyAsync(): Promise<void>;
  118713. /** @hidden */
  118714. _checkIsReady(): void;
  118715. /**
  118716. * Gets all animatable attached to the scene
  118717. */
  118718. get animatables(): Animatable[];
  118719. /**
  118720. * Resets the last animation time frame.
  118721. * Useful to override when animations start running when loading a scene for the first time.
  118722. */
  118723. resetLastAnimationTimeFrame(): void;
  118724. /**
  118725. * Gets the current view matrix
  118726. * @returns a Matrix
  118727. */
  118728. getViewMatrix(): Matrix;
  118729. /**
  118730. * Gets the current projection matrix
  118731. * @returns a Matrix
  118732. */
  118733. getProjectionMatrix(): Matrix;
  118734. /**
  118735. * Gets the current transform matrix
  118736. * @returns a Matrix made of View * Projection
  118737. */
  118738. getTransformMatrix(): Matrix;
  118739. /**
  118740. * Sets the current transform matrix
  118741. * @param viewL defines the View matrix to use
  118742. * @param projectionL defines the Projection matrix to use
  118743. * @param viewR defines the right View matrix to use (if provided)
  118744. * @param projectionR defines the right Projection matrix to use (if provided)
  118745. */
  118746. setTransformMatrix(viewL: Matrix, projectionL: Matrix, viewR?: Matrix, projectionR?: Matrix): void;
  118747. /**
  118748. * Gets the uniform buffer used to store scene data
  118749. * @returns a UniformBuffer
  118750. */
  118751. getSceneUniformBuffer(): UniformBuffer;
  118752. /**
  118753. * Gets an unique (relatively to the current scene) Id
  118754. * @returns an unique number for the scene
  118755. */
  118756. getUniqueId(): number;
  118757. /**
  118758. * Add a mesh to the list of scene's meshes
  118759. * @param newMesh defines the mesh to add
  118760. * @param recursive if all child meshes should also be added to the scene
  118761. */
  118762. addMesh(newMesh: AbstractMesh, recursive?: boolean): void;
  118763. /**
  118764. * Remove a mesh for the list of scene's meshes
  118765. * @param toRemove defines the mesh to remove
  118766. * @param recursive if all child meshes should also be removed from the scene
  118767. * @returns the index where the mesh was in the mesh list
  118768. */
  118769. removeMesh(toRemove: AbstractMesh, recursive?: boolean): number;
  118770. /**
  118771. * Add a transform node to the list of scene's transform nodes
  118772. * @param newTransformNode defines the transform node to add
  118773. */
  118774. addTransformNode(newTransformNode: TransformNode): void;
  118775. /**
  118776. * Remove a transform node for the list of scene's transform nodes
  118777. * @param toRemove defines the transform node to remove
  118778. * @returns the index where the transform node was in the transform node list
  118779. */
  118780. removeTransformNode(toRemove: TransformNode): number;
  118781. /**
  118782. * Remove a skeleton for the list of scene's skeletons
  118783. * @param toRemove defines the skeleton to remove
  118784. * @returns the index where the skeleton was in the skeleton list
  118785. */
  118786. removeSkeleton(toRemove: Skeleton): number;
  118787. /**
  118788. * Remove a morph target for the list of scene's morph targets
  118789. * @param toRemove defines the morph target to remove
  118790. * @returns the index where the morph target was in the morph target list
  118791. */
  118792. removeMorphTargetManager(toRemove: MorphTargetManager): number;
  118793. /**
  118794. * Remove a light for the list of scene's lights
  118795. * @param toRemove defines the light to remove
  118796. * @returns the index where the light was in the light list
  118797. */
  118798. removeLight(toRemove: Light): number;
  118799. /**
  118800. * Remove a camera for the list of scene's cameras
  118801. * @param toRemove defines the camera to remove
  118802. * @returns the index where the camera was in the camera list
  118803. */
  118804. removeCamera(toRemove: Camera): number;
  118805. /**
  118806. * Remove a particle system for the list of scene's particle systems
  118807. * @param toRemove defines the particle system to remove
  118808. * @returns the index where the particle system was in the particle system list
  118809. */
  118810. removeParticleSystem(toRemove: IParticleSystem): number;
  118811. /**
  118812. * Remove a animation for the list of scene's animations
  118813. * @param toRemove defines the animation to remove
  118814. * @returns the index where the animation was in the animation list
  118815. */
  118816. removeAnimation(toRemove: Animation): number;
  118817. /**
  118818. * Will stop the animation of the given target
  118819. * @param target - the target
  118820. * @param animationName - the name of the animation to stop (all animations will be stopped if both this and targetMask are empty)
  118821. * @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)
  118822. */
  118823. stopAnimation(target: any, animationName?: string, targetMask?: (target: any) => boolean): void;
  118824. /**
  118825. * Removes the given animation group from this scene.
  118826. * @param toRemove The animation group to remove
  118827. * @returns The index of the removed animation group
  118828. */
  118829. removeAnimationGroup(toRemove: AnimationGroup): number;
  118830. /**
  118831. * Removes the given multi-material from this scene.
  118832. * @param toRemove The multi-material to remove
  118833. * @returns The index of the removed multi-material
  118834. */
  118835. removeMultiMaterial(toRemove: MultiMaterial): number;
  118836. /**
  118837. * Removes the given material from this scene.
  118838. * @param toRemove The material to remove
  118839. * @returns The index of the removed material
  118840. */
  118841. removeMaterial(toRemove: Material): number;
  118842. /**
  118843. * Removes the given action manager from this scene.
  118844. * @param toRemove The action manager to remove
  118845. * @returns The index of the removed action manager
  118846. */
  118847. removeActionManager(toRemove: AbstractActionManager): number;
  118848. /**
  118849. * Removes the given texture from this scene.
  118850. * @param toRemove The texture to remove
  118851. * @returns The index of the removed texture
  118852. */
  118853. removeTexture(toRemove: BaseTexture): number;
  118854. /**
  118855. * Adds the given light to this scene
  118856. * @param newLight The light to add
  118857. */
  118858. addLight(newLight: Light): void;
  118859. /**
  118860. * Sorts the list list based on light priorities
  118861. */
  118862. sortLightsByPriority(): void;
  118863. /**
  118864. * Adds the given camera to this scene
  118865. * @param newCamera The camera to add
  118866. */
  118867. addCamera(newCamera: Camera): void;
  118868. /**
  118869. * Adds the given skeleton to this scene
  118870. * @param newSkeleton The skeleton to add
  118871. */
  118872. addSkeleton(newSkeleton: Skeleton): void;
  118873. /**
  118874. * Adds the given particle system to this scene
  118875. * @param newParticleSystem The particle system to add
  118876. */
  118877. addParticleSystem(newParticleSystem: IParticleSystem): void;
  118878. /**
  118879. * Adds the given animation to this scene
  118880. * @param newAnimation The animation to add
  118881. */
  118882. addAnimation(newAnimation: Animation): void;
  118883. /**
  118884. * Adds the given animation group to this scene.
  118885. * @param newAnimationGroup The animation group to add
  118886. */
  118887. addAnimationGroup(newAnimationGroup: AnimationGroup): void;
  118888. /**
  118889. * Adds the given multi-material to this scene
  118890. * @param newMultiMaterial The multi-material to add
  118891. */
  118892. addMultiMaterial(newMultiMaterial: MultiMaterial): void;
  118893. /**
  118894. * Adds the given material to this scene
  118895. * @param newMaterial The material to add
  118896. */
  118897. addMaterial(newMaterial: Material): void;
  118898. /**
  118899. * Adds the given morph target to this scene
  118900. * @param newMorphTargetManager The morph target to add
  118901. */
  118902. addMorphTargetManager(newMorphTargetManager: MorphTargetManager): void;
  118903. /**
  118904. * Adds the given geometry to this scene
  118905. * @param newGeometry The geometry to add
  118906. */
  118907. addGeometry(newGeometry: Geometry): void;
  118908. /**
  118909. * Adds the given action manager to this scene
  118910. * @param newActionManager The action manager to add
  118911. */
  118912. addActionManager(newActionManager: AbstractActionManager): void;
  118913. /**
  118914. * Adds the given texture to this scene.
  118915. * @param newTexture The texture to add
  118916. */
  118917. addTexture(newTexture: BaseTexture): void;
  118918. /**
  118919. * Switch active camera
  118920. * @param newCamera defines the new active camera
  118921. * @param attachControl defines if attachControl must be called for the new active camera (default: true)
  118922. */
  118923. switchActiveCamera(newCamera: Camera, attachControl?: boolean): void;
  118924. /**
  118925. * sets the active camera of the scene using its ID
  118926. * @param id defines the camera's ID
  118927. * @return the new active camera or null if none found.
  118928. */
  118929. setActiveCameraByID(id: string): Nullable<Camera>;
  118930. /**
  118931. * sets the active camera of the scene using its name
  118932. * @param name defines the camera's name
  118933. * @returns the new active camera or null if none found.
  118934. */
  118935. setActiveCameraByName(name: string): Nullable<Camera>;
  118936. /**
  118937. * get an animation group using its name
  118938. * @param name defines the material's name
  118939. * @return the animation group or null if none found.
  118940. */
  118941. getAnimationGroupByName(name: string): Nullable<AnimationGroup>;
  118942. /**
  118943. * Get a material using its unique id
  118944. * @param uniqueId defines the material's unique id
  118945. * @return the material or null if none found.
  118946. */
  118947. getMaterialByUniqueID(uniqueId: number): Nullable<Material>;
  118948. /**
  118949. * get a material using its id
  118950. * @param id defines the material's ID
  118951. * @return the material or null if none found.
  118952. */
  118953. getMaterialByID(id: string): Nullable<Material>;
  118954. /**
  118955. * Gets a the last added material using a given id
  118956. * @param id defines the material's ID
  118957. * @return the last material with the given id or null if none found.
  118958. */
  118959. getLastMaterialByID(id: string): Nullable<Material>;
  118960. /**
  118961. * Gets a material using its name
  118962. * @param name defines the material's name
  118963. * @return the material or null if none found.
  118964. */
  118965. getMaterialByName(name: string): Nullable<Material>;
  118966. /**
  118967. * Get a texture using its unique id
  118968. * @param uniqueId defines the texture's unique id
  118969. * @return the texture or null if none found.
  118970. */
  118971. getTextureByUniqueID(uniqueId: number): Nullable<BaseTexture>;
  118972. /**
  118973. * Gets a camera using its id
  118974. * @param id defines the id to look for
  118975. * @returns the camera or null if not found
  118976. */
  118977. getCameraByID(id: string): Nullable<Camera>;
  118978. /**
  118979. * Gets a camera using its unique id
  118980. * @param uniqueId defines the unique id to look for
  118981. * @returns the camera or null if not found
  118982. */
  118983. getCameraByUniqueID(uniqueId: number): Nullable<Camera>;
  118984. /**
  118985. * Gets a camera using its name
  118986. * @param name defines the camera's name
  118987. * @return the camera or null if none found.
  118988. */
  118989. getCameraByName(name: string): Nullable<Camera>;
  118990. /**
  118991. * Gets a bone using its id
  118992. * @param id defines the bone's id
  118993. * @return the bone or null if not found
  118994. */
  118995. getBoneByID(id: string): Nullable<Bone>;
  118996. /**
  118997. * Gets a bone using its id
  118998. * @param name defines the bone's name
  118999. * @return the bone or null if not found
  119000. */
  119001. getBoneByName(name: string): Nullable<Bone>;
  119002. /**
  119003. * Gets a light node using its name
  119004. * @param name defines the the light's name
  119005. * @return the light or null if none found.
  119006. */
  119007. getLightByName(name: string): Nullable<Light>;
  119008. /**
  119009. * Gets a light node using its id
  119010. * @param id defines the light's id
  119011. * @return the light or null if none found.
  119012. */
  119013. getLightByID(id: string): Nullable<Light>;
  119014. /**
  119015. * Gets a light node using its scene-generated unique ID
  119016. * @param uniqueId defines the light's unique id
  119017. * @return the light or null if none found.
  119018. */
  119019. getLightByUniqueID(uniqueId: number): Nullable<Light>;
  119020. /**
  119021. * Gets a particle system by id
  119022. * @param id defines the particle system id
  119023. * @return the corresponding system or null if none found
  119024. */
  119025. getParticleSystemByID(id: string): Nullable<IParticleSystem>;
  119026. /**
  119027. * Gets a geometry using its ID
  119028. * @param id defines the geometry's id
  119029. * @return the geometry or null if none found.
  119030. */
  119031. getGeometryByID(id: string): Nullable<Geometry>;
  119032. private _getGeometryByUniqueID;
  119033. /**
  119034. * Add a new geometry to this scene
  119035. * @param geometry defines the geometry to be added to the scene.
  119036. * @param force defines if the geometry must be pushed even if a geometry with this id already exists
  119037. * @return a boolean defining if the geometry was added or not
  119038. */
  119039. pushGeometry(geometry: Geometry, force?: boolean): boolean;
  119040. /**
  119041. * Removes an existing geometry
  119042. * @param geometry defines the geometry to be removed from the scene
  119043. * @return a boolean defining if the geometry was removed or not
  119044. */
  119045. removeGeometry(geometry: Geometry): boolean;
  119046. /**
  119047. * Gets the list of geometries attached to the scene
  119048. * @returns an array of Geometry
  119049. */
  119050. getGeometries(): Geometry[];
  119051. /**
  119052. * Gets the first added mesh found of a given ID
  119053. * @param id defines the id to search for
  119054. * @return the mesh found or null if not found at all
  119055. */
  119056. getMeshByID(id: string): Nullable<AbstractMesh>;
  119057. /**
  119058. * Gets a list of meshes using their id
  119059. * @param id defines the id to search for
  119060. * @returns a list of meshes
  119061. */
  119062. getMeshesByID(id: string): Array<AbstractMesh>;
  119063. /**
  119064. * Gets the first added transform node found of a given ID
  119065. * @param id defines the id to search for
  119066. * @return the found transform node or null if not found at all.
  119067. */
  119068. getTransformNodeByID(id: string): Nullable<TransformNode>;
  119069. /**
  119070. * Gets a transform node with its auto-generated unique id
  119071. * @param uniqueId efines the unique id to search for
  119072. * @return the found transform node or null if not found at all.
  119073. */
  119074. getTransformNodeByUniqueID(uniqueId: number): Nullable<TransformNode>;
  119075. /**
  119076. * Gets a list of transform nodes using their id
  119077. * @param id defines the id to search for
  119078. * @returns a list of transform nodes
  119079. */
  119080. getTransformNodesByID(id: string): Array<TransformNode>;
  119081. /**
  119082. * Gets a mesh with its auto-generated unique id
  119083. * @param uniqueId defines the unique id to search for
  119084. * @return the found mesh or null if not found at all.
  119085. */
  119086. getMeshByUniqueID(uniqueId: number): Nullable<AbstractMesh>;
  119087. /**
  119088. * Gets a the last added mesh using a given id
  119089. * @param id defines the id to search for
  119090. * @return the found mesh or null if not found at all.
  119091. */
  119092. getLastMeshByID(id: string): Nullable<AbstractMesh>;
  119093. /**
  119094. * Gets a the last added node (Mesh, Camera, Light) using a given id
  119095. * @param id defines the id to search for
  119096. * @return the found node or null if not found at all
  119097. */
  119098. getLastEntryByID(id: string): Nullable<Node>;
  119099. /**
  119100. * Gets a node (Mesh, Camera, Light) using a given id
  119101. * @param id defines the id to search for
  119102. * @return the found node or null if not found at all
  119103. */
  119104. getNodeByID(id: string): Nullable<Node>;
  119105. /**
  119106. * Gets a node (Mesh, Camera, Light) using a given name
  119107. * @param name defines the name to search for
  119108. * @return the found node or null if not found at all.
  119109. */
  119110. getNodeByName(name: string): Nullable<Node>;
  119111. /**
  119112. * Gets a mesh using a given name
  119113. * @param name defines the name to search for
  119114. * @return the found mesh or null if not found at all.
  119115. */
  119116. getMeshByName(name: string): Nullable<AbstractMesh>;
  119117. /**
  119118. * Gets a transform node using a given name
  119119. * @param name defines the name to search for
  119120. * @return the found transform node or null if not found at all.
  119121. */
  119122. getTransformNodeByName(name: string): Nullable<TransformNode>;
  119123. /**
  119124. * Gets a skeleton using a given id (if many are found, this function will pick the last one)
  119125. * @param id defines the id to search for
  119126. * @return the found skeleton or null if not found at all.
  119127. */
  119128. getLastSkeletonByID(id: string): Nullable<Skeleton>;
  119129. /**
  119130. * Gets a skeleton using a given auto generated unique id
  119131. * @param uniqueId defines the unique id to search for
  119132. * @return the found skeleton or null if not found at all.
  119133. */
  119134. getSkeletonByUniqueId(uniqueId: number): Nullable<Skeleton>;
  119135. /**
  119136. * Gets a skeleton using a given id (if many are found, this function will pick the first one)
  119137. * @param id defines the id to search for
  119138. * @return the found skeleton or null if not found at all.
  119139. */
  119140. getSkeletonById(id: string): Nullable<Skeleton>;
  119141. /**
  119142. * Gets a skeleton using a given name
  119143. * @param name defines the name to search for
  119144. * @return the found skeleton or null if not found at all.
  119145. */
  119146. getSkeletonByName(name: string): Nullable<Skeleton>;
  119147. /**
  119148. * Gets a morph target manager using a given id (if many are found, this function will pick the last one)
  119149. * @param id defines the id to search for
  119150. * @return the found morph target manager or null if not found at all.
  119151. */
  119152. getMorphTargetManagerById(id: number): Nullable<MorphTargetManager>;
  119153. /**
  119154. * Gets a morph target using a given id (if many are found, this function will pick the first one)
  119155. * @param id defines the id to search for
  119156. * @return the found morph target or null if not found at all.
  119157. */
  119158. getMorphTargetById(id: string): Nullable<MorphTarget>;
  119159. /**
  119160. * Gets a morph target using a given name (if many are found, this function will pick the first one)
  119161. * @param name defines the name to search for
  119162. * @return the found morph target or null if not found at all.
  119163. */
  119164. getMorphTargetByName(name: string): Nullable<MorphTarget>;
  119165. /**
  119166. * Gets a boolean indicating if the given mesh is active
  119167. * @param mesh defines the mesh to look for
  119168. * @returns true if the mesh is in the active list
  119169. */
  119170. isActiveMesh(mesh: AbstractMesh): boolean;
  119171. /**
  119172. * Return a unique id as a string which can serve as an identifier for the scene
  119173. */
  119174. get uid(): string;
  119175. /**
  119176. * Add an externaly attached data from its key.
  119177. * This method call will fail and return false, if such key already exists.
  119178. * If you don't care and just want to get the data no matter what, use the more convenient getOrAddExternalDataWithFactory() method.
  119179. * @param key the unique key that identifies the data
  119180. * @param data the data object to associate to the key for this Engine instance
  119181. * @return true if no such key were already present and the data was added successfully, false otherwise
  119182. */
  119183. addExternalData<T>(key: string, data: T): boolean;
  119184. /**
  119185. * Get an externaly attached data from its key
  119186. * @param key the unique key that identifies the data
  119187. * @return the associated data, if present (can be null), or undefined if not present
  119188. */
  119189. getExternalData<T>(key: string): Nullable<T>;
  119190. /**
  119191. * Get an externaly attached data from its key, create it using a factory if it's not already present
  119192. * @param key the unique key that identifies the data
  119193. * @param factory the factory that will be called to create the instance if and only if it doesn't exists
  119194. * @return the associated data, can be null if the factory returned null.
  119195. */
  119196. getOrAddExternalDataWithFactory<T>(key: string, factory: (k: string) => T): T;
  119197. /**
  119198. * Remove an externaly attached data from the Engine instance
  119199. * @param key the unique key that identifies the data
  119200. * @return true if the data was successfully removed, false if it doesn't exist
  119201. */
  119202. removeExternalData(key: string): boolean;
  119203. private _evaluateSubMesh;
  119204. /**
  119205. * Clear the processed materials smart array preventing retention point in material dispose.
  119206. */
  119207. freeProcessedMaterials(): void;
  119208. private _preventFreeActiveMeshesAndRenderingGroups;
  119209. /** Gets or sets a boolean blocking all the calls to freeActiveMeshes and freeRenderingGroups
  119210. * It can be used in order to prevent going through methods freeRenderingGroups and freeActiveMeshes several times to improve performance
  119211. * when disposing several meshes in a row or a hierarchy of meshes.
  119212. * When used, it is the responsability of the user to blockfreeActiveMeshesAndRenderingGroups back to false.
  119213. */
  119214. get blockfreeActiveMeshesAndRenderingGroups(): boolean;
  119215. set blockfreeActiveMeshesAndRenderingGroups(value: boolean);
  119216. /**
  119217. * Clear the active meshes smart array preventing retention point in mesh dispose.
  119218. */
  119219. freeActiveMeshes(): void;
  119220. /**
  119221. * Clear the info related to rendering groups preventing retention points during dispose.
  119222. */
  119223. freeRenderingGroups(): void;
  119224. /** @hidden */
  119225. _isInIntermediateRendering(): boolean;
  119226. /**
  119227. * Lambda returning the list of potentially active meshes.
  119228. */
  119229. getActiveMeshCandidates: () => ISmartArrayLike<AbstractMesh>;
  119230. /**
  119231. * Lambda returning the list of potentially active sub meshes.
  119232. */
  119233. getActiveSubMeshCandidates: (mesh: AbstractMesh) => ISmartArrayLike<SubMesh>;
  119234. /**
  119235. * Lambda returning the list of potentially intersecting sub meshes.
  119236. */
  119237. getIntersectingSubMeshCandidates: (mesh: AbstractMesh, localRay: Ray) => ISmartArrayLike<SubMesh>;
  119238. /**
  119239. * Lambda returning the list of potentially colliding sub meshes.
  119240. */
  119241. getCollidingSubMeshCandidates: (mesh: AbstractMesh, collider: Collider) => ISmartArrayLike<SubMesh>;
  119242. private _activeMeshesFrozen;
  119243. private _skipEvaluateActiveMeshesCompletely;
  119244. /**
  119245. * Use this function to stop evaluating active meshes. The current list will be keep alive between frames
  119246. * @param skipEvaluateActiveMeshes defines an optional boolean indicating that the evaluate active meshes step must be completely skipped
  119247. * @returns the current scene
  119248. */
  119249. freezeActiveMeshes(skipEvaluateActiveMeshes?: boolean): Scene;
  119250. /**
  119251. * Use this function to restart evaluating active meshes on every frame
  119252. * @returns the current scene
  119253. */
  119254. unfreezeActiveMeshes(): Scene;
  119255. private _evaluateActiveMeshes;
  119256. private _activeMesh;
  119257. /**
  119258. * Update the transform matrix to update from the current active camera
  119259. * @param force defines a boolean used to force the update even if cache is up to date
  119260. */
  119261. updateTransformMatrix(force?: boolean): void;
  119262. private _bindFrameBuffer;
  119263. /** @hidden */
  119264. _allowPostProcessClearColor: boolean;
  119265. /** @hidden */
  119266. _renderForCamera(camera: Camera, rigParent?: Camera): void;
  119267. private _processSubCameras;
  119268. private _checkIntersections;
  119269. /** @hidden */
  119270. _advancePhysicsEngineStep(step: number): void;
  119271. /**
  119272. * User updatable function that will return a deterministic frame time when engine is in deterministic lock step mode
  119273. */
  119274. getDeterministicFrameTime: () => number;
  119275. /** @hidden */
  119276. _animate(): void;
  119277. /** Execute all animations (for a frame) */
  119278. animate(): void;
  119279. /**
  119280. * Render the scene
  119281. * @param updateCameras defines a boolean indicating if cameras must update according to their inputs (true by default)
  119282. * @param ignoreAnimations defines a boolean indicating if animations should not be executed (false by default)
  119283. */
  119284. render(updateCameras?: boolean, ignoreAnimations?: boolean): void;
  119285. /**
  119286. * Freeze all materials
  119287. * A frozen material will not be updatable but should be faster to render
  119288. */
  119289. freezeMaterials(): void;
  119290. /**
  119291. * Unfreeze all materials
  119292. * A frozen material will not be updatable but should be faster to render
  119293. */
  119294. unfreezeMaterials(): void;
  119295. /**
  119296. * Releases all held ressources
  119297. */
  119298. dispose(): void;
  119299. /**
  119300. * Gets if the scene is already disposed
  119301. */
  119302. get isDisposed(): boolean;
  119303. /**
  119304. * Call this function to reduce memory footprint of the scene.
  119305. * Vertex buffers will not store CPU data anymore (this will prevent picking, collisions or physics to work correctly)
  119306. */
  119307. clearCachedVertexData(): void;
  119308. /**
  119309. * This function will remove the local cached buffer data from texture.
  119310. * It will save memory but will prevent the texture from being rebuilt
  119311. */
  119312. cleanCachedTextureBuffer(): void;
  119313. /**
  119314. * Get the world extend vectors with an optional filter
  119315. *
  119316. * @param filterPredicate the predicate - which meshes should be included when calculating the world size
  119317. * @returns {{ min: Vector3; max: Vector3 }} min and max vectors
  119318. */
  119319. getWorldExtends(filterPredicate?: (mesh: AbstractMesh) => boolean): {
  119320. min: Vector3;
  119321. max: Vector3;
  119322. };
  119323. /**
  119324. * Creates a ray that can be used to pick in the scene
  119325. * @param x defines the x coordinate of the origin (on-screen)
  119326. * @param y defines the y coordinate of the origin (on-screen)
  119327. * @param world defines the world matrix to use if you want to pick in object space (instead of world space)
  119328. * @param camera defines the camera to use for the picking
  119329. * @param cameraViewSpace defines if picking will be done in view space (false by default)
  119330. * @returns a Ray
  119331. */
  119332. createPickingRay(x: number, y: number, world: Matrix, camera: Nullable<Camera>, cameraViewSpace?: boolean): Ray;
  119333. /**
  119334. * Creates a ray that can be used to pick in the scene
  119335. * @param x defines the x coordinate of the origin (on-screen)
  119336. * @param y defines the y coordinate of the origin (on-screen)
  119337. * @param world defines the world matrix to use if you want to pick in object space (instead of world space)
  119338. * @param result defines the ray where to store the picking ray
  119339. * @param camera defines the camera to use for the picking
  119340. * @param cameraViewSpace defines if picking will be done in view space (false by default)
  119341. * @returns the current scene
  119342. */
  119343. createPickingRayToRef(x: number, y: number, world: Matrix, result: Ray, camera: Nullable<Camera>, cameraViewSpace?: boolean): Scene;
  119344. /**
  119345. * Creates a ray that can be used to pick in the scene
  119346. * @param x defines the x coordinate of the origin (on-screen)
  119347. * @param y defines the y coordinate of the origin (on-screen)
  119348. * @param camera defines the camera to use for the picking
  119349. * @returns a Ray
  119350. */
  119351. createPickingRayInCameraSpace(x: number, y: number, camera?: Camera): Ray;
  119352. /**
  119353. * Creates a ray that can be used to pick in the scene
  119354. * @param x defines the x coordinate of the origin (on-screen)
  119355. * @param y defines the y coordinate of the origin (on-screen)
  119356. * @param result defines the ray where to store the picking ray
  119357. * @param camera defines the camera to use for the picking
  119358. * @returns the current scene
  119359. */
  119360. createPickingRayInCameraSpaceToRef(x: number, y: number, result: Ray, camera?: Camera): Scene;
  119361. /** Launch a ray to try to pick a mesh in the scene
  119362. * @param x position on screen
  119363. * @param y position on screen
  119364. * @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
  119365. * @param fastCheck defines if the first intersection will be used (and not the closest)
  119366. * @param camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  119367. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  119368. * @returns a PickingInfo
  119369. */
  119370. pick(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, camera?: Nullable<Camera>, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  119371. /** Launch a ray to try to pick a mesh in the scene using only bounding information of the main mesh (not using submeshes)
  119372. * @param x position on screen
  119373. * @param y position on screen
  119374. * @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
  119375. * @param fastCheck defines if the first intersection will be used (and not the closest)
  119376. * @param camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  119377. * @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)
  119378. */
  119379. pickWithBoundingInfo(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, camera?: Nullable<Camera>): Nullable<PickingInfo>;
  119380. /** Use the given ray to pick a mesh in the scene
  119381. * @param ray The ray to use to pick meshes
  119382. * @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
  119383. * @param fastCheck defines if the first intersection will be used (and not the closest)
  119384. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  119385. * @returns a PickingInfo
  119386. */
  119387. pickWithRay(ray: Ray, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  119388. /**
  119389. * Launch a ray to try to pick a mesh in the scene
  119390. * @param x X position on screen
  119391. * @param y Y position on screen
  119392. * @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
  119393. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  119394. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  119395. * @returns an array of PickingInfo
  119396. */
  119397. multiPick(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, camera?: Camera, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  119398. /**
  119399. * Launch a ray to try to pick a mesh in the scene
  119400. * @param ray Ray to use
  119401. * @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
  119402. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  119403. * @returns an array of PickingInfo
  119404. */
  119405. multiPickWithRay(ray: Ray, predicate: (mesh: AbstractMesh) => boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  119406. /**
  119407. * Force the value of meshUnderPointer
  119408. * @param mesh defines the mesh to use
  119409. */
  119410. setPointerOverMesh(mesh: Nullable<AbstractMesh>): void;
  119411. /**
  119412. * Gets the mesh under the pointer
  119413. * @returns a Mesh or null if no mesh is under the pointer
  119414. */
  119415. getPointerOverMesh(): Nullable<AbstractMesh>;
  119416. /** @hidden */
  119417. _rebuildGeometries(): void;
  119418. /** @hidden */
  119419. _rebuildTextures(): void;
  119420. private _getByTags;
  119421. /**
  119422. * Get a list of meshes by tags
  119423. * @param tagsQuery defines the tags query to use
  119424. * @param forEach defines a predicate used to filter results
  119425. * @returns an array of Mesh
  119426. */
  119427. getMeshesByTags(tagsQuery: string, forEach?: (mesh: AbstractMesh) => void): Mesh[];
  119428. /**
  119429. * Get a list of cameras by tags
  119430. * @param tagsQuery defines the tags query to use
  119431. * @param forEach defines a predicate used to filter results
  119432. * @returns an array of Camera
  119433. */
  119434. getCamerasByTags(tagsQuery: string, forEach?: (camera: Camera) => void): Camera[];
  119435. /**
  119436. * Get a list of lights by tags
  119437. * @param tagsQuery defines the tags query to use
  119438. * @param forEach defines a predicate used to filter results
  119439. * @returns an array of Light
  119440. */
  119441. getLightsByTags(tagsQuery: string, forEach?: (light: Light) => void): Light[];
  119442. /**
  119443. * Get a list of materials by tags
  119444. * @param tagsQuery defines the tags query to use
  119445. * @param forEach defines a predicate used to filter results
  119446. * @returns an array of Material
  119447. */
  119448. getMaterialByTags(tagsQuery: string, forEach?: (material: Material) => void): Material[];
  119449. /**
  119450. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  119451. * This allowed control for front to back rendering or reversly depending of the special needs.
  119452. *
  119453. * @param renderingGroupId The rendering group id corresponding to its index
  119454. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  119455. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  119456. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  119457. */
  119458. 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;
  119459. /**
  119460. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  119461. *
  119462. * @param renderingGroupId The rendering group id corresponding to its index
  119463. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  119464. * @param depth Automatically clears depth between groups if true and autoClear is true.
  119465. * @param stencil Automatically clears stencil between groups if true and autoClear is true.
  119466. */
  119467. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean, depth?: boolean, stencil?: boolean): void;
  119468. /**
  119469. * Gets the current auto clear configuration for one rendering group of the rendering
  119470. * manager.
  119471. * @param index the rendering group index to get the information for
  119472. * @returns The auto clear setup for the requested rendering group
  119473. */
  119474. getAutoClearDepthStencilSetup(index: number): IRenderingManagerAutoClearSetup;
  119475. private _blockMaterialDirtyMechanism;
  119476. /** Gets or sets a boolean blocking all the calls to markAllMaterialsAsDirty (ie. the materials won't be updated if they are out of sync) */
  119477. get blockMaterialDirtyMechanism(): boolean;
  119478. set blockMaterialDirtyMechanism(value: boolean);
  119479. /**
  119480. * Will flag all materials as dirty to trigger new shader compilation
  119481. * @param flag defines the flag used to specify which material part must be marked as dirty
  119482. * @param predicate If not null, it will be used to specifiy if a material has to be marked as dirty
  119483. */
  119484. markAllMaterialsAsDirty(flag: number, predicate?: (mat: Material) => boolean): void;
  119485. /** @hidden */
  119486. _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;
  119487. /** @hidden */
  119488. _loadFileAsync(url: string, onProgress?: (data: any) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  119489. /** @hidden */
  119490. _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;
  119491. /** @hidden */
  119492. _requestFileAsync(url: string, onProgress?: (ev: ProgressEvent) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean, onOpened?: (request: WebRequest) => void): Promise<string | ArrayBuffer>;
  119493. /** @hidden */
  119494. _readFile(file: File, onSuccess: (data: string | ArrayBuffer) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  119495. /** @hidden */
  119496. _readFileAsync(file: File, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  119497. }
  119498. }
  119499. declare module BABYLON {
  119500. /**
  119501. * Set of assets to keep when moving a scene into an asset container.
  119502. */
  119503. export class KeepAssets extends AbstractScene {
  119504. }
  119505. /**
  119506. * Class used to store the output of the AssetContainer.instantiateAllMeshesToScene function
  119507. */
  119508. export class InstantiatedEntries {
  119509. /**
  119510. * List of new root nodes (eg. nodes with no parent)
  119511. */
  119512. rootNodes: TransformNode[];
  119513. /**
  119514. * List of new skeletons
  119515. */
  119516. skeletons: Skeleton[];
  119517. /**
  119518. * List of new animation groups
  119519. */
  119520. animationGroups: AnimationGroup[];
  119521. }
  119522. /**
  119523. * Container with a set of assets that can be added or removed from a scene.
  119524. */
  119525. export class AssetContainer extends AbstractScene {
  119526. private _wasAddedToScene;
  119527. /**
  119528. * The scene the AssetContainer belongs to.
  119529. */
  119530. scene: Scene;
  119531. /**
  119532. * Instantiates an AssetContainer.
  119533. * @param scene The scene the AssetContainer belongs to.
  119534. */
  119535. constructor(scene: Scene);
  119536. /**
  119537. * Instantiate or clone all meshes and add the new ones to the scene.
  119538. * Skeletons and animation groups will all be cloned
  119539. * @param nameFunction defines an optional function used to get new names for clones
  119540. * @param cloneMaterials defines an optional boolean that defines if materials must be cloned as well (false by default)
  119541. * @returns a list of rootNodes, skeletons and aniamtion groups that were duplicated
  119542. */
  119543. instantiateModelsToScene(nameFunction?: (sourceName: string) => string, cloneMaterials?: boolean): InstantiatedEntries;
  119544. /**
  119545. * Adds all the assets from the container to the scene.
  119546. */
  119547. addAllToScene(): void;
  119548. /**
  119549. * Removes all the assets in the container from the scene
  119550. */
  119551. removeAllFromScene(): void;
  119552. /**
  119553. * Disposes all the assets in the container
  119554. */
  119555. dispose(): void;
  119556. private _moveAssets;
  119557. /**
  119558. * Removes all the assets contained in the scene and adds them to the container.
  119559. * @param keepAssets Set of assets to keep in the scene. (default: empty)
  119560. */
  119561. moveAllFromScene(keepAssets?: KeepAssets): void;
  119562. /**
  119563. * 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.
  119564. * @returns the root mesh
  119565. */
  119566. createRootMesh(): Mesh;
  119567. /**
  119568. * Merge animations (direct and animation groups) from this asset container into a scene
  119569. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  119570. * @param animatables set of animatables to retarget to a node from the scene
  119571. * @param targetConverter defines a function used to convert animation targets from the asset container to the scene (default: search node by name)
  119572. * @returns an array of the new AnimationGroup added to the scene (empty array if none)
  119573. */
  119574. mergeAnimationsTo(scene: Scene | null | undefined, animatables: Animatable[], targetConverter?: Nullable<(target: any) => Nullable<Node>>): AnimationGroup[];
  119575. }
  119576. }
  119577. declare module BABYLON {
  119578. /**
  119579. * Defines how the parser contract is defined.
  119580. * These parsers are used to parse a list of specific assets (like particle systems, etc..)
  119581. */
  119582. export type BabylonFileParser = (parsedData: any, scene: Scene, container: AssetContainer, rootUrl: string) => void;
  119583. /**
  119584. * Defines how the individual parser contract is defined.
  119585. * These parser can parse an individual asset
  119586. */
  119587. export type IndividualBabylonFileParser = (parsedData: any, scene: Scene, rootUrl: string) => any;
  119588. /**
  119589. * Base class of the scene acting as a container for the different elements composing a scene.
  119590. * This class is dynamically extended by the different components of the scene increasing
  119591. * flexibility and reducing coupling
  119592. */
  119593. export abstract class AbstractScene {
  119594. /**
  119595. * Stores the list of available parsers in the application.
  119596. */
  119597. private static _BabylonFileParsers;
  119598. /**
  119599. * Stores the list of available individual parsers in the application.
  119600. */
  119601. private static _IndividualBabylonFileParsers;
  119602. /**
  119603. * Adds a parser in the list of available ones
  119604. * @param name Defines the name of the parser
  119605. * @param parser Defines the parser to add
  119606. */
  119607. static AddParser(name: string, parser: BabylonFileParser): void;
  119608. /**
  119609. * Gets a general parser from the list of avaialble ones
  119610. * @param name Defines the name of the parser
  119611. * @returns the requested parser or null
  119612. */
  119613. static GetParser(name: string): Nullable<BabylonFileParser>;
  119614. /**
  119615. * Adds n individual parser in the list of available ones
  119616. * @param name Defines the name of the parser
  119617. * @param parser Defines the parser to add
  119618. */
  119619. static AddIndividualParser(name: string, parser: IndividualBabylonFileParser): void;
  119620. /**
  119621. * Gets an individual parser from the list of avaialble ones
  119622. * @param name Defines the name of the parser
  119623. * @returns the requested parser or null
  119624. */
  119625. static GetIndividualParser(name: string): Nullable<IndividualBabylonFileParser>;
  119626. /**
  119627. * Parser json data and populate both a scene and its associated container object
  119628. * @param jsonData Defines the data to parse
  119629. * @param scene Defines the scene to parse the data for
  119630. * @param container Defines the container attached to the parsing sequence
  119631. * @param rootUrl Defines the root url of the data
  119632. */
  119633. static Parse(jsonData: any, scene: Scene, container: AssetContainer, rootUrl: string): void;
  119634. /**
  119635. * Gets the list of root nodes (ie. nodes with no parent)
  119636. */
  119637. rootNodes: Node[];
  119638. /** All of the cameras added to this scene
  119639. * @see https://doc.babylonjs.com/babylon101/cameras
  119640. */
  119641. cameras: Camera[];
  119642. /**
  119643. * All of the lights added to this scene
  119644. * @see https://doc.babylonjs.com/babylon101/lights
  119645. */
  119646. lights: Light[];
  119647. /**
  119648. * All of the (abstract) meshes added to this scene
  119649. */
  119650. meshes: AbstractMesh[];
  119651. /**
  119652. * The list of skeletons added to the scene
  119653. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  119654. */
  119655. skeletons: Skeleton[];
  119656. /**
  119657. * All of the particle systems added to this scene
  119658. * @see https://doc.babylonjs.com/babylon101/particles
  119659. */
  119660. particleSystems: IParticleSystem[];
  119661. /**
  119662. * Gets a list of Animations associated with the scene
  119663. */
  119664. animations: Animation[];
  119665. /**
  119666. * All of the animation groups added to this scene
  119667. * @see https://doc.babylonjs.com/how_to/group
  119668. */
  119669. animationGroups: AnimationGroup[];
  119670. /**
  119671. * All of the multi-materials added to this scene
  119672. * @see https://doc.babylonjs.com/how_to/multi_materials
  119673. */
  119674. multiMaterials: MultiMaterial[];
  119675. /**
  119676. * All of the materials added to this scene
  119677. * In the context of a Scene, it is not supposed to be modified manually.
  119678. * Any addition or removal should be done using the addMaterial and removeMaterial Scene methods.
  119679. * Note also that the order of the Material within the array is not significant and might change.
  119680. * @see https://doc.babylonjs.com/babylon101/materials
  119681. */
  119682. materials: Material[];
  119683. /**
  119684. * The list of morph target managers added to the scene
  119685. * @see https://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh
  119686. */
  119687. morphTargetManagers: MorphTargetManager[];
  119688. /**
  119689. * The list of geometries used in the scene.
  119690. */
  119691. geometries: Geometry[];
  119692. /**
  119693. * All of the tranform nodes added to this scene
  119694. * In the context of a Scene, it is not supposed to be modified manually.
  119695. * Any addition or removal should be done using the addTransformNode and removeTransformNode Scene methods.
  119696. * Note also that the order of the TransformNode wihin the array is not significant and might change.
  119697. * @see https://doc.babylonjs.com/how_to/transformnode
  119698. */
  119699. transformNodes: TransformNode[];
  119700. /**
  119701. * ActionManagers available on the scene.
  119702. */
  119703. actionManagers: AbstractActionManager[];
  119704. /**
  119705. * Textures to keep.
  119706. */
  119707. textures: BaseTexture[];
  119708. /**
  119709. * Environment texture for the scene
  119710. */
  119711. environmentTexture: Nullable<BaseTexture>;
  119712. /**
  119713. * @returns all meshes, lights, cameras, transformNodes and bones
  119714. */
  119715. getNodes(): Array<Node>;
  119716. }
  119717. }
  119718. declare module BABYLON {
  119719. /**
  119720. * Interface used to define options for Sound class
  119721. */
  119722. export interface ISoundOptions {
  119723. /**
  119724. * Does the sound autoplay once loaded.
  119725. */
  119726. autoplay?: boolean;
  119727. /**
  119728. * Does the sound loop after it finishes playing once.
  119729. */
  119730. loop?: boolean;
  119731. /**
  119732. * Sound's volume
  119733. */
  119734. volume?: number;
  119735. /**
  119736. * Is it a spatial sound?
  119737. */
  119738. spatialSound?: boolean;
  119739. /**
  119740. * Maximum distance to hear that sound
  119741. */
  119742. maxDistance?: number;
  119743. /**
  119744. * Uses user defined attenuation function
  119745. */
  119746. useCustomAttenuation?: boolean;
  119747. /**
  119748. * Define the roll off factor of spatial sounds.
  119749. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  119750. */
  119751. rolloffFactor?: number;
  119752. /**
  119753. * Define the reference distance the sound should be heard perfectly.
  119754. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  119755. */
  119756. refDistance?: number;
  119757. /**
  119758. * Define the distance attenuation model the sound will follow.
  119759. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  119760. */
  119761. distanceModel?: string;
  119762. /**
  119763. * Defines the playback speed (1 by default)
  119764. */
  119765. playbackRate?: number;
  119766. /**
  119767. * Defines if the sound is from a streaming source
  119768. */
  119769. streaming?: boolean;
  119770. /**
  119771. * Defines an optional length (in seconds) inside the sound file
  119772. */
  119773. length?: number;
  119774. /**
  119775. * Defines an optional offset (in seconds) inside the sound file
  119776. */
  119777. offset?: number;
  119778. /**
  119779. * If true, URLs will not be required to state the audio file codec to use.
  119780. */
  119781. skipCodecCheck?: boolean;
  119782. }
  119783. /**
  119784. * Defines a sound that can be played in the application.
  119785. * The sound can either be an ambient track or a simple sound played in reaction to a user action.
  119786. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  119787. */
  119788. export class Sound {
  119789. /**
  119790. * The name of the sound in the scene.
  119791. */
  119792. name: string;
  119793. /**
  119794. * Does the sound autoplay once loaded.
  119795. */
  119796. autoplay: boolean;
  119797. /**
  119798. * Does the sound loop after it finishes playing once.
  119799. */
  119800. loop: boolean;
  119801. /**
  119802. * Does the sound use a custom attenuation curve to simulate the falloff
  119803. * happening when the source gets further away from the camera.
  119804. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-your-own-custom-attenuation-function
  119805. */
  119806. useCustomAttenuation: boolean;
  119807. /**
  119808. * The sound track id this sound belongs to.
  119809. */
  119810. soundTrackId: number;
  119811. /**
  119812. * Is this sound currently played.
  119813. */
  119814. isPlaying: boolean;
  119815. /**
  119816. * Is this sound currently paused.
  119817. */
  119818. isPaused: boolean;
  119819. /**
  119820. * Does this sound enables spatial sound.
  119821. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  119822. */
  119823. spatialSound: boolean;
  119824. /**
  119825. * Define the reference distance the sound should be heard perfectly.
  119826. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  119827. */
  119828. refDistance: number;
  119829. /**
  119830. * Define the roll off factor of spatial sounds.
  119831. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  119832. */
  119833. rolloffFactor: number;
  119834. /**
  119835. * Define the max distance the sound should be heard (intensity just became 0 at this point).
  119836. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  119837. */
  119838. maxDistance: number;
  119839. /**
  119840. * Define the distance attenuation model the sound will follow.
  119841. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  119842. */
  119843. distanceModel: string;
  119844. /**
  119845. * @hidden
  119846. * Back Compat
  119847. **/
  119848. onended: () => any;
  119849. /**
  119850. * Gets or sets an object used to store user defined information for the sound.
  119851. */
  119852. metadata: any;
  119853. /**
  119854. * Observable event when the current playing sound finishes.
  119855. */
  119856. onEndedObservable: Observable<Sound>;
  119857. private _panningModel;
  119858. private _playbackRate;
  119859. private _streaming;
  119860. private _startTime;
  119861. private _startOffset;
  119862. private _position;
  119863. /** @hidden */
  119864. _positionInEmitterSpace: boolean;
  119865. private _localDirection;
  119866. private _volume;
  119867. private _isReadyToPlay;
  119868. private _isDirectional;
  119869. private _readyToPlayCallback;
  119870. private _audioBuffer;
  119871. private _soundSource;
  119872. private _streamingSource;
  119873. private _soundPanner;
  119874. private _soundGain;
  119875. private _inputAudioNode;
  119876. private _outputAudioNode;
  119877. private _coneInnerAngle;
  119878. private _coneOuterAngle;
  119879. private _coneOuterGain;
  119880. private _scene;
  119881. private _connectedTransformNode;
  119882. private _customAttenuationFunction;
  119883. private _registerFunc;
  119884. private _isOutputConnected;
  119885. private _htmlAudioElement;
  119886. private _urlType;
  119887. private _length?;
  119888. private _offset?;
  119889. /** @hidden */
  119890. static _SceneComponentInitialization: (scene: Scene) => void;
  119891. /**
  119892. * Create a sound and attach it to a scene
  119893. * @param name Name of your sound
  119894. * @param urlOrArrayBuffer Url to the sound to load async or ArrayBuffer, it also works with MediaStreams
  119895. * @param scene defines the scene the sound belongs to
  119896. * @param readyToPlayCallback Provide a callback function if you'd like to load your code once the sound is ready to be played
  119897. * @param options Objects to provide with the current available options: autoplay, loop, volume, spatialSound, maxDistance, rolloffFactor, refDistance, distanceModel, panningModel, streaming
  119898. */
  119899. constructor(name: string, urlOrArrayBuffer: any, scene: Scene, readyToPlayCallback?: Nullable<() => void>, options?: ISoundOptions);
  119900. /**
  119901. * Release the sound and its associated resources
  119902. */
  119903. dispose(): void;
  119904. /**
  119905. * Gets if the sounds is ready to be played or not.
  119906. * @returns true if ready, otherwise false
  119907. */
  119908. isReady(): boolean;
  119909. private _soundLoaded;
  119910. /**
  119911. * Sets the data of the sound from an audiobuffer
  119912. * @param audioBuffer The audioBuffer containing the data
  119913. */
  119914. setAudioBuffer(audioBuffer: AudioBuffer): void;
  119915. /**
  119916. * Updates the current sounds options such as maxdistance, loop...
  119917. * @param options A JSON object containing values named as the object properties
  119918. */
  119919. updateOptions(options: ISoundOptions): void;
  119920. private _createSpatialParameters;
  119921. private _updateSpatialParameters;
  119922. /**
  119923. * Switch the panning model to HRTF:
  119924. * Renders a stereo output of higher quality than equalpower — it uses a convolution with measured impulse responses from human subjects.
  119925. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  119926. */
  119927. switchPanningModelToHRTF(): void;
  119928. /**
  119929. * Switch the panning model to Equal Power:
  119930. * Represents the equal-power panning algorithm, generally regarded as simple and efficient. equalpower is the default value.
  119931. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  119932. */
  119933. switchPanningModelToEqualPower(): void;
  119934. private _switchPanningModel;
  119935. /**
  119936. * Connect this sound to a sound track audio node like gain...
  119937. * @param soundTrackAudioNode the sound track audio node to connect to
  119938. */
  119939. connectToSoundTrackAudioNode(soundTrackAudioNode: AudioNode): void;
  119940. /**
  119941. * Transform this sound into a directional source
  119942. * @param coneInnerAngle Size of the inner cone in degree
  119943. * @param coneOuterAngle Size of the outer cone in degree
  119944. * @param coneOuterGain Volume of the sound outside the outer cone (between 0.0 and 1.0)
  119945. */
  119946. setDirectionalCone(coneInnerAngle: number, coneOuterAngle: number, coneOuterGain: number): void;
  119947. /**
  119948. * Gets or sets the inner angle for the directional cone.
  119949. */
  119950. get directionalConeInnerAngle(): number;
  119951. /**
  119952. * Gets or sets the inner angle for the directional cone.
  119953. */
  119954. set directionalConeInnerAngle(value: number);
  119955. /**
  119956. * Gets or sets the outer angle for the directional cone.
  119957. */
  119958. get directionalConeOuterAngle(): number;
  119959. /**
  119960. * Gets or sets the outer angle for the directional cone.
  119961. */
  119962. set directionalConeOuterAngle(value: number);
  119963. /**
  119964. * Sets the position of the emitter if spatial sound is enabled
  119965. * @param newPosition Defines the new posisiton
  119966. */
  119967. setPosition(newPosition: Vector3): void;
  119968. /**
  119969. * Sets the local direction of the emitter if spatial sound is enabled
  119970. * @param newLocalDirection Defines the new local direction
  119971. */
  119972. setLocalDirectionToMesh(newLocalDirection: Vector3): void;
  119973. private _updateDirection;
  119974. /** @hidden */
  119975. updateDistanceFromListener(): void;
  119976. /**
  119977. * Sets a new custom attenuation function for the sound.
  119978. * @param callback Defines the function used for the attenuation
  119979. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-your-own-custom-attenuation-function
  119980. */
  119981. setAttenuationFunction(callback: (currentVolume: number, currentDistance: number, maxDistance: number, refDistance: number, rolloffFactor: number) => number): void;
  119982. /**
  119983. * Play the sound
  119984. * @param time (optional) Start the sound after X seconds. Start immediately (0) by default.
  119985. * @param offset (optional) Start the sound at a specific time in seconds
  119986. * @param length (optional) Sound duration (in seconds)
  119987. */
  119988. play(time?: number, offset?: number, length?: number): void;
  119989. private _onended;
  119990. /**
  119991. * Stop the sound
  119992. * @param time (optional) Stop the sound after X seconds. Stop immediately (0) by default.
  119993. */
  119994. stop(time?: number): void;
  119995. /**
  119996. * Put the sound in pause
  119997. */
  119998. pause(): void;
  119999. /**
  120000. * Sets a dedicated volume for this sounds
  120001. * @param newVolume Define the new volume of the sound
  120002. * @param time Define time for gradual change to new volume
  120003. */
  120004. setVolume(newVolume: number, time?: number): void;
  120005. /**
  120006. * Set the sound play back rate
  120007. * @param newPlaybackRate Define the playback rate the sound should be played at
  120008. */
  120009. setPlaybackRate(newPlaybackRate: number): void;
  120010. /**
  120011. * Gets the volume of the sound.
  120012. * @returns the volume of the sound
  120013. */
  120014. getVolume(): number;
  120015. /**
  120016. * Attach the sound to a dedicated mesh
  120017. * @param transformNode The transform node to connect the sound with
  120018. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#attaching-a-sound-to-a-mesh
  120019. */
  120020. attachToMesh(transformNode: TransformNode): void;
  120021. /**
  120022. * Detach the sound from the previously attached mesh
  120023. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#attaching-a-sound-to-a-mesh
  120024. */
  120025. detachFromMesh(): void;
  120026. private _onRegisterAfterWorldMatrixUpdate;
  120027. /**
  120028. * Clone the current sound in the scene.
  120029. * @returns the new sound clone
  120030. */
  120031. clone(): Nullable<Sound>;
  120032. /**
  120033. * Gets the current underlying audio buffer containing the data
  120034. * @returns the audio buffer
  120035. */
  120036. getAudioBuffer(): Nullable<AudioBuffer>;
  120037. /**
  120038. * Gets the WebAudio AudioBufferSourceNode, lets you keep track of and stop instances of this Sound.
  120039. * @returns the source node
  120040. */
  120041. getSoundSource(): Nullable<AudioBufferSourceNode>;
  120042. /**
  120043. * Gets the WebAudio GainNode, gives you precise control over the gain of instances of this Sound.
  120044. * @returns the gain node
  120045. */
  120046. getSoundGain(): Nullable<GainNode>;
  120047. /**
  120048. * Serializes the Sound in a JSON representation
  120049. * @returns the JSON representation of the sound
  120050. */
  120051. serialize(): any;
  120052. /**
  120053. * Parse a JSON representation of a sound to innstantiate in a given scene
  120054. * @param parsedSound Define the JSON representation of the sound (usually coming from the serialize method)
  120055. * @param scene Define the scene the new parsed sound should be created in
  120056. * @param rootUrl Define the rooturl of the load in case we need to fetch relative dependencies
  120057. * @param sourceSound Define a cound place holder if do not need to instantiate a new one
  120058. * @returns the newly parsed sound
  120059. */
  120060. static Parse(parsedSound: any, scene: Scene, rootUrl: string, sourceSound?: Sound): Sound;
  120061. }
  120062. }
  120063. declare module BABYLON {
  120064. /**
  120065. * This defines an action helpful to play a defined sound on a triggered action.
  120066. */
  120067. export class PlaySoundAction extends Action {
  120068. private _sound;
  120069. /**
  120070. * Instantiate the action
  120071. * @param triggerOptions defines the trigger options
  120072. * @param sound defines the sound to play
  120073. * @param condition defines the trigger related conditions
  120074. */
  120075. constructor(triggerOptions: any, sound: Sound, condition?: Condition);
  120076. /** @hidden */
  120077. _prepare(): void;
  120078. /**
  120079. * Execute the action and play the sound.
  120080. */
  120081. execute(): void;
  120082. /**
  120083. * Serializes the actions and its related information.
  120084. * @param parent defines the object to serialize in
  120085. * @returns the serialized object
  120086. */
  120087. serialize(parent: any): any;
  120088. }
  120089. /**
  120090. * This defines an action helpful to stop a defined sound on a triggered action.
  120091. */
  120092. export class StopSoundAction extends Action {
  120093. private _sound;
  120094. /**
  120095. * Instantiate the action
  120096. * @param triggerOptions defines the trigger options
  120097. * @param sound defines the sound to stop
  120098. * @param condition defines the trigger related conditions
  120099. */
  120100. constructor(triggerOptions: any, sound: Sound, condition?: Condition);
  120101. /** @hidden */
  120102. _prepare(): void;
  120103. /**
  120104. * Execute the action and stop the sound.
  120105. */
  120106. execute(): void;
  120107. /**
  120108. * Serializes the actions and its related information.
  120109. * @param parent defines the object to serialize in
  120110. * @returns the serialized object
  120111. */
  120112. serialize(parent: any): any;
  120113. }
  120114. }
  120115. declare module BABYLON {
  120116. /**
  120117. * This defines an action responsible to change the value of a property
  120118. * by interpolating between its current value and the newly set one once triggered.
  120119. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  120120. */
  120121. export class InterpolateValueAction extends Action {
  120122. /**
  120123. * Defines the path of the property where the value should be interpolated
  120124. */
  120125. propertyPath: string;
  120126. /**
  120127. * Defines the target value at the end of the interpolation.
  120128. */
  120129. value: any;
  120130. /**
  120131. * Defines the time it will take for the property to interpolate to the value.
  120132. */
  120133. duration: number;
  120134. /**
  120135. * Defines if the other scene animations should be stopped when the action has been triggered
  120136. */
  120137. stopOtherAnimations?: boolean;
  120138. /**
  120139. * Defines a callback raised once the interpolation animation has been done.
  120140. */
  120141. onInterpolationDone?: () => void;
  120142. /**
  120143. * Observable triggered once the interpolation animation has been done.
  120144. */
  120145. onInterpolationDoneObservable: Observable<InterpolateValueAction>;
  120146. private _target;
  120147. private _effectiveTarget;
  120148. private _property;
  120149. /**
  120150. * Instantiate the action
  120151. * @param triggerOptions defines the trigger options
  120152. * @param target defines the object containing the value to interpolate
  120153. * @param propertyPath defines the path to the property in the target object
  120154. * @param value defines the target value at the end of the interpolation
  120155. * @param duration deines the time it will take for the property to interpolate to the value.
  120156. * @param condition defines the trigger related conditions
  120157. * @param stopOtherAnimations defines if the other scene animations should be stopped when the action has been triggered
  120158. * @param onInterpolationDone defines a callback raised once the interpolation animation has been done
  120159. */
  120160. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, duration?: number, condition?: Condition, stopOtherAnimations?: boolean, onInterpolationDone?: () => void);
  120161. /** @hidden */
  120162. _prepare(): void;
  120163. /**
  120164. * Execute the action starts the value interpolation.
  120165. */
  120166. execute(): void;
  120167. /**
  120168. * Serializes the actions and its related information.
  120169. * @param parent defines the object to serialize in
  120170. * @returns the serialized object
  120171. */
  120172. serialize(parent: any): any;
  120173. }
  120174. }
  120175. declare module BABYLON {
  120176. /**
  120177. * Options allowed during the creation of a sound track.
  120178. */
  120179. export interface ISoundTrackOptions {
  120180. /**
  120181. * The volume the sound track should take during creation
  120182. */
  120183. volume?: number;
  120184. /**
  120185. * Define if the sound track is the main sound track of the scene
  120186. */
  120187. mainTrack?: boolean;
  120188. }
  120189. /**
  120190. * It could be useful to isolate your music & sounds on several tracks to better manage volume on a grouped instance of sounds.
  120191. * It will be also used in a future release to apply effects on a specific track.
  120192. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-sound-tracks
  120193. */
  120194. export class SoundTrack {
  120195. /**
  120196. * The unique identifier of the sound track in the scene.
  120197. */
  120198. id: number;
  120199. /**
  120200. * The list of sounds included in the sound track.
  120201. */
  120202. soundCollection: Array<Sound>;
  120203. private _outputAudioNode;
  120204. private _scene;
  120205. private _connectedAnalyser;
  120206. private _options;
  120207. private _isInitialized;
  120208. /**
  120209. * Creates a new sound track.
  120210. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-sound-tracks
  120211. * @param scene Define the scene the sound track belongs to
  120212. * @param options
  120213. */
  120214. constructor(scene: Scene, options?: ISoundTrackOptions);
  120215. private _initializeSoundTrackAudioGraph;
  120216. /**
  120217. * Release the sound track and its associated resources
  120218. */
  120219. dispose(): void;
  120220. /**
  120221. * Adds a sound to this sound track
  120222. * @param sound define the cound to add
  120223. * @ignoreNaming
  120224. */
  120225. AddSound(sound: Sound): void;
  120226. /**
  120227. * Removes a sound to this sound track
  120228. * @param sound define the cound to remove
  120229. * @ignoreNaming
  120230. */
  120231. RemoveSound(sound: Sound): void;
  120232. /**
  120233. * Set a global volume for the full sound track.
  120234. * @param newVolume Define the new volume of the sound track
  120235. */
  120236. setVolume(newVolume: number): void;
  120237. /**
  120238. * Switch the panning model to HRTF:
  120239. * Renders a stereo output of higher quality than equalpower — it uses a convolution with measured impulse responses from human subjects.
  120240. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  120241. */
  120242. switchPanningModelToHRTF(): void;
  120243. /**
  120244. * Switch the panning model to Equal Power:
  120245. * Represents the equal-power panning algorithm, generally regarded as simple and efficient. equalpower is the default value.
  120246. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  120247. */
  120248. switchPanningModelToEqualPower(): void;
  120249. /**
  120250. * Connect the sound track to an audio analyser allowing some amazing
  120251. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  120252. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  120253. * @param analyser The analyser to connect to the engine
  120254. */
  120255. connectToAnalyser(analyser: Analyser): void;
  120256. }
  120257. }
  120258. declare module BABYLON {
  120259. interface AbstractScene {
  120260. /**
  120261. * The list of sounds used in the scene.
  120262. */
  120263. sounds: Nullable<Array<Sound>>;
  120264. }
  120265. interface Scene {
  120266. /**
  120267. * @hidden
  120268. * Backing field
  120269. */
  120270. _mainSoundTrack: SoundTrack;
  120271. /**
  120272. * The main sound track played by the scene.
  120273. * It cotains your primary collection of sounds.
  120274. */
  120275. mainSoundTrack: SoundTrack;
  120276. /**
  120277. * The list of sound tracks added to the scene
  120278. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  120279. */
  120280. soundTracks: Nullable<Array<SoundTrack>>;
  120281. /**
  120282. * Gets a sound using a given name
  120283. * @param name defines the name to search for
  120284. * @return the found sound or null if not found at all.
  120285. */
  120286. getSoundByName(name: string): Nullable<Sound>;
  120287. /**
  120288. * Gets or sets if audio support is enabled
  120289. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  120290. */
  120291. audioEnabled: boolean;
  120292. /**
  120293. * Gets or sets if audio will be output to headphones
  120294. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  120295. */
  120296. headphone: boolean;
  120297. /**
  120298. * Gets or sets custom audio listener position provider
  120299. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  120300. */
  120301. audioListenerPositionProvider: Nullable<() => Vector3>;
  120302. /**
  120303. * Gets or sets a refresh rate when using 3D audio positioning
  120304. */
  120305. audioPositioningRefreshRate: number;
  120306. }
  120307. /**
  120308. * Defines the sound scene component responsible to manage any sounds
  120309. * in a given scene.
  120310. */
  120311. export class AudioSceneComponent implements ISceneSerializableComponent {
  120312. /**
  120313. * The component name helpfull to identify the component in the list of scene components.
  120314. */
  120315. readonly name: string;
  120316. /**
  120317. * The scene the component belongs to.
  120318. */
  120319. scene: Scene;
  120320. private _audioEnabled;
  120321. /**
  120322. * Gets whether audio is enabled or not.
  120323. * Please use related enable/disable method to switch state.
  120324. */
  120325. get audioEnabled(): boolean;
  120326. private _headphone;
  120327. /**
  120328. * Gets whether audio is outputing to headphone or not.
  120329. * Please use the according Switch methods to change output.
  120330. */
  120331. get headphone(): boolean;
  120332. /**
  120333. * Gets or sets a refresh rate when using 3D audio positioning
  120334. */
  120335. audioPositioningRefreshRate: number;
  120336. private _audioListenerPositionProvider;
  120337. /**
  120338. * Gets the current audio listener position provider
  120339. */
  120340. get audioListenerPositionProvider(): Nullable<() => Vector3>;
  120341. /**
  120342. * Sets a custom listener position for all sounds in the scene
  120343. * By default, this is the position of the first active camera
  120344. */
  120345. set audioListenerPositionProvider(value: Nullable<() => Vector3>);
  120346. /**
  120347. * Creates a new instance of the component for the given scene
  120348. * @param scene Defines the scene to register the component in
  120349. */
  120350. constructor(scene: Scene);
  120351. /**
  120352. * Registers the component in a given scene
  120353. */
  120354. register(): void;
  120355. /**
  120356. * Rebuilds the elements related to this component in case of
  120357. * context lost for instance.
  120358. */
  120359. rebuild(): void;
  120360. /**
  120361. * Serializes the component data to the specified json object
  120362. * @param serializationObject The object to serialize to
  120363. */
  120364. serialize(serializationObject: any): void;
  120365. /**
  120366. * Adds all the elements from the container to the scene
  120367. * @param container the container holding the elements
  120368. */
  120369. addFromContainer(container: AbstractScene): void;
  120370. /**
  120371. * Removes all the elements in the container from the scene
  120372. * @param container contains the elements to remove
  120373. * @param dispose if the removed element should be disposed (default: false)
  120374. */
  120375. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  120376. /**
  120377. * Disposes the component and the associated ressources.
  120378. */
  120379. dispose(): void;
  120380. /**
  120381. * Disables audio in the associated scene.
  120382. */
  120383. disableAudio(): void;
  120384. /**
  120385. * Enables audio in the associated scene.
  120386. */
  120387. enableAudio(): void;
  120388. /**
  120389. * Switch audio to headphone output.
  120390. */
  120391. switchAudioModeForHeadphones(): void;
  120392. /**
  120393. * Switch audio to normal speakers.
  120394. */
  120395. switchAudioModeForNormalSpeakers(): void;
  120396. private _cachedCameraDirection;
  120397. private _cachedCameraPosition;
  120398. private _lastCheck;
  120399. private _afterRender;
  120400. }
  120401. }
  120402. declare module BABYLON {
  120403. /**
  120404. * Wraps one or more Sound objects and selects one with random weight for playback.
  120405. */
  120406. export class WeightedSound {
  120407. /** When true a Sound will be selected and played when the current playing Sound completes. */
  120408. loop: boolean;
  120409. private _coneInnerAngle;
  120410. private _coneOuterAngle;
  120411. private _volume;
  120412. /** A Sound is currently playing. */
  120413. isPlaying: boolean;
  120414. /** A Sound is currently paused. */
  120415. isPaused: boolean;
  120416. private _sounds;
  120417. private _weights;
  120418. private _currentIndex?;
  120419. /**
  120420. * Creates a new WeightedSound from the list of sounds given.
  120421. * @param loop When true a Sound will be selected and played when the current playing Sound completes.
  120422. * @param sounds Array of Sounds that will be selected from.
  120423. * @param weights Array of number values for selection weights; length must equal sounds, values will be normalized to 1
  120424. */
  120425. constructor(loop: boolean, sounds: Sound[], weights: number[]);
  120426. /**
  120427. * The size of cone in degrees for a directional sound in which there will be no attenuation.
  120428. */
  120429. get directionalConeInnerAngle(): number;
  120430. /**
  120431. * The size of cone in degress for a directional sound in which there will be no attenuation.
  120432. */
  120433. set directionalConeInnerAngle(value: number);
  120434. /**
  120435. * Size of cone in degrees for a directional sound outside of which there will be no sound.
  120436. * Listener angles between innerAngle and outerAngle will falloff linearly.
  120437. */
  120438. get directionalConeOuterAngle(): number;
  120439. /**
  120440. * Size of cone in degrees for a directional sound outside of which there will be no sound.
  120441. * Listener angles between innerAngle and outerAngle will falloff linearly.
  120442. */
  120443. set directionalConeOuterAngle(value: number);
  120444. /**
  120445. * Playback volume.
  120446. */
  120447. get volume(): number;
  120448. /**
  120449. * Playback volume.
  120450. */
  120451. set volume(value: number);
  120452. private _onended;
  120453. /**
  120454. * Suspend playback
  120455. */
  120456. pause(): void;
  120457. /**
  120458. * Stop playback
  120459. */
  120460. stop(): void;
  120461. /**
  120462. * Start playback.
  120463. * @param startOffset Position the clip head at a specific time in seconds.
  120464. */
  120465. play(startOffset?: number): void;
  120466. }
  120467. }
  120468. declare module BABYLON {
  120469. /**
  120470. * Add a bouncing effect to an ArcRotateCamera when reaching a specified minimum and maximum radius
  120471. * @see https://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  120472. */
  120473. export class BouncingBehavior implements Behavior<ArcRotateCamera> {
  120474. /**
  120475. * Gets the name of the behavior.
  120476. */
  120477. get name(): string;
  120478. /**
  120479. * The easing function used by animations
  120480. */
  120481. static EasingFunction: BackEase;
  120482. /**
  120483. * The easing mode used by animations
  120484. */
  120485. static EasingMode: number;
  120486. /**
  120487. * The duration of the animation, in milliseconds
  120488. */
  120489. transitionDuration: number;
  120490. /**
  120491. * Length of the distance animated by the transition when lower radius is reached
  120492. */
  120493. lowerRadiusTransitionRange: number;
  120494. /**
  120495. * Length of the distance animated by the transition when upper radius is reached
  120496. */
  120497. upperRadiusTransitionRange: number;
  120498. private _autoTransitionRange;
  120499. /**
  120500. * Gets a value indicating if the lowerRadiusTransitionRange and upperRadiusTransitionRange are defined automatically
  120501. */
  120502. get autoTransitionRange(): boolean;
  120503. /**
  120504. * Sets a value indicating if the lowerRadiusTransitionRange and upperRadiusTransitionRange are defined automatically
  120505. * Transition ranges will be set to 5% of the bounding box diagonal in world space
  120506. */
  120507. set autoTransitionRange(value: boolean);
  120508. private _attachedCamera;
  120509. private _onAfterCheckInputsObserver;
  120510. private _onMeshTargetChangedObserver;
  120511. /**
  120512. * Initializes the behavior.
  120513. */
  120514. init(): void;
  120515. /**
  120516. * Attaches the behavior to its arc rotate camera.
  120517. * @param camera Defines the camera to attach the behavior to
  120518. */
  120519. attach(camera: ArcRotateCamera): void;
  120520. /**
  120521. * Detaches the behavior from its current arc rotate camera.
  120522. */
  120523. detach(): void;
  120524. private _radiusIsAnimating;
  120525. private _radiusBounceTransition;
  120526. private _animatables;
  120527. private _cachedWheelPrecision;
  120528. /**
  120529. * Checks if the camera radius is at the specified limit. Takes into account animation locks.
  120530. * @param radiusLimit The limit to check against.
  120531. * @return Bool to indicate if at limit.
  120532. */
  120533. private _isRadiusAtLimit;
  120534. /**
  120535. * Applies an animation to the radius of the camera, extending by the radiusDelta.
  120536. * @param radiusDelta The delta by which to animate to. Can be negative.
  120537. */
  120538. private _applyBoundRadiusAnimation;
  120539. /**
  120540. * Removes all animation locks. Allows new animations to be added to any of the camera properties.
  120541. */
  120542. protected _clearAnimationLocks(): void;
  120543. /**
  120544. * Stops and removes all animations that have been applied to the camera
  120545. */
  120546. stopAllAnimations(): void;
  120547. }
  120548. }
  120549. declare module BABYLON {
  120550. /**
  120551. * 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.
  120552. * @see https://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  120553. */
  120554. export class FramingBehavior implements Behavior<ArcRotateCamera> {
  120555. /**
  120556. * Gets the name of the behavior.
  120557. */
  120558. get name(): string;
  120559. private _mode;
  120560. private _radiusScale;
  120561. private _positionScale;
  120562. private _defaultElevation;
  120563. private _elevationReturnTime;
  120564. private _elevationReturnWaitTime;
  120565. private _zoomStopsAnimation;
  120566. private _framingTime;
  120567. /**
  120568. * The easing function used by animations
  120569. */
  120570. static EasingFunction: ExponentialEase;
  120571. /**
  120572. * The easing mode used by animations
  120573. */
  120574. static EasingMode: number;
  120575. /**
  120576. * Sets the current mode used by the behavior
  120577. */
  120578. set mode(mode: number);
  120579. /**
  120580. * Gets current mode used by the behavior.
  120581. */
  120582. get mode(): number;
  120583. /**
  120584. * Sets the scale applied to the radius (1 by default)
  120585. */
  120586. set radiusScale(radius: number);
  120587. /**
  120588. * Gets the scale applied to the radius
  120589. */
  120590. get radiusScale(): number;
  120591. /**
  120592. * Sets the scale to apply on Y axis to position camera focus. 0.5 by default which means the center of the bounding box.
  120593. */
  120594. set positionScale(scale: number);
  120595. /**
  120596. * Gets the scale to apply on Y axis to position camera focus. 0.5 by default which means the center of the bounding box.
  120597. */
  120598. get positionScale(): number;
  120599. /**
  120600. * Sets the angle above/below the horizontal plane to return to when the return to default elevation idle
  120601. * behaviour is triggered, in radians.
  120602. */
  120603. set defaultElevation(elevation: number);
  120604. /**
  120605. * Gets the angle above/below the horizontal plane to return to when the return to default elevation idle
  120606. * behaviour is triggered, in radians.
  120607. */
  120608. get defaultElevation(): number;
  120609. /**
  120610. * Sets the time (in milliseconds) taken to return to the default beta position.
  120611. * Negative value indicates camera should not return to default.
  120612. */
  120613. set elevationReturnTime(speed: number);
  120614. /**
  120615. * Gets the time (in milliseconds) taken to return to the default beta position.
  120616. * Negative value indicates camera should not return to default.
  120617. */
  120618. get elevationReturnTime(): number;
  120619. /**
  120620. * Sets the delay (in milliseconds) taken before the camera returns to the default beta position.
  120621. */
  120622. set elevationReturnWaitTime(time: number);
  120623. /**
  120624. * Gets the delay (in milliseconds) taken before the camera returns to the default beta position.
  120625. */
  120626. get elevationReturnWaitTime(): number;
  120627. /**
  120628. * Sets the flag that indicates if user zooming should stop animation.
  120629. */
  120630. set zoomStopsAnimation(flag: boolean);
  120631. /**
  120632. * Gets the flag that indicates if user zooming should stop animation.
  120633. */
  120634. get zoomStopsAnimation(): boolean;
  120635. /**
  120636. * Sets the transition time when framing the mesh, in milliseconds
  120637. */
  120638. set framingTime(time: number);
  120639. /**
  120640. * Gets the transition time when framing the mesh, in milliseconds
  120641. */
  120642. get framingTime(): number;
  120643. /**
  120644. * Define if the behavior should automatically change the configured
  120645. * camera limits and sensibilities.
  120646. */
  120647. autoCorrectCameraLimitsAndSensibility: boolean;
  120648. private _onPrePointerObservableObserver;
  120649. private _onAfterCheckInputsObserver;
  120650. private _onMeshTargetChangedObserver;
  120651. private _attachedCamera;
  120652. private _isPointerDown;
  120653. private _lastInteractionTime;
  120654. /**
  120655. * Initializes the behavior.
  120656. */
  120657. init(): void;
  120658. /**
  120659. * Attaches the behavior to its arc rotate camera.
  120660. * @param camera Defines the camera to attach the behavior to
  120661. */
  120662. attach(camera: ArcRotateCamera): void;
  120663. /**
  120664. * Detaches the behavior from its current arc rotate camera.
  120665. */
  120666. detach(): void;
  120667. private _animatables;
  120668. private _betaIsAnimating;
  120669. private _betaTransition;
  120670. private _radiusTransition;
  120671. private _vectorTransition;
  120672. /**
  120673. * Targets the given mesh and updates zoom level accordingly.
  120674. * @param mesh The mesh to target.
  120675. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  120676. * @param onAnimationEnd Callback triggered at the end of the framing animation
  120677. */
  120678. zoomOnMesh(mesh: AbstractMesh, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  120679. /**
  120680. * Targets the given mesh with its children and updates zoom level accordingly.
  120681. * @param mesh The mesh to target.
  120682. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  120683. * @param onAnimationEnd Callback triggered at the end of the framing animation
  120684. */
  120685. zoomOnMeshHierarchy(mesh: AbstractMesh, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  120686. /**
  120687. * Targets the given meshes with their children and updates zoom level accordingly.
  120688. * @param meshes The mesh to target.
  120689. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  120690. * @param onAnimationEnd Callback triggered at the end of the framing animation
  120691. */
  120692. zoomOnMeshesHierarchy(meshes: AbstractMesh[], focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  120693. /**
  120694. * Targets the bounding box info defined by its extends and updates zoom level accordingly.
  120695. * @param minimumWorld Determines the smaller position of the bounding box extend
  120696. * @param maximumWorld Determines the bigger position of the bounding box extend
  120697. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  120698. * @param onAnimationEnd Callback triggered at the end of the framing animation
  120699. */
  120700. zoomOnBoundingInfo(minimumWorld: Vector3, maximumWorld: Vector3, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  120701. /**
  120702. * Calculates the lowest radius for the camera based on the bounding box of the mesh.
  120703. * @param mesh The mesh on which to base the calculation. mesh boundingInfo used to estimate necessary
  120704. * frustum width.
  120705. * @return The minimum distance from the primary mesh's center point at which the camera must be kept in order
  120706. * to fully enclose the mesh in the viewing frustum.
  120707. */
  120708. protected _calculateLowerRadiusFromModelBoundingSphere(minimumWorld: Vector3, maximumWorld: Vector3): number;
  120709. /**
  120710. * Keeps the camera above the ground plane. If the user pulls the camera below the ground plane, the camera
  120711. * is automatically returned to its default position (expected to be above ground plane).
  120712. */
  120713. private _maintainCameraAboveGround;
  120714. /**
  120715. * Returns the frustum slope based on the canvas ratio and camera FOV
  120716. * @returns The frustum slope represented as a Vector2 with X and Y slopes
  120717. */
  120718. private _getFrustumSlope;
  120719. /**
  120720. * Removes all animation locks. Allows new animations to be added to any of the arcCamera properties.
  120721. */
  120722. private _clearAnimationLocks;
  120723. /**
  120724. * Applies any current user interaction to the camera. Takes into account maximum alpha rotation.
  120725. */
  120726. private _applyUserInteraction;
  120727. /**
  120728. * Stops and removes all animations that have been applied to the camera
  120729. */
  120730. stopAllAnimations(): void;
  120731. /**
  120732. * Gets a value indicating if the user is moving the camera
  120733. */
  120734. get isUserIsMoving(): boolean;
  120735. /**
  120736. * The camera can move all the way towards the mesh.
  120737. */
  120738. static IgnoreBoundsSizeMode: number;
  120739. /**
  120740. * The camera is not allowed to zoom closer to the mesh than the point at which the adjusted bounding sphere touches the frustum sides
  120741. */
  120742. static FitFrustumSidesMode: number;
  120743. }
  120744. }
  120745. declare module BABYLON {
  120746. /**
  120747. * Base class for Camera Pointer Inputs.
  120748. * See FollowCameraPointersInput in src/Cameras/Inputs/followCameraPointersInput.ts
  120749. * for example usage.
  120750. */
  120751. export abstract class BaseCameraPointersInput implements ICameraInput<Camera> {
  120752. /**
  120753. * Defines the camera the input is attached to.
  120754. */
  120755. abstract camera: Camera;
  120756. /**
  120757. * Whether keyboard modifier keys are pressed at time of last mouse event.
  120758. */
  120759. protected _altKey: boolean;
  120760. protected _ctrlKey: boolean;
  120761. protected _metaKey: boolean;
  120762. protected _shiftKey: boolean;
  120763. /**
  120764. * Which mouse buttons were pressed at time of last mouse event.
  120765. * https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/buttons
  120766. */
  120767. protected _buttonsPressed: number;
  120768. /**
  120769. * Defines the buttons associated with the input to handle camera move.
  120770. */
  120771. buttons: number[];
  120772. /**
  120773. * Attach the input controls to a specific dom element to get the input from.
  120774. * @param element Defines the element the controls should be listened from
  120775. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  120776. */
  120777. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  120778. /**
  120779. * Detach the current controls from the specified dom element.
  120780. * @param element Defines the element to stop listening the inputs from
  120781. */
  120782. detachControl(element: Nullable<HTMLElement>): void;
  120783. /**
  120784. * Gets the class name of the current input.
  120785. * @returns the class name
  120786. */
  120787. getClassName(): string;
  120788. /**
  120789. * Get the friendly name associated with the input class.
  120790. * @returns the input friendly name
  120791. */
  120792. getSimpleName(): string;
  120793. /**
  120794. * Called on pointer POINTERDOUBLETAP event.
  120795. * Override this method to provide functionality on POINTERDOUBLETAP event.
  120796. */
  120797. protected onDoubleTap(type: string): void;
  120798. /**
  120799. * Called on pointer POINTERMOVE event if only a single touch is active.
  120800. * Override this method to provide functionality.
  120801. */
  120802. protected onTouch(point: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  120803. /**
  120804. * Called on pointer POINTERMOVE event if multiple touches are active.
  120805. * Override this method to provide functionality.
  120806. */
  120807. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  120808. /**
  120809. * Called on JS contextmenu event.
  120810. * Override this method to provide functionality.
  120811. */
  120812. protected onContextMenu(evt: PointerEvent): void;
  120813. /**
  120814. * Called each time a new POINTERDOWN event occurs. Ie, for each button
  120815. * press.
  120816. * Override this method to provide functionality.
  120817. */
  120818. protected onButtonDown(evt: PointerEvent): void;
  120819. /**
  120820. * Called each time a new POINTERUP event occurs. Ie, for each button
  120821. * release.
  120822. * Override this method to provide functionality.
  120823. */
  120824. protected onButtonUp(evt: PointerEvent): void;
  120825. /**
  120826. * Called when window becomes inactive.
  120827. * Override this method to provide functionality.
  120828. */
  120829. protected onLostFocus(): void;
  120830. private _pointerInput;
  120831. private _observer;
  120832. private _onLostFocus;
  120833. private pointA;
  120834. private pointB;
  120835. }
  120836. }
  120837. declare module BABYLON {
  120838. /**
  120839. * Manage the pointers inputs to control an arc rotate camera.
  120840. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  120841. */
  120842. export class ArcRotateCameraPointersInput extends BaseCameraPointersInput {
  120843. /**
  120844. * Defines the camera the input is attached to.
  120845. */
  120846. camera: ArcRotateCamera;
  120847. /**
  120848. * Gets the class name of the current input.
  120849. * @returns the class name
  120850. */
  120851. getClassName(): string;
  120852. /**
  120853. * Defines the buttons associated with the input to handle camera move.
  120854. */
  120855. buttons: number[];
  120856. /**
  120857. * Defines the pointer angular sensibility along the X axis or how fast is
  120858. * the camera rotating.
  120859. */
  120860. angularSensibilityX: number;
  120861. /**
  120862. * Defines the pointer angular sensibility along the Y axis or how fast is
  120863. * the camera rotating.
  120864. */
  120865. angularSensibilityY: number;
  120866. /**
  120867. * Defines the pointer pinch precision or how fast is the camera zooming.
  120868. */
  120869. pinchPrecision: number;
  120870. /**
  120871. * pinchDeltaPercentage will be used instead of pinchPrecision if different
  120872. * from 0.
  120873. * It defines the percentage of current camera.radius to use as delta when
  120874. * pinch zoom is used.
  120875. */
  120876. pinchDeltaPercentage: number;
  120877. /**
  120878. * When useNaturalPinchZoom is true, multi touch zoom will zoom in such
  120879. * that any object in the plane at the camera's target point will scale
  120880. * perfectly with finger motion.
  120881. * Overrides pinchDeltaPercentage and pinchPrecision.
  120882. */
  120883. useNaturalPinchZoom: boolean;
  120884. /**
  120885. * Defines the pointer panning sensibility or how fast is the camera moving.
  120886. */
  120887. panningSensibility: number;
  120888. /**
  120889. * Defines whether panning (2 fingers swipe) is enabled through multitouch.
  120890. */
  120891. multiTouchPanning: boolean;
  120892. /**
  120893. * Defines whether panning is enabled for both pan (2 fingers swipe) and
  120894. * zoom (pinch) through multitouch.
  120895. */
  120896. multiTouchPanAndZoom: boolean;
  120897. /**
  120898. * Revers pinch action direction.
  120899. */
  120900. pinchInwards: boolean;
  120901. private _isPanClick;
  120902. private _twoFingerActivityCount;
  120903. private _isPinching;
  120904. /**
  120905. * Called on pointer POINTERMOVE event if only a single touch is active.
  120906. */
  120907. protected onTouch(point: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  120908. /**
  120909. * Called on pointer POINTERDOUBLETAP event.
  120910. */
  120911. protected onDoubleTap(type: string): void;
  120912. /**
  120913. * Called on pointer POINTERMOVE event if multiple touches are active.
  120914. */
  120915. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  120916. /**
  120917. * Called each time a new POINTERDOWN event occurs. Ie, for each button
  120918. * press.
  120919. */
  120920. protected onButtonDown(evt: PointerEvent): void;
  120921. /**
  120922. * Called each time a new POINTERUP event occurs. Ie, for each button
  120923. * release.
  120924. */
  120925. protected onButtonUp(evt: PointerEvent): void;
  120926. /**
  120927. * Called when window becomes inactive.
  120928. */
  120929. protected onLostFocus(): void;
  120930. }
  120931. }
  120932. declare module BABYLON {
  120933. /**
  120934. * Manage the keyboard inputs to control the movement of an arc rotate camera.
  120935. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  120936. */
  120937. export class ArcRotateCameraKeyboardMoveInput implements ICameraInput<ArcRotateCamera> {
  120938. /**
  120939. * Defines the camera the input is attached to.
  120940. */
  120941. camera: ArcRotateCamera;
  120942. /**
  120943. * Defines the list of key codes associated with the up action (increase alpha)
  120944. */
  120945. keysUp: number[];
  120946. /**
  120947. * Defines the list of key codes associated with the down action (decrease alpha)
  120948. */
  120949. keysDown: number[];
  120950. /**
  120951. * Defines the list of key codes associated with the left action (increase beta)
  120952. */
  120953. keysLeft: number[];
  120954. /**
  120955. * Defines the list of key codes associated with the right action (decrease beta)
  120956. */
  120957. keysRight: number[];
  120958. /**
  120959. * Defines the list of key codes associated with the reset action.
  120960. * Those keys reset the camera to its last stored state (with the method camera.storeState())
  120961. */
  120962. keysReset: number[];
  120963. /**
  120964. * Defines the panning sensibility of the inputs.
  120965. * (How fast is the camera panning)
  120966. */
  120967. panningSensibility: number;
  120968. /**
  120969. * Defines the zooming sensibility of the inputs.
  120970. * (How fast is the camera zooming)
  120971. */
  120972. zoomingSensibility: number;
  120973. /**
  120974. * Defines whether maintaining the alt key down switch the movement mode from
  120975. * orientation to zoom.
  120976. */
  120977. useAltToZoom: boolean;
  120978. /**
  120979. * Rotation speed of the camera
  120980. */
  120981. angularSpeed: number;
  120982. private _keys;
  120983. private _ctrlPressed;
  120984. private _altPressed;
  120985. private _onCanvasBlurObserver;
  120986. private _onKeyboardObserver;
  120987. private _engine;
  120988. private _scene;
  120989. /**
  120990. * Attach the input controls to a specific dom element to get the input from.
  120991. * @param element Defines the element the controls should be listened from
  120992. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  120993. */
  120994. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  120995. /**
  120996. * Detach the current controls from the specified dom element.
  120997. * @param element Defines the element to stop listening the inputs from
  120998. */
  120999. detachControl(element: Nullable<HTMLElement>): void;
  121000. /**
  121001. * Update the current camera state depending on the inputs that have been used this frame.
  121002. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  121003. */
  121004. checkInputs(): void;
  121005. /**
  121006. * Gets the class name of the current intput.
  121007. * @returns the class name
  121008. */
  121009. getClassName(): string;
  121010. /**
  121011. * Get the friendly name associated with the input class.
  121012. * @returns the input friendly name
  121013. */
  121014. getSimpleName(): string;
  121015. }
  121016. }
  121017. declare module BABYLON {
  121018. /**
  121019. * Manage the mouse wheel inputs to control an arc rotate camera.
  121020. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  121021. */
  121022. export class ArcRotateCameraMouseWheelInput implements ICameraInput<ArcRotateCamera> {
  121023. /**
  121024. * Defines the camera the input is attached to.
  121025. */
  121026. camera: ArcRotateCamera;
  121027. /**
  121028. * Gets or Set the mouse wheel precision or how fast is the camera zooming.
  121029. */
  121030. wheelPrecision: number;
  121031. /**
  121032. * wheelDeltaPercentage will be used instead of wheelPrecision if different from 0.
  121033. * It defines the percentage of current camera.radius to use as delta when wheel is used.
  121034. */
  121035. wheelDeltaPercentage: number;
  121036. private _wheel;
  121037. private _observer;
  121038. private computeDeltaFromMouseWheelLegacyEvent;
  121039. /**
  121040. * Attach the input controls to a specific dom element to get the input from.
  121041. * @param element Defines the element the controls should be listened from
  121042. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  121043. */
  121044. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  121045. /**
  121046. * Detach the current controls from the specified dom element.
  121047. * @param element Defines the element to stop listening the inputs from
  121048. */
  121049. detachControl(element: Nullable<HTMLElement>): void;
  121050. /**
  121051. * Gets the class name of the current intput.
  121052. * @returns the class name
  121053. */
  121054. getClassName(): string;
  121055. /**
  121056. * Get the friendly name associated with the input class.
  121057. * @returns the input friendly name
  121058. */
  121059. getSimpleName(): string;
  121060. }
  121061. }
  121062. declare module BABYLON {
  121063. /**
  121064. * Default Inputs manager for the ArcRotateCamera.
  121065. * It groups all the default supported inputs for ease of use.
  121066. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  121067. */
  121068. export class ArcRotateCameraInputsManager extends CameraInputsManager<ArcRotateCamera> {
  121069. /**
  121070. * Instantiates a new ArcRotateCameraInputsManager.
  121071. * @param camera Defines the camera the inputs belong to
  121072. */
  121073. constructor(camera: ArcRotateCamera);
  121074. /**
  121075. * Add mouse wheel input support to the input manager.
  121076. * @returns the current input manager
  121077. */
  121078. addMouseWheel(): ArcRotateCameraInputsManager;
  121079. /**
  121080. * Add pointers input support to the input manager.
  121081. * @returns the current input manager
  121082. */
  121083. addPointers(): ArcRotateCameraInputsManager;
  121084. /**
  121085. * Add keyboard input support to the input manager.
  121086. * @returns the current input manager
  121087. */
  121088. addKeyboard(): ArcRotateCameraInputsManager;
  121089. }
  121090. }
  121091. declare module BABYLON {
  121092. /**
  121093. * This represents an orbital type of camera.
  121094. *
  121095. * 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.
  121096. * 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.
  121097. * @see https://doc.babylonjs.com/babylon101/cameras#arc-rotate-camera
  121098. */
  121099. export class ArcRotateCamera extends TargetCamera {
  121100. /**
  121101. * Defines the rotation angle of the camera along the longitudinal axis.
  121102. */
  121103. alpha: number;
  121104. /**
  121105. * Defines the rotation angle of the camera along the latitudinal axis.
  121106. */
  121107. beta: number;
  121108. /**
  121109. * Defines the radius of the camera from it s target point.
  121110. */
  121111. radius: number;
  121112. protected _target: Vector3;
  121113. protected _targetHost: Nullable<AbstractMesh>;
  121114. /**
  121115. * Defines the target point of the camera.
  121116. * The camera looks towards it form the radius distance.
  121117. */
  121118. get target(): Vector3;
  121119. set target(value: Vector3);
  121120. /**
  121121. * Define the current local position of the camera in the scene
  121122. */
  121123. get position(): Vector3;
  121124. set position(newPosition: Vector3);
  121125. protected _upVector: Vector3;
  121126. protected _upToYMatrix: Matrix;
  121127. protected _YToUpMatrix: Matrix;
  121128. /**
  121129. * The vector the camera should consider as up. (default is Vector3(0, 1, 0) as returned by Vector3.Up())
  121130. * Setting this will copy the given vector to the camera's upVector, and set rotation matrices to and from Y up.
  121131. * DO NOT set the up vector using copyFrom or copyFromFloats, as this bypasses setting the above matrices.
  121132. */
  121133. set upVector(vec: Vector3);
  121134. get upVector(): Vector3;
  121135. /**
  121136. * Sets the Y-up to camera up-vector rotation matrix, and the up-vector to Y-up rotation matrix.
  121137. */
  121138. setMatUp(): void;
  121139. /**
  121140. * Current inertia value on the longitudinal axis.
  121141. * The bigger this number the longer it will take for the camera to stop.
  121142. */
  121143. inertialAlphaOffset: number;
  121144. /**
  121145. * Current inertia value on the latitudinal axis.
  121146. * The bigger this number the longer it will take for the camera to stop.
  121147. */
  121148. inertialBetaOffset: number;
  121149. /**
  121150. * Current inertia value on the radius axis.
  121151. * The bigger this number the longer it will take for the camera to stop.
  121152. */
  121153. inertialRadiusOffset: number;
  121154. /**
  121155. * Minimum allowed angle on the longitudinal axis.
  121156. * This can help limiting how the Camera is able to move in the scene.
  121157. */
  121158. lowerAlphaLimit: Nullable<number>;
  121159. /**
  121160. * Maximum allowed angle on the longitudinal axis.
  121161. * This can help limiting how the Camera is able to move in the scene.
  121162. */
  121163. upperAlphaLimit: Nullable<number>;
  121164. /**
  121165. * Minimum allowed angle on the latitudinal axis.
  121166. * This can help limiting how the Camera is able to move in the scene.
  121167. */
  121168. lowerBetaLimit: number;
  121169. /**
  121170. * Maximum allowed angle on the latitudinal axis.
  121171. * This can help limiting how the Camera is able to move in the scene.
  121172. */
  121173. upperBetaLimit: number;
  121174. /**
  121175. * Minimum allowed distance of the camera to the target (The camera can not get closer).
  121176. * This can help limiting how the Camera is able to move in the scene.
  121177. */
  121178. lowerRadiusLimit: Nullable<number>;
  121179. /**
  121180. * Maximum allowed distance of the camera to the target (The camera can not get further).
  121181. * This can help limiting how the Camera is able to move in the scene.
  121182. */
  121183. upperRadiusLimit: Nullable<number>;
  121184. /**
  121185. * Defines the current inertia value used during panning of the camera along the X axis.
  121186. */
  121187. inertialPanningX: number;
  121188. /**
  121189. * Defines the current inertia value used during panning of the camera along the Y axis.
  121190. */
  121191. inertialPanningY: number;
  121192. /**
  121193. * Defines the distance used to consider the camera in pan mode vs pinch/zoom.
  121194. * Basically if your fingers moves away from more than this distance you will be considered
  121195. * in pinch mode.
  121196. */
  121197. pinchToPanMaxDistance: number;
  121198. /**
  121199. * Defines the maximum distance the camera can pan.
  121200. * This could help keeping the cammera always in your scene.
  121201. */
  121202. panningDistanceLimit: Nullable<number>;
  121203. /**
  121204. * Defines the target of the camera before paning.
  121205. */
  121206. panningOriginTarget: Vector3;
  121207. /**
  121208. * Defines the value of the inertia used during panning.
  121209. * 0 would mean stop inertia and one would mean no decelleration at all.
  121210. */
  121211. panningInertia: number;
  121212. /**
  121213. * Gets or Set the pointer angular sensibility along the X axis or how fast is the camera rotating.
  121214. */
  121215. get angularSensibilityX(): number;
  121216. set angularSensibilityX(value: number);
  121217. /**
  121218. * Gets or Set the pointer angular sensibility along the Y axis or how fast is the camera rotating.
  121219. */
  121220. get angularSensibilityY(): number;
  121221. set angularSensibilityY(value: number);
  121222. /**
  121223. * Gets or Set the pointer pinch precision or how fast is the camera zooming.
  121224. */
  121225. get pinchPrecision(): number;
  121226. set pinchPrecision(value: number);
  121227. /**
  121228. * Gets or Set the pointer pinch delta percentage or how fast is the camera zooming.
  121229. * It will be used instead of pinchDeltaPrecision if different from 0.
  121230. * It defines the percentage of current camera.radius to use as delta when pinch zoom is used.
  121231. */
  121232. get pinchDeltaPercentage(): number;
  121233. set pinchDeltaPercentage(value: number);
  121234. /**
  121235. * Gets or Set the pointer use natural pinch zoom to override the pinch precision
  121236. * and pinch delta percentage.
  121237. * When useNaturalPinchZoom is true, multi touch zoom will zoom in such
  121238. * that any object in the plane at the camera's target point will scale
  121239. * perfectly with finger motion.
  121240. */
  121241. get useNaturalPinchZoom(): boolean;
  121242. set useNaturalPinchZoom(value: boolean);
  121243. /**
  121244. * Gets or Set the pointer panning sensibility or how fast is the camera moving.
  121245. */
  121246. get panningSensibility(): number;
  121247. set panningSensibility(value: number);
  121248. /**
  121249. * Gets or Set the list of keyboard keys used to control beta angle in a positive direction.
  121250. */
  121251. get keysUp(): number[];
  121252. set keysUp(value: number[]);
  121253. /**
  121254. * Gets or Set the list of keyboard keys used to control beta angle in a negative direction.
  121255. */
  121256. get keysDown(): number[];
  121257. set keysDown(value: number[]);
  121258. /**
  121259. * Gets or Set the list of keyboard keys used to control alpha angle in a negative direction.
  121260. */
  121261. get keysLeft(): number[];
  121262. set keysLeft(value: number[]);
  121263. /**
  121264. * Gets or Set the list of keyboard keys used to control alpha angle in a positive direction.
  121265. */
  121266. get keysRight(): number[];
  121267. set keysRight(value: number[]);
  121268. /**
  121269. * Gets or Set the mouse wheel precision or how fast is the camera zooming.
  121270. */
  121271. get wheelPrecision(): number;
  121272. set wheelPrecision(value: number);
  121273. /**
  121274. * Gets or Set the mouse wheel delta percentage or how fast is the camera zooming.
  121275. * It will be used instead of pinchDeltaPrecision if different from 0.
  121276. * It defines the percentage of current camera.radius to use as delta when pinch zoom is used.
  121277. */
  121278. get wheelDeltaPercentage(): number;
  121279. set wheelDeltaPercentage(value: number);
  121280. /**
  121281. * Defines how much the radius should be scaled while zomming on a particular mesh (through the zoomOn function)
  121282. */
  121283. zoomOnFactor: number;
  121284. /**
  121285. * Defines a screen offset for the camera position.
  121286. */
  121287. targetScreenOffset: Vector2;
  121288. /**
  121289. * Allows the camera to be completely reversed.
  121290. * If false the camera can not arrive upside down.
  121291. */
  121292. allowUpsideDown: boolean;
  121293. /**
  121294. * Define if double tap/click is used to restore the previously saved state of the camera.
  121295. */
  121296. useInputToRestoreState: boolean;
  121297. /** @hidden */
  121298. _viewMatrix: Matrix;
  121299. /** @hidden */
  121300. _useCtrlForPanning: boolean;
  121301. /** @hidden */
  121302. _panningMouseButton: number;
  121303. /**
  121304. * Defines the input associated to the camera.
  121305. */
  121306. inputs: ArcRotateCameraInputsManager;
  121307. /** @hidden */
  121308. _reset: () => void;
  121309. /**
  121310. * Defines the allowed panning axis.
  121311. */
  121312. panningAxis: Vector3;
  121313. protected _localDirection: Vector3;
  121314. protected _transformedDirection: Vector3;
  121315. private _bouncingBehavior;
  121316. /**
  121317. * Gets the bouncing behavior of the camera if it has been enabled.
  121318. * @see https://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  121319. */
  121320. get bouncingBehavior(): Nullable<BouncingBehavior>;
  121321. /**
  121322. * Defines if the bouncing behavior of the camera is enabled on the camera.
  121323. * @see https://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  121324. */
  121325. get useBouncingBehavior(): boolean;
  121326. set useBouncingBehavior(value: boolean);
  121327. private _framingBehavior;
  121328. /**
  121329. * Gets the framing behavior of the camera if it has been enabled.
  121330. * @see https://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  121331. */
  121332. get framingBehavior(): Nullable<FramingBehavior>;
  121333. /**
  121334. * Defines if the framing behavior of the camera is enabled on the camera.
  121335. * @see https://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  121336. */
  121337. get useFramingBehavior(): boolean;
  121338. set useFramingBehavior(value: boolean);
  121339. private _autoRotationBehavior;
  121340. /**
  121341. * Gets the auto rotation behavior of the camera if it has been enabled.
  121342. * @see https://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  121343. */
  121344. get autoRotationBehavior(): Nullable<AutoRotationBehavior>;
  121345. /**
  121346. * Defines if the auto rotation behavior of the camera is enabled on the camera.
  121347. * @see https://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  121348. */
  121349. get useAutoRotationBehavior(): boolean;
  121350. set useAutoRotationBehavior(value: boolean);
  121351. /**
  121352. * Observable triggered when the mesh target has been changed on the camera.
  121353. */
  121354. onMeshTargetChangedObservable: Observable<Nullable<AbstractMesh>>;
  121355. /**
  121356. * Event raised when the camera is colliding with a mesh.
  121357. */
  121358. onCollide: (collidedMesh: AbstractMesh) => void;
  121359. /**
  121360. * Defines whether the camera should check collision with the objects oh the scene.
  121361. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#how-can-i-do-this
  121362. */
  121363. checkCollisions: boolean;
  121364. /**
  121365. * Defines the collision radius of the camera.
  121366. * This simulates a sphere around the camera.
  121367. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  121368. */
  121369. collisionRadius: Vector3;
  121370. protected _collider: Collider;
  121371. protected _previousPosition: Vector3;
  121372. protected _collisionVelocity: Vector3;
  121373. protected _newPosition: Vector3;
  121374. protected _previousAlpha: number;
  121375. protected _previousBeta: number;
  121376. protected _previousRadius: number;
  121377. protected _collisionTriggered: boolean;
  121378. protected _targetBoundingCenter: Nullable<Vector3>;
  121379. private _computationVector;
  121380. /**
  121381. * Instantiates a new ArcRotateCamera in a given scene
  121382. * @param name Defines the name of the camera
  121383. * @param alpha Defines the camera rotation along the logitudinal axis
  121384. * @param beta Defines the camera rotation along the latitudinal axis
  121385. * @param radius Defines the camera distance from its target
  121386. * @param target Defines the camera target
  121387. * @param scene Defines the scene the camera belongs to
  121388. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  121389. */
  121390. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  121391. /** @hidden */
  121392. _initCache(): void;
  121393. /** @hidden */
  121394. _updateCache(ignoreParentClass?: boolean): void;
  121395. protected _getTargetPosition(): Vector3;
  121396. private _storedAlpha;
  121397. private _storedBeta;
  121398. private _storedRadius;
  121399. private _storedTarget;
  121400. private _storedTargetScreenOffset;
  121401. /**
  121402. * Stores the current state of the camera (alpha, beta, radius and target)
  121403. * @returns the camera itself
  121404. */
  121405. storeState(): Camera;
  121406. /**
  121407. * @hidden
  121408. * Restored camera state. You must call storeState() first
  121409. */
  121410. _restoreStateValues(): boolean;
  121411. /** @hidden */
  121412. _isSynchronizedViewMatrix(): boolean;
  121413. /**
  121414. * Attached controls to the current camera.
  121415. * @param element Defines the element the controls should be listened from
  121416. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  121417. * @param useCtrlForPanning Defines whether ctrl is used for paning within the controls
  121418. * @param panningMouseButton Defines whether panning is allowed through mouse click button
  121419. */
  121420. attachControl(element: HTMLElement, noPreventDefault?: boolean, useCtrlForPanning?: boolean, panningMouseButton?: number): void;
  121421. /**
  121422. * Detach the current controls from the camera.
  121423. * The camera will stop reacting to inputs.
  121424. * @param element Defines the element to stop listening the inputs from
  121425. */
  121426. detachControl(element: HTMLElement): void;
  121427. /** @hidden */
  121428. _checkInputs(): void;
  121429. protected _checkLimits(): void;
  121430. /**
  121431. * Rebuilds angles (alpha, beta) and radius from the give position and target
  121432. */
  121433. rebuildAnglesAndRadius(): void;
  121434. /**
  121435. * Use a position to define the current camera related information like alpha, beta and radius
  121436. * @param position Defines the position to set the camera at
  121437. */
  121438. setPosition(position: Vector3): void;
  121439. /**
  121440. * Defines the target the camera should look at.
  121441. * This will automatically adapt alpha beta and radius to fit within the new target.
  121442. * @param target Defines the new target as a Vector or a mesh
  121443. * @param toBoundingCenter In case of a mesh target, defines whether to target the mesh position or its bounding information center
  121444. * @param allowSamePosition If false, prevents reapplying the new computed position if it is identical to the current one (optim)
  121445. */
  121446. setTarget(target: AbstractMesh | Vector3, toBoundingCenter?: boolean, allowSamePosition?: boolean): void;
  121447. /** @hidden */
  121448. _getViewMatrix(): Matrix;
  121449. protected _onCollisionPositionChange: (collisionId: number, newPosition: Vector3, collidedMesh?: Nullable<AbstractMesh>) => void;
  121450. /**
  121451. * Zooms on a mesh to be at the min distance where we could see it fully in the current viewport.
  121452. * @param meshes Defines the mesh to zoom on
  121453. * @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)
  121454. */
  121455. zoomOn(meshes?: AbstractMesh[], doNotUpdateMaxZ?: boolean): void;
  121456. /**
  121457. * Focus on a mesh or a bounding box. This adapts the target and maxRadius if necessary but does not update the current radius.
  121458. * The target will be changed but the radius
  121459. * @param meshesOrMinMaxVectorAndDistance Defines the mesh or bounding info to focus on
  121460. * @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)
  121461. */
  121462. focusOn(meshesOrMinMaxVectorAndDistance: AbstractMesh[] | {
  121463. min: Vector3;
  121464. max: Vector3;
  121465. distance: number;
  121466. }, doNotUpdateMaxZ?: boolean): void;
  121467. /**
  121468. * @override
  121469. * Override Camera.createRigCamera
  121470. */
  121471. createRigCamera(name: string, cameraIndex: number): Camera;
  121472. /**
  121473. * @hidden
  121474. * @override
  121475. * Override Camera._updateRigCameras
  121476. */
  121477. _updateRigCameras(): void;
  121478. /**
  121479. * Destroy the camera and release the current resources hold by it.
  121480. */
  121481. dispose(): void;
  121482. /**
  121483. * Gets the current object class name.
  121484. * @return the class name
  121485. */
  121486. getClassName(): string;
  121487. }
  121488. }
  121489. declare module BABYLON {
  121490. /**
  121491. * The autoRotation behavior (AutoRotationBehavior) is designed to create a smooth rotation of an ArcRotateCamera when there is no user interaction.
  121492. * @see https://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  121493. */
  121494. export class AutoRotationBehavior implements Behavior<ArcRotateCamera> {
  121495. /**
  121496. * Gets the name of the behavior.
  121497. */
  121498. get name(): string;
  121499. private _zoomStopsAnimation;
  121500. private _idleRotationSpeed;
  121501. private _idleRotationWaitTime;
  121502. private _idleRotationSpinupTime;
  121503. /**
  121504. * Sets the flag that indicates if user zooming should stop animation.
  121505. */
  121506. set zoomStopsAnimation(flag: boolean);
  121507. /**
  121508. * Gets the flag that indicates if user zooming should stop animation.
  121509. */
  121510. get zoomStopsAnimation(): boolean;
  121511. /**
  121512. * Sets the default speed at which the camera rotates around the model.
  121513. */
  121514. set idleRotationSpeed(speed: number);
  121515. /**
  121516. * Gets the default speed at which the camera rotates around the model.
  121517. */
  121518. get idleRotationSpeed(): number;
  121519. /**
  121520. * Sets the time (in milliseconds) to wait after user interaction before the camera starts rotating.
  121521. */
  121522. set idleRotationWaitTime(time: number);
  121523. /**
  121524. * Gets the time (milliseconds) to wait after user interaction before the camera starts rotating.
  121525. */
  121526. get idleRotationWaitTime(): number;
  121527. /**
  121528. * Sets the time (milliseconds) to take to spin up to the full idle rotation speed.
  121529. */
  121530. set idleRotationSpinupTime(time: number);
  121531. /**
  121532. * Gets the time (milliseconds) to take to spin up to the full idle rotation speed.
  121533. */
  121534. get idleRotationSpinupTime(): number;
  121535. /**
  121536. * Gets a value indicating if the camera is currently rotating because of this behavior
  121537. */
  121538. get rotationInProgress(): boolean;
  121539. private _onPrePointerObservableObserver;
  121540. private _onAfterCheckInputsObserver;
  121541. private _attachedCamera;
  121542. private _isPointerDown;
  121543. private _lastFrameTime;
  121544. private _lastInteractionTime;
  121545. private _cameraRotationSpeed;
  121546. /**
  121547. * Initializes the behavior.
  121548. */
  121549. init(): void;
  121550. /**
  121551. * Attaches the behavior to its arc rotate camera.
  121552. * @param camera Defines the camera to attach the behavior to
  121553. */
  121554. attach(camera: ArcRotateCamera): void;
  121555. /**
  121556. * Detaches the behavior from its current arc rotate camera.
  121557. */
  121558. detach(): void;
  121559. /**
  121560. * Returns true if user is scrolling.
  121561. * @return true if user is scrolling.
  121562. */
  121563. private _userIsZooming;
  121564. private _lastFrameRadius;
  121565. private _shouldAnimationStopForInteraction;
  121566. /**
  121567. * Applies any current user interaction to the camera. Takes into account maximum alpha rotation.
  121568. */
  121569. private _applyUserInteraction;
  121570. private _userIsMoving;
  121571. }
  121572. }
  121573. declare module BABYLON {
  121574. /**
  121575. * A behavior that when attached to a mesh will will place a specified node on the meshes face pointing towards the camera
  121576. */
  121577. export class AttachToBoxBehavior implements Behavior<Mesh> {
  121578. private ui;
  121579. /**
  121580. * The name of the behavior
  121581. */
  121582. name: string;
  121583. /**
  121584. * The distance away from the face of the mesh that the UI should be attached to (default: 0.15)
  121585. */
  121586. distanceAwayFromFace: number;
  121587. /**
  121588. * The distance from the bottom of the face that the UI should be attached to (default: 0.15)
  121589. */
  121590. distanceAwayFromBottomOfFace: number;
  121591. private _faceVectors;
  121592. private _target;
  121593. private _scene;
  121594. private _onRenderObserver;
  121595. private _tmpMatrix;
  121596. private _tmpVector;
  121597. /**
  121598. * Creates the AttachToBoxBehavior, used to attach UI to the closest face of the box to a camera
  121599. * @param ui The transform node that should be attched to the mesh
  121600. */
  121601. constructor(ui: TransformNode);
  121602. /**
  121603. * Initializes the behavior
  121604. */
  121605. init(): void;
  121606. private _closestFace;
  121607. private _zeroVector;
  121608. private _lookAtTmpMatrix;
  121609. private _lookAtToRef;
  121610. /**
  121611. * Attaches the AttachToBoxBehavior to the passed in mesh
  121612. * @param target The mesh that the specified node will be attached to
  121613. */
  121614. attach(target: Mesh): void;
  121615. /**
  121616. * Detaches the behavior from the mesh
  121617. */
  121618. detach(): void;
  121619. }
  121620. }
  121621. declare module BABYLON {
  121622. /**
  121623. * A behavior that when attached to a mesh will allow the mesh to fade in and out
  121624. */
  121625. export class FadeInOutBehavior implements Behavior<Mesh> {
  121626. /**
  121627. * Time in milliseconds to delay before fading in (Default: 0)
  121628. */
  121629. delay: number;
  121630. /**
  121631. * Time in milliseconds for the mesh to fade in (Default: 300)
  121632. */
  121633. fadeInTime: number;
  121634. private _millisecondsPerFrame;
  121635. private _hovered;
  121636. private _hoverValue;
  121637. private _ownerNode;
  121638. /**
  121639. * Instatiates the FadeInOutBehavior
  121640. */
  121641. constructor();
  121642. /**
  121643. * The name of the behavior
  121644. */
  121645. get name(): string;
  121646. /**
  121647. * Initializes the behavior
  121648. */
  121649. init(): void;
  121650. /**
  121651. * Attaches the fade behavior on the passed in mesh
  121652. * @param ownerNode The mesh that will be faded in/out once attached
  121653. */
  121654. attach(ownerNode: Mesh): void;
  121655. /**
  121656. * Detaches the behavior from the mesh
  121657. */
  121658. detach(): void;
  121659. /**
  121660. * Triggers the mesh to begin fading in or out
  121661. * @param value if the object should fade in or out (true to fade in)
  121662. */
  121663. fadeIn(value: boolean): void;
  121664. private _update;
  121665. private _setAllVisibility;
  121666. }
  121667. }
  121668. declare module BABYLON {
  121669. /**
  121670. * Class containing a set of static utilities functions for managing Pivots
  121671. * @hidden
  121672. */
  121673. export class PivotTools {
  121674. private static _PivotCached;
  121675. private static _OldPivotPoint;
  121676. private static _PivotTranslation;
  121677. private static _PivotTmpVector;
  121678. /** @hidden */
  121679. static _RemoveAndStorePivotPoint(mesh: AbstractMesh): void;
  121680. /** @hidden */
  121681. static _RestorePivotPoint(mesh: AbstractMesh): void;
  121682. }
  121683. }
  121684. declare module BABYLON {
  121685. /**
  121686. * Class containing static functions to help procedurally build meshes
  121687. */
  121688. export class PlaneBuilder {
  121689. /**
  121690. * Creates a plane mesh
  121691. * * The parameter `size` sets the size (float) of both sides of the plane at once (default 1)
  121692. * * You can set some different plane dimensions by using the parameters `width` and `height` (both by default have the same value of `size`)
  121693. * * The parameter `sourcePlane` is a Plane instance. It builds a mesh plane from a Math plane
  121694. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  121695. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  121696. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  121697. * @param name defines the name of the mesh
  121698. * @param options defines the options used to create the mesh
  121699. * @param scene defines the hosting scene
  121700. * @returns the plane mesh
  121701. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  121702. */
  121703. static CreatePlane(name: string, options: {
  121704. size?: number;
  121705. width?: number;
  121706. height?: number;
  121707. sideOrientation?: number;
  121708. frontUVs?: Vector4;
  121709. backUVs?: Vector4;
  121710. updatable?: boolean;
  121711. sourcePlane?: Plane;
  121712. }, scene?: Nullable<Scene>): Mesh;
  121713. }
  121714. }
  121715. declare module BABYLON {
  121716. /**
  121717. * A behavior that when attached to a mesh will allow the mesh to be dragged around the screen based on pointer events
  121718. */
  121719. export class PointerDragBehavior implements Behavior<AbstractMesh> {
  121720. private static _AnyMouseID;
  121721. /**
  121722. * Abstract mesh the behavior is set on
  121723. */
  121724. attachedNode: AbstractMesh;
  121725. private _dragPlane;
  121726. private _scene;
  121727. private _pointerObserver;
  121728. private _beforeRenderObserver;
  121729. private static _planeScene;
  121730. private _useAlternatePickedPointAboveMaxDragAngleDragSpeed;
  121731. /**
  121732. * 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)
  121733. */
  121734. maxDragAngle: number;
  121735. /**
  121736. * @hidden
  121737. */
  121738. _useAlternatePickedPointAboveMaxDragAngle: boolean;
  121739. /**
  121740. * The id of the pointer that is currently interacting with the behavior (-1 when no pointer is active)
  121741. */
  121742. currentDraggingPointerID: number;
  121743. /**
  121744. * The last position where the pointer hit the drag plane in world space
  121745. */
  121746. lastDragPosition: Vector3;
  121747. /**
  121748. * If the behavior is currently in a dragging state
  121749. */
  121750. dragging: boolean;
  121751. /**
  121752. * 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)
  121753. */
  121754. dragDeltaRatio: number;
  121755. /**
  121756. * If the drag plane orientation should be updated during the dragging (Default: true)
  121757. */
  121758. updateDragPlane: boolean;
  121759. private _debugMode;
  121760. private _moving;
  121761. /**
  121762. * Fires each time the attached mesh is dragged with the pointer
  121763. * * delta between last drag position and current drag position in world space
  121764. * * dragDistance along the drag axis
  121765. * * dragPlaneNormal normal of the current drag plane used during the drag
  121766. * * dragPlanePoint in world space where the drag intersects the drag plane
  121767. */
  121768. onDragObservable: Observable<{
  121769. delta: Vector3;
  121770. dragPlanePoint: Vector3;
  121771. dragPlaneNormal: Vector3;
  121772. dragDistance: number;
  121773. pointerId: number;
  121774. }>;
  121775. /**
  121776. * Fires each time a drag begins (eg. mouse down on mesh)
  121777. */
  121778. onDragStartObservable: Observable<{
  121779. dragPlanePoint: Vector3;
  121780. pointerId: number;
  121781. }>;
  121782. /**
  121783. * Fires each time a drag ends (eg. mouse release after drag)
  121784. */
  121785. onDragEndObservable: Observable<{
  121786. dragPlanePoint: Vector3;
  121787. pointerId: number;
  121788. }>;
  121789. /**
  121790. * If the attached mesh should be moved when dragged
  121791. */
  121792. moveAttached: boolean;
  121793. /**
  121794. * If the drag behavior will react to drag events (Default: true)
  121795. */
  121796. enabled: boolean;
  121797. /**
  121798. * If pointer events should start and release the drag (Default: true)
  121799. */
  121800. startAndReleaseDragOnPointerEvents: boolean;
  121801. /**
  121802. * If camera controls should be detached during the drag
  121803. */
  121804. detachCameraControls: boolean;
  121805. /**
  121806. * If set, the drag plane/axis will be rotated based on the attached mesh's world rotation (Default: true)
  121807. */
  121808. useObjectOrientationForDragging: boolean;
  121809. private _options;
  121810. /**
  121811. * Gets the options used by the behavior
  121812. */
  121813. get options(): {
  121814. dragAxis?: Vector3;
  121815. dragPlaneNormal?: Vector3;
  121816. };
  121817. /**
  121818. * Sets the options used by the behavior
  121819. */
  121820. set options(options: {
  121821. dragAxis?: Vector3;
  121822. dragPlaneNormal?: Vector3;
  121823. });
  121824. /**
  121825. * Creates a pointer drag behavior that can be attached to a mesh
  121826. * @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)
  121827. */
  121828. constructor(options?: {
  121829. dragAxis?: Vector3;
  121830. dragPlaneNormal?: Vector3;
  121831. });
  121832. /**
  121833. * Predicate to determine if it is valid to move the object to a new position when it is moved
  121834. */
  121835. validateDrag: (targetPosition: Vector3) => boolean;
  121836. /**
  121837. * The name of the behavior
  121838. */
  121839. get name(): string;
  121840. /**
  121841. * Initializes the behavior
  121842. */
  121843. init(): void;
  121844. private _tmpVector;
  121845. private _alternatePickedPoint;
  121846. private _worldDragAxis;
  121847. private _targetPosition;
  121848. private _attachedElement;
  121849. /**
  121850. * Attaches the drag behavior the passed in mesh
  121851. * @param ownerNode The mesh that will be dragged around once attached
  121852. * @param predicate Predicate to use for pick filtering
  121853. */
  121854. attach(ownerNode: AbstractMesh, predicate?: (m: AbstractMesh) => boolean): void;
  121855. /**
  121856. * Force relase the drag action by code.
  121857. */
  121858. releaseDrag(): void;
  121859. private _startDragRay;
  121860. private _lastPointerRay;
  121861. /**
  121862. * Simulates the start of a pointer drag event on the behavior
  121863. * @param pointerId pointerID of the pointer that should be simulated (Default: Any mouse pointer ID)
  121864. * @param fromRay initial ray of the pointer to be simulated (Default: Ray from camera to attached mesh)
  121865. * @param startPickedPoint picked point of the pointer to be simulated (Default: attached mesh position)
  121866. */
  121867. startDrag(pointerId?: number, fromRay?: Ray, startPickedPoint?: Vector3): void;
  121868. private _startDrag;
  121869. private _dragDelta;
  121870. private _moveDrag;
  121871. private _pickWithRayOnDragPlane;
  121872. private _pointA;
  121873. private _pointC;
  121874. private _localAxis;
  121875. private _lookAt;
  121876. private _updateDragPlanePosition;
  121877. /**
  121878. * Detaches the behavior from the mesh
  121879. */
  121880. detach(): void;
  121881. }
  121882. }
  121883. declare module BABYLON {
  121884. /**
  121885. * A behavior that when attached to a mesh will allow the mesh to be scaled
  121886. */
  121887. export class MultiPointerScaleBehavior implements Behavior<Mesh> {
  121888. private _dragBehaviorA;
  121889. private _dragBehaviorB;
  121890. private _startDistance;
  121891. private _initialScale;
  121892. private _targetScale;
  121893. private _ownerNode;
  121894. private _sceneRenderObserver;
  121895. /**
  121896. * Instantiate a new behavior that when attached to a mesh will allow the mesh to be scaled
  121897. */
  121898. constructor();
  121899. /**
  121900. * The name of the behavior
  121901. */
  121902. get name(): string;
  121903. /**
  121904. * Initializes the behavior
  121905. */
  121906. init(): void;
  121907. private _getCurrentDistance;
  121908. /**
  121909. * Attaches the scale behavior the passed in mesh
  121910. * @param ownerNode The mesh that will be scaled around once attached
  121911. */
  121912. attach(ownerNode: Mesh): void;
  121913. /**
  121914. * Detaches the behavior from the mesh
  121915. */
  121916. detach(): void;
  121917. }
  121918. }
  121919. declare module BABYLON {
  121920. /**
  121921. * 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
  121922. */
  121923. export class SixDofDragBehavior implements Behavior<Mesh> {
  121924. private static _virtualScene;
  121925. private _ownerNode;
  121926. private _sceneRenderObserver;
  121927. private _scene;
  121928. private _targetPosition;
  121929. private _virtualOriginMesh;
  121930. private _virtualDragMesh;
  121931. private _pointerObserver;
  121932. private _moving;
  121933. private _startingOrientation;
  121934. private _attachedElement;
  121935. /**
  121936. * 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)
  121937. */
  121938. private zDragFactor;
  121939. /**
  121940. * If the object should rotate to face the drag origin
  121941. */
  121942. rotateDraggedObject: boolean;
  121943. /**
  121944. * If the behavior is currently in a dragging state
  121945. */
  121946. dragging: boolean;
  121947. /**
  121948. * 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)
  121949. */
  121950. dragDeltaRatio: number;
  121951. /**
  121952. * The id of the pointer that is currently interacting with the behavior (-1 when no pointer is active)
  121953. */
  121954. currentDraggingPointerID: number;
  121955. /**
  121956. * If camera controls should be detached during the drag
  121957. */
  121958. detachCameraControls: boolean;
  121959. /**
  121960. * Fires each time a drag starts
  121961. */
  121962. onDragStartObservable: Observable<{}>;
  121963. /**
  121964. * Fires each time a drag ends (eg. mouse release after drag)
  121965. */
  121966. onDragEndObservable: Observable<{}>;
  121967. /**
  121968. * 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
  121969. */
  121970. constructor();
  121971. /**
  121972. * The name of the behavior
  121973. */
  121974. get name(): string;
  121975. /**
  121976. * Initializes the behavior
  121977. */
  121978. init(): void;
  121979. /**
  121980. * In the case of multiplea active cameras, the cameraToUseForPointers should be used if set instead of active camera
  121981. */
  121982. private get _pointerCamera();
  121983. /**
  121984. * Attaches the scale behavior the passed in mesh
  121985. * @param ownerNode The mesh that will be scaled around once attached
  121986. */
  121987. attach(ownerNode: Mesh): void;
  121988. /**
  121989. * Detaches the behavior from the mesh
  121990. */
  121991. detach(): void;
  121992. }
  121993. }
  121994. declare module BABYLON {
  121995. /**
  121996. * Class used to apply inverse kinematics to bones
  121997. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons#boneikcontroller
  121998. */
  121999. export class BoneIKController {
  122000. private static _tmpVecs;
  122001. private static _tmpQuat;
  122002. private static _tmpMats;
  122003. /**
  122004. * Gets or sets the target mesh
  122005. */
  122006. targetMesh: AbstractMesh;
  122007. /** Gets or sets the mesh used as pole */
  122008. poleTargetMesh: AbstractMesh;
  122009. /**
  122010. * Gets or sets the bone used as pole
  122011. */
  122012. poleTargetBone: Nullable<Bone>;
  122013. /**
  122014. * Gets or sets the target position
  122015. */
  122016. targetPosition: Vector3;
  122017. /**
  122018. * Gets or sets the pole target position
  122019. */
  122020. poleTargetPosition: Vector3;
  122021. /**
  122022. * Gets or sets the pole target local offset
  122023. */
  122024. poleTargetLocalOffset: Vector3;
  122025. /**
  122026. * Gets or sets the pole angle
  122027. */
  122028. poleAngle: number;
  122029. /**
  122030. * Gets or sets the mesh associated with the controller
  122031. */
  122032. mesh: AbstractMesh;
  122033. /**
  122034. * 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)
  122035. */
  122036. slerpAmount: number;
  122037. private _bone1Quat;
  122038. private _bone1Mat;
  122039. private _bone2Ang;
  122040. private _bone1;
  122041. private _bone2;
  122042. private _bone1Length;
  122043. private _bone2Length;
  122044. private _maxAngle;
  122045. private _maxReach;
  122046. private _rightHandedSystem;
  122047. private _bendAxis;
  122048. private _slerping;
  122049. private _adjustRoll;
  122050. /**
  122051. * Gets or sets maximum allowed angle
  122052. */
  122053. get maxAngle(): number;
  122054. set maxAngle(value: number);
  122055. /**
  122056. * Creates a new BoneIKController
  122057. * @param mesh defines the mesh to control
  122058. * @param bone defines the bone to control
  122059. * @param options defines options to set up the controller
  122060. */
  122061. constructor(mesh: AbstractMesh, bone: Bone, options?: {
  122062. targetMesh?: AbstractMesh;
  122063. poleTargetMesh?: AbstractMesh;
  122064. poleTargetBone?: Bone;
  122065. poleTargetLocalOffset?: Vector3;
  122066. poleAngle?: number;
  122067. bendAxis?: Vector3;
  122068. maxAngle?: number;
  122069. slerpAmount?: number;
  122070. });
  122071. private _setMaxAngle;
  122072. /**
  122073. * Force the controller to update the bones
  122074. */
  122075. update(): void;
  122076. }
  122077. }
  122078. declare module BABYLON {
  122079. /**
  122080. * Class used to make a bone look toward a point in space
  122081. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons#bonelookcontroller
  122082. */
  122083. export class BoneLookController {
  122084. private static _tmpVecs;
  122085. private static _tmpQuat;
  122086. private static _tmpMats;
  122087. /**
  122088. * The target Vector3 that the bone will look at
  122089. */
  122090. target: Vector3;
  122091. /**
  122092. * The mesh that the bone is attached to
  122093. */
  122094. mesh: AbstractMesh;
  122095. /**
  122096. * The bone that will be looking to the target
  122097. */
  122098. bone: Bone;
  122099. /**
  122100. * The up axis of the coordinate system that is used when the bone is rotated
  122101. */
  122102. upAxis: Vector3;
  122103. /**
  122104. * The space that the up axis is in - Space.BONE, Space.LOCAL (default), or Space.WORLD
  122105. */
  122106. upAxisSpace: Space;
  122107. /**
  122108. * Used to make an adjustment to the yaw of the bone
  122109. */
  122110. adjustYaw: number;
  122111. /**
  122112. * Used to make an adjustment to the pitch of the bone
  122113. */
  122114. adjustPitch: number;
  122115. /**
  122116. * Used to make an adjustment to the roll of the bone
  122117. */
  122118. adjustRoll: number;
  122119. /**
  122120. * 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)
  122121. */
  122122. slerpAmount: number;
  122123. private _minYaw;
  122124. private _maxYaw;
  122125. private _minPitch;
  122126. private _maxPitch;
  122127. private _minYawSin;
  122128. private _minYawCos;
  122129. private _maxYawSin;
  122130. private _maxYawCos;
  122131. private _midYawConstraint;
  122132. private _minPitchTan;
  122133. private _maxPitchTan;
  122134. private _boneQuat;
  122135. private _slerping;
  122136. private _transformYawPitch;
  122137. private _transformYawPitchInv;
  122138. private _firstFrameSkipped;
  122139. private _yawRange;
  122140. private _fowardAxis;
  122141. /**
  122142. * Gets or sets the minimum yaw angle that the bone can look to
  122143. */
  122144. get minYaw(): number;
  122145. set minYaw(value: number);
  122146. /**
  122147. * Gets or sets the maximum yaw angle that the bone can look to
  122148. */
  122149. get maxYaw(): number;
  122150. set maxYaw(value: number);
  122151. /**
  122152. * Gets or sets the minimum pitch angle that the bone can look to
  122153. */
  122154. get minPitch(): number;
  122155. set minPitch(value: number);
  122156. /**
  122157. * Gets or sets the maximum pitch angle that the bone can look to
  122158. */
  122159. get maxPitch(): number;
  122160. set maxPitch(value: number);
  122161. /**
  122162. * Create a BoneLookController
  122163. * @param mesh the mesh that the bone belongs to
  122164. * @param bone the bone that will be looking to the target
  122165. * @param target the target Vector3 to look at
  122166. * @param options optional settings:
  122167. * * maxYaw: the maximum angle the bone will yaw to
  122168. * * minYaw: the minimum angle the bone will yaw to
  122169. * * maxPitch: the maximum angle the bone will pitch to
  122170. * * minPitch: the minimum angle the bone will yaw to
  122171. * * slerpAmount: set the between 0 and 1 to make the bone slerp to the target.
  122172. * * upAxis: the up axis of the coordinate system
  122173. * * upAxisSpace: the space that the up axis is in - Space.BONE, Space.LOCAL (default), or Space.WORLD.
  122174. * * yawAxis: set yawAxis if the bone does not yaw on the y axis
  122175. * * pitchAxis: set pitchAxis if the bone does not pitch on the x axis
  122176. * * adjustYaw: used to make an adjustment to the yaw of the bone
  122177. * * adjustPitch: used to make an adjustment to the pitch of the bone
  122178. * * adjustRoll: used to make an adjustment to the roll of the bone
  122179. **/
  122180. constructor(mesh: AbstractMesh, bone: Bone, target: Vector3, options?: {
  122181. maxYaw?: number;
  122182. minYaw?: number;
  122183. maxPitch?: number;
  122184. minPitch?: number;
  122185. slerpAmount?: number;
  122186. upAxis?: Vector3;
  122187. upAxisSpace?: Space;
  122188. yawAxis?: Vector3;
  122189. pitchAxis?: Vector3;
  122190. adjustYaw?: number;
  122191. adjustPitch?: number;
  122192. adjustRoll?: number;
  122193. });
  122194. /**
  122195. * Update the bone to look at the target. This should be called before the scene is rendered (use scene.registerBeforeRender())
  122196. */
  122197. update(): void;
  122198. private _getAngleDiff;
  122199. private _getAngleBetween;
  122200. private _isAngleBetween;
  122201. }
  122202. }
  122203. declare module BABYLON {
  122204. /**
  122205. * Manage the gamepad inputs to control an arc rotate camera.
  122206. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  122207. */
  122208. export class ArcRotateCameraGamepadInput implements ICameraInput<ArcRotateCamera> {
  122209. /**
  122210. * Defines the camera the input is attached to.
  122211. */
  122212. camera: ArcRotateCamera;
  122213. /**
  122214. * Defines the gamepad the input is gathering event from.
  122215. */
  122216. gamepad: Nullable<Gamepad>;
  122217. /**
  122218. * Defines the gamepad rotation sensiblity.
  122219. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  122220. */
  122221. gamepadRotationSensibility: number;
  122222. /**
  122223. * Defines the gamepad move sensiblity.
  122224. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  122225. */
  122226. gamepadMoveSensibility: number;
  122227. private _yAxisScale;
  122228. /**
  122229. * Gets or sets a boolean indicating that Yaxis (for right stick) should be inverted
  122230. */
  122231. get invertYAxis(): boolean;
  122232. set invertYAxis(value: boolean);
  122233. private _onGamepadConnectedObserver;
  122234. private _onGamepadDisconnectedObserver;
  122235. /**
  122236. * Attach the input controls to a specific dom element to get the input from.
  122237. * @param element Defines the element the controls should be listened from
  122238. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  122239. */
  122240. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  122241. /**
  122242. * Detach the current controls from the specified dom element.
  122243. * @param element Defines the element to stop listening the inputs from
  122244. */
  122245. detachControl(element: Nullable<HTMLElement>): void;
  122246. /**
  122247. * Update the current camera state depending on the inputs that have been used this frame.
  122248. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  122249. */
  122250. checkInputs(): void;
  122251. /**
  122252. * Gets the class name of the current intput.
  122253. * @returns the class name
  122254. */
  122255. getClassName(): string;
  122256. /**
  122257. * Get the friendly name associated with the input class.
  122258. * @returns the input friendly name
  122259. */
  122260. getSimpleName(): string;
  122261. }
  122262. }
  122263. declare module BABYLON {
  122264. interface ArcRotateCameraInputsManager {
  122265. /**
  122266. * Add orientation input support to the input manager.
  122267. * @returns the current input manager
  122268. */
  122269. addVRDeviceOrientation(): ArcRotateCameraInputsManager;
  122270. }
  122271. /**
  122272. * Manage the device orientation inputs (gyroscope) to control an arc rotate camera.
  122273. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  122274. */
  122275. export class ArcRotateCameraVRDeviceOrientationInput implements ICameraInput<ArcRotateCamera> {
  122276. /**
  122277. * Defines the camera the input is attached to.
  122278. */
  122279. camera: ArcRotateCamera;
  122280. /**
  122281. * Defines a correction factor applied on the alpha value retrieved from the orientation events.
  122282. */
  122283. alphaCorrection: number;
  122284. /**
  122285. * Defines a correction factor applied on the gamma value retrieved from the orientation events.
  122286. */
  122287. gammaCorrection: number;
  122288. private _alpha;
  122289. private _gamma;
  122290. private _dirty;
  122291. private _deviceOrientationHandler;
  122292. /**
  122293. * Instantiate a new ArcRotateCameraVRDeviceOrientationInput.
  122294. */
  122295. constructor();
  122296. /**
  122297. * Attach the input controls to a specific dom element to get the input from.
  122298. * @param element Defines the element the controls should be listened from
  122299. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  122300. */
  122301. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  122302. /** @hidden */
  122303. _onOrientationEvent(evt: DeviceOrientationEvent): void;
  122304. /**
  122305. * Update the current camera state depending on the inputs that have been used this frame.
  122306. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  122307. */
  122308. checkInputs(): void;
  122309. /**
  122310. * Detach the current controls from the specified dom element.
  122311. * @param element Defines the element to stop listening the inputs from
  122312. */
  122313. detachControl(element: Nullable<HTMLElement>): void;
  122314. /**
  122315. * Gets the class name of the current intput.
  122316. * @returns the class name
  122317. */
  122318. getClassName(): string;
  122319. /**
  122320. * Get the friendly name associated with the input class.
  122321. * @returns the input friendly name
  122322. */
  122323. getSimpleName(): string;
  122324. }
  122325. }
  122326. declare module BABYLON {
  122327. /**
  122328. * Listen to mouse events to control the camera.
  122329. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  122330. */
  122331. export class FlyCameraMouseInput implements ICameraInput<FlyCamera> {
  122332. /**
  122333. * Defines the camera the input is attached to.
  122334. */
  122335. camera: FlyCamera;
  122336. /**
  122337. * Defines if touch is enabled. (Default is true.)
  122338. */
  122339. touchEnabled: boolean;
  122340. /**
  122341. * Defines the buttons associated with the input to handle camera rotation.
  122342. */
  122343. buttons: number[];
  122344. /**
  122345. * Assign buttons for Yaw control.
  122346. */
  122347. buttonsYaw: number[];
  122348. /**
  122349. * Assign buttons for Pitch control.
  122350. */
  122351. buttonsPitch: number[];
  122352. /**
  122353. * Assign buttons for Roll control.
  122354. */
  122355. buttonsRoll: number[];
  122356. /**
  122357. * Detect if any button is being pressed while mouse is moved.
  122358. * -1 = Mouse locked.
  122359. * 0 = Left button.
  122360. * 1 = Middle Button.
  122361. * 2 = Right Button.
  122362. */
  122363. activeButton: number;
  122364. /**
  122365. * Defines the pointer's angular sensibility, to control the camera rotation speed.
  122366. * Higher values reduce its sensitivity.
  122367. */
  122368. angularSensibility: number;
  122369. private _mousemoveCallback;
  122370. private _observer;
  122371. private _rollObserver;
  122372. private previousPosition;
  122373. private noPreventDefault;
  122374. private element;
  122375. /**
  122376. * Listen to mouse events to control the camera.
  122377. * @param touchEnabled Define if touch is enabled. (Default is true.)
  122378. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  122379. */
  122380. constructor(touchEnabled?: boolean);
  122381. /**
  122382. * Attach the mouse control to the HTML DOM element.
  122383. * @param element Defines the element that listens to the input events.
  122384. * @param noPreventDefault Defines whether events caught by the controls should call preventdefault().
  122385. */
  122386. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  122387. /**
  122388. * Detach the current controls from the specified dom element.
  122389. * @param element Defines the element to stop listening the inputs from
  122390. */
  122391. detachControl(element: Nullable<HTMLElement>): void;
  122392. /**
  122393. * Gets the class name of the current input.
  122394. * @returns the class name.
  122395. */
  122396. getClassName(): string;
  122397. /**
  122398. * Get the friendly name associated with the input class.
  122399. * @returns the input's friendly name.
  122400. */
  122401. getSimpleName(): string;
  122402. private _pointerInput;
  122403. private _onMouseMove;
  122404. /**
  122405. * Rotate camera by mouse offset.
  122406. */
  122407. private rotateCamera;
  122408. }
  122409. }
  122410. declare module BABYLON {
  122411. /**
  122412. * Default Inputs manager for the FlyCamera.
  122413. * It groups all the default supported inputs for ease of use.
  122414. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  122415. */
  122416. export class FlyCameraInputsManager extends CameraInputsManager<FlyCamera> {
  122417. /**
  122418. * Instantiates a new FlyCameraInputsManager.
  122419. * @param camera Defines the camera the inputs belong to.
  122420. */
  122421. constructor(camera: FlyCamera);
  122422. /**
  122423. * Add keyboard input support to the input manager.
  122424. * @returns the new FlyCameraKeyboardMoveInput().
  122425. */
  122426. addKeyboard(): FlyCameraInputsManager;
  122427. /**
  122428. * Add mouse input support to the input manager.
  122429. * @param touchEnabled Enable touch screen support.
  122430. * @returns the new FlyCameraMouseInput().
  122431. */
  122432. addMouse(touchEnabled?: boolean): FlyCameraInputsManager;
  122433. }
  122434. }
  122435. declare module BABYLON {
  122436. /**
  122437. * This is a flying camera, designed for 3D movement and rotation in all directions,
  122438. * such as in a 3D Space Shooter or a Flight Simulator.
  122439. */
  122440. export class FlyCamera extends TargetCamera {
  122441. /**
  122442. * Define the collision ellipsoid of the camera.
  122443. * This is helpful for simulating a camera body, like a player's body.
  122444. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  122445. */
  122446. ellipsoid: Vector3;
  122447. /**
  122448. * Define an offset for the position of the ellipsoid around the camera.
  122449. * This can be helpful if the camera is attached away from the player's body center,
  122450. * such as at its head.
  122451. */
  122452. ellipsoidOffset: Vector3;
  122453. /**
  122454. * Enable or disable collisions of the camera with the rest of the scene objects.
  122455. */
  122456. checkCollisions: boolean;
  122457. /**
  122458. * Enable or disable gravity on the camera.
  122459. */
  122460. applyGravity: boolean;
  122461. /**
  122462. * Define the current direction the camera is moving to.
  122463. */
  122464. cameraDirection: Vector3;
  122465. /**
  122466. * Define the current local rotation of the camera as a quaternion to prevent Gimbal lock.
  122467. * This overrides and empties cameraRotation.
  122468. */
  122469. rotationQuaternion: Quaternion;
  122470. /**
  122471. * Track Roll to maintain the wanted Rolling when looking around.
  122472. */
  122473. _trackRoll: number;
  122474. /**
  122475. * Slowly correct the Roll to its original value after a Pitch+Yaw rotation.
  122476. */
  122477. rollCorrect: number;
  122478. /**
  122479. * Mimic a banked turn, Rolling the camera when Yawing.
  122480. * It's recommended to use rollCorrect = 10 for faster banking correction.
  122481. */
  122482. bankedTurn: boolean;
  122483. /**
  122484. * Limit in radians for how much Roll banking will add. (Default: 90°)
  122485. */
  122486. bankedTurnLimit: number;
  122487. /**
  122488. * Value of 0 disables the banked Roll.
  122489. * Value of 1 is equal to the Yaw angle in radians.
  122490. */
  122491. bankedTurnMultiplier: number;
  122492. /**
  122493. * The inputs manager loads all the input sources, such as keyboard and mouse.
  122494. */
  122495. inputs: FlyCameraInputsManager;
  122496. /**
  122497. * Gets the input sensibility for mouse input.
  122498. * Higher values reduce sensitivity.
  122499. */
  122500. get angularSensibility(): number;
  122501. /**
  122502. * Sets the input sensibility for a mouse input.
  122503. * Higher values reduce sensitivity.
  122504. */
  122505. set angularSensibility(value: number);
  122506. /**
  122507. * Get the keys for camera movement forward.
  122508. */
  122509. get keysForward(): number[];
  122510. /**
  122511. * Set the keys for camera movement forward.
  122512. */
  122513. set keysForward(value: number[]);
  122514. /**
  122515. * Get the keys for camera movement backward.
  122516. */
  122517. get keysBackward(): number[];
  122518. set keysBackward(value: number[]);
  122519. /**
  122520. * Get the keys for camera movement up.
  122521. */
  122522. get keysUp(): number[];
  122523. /**
  122524. * Set the keys for camera movement up.
  122525. */
  122526. set keysUp(value: number[]);
  122527. /**
  122528. * Get the keys for camera movement down.
  122529. */
  122530. get keysDown(): number[];
  122531. /**
  122532. * Set the keys for camera movement down.
  122533. */
  122534. set keysDown(value: number[]);
  122535. /**
  122536. * Get the keys for camera movement left.
  122537. */
  122538. get keysLeft(): number[];
  122539. /**
  122540. * Set the keys for camera movement left.
  122541. */
  122542. set keysLeft(value: number[]);
  122543. /**
  122544. * Set the keys for camera movement right.
  122545. */
  122546. get keysRight(): number[];
  122547. /**
  122548. * Set the keys for camera movement right.
  122549. */
  122550. set keysRight(value: number[]);
  122551. /**
  122552. * Event raised when the camera collides with a mesh in the scene.
  122553. */
  122554. onCollide: (collidedMesh: AbstractMesh) => void;
  122555. private _collider;
  122556. private _needMoveForGravity;
  122557. private _oldPosition;
  122558. private _diffPosition;
  122559. private _newPosition;
  122560. /** @hidden */
  122561. _localDirection: Vector3;
  122562. /** @hidden */
  122563. _transformedDirection: Vector3;
  122564. /**
  122565. * Instantiates a FlyCamera.
  122566. * This is a flying camera, designed for 3D movement and rotation in all directions,
  122567. * such as in a 3D Space Shooter or a Flight Simulator.
  122568. * @param name Define the name of the camera in the scene.
  122569. * @param position Define the starting position of the camera in the scene.
  122570. * @param scene Define the scene the camera belongs to.
  122571. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active, if no other camera has been defined as active.
  122572. */
  122573. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  122574. /**
  122575. * Attach a control to the HTML DOM element.
  122576. * @param element Defines the element that listens to the input events.
  122577. * @param noPreventDefault Defines whether events caught by the controls should call preventdefault(). https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault
  122578. */
  122579. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  122580. /**
  122581. * Detach a control from the HTML DOM element.
  122582. * The camera will stop reacting to that input.
  122583. * @param element Defines the element that listens to the input events.
  122584. */
  122585. detachControl(element: HTMLElement): void;
  122586. private _collisionMask;
  122587. /**
  122588. * Get the mask that the camera ignores in collision events.
  122589. */
  122590. get collisionMask(): number;
  122591. /**
  122592. * Set the mask that the camera ignores in collision events.
  122593. */
  122594. set collisionMask(mask: number);
  122595. /** @hidden */
  122596. _collideWithWorld(displacement: Vector3): void;
  122597. /** @hidden */
  122598. private _onCollisionPositionChange;
  122599. /** @hidden */
  122600. _checkInputs(): void;
  122601. /** @hidden */
  122602. _decideIfNeedsToMove(): boolean;
  122603. /** @hidden */
  122604. _updatePosition(): void;
  122605. /**
  122606. * Restore the Roll to its target value at the rate specified.
  122607. * @param rate - Higher means slower restoring.
  122608. * @hidden
  122609. */
  122610. restoreRoll(rate: number): void;
  122611. /**
  122612. * Destroy the camera and release the current resources held by it.
  122613. */
  122614. dispose(): void;
  122615. /**
  122616. * Get the current object class name.
  122617. * @returns the class name.
  122618. */
  122619. getClassName(): string;
  122620. }
  122621. }
  122622. declare module BABYLON {
  122623. /**
  122624. * Listen to keyboard events to control the camera.
  122625. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  122626. */
  122627. export class FlyCameraKeyboardInput implements ICameraInput<FlyCamera> {
  122628. /**
  122629. * Defines the camera the input is attached to.
  122630. */
  122631. camera: FlyCamera;
  122632. /**
  122633. * The list of keyboard keys used to control the forward move of the camera.
  122634. */
  122635. keysForward: number[];
  122636. /**
  122637. * The list of keyboard keys used to control the backward move of the camera.
  122638. */
  122639. keysBackward: number[];
  122640. /**
  122641. * The list of keyboard keys used to control the forward move of the camera.
  122642. */
  122643. keysUp: number[];
  122644. /**
  122645. * The list of keyboard keys used to control the backward move of the camera.
  122646. */
  122647. keysDown: number[];
  122648. /**
  122649. * The list of keyboard keys used to control the right strafe move of the camera.
  122650. */
  122651. keysRight: number[];
  122652. /**
  122653. * The list of keyboard keys used to control the left strafe move of the camera.
  122654. */
  122655. keysLeft: number[];
  122656. private _keys;
  122657. private _onCanvasBlurObserver;
  122658. private _onKeyboardObserver;
  122659. private _engine;
  122660. private _scene;
  122661. /**
  122662. * Attach the input controls to a specific dom element to get the input from.
  122663. * @param element Defines the element the controls should be listened from
  122664. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  122665. */
  122666. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  122667. /**
  122668. * Detach the current controls from the specified dom element.
  122669. * @param element Defines the element to stop listening the inputs from
  122670. */
  122671. detachControl(element: Nullable<HTMLElement>): void;
  122672. /**
  122673. * Gets the class name of the current intput.
  122674. * @returns the class name
  122675. */
  122676. getClassName(): string;
  122677. /** @hidden */
  122678. _onLostFocus(e: FocusEvent): void;
  122679. /**
  122680. * Get the friendly name associated with the input class.
  122681. * @returns the input friendly name
  122682. */
  122683. getSimpleName(): string;
  122684. /**
  122685. * Update the current camera state depending on the inputs that have been used this frame.
  122686. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  122687. */
  122688. checkInputs(): void;
  122689. }
  122690. }
  122691. declare module BABYLON {
  122692. /**
  122693. * Manage the mouse wheel inputs to control a follow camera.
  122694. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  122695. */
  122696. export class FollowCameraMouseWheelInput implements ICameraInput<FollowCamera> {
  122697. /**
  122698. * Defines the camera the input is attached to.
  122699. */
  122700. camera: FollowCamera;
  122701. /**
  122702. * Moue wheel controls zoom. (Mouse wheel modifies camera.radius value.)
  122703. */
  122704. axisControlRadius: boolean;
  122705. /**
  122706. * Moue wheel controls height. (Mouse wheel modifies camera.heightOffset value.)
  122707. */
  122708. axisControlHeight: boolean;
  122709. /**
  122710. * Moue wheel controls angle. (Mouse wheel modifies camera.rotationOffset value.)
  122711. */
  122712. axisControlRotation: boolean;
  122713. /**
  122714. * Gets or Set the mouse wheel precision or how fast is the camera moves in
  122715. * relation to mouseWheel events.
  122716. */
  122717. wheelPrecision: number;
  122718. /**
  122719. * wheelDeltaPercentage will be used instead of wheelPrecision if different from 0.
  122720. * It defines the percentage of current camera.radius to use as delta when wheel is used.
  122721. */
  122722. wheelDeltaPercentage: number;
  122723. private _wheel;
  122724. private _observer;
  122725. /**
  122726. * Attach the input controls to a specific dom element to get the input from.
  122727. * @param element Defines the element the controls should be listened from
  122728. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  122729. */
  122730. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  122731. /**
  122732. * Detach the current controls from the specified dom element.
  122733. * @param element Defines the element to stop listening the inputs from
  122734. */
  122735. detachControl(element: Nullable<HTMLElement>): void;
  122736. /**
  122737. * Gets the class name of the current intput.
  122738. * @returns the class name
  122739. */
  122740. getClassName(): string;
  122741. /**
  122742. * Get the friendly name associated with the input class.
  122743. * @returns the input friendly name
  122744. */
  122745. getSimpleName(): string;
  122746. }
  122747. }
  122748. declare module BABYLON {
  122749. /**
  122750. * Manage the pointers inputs to control an follow camera.
  122751. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  122752. */
  122753. export class FollowCameraPointersInput extends BaseCameraPointersInput {
  122754. /**
  122755. * Defines the camera the input is attached to.
  122756. */
  122757. camera: FollowCamera;
  122758. /**
  122759. * Gets the class name of the current input.
  122760. * @returns the class name
  122761. */
  122762. getClassName(): string;
  122763. /**
  122764. * Defines the pointer angular sensibility along the X axis or how fast is
  122765. * the camera rotating.
  122766. * A negative number will reverse the axis direction.
  122767. */
  122768. angularSensibilityX: number;
  122769. /**
  122770. * Defines the pointer angular sensibility along the Y axis or how fast is
  122771. * the camera rotating.
  122772. * A negative number will reverse the axis direction.
  122773. */
  122774. angularSensibilityY: number;
  122775. /**
  122776. * Defines the pointer pinch precision or how fast is the camera zooming.
  122777. * A negative number will reverse the axis direction.
  122778. */
  122779. pinchPrecision: number;
  122780. /**
  122781. * pinchDeltaPercentage will be used instead of pinchPrecision if different
  122782. * from 0.
  122783. * It defines the percentage of current camera.radius to use as delta when
  122784. * pinch zoom is used.
  122785. */
  122786. pinchDeltaPercentage: number;
  122787. /**
  122788. * Pointer X axis controls zoom. (X axis modifies camera.radius value.)
  122789. */
  122790. axisXControlRadius: boolean;
  122791. /**
  122792. * Pointer X axis controls height. (X axis modifies camera.heightOffset value.)
  122793. */
  122794. axisXControlHeight: boolean;
  122795. /**
  122796. * Pointer X axis controls angle. (X axis modifies camera.rotationOffset value.)
  122797. */
  122798. axisXControlRotation: boolean;
  122799. /**
  122800. * Pointer Y axis controls zoom. (Y axis modifies camera.radius value.)
  122801. */
  122802. axisYControlRadius: boolean;
  122803. /**
  122804. * Pointer Y axis controls height. (Y axis modifies camera.heightOffset value.)
  122805. */
  122806. axisYControlHeight: boolean;
  122807. /**
  122808. * Pointer Y axis controls angle. (Y axis modifies camera.rotationOffset value.)
  122809. */
  122810. axisYControlRotation: boolean;
  122811. /**
  122812. * Pinch controls zoom. (Pinch modifies camera.radius value.)
  122813. */
  122814. axisPinchControlRadius: boolean;
  122815. /**
  122816. * Pinch controls height. (Pinch modifies camera.heightOffset value.)
  122817. */
  122818. axisPinchControlHeight: boolean;
  122819. /**
  122820. * Pinch controls angle. (Pinch modifies camera.rotationOffset value.)
  122821. */
  122822. axisPinchControlRotation: boolean;
  122823. /**
  122824. * Log error messages if basic misconfiguration has occurred.
  122825. */
  122826. warningEnable: boolean;
  122827. protected onTouch(pointA: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  122828. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  122829. private _warningCounter;
  122830. private _warning;
  122831. }
  122832. }
  122833. declare module BABYLON {
  122834. /**
  122835. * Default Inputs manager for the FollowCamera.
  122836. * It groups all the default supported inputs for ease of use.
  122837. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  122838. */
  122839. export class FollowCameraInputsManager extends CameraInputsManager<FollowCamera> {
  122840. /**
  122841. * Instantiates a new FollowCameraInputsManager.
  122842. * @param camera Defines the camera the inputs belong to
  122843. */
  122844. constructor(camera: FollowCamera);
  122845. /**
  122846. * Add keyboard input support to the input manager.
  122847. * @returns the current input manager
  122848. */
  122849. addKeyboard(): FollowCameraInputsManager;
  122850. /**
  122851. * Add mouse wheel input support to the input manager.
  122852. * @returns the current input manager
  122853. */
  122854. addMouseWheel(): FollowCameraInputsManager;
  122855. /**
  122856. * Add pointers input support to the input manager.
  122857. * @returns the current input manager
  122858. */
  122859. addPointers(): FollowCameraInputsManager;
  122860. /**
  122861. * Add orientation input support to the input manager.
  122862. * @returns the current input manager
  122863. */
  122864. addVRDeviceOrientation(): FollowCameraInputsManager;
  122865. }
  122866. }
  122867. declare module BABYLON {
  122868. /**
  122869. * A follow camera takes a mesh as a target and follows it as it moves. Both a free camera version followCamera and
  122870. * an arc rotate version arcFollowCamera are available.
  122871. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  122872. */
  122873. export class FollowCamera extends TargetCamera {
  122874. /**
  122875. * Distance the follow camera should follow an object at
  122876. */
  122877. radius: number;
  122878. /**
  122879. * Minimum allowed distance of the camera to the axis of rotation
  122880. * (The camera can not get closer).
  122881. * This can help limiting how the Camera is able to move in the scene.
  122882. */
  122883. lowerRadiusLimit: Nullable<number>;
  122884. /**
  122885. * Maximum allowed distance of the camera to the axis of rotation
  122886. * (The camera can not get further).
  122887. * This can help limiting how the Camera is able to move in the scene.
  122888. */
  122889. upperRadiusLimit: Nullable<number>;
  122890. /**
  122891. * Define a rotation offset between the camera and the object it follows
  122892. */
  122893. rotationOffset: number;
  122894. /**
  122895. * Minimum allowed angle to camera position relative to target object.
  122896. * This can help limiting how the Camera is able to move in the scene.
  122897. */
  122898. lowerRotationOffsetLimit: Nullable<number>;
  122899. /**
  122900. * Maximum allowed angle to camera position relative to target object.
  122901. * This can help limiting how the Camera is able to move in the scene.
  122902. */
  122903. upperRotationOffsetLimit: Nullable<number>;
  122904. /**
  122905. * Define a height offset between the camera and the object it follows.
  122906. * It can help following an object from the top (like a car chaing a plane)
  122907. */
  122908. heightOffset: number;
  122909. /**
  122910. * Minimum allowed height of camera position relative to target object.
  122911. * This can help limiting how the Camera is able to move in the scene.
  122912. */
  122913. lowerHeightOffsetLimit: Nullable<number>;
  122914. /**
  122915. * Maximum allowed height of camera position relative to target object.
  122916. * This can help limiting how the Camera is able to move in the scene.
  122917. */
  122918. upperHeightOffsetLimit: Nullable<number>;
  122919. /**
  122920. * Define how fast the camera can accelerate to follow it s target.
  122921. */
  122922. cameraAcceleration: number;
  122923. /**
  122924. * Define the speed limit of the camera following an object.
  122925. */
  122926. maxCameraSpeed: number;
  122927. /**
  122928. * Define the target of the camera.
  122929. */
  122930. lockedTarget: Nullable<AbstractMesh>;
  122931. /**
  122932. * Defines the input associated with the camera.
  122933. */
  122934. inputs: FollowCameraInputsManager;
  122935. /**
  122936. * Instantiates the follow camera.
  122937. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  122938. * @param name Define the name of the camera in the scene
  122939. * @param position Define the position of the camera
  122940. * @param scene Define the scene the camera belong to
  122941. * @param lockedTarget Define the target of the camera
  122942. */
  122943. constructor(name: string, position: Vector3, scene: Scene, lockedTarget?: Nullable<AbstractMesh>);
  122944. private _follow;
  122945. /**
  122946. * Attached controls to the current camera.
  122947. * @param element Defines the element the controls should be listened from
  122948. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  122949. */
  122950. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  122951. /**
  122952. * Detach the current controls from the camera.
  122953. * The camera will stop reacting to inputs.
  122954. * @param element Defines the element to stop listening the inputs from
  122955. */
  122956. detachControl(element: HTMLElement): void;
  122957. /** @hidden */
  122958. _checkInputs(): void;
  122959. private _checkLimits;
  122960. /**
  122961. * Gets the camera class name.
  122962. * @returns the class name
  122963. */
  122964. getClassName(): string;
  122965. }
  122966. /**
  122967. * Arc Rotate version of the follow camera.
  122968. * It still follows a Defined mesh but in an Arc Rotate Camera fashion.
  122969. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  122970. */
  122971. export class ArcFollowCamera extends TargetCamera {
  122972. /** The longitudinal angle of the camera */
  122973. alpha: number;
  122974. /** The latitudinal angle of the camera */
  122975. beta: number;
  122976. /** The radius of the camera from its target */
  122977. radius: number;
  122978. /** Define the camera target (the mesh it should follow) */
  122979. target: Nullable<AbstractMesh>;
  122980. private _cartesianCoordinates;
  122981. /**
  122982. * Instantiates a new ArcFollowCamera
  122983. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  122984. * @param name Define the name of the camera
  122985. * @param alpha Define the rotation angle of the camera around the logitudinal axis
  122986. * @param beta Define the rotation angle of the camera around the elevation axis
  122987. * @param radius Define the radius of the camera from its target point
  122988. * @param target Define the target of the camera
  122989. * @param scene Define the scene the camera belongs to
  122990. */
  122991. constructor(name: string,
  122992. /** The longitudinal angle of the camera */
  122993. alpha: number,
  122994. /** The latitudinal angle of the camera */
  122995. beta: number,
  122996. /** The radius of the camera from its target */
  122997. radius: number,
  122998. /** Define the camera target (the mesh it should follow) */
  122999. target: Nullable<AbstractMesh>, scene: Scene);
  123000. private _follow;
  123001. /** @hidden */
  123002. _checkInputs(): void;
  123003. /**
  123004. * Returns the class name of the object.
  123005. * It is mostly used internally for serialization purposes.
  123006. */
  123007. getClassName(): string;
  123008. }
  123009. }
  123010. declare module BABYLON {
  123011. /**
  123012. * Manage the keyboard inputs to control the movement of a follow camera.
  123013. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  123014. */
  123015. export class FollowCameraKeyboardMoveInput implements ICameraInput<FollowCamera> {
  123016. /**
  123017. * Defines the camera the input is attached to.
  123018. */
  123019. camera: FollowCamera;
  123020. /**
  123021. * Defines the list of key codes associated with the up action (increase heightOffset)
  123022. */
  123023. keysHeightOffsetIncr: number[];
  123024. /**
  123025. * Defines the list of key codes associated with the down action (decrease heightOffset)
  123026. */
  123027. keysHeightOffsetDecr: number[];
  123028. /**
  123029. * Defines whether the Alt modifier key is required to move up/down (alter heightOffset)
  123030. */
  123031. keysHeightOffsetModifierAlt: boolean;
  123032. /**
  123033. * Defines whether the Ctrl modifier key is required to move up/down (alter heightOffset)
  123034. */
  123035. keysHeightOffsetModifierCtrl: boolean;
  123036. /**
  123037. * Defines whether the Shift modifier key is required to move up/down (alter heightOffset)
  123038. */
  123039. keysHeightOffsetModifierShift: boolean;
  123040. /**
  123041. * Defines the list of key codes associated with the left action (increase rotationOffset)
  123042. */
  123043. keysRotationOffsetIncr: number[];
  123044. /**
  123045. * Defines the list of key codes associated with the right action (decrease rotationOffset)
  123046. */
  123047. keysRotationOffsetDecr: number[];
  123048. /**
  123049. * Defines whether the Alt modifier key is required to move left/right (alter rotationOffset)
  123050. */
  123051. keysRotationOffsetModifierAlt: boolean;
  123052. /**
  123053. * Defines whether the Ctrl modifier key is required to move left/right (alter rotationOffset)
  123054. */
  123055. keysRotationOffsetModifierCtrl: boolean;
  123056. /**
  123057. * Defines whether the Shift modifier key is required to move left/right (alter rotationOffset)
  123058. */
  123059. keysRotationOffsetModifierShift: boolean;
  123060. /**
  123061. * Defines the list of key codes associated with the zoom-in action (decrease radius)
  123062. */
  123063. keysRadiusIncr: number[];
  123064. /**
  123065. * Defines the list of key codes associated with the zoom-out action (increase radius)
  123066. */
  123067. keysRadiusDecr: number[];
  123068. /**
  123069. * Defines whether the Alt modifier key is required to zoom in/out (alter radius value)
  123070. */
  123071. keysRadiusModifierAlt: boolean;
  123072. /**
  123073. * Defines whether the Ctrl modifier key is required to zoom in/out (alter radius value)
  123074. */
  123075. keysRadiusModifierCtrl: boolean;
  123076. /**
  123077. * Defines whether the Shift modifier key is required to zoom in/out (alter radius value)
  123078. */
  123079. keysRadiusModifierShift: boolean;
  123080. /**
  123081. * Defines the rate of change of heightOffset.
  123082. */
  123083. heightSensibility: number;
  123084. /**
  123085. * Defines the rate of change of rotationOffset.
  123086. */
  123087. rotationSensibility: number;
  123088. /**
  123089. * Defines the rate of change of radius.
  123090. */
  123091. radiusSensibility: number;
  123092. private _keys;
  123093. private _ctrlPressed;
  123094. private _altPressed;
  123095. private _shiftPressed;
  123096. private _onCanvasBlurObserver;
  123097. private _onKeyboardObserver;
  123098. private _engine;
  123099. private _scene;
  123100. /**
  123101. * Attach the input controls to a specific dom element to get the input from.
  123102. * @param element Defines the element the controls should be listened from
  123103. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  123104. */
  123105. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  123106. /**
  123107. * Detach the current controls from the specified dom element.
  123108. * @param element Defines the element to stop listening the inputs from
  123109. */
  123110. detachControl(element: Nullable<HTMLElement>): void;
  123111. /**
  123112. * Update the current camera state depending on the inputs that have been used this frame.
  123113. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  123114. */
  123115. checkInputs(): void;
  123116. /**
  123117. * Gets the class name of the current input.
  123118. * @returns the class name
  123119. */
  123120. getClassName(): string;
  123121. /**
  123122. * Get the friendly name associated with the input class.
  123123. * @returns the input friendly name
  123124. */
  123125. getSimpleName(): string;
  123126. /**
  123127. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  123128. * allow modification of the heightOffset value.
  123129. */
  123130. private _modifierHeightOffset;
  123131. /**
  123132. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  123133. * allow modification of the rotationOffset value.
  123134. */
  123135. private _modifierRotationOffset;
  123136. /**
  123137. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  123138. * allow modification of the radius value.
  123139. */
  123140. private _modifierRadius;
  123141. }
  123142. }
  123143. declare module BABYLON {
  123144. interface FreeCameraInputsManager {
  123145. /**
  123146. * @hidden
  123147. */
  123148. _deviceOrientationInput: Nullable<FreeCameraDeviceOrientationInput>;
  123149. /**
  123150. * Add orientation input support to the input manager.
  123151. * @returns the current input manager
  123152. */
  123153. addDeviceOrientation(): FreeCameraInputsManager;
  123154. }
  123155. /**
  123156. * Takes information about the orientation of the device as reported by the deviceorientation event to orient the camera.
  123157. * Screen rotation is taken into account.
  123158. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  123159. */
  123160. export class FreeCameraDeviceOrientationInput implements ICameraInput<FreeCamera> {
  123161. private _camera;
  123162. private _screenOrientationAngle;
  123163. private _constantTranform;
  123164. private _screenQuaternion;
  123165. private _alpha;
  123166. private _beta;
  123167. private _gamma;
  123168. /**
  123169. * Can be used to detect if a device orientation sensor is available on a device
  123170. * @param timeout amount of time in milliseconds to wait for a response from the sensor (default: infinite)
  123171. * @returns a promise that will resolve on orientation change
  123172. */
  123173. static WaitForOrientationChangeAsync(timeout?: number): Promise<unknown>;
  123174. /**
  123175. * @hidden
  123176. */
  123177. _onDeviceOrientationChangedObservable: Observable<void>;
  123178. /**
  123179. * Instantiates a new input
  123180. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  123181. */
  123182. constructor();
  123183. /**
  123184. * Define the camera controlled by the input.
  123185. */
  123186. get camera(): FreeCamera;
  123187. set camera(camera: FreeCamera);
  123188. /**
  123189. * Attach the input controls to a specific dom element to get the input from.
  123190. * @param element Defines the element the controls should be listened from
  123191. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  123192. */
  123193. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  123194. private _orientationChanged;
  123195. private _deviceOrientation;
  123196. /**
  123197. * Detach the current controls from the specified dom element.
  123198. * @param element Defines the element to stop listening the inputs from
  123199. */
  123200. detachControl(element: Nullable<HTMLElement>): void;
  123201. /**
  123202. * Update the current camera state depending on the inputs that have been used this frame.
  123203. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  123204. */
  123205. checkInputs(): void;
  123206. /**
  123207. * Gets the class name of the current intput.
  123208. * @returns the class name
  123209. */
  123210. getClassName(): string;
  123211. /**
  123212. * Get the friendly name associated with the input class.
  123213. * @returns the input friendly name
  123214. */
  123215. getSimpleName(): string;
  123216. }
  123217. }
  123218. declare module BABYLON {
  123219. /**
  123220. * Manage the gamepad inputs to control a free camera.
  123221. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  123222. */
  123223. export class FreeCameraGamepadInput implements ICameraInput<FreeCamera> {
  123224. /**
  123225. * Define the camera the input is attached to.
  123226. */
  123227. camera: FreeCamera;
  123228. /**
  123229. * Define the Gamepad controlling the input
  123230. */
  123231. gamepad: Nullable<Gamepad>;
  123232. /**
  123233. * Defines the gamepad rotation sensiblity.
  123234. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  123235. */
  123236. gamepadAngularSensibility: number;
  123237. /**
  123238. * Defines the gamepad move sensiblity.
  123239. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  123240. */
  123241. gamepadMoveSensibility: number;
  123242. private _yAxisScale;
  123243. /**
  123244. * Gets or sets a boolean indicating that Yaxis (for right stick) should be inverted
  123245. */
  123246. get invertYAxis(): boolean;
  123247. set invertYAxis(value: boolean);
  123248. private _onGamepadConnectedObserver;
  123249. private _onGamepadDisconnectedObserver;
  123250. private _cameraTransform;
  123251. private _deltaTransform;
  123252. private _vector3;
  123253. private _vector2;
  123254. /**
  123255. * Attach the input controls to a specific dom element to get the input from.
  123256. * @param element Defines the element the controls should be listened from
  123257. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  123258. */
  123259. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  123260. /**
  123261. * Detach the current controls from the specified dom element.
  123262. * @param element Defines the element to stop listening the inputs from
  123263. */
  123264. detachControl(element: Nullable<HTMLElement>): void;
  123265. /**
  123266. * Update the current camera state depending on the inputs that have been used this frame.
  123267. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  123268. */
  123269. checkInputs(): void;
  123270. /**
  123271. * Gets the class name of the current intput.
  123272. * @returns the class name
  123273. */
  123274. getClassName(): string;
  123275. /**
  123276. * Get the friendly name associated with the input class.
  123277. * @returns the input friendly name
  123278. */
  123279. getSimpleName(): string;
  123280. }
  123281. }
  123282. declare module BABYLON {
  123283. /**
  123284. * Defines the potential axis of a Joystick
  123285. */
  123286. export enum JoystickAxis {
  123287. /** X axis */
  123288. X = 0,
  123289. /** Y axis */
  123290. Y = 1,
  123291. /** Z axis */
  123292. Z = 2
  123293. }
  123294. /**
  123295. * Represents the different customization options available
  123296. * for VirtualJoystick
  123297. */
  123298. interface VirtualJoystickCustomizations {
  123299. /**
  123300. * Size of the joystick's puck
  123301. */
  123302. puckSize: number;
  123303. /**
  123304. * Size of the joystick's container
  123305. */
  123306. containerSize: number;
  123307. /**
  123308. * Color of the joystick && puck
  123309. */
  123310. color: string;
  123311. /**
  123312. * Image URL for the joystick's puck
  123313. */
  123314. puckImage?: string;
  123315. /**
  123316. * Image URL for the joystick's container
  123317. */
  123318. containerImage?: string;
  123319. /**
  123320. * Defines the unmoving position of the joystick container
  123321. */
  123322. position?: {
  123323. x: number;
  123324. y: number;
  123325. };
  123326. /**
  123327. * Defines whether or not the joystick container is always visible
  123328. */
  123329. alwaysVisible: boolean;
  123330. /**
  123331. * Defines whether or not to limit the movement of the puck to the joystick's container
  123332. */
  123333. limitToContainer: boolean;
  123334. }
  123335. /**
  123336. * Class used to define virtual joystick (used in touch mode)
  123337. */
  123338. export class VirtualJoystick {
  123339. /**
  123340. * Gets or sets a boolean indicating that left and right values must be inverted
  123341. */
  123342. reverseLeftRight: boolean;
  123343. /**
  123344. * Gets or sets a boolean indicating that up and down values must be inverted
  123345. */
  123346. reverseUpDown: boolean;
  123347. /**
  123348. * Gets the offset value for the position (ie. the change of the position value)
  123349. */
  123350. deltaPosition: Vector3;
  123351. /**
  123352. * Gets a boolean indicating if the virtual joystick was pressed
  123353. */
  123354. pressed: boolean;
  123355. /**
  123356. * Canvas the virtual joystick will render onto, default z-index of this is 5
  123357. */
  123358. static Canvas: Nullable<HTMLCanvasElement>;
  123359. /**
  123360. * boolean indicating whether or not the joystick's puck's movement should be limited to the joystick's container area
  123361. */
  123362. limitToContainer: boolean;
  123363. private static _globalJoystickIndex;
  123364. private static _alwaysVisibleSticks;
  123365. private static vjCanvasContext;
  123366. private static vjCanvasWidth;
  123367. private static vjCanvasHeight;
  123368. private static halfWidth;
  123369. private static _GetDefaultOptions;
  123370. private _action;
  123371. private _axisTargetedByLeftAndRight;
  123372. private _axisTargetedByUpAndDown;
  123373. private _joystickSensibility;
  123374. private _inversedSensibility;
  123375. private _joystickPointerID;
  123376. private _joystickColor;
  123377. private _joystickPointerPos;
  123378. private _joystickPreviousPointerPos;
  123379. private _joystickPointerStartPos;
  123380. private _deltaJoystickVector;
  123381. private _leftJoystick;
  123382. private _touches;
  123383. private _joystickPosition;
  123384. private _alwaysVisible;
  123385. private _puckImage;
  123386. private _containerImage;
  123387. private _joystickPuckSize;
  123388. private _joystickContainerSize;
  123389. private _clearPuckSize;
  123390. private _clearContainerSize;
  123391. private _clearPuckSizeOffset;
  123392. private _clearContainerSizeOffset;
  123393. private _onPointerDownHandlerRef;
  123394. private _onPointerMoveHandlerRef;
  123395. private _onPointerUpHandlerRef;
  123396. private _onResize;
  123397. /**
  123398. * Creates a new virtual joystick
  123399. * @param leftJoystick defines that the joystick is for left hand (false by default)
  123400. * @param customizations Defines the options we want to customize the VirtualJoystick
  123401. */
  123402. constructor(leftJoystick?: boolean, customizations?: Partial<VirtualJoystickCustomizations>);
  123403. /**
  123404. * Defines joystick sensibility (ie. the ratio beteen a physical move and virtual joystick position change)
  123405. * @param newJoystickSensibility defines the new sensibility
  123406. */
  123407. setJoystickSensibility(newJoystickSensibility: number): void;
  123408. private _onPointerDown;
  123409. private _onPointerMove;
  123410. private _onPointerUp;
  123411. /**
  123412. * Change the color of the virtual joystick
  123413. * @param newColor a string that must be a CSS color value (like "red") or the hexa value (like "#FF0000")
  123414. */
  123415. setJoystickColor(newColor: string): void;
  123416. /**
  123417. * Size of the joystick's container
  123418. */
  123419. set containerSize(newSize: number);
  123420. get containerSize(): number;
  123421. /**
  123422. * Size of the joystick's puck
  123423. */
  123424. set puckSize(newSize: number);
  123425. get puckSize(): number;
  123426. /**
  123427. * Clears the set position of the joystick
  123428. */
  123429. clearPosition(): void;
  123430. /**
  123431. * Defines whether or not the joystick container is always visible
  123432. */
  123433. set alwaysVisible(value: boolean);
  123434. get alwaysVisible(): boolean;
  123435. /**
  123436. * Sets the constant position of the Joystick container
  123437. * @param x X axis coordinate
  123438. * @param y Y axis coordinate
  123439. */
  123440. setPosition(x: number, y: number): void;
  123441. /**
  123442. * Defines a callback to call when the joystick is touched
  123443. * @param action defines the callback
  123444. */
  123445. setActionOnTouch(action: () => any): void;
  123446. /**
  123447. * Defines which axis you'd like to control for left & right
  123448. * @param axis defines the axis to use
  123449. */
  123450. setAxisForLeftRight(axis: JoystickAxis): void;
  123451. /**
  123452. * Defines which axis you'd like to control for up & down
  123453. * @param axis defines the axis to use
  123454. */
  123455. setAxisForUpDown(axis: JoystickAxis): void;
  123456. /**
  123457. * Clears the canvas from the previous puck / container draw
  123458. */
  123459. private _clearPreviousDraw;
  123460. /**
  123461. * Loads `urlPath` to be used for the container's image
  123462. * @param urlPath defines the urlPath of an image to use
  123463. */
  123464. setContainerImage(urlPath: string): void;
  123465. /**
  123466. * Loads `urlPath` to be used for the puck's image
  123467. * @param urlPath defines the urlPath of an image to use
  123468. */
  123469. setPuckImage(urlPath: string): void;
  123470. /**
  123471. * Draws the Virtual Joystick's container
  123472. */
  123473. private _drawContainer;
  123474. /**
  123475. * Draws the Virtual Joystick's puck
  123476. */
  123477. private _drawPuck;
  123478. private _drawVirtualJoystick;
  123479. /**
  123480. * Release internal HTML canvas
  123481. */
  123482. releaseCanvas(): void;
  123483. }
  123484. }
  123485. declare module BABYLON {
  123486. interface FreeCameraInputsManager {
  123487. /**
  123488. * Add virtual joystick input support to the input manager.
  123489. * @returns the current input manager
  123490. */
  123491. addVirtualJoystick(): FreeCameraInputsManager;
  123492. }
  123493. /**
  123494. * Manage the Virtual Joystick inputs to control the movement of a free camera.
  123495. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  123496. */
  123497. export class FreeCameraVirtualJoystickInput implements ICameraInput<FreeCamera> {
  123498. /**
  123499. * Defines the camera the input is attached to.
  123500. */
  123501. camera: FreeCamera;
  123502. private _leftjoystick;
  123503. private _rightjoystick;
  123504. /**
  123505. * Gets the left stick of the virtual joystick.
  123506. * @returns The virtual Joystick
  123507. */
  123508. getLeftJoystick(): VirtualJoystick;
  123509. /**
  123510. * Gets the right stick of the virtual joystick.
  123511. * @returns The virtual Joystick
  123512. */
  123513. getRightJoystick(): VirtualJoystick;
  123514. /**
  123515. * Update the current camera state depending on the inputs that have been used this frame.
  123516. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  123517. */
  123518. checkInputs(): void;
  123519. /**
  123520. * Attach the input controls to a specific dom element to get the input from.
  123521. * @param element Defines the element the controls should be listened from
  123522. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  123523. */
  123524. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  123525. /**
  123526. * Detach the current controls from the specified dom element.
  123527. * @param element Defines the element to stop listening the inputs from
  123528. */
  123529. detachControl(element: Nullable<HTMLElement>): void;
  123530. /**
  123531. * Gets the class name of the current intput.
  123532. * @returns the class name
  123533. */
  123534. getClassName(): string;
  123535. /**
  123536. * Get the friendly name associated with the input class.
  123537. * @returns the input friendly name
  123538. */
  123539. getSimpleName(): string;
  123540. }
  123541. }
  123542. declare module BABYLON {
  123543. /**
  123544. * This represents a FPS type of camera controlled by touch.
  123545. * This is like a universal camera minus the Gamepad controls.
  123546. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  123547. */
  123548. export class TouchCamera extends FreeCamera {
  123549. /**
  123550. * Defines the touch sensibility for rotation.
  123551. * The higher the faster.
  123552. */
  123553. get touchAngularSensibility(): number;
  123554. set touchAngularSensibility(value: number);
  123555. /**
  123556. * Defines the touch sensibility for move.
  123557. * The higher the faster.
  123558. */
  123559. get touchMoveSensibility(): number;
  123560. set touchMoveSensibility(value: number);
  123561. /**
  123562. * Instantiates a new touch camera.
  123563. * This represents a FPS type of camera controlled by touch.
  123564. * This is like a universal camera minus the Gamepad controls.
  123565. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  123566. * @param name Define the name of the camera in the scene
  123567. * @param position Define the start position of the camera in the scene
  123568. * @param scene Define the scene the camera belongs to
  123569. */
  123570. constructor(name: string, position: Vector3, scene: Scene);
  123571. /**
  123572. * Gets the current object class name.
  123573. * @return the class name
  123574. */
  123575. getClassName(): string;
  123576. /** @hidden */
  123577. _setupInputs(): void;
  123578. }
  123579. }
  123580. declare module BABYLON {
  123581. /**
  123582. * This is a camera specifically designed to react to device orientation events such as a modern mobile device
  123583. * being tilted forward or back and left or right.
  123584. */
  123585. export class DeviceOrientationCamera extends FreeCamera {
  123586. private _initialQuaternion;
  123587. private _quaternionCache;
  123588. private _tmpDragQuaternion;
  123589. private _disablePointerInputWhenUsingDeviceOrientation;
  123590. /**
  123591. * Creates a new device orientation camera
  123592. * @param name The name of the camera
  123593. * @param position The start position camera
  123594. * @param scene The scene the camera belongs to
  123595. */
  123596. constructor(name: string, position: Vector3, scene: Scene);
  123597. /**
  123598. * Gets or sets a boolean indicating that pointer input must be disabled on first orientation sensor update (Default: true)
  123599. */
  123600. get disablePointerInputWhenUsingDeviceOrientation(): boolean;
  123601. set disablePointerInputWhenUsingDeviceOrientation(value: boolean);
  123602. private _dragFactor;
  123603. /**
  123604. * Enabled turning on the y axis when the orientation sensor is active
  123605. * @param dragFactor the factor that controls the turn speed (default: 1/300)
  123606. */
  123607. enableHorizontalDragging(dragFactor?: number): void;
  123608. /**
  123609. * Gets the current instance class name ("DeviceOrientationCamera").
  123610. * This helps avoiding instanceof at run time.
  123611. * @returns the class name
  123612. */
  123613. getClassName(): string;
  123614. /**
  123615. * @hidden
  123616. * Checks and applies the current values of the inputs to the camera. (Internal use only)
  123617. */
  123618. _checkInputs(): void;
  123619. /**
  123620. * Reset the camera to its default orientation on the specified axis only.
  123621. * @param axis The axis to reset
  123622. */
  123623. resetToCurrentRotation(axis?: Axis): void;
  123624. }
  123625. }
  123626. declare module BABYLON {
  123627. /**
  123628. * Defines supported buttons for XBox360 compatible gamepads
  123629. */
  123630. export enum Xbox360Button {
  123631. /** A */
  123632. A = 0,
  123633. /** B */
  123634. B = 1,
  123635. /** X */
  123636. X = 2,
  123637. /** Y */
  123638. Y = 3,
  123639. /** Left button */
  123640. LB = 4,
  123641. /** Right button */
  123642. RB = 5,
  123643. /** Back */
  123644. Back = 8,
  123645. /** Start */
  123646. Start = 9,
  123647. /** Left stick */
  123648. LeftStick = 10,
  123649. /** Right stick */
  123650. RightStick = 11
  123651. }
  123652. /** Defines values for XBox360 DPad */
  123653. export enum Xbox360Dpad {
  123654. /** Up */
  123655. Up = 12,
  123656. /** Down */
  123657. Down = 13,
  123658. /** Left */
  123659. Left = 14,
  123660. /** Right */
  123661. Right = 15
  123662. }
  123663. /**
  123664. * Defines a XBox360 gamepad
  123665. */
  123666. export class Xbox360Pad extends Gamepad {
  123667. private _leftTrigger;
  123668. private _rightTrigger;
  123669. private _onlefttriggerchanged;
  123670. private _onrighttriggerchanged;
  123671. private _onbuttondown;
  123672. private _onbuttonup;
  123673. private _ondpaddown;
  123674. private _ondpadup;
  123675. /** Observable raised when a button is pressed */
  123676. onButtonDownObservable: Observable<Xbox360Button>;
  123677. /** Observable raised when a button is released */
  123678. onButtonUpObservable: Observable<Xbox360Button>;
  123679. /** Observable raised when a pad is pressed */
  123680. onPadDownObservable: Observable<Xbox360Dpad>;
  123681. /** Observable raised when a pad is released */
  123682. onPadUpObservable: Observable<Xbox360Dpad>;
  123683. private _buttonA;
  123684. private _buttonB;
  123685. private _buttonX;
  123686. private _buttonY;
  123687. private _buttonBack;
  123688. private _buttonStart;
  123689. private _buttonLB;
  123690. private _buttonRB;
  123691. private _buttonLeftStick;
  123692. private _buttonRightStick;
  123693. private _dPadUp;
  123694. private _dPadDown;
  123695. private _dPadLeft;
  123696. private _dPadRight;
  123697. private _isXboxOnePad;
  123698. /**
  123699. * Creates a new XBox360 gamepad object
  123700. * @param id defines the id of this gamepad
  123701. * @param index defines its index
  123702. * @param gamepad defines the internal HTML gamepad object
  123703. * @param xboxOne defines if it is a XBox One gamepad
  123704. */
  123705. constructor(id: string, index: number, gamepad: any, xboxOne?: boolean);
  123706. /**
  123707. * Defines the callback to call when left trigger is pressed
  123708. * @param callback defines the callback to use
  123709. */
  123710. onlefttriggerchanged(callback: (value: number) => void): void;
  123711. /**
  123712. * Defines the callback to call when right trigger is pressed
  123713. * @param callback defines the callback to use
  123714. */
  123715. onrighttriggerchanged(callback: (value: number) => void): void;
  123716. /**
  123717. * Gets the left trigger value
  123718. */
  123719. get leftTrigger(): number;
  123720. /**
  123721. * Sets the left trigger value
  123722. */
  123723. set leftTrigger(newValue: number);
  123724. /**
  123725. * Gets the right trigger value
  123726. */
  123727. get rightTrigger(): number;
  123728. /**
  123729. * Sets the right trigger value
  123730. */
  123731. set rightTrigger(newValue: number);
  123732. /**
  123733. * Defines the callback to call when a button is pressed
  123734. * @param callback defines the callback to use
  123735. */
  123736. onbuttondown(callback: (buttonPressed: Xbox360Button) => void): void;
  123737. /**
  123738. * Defines the callback to call when a button is released
  123739. * @param callback defines the callback to use
  123740. */
  123741. onbuttonup(callback: (buttonReleased: Xbox360Button) => void): void;
  123742. /**
  123743. * Defines the callback to call when a pad is pressed
  123744. * @param callback defines the callback to use
  123745. */
  123746. ondpaddown(callback: (dPadPressed: Xbox360Dpad) => void): void;
  123747. /**
  123748. * Defines the callback to call when a pad is released
  123749. * @param callback defines the callback to use
  123750. */
  123751. ondpadup(callback: (dPadReleased: Xbox360Dpad) => void): void;
  123752. private _setButtonValue;
  123753. private _setDPadValue;
  123754. /**
  123755. * Gets the value of the `A` button
  123756. */
  123757. get buttonA(): number;
  123758. /**
  123759. * Sets the value of the `A` button
  123760. */
  123761. set buttonA(value: number);
  123762. /**
  123763. * Gets the value of the `B` button
  123764. */
  123765. get buttonB(): number;
  123766. /**
  123767. * Sets the value of the `B` button
  123768. */
  123769. set buttonB(value: number);
  123770. /**
  123771. * Gets the value of the `X` button
  123772. */
  123773. get buttonX(): number;
  123774. /**
  123775. * Sets the value of the `X` button
  123776. */
  123777. set buttonX(value: number);
  123778. /**
  123779. * Gets the value of the `Y` button
  123780. */
  123781. get buttonY(): number;
  123782. /**
  123783. * Sets the value of the `Y` button
  123784. */
  123785. set buttonY(value: number);
  123786. /**
  123787. * Gets the value of the `Start` button
  123788. */
  123789. get buttonStart(): number;
  123790. /**
  123791. * Sets the value of the `Start` button
  123792. */
  123793. set buttonStart(value: number);
  123794. /**
  123795. * Gets the value of the `Back` button
  123796. */
  123797. get buttonBack(): number;
  123798. /**
  123799. * Sets the value of the `Back` button
  123800. */
  123801. set buttonBack(value: number);
  123802. /**
  123803. * Gets the value of the `Left` button
  123804. */
  123805. get buttonLB(): number;
  123806. /**
  123807. * Sets the value of the `Left` button
  123808. */
  123809. set buttonLB(value: number);
  123810. /**
  123811. * Gets the value of the `Right` button
  123812. */
  123813. get buttonRB(): number;
  123814. /**
  123815. * Sets the value of the `Right` button
  123816. */
  123817. set buttonRB(value: number);
  123818. /**
  123819. * Gets the value of the Left joystick
  123820. */
  123821. get buttonLeftStick(): number;
  123822. /**
  123823. * Sets the value of the Left joystick
  123824. */
  123825. set buttonLeftStick(value: number);
  123826. /**
  123827. * Gets the value of the Right joystick
  123828. */
  123829. get buttonRightStick(): number;
  123830. /**
  123831. * Sets the value of the Right joystick
  123832. */
  123833. set buttonRightStick(value: number);
  123834. /**
  123835. * Gets the value of D-pad up
  123836. */
  123837. get dPadUp(): number;
  123838. /**
  123839. * Sets the value of D-pad up
  123840. */
  123841. set dPadUp(value: number);
  123842. /**
  123843. * Gets the value of D-pad down
  123844. */
  123845. get dPadDown(): number;
  123846. /**
  123847. * Sets the value of D-pad down
  123848. */
  123849. set dPadDown(value: number);
  123850. /**
  123851. * Gets the value of D-pad left
  123852. */
  123853. get dPadLeft(): number;
  123854. /**
  123855. * Sets the value of D-pad left
  123856. */
  123857. set dPadLeft(value: number);
  123858. /**
  123859. * Gets the value of D-pad right
  123860. */
  123861. get dPadRight(): number;
  123862. /**
  123863. * Sets the value of D-pad right
  123864. */
  123865. set dPadRight(value: number);
  123866. /**
  123867. * Force the gamepad to synchronize with device values
  123868. */
  123869. update(): void;
  123870. /**
  123871. * Disposes the gamepad
  123872. */
  123873. dispose(): void;
  123874. }
  123875. }
  123876. declare module BABYLON {
  123877. /**
  123878. * Defines supported buttons for DualShock compatible gamepads
  123879. */
  123880. export enum DualShockButton {
  123881. /** Cross */
  123882. Cross = 0,
  123883. /** Circle */
  123884. Circle = 1,
  123885. /** Square */
  123886. Square = 2,
  123887. /** Triangle */
  123888. Triangle = 3,
  123889. /** L1 */
  123890. L1 = 4,
  123891. /** R1 */
  123892. R1 = 5,
  123893. /** Share */
  123894. Share = 8,
  123895. /** Options */
  123896. Options = 9,
  123897. /** Left stick */
  123898. LeftStick = 10,
  123899. /** Right stick */
  123900. RightStick = 11
  123901. }
  123902. /** Defines values for DualShock DPad */
  123903. export enum DualShockDpad {
  123904. /** Up */
  123905. Up = 12,
  123906. /** Down */
  123907. Down = 13,
  123908. /** Left */
  123909. Left = 14,
  123910. /** Right */
  123911. Right = 15
  123912. }
  123913. /**
  123914. * Defines a DualShock gamepad
  123915. */
  123916. export class DualShockPad extends Gamepad {
  123917. private _leftTrigger;
  123918. private _rightTrigger;
  123919. private _onlefttriggerchanged;
  123920. private _onrighttriggerchanged;
  123921. private _onbuttondown;
  123922. private _onbuttonup;
  123923. private _ondpaddown;
  123924. private _ondpadup;
  123925. /** Observable raised when a button is pressed */
  123926. onButtonDownObservable: Observable<DualShockButton>;
  123927. /** Observable raised when a button is released */
  123928. onButtonUpObservable: Observable<DualShockButton>;
  123929. /** Observable raised when a pad is pressed */
  123930. onPadDownObservable: Observable<DualShockDpad>;
  123931. /** Observable raised when a pad is released */
  123932. onPadUpObservable: Observable<DualShockDpad>;
  123933. private _buttonCross;
  123934. private _buttonCircle;
  123935. private _buttonSquare;
  123936. private _buttonTriangle;
  123937. private _buttonShare;
  123938. private _buttonOptions;
  123939. private _buttonL1;
  123940. private _buttonR1;
  123941. private _buttonLeftStick;
  123942. private _buttonRightStick;
  123943. private _dPadUp;
  123944. private _dPadDown;
  123945. private _dPadLeft;
  123946. private _dPadRight;
  123947. /**
  123948. * Creates a new DualShock gamepad object
  123949. * @param id defines the id of this gamepad
  123950. * @param index defines its index
  123951. * @param gamepad defines the internal HTML gamepad object
  123952. */
  123953. constructor(id: string, index: number, gamepad: any);
  123954. /**
  123955. * Defines the callback to call when left trigger is pressed
  123956. * @param callback defines the callback to use
  123957. */
  123958. onlefttriggerchanged(callback: (value: number) => void): void;
  123959. /**
  123960. * Defines the callback to call when right trigger is pressed
  123961. * @param callback defines the callback to use
  123962. */
  123963. onrighttriggerchanged(callback: (value: number) => void): void;
  123964. /**
  123965. * Gets the left trigger value
  123966. */
  123967. get leftTrigger(): number;
  123968. /**
  123969. * Sets the left trigger value
  123970. */
  123971. set leftTrigger(newValue: number);
  123972. /**
  123973. * Gets the right trigger value
  123974. */
  123975. get rightTrigger(): number;
  123976. /**
  123977. * Sets the right trigger value
  123978. */
  123979. set rightTrigger(newValue: number);
  123980. /**
  123981. * Defines the callback to call when a button is pressed
  123982. * @param callback defines the callback to use
  123983. */
  123984. onbuttondown(callback: (buttonPressed: DualShockButton) => void): void;
  123985. /**
  123986. * Defines the callback to call when a button is released
  123987. * @param callback defines the callback to use
  123988. */
  123989. onbuttonup(callback: (buttonReleased: DualShockButton) => void): void;
  123990. /**
  123991. * Defines the callback to call when a pad is pressed
  123992. * @param callback defines the callback to use
  123993. */
  123994. ondpaddown(callback: (dPadPressed: DualShockDpad) => void): void;
  123995. /**
  123996. * Defines the callback to call when a pad is released
  123997. * @param callback defines the callback to use
  123998. */
  123999. ondpadup(callback: (dPadReleased: DualShockDpad) => void): void;
  124000. private _setButtonValue;
  124001. private _setDPadValue;
  124002. /**
  124003. * Gets the value of the `Cross` button
  124004. */
  124005. get buttonCross(): number;
  124006. /**
  124007. * Sets the value of the `Cross` button
  124008. */
  124009. set buttonCross(value: number);
  124010. /**
  124011. * Gets the value of the `Circle` button
  124012. */
  124013. get buttonCircle(): number;
  124014. /**
  124015. * Sets the value of the `Circle` button
  124016. */
  124017. set buttonCircle(value: number);
  124018. /**
  124019. * Gets the value of the `Square` button
  124020. */
  124021. get buttonSquare(): number;
  124022. /**
  124023. * Sets the value of the `Square` button
  124024. */
  124025. set buttonSquare(value: number);
  124026. /**
  124027. * Gets the value of the `Triangle` button
  124028. */
  124029. get buttonTriangle(): number;
  124030. /**
  124031. * Sets the value of the `Triangle` button
  124032. */
  124033. set buttonTriangle(value: number);
  124034. /**
  124035. * Gets the value of the `Options` button
  124036. */
  124037. get buttonOptions(): number;
  124038. /**
  124039. * Sets the value of the `Options` button
  124040. */
  124041. set buttonOptions(value: number);
  124042. /**
  124043. * Gets the value of the `Share` button
  124044. */
  124045. get buttonShare(): number;
  124046. /**
  124047. * Sets the value of the `Share` button
  124048. */
  124049. set buttonShare(value: number);
  124050. /**
  124051. * Gets the value of the `L1` button
  124052. */
  124053. get buttonL1(): number;
  124054. /**
  124055. * Sets the value of the `L1` button
  124056. */
  124057. set buttonL1(value: number);
  124058. /**
  124059. * Gets the value of the `R1` button
  124060. */
  124061. get buttonR1(): number;
  124062. /**
  124063. * Sets the value of the `R1` button
  124064. */
  124065. set buttonR1(value: number);
  124066. /**
  124067. * Gets the value of the Left joystick
  124068. */
  124069. get buttonLeftStick(): number;
  124070. /**
  124071. * Sets the value of the Left joystick
  124072. */
  124073. set buttonLeftStick(value: number);
  124074. /**
  124075. * Gets the value of the Right joystick
  124076. */
  124077. get buttonRightStick(): number;
  124078. /**
  124079. * Sets the value of the Right joystick
  124080. */
  124081. set buttonRightStick(value: number);
  124082. /**
  124083. * Gets the value of D-pad up
  124084. */
  124085. get dPadUp(): number;
  124086. /**
  124087. * Sets the value of D-pad up
  124088. */
  124089. set dPadUp(value: number);
  124090. /**
  124091. * Gets the value of D-pad down
  124092. */
  124093. get dPadDown(): number;
  124094. /**
  124095. * Sets the value of D-pad down
  124096. */
  124097. set dPadDown(value: number);
  124098. /**
  124099. * Gets the value of D-pad left
  124100. */
  124101. get dPadLeft(): number;
  124102. /**
  124103. * Sets the value of D-pad left
  124104. */
  124105. set dPadLeft(value: number);
  124106. /**
  124107. * Gets the value of D-pad right
  124108. */
  124109. get dPadRight(): number;
  124110. /**
  124111. * Sets the value of D-pad right
  124112. */
  124113. set dPadRight(value: number);
  124114. /**
  124115. * Force the gamepad to synchronize with device values
  124116. */
  124117. update(): void;
  124118. /**
  124119. * Disposes the gamepad
  124120. */
  124121. dispose(): void;
  124122. }
  124123. }
  124124. declare module BABYLON {
  124125. /**
  124126. * Manager for handling gamepads
  124127. */
  124128. export class GamepadManager {
  124129. private _scene?;
  124130. private _babylonGamepads;
  124131. private _oneGamepadConnected;
  124132. /** @hidden */
  124133. _isMonitoring: boolean;
  124134. private _gamepadEventSupported;
  124135. private _gamepadSupport?;
  124136. /**
  124137. * observable to be triggered when the gamepad controller has been connected
  124138. */
  124139. onGamepadConnectedObservable: Observable<Gamepad>;
  124140. /**
  124141. * observable to be triggered when the gamepad controller has been disconnected
  124142. */
  124143. onGamepadDisconnectedObservable: Observable<Gamepad>;
  124144. private _onGamepadConnectedEvent;
  124145. private _onGamepadDisconnectedEvent;
  124146. /**
  124147. * Initializes the gamepad manager
  124148. * @param _scene BabylonJS scene
  124149. */
  124150. constructor(_scene?: Scene | undefined);
  124151. /**
  124152. * The gamepads in the game pad manager
  124153. */
  124154. get gamepads(): Gamepad[];
  124155. /**
  124156. * Get the gamepad controllers based on type
  124157. * @param type The type of gamepad controller
  124158. * @returns Nullable gamepad
  124159. */
  124160. getGamepadByType(type?: number): Nullable<Gamepad>;
  124161. /**
  124162. * Disposes the gamepad manager
  124163. */
  124164. dispose(): void;
  124165. private _addNewGamepad;
  124166. private _startMonitoringGamepads;
  124167. private _stopMonitoringGamepads;
  124168. /** @hidden */
  124169. _checkGamepadsStatus(): void;
  124170. private _updateGamepadObjects;
  124171. }
  124172. }
  124173. declare module BABYLON {
  124174. interface Scene {
  124175. /** @hidden */
  124176. _gamepadManager: Nullable<GamepadManager>;
  124177. /**
  124178. * Gets the gamepad manager associated with the scene
  124179. * @see https://doc.babylonjs.com/how_to/how_to_use_gamepads
  124180. */
  124181. gamepadManager: GamepadManager;
  124182. }
  124183. /**
  124184. * Interface representing a free camera inputs manager
  124185. */
  124186. interface FreeCameraInputsManager {
  124187. /**
  124188. * Adds gamepad input support to the FreeCameraInputsManager.
  124189. * @returns the FreeCameraInputsManager
  124190. */
  124191. addGamepad(): FreeCameraInputsManager;
  124192. }
  124193. /**
  124194. * Interface representing an arc rotate camera inputs manager
  124195. */
  124196. interface ArcRotateCameraInputsManager {
  124197. /**
  124198. * Adds gamepad input support to the ArcRotateCamera InputManager.
  124199. * @returns the camera inputs manager
  124200. */
  124201. addGamepad(): ArcRotateCameraInputsManager;
  124202. }
  124203. /**
  124204. * Defines the gamepad scene component responsible to manage gamepads in a given scene
  124205. */
  124206. export class GamepadSystemSceneComponent implements ISceneComponent {
  124207. /**
  124208. * The component name helpfull to identify the component in the list of scene components.
  124209. */
  124210. readonly name: string;
  124211. /**
  124212. * The scene the component belongs to.
  124213. */
  124214. scene: Scene;
  124215. /**
  124216. * Creates a new instance of the component for the given scene
  124217. * @param scene Defines the scene to register the component in
  124218. */
  124219. constructor(scene: Scene);
  124220. /**
  124221. * Registers the component in a given scene
  124222. */
  124223. register(): void;
  124224. /**
  124225. * Rebuilds the elements related to this component in case of
  124226. * context lost for instance.
  124227. */
  124228. rebuild(): void;
  124229. /**
  124230. * Disposes the component and the associated ressources
  124231. */
  124232. dispose(): void;
  124233. private _beforeCameraUpdate;
  124234. }
  124235. }
  124236. declare module BABYLON {
  124237. /**
  124238. * 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,
  124239. * which still works and will still be found in many Playgrounds.
  124240. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  124241. */
  124242. export class UniversalCamera extends TouchCamera {
  124243. /**
  124244. * Defines the gamepad rotation sensiblity.
  124245. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  124246. */
  124247. get gamepadAngularSensibility(): number;
  124248. set gamepadAngularSensibility(value: number);
  124249. /**
  124250. * Defines the gamepad move sensiblity.
  124251. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  124252. */
  124253. get gamepadMoveSensibility(): number;
  124254. set gamepadMoveSensibility(value: number);
  124255. /**
  124256. * 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,
  124257. * which still works and will still be found in many Playgrounds.
  124258. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  124259. * @param name Define the name of the camera in the scene
  124260. * @param position Define the start position of the camera in the scene
  124261. * @param scene Define the scene the camera belongs to
  124262. */
  124263. constructor(name: string, position: Vector3, scene: Scene);
  124264. /**
  124265. * Gets the current object class name.
  124266. * @return the class name
  124267. */
  124268. getClassName(): string;
  124269. }
  124270. }
  124271. declare module BABYLON {
  124272. /**
  124273. * This represents a FPS type of camera. This is only here for back compat purpose.
  124274. * Please use the UniversalCamera instead as both are identical.
  124275. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  124276. */
  124277. export class GamepadCamera extends UniversalCamera {
  124278. /**
  124279. * Instantiates a new Gamepad Camera
  124280. * This represents a FPS type of camera. This is only here for back compat purpose.
  124281. * Please use the UniversalCamera instead as both are identical.
  124282. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  124283. * @param name Define the name of the camera in the scene
  124284. * @param position Define the start position of the camera in the scene
  124285. * @param scene Define the scene the camera belongs to
  124286. */
  124287. constructor(name: string, position: Vector3, scene: Scene);
  124288. /**
  124289. * Gets the current object class name.
  124290. * @return the class name
  124291. */
  124292. getClassName(): string;
  124293. }
  124294. }
  124295. declare module BABYLON {
  124296. /** @hidden */
  124297. export var passPixelShader: {
  124298. name: string;
  124299. shader: string;
  124300. };
  124301. }
  124302. declare module BABYLON {
  124303. /** @hidden */
  124304. export var passCubePixelShader: {
  124305. name: string;
  124306. shader: string;
  124307. };
  124308. }
  124309. declare module BABYLON {
  124310. /**
  124311. * PassPostProcess which produces an output the same as it's input
  124312. */
  124313. export class PassPostProcess extends PostProcess {
  124314. /**
  124315. * Creates the PassPostProcess
  124316. * @param name The name of the effect.
  124317. * @param options The required width/height ratio to downsize to before computing the render pass.
  124318. * @param camera The camera to apply the render pass to.
  124319. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  124320. * @param engine The engine which the post process will be applied. (default: current engine)
  124321. * @param reusable If the post process can be reused on the same frame. (default: false)
  124322. * @param textureType The type of texture to be used when performing the post processing.
  124323. * @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)
  124324. */
  124325. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  124326. }
  124327. /**
  124328. * PassCubePostProcess which produces an output the same as it's input (which must be a cube texture)
  124329. */
  124330. export class PassCubePostProcess extends PostProcess {
  124331. private _face;
  124332. /**
  124333. * Gets or sets the cube face to display.
  124334. * * 0 is +X
  124335. * * 1 is -X
  124336. * * 2 is +Y
  124337. * * 3 is -Y
  124338. * * 4 is +Z
  124339. * * 5 is -Z
  124340. */
  124341. get face(): number;
  124342. set face(value: number);
  124343. /**
  124344. * Creates the PassCubePostProcess
  124345. * @param name The name of the effect.
  124346. * @param options The required width/height ratio to downsize to before computing the render pass.
  124347. * @param camera The camera to apply the render pass to.
  124348. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  124349. * @param engine The engine which the post process will be applied. (default: current engine)
  124350. * @param reusable If the post process can be reused on the same frame. (default: false)
  124351. * @param textureType The type of texture to be used when performing the post processing.
  124352. * @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)
  124353. */
  124354. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  124355. }
  124356. }
  124357. declare module BABYLON {
  124358. /** @hidden */
  124359. export var anaglyphPixelShader: {
  124360. name: string;
  124361. shader: string;
  124362. };
  124363. }
  124364. declare module BABYLON {
  124365. /**
  124366. * Postprocess used to generate anaglyphic rendering
  124367. */
  124368. export class AnaglyphPostProcess extends PostProcess {
  124369. private _passedProcess;
  124370. /**
  124371. * Creates a new AnaglyphPostProcess
  124372. * @param name defines postprocess name
  124373. * @param options defines creation options or target ratio scale
  124374. * @param rigCameras defines cameras using this postprocess
  124375. * @param samplingMode defines required sampling mode (BABYLON.Texture.NEAREST_SAMPLINGMODE by default)
  124376. * @param engine defines hosting engine
  124377. * @param reusable defines if the postprocess will be reused multiple times per frame
  124378. */
  124379. constructor(name: string, options: number | PostProcessOptions, rigCameras: Camera[], samplingMode?: number, engine?: Engine, reusable?: boolean);
  124380. }
  124381. }
  124382. declare module BABYLON {
  124383. /**
  124384. * Camera used to simulate anaglyphic rendering (based on ArcRotateCamera)
  124385. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  124386. */
  124387. export class AnaglyphArcRotateCamera extends ArcRotateCamera {
  124388. /**
  124389. * Creates a new AnaglyphArcRotateCamera
  124390. * @param name defines camera name
  124391. * @param alpha defines alpha angle (in radians)
  124392. * @param beta defines beta angle (in radians)
  124393. * @param radius defines radius
  124394. * @param target defines camera target
  124395. * @param interaxialDistance defines distance between each color axis
  124396. * @param scene defines the hosting scene
  124397. */
  124398. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, interaxialDistance: number, scene: Scene);
  124399. /**
  124400. * Gets camera class name
  124401. * @returns AnaglyphArcRotateCamera
  124402. */
  124403. getClassName(): string;
  124404. }
  124405. }
  124406. declare module BABYLON {
  124407. /**
  124408. * Camera used to simulate anaglyphic rendering (based on FreeCamera)
  124409. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  124410. */
  124411. export class AnaglyphFreeCamera extends FreeCamera {
  124412. /**
  124413. * Creates a new AnaglyphFreeCamera
  124414. * @param name defines camera name
  124415. * @param position defines initial position
  124416. * @param interaxialDistance defines distance between each color axis
  124417. * @param scene defines the hosting scene
  124418. */
  124419. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  124420. /**
  124421. * Gets camera class name
  124422. * @returns AnaglyphFreeCamera
  124423. */
  124424. getClassName(): string;
  124425. }
  124426. }
  124427. declare module BABYLON {
  124428. /**
  124429. * Camera used to simulate anaglyphic rendering (based on GamepadCamera)
  124430. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  124431. */
  124432. export class AnaglyphGamepadCamera extends GamepadCamera {
  124433. /**
  124434. * Creates a new AnaglyphGamepadCamera
  124435. * @param name defines camera name
  124436. * @param position defines initial position
  124437. * @param interaxialDistance defines distance between each color axis
  124438. * @param scene defines the hosting scene
  124439. */
  124440. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  124441. /**
  124442. * Gets camera class name
  124443. * @returns AnaglyphGamepadCamera
  124444. */
  124445. getClassName(): string;
  124446. }
  124447. }
  124448. declare module BABYLON {
  124449. /**
  124450. * Camera used to simulate anaglyphic rendering (based on UniversalCamera)
  124451. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  124452. */
  124453. export class AnaglyphUniversalCamera extends UniversalCamera {
  124454. /**
  124455. * Creates a new AnaglyphUniversalCamera
  124456. * @param name defines camera name
  124457. * @param position defines initial position
  124458. * @param interaxialDistance defines distance between each color axis
  124459. * @param scene defines the hosting scene
  124460. */
  124461. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  124462. /**
  124463. * Gets camera class name
  124464. * @returns AnaglyphUniversalCamera
  124465. */
  124466. getClassName(): string;
  124467. }
  124468. }
  124469. declare module BABYLON {
  124470. /**
  124471. * Camera used to simulate stereoscopic rendering (based on ArcRotateCamera)
  124472. * @see https://doc.babylonjs.com/features/cameras
  124473. */
  124474. export class StereoscopicArcRotateCamera extends ArcRotateCamera {
  124475. /**
  124476. * Creates a new StereoscopicArcRotateCamera
  124477. * @param name defines camera name
  124478. * @param alpha defines alpha angle (in radians)
  124479. * @param beta defines beta angle (in radians)
  124480. * @param radius defines radius
  124481. * @param target defines camera target
  124482. * @param interaxialDistance defines distance between each color axis
  124483. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  124484. * @param scene defines the hosting scene
  124485. */
  124486. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  124487. /**
  124488. * Gets camera class name
  124489. * @returns StereoscopicArcRotateCamera
  124490. */
  124491. getClassName(): string;
  124492. }
  124493. }
  124494. declare module BABYLON {
  124495. /**
  124496. * Camera used to simulate stereoscopic rendering (based on FreeCamera)
  124497. * @see https://doc.babylonjs.com/features/cameras
  124498. */
  124499. export class StereoscopicFreeCamera extends FreeCamera {
  124500. /**
  124501. * Creates a new StereoscopicFreeCamera
  124502. * @param name defines camera name
  124503. * @param position defines initial position
  124504. * @param interaxialDistance defines distance between each color axis
  124505. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  124506. * @param scene defines the hosting scene
  124507. */
  124508. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  124509. /**
  124510. * Gets camera class name
  124511. * @returns StereoscopicFreeCamera
  124512. */
  124513. getClassName(): string;
  124514. }
  124515. }
  124516. declare module BABYLON {
  124517. /**
  124518. * Camera used to simulate stereoscopic rendering (based on GamepadCamera)
  124519. * @see https://doc.babylonjs.com/features/cameras
  124520. */
  124521. export class StereoscopicGamepadCamera extends GamepadCamera {
  124522. /**
  124523. * Creates a new StereoscopicGamepadCamera
  124524. * @param name defines camera name
  124525. * @param position defines initial position
  124526. * @param interaxialDistance defines distance between each color axis
  124527. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  124528. * @param scene defines the hosting scene
  124529. */
  124530. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  124531. /**
  124532. * Gets camera class name
  124533. * @returns StereoscopicGamepadCamera
  124534. */
  124535. getClassName(): string;
  124536. }
  124537. }
  124538. declare module BABYLON {
  124539. /**
  124540. * Camera used to simulate stereoscopic rendering (based on UniversalCamera)
  124541. * @see https://doc.babylonjs.com/features/cameras
  124542. */
  124543. export class StereoscopicUniversalCamera extends UniversalCamera {
  124544. /**
  124545. * Creates a new StereoscopicUniversalCamera
  124546. * @param name defines camera name
  124547. * @param position defines initial position
  124548. * @param interaxialDistance defines distance between each color axis
  124549. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  124550. * @param scene defines the hosting scene
  124551. */
  124552. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  124553. /**
  124554. * Gets camera class name
  124555. * @returns StereoscopicUniversalCamera
  124556. */
  124557. getClassName(): string;
  124558. }
  124559. }
  124560. declare module BABYLON {
  124561. /**
  124562. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  124563. * It is identical to the Free Camera and simply adds by default a virtual joystick.
  124564. * Virtual Joysticks are on-screen 2D graphics that are used to control the camera or other scene items.
  124565. * @see https://doc.babylonjs.com/features/cameras#virtual-joysticks-camera
  124566. */
  124567. export class VirtualJoysticksCamera extends FreeCamera {
  124568. /**
  124569. * Intantiates a VirtualJoysticksCamera. It can be useful in First Person Shooter game for instance.
  124570. * It is identical to the Free Camera and simply adds by default a virtual joystick.
  124571. * Virtual Joysticks are on-screen 2D graphics that are used to control the camera or other scene items.
  124572. * @see https://doc.babylonjs.com/features/cameras#virtual-joysticks-camera
  124573. * @param name Define the name of the camera in the scene
  124574. * @param position Define the start position of the camera in the scene
  124575. * @param scene Define the scene the camera belongs to
  124576. */
  124577. constructor(name: string, position: Vector3, scene: Scene);
  124578. /**
  124579. * Gets the current object class name.
  124580. * @return the class name
  124581. */
  124582. getClassName(): string;
  124583. }
  124584. }
  124585. declare module BABYLON {
  124586. /**
  124587. * This represents all the required metrics to create a VR camera.
  124588. * @see https://doc.babylonjs.com/babylon101/cameras#device-orientation-camera
  124589. */
  124590. export class VRCameraMetrics {
  124591. /**
  124592. * Define the horizontal resolution off the screen.
  124593. */
  124594. hResolution: number;
  124595. /**
  124596. * Define the vertical resolution off the screen.
  124597. */
  124598. vResolution: number;
  124599. /**
  124600. * Define the horizontal screen size.
  124601. */
  124602. hScreenSize: number;
  124603. /**
  124604. * Define the vertical screen size.
  124605. */
  124606. vScreenSize: number;
  124607. /**
  124608. * Define the vertical screen center position.
  124609. */
  124610. vScreenCenter: number;
  124611. /**
  124612. * Define the distance of the eyes to the screen.
  124613. */
  124614. eyeToScreenDistance: number;
  124615. /**
  124616. * Define the distance between both lenses
  124617. */
  124618. lensSeparationDistance: number;
  124619. /**
  124620. * Define the distance between both viewer's eyes.
  124621. */
  124622. interpupillaryDistance: number;
  124623. /**
  124624. * Define the distortion factor of the VR postprocess.
  124625. * Please, touch with care.
  124626. */
  124627. distortionK: number[];
  124628. /**
  124629. * Define the chromatic aberration correction factors for the VR post process.
  124630. */
  124631. chromaAbCorrection: number[];
  124632. /**
  124633. * Define the scale factor of the post process.
  124634. * The smaller the better but the slower.
  124635. */
  124636. postProcessScaleFactor: number;
  124637. /**
  124638. * Define an offset for the lens center.
  124639. */
  124640. lensCenterOffset: number;
  124641. /**
  124642. * Define if the current vr camera should compensate the distortion of the lense or not.
  124643. */
  124644. compensateDistortion: boolean;
  124645. /**
  124646. * Defines if multiview should be enabled when rendering (Default: false)
  124647. */
  124648. multiviewEnabled: boolean;
  124649. /**
  124650. * Gets the rendering aspect ratio based on the provided resolutions.
  124651. */
  124652. get aspectRatio(): number;
  124653. /**
  124654. * Gets the aspect ratio based on the FOV, scale factors, and real screen sizes.
  124655. */
  124656. get aspectRatioFov(): number;
  124657. /**
  124658. * @hidden
  124659. */
  124660. get leftHMatrix(): Matrix;
  124661. /**
  124662. * @hidden
  124663. */
  124664. get rightHMatrix(): Matrix;
  124665. /**
  124666. * @hidden
  124667. */
  124668. get leftPreViewMatrix(): Matrix;
  124669. /**
  124670. * @hidden
  124671. */
  124672. get rightPreViewMatrix(): Matrix;
  124673. /**
  124674. * Get the default VRMetrics based on the most generic setup.
  124675. * @returns the default vr metrics
  124676. */
  124677. static GetDefault(): VRCameraMetrics;
  124678. }
  124679. }
  124680. declare module BABYLON {
  124681. /** @hidden */
  124682. export var vrDistortionCorrectionPixelShader: {
  124683. name: string;
  124684. shader: string;
  124685. };
  124686. }
  124687. declare module BABYLON {
  124688. /**
  124689. * VRDistortionCorrectionPostProcess used for mobile VR
  124690. */
  124691. export class VRDistortionCorrectionPostProcess extends PostProcess {
  124692. private _isRightEye;
  124693. private _distortionFactors;
  124694. private _postProcessScaleFactor;
  124695. private _lensCenterOffset;
  124696. private _scaleIn;
  124697. private _scaleFactor;
  124698. private _lensCenter;
  124699. /**
  124700. * Initializes the VRDistortionCorrectionPostProcess
  124701. * @param name The name of the effect.
  124702. * @param camera The camera to apply the render pass to.
  124703. * @param isRightEye If this is for the right eye distortion
  124704. * @param vrMetrics All the required metrics for the VR camera
  124705. */
  124706. constructor(name: string, camera: Camera, isRightEye: boolean, vrMetrics: VRCameraMetrics);
  124707. }
  124708. }
  124709. declare module BABYLON {
  124710. /**
  124711. * Camera used to simulate VR rendering (based on ArcRotateCamera)
  124712. * @see https://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  124713. */
  124714. export class VRDeviceOrientationArcRotateCamera extends ArcRotateCamera {
  124715. /**
  124716. * Creates a new VRDeviceOrientationArcRotateCamera
  124717. * @param name defines camera name
  124718. * @param alpha defines the camera rotation along the logitudinal axis
  124719. * @param beta defines the camera rotation along the latitudinal axis
  124720. * @param radius defines the camera distance from its target
  124721. * @param target defines the camera target
  124722. * @param scene defines the scene the camera belongs to
  124723. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  124724. * @param vrCameraMetrics defines the vr metrics associated to the camera
  124725. */
  124726. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  124727. /**
  124728. * Gets camera class name
  124729. * @returns VRDeviceOrientationArcRotateCamera
  124730. */
  124731. getClassName(): string;
  124732. }
  124733. }
  124734. declare module BABYLON {
  124735. /**
  124736. * Camera used to simulate VR rendering (based on FreeCamera)
  124737. * @see https://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  124738. */
  124739. export class VRDeviceOrientationFreeCamera extends DeviceOrientationCamera {
  124740. /**
  124741. * Creates a new VRDeviceOrientationFreeCamera
  124742. * @param name defines camera name
  124743. * @param position defines the start position of the camera
  124744. * @param scene defines the scene the camera belongs to
  124745. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  124746. * @param vrCameraMetrics defines the vr metrics associated to the camera
  124747. */
  124748. constructor(name: string, position: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  124749. /**
  124750. * Gets camera class name
  124751. * @returns VRDeviceOrientationFreeCamera
  124752. */
  124753. getClassName(): string;
  124754. }
  124755. }
  124756. declare module BABYLON {
  124757. /**
  124758. * Camera used to simulate VR rendering (based on VRDeviceOrientationFreeCamera)
  124759. * @see https://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  124760. */
  124761. export class VRDeviceOrientationGamepadCamera extends VRDeviceOrientationFreeCamera {
  124762. /**
  124763. * Creates a new VRDeviceOrientationGamepadCamera
  124764. * @param name defines camera name
  124765. * @param position defines the start position of the camera
  124766. * @param scene defines the scene the camera belongs to
  124767. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  124768. * @param vrCameraMetrics defines the vr metrics associated to the camera
  124769. */
  124770. constructor(name: string, position: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  124771. /**
  124772. * Gets camera class name
  124773. * @returns VRDeviceOrientationGamepadCamera
  124774. */
  124775. getClassName(): string;
  124776. }
  124777. }
  124778. declare module BABYLON {
  124779. /**
  124780. * A class extending Texture allowing drawing on a texture
  124781. * @see https://doc.babylonjs.com/how_to/dynamictexture
  124782. */
  124783. export class DynamicTexture extends Texture {
  124784. private _generateMipMaps;
  124785. private _canvas;
  124786. private _context;
  124787. /**
  124788. * Creates a DynamicTexture
  124789. * @param name defines the name of the texture
  124790. * @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
  124791. * @param scene defines the scene where you want the texture
  124792. * @param generateMipMaps defines the use of MinMaps or not (default is false)
  124793. * @param samplingMode defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  124794. * @param format defines the texture format to use (default is Engine.TEXTUREFORMAT_RGBA)
  124795. */
  124796. constructor(name: string, options: any, scene: Scene | null | undefined, generateMipMaps: boolean, samplingMode?: number, format?: number);
  124797. /**
  124798. * Get the current class name of the texture useful for serialization or dynamic coding.
  124799. * @returns "DynamicTexture"
  124800. */
  124801. getClassName(): string;
  124802. /**
  124803. * Gets the current state of canRescale
  124804. */
  124805. get canRescale(): boolean;
  124806. private _recreate;
  124807. /**
  124808. * Scales the texture
  124809. * @param ratio the scale factor to apply to both width and height
  124810. */
  124811. scale(ratio: number): void;
  124812. /**
  124813. * Resizes the texture
  124814. * @param width the new width
  124815. * @param height the new height
  124816. */
  124817. scaleTo(width: number, height: number): void;
  124818. /**
  124819. * Gets the context of the canvas used by the texture
  124820. * @returns the canvas context of the dynamic texture
  124821. */
  124822. getContext(): CanvasRenderingContext2D;
  124823. /**
  124824. * Clears the texture
  124825. */
  124826. clear(): void;
  124827. /**
  124828. * Updates the texture
  124829. * @param invertY defines the direction for the Y axis (default is true - y increases downwards)
  124830. * @param premulAlpha defines if alpha is stored as premultiplied (default is false)
  124831. */
  124832. update(invertY?: boolean, premulAlpha?: boolean): void;
  124833. /**
  124834. * Draws text onto the texture
  124835. * @param text defines the text to be drawn
  124836. * @param x defines the placement of the text from the left
  124837. * @param y defines the placement of the text from the top when invertY is true and from the bottom when false
  124838. * @param font defines the font to be used with font-style, font-size, font-name
  124839. * @param color defines the color used for the text
  124840. * @param clearColor defines the color for the canvas, use null to not overwrite canvas
  124841. * @param invertY defines the direction for the Y axis (default is true - y increases downwards)
  124842. * @param update defines whether texture is immediately update (default is true)
  124843. */
  124844. drawText(text: string, x: number | null | undefined, y: number | null | undefined, font: string, color: string | null, clearColor: string, invertY?: boolean, update?: boolean): void;
  124845. /**
  124846. * Clones the texture
  124847. * @returns the clone of the texture.
  124848. */
  124849. clone(): DynamicTexture;
  124850. /**
  124851. * Serializes the dynamic texture. The scene should be ready before the dynamic texture is serialized
  124852. * @returns a serialized dynamic texture object
  124853. */
  124854. serialize(): any;
  124855. private _IsCanvasElement;
  124856. /** @hidden */
  124857. _rebuild(): void;
  124858. }
  124859. }
  124860. declare module BABYLON {
  124861. /**
  124862. * Class containing static functions to help procedurally build meshes
  124863. */
  124864. export class GroundBuilder {
  124865. /**
  124866. * Creates a ground mesh
  124867. * * The parameters `width` and `height` (floats, default 1) set the width and height sizes of the ground
  124868. * * The parameter `subdivisions` (positive integer) sets the number of subdivisions per side
  124869. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  124870. * @param name defines the name of the mesh
  124871. * @param options defines the options used to create the mesh
  124872. * @param scene defines the hosting scene
  124873. * @returns the ground mesh
  124874. * @see https://doc.babylonjs.com/how_to/set_shapes#ground
  124875. */
  124876. static CreateGround(name: string, options: {
  124877. width?: number;
  124878. height?: number;
  124879. subdivisions?: number;
  124880. subdivisionsX?: number;
  124881. subdivisionsY?: number;
  124882. updatable?: boolean;
  124883. }, scene: any): Mesh;
  124884. /**
  124885. * Creates a tiled ground mesh
  124886. * * The parameters `xmin` and `xmax` (floats, default -1 and 1) set the ground minimum and maximum X coordinates
  124887. * * The parameters `zmin` and `zmax` (floats, default -1 and 1) set the ground minimum and maximum Z coordinates
  124888. * * 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
  124889. * * 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
  124890. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  124891. * @param name defines the name of the mesh
  124892. * @param options defines the options used to create the mesh
  124893. * @param scene defines the hosting scene
  124894. * @returns the tiled ground mesh
  124895. * @see https://doc.babylonjs.com/how_to/set_shapes#tiled-ground
  124896. */
  124897. static CreateTiledGround(name: string, options: {
  124898. xmin: number;
  124899. zmin: number;
  124900. xmax: number;
  124901. zmax: number;
  124902. subdivisions?: {
  124903. w: number;
  124904. h: number;
  124905. };
  124906. precision?: {
  124907. w: number;
  124908. h: number;
  124909. };
  124910. updatable?: boolean;
  124911. }, scene?: Nullable<Scene>): Mesh;
  124912. /**
  124913. * Creates a ground mesh from a height map
  124914. * * The parameter `url` sets the URL of the height map image resource.
  124915. * * The parameters `width` and `height` (positive floats, default 10) set the ground width and height sizes.
  124916. * * The parameter `subdivisions` (positive integer, default 1) sets the number of subdivision per side.
  124917. * * The parameter `minHeight` (float, default 0) is the minimum altitude on the ground.
  124918. * * The parameter `maxHeight` (float, default 1) is the maximum altitude on the ground.
  124919. * * 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.
  124920. * * 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).
  124921. * * The parameter `alphaFilter` will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  124922. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  124923. * @param name defines the name of the mesh
  124924. * @param url defines the url to the height map
  124925. * @param options defines the options used to create the mesh
  124926. * @param scene defines the hosting scene
  124927. * @returns the ground mesh
  124928. * @see https://doc.babylonjs.com/babylon101/height_map
  124929. * @see https://doc.babylonjs.com/how_to/set_shapes#ground-from-a-height-map
  124930. */
  124931. static CreateGroundFromHeightMap(name: string, url: string, options: {
  124932. width?: number;
  124933. height?: number;
  124934. subdivisions?: number;
  124935. minHeight?: number;
  124936. maxHeight?: number;
  124937. colorFilter?: Color3;
  124938. alphaFilter?: number;
  124939. updatable?: boolean;
  124940. onReady?: (mesh: GroundMesh) => void;
  124941. }, scene?: Nullable<Scene>): GroundMesh;
  124942. }
  124943. }
  124944. declare module BABYLON {
  124945. /**
  124946. * Class containing static functions to help procedurally build meshes
  124947. */
  124948. export class TorusBuilder {
  124949. /**
  124950. * Creates a torus mesh
  124951. * * The parameter `diameter` sets the diameter size (float) of the torus (default 1)
  124952. * * The parameter `thickness` sets the diameter size of the tube of the torus (float, default 0.5)
  124953. * * The parameter `tessellation` sets the number of torus sides (postive integer, default 16)
  124954. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  124955. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  124956. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  124957. * @param name defines the name of the mesh
  124958. * @param options defines the options used to create the mesh
  124959. * @param scene defines the hosting scene
  124960. * @returns the torus mesh
  124961. * @see https://doc.babylonjs.com/how_to/set_shapes#torus
  124962. */
  124963. static CreateTorus(name: string, options: {
  124964. diameter?: number;
  124965. thickness?: number;
  124966. tessellation?: number;
  124967. updatable?: boolean;
  124968. sideOrientation?: number;
  124969. frontUVs?: Vector4;
  124970. backUVs?: Vector4;
  124971. }, scene: any): Mesh;
  124972. }
  124973. }
  124974. declare module BABYLON {
  124975. /**
  124976. * Class containing static functions to help procedurally build meshes
  124977. */
  124978. export class CylinderBuilder {
  124979. /**
  124980. * Creates a cylinder or a cone mesh
  124981. * * The parameter `height` sets the height size (float) of the cylinder/cone (float, default 2).
  124982. * * The parameter `diameter` sets the diameter of the top and bottom cap at once (float, default 1).
  124983. * * 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.
  124984. * * The parameter `tessellation` sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance.
  124985. * * The parameter `subdivisions` sets the number of rings along the cylinder height (positive integer, default 1).
  124986. * * The parameter `hasRings` (boolean, default false) makes the subdivisions independent from each other, so they become different faces.
  124987. * * The parameter `enclose` (boolean, default false) adds two extra faces per subdivision to a sliced cylinder to close it around its height axis.
  124988. * * 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).
  124989. * * The parameter `arc` (float, default 1) is the ratio (max 1) to apply to the circumference to slice the cylinder.
  124990. * * 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).
  124991. * * 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
  124992. * * Now, if the cylinder has 5 independent subdivisions (hasRings = true), n equals : top face + 5 stripe surfaces + bottom face = 2 + 5 = 7
  124993. * * 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
  124994. * * 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.
  124995. * * If `enclose` is false, a ring surface is one element.
  124996. * * If `enclose` is true, a ring surface is 3 successive elements in the array : the tubular surface, then the two closing faces.
  124997. * * 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
  124998. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  124999. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  125000. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  125001. * @param name defines the name of the mesh
  125002. * @param options defines the options used to create the mesh
  125003. * @param scene defines the hosting scene
  125004. * @returns the cylinder mesh
  125005. * @see https://doc.babylonjs.com/how_to/set_shapes#cylinder-or-cone
  125006. */
  125007. static CreateCylinder(name: string, options: {
  125008. height?: number;
  125009. diameterTop?: number;
  125010. diameterBottom?: number;
  125011. diameter?: number;
  125012. tessellation?: number;
  125013. subdivisions?: number;
  125014. arc?: number;
  125015. faceColors?: Color4[];
  125016. faceUV?: Vector4[];
  125017. updatable?: boolean;
  125018. hasRings?: boolean;
  125019. enclose?: boolean;
  125020. cap?: number;
  125021. sideOrientation?: number;
  125022. frontUVs?: Vector4;
  125023. backUVs?: Vector4;
  125024. }, scene: any): Mesh;
  125025. }
  125026. }
  125027. declare module BABYLON {
  125028. /**
  125029. * States of the webXR experience
  125030. */
  125031. export enum WebXRState {
  125032. /**
  125033. * Transitioning to being in XR mode
  125034. */
  125035. ENTERING_XR = 0,
  125036. /**
  125037. * Transitioning to non XR mode
  125038. */
  125039. EXITING_XR = 1,
  125040. /**
  125041. * In XR mode and presenting
  125042. */
  125043. IN_XR = 2,
  125044. /**
  125045. * Not entered XR mode
  125046. */
  125047. NOT_IN_XR = 3
  125048. }
  125049. /**
  125050. * Abstraction of the XR render target
  125051. */
  125052. export interface WebXRRenderTarget extends IDisposable {
  125053. /**
  125054. * xrpresent context of the canvas which can be used to display/mirror xr content
  125055. */
  125056. canvasContext: WebGLRenderingContext;
  125057. /**
  125058. * xr layer for the canvas
  125059. */
  125060. xrLayer: Nullable<XRWebGLLayer>;
  125061. /**
  125062. * Initializes the xr layer for the session
  125063. * @param xrSession xr session
  125064. * @returns a promise that will resolve once the XR Layer has been created
  125065. */
  125066. initializeXRLayerAsync(xrSession: XRSession): Promise<XRWebGLLayer>;
  125067. }
  125068. }
  125069. declare module BABYLON {
  125070. /**
  125071. * COnfiguration object for WebXR output canvas
  125072. */
  125073. export class WebXRManagedOutputCanvasOptions {
  125074. /**
  125075. * An optional canvas in case you wish to create it yourself and provide it here.
  125076. * If not provided, a new canvas will be created
  125077. */
  125078. canvasElement?: HTMLCanvasElement;
  125079. /**
  125080. * Options for this XR Layer output
  125081. */
  125082. canvasOptions?: XRWebGLLayerOptions;
  125083. /**
  125084. * CSS styling for a newly created canvas (if not provided)
  125085. */
  125086. newCanvasCssStyle?: string;
  125087. /**
  125088. * Get the default values of the configuration object
  125089. * @returns default values of this configuration object
  125090. */
  125091. static GetDefaults(): WebXRManagedOutputCanvasOptions;
  125092. }
  125093. /**
  125094. * Creates a canvas that is added/removed from the webpage when entering/exiting XR
  125095. */
  125096. export class WebXRManagedOutputCanvas implements WebXRRenderTarget {
  125097. private _options;
  125098. private _canvas;
  125099. private _engine;
  125100. private _originalCanvasSize;
  125101. /**
  125102. * Rendering context of the canvas which can be used to display/mirror xr content
  125103. */
  125104. canvasContext: WebGLRenderingContext;
  125105. /**
  125106. * xr layer for the canvas
  125107. */
  125108. xrLayer: Nullable<XRWebGLLayer>;
  125109. /**
  125110. * Obseervers registered here will be triggered when the xr layer was initialized
  125111. */
  125112. onXRLayerInitObservable: Observable<XRWebGLLayer>;
  125113. /**
  125114. * Initializes the canvas to be added/removed upon entering/exiting xr
  125115. * @param _xrSessionManager The XR Session manager
  125116. * @param _options optional configuration for this canvas output. defaults will be used if not provided
  125117. */
  125118. constructor(_xrSessionManager: WebXRSessionManager, _options?: WebXRManagedOutputCanvasOptions);
  125119. /**
  125120. * Disposes of the object
  125121. */
  125122. dispose(): void;
  125123. /**
  125124. * Initializes the xr layer for the session
  125125. * @param xrSession xr session
  125126. * @returns a promise that will resolve once the XR Layer has been created
  125127. */
  125128. initializeXRLayerAsync(xrSession: XRSession): Promise<XRWebGLLayer>;
  125129. private _addCanvas;
  125130. private _removeCanvas;
  125131. private _setCanvasSize;
  125132. private _setManagedOutputCanvas;
  125133. }
  125134. }
  125135. declare module BABYLON {
  125136. /**
  125137. * Manages an XRSession to work with Babylon's engine
  125138. * @see https://doc.babylonjs.com/how_to/webxr_session_manager
  125139. */
  125140. export class WebXRSessionManager implements IDisposable {
  125141. /** The scene which the session should be created for */
  125142. scene: Scene;
  125143. private _referenceSpace;
  125144. private _rttProvider;
  125145. private _sessionEnded;
  125146. private _xrNavigator;
  125147. private baseLayer;
  125148. /**
  125149. * The base reference space from which the session started. good if you want to reset your
  125150. * reference space
  125151. */
  125152. baseReferenceSpace: XRReferenceSpace;
  125153. /**
  125154. * Current XR frame
  125155. */
  125156. currentFrame: Nullable<XRFrame>;
  125157. /** WebXR timestamp updated every frame */
  125158. currentTimestamp: number;
  125159. /**
  125160. * Used just in case of a failure to initialize an immersive session.
  125161. * The viewer reference space is compensated using this height, creating a kind of "viewer-floor" reference space
  125162. */
  125163. defaultHeightCompensation: number;
  125164. /**
  125165. * Fires every time a new xrFrame arrives which can be used to update the camera
  125166. */
  125167. onXRFrameObservable: Observable<XRFrame>;
  125168. /**
  125169. * Fires when the reference space changed
  125170. */
  125171. onXRReferenceSpaceChanged: Observable<XRReferenceSpace>;
  125172. /**
  125173. * Fires when the xr session is ended either by the device or manually done
  125174. */
  125175. onXRSessionEnded: Observable<any>;
  125176. /**
  125177. * Fires when the xr session is ended either by the device or manually done
  125178. */
  125179. onXRSessionInit: Observable<XRSession>;
  125180. /**
  125181. * Underlying xr session
  125182. */
  125183. session: XRSession;
  125184. /**
  125185. * The viewer (head position) reference space. This can be used to get the XR world coordinates
  125186. * or get the offset the player is currently at.
  125187. */
  125188. viewerReferenceSpace: XRReferenceSpace;
  125189. /**
  125190. * Constructs a WebXRSessionManager, this must be initialized within a user action before usage
  125191. * @param scene The scene which the session should be created for
  125192. */
  125193. constructor(
  125194. /** The scene which the session should be created for */
  125195. scene: Scene);
  125196. /**
  125197. * The current reference space used in this session. This reference space can constantly change!
  125198. * It is mainly used to offset the camera's position.
  125199. */
  125200. get referenceSpace(): XRReferenceSpace;
  125201. /**
  125202. * Set a new reference space and triggers the observable
  125203. */
  125204. set referenceSpace(newReferenceSpace: XRReferenceSpace);
  125205. /**
  125206. * Disposes of the session manager
  125207. */
  125208. dispose(): void;
  125209. /**
  125210. * Stops the xrSession and restores the render loop
  125211. * @returns Promise which resolves after it exits XR
  125212. */
  125213. exitXRAsync(): Promise<void>;
  125214. /**
  125215. * Gets the correct render target texture to be rendered this frame for this eye
  125216. * @param eye the eye for which to get the render target
  125217. * @returns the render target for the specified eye
  125218. */
  125219. getRenderTargetTextureForEye(eye: XREye): RenderTargetTexture;
  125220. /**
  125221. * Creates a WebXRRenderTarget object for the XR session
  125222. * @param onStateChangedObservable optional, mechanism for enabling/disabling XR rendering canvas, used only on Web
  125223. * @param options optional options to provide when creating a new render target
  125224. * @returns a WebXR render target to which the session can render
  125225. */
  125226. getWebXRRenderTarget(options?: WebXRManagedOutputCanvasOptions): WebXRRenderTarget;
  125227. /**
  125228. * Initializes the manager
  125229. * After initialization enterXR can be called to start an XR session
  125230. * @returns Promise which resolves after it is initialized
  125231. */
  125232. initializeAsync(): Promise<void>;
  125233. /**
  125234. * Initializes an xr session
  125235. * @param xrSessionMode mode to initialize
  125236. * @param xrSessionInit defines optional and required values to pass to the session builder
  125237. * @returns a promise which will resolve once the session has been initialized
  125238. */
  125239. initializeSessionAsync(xrSessionMode?: XRSessionMode, xrSessionInit?: XRSessionInit): Promise<XRSession>;
  125240. /**
  125241. * Checks if a session would be supported for the creation options specified
  125242. * @param sessionMode session mode to check if supported eg. immersive-vr
  125243. * @returns A Promise that resolves to true if supported and false if not
  125244. */
  125245. isSessionSupportedAsync(sessionMode: XRSessionMode): Promise<boolean>;
  125246. /**
  125247. * Resets the reference space to the one started the session
  125248. */
  125249. resetReferenceSpace(): void;
  125250. /**
  125251. * Starts rendering to the xr layer
  125252. */
  125253. runXRRenderLoop(): void;
  125254. /**
  125255. * Sets the reference space on the xr session
  125256. * @param referenceSpaceType space to set
  125257. * @returns a promise that will resolve once the reference space has been set
  125258. */
  125259. setReferenceSpaceTypeAsync(referenceSpaceType?: XRReferenceSpaceType): Promise<XRReferenceSpace>;
  125260. /**
  125261. * Updates the render state of the session
  125262. * @param state state to set
  125263. * @returns a promise that resolves once the render state has been updated
  125264. */
  125265. updateRenderStateAsync(state: XRRenderState): Promise<void>;
  125266. /**
  125267. * Returns a promise that resolves with a boolean indicating if the provided session mode is supported by this browser
  125268. * @param sessionMode defines the session to test
  125269. * @returns a promise with boolean as final value
  125270. */
  125271. static IsSessionSupportedAsync(sessionMode: XRSessionMode): Promise<boolean>;
  125272. private _createRenderTargetTexture;
  125273. }
  125274. }
  125275. declare module BABYLON {
  125276. /**
  125277. * WebXR Camera which holds the views for the xrSession
  125278. * @see https://doc.babylonjs.com/how_to/webxr_camera
  125279. */
  125280. export class WebXRCamera extends FreeCamera {
  125281. private _xrSessionManager;
  125282. private _firstFrame;
  125283. private _referenceQuaternion;
  125284. private _referencedPosition;
  125285. private _xrInvPositionCache;
  125286. private _xrInvQuaternionCache;
  125287. /**
  125288. * Should position compensation execute on first frame.
  125289. * This is used when copying the position from a native (non XR) camera
  125290. */
  125291. compensateOnFirstFrame: boolean;
  125292. /**
  125293. * Creates a new webXRCamera, this should only be set at the camera after it has been updated by the xrSessionManager
  125294. * @param name the name of the camera
  125295. * @param scene the scene to add the camera to
  125296. * @param _xrSessionManager a constructed xr session manager
  125297. */
  125298. constructor(name: string, scene: Scene, _xrSessionManager: WebXRSessionManager);
  125299. /**
  125300. * Return the user's height, unrelated to the current ground.
  125301. * This will be the y position of this camera, when ground level is 0.
  125302. */
  125303. get realWorldHeight(): number;
  125304. /** @hidden */
  125305. _updateForDualEyeDebugging(): void;
  125306. /**
  125307. * Sets this camera's transformation based on a non-vr camera
  125308. * @param otherCamera the non-vr camera to copy the transformation from
  125309. * @param resetToBaseReferenceSpace should XR reset to the base reference space
  125310. */
  125311. setTransformationFromNonVRCamera(otherCamera?: Camera, resetToBaseReferenceSpace?: boolean): void;
  125312. /**
  125313. * Gets the current instance class name ("WebXRCamera").
  125314. * @returns the class name
  125315. */
  125316. getClassName(): string;
  125317. private _rotate180;
  125318. private _updateFromXRSession;
  125319. private _updateNumberOfRigCameras;
  125320. private _updateReferenceSpace;
  125321. private _updateReferenceSpaceOffset;
  125322. }
  125323. }
  125324. declare module BABYLON {
  125325. /**
  125326. * Defining the interface required for a (webxr) feature
  125327. */
  125328. export interface IWebXRFeature extends IDisposable {
  125329. /**
  125330. * Is this feature attached
  125331. */
  125332. attached: boolean;
  125333. /**
  125334. * Should auto-attach be disabled?
  125335. */
  125336. disableAutoAttach: boolean;
  125337. /**
  125338. * Attach the feature to the session
  125339. * Will usually be called by the features manager
  125340. *
  125341. * @param force should attachment be forced (even when already attached)
  125342. * @returns true if successful.
  125343. */
  125344. attach(force?: boolean): boolean;
  125345. /**
  125346. * Detach the feature from the session
  125347. * Will usually be called by the features manager
  125348. *
  125349. * @returns true if successful.
  125350. */
  125351. detach(): boolean;
  125352. }
  125353. /**
  125354. * A list of the currently available features without referencing them
  125355. */
  125356. export class WebXRFeatureName {
  125357. /**
  125358. * The name of the anchor system feature
  125359. */
  125360. static ANCHOR_SYSTEM: string;
  125361. /**
  125362. * The name of the background remover feature
  125363. */
  125364. static BACKGROUND_REMOVER: string;
  125365. /**
  125366. * The name of the hit test feature
  125367. */
  125368. static HIT_TEST: string;
  125369. /**
  125370. * physics impostors for xr controllers feature
  125371. */
  125372. static PHYSICS_CONTROLLERS: string;
  125373. /**
  125374. * The name of the plane detection feature
  125375. */
  125376. static PLANE_DETECTION: string;
  125377. /**
  125378. * The name of the pointer selection feature
  125379. */
  125380. static POINTER_SELECTION: string;
  125381. /**
  125382. * The name of the teleportation feature
  125383. */
  125384. static TELEPORTATION: string;
  125385. }
  125386. /**
  125387. * Defining the constructor of a feature. Used to register the modules.
  125388. */
  125389. export type WebXRFeatureConstructor = (xrSessionManager: WebXRSessionManager, options?: any) => () => IWebXRFeature;
  125390. /**
  125391. * The WebXR features manager is responsible of enabling or disabling features required for the current XR session.
  125392. * It is mainly used in AR sessions.
  125393. *
  125394. * A feature can have a version that is defined by Babylon (and does not correspond with the webxr version).
  125395. */
  125396. export class WebXRFeaturesManager implements IDisposable {
  125397. private _xrSessionManager;
  125398. private static readonly _AvailableFeatures;
  125399. private _features;
  125400. /**
  125401. * constructs a new features manages.
  125402. *
  125403. * @param _xrSessionManager an instance of WebXRSessionManager
  125404. */
  125405. constructor(_xrSessionManager: WebXRSessionManager);
  125406. /**
  125407. * Used to register a module. After calling this function a developer can use this feature in the scene.
  125408. * Mainly used internally.
  125409. *
  125410. * @param featureName the name of the feature to register
  125411. * @param constructorFunction the function used to construct the module
  125412. * @param version the (babylon) version of the module
  125413. * @param stable is that a stable version of this module
  125414. */
  125415. static AddWebXRFeature(featureName: string, constructorFunction: WebXRFeatureConstructor, version?: number, stable?: boolean): void;
  125416. /**
  125417. * Returns a constructor of a specific feature.
  125418. *
  125419. * @param featureName the name of the feature to construct
  125420. * @param version the version of the feature to load
  125421. * @param xrSessionManager the xrSessionManager. Used to construct the module
  125422. * @param options optional options provided to the module.
  125423. * @returns a function that, when called, will return a new instance of this feature
  125424. */
  125425. static ConstructFeature(featureName: string, version: number | undefined, xrSessionManager: WebXRSessionManager, options?: any): () => IWebXRFeature;
  125426. /**
  125427. * Can be used to return the list of features currently registered
  125428. *
  125429. * @returns an Array of available features
  125430. */
  125431. static GetAvailableFeatures(): string[];
  125432. /**
  125433. * Gets the versions available for a specific feature
  125434. * @param featureName the name of the feature
  125435. * @returns an array with the available versions
  125436. */
  125437. static GetAvailableVersions(featureName: string): string[];
  125438. /**
  125439. * Return the latest unstable version of this feature
  125440. * @param featureName the name of the feature to search
  125441. * @returns the version number. if not found will return -1
  125442. */
  125443. static GetLatestVersionOfFeature(featureName: string): number;
  125444. /**
  125445. * Return the latest stable version of this feature
  125446. * @param featureName the name of the feature to search
  125447. * @returns the version number. if not found will return -1
  125448. */
  125449. static GetStableVersionOfFeature(featureName: string): number;
  125450. /**
  125451. * Attach a feature to the current session. Mainly used when session started to start the feature effect.
  125452. * Can be used during a session to start a feature
  125453. * @param featureName the name of feature to attach
  125454. */
  125455. attachFeature(featureName: string): void;
  125456. /**
  125457. * Can be used inside a session or when the session ends to detach a specific feature
  125458. * @param featureName the name of the feature to detach
  125459. */
  125460. detachFeature(featureName: string): void;
  125461. /**
  125462. * Used to disable an already-enabled feature
  125463. * The feature will be disposed and will be recreated once enabled.
  125464. * @param featureName the feature to disable
  125465. * @returns true if disable was successful
  125466. */
  125467. disableFeature(featureName: string | {
  125468. Name: string;
  125469. }): boolean;
  125470. /**
  125471. * dispose this features manager
  125472. */
  125473. dispose(): void;
  125474. /**
  125475. * 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.
  125476. * 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.
  125477. *
  125478. * @param featureName the name of the feature to load or the class of the feature
  125479. * @param version optional version to load. if not provided the latest version will be enabled
  125480. * @param moduleOptions options provided to the module. Ses the module documentation / constructor
  125481. * @param attachIfPossible if set to true (default) the feature will be automatically attached, if it is currently possible
  125482. * @returns a new constructed feature or throws an error if feature not found.
  125483. */
  125484. enableFeature(featureName: string | {
  125485. Name: string;
  125486. }, version?: number | string, moduleOptions?: any, attachIfPossible?: boolean): IWebXRFeature;
  125487. /**
  125488. * get the implementation of an enabled feature.
  125489. * @param featureName the name of the feature to load
  125490. * @returns the feature class, if found
  125491. */
  125492. getEnabledFeature(featureName: string): IWebXRFeature;
  125493. /**
  125494. * Get the list of enabled features
  125495. * @returns an array of enabled features
  125496. */
  125497. getEnabledFeatures(): string[];
  125498. }
  125499. }
  125500. declare module BABYLON {
  125501. /**
  125502. * Base set of functionality needed to create an XR experience (WebXRSessionManager, Camera, StateManagement, etc.)
  125503. * @see https://doc.babylonjs.com/how_to/webxr_experience_helpers
  125504. */
  125505. export class WebXRExperienceHelper implements IDisposable {
  125506. private scene;
  125507. private _nonVRCamera;
  125508. private _originalSceneAutoClear;
  125509. private _supported;
  125510. /**
  125511. * Camera used to render xr content
  125512. */
  125513. camera: WebXRCamera;
  125514. /** A features manager for this xr session */
  125515. featuresManager: WebXRFeaturesManager;
  125516. /**
  125517. * Observers registered here will be triggered after the camera's initial transformation is set
  125518. * This can be used to set a different ground level or an extra rotation.
  125519. *
  125520. * Note that ground level is considered to be at 0. The height defined by the XR camera will be added
  125521. * to the position set after this observable is done executing.
  125522. */
  125523. onInitialXRPoseSetObservable: Observable<WebXRCamera>;
  125524. /**
  125525. * Fires when the state of the experience helper has changed
  125526. */
  125527. onStateChangedObservable: Observable<WebXRState>;
  125528. /** Session manager used to keep track of xr session */
  125529. sessionManager: WebXRSessionManager;
  125530. /**
  125531. * The current state of the XR experience (eg. transitioning, in XR or not in XR)
  125532. */
  125533. state: WebXRState;
  125534. /**
  125535. * Creates a WebXRExperienceHelper
  125536. * @param scene The scene the helper should be created in
  125537. */
  125538. private constructor();
  125539. /**
  125540. * Creates the experience helper
  125541. * @param scene the scene to attach the experience helper to
  125542. * @returns a promise for the experience helper
  125543. */
  125544. static CreateAsync(scene: Scene): Promise<WebXRExperienceHelper>;
  125545. /**
  125546. * Disposes of the experience helper
  125547. */
  125548. dispose(): void;
  125549. /**
  125550. * Enters XR mode (This must be done within a user interaction in most browsers eg. button click)
  125551. * @param sessionMode options for the XR session
  125552. * @param referenceSpaceType frame of reference of the XR session
  125553. * @param renderTarget the output canvas that will be used to enter XR mode
  125554. * @param sessionCreationOptions optional XRSessionInit object to init the session with
  125555. * @returns promise that resolves after xr mode has entered
  125556. */
  125557. enterXRAsync(sessionMode: XRSessionMode, referenceSpaceType: XRReferenceSpaceType, renderTarget?: WebXRRenderTarget, sessionCreationOptions?: XRSessionInit): Promise<WebXRSessionManager>;
  125558. /**
  125559. * Exits XR mode and returns the scene to its original state
  125560. * @returns promise that resolves after xr mode has exited
  125561. */
  125562. exitXRAsync(): Promise<void>;
  125563. private _nonXRToXRCamera;
  125564. private _setState;
  125565. }
  125566. }
  125567. declare module BABYLON {
  125568. /**
  125569. * X-Y values for axes in WebXR
  125570. */
  125571. export interface IWebXRMotionControllerAxesValue {
  125572. /**
  125573. * The value of the x axis
  125574. */
  125575. x: number;
  125576. /**
  125577. * The value of the y-axis
  125578. */
  125579. y: number;
  125580. }
  125581. /**
  125582. * changed / previous values for the values of this component
  125583. */
  125584. export interface IWebXRMotionControllerComponentChangesValues<T> {
  125585. /**
  125586. * current (this frame) value
  125587. */
  125588. current: T;
  125589. /**
  125590. * previous (last change) value
  125591. */
  125592. previous: T;
  125593. }
  125594. /**
  125595. * Represents changes in the component between current frame and last values recorded
  125596. */
  125597. export interface IWebXRMotionControllerComponentChanges {
  125598. /**
  125599. * will be populated with previous and current values if axes changed
  125600. */
  125601. axes?: IWebXRMotionControllerComponentChangesValues<IWebXRMotionControllerAxesValue>;
  125602. /**
  125603. * will be populated with previous and current values if pressed changed
  125604. */
  125605. pressed?: IWebXRMotionControllerComponentChangesValues<boolean>;
  125606. /**
  125607. * will be populated with previous and current values if touched changed
  125608. */
  125609. touched?: IWebXRMotionControllerComponentChangesValues<boolean>;
  125610. /**
  125611. * will be populated with previous and current values if value changed
  125612. */
  125613. value?: IWebXRMotionControllerComponentChangesValues<number>;
  125614. }
  125615. /**
  125616. * This class represents a single component (for example button or thumbstick) of a motion controller
  125617. */
  125618. export class WebXRControllerComponent implements IDisposable {
  125619. /**
  125620. * the id of this component
  125621. */
  125622. id: string;
  125623. /**
  125624. * the type of the component
  125625. */
  125626. type: MotionControllerComponentType;
  125627. private _buttonIndex;
  125628. private _axesIndices;
  125629. private _axes;
  125630. private _changes;
  125631. private _currentValue;
  125632. private _hasChanges;
  125633. private _pressed;
  125634. private _touched;
  125635. /**
  125636. * button component type
  125637. */
  125638. static BUTTON_TYPE: MotionControllerComponentType;
  125639. /**
  125640. * squeeze component type
  125641. */
  125642. static SQUEEZE_TYPE: MotionControllerComponentType;
  125643. /**
  125644. * Thumbstick component type
  125645. */
  125646. static THUMBSTICK_TYPE: MotionControllerComponentType;
  125647. /**
  125648. * Touchpad component type
  125649. */
  125650. static TOUCHPAD_TYPE: MotionControllerComponentType;
  125651. /**
  125652. * trigger component type
  125653. */
  125654. static TRIGGER_TYPE: MotionControllerComponentType;
  125655. /**
  125656. * If axes are available for this component (like a touchpad or thumbstick) the observers will be notified when
  125657. * the axes data changes
  125658. */
  125659. onAxisValueChangedObservable: Observable<{
  125660. x: number;
  125661. y: number;
  125662. }>;
  125663. /**
  125664. * Observers registered here will be triggered when the state of a button changes
  125665. * State change is either pressed / touched / value
  125666. */
  125667. onButtonStateChangedObservable: Observable<WebXRControllerComponent>;
  125668. /**
  125669. * Creates a new component for a motion controller.
  125670. * It is created by the motion controller itself
  125671. *
  125672. * @param id the id of this component
  125673. * @param type the type of the component
  125674. * @param _buttonIndex index in the buttons array of the gamepad
  125675. * @param _axesIndices indices of the values in the axes array of the gamepad
  125676. */
  125677. constructor(
  125678. /**
  125679. * the id of this component
  125680. */
  125681. id: string,
  125682. /**
  125683. * the type of the component
  125684. */
  125685. type: MotionControllerComponentType, _buttonIndex?: number, _axesIndices?: number[]);
  125686. /**
  125687. * The current axes data. If this component has no axes it will still return an object { x: 0, y: 0 }
  125688. */
  125689. get axes(): IWebXRMotionControllerAxesValue;
  125690. /**
  125691. * Get the changes. Elements will be populated only if they changed with their previous and current value
  125692. */
  125693. get changes(): IWebXRMotionControllerComponentChanges;
  125694. /**
  125695. * Return whether or not the component changed the last frame
  125696. */
  125697. get hasChanges(): boolean;
  125698. /**
  125699. * is the button currently pressed
  125700. */
  125701. get pressed(): boolean;
  125702. /**
  125703. * is the button currently touched
  125704. */
  125705. get touched(): boolean;
  125706. /**
  125707. * Get the current value of this component
  125708. */
  125709. get value(): number;
  125710. /**
  125711. * Dispose this component
  125712. */
  125713. dispose(): void;
  125714. /**
  125715. * Are there axes correlating to this component
  125716. * @return true is axes data is available
  125717. */
  125718. isAxes(): boolean;
  125719. /**
  125720. * Is this component a button (hence - pressable)
  125721. * @returns true if can be pressed
  125722. */
  125723. isButton(): boolean;
  125724. /**
  125725. * update this component using the gamepad object it is in. Called on every frame
  125726. * @param nativeController the native gamepad controller object
  125727. */
  125728. update(nativeController: IMinimalMotionControllerObject): void;
  125729. }
  125730. }
  125731. declare module BABYLON {
  125732. /**
  125733. * Interface used to represent data loading progression
  125734. */
  125735. export interface ISceneLoaderProgressEvent {
  125736. /**
  125737. * Defines if data length to load can be evaluated
  125738. */
  125739. readonly lengthComputable: boolean;
  125740. /**
  125741. * Defines the loaded data length
  125742. */
  125743. readonly loaded: number;
  125744. /**
  125745. * Defines the data length to load
  125746. */
  125747. readonly total: number;
  125748. }
  125749. /**
  125750. * Interface used by SceneLoader plugins to define supported file extensions
  125751. */
  125752. export interface ISceneLoaderPluginExtensions {
  125753. /**
  125754. * Defines the list of supported extensions
  125755. */
  125756. [extension: string]: {
  125757. isBinary: boolean;
  125758. };
  125759. }
  125760. /**
  125761. * Interface used by SceneLoader plugin factory
  125762. */
  125763. export interface ISceneLoaderPluginFactory {
  125764. /**
  125765. * Defines the name of the factory
  125766. */
  125767. name: string;
  125768. /**
  125769. * Function called to create a new plugin
  125770. * @return the new plugin
  125771. */
  125772. createPlugin(): ISceneLoaderPlugin | ISceneLoaderPluginAsync;
  125773. /**
  125774. * The callback that returns true if the data can be directly loaded.
  125775. * @param data string containing the file data
  125776. * @returns if the data can be loaded directly
  125777. */
  125778. canDirectLoad?(data: string): boolean;
  125779. }
  125780. /**
  125781. * Interface used to define the base of ISceneLoaderPlugin and ISceneLoaderPluginAsync
  125782. */
  125783. export interface ISceneLoaderPluginBase {
  125784. /**
  125785. * The friendly name of this plugin.
  125786. */
  125787. name: string;
  125788. /**
  125789. * The file extensions supported by this plugin.
  125790. */
  125791. extensions: string | ISceneLoaderPluginExtensions;
  125792. /**
  125793. * The callback called when loading from a url.
  125794. * @param scene scene loading this url
  125795. * @param url url to load
  125796. * @param onSuccess callback called when the file successfully loads
  125797. * @param onProgress callback called while file is loading (if the server supports this mode)
  125798. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  125799. * @param onError callback called when the file fails to load
  125800. * @returns a file request object
  125801. */
  125802. requestFile?(scene: Scene, url: string, onSuccess: (data: any, request?: WebRequest) => void, onProgress?: (ev: ISceneLoaderProgressEvent) => void, useArrayBuffer?: boolean, onError?: (error: any) => void): IFileRequest;
  125803. /**
  125804. * The callback called when loading from a file object.
  125805. * @param scene scene loading this file
  125806. * @param file defines the file to load
  125807. * @param onSuccess defines the callback to call when data is loaded
  125808. * @param onProgress defines the callback to call during loading process
  125809. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  125810. * @param onError defines the callback to call when an error occurs
  125811. * @returns a file request object
  125812. */
  125813. readFile?(scene: Scene, file: File, onSuccess: (data: any) => void, onProgress?: (ev: ISceneLoaderProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: any) => void): IFileRequest;
  125814. /**
  125815. * The callback that returns true if the data can be directly loaded.
  125816. * @param data string containing the file data
  125817. * @returns if the data can be loaded directly
  125818. */
  125819. canDirectLoad?(data: string): boolean;
  125820. /**
  125821. * The callback that returns the data to pass to the plugin if the data can be directly loaded.
  125822. * @param scene scene loading this data
  125823. * @param data string containing the data
  125824. * @returns data to pass to the plugin
  125825. */
  125826. directLoad?(scene: Scene, data: string): any;
  125827. /**
  125828. * The callback that allows custom handling of the root url based on the response url.
  125829. * @param rootUrl the original root url
  125830. * @param responseURL the response url if available
  125831. * @returns the new root url
  125832. */
  125833. rewriteRootURL?(rootUrl: string, responseURL?: string): string;
  125834. }
  125835. /**
  125836. * Interface used to define a SceneLoader plugin
  125837. */
  125838. export interface ISceneLoaderPlugin extends ISceneLoaderPluginBase {
  125839. /**
  125840. * Import meshes into a scene.
  125841. * @param meshesNames An array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  125842. * @param scene The scene to import into
  125843. * @param data The data to import
  125844. * @param rootUrl The root url for scene and resources
  125845. * @param meshes The meshes array to import into
  125846. * @param particleSystems The particle systems array to import into
  125847. * @param skeletons The skeletons array to import into
  125848. * @param onError The callback when import fails
  125849. * @returns True if successful or false otherwise
  125850. */
  125851. importMesh(meshesNames: any, scene: Scene, data: any, rootUrl: string, meshes: AbstractMesh[], particleSystems: IParticleSystem[], skeletons: Skeleton[], onError?: (message: string, exception?: any) => void): boolean;
  125852. /**
  125853. * Load into a scene.
  125854. * @param scene The scene to load into
  125855. * @param data The data to import
  125856. * @param rootUrl The root url for scene and resources
  125857. * @param onError The callback when import fails
  125858. * @returns True if successful or false otherwise
  125859. */
  125860. load(scene: Scene, data: any, rootUrl: string, onError?: (message: string, exception?: any) => void): boolean;
  125861. /**
  125862. * Load into an asset container.
  125863. * @param scene The scene to load into
  125864. * @param data The data to import
  125865. * @param rootUrl The root url for scene and resources
  125866. * @param onError The callback when import fails
  125867. * @returns The loaded asset container
  125868. */
  125869. loadAssetContainer(scene: Scene, data: any, rootUrl: string, onError?: (message: string, exception?: any) => void): AssetContainer;
  125870. }
  125871. /**
  125872. * Interface used to define an async SceneLoader plugin
  125873. */
  125874. export interface ISceneLoaderPluginAsync extends ISceneLoaderPluginBase {
  125875. /**
  125876. * Import meshes into a scene.
  125877. * @param meshesNames An array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  125878. * @param scene The scene to import into
  125879. * @param data The data to import
  125880. * @param rootUrl The root url for scene and resources
  125881. * @param onProgress The callback when the load progresses
  125882. * @param fileName Defines the name of the file to load
  125883. * @returns The loaded meshes, particle systems, skeletons, and animation groups
  125884. */
  125885. importMeshAsync(meshesNames: any, scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<{
  125886. meshes: AbstractMesh[];
  125887. particleSystems: IParticleSystem[];
  125888. skeletons: Skeleton[];
  125889. animationGroups: AnimationGroup[];
  125890. }>;
  125891. /**
  125892. * Load into a scene.
  125893. * @param scene The scene to load into
  125894. * @param data The data to import
  125895. * @param rootUrl The root url for scene and resources
  125896. * @param onProgress The callback when the load progresses
  125897. * @param fileName Defines the name of the file to load
  125898. * @returns Nothing
  125899. */
  125900. loadAsync(scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<void>;
  125901. /**
  125902. * Load into an asset container.
  125903. * @param scene The scene to load into
  125904. * @param data The data to import
  125905. * @param rootUrl The root url for scene and resources
  125906. * @param onProgress The callback when the load progresses
  125907. * @param fileName Defines the name of the file to load
  125908. * @returns The loaded asset container
  125909. */
  125910. loadAssetContainerAsync(scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<AssetContainer>;
  125911. }
  125912. /**
  125913. * Mode that determines how to handle old animation groups before loading new ones.
  125914. */
  125915. export enum SceneLoaderAnimationGroupLoadingMode {
  125916. /**
  125917. * Reset all old animations to initial state then dispose them.
  125918. */
  125919. Clean = 0,
  125920. /**
  125921. * Stop all old animations.
  125922. */
  125923. Stop = 1,
  125924. /**
  125925. * Restart old animations from first frame.
  125926. */
  125927. Sync = 2,
  125928. /**
  125929. * Old animations remains untouched.
  125930. */
  125931. NoSync = 3
  125932. }
  125933. /**
  125934. * Class used to load scene from various file formats using registered plugins
  125935. * @see https://doc.babylonjs.com/how_to/load_from_any_file_type
  125936. */
  125937. export class SceneLoader {
  125938. /**
  125939. * No logging while loading
  125940. */
  125941. static readonly NO_LOGGING: number;
  125942. /**
  125943. * Minimal logging while loading
  125944. */
  125945. static readonly MINIMAL_LOGGING: number;
  125946. /**
  125947. * Summary logging while loading
  125948. */
  125949. static readonly SUMMARY_LOGGING: number;
  125950. /**
  125951. * Detailled logging while loading
  125952. */
  125953. static readonly DETAILED_LOGGING: number;
  125954. /**
  125955. * Gets or sets a boolean indicating if entire scene must be loaded even if scene contains incremental data
  125956. */
  125957. static get ForceFullSceneLoadingForIncremental(): boolean;
  125958. static set ForceFullSceneLoadingForIncremental(value: boolean);
  125959. /**
  125960. * Gets or sets a boolean indicating if loading screen must be displayed while loading a scene
  125961. */
  125962. static get ShowLoadingScreen(): boolean;
  125963. static set ShowLoadingScreen(value: boolean);
  125964. /**
  125965. * Defines the current logging level (while loading the scene)
  125966. * @ignorenaming
  125967. */
  125968. static get loggingLevel(): number;
  125969. static set loggingLevel(value: number);
  125970. /**
  125971. * Gets or set a boolean indicating if matrix weights must be cleaned upon loading
  125972. */
  125973. static get CleanBoneMatrixWeights(): boolean;
  125974. static set CleanBoneMatrixWeights(value: boolean);
  125975. /**
  125976. * Event raised when a plugin is used to load a scene
  125977. */
  125978. static OnPluginActivatedObservable: Observable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>;
  125979. private static _registeredPlugins;
  125980. private static _showingLoadingScreen;
  125981. private static _getDefaultPlugin;
  125982. private static _getPluginForExtension;
  125983. private static _getPluginForDirectLoad;
  125984. private static _getPluginForFilename;
  125985. private static _getDirectLoad;
  125986. private static _loadData;
  125987. private static _getFileInfo;
  125988. /**
  125989. * Gets a plugin that can load the given extension
  125990. * @param extension defines the extension to load
  125991. * @returns a plugin or null if none works
  125992. */
  125993. static GetPluginForExtension(extension: string): ISceneLoaderPlugin | ISceneLoaderPluginAsync | ISceneLoaderPluginFactory;
  125994. /**
  125995. * Gets a boolean indicating that the given extension can be loaded
  125996. * @param extension defines the extension to load
  125997. * @returns true if the extension is supported
  125998. */
  125999. static IsPluginForExtensionAvailable(extension: string): boolean;
  126000. /**
  126001. * Adds a new plugin to the list of registered plugins
  126002. * @param plugin defines the plugin to add
  126003. */
  126004. static RegisterPlugin(plugin: ISceneLoaderPlugin | ISceneLoaderPluginAsync): void;
  126005. /**
  126006. * Import meshes into a scene
  126007. * @param meshNames an array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  126008. * @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)
  126009. * @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)
  126010. * @param scene the instance of BABYLON.Scene to append to
  126011. * @param onSuccess a callback with a list of imported meshes, particleSystems, and skeletons when import succeeds
  126012. * @param onProgress a callback with a progress event for each file being loaded
  126013. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  126014. * @param pluginExtension the extension used to determine the plugin
  126015. * @returns The loaded plugin
  126016. */
  126017. 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>;
  126018. /**
  126019. * Import meshes into a scene
  126020. * @param meshNames an array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  126021. * @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)
  126022. * @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)
  126023. * @param scene the instance of BABYLON.Scene to append to
  126024. * @param onProgress a callback with a progress event for each file being loaded
  126025. * @param pluginExtension the extension used to determine the plugin
  126026. * @returns The loaded list of imported meshes, particle systems, skeletons, and animation groups
  126027. */
  126028. static ImportMeshAsync(meshNames: any, rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<{
  126029. meshes: AbstractMesh[];
  126030. particleSystems: IParticleSystem[];
  126031. skeletons: Skeleton[];
  126032. animationGroups: AnimationGroup[];
  126033. }>;
  126034. /**
  126035. * Load a scene
  126036. * @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)
  126037. * @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)
  126038. * @param engine is the instance of BABYLON.Engine to use to create the scene
  126039. * @param onSuccess a callback with the scene when import succeeds
  126040. * @param onProgress a callback with a progress event for each file being loaded
  126041. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  126042. * @param pluginExtension the extension used to determine the plugin
  126043. * @returns The loaded plugin
  126044. */
  126045. 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>;
  126046. /**
  126047. * Load a scene
  126048. * @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)
  126049. * @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)
  126050. * @param engine is the instance of BABYLON.Engine to use to create the scene
  126051. * @param onProgress a callback with a progress event for each file being loaded
  126052. * @param pluginExtension the extension used to determine the plugin
  126053. * @returns The loaded scene
  126054. */
  126055. static LoadAsync(rootUrl: string, sceneFilename?: string | File, engine?: Nullable<Engine>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<Scene>;
  126056. /**
  126057. * Append a scene
  126058. * @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)
  126059. * @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)
  126060. * @param scene is the instance of BABYLON.Scene to append to
  126061. * @param onSuccess a callback with the scene when import succeeds
  126062. * @param onProgress a callback with a progress event for each file being loaded
  126063. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  126064. * @param pluginExtension the extension used to determine the plugin
  126065. * @returns The loaded plugin
  126066. */
  126067. 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>;
  126068. /**
  126069. * Append a scene
  126070. * @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)
  126071. * @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)
  126072. * @param scene is the instance of BABYLON.Scene to append to
  126073. * @param onProgress a callback with a progress event for each file being loaded
  126074. * @param pluginExtension the extension used to determine the plugin
  126075. * @returns The given scene
  126076. */
  126077. static AppendAsync(rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<Scene>;
  126078. /**
  126079. * Load a scene into an asset container
  126080. * @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)
  126081. * @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)
  126082. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  126083. * @param onSuccess a callback with the scene when import succeeds
  126084. * @param onProgress a callback with a progress event for each file being loaded
  126085. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  126086. * @param pluginExtension the extension used to determine the plugin
  126087. * @returns The loaded plugin
  126088. */
  126089. 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>;
  126090. /**
  126091. * Load a scene into an asset container
  126092. * @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)
  126093. * @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)
  126094. * @param scene is the instance of Scene to append to
  126095. * @param onProgress a callback with a progress event for each file being loaded
  126096. * @param pluginExtension the extension used to determine the plugin
  126097. * @returns The loaded asset container
  126098. */
  126099. static LoadAssetContainerAsync(rootUrl: string, sceneFilename?: string, scene?: Nullable<Scene>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<AssetContainer>;
  126100. /**
  126101. * Import animations from a file into a scene
  126102. * @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)
  126103. * @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)
  126104. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  126105. * @param overwriteAnimations when true, animations are cleaned before importing new ones. Animations are appended otherwise
  126106. * @param animationGroupLoadingMode defines how to handle old animations groups before importing new ones
  126107. * @param targetConverter defines a function used to convert animation targets from loaded scene to current scene (default: search node by name)
  126108. * @param onSuccess a callback with the scene when import succeeds
  126109. * @param onProgress a callback with a progress event for each file being loaded
  126110. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  126111. * @param pluginExtension the extension used to determine the plugin
  126112. */
  126113. 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;
  126114. /**
  126115. * Import animations from a file into a scene
  126116. * @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)
  126117. * @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)
  126118. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  126119. * @param overwriteAnimations when true, animations are cleaned before importing new ones. Animations are appended otherwise
  126120. * @param animationGroupLoadingMode defines how to handle old animations groups before importing new ones
  126121. * @param targetConverter defines a function used to convert animation targets from loaded scene to current scene (default: search node by name)
  126122. * @param onSuccess a callback with the scene when import succeeds
  126123. * @param onProgress a callback with a progress event for each file being loaded
  126124. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  126125. * @param pluginExtension the extension used to determine the plugin
  126126. * @returns the updated scene with imported animations
  126127. */
  126128. 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>;
  126129. }
  126130. }
  126131. declare module BABYLON {
  126132. /**
  126133. * Handedness type in xrInput profiles. These can be used to define layouts in the Layout Map.
  126134. */
  126135. export type MotionControllerHandedness = "none" | "left" | "right";
  126136. /**
  126137. * The type of components available in motion controllers.
  126138. * This is not the name of the component.
  126139. */
  126140. export type MotionControllerComponentType = "trigger" | "squeeze" | "touchpad" | "thumbstick" | "button";
  126141. /**
  126142. * The state of a controller component
  126143. */
  126144. export type MotionControllerComponentStateType = "default" | "touched" | "pressed";
  126145. /**
  126146. * The schema of motion controller layout.
  126147. * No object will be initialized using this interface
  126148. * This is used just to define the profile.
  126149. */
  126150. export interface IMotionControllerLayout {
  126151. /**
  126152. * Path to load the assets. Usually relative to the base path
  126153. */
  126154. assetPath: string;
  126155. /**
  126156. * Available components (unsorted)
  126157. */
  126158. components: {
  126159. /**
  126160. * A map of component Ids
  126161. */
  126162. [componentId: string]: {
  126163. /**
  126164. * The type of input the component outputs
  126165. */
  126166. type: MotionControllerComponentType;
  126167. /**
  126168. * The indices of this component in the gamepad object
  126169. */
  126170. gamepadIndices: {
  126171. /**
  126172. * Index of button
  126173. */
  126174. button?: number;
  126175. /**
  126176. * If available, index of x-axis
  126177. */
  126178. xAxis?: number;
  126179. /**
  126180. * If available, index of y-axis
  126181. */
  126182. yAxis?: number;
  126183. };
  126184. /**
  126185. * The mesh's root node name
  126186. */
  126187. rootNodeName: string;
  126188. /**
  126189. * Animation definitions for this model
  126190. */
  126191. visualResponses: {
  126192. [stateKey: string]: {
  126193. /**
  126194. * What property will be animated
  126195. */
  126196. componentProperty: "xAxis" | "yAxis" | "button" | "state";
  126197. /**
  126198. * What states influence this visual response
  126199. */
  126200. states: MotionControllerComponentStateType[];
  126201. /**
  126202. * Type of animation - movement or visibility
  126203. */
  126204. valueNodeProperty: "transform" | "visibility";
  126205. /**
  126206. * Base node name to move. Its position will be calculated according to the min and max nodes
  126207. */
  126208. valueNodeName?: string;
  126209. /**
  126210. * Minimum movement node
  126211. */
  126212. minNodeName?: string;
  126213. /**
  126214. * Max movement node
  126215. */
  126216. maxNodeName?: string;
  126217. };
  126218. };
  126219. /**
  126220. * If touch enabled, what is the name of node to display user feedback
  126221. */
  126222. touchPointNodeName?: string;
  126223. };
  126224. };
  126225. /**
  126226. * Is it xr standard mapping or not
  126227. */
  126228. gamepadMapping: "" | "xr-standard";
  126229. /**
  126230. * Base root node of this entire model
  126231. */
  126232. rootNodeName: string;
  126233. /**
  126234. * Defines the main button component id
  126235. */
  126236. selectComponentId: string;
  126237. }
  126238. /**
  126239. * A definition for the layout map in the input profile
  126240. */
  126241. export interface IMotionControllerLayoutMap {
  126242. /**
  126243. * Layouts with handedness type as a key
  126244. */
  126245. [handedness: string]: IMotionControllerLayout;
  126246. }
  126247. /**
  126248. * The XR Input profile schema
  126249. * Profiles can be found here:
  126250. * https://github.com/immersive-web/webxr-input-profiles/tree/master/packages/registry/profiles
  126251. */
  126252. export interface IMotionControllerProfile {
  126253. /**
  126254. * fallback profiles for this profileId
  126255. */
  126256. fallbackProfileIds: string[];
  126257. /**
  126258. * The layout map, with handedness as key
  126259. */
  126260. layouts: IMotionControllerLayoutMap;
  126261. /**
  126262. * The id of this profile
  126263. * correlates to the profile(s) in the xrInput.profiles array
  126264. */
  126265. profileId: string;
  126266. }
  126267. /**
  126268. * A helper-interface for the 3 meshes needed for controller button animation
  126269. * The meshes are provided to the _lerpButtonTransform function to calculate the current position of the value mesh
  126270. */
  126271. export interface IMotionControllerButtonMeshMap {
  126272. /**
  126273. * the mesh that defines the pressed value mesh position.
  126274. * This is used to find the max-position of this button
  126275. */
  126276. pressedMesh: AbstractMesh;
  126277. /**
  126278. * the mesh that defines the unpressed value mesh position.
  126279. * This is used to find the min (or initial) position of this button
  126280. */
  126281. unpressedMesh: AbstractMesh;
  126282. /**
  126283. * The mesh that will be changed when value changes
  126284. */
  126285. valueMesh: AbstractMesh;
  126286. }
  126287. /**
  126288. * A helper-interface for the 3 meshes needed for controller axis animation.
  126289. * This will be expanded when touchpad animations are fully supported
  126290. * The meshes are provided to the _lerpAxisTransform function to calculate the current position of the value mesh
  126291. */
  126292. export interface IMotionControllerMeshMap {
  126293. /**
  126294. * the mesh that defines the maximum value mesh position.
  126295. */
  126296. maxMesh?: AbstractMesh;
  126297. /**
  126298. * the mesh that defines the minimum value mesh position.
  126299. */
  126300. minMesh?: AbstractMesh;
  126301. /**
  126302. * The mesh that will be changed when axis value changes
  126303. */
  126304. valueMesh: AbstractMesh;
  126305. }
  126306. /**
  126307. * The elements needed for change-detection of the gamepad objects in motion controllers
  126308. */
  126309. export interface IMinimalMotionControllerObject {
  126310. /**
  126311. * Available axes of this controller
  126312. */
  126313. axes: number[];
  126314. /**
  126315. * An array of available buttons
  126316. */
  126317. buttons: Array<{
  126318. /**
  126319. * Value of the button/trigger
  126320. */
  126321. value: number;
  126322. /**
  126323. * If the button/trigger is currently touched
  126324. */
  126325. touched: boolean;
  126326. /**
  126327. * If the button/trigger is currently pressed
  126328. */
  126329. pressed: boolean;
  126330. }>;
  126331. /**
  126332. * EXPERIMENTAL haptic support.
  126333. */
  126334. hapticActuators?: Array<{
  126335. pulse: (value: number, duration: number) => Promise<boolean>;
  126336. }>;
  126337. }
  126338. /**
  126339. * An Abstract Motion controller
  126340. * This class receives an xrInput and a profile layout and uses those to initialize the components
  126341. * Each component has an observable to check for changes in value and state
  126342. */
  126343. export abstract class WebXRAbstractMotionController implements IDisposable {
  126344. protected scene: Scene;
  126345. protected layout: IMotionControllerLayout;
  126346. /**
  126347. * The gamepad object correlating to this controller
  126348. */
  126349. gamepadObject: IMinimalMotionControllerObject;
  126350. /**
  126351. * handedness (left/right/none) of this controller
  126352. */
  126353. handedness: MotionControllerHandedness;
  126354. private _initComponent;
  126355. private _modelReady;
  126356. /**
  126357. * A map of components (WebXRControllerComponent) in this motion controller
  126358. * Components have a ComponentType and can also have both button and axis definitions
  126359. */
  126360. readonly components: {
  126361. [id: string]: WebXRControllerComponent;
  126362. };
  126363. /**
  126364. * Disable the model's animation. Can be set at any time.
  126365. */
  126366. disableAnimation: boolean;
  126367. /**
  126368. * Observers registered here will be triggered when the model of this controller is done loading
  126369. */
  126370. onModelLoadedObservable: Observable<WebXRAbstractMotionController>;
  126371. /**
  126372. * The profile id of this motion controller
  126373. */
  126374. abstract profileId: string;
  126375. /**
  126376. * The root mesh of the model. It is null if the model was not yet initialized
  126377. */
  126378. rootMesh: Nullable<AbstractMesh>;
  126379. /**
  126380. * constructs a new abstract motion controller
  126381. * @param scene the scene to which the model of the controller will be added
  126382. * @param layout The profile layout to load
  126383. * @param gamepadObject The gamepad object correlating to this controller
  126384. * @param handedness handedness (left/right/none) of this controller
  126385. * @param _doNotLoadControllerMesh set this flag to ignore the mesh loading
  126386. */
  126387. constructor(scene: Scene, layout: IMotionControllerLayout,
  126388. /**
  126389. * The gamepad object correlating to this controller
  126390. */
  126391. gamepadObject: IMinimalMotionControllerObject,
  126392. /**
  126393. * handedness (left/right/none) of this controller
  126394. */
  126395. handedness: MotionControllerHandedness, _doNotLoadControllerMesh?: boolean);
  126396. /**
  126397. * Dispose this controller, the model mesh and all its components
  126398. */
  126399. dispose(): void;
  126400. /**
  126401. * Returns all components of specific type
  126402. * @param type the type to search for
  126403. * @return an array of components with this type
  126404. */
  126405. getAllComponentsOfType(type: MotionControllerComponentType): WebXRControllerComponent[];
  126406. /**
  126407. * get a component based an its component id as defined in layout.components
  126408. * @param id the id of the component
  126409. * @returns the component correlates to the id or undefined if not found
  126410. */
  126411. getComponent(id: string): WebXRControllerComponent;
  126412. /**
  126413. * Get the list of components available in this motion controller
  126414. * @returns an array of strings correlating to available components
  126415. */
  126416. getComponentIds(): string[];
  126417. /**
  126418. * Get the first component of specific type
  126419. * @param type type of component to find
  126420. * @return a controller component or null if not found
  126421. */
  126422. getComponentOfType(type: MotionControllerComponentType): Nullable<WebXRControllerComponent>;
  126423. /**
  126424. * Get the main (Select) component of this controller as defined in the layout
  126425. * @returns the main component of this controller
  126426. */
  126427. getMainComponent(): WebXRControllerComponent;
  126428. /**
  126429. * Loads the model correlating to this controller
  126430. * When the mesh is loaded, the onModelLoadedObservable will be triggered
  126431. * @returns A promise fulfilled with the result of the model loading
  126432. */
  126433. loadModel(): Promise<boolean>;
  126434. /**
  126435. * Update this model using the current XRFrame
  126436. * @param xrFrame the current xr frame to use and update the model
  126437. */
  126438. updateFromXRFrame(xrFrame: XRFrame): void;
  126439. /**
  126440. * Backwards compatibility due to a deeply-integrated typo
  126441. */
  126442. get handness(): XREye;
  126443. /**
  126444. * Pulse (vibrate) this controller
  126445. * If the controller does not support pulses, this function will fail silently and return Promise<false> directly after called
  126446. * Consecutive calls to this function will cancel the last pulse call
  126447. *
  126448. * @param value the strength of the pulse in 0.0...1.0 range
  126449. * @param duration Duration of the pulse in milliseconds
  126450. * @param hapticActuatorIndex optional index of actuator (will usually be 0)
  126451. * @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
  126452. */
  126453. pulse(value: number, duration: number, hapticActuatorIndex?: number): Promise<boolean>;
  126454. protected _getChildByName(node: AbstractMesh, name: string): AbstractMesh;
  126455. protected _getImmediateChildByName(node: AbstractMesh, name: string): AbstractMesh;
  126456. /**
  126457. * Moves the axis on the controller mesh based on its current state
  126458. * @param axis the index of the axis
  126459. * @param axisValue the value of the axis which determines the meshes new position
  126460. * @hidden
  126461. */
  126462. protected _lerpTransform(axisMap: IMotionControllerMeshMap, axisValue: number, fixValueCoordinates?: boolean): void;
  126463. /**
  126464. * Update the model itself with the current frame data
  126465. * @param xrFrame the frame to use for updating the model mesh
  126466. */
  126467. protected updateModel(xrFrame: XRFrame): void;
  126468. /**
  126469. * Get the filename and path for this controller's model
  126470. * @returns a map of filename and path
  126471. */
  126472. protected abstract _getFilenameAndPath(): {
  126473. filename: string;
  126474. path: string;
  126475. };
  126476. /**
  126477. * This function is called before the mesh is loaded. It checks for loading constraints.
  126478. * For example, this function can check if the GLB loader is available
  126479. * If this function returns false, the generic controller will be loaded instead
  126480. * @returns Is the client ready to load the mesh
  126481. */
  126482. protected abstract _getModelLoadingConstraints(): boolean;
  126483. /**
  126484. * This function will be called after the model was successfully loaded and can be used
  126485. * for mesh transformations before it is available for the user
  126486. * @param meshes the loaded meshes
  126487. */
  126488. protected abstract _processLoadedModel(meshes: AbstractMesh[]): void;
  126489. /**
  126490. * Set the root mesh for this controller. Important for the WebXR controller class
  126491. * @param meshes the loaded meshes
  126492. */
  126493. protected abstract _setRootMesh(meshes: AbstractMesh[]): void;
  126494. /**
  126495. * A function executed each frame that updates the mesh (if needed)
  126496. * @param xrFrame the current xrFrame
  126497. */
  126498. protected abstract _updateModel(xrFrame: XRFrame): void;
  126499. private _getGenericFilenameAndPath;
  126500. private _getGenericParentMesh;
  126501. }
  126502. }
  126503. declare module BABYLON {
  126504. /**
  126505. * A generic trigger-only motion controller for WebXR
  126506. */
  126507. export class WebXRGenericTriggerMotionController extends WebXRAbstractMotionController {
  126508. /**
  126509. * Static version of the profile id of this controller
  126510. */
  126511. static ProfileId: string;
  126512. profileId: string;
  126513. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness);
  126514. protected _getFilenameAndPath(): {
  126515. filename: string;
  126516. path: string;
  126517. };
  126518. protected _getModelLoadingConstraints(): boolean;
  126519. protected _processLoadedModel(meshes: AbstractMesh[]): void;
  126520. protected _setRootMesh(meshes: AbstractMesh[]): void;
  126521. protected _updateModel(): void;
  126522. }
  126523. }
  126524. declare module BABYLON {
  126525. /**
  126526. * Class containing static functions to help procedurally build meshes
  126527. */
  126528. export class SphereBuilder {
  126529. /**
  126530. * Creates a sphere mesh
  126531. * * The parameter `diameter` sets the diameter size (float) of the sphere (default 1)
  126532. * * 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`)
  126533. * * The parameter `segments` sets the sphere number of horizontal stripes (positive integer, default 32)
  126534. * * 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
  126535. * * 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)
  126536. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  126537. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  126538. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  126539. * @param name defines the name of the mesh
  126540. * @param options defines the options used to create the mesh
  126541. * @param scene defines the hosting scene
  126542. * @returns the sphere mesh
  126543. * @see https://doc.babylonjs.com/how_to/set_shapes#sphere
  126544. */
  126545. static CreateSphere(name: string, options: {
  126546. segments?: number;
  126547. diameter?: number;
  126548. diameterX?: number;
  126549. diameterY?: number;
  126550. diameterZ?: number;
  126551. arc?: number;
  126552. slice?: number;
  126553. sideOrientation?: number;
  126554. frontUVs?: Vector4;
  126555. backUVs?: Vector4;
  126556. updatable?: boolean;
  126557. }, scene?: Nullable<Scene>): Mesh;
  126558. }
  126559. }
  126560. declare module BABYLON {
  126561. /**
  126562. * A profiled motion controller has its profile loaded from an online repository.
  126563. * The class is responsible of loading the model, mapping the keys and enabling model-animations
  126564. */
  126565. export class WebXRProfiledMotionController extends WebXRAbstractMotionController {
  126566. private _repositoryUrl;
  126567. private _buttonMeshMapping;
  126568. private _touchDots;
  126569. /**
  126570. * The profile ID of this controller. Will be populated when the controller initializes.
  126571. */
  126572. profileId: string;
  126573. constructor(scene: Scene, xrInput: XRInputSource, _profile: IMotionControllerProfile, _repositoryUrl: string);
  126574. dispose(): void;
  126575. protected _getFilenameAndPath(): {
  126576. filename: string;
  126577. path: string;
  126578. };
  126579. protected _getModelLoadingConstraints(): boolean;
  126580. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  126581. protected _setRootMesh(meshes: AbstractMesh[]): void;
  126582. protected _updateModel(_xrFrame: XRFrame): void;
  126583. }
  126584. }
  126585. declare module BABYLON {
  126586. /**
  126587. * A construction function type to create a new controller based on an xrInput object
  126588. */
  126589. export type MotionControllerConstructor = (xrInput: XRInputSource, scene: Scene) => WebXRAbstractMotionController;
  126590. /**
  126591. * The MotionController Manager manages all registered motion controllers and loads the right one when needed.
  126592. *
  126593. * When this repository is complete: https://github.com/immersive-web/webxr-input-profiles/tree/master/packages/assets
  126594. * it should be replaced with auto-loaded controllers.
  126595. *
  126596. * When using a model try to stay as generic as possible. Eventually there will be no need in any of the controller classes
  126597. */
  126598. export class WebXRMotionControllerManager {
  126599. private static _AvailableControllers;
  126600. private static _Fallbacks;
  126601. private static _ProfileLoadingPromises;
  126602. private static _ProfilesList;
  126603. /**
  126604. * The base URL of the online controller repository. Can be changed at any time.
  126605. */
  126606. static BaseRepositoryUrl: string;
  126607. /**
  126608. * Which repository gets priority - local or online
  126609. */
  126610. static PrioritizeOnlineRepository: boolean;
  126611. /**
  126612. * Use the online repository, or use only locally-defined controllers
  126613. */
  126614. static UseOnlineRepository: boolean;
  126615. /**
  126616. * Clear the cache used for profile loading and reload when requested again
  126617. */
  126618. static ClearProfilesCache(): void;
  126619. /**
  126620. * Register the default fallbacks.
  126621. * This function is called automatically when this file is imported.
  126622. */
  126623. static DefaultFallbacks(): void;
  126624. /**
  126625. * Find a fallback profile if the profile was not found. There are a few predefined generic profiles.
  126626. * @param profileId the profile to which a fallback needs to be found
  126627. * @return an array with corresponding fallback profiles
  126628. */
  126629. static FindFallbackWithProfileId(profileId: string): string[];
  126630. /**
  126631. * When acquiring a new xrInput object (usually by the WebXRInput class), match it with the correct profile.
  126632. * The order of search:
  126633. *
  126634. * 1) Iterate the profiles array of the xr input and try finding a corresponding motion controller
  126635. * 2) (If not found) search in the gamepad id and try using it (legacy versions only)
  126636. * 3) search for registered fallbacks (should be redundant, nonetheless it makes sense to check)
  126637. * 4) return the generic trigger controller if none were found
  126638. *
  126639. * @param xrInput the xrInput to which a new controller is initialized
  126640. * @param scene the scene to which the model will be added
  126641. * @param forceProfile force a certain profile for this controller
  126642. * @return A promise that fulfils with the motion controller class for this profile id or the generic standard class if none was found
  126643. */
  126644. static GetMotionControllerWithXRInput(xrInput: XRInputSource, scene: Scene, forceProfile?: string): Promise<WebXRAbstractMotionController>;
  126645. /**
  126646. * Register a new controller based on its profile. This function will be called by the controller classes themselves.
  126647. *
  126648. * If you are missing a profile, make sure it is imported in your source, otherwise it will not register.
  126649. *
  126650. * @param type the profile type to register
  126651. * @param constructFunction the function to be called when loading this profile
  126652. */
  126653. static RegisterController(type: string, constructFunction: MotionControllerConstructor): void;
  126654. /**
  126655. * Register a fallback to a specific profile.
  126656. * @param profileId the profileId that will receive the fallbacks
  126657. * @param fallbacks A list of fallback profiles
  126658. */
  126659. static RegisterFallbacksForProfileId(profileId: string, fallbacks: string[]): void;
  126660. /**
  126661. * Will update the list of profiles available in the repository
  126662. * @return a promise that resolves to a map of profiles available online
  126663. */
  126664. static UpdateProfilesList(): Promise<{
  126665. [profile: string]: string;
  126666. }>;
  126667. private static _LoadProfileFromRepository;
  126668. private static _LoadProfilesFromAvailableControllers;
  126669. }
  126670. }
  126671. declare module BABYLON {
  126672. /**
  126673. * Configuration options for the WebXR controller creation
  126674. */
  126675. export interface IWebXRControllerOptions {
  126676. /**
  126677. * Should the controller mesh be animated when a user interacts with it
  126678. * The pressed buttons / thumbstick and touchpad animations will be disabled
  126679. */
  126680. disableMotionControllerAnimation?: boolean;
  126681. /**
  126682. * Do not load the controller mesh, in case a different mesh needs to be loaded.
  126683. */
  126684. doNotLoadControllerMesh?: boolean;
  126685. /**
  126686. * Force a specific controller type for this controller.
  126687. * This can be used when creating your own profile or when testing different controllers
  126688. */
  126689. forceControllerProfile?: string;
  126690. /**
  126691. * Defines a rendering group ID for meshes that will be loaded.
  126692. * This is for the default controllers only.
  126693. */
  126694. renderingGroupId?: number;
  126695. }
  126696. /**
  126697. * Represents an XR controller
  126698. */
  126699. export class WebXRInputSource {
  126700. private _scene;
  126701. /** The underlying input source for the controller */
  126702. inputSource: XRInputSource;
  126703. private _options;
  126704. private _tmpVector;
  126705. private _uniqueId;
  126706. /**
  126707. * 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
  126708. */
  126709. grip?: AbstractMesh;
  126710. /**
  126711. * If available, this is the gamepad object related to this controller.
  126712. * Using this object it is possible to get click events and trackpad changes of the
  126713. * webxr controller that is currently being used.
  126714. */
  126715. motionController?: WebXRAbstractMotionController;
  126716. /**
  126717. * Event that fires when the controller is removed/disposed.
  126718. * The object provided as event data is this controller, after associated assets were disposed.
  126719. * uniqueId is still available.
  126720. */
  126721. onDisposeObservable: Observable<WebXRInputSource>;
  126722. /**
  126723. * Will be triggered when the mesh associated with the motion controller is done loading.
  126724. * It is also possible that this will never trigger (!) if no mesh was loaded, or if the developer decides to load a different mesh
  126725. * A shortened version of controller -> motion controller -> on mesh loaded.
  126726. */
  126727. onMeshLoadedObservable: Observable<AbstractMesh>;
  126728. /**
  126729. * Observers registered here will trigger when a motion controller profile was assigned to this xr controller
  126730. */
  126731. onMotionControllerInitObservable: Observable<WebXRAbstractMotionController>;
  126732. /**
  126733. * Pointer which can be used to select objects or attach a visible laser to
  126734. */
  126735. pointer: AbstractMesh;
  126736. /**
  126737. * Creates the input source object
  126738. * @see https://doc.babylonjs.com/how_to/webxr_controllers_support
  126739. * @param _scene the scene which the controller should be associated to
  126740. * @param inputSource the underlying input source for the controller
  126741. * @param _options options for this controller creation
  126742. */
  126743. constructor(_scene: Scene,
  126744. /** The underlying input source for the controller */
  126745. inputSource: XRInputSource, _options?: IWebXRControllerOptions);
  126746. /**
  126747. * Get this controllers unique id
  126748. */
  126749. get uniqueId(): string;
  126750. /**
  126751. * Disposes of the object
  126752. */
  126753. dispose(): void;
  126754. /**
  126755. * Gets a world space ray coming from the pointer or grip
  126756. * @param result the resulting ray
  126757. * @param gripIfAvailable use the grip mesh instead of the pointer, if available
  126758. */
  126759. getWorldPointerRayToRef(result: Ray, gripIfAvailable?: boolean): void;
  126760. /**
  126761. * Updates the controller pose based on the given XRFrame
  126762. * @param xrFrame xr frame to update the pose with
  126763. * @param referenceSpace reference space to use
  126764. */
  126765. updateFromXRFrame(xrFrame: XRFrame, referenceSpace: XRReferenceSpace): void;
  126766. }
  126767. }
  126768. declare module BABYLON {
  126769. /**
  126770. * The schema for initialization options of the XR Input class
  126771. */
  126772. export interface IWebXRInputOptions {
  126773. /**
  126774. * If set to true no model will be automatically loaded
  126775. */
  126776. doNotLoadControllerMeshes?: boolean;
  126777. /**
  126778. * If set, this profile will be used for all controllers loaded (for example "microsoft-mixed-reality")
  126779. * If not found, the xr input profile data will be used.
  126780. * Profiles are defined here - https://github.com/immersive-web/webxr-input-profiles/
  126781. */
  126782. forceInputProfile?: string;
  126783. /**
  126784. * Do not send a request to the controller repository to load the profile.
  126785. *
  126786. * Instead, use the controllers available in babylon itself.
  126787. */
  126788. disableOnlineControllerRepository?: boolean;
  126789. /**
  126790. * A custom URL for the controllers repository
  126791. */
  126792. customControllersRepositoryURL?: string;
  126793. /**
  126794. * Should the controller model's components not move according to the user input
  126795. */
  126796. disableControllerAnimation?: boolean;
  126797. /**
  126798. * Optional options to pass to the controller. Will be overridden by the Input options where applicable
  126799. */
  126800. controllerOptions?: IWebXRControllerOptions;
  126801. }
  126802. /**
  126803. * XR input used to track XR inputs such as controllers/rays
  126804. */
  126805. export class WebXRInput implements IDisposable {
  126806. /**
  126807. * the xr session manager for this session
  126808. */
  126809. xrSessionManager: WebXRSessionManager;
  126810. /**
  126811. * the WebXR camera for this session. Mainly used for teleportation
  126812. */
  126813. xrCamera: WebXRCamera;
  126814. private readonly options;
  126815. /**
  126816. * XR controllers being tracked
  126817. */
  126818. controllers: Array<WebXRInputSource>;
  126819. private _frameObserver;
  126820. private _sessionEndedObserver;
  126821. private _sessionInitObserver;
  126822. /**
  126823. * Event when a controller has been connected/added
  126824. */
  126825. onControllerAddedObservable: Observable<WebXRInputSource>;
  126826. /**
  126827. * Event when a controller has been removed/disconnected
  126828. */
  126829. onControllerRemovedObservable: Observable<WebXRInputSource>;
  126830. /**
  126831. * Initializes the WebXRInput
  126832. * @param xrSessionManager the xr session manager for this session
  126833. * @param xrCamera the WebXR camera for this session. Mainly used for teleportation
  126834. * @param options = initialization options for this xr input
  126835. */
  126836. constructor(
  126837. /**
  126838. * the xr session manager for this session
  126839. */
  126840. xrSessionManager: WebXRSessionManager,
  126841. /**
  126842. * the WebXR camera for this session. Mainly used for teleportation
  126843. */
  126844. xrCamera: WebXRCamera, options?: IWebXRInputOptions);
  126845. private _onInputSourcesChange;
  126846. private _addAndRemoveControllers;
  126847. /**
  126848. * Disposes of the object
  126849. */
  126850. dispose(): void;
  126851. }
  126852. }
  126853. declare module BABYLON {
  126854. /**
  126855. * This is the base class for all WebXR features.
  126856. * Since most features require almost the same resources and callbacks, this class can be used to simplify the development
  126857. * Note that since the features manager is using the `IWebXRFeature` you are in no way obligated to use this class
  126858. */
  126859. export abstract class WebXRAbstractFeature implements IWebXRFeature {
  126860. protected _xrSessionManager: WebXRSessionManager;
  126861. private _attached;
  126862. private _removeOnDetach;
  126863. /**
  126864. * Should auto-attach be disabled?
  126865. */
  126866. disableAutoAttach: boolean;
  126867. /**
  126868. * Construct a new (abstract) WebXR feature
  126869. * @param _xrSessionManager the xr session manager for this feature
  126870. */
  126871. constructor(_xrSessionManager: WebXRSessionManager);
  126872. /**
  126873. * Is this feature attached
  126874. */
  126875. get attached(): boolean;
  126876. /**
  126877. * attach this feature
  126878. *
  126879. * @param force should attachment be forced (even when already attached)
  126880. * @returns true if successful, false is failed or already attached
  126881. */
  126882. attach(force?: boolean): boolean;
  126883. /**
  126884. * detach this feature.
  126885. *
  126886. * @returns true if successful, false if failed or already detached
  126887. */
  126888. detach(): boolean;
  126889. /**
  126890. * Dispose this feature and all of the resources attached
  126891. */
  126892. dispose(): void;
  126893. /**
  126894. * This is used to register callbacks that will automatically be removed when detach is called.
  126895. * @param observable the observable to which the observer will be attached
  126896. * @param callback the callback to register
  126897. */
  126898. protected _addNewAttachObserver<T>(observable: Observable<T>, callback: (eventData: T, eventState: EventState) => void): void;
  126899. /**
  126900. * Code in this function will be executed on each xrFrame received from the browser.
  126901. * This function will not execute after the feature is detached.
  126902. * @param _xrFrame the current frame
  126903. */
  126904. protected abstract _onXRFrame(_xrFrame: XRFrame): void;
  126905. }
  126906. }
  126907. declare module BABYLON {
  126908. /**
  126909. * Renders a layer on top of an existing scene
  126910. */
  126911. export class UtilityLayerRenderer implements IDisposable {
  126912. /** the original scene that will be rendered on top of */
  126913. originalScene: Scene;
  126914. private _pointerCaptures;
  126915. private _lastPointerEvents;
  126916. private static _DefaultUtilityLayer;
  126917. private static _DefaultKeepDepthUtilityLayer;
  126918. private _sharedGizmoLight;
  126919. private _renderCamera;
  126920. /**
  126921. * Gets the camera that is used to render the utility layer (when not set, this will be the last active camera)
  126922. * @param getRigParentIfPossible if the current active camera is a rig camera, should its parent camera be returned
  126923. * @returns the camera that is used when rendering the utility layer
  126924. */
  126925. getRenderCamera(getRigParentIfPossible?: boolean): Camera;
  126926. /**
  126927. * Sets the camera that should be used when rendering the utility layer (If set to null the last active camera will be used)
  126928. * @param cam the camera that should be used when rendering the utility layer
  126929. */
  126930. setRenderCamera(cam: Nullable<Camera>): void;
  126931. /**
  126932. * @hidden
  126933. * Light which used by gizmos to get light shading
  126934. */
  126935. _getSharedGizmoLight(): HemisphericLight;
  126936. /**
  126937. * If the picking should be done on the utility layer prior to the actual scene (Default: true)
  126938. */
  126939. pickUtilitySceneFirst: boolean;
  126940. /**
  126941. * 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)
  126942. */
  126943. static get DefaultUtilityLayer(): UtilityLayerRenderer;
  126944. /**
  126945. * 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)
  126946. */
  126947. static get DefaultKeepDepthUtilityLayer(): UtilityLayerRenderer;
  126948. /**
  126949. * The scene that is rendered on top of the original scene
  126950. */
  126951. utilityLayerScene: Scene;
  126952. /**
  126953. * If the utility layer should automatically be rendered on top of existing scene
  126954. */
  126955. shouldRender: boolean;
  126956. /**
  126957. * If set to true, only pointer down onPointerObservable events will be blocked when picking is occluded by original scene
  126958. */
  126959. onlyCheckPointerDownEvents: boolean;
  126960. /**
  126961. * If set to false, only pointerUp, pointerDown and pointerMove will be sent to the utilityLayerScene (false by default)
  126962. */
  126963. processAllEvents: boolean;
  126964. /**
  126965. * Observable raised when the pointer move from the utility layer scene to the main scene
  126966. */
  126967. onPointerOutObservable: Observable<number>;
  126968. /** Gets or sets a predicate that will be used to indicate utility meshes present in the main scene */
  126969. mainSceneTrackerPredicate: (mesh: Nullable<AbstractMesh>) => boolean;
  126970. private _afterRenderObserver;
  126971. private _sceneDisposeObserver;
  126972. private _originalPointerObserver;
  126973. /**
  126974. * Instantiates a UtilityLayerRenderer
  126975. * @param originalScene the original scene that will be rendered on top of
  126976. * @param handleEvents boolean indicating if the utility layer should handle events
  126977. */
  126978. constructor(
  126979. /** the original scene that will be rendered on top of */
  126980. originalScene: Scene, handleEvents?: boolean);
  126981. private _notifyObservers;
  126982. /**
  126983. * Renders the utility layers scene on top of the original scene
  126984. */
  126985. render(): void;
  126986. /**
  126987. * Disposes of the renderer
  126988. */
  126989. dispose(): void;
  126990. private _updateCamera;
  126991. }
  126992. }
  126993. declare module BABYLON {
  126994. /**
  126995. * Options interface for the pointer selection module
  126996. */
  126997. export interface IWebXRControllerPointerSelectionOptions {
  126998. /**
  126999. * if provided, this scene will be used to render meshes.
  127000. */
  127001. customUtilityLayerScene?: Scene;
  127002. /**
  127003. * 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)
  127004. * If not disabled, the last picked point will be used to execute a pointer up event
  127005. * If disabled, pointer up event will be triggered right after the pointer down event.
  127006. * Used in screen and gaze target ray mode only
  127007. */
  127008. disablePointerUpOnTouchOut: boolean;
  127009. /**
  127010. * For gaze mode (time to select instead of press)
  127011. */
  127012. forceGazeMode: boolean;
  127013. /**
  127014. * 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
  127015. * to start a new countdown to the pointer down event.
  127016. * Defaults to 1.
  127017. */
  127018. gazeModePointerMovedFactor?: number;
  127019. /**
  127020. * Different button type to use instead of the main component
  127021. */
  127022. overrideButtonId?: string;
  127023. /**
  127024. * use this rendering group id for the meshes (optional)
  127025. */
  127026. renderingGroupId?: number;
  127027. /**
  127028. * The amount of time in milliseconds it takes between pick found something to a pointer down event.
  127029. * Used in gaze modes. Tracked pointer uses the trigger, screen uses touch events
  127030. * 3000 means 3 seconds between pointing at something and selecting it
  127031. */
  127032. timeToSelect?: number;
  127033. /**
  127034. * Should meshes created here be added to a utility layer or the main scene
  127035. */
  127036. useUtilityLayer?: boolean;
  127037. /**
  127038. * the xr input to use with this pointer selection
  127039. */
  127040. xrInput: WebXRInput;
  127041. }
  127042. /**
  127043. * A module that will enable pointer selection for motion controllers of XR Input Sources
  127044. */
  127045. export class WebXRControllerPointerSelection extends WebXRAbstractFeature {
  127046. private readonly _options;
  127047. private static _idCounter;
  127048. private _attachController;
  127049. private _controllers;
  127050. private _scene;
  127051. private _tmpVectorForPickCompare;
  127052. /**
  127053. * The module's name
  127054. */
  127055. static readonly Name: string;
  127056. /**
  127057. * The (Babylon) version of this module.
  127058. * This is an integer representing the implementation version.
  127059. * This number does not correspond to the WebXR specs version
  127060. */
  127061. static readonly Version: number;
  127062. /**
  127063. * Disable lighting on the laser pointer (so it will always be visible)
  127064. */
  127065. disablePointerLighting: boolean;
  127066. /**
  127067. * Disable lighting on the selection mesh (so it will always be visible)
  127068. */
  127069. disableSelectionMeshLighting: boolean;
  127070. /**
  127071. * Should the laser pointer be displayed
  127072. */
  127073. displayLaserPointer: boolean;
  127074. /**
  127075. * Should the selection mesh be displayed (The ring at the end of the laser pointer)
  127076. */
  127077. displaySelectionMesh: boolean;
  127078. /**
  127079. * This color will be set to the laser pointer when selection is triggered
  127080. */
  127081. laserPointerPickedColor: Color3;
  127082. /**
  127083. * Default color of the laser pointer
  127084. */
  127085. laserPointerDefaultColor: Color3;
  127086. /**
  127087. * default color of the selection ring
  127088. */
  127089. selectionMeshDefaultColor: Color3;
  127090. /**
  127091. * This color will be applied to the selection ring when selection is triggered
  127092. */
  127093. selectionMeshPickedColor: Color3;
  127094. /**
  127095. * Optional filter to be used for ray selection. This predicate shares behavior with
  127096. * scene.pointerMovePredicate which takes priority if it is also assigned.
  127097. */
  127098. raySelectionPredicate: (mesh: AbstractMesh) => boolean;
  127099. /**
  127100. * constructs a new background remover module
  127101. * @param _xrSessionManager the session manager for this module
  127102. * @param _options read-only options to be used in this module
  127103. */
  127104. constructor(_xrSessionManager: WebXRSessionManager, _options: IWebXRControllerPointerSelectionOptions);
  127105. /**
  127106. * attach this feature
  127107. * Will usually be called by the features manager
  127108. *
  127109. * @returns true if successful.
  127110. */
  127111. attach(): boolean;
  127112. /**
  127113. * detach this feature.
  127114. * Will usually be called by the features manager
  127115. *
  127116. * @returns true if successful.
  127117. */
  127118. detach(): boolean;
  127119. /**
  127120. * Will get the mesh under a specific pointer.
  127121. * `scene.meshUnderPointer` will only return one mesh - either left or right.
  127122. * @param controllerId the controllerId to check
  127123. * @returns The mesh under pointer or null if no mesh is under the pointer
  127124. */
  127125. getMeshUnderPointer(controllerId: string): Nullable<AbstractMesh>;
  127126. /**
  127127. * Get the xr controller that correlates to the pointer id in the pointer event
  127128. *
  127129. * @param id the pointer id to search for
  127130. * @returns the controller that correlates to this id or null if not found
  127131. */
  127132. getXRControllerByPointerId(id: number): Nullable<WebXRInputSource>;
  127133. protected _onXRFrame(_xrFrame: XRFrame): void;
  127134. private _attachGazeMode;
  127135. private _attachScreenRayMode;
  127136. private _attachTrackedPointerRayMode;
  127137. private _convertNormalToDirectionOfRay;
  127138. private _detachController;
  127139. private _generateNewMeshPair;
  127140. private _pickingMoved;
  127141. private _updatePointerDistance;
  127142. /** @hidden */
  127143. get lasterPointerDefaultColor(): Color3;
  127144. }
  127145. }
  127146. declare module BABYLON {
  127147. /**
  127148. * Button which can be used to enter a different mode of XR
  127149. */
  127150. export class WebXREnterExitUIButton {
  127151. /** button element */
  127152. element: HTMLElement;
  127153. /** XR initialization options for the button */
  127154. sessionMode: XRSessionMode;
  127155. /** Reference space type */
  127156. referenceSpaceType: XRReferenceSpaceType;
  127157. /**
  127158. * Creates a WebXREnterExitUIButton
  127159. * @param element button element
  127160. * @param sessionMode XR initialization session mode
  127161. * @param referenceSpaceType the type of reference space to be used
  127162. */
  127163. constructor(
  127164. /** button element */
  127165. element: HTMLElement,
  127166. /** XR initialization options for the button */
  127167. sessionMode: XRSessionMode,
  127168. /** Reference space type */
  127169. referenceSpaceType: XRReferenceSpaceType);
  127170. /**
  127171. * Extendable function which can be used to update the button's visuals when the state changes
  127172. * @param activeButton the current active button in the UI
  127173. */
  127174. update(activeButton: Nullable<WebXREnterExitUIButton>): void;
  127175. }
  127176. /**
  127177. * Options to create the webXR UI
  127178. */
  127179. export class WebXREnterExitUIOptions {
  127180. /**
  127181. * User provided buttons to enable/disable WebXR. The system will provide default if not set
  127182. */
  127183. customButtons?: Array<WebXREnterExitUIButton>;
  127184. /**
  127185. * A reference space type to use when creating the default button.
  127186. * Default is local-floor
  127187. */
  127188. referenceSpaceType?: XRReferenceSpaceType;
  127189. /**
  127190. * Context to enter xr with
  127191. */
  127192. renderTarget?: Nullable<WebXRRenderTarget>;
  127193. /**
  127194. * A session mode to use when creating the default button.
  127195. * Default is immersive-vr
  127196. */
  127197. sessionMode?: XRSessionMode;
  127198. /**
  127199. * A list of optional features to init the session with
  127200. */
  127201. optionalFeatures?: string[];
  127202. /**
  127203. * A list of optional features to init the session with
  127204. */
  127205. requiredFeatures?: string[];
  127206. }
  127207. /**
  127208. * UI to allow the user to enter/exit XR mode
  127209. */
  127210. export class WebXREnterExitUI implements IDisposable {
  127211. private scene;
  127212. /** version of the options passed to this UI */
  127213. options: WebXREnterExitUIOptions;
  127214. private _activeButton;
  127215. private _buttons;
  127216. private _overlay;
  127217. /**
  127218. * Fired every time the active button is changed.
  127219. *
  127220. * When xr is entered via a button that launches xr that button will be the callback parameter
  127221. *
  127222. * When exiting xr the callback parameter will be null)
  127223. */
  127224. activeButtonChangedObservable: Observable<Nullable<WebXREnterExitUIButton>>;
  127225. /**
  127226. *
  127227. * @param scene babylon scene object to use
  127228. * @param options (read-only) version of the options passed to this UI
  127229. */
  127230. private constructor();
  127231. /**
  127232. * Creates UI to allow the user to enter/exit XR mode
  127233. * @param scene the scene to add the ui to
  127234. * @param helper the xr experience helper to enter/exit xr with
  127235. * @param options options to configure the UI
  127236. * @returns the created ui
  127237. */
  127238. static CreateAsync(scene: Scene, helper: WebXRExperienceHelper, options: WebXREnterExitUIOptions): Promise<WebXREnterExitUI>;
  127239. /**
  127240. * Disposes of the XR UI component
  127241. */
  127242. dispose(): void;
  127243. private _updateButtons;
  127244. }
  127245. }
  127246. declare module BABYLON {
  127247. /**
  127248. * Class containing static functions to help procedurally build meshes
  127249. */
  127250. export class LinesBuilder {
  127251. /**
  127252. * Creates a line system mesh. A line system is a pool of many lines gathered in a single mesh
  127253. * * 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
  127254. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineSystem to this static function
  127255. * * The parameter `lines` is an array of lines, each line being an array of successive Vector3
  127256. * * The optional parameter `instance` is an instance of an existing LineSystem object to be updated with the passed `lines` parameter
  127257. * * The optional parameter `colors` is an array of line colors, each line colors being an array of successive Color4, one per line point
  127258. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  127259. * * 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
  127260. * * When updating an instance, remember that only line point positions can change, not the number of points, neither the number of lines
  127261. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  127262. * @see https://doc.babylonjs.com/how_to/parametric_shapes#line-system
  127263. * @param name defines the name of the new line system
  127264. * @param options defines the options used to create the line system
  127265. * @param scene defines the hosting scene
  127266. * @returns a new line system mesh
  127267. */
  127268. static CreateLineSystem(name: string, options: {
  127269. lines: Vector3[][];
  127270. updatable?: boolean;
  127271. instance?: Nullable<LinesMesh>;
  127272. colors?: Nullable<Color4[][]>;
  127273. useVertexAlpha?: boolean;
  127274. }, scene: Nullable<Scene>): LinesMesh;
  127275. /**
  127276. * Creates a line mesh
  127277. * 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
  127278. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  127279. * * The parameter `points` is an array successive Vector3
  127280. * * 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
  127281. * * The optional parameter `colors` is an array of successive Color4, one per line point
  127282. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need alpha blending (faster)
  127283. * * When updating an instance, remember that only point positions can change, not the number of points
  127284. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  127285. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lines
  127286. * @param name defines the name of the new line system
  127287. * @param options defines the options used to create the line system
  127288. * @param scene defines the hosting scene
  127289. * @returns a new line mesh
  127290. */
  127291. static CreateLines(name: string, options: {
  127292. points: Vector3[];
  127293. updatable?: boolean;
  127294. instance?: Nullable<LinesMesh>;
  127295. colors?: Color4[];
  127296. useVertexAlpha?: boolean;
  127297. }, scene?: Nullable<Scene>): LinesMesh;
  127298. /**
  127299. * Creates a dashed line mesh
  127300. * * 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
  127301. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  127302. * * The parameter `points` is an array successive Vector3
  127303. * * The parameter `dashNb` is the intended total number of dashes (positive integer, default 200)
  127304. * * The parameter `dashSize` is the size of the dashes relatively the dash number (positive float, default 3)
  127305. * * The parameter `gapSize` is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  127306. * * 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
  127307. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  127308. * * When updating an instance, remember that only point positions can change, not the number of points
  127309. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  127310. * @param name defines the name of the mesh
  127311. * @param options defines the options used to create the mesh
  127312. * @param scene defines the hosting scene
  127313. * @returns the dashed line mesh
  127314. * @see https://doc.babylonjs.com/how_to/parametric_shapes#dashed-lines
  127315. */
  127316. static CreateDashedLines(name: string, options: {
  127317. points: Vector3[];
  127318. dashSize?: number;
  127319. gapSize?: number;
  127320. dashNb?: number;
  127321. updatable?: boolean;
  127322. instance?: LinesMesh;
  127323. useVertexAlpha?: boolean;
  127324. }, scene?: Nullable<Scene>): LinesMesh;
  127325. }
  127326. }
  127327. declare module BABYLON {
  127328. /**
  127329. * Construction options for a timer
  127330. */
  127331. export interface ITimerOptions<T> {
  127332. /**
  127333. * Time-to-end
  127334. */
  127335. timeout: number;
  127336. /**
  127337. * The context observable is used to calculate time deltas and provides the context of the timer's callbacks. Will usually be OnBeforeRenderObservable.
  127338. * Countdown calculation is done ONLY when the observable is notifying its observers, meaning that if
  127339. * you choose an observable that doesn't trigger too often, the wait time might extend further than the requested max time
  127340. */
  127341. contextObservable: Observable<T>;
  127342. /**
  127343. * Optional parameters when adding an observer to the observable
  127344. */
  127345. observableParameters?: {
  127346. mask?: number;
  127347. insertFirst?: boolean;
  127348. scope?: any;
  127349. };
  127350. /**
  127351. * An optional break condition that will stop the times prematurely. In this case onEnded will not be triggered!
  127352. */
  127353. breakCondition?: (data?: ITimerData<T>) => boolean;
  127354. /**
  127355. * Will be triggered when the time condition has met
  127356. */
  127357. onEnded?: (data: ITimerData<any>) => void;
  127358. /**
  127359. * Will be triggered when the break condition has met (prematurely ended)
  127360. */
  127361. onAborted?: (data: ITimerData<any>) => void;
  127362. /**
  127363. * Optional function to execute on each tick (or count)
  127364. */
  127365. onTick?: (data: ITimerData<any>) => void;
  127366. }
  127367. /**
  127368. * An interface defining the data sent by the timer
  127369. */
  127370. export interface ITimerData<T> {
  127371. /**
  127372. * When did it start
  127373. */
  127374. startTime: number;
  127375. /**
  127376. * Time now
  127377. */
  127378. currentTime: number;
  127379. /**
  127380. * Time passed since started
  127381. */
  127382. deltaTime: number;
  127383. /**
  127384. * How much is completed, in [0.0...1.0].
  127385. * Note that this CAN be higher than 1 due to the fact that we don't actually measure time but delta between observable calls
  127386. */
  127387. completeRate: number;
  127388. /**
  127389. * What the registered observable sent in the last count
  127390. */
  127391. payload: T;
  127392. }
  127393. /**
  127394. * The current state of the timer
  127395. */
  127396. export enum TimerState {
  127397. /**
  127398. * Timer initialized, not yet started
  127399. */
  127400. INIT = 0,
  127401. /**
  127402. * Timer started and counting
  127403. */
  127404. STARTED = 1,
  127405. /**
  127406. * Timer ended (whether aborted or time reached)
  127407. */
  127408. ENDED = 2
  127409. }
  127410. /**
  127411. * A simple version of the timer. Will take options and start the timer immediately after calling it
  127412. *
  127413. * @param options options with which to initialize this timer
  127414. */
  127415. export function setAndStartTimer(options: ITimerOptions<any>): Nullable<Observer<any>>;
  127416. /**
  127417. * An advanced implementation of a timer class
  127418. */
  127419. export class AdvancedTimer<T = any> implements IDisposable {
  127420. /**
  127421. * Will notify each time the timer calculates the remaining time
  127422. */
  127423. onEachCountObservable: Observable<ITimerData<T>>;
  127424. /**
  127425. * Will trigger when the timer was aborted due to the break condition
  127426. */
  127427. onTimerAbortedObservable: Observable<ITimerData<T>>;
  127428. /**
  127429. * Will trigger when the timer ended successfully
  127430. */
  127431. onTimerEndedObservable: Observable<ITimerData<T>>;
  127432. /**
  127433. * Will trigger when the timer state has changed
  127434. */
  127435. onStateChangedObservable: Observable<TimerState>;
  127436. private _observer;
  127437. private _contextObservable;
  127438. private _observableParameters;
  127439. private _startTime;
  127440. private _timer;
  127441. private _state;
  127442. private _breakCondition;
  127443. private _timeToEnd;
  127444. private _breakOnNextTick;
  127445. /**
  127446. * Will construct a new advanced timer based on the options provided. Timer will not start until start() is called.
  127447. * @param options construction options for this advanced timer
  127448. */
  127449. constructor(options: ITimerOptions<T>);
  127450. /**
  127451. * set a breaking condition for this timer. Default is to never break during count
  127452. * @param predicate the new break condition. Returns true to break, false otherwise
  127453. */
  127454. set breakCondition(predicate: (data: ITimerData<T>) => boolean);
  127455. /**
  127456. * Reset ALL associated observables in this advanced timer
  127457. */
  127458. clearObservables(): void;
  127459. /**
  127460. * Will start a new iteration of this timer. Only one instance of this timer can run at a time.
  127461. *
  127462. * @param timeToEnd how much time to measure until timer ended
  127463. */
  127464. start(timeToEnd?: number): void;
  127465. /**
  127466. * Will force a stop on the next tick.
  127467. */
  127468. stop(): void;
  127469. /**
  127470. * Dispose this timer, clearing all resources
  127471. */
  127472. dispose(): void;
  127473. private _setState;
  127474. private _tick;
  127475. private _stop;
  127476. }
  127477. }
  127478. declare module BABYLON {
  127479. /**
  127480. * The options container for the teleportation module
  127481. */
  127482. export interface IWebXRTeleportationOptions {
  127483. /**
  127484. * if provided, this scene will be used to render meshes.
  127485. */
  127486. customUtilityLayerScene?: Scene;
  127487. /**
  127488. * Values to configure the default target mesh
  127489. */
  127490. defaultTargetMeshOptions?: {
  127491. /**
  127492. * Fill color of the teleportation area
  127493. */
  127494. teleportationFillColor?: string;
  127495. /**
  127496. * Border color for the teleportation area
  127497. */
  127498. teleportationBorderColor?: string;
  127499. /**
  127500. * Disable the mesh's animation sequence
  127501. */
  127502. disableAnimation?: boolean;
  127503. /**
  127504. * Disable lighting on the material or the ring and arrow
  127505. */
  127506. disableLighting?: boolean;
  127507. /**
  127508. * Override the default material of the torus and arrow
  127509. */
  127510. torusArrowMaterial?: Material;
  127511. };
  127512. /**
  127513. * A list of meshes to use as floor meshes.
  127514. * Meshes can be added and removed after initializing the feature using the
  127515. * addFloorMesh and removeFloorMesh functions
  127516. * If empty, rotation will still work
  127517. */
  127518. floorMeshes?: AbstractMesh[];
  127519. /**
  127520. * use this rendering group id for the meshes (optional)
  127521. */
  127522. renderingGroupId?: number;
  127523. /**
  127524. * Should teleportation move only to snap points
  127525. */
  127526. snapPointsOnly?: boolean;
  127527. /**
  127528. * An array of points to which the teleportation will snap to.
  127529. * If the teleportation ray is in the proximity of one of those points, it will be corrected to this point.
  127530. */
  127531. snapPositions?: Vector3[];
  127532. /**
  127533. * How close should the teleportation ray be in order to snap to position.
  127534. * Default to 0.8 units (meters)
  127535. */
  127536. snapToPositionRadius?: number;
  127537. /**
  127538. * Provide your own teleportation mesh instead of babylon's wonderful doughnut.
  127539. * If you want to support rotation, make sure your mesh has a direction indicator.
  127540. *
  127541. * When left untouched, the default mesh will be initialized.
  127542. */
  127543. teleportationTargetMesh?: AbstractMesh;
  127544. /**
  127545. * If main component is used (no thumbstick), how long should the "long press" take before teleport
  127546. */
  127547. timeToTeleport?: number;
  127548. /**
  127549. * Disable using the thumbstick and use the main component (usually trigger) on long press.
  127550. * This will be automatically true if the controller doesn't have a thumbstick or touchpad.
  127551. */
  127552. useMainComponentOnly?: boolean;
  127553. /**
  127554. * Should meshes created here be added to a utility layer or the main scene
  127555. */
  127556. useUtilityLayer?: boolean;
  127557. /**
  127558. * Babylon XR Input class for controller
  127559. */
  127560. xrInput: WebXRInput;
  127561. }
  127562. /**
  127563. * This is a teleportation feature to be used with WebXR-enabled motion controllers.
  127564. * When enabled and attached, the feature will allow a user to move around and rotate in the scene using
  127565. * the input of the attached controllers.
  127566. */
  127567. export class WebXRMotionControllerTeleportation extends WebXRAbstractFeature {
  127568. private _options;
  127569. private _controllers;
  127570. private _currentTeleportationControllerId;
  127571. private _floorMeshes;
  127572. private _quadraticBezierCurve;
  127573. private _selectionFeature;
  127574. private _snapToPositions;
  127575. private _snappedToPoint;
  127576. private _teleportationRingMaterial?;
  127577. private _tmpRay;
  127578. private _tmpVector;
  127579. /**
  127580. * The module's name
  127581. */
  127582. static readonly Name: string;
  127583. /**
  127584. * The (Babylon) version of this module.
  127585. * This is an integer representing the implementation version.
  127586. * This number does not correspond to the webxr specs version
  127587. */
  127588. static readonly Version: number;
  127589. /**
  127590. * Is movement backwards enabled
  127591. */
  127592. backwardsMovementEnabled: boolean;
  127593. /**
  127594. * Distance to travel when moving backwards
  127595. */
  127596. backwardsTeleportationDistance: number;
  127597. /**
  127598. * The distance from the user to the inspection point in the direction of the controller
  127599. * A higher number will allow the user to move further
  127600. * defaults to 5 (meters, in xr units)
  127601. */
  127602. parabolicCheckRadius: number;
  127603. /**
  127604. * Should the module support parabolic ray on top of direct ray
  127605. * If enabled, the user will be able to point "at the sky" and move according to predefined radius distance
  127606. * Very helpful when moving between floors / different heights
  127607. */
  127608. parabolicRayEnabled: boolean;
  127609. /**
  127610. * How much rotation should be applied when rotating right and left
  127611. */
  127612. rotationAngle: number;
  127613. /**
  127614. * Is rotation enabled when moving forward?
  127615. * Disabling this feature will prevent the user from deciding the direction when teleporting
  127616. */
  127617. rotationEnabled: boolean;
  127618. /**
  127619. * constructs a new anchor system
  127620. * @param _xrSessionManager an instance of WebXRSessionManager
  127621. * @param _options configuration object for this feature
  127622. */
  127623. constructor(_xrSessionManager: WebXRSessionManager, _options: IWebXRTeleportationOptions);
  127624. /**
  127625. * Get the snapPointsOnly flag
  127626. */
  127627. get snapPointsOnly(): boolean;
  127628. /**
  127629. * Sets the snapPointsOnly flag
  127630. * @param snapToPoints should teleportation be exclusively to snap points
  127631. */
  127632. set snapPointsOnly(snapToPoints: boolean);
  127633. /**
  127634. * Add a new mesh to the floor meshes array
  127635. * @param mesh the mesh to use as floor mesh
  127636. */
  127637. addFloorMesh(mesh: AbstractMesh): void;
  127638. /**
  127639. * Add a new snap-to point to fix teleportation to this position
  127640. * @param newSnapPoint The new Snap-To point
  127641. */
  127642. addSnapPoint(newSnapPoint: Vector3): void;
  127643. attach(): boolean;
  127644. detach(): boolean;
  127645. dispose(): void;
  127646. /**
  127647. * Remove a mesh from the floor meshes array
  127648. * @param mesh the mesh to remove
  127649. */
  127650. removeFloorMesh(mesh: AbstractMesh): void;
  127651. /**
  127652. * Remove a mesh from the floor meshes array using its name
  127653. * @param name the mesh name to remove
  127654. */
  127655. removeFloorMeshByName(name: string): void;
  127656. /**
  127657. * 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
  127658. * @param snapPointToRemove the point (or a clone of it) to be removed from the array
  127659. * @returns was the point found and removed or not
  127660. */
  127661. removeSnapPoint(snapPointToRemove: Vector3): boolean;
  127662. /**
  127663. * This function sets a selection feature that will be disabled when
  127664. * the forward ray is shown and will be reattached when hidden.
  127665. * This is used to remove the selection rays when moving.
  127666. * @param selectionFeature the feature to disable when forward movement is enabled
  127667. */
  127668. setSelectionFeature(selectionFeature: IWebXRFeature): void;
  127669. protected _onXRFrame(_xrFrame: XRFrame): void;
  127670. private _attachController;
  127671. private _createDefaultTargetMesh;
  127672. private _detachController;
  127673. private _findClosestSnapPointWithRadius;
  127674. private _setTargetMeshPosition;
  127675. private _setTargetMeshVisibility;
  127676. private _showParabolicPath;
  127677. private _teleportForward;
  127678. }
  127679. }
  127680. declare module BABYLON {
  127681. /**
  127682. * Options for the default xr helper
  127683. */
  127684. export class WebXRDefaultExperienceOptions {
  127685. /**
  127686. * Enable or disable default UI to enter XR
  127687. */
  127688. disableDefaultUI?: boolean;
  127689. /**
  127690. * Should teleportation not initialize. defaults to false.
  127691. */
  127692. disableTeleportation?: boolean;
  127693. /**
  127694. * Floor meshes that will be used for teleport
  127695. */
  127696. floorMeshes?: Array<AbstractMesh>;
  127697. /**
  127698. * If set to true, the first frame will not be used to reset position
  127699. * The first frame is mainly used when copying transformation from the old camera
  127700. * Mainly used in AR
  127701. */
  127702. ignoreNativeCameraTransformation?: boolean;
  127703. /**
  127704. * Disable the controller mesh-loading. Can be used if you want to load your own meshes
  127705. */
  127706. inputOptions?: IWebXRInputOptions;
  127707. /**
  127708. * optional configuration for the output canvas
  127709. */
  127710. outputCanvasOptions?: WebXRManagedOutputCanvasOptions;
  127711. /**
  127712. * optional UI options. This can be used among other to change session mode and reference space type
  127713. */
  127714. uiOptions?: WebXREnterExitUIOptions;
  127715. /**
  127716. * When loading teleportation and pointer select, use stable versions instead of latest.
  127717. */
  127718. useStablePlugins?: boolean;
  127719. /**
  127720. * An optional rendering group id that will be set globally for teleportation, pointer selection and default controller meshes
  127721. */
  127722. renderingGroupId?: number;
  127723. /**
  127724. * A list of optional features to init the session with
  127725. * If set to true, all features we support will be added
  127726. */
  127727. optionalFeatures?: boolean | string[];
  127728. }
  127729. /**
  127730. * Default experience which provides a similar setup to the previous webVRExperience
  127731. */
  127732. export class WebXRDefaultExperience {
  127733. /**
  127734. * Base experience
  127735. */
  127736. baseExperience: WebXRExperienceHelper;
  127737. /**
  127738. * Enables ui for entering/exiting xr
  127739. */
  127740. enterExitUI: WebXREnterExitUI;
  127741. /**
  127742. * Input experience extension
  127743. */
  127744. input: WebXRInput;
  127745. /**
  127746. * Enables laser pointer and selection
  127747. */
  127748. pointerSelection: WebXRControllerPointerSelection;
  127749. /**
  127750. * Default target xr should render to
  127751. */
  127752. renderTarget: WebXRRenderTarget;
  127753. /**
  127754. * Enables teleportation
  127755. */
  127756. teleportation: WebXRMotionControllerTeleportation;
  127757. private constructor();
  127758. /**
  127759. * Creates the default xr experience
  127760. * @param scene scene
  127761. * @param options options for basic configuration
  127762. * @returns resulting WebXRDefaultExperience
  127763. */
  127764. static CreateAsync(scene: Scene, options?: WebXRDefaultExperienceOptions): Promise<WebXRDefaultExperience>;
  127765. /**
  127766. * DIsposes of the experience helper
  127767. */
  127768. dispose(): void;
  127769. }
  127770. }
  127771. declare module BABYLON {
  127772. /**
  127773. * Options to modify the vr teleportation behavior.
  127774. */
  127775. export interface VRTeleportationOptions {
  127776. /**
  127777. * The name of the mesh which should be used as the teleportation floor. (default: null)
  127778. */
  127779. floorMeshName?: string;
  127780. /**
  127781. * A list of meshes to be used as the teleportation floor. (default: empty)
  127782. */
  127783. floorMeshes?: Mesh[];
  127784. /**
  127785. * The teleportation mode. (default: TELEPORTATIONMODE_CONSTANTTIME)
  127786. */
  127787. teleportationMode?: number;
  127788. /**
  127789. * The duration of the animation in ms, apply when animationMode is TELEPORTATIONMODE_CONSTANTTIME. (default 122ms)
  127790. */
  127791. teleportationTime?: number;
  127792. /**
  127793. * The speed of the animation in distance/sec, apply when animationMode is TELEPORTATIONMODE_CONSTANTSPEED. (default 20 units / sec)
  127794. */
  127795. teleportationSpeed?: number;
  127796. /**
  127797. * The easing function used in the animation or null for Linear. (default CircleEase)
  127798. */
  127799. easingFunction?: EasingFunction;
  127800. }
  127801. /**
  127802. * Options to modify the vr experience helper's behavior.
  127803. */
  127804. export interface VRExperienceHelperOptions extends WebVROptions {
  127805. /**
  127806. * Create a DeviceOrientationCamera to be used as your out of vr camera. (default: true)
  127807. */
  127808. createDeviceOrientationCamera?: boolean;
  127809. /**
  127810. * Create a VRDeviceOrientationFreeCamera to be used for VR when no external HMD is found. (default: true)
  127811. */
  127812. createFallbackVRDeviceOrientationFreeCamera?: boolean;
  127813. /**
  127814. * Uses the main button on the controller to toggle the laser casted. (default: true)
  127815. */
  127816. laserToggle?: boolean;
  127817. /**
  127818. * A list of meshes to be used as the teleportation floor. If specified, teleportation will be enabled (default: undefined)
  127819. */
  127820. floorMeshes?: Mesh[];
  127821. /**
  127822. * Distortion metrics for the fallback vrDeviceOrientationCamera (default: VRCameraMetrics.Default)
  127823. */
  127824. vrDeviceOrientationCameraMetrics?: VRCameraMetrics;
  127825. /**
  127826. * Defines if WebXR should be used instead of WebVR (if available)
  127827. */
  127828. useXR?: boolean;
  127829. }
  127830. /**
  127831. * Event containing information after VR has been entered
  127832. */
  127833. export class OnAfterEnteringVRObservableEvent {
  127834. /**
  127835. * If entering vr was successful
  127836. */
  127837. success: boolean;
  127838. }
  127839. /**
  127840. * Helps to quickly add VR support to an existing scene.
  127841. * See https://doc.babylonjs.com/how_to/webvr_helper
  127842. */
  127843. export class VRExperienceHelper {
  127844. /** Options to modify the vr experience helper's behavior. */
  127845. webVROptions: VRExperienceHelperOptions;
  127846. private _scene;
  127847. private _position;
  127848. private _btnVR;
  127849. private _btnVRDisplayed;
  127850. private _webVRsupported;
  127851. private _webVRready;
  127852. private _webVRrequesting;
  127853. private _webVRpresenting;
  127854. private _hasEnteredVR;
  127855. private _fullscreenVRpresenting;
  127856. private _inputElement;
  127857. private _webVRCamera;
  127858. private _vrDeviceOrientationCamera;
  127859. private _deviceOrientationCamera;
  127860. private _existingCamera;
  127861. private _onKeyDown;
  127862. private _onVrDisplayPresentChange;
  127863. private _onVRDisplayChanged;
  127864. private _onVRRequestPresentStart;
  127865. private _onVRRequestPresentComplete;
  127866. /**
  127867. * 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)
  127868. */
  127869. enableGazeEvenWhenNoPointerLock: boolean;
  127870. /**
  127871. * Gets or sets a boolean indicating that the VREXperienceHelper will exit VR if double tap is detected
  127872. */
  127873. exitVROnDoubleTap: boolean;
  127874. /**
  127875. * Observable raised right before entering VR.
  127876. */
  127877. onEnteringVRObservable: Observable<VRExperienceHelper>;
  127878. /**
  127879. * Observable raised when entering VR has completed.
  127880. */
  127881. onAfterEnteringVRObservable: Observable<OnAfterEnteringVRObservableEvent>;
  127882. /**
  127883. * Observable raised when exiting VR.
  127884. */
  127885. onExitingVRObservable: Observable<VRExperienceHelper>;
  127886. /**
  127887. * Observable raised when controller mesh is loaded.
  127888. */
  127889. onControllerMeshLoadedObservable: Observable<WebVRController>;
  127890. /** Return this.onEnteringVRObservable
  127891. * Note: This one is for backward compatibility. Please use onEnteringVRObservable directly
  127892. */
  127893. get onEnteringVR(): Observable<VRExperienceHelper>;
  127894. /** Return this.onExitingVRObservable
  127895. * Note: This one is for backward compatibility. Please use onExitingVRObservable directly
  127896. */
  127897. get onExitingVR(): Observable<VRExperienceHelper>;
  127898. /** Return this.onControllerMeshLoadedObservable
  127899. * Note: This one is for backward compatibility. Please use onControllerMeshLoadedObservable directly
  127900. */
  127901. get onControllerMeshLoaded(): Observable<WebVRController>;
  127902. private _rayLength;
  127903. private _useCustomVRButton;
  127904. private _teleportationRequested;
  127905. private _teleportActive;
  127906. private _floorMeshName;
  127907. private _floorMeshesCollection;
  127908. private _teleportationMode;
  127909. private _teleportationTime;
  127910. private _teleportationSpeed;
  127911. private _teleportationEasing;
  127912. private _rotationAllowed;
  127913. private _teleportBackwardsVector;
  127914. private _teleportationTarget;
  127915. private _isDefaultTeleportationTarget;
  127916. private _postProcessMove;
  127917. private _teleportationFillColor;
  127918. private _teleportationBorderColor;
  127919. private _rotationAngle;
  127920. private _haloCenter;
  127921. private _cameraGazer;
  127922. private _padSensibilityUp;
  127923. private _padSensibilityDown;
  127924. private _leftController;
  127925. private _rightController;
  127926. private _gazeColor;
  127927. private _laserColor;
  127928. private _pickedLaserColor;
  127929. private _pickedGazeColor;
  127930. /**
  127931. * Observable raised when a new mesh is selected based on meshSelectionPredicate
  127932. */
  127933. onNewMeshSelected: Observable<AbstractMesh>;
  127934. /**
  127935. * Observable raised when a new mesh is selected based on meshSelectionPredicate.
  127936. * This observable will provide the mesh and the controller used to select the mesh
  127937. */
  127938. onMeshSelectedWithController: Observable<{
  127939. mesh: AbstractMesh;
  127940. controller: WebVRController;
  127941. }>;
  127942. /**
  127943. * Observable raised when a new mesh is picked based on meshSelectionPredicate
  127944. */
  127945. onNewMeshPicked: Observable<PickingInfo>;
  127946. private _circleEase;
  127947. /**
  127948. * Observable raised before camera teleportation
  127949. */
  127950. onBeforeCameraTeleport: Observable<Vector3>;
  127951. /**
  127952. * Observable raised after camera teleportation
  127953. */
  127954. onAfterCameraTeleport: Observable<Vector3>;
  127955. /**
  127956. * Observable raised when current selected mesh gets unselected
  127957. */
  127958. onSelectedMeshUnselected: Observable<AbstractMesh>;
  127959. private _raySelectionPredicate;
  127960. /**
  127961. * To be optionaly changed by user to define custom ray selection
  127962. */
  127963. raySelectionPredicate: (mesh: AbstractMesh) => boolean;
  127964. /**
  127965. * To be optionaly changed by user to define custom selection logic (after ray selection)
  127966. */
  127967. meshSelectionPredicate: (mesh: AbstractMesh) => boolean;
  127968. /**
  127969. * Set teleportation enabled. If set to false camera teleportation will be disabled but camera rotation will be kept.
  127970. */
  127971. teleportationEnabled: boolean;
  127972. private _defaultHeight;
  127973. private _teleportationInitialized;
  127974. private _interactionsEnabled;
  127975. private _interactionsRequested;
  127976. private _displayGaze;
  127977. private _displayLaserPointer;
  127978. /**
  127979. * The mesh used to display where the user is going to teleport.
  127980. */
  127981. get teleportationTarget(): Mesh;
  127982. /**
  127983. * Sets the mesh to be used to display where the user is going to teleport.
  127984. */
  127985. set teleportationTarget(value: Mesh);
  127986. /**
  127987. * 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
  127988. * when set bakeCurrentTransformIntoVertices will be called on the mesh.
  127989. * See https://doc.babylonjs.com/resources/baking_transformations
  127990. */
  127991. get gazeTrackerMesh(): Mesh;
  127992. set gazeTrackerMesh(value: Mesh);
  127993. /**
  127994. * If the gaze trackers scale should be updated to be constant size when pointing at near/far meshes
  127995. */
  127996. updateGazeTrackerScale: boolean;
  127997. /**
  127998. * If the gaze trackers color should be updated when selecting meshes
  127999. */
  128000. updateGazeTrackerColor: boolean;
  128001. /**
  128002. * If the controller laser color should be updated when selecting meshes
  128003. */
  128004. updateControllerLaserColor: boolean;
  128005. /**
  128006. * The gaze tracking mesh corresponding to the left controller
  128007. */
  128008. get leftControllerGazeTrackerMesh(): Nullable<Mesh>;
  128009. /**
  128010. * The gaze tracking mesh corresponding to the right controller
  128011. */
  128012. get rightControllerGazeTrackerMesh(): Nullable<Mesh>;
  128013. /**
  128014. * If the ray of the gaze should be displayed.
  128015. */
  128016. get displayGaze(): boolean;
  128017. /**
  128018. * Sets if the ray of the gaze should be displayed.
  128019. */
  128020. set displayGaze(value: boolean);
  128021. /**
  128022. * If the ray of the LaserPointer should be displayed.
  128023. */
  128024. get displayLaserPointer(): boolean;
  128025. /**
  128026. * Sets if the ray of the LaserPointer should be displayed.
  128027. */
  128028. set displayLaserPointer(value: boolean);
  128029. /**
  128030. * The deviceOrientationCamera used as the camera when not in VR.
  128031. */
  128032. get deviceOrientationCamera(): Nullable<DeviceOrientationCamera>;
  128033. /**
  128034. * Based on the current WebVR support, returns the current VR camera used.
  128035. */
  128036. get currentVRCamera(): Nullable<Camera>;
  128037. /**
  128038. * The webVRCamera which is used when in VR.
  128039. */
  128040. get webVRCamera(): WebVRFreeCamera;
  128041. /**
  128042. * The deviceOrientationCamera that is used as a fallback when vr device is not connected.
  128043. */
  128044. get vrDeviceOrientationCamera(): Nullable<VRDeviceOrientationFreeCamera>;
  128045. /**
  128046. * The html button that is used to trigger entering into VR.
  128047. */
  128048. get vrButton(): Nullable<HTMLButtonElement>;
  128049. private get _teleportationRequestInitiated();
  128050. /**
  128051. * Defines whether or not Pointer lock should be requested when switching to
  128052. * full screen.
  128053. */
  128054. requestPointerLockOnFullScreen: boolean;
  128055. /**
  128056. * If asking to force XR, this will be populated with the default xr experience
  128057. */
  128058. xr: WebXRDefaultExperience;
  128059. /**
  128060. * Was the XR test done already. If this is true AND this.xr exists, xr is initialized.
  128061. * If this is true and no this.xr, xr exists but is not supported, using WebVR.
  128062. */
  128063. xrTestDone: boolean;
  128064. /**
  128065. * Instantiates a VRExperienceHelper.
  128066. * Helps to quickly add VR support to an existing scene.
  128067. * @param scene The scene the VRExperienceHelper belongs to.
  128068. * @param webVROptions Options to modify the vr experience helper's behavior.
  128069. */
  128070. constructor(scene: Scene,
  128071. /** Options to modify the vr experience helper's behavior. */
  128072. webVROptions?: VRExperienceHelperOptions);
  128073. private completeVRInit;
  128074. private _onDefaultMeshLoaded;
  128075. private _onResize;
  128076. private _onFullscreenChange;
  128077. /**
  128078. * Gets a value indicating if we are currently in VR mode.
  128079. */
  128080. get isInVRMode(): boolean;
  128081. private onVrDisplayPresentChange;
  128082. private onVRDisplayChanged;
  128083. private moveButtonToBottomRight;
  128084. private displayVRButton;
  128085. private updateButtonVisibility;
  128086. private _cachedAngularSensibility;
  128087. /**
  128088. * Attempt to enter VR. If a headset is connected and ready, will request present on that.
  128089. * Otherwise, will use the fullscreen API.
  128090. */
  128091. enterVR(): void;
  128092. /**
  128093. * Attempt to exit VR, or fullscreen.
  128094. */
  128095. exitVR(): void;
  128096. /**
  128097. * The position of the vr experience helper.
  128098. */
  128099. get position(): Vector3;
  128100. /**
  128101. * Sets the position of the vr experience helper.
  128102. */
  128103. set position(value: Vector3);
  128104. /**
  128105. * Enables controllers and user interactions such as selecting and object or clicking on an object.
  128106. */
  128107. enableInteractions(): void;
  128108. private get _noControllerIsActive();
  128109. private beforeRender;
  128110. private _isTeleportationFloor;
  128111. /**
  128112. * Adds a floor mesh to be used for teleportation.
  128113. * @param floorMesh the mesh to be used for teleportation.
  128114. */
  128115. addFloorMesh(floorMesh: Mesh): void;
  128116. /**
  128117. * Removes a floor mesh from being used for teleportation.
  128118. * @param floorMesh the mesh to be removed.
  128119. */
  128120. removeFloorMesh(floorMesh: Mesh): void;
  128121. /**
  128122. * Enables interactions and teleportation using the VR controllers and gaze.
  128123. * @param vrTeleportationOptions options to modify teleportation behavior.
  128124. */
  128125. enableTeleportation(vrTeleportationOptions?: VRTeleportationOptions): void;
  128126. private _onNewGamepadConnected;
  128127. private _tryEnableInteractionOnController;
  128128. private _onNewGamepadDisconnected;
  128129. private _enableInteractionOnController;
  128130. private _checkTeleportWithRay;
  128131. private _checkRotate;
  128132. private _checkTeleportBackwards;
  128133. private _enableTeleportationOnController;
  128134. private _createTeleportationCircles;
  128135. private _displayTeleportationTarget;
  128136. private _hideTeleportationTarget;
  128137. private _rotateCamera;
  128138. private _moveTeleportationSelectorTo;
  128139. private _workingVector;
  128140. private _workingQuaternion;
  128141. private _workingMatrix;
  128142. /**
  128143. * Time Constant Teleportation Mode
  128144. */
  128145. static readonly TELEPORTATIONMODE_CONSTANTTIME: number;
  128146. /**
  128147. * Speed Constant Teleportation Mode
  128148. */
  128149. static readonly TELEPORTATIONMODE_CONSTANTSPEED: number;
  128150. /**
  128151. * Teleports the users feet to the desired location
  128152. * @param location The location where the user's feet should be placed
  128153. */
  128154. teleportCamera(location: Vector3): void;
  128155. private _convertNormalToDirectionOfRay;
  128156. private _castRayAndSelectObject;
  128157. private _notifySelectedMeshUnselected;
  128158. /**
  128159. * Permanently set new colors for the laser pointer
  128160. * @param color the new laser color
  128161. * @param pickedColor the new laser color when picked mesh detected
  128162. */
  128163. setLaserColor(color: Color3, pickedColor?: Color3): void;
  128164. /**
  128165. * Set lighting enabled / disabled on the laser pointer of both controllers
  128166. * @param enabled should the lighting be enabled on the laser pointer
  128167. */
  128168. setLaserLightingState(enabled?: boolean): void;
  128169. /**
  128170. * Permanently set new colors for the gaze pointer
  128171. * @param color the new gaze color
  128172. * @param pickedColor the new gaze color when picked mesh detected
  128173. */
  128174. setGazeColor(color: Color3, pickedColor?: Color3): void;
  128175. /**
  128176. * Sets the color of the laser ray from the vr controllers.
  128177. * @param color new color for the ray.
  128178. */
  128179. changeLaserColor(color: Color3): void;
  128180. /**
  128181. * Sets the color of the ray from the vr headsets gaze.
  128182. * @param color new color for the ray.
  128183. */
  128184. changeGazeColor(color: Color3): void;
  128185. /**
  128186. * Exits VR and disposes of the vr experience helper
  128187. */
  128188. dispose(): void;
  128189. /**
  128190. * Gets the name of the VRExperienceHelper class
  128191. * @returns "VRExperienceHelper"
  128192. */
  128193. getClassName(): string;
  128194. }
  128195. }
  128196. declare module BABYLON {
  128197. /**
  128198. * Contains an array of blocks representing the octree
  128199. */
  128200. export interface IOctreeContainer<T> {
  128201. /**
  128202. * Blocks within the octree
  128203. */
  128204. blocks: Array<OctreeBlock<T>>;
  128205. }
  128206. /**
  128207. * Class used to store a cell in an octree
  128208. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  128209. */
  128210. export class OctreeBlock<T> {
  128211. /**
  128212. * Gets the content of the current block
  128213. */
  128214. entries: T[];
  128215. /**
  128216. * Gets the list of block children
  128217. */
  128218. blocks: Array<OctreeBlock<T>>;
  128219. private _depth;
  128220. private _maxDepth;
  128221. private _capacity;
  128222. private _minPoint;
  128223. private _maxPoint;
  128224. private _boundingVectors;
  128225. private _creationFunc;
  128226. /**
  128227. * Creates a new block
  128228. * @param minPoint defines the minimum vector (in world space) of the block's bounding box
  128229. * @param maxPoint defines the maximum vector (in world space) of the block's bounding box
  128230. * @param capacity defines the maximum capacity of this block (if capacity is reached the block will be split into sub blocks)
  128231. * @param depth defines the current depth of this block in the octree
  128232. * @param maxDepth defines the maximal depth allowed (beyond this value, the capacity is ignored)
  128233. * @param creationFunc defines a callback to call when an element is added to the block
  128234. */
  128235. constructor(minPoint: Vector3, maxPoint: Vector3, capacity: number, depth: number, maxDepth: number, creationFunc: (entry: T, block: OctreeBlock<T>) => void);
  128236. /**
  128237. * Gets the maximum capacity of this block (if capacity is reached the block will be split into sub blocks)
  128238. */
  128239. get capacity(): number;
  128240. /**
  128241. * Gets the minimum vector (in world space) of the block's bounding box
  128242. */
  128243. get minPoint(): Vector3;
  128244. /**
  128245. * Gets the maximum vector (in world space) of the block's bounding box
  128246. */
  128247. get maxPoint(): Vector3;
  128248. /**
  128249. * Add a new element to this block
  128250. * @param entry defines the element to add
  128251. */
  128252. addEntry(entry: T): void;
  128253. /**
  128254. * Remove an element from this block
  128255. * @param entry defines the element to remove
  128256. */
  128257. removeEntry(entry: T): void;
  128258. /**
  128259. * Add an array of elements to this block
  128260. * @param entries defines the array of elements to add
  128261. */
  128262. addEntries(entries: T[]): void;
  128263. /**
  128264. * Test if the current block intersects the furstum planes and if yes, then add its content to the selection array
  128265. * @param frustumPlanes defines the frustum planes to test
  128266. * @param selection defines the array to store current content if selection is positive
  128267. * @param allowDuplicate defines if the selection array can contains duplicated entries
  128268. */
  128269. select(frustumPlanes: Plane[], selection: SmartArrayNoDuplicate<T>, allowDuplicate?: boolean): void;
  128270. /**
  128271. * Test if the current block intersect with the given bounding sphere and if yes, then add its content to the selection array
  128272. * @param sphereCenter defines the bounding sphere center
  128273. * @param sphereRadius defines the bounding sphere radius
  128274. * @param selection defines the array to store current content if selection is positive
  128275. * @param allowDuplicate defines if the selection array can contains duplicated entries
  128276. */
  128277. intersects(sphereCenter: Vector3, sphereRadius: number, selection: SmartArrayNoDuplicate<T>, allowDuplicate?: boolean): void;
  128278. /**
  128279. * Test if the current block intersect with the given ray and if yes, then add its content to the selection array
  128280. * @param ray defines the ray to test with
  128281. * @param selection defines the array to store current content if selection is positive
  128282. */
  128283. intersectsRay(ray: Ray, selection: SmartArrayNoDuplicate<T>): void;
  128284. /**
  128285. * Subdivide the content into child blocks (this block will then be empty)
  128286. */
  128287. createInnerBlocks(): void;
  128288. /**
  128289. * @hidden
  128290. */
  128291. 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;
  128292. }
  128293. }
  128294. declare module BABYLON {
  128295. /**
  128296. * Octrees are a really powerful data structure that can quickly select entities based on space coordinates.
  128297. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  128298. */
  128299. export class Octree<T> {
  128300. /** 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.) */
  128301. maxDepth: number;
  128302. /**
  128303. * Blocks within the octree containing objects
  128304. */
  128305. blocks: Array<OctreeBlock<T>>;
  128306. /**
  128307. * Content stored in the octree
  128308. */
  128309. dynamicContent: T[];
  128310. private _maxBlockCapacity;
  128311. private _selectionContent;
  128312. private _creationFunc;
  128313. /**
  128314. * Creates a octree
  128315. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  128316. * @param creationFunc function to be used to instatiate the octree
  128317. * @param maxBlockCapacity defines the maximum number of meshes you want on your octree's leaves (default: 64)
  128318. * @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.)
  128319. */
  128320. constructor(creationFunc: (entry: T, block: OctreeBlock<T>) => void, maxBlockCapacity?: number,
  128321. /** 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.) */
  128322. maxDepth?: number);
  128323. /**
  128324. * Updates the octree by adding blocks for the passed in meshes within the min and max world parameters
  128325. * @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);
  128326. * @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);
  128327. * @param entries meshes to be added to the octree blocks
  128328. */
  128329. update(worldMin: Vector3, worldMax: Vector3, entries: T[]): void;
  128330. /**
  128331. * Adds a mesh to the octree
  128332. * @param entry Mesh to add to the octree
  128333. */
  128334. addMesh(entry: T): void;
  128335. /**
  128336. * Remove an element from the octree
  128337. * @param entry defines the element to remove
  128338. */
  128339. removeMesh(entry: T): void;
  128340. /**
  128341. * Selects an array of meshes within the frustum
  128342. * @param frustumPlanes The frustum planes to use which will select all meshes within it
  128343. * @param allowDuplicate If duplicate objects are allowed in the resulting object array
  128344. * @returns array of meshes within the frustum
  128345. */
  128346. select(frustumPlanes: Plane[], allowDuplicate?: boolean): SmartArray<T>;
  128347. /**
  128348. * Test if the octree intersect with the given bounding sphere and if yes, then add its content to the selection array
  128349. * @param sphereCenter defines the bounding sphere center
  128350. * @param sphereRadius defines the bounding sphere radius
  128351. * @param allowDuplicate defines if the selection array can contains duplicated entries
  128352. * @returns an array of objects that intersect the sphere
  128353. */
  128354. intersects(sphereCenter: Vector3, sphereRadius: number, allowDuplicate?: boolean): SmartArray<T>;
  128355. /**
  128356. * Test if the octree intersect with the given ray and if yes, then add its content to resulting array
  128357. * @param ray defines the ray to test with
  128358. * @returns array of intersected objects
  128359. */
  128360. intersectsRay(ray: Ray): SmartArray<T>;
  128361. /**
  128362. * Adds a mesh into the octree block if it intersects the block
  128363. */
  128364. static CreationFuncForMeshes: (entry: AbstractMesh, block: OctreeBlock<AbstractMesh>) => void;
  128365. /**
  128366. * Adds a submesh into the octree block if it intersects the block
  128367. */
  128368. static CreationFuncForSubMeshes: (entry: SubMesh, block: OctreeBlock<SubMesh>) => void;
  128369. }
  128370. }
  128371. declare module BABYLON {
  128372. interface Scene {
  128373. /**
  128374. * @hidden
  128375. * Backing Filed
  128376. */
  128377. _selectionOctree: Octree<AbstractMesh>;
  128378. /**
  128379. * Gets the octree used to boost mesh selection (picking)
  128380. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  128381. */
  128382. selectionOctree: Octree<AbstractMesh>;
  128383. /**
  128384. * Creates or updates the octree used to boost selection (picking)
  128385. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  128386. * @param maxCapacity defines the maximum capacity per leaf
  128387. * @param maxDepth defines the maximum depth of the octree
  128388. * @returns an octree of AbstractMesh
  128389. */
  128390. createOrUpdateSelectionOctree(maxCapacity?: number, maxDepth?: number): Octree<AbstractMesh>;
  128391. }
  128392. interface AbstractMesh {
  128393. /**
  128394. * @hidden
  128395. * Backing Field
  128396. */
  128397. _submeshesOctree: Octree<SubMesh>;
  128398. /**
  128399. * This function will create an octree to help to select the right submeshes for rendering, picking and collision computations.
  128400. * Please note that you must have a decent number of submeshes to get performance improvements when using an octree
  128401. * @param maxCapacity defines the maximum size of each block (64 by default)
  128402. * @param maxDepth defines the maximum depth to use (no more than 2 levels by default)
  128403. * @returns the new octree
  128404. * @see https://www.babylonjs-playground.com/#NA4OQ#12
  128405. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  128406. */
  128407. createOrUpdateSubmeshesOctree(maxCapacity?: number, maxDepth?: number): Octree<SubMesh>;
  128408. }
  128409. /**
  128410. * Defines the octree scene component responsible to manage any octrees
  128411. * in a given scene.
  128412. */
  128413. export class OctreeSceneComponent {
  128414. /**
  128415. * The component name help to identify the component in the list of scene components.
  128416. */
  128417. readonly name: string;
  128418. /**
  128419. * The scene the component belongs to.
  128420. */
  128421. scene: Scene;
  128422. /**
  128423. * Indicates if the meshes have been checked to make sure they are isEnabled()
  128424. */
  128425. readonly checksIsEnabled: boolean;
  128426. /**
  128427. * Creates a new instance of the component for the given scene
  128428. * @param scene Defines the scene to register the component in
  128429. */
  128430. constructor(scene: Scene);
  128431. /**
  128432. * Registers the component in a given scene
  128433. */
  128434. register(): void;
  128435. /**
  128436. * Return the list of active meshes
  128437. * @returns the list of active meshes
  128438. */
  128439. getActiveMeshCandidates(): ISmartArrayLike<AbstractMesh>;
  128440. /**
  128441. * Return the list of active sub meshes
  128442. * @param mesh The mesh to get the candidates sub meshes from
  128443. * @returns the list of active sub meshes
  128444. */
  128445. getActiveSubMeshCandidates(mesh: AbstractMesh): ISmartArrayLike<SubMesh>;
  128446. private _tempRay;
  128447. /**
  128448. * Return the list of sub meshes intersecting with a given local ray
  128449. * @param mesh defines the mesh to find the submesh for
  128450. * @param localRay defines the ray in local space
  128451. * @returns the list of intersecting sub meshes
  128452. */
  128453. getIntersectingSubMeshCandidates(mesh: AbstractMesh, localRay: Ray): ISmartArrayLike<SubMesh>;
  128454. /**
  128455. * Return the list of sub meshes colliding with a collider
  128456. * @param mesh defines the mesh to find the submesh for
  128457. * @param collider defines the collider to evaluate the collision against
  128458. * @returns the list of colliding sub meshes
  128459. */
  128460. getCollidingSubMeshCandidates(mesh: AbstractMesh, collider: Collider): ISmartArrayLike<SubMesh>;
  128461. /**
  128462. * Rebuilds the elements related to this component in case of
  128463. * context lost for instance.
  128464. */
  128465. rebuild(): void;
  128466. /**
  128467. * Disposes the component and the associated ressources.
  128468. */
  128469. dispose(): void;
  128470. }
  128471. }
  128472. declare module BABYLON {
  128473. /**
  128474. * Renders gizmos on top of an existing scene which provide controls for position, rotation, etc.
  128475. */
  128476. export class Gizmo implements IDisposable {
  128477. /** The utility layer the gizmo will be added to */
  128478. gizmoLayer: UtilityLayerRenderer;
  128479. /**
  128480. * The root mesh of the gizmo
  128481. */
  128482. _rootMesh: Mesh;
  128483. private _attachedMesh;
  128484. private _attachedNode;
  128485. /**
  128486. * Ratio for the scale of the gizmo (Default: 1)
  128487. */
  128488. scaleRatio: number;
  128489. /**
  128490. * If a custom mesh has been set (Default: false)
  128491. */
  128492. protected _customMeshSet: boolean;
  128493. /**
  128494. * Mesh that the gizmo will be attached to. (eg. on a drag gizmo the mesh that will be dragged)
  128495. * * When set, interactions will be enabled
  128496. */
  128497. get attachedMesh(): Nullable<AbstractMesh>;
  128498. set attachedMesh(value: Nullable<AbstractMesh>);
  128499. /**
  128500. * Node that the gizmo will be attached to. (eg. on a drag gizmo the mesh, bone or NodeTransform that will be dragged)
  128501. * * When set, interactions will be enabled
  128502. */
  128503. get attachedNode(): Nullable<Node>;
  128504. set attachedNode(value: Nullable<Node>);
  128505. /**
  128506. * Disposes and replaces the current meshes in the gizmo with the specified mesh
  128507. * @param mesh The mesh to replace the default mesh of the gizmo
  128508. */
  128509. setCustomMesh(mesh: Mesh): void;
  128510. /**
  128511. * If set the gizmo's rotation will be updated to match the attached mesh each frame (Default: true)
  128512. */
  128513. updateGizmoRotationToMatchAttachedMesh: boolean;
  128514. /**
  128515. * If set the gizmo's position will be updated to match the attached mesh each frame (Default: true)
  128516. */
  128517. updateGizmoPositionToMatchAttachedMesh: boolean;
  128518. /**
  128519. * When set, the gizmo will always appear the same size no matter where the camera is (default: true)
  128520. */
  128521. updateScale: boolean;
  128522. protected _interactionsEnabled: boolean;
  128523. protected _attachedNodeChanged(value: Nullable<Node>): void;
  128524. private _beforeRenderObserver;
  128525. private _tempVector;
  128526. /**
  128527. * Creates a gizmo
  128528. * @param gizmoLayer The utility layer the gizmo will be added to
  128529. */
  128530. constructor(
  128531. /** The utility layer the gizmo will be added to */
  128532. gizmoLayer?: UtilityLayerRenderer);
  128533. /**
  128534. * Updates the gizmo to match the attached mesh's position/rotation
  128535. */
  128536. protected _update(): void;
  128537. /**
  128538. * computes the rotation/scaling/position of the transform once the Node world matrix has changed.
  128539. * @param value Node, TransformNode or mesh
  128540. */
  128541. protected _matrixChanged(): void;
  128542. /**
  128543. * Disposes of the gizmo
  128544. */
  128545. dispose(): void;
  128546. }
  128547. }
  128548. declare module BABYLON {
  128549. /**
  128550. * Single plane drag gizmo
  128551. */
  128552. export class PlaneDragGizmo extends Gizmo {
  128553. /**
  128554. * Drag behavior responsible for the gizmos dragging interactions
  128555. */
  128556. dragBehavior: PointerDragBehavior;
  128557. private _pointerObserver;
  128558. /**
  128559. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  128560. */
  128561. snapDistance: number;
  128562. /**
  128563. * Event that fires each time the gizmo snaps to a new location.
  128564. * * snapDistance is the the change in distance
  128565. */
  128566. onSnapObservable: Observable<{
  128567. snapDistance: number;
  128568. }>;
  128569. private _plane;
  128570. private _coloredMaterial;
  128571. private _hoverMaterial;
  128572. private _isEnabled;
  128573. private _parent;
  128574. /** @hidden */
  128575. static _CreatePlane(scene: Scene, material: StandardMaterial): TransformNode;
  128576. /** @hidden */
  128577. static _CreateArrowInstance(scene: Scene, arrow: TransformNode): TransformNode;
  128578. /**
  128579. * Creates a PlaneDragGizmo
  128580. * @param gizmoLayer The utility layer the gizmo will be added to
  128581. * @param dragPlaneNormal The axis normal to which the gizmo will be able to drag on
  128582. * @param color The color of the gizmo
  128583. */
  128584. constructor(dragPlaneNormal: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<PositionGizmo>);
  128585. protected _attachedNodeChanged(value: Nullable<Node>): void;
  128586. /**
  128587. * If the gizmo is enabled
  128588. */
  128589. set isEnabled(value: boolean);
  128590. get isEnabled(): boolean;
  128591. /**
  128592. * Disposes of the gizmo
  128593. */
  128594. dispose(): void;
  128595. }
  128596. }
  128597. declare module BABYLON {
  128598. /**
  128599. * Gizmo that enables dragging a mesh along 3 axis
  128600. */
  128601. export class PositionGizmo extends Gizmo {
  128602. /**
  128603. * Internal gizmo used for interactions on the x axis
  128604. */
  128605. xGizmo: AxisDragGizmo;
  128606. /**
  128607. * Internal gizmo used for interactions on the y axis
  128608. */
  128609. yGizmo: AxisDragGizmo;
  128610. /**
  128611. * Internal gizmo used for interactions on the z axis
  128612. */
  128613. zGizmo: AxisDragGizmo;
  128614. /**
  128615. * Internal gizmo used for interactions on the yz plane
  128616. */
  128617. xPlaneGizmo: PlaneDragGizmo;
  128618. /**
  128619. * Internal gizmo used for interactions on the xz plane
  128620. */
  128621. yPlaneGizmo: PlaneDragGizmo;
  128622. /**
  128623. * Internal gizmo used for interactions on the xy plane
  128624. */
  128625. zPlaneGizmo: PlaneDragGizmo;
  128626. /**
  128627. * private variables
  128628. */
  128629. private _meshAttached;
  128630. private _nodeAttached;
  128631. private _updateGizmoRotationToMatchAttachedMesh;
  128632. private _snapDistance;
  128633. private _scaleRatio;
  128634. /** Fires an event when any of it's sub gizmos are dragged */
  128635. onDragStartObservable: Observable<unknown>;
  128636. /** Fires an event when any of it's sub gizmos are released from dragging */
  128637. onDragEndObservable: Observable<unknown>;
  128638. /**
  128639. * If set to true, planar drag is enabled
  128640. */
  128641. private _planarGizmoEnabled;
  128642. get attachedMesh(): Nullable<AbstractMesh>;
  128643. set attachedMesh(mesh: Nullable<AbstractMesh>);
  128644. get attachedNode(): Nullable<Node>;
  128645. set attachedNode(node: Nullable<Node>);
  128646. /**
  128647. * Creates a PositionGizmo
  128648. * @param gizmoLayer The utility layer the gizmo will be added to
  128649. @param thickness display gizmo axis thickness
  128650. */
  128651. constructor(gizmoLayer?: UtilityLayerRenderer, thickness?: number);
  128652. /**
  128653. * If the planar drag gizmo is enabled
  128654. * setting this will enable/disable XY, XZ and YZ planes regardless of individual gizmo settings.
  128655. */
  128656. set planarGizmoEnabled(value: boolean);
  128657. get planarGizmoEnabled(): boolean;
  128658. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  128659. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  128660. /**
  128661. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  128662. */
  128663. set snapDistance(value: number);
  128664. get snapDistance(): number;
  128665. /**
  128666. * Ratio for the scale of the gizmo (Default: 1)
  128667. */
  128668. set scaleRatio(value: number);
  128669. get scaleRatio(): number;
  128670. /**
  128671. * Disposes of the gizmo
  128672. */
  128673. dispose(): void;
  128674. /**
  128675. * CustomMeshes are not supported by this gizmo
  128676. * @param mesh The mesh to replace the default mesh of the gizmo
  128677. */
  128678. setCustomMesh(mesh: Mesh): void;
  128679. }
  128680. }
  128681. declare module BABYLON {
  128682. /**
  128683. * Single axis drag gizmo
  128684. */
  128685. export class AxisDragGizmo extends Gizmo {
  128686. /**
  128687. * Drag behavior responsible for the gizmos dragging interactions
  128688. */
  128689. dragBehavior: PointerDragBehavior;
  128690. private _pointerObserver;
  128691. /**
  128692. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  128693. */
  128694. snapDistance: number;
  128695. /**
  128696. * Event that fires each time the gizmo snaps to a new location.
  128697. * * snapDistance is the the change in distance
  128698. */
  128699. onSnapObservable: Observable<{
  128700. snapDistance: number;
  128701. }>;
  128702. private _isEnabled;
  128703. private _parent;
  128704. private _arrow;
  128705. private _coloredMaterial;
  128706. private _hoverMaterial;
  128707. /** @hidden */
  128708. static _CreateArrow(scene: Scene, material: StandardMaterial, thickness?: number): TransformNode;
  128709. /** @hidden */
  128710. static _CreateArrowInstance(scene: Scene, arrow: TransformNode): TransformNode;
  128711. /**
  128712. * Creates an AxisDragGizmo
  128713. * @param gizmoLayer The utility layer the gizmo will be added to
  128714. * @param dragAxis The axis which the gizmo will be able to drag on
  128715. * @param color The color of the gizmo
  128716. * @param thickness display gizmo axis thickness
  128717. */
  128718. constructor(dragAxis: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<PositionGizmo>, thickness?: number);
  128719. protected _attachedNodeChanged(value: Nullable<Node>): void;
  128720. /**
  128721. * If the gizmo is enabled
  128722. */
  128723. set isEnabled(value: boolean);
  128724. get isEnabled(): boolean;
  128725. /**
  128726. * Disposes of the gizmo
  128727. */
  128728. dispose(): void;
  128729. }
  128730. }
  128731. declare module BABYLON.Debug {
  128732. /**
  128733. * The Axes viewer will show 3 axes in a specific point in space
  128734. */
  128735. export class AxesViewer {
  128736. private _xAxis;
  128737. private _yAxis;
  128738. private _zAxis;
  128739. private _scaleLinesFactor;
  128740. private _instanced;
  128741. /**
  128742. * Gets the hosting scene
  128743. */
  128744. scene: Scene;
  128745. /**
  128746. * Gets or sets a number used to scale line length
  128747. */
  128748. scaleLines: number;
  128749. /** Gets the node hierarchy used to render x-axis */
  128750. get xAxis(): TransformNode;
  128751. /** Gets the node hierarchy used to render y-axis */
  128752. get yAxis(): TransformNode;
  128753. /** Gets the node hierarchy used to render z-axis */
  128754. get zAxis(): TransformNode;
  128755. /**
  128756. * Creates a new AxesViewer
  128757. * @param scene defines the hosting scene
  128758. * @param scaleLines defines a number used to scale line length (1 by default)
  128759. * @param renderingGroupId defines a number used to set the renderingGroupId of the meshes (2 by default)
  128760. * @param xAxis defines the node hierarchy used to render the x-axis
  128761. * @param yAxis defines the node hierarchy used to render the y-axis
  128762. * @param zAxis defines the node hierarchy used to render the z-axis
  128763. */
  128764. constructor(scene: Scene, scaleLines?: number, renderingGroupId?: Nullable<number>, xAxis?: TransformNode, yAxis?: TransformNode, zAxis?: TransformNode);
  128765. /**
  128766. * Force the viewer to update
  128767. * @param position defines the position of the viewer
  128768. * @param xaxis defines the x axis of the viewer
  128769. * @param yaxis defines the y axis of the viewer
  128770. * @param zaxis defines the z axis of the viewer
  128771. */
  128772. update(position: Vector3, xaxis: Vector3, yaxis: Vector3, zaxis: Vector3): void;
  128773. /**
  128774. * Creates an instance of this axes viewer.
  128775. * @returns a new axes viewer with instanced meshes
  128776. */
  128777. createInstance(): AxesViewer;
  128778. /** Releases resources */
  128779. dispose(): void;
  128780. private static _SetRenderingGroupId;
  128781. }
  128782. }
  128783. declare module BABYLON.Debug {
  128784. /**
  128785. * The BoneAxesViewer will attach 3 axes to a specific bone of a specific mesh
  128786. * @see demo here: https://www.babylonjs-playground.com/#0DE8F4#8
  128787. */
  128788. export class BoneAxesViewer extends AxesViewer {
  128789. /**
  128790. * Gets or sets the target mesh where to display the axes viewer
  128791. */
  128792. mesh: Nullable<Mesh>;
  128793. /**
  128794. * Gets or sets the target bone where to display the axes viewer
  128795. */
  128796. bone: Nullable<Bone>;
  128797. /** Gets current position */
  128798. pos: Vector3;
  128799. /** Gets direction of X axis */
  128800. xaxis: Vector3;
  128801. /** Gets direction of Y axis */
  128802. yaxis: Vector3;
  128803. /** Gets direction of Z axis */
  128804. zaxis: Vector3;
  128805. /**
  128806. * Creates a new BoneAxesViewer
  128807. * @param scene defines the hosting scene
  128808. * @param bone defines the target bone
  128809. * @param mesh defines the target mesh
  128810. * @param scaleLines defines a scaling factor for line length (1 by default)
  128811. */
  128812. constructor(scene: Scene, bone: Bone, mesh: Mesh, scaleLines?: number);
  128813. /**
  128814. * Force the viewer to update
  128815. */
  128816. update(): void;
  128817. /** Releases resources */
  128818. dispose(): void;
  128819. }
  128820. }
  128821. declare module BABYLON {
  128822. /**
  128823. * Interface used to define scene explorer extensibility option
  128824. */
  128825. export interface IExplorerExtensibilityOption {
  128826. /**
  128827. * Define the option label
  128828. */
  128829. label: string;
  128830. /**
  128831. * Defines the action to execute on click
  128832. */
  128833. action: (entity: any) => void;
  128834. }
  128835. /**
  128836. * Defines a group of actions associated with a predicate to use when extending the Inspector scene explorer
  128837. */
  128838. export interface IExplorerExtensibilityGroup {
  128839. /**
  128840. * Defines a predicate to test if a given type mut be extended
  128841. */
  128842. predicate: (entity: any) => boolean;
  128843. /**
  128844. * Gets the list of options added to a type
  128845. */
  128846. entries: IExplorerExtensibilityOption[];
  128847. }
  128848. /**
  128849. * Interface used to define the options to use to create the Inspector
  128850. */
  128851. export interface IInspectorOptions {
  128852. /**
  128853. * Display in overlay mode (default: false)
  128854. */
  128855. overlay?: boolean;
  128856. /**
  128857. * HTML element to use as root (the parent of the rendering canvas will be used as default value)
  128858. */
  128859. globalRoot?: HTMLElement;
  128860. /**
  128861. * Display the Scene explorer
  128862. */
  128863. showExplorer?: boolean;
  128864. /**
  128865. * Display the property inspector
  128866. */
  128867. showInspector?: boolean;
  128868. /**
  128869. * Display in embed mode (both panes on the right)
  128870. */
  128871. embedMode?: boolean;
  128872. /**
  128873. * let the Inspector handles resize of the canvas when panes are resized (default to true)
  128874. */
  128875. handleResize?: boolean;
  128876. /**
  128877. * Allow the panes to popup (default: true)
  128878. */
  128879. enablePopup?: boolean;
  128880. /**
  128881. * Allow the panes to be closed by users (default: true)
  128882. */
  128883. enableClose?: boolean;
  128884. /**
  128885. * Optional list of extensibility entries
  128886. */
  128887. explorerExtensibility?: IExplorerExtensibilityGroup[];
  128888. /**
  128889. * Optional URL to get the inspector script from (by default it uses the babylonjs CDN).
  128890. */
  128891. inspectorURL?: string;
  128892. /**
  128893. * Optional initial tab (default to DebugLayerTab.Properties)
  128894. */
  128895. initialTab?: DebugLayerTab;
  128896. }
  128897. interface Scene {
  128898. /**
  128899. * @hidden
  128900. * Backing field
  128901. */
  128902. _debugLayer: DebugLayer;
  128903. /**
  128904. * Gets the debug layer (aka Inspector) associated with the scene
  128905. * @see https://doc.babylonjs.com/features/playground_debuglayer
  128906. */
  128907. debugLayer: DebugLayer;
  128908. }
  128909. /**
  128910. * Enum of inspector action tab
  128911. */
  128912. export enum DebugLayerTab {
  128913. /**
  128914. * Properties tag (default)
  128915. */
  128916. Properties = 0,
  128917. /**
  128918. * Debug tab
  128919. */
  128920. Debug = 1,
  128921. /**
  128922. * Statistics tab
  128923. */
  128924. Statistics = 2,
  128925. /**
  128926. * Tools tab
  128927. */
  128928. Tools = 3,
  128929. /**
  128930. * Settings tab
  128931. */
  128932. Settings = 4
  128933. }
  128934. /**
  128935. * The debug layer (aka Inspector) is the go to tool in order to better understand
  128936. * what is happening in your scene
  128937. * @see https://doc.babylonjs.com/features/playground_debuglayer
  128938. */
  128939. export class DebugLayer {
  128940. /**
  128941. * Define the url to get the inspector script from.
  128942. * By default it uses the babylonjs CDN.
  128943. * @ignoreNaming
  128944. */
  128945. static InspectorURL: string;
  128946. private _scene;
  128947. private BJSINSPECTOR;
  128948. private _onPropertyChangedObservable?;
  128949. /**
  128950. * Observable triggered when a property is changed through the inspector.
  128951. */
  128952. get onPropertyChangedObservable(): any;
  128953. /**
  128954. * Instantiates a new debug layer.
  128955. * The debug layer (aka Inspector) is the go to tool in order to better understand
  128956. * what is happening in your scene
  128957. * @see https://doc.babylonjs.com/features/playground_debuglayer
  128958. * @param scene Defines the scene to inspect
  128959. */
  128960. constructor(scene: Scene);
  128961. /** Creates the inspector window. */
  128962. private _createInspector;
  128963. /**
  128964. * Select a specific entity in the scene explorer and highlight a specific block in that entity property grid
  128965. * @param entity defines the entity to select
  128966. * @param lineContainerTitles defines the specific blocks to highlight (could be a string or an array of strings)
  128967. */
  128968. select(entity: any, lineContainerTitles?: string | string[]): void;
  128969. /** Get the inspector from bundle or global */
  128970. private _getGlobalInspector;
  128971. /**
  128972. * Get if the inspector is visible or not.
  128973. * @returns true if visible otherwise, false
  128974. */
  128975. isVisible(): boolean;
  128976. /**
  128977. * Hide the inspector and close its window.
  128978. */
  128979. hide(): void;
  128980. /**
  128981. * Update the scene in the inspector
  128982. */
  128983. setAsActiveScene(): void;
  128984. /**
  128985. * Launch the debugLayer.
  128986. * @param config Define the configuration of the inspector
  128987. * @return a promise fulfilled when the debug layer is visible
  128988. */
  128989. show(config?: IInspectorOptions): Promise<DebugLayer>;
  128990. }
  128991. }
  128992. declare module BABYLON {
  128993. /**
  128994. * Class containing static functions to help procedurally build meshes
  128995. */
  128996. export class BoxBuilder {
  128997. /**
  128998. * Creates a box mesh
  128999. * * The parameter `size` sets the size (float) of each box side (default 1)
  129000. * * You can set some different box dimensions by using the parameters `width`, `height` and `depth` (all by default have the same value of `size`)
  129001. * * 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)
  129002. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  129003. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  129004. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  129005. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  129006. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  129007. * @param name defines the name of the mesh
  129008. * @param options defines the options used to create the mesh
  129009. * @param scene defines the hosting scene
  129010. * @returns the box mesh
  129011. */
  129012. static CreateBox(name: string, options: {
  129013. size?: number;
  129014. width?: number;
  129015. height?: number;
  129016. depth?: number;
  129017. faceUV?: Vector4[];
  129018. faceColors?: Color4[];
  129019. sideOrientation?: number;
  129020. frontUVs?: Vector4;
  129021. backUVs?: Vector4;
  129022. wrap?: boolean;
  129023. topBaseAt?: number;
  129024. bottomBaseAt?: number;
  129025. updatable?: boolean;
  129026. }, scene?: Nullable<Scene>): Mesh;
  129027. }
  129028. }
  129029. declare module BABYLON.Debug {
  129030. /**
  129031. * Used to show the physics impostor around the specific mesh
  129032. */
  129033. export class PhysicsViewer {
  129034. /** @hidden */
  129035. protected _impostors: Array<Nullable<PhysicsImpostor>>;
  129036. /** @hidden */
  129037. protected _meshes: Array<Nullable<AbstractMesh>>;
  129038. /** @hidden */
  129039. protected _scene: Nullable<Scene>;
  129040. /** @hidden */
  129041. protected _numMeshes: number;
  129042. /** @hidden */
  129043. protected _physicsEnginePlugin: Nullable<IPhysicsEnginePlugin>;
  129044. private _renderFunction;
  129045. private _utilityLayer;
  129046. private _debugBoxMesh;
  129047. private _debugSphereMesh;
  129048. private _debugCylinderMesh;
  129049. private _debugMaterial;
  129050. private _debugMeshMeshes;
  129051. /**
  129052. * Creates a new PhysicsViewer
  129053. * @param scene defines the hosting scene
  129054. */
  129055. constructor(scene: Scene);
  129056. /** @hidden */
  129057. protected _updateDebugMeshes(): void;
  129058. /**
  129059. * Renders a specified physic impostor
  129060. * @param impostor defines the impostor to render
  129061. * @param targetMesh defines the mesh represented by the impostor
  129062. * @returns the new debug mesh used to render the impostor
  129063. */
  129064. showImpostor(impostor: PhysicsImpostor, targetMesh?: Mesh): Nullable<AbstractMesh>;
  129065. /**
  129066. * Hides a specified physic impostor
  129067. * @param impostor defines the impostor to hide
  129068. */
  129069. hideImpostor(impostor: Nullable<PhysicsImpostor>): void;
  129070. private _getDebugMaterial;
  129071. private _getDebugBoxMesh;
  129072. private _getDebugSphereMesh;
  129073. private _getDebugCylinderMesh;
  129074. private _getDebugMeshMesh;
  129075. private _getDebugMesh;
  129076. /** Releases all resources */
  129077. dispose(): void;
  129078. }
  129079. }
  129080. declare module BABYLON {
  129081. /**
  129082. * As raycast might be hard to debug, the RayHelper can help rendering the different rays
  129083. * in order to better appreciate the issue one might have.
  129084. * @see https://doc.babylonjs.com/babylon101/raycasts#debugging
  129085. */
  129086. export class RayHelper {
  129087. /**
  129088. * Defines the ray we are currently tryin to visualize.
  129089. */
  129090. ray: Nullable<Ray>;
  129091. private _renderPoints;
  129092. private _renderLine;
  129093. private _renderFunction;
  129094. private _scene;
  129095. private _updateToMeshFunction;
  129096. private _attachedToMesh;
  129097. private _meshSpaceDirection;
  129098. private _meshSpaceOrigin;
  129099. /**
  129100. * Helper function to create a colored helper in a scene in one line.
  129101. * @param ray Defines the ray we are currently tryin to visualize
  129102. * @param scene Defines the scene the ray is used in
  129103. * @param color Defines the color we want to see the ray in
  129104. * @returns The newly created ray helper.
  129105. */
  129106. static CreateAndShow(ray: Ray, scene: Scene, color: Color3): RayHelper;
  129107. /**
  129108. * Instantiate a new ray helper.
  129109. * As raycast might be hard to debug, the RayHelper can help rendering the different rays
  129110. * in order to better appreciate the issue one might have.
  129111. * @see https://doc.babylonjs.com/babylon101/raycasts#debugging
  129112. * @param ray Defines the ray we are currently tryin to visualize
  129113. */
  129114. constructor(ray: Ray);
  129115. /**
  129116. * Shows the ray we are willing to debug.
  129117. * @param scene Defines the scene the ray needs to be rendered in
  129118. * @param color Defines the color the ray needs to be rendered in
  129119. */
  129120. show(scene: Scene, color?: Color3): void;
  129121. /**
  129122. * Hides the ray we are debugging.
  129123. */
  129124. hide(): void;
  129125. private _render;
  129126. /**
  129127. * Attach a ray helper to a mesh so that we can easily see its orientation for instance or information like its normals.
  129128. * @param mesh Defines the mesh we want the helper attached to
  129129. * @param meshSpaceDirection Defines the direction of the Ray in mesh space (local space of the mesh node)
  129130. * @param meshSpaceOrigin Defines the origin of the Ray in mesh space (local space of the mesh node)
  129131. * @param length Defines the length of the ray
  129132. */
  129133. attachToMesh(mesh: AbstractMesh, meshSpaceDirection?: Vector3, meshSpaceOrigin?: Vector3, length?: number): void;
  129134. /**
  129135. * Detach the ray helper from the mesh it has previously been attached to.
  129136. */
  129137. detachFromMesh(): void;
  129138. private _updateToMesh;
  129139. /**
  129140. * Dispose the helper and release its associated resources.
  129141. */
  129142. dispose(): void;
  129143. }
  129144. }
  129145. declare module BABYLON.Debug {
  129146. /**
  129147. * Class used to render a debug view of a given skeleton
  129148. * @see http://www.babylonjs-playground.com/#1BZJVJ#8
  129149. */
  129150. export class SkeletonViewer {
  129151. /** defines the skeleton to render */
  129152. skeleton: Skeleton;
  129153. /** defines the mesh attached to the skeleton */
  129154. mesh: AbstractMesh;
  129155. /** defines a boolean indicating if bones matrices must be forced to update before rendering (true by default) */
  129156. autoUpdateBonesMatrices: boolean;
  129157. /** defines the rendering group id to use with the viewer */
  129158. renderingGroupId: number;
  129159. /** Gets or sets the color used to render the skeleton */
  129160. color: Color3;
  129161. private _scene;
  129162. private _debugLines;
  129163. private _debugMesh;
  129164. private _isEnabled;
  129165. private _renderFunction;
  129166. private _utilityLayer;
  129167. /**
  129168. * Returns the mesh used to render the bones
  129169. */
  129170. get debugMesh(): Nullable<LinesMesh>;
  129171. /**
  129172. * Creates a new SkeletonViewer
  129173. * @param skeleton defines the skeleton to render
  129174. * @param mesh defines the mesh attached to the skeleton
  129175. * @param scene defines the hosting scene
  129176. * @param autoUpdateBonesMatrices defines a boolean indicating if bones matrices must be forced to update before rendering (true by default)
  129177. * @param renderingGroupId defines the rendering group id to use with the viewer
  129178. */
  129179. constructor(
  129180. /** defines the skeleton to render */
  129181. skeleton: Skeleton,
  129182. /** defines the mesh attached to the skeleton */
  129183. mesh: AbstractMesh, scene: Scene,
  129184. /** defines a boolean indicating if bones matrices must be forced to update before rendering (true by default) */
  129185. autoUpdateBonesMatrices?: boolean,
  129186. /** defines the rendering group id to use with the viewer */
  129187. renderingGroupId?: number);
  129188. /** Gets or sets a boolean indicating if the viewer is enabled */
  129189. set isEnabled(value: boolean);
  129190. get isEnabled(): boolean;
  129191. private _getBonePosition;
  129192. private _getLinesForBonesWithLength;
  129193. private _getLinesForBonesNoLength;
  129194. /** Update the viewer to sync with current skeleton state */
  129195. update(): void;
  129196. /** Release associated resources */
  129197. dispose(): void;
  129198. }
  129199. }
  129200. declare module BABYLON {
  129201. /**
  129202. * Enum for Device Types
  129203. */
  129204. export enum DeviceType {
  129205. /** Generic */
  129206. Generic = 0,
  129207. /** Keyboard */
  129208. Keyboard = 1,
  129209. /** Mouse */
  129210. Mouse = 2,
  129211. /** Touch Pointers */
  129212. Touch = 3,
  129213. /** PS4 Dual Shock */
  129214. DualShock = 4,
  129215. /** Xbox */
  129216. Xbox = 5,
  129217. /** Switch Controller */
  129218. Switch = 6
  129219. }
  129220. /**
  129221. * Enum for All Pointers (Touch/Mouse)
  129222. */
  129223. export enum PointerInput {
  129224. /** Horizontal Axis */
  129225. Horizontal = 0,
  129226. /** Vertical Axis */
  129227. Vertical = 1,
  129228. /** Left Click or Touch */
  129229. LeftClick = 2,
  129230. /** Middle Click */
  129231. MiddleClick = 3,
  129232. /** Right Click */
  129233. RightClick = 4,
  129234. /** Browser Back */
  129235. BrowserBack = 5,
  129236. /** Browser Forward */
  129237. BrowserForward = 6
  129238. }
  129239. /**
  129240. * Enum for Dual Shock Gamepad
  129241. */
  129242. export enum DualShockInput {
  129243. /** Cross */
  129244. Cross = 0,
  129245. /** Circle */
  129246. Circle = 1,
  129247. /** Square */
  129248. Square = 2,
  129249. /** Triangle */
  129250. Triangle = 3,
  129251. /** L1 */
  129252. L1 = 4,
  129253. /** R1 */
  129254. R1 = 5,
  129255. /** L2 */
  129256. L2 = 6,
  129257. /** R2 */
  129258. R2 = 7,
  129259. /** Share */
  129260. Share = 8,
  129261. /** Options */
  129262. Options = 9,
  129263. /** L3 */
  129264. L3 = 10,
  129265. /** R3 */
  129266. R3 = 11,
  129267. /** DPadUp */
  129268. DPadUp = 12,
  129269. /** DPadDown */
  129270. DPadDown = 13,
  129271. /** DPadLeft */
  129272. DPadLeft = 14,
  129273. /** DRight */
  129274. DPadRight = 15,
  129275. /** Home */
  129276. Home = 16,
  129277. /** TouchPad */
  129278. TouchPad = 17,
  129279. /** LStickXAxis */
  129280. LStickXAxis = 18,
  129281. /** LStickYAxis */
  129282. LStickYAxis = 19,
  129283. /** RStickXAxis */
  129284. RStickXAxis = 20,
  129285. /** RStickYAxis */
  129286. RStickYAxis = 21
  129287. }
  129288. /**
  129289. * Enum for Xbox Gamepad
  129290. */
  129291. export enum XboxInput {
  129292. /** A */
  129293. A = 0,
  129294. /** B */
  129295. B = 1,
  129296. /** X */
  129297. X = 2,
  129298. /** Y */
  129299. Y = 3,
  129300. /** LB */
  129301. LB = 4,
  129302. /** RB */
  129303. RB = 5,
  129304. /** LT */
  129305. LT = 6,
  129306. /** RT */
  129307. RT = 7,
  129308. /** Back */
  129309. Back = 8,
  129310. /** Start */
  129311. Start = 9,
  129312. /** LS */
  129313. LS = 10,
  129314. /** RS */
  129315. RS = 11,
  129316. /** DPadUp */
  129317. DPadUp = 12,
  129318. /** DPadDown */
  129319. DPadDown = 13,
  129320. /** DPadLeft */
  129321. DPadLeft = 14,
  129322. /** DRight */
  129323. DPadRight = 15,
  129324. /** Home */
  129325. Home = 16,
  129326. /** LStickXAxis */
  129327. LStickXAxis = 17,
  129328. /** LStickYAxis */
  129329. LStickYAxis = 18,
  129330. /** RStickXAxis */
  129331. RStickXAxis = 19,
  129332. /** RStickYAxis */
  129333. RStickYAxis = 20
  129334. }
  129335. /**
  129336. * Enum for Switch (Pro/JoyCon L+R) Gamepad
  129337. */
  129338. export enum SwitchInput {
  129339. /** B */
  129340. B = 0,
  129341. /** A */
  129342. A = 1,
  129343. /** Y */
  129344. Y = 2,
  129345. /** X */
  129346. X = 3,
  129347. /** L */
  129348. L = 4,
  129349. /** R */
  129350. R = 5,
  129351. /** ZL */
  129352. ZL = 6,
  129353. /** ZR */
  129354. ZR = 7,
  129355. /** Minus */
  129356. Minus = 8,
  129357. /** Plus */
  129358. Plus = 9,
  129359. /** LS */
  129360. LS = 10,
  129361. /** RS */
  129362. RS = 11,
  129363. /** DPadUp */
  129364. DPadUp = 12,
  129365. /** DPadDown */
  129366. DPadDown = 13,
  129367. /** DPadLeft */
  129368. DPadLeft = 14,
  129369. /** DRight */
  129370. DPadRight = 15,
  129371. /** Home */
  129372. Home = 16,
  129373. /** Capture */
  129374. Capture = 17,
  129375. /** LStickXAxis */
  129376. LStickXAxis = 18,
  129377. /** LStickYAxis */
  129378. LStickYAxis = 19,
  129379. /** RStickXAxis */
  129380. RStickXAxis = 20,
  129381. /** RStickYAxis */
  129382. RStickYAxis = 21
  129383. }
  129384. }
  129385. declare module BABYLON {
  129386. /**
  129387. * This class will take all inputs from Keyboard, Pointer, and
  129388. * any Gamepads and provide a polling system that all devices
  129389. * will use. This class assumes that there will only be one
  129390. * pointer device and one keyboard.
  129391. */
  129392. export class DeviceInputSystem implements IDisposable {
  129393. /**
  129394. * Callback to be triggered when a device is connected
  129395. */
  129396. onDeviceConnected: (deviceType: DeviceType, deviceSlot: number) => void;
  129397. /**
  129398. * Callback to be triggered when a device is disconnected
  129399. */
  129400. onDeviceDisconnected: (deviceType: DeviceType, deviceSlot: number) => void;
  129401. /**
  129402. * Callback to be triggered when event driven input is updated
  129403. */
  129404. onInputChanged: (deviceType: DeviceType, deviceSlot: number, inputIndex: number, previousState: Nullable<number>, currentState: Nullable<number>) => void;
  129405. private _inputs;
  129406. private _gamepads;
  129407. private _keyboardActive;
  129408. private _pointerActive;
  129409. private _elementToAttachTo;
  129410. private _keyboardDownEvent;
  129411. private _keyboardUpEvent;
  129412. private _pointerMoveEvent;
  129413. private _pointerDownEvent;
  129414. private _pointerUpEvent;
  129415. private _gamepadConnectedEvent;
  129416. private _gamepadDisconnectedEvent;
  129417. private static _MAX_KEYCODES;
  129418. private static _MAX_POINTER_INPUTS;
  129419. private constructor();
  129420. /**
  129421. * Creates a new DeviceInputSystem instance
  129422. * @param engine Engine to pull input element from
  129423. * @returns The new instance
  129424. */
  129425. static Create(engine: Engine): DeviceInputSystem;
  129426. /**
  129427. * Checks for current device input value, given an id and input index
  129428. * @param deviceName Id of connected device
  129429. * @param inputIndex Index of device input
  129430. * @returns Current value of input
  129431. */
  129432. /**
  129433. * Checks for current device input value, given an id and input index
  129434. * @param deviceType Enum specifiying device type
  129435. * @param deviceSlot "Slot" or index that device is referenced in
  129436. * @param inputIndex Id of input to be checked
  129437. * @returns Current value of input
  129438. */
  129439. pollInput(deviceType: DeviceType, deviceSlot: number, inputIndex: number): Nullable<number>;
  129440. /**
  129441. * Dispose of all the eventlisteners
  129442. */
  129443. dispose(): void;
  129444. /**
  129445. * Add device and inputs to device array
  129446. * @param deviceType Enum specifiying device type
  129447. * @param deviceSlot "Slot" or index that device is referenced in
  129448. * @param numberOfInputs Number of input entries to create for given device
  129449. */
  129450. private _registerDevice;
  129451. /**
  129452. * Given a specific device name, remove that device from the device map
  129453. * @param deviceType Enum specifiying device type
  129454. * @param deviceSlot "Slot" or index that device is referenced in
  129455. */
  129456. private _unregisterDevice;
  129457. /**
  129458. * Handle all actions that come from keyboard interaction
  129459. */
  129460. private _handleKeyActions;
  129461. /**
  129462. * Handle all actions that come from pointer interaction
  129463. */
  129464. private _handlePointerActions;
  129465. /**
  129466. * Handle all actions that come from gamepad interaction
  129467. */
  129468. private _handleGamepadActions;
  129469. /**
  129470. * Update all non-event based devices with each frame
  129471. * @param deviceType Enum specifiying device type
  129472. * @param deviceSlot "Slot" or index that device is referenced in
  129473. * @param inputIndex Id of input to be checked
  129474. */
  129475. private _updateDevice;
  129476. /**
  129477. * Gets DeviceType from the device name
  129478. * @param deviceName Name of Device from DeviceInputSystem
  129479. * @returns DeviceType enum value
  129480. */
  129481. private _getGamepadDeviceType;
  129482. }
  129483. }
  129484. declare module BABYLON {
  129485. /**
  129486. * Type to handle enforcement of inputs
  129487. */
  129488. 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;
  129489. }
  129490. declare module BABYLON {
  129491. /**
  129492. * Class that handles all input for a specific device
  129493. */
  129494. export class DeviceSource<T extends DeviceType> {
  129495. /** Type of device */
  129496. readonly deviceType: DeviceType;
  129497. /** "Slot" or index that device is referenced in */
  129498. readonly deviceSlot: number;
  129499. /**
  129500. * Observable to handle device input changes per device
  129501. */
  129502. readonly onInputChangedObservable: Observable<{
  129503. inputIndex: DeviceInput<T>;
  129504. previousState: Nullable<number>;
  129505. currentState: Nullable<number>;
  129506. }>;
  129507. private readonly _deviceInputSystem;
  129508. /**
  129509. * Default Constructor
  129510. * @param deviceInputSystem Reference to DeviceInputSystem
  129511. * @param deviceType Type of device
  129512. * @param deviceSlot "Slot" or index that device is referenced in
  129513. */
  129514. constructor(deviceInputSystem: DeviceInputSystem,
  129515. /** Type of device */
  129516. deviceType: DeviceType,
  129517. /** "Slot" or index that device is referenced in */
  129518. deviceSlot?: number);
  129519. /**
  129520. * Get input for specific input
  129521. * @param inputIndex index of specific input on device
  129522. * @returns Input value from DeviceInputSystem
  129523. */
  129524. getInput(inputIndex: DeviceInput<T>): Nullable<number>;
  129525. }
  129526. /**
  129527. * Class to keep track of devices
  129528. */
  129529. export class DeviceSourceManager implements IDisposable {
  129530. /**
  129531. * Observable to be triggered when before a device is connected
  129532. */
  129533. readonly onBeforeDeviceConnectedObservable: Observable<{
  129534. deviceType: DeviceType;
  129535. deviceSlot: number;
  129536. }>;
  129537. /**
  129538. * Observable to be triggered when before a device is disconnected
  129539. */
  129540. readonly onBeforeDeviceDisconnectedObservable: Observable<{
  129541. deviceType: DeviceType;
  129542. deviceSlot: number;
  129543. }>;
  129544. /**
  129545. * Observable to be triggered when after a device is connected
  129546. */
  129547. readonly onAfterDeviceConnectedObservable: Observable<{
  129548. deviceType: DeviceType;
  129549. deviceSlot: number;
  129550. }>;
  129551. /**
  129552. * Observable to be triggered when after a device is disconnected
  129553. */
  129554. readonly onAfterDeviceDisconnectedObservable: Observable<{
  129555. deviceType: DeviceType;
  129556. deviceSlot: number;
  129557. }>;
  129558. private readonly _devices;
  129559. private readonly _firstDevice;
  129560. private readonly _deviceInputSystem;
  129561. /**
  129562. * Default Constructor
  129563. * @param engine engine to pull input element from
  129564. */
  129565. constructor(engine: Engine);
  129566. /**
  129567. * Gets a DeviceSource, given a type and slot
  129568. * @param deviceType Enum specifying device type
  129569. * @param deviceSlot "Slot" or index that device is referenced in
  129570. * @returns DeviceSource object
  129571. */
  129572. getDeviceSource<T extends DeviceType>(deviceType: T, deviceSlot?: number): Nullable<DeviceSource<T>>;
  129573. /**
  129574. * Gets an array of DeviceSource objects for a given device type
  129575. * @param deviceType Enum specifying device type
  129576. * @returns Array of DeviceSource objects
  129577. */
  129578. getDeviceSources<T extends DeviceType>(deviceType: T): ReadonlyArray<DeviceSource<T>>;
  129579. /**
  129580. * Dispose of DeviceInputSystem and other parts
  129581. */
  129582. dispose(): void;
  129583. /**
  129584. * Function to add device name to device list
  129585. * @param deviceType Enum specifying device type
  129586. * @param deviceSlot "Slot" or index that device is referenced in
  129587. */
  129588. private _addDevice;
  129589. /**
  129590. * Function to remove device name to device list
  129591. * @param deviceType Enum specifying device type
  129592. * @param deviceSlot "Slot" or index that device is referenced in
  129593. */
  129594. private _removeDevice;
  129595. /**
  129596. * Updates array storing first connected device of each type
  129597. * @param type Type of Device
  129598. */
  129599. private _updateFirstDevices;
  129600. }
  129601. }
  129602. declare module BABYLON {
  129603. /**
  129604. * Options to create the null engine
  129605. */
  129606. export class NullEngineOptions {
  129607. /**
  129608. * Render width (Default: 512)
  129609. */
  129610. renderWidth: number;
  129611. /**
  129612. * Render height (Default: 256)
  129613. */
  129614. renderHeight: number;
  129615. /**
  129616. * Texture size (Default: 512)
  129617. */
  129618. textureSize: number;
  129619. /**
  129620. * If delta time between frames should be constant
  129621. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  129622. */
  129623. deterministicLockstep: boolean;
  129624. /**
  129625. * Maximum about of steps between frames (Default: 4)
  129626. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  129627. */
  129628. lockstepMaxSteps: number;
  129629. /**
  129630. * Make the matrix computations to be performed in 64 bits instead of 32 bits. False by default
  129631. */
  129632. useHighPrecisionMatrix?: boolean;
  129633. }
  129634. /**
  129635. * The null engine class provides support for headless version of babylon.js.
  129636. * This can be used in server side scenario or for testing purposes
  129637. */
  129638. export class NullEngine extends Engine {
  129639. private _options;
  129640. /**
  129641. * Gets a boolean indicating that the engine is running in deterministic lock step mode
  129642. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  129643. * @returns true if engine is in deterministic lock step mode
  129644. */
  129645. isDeterministicLockStep(): boolean;
  129646. /**
  129647. * Gets the max steps when engine is running in deterministic lock step
  129648. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  129649. * @returns the max steps
  129650. */
  129651. getLockstepMaxSteps(): number;
  129652. /**
  129653. * Gets the current hardware scaling level.
  129654. * By default the hardware scaling level is computed from the window device ratio.
  129655. * 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.
  129656. * @returns a number indicating the current hardware scaling level
  129657. */
  129658. getHardwareScalingLevel(): number;
  129659. constructor(options?: NullEngineOptions);
  129660. /**
  129661. * Creates a vertex buffer
  129662. * @param vertices the data for the vertex buffer
  129663. * @returns the new WebGL static buffer
  129664. */
  129665. createVertexBuffer(vertices: FloatArray): DataBuffer;
  129666. /**
  129667. * Creates a new index buffer
  129668. * @param indices defines the content of the index buffer
  129669. * @param updatable defines if the index buffer must be updatable
  129670. * @returns a new webGL buffer
  129671. */
  129672. createIndexBuffer(indices: IndicesArray): DataBuffer;
  129673. /**
  129674. * Clear the current render buffer or the current render target (if any is set up)
  129675. * @param color defines the color to use
  129676. * @param backBuffer defines if the back buffer must be cleared
  129677. * @param depth defines if the depth buffer must be cleared
  129678. * @param stencil defines if the stencil buffer must be cleared
  129679. */
  129680. clear(color: IColor4Like, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  129681. /**
  129682. * Gets the current render width
  129683. * @param useScreen defines if screen size must be used (or the current render target if any)
  129684. * @returns a number defining the current render width
  129685. */
  129686. getRenderWidth(useScreen?: boolean): number;
  129687. /**
  129688. * Gets the current render height
  129689. * @param useScreen defines if screen size must be used (or the current render target if any)
  129690. * @returns a number defining the current render height
  129691. */
  129692. getRenderHeight(useScreen?: boolean): number;
  129693. /**
  129694. * Set the WebGL's viewport
  129695. * @param viewport defines the viewport element to be used
  129696. * @param requiredWidth defines the width required for rendering. If not provided the rendering canvas' width is used
  129697. * @param requiredHeight defines the height required for rendering. If not provided the rendering canvas' height is used
  129698. */
  129699. setViewport(viewport: IViewportLike, requiredWidth?: number, requiredHeight?: number): void;
  129700. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: string, context?: WebGLRenderingContext): WebGLProgram;
  129701. /**
  129702. * Gets the list of webGL uniform locations associated with a specific program based on a list of uniform names
  129703. * @param pipelineContext defines the pipeline context to use
  129704. * @param uniformsNames defines the list of uniform names
  129705. * @returns an array of webGL uniform locations
  129706. */
  129707. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): Nullable<WebGLUniformLocation>[];
  129708. /**
  129709. * Gets the lsit of active attributes for a given webGL program
  129710. * @param pipelineContext defines the pipeline context to use
  129711. * @param attributesNames defines the list of attribute names to get
  129712. * @returns an array of indices indicating the offset of each attribute
  129713. */
  129714. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  129715. /**
  129716. * Binds an effect to the webGL context
  129717. * @param effect defines the effect to bind
  129718. */
  129719. bindSamplers(effect: Effect): void;
  129720. /**
  129721. * Activates an effect, mkaing it the current one (ie. the one used for rendering)
  129722. * @param effect defines the effect to activate
  129723. */
  129724. enableEffect(effect: Effect): void;
  129725. /**
  129726. * Set various states to the webGL context
  129727. * @param culling defines backface culling state
  129728. * @param zOffset defines the value to apply to zOffset (0 by default)
  129729. * @param force defines if states must be applied even if cache is up to date
  129730. * @param reverseSide defines if culling must be reversed (CCW instead of CW and CW instead of CCW)
  129731. */
  129732. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  129733. /**
  129734. * Set the value of an uniform to an array of int32
  129735. * @param uniform defines the webGL uniform location where to store the value
  129736. * @param array defines the array of int32 to store
  129737. */
  129738. setIntArray(uniform: WebGLUniformLocation, array: Int32Array): void;
  129739. /**
  129740. * Set the value of an uniform to an array of int32 (stored as vec2)
  129741. * @param uniform defines the webGL uniform location where to store the value
  129742. * @param array defines the array of int32 to store
  129743. */
  129744. setIntArray2(uniform: WebGLUniformLocation, array: Int32Array): void;
  129745. /**
  129746. * Set the value of an uniform to an array of int32 (stored as vec3)
  129747. * @param uniform defines the webGL uniform location where to store the value
  129748. * @param array defines the array of int32 to store
  129749. */
  129750. setIntArray3(uniform: WebGLUniformLocation, array: Int32Array): void;
  129751. /**
  129752. * Set the value of an uniform to an array of int32 (stored as vec4)
  129753. * @param uniform defines the webGL uniform location where to store the value
  129754. * @param array defines the array of int32 to store
  129755. */
  129756. setIntArray4(uniform: WebGLUniformLocation, array: Int32Array): void;
  129757. /**
  129758. * Set the value of an uniform to an array of float32
  129759. * @param uniform defines the webGL uniform location where to store the value
  129760. * @param array defines the array of float32 to store
  129761. */
  129762. setFloatArray(uniform: WebGLUniformLocation, array: Float32Array): void;
  129763. /**
  129764. * Set the value of an uniform to an array of float32 (stored as vec2)
  129765. * @param uniform defines the webGL uniform location where to store the value
  129766. * @param array defines the array of float32 to store
  129767. */
  129768. setFloatArray2(uniform: WebGLUniformLocation, array: Float32Array): void;
  129769. /**
  129770. * Set the value of an uniform to an array of float32 (stored as vec3)
  129771. * @param uniform defines the webGL uniform location where to store the value
  129772. * @param array defines the array of float32 to store
  129773. */
  129774. setFloatArray3(uniform: WebGLUniformLocation, array: Float32Array): void;
  129775. /**
  129776. * Set the value of an uniform to an array of float32 (stored as vec4)
  129777. * @param uniform defines the webGL uniform location where to store the value
  129778. * @param array defines the array of float32 to store
  129779. */
  129780. setFloatArray4(uniform: WebGLUniformLocation, array: Float32Array): void;
  129781. /**
  129782. * Set the value of an uniform to an array of number
  129783. * @param uniform defines the webGL uniform location where to store the value
  129784. * @param array defines the array of number to store
  129785. */
  129786. setArray(uniform: WebGLUniformLocation, array: number[]): void;
  129787. /**
  129788. * Set the value of an uniform to an array of number (stored as vec2)
  129789. * @param uniform defines the webGL uniform location where to store the value
  129790. * @param array defines the array of number to store
  129791. */
  129792. setArray2(uniform: WebGLUniformLocation, array: number[]): void;
  129793. /**
  129794. * Set the value of an uniform to an array of number (stored as vec3)
  129795. * @param uniform defines the webGL uniform location where to store the value
  129796. * @param array defines the array of number to store
  129797. */
  129798. setArray3(uniform: WebGLUniformLocation, array: number[]): void;
  129799. /**
  129800. * Set the value of an uniform to an array of number (stored as vec4)
  129801. * @param uniform defines the webGL uniform location where to store the value
  129802. * @param array defines the array of number to store
  129803. */
  129804. setArray4(uniform: WebGLUniformLocation, array: number[]): void;
  129805. /**
  129806. * Set the value of an uniform to an array of float32 (stored as matrices)
  129807. * @param uniform defines the webGL uniform location where to store the value
  129808. * @param matrices defines the array of float32 to store
  129809. */
  129810. setMatrices(uniform: WebGLUniformLocation, matrices: Float32Array): void;
  129811. /**
  129812. * Set the value of an uniform to a matrix (3x3)
  129813. * @param uniform defines the webGL uniform location where to store the value
  129814. * @param matrix defines the Float32Array representing the 3x3 matrix to store
  129815. */
  129816. setMatrix3x3(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  129817. /**
  129818. * Set the value of an uniform to a matrix (2x2)
  129819. * @param uniform defines the webGL uniform location where to store the value
  129820. * @param matrix defines the Float32Array representing the 2x2 matrix to store
  129821. */
  129822. setMatrix2x2(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  129823. /**
  129824. * Set the value of an uniform to a number (float)
  129825. * @param uniform defines the webGL uniform location where to store the value
  129826. * @param value defines the float number to store
  129827. */
  129828. setFloat(uniform: WebGLUniformLocation, value: number): void;
  129829. /**
  129830. * Set the value of an uniform to a vec2
  129831. * @param uniform defines the webGL uniform location where to store the value
  129832. * @param x defines the 1st component of the value
  129833. * @param y defines the 2nd component of the value
  129834. */
  129835. setFloat2(uniform: WebGLUniformLocation, x: number, y: number): void;
  129836. /**
  129837. * Set the value of an uniform to a vec3
  129838. * @param uniform defines the webGL uniform location where to store the value
  129839. * @param x defines the 1st component of the value
  129840. * @param y defines the 2nd component of the value
  129841. * @param z defines the 3rd component of the value
  129842. */
  129843. setFloat3(uniform: WebGLUniformLocation, x: number, y: number, z: number): void;
  129844. /**
  129845. * Set the value of an uniform to a boolean
  129846. * @param uniform defines the webGL uniform location where to store the value
  129847. * @param bool defines the boolean to store
  129848. */
  129849. setBool(uniform: WebGLUniformLocation, bool: number): void;
  129850. /**
  129851. * Set the value of an uniform to a vec4
  129852. * @param uniform defines the webGL uniform location where to store the value
  129853. * @param x defines the 1st component of the value
  129854. * @param y defines the 2nd component of the value
  129855. * @param z defines the 3rd component of the value
  129856. * @param w defines the 4th component of the value
  129857. */
  129858. setFloat4(uniform: WebGLUniformLocation, x: number, y: number, z: number, w: number): void;
  129859. /**
  129860. * Sets the current alpha mode
  129861. * @param mode defines the mode to use (one of the Engine.ALPHA_XXX)
  129862. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  129863. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  129864. */
  129865. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  129866. /**
  129867. * Bind webGl buffers directly to the webGL context
  129868. * @param vertexBuffers defines the vertex buffer to bind
  129869. * @param indexBuffer defines the index buffer to bind
  129870. * @param vertexDeclaration defines the vertex declaration to use with the vertex buffer
  129871. * @param vertexStrideSize defines the vertex stride of the vertex buffer
  129872. * @param effect defines the effect associated with the vertex buffer
  129873. */
  129874. bindBuffers(vertexBuffers: {
  129875. [key: string]: VertexBuffer;
  129876. }, indexBuffer: DataBuffer, effect: Effect): void;
  129877. /**
  129878. * Force the entire cache to be cleared
  129879. * You should not have to use this function unless your engine needs to share the webGL context with another engine
  129880. * @param bruteForce defines a boolean to force clearing ALL caches (including stencil, detoh and alpha states)
  129881. */
  129882. wipeCaches(bruteForce?: boolean): void;
  129883. /**
  129884. * Send a draw order
  129885. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  129886. * @param indexStart defines the starting index
  129887. * @param indexCount defines the number of index to draw
  129888. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  129889. */
  129890. draw(useTriangles: boolean, indexStart: number, indexCount: number, instancesCount?: number): void;
  129891. /**
  129892. * Draw a list of indexed primitives
  129893. * @param fillMode defines the primitive to use
  129894. * @param indexStart defines the starting index
  129895. * @param indexCount defines the number of index to draw
  129896. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  129897. */
  129898. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  129899. /**
  129900. * Draw a list of unindexed primitives
  129901. * @param fillMode defines the primitive to use
  129902. * @param verticesStart defines the index of first vertex to draw
  129903. * @param verticesCount defines the count of vertices to draw
  129904. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  129905. */
  129906. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  129907. /** @hidden */
  129908. _createTexture(): WebGLTexture;
  129909. /** @hidden */
  129910. _releaseTexture(texture: InternalTexture): void;
  129911. /**
  129912. * Usually called from Texture.ts.
  129913. * Passed information to create a WebGLTexture
  129914. * @param urlArg defines a value which contains one of the following:
  129915. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  129916. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  129917. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  129918. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  129919. * @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)
  129920. * @param scene needed for loading to the correct scene
  129921. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  129922. * @param onLoad optional callback to be called upon successful completion
  129923. * @param onError optional callback to be called upon failure
  129924. * @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
  129925. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  129926. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  129927. * @param forcedExtension defines the extension to use to pick the right loader
  129928. * @param mimeType defines an optional mime type
  129929. * @returns a InternalTexture for assignment back into BABYLON.Texture
  129930. */
  129931. 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;
  129932. /**
  129933. * Creates a new render target texture
  129934. * @param size defines the size of the texture
  129935. * @param options defines the options used to create the texture
  129936. * @returns a new render target texture stored in an InternalTexture
  129937. */
  129938. createRenderTargetTexture(size: any, options: boolean | RenderTargetCreationOptions): InternalTexture;
  129939. /**
  129940. * Update the sampling mode of a given texture
  129941. * @param samplingMode defines the required sampling mode
  129942. * @param texture defines the texture to update
  129943. */
  129944. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  129945. /**
  129946. * Binds the frame buffer to the specified texture.
  129947. * @param texture The texture to render to or null for the default canvas
  129948. * @param faceIndex The face of the texture to render to in case of cube texture
  129949. * @param requiredWidth The width of the target to render to
  129950. * @param requiredHeight The height of the target to render to
  129951. * @param forceFullscreenViewport Forces the viewport to be the entire texture/screen if true
  129952. * @param lodLevel defines le lod level to bind to the frame buffer
  129953. */
  129954. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean): void;
  129955. /**
  129956. * Unbind the current render target texture from the webGL context
  129957. * @param texture defines the render target texture to unbind
  129958. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  129959. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  129960. */
  129961. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  129962. /**
  129963. * Creates a dynamic vertex buffer
  129964. * @param vertices the data for the dynamic vertex buffer
  129965. * @returns the new WebGL dynamic buffer
  129966. */
  129967. createDynamicVertexBuffer(vertices: FloatArray): DataBuffer;
  129968. /**
  129969. * Update the content of a dynamic texture
  129970. * @param texture defines the texture to update
  129971. * @param canvas defines the canvas containing the source
  129972. * @param invertY defines if data must be stored with Y axis inverted
  129973. * @param premulAlpha defines if alpha is stored as premultiplied
  129974. * @param format defines the format of the data
  129975. * @param forceBindTexture if the texture should be forced to be bound eg. after a graphics context loss (Default: false)
  129976. */
  129977. updateDynamicTexture(texture: Nullable<InternalTexture>, canvas: HTMLCanvasElement, invertY: boolean, premulAlpha?: boolean, format?: number): void;
  129978. /**
  129979. * Gets a boolean indicating if all created effects are ready
  129980. * @returns true if all effects are ready
  129981. */
  129982. areAllEffectsReady(): boolean;
  129983. /**
  129984. * @hidden
  129985. * Get the current error code of the webGL context
  129986. * @returns the error code
  129987. * @see https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/getError
  129988. */
  129989. getError(): number;
  129990. /** @hidden */
  129991. _getUnpackAlignement(): number;
  129992. /** @hidden */
  129993. _unpackFlipY(value: boolean): void;
  129994. /**
  129995. * Update a dynamic index buffer
  129996. * @param indexBuffer defines the target index buffer
  129997. * @param indices defines the data to update
  129998. * @param offset defines the offset in the target index buffer where update should start
  129999. */
  130000. updateDynamicIndexBuffer(indexBuffer: WebGLBuffer, indices: IndicesArray, offset?: number): void;
  130001. /**
  130002. * Updates a dynamic vertex buffer.
  130003. * @param vertexBuffer the vertex buffer to update
  130004. * @param vertices the data used to update the vertex buffer
  130005. * @param byteOffset the byte offset of the data (optional)
  130006. * @param byteLength the byte length of the data (optional)
  130007. */
  130008. updateDynamicVertexBuffer(vertexBuffer: WebGLBuffer, vertices: FloatArray, byteOffset?: number, byteLength?: number): void;
  130009. /** @hidden */
  130010. _bindTextureDirectly(target: number, texture: InternalTexture): boolean;
  130011. /** @hidden */
  130012. _bindTexture(channel: number, texture: InternalTexture): void;
  130013. protected _deleteBuffer(buffer: WebGLBuffer): void;
  130014. /**
  130015. * 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
  130016. */
  130017. releaseEffects(): void;
  130018. displayLoadingUI(): void;
  130019. hideLoadingUI(): void;
  130020. /** @hidden */
  130021. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  130022. /** @hidden */
  130023. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  130024. /** @hidden */
  130025. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  130026. /** @hidden */
  130027. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement, faceIndex?: number, lod?: number): void;
  130028. }
  130029. }
  130030. declare module BABYLON {
  130031. /**
  130032. * @hidden
  130033. **/
  130034. export class _TimeToken {
  130035. _startTimeQuery: Nullable<WebGLQuery>;
  130036. _endTimeQuery: Nullable<WebGLQuery>;
  130037. _timeElapsedQuery: Nullable<WebGLQuery>;
  130038. _timeElapsedQueryEnded: boolean;
  130039. }
  130040. }
  130041. declare module BABYLON {
  130042. /** @hidden */
  130043. export class _OcclusionDataStorage {
  130044. /** @hidden */
  130045. occlusionInternalRetryCounter: number;
  130046. /** @hidden */
  130047. isOcclusionQueryInProgress: boolean;
  130048. /** @hidden */
  130049. isOccluded: boolean;
  130050. /** @hidden */
  130051. occlusionRetryCount: number;
  130052. /** @hidden */
  130053. occlusionType: number;
  130054. /** @hidden */
  130055. occlusionQueryAlgorithmType: number;
  130056. }
  130057. interface Engine {
  130058. /**
  130059. * Create a new webGL query (you must be sure that queries are supported by checking getCaps() function)
  130060. * @return the new query
  130061. */
  130062. createQuery(): WebGLQuery;
  130063. /**
  130064. * Delete and release a webGL query
  130065. * @param query defines the query to delete
  130066. * @return the current engine
  130067. */
  130068. deleteQuery(query: WebGLQuery): Engine;
  130069. /**
  130070. * Check if a given query has resolved and got its value
  130071. * @param query defines the query to check
  130072. * @returns true if the query got its value
  130073. */
  130074. isQueryResultAvailable(query: WebGLQuery): boolean;
  130075. /**
  130076. * Gets the value of a given query
  130077. * @param query defines the query to check
  130078. * @returns the value of the query
  130079. */
  130080. getQueryResult(query: WebGLQuery): number;
  130081. /**
  130082. * Initiates an occlusion query
  130083. * @param algorithmType defines the algorithm to use
  130084. * @param query defines the query to use
  130085. * @returns the current engine
  130086. * @see https://doc.babylonjs.com/features/occlusionquery
  130087. */
  130088. beginOcclusionQuery(algorithmType: number, query: WebGLQuery): Engine;
  130089. /**
  130090. * Ends an occlusion query
  130091. * @see https://doc.babylonjs.com/features/occlusionquery
  130092. * @param algorithmType defines the algorithm to use
  130093. * @returns the current engine
  130094. */
  130095. endOcclusionQuery(algorithmType: number): Engine;
  130096. /**
  130097. * Starts a time query (used to measure time spent by the GPU on a specific frame)
  130098. * Please note that only one query can be issued at a time
  130099. * @returns a time token used to track the time span
  130100. */
  130101. startTimeQuery(): Nullable<_TimeToken>;
  130102. /**
  130103. * Ends a time query
  130104. * @param token defines the token used to measure the time span
  130105. * @returns the time spent (in ns)
  130106. */
  130107. endTimeQuery(token: _TimeToken): int;
  130108. /** @hidden */
  130109. _currentNonTimestampToken: Nullable<_TimeToken>;
  130110. /** @hidden */
  130111. _createTimeQuery(): WebGLQuery;
  130112. /** @hidden */
  130113. _deleteTimeQuery(query: WebGLQuery): void;
  130114. /** @hidden */
  130115. _getGlAlgorithmType(algorithmType: number): number;
  130116. /** @hidden */
  130117. _getTimeQueryResult(query: WebGLQuery): any;
  130118. /** @hidden */
  130119. _getTimeQueryAvailability(query: WebGLQuery): any;
  130120. }
  130121. interface AbstractMesh {
  130122. /**
  130123. * Backing filed
  130124. * @hidden
  130125. */
  130126. __occlusionDataStorage: _OcclusionDataStorage;
  130127. /**
  130128. * Access property
  130129. * @hidden
  130130. */
  130131. _occlusionDataStorage: _OcclusionDataStorage;
  130132. /**
  130133. * 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.
  130134. * The default value is -1 which means don't break the query and wait till the result
  130135. * @see https://doc.babylonjs.com/features/occlusionquery
  130136. */
  130137. occlusionRetryCount: number;
  130138. /**
  130139. * 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:
  130140. * * OCCLUSION_TYPE_NONE (Default Value): this option means no occlusion query whith the Mesh.
  130141. * * OCCLUSION_TYPE_OPTIMISTIC: this option is means use occlusion query and if occlusionRetryCount is reached and the query is broken show the mesh.
  130142. * * 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.
  130143. * @see https://doc.babylonjs.com/features/occlusionquery
  130144. */
  130145. occlusionType: number;
  130146. /**
  130147. * This property determines the type of occlusion query algorithm to run in WebGl, you can use:
  130148. * * AbstractMesh.OCCLUSION_ALGORITHM_TYPE_ACCURATE which is mapped to GL_ANY_SAMPLES_PASSED.
  130149. * * 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.
  130150. * @see https://doc.babylonjs.com/features/occlusionquery
  130151. */
  130152. occlusionQueryAlgorithmType: number;
  130153. /**
  130154. * 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
  130155. * @see https://doc.babylonjs.com/features/occlusionquery
  130156. */
  130157. isOccluded: boolean;
  130158. /**
  130159. * Flag to check the progress status of the query
  130160. * @see https://doc.babylonjs.com/features/occlusionquery
  130161. */
  130162. isOcclusionQueryInProgress: boolean;
  130163. }
  130164. }
  130165. declare module BABYLON {
  130166. /** @hidden */
  130167. export var _forceTransformFeedbackToBundle: boolean;
  130168. interface Engine {
  130169. /**
  130170. * Creates a webGL transform feedback object
  130171. * Please makes sure to check webGLVersion property to check if you are running webGL 2+
  130172. * @returns the webGL transform feedback object
  130173. */
  130174. createTransformFeedback(): WebGLTransformFeedback;
  130175. /**
  130176. * Delete a webGL transform feedback object
  130177. * @param value defines the webGL transform feedback object to delete
  130178. */
  130179. deleteTransformFeedback(value: WebGLTransformFeedback): void;
  130180. /**
  130181. * Bind a webGL transform feedback object to the webgl context
  130182. * @param value defines the webGL transform feedback object to bind
  130183. */
  130184. bindTransformFeedback(value: Nullable<WebGLTransformFeedback>): void;
  130185. /**
  130186. * Begins a transform feedback operation
  130187. * @param usePoints defines if points or triangles must be used
  130188. */
  130189. beginTransformFeedback(usePoints: boolean): void;
  130190. /**
  130191. * Ends a transform feedback operation
  130192. */
  130193. endTransformFeedback(): void;
  130194. /**
  130195. * Specify the varyings to use with transform feedback
  130196. * @param program defines the associated webGL program
  130197. * @param value defines the list of strings representing the varying names
  130198. */
  130199. setTranformFeedbackVaryings(program: WebGLProgram, value: string[]): void;
  130200. /**
  130201. * Bind a webGL buffer for a transform feedback operation
  130202. * @param value defines the webGL buffer to bind
  130203. */
  130204. bindTransformFeedbackBuffer(value: Nullable<DataBuffer>): void;
  130205. }
  130206. }
  130207. declare module BABYLON {
  130208. /**
  130209. * Class used to define an additional view for the engine
  130210. * @see https://doc.babylonjs.com/how_to/multi_canvases
  130211. */
  130212. export class EngineView {
  130213. /** Defines the canvas where to render the view */
  130214. target: HTMLCanvasElement;
  130215. /** Defines an optional camera used to render the view (will use active camera else) */
  130216. camera?: Camera;
  130217. }
  130218. interface Engine {
  130219. /**
  130220. * Gets or sets the HTML element to use for attaching events
  130221. */
  130222. inputElement: Nullable<HTMLElement>;
  130223. /**
  130224. * Gets the current engine view
  130225. * @see https://doc.babylonjs.com/how_to/multi_canvases
  130226. */
  130227. activeView: Nullable<EngineView>;
  130228. /** Gets or sets the list of views */
  130229. views: EngineView[];
  130230. /**
  130231. * Register a new child canvas
  130232. * @param canvas defines the canvas to register
  130233. * @param camera defines an optional camera to use with this canvas (it will overwrite the scene.camera for this view)
  130234. * @returns the associated view
  130235. */
  130236. registerView(canvas: HTMLCanvasElement, camera?: Camera): EngineView;
  130237. /**
  130238. * Remove a registered child canvas
  130239. * @param canvas defines the canvas to remove
  130240. * @returns the current engine
  130241. */
  130242. unRegisterView(canvas: HTMLCanvasElement): Engine;
  130243. }
  130244. }
  130245. declare module BABYLON {
  130246. interface Engine {
  130247. /** @hidden */
  130248. _excludedCompressedTextures: string[];
  130249. /** @hidden */
  130250. _textureFormatInUse: string;
  130251. /**
  130252. * Gets the list of texture formats supported
  130253. */
  130254. readonly texturesSupported: Array<string>;
  130255. /**
  130256. * Gets the texture format in use
  130257. */
  130258. readonly textureFormatInUse: Nullable<string>;
  130259. /**
  130260. * Set the compressed texture extensions or file names to skip.
  130261. *
  130262. * @param skippedFiles defines the list of those texture files you want to skip
  130263. * Example: [".dds", ".env", "myfile.png"]
  130264. */
  130265. setCompressedTextureExclusions(skippedFiles: Array<string>): void;
  130266. /**
  130267. * Set the compressed texture format to use, based on the formats you have, and the formats
  130268. * supported by the hardware / browser.
  130269. *
  130270. * Khronos Texture Container (.ktx) files are used to support this. This format has the
  130271. * advantage of being specifically designed for OpenGL. Header elements directly correspond
  130272. * to API arguments needed to compressed textures. This puts the burden on the container
  130273. * generator to house the arcane code for determining these for current & future formats.
  130274. *
  130275. * for description see https://www.khronos.org/opengles/sdk/tools/KTX/
  130276. * for file layout see https://www.khronos.org/opengles/sdk/tools/KTX/file_format_spec/
  130277. *
  130278. * Note: The result of this call is not taken into account when a texture is base64.
  130279. *
  130280. * @param formatsAvailable defines the list of those format families you have created
  130281. * on your server. Syntax: '-' + format family + '.ktx'. (Case and order do not matter.)
  130282. *
  130283. * Current families are astc, dxt, pvrtc, etc2, & etc1.
  130284. * @returns The extension selected.
  130285. */
  130286. setTextureFormatToUse(formatsAvailable: Array<string>): Nullable<string>;
  130287. }
  130288. }
  130289. declare module BABYLON {
  130290. /**
  130291. * CubeMap information grouping all the data for each faces as well as the cubemap size.
  130292. */
  130293. export interface CubeMapInfo {
  130294. /**
  130295. * The pixel array for the front face.
  130296. * This is stored in format, left to right, up to down format.
  130297. */
  130298. front: Nullable<ArrayBufferView>;
  130299. /**
  130300. * The pixel array for the back face.
  130301. * This is stored in format, left to right, up to down format.
  130302. */
  130303. back: Nullable<ArrayBufferView>;
  130304. /**
  130305. * The pixel array for the left face.
  130306. * This is stored in format, left to right, up to down format.
  130307. */
  130308. left: Nullable<ArrayBufferView>;
  130309. /**
  130310. * The pixel array for the right face.
  130311. * This is stored in format, left to right, up to down format.
  130312. */
  130313. right: Nullable<ArrayBufferView>;
  130314. /**
  130315. * The pixel array for the up face.
  130316. * This is stored in format, left to right, up to down format.
  130317. */
  130318. up: Nullable<ArrayBufferView>;
  130319. /**
  130320. * The pixel array for the down face.
  130321. * This is stored in format, left to right, up to down format.
  130322. */
  130323. down: Nullable<ArrayBufferView>;
  130324. /**
  130325. * The size of the cubemap stored.
  130326. *
  130327. * Each faces will be size * size pixels.
  130328. */
  130329. size: number;
  130330. /**
  130331. * The format of the texture.
  130332. *
  130333. * RGBA, RGB.
  130334. */
  130335. format: number;
  130336. /**
  130337. * The type of the texture data.
  130338. *
  130339. * UNSIGNED_INT, FLOAT.
  130340. */
  130341. type: number;
  130342. /**
  130343. * Specifies whether the texture is in gamma space.
  130344. */
  130345. gammaSpace: boolean;
  130346. }
  130347. /**
  130348. * Helper class useful to convert panorama picture to their cubemap representation in 6 faces.
  130349. */
  130350. export class PanoramaToCubeMapTools {
  130351. private static FACE_LEFT;
  130352. private static FACE_RIGHT;
  130353. private static FACE_FRONT;
  130354. private static FACE_BACK;
  130355. private static FACE_DOWN;
  130356. private static FACE_UP;
  130357. /**
  130358. * Converts a panorma stored in RGB right to left up to down format into a cubemap (6 faces).
  130359. *
  130360. * @param float32Array The source data.
  130361. * @param inputWidth The width of the input panorama.
  130362. * @param inputHeight The height of the input panorama.
  130363. * @param size The willing size of the generated cubemap (each faces will be size * size pixels)
  130364. * @return The cubemap data
  130365. */
  130366. static ConvertPanoramaToCubemap(float32Array: Float32Array, inputWidth: number, inputHeight: number, size: number): CubeMapInfo;
  130367. private static CreateCubemapTexture;
  130368. private static CalcProjectionSpherical;
  130369. }
  130370. }
  130371. declare module BABYLON {
  130372. /**
  130373. * Helper class dealing with the extraction of spherical polynomial dataArray
  130374. * from a cube map.
  130375. */
  130376. export class CubeMapToSphericalPolynomialTools {
  130377. private static FileFaces;
  130378. /**
  130379. * Converts a texture to the according Spherical Polynomial data.
  130380. * This extracts the first 3 orders only as they are the only one used in the lighting.
  130381. *
  130382. * @param texture The texture to extract the information from.
  130383. * @return The Spherical Polynomial data.
  130384. */
  130385. static ConvertCubeMapTextureToSphericalPolynomial(texture: BaseTexture): Nullable<SphericalPolynomial>;
  130386. /**
  130387. * Converts a cubemap to the according Spherical Polynomial data.
  130388. * This extracts the first 3 orders only as they are the only one used in the lighting.
  130389. *
  130390. * @param cubeInfo The Cube map to extract the information from.
  130391. * @return The Spherical Polynomial data.
  130392. */
  130393. static ConvertCubeMapToSphericalPolynomial(cubeInfo: CubeMapInfo): SphericalPolynomial;
  130394. }
  130395. }
  130396. declare module BABYLON {
  130397. interface BaseTexture {
  130398. /**
  130399. * Get the polynomial representation of the texture data.
  130400. * This is mainly use as a fast way to recover IBL Diffuse irradiance data.
  130401. * @see https://learnopengl.com/PBR/IBL/Diffuse-irradiance
  130402. */
  130403. sphericalPolynomial: Nullable<SphericalPolynomial>;
  130404. }
  130405. }
  130406. declare module BABYLON {
  130407. /** @hidden */
  130408. export var rgbdEncodePixelShader: {
  130409. name: string;
  130410. shader: string;
  130411. };
  130412. }
  130413. declare module BABYLON {
  130414. /** @hidden */
  130415. export var rgbdDecodePixelShader: {
  130416. name: string;
  130417. shader: string;
  130418. };
  130419. }
  130420. declare module BABYLON {
  130421. /**
  130422. * Raw texture data and descriptor sufficient for WebGL texture upload
  130423. */
  130424. export interface EnvironmentTextureInfo {
  130425. /**
  130426. * Version of the environment map
  130427. */
  130428. version: number;
  130429. /**
  130430. * Width of image
  130431. */
  130432. width: number;
  130433. /**
  130434. * Irradiance information stored in the file.
  130435. */
  130436. irradiance: any;
  130437. /**
  130438. * Specular information stored in the file.
  130439. */
  130440. specular: any;
  130441. }
  130442. /**
  130443. * Defines One Image in the file. It requires only the position in the file
  130444. * as well as the length.
  130445. */
  130446. interface BufferImageData {
  130447. /**
  130448. * Length of the image data.
  130449. */
  130450. length: number;
  130451. /**
  130452. * Position of the data from the null terminator delimiting the end of the JSON.
  130453. */
  130454. position: number;
  130455. }
  130456. /**
  130457. * Defines the specular data enclosed in the file.
  130458. * This corresponds to the version 1 of the data.
  130459. */
  130460. export interface EnvironmentTextureSpecularInfoV1 {
  130461. /**
  130462. * Defines where the specular Payload is located. It is a runtime value only not stored in the file.
  130463. */
  130464. specularDataPosition?: number;
  130465. /**
  130466. * This contains all the images data needed to reconstruct the cubemap.
  130467. */
  130468. mipmaps: Array<BufferImageData>;
  130469. /**
  130470. * Defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness.
  130471. */
  130472. lodGenerationScale: number;
  130473. }
  130474. /**
  130475. * Sets of helpers addressing the serialization and deserialization of environment texture
  130476. * stored in a BabylonJS env file.
  130477. * Those files are usually stored as .env files.
  130478. */
  130479. export class EnvironmentTextureTools {
  130480. /**
  130481. * Magic number identifying the env file.
  130482. */
  130483. private static _MagicBytes;
  130484. /**
  130485. * Gets the environment info from an env file.
  130486. * @param data The array buffer containing the .env bytes.
  130487. * @returns the environment file info (the json header) if successfully parsed.
  130488. */
  130489. static GetEnvInfo(data: ArrayBufferView): Nullable<EnvironmentTextureInfo>;
  130490. /**
  130491. * Creates an environment texture from a loaded cube texture.
  130492. * @param texture defines the cube texture to convert in env file
  130493. * @return a promise containing the environment data if succesfull.
  130494. */
  130495. static CreateEnvTextureAsync(texture: BaseTexture): Promise<ArrayBuffer>;
  130496. /**
  130497. * Creates a JSON representation of the spherical data.
  130498. * @param texture defines the texture containing the polynomials
  130499. * @return the JSON representation of the spherical info
  130500. */
  130501. private static _CreateEnvTextureIrradiance;
  130502. /**
  130503. * Creates the ArrayBufferViews used for initializing environment texture image data.
  130504. * @param data the image data
  130505. * @param info parameters that determine what views will be created for accessing the underlying buffer
  130506. * @return the views described by info providing access to the underlying buffer
  130507. */
  130508. static CreateImageDataArrayBufferViews(data: ArrayBufferView, info: EnvironmentTextureInfo): Array<Array<ArrayBufferView>>;
  130509. /**
  130510. * Uploads the texture info contained in the env file to the GPU.
  130511. * @param texture defines the internal texture to upload to
  130512. * @param data defines the data to load
  130513. * @param info defines the texture info retrieved through the GetEnvInfo method
  130514. * @returns a promise
  130515. */
  130516. static UploadEnvLevelsAsync(texture: InternalTexture, data: ArrayBufferView, info: EnvironmentTextureInfo): Promise<void>;
  130517. private static _OnImageReadyAsync;
  130518. /**
  130519. * Uploads the levels of image data to the GPU.
  130520. * @param texture defines the internal texture to upload to
  130521. * @param imageData defines the array buffer views of image data [mipmap][face]
  130522. * @returns a promise
  130523. */
  130524. static UploadLevelsAsync(texture: InternalTexture, imageData: ArrayBufferView[][]): Promise<void>;
  130525. /**
  130526. * Uploads spherical polynomials information to the texture.
  130527. * @param texture defines the texture we are trying to upload the information to
  130528. * @param info defines the environment texture info retrieved through the GetEnvInfo method
  130529. */
  130530. static UploadEnvSpherical(texture: InternalTexture, info: EnvironmentTextureInfo): void;
  130531. /** @hidden */
  130532. static _UpdateRGBDAsync(internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number): Promise<void>;
  130533. }
  130534. }
  130535. declare module BABYLON {
  130536. /**
  130537. * Class used to inline functions in shader code
  130538. */
  130539. export class ShaderCodeInliner {
  130540. private static readonly _RegexpFindFunctionNameAndType;
  130541. private _sourceCode;
  130542. private _functionDescr;
  130543. private _numMaxIterations;
  130544. /** Gets or sets the token used to mark the functions to inline */
  130545. inlineToken: string;
  130546. /** Gets or sets the debug mode */
  130547. debug: boolean;
  130548. /** Gets the code after the inlining process */
  130549. get code(): string;
  130550. /**
  130551. * Initializes the inliner
  130552. * @param sourceCode shader code source to inline
  130553. * @param numMaxIterations maximum number of iterations (used to detect recursive calls)
  130554. */
  130555. constructor(sourceCode: string, numMaxIterations?: number);
  130556. /**
  130557. * Start the processing of the shader code
  130558. */
  130559. processCode(): void;
  130560. private _collectFunctions;
  130561. private _processInlining;
  130562. private _extractBetweenMarkers;
  130563. private _skipWhitespaces;
  130564. private _removeComments;
  130565. private _replaceFunctionCallsByCode;
  130566. private _findBackward;
  130567. private _escapeRegExp;
  130568. private _replaceNames;
  130569. }
  130570. }
  130571. declare module BABYLON {
  130572. /**
  130573. * Container for accessors for natively-stored mesh data buffers.
  130574. */
  130575. class NativeDataBuffer extends DataBuffer {
  130576. /**
  130577. * Accessor value used to identify/retrieve a natively-stored index buffer.
  130578. */
  130579. nativeIndexBuffer?: any;
  130580. /**
  130581. * Accessor value used to identify/retrieve a natively-stored vertex buffer.
  130582. */
  130583. nativeVertexBuffer?: any;
  130584. }
  130585. /** @hidden */
  130586. class NativeTexture extends InternalTexture {
  130587. getInternalTexture(): InternalTexture;
  130588. getViewCount(): number;
  130589. }
  130590. /** @hidden */
  130591. export class NativeEngine extends Engine {
  130592. private readonly _native;
  130593. /** Defines the invalid handle returned by bgfx when resource creation goes wrong */
  130594. private readonly INVALID_HANDLE;
  130595. getHardwareScalingLevel(): number;
  130596. constructor();
  130597. dispose(): void;
  130598. /**
  130599. * Can be used to override the current requestAnimationFrame requester.
  130600. * @hidden
  130601. */
  130602. protected _queueNewFrame(bindedRenderFunction: any, requester?: any): number;
  130603. /**
  130604. * Override default engine behavior.
  130605. * @param color
  130606. * @param backBuffer
  130607. * @param depth
  130608. * @param stencil
  130609. */
  130610. _bindUnboundFramebuffer(framebuffer: Nullable<WebGLFramebuffer>): void;
  130611. /**
  130612. * Gets host document
  130613. * @returns the host document object
  130614. */
  130615. getHostDocument(): Nullable<Document>;
  130616. clear(color: Nullable<IColor4Like>, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  130617. createIndexBuffer(indices: IndicesArray, updateable?: boolean): NativeDataBuffer;
  130618. createVertexBuffer(data: DataArray, updateable?: boolean): NativeDataBuffer;
  130619. recordVertexArrayObject(vertexBuffers: {
  130620. [key: string]: VertexBuffer;
  130621. }, indexBuffer: Nullable<NativeDataBuffer>, effect: Effect): WebGLVertexArrayObject;
  130622. bindVertexArrayObject(vertexArray: WebGLVertexArrayObject): void;
  130623. releaseVertexArrayObject(vertexArray: WebGLVertexArrayObject): void;
  130624. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  130625. /**
  130626. * Draw a list of indexed primitives
  130627. * @param fillMode defines the primitive to use
  130628. * @param indexStart defines the starting index
  130629. * @param indexCount defines the number of index to draw
  130630. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  130631. */
  130632. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  130633. /**
  130634. * Draw a list of unindexed primitives
  130635. * @param fillMode defines the primitive to use
  130636. * @param verticesStart defines the index of first vertex to draw
  130637. * @param verticesCount defines the count of vertices to draw
  130638. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  130639. */
  130640. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  130641. createPipelineContext(): IPipelineContext;
  130642. _preparePipelineContext(pipelineContext: IPipelineContext, vertexSourceCode: string, fragmentSourceCode: string, createAsRaw: boolean, rebuildRebind: any, defines: Nullable<string>, transformFeedbackVaryings: Nullable<string[]>): void;
  130643. /** @hidden */
  130644. _isRenderingStateCompiled(pipelineContext: IPipelineContext): boolean;
  130645. /** @hidden */
  130646. _executeWhenRenderingStateIsCompiled(pipelineContext: IPipelineContext, action: () => void): void;
  130647. createRawShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): any;
  130648. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): any;
  130649. protected _setProgram(program: WebGLProgram): void;
  130650. _releaseEffect(effect: Effect): void;
  130651. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  130652. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): WebGLUniformLocation[];
  130653. bindUniformBlock(pipelineContext: IPipelineContext, blockName: string, index: number): void;
  130654. bindSamplers(effect: Effect): void;
  130655. setMatrix(uniform: WebGLUniformLocation, matrix: Matrix): void;
  130656. getRenderWidth(useScreen?: boolean): number;
  130657. getRenderHeight(useScreen?: boolean): number;
  130658. setViewport(viewport: Viewport, requiredWidth?: number, requiredHeight?: number): void;
  130659. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  130660. /**
  130661. * Set the z offset to apply to current rendering
  130662. * @param value defines the offset to apply
  130663. */
  130664. setZOffset(value: number): void;
  130665. /**
  130666. * Gets the current value of the zOffset
  130667. * @returns the current zOffset state
  130668. */
  130669. getZOffset(): number;
  130670. /**
  130671. * Enable or disable depth buffering
  130672. * @param enable defines the state to set
  130673. */
  130674. setDepthBuffer(enable: boolean): void;
  130675. /**
  130676. * Gets a boolean indicating if depth writing is enabled
  130677. * @returns the current depth writing state
  130678. */
  130679. getDepthWrite(): boolean;
  130680. /**
  130681. * Enable or disable depth writing
  130682. * @param enable defines the state to set
  130683. */
  130684. setDepthWrite(enable: boolean): void;
  130685. /**
  130686. * Enable or disable color writing
  130687. * @param enable defines the state to set
  130688. */
  130689. setColorWrite(enable: boolean): void;
  130690. /**
  130691. * Gets a boolean indicating if color writing is enabled
  130692. * @returns the current color writing state
  130693. */
  130694. getColorWrite(): boolean;
  130695. /**
  130696. * Sets alpha constants used by some alpha blending modes
  130697. * @param r defines the red component
  130698. * @param g defines the green component
  130699. * @param b defines the blue component
  130700. * @param a defines the alpha component
  130701. */
  130702. setAlphaConstants(r: number, g: number, b: number, a: number): void;
  130703. /**
  130704. * Sets the current alpha mode
  130705. * @param mode defines the mode to use (one of the BABYLON.Constants.ALPHA_XXX)
  130706. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  130707. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  130708. */
  130709. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  130710. /**
  130711. * Gets the current alpha mode
  130712. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  130713. * @returns the current alpha mode
  130714. */
  130715. getAlphaMode(): number;
  130716. setInt(uniform: WebGLUniformLocation, int: number): void;
  130717. setIntArray(uniform: WebGLUniformLocation, array: Int32Array): void;
  130718. setIntArray2(uniform: WebGLUniformLocation, array: Int32Array): void;
  130719. setIntArray3(uniform: WebGLUniformLocation, array: Int32Array): void;
  130720. setIntArray4(uniform: WebGLUniformLocation, array: Int32Array): void;
  130721. setFloatArray(uniform: WebGLUniformLocation, array: Float32Array): void;
  130722. setFloatArray2(uniform: WebGLUniformLocation, array: Float32Array): void;
  130723. setFloatArray3(uniform: WebGLUniformLocation, array: Float32Array): void;
  130724. setFloatArray4(uniform: WebGLUniformLocation, array: Float32Array): void;
  130725. setArray(uniform: WebGLUniformLocation, array: number[]): void;
  130726. setArray2(uniform: WebGLUniformLocation, array: number[]): void;
  130727. setArray3(uniform: WebGLUniformLocation, array: number[]): void;
  130728. setArray4(uniform: WebGLUniformLocation, array: number[]): void;
  130729. setMatrices(uniform: WebGLUniformLocation, matrices: Float32Array): void;
  130730. setMatrix3x3(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  130731. setMatrix2x2(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  130732. setFloat(uniform: WebGLUniformLocation, value: number): void;
  130733. setFloat2(uniform: WebGLUniformLocation, x: number, y: number): void;
  130734. setFloat3(uniform: WebGLUniformLocation, x: number, y: number, z: number): void;
  130735. setFloat4(uniform: WebGLUniformLocation, x: number, y: number, z: number, w: number): void;
  130736. setColor3(uniform: WebGLUniformLocation, color3: Color3): void;
  130737. setColor4(uniform: WebGLUniformLocation, color3: Color3, alpha: number): void;
  130738. wipeCaches(bruteForce?: boolean): void;
  130739. _createTexture(): WebGLTexture;
  130740. protected _deleteTexture(texture: Nullable<WebGLTexture>): void;
  130741. /**
  130742. * Usually called from Texture.ts.
  130743. * Passed information to create a WebGLTexture
  130744. * @param url defines a value which contains one of the following:
  130745. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  130746. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  130747. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  130748. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  130749. * @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)
  130750. * @param scene needed for loading to the correct scene
  130751. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  130752. * @param onLoad optional callback to be called upon successful completion
  130753. * @param onError optional callback to be called upon failure
  130754. * @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
  130755. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  130756. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  130757. * @param forcedExtension defines the extension to use to pick the right loader
  130758. * @param mimeType defines an optional mime type
  130759. * @returns a InternalTexture for assignment back into BABYLON.Texture
  130760. */
  130761. 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;
  130762. /**
  130763. * Creates a cube texture
  130764. * @param rootUrl defines the url where the files to load is located
  130765. * @param scene defines the current scene
  130766. * @param files defines the list of files to load (1 per face)
  130767. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  130768. * @param onLoad defines an optional callback raised when the texture is loaded
  130769. * @param onError defines an optional callback raised if there is an issue to load the texture
  130770. * @param format defines the format of the data
  130771. * @param forcedExtension defines the extension to use to pick the right loader
  130772. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  130773. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  130774. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  130775. * @param fallback defines texture to use while falling back when (compressed) texture file not found.
  130776. * @returns the cube texture as an InternalTexture
  130777. */
  130778. 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;
  130779. private _getSamplingFilter;
  130780. private static _GetNativeTextureFormat;
  130781. createRenderTargetTexture(size: number | {
  130782. width: number;
  130783. height: number;
  130784. }, options: boolean | RenderTargetCreationOptions): NativeTexture;
  130785. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  130786. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean): void;
  130787. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  130788. createDynamicVertexBuffer(data: DataArray): DataBuffer;
  130789. updateDynamicIndexBuffer(indexBuffer: DataBuffer, indices: IndicesArray, offset?: number): void;
  130790. /**
  130791. * Updates a dynamic vertex buffer.
  130792. * @param vertexBuffer the vertex buffer to update
  130793. * @param data the data used to update the vertex buffer
  130794. * @param byteOffset the byte offset of the data (optional)
  130795. * @param byteLength the byte length of the data (optional)
  130796. */
  130797. updateDynamicVertexBuffer(vertexBuffer: DataBuffer, data: DataArray, byteOffset?: number, byteLength?: number): void;
  130798. protected _setTexture(channel: number, texture: Nullable<BaseTexture>, isPartOfTextureArray?: boolean, depthStencilTexture?: boolean): boolean;
  130799. private _updateAnisotropicLevel;
  130800. private _getAddressMode;
  130801. /** @hidden */
  130802. _bindTexture(channel: number, texture: InternalTexture): void;
  130803. protected _deleteBuffer(buffer: NativeDataBuffer): void;
  130804. releaseEffects(): void;
  130805. /** @hidden */
  130806. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  130807. /** @hidden */
  130808. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  130809. /** @hidden */
  130810. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  130811. /** @hidden */
  130812. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement, faceIndex?: number, lod?: number): void;
  130813. }
  130814. }
  130815. declare module BABYLON {
  130816. /**
  130817. * Gather the list of clipboard event types as constants.
  130818. */
  130819. export class ClipboardEventTypes {
  130820. /**
  130821. * The clipboard event is fired when a copy command is active (pressed).
  130822. */
  130823. static readonly COPY: number;
  130824. /**
  130825. * The clipboard event is fired when a cut command is active (pressed).
  130826. */
  130827. static readonly CUT: number;
  130828. /**
  130829. * The clipboard event is fired when a paste command is active (pressed).
  130830. */
  130831. static readonly PASTE: number;
  130832. }
  130833. /**
  130834. * This class is used to store clipboard related info for the onClipboardObservable event.
  130835. */
  130836. export class ClipboardInfo {
  130837. /**
  130838. * Defines the type of event (BABYLON.ClipboardEventTypes)
  130839. */
  130840. type: number;
  130841. /**
  130842. * Defines the related dom event
  130843. */
  130844. event: ClipboardEvent;
  130845. /**
  130846. *Creates an instance of ClipboardInfo.
  130847. * @param type Defines the type of event (BABYLON.ClipboardEventTypes)
  130848. * @param event Defines the related dom event
  130849. */
  130850. constructor(
  130851. /**
  130852. * Defines the type of event (BABYLON.ClipboardEventTypes)
  130853. */
  130854. type: number,
  130855. /**
  130856. * Defines the related dom event
  130857. */
  130858. event: ClipboardEvent);
  130859. /**
  130860. * Get the clipboard event's type from the keycode.
  130861. * @param keyCode Defines the keyCode for the current keyboard event.
  130862. * @return {number}
  130863. */
  130864. static GetTypeFromCharacter(keyCode: number): number;
  130865. }
  130866. }
  130867. declare module BABYLON {
  130868. /**
  130869. * Google Daydream controller
  130870. */
  130871. export class DaydreamController extends WebVRController {
  130872. /**
  130873. * Base Url for the controller model.
  130874. */
  130875. static MODEL_BASE_URL: string;
  130876. /**
  130877. * File name for the controller model.
  130878. */
  130879. static MODEL_FILENAME: string;
  130880. /**
  130881. * Gamepad Id prefix used to identify Daydream Controller.
  130882. */
  130883. static readonly GAMEPAD_ID_PREFIX: string;
  130884. /**
  130885. * Creates a new DaydreamController from a gamepad
  130886. * @param vrGamepad the gamepad that the controller should be created from
  130887. */
  130888. constructor(vrGamepad: any);
  130889. /**
  130890. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  130891. * @param scene scene in which to add meshes
  130892. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  130893. */
  130894. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  130895. /**
  130896. * Called once for each button that changed state since the last frame
  130897. * @param buttonIdx Which button index changed
  130898. * @param state New state of the button
  130899. * @param changes Which properties on the state changed since last frame
  130900. */
  130901. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  130902. }
  130903. }
  130904. declare module BABYLON {
  130905. /**
  130906. * Gear VR Controller
  130907. */
  130908. export class GearVRController extends WebVRController {
  130909. /**
  130910. * Base Url for the controller model.
  130911. */
  130912. static MODEL_BASE_URL: string;
  130913. /**
  130914. * File name for the controller model.
  130915. */
  130916. static MODEL_FILENAME: string;
  130917. /**
  130918. * Gamepad Id prefix used to identify this controller.
  130919. */
  130920. static readonly GAMEPAD_ID_PREFIX: string;
  130921. private readonly _buttonIndexToObservableNameMap;
  130922. /**
  130923. * Creates a new GearVRController from a gamepad
  130924. * @param vrGamepad the gamepad that the controller should be created from
  130925. */
  130926. constructor(vrGamepad: any);
  130927. /**
  130928. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  130929. * @param scene scene in which to add meshes
  130930. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  130931. */
  130932. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  130933. /**
  130934. * Called once for each button that changed state since the last frame
  130935. * @param buttonIdx Which button index changed
  130936. * @param state New state of the button
  130937. * @param changes Which properties on the state changed since last frame
  130938. */
  130939. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  130940. }
  130941. }
  130942. declare module BABYLON {
  130943. /**
  130944. * Generic Controller
  130945. */
  130946. export class GenericController extends WebVRController {
  130947. /**
  130948. * Base Url for the controller model.
  130949. */
  130950. static readonly MODEL_BASE_URL: string;
  130951. /**
  130952. * File name for the controller model.
  130953. */
  130954. static readonly MODEL_FILENAME: string;
  130955. /**
  130956. * Creates a new GenericController from a gamepad
  130957. * @param vrGamepad the gamepad that the controller should be created from
  130958. */
  130959. constructor(vrGamepad: any);
  130960. /**
  130961. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  130962. * @param scene scene in which to add meshes
  130963. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  130964. */
  130965. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  130966. /**
  130967. * Called once for each button that changed state since the last frame
  130968. * @param buttonIdx Which button index changed
  130969. * @param state New state of the button
  130970. * @param changes Which properties on the state changed since last frame
  130971. */
  130972. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  130973. }
  130974. }
  130975. declare module BABYLON {
  130976. /**
  130977. * Oculus Touch Controller
  130978. */
  130979. export class OculusTouchController extends WebVRController {
  130980. /**
  130981. * Base Url for the controller model.
  130982. */
  130983. static MODEL_BASE_URL: string;
  130984. /**
  130985. * File name for the left controller model.
  130986. */
  130987. static MODEL_LEFT_FILENAME: string;
  130988. /**
  130989. * File name for the right controller model.
  130990. */
  130991. static MODEL_RIGHT_FILENAME: string;
  130992. /**
  130993. * Base Url for the Quest controller model.
  130994. */
  130995. static QUEST_MODEL_BASE_URL: string;
  130996. /**
  130997. * @hidden
  130998. * If the controllers are running on a device that needs the updated Quest controller models
  130999. */
  131000. static _IsQuest: boolean;
  131001. /**
  131002. * Fired when the secondary trigger on this controller is modified
  131003. */
  131004. onSecondaryTriggerStateChangedObservable: Observable<ExtendedGamepadButton>;
  131005. /**
  131006. * Fired when the thumb rest on this controller is modified
  131007. */
  131008. onThumbRestChangedObservable: Observable<ExtendedGamepadButton>;
  131009. /**
  131010. * Creates a new OculusTouchController from a gamepad
  131011. * @param vrGamepad the gamepad that the controller should be created from
  131012. */
  131013. constructor(vrGamepad: any);
  131014. /**
  131015. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  131016. * @param scene scene in which to add meshes
  131017. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  131018. */
  131019. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  131020. /**
  131021. * Fired when the A button on this controller is modified
  131022. */
  131023. get onAButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  131024. /**
  131025. * Fired when the B button on this controller is modified
  131026. */
  131027. get onBButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  131028. /**
  131029. * Fired when the X button on this controller is modified
  131030. */
  131031. get onXButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  131032. /**
  131033. * Fired when the Y button on this controller is modified
  131034. */
  131035. get onYButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  131036. /**
  131037. * Called once for each button that changed state since the last frame
  131038. * 0) thumb stick (touch, press, value = pressed (0,1)). value is in this.leftStick
  131039. * 1) index trigger (touch (?), press (only when value > 0.1), value 0 to 1)
  131040. * 2) secondary trigger (same)
  131041. * 3) A (right) X (left), touch, pressed = value
  131042. * 4) B / Y
  131043. * 5) thumb rest
  131044. * @param buttonIdx Which button index changed
  131045. * @param state New state of the button
  131046. * @param changes Which properties on the state changed since last frame
  131047. */
  131048. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  131049. }
  131050. }
  131051. declare module BABYLON {
  131052. /**
  131053. * Vive Controller
  131054. */
  131055. export class ViveController extends WebVRController {
  131056. /**
  131057. * Base Url for the controller model.
  131058. */
  131059. static MODEL_BASE_URL: string;
  131060. /**
  131061. * File name for the controller model.
  131062. */
  131063. static MODEL_FILENAME: string;
  131064. /**
  131065. * Creates a new ViveController from a gamepad
  131066. * @param vrGamepad the gamepad that the controller should be created from
  131067. */
  131068. constructor(vrGamepad: any);
  131069. /**
  131070. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  131071. * @param scene scene in which to add meshes
  131072. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  131073. */
  131074. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  131075. /**
  131076. * Fired when the left button on this controller is modified
  131077. */
  131078. get onLeftButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  131079. /**
  131080. * Fired when the right button on this controller is modified
  131081. */
  131082. get onRightButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  131083. /**
  131084. * Fired when the menu button on this controller is modified
  131085. */
  131086. get onMenuButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  131087. /**
  131088. * Called once for each button that changed state since the last frame
  131089. * Vive mapping:
  131090. * 0: touchpad
  131091. * 1: trigger
  131092. * 2: left AND right buttons
  131093. * 3: menu button
  131094. * @param buttonIdx Which button index changed
  131095. * @param state New state of the button
  131096. * @param changes Which properties on the state changed since last frame
  131097. */
  131098. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  131099. }
  131100. }
  131101. declare module BABYLON {
  131102. /**
  131103. * Defines the WindowsMotionController object that the state of the windows motion controller
  131104. */
  131105. export class WindowsMotionController extends WebVRController {
  131106. /**
  131107. * The base url used to load the left and right controller models
  131108. */
  131109. static MODEL_BASE_URL: string;
  131110. /**
  131111. * The name of the left controller model file
  131112. */
  131113. static MODEL_LEFT_FILENAME: string;
  131114. /**
  131115. * The name of the right controller model file
  131116. */
  131117. static MODEL_RIGHT_FILENAME: string;
  131118. /**
  131119. * The controller name prefix for this controller type
  131120. */
  131121. static readonly GAMEPAD_ID_PREFIX: string;
  131122. /**
  131123. * The controller id pattern for this controller type
  131124. */
  131125. private static readonly GAMEPAD_ID_PATTERN;
  131126. private _loadedMeshInfo;
  131127. protected readonly _mapping: {
  131128. buttons: string[];
  131129. buttonMeshNames: {
  131130. trigger: string;
  131131. menu: string;
  131132. grip: string;
  131133. thumbstick: string;
  131134. trackpad: string;
  131135. };
  131136. buttonObservableNames: {
  131137. trigger: string;
  131138. menu: string;
  131139. grip: string;
  131140. thumbstick: string;
  131141. trackpad: string;
  131142. };
  131143. axisMeshNames: string[];
  131144. pointingPoseMeshName: string;
  131145. };
  131146. /**
  131147. * Fired when the trackpad on this controller is clicked
  131148. */
  131149. onTrackpadChangedObservable: Observable<ExtendedGamepadButton>;
  131150. /**
  131151. * Fired when the trackpad on this controller is modified
  131152. */
  131153. onTrackpadValuesChangedObservable: Observable<StickValues>;
  131154. /**
  131155. * The current x and y values of this controller's trackpad
  131156. */
  131157. trackpad: StickValues;
  131158. /**
  131159. * Creates a new WindowsMotionController from a gamepad
  131160. * @param vrGamepad the gamepad that the controller should be created from
  131161. */
  131162. constructor(vrGamepad: any);
  131163. /**
  131164. * Fired when the trigger on this controller is modified
  131165. */
  131166. get onTriggerButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  131167. /**
  131168. * Fired when the menu button on this controller is modified
  131169. */
  131170. get onMenuButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  131171. /**
  131172. * Fired when the grip button on this controller is modified
  131173. */
  131174. get onGripButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  131175. /**
  131176. * Fired when the thumbstick button on this controller is modified
  131177. */
  131178. get onThumbstickButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  131179. /**
  131180. * Fired when the touchpad button on this controller is modified
  131181. */
  131182. get onTouchpadButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  131183. /**
  131184. * Fired when the touchpad values on this controller are modified
  131185. */
  131186. get onTouchpadValuesChangedObservable(): Observable<StickValues>;
  131187. protected _updateTrackpad(): void;
  131188. /**
  131189. * Called once per frame by the engine.
  131190. */
  131191. update(): void;
  131192. /**
  131193. * Called once for each button that changed state since the last frame
  131194. * @param buttonIdx Which button index changed
  131195. * @param state New state of the button
  131196. * @param changes Which properties on the state changed since last frame
  131197. */
  131198. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  131199. /**
  131200. * Moves the buttons on the controller mesh based on their current state
  131201. * @param buttonName the name of the button to move
  131202. * @param buttonValue the value of the button which determines the buttons new position
  131203. */
  131204. protected _lerpButtonTransform(buttonName: string, buttonValue: number): void;
  131205. /**
  131206. * Moves the axis on the controller mesh based on its current state
  131207. * @param axis the index of the axis
  131208. * @param axisValue the value of the axis which determines the meshes new position
  131209. * @hidden
  131210. */
  131211. protected _lerpAxisTransform(axis: number, axisValue: number): void;
  131212. /**
  131213. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  131214. * @param scene scene in which to add meshes
  131215. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  131216. */
  131217. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void, forceDefault?: boolean): void;
  131218. /**
  131219. * Takes a list of meshes (as loaded from the glTF file) and finds the root node, as well as nodes that
  131220. * can be transformed by button presses and axes values, based on this._mapping.
  131221. *
  131222. * @param scene scene in which the meshes exist
  131223. * @param meshes list of meshes that make up the controller model to process
  131224. * @return structured view of the given meshes, with mapping of buttons and axes to meshes that can be transformed.
  131225. */
  131226. private processModel;
  131227. private createMeshInfo;
  131228. /**
  131229. * Gets the ray of the controller in the direction the controller is pointing
  131230. * @param length the length the resulting ray should be
  131231. * @returns a ray in the direction the controller is pointing
  131232. */
  131233. getForwardRay(length?: number): Ray;
  131234. /**
  131235. * Disposes of the controller
  131236. */
  131237. dispose(): void;
  131238. }
  131239. /**
  131240. * This class represents a new windows motion controller in XR.
  131241. */
  131242. export class XRWindowsMotionController extends WindowsMotionController {
  131243. /**
  131244. * Changing the original WIndowsMotionController mapping to fir the new mapping
  131245. */
  131246. protected readonly _mapping: {
  131247. buttons: string[];
  131248. buttonMeshNames: {
  131249. trigger: string;
  131250. menu: string;
  131251. grip: string;
  131252. thumbstick: string;
  131253. trackpad: string;
  131254. };
  131255. buttonObservableNames: {
  131256. trigger: string;
  131257. menu: string;
  131258. grip: string;
  131259. thumbstick: string;
  131260. trackpad: string;
  131261. };
  131262. axisMeshNames: string[];
  131263. pointingPoseMeshName: string;
  131264. };
  131265. /**
  131266. * Construct a new XR-Based windows motion controller
  131267. *
  131268. * @param gamepadInfo the gamepad object from the browser
  131269. */
  131270. constructor(gamepadInfo: any);
  131271. /**
  131272. * holds the thumbstick values (X,Y)
  131273. */
  131274. thumbstickValues: StickValues;
  131275. /**
  131276. * Fired when the thumbstick on this controller is clicked
  131277. */
  131278. onThumbstickStateChangedObservable: Observable<ExtendedGamepadButton>;
  131279. /**
  131280. * Fired when the thumbstick on this controller is modified
  131281. */
  131282. onThumbstickValuesChangedObservable: Observable<StickValues>;
  131283. /**
  131284. * Fired when the touchpad button on this controller is modified
  131285. */
  131286. onTrackpadChangedObservable: Observable<ExtendedGamepadButton>;
  131287. /**
  131288. * Fired when the touchpad values on this controller are modified
  131289. */
  131290. onTrackpadValuesChangedObservable: Observable<StickValues>;
  131291. /**
  131292. * Fired when the thumbstick button on this controller is modified
  131293. * here to prevent breaking changes
  131294. */
  131295. get onThumbstickButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  131296. /**
  131297. * updating the thumbstick(!) and not the trackpad.
  131298. * This is named this way due to the difference between WebVR and XR and to avoid
  131299. * changing the parent class.
  131300. */
  131301. protected _updateTrackpad(): void;
  131302. /**
  131303. * Disposes the class with joy
  131304. */
  131305. dispose(): void;
  131306. }
  131307. }
  131308. declare module BABYLON {
  131309. /**
  131310. * Class containing static functions to help procedurally build meshes
  131311. */
  131312. export class PolyhedronBuilder {
  131313. /**
  131314. * Creates a polyhedron mesh
  131315. * * 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
  131316. * * The parameter `size` (positive float, default 1) sets the polygon size
  131317. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  131318. * * 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`
  131319. * * 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
  131320. * * 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)`)
  131321. * * 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
  131322. * * 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
  131323. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  131324. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  131325. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  131326. * @param name defines the name of the mesh
  131327. * @param options defines the options used to create the mesh
  131328. * @param scene defines the hosting scene
  131329. * @returns the polyhedron mesh
  131330. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes
  131331. */
  131332. static CreatePolyhedron(name: string, options: {
  131333. type?: number;
  131334. size?: number;
  131335. sizeX?: number;
  131336. sizeY?: number;
  131337. sizeZ?: number;
  131338. custom?: any;
  131339. faceUV?: Vector4[];
  131340. faceColors?: Color4[];
  131341. flat?: boolean;
  131342. updatable?: boolean;
  131343. sideOrientation?: number;
  131344. frontUVs?: Vector4;
  131345. backUVs?: Vector4;
  131346. }, scene?: Nullable<Scene>): Mesh;
  131347. }
  131348. }
  131349. declare module BABYLON {
  131350. /**
  131351. * Gizmo that enables scaling a mesh along 3 axis
  131352. */
  131353. export class ScaleGizmo extends Gizmo {
  131354. /**
  131355. * Internal gizmo used for interactions on the x axis
  131356. */
  131357. xGizmo: AxisScaleGizmo;
  131358. /**
  131359. * Internal gizmo used for interactions on the y axis
  131360. */
  131361. yGizmo: AxisScaleGizmo;
  131362. /**
  131363. * Internal gizmo used for interactions on the z axis
  131364. */
  131365. zGizmo: AxisScaleGizmo;
  131366. /**
  131367. * Internal gizmo used to scale all axis equally
  131368. */
  131369. uniformScaleGizmo: AxisScaleGizmo;
  131370. private _meshAttached;
  131371. private _nodeAttached;
  131372. private _updateGizmoRotationToMatchAttachedMesh;
  131373. private _snapDistance;
  131374. private _scaleRatio;
  131375. private _uniformScalingMesh;
  131376. private _octahedron;
  131377. private _sensitivity;
  131378. /** Fires an event when any of it's sub gizmos are dragged */
  131379. onDragStartObservable: Observable<unknown>;
  131380. /** Fires an event when any of it's sub gizmos are released from dragging */
  131381. onDragEndObservable: Observable<unknown>;
  131382. get attachedMesh(): Nullable<AbstractMesh>;
  131383. set attachedMesh(mesh: Nullable<AbstractMesh>);
  131384. get attachedNode(): Nullable<Node>;
  131385. set attachedNode(node: Nullable<Node>);
  131386. /**
  131387. * Creates a ScaleGizmo
  131388. * @param gizmoLayer The utility layer the gizmo will be added to
  131389. * @param thickness display gizmo axis thickness
  131390. */
  131391. constructor(gizmoLayer?: UtilityLayerRenderer, thickness?: number);
  131392. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  131393. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  131394. /**
  131395. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  131396. */
  131397. set snapDistance(value: number);
  131398. get snapDistance(): number;
  131399. /**
  131400. * Ratio for the scale of the gizmo (Default: 1)
  131401. */
  131402. set scaleRatio(value: number);
  131403. get scaleRatio(): number;
  131404. /**
  131405. * Sensitivity factor for dragging (Default: 1)
  131406. */
  131407. set sensitivity(value: number);
  131408. get sensitivity(): number;
  131409. /**
  131410. * Disposes of the gizmo
  131411. */
  131412. dispose(): void;
  131413. }
  131414. }
  131415. declare module BABYLON {
  131416. /**
  131417. * Single axis scale gizmo
  131418. */
  131419. export class AxisScaleGizmo extends Gizmo {
  131420. /**
  131421. * Drag behavior responsible for the gizmos dragging interactions
  131422. */
  131423. dragBehavior: PointerDragBehavior;
  131424. private _pointerObserver;
  131425. /**
  131426. * Scale distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  131427. */
  131428. snapDistance: number;
  131429. /**
  131430. * Event that fires each time the gizmo snaps to a new location.
  131431. * * snapDistance is the the change in distance
  131432. */
  131433. onSnapObservable: Observable<{
  131434. snapDistance: number;
  131435. }>;
  131436. /**
  131437. * If the scaling operation should be done on all axis (default: false)
  131438. */
  131439. uniformScaling: boolean;
  131440. /**
  131441. * Custom sensitivity value for the drag strength
  131442. */
  131443. sensitivity: number;
  131444. private _isEnabled;
  131445. private _parent;
  131446. private _arrow;
  131447. private _coloredMaterial;
  131448. private _hoverMaterial;
  131449. /**
  131450. * Creates an AxisScaleGizmo
  131451. * @param gizmoLayer The utility layer the gizmo will be added to
  131452. * @param dragAxis The axis which the gizmo will be able to scale on
  131453. * @param color The color of the gizmo
  131454. * @param thickness display gizmo axis thickness
  131455. */
  131456. constructor(dragAxis: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<ScaleGizmo>, thickness?: number);
  131457. protected _attachedNodeChanged(value: Nullable<Node>): void;
  131458. /**
  131459. * If the gizmo is enabled
  131460. */
  131461. set isEnabled(value: boolean);
  131462. get isEnabled(): boolean;
  131463. /**
  131464. * Disposes of the gizmo
  131465. */
  131466. dispose(): void;
  131467. /**
  131468. * Disposes and replaces the current meshes in the gizmo with the specified mesh
  131469. * @param mesh The mesh to replace the default mesh of the gizmo
  131470. * @param useGizmoMaterial If the gizmo's default material should be used (default: false)
  131471. */
  131472. setCustomMesh(mesh: Mesh, useGizmoMaterial?: boolean): void;
  131473. }
  131474. }
  131475. declare module BABYLON {
  131476. /**
  131477. * Bounding box gizmo
  131478. */
  131479. export class BoundingBoxGizmo extends Gizmo {
  131480. private _lineBoundingBox;
  131481. private _rotateSpheresParent;
  131482. private _scaleBoxesParent;
  131483. private _boundingDimensions;
  131484. private _renderObserver;
  131485. private _pointerObserver;
  131486. private _scaleDragSpeed;
  131487. private _tmpQuaternion;
  131488. private _tmpVector;
  131489. private _tmpRotationMatrix;
  131490. /**
  131491. * 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)
  131492. */
  131493. ignoreChildren: boolean;
  131494. /**
  131495. * 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)
  131496. */
  131497. includeChildPredicate: Nullable<(abstractMesh: AbstractMesh) => boolean>;
  131498. /**
  131499. * The size of the rotation spheres attached to the bounding box (Default: 0.1)
  131500. */
  131501. rotationSphereSize: number;
  131502. /**
  131503. * The size of the scale boxes attached to the bounding box (Default: 0.1)
  131504. */
  131505. scaleBoxSize: number;
  131506. /**
  131507. * 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)
  131508. */
  131509. fixedDragMeshScreenSize: boolean;
  131510. /**
  131511. * The distance away from the object which the draggable meshes should appear world sized when fixedDragMeshScreenSize is set to true (default: 10)
  131512. */
  131513. fixedDragMeshScreenSizeDistanceFactor: number;
  131514. /**
  131515. * Fired when a rotation sphere or scale box is dragged
  131516. */
  131517. onDragStartObservable: Observable<{}>;
  131518. /**
  131519. * Fired when a scale box is dragged
  131520. */
  131521. onScaleBoxDragObservable: Observable<{}>;
  131522. /**
  131523. * Fired when a scale box drag is ended
  131524. */
  131525. onScaleBoxDragEndObservable: Observable<{}>;
  131526. /**
  131527. * Fired when a rotation sphere is dragged
  131528. */
  131529. onRotationSphereDragObservable: Observable<{}>;
  131530. /**
  131531. * Fired when a rotation sphere drag is ended
  131532. */
  131533. onRotationSphereDragEndObservable: Observable<{}>;
  131534. /**
  131535. * 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)
  131536. */
  131537. scalePivot: Nullable<Vector3>;
  131538. /**
  131539. * Mesh used as a pivot to rotate the attached node
  131540. */
  131541. private _anchorMesh;
  131542. private _existingMeshScale;
  131543. private _dragMesh;
  131544. private pointerDragBehavior;
  131545. private coloredMaterial;
  131546. private hoverColoredMaterial;
  131547. /**
  131548. * Sets the color of the bounding box gizmo
  131549. * @param color the color to set
  131550. */
  131551. setColor(color: Color3): void;
  131552. /**
  131553. * Creates an BoundingBoxGizmo
  131554. * @param gizmoLayer The utility layer the gizmo will be added to
  131555. * @param color The color of the gizmo
  131556. */
  131557. constructor(color?: Color3, gizmoLayer?: UtilityLayerRenderer);
  131558. protected _attachedNodeChanged(value: Nullable<AbstractMesh>): void;
  131559. private _selectNode;
  131560. /**
  131561. * Updates the bounding box information for the Gizmo
  131562. */
  131563. updateBoundingBox(): void;
  131564. private _updateRotationSpheres;
  131565. private _updateScaleBoxes;
  131566. /**
  131567. * Enables rotation on the specified axis and disables rotation on the others
  131568. * @param axis The list of axis that should be enabled (eg. "xy" or "xyz")
  131569. */
  131570. setEnabledRotationAxis(axis: string): void;
  131571. /**
  131572. * Enables/disables scaling
  131573. * @param enable if scaling should be enabled
  131574. * @param homogeneousScaling defines if scaling should only be homogeneous
  131575. */
  131576. setEnabledScaling(enable: boolean, homogeneousScaling?: boolean): void;
  131577. private _updateDummy;
  131578. /**
  131579. * Enables a pointer drag behavior on the bounding box of the gizmo
  131580. */
  131581. enableDragBehavior(): void;
  131582. /**
  131583. * Disposes of the gizmo
  131584. */
  131585. dispose(): void;
  131586. /**
  131587. * 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)
  131588. * @param mesh the mesh to wrap in the bounding box mesh and make not pickable
  131589. * @returns the bounding box mesh with the passed in mesh as a child
  131590. */
  131591. static MakeNotPickableAndWrapInBoundingBox(mesh: Mesh): Mesh;
  131592. /**
  131593. * CustomMeshes are not supported by this gizmo
  131594. * @param mesh The mesh to replace the default mesh of the gizmo
  131595. */
  131596. setCustomMesh(mesh: Mesh): void;
  131597. }
  131598. }
  131599. declare module BABYLON {
  131600. /**
  131601. * Single plane rotation gizmo
  131602. */
  131603. export class PlaneRotationGizmo extends Gizmo {
  131604. /**
  131605. * Drag behavior responsible for the gizmos dragging interactions
  131606. */
  131607. dragBehavior: PointerDragBehavior;
  131608. private _pointerObserver;
  131609. /**
  131610. * Rotation distance in radians that the gizmo will snap to (Default: 0)
  131611. */
  131612. snapDistance: number;
  131613. /**
  131614. * Event that fires each time the gizmo snaps to a new location.
  131615. * * snapDistance is the the change in distance
  131616. */
  131617. onSnapObservable: Observable<{
  131618. snapDistance: number;
  131619. }>;
  131620. private _isEnabled;
  131621. private _parent;
  131622. /**
  131623. * Creates a PlaneRotationGizmo
  131624. * @param gizmoLayer The utility layer the gizmo will be added to
  131625. * @param planeNormal The normal of the plane which the gizmo will be able to rotate on
  131626. * @param color The color of the gizmo
  131627. * @param tessellation Amount of tessellation to be used when creating rotation circles
  131628. * @param useEulerRotation Use and update Euler angle instead of quaternion
  131629. * @param thickness display gizmo axis thickness
  131630. */
  131631. constructor(planeNormal: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, tessellation?: number, parent?: Nullable<RotationGizmo>, useEulerRotation?: boolean, thickness?: number);
  131632. protected _attachedNodeChanged(value: Nullable<Node>): void;
  131633. /**
  131634. * If the gizmo is enabled
  131635. */
  131636. set isEnabled(value: boolean);
  131637. get isEnabled(): boolean;
  131638. /**
  131639. * Disposes of the gizmo
  131640. */
  131641. dispose(): void;
  131642. }
  131643. }
  131644. declare module BABYLON {
  131645. /**
  131646. * Gizmo that enables rotating a mesh along 3 axis
  131647. */
  131648. export class RotationGizmo extends Gizmo {
  131649. /**
  131650. * Internal gizmo used for interactions on the x axis
  131651. */
  131652. xGizmo: PlaneRotationGizmo;
  131653. /**
  131654. * Internal gizmo used for interactions on the y axis
  131655. */
  131656. yGizmo: PlaneRotationGizmo;
  131657. /**
  131658. * Internal gizmo used for interactions on the z axis
  131659. */
  131660. zGizmo: PlaneRotationGizmo;
  131661. /** Fires an event when any of it's sub gizmos are dragged */
  131662. onDragStartObservable: Observable<unknown>;
  131663. /** Fires an event when any of it's sub gizmos are released from dragging */
  131664. onDragEndObservable: Observable<unknown>;
  131665. private _meshAttached;
  131666. private _nodeAttached;
  131667. get attachedMesh(): Nullable<AbstractMesh>;
  131668. set attachedMesh(mesh: Nullable<AbstractMesh>);
  131669. get attachedNode(): Nullable<Node>;
  131670. set attachedNode(node: Nullable<Node>);
  131671. /**
  131672. * Creates a RotationGizmo
  131673. * @param gizmoLayer The utility layer the gizmo will be added to
  131674. * @param tessellation Amount of tessellation to be used when creating rotation circles
  131675. * @param useEulerRotation Use and update Euler angle instead of quaternion
  131676. * @param thickness display gizmo axis thickness
  131677. */
  131678. constructor(gizmoLayer?: UtilityLayerRenderer, tessellation?: number, useEulerRotation?: boolean, thickness?: number);
  131679. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  131680. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  131681. /**
  131682. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  131683. */
  131684. set snapDistance(value: number);
  131685. get snapDistance(): number;
  131686. /**
  131687. * Ratio for the scale of the gizmo (Default: 1)
  131688. */
  131689. set scaleRatio(value: number);
  131690. get scaleRatio(): number;
  131691. /**
  131692. * Disposes of the gizmo
  131693. */
  131694. dispose(): void;
  131695. /**
  131696. * CustomMeshes are not supported by this gizmo
  131697. * @param mesh The mesh to replace the default mesh of the gizmo
  131698. */
  131699. setCustomMesh(mesh: Mesh): void;
  131700. }
  131701. }
  131702. declare module BABYLON {
  131703. /**
  131704. * Helps setup gizmo's in the scene to rotate/scale/position meshes
  131705. */
  131706. export class GizmoManager implements IDisposable {
  131707. private scene;
  131708. /**
  131709. * Gizmo's created by the gizmo manager, gizmo will be null until gizmo has been enabled for the first time
  131710. */
  131711. gizmos: {
  131712. positionGizmo: Nullable<PositionGizmo>;
  131713. rotationGizmo: Nullable<RotationGizmo>;
  131714. scaleGizmo: Nullable<ScaleGizmo>;
  131715. boundingBoxGizmo: Nullable<BoundingBoxGizmo>;
  131716. };
  131717. /** When true, the gizmo will be detached from the current object when a pointer down occurs with an empty picked mesh */
  131718. clearGizmoOnEmptyPointerEvent: boolean;
  131719. /** Fires an event when the manager is attached to a mesh */
  131720. onAttachedToMeshObservable: Observable<Nullable<AbstractMesh>>;
  131721. private _gizmosEnabled;
  131722. private _pointerObserver;
  131723. private _attachedMesh;
  131724. private _boundingBoxColor;
  131725. private _defaultUtilityLayer;
  131726. private _defaultKeepDepthUtilityLayer;
  131727. private _thickness;
  131728. /**
  131729. * When bounding box gizmo is enabled, this can be used to track drag/end events
  131730. */
  131731. boundingBoxDragBehavior: SixDofDragBehavior;
  131732. /**
  131733. * Array of meshes which will have the gizmo attached when a pointer selected them. If null, all meshes are attachable. (Default: null)
  131734. */
  131735. attachableMeshes: Nullable<Array<AbstractMesh>>;
  131736. /**
  131737. * If pointer events should perform attaching/detaching a gizmo, if false this can be done manually via attachToMesh. (Default: true)
  131738. */
  131739. usePointerToAttachGizmos: boolean;
  131740. /**
  131741. * Utility layer that the bounding box gizmo belongs to
  131742. */
  131743. get keepDepthUtilityLayer(): UtilityLayerRenderer;
  131744. /**
  131745. * Utility layer that all gizmos besides bounding box belong to
  131746. */
  131747. get utilityLayer(): UtilityLayerRenderer;
  131748. /**
  131749. * Instatiates a gizmo manager
  131750. * @param scene the scene to overlay the gizmos on top of
  131751. * @param thickness display gizmo axis thickness
  131752. */
  131753. constructor(scene: Scene, thickness?: number);
  131754. /**
  131755. * Attaches a set of gizmos to the specified mesh
  131756. * @param mesh The mesh the gizmo's should be attached to
  131757. */
  131758. attachToMesh(mesh: Nullable<AbstractMesh>): void;
  131759. /**
  131760. * If the position gizmo is enabled
  131761. */
  131762. set positionGizmoEnabled(value: boolean);
  131763. get positionGizmoEnabled(): boolean;
  131764. /**
  131765. * If the rotation gizmo is enabled
  131766. */
  131767. set rotationGizmoEnabled(value: boolean);
  131768. get rotationGizmoEnabled(): boolean;
  131769. /**
  131770. * If the scale gizmo is enabled
  131771. */
  131772. set scaleGizmoEnabled(value: boolean);
  131773. get scaleGizmoEnabled(): boolean;
  131774. /**
  131775. * If the boundingBox gizmo is enabled
  131776. */
  131777. set boundingBoxGizmoEnabled(value: boolean);
  131778. get boundingBoxGizmoEnabled(): boolean;
  131779. /**
  131780. * Disposes of the gizmo manager
  131781. */
  131782. dispose(): void;
  131783. }
  131784. }
  131785. declare module BABYLON {
  131786. /**
  131787. * A directional light is defined by a direction (what a surprise!).
  131788. * The light is emitted from everywhere in the specified direction, and has an infinite range.
  131789. * 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.
  131790. * Documentation: https://doc.babylonjs.com/babylon101/lights
  131791. */
  131792. export class DirectionalLight extends ShadowLight {
  131793. private _shadowFrustumSize;
  131794. /**
  131795. * Fix frustum size for the shadow generation. This is disabled if the value is 0.
  131796. */
  131797. get shadowFrustumSize(): number;
  131798. /**
  131799. * Specifies a fix frustum size for the shadow generation.
  131800. */
  131801. set shadowFrustumSize(value: number);
  131802. private _shadowOrthoScale;
  131803. /**
  131804. * Gets the shadow projection scale against the optimal computed one.
  131805. * 0.1 by default which means that the projection window is increase by 10% from the optimal size.
  131806. * This does not impact in fixed frustum size (shadowFrustumSize being set)
  131807. */
  131808. get shadowOrthoScale(): number;
  131809. /**
  131810. * Sets the shadow projection scale against the optimal computed one.
  131811. * 0.1 by default which means that the projection window is increase by 10% from the optimal size.
  131812. * This does not impact in fixed frustum size (shadowFrustumSize being set)
  131813. */
  131814. set shadowOrthoScale(value: number);
  131815. /**
  131816. * Automatically compute the projection matrix to best fit (including all the casters)
  131817. * on each frame.
  131818. */
  131819. autoUpdateExtends: boolean;
  131820. /**
  131821. * Automatically compute the shadowMinZ and shadowMaxZ for the projection matrix to best fit (including all the casters)
  131822. * on each frame. autoUpdateExtends must be set to true for this to work
  131823. */
  131824. autoCalcShadowZBounds: boolean;
  131825. private _orthoLeft;
  131826. private _orthoRight;
  131827. private _orthoTop;
  131828. private _orthoBottom;
  131829. /**
  131830. * Creates a DirectionalLight object in the scene, oriented towards the passed direction (Vector3).
  131831. * The directional light is emitted from everywhere in the given direction.
  131832. * It can cast shadows.
  131833. * Documentation : https://doc.babylonjs.com/babylon101/lights
  131834. * @param name The friendly name of the light
  131835. * @param direction The direction of the light
  131836. * @param scene The scene the light belongs to
  131837. */
  131838. constructor(name: string, direction: Vector3, scene: Scene);
  131839. /**
  131840. * Returns the string "DirectionalLight".
  131841. * @return The class name
  131842. */
  131843. getClassName(): string;
  131844. /**
  131845. * Returns the integer 1.
  131846. * @return The light Type id as a constant defines in Light.LIGHTTYPEID_x
  131847. */
  131848. getTypeID(): number;
  131849. /**
  131850. * Sets the passed matrix "matrix" as projection matrix for the shadows cast by the light according to the passed view matrix.
  131851. * Returns the DirectionalLight Shadow projection matrix.
  131852. */
  131853. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  131854. /**
  131855. * Sets the passed matrix "matrix" as fixed frustum projection matrix for the shadows cast by the light according to the passed view matrix.
  131856. * Returns the DirectionalLight Shadow projection matrix.
  131857. */
  131858. protected _setDefaultFixedFrustumShadowProjectionMatrix(matrix: Matrix): void;
  131859. /**
  131860. * Sets the passed matrix "matrix" as auto extend projection matrix for the shadows cast by the light according to the passed view matrix.
  131861. * Returns the DirectionalLight Shadow projection matrix.
  131862. */
  131863. protected _setDefaultAutoExtendShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  131864. protected _buildUniformLayout(): void;
  131865. /**
  131866. * Sets the passed Effect object with the DirectionalLight transformed position (or position if not parented) and the passed name.
  131867. * @param effect The effect to update
  131868. * @param lightIndex The index of the light in the effect to update
  131869. * @returns The directional light
  131870. */
  131871. transferToEffect(effect: Effect, lightIndex: string): DirectionalLight;
  131872. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): Light;
  131873. /**
  131874. * Gets the minZ used for shadow according to both the scene and the light.
  131875. *
  131876. * Values are fixed on directional lights as it relies on an ortho projection hence the need to convert being
  131877. * -1 and 1 to 0 and 1 doing (depth + min) / (min + max) -> (depth + 1) / (1 + 1) -> (depth * 0.5) + 0.5.
  131878. * @param activeCamera The camera we are returning the min for
  131879. * @returns the depth min z
  131880. */
  131881. getDepthMinZ(activeCamera: Camera): number;
  131882. /**
  131883. * Gets the maxZ used for shadow according to both the scene and the light.
  131884. *
  131885. * Values are fixed on directional lights as it relies on an ortho projection hence the need to convert being
  131886. * -1 and 1 to 0 and 1 doing (depth + min) / (min + max) -> (depth + 1) / (1 + 1) -> (depth * 0.5) + 0.5.
  131887. * @param activeCamera The camera we are returning the max for
  131888. * @returns the depth max z
  131889. */
  131890. getDepthMaxZ(activeCamera: Camera): number;
  131891. /**
  131892. * Prepares the list of defines specific to the light type.
  131893. * @param defines the list of defines
  131894. * @param lightIndex defines the index of the light for the effect
  131895. */
  131896. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  131897. }
  131898. }
  131899. declare module BABYLON {
  131900. /**
  131901. * Class containing static functions to help procedurally build meshes
  131902. */
  131903. export class HemisphereBuilder {
  131904. /**
  131905. * Creates a hemisphere mesh
  131906. * @param name defines the name of the mesh
  131907. * @param options defines the options used to create the mesh
  131908. * @param scene defines the hosting scene
  131909. * @returns the hemisphere mesh
  131910. */
  131911. static CreateHemisphere(name: string, options: {
  131912. segments?: number;
  131913. diameter?: number;
  131914. sideOrientation?: number;
  131915. }, scene: any): Mesh;
  131916. }
  131917. }
  131918. declare module BABYLON {
  131919. /**
  131920. * A spot light is defined by a position, a direction, an angle, and an exponent.
  131921. * These values define a cone of light starting from the position, emitting toward the direction.
  131922. * The angle, in radians, defines the size (field of illumination) of the spotlight's conical beam,
  131923. * and the exponent defines the speed of the decay of the light with distance (reach).
  131924. * Documentation: https://doc.babylonjs.com/babylon101/lights
  131925. */
  131926. export class SpotLight extends ShadowLight {
  131927. private _angle;
  131928. private _innerAngle;
  131929. private _cosHalfAngle;
  131930. private _lightAngleScale;
  131931. private _lightAngleOffset;
  131932. /**
  131933. * Gets the cone angle of the spot light in Radians.
  131934. */
  131935. get angle(): number;
  131936. /**
  131937. * Sets the cone angle of the spot light in Radians.
  131938. */
  131939. set angle(value: number);
  131940. /**
  131941. * Only used in gltf falloff mode, this defines the angle where
  131942. * the directional falloff will start before cutting at angle which could be seen
  131943. * as outer angle.
  131944. */
  131945. get innerAngle(): number;
  131946. /**
  131947. * Only used in gltf falloff mode, this defines the angle where
  131948. * the directional falloff will start before cutting at angle which could be seen
  131949. * as outer angle.
  131950. */
  131951. set innerAngle(value: number);
  131952. private _shadowAngleScale;
  131953. /**
  131954. * Allows scaling the angle of the light for shadow generation only.
  131955. */
  131956. get shadowAngleScale(): number;
  131957. /**
  131958. * Allows scaling the angle of the light for shadow generation only.
  131959. */
  131960. set shadowAngleScale(value: number);
  131961. /**
  131962. * The light decay speed with the distance from the emission spot.
  131963. */
  131964. exponent: number;
  131965. private _projectionTextureMatrix;
  131966. /**
  131967. * Allows reading the projecton texture
  131968. */
  131969. get projectionTextureMatrix(): Matrix;
  131970. protected _projectionTextureLightNear: number;
  131971. /**
  131972. * Gets the near clip of the Spotlight for texture projection.
  131973. */
  131974. get projectionTextureLightNear(): number;
  131975. /**
  131976. * Sets the near clip of the Spotlight for texture projection.
  131977. */
  131978. set projectionTextureLightNear(value: number);
  131979. protected _projectionTextureLightFar: number;
  131980. /**
  131981. * Gets the far clip of the Spotlight for texture projection.
  131982. */
  131983. get projectionTextureLightFar(): number;
  131984. /**
  131985. * Sets the far clip of the Spotlight for texture projection.
  131986. */
  131987. set projectionTextureLightFar(value: number);
  131988. protected _projectionTextureUpDirection: Vector3;
  131989. /**
  131990. * Gets the Up vector of the Spotlight for texture projection.
  131991. */
  131992. get projectionTextureUpDirection(): Vector3;
  131993. /**
  131994. * Sets the Up vector of the Spotlight for texture projection.
  131995. */
  131996. set projectionTextureUpDirection(value: Vector3);
  131997. private _projectionTexture;
  131998. /**
  131999. * Gets the projection texture of the light.
  132000. */
  132001. get projectionTexture(): Nullable<BaseTexture>;
  132002. /**
  132003. * Sets the projection texture of the light.
  132004. */
  132005. set projectionTexture(value: Nullable<BaseTexture>);
  132006. private _projectionTextureViewLightDirty;
  132007. private _projectionTextureProjectionLightDirty;
  132008. private _projectionTextureDirty;
  132009. private _projectionTextureViewTargetVector;
  132010. private _projectionTextureViewLightMatrix;
  132011. private _projectionTextureProjectionLightMatrix;
  132012. private _projectionTextureScalingMatrix;
  132013. /**
  132014. * Creates a SpotLight object in the scene. A spot light is a simply light oriented cone.
  132015. * It can cast shadows.
  132016. * Documentation : https://doc.babylonjs.com/babylon101/lights
  132017. * @param name The light friendly name
  132018. * @param position The position of the spot light in the scene
  132019. * @param direction The direction of the light in the scene
  132020. * @param angle The cone angle of the light in Radians
  132021. * @param exponent The light decay speed with the distance from the emission spot
  132022. * @param scene The scene the lights belongs to
  132023. */
  132024. constructor(name: string, position: Vector3, direction: Vector3, angle: number, exponent: number, scene: Scene);
  132025. /**
  132026. * Returns the string "SpotLight".
  132027. * @returns the class name
  132028. */
  132029. getClassName(): string;
  132030. /**
  132031. * Returns the integer 2.
  132032. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  132033. */
  132034. getTypeID(): number;
  132035. /**
  132036. * Overrides the direction setter to recompute the projection texture view light Matrix.
  132037. */
  132038. protected _setDirection(value: Vector3): void;
  132039. /**
  132040. * Overrides the position setter to recompute the projection texture view light Matrix.
  132041. */
  132042. protected _setPosition(value: Vector3): void;
  132043. /**
  132044. * 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.
  132045. * Returns the SpotLight.
  132046. */
  132047. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  132048. protected _computeProjectionTextureViewLightMatrix(): void;
  132049. protected _computeProjectionTextureProjectionLightMatrix(): void;
  132050. /**
  132051. * Main function for light texture projection matrix computing.
  132052. */
  132053. protected _computeProjectionTextureMatrix(): void;
  132054. protected _buildUniformLayout(): void;
  132055. private _computeAngleValues;
  132056. /**
  132057. * Sets the passed Effect "effect" with the Light textures.
  132058. * @param effect The effect to update
  132059. * @param lightIndex The index of the light in the effect to update
  132060. * @returns The light
  132061. */
  132062. transferTexturesToEffect(effect: Effect, lightIndex: string): Light;
  132063. /**
  132064. * Sets the passed Effect object with the SpotLight transfomed position (or position if not parented) and normalized direction.
  132065. * @param effect The effect to update
  132066. * @param lightIndex The index of the light in the effect to update
  132067. * @returns The spot light
  132068. */
  132069. transferToEffect(effect: Effect, lightIndex: string): SpotLight;
  132070. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  132071. /**
  132072. * Disposes the light and the associated resources.
  132073. */
  132074. dispose(): void;
  132075. /**
  132076. * Prepares the list of defines specific to the light type.
  132077. * @param defines the list of defines
  132078. * @param lightIndex defines the index of the light for the effect
  132079. */
  132080. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  132081. }
  132082. }
  132083. declare module BABYLON {
  132084. /**
  132085. * Gizmo that enables viewing a light
  132086. */
  132087. export class LightGizmo extends Gizmo {
  132088. private _lightMesh;
  132089. private _material;
  132090. private _cachedPosition;
  132091. private _cachedForward;
  132092. private _attachedMeshParent;
  132093. /**
  132094. * Creates a LightGizmo
  132095. * @param gizmoLayer The utility layer the gizmo will be added to
  132096. */
  132097. constructor(gizmoLayer?: UtilityLayerRenderer);
  132098. private _light;
  132099. /**
  132100. * The light that the gizmo is attached to
  132101. */
  132102. set light(light: Nullable<Light>);
  132103. get light(): Nullable<Light>;
  132104. /**
  132105. * Gets the material used to render the light gizmo
  132106. */
  132107. get material(): StandardMaterial;
  132108. /**
  132109. * @hidden
  132110. * Updates the gizmo to match the attached mesh's position/rotation
  132111. */
  132112. protected _update(): void;
  132113. private static _Scale;
  132114. /**
  132115. * Creates the lines for a light mesh
  132116. */
  132117. private static _CreateLightLines;
  132118. /**
  132119. * Disposes of the light gizmo
  132120. */
  132121. dispose(): void;
  132122. private static _CreateHemisphericLightMesh;
  132123. private static _CreatePointLightMesh;
  132124. private static _CreateSpotLightMesh;
  132125. private static _CreateDirectionalLightMesh;
  132126. }
  132127. }
  132128. declare module BABYLON {
  132129. /** @hidden */
  132130. export var backgroundFragmentDeclaration: {
  132131. name: string;
  132132. shader: string;
  132133. };
  132134. }
  132135. declare module BABYLON {
  132136. /** @hidden */
  132137. export var backgroundUboDeclaration: {
  132138. name: string;
  132139. shader: string;
  132140. };
  132141. }
  132142. declare module BABYLON {
  132143. /** @hidden */
  132144. export var backgroundPixelShader: {
  132145. name: string;
  132146. shader: string;
  132147. };
  132148. }
  132149. declare module BABYLON {
  132150. /** @hidden */
  132151. export var backgroundVertexDeclaration: {
  132152. name: string;
  132153. shader: string;
  132154. };
  132155. }
  132156. declare module BABYLON {
  132157. /** @hidden */
  132158. export var backgroundVertexShader: {
  132159. name: string;
  132160. shader: string;
  132161. };
  132162. }
  132163. declare module BABYLON {
  132164. /**
  132165. * Background material used to create an efficient environement around your scene.
  132166. */
  132167. export class BackgroundMaterial extends PushMaterial {
  132168. /**
  132169. * Standard reflectance value at parallel view angle.
  132170. */
  132171. static StandardReflectance0: number;
  132172. /**
  132173. * Standard reflectance value at grazing angle.
  132174. */
  132175. static StandardReflectance90: number;
  132176. protected _primaryColor: Color3;
  132177. /**
  132178. * Key light Color (multiply against the environement texture)
  132179. */
  132180. primaryColor: Color3;
  132181. protected __perceptualColor: Nullable<Color3>;
  132182. /**
  132183. * Experimental Internal Use Only.
  132184. *
  132185. * Key light Color in "perceptual value" meaning the color you would like to see on screen.
  132186. * This acts as a helper to set the primary color to a more "human friendly" value.
  132187. * Conversion to linear space as well as exposure and tone mapping correction will be applied to keep the
  132188. * output color as close as possible from the chosen value.
  132189. * (This does not account for contrast color grading and color curves as they are considered post effect and not directly
  132190. * part of lighting setup.)
  132191. */
  132192. get _perceptualColor(): Nullable<Color3>;
  132193. set _perceptualColor(value: Nullable<Color3>);
  132194. protected _primaryColorShadowLevel: float;
  132195. /**
  132196. * Defines the level of the shadows (dark area of the reflection map) in order to help scaling the colors.
  132197. * The color opposite to the primary color is used at the level chosen to define what the black area would look.
  132198. */
  132199. get primaryColorShadowLevel(): float;
  132200. set primaryColorShadowLevel(value: float);
  132201. protected _primaryColorHighlightLevel: float;
  132202. /**
  132203. * Defines the level of the highliights (highlight area of the reflection map) in order to help scaling the colors.
  132204. * The primary color is used at the level chosen to define what the white area would look.
  132205. */
  132206. get primaryColorHighlightLevel(): float;
  132207. set primaryColorHighlightLevel(value: float);
  132208. protected _reflectionTexture: Nullable<BaseTexture>;
  132209. /**
  132210. * Reflection Texture used in the material.
  132211. * Should be author in a specific way for the best result (refer to the documentation).
  132212. */
  132213. reflectionTexture: Nullable<BaseTexture>;
  132214. protected _reflectionBlur: float;
  132215. /**
  132216. * Reflection Texture level of blur.
  132217. *
  132218. * Can be use to reuse an existing HDR Texture and target a specific LOD to prevent authoring the
  132219. * texture twice.
  132220. */
  132221. reflectionBlur: float;
  132222. protected _diffuseTexture: Nullable<BaseTexture>;
  132223. /**
  132224. * Diffuse Texture used in the material.
  132225. * Should be author in a specific way for the best result (refer to the documentation).
  132226. */
  132227. diffuseTexture: Nullable<BaseTexture>;
  132228. protected _shadowLights: Nullable<IShadowLight[]>;
  132229. /**
  132230. * Specify the list of lights casting shadow on the material.
  132231. * All scene shadow lights will be included if null.
  132232. */
  132233. shadowLights: Nullable<IShadowLight[]>;
  132234. protected _shadowLevel: float;
  132235. /**
  132236. * Helps adjusting the shadow to a softer level if required.
  132237. * 0 means black shadows and 1 means no shadows.
  132238. */
  132239. shadowLevel: float;
  132240. protected _sceneCenter: Vector3;
  132241. /**
  132242. * In case of opacity Fresnel or reflection falloff, this is use as a scene center.
  132243. * It is usually zero but might be interesting to modify according to your setup.
  132244. */
  132245. sceneCenter: Vector3;
  132246. protected _opacityFresnel: boolean;
  132247. /**
  132248. * This helps specifying that the material is falling off to the sky box at grazing angle.
  132249. * This helps ensuring a nice transition when the camera goes under the ground.
  132250. */
  132251. opacityFresnel: boolean;
  132252. protected _reflectionFresnel: boolean;
  132253. /**
  132254. * This helps specifying that the material is falling off from diffuse to the reflection texture at grazing angle.
  132255. * This helps adding a mirror texture on the ground.
  132256. */
  132257. reflectionFresnel: boolean;
  132258. protected _reflectionFalloffDistance: number;
  132259. /**
  132260. * This helps specifying the falloff radius off the reflection texture from the sceneCenter.
  132261. * This helps adding a nice falloff effect to the reflection if used as a mirror for instance.
  132262. */
  132263. reflectionFalloffDistance: number;
  132264. protected _reflectionAmount: number;
  132265. /**
  132266. * This specifies the weight of the reflection against the background in case of reflection Fresnel.
  132267. */
  132268. reflectionAmount: number;
  132269. protected _reflectionReflectance0: number;
  132270. /**
  132271. * This specifies the weight of the reflection at grazing angle.
  132272. */
  132273. reflectionReflectance0: number;
  132274. protected _reflectionReflectance90: number;
  132275. /**
  132276. * This specifies the weight of the reflection at a perpendicular point of view.
  132277. */
  132278. reflectionReflectance90: number;
  132279. /**
  132280. * Sets the reflection reflectance fresnel values according to the default standard
  132281. * empirically know to work well :-)
  132282. */
  132283. set reflectionStandardFresnelWeight(value: number);
  132284. protected _useRGBColor: boolean;
  132285. /**
  132286. * Helps to directly use the maps channels instead of their level.
  132287. */
  132288. useRGBColor: boolean;
  132289. protected _enableNoise: boolean;
  132290. /**
  132291. * This helps reducing the banding effect that could occur on the background.
  132292. */
  132293. enableNoise: boolean;
  132294. /**
  132295. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  132296. * Best used when trying to implement visual zoom effects like fish-eye or binoculars while not adjusting camera fov.
  132297. * Recommended to be keep at 1.0 except for special cases.
  132298. */
  132299. get fovMultiplier(): number;
  132300. set fovMultiplier(value: number);
  132301. private _fovMultiplier;
  132302. /**
  132303. * Enable the FOV adjustment feature controlled by fovMultiplier.
  132304. */
  132305. useEquirectangularFOV: boolean;
  132306. private _maxSimultaneousLights;
  132307. /**
  132308. * Number of Simultaneous lights allowed on the material.
  132309. */
  132310. maxSimultaneousLights: int;
  132311. private _shadowOnly;
  132312. /**
  132313. * Make the material only render shadows
  132314. */
  132315. shadowOnly: boolean;
  132316. /**
  132317. * Default configuration related to image processing available in the Background Material.
  132318. */
  132319. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  132320. /**
  132321. * Keep track of the image processing observer to allow dispose and replace.
  132322. */
  132323. private _imageProcessingObserver;
  132324. /**
  132325. * Attaches a new image processing configuration to the PBR Material.
  132326. * @param configuration (if null the scene configuration will be use)
  132327. */
  132328. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  132329. /**
  132330. * Gets the image processing configuration used either in this material.
  132331. */
  132332. get imageProcessingConfiguration(): Nullable<ImageProcessingConfiguration>;
  132333. /**
  132334. * Sets the Default image processing configuration used either in the this material.
  132335. *
  132336. * If sets to null, the scene one is in use.
  132337. */
  132338. set imageProcessingConfiguration(value: Nullable<ImageProcessingConfiguration>);
  132339. /**
  132340. * Gets wether the color curves effect is enabled.
  132341. */
  132342. get cameraColorCurvesEnabled(): boolean;
  132343. /**
  132344. * Sets wether the color curves effect is enabled.
  132345. */
  132346. set cameraColorCurvesEnabled(value: boolean);
  132347. /**
  132348. * Gets wether the color grading effect is enabled.
  132349. */
  132350. get cameraColorGradingEnabled(): boolean;
  132351. /**
  132352. * Gets wether the color grading effect is enabled.
  132353. */
  132354. set cameraColorGradingEnabled(value: boolean);
  132355. /**
  132356. * Gets wether tonemapping is enabled or not.
  132357. */
  132358. get cameraToneMappingEnabled(): boolean;
  132359. /**
  132360. * Sets wether tonemapping is enabled or not
  132361. */
  132362. set cameraToneMappingEnabled(value: boolean);
  132363. /**
  132364. * The camera exposure used on this material.
  132365. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  132366. * This corresponds to a photographic exposure.
  132367. */
  132368. get cameraExposure(): float;
  132369. /**
  132370. * The camera exposure used on this material.
  132371. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  132372. * This corresponds to a photographic exposure.
  132373. */
  132374. set cameraExposure(value: float);
  132375. /**
  132376. * Gets The camera contrast used on this material.
  132377. */
  132378. get cameraContrast(): float;
  132379. /**
  132380. * Sets The camera contrast used on this material.
  132381. */
  132382. set cameraContrast(value: float);
  132383. /**
  132384. * Gets the Color Grading 2D Lookup Texture.
  132385. */
  132386. get cameraColorGradingTexture(): Nullable<BaseTexture>;
  132387. /**
  132388. * Sets the Color Grading 2D Lookup Texture.
  132389. */
  132390. set cameraColorGradingTexture(value: Nullable<BaseTexture>);
  132391. /**
  132392. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  132393. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  132394. * 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;
  132395. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  132396. */
  132397. get cameraColorCurves(): Nullable<ColorCurves>;
  132398. /**
  132399. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  132400. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  132401. * 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;
  132402. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  132403. */
  132404. set cameraColorCurves(value: Nullable<ColorCurves>);
  132405. /**
  132406. * Due to a bug in iOS10, video tags (which are using the background material) are in BGR and not RGB.
  132407. * Setting this flag to true (not done automatically!) will convert it back to RGB.
  132408. */
  132409. switchToBGR: boolean;
  132410. private _renderTargets;
  132411. private _reflectionControls;
  132412. private _white;
  132413. private _primaryShadowColor;
  132414. private _primaryHighlightColor;
  132415. /**
  132416. * Instantiates a Background Material in the given scene
  132417. * @param name The friendly name of the material
  132418. * @param scene The scene to add the material to
  132419. */
  132420. constructor(name: string, scene: Scene);
  132421. /**
  132422. * Gets a boolean indicating that current material needs to register RTT
  132423. */
  132424. get hasRenderTargetTextures(): boolean;
  132425. /**
  132426. * The entire material has been created in order to prevent overdraw.
  132427. * @returns false
  132428. */
  132429. needAlphaTesting(): boolean;
  132430. /**
  132431. * The entire material has been created in order to prevent overdraw.
  132432. * @returns true if blending is enable
  132433. */
  132434. needAlphaBlending(): boolean;
  132435. /**
  132436. * Checks wether the material is ready to be rendered for a given mesh.
  132437. * @param mesh The mesh to render
  132438. * @param subMesh The submesh to check against
  132439. * @param useInstances Specify wether or not the material is used with instances
  132440. * @returns true if all the dependencies are ready (Textures, Effects...)
  132441. */
  132442. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  132443. /**
  132444. * Compute the primary color according to the chosen perceptual color.
  132445. */
  132446. private _computePrimaryColorFromPerceptualColor;
  132447. /**
  132448. * Compute the highlights and shadow colors according to their chosen levels.
  132449. */
  132450. private _computePrimaryColors;
  132451. /**
  132452. * Build the uniform buffer used in the material.
  132453. */
  132454. buildUniformLayout(): void;
  132455. /**
  132456. * Unbind the material.
  132457. */
  132458. unbind(): void;
  132459. /**
  132460. * Bind only the world matrix to the material.
  132461. * @param world The world matrix to bind.
  132462. */
  132463. bindOnlyWorldMatrix(world: Matrix): void;
  132464. /**
  132465. * Bind the material for a dedicated submeh (every used meshes will be considered opaque).
  132466. * @param world The world matrix to bind.
  132467. * @param subMesh The submesh to bind for.
  132468. */
  132469. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  132470. /**
  132471. * Checks to see if a texture is used in the material.
  132472. * @param texture - Base texture to use.
  132473. * @returns - Boolean specifying if a texture is used in the material.
  132474. */
  132475. hasTexture(texture: BaseTexture): boolean;
  132476. /**
  132477. * Dispose the material.
  132478. * @param forceDisposeEffect Force disposal of the associated effect.
  132479. * @param forceDisposeTextures Force disposal of the associated textures.
  132480. */
  132481. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  132482. /**
  132483. * Clones the material.
  132484. * @param name The cloned name.
  132485. * @returns The cloned material.
  132486. */
  132487. clone(name: string): BackgroundMaterial;
  132488. /**
  132489. * Serializes the current material to its JSON representation.
  132490. * @returns The JSON representation.
  132491. */
  132492. serialize(): any;
  132493. /**
  132494. * Gets the class name of the material
  132495. * @returns "BackgroundMaterial"
  132496. */
  132497. getClassName(): string;
  132498. /**
  132499. * Parse a JSON input to create back a background material.
  132500. * @param source The JSON data to parse
  132501. * @param scene The scene to create the parsed material in
  132502. * @param rootUrl The root url of the assets the material depends upon
  132503. * @returns the instantiated BackgroundMaterial.
  132504. */
  132505. static Parse(source: any, scene: Scene, rootUrl: string): BackgroundMaterial;
  132506. }
  132507. }
  132508. declare module BABYLON {
  132509. /**
  132510. * Represents the different options available during the creation of
  132511. * a Environment helper.
  132512. *
  132513. * This can control the default ground, skybox and image processing setup of your scene.
  132514. */
  132515. export interface IEnvironmentHelperOptions {
  132516. /**
  132517. * Specifies whether or not to create a ground.
  132518. * True by default.
  132519. */
  132520. createGround: boolean;
  132521. /**
  132522. * Specifies the ground size.
  132523. * 15 by default.
  132524. */
  132525. groundSize: number;
  132526. /**
  132527. * The texture used on the ground for the main color.
  132528. * Comes from the BabylonJS CDN by default.
  132529. *
  132530. * Remarks: Can be either a texture or a url.
  132531. */
  132532. groundTexture: string | BaseTexture;
  132533. /**
  132534. * The color mixed in the ground texture by default.
  132535. * BabylonJS clearColor by default.
  132536. */
  132537. groundColor: Color3;
  132538. /**
  132539. * Specifies the ground opacity.
  132540. * 1 by default.
  132541. */
  132542. groundOpacity: number;
  132543. /**
  132544. * Enables the ground to receive shadows.
  132545. * True by default.
  132546. */
  132547. enableGroundShadow: boolean;
  132548. /**
  132549. * Helps preventing the shadow to be fully black on the ground.
  132550. * 0.5 by default.
  132551. */
  132552. groundShadowLevel: number;
  132553. /**
  132554. * Creates a mirror texture attach to the ground.
  132555. * false by default.
  132556. */
  132557. enableGroundMirror: boolean;
  132558. /**
  132559. * Specifies the ground mirror size ratio.
  132560. * 0.3 by default as the default kernel is 64.
  132561. */
  132562. groundMirrorSizeRatio: number;
  132563. /**
  132564. * Specifies the ground mirror blur kernel size.
  132565. * 64 by default.
  132566. */
  132567. groundMirrorBlurKernel: number;
  132568. /**
  132569. * Specifies the ground mirror visibility amount.
  132570. * 1 by default
  132571. */
  132572. groundMirrorAmount: number;
  132573. /**
  132574. * Specifies the ground mirror reflectance weight.
  132575. * This uses the standard weight of the background material to setup the fresnel effect
  132576. * of the mirror.
  132577. * 1 by default.
  132578. */
  132579. groundMirrorFresnelWeight: number;
  132580. /**
  132581. * Specifies the ground mirror Falloff distance.
  132582. * This can helps reducing the size of the reflection.
  132583. * 0 by Default.
  132584. */
  132585. groundMirrorFallOffDistance: number;
  132586. /**
  132587. * Specifies the ground mirror texture type.
  132588. * Unsigned Int by Default.
  132589. */
  132590. groundMirrorTextureType: number;
  132591. /**
  132592. * Specifies a bias applied to the ground vertical position to prevent z-fighting with
  132593. * the shown objects.
  132594. */
  132595. groundYBias: number;
  132596. /**
  132597. * Specifies whether or not to create a skybox.
  132598. * True by default.
  132599. */
  132600. createSkybox: boolean;
  132601. /**
  132602. * Specifies the skybox size.
  132603. * 20 by default.
  132604. */
  132605. skyboxSize: number;
  132606. /**
  132607. * The texture used on the skybox for the main color.
  132608. * Comes from the BabylonJS CDN by default.
  132609. *
  132610. * Remarks: Can be either a texture or a url.
  132611. */
  132612. skyboxTexture: string | BaseTexture;
  132613. /**
  132614. * The color mixed in the skybox texture by default.
  132615. * BabylonJS clearColor by default.
  132616. */
  132617. skyboxColor: Color3;
  132618. /**
  132619. * The background rotation around the Y axis of the scene.
  132620. * This helps aligning the key lights of your scene with the background.
  132621. * 0 by default.
  132622. */
  132623. backgroundYRotation: number;
  132624. /**
  132625. * Compute automatically the size of the elements to best fit with the scene.
  132626. */
  132627. sizeAuto: boolean;
  132628. /**
  132629. * Default position of the rootMesh if autoSize is not true.
  132630. */
  132631. rootPosition: Vector3;
  132632. /**
  132633. * Sets up the image processing in the scene.
  132634. * true by default.
  132635. */
  132636. setupImageProcessing: boolean;
  132637. /**
  132638. * The texture used as your environment texture in the scene.
  132639. * Comes from the BabylonJS CDN by default and in use if setupImageProcessing is true.
  132640. *
  132641. * Remarks: Can be either a texture or a url.
  132642. */
  132643. environmentTexture: string | BaseTexture;
  132644. /**
  132645. * The value of the exposure to apply to the scene.
  132646. * 0.6 by default if setupImageProcessing is true.
  132647. */
  132648. cameraExposure: number;
  132649. /**
  132650. * The value of the contrast to apply to the scene.
  132651. * 1.6 by default if setupImageProcessing is true.
  132652. */
  132653. cameraContrast: number;
  132654. /**
  132655. * Specifies whether or not tonemapping should be enabled in the scene.
  132656. * true by default if setupImageProcessing is true.
  132657. */
  132658. toneMappingEnabled: boolean;
  132659. }
  132660. /**
  132661. * The Environment helper class can be used to add a fully featuread none expensive background to your scene.
  132662. * It includes by default a skybox and a ground relying on the BackgroundMaterial.
  132663. * It also helps with the default setup of your imageProcessing configuration.
  132664. */
  132665. export class EnvironmentHelper {
  132666. /**
  132667. * Default ground texture URL.
  132668. */
  132669. private static _groundTextureCDNUrl;
  132670. /**
  132671. * Default skybox texture URL.
  132672. */
  132673. private static _skyboxTextureCDNUrl;
  132674. /**
  132675. * Default environment texture URL.
  132676. */
  132677. private static _environmentTextureCDNUrl;
  132678. /**
  132679. * Creates the default options for the helper.
  132680. */
  132681. private static _getDefaultOptions;
  132682. private _rootMesh;
  132683. /**
  132684. * Gets the root mesh created by the helper.
  132685. */
  132686. get rootMesh(): Mesh;
  132687. private _skybox;
  132688. /**
  132689. * Gets the skybox created by the helper.
  132690. */
  132691. get skybox(): Nullable<Mesh>;
  132692. private _skyboxTexture;
  132693. /**
  132694. * Gets the skybox texture created by the helper.
  132695. */
  132696. get skyboxTexture(): Nullable<BaseTexture>;
  132697. private _skyboxMaterial;
  132698. /**
  132699. * Gets the skybox material created by the helper.
  132700. */
  132701. get skyboxMaterial(): Nullable<BackgroundMaterial>;
  132702. private _ground;
  132703. /**
  132704. * Gets the ground mesh created by the helper.
  132705. */
  132706. get ground(): Nullable<Mesh>;
  132707. private _groundTexture;
  132708. /**
  132709. * Gets the ground texture created by the helper.
  132710. */
  132711. get groundTexture(): Nullable<BaseTexture>;
  132712. private _groundMirror;
  132713. /**
  132714. * Gets the ground mirror created by the helper.
  132715. */
  132716. get groundMirror(): Nullable<MirrorTexture>;
  132717. /**
  132718. * Gets the ground mirror render list to helps pushing the meshes
  132719. * you wish in the ground reflection.
  132720. */
  132721. get groundMirrorRenderList(): Nullable<AbstractMesh[]>;
  132722. private _groundMaterial;
  132723. /**
  132724. * Gets the ground material created by the helper.
  132725. */
  132726. get groundMaterial(): Nullable<BackgroundMaterial>;
  132727. /**
  132728. * Stores the creation options.
  132729. */
  132730. private readonly _scene;
  132731. private _options;
  132732. /**
  132733. * This observable will be notified with any error during the creation of the environment,
  132734. * mainly texture creation errors.
  132735. */
  132736. onErrorObservable: Observable<{
  132737. message?: string;
  132738. exception?: any;
  132739. }>;
  132740. /**
  132741. * constructor
  132742. * @param options Defines the options we want to customize the helper
  132743. * @param scene The scene to add the material to
  132744. */
  132745. constructor(options: Partial<IEnvironmentHelperOptions>, scene: Scene);
  132746. /**
  132747. * Updates the background according to the new options
  132748. * @param options
  132749. */
  132750. updateOptions(options: Partial<IEnvironmentHelperOptions>): void;
  132751. /**
  132752. * Sets the primary color of all the available elements.
  132753. * @param color the main color to affect to the ground and the background
  132754. */
  132755. setMainColor(color: Color3): void;
  132756. /**
  132757. * Setup the image processing according to the specified options.
  132758. */
  132759. private _setupImageProcessing;
  132760. /**
  132761. * Setup the environment texture according to the specified options.
  132762. */
  132763. private _setupEnvironmentTexture;
  132764. /**
  132765. * Setup the background according to the specified options.
  132766. */
  132767. private _setupBackground;
  132768. /**
  132769. * Get the scene sizes according to the setup.
  132770. */
  132771. private _getSceneSize;
  132772. /**
  132773. * Setup the ground according to the specified options.
  132774. */
  132775. private _setupGround;
  132776. /**
  132777. * Setup the ground material according to the specified options.
  132778. */
  132779. private _setupGroundMaterial;
  132780. /**
  132781. * Setup the ground diffuse texture according to the specified options.
  132782. */
  132783. private _setupGroundDiffuseTexture;
  132784. /**
  132785. * Setup the ground mirror texture according to the specified options.
  132786. */
  132787. private _setupGroundMirrorTexture;
  132788. /**
  132789. * Setup the ground to receive the mirror texture.
  132790. */
  132791. private _setupMirrorInGroundMaterial;
  132792. /**
  132793. * Setup the skybox according to the specified options.
  132794. */
  132795. private _setupSkybox;
  132796. /**
  132797. * Setup the skybox material according to the specified options.
  132798. */
  132799. private _setupSkyboxMaterial;
  132800. /**
  132801. * Setup the skybox reflection texture according to the specified options.
  132802. */
  132803. private _setupSkyboxReflectionTexture;
  132804. private _errorHandler;
  132805. /**
  132806. * Dispose all the elements created by the Helper.
  132807. */
  132808. dispose(): void;
  132809. }
  132810. }
  132811. declare module BABYLON {
  132812. /**
  132813. * Display a 360 degree photo on an approximately spherical surface, useful for VR applications or skyboxes.
  132814. * As a subclass of TransformNode, this allow parenting to the camera with different locations in the scene.
  132815. * This class achieves its effect with a Texture and a correctly configured BackgroundMaterial on an inverted sphere.
  132816. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  132817. */
  132818. export class PhotoDome extends TransformNode {
  132819. /**
  132820. * Define the image as a Monoscopic panoramic 360 image.
  132821. */
  132822. static readonly MODE_MONOSCOPIC: number;
  132823. /**
  132824. * Define the image as a Stereoscopic TopBottom/OverUnder panoramic 360 image.
  132825. */
  132826. static readonly MODE_TOPBOTTOM: number;
  132827. /**
  132828. * Define the image as a Stereoscopic Side by Side panoramic 360 image.
  132829. */
  132830. static readonly MODE_SIDEBYSIDE: number;
  132831. private _useDirectMapping;
  132832. /**
  132833. * The texture being displayed on the sphere
  132834. */
  132835. protected _photoTexture: Texture;
  132836. /**
  132837. * Gets or sets the texture being displayed on the sphere
  132838. */
  132839. get photoTexture(): Texture;
  132840. set photoTexture(value: Texture);
  132841. /**
  132842. * Observable raised when an error occured while loading the 360 image
  132843. */
  132844. onLoadErrorObservable: Observable<string>;
  132845. /**
  132846. * The skybox material
  132847. */
  132848. protected _material: BackgroundMaterial;
  132849. /**
  132850. * The surface used for the skybox
  132851. */
  132852. protected _mesh: Mesh;
  132853. /**
  132854. * Gets the mesh used for the skybox.
  132855. */
  132856. get mesh(): Mesh;
  132857. /**
  132858. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  132859. * Also see the options.resolution property.
  132860. */
  132861. get fovMultiplier(): number;
  132862. set fovMultiplier(value: number);
  132863. private _imageMode;
  132864. /**
  132865. * Gets or set the current video mode for the video. It can be:
  132866. * * PhotoDome.MODE_MONOSCOPIC : Define the image as a Monoscopic panoramic 360 image.
  132867. * * PhotoDome.MODE_TOPBOTTOM : Define the image as a Stereoscopic TopBottom/OverUnder panoramic 360 image.
  132868. * * PhotoDome.MODE_SIDEBYSIDE : Define the image as a Stereoscopic Side by Side panoramic 360 image.
  132869. */
  132870. get imageMode(): number;
  132871. set imageMode(value: number);
  132872. /**
  132873. * Create an instance of this class and pass through the parameters to the relevant classes, Texture, StandardMaterial, and Mesh.
  132874. * @param name Element's name, child elements will append suffixes for their own names.
  132875. * @param urlsOfPhoto defines the url of the photo to display
  132876. * @param options defines an object containing optional or exposed sub element properties
  132877. * @param onError defines a callback called when an error occured while loading the texture
  132878. */
  132879. constructor(name: string, urlOfPhoto: string, options: {
  132880. resolution?: number;
  132881. size?: number;
  132882. useDirectMapping?: boolean;
  132883. faceForward?: boolean;
  132884. }, scene: Scene, onError?: Nullable<(message?: string, exception?: any) => void>);
  132885. private _onBeforeCameraRenderObserver;
  132886. private _changeImageMode;
  132887. /**
  132888. * Releases resources associated with this node.
  132889. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  132890. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  132891. */
  132892. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  132893. }
  132894. }
  132895. declare module BABYLON {
  132896. /**
  132897. * Class used to host RGBD texture specific utilities
  132898. */
  132899. export class RGBDTextureTools {
  132900. /**
  132901. * Expand the RGBD Texture from RGBD to Half Float if possible.
  132902. * @param texture the texture to expand.
  132903. */
  132904. static ExpandRGBDTexture(texture: Texture): void;
  132905. }
  132906. }
  132907. declare module BABYLON {
  132908. /**
  132909. * Class used to host texture specific utilities
  132910. */
  132911. export class BRDFTextureTools {
  132912. /**
  132913. * Prevents texture cache collision
  132914. */
  132915. private static _instanceNumber;
  132916. /**
  132917. * Gets a default environment BRDF for MS-BRDF Height Correlated BRDF
  132918. * @param scene defines the hosting scene
  132919. * @returns the environment BRDF texture
  132920. */
  132921. static GetEnvironmentBRDFTexture(scene: Scene): BaseTexture;
  132922. private static _environmentBRDFBase64Texture;
  132923. }
  132924. }
  132925. declare module BABYLON {
  132926. /**
  132927. * @hidden
  132928. */
  132929. export interface IMaterialClearCoatDefines {
  132930. CLEARCOAT: boolean;
  132931. CLEARCOAT_DEFAULTIOR: boolean;
  132932. CLEARCOAT_TEXTURE: boolean;
  132933. CLEARCOAT_TEXTUREDIRECTUV: number;
  132934. CLEARCOAT_BUMP: boolean;
  132935. CLEARCOAT_BUMPDIRECTUV: number;
  132936. CLEARCOAT_TINT: boolean;
  132937. CLEARCOAT_TINT_TEXTURE: boolean;
  132938. CLEARCOAT_TINT_TEXTUREDIRECTUV: number;
  132939. /** @hidden */
  132940. _areTexturesDirty: boolean;
  132941. }
  132942. /**
  132943. * Define the code related to the clear coat parameters of the pbr material.
  132944. */
  132945. export class PBRClearCoatConfiguration {
  132946. /**
  132947. * This defaults to 1.5 corresponding to a 0.04 f0 or a 4% reflectance at normal incidence
  132948. * The default fits with a polyurethane material.
  132949. */
  132950. private static readonly _DefaultIndexOfRefraction;
  132951. private _isEnabled;
  132952. /**
  132953. * Defines if the clear coat is enabled in the material.
  132954. */
  132955. isEnabled: boolean;
  132956. /**
  132957. * Defines the clear coat layer strength (between 0 and 1) it defaults to 1.
  132958. */
  132959. intensity: number;
  132960. /**
  132961. * Defines the clear coat layer roughness.
  132962. */
  132963. roughness: number;
  132964. private _indexOfRefraction;
  132965. /**
  132966. * Defines the index of refraction of the clear coat.
  132967. * This defaults to 1.5 corresponding to a 0.04 f0 or a 4% reflectance at normal incidence
  132968. * The default fits with a polyurethane material.
  132969. * Changing the default value is more performance intensive.
  132970. */
  132971. indexOfRefraction: number;
  132972. private _texture;
  132973. /**
  132974. * Stores the clear coat values in a texture.
  132975. */
  132976. texture: Nullable<BaseTexture>;
  132977. private _bumpTexture;
  132978. /**
  132979. * Define the clear coat specific bump texture.
  132980. */
  132981. bumpTexture: Nullable<BaseTexture>;
  132982. private _isTintEnabled;
  132983. /**
  132984. * Defines if the clear coat tint is enabled in the material.
  132985. */
  132986. isTintEnabled: boolean;
  132987. /**
  132988. * Defines the clear coat tint of the material.
  132989. * This is only use if tint is enabled
  132990. */
  132991. tintColor: Color3;
  132992. /**
  132993. * Defines the distance at which the tint color should be found in the
  132994. * clear coat media.
  132995. * This is only use if tint is enabled
  132996. */
  132997. tintColorAtDistance: number;
  132998. /**
  132999. * Defines the clear coat layer thickness.
  133000. * This is only use if tint is enabled
  133001. */
  133002. tintThickness: number;
  133003. private _tintTexture;
  133004. /**
  133005. * Stores the clear tint values in a texture.
  133006. * rgb is tint
  133007. * a is a thickness factor
  133008. */
  133009. tintTexture: Nullable<BaseTexture>;
  133010. /** @hidden */
  133011. private _internalMarkAllSubMeshesAsTexturesDirty;
  133012. /** @hidden */
  133013. _markAllSubMeshesAsTexturesDirty(): void;
  133014. /**
  133015. * Instantiate a new istance of clear coat configuration.
  133016. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  133017. */
  133018. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  133019. /**
  133020. * Gets wehter the submesh is ready to be used or not.
  133021. * @param defines the list of "defines" to update.
  133022. * @param scene defines the scene the material belongs to.
  133023. * @param engine defines the engine the material belongs to.
  133024. * @param disableBumpMap defines wether the material disables bump or not.
  133025. * @returns - boolean indicating that the submesh is ready or not.
  133026. */
  133027. isReadyForSubMesh(defines: IMaterialClearCoatDefines, scene: Scene, engine: Engine, disableBumpMap: boolean): boolean;
  133028. /**
  133029. * Checks to see if a texture is used in the material.
  133030. * @param defines the list of "defines" to update.
  133031. * @param scene defines the scene to the material belongs to.
  133032. */
  133033. prepareDefines(defines: IMaterialClearCoatDefines, scene: Scene): void;
  133034. /**
  133035. * Binds the material data.
  133036. * @param uniformBuffer defines the Uniform buffer to fill in.
  133037. * @param scene defines the scene the material belongs to.
  133038. * @param engine defines the engine the material belongs to.
  133039. * @param disableBumpMap defines wether the material disables bump or not.
  133040. * @param isFrozen defines wether the material is frozen or not.
  133041. * @param invertNormalMapX If sets to true, x component of normal map value will be inverted (x = 1.0 - x).
  133042. * @param invertNormalMapY If sets to true, y component of normal map value will be inverted (y = 1.0 - y).
  133043. */
  133044. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, engine: Engine, disableBumpMap: boolean, isFrozen: boolean, invertNormalMapX: boolean, invertNormalMapY: boolean): void;
  133045. /**
  133046. * Checks to see if a texture is used in the material.
  133047. * @param texture - Base texture to use.
  133048. * @returns - Boolean specifying if a texture is used in the material.
  133049. */
  133050. hasTexture(texture: BaseTexture): boolean;
  133051. /**
  133052. * Returns an array of the actively used textures.
  133053. * @param activeTextures Array of BaseTextures
  133054. */
  133055. getActiveTextures(activeTextures: BaseTexture[]): void;
  133056. /**
  133057. * Returns the animatable textures.
  133058. * @param animatables Array of animatable textures.
  133059. */
  133060. getAnimatables(animatables: IAnimatable[]): void;
  133061. /**
  133062. * Disposes the resources of the material.
  133063. * @param forceDisposeTextures - Forces the disposal of all textures.
  133064. */
  133065. dispose(forceDisposeTextures?: boolean): void;
  133066. /**
  133067. * Get the current class name of the texture useful for serialization or dynamic coding.
  133068. * @returns "PBRClearCoatConfiguration"
  133069. */
  133070. getClassName(): string;
  133071. /**
  133072. * Add fallbacks to the effect fallbacks list.
  133073. * @param defines defines the Base texture to use.
  133074. * @param fallbacks defines the current fallback list.
  133075. * @param currentRank defines the current fallback rank.
  133076. * @returns the new fallback rank.
  133077. */
  133078. static AddFallbacks(defines: IMaterialClearCoatDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  133079. /**
  133080. * Add the required uniforms to the current list.
  133081. * @param uniforms defines the current uniform list.
  133082. */
  133083. static AddUniforms(uniforms: string[]): void;
  133084. /**
  133085. * Add the required samplers to the current list.
  133086. * @param samplers defines the current sampler list.
  133087. */
  133088. static AddSamplers(samplers: string[]): void;
  133089. /**
  133090. * Add the required uniforms to the current buffer.
  133091. * @param uniformBuffer defines the current uniform buffer.
  133092. */
  133093. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  133094. /**
  133095. * Makes a duplicate of the current configuration into another one.
  133096. * @param clearCoatConfiguration define the config where to copy the info
  133097. */
  133098. copyTo(clearCoatConfiguration: PBRClearCoatConfiguration): void;
  133099. /**
  133100. * Serializes this clear coat configuration.
  133101. * @returns - An object with the serialized config.
  133102. */
  133103. serialize(): any;
  133104. /**
  133105. * Parses a anisotropy Configuration from a serialized object.
  133106. * @param source - Serialized object.
  133107. * @param scene Defines the scene we are parsing for
  133108. * @param rootUrl Defines the rootUrl to load from
  133109. */
  133110. parse(source: any, scene: Scene, rootUrl: string): void;
  133111. }
  133112. }
  133113. declare module BABYLON {
  133114. /**
  133115. * @hidden
  133116. */
  133117. export interface IMaterialAnisotropicDefines {
  133118. ANISOTROPIC: boolean;
  133119. ANISOTROPIC_TEXTURE: boolean;
  133120. ANISOTROPIC_TEXTUREDIRECTUV: number;
  133121. MAINUV1: boolean;
  133122. _areTexturesDirty: boolean;
  133123. _needUVs: boolean;
  133124. }
  133125. /**
  133126. * Define the code related to the anisotropic parameters of the pbr material.
  133127. */
  133128. export class PBRAnisotropicConfiguration {
  133129. private _isEnabled;
  133130. /**
  133131. * Defines if the anisotropy is enabled in the material.
  133132. */
  133133. isEnabled: boolean;
  133134. /**
  133135. * Defines the anisotropy strength (between 0 and 1) it defaults to 1.
  133136. */
  133137. intensity: number;
  133138. /**
  133139. * Defines if the effect is along the tangents, bitangents or in between.
  133140. * By default, the effect is "strectching" the highlights along the tangents.
  133141. */
  133142. direction: Vector2;
  133143. private _texture;
  133144. /**
  133145. * Stores the anisotropy values in a texture.
  133146. * rg is direction (like normal from -1 to 1)
  133147. * b is a intensity
  133148. */
  133149. texture: Nullable<BaseTexture>;
  133150. /** @hidden */
  133151. private _internalMarkAllSubMeshesAsTexturesDirty;
  133152. /** @hidden */
  133153. _markAllSubMeshesAsTexturesDirty(): void;
  133154. /**
  133155. * Instantiate a new istance of anisotropy configuration.
  133156. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  133157. */
  133158. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  133159. /**
  133160. * Specifies that the submesh is ready to be used.
  133161. * @param defines the list of "defines" to update.
  133162. * @param scene defines the scene the material belongs to.
  133163. * @returns - boolean indicating that the submesh is ready or not.
  133164. */
  133165. isReadyForSubMesh(defines: IMaterialAnisotropicDefines, scene: Scene): boolean;
  133166. /**
  133167. * Checks to see if a texture is used in the material.
  133168. * @param defines the list of "defines" to update.
  133169. * @param mesh the mesh we are preparing the defines for.
  133170. * @param scene defines the scene the material belongs to.
  133171. */
  133172. prepareDefines(defines: IMaterialAnisotropicDefines, mesh: AbstractMesh, scene: Scene): void;
  133173. /**
  133174. * Binds the material data.
  133175. * @param uniformBuffer defines the Uniform buffer to fill in.
  133176. * @param scene defines the scene the material belongs to.
  133177. * @param isFrozen defines wether the material is frozen or not.
  133178. */
  133179. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  133180. /**
  133181. * Checks to see if a texture is used in the material.
  133182. * @param texture - Base texture to use.
  133183. * @returns - Boolean specifying if a texture is used in the material.
  133184. */
  133185. hasTexture(texture: BaseTexture): boolean;
  133186. /**
  133187. * Returns an array of the actively used textures.
  133188. * @param activeTextures Array of BaseTextures
  133189. */
  133190. getActiveTextures(activeTextures: BaseTexture[]): void;
  133191. /**
  133192. * Returns the animatable textures.
  133193. * @param animatables Array of animatable textures.
  133194. */
  133195. getAnimatables(animatables: IAnimatable[]): void;
  133196. /**
  133197. * Disposes the resources of the material.
  133198. * @param forceDisposeTextures - Forces the disposal of all textures.
  133199. */
  133200. dispose(forceDisposeTextures?: boolean): void;
  133201. /**
  133202. * Get the current class name of the texture useful for serialization or dynamic coding.
  133203. * @returns "PBRAnisotropicConfiguration"
  133204. */
  133205. getClassName(): string;
  133206. /**
  133207. * Add fallbacks to the effect fallbacks list.
  133208. * @param defines defines the Base texture to use.
  133209. * @param fallbacks defines the current fallback list.
  133210. * @param currentRank defines the current fallback rank.
  133211. * @returns the new fallback rank.
  133212. */
  133213. static AddFallbacks(defines: IMaterialAnisotropicDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  133214. /**
  133215. * Add the required uniforms to the current list.
  133216. * @param uniforms defines the current uniform list.
  133217. */
  133218. static AddUniforms(uniforms: string[]): void;
  133219. /**
  133220. * Add the required uniforms to the current buffer.
  133221. * @param uniformBuffer defines the current uniform buffer.
  133222. */
  133223. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  133224. /**
  133225. * Add the required samplers to the current list.
  133226. * @param samplers defines the current sampler list.
  133227. */
  133228. static AddSamplers(samplers: string[]): void;
  133229. /**
  133230. * Makes a duplicate of the current configuration into another one.
  133231. * @param anisotropicConfiguration define the config where to copy the info
  133232. */
  133233. copyTo(anisotropicConfiguration: PBRAnisotropicConfiguration): void;
  133234. /**
  133235. * Serializes this anisotropy configuration.
  133236. * @returns - An object with the serialized config.
  133237. */
  133238. serialize(): any;
  133239. /**
  133240. * Parses a anisotropy Configuration from a serialized object.
  133241. * @param source - Serialized object.
  133242. * @param scene Defines the scene we are parsing for
  133243. * @param rootUrl Defines the rootUrl to load from
  133244. */
  133245. parse(source: any, scene: Scene, rootUrl: string): void;
  133246. }
  133247. }
  133248. declare module BABYLON {
  133249. /**
  133250. * @hidden
  133251. */
  133252. export interface IMaterialBRDFDefines {
  133253. BRDF_V_HEIGHT_CORRELATED: boolean;
  133254. MS_BRDF_ENERGY_CONSERVATION: boolean;
  133255. SPHERICAL_HARMONICS: boolean;
  133256. SPECULAR_GLOSSINESS_ENERGY_CONSERVATION: boolean;
  133257. /** @hidden */
  133258. _areMiscDirty: boolean;
  133259. }
  133260. /**
  133261. * Define the code related to the BRDF parameters of the pbr material.
  133262. */
  133263. export class PBRBRDFConfiguration {
  133264. /**
  133265. * Default value used for the energy conservation.
  133266. * This should only be changed to adapt to the type of texture in scene.environmentBRDFTexture.
  133267. */
  133268. static DEFAULT_USE_ENERGY_CONSERVATION: boolean;
  133269. /**
  133270. * Default value used for the Smith Visibility Height Correlated mode.
  133271. * This should only be changed to adapt to the type of texture in scene.environmentBRDFTexture.
  133272. */
  133273. static DEFAULT_USE_SMITH_VISIBILITY_HEIGHT_CORRELATED: boolean;
  133274. /**
  133275. * Default value used for the IBL diffuse part.
  133276. * This can help switching back to the polynomials mode globally which is a tiny bit
  133277. * less GPU intensive at the drawback of a lower quality.
  133278. */
  133279. static DEFAULT_USE_SPHERICAL_HARMONICS: boolean;
  133280. /**
  133281. * Default value used for activating energy conservation for the specular workflow.
  133282. * If activated, the albedo color is multiplied with (1. - maxChannel(specular color)).
  133283. * If deactivated, a material is only physically plausible, when (albedo color + specular color) < 1.
  133284. */
  133285. static DEFAULT_USE_SPECULAR_GLOSSINESS_INPUT_ENERGY_CONSERVATION: boolean;
  133286. private _useEnergyConservation;
  133287. /**
  133288. * Defines if the material uses energy conservation.
  133289. */
  133290. useEnergyConservation: boolean;
  133291. private _useSmithVisibilityHeightCorrelated;
  133292. /**
  133293. * LEGACY Mode set to false
  133294. * Defines if the material uses height smith correlated visibility term.
  133295. * If you intent to not use our default BRDF, you need to load a separate BRDF Texture for the PBR
  133296. * You can either load https://assets.babylonjs.com/environments/uncorrelatedBRDF.png
  133297. * or https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds to have more precision
  133298. * Not relying on height correlated will also disable energy conservation.
  133299. */
  133300. useSmithVisibilityHeightCorrelated: boolean;
  133301. private _useSphericalHarmonics;
  133302. /**
  133303. * LEGACY Mode set to false
  133304. * Defines if the material uses spherical harmonics vs spherical polynomials for the
  133305. * diffuse part of the IBL.
  133306. * The harmonics despite a tiny bigger cost has been proven to provide closer results
  133307. * to the ground truth.
  133308. */
  133309. useSphericalHarmonics: boolean;
  133310. private _useSpecularGlossinessInputEnergyConservation;
  133311. /**
  133312. * Defines if the material uses energy conservation, when the specular workflow is active.
  133313. * If activated, the albedo color is multiplied with (1. - maxChannel(specular color)).
  133314. * If deactivated, a material is only physically plausible, when (albedo color + specular color) < 1.
  133315. * In the deactivated case, the material author has to ensure energy conservation, for a physically plausible rendering.
  133316. */
  133317. useSpecularGlossinessInputEnergyConservation: boolean;
  133318. /** @hidden */
  133319. private _internalMarkAllSubMeshesAsMiscDirty;
  133320. /** @hidden */
  133321. _markAllSubMeshesAsMiscDirty(): void;
  133322. /**
  133323. * Instantiate a new istance of clear coat configuration.
  133324. * @param markAllSubMeshesAsMiscDirty Callback to flag the material to dirty
  133325. */
  133326. constructor(markAllSubMeshesAsMiscDirty: () => void);
  133327. /**
  133328. * Checks to see if a texture is used in the material.
  133329. * @param defines the list of "defines" to update.
  133330. */
  133331. prepareDefines(defines: IMaterialBRDFDefines): void;
  133332. /**
  133333. * Get the current class name of the texture useful for serialization or dynamic coding.
  133334. * @returns "PBRClearCoatConfiguration"
  133335. */
  133336. getClassName(): string;
  133337. /**
  133338. * Makes a duplicate of the current configuration into another one.
  133339. * @param brdfConfiguration define the config where to copy the info
  133340. */
  133341. copyTo(brdfConfiguration: PBRBRDFConfiguration): void;
  133342. /**
  133343. * Serializes this BRDF configuration.
  133344. * @returns - An object with the serialized config.
  133345. */
  133346. serialize(): any;
  133347. /**
  133348. * Parses a anisotropy Configuration from a serialized object.
  133349. * @param source - Serialized object.
  133350. * @param scene Defines the scene we are parsing for
  133351. * @param rootUrl Defines the rootUrl to load from
  133352. */
  133353. parse(source: any, scene: Scene, rootUrl: string): void;
  133354. }
  133355. }
  133356. declare module BABYLON {
  133357. /**
  133358. * @hidden
  133359. */
  133360. export interface IMaterialSheenDefines {
  133361. SHEEN: boolean;
  133362. SHEEN_TEXTURE: boolean;
  133363. SHEEN_TEXTUREDIRECTUV: number;
  133364. SHEEN_LINKWITHALBEDO: boolean;
  133365. SHEEN_ROUGHNESS: boolean;
  133366. SHEEN_ALBEDOSCALING: boolean;
  133367. /** @hidden */
  133368. _areTexturesDirty: boolean;
  133369. }
  133370. /**
  133371. * Define the code related to the Sheen parameters of the pbr material.
  133372. */
  133373. export class PBRSheenConfiguration {
  133374. private _isEnabled;
  133375. /**
  133376. * Defines if the material uses sheen.
  133377. */
  133378. isEnabled: boolean;
  133379. private _linkSheenWithAlbedo;
  133380. /**
  133381. * Defines if the sheen is linked to the sheen color.
  133382. */
  133383. linkSheenWithAlbedo: boolean;
  133384. /**
  133385. * Defines the sheen intensity.
  133386. */
  133387. intensity: number;
  133388. /**
  133389. * Defines the sheen color.
  133390. */
  133391. color: Color3;
  133392. private _texture;
  133393. /**
  133394. * Stores the sheen tint values in a texture.
  133395. * rgb is tint
  133396. * a is a intensity or roughness if roughness has been defined
  133397. */
  133398. texture: Nullable<BaseTexture>;
  133399. private _roughness;
  133400. /**
  133401. * Defines the sheen roughness.
  133402. * It is not taken into account if linkSheenWithAlbedo is true.
  133403. * To stay backward compatible, material roughness is used instead if sheen roughness = null
  133404. */
  133405. roughness: Nullable<number>;
  133406. private _albedoScaling;
  133407. /**
  133408. * If true, the sheen effect is layered above the base BRDF with the albedo-scaling technique.
  133409. * It allows the strength of the sheen effect to not depend on the base color of the material,
  133410. * making it easier to setup and tweak the effect
  133411. */
  133412. albedoScaling: boolean;
  133413. /** @hidden */
  133414. private _internalMarkAllSubMeshesAsTexturesDirty;
  133415. /** @hidden */
  133416. _markAllSubMeshesAsTexturesDirty(): void;
  133417. /**
  133418. * Instantiate a new istance of clear coat configuration.
  133419. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  133420. */
  133421. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  133422. /**
  133423. * Specifies that the submesh is ready to be used.
  133424. * @param defines the list of "defines" to update.
  133425. * @param scene defines the scene the material belongs to.
  133426. * @returns - boolean indicating that the submesh is ready or not.
  133427. */
  133428. isReadyForSubMesh(defines: IMaterialSheenDefines, scene: Scene): boolean;
  133429. /**
  133430. * Checks to see if a texture is used in the material.
  133431. * @param defines the list of "defines" to update.
  133432. * @param scene defines the scene the material belongs to.
  133433. */
  133434. prepareDefines(defines: IMaterialSheenDefines, scene: Scene): void;
  133435. /**
  133436. * Binds the material data.
  133437. * @param uniformBuffer defines the Uniform buffer to fill in.
  133438. * @param scene defines the scene the material belongs to.
  133439. * @param isFrozen defines wether the material is frozen or not.
  133440. */
  133441. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  133442. /**
  133443. * Checks to see if a texture is used in the material.
  133444. * @param texture - Base texture to use.
  133445. * @returns - Boolean specifying if a texture is used in the material.
  133446. */
  133447. hasTexture(texture: BaseTexture): boolean;
  133448. /**
  133449. * Returns an array of the actively used textures.
  133450. * @param activeTextures Array of BaseTextures
  133451. */
  133452. getActiveTextures(activeTextures: BaseTexture[]): void;
  133453. /**
  133454. * Returns the animatable textures.
  133455. * @param animatables Array of animatable textures.
  133456. */
  133457. getAnimatables(animatables: IAnimatable[]): void;
  133458. /**
  133459. * Disposes the resources of the material.
  133460. * @param forceDisposeTextures - Forces the disposal of all textures.
  133461. */
  133462. dispose(forceDisposeTextures?: boolean): void;
  133463. /**
  133464. * Get the current class name of the texture useful for serialization or dynamic coding.
  133465. * @returns "PBRSheenConfiguration"
  133466. */
  133467. getClassName(): string;
  133468. /**
  133469. * Add fallbacks to the effect fallbacks list.
  133470. * @param defines defines the Base texture to use.
  133471. * @param fallbacks defines the current fallback list.
  133472. * @param currentRank defines the current fallback rank.
  133473. * @returns the new fallback rank.
  133474. */
  133475. static AddFallbacks(defines: IMaterialSheenDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  133476. /**
  133477. * Add the required uniforms to the current list.
  133478. * @param uniforms defines the current uniform list.
  133479. */
  133480. static AddUniforms(uniforms: string[]): void;
  133481. /**
  133482. * Add the required uniforms to the current buffer.
  133483. * @param uniformBuffer defines the current uniform buffer.
  133484. */
  133485. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  133486. /**
  133487. * Add the required samplers to the current list.
  133488. * @param samplers defines the current sampler list.
  133489. */
  133490. static AddSamplers(samplers: string[]): void;
  133491. /**
  133492. * Makes a duplicate of the current configuration into another one.
  133493. * @param sheenConfiguration define the config where to copy the info
  133494. */
  133495. copyTo(sheenConfiguration: PBRSheenConfiguration): void;
  133496. /**
  133497. * Serializes this BRDF configuration.
  133498. * @returns - An object with the serialized config.
  133499. */
  133500. serialize(): any;
  133501. /**
  133502. * Parses a anisotropy Configuration from a serialized object.
  133503. * @param source - Serialized object.
  133504. * @param scene Defines the scene we are parsing for
  133505. * @param rootUrl Defines the rootUrl to load from
  133506. */
  133507. parse(source: any, scene: Scene, rootUrl: string): void;
  133508. }
  133509. }
  133510. declare module BABYLON {
  133511. /**
  133512. * @hidden
  133513. */
  133514. export interface IMaterialSubSurfaceDefines {
  133515. SUBSURFACE: boolean;
  133516. SS_REFRACTION: boolean;
  133517. SS_TRANSLUCENCY: boolean;
  133518. SS_SCATTERING: boolean;
  133519. SS_THICKNESSANDMASK_TEXTURE: boolean;
  133520. SS_THICKNESSANDMASK_TEXTUREDIRECTUV: number;
  133521. SS_REFRACTIONMAP_3D: boolean;
  133522. SS_REFRACTIONMAP_OPPOSITEZ: boolean;
  133523. SS_LODINREFRACTIONALPHA: boolean;
  133524. SS_GAMMAREFRACTION: boolean;
  133525. SS_RGBDREFRACTION: boolean;
  133526. SS_LINEARSPECULARREFRACTION: boolean;
  133527. SS_LINKREFRACTIONTOTRANSPARENCY: boolean;
  133528. SS_ALBEDOFORREFRACTIONTINT: boolean;
  133529. SS_MASK_FROM_THICKNESS_TEXTURE: boolean;
  133530. /** @hidden */
  133531. _areTexturesDirty: boolean;
  133532. }
  133533. /**
  133534. * Define the code related to the sub surface parameters of the pbr material.
  133535. */
  133536. export class PBRSubSurfaceConfiguration {
  133537. private _isRefractionEnabled;
  133538. /**
  133539. * Defines if the refraction is enabled in the material.
  133540. */
  133541. isRefractionEnabled: boolean;
  133542. private _isTranslucencyEnabled;
  133543. /**
  133544. * Defines if the translucency is enabled in the material.
  133545. */
  133546. isTranslucencyEnabled: boolean;
  133547. private _isScatteringEnabled;
  133548. /**
  133549. * Defines if the sub surface scattering is enabled in the material.
  133550. */
  133551. isScatteringEnabled: boolean;
  133552. private _scatteringDiffusionProfileIndex;
  133553. /**
  133554. * Diffusion profile for subsurface scattering.
  133555. * Useful for better scattering in the skins or foliages.
  133556. */
  133557. get scatteringDiffusionProfile(): Nullable<Color3>;
  133558. set scatteringDiffusionProfile(c: Nullable<Color3>);
  133559. /**
  133560. * Defines the refraction intensity of the material.
  133561. * The refraction when enabled replaces the Diffuse part of the material.
  133562. * The intensity helps transitionning between diffuse and refraction.
  133563. */
  133564. refractionIntensity: number;
  133565. /**
  133566. * Defines the translucency intensity of the material.
  133567. * When translucency has been enabled, this defines how much of the "translucency"
  133568. * is addded to the diffuse part of the material.
  133569. */
  133570. translucencyIntensity: number;
  133571. /**
  133572. * When enabled, transparent surfaces will be tinted with the albedo colour (independent of thickness)
  133573. */
  133574. useAlbedoToTintRefraction: boolean;
  133575. private _thicknessTexture;
  133576. /**
  133577. * Stores the average thickness of a mesh in a texture (The texture is holding the values linearly).
  133578. * The red channel of the texture should contain the thickness remapped between 0 and 1.
  133579. * 0 would mean minimumThickness
  133580. * 1 would mean maximumThickness
  133581. * The other channels might be use as a mask to vary the different effects intensity.
  133582. */
  133583. thicknessTexture: Nullable<BaseTexture>;
  133584. private _refractionTexture;
  133585. /**
  133586. * Defines the texture to use for refraction.
  133587. */
  133588. refractionTexture: Nullable<BaseTexture>;
  133589. private _indexOfRefraction;
  133590. /**
  133591. * Index of refraction of the material base layer.
  133592. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  133593. *
  133594. * This does not only impact refraction but also the Base F0 of Dielectric Materials.
  133595. *
  133596. * From dielectric fresnel rules: F0 = square((iorT - iorI) / (iorT + iorI))
  133597. */
  133598. indexOfRefraction: number;
  133599. private _volumeIndexOfRefraction;
  133600. /**
  133601. * Index of refraction of the material's volume.
  133602. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  133603. *
  133604. * This ONLY impacts refraction. If not provided or given a non-valid value,
  133605. * the volume will use the same IOR as the surface.
  133606. */
  133607. get volumeIndexOfRefraction(): number;
  133608. set volumeIndexOfRefraction(value: number);
  133609. private _invertRefractionY;
  133610. /**
  133611. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  133612. */
  133613. invertRefractionY: boolean;
  133614. private _linkRefractionWithTransparency;
  133615. /**
  133616. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  133617. * Materials half opaque for instance using refraction could benefit from this control.
  133618. */
  133619. linkRefractionWithTransparency: boolean;
  133620. /**
  133621. * Defines the minimum thickness stored in the thickness map.
  133622. * If no thickness map is defined, this value will be used to simulate thickness.
  133623. */
  133624. minimumThickness: number;
  133625. /**
  133626. * Defines the maximum thickness stored in the thickness map.
  133627. */
  133628. maximumThickness: number;
  133629. /**
  133630. * Defines the volume tint of the material.
  133631. * This is used for both translucency and scattering.
  133632. */
  133633. tintColor: Color3;
  133634. /**
  133635. * Defines the distance at which the tint color should be found in the media.
  133636. * This is used for refraction only.
  133637. */
  133638. tintColorAtDistance: number;
  133639. /**
  133640. * Defines how far each channel transmit through the media.
  133641. * It is defined as a color to simplify it selection.
  133642. */
  133643. diffusionDistance: Color3;
  133644. private _useMaskFromThicknessTexture;
  133645. /**
  133646. * Stores the intensity of the different subsurface effects in the thickness texture.
  133647. * * the green channel is the translucency intensity.
  133648. * * the blue channel is the scattering intensity.
  133649. * * the alpha channel is the refraction intensity.
  133650. */
  133651. useMaskFromThicknessTexture: boolean;
  133652. private _scene;
  133653. /** @hidden */
  133654. private _internalMarkAllSubMeshesAsTexturesDirty;
  133655. private _internalMarkScenePrePassDirty;
  133656. /** @hidden */
  133657. _markAllSubMeshesAsTexturesDirty(): void;
  133658. /** @hidden */
  133659. _markScenePrePassDirty(): void;
  133660. /**
  133661. * Instantiate a new istance of sub surface configuration.
  133662. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  133663. * @param markScenePrePassDirty Callback to flag the scene as prepass dirty
  133664. * @param scene The scene
  133665. */
  133666. constructor(markAllSubMeshesAsTexturesDirty: () => void, markScenePrePassDirty: () => void, scene: Scene);
  133667. /**
  133668. * Gets wehter the submesh is ready to be used or not.
  133669. * @param defines the list of "defines" to update.
  133670. * @param scene defines the scene the material belongs to.
  133671. * @returns - boolean indicating that the submesh is ready or not.
  133672. */
  133673. isReadyForSubMesh(defines: IMaterialSubSurfaceDefines, scene: Scene): boolean;
  133674. /**
  133675. * Checks to see if a texture is used in the material.
  133676. * @param defines the list of "defines" to update.
  133677. * @param scene defines the scene to the material belongs to.
  133678. */
  133679. prepareDefines(defines: IMaterialSubSurfaceDefines, scene: Scene): void;
  133680. /**
  133681. * Binds the material data.
  133682. * @param uniformBuffer defines the Uniform buffer to fill in.
  133683. * @param scene defines the scene the material belongs to.
  133684. * @param engine defines the engine the material belongs to.
  133685. * @param isFrozen defines whether the material is frozen or not.
  133686. * @param lodBasedMicrosurface defines whether the material relies on lod based microsurface or not.
  133687. * @param realTimeFiltering defines whether the textures should be filtered on the fly.
  133688. */
  133689. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, engine: Engine, isFrozen: boolean, lodBasedMicrosurface: boolean, realTimeFiltering: boolean): void;
  133690. /**
  133691. * Unbinds the material from the mesh.
  133692. * @param activeEffect defines the effect that should be unbound from.
  133693. * @returns true if unbound, otherwise false
  133694. */
  133695. unbind(activeEffect: Effect): boolean;
  133696. /**
  133697. * Returns the texture used for refraction or null if none is used.
  133698. * @param scene defines the scene the material belongs to.
  133699. * @returns - Refraction texture if present. If no refraction texture and refraction
  133700. * is linked with transparency, returns environment texture. Otherwise, returns null.
  133701. */
  133702. private _getRefractionTexture;
  133703. /**
  133704. * Returns true if alpha blending should be disabled.
  133705. */
  133706. get disableAlphaBlending(): boolean;
  133707. /**
  133708. * Fills the list of render target textures.
  133709. * @param renderTargets the list of render targets to update
  133710. */
  133711. fillRenderTargetTextures(renderTargets: SmartArray<RenderTargetTexture>): void;
  133712. /**
  133713. * Checks to see if a texture is used in the material.
  133714. * @param texture - Base texture to use.
  133715. * @returns - Boolean specifying if a texture is used in the material.
  133716. */
  133717. hasTexture(texture: BaseTexture): boolean;
  133718. /**
  133719. * Gets a boolean indicating that current material needs to register RTT
  133720. * @returns true if this uses a render target otherwise false.
  133721. */
  133722. hasRenderTargetTextures(): boolean;
  133723. /**
  133724. * Returns an array of the actively used textures.
  133725. * @param activeTextures Array of BaseTextures
  133726. */
  133727. getActiveTextures(activeTextures: BaseTexture[]): void;
  133728. /**
  133729. * Returns the animatable textures.
  133730. * @param animatables Array of animatable textures.
  133731. */
  133732. getAnimatables(animatables: IAnimatable[]): void;
  133733. /**
  133734. * Disposes the resources of the material.
  133735. * @param forceDisposeTextures - Forces the disposal of all textures.
  133736. */
  133737. dispose(forceDisposeTextures?: boolean): void;
  133738. /**
  133739. * Get the current class name of the texture useful for serialization or dynamic coding.
  133740. * @returns "PBRSubSurfaceConfiguration"
  133741. */
  133742. getClassName(): string;
  133743. /**
  133744. * Add fallbacks to the effect fallbacks list.
  133745. * @param defines defines the Base texture to use.
  133746. * @param fallbacks defines the current fallback list.
  133747. * @param currentRank defines the current fallback rank.
  133748. * @returns the new fallback rank.
  133749. */
  133750. static AddFallbacks(defines: IMaterialSubSurfaceDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  133751. /**
  133752. * Add the required uniforms to the current list.
  133753. * @param uniforms defines the current uniform list.
  133754. */
  133755. static AddUniforms(uniforms: string[]): void;
  133756. /**
  133757. * Add the required samplers to the current list.
  133758. * @param samplers defines the current sampler list.
  133759. */
  133760. static AddSamplers(samplers: string[]): void;
  133761. /**
  133762. * Add the required uniforms to the current buffer.
  133763. * @param uniformBuffer defines the current uniform buffer.
  133764. */
  133765. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  133766. /**
  133767. * Makes a duplicate of the current configuration into another one.
  133768. * @param configuration define the config where to copy the info
  133769. */
  133770. copyTo(configuration: PBRSubSurfaceConfiguration): void;
  133771. /**
  133772. * Serializes this Sub Surface configuration.
  133773. * @returns - An object with the serialized config.
  133774. */
  133775. serialize(): any;
  133776. /**
  133777. * Parses a anisotropy Configuration from a serialized object.
  133778. * @param source - Serialized object.
  133779. * @param scene Defines the scene we are parsing for
  133780. * @param rootUrl Defines the rootUrl to load from
  133781. */
  133782. parse(source: any, scene: Scene, rootUrl: string): void;
  133783. }
  133784. }
  133785. declare module BABYLON {
  133786. /** @hidden */
  133787. export var pbrFragmentDeclaration: {
  133788. name: string;
  133789. shader: string;
  133790. };
  133791. }
  133792. declare module BABYLON {
  133793. /** @hidden */
  133794. export var pbrUboDeclaration: {
  133795. name: string;
  133796. shader: string;
  133797. };
  133798. }
  133799. declare module BABYLON {
  133800. /** @hidden */
  133801. export var pbrFragmentExtraDeclaration: {
  133802. name: string;
  133803. shader: string;
  133804. };
  133805. }
  133806. declare module BABYLON {
  133807. /** @hidden */
  133808. export var pbrFragmentSamplersDeclaration: {
  133809. name: string;
  133810. shader: string;
  133811. };
  133812. }
  133813. declare module BABYLON {
  133814. /** @hidden */
  133815. export var importanceSampling: {
  133816. name: string;
  133817. shader: string;
  133818. };
  133819. }
  133820. declare module BABYLON {
  133821. /** @hidden */
  133822. export var pbrHelperFunctions: {
  133823. name: string;
  133824. shader: string;
  133825. };
  133826. }
  133827. declare module BABYLON {
  133828. /** @hidden */
  133829. export var harmonicsFunctions: {
  133830. name: string;
  133831. shader: string;
  133832. };
  133833. }
  133834. declare module BABYLON {
  133835. /** @hidden */
  133836. export var pbrDirectLightingSetupFunctions: {
  133837. name: string;
  133838. shader: string;
  133839. };
  133840. }
  133841. declare module BABYLON {
  133842. /** @hidden */
  133843. export var pbrDirectLightingFalloffFunctions: {
  133844. name: string;
  133845. shader: string;
  133846. };
  133847. }
  133848. declare module BABYLON {
  133849. /** @hidden */
  133850. export var pbrBRDFFunctions: {
  133851. name: string;
  133852. shader: string;
  133853. };
  133854. }
  133855. declare module BABYLON {
  133856. /** @hidden */
  133857. export var hdrFilteringFunctions: {
  133858. name: string;
  133859. shader: string;
  133860. };
  133861. }
  133862. declare module BABYLON {
  133863. /** @hidden */
  133864. export var pbrDirectLightingFunctions: {
  133865. name: string;
  133866. shader: string;
  133867. };
  133868. }
  133869. declare module BABYLON {
  133870. /** @hidden */
  133871. export var pbrIBLFunctions: {
  133872. name: string;
  133873. shader: string;
  133874. };
  133875. }
  133876. declare module BABYLON {
  133877. /** @hidden */
  133878. export var pbrBlockAlbedoOpacity: {
  133879. name: string;
  133880. shader: string;
  133881. };
  133882. }
  133883. declare module BABYLON {
  133884. /** @hidden */
  133885. export var pbrBlockReflectivity: {
  133886. name: string;
  133887. shader: string;
  133888. };
  133889. }
  133890. declare module BABYLON {
  133891. /** @hidden */
  133892. export var pbrBlockAmbientOcclusion: {
  133893. name: string;
  133894. shader: string;
  133895. };
  133896. }
  133897. declare module BABYLON {
  133898. /** @hidden */
  133899. export var pbrBlockAlphaFresnel: {
  133900. name: string;
  133901. shader: string;
  133902. };
  133903. }
  133904. declare module BABYLON {
  133905. /** @hidden */
  133906. export var pbrBlockAnisotropic: {
  133907. name: string;
  133908. shader: string;
  133909. };
  133910. }
  133911. declare module BABYLON {
  133912. /** @hidden */
  133913. export var pbrBlockReflection: {
  133914. name: string;
  133915. shader: string;
  133916. };
  133917. }
  133918. declare module BABYLON {
  133919. /** @hidden */
  133920. export var pbrBlockSheen: {
  133921. name: string;
  133922. shader: string;
  133923. };
  133924. }
  133925. declare module BABYLON {
  133926. /** @hidden */
  133927. export var pbrBlockClearcoat: {
  133928. name: string;
  133929. shader: string;
  133930. };
  133931. }
  133932. declare module BABYLON {
  133933. /** @hidden */
  133934. export var pbrBlockSubSurface: {
  133935. name: string;
  133936. shader: string;
  133937. };
  133938. }
  133939. declare module BABYLON {
  133940. /** @hidden */
  133941. export var pbrBlockNormalGeometric: {
  133942. name: string;
  133943. shader: string;
  133944. };
  133945. }
  133946. declare module BABYLON {
  133947. /** @hidden */
  133948. export var pbrBlockNormalFinal: {
  133949. name: string;
  133950. shader: string;
  133951. };
  133952. }
  133953. declare module BABYLON {
  133954. /** @hidden */
  133955. export var pbrBlockLightmapInit: {
  133956. name: string;
  133957. shader: string;
  133958. };
  133959. }
  133960. declare module BABYLON {
  133961. /** @hidden */
  133962. export var pbrBlockGeometryInfo: {
  133963. name: string;
  133964. shader: string;
  133965. };
  133966. }
  133967. declare module BABYLON {
  133968. /** @hidden */
  133969. export var pbrBlockReflectance0: {
  133970. name: string;
  133971. shader: string;
  133972. };
  133973. }
  133974. declare module BABYLON {
  133975. /** @hidden */
  133976. export var pbrBlockReflectance: {
  133977. name: string;
  133978. shader: string;
  133979. };
  133980. }
  133981. declare module BABYLON {
  133982. /** @hidden */
  133983. export var pbrBlockDirectLighting: {
  133984. name: string;
  133985. shader: string;
  133986. };
  133987. }
  133988. declare module BABYLON {
  133989. /** @hidden */
  133990. export var pbrBlockFinalLitComponents: {
  133991. name: string;
  133992. shader: string;
  133993. };
  133994. }
  133995. declare module BABYLON {
  133996. /** @hidden */
  133997. export var pbrBlockFinalUnlitComponents: {
  133998. name: string;
  133999. shader: string;
  134000. };
  134001. }
  134002. declare module BABYLON {
  134003. /** @hidden */
  134004. export var pbrBlockFinalColorComposition: {
  134005. name: string;
  134006. shader: string;
  134007. };
  134008. }
  134009. declare module BABYLON {
  134010. /** @hidden */
  134011. export var pbrBlockImageProcessing: {
  134012. name: string;
  134013. shader: string;
  134014. };
  134015. }
  134016. declare module BABYLON {
  134017. /** @hidden */
  134018. export var pbrDebug: {
  134019. name: string;
  134020. shader: string;
  134021. };
  134022. }
  134023. declare module BABYLON {
  134024. /** @hidden */
  134025. export var pbrPixelShader: {
  134026. name: string;
  134027. shader: string;
  134028. };
  134029. }
  134030. declare module BABYLON {
  134031. /** @hidden */
  134032. export var pbrVertexDeclaration: {
  134033. name: string;
  134034. shader: string;
  134035. };
  134036. }
  134037. declare module BABYLON {
  134038. /** @hidden */
  134039. export var pbrVertexShader: {
  134040. name: string;
  134041. shader: string;
  134042. };
  134043. }
  134044. declare module BABYLON {
  134045. /**
  134046. * Manages the defines for the PBR Material.
  134047. * @hidden
  134048. */
  134049. export class PBRMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines, IMaterialClearCoatDefines, IMaterialAnisotropicDefines, IMaterialBRDFDefines, IMaterialSheenDefines, IMaterialSubSurfaceDefines, IMaterialDetailMapDefines {
  134050. PBR: boolean;
  134051. NUM_SAMPLES: string;
  134052. REALTIME_FILTERING: boolean;
  134053. MAINUV1: boolean;
  134054. MAINUV2: boolean;
  134055. UV1: boolean;
  134056. UV2: boolean;
  134057. ALBEDO: boolean;
  134058. GAMMAALBEDO: boolean;
  134059. ALBEDODIRECTUV: number;
  134060. VERTEXCOLOR: boolean;
  134061. DETAIL: boolean;
  134062. DETAILDIRECTUV: number;
  134063. DETAIL_NORMALBLENDMETHOD: number;
  134064. AMBIENT: boolean;
  134065. AMBIENTDIRECTUV: number;
  134066. AMBIENTINGRAYSCALE: boolean;
  134067. OPACITY: boolean;
  134068. VERTEXALPHA: boolean;
  134069. OPACITYDIRECTUV: number;
  134070. OPACITYRGB: boolean;
  134071. ALPHATEST: boolean;
  134072. DEPTHPREPASS: boolean;
  134073. ALPHABLEND: boolean;
  134074. ALPHAFROMALBEDO: boolean;
  134075. ALPHATESTVALUE: string;
  134076. SPECULAROVERALPHA: boolean;
  134077. RADIANCEOVERALPHA: boolean;
  134078. ALPHAFRESNEL: boolean;
  134079. LINEARALPHAFRESNEL: boolean;
  134080. PREMULTIPLYALPHA: boolean;
  134081. EMISSIVE: boolean;
  134082. EMISSIVEDIRECTUV: number;
  134083. REFLECTIVITY: boolean;
  134084. REFLECTIVITYDIRECTUV: number;
  134085. SPECULARTERM: boolean;
  134086. MICROSURFACEFROMREFLECTIVITYMAP: boolean;
  134087. MICROSURFACEAUTOMATIC: boolean;
  134088. LODBASEDMICROSFURACE: boolean;
  134089. MICROSURFACEMAP: boolean;
  134090. MICROSURFACEMAPDIRECTUV: number;
  134091. METALLICWORKFLOW: boolean;
  134092. ROUGHNESSSTOREINMETALMAPALPHA: boolean;
  134093. ROUGHNESSSTOREINMETALMAPGREEN: boolean;
  134094. METALLNESSSTOREINMETALMAPBLUE: boolean;
  134095. AOSTOREINMETALMAPRED: boolean;
  134096. METALLIC_REFLECTANCE: boolean;
  134097. METALLIC_REFLECTANCEDIRECTUV: number;
  134098. ENVIRONMENTBRDF: boolean;
  134099. ENVIRONMENTBRDF_RGBD: boolean;
  134100. NORMAL: boolean;
  134101. TANGENT: boolean;
  134102. BUMP: boolean;
  134103. BUMPDIRECTUV: number;
  134104. OBJECTSPACE_NORMALMAP: boolean;
  134105. PARALLAX: boolean;
  134106. PARALLAXOCCLUSION: boolean;
  134107. NORMALXYSCALE: boolean;
  134108. LIGHTMAP: boolean;
  134109. LIGHTMAPDIRECTUV: number;
  134110. USELIGHTMAPASSHADOWMAP: boolean;
  134111. GAMMALIGHTMAP: boolean;
  134112. RGBDLIGHTMAP: boolean;
  134113. REFLECTION: boolean;
  134114. REFLECTIONMAP_3D: boolean;
  134115. REFLECTIONMAP_SPHERICAL: boolean;
  134116. REFLECTIONMAP_PLANAR: boolean;
  134117. REFLECTIONMAP_CUBIC: boolean;
  134118. USE_LOCAL_REFLECTIONMAP_CUBIC: boolean;
  134119. REFLECTIONMAP_PROJECTION: boolean;
  134120. REFLECTIONMAP_SKYBOX: boolean;
  134121. REFLECTIONMAP_EXPLICIT: boolean;
  134122. REFLECTIONMAP_EQUIRECTANGULAR: boolean;
  134123. REFLECTIONMAP_EQUIRECTANGULAR_FIXED: boolean;
  134124. REFLECTIONMAP_MIRROREDEQUIRECTANGULAR_FIXED: boolean;
  134125. INVERTCUBICMAP: boolean;
  134126. USESPHERICALFROMREFLECTIONMAP: boolean;
  134127. USEIRRADIANCEMAP: boolean;
  134128. SPHERICAL_HARMONICS: boolean;
  134129. USESPHERICALINVERTEX: boolean;
  134130. REFLECTIONMAP_OPPOSITEZ: boolean;
  134131. LODINREFLECTIONALPHA: boolean;
  134132. GAMMAREFLECTION: boolean;
  134133. RGBDREFLECTION: boolean;
  134134. LINEARSPECULARREFLECTION: boolean;
  134135. RADIANCEOCCLUSION: boolean;
  134136. HORIZONOCCLUSION: boolean;
  134137. INSTANCES: boolean;
  134138. THIN_INSTANCES: boolean;
  134139. PREPASS: boolean;
  134140. SCENE_MRT_COUNT: number;
  134141. NUM_BONE_INFLUENCERS: number;
  134142. BonesPerMesh: number;
  134143. BONETEXTURE: boolean;
  134144. NONUNIFORMSCALING: boolean;
  134145. MORPHTARGETS: boolean;
  134146. MORPHTARGETS_NORMAL: boolean;
  134147. MORPHTARGETS_TANGENT: boolean;
  134148. MORPHTARGETS_UV: boolean;
  134149. NUM_MORPH_INFLUENCERS: number;
  134150. IMAGEPROCESSING: boolean;
  134151. VIGNETTE: boolean;
  134152. VIGNETTEBLENDMODEMULTIPLY: boolean;
  134153. VIGNETTEBLENDMODEOPAQUE: boolean;
  134154. TONEMAPPING: boolean;
  134155. TONEMAPPING_ACES: boolean;
  134156. CONTRAST: boolean;
  134157. COLORCURVES: boolean;
  134158. COLORGRADING: boolean;
  134159. COLORGRADING3D: boolean;
  134160. SAMPLER3DGREENDEPTH: boolean;
  134161. SAMPLER3DBGRMAP: boolean;
  134162. IMAGEPROCESSINGPOSTPROCESS: boolean;
  134163. EXPOSURE: boolean;
  134164. MULTIVIEW: boolean;
  134165. USEPHYSICALLIGHTFALLOFF: boolean;
  134166. USEGLTFLIGHTFALLOFF: boolean;
  134167. TWOSIDEDLIGHTING: boolean;
  134168. SHADOWFLOAT: boolean;
  134169. CLIPPLANE: boolean;
  134170. CLIPPLANE2: boolean;
  134171. CLIPPLANE3: boolean;
  134172. CLIPPLANE4: boolean;
  134173. CLIPPLANE5: boolean;
  134174. CLIPPLANE6: boolean;
  134175. POINTSIZE: boolean;
  134176. FOG: boolean;
  134177. LOGARITHMICDEPTH: boolean;
  134178. FORCENORMALFORWARD: boolean;
  134179. SPECULARAA: boolean;
  134180. CLEARCOAT: boolean;
  134181. CLEARCOAT_DEFAULTIOR: boolean;
  134182. CLEARCOAT_TEXTURE: boolean;
  134183. CLEARCOAT_TEXTUREDIRECTUV: number;
  134184. CLEARCOAT_BUMP: boolean;
  134185. CLEARCOAT_BUMPDIRECTUV: number;
  134186. CLEARCOAT_TINT: boolean;
  134187. CLEARCOAT_TINT_TEXTURE: boolean;
  134188. CLEARCOAT_TINT_TEXTUREDIRECTUV: number;
  134189. ANISOTROPIC: boolean;
  134190. ANISOTROPIC_TEXTURE: boolean;
  134191. ANISOTROPIC_TEXTUREDIRECTUV: number;
  134192. BRDF_V_HEIGHT_CORRELATED: boolean;
  134193. MS_BRDF_ENERGY_CONSERVATION: boolean;
  134194. SPECULAR_GLOSSINESS_ENERGY_CONSERVATION: boolean;
  134195. SHEEN: boolean;
  134196. SHEEN_TEXTURE: boolean;
  134197. SHEEN_TEXTUREDIRECTUV: number;
  134198. SHEEN_LINKWITHALBEDO: boolean;
  134199. SHEEN_ROUGHNESS: boolean;
  134200. SHEEN_ALBEDOSCALING: boolean;
  134201. SUBSURFACE: boolean;
  134202. SS_REFRACTION: boolean;
  134203. SS_TRANSLUCENCY: boolean;
  134204. SS_SCATTERING: boolean;
  134205. SS_THICKNESSANDMASK_TEXTURE: boolean;
  134206. SS_THICKNESSANDMASK_TEXTUREDIRECTUV: number;
  134207. SS_REFRACTIONMAP_3D: boolean;
  134208. SS_REFRACTIONMAP_OPPOSITEZ: boolean;
  134209. SS_LODINREFRACTIONALPHA: boolean;
  134210. SS_GAMMAREFRACTION: boolean;
  134211. SS_RGBDREFRACTION: boolean;
  134212. SS_LINEARSPECULARREFRACTION: boolean;
  134213. SS_LINKREFRACTIONTOTRANSPARENCY: boolean;
  134214. SS_ALBEDOFORREFRACTIONTINT: boolean;
  134215. SS_MASK_FROM_THICKNESS_TEXTURE: boolean;
  134216. UNLIT: boolean;
  134217. DEBUGMODE: number;
  134218. /**
  134219. * Initializes the PBR Material defines.
  134220. */
  134221. constructor();
  134222. /**
  134223. * Resets the PBR Material defines.
  134224. */
  134225. reset(): void;
  134226. }
  134227. /**
  134228. * The Physically based material base class of BJS.
  134229. *
  134230. * This offers the main features of a standard PBR material.
  134231. * For more information, please refer to the documentation :
  134232. * https://doc.babylonjs.com/how_to/physically_based_rendering
  134233. */
  134234. export abstract class PBRBaseMaterial extends PushMaterial {
  134235. /**
  134236. * PBRMaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  134237. */
  134238. static readonly PBRMATERIAL_OPAQUE: number;
  134239. /**
  134240. * PBRMaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  134241. */
  134242. static readonly PBRMATERIAL_ALPHATEST: number;
  134243. /**
  134244. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  134245. */
  134246. static readonly PBRMATERIAL_ALPHABLEND: number;
  134247. /**
  134248. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  134249. * They are also discarded below the alpha cutoff threshold to improve performances.
  134250. */
  134251. static readonly PBRMATERIAL_ALPHATESTANDBLEND: number;
  134252. /**
  134253. * Defines the default value of how much AO map is occluding the analytical lights
  134254. * (point spot...).
  134255. */
  134256. static DEFAULT_AO_ON_ANALYTICAL_LIGHTS: number;
  134257. /**
  134258. * PBRMaterialLightFalloff Physical: light is falling off following the inverse squared distance law.
  134259. */
  134260. static readonly LIGHTFALLOFF_PHYSICAL: number;
  134261. /**
  134262. * PBRMaterialLightFalloff gltf: light is falling off as described in the gltf moving to PBR document
  134263. * to enhance interoperability with other engines.
  134264. */
  134265. static readonly LIGHTFALLOFF_GLTF: number;
  134266. /**
  134267. * PBRMaterialLightFalloff Standard: light is falling off like in the standard material
  134268. * to enhance interoperability with other materials.
  134269. */
  134270. static readonly LIGHTFALLOFF_STANDARD: number;
  134271. /**
  134272. * Intensity of the direct lights e.g. the four lights available in your scene.
  134273. * This impacts both the direct diffuse and specular highlights.
  134274. */
  134275. protected _directIntensity: number;
  134276. /**
  134277. * Intensity of the emissive part of the material.
  134278. * This helps controlling the emissive effect without modifying the emissive color.
  134279. */
  134280. protected _emissiveIntensity: number;
  134281. /**
  134282. * Intensity of the environment e.g. how much the environment will light the object
  134283. * either through harmonics for rough material or through the refelction for shiny ones.
  134284. */
  134285. protected _environmentIntensity: number;
  134286. /**
  134287. * This is a special control allowing the reduction of the specular highlights coming from the
  134288. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  134289. */
  134290. protected _specularIntensity: number;
  134291. /**
  134292. * This stores the direct, emissive, environment, and specular light intensities into a Vector4.
  134293. */
  134294. private _lightingInfos;
  134295. /**
  134296. * Debug Control allowing disabling the bump map on this material.
  134297. */
  134298. protected _disableBumpMap: boolean;
  134299. /**
  134300. * AKA Diffuse Texture in standard nomenclature.
  134301. */
  134302. protected _albedoTexture: Nullable<BaseTexture>;
  134303. /**
  134304. * AKA Occlusion Texture in other nomenclature.
  134305. */
  134306. protected _ambientTexture: Nullable<BaseTexture>;
  134307. /**
  134308. * AKA Occlusion Texture Intensity in other nomenclature.
  134309. */
  134310. protected _ambientTextureStrength: number;
  134311. /**
  134312. * Defines how much the AO map is occluding the analytical lights (point spot...).
  134313. * 1 means it completely occludes it
  134314. * 0 mean it has no impact
  134315. */
  134316. protected _ambientTextureImpactOnAnalyticalLights: number;
  134317. /**
  134318. * Stores the alpha values in a texture.
  134319. */
  134320. protected _opacityTexture: Nullable<BaseTexture>;
  134321. /**
  134322. * Stores the reflection values in a texture.
  134323. */
  134324. protected _reflectionTexture: Nullable<BaseTexture>;
  134325. /**
  134326. * Stores the emissive values in a texture.
  134327. */
  134328. protected _emissiveTexture: Nullable<BaseTexture>;
  134329. /**
  134330. * AKA Specular texture in other nomenclature.
  134331. */
  134332. protected _reflectivityTexture: Nullable<BaseTexture>;
  134333. /**
  134334. * Used to switch from specular/glossiness to metallic/roughness workflow.
  134335. */
  134336. protected _metallicTexture: Nullable<BaseTexture>;
  134337. /**
  134338. * Specifies the metallic scalar of the metallic/roughness workflow.
  134339. * Can also be used to scale the metalness values of the metallic texture.
  134340. */
  134341. protected _metallic: Nullable<number>;
  134342. /**
  134343. * Specifies the roughness scalar of the metallic/roughness workflow.
  134344. * Can also be used to scale the roughness values of the metallic texture.
  134345. */
  134346. protected _roughness: Nullable<number>;
  134347. /**
  134348. * In metallic workflow, specifies an F0 factor to help configuring the material F0.
  134349. * By default the indexOfrefraction is used to compute F0;
  134350. *
  134351. * This is used as a factor against the default reflectance at normal incidence to tweak it.
  134352. *
  134353. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor;
  134354. * F90 = metallicReflectanceColor;
  134355. */
  134356. protected _metallicF0Factor: number;
  134357. /**
  134358. * In metallic workflow, specifies an F90 color to help configuring the material F90.
  134359. * By default the F90 is always 1;
  134360. *
  134361. * Please note that this factor is also used as a factor against the default reflectance at normal incidence.
  134362. *
  134363. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor
  134364. * F90 = metallicReflectanceColor;
  134365. */
  134366. protected _metallicReflectanceColor: Color3;
  134367. /**
  134368. * Defines to store metallicReflectanceColor in RGB and metallicF0Factor in A
  134369. * This is multiply against the scalar values defined in the material.
  134370. */
  134371. protected _metallicReflectanceTexture: Nullable<BaseTexture>;
  134372. /**
  134373. * Used to enable roughness/glossiness fetch from a separate channel depending on the current mode.
  134374. * Gray Scale represents roughness in metallic mode and glossiness in specular mode.
  134375. */
  134376. protected _microSurfaceTexture: Nullable<BaseTexture>;
  134377. /**
  134378. * Stores surface normal data used to displace a mesh in a texture.
  134379. */
  134380. protected _bumpTexture: Nullable<BaseTexture>;
  134381. /**
  134382. * Stores the pre-calculated light information of a mesh in a texture.
  134383. */
  134384. protected _lightmapTexture: Nullable<BaseTexture>;
  134385. /**
  134386. * The color of a material in ambient lighting.
  134387. */
  134388. protected _ambientColor: Color3;
  134389. /**
  134390. * AKA Diffuse Color in other nomenclature.
  134391. */
  134392. protected _albedoColor: Color3;
  134393. /**
  134394. * AKA Specular Color in other nomenclature.
  134395. */
  134396. protected _reflectivityColor: Color3;
  134397. /**
  134398. * The color applied when light is reflected from a material.
  134399. */
  134400. protected _reflectionColor: Color3;
  134401. /**
  134402. * The color applied when light is emitted from a material.
  134403. */
  134404. protected _emissiveColor: Color3;
  134405. /**
  134406. * AKA Glossiness in other nomenclature.
  134407. */
  134408. protected _microSurface: number;
  134409. /**
  134410. * Specifies that the material will use the light map as a show map.
  134411. */
  134412. protected _useLightmapAsShadowmap: boolean;
  134413. /**
  134414. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  134415. * makes the reflect vector face the model (under horizon).
  134416. */
  134417. protected _useHorizonOcclusion: boolean;
  134418. /**
  134419. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  134420. * too much the area relying on ambient texture to define their ambient occlusion.
  134421. */
  134422. protected _useRadianceOcclusion: boolean;
  134423. /**
  134424. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  134425. */
  134426. protected _useAlphaFromAlbedoTexture: boolean;
  134427. /**
  134428. * Specifies that the material will keeps the specular highlights over a transparent surface (only the most limunous ones).
  134429. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  134430. */
  134431. protected _useSpecularOverAlpha: boolean;
  134432. /**
  134433. * Specifies if the reflectivity texture contains the glossiness information in its alpha channel.
  134434. */
  134435. protected _useMicroSurfaceFromReflectivityMapAlpha: boolean;
  134436. /**
  134437. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  134438. */
  134439. protected _useRoughnessFromMetallicTextureAlpha: boolean;
  134440. /**
  134441. * Specifies if the metallic texture contains the roughness information in its green channel.
  134442. */
  134443. protected _useRoughnessFromMetallicTextureGreen: boolean;
  134444. /**
  134445. * Specifies if the metallic texture contains the metallness information in its blue channel.
  134446. */
  134447. protected _useMetallnessFromMetallicTextureBlue: boolean;
  134448. /**
  134449. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  134450. */
  134451. protected _useAmbientOcclusionFromMetallicTextureRed: boolean;
  134452. /**
  134453. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  134454. */
  134455. protected _useAmbientInGrayScale: boolean;
  134456. /**
  134457. * In case the reflectivity map does not contain the microsurface information in its alpha channel,
  134458. * The material will try to infer what glossiness each pixel should be.
  134459. */
  134460. protected _useAutoMicroSurfaceFromReflectivityMap: boolean;
  134461. /**
  134462. * Defines the falloff type used in this material.
  134463. * It by default is Physical.
  134464. */
  134465. protected _lightFalloff: number;
  134466. /**
  134467. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  134468. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  134469. */
  134470. protected _useRadianceOverAlpha: boolean;
  134471. /**
  134472. * Allows using an object space normal map (instead of tangent space).
  134473. */
  134474. protected _useObjectSpaceNormalMap: boolean;
  134475. /**
  134476. * Allows using the bump map in parallax mode.
  134477. */
  134478. protected _useParallax: boolean;
  134479. /**
  134480. * Allows using the bump map in parallax occlusion mode.
  134481. */
  134482. protected _useParallaxOcclusion: boolean;
  134483. /**
  134484. * Controls the scale bias of the parallax mode.
  134485. */
  134486. protected _parallaxScaleBias: number;
  134487. /**
  134488. * If sets to true, disables all the lights affecting the material.
  134489. */
  134490. protected _disableLighting: boolean;
  134491. /**
  134492. * Number of Simultaneous lights allowed on the material.
  134493. */
  134494. protected _maxSimultaneousLights: number;
  134495. /**
  134496. * If sets to true, x component of normal map value will be inverted (x = 1.0 - x).
  134497. */
  134498. protected _invertNormalMapX: boolean;
  134499. /**
  134500. * If sets to true, y component of normal map value will be inverted (y = 1.0 - y).
  134501. */
  134502. protected _invertNormalMapY: boolean;
  134503. /**
  134504. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  134505. */
  134506. protected _twoSidedLighting: boolean;
  134507. /**
  134508. * Defines the alpha limits in alpha test mode.
  134509. */
  134510. protected _alphaCutOff: number;
  134511. /**
  134512. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  134513. */
  134514. protected _forceAlphaTest: boolean;
  134515. /**
  134516. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  134517. * And/Or occlude the blended part. (alpha is converted to gamma to compute the fresnel)
  134518. */
  134519. protected _useAlphaFresnel: boolean;
  134520. /**
  134521. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  134522. * And/Or occlude the blended part. (alpha stays linear to compute the fresnel)
  134523. */
  134524. protected _useLinearAlphaFresnel: boolean;
  134525. /**
  134526. * Specifies the environment BRDF texture used to comput the scale and offset roughness values
  134527. * from cos thetav and roughness:
  134528. * http://blog.selfshadow.com/publications/s2013-shading-course/karis/s2013_pbs_epic_notes_v2.pdf
  134529. */
  134530. protected _environmentBRDFTexture: Nullable<BaseTexture>;
  134531. /**
  134532. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  134533. */
  134534. protected _forceIrradianceInFragment: boolean;
  134535. private _realTimeFiltering;
  134536. /**
  134537. * Enables realtime filtering on the texture.
  134538. */
  134539. get realTimeFiltering(): boolean;
  134540. set realTimeFiltering(b: boolean);
  134541. private _realTimeFilteringQuality;
  134542. /**
  134543. * Quality switch for realtime filtering
  134544. */
  134545. get realTimeFilteringQuality(): number;
  134546. set realTimeFilteringQuality(n: number);
  134547. /**
  134548. * Can this material render to several textures at once
  134549. */
  134550. get canRenderToMRT(): boolean;
  134551. /**
  134552. * Force normal to face away from face.
  134553. */
  134554. protected _forceNormalForward: boolean;
  134555. /**
  134556. * Enables specular anti aliasing in the PBR shader.
  134557. * It will both interacts on the Geometry for analytical and IBL lighting.
  134558. * It also prefilter the roughness map based on the bump values.
  134559. */
  134560. protected _enableSpecularAntiAliasing: boolean;
  134561. /**
  134562. * Default configuration related to image processing available in the PBR Material.
  134563. */
  134564. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  134565. /**
  134566. * Keep track of the image processing observer to allow dispose and replace.
  134567. */
  134568. private _imageProcessingObserver;
  134569. /**
  134570. * Attaches a new image processing configuration to the PBR Material.
  134571. * @param configuration
  134572. */
  134573. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  134574. /**
  134575. * Stores the available render targets.
  134576. */
  134577. private _renderTargets;
  134578. /**
  134579. * Sets the global ambient color for the material used in lighting calculations.
  134580. */
  134581. private _globalAmbientColor;
  134582. /**
  134583. * Enables the use of logarithmic depth buffers, which is good for wide depth buffers.
  134584. */
  134585. private _useLogarithmicDepth;
  134586. /**
  134587. * If set to true, no lighting calculations will be applied.
  134588. */
  134589. private _unlit;
  134590. private _debugMode;
  134591. /**
  134592. * @hidden
  134593. * This is reserved for the inspector.
  134594. * Defines the material debug mode.
  134595. * It helps seeing only some components of the material while troubleshooting.
  134596. */
  134597. debugMode: number;
  134598. /**
  134599. * @hidden
  134600. * This is reserved for the inspector.
  134601. * Specify from where on screen the debug mode should start.
  134602. * The value goes from -1 (full screen) to 1 (not visible)
  134603. * It helps with side by side comparison against the final render
  134604. * This defaults to -1
  134605. */
  134606. private debugLimit;
  134607. /**
  134608. * @hidden
  134609. * This is reserved for the inspector.
  134610. * As the default viewing range might not be enough (if the ambient is really small for instance)
  134611. * You can use the factor to better multiply the final value.
  134612. */
  134613. private debugFactor;
  134614. /**
  134615. * Defines the clear coat layer parameters for the material.
  134616. */
  134617. readonly clearCoat: PBRClearCoatConfiguration;
  134618. /**
  134619. * Defines the anisotropic parameters for the material.
  134620. */
  134621. readonly anisotropy: PBRAnisotropicConfiguration;
  134622. /**
  134623. * Defines the BRDF parameters for the material.
  134624. */
  134625. readonly brdf: PBRBRDFConfiguration;
  134626. /**
  134627. * Defines the Sheen parameters for the material.
  134628. */
  134629. readonly sheen: PBRSheenConfiguration;
  134630. /**
  134631. * Defines the SubSurface parameters for the material.
  134632. */
  134633. readonly subSurface: PBRSubSurfaceConfiguration;
  134634. /**
  134635. * Defines the detail map parameters for the material.
  134636. */
  134637. readonly detailMap: DetailMapConfiguration;
  134638. protected _rebuildInParallel: boolean;
  134639. /**
  134640. * Instantiates a new PBRMaterial instance.
  134641. *
  134642. * @param name The material name
  134643. * @param scene The scene the material will be use in.
  134644. */
  134645. constructor(name: string, scene: Scene);
  134646. /**
  134647. * Gets a boolean indicating that current material needs to register RTT
  134648. */
  134649. get hasRenderTargetTextures(): boolean;
  134650. /**
  134651. * Gets the name of the material class.
  134652. */
  134653. getClassName(): string;
  134654. /**
  134655. * Enabled the use of logarithmic depth buffers, which is good for wide depth buffers.
  134656. */
  134657. get useLogarithmicDepth(): boolean;
  134658. /**
  134659. * Enabled the use of logarithmic depth buffers, which is good for wide depth buffers.
  134660. */
  134661. set useLogarithmicDepth(value: boolean);
  134662. /**
  134663. * Returns true if alpha blending should be disabled.
  134664. */
  134665. protected get _disableAlphaBlending(): boolean;
  134666. /**
  134667. * Specifies whether or not this material should be rendered in alpha blend mode.
  134668. */
  134669. needAlphaBlending(): boolean;
  134670. /**
  134671. * Specifies whether or not this material should be rendered in alpha test mode.
  134672. */
  134673. needAlphaTesting(): boolean;
  134674. /**
  134675. * Specifies whether or not the alpha value of the albedo texture should be used for alpha blending.
  134676. */
  134677. protected _shouldUseAlphaFromAlbedoTexture(): boolean;
  134678. /**
  134679. * Gets the texture used for the alpha test.
  134680. */
  134681. getAlphaTestTexture(): Nullable<BaseTexture>;
  134682. /**
  134683. * Specifies that the submesh is ready to be used.
  134684. * @param mesh - BJS mesh.
  134685. * @param subMesh - A submesh of the BJS mesh. Used to check if it is ready.
  134686. * @param useInstances - Specifies that instances should be used.
  134687. * @returns - boolean indicating that the submesh is ready or not.
  134688. */
  134689. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  134690. /**
  134691. * Specifies if the material uses metallic roughness workflow.
  134692. * @returns boolean specifiying if the material uses metallic roughness workflow.
  134693. */
  134694. isMetallicWorkflow(): boolean;
  134695. private _prepareEffect;
  134696. private _prepareDefines;
  134697. /**
  134698. * Force shader compilation
  134699. */
  134700. forceCompilation(mesh: AbstractMesh, onCompiled?: (material: Material) => void, options?: Partial<IMaterialCompilationOptions>): void;
  134701. /**
  134702. * Initializes the uniform buffer layout for the shader.
  134703. */
  134704. buildUniformLayout(): void;
  134705. /**
  134706. * Unbinds the material from the mesh
  134707. */
  134708. unbind(): void;
  134709. /**
  134710. * Binds the submesh data.
  134711. * @param world - The world matrix.
  134712. * @param mesh - The BJS mesh.
  134713. * @param subMesh - A submesh of the BJS mesh.
  134714. */
  134715. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  134716. /**
  134717. * Returns the animatable textures.
  134718. * @returns - Array of animatable textures.
  134719. */
  134720. getAnimatables(): IAnimatable[];
  134721. /**
  134722. * Returns the texture used for reflections.
  134723. * @returns - Reflection texture if present. Otherwise, returns the environment texture.
  134724. */
  134725. private _getReflectionTexture;
  134726. /**
  134727. * Returns an array of the actively used textures.
  134728. * @returns - Array of BaseTextures
  134729. */
  134730. getActiveTextures(): BaseTexture[];
  134731. /**
  134732. * Checks to see if a texture is used in the material.
  134733. * @param texture - Base texture to use.
  134734. * @returns - Boolean specifying if a texture is used in the material.
  134735. */
  134736. hasTexture(texture: BaseTexture): boolean;
  134737. /**
  134738. * Sets the required values to the prepass renderer.
  134739. * @param prePassRenderer defines the prepass renderer to setup
  134740. */
  134741. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  134742. /**
  134743. * Disposes the resources of the material.
  134744. * @param forceDisposeEffect - Forces the disposal of effects.
  134745. * @param forceDisposeTextures - Forces the disposal of all textures.
  134746. */
  134747. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  134748. }
  134749. }
  134750. declare module BABYLON {
  134751. /**
  134752. * The Physically based material of BJS.
  134753. *
  134754. * This offers the main features of a standard PBR material.
  134755. * For more information, please refer to the documentation :
  134756. * https://doc.babylonjs.com/how_to/physically_based_rendering
  134757. */
  134758. export class PBRMaterial extends PBRBaseMaterial {
  134759. /**
  134760. * PBRMaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  134761. */
  134762. static readonly PBRMATERIAL_OPAQUE: number;
  134763. /**
  134764. * PBRMaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  134765. */
  134766. static readonly PBRMATERIAL_ALPHATEST: number;
  134767. /**
  134768. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  134769. */
  134770. static readonly PBRMATERIAL_ALPHABLEND: number;
  134771. /**
  134772. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  134773. * They are also discarded below the alpha cutoff threshold to improve performances.
  134774. */
  134775. static readonly PBRMATERIAL_ALPHATESTANDBLEND: number;
  134776. /**
  134777. * Defines the default value of how much AO map is occluding the analytical lights
  134778. * (point spot...).
  134779. */
  134780. static DEFAULT_AO_ON_ANALYTICAL_LIGHTS: number;
  134781. /**
  134782. * Intensity of the direct lights e.g. the four lights available in your scene.
  134783. * This impacts both the direct diffuse and specular highlights.
  134784. */
  134785. directIntensity: number;
  134786. /**
  134787. * Intensity of the emissive part of the material.
  134788. * This helps controlling the emissive effect without modifying the emissive color.
  134789. */
  134790. emissiveIntensity: number;
  134791. /**
  134792. * Intensity of the environment e.g. how much the environment will light the object
  134793. * either through harmonics for rough material or through the refelction for shiny ones.
  134794. */
  134795. environmentIntensity: number;
  134796. /**
  134797. * This is a special control allowing the reduction of the specular highlights coming from the
  134798. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  134799. */
  134800. specularIntensity: number;
  134801. /**
  134802. * Debug Control allowing disabling the bump map on this material.
  134803. */
  134804. disableBumpMap: boolean;
  134805. /**
  134806. * AKA Diffuse Texture in standard nomenclature.
  134807. */
  134808. albedoTexture: BaseTexture;
  134809. /**
  134810. * AKA Occlusion Texture in other nomenclature.
  134811. */
  134812. ambientTexture: BaseTexture;
  134813. /**
  134814. * AKA Occlusion Texture Intensity in other nomenclature.
  134815. */
  134816. ambientTextureStrength: number;
  134817. /**
  134818. * Defines how much the AO map is occluding the analytical lights (point spot...).
  134819. * 1 means it completely occludes it
  134820. * 0 mean it has no impact
  134821. */
  134822. ambientTextureImpactOnAnalyticalLights: number;
  134823. /**
  134824. * Stores the alpha values in a texture. Use luminance if texture.getAlphaFromRGB is true.
  134825. */
  134826. opacityTexture: BaseTexture;
  134827. /**
  134828. * Stores the reflection values in a texture.
  134829. */
  134830. reflectionTexture: Nullable<BaseTexture>;
  134831. /**
  134832. * Stores the emissive values in a texture.
  134833. */
  134834. emissiveTexture: BaseTexture;
  134835. /**
  134836. * AKA Specular texture in other nomenclature.
  134837. */
  134838. reflectivityTexture: BaseTexture;
  134839. /**
  134840. * Used to switch from specular/glossiness to metallic/roughness workflow.
  134841. */
  134842. metallicTexture: BaseTexture;
  134843. /**
  134844. * Specifies the metallic scalar of the metallic/roughness workflow.
  134845. * Can also be used to scale the metalness values of the metallic texture.
  134846. */
  134847. metallic: Nullable<number>;
  134848. /**
  134849. * Specifies the roughness scalar of the metallic/roughness workflow.
  134850. * Can also be used to scale the roughness values of the metallic texture.
  134851. */
  134852. roughness: Nullable<number>;
  134853. /**
  134854. * In metallic workflow, specifies an F0 factor to help configuring the material F0.
  134855. * By default the indexOfrefraction is used to compute F0;
  134856. *
  134857. * This is used as a factor against the default reflectance at normal incidence to tweak it.
  134858. *
  134859. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor;
  134860. * F90 = metallicReflectanceColor;
  134861. */
  134862. metallicF0Factor: number;
  134863. /**
  134864. * In metallic workflow, specifies an F90 color to help configuring the material F90.
  134865. * By default the F90 is always 1;
  134866. *
  134867. * Please note that this factor is also used as a factor against the default reflectance at normal incidence.
  134868. *
  134869. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor
  134870. * F90 = metallicReflectanceColor;
  134871. */
  134872. metallicReflectanceColor: Color3;
  134873. /**
  134874. * Defines to store metallicReflectanceColor in RGB and metallicF0Factor in A
  134875. * This is multiply against the scalar values defined in the material.
  134876. */
  134877. metallicReflectanceTexture: Nullable<BaseTexture>;
  134878. /**
  134879. * Used to enable roughness/glossiness fetch from a separate channel depending on the current mode.
  134880. * Gray Scale represents roughness in metallic mode and glossiness in specular mode.
  134881. */
  134882. microSurfaceTexture: BaseTexture;
  134883. /**
  134884. * Stores surface normal data used to displace a mesh in a texture.
  134885. */
  134886. bumpTexture: BaseTexture;
  134887. /**
  134888. * Stores the pre-calculated light information of a mesh in a texture.
  134889. */
  134890. lightmapTexture: BaseTexture;
  134891. /**
  134892. * Stores the refracted light information in a texture.
  134893. */
  134894. get refractionTexture(): Nullable<BaseTexture>;
  134895. set refractionTexture(value: Nullable<BaseTexture>);
  134896. /**
  134897. * The color of a material in ambient lighting.
  134898. */
  134899. ambientColor: Color3;
  134900. /**
  134901. * AKA Diffuse Color in other nomenclature.
  134902. */
  134903. albedoColor: Color3;
  134904. /**
  134905. * AKA Specular Color in other nomenclature.
  134906. */
  134907. reflectivityColor: Color3;
  134908. /**
  134909. * The color reflected from the material.
  134910. */
  134911. reflectionColor: Color3;
  134912. /**
  134913. * The color emitted from the material.
  134914. */
  134915. emissiveColor: Color3;
  134916. /**
  134917. * AKA Glossiness in other nomenclature.
  134918. */
  134919. microSurface: number;
  134920. /**
  134921. * Index of refraction of the material base layer.
  134922. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  134923. *
  134924. * This does not only impact refraction but also the Base F0 of Dielectric Materials.
  134925. *
  134926. * From dielectric fresnel rules: F0 = square((iorT - iorI) / (iorT + iorI))
  134927. */
  134928. get indexOfRefraction(): number;
  134929. set indexOfRefraction(value: number);
  134930. /**
  134931. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  134932. */
  134933. get invertRefractionY(): boolean;
  134934. set invertRefractionY(value: boolean);
  134935. /**
  134936. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  134937. * Materials half opaque for instance using refraction could benefit from this control.
  134938. */
  134939. get linkRefractionWithTransparency(): boolean;
  134940. set linkRefractionWithTransparency(value: boolean);
  134941. /**
  134942. * If true, the light map contains occlusion information instead of lighting info.
  134943. */
  134944. useLightmapAsShadowmap: boolean;
  134945. /**
  134946. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  134947. */
  134948. useAlphaFromAlbedoTexture: boolean;
  134949. /**
  134950. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  134951. */
  134952. forceAlphaTest: boolean;
  134953. /**
  134954. * Defines the alpha limits in alpha test mode.
  134955. */
  134956. alphaCutOff: number;
  134957. /**
  134958. * Specifies that the material will keep the specular highlights over a transparent surface (only the most limunous ones).
  134959. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  134960. */
  134961. useSpecularOverAlpha: boolean;
  134962. /**
  134963. * Specifies if the reflectivity texture contains the glossiness information in its alpha channel.
  134964. */
  134965. useMicroSurfaceFromReflectivityMapAlpha: boolean;
  134966. /**
  134967. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  134968. */
  134969. useRoughnessFromMetallicTextureAlpha: boolean;
  134970. /**
  134971. * Specifies if the metallic texture contains the roughness information in its green channel.
  134972. */
  134973. useRoughnessFromMetallicTextureGreen: boolean;
  134974. /**
  134975. * Specifies if the metallic texture contains the metallness information in its blue channel.
  134976. */
  134977. useMetallnessFromMetallicTextureBlue: boolean;
  134978. /**
  134979. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  134980. */
  134981. useAmbientOcclusionFromMetallicTextureRed: boolean;
  134982. /**
  134983. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  134984. */
  134985. useAmbientInGrayScale: boolean;
  134986. /**
  134987. * In case the reflectivity map does not contain the microsurface information in its alpha channel,
  134988. * The material will try to infer what glossiness each pixel should be.
  134989. */
  134990. useAutoMicroSurfaceFromReflectivityMap: boolean;
  134991. /**
  134992. * BJS is using an harcoded light falloff based on a manually sets up range.
  134993. * In PBR, one way to represents the fallof is to use the inverse squared root algorythm.
  134994. * This parameter can help you switch back to the BJS mode in order to create scenes using both materials.
  134995. */
  134996. get usePhysicalLightFalloff(): boolean;
  134997. /**
  134998. * BJS is using an harcoded light falloff based on a manually sets up range.
  134999. * In PBR, one way to represents the fallof is to use the inverse squared root algorythm.
  135000. * This parameter can help you switch back to the BJS mode in order to create scenes using both materials.
  135001. */
  135002. set usePhysicalLightFalloff(value: boolean);
  135003. /**
  135004. * In order to support the falloff compatibility with gltf, a special mode has been added
  135005. * to reproduce the gltf light falloff.
  135006. */
  135007. get useGLTFLightFalloff(): boolean;
  135008. /**
  135009. * In order to support the falloff compatibility with gltf, a special mode has been added
  135010. * to reproduce the gltf light falloff.
  135011. */
  135012. set useGLTFLightFalloff(value: boolean);
  135013. /**
  135014. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  135015. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  135016. */
  135017. useRadianceOverAlpha: boolean;
  135018. /**
  135019. * Allows using an object space normal map (instead of tangent space).
  135020. */
  135021. useObjectSpaceNormalMap: boolean;
  135022. /**
  135023. * Allows using the bump map in parallax mode.
  135024. */
  135025. useParallax: boolean;
  135026. /**
  135027. * Allows using the bump map in parallax occlusion mode.
  135028. */
  135029. useParallaxOcclusion: boolean;
  135030. /**
  135031. * Controls the scale bias of the parallax mode.
  135032. */
  135033. parallaxScaleBias: number;
  135034. /**
  135035. * If sets to true, disables all the lights affecting the material.
  135036. */
  135037. disableLighting: boolean;
  135038. /**
  135039. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  135040. */
  135041. forceIrradianceInFragment: boolean;
  135042. /**
  135043. * Number of Simultaneous lights allowed on the material.
  135044. */
  135045. maxSimultaneousLights: number;
  135046. /**
  135047. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  135048. */
  135049. invertNormalMapX: boolean;
  135050. /**
  135051. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  135052. */
  135053. invertNormalMapY: boolean;
  135054. /**
  135055. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  135056. */
  135057. twoSidedLighting: boolean;
  135058. /**
  135059. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  135060. * And/Or occlude the blended part. (alpha is converted to gamma to compute the fresnel)
  135061. */
  135062. useAlphaFresnel: boolean;
  135063. /**
  135064. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  135065. * And/Or occlude the blended part. (alpha stays linear to compute the fresnel)
  135066. */
  135067. useLinearAlphaFresnel: boolean;
  135068. /**
  135069. * Let user defines the brdf lookup texture used for IBL.
  135070. * A default 8bit version is embedded but you could point at :
  135071. * * Default texture: https://assets.babylonjs.com/environments/correlatedMSBRDF_RGBD.png
  135072. * * Default 16bit pixel depth texture: https://assets.babylonjs.com/environments/correlatedMSBRDF.dds
  135073. * * LEGACY Default None correlated https://assets.babylonjs.com/environments/uncorrelatedBRDF_RGBD.png
  135074. * * LEGACY Default None correlated 16bit pixel depth https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds
  135075. */
  135076. environmentBRDFTexture: Nullable<BaseTexture>;
  135077. /**
  135078. * Force normal to face away from face.
  135079. */
  135080. forceNormalForward: boolean;
  135081. /**
  135082. * Enables specular anti aliasing in the PBR shader.
  135083. * It will both interacts on the Geometry for analytical and IBL lighting.
  135084. * It also prefilter the roughness map based on the bump values.
  135085. */
  135086. enableSpecularAntiAliasing: boolean;
  135087. /**
  135088. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  135089. * makes the reflect vector face the model (under horizon).
  135090. */
  135091. useHorizonOcclusion: boolean;
  135092. /**
  135093. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  135094. * too much the area relying on ambient texture to define their ambient occlusion.
  135095. */
  135096. useRadianceOcclusion: boolean;
  135097. /**
  135098. * If set to true, no lighting calculations will be applied.
  135099. */
  135100. unlit: boolean;
  135101. /**
  135102. * Gets the image processing configuration used either in this material.
  135103. */
  135104. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  135105. /**
  135106. * Sets the Default image processing configuration used either in the this material.
  135107. *
  135108. * If sets to null, the scene one is in use.
  135109. */
  135110. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  135111. /**
  135112. * Gets wether the color curves effect is enabled.
  135113. */
  135114. get cameraColorCurvesEnabled(): boolean;
  135115. /**
  135116. * Sets wether the color curves effect is enabled.
  135117. */
  135118. set cameraColorCurvesEnabled(value: boolean);
  135119. /**
  135120. * Gets wether the color grading effect is enabled.
  135121. */
  135122. get cameraColorGradingEnabled(): boolean;
  135123. /**
  135124. * Gets wether the color grading effect is enabled.
  135125. */
  135126. set cameraColorGradingEnabled(value: boolean);
  135127. /**
  135128. * Gets wether tonemapping is enabled or not.
  135129. */
  135130. get cameraToneMappingEnabled(): boolean;
  135131. /**
  135132. * Sets wether tonemapping is enabled or not
  135133. */
  135134. set cameraToneMappingEnabled(value: boolean);
  135135. /**
  135136. * The camera exposure used on this material.
  135137. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  135138. * This corresponds to a photographic exposure.
  135139. */
  135140. get cameraExposure(): number;
  135141. /**
  135142. * The camera exposure used on this material.
  135143. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  135144. * This corresponds to a photographic exposure.
  135145. */
  135146. set cameraExposure(value: number);
  135147. /**
  135148. * Gets The camera contrast used on this material.
  135149. */
  135150. get cameraContrast(): number;
  135151. /**
  135152. * Sets The camera contrast used on this material.
  135153. */
  135154. set cameraContrast(value: number);
  135155. /**
  135156. * Gets the Color Grading 2D Lookup Texture.
  135157. */
  135158. get cameraColorGradingTexture(): Nullable<BaseTexture>;
  135159. /**
  135160. * Sets the Color Grading 2D Lookup Texture.
  135161. */
  135162. set cameraColorGradingTexture(value: Nullable<BaseTexture>);
  135163. /**
  135164. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  135165. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  135166. * 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;
  135167. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  135168. */
  135169. get cameraColorCurves(): Nullable<ColorCurves>;
  135170. /**
  135171. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  135172. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  135173. * 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;
  135174. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  135175. */
  135176. set cameraColorCurves(value: Nullable<ColorCurves>);
  135177. /**
  135178. * Instantiates a new PBRMaterial instance.
  135179. *
  135180. * @param name The material name
  135181. * @param scene The scene the material will be use in.
  135182. */
  135183. constructor(name: string, scene: Scene);
  135184. /**
  135185. * Returns the name of this material class.
  135186. */
  135187. getClassName(): string;
  135188. /**
  135189. * Makes a duplicate of the current material.
  135190. * @param name - name to use for the new material.
  135191. */
  135192. clone(name: string): PBRMaterial;
  135193. /**
  135194. * Serializes this PBR Material.
  135195. * @returns - An object with the serialized material.
  135196. */
  135197. serialize(): any;
  135198. /**
  135199. * Parses a PBR Material from a serialized object.
  135200. * @param source - Serialized object.
  135201. * @param scene - BJS scene instance.
  135202. * @param rootUrl - url for the scene object
  135203. * @returns - PBRMaterial
  135204. */
  135205. static Parse(source: any, scene: Scene, rootUrl: string): PBRMaterial;
  135206. }
  135207. }
  135208. declare module BABYLON {
  135209. /**
  135210. * Direct draw surface info
  135211. * @see https://docs.microsoft.com/en-us/windows/desktop/direct3ddds/dx-graphics-dds-pguide
  135212. */
  135213. export interface DDSInfo {
  135214. /**
  135215. * Width of the texture
  135216. */
  135217. width: number;
  135218. /**
  135219. * Width of the texture
  135220. */
  135221. height: number;
  135222. /**
  135223. * Number of Mipmaps for the texture
  135224. * @see https://en.wikipedia.org/wiki/Mipmap
  135225. */
  135226. mipmapCount: number;
  135227. /**
  135228. * If the textures format is a known fourCC format
  135229. * @see https://www.fourcc.org/
  135230. */
  135231. isFourCC: boolean;
  135232. /**
  135233. * If the texture is an RGB format eg. DXGI_FORMAT_B8G8R8X8_UNORM format
  135234. */
  135235. isRGB: boolean;
  135236. /**
  135237. * If the texture is a lumincance format
  135238. */
  135239. isLuminance: boolean;
  135240. /**
  135241. * If this is a cube texture
  135242. * @see https://docs.microsoft.com/en-us/windows/desktop/direct3ddds/dds-file-layout-for-cubic-environment-maps
  135243. */
  135244. isCube: boolean;
  135245. /**
  135246. * If the texture is a compressed format eg. FOURCC_DXT1
  135247. */
  135248. isCompressed: boolean;
  135249. /**
  135250. * The dxgiFormat of the texture
  135251. * @see https://docs.microsoft.com/en-us/windows/desktop/api/dxgiformat/ne-dxgiformat-dxgi_format
  135252. */
  135253. dxgiFormat: number;
  135254. /**
  135255. * Texture type eg. Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT
  135256. */
  135257. textureType: number;
  135258. /**
  135259. * Sphericle polynomial created for the dds texture
  135260. */
  135261. sphericalPolynomial?: SphericalPolynomial;
  135262. }
  135263. /**
  135264. * Class used to provide DDS decompression tools
  135265. */
  135266. export class DDSTools {
  135267. /**
  135268. * Gets or sets a boolean indicating that LOD info is stored in alpha channel (false by default)
  135269. */
  135270. static StoreLODInAlphaChannel: boolean;
  135271. /**
  135272. * Gets DDS information from an array buffer
  135273. * @param data defines the array buffer view to read data from
  135274. * @returns the DDS information
  135275. */
  135276. static GetDDSInfo(data: ArrayBufferView): DDSInfo;
  135277. private static _FloatView;
  135278. private static _Int32View;
  135279. private static _ToHalfFloat;
  135280. private static _FromHalfFloat;
  135281. private static _GetHalfFloatAsFloatRGBAArrayBuffer;
  135282. private static _GetHalfFloatRGBAArrayBuffer;
  135283. private static _GetFloatRGBAArrayBuffer;
  135284. private static _GetFloatAsUIntRGBAArrayBuffer;
  135285. private static _GetHalfFloatAsUIntRGBAArrayBuffer;
  135286. private static _GetRGBAArrayBuffer;
  135287. private static _ExtractLongWordOrder;
  135288. private static _GetRGBArrayBuffer;
  135289. private static _GetLuminanceArrayBuffer;
  135290. /**
  135291. * Uploads DDS Levels to a Babylon Texture
  135292. * @hidden
  135293. */
  135294. static UploadDDSLevels(engine: ThinEngine, texture: InternalTexture, data: ArrayBufferView, info: DDSInfo, loadMipmaps: boolean, faces: number, lodIndex?: number, currentFace?: number): void;
  135295. }
  135296. interface ThinEngine {
  135297. /**
  135298. * Create a cube texture from prefiltered data (ie. the mipmaps contain ready to use data for PBR reflection)
  135299. * @param rootUrl defines the url where the file to load is located
  135300. * @param scene defines the current scene
  135301. * @param lodScale defines scale to apply to the mip map selection
  135302. * @param lodOffset defines offset to apply to the mip map selection
  135303. * @param onLoad defines an optional callback raised when the texture is loaded
  135304. * @param onError defines an optional callback raised if there is an issue to load the texture
  135305. * @param format defines the format of the data
  135306. * @param forcedExtension defines the extension to use to pick the right loader
  135307. * @param createPolynomials defines wheter or not to create polynomails harmonics for the texture
  135308. * @returns the cube texture as an InternalTexture
  135309. */
  135310. 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;
  135311. }
  135312. }
  135313. declare module BABYLON {
  135314. /**
  135315. * Implementation of the DDS Texture Loader.
  135316. * @hidden
  135317. */
  135318. export class _DDSTextureLoader implements IInternalTextureLoader {
  135319. /**
  135320. * Defines wether the loader supports cascade loading the different faces.
  135321. */
  135322. readonly supportCascades: boolean;
  135323. /**
  135324. * This returns if the loader support the current file information.
  135325. * @param extension defines the file extension of the file being loaded
  135326. * @returns true if the loader can load the specified file
  135327. */
  135328. canLoad(extension: string): boolean;
  135329. /**
  135330. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  135331. * @param data contains the texture data
  135332. * @param texture defines the BabylonJS internal texture
  135333. * @param createPolynomials will be true if polynomials have been requested
  135334. * @param onLoad defines the callback to trigger once the texture is ready
  135335. * @param onError defines the callback to trigger in case of error
  135336. */
  135337. loadCubeData(imgs: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  135338. /**
  135339. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  135340. * @param data contains the texture data
  135341. * @param texture defines the BabylonJS internal texture
  135342. * @param callback defines the method to call once ready to upload
  135343. */
  135344. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  135345. }
  135346. }
  135347. declare module BABYLON {
  135348. /**
  135349. * Implementation of the ENV Texture Loader.
  135350. * @hidden
  135351. */
  135352. export class _ENVTextureLoader implements IInternalTextureLoader {
  135353. /**
  135354. * Defines wether the loader supports cascade loading the different faces.
  135355. */
  135356. readonly supportCascades: boolean;
  135357. /**
  135358. * This returns if the loader support the current file information.
  135359. * @param extension defines the file extension of the file being loaded
  135360. * @returns true if the loader can load the specified file
  135361. */
  135362. canLoad(extension: string): boolean;
  135363. /**
  135364. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  135365. * @param data contains the texture data
  135366. * @param texture defines the BabylonJS internal texture
  135367. * @param createPolynomials will be true if polynomials have been requested
  135368. * @param onLoad defines the callback to trigger once the texture is ready
  135369. * @param onError defines the callback to trigger in case of error
  135370. */
  135371. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  135372. /**
  135373. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  135374. * @param data contains the texture data
  135375. * @param texture defines the BabylonJS internal texture
  135376. * @param callback defines the method to call once ready to upload
  135377. */
  135378. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  135379. }
  135380. }
  135381. declare module BABYLON {
  135382. /**
  135383. * for description see https://www.khronos.org/opengles/sdk/tools/KTX/
  135384. * for file layout see https://www.khronos.org/opengles/sdk/tools/KTX/file_format_spec/
  135385. */
  135386. export class KhronosTextureContainer {
  135387. /** contents of the KTX container file */
  135388. data: ArrayBufferView;
  135389. private static HEADER_LEN;
  135390. private static COMPRESSED_2D;
  135391. private static COMPRESSED_3D;
  135392. private static TEX_2D;
  135393. private static TEX_3D;
  135394. /**
  135395. * Gets the openGL type
  135396. */
  135397. glType: number;
  135398. /**
  135399. * Gets the openGL type size
  135400. */
  135401. glTypeSize: number;
  135402. /**
  135403. * Gets the openGL format
  135404. */
  135405. glFormat: number;
  135406. /**
  135407. * Gets the openGL internal format
  135408. */
  135409. glInternalFormat: number;
  135410. /**
  135411. * Gets the base internal format
  135412. */
  135413. glBaseInternalFormat: number;
  135414. /**
  135415. * Gets image width in pixel
  135416. */
  135417. pixelWidth: number;
  135418. /**
  135419. * Gets image height in pixel
  135420. */
  135421. pixelHeight: number;
  135422. /**
  135423. * Gets image depth in pixels
  135424. */
  135425. pixelDepth: number;
  135426. /**
  135427. * Gets the number of array elements
  135428. */
  135429. numberOfArrayElements: number;
  135430. /**
  135431. * Gets the number of faces
  135432. */
  135433. numberOfFaces: number;
  135434. /**
  135435. * Gets the number of mipmap levels
  135436. */
  135437. numberOfMipmapLevels: number;
  135438. /**
  135439. * Gets the bytes of key value data
  135440. */
  135441. bytesOfKeyValueData: number;
  135442. /**
  135443. * Gets the load type
  135444. */
  135445. loadType: number;
  135446. /**
  135447. * If the container has been made invalid (eg. constructor failed to correctly load array buffer)
  135448. */
  135449. isInvalid: boolean;
  135450. /**
  135451. * Creates a new KhronosTextureContainer
  135452. * @param data contents of the KTX container file
  135453. * @param facesExpected should be either 1 or 6, based whether a cube texture or or
  135454. * @param threeDExpected provision for indicating that data should be a 3D texture, not implemented
  135455. * @param textureArrayExpected provision for indicating that data should be a texture array, not implemented
  135456. */
  135457. constructor(
  135458. /** contents of the KTX container file */
  135459. data: ArrayBufferView, facesExpected: number, threeDExpected?: boolean, textureArrayExpected?: boolean);
  135460. /**
  135461. * Uploads KTX content to a Babylon Texture.
  135462. * It is assumed that the texture has already been created & is currently bound
  135463. * @hidden
  135464. */
  135465. uploadLevels(texture: InternalTexture, loadMipmaps: boolean): void;
  135466. private _upload2DCompressedLevels;
  135467. /**
  135468. * Checks if the given data starts with a KTX file identifier.
  135469. * @param data the data to check
  135470. * @returns true if the data is a KTX file or false otherwise
  135471. */
  135472. static IsValid(data: ArrayBufferView): boolean;
  135473. }
  135474. }
  135475. declare module BABYLON {
  135476. /**
  135477. * Class for loading KTX2 files
  135478. * !!! Experimental Extension Subject to Changes !!!
  135479. * @hidden
  135480. */
  135481. export class KhronosTextureContainer2 {
  135482. private static _ModulePromise;
  135483. private static _TranscodeFormat;
  135484. constructor(engine: ThinEngine);
  135485. uploadAsync(data: ArrayBufferView, internalTexture: InternalTexture): Promise<void>;
  135486. private _determineTranscodeFormat;
  135487. /**
  135488. * Checks if the given data starts with a KTX2 file identifier.
  135489. * @param data the data to check
  135490. * @returns true if the data is a KTX2 file or false otherwise
  135491. */
  135492. static IsValid(data: ArrayBufferView): boolean;
  135493. }
  135494. }
  135495. declare module BABYLON {
  135496. /**
  135497. * Implementation of the KTX Texture Loader.
  135498. * @hidden
  135499. */
  135500. export class _KTXTextureLoader implements IInternalTextureLoader {
  135501. /**
  135502. * Defines wether the loader supports cascade loading the different faces.
  135503. */
  135504. readonly supportCascades: boolean;
  135505. /**
  135506. * This returns if the loader support the current file information.
  135507. * @param extension defines the file extension of the file being loaded
  135508. * @param mimeType defines the optional mime type of the file being loaded
  135509. * @returns true if the loader can load the specified file
  135510. */
  135511. canLoad(extension: string, mimeType?: string): boolean;
  135512. /**
  135513. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  135514. * @param data contains the texture data
  135515. * @param texture defines the BabylonJS internal texture
  135516. * @param createPolynomials will be true if polynomials have been requested
  135517. * @param onLoad defines the callback to trigger once the texture is ready
  135518. * @param onError defines the callback to trigger in case of error
  135519. */
  135520. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  135521. /**
  135522. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  135523. * @param data contains the texture data
  135524. * @param texture defines the BabylonJS internal texture
  135525. * @param callback defines the method to call once ready to upload
  135526. */
  135527. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void, loadFailed: boolean) => void): void;
  135528. }
  135529. }
  135530. declare module BABYLON {
  135531. /** @hidden */
  135532. export var _forceSceneHelpersToBundle: boolean;
  135533. interface Scene {
  135534. /**
  135535. * Creates a default light for the scene.
  135536. * @see https://doc.babylonjs.com/How_To/Fast_Build#create-default-light
  135537. * @param replace has the default false, when true replaces the existing lights in the scene with a hemispheric light
  135538. */
  135539. createDefaultLight(replace?: boolean): void;
  135540. /**
  135541. * Creates a default camera for the scene.
  135542. * @see https://doc.babylonjs.com/How_To/Fast_Build#create-default-camera
  135543. * @param createArcRotateCamera has the default false which creates a free camera, when true creates an arc rotate camera
  135544. * @param replace has default false, when true replaces the active camera in the scene
  135545. * @param attachCameraControls has default false, when true attaches camera controls to the canvas.
  135546. */
  135547. createDefaultCamera(createArcRotateCamera?: boolean, replace?: boolean, attachCameraControls?: boolean): void;
  135548. /**
  135549. * Creates a default camera and a default light.
  135550. * @see https://doc.babylonjs.com/how_to/Fast_Build#create-default-camera-or-light
  135551. * @param createArcRotateCamera has the default false which creates a free camera, when true creates an arc rotate camera
  135552. * @param replace has the default false, when true replaces the active camera/light in the scene
  135553. * @param attachCameraControls has the default false, when true attaches camera controls to the canvas.
  135554. */
  135555. createDefaultCameraOrLight(createArcRotateCamera?: boolean, replace?: boolean, attachCameraControls?: boolean): void;
  135556. /**
  135557. * Creates a new sky box
  135558. * @see https://doc.babylonjs.com/how_to/Fast_Build#create-default-skybox
  135559. * @param environmentTexture defines the texture to use as environment texture
  135560. * @param pbr has default false which requires the StandardMaterial to be used, when true PBRMaterial must be used
  135561. * @param scale defines the overall scale of the skybox
  135562. * @param blur is only available when pbr is true, default is 0, no blur, maximum value is 1
  135563. * @param setGlobalEnvTexture has default true indicating that scene.environmentTexture must match the current skybox texture
  135564. * @returns a new mesh holding the sky box
  135565. */
  135566. createDefaultSkybox(environmentTexture?: BaseTexture, pbr?: boolean, scale?: number, blur?: number, setGlobalEnvTexture?: boolean): Nullable<Mesh>;
  135567. /**
  135568. * Creates a new environment
  135569. * @see https://doc.babylonjs.com/How_To/Fast_Build#create-default-environment
  135570. * @param options defines the options you can use to configure the environment
  135571. * @returns the new EnvironmentHelper
  135572. */
  135573. createDefaultEnvironment(options?: Partial<IEnvironmentHelperOptions>): Nullable<EnvironmentHelper>;
  135574. /**
  135575. * Creates a new VREXperienceHelper
  135576. * @see https://doc.babylonjs.com/how_to/webvr_helper
  135577. * @param webVROptions defines the options used to create the new VREXperienceHelper
  135578. * @returns a new VREXperienceHelper
  135579. */
  135580. createDefaultVRExperience(webVROptions?: VRExperienceHelperOptions): VRExperienceHelper;
  135581. /**
  135582. * Creates a new WebXRDefaultExperience
  135583. * @see https://doc.babylonjs.com/how_to/introduction_to_webxr
  135584. * @param options experience options
  135585. * @returns a promise for a new WebXRDefaultExperience
  135586. */
  135587. createDefaultXRExperienceAsync(options: WebXRDefaultExperienceOptions): Promise<WebXRDefaultExperience>;
  135588. }
  135589. }
  135590. declare module BABYLON {
  135591. /**
  135592. * Display a 360/180 degree video on an approximately spherical surface, useful for VR applications or skyboxes.
  135593. * As a subclass of TransformNode, this allow parenting to the camera or multiple videos with different locations in the scene.
  135594. * This class achieves its effect with a VideoTexture and a correctly configured BackgroundMaterial on an inverted sphere.
  135595. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  135596. */
  135597. export class VideoDome extends TransformNode {
  135598. /**
  135599. * Define the video source as a Monoscopic panoramic 360 video.
  135600. */
  135601. static readonly MODE_MONOSCOPIC: number;
  135602. /**
  135603. * Define the video source as a Stereoscopic TopBottom/OverUnder panoramic 360 video.
  135604. */
  135605. static readonly MODE_TOPBOTTOM: number;
  135606. /**
  135607. * Define the video source as a Stereoscopic Side by Side panoramic 360 video.
  135608. */
  135609. static readonly MODE_SIDEBYSIDE: number;
  135610. private _halfDome;
  135611. private _useDirectMapping;
  135612. /**
  135613. * The video texture being displayed on the sphere
  135614. */
  135615. protected _videoTexture: VideoTexture;
  135616. /**
  135617. * Gets the video texture being displayed on the sphere
  135618. */
  135619. get videoTexture(): VideoTexture;
  135620. /**
  135621. * The skybox material
  135622. */
  135623. protected _material: BackgroundMaterial;
  135624. /**
  135625. * The surface used for the video dome
  135626. */
  135627. protected _mesh: Mesh;
  135628. /**
  135629. * Gets the mesh used for the video dome.
  135630. */
  135631. get mesh(): Mesh;
  135632. /**
  135633. * A mesh that will be used to mask the back of the video dome in case it is a 180 degree movie.
  135634. */
  135635. private _halfDomeMask;
  135636. /**
  135637. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  135638. * Also see the options.resolution property.
  135639. */
  135640. get fovMultiplier(): number;
  135641. set fovMultiplier(value: number);
  135642. private _videoMode;
  135643. /**
  135644. * Gets or set the current video mode for the video. It can be:
  135645. * * VideoDome.MODE_MONOSCOPIC : Define the video source as a Monoscopic panoramic 360 video.
  135646. * * VideoDome.MODE_TOPBOTTOM : Define the video source as a Stereoscopic TopBottom/OverUnder panoramic 360 video.
  135647. * * VideoDome.MODE_SIDEBYSIDE : Define the video source as a Stereoscopic Side by Side panoramic 360 video.
  135648. */
  135649. get videoMode(): number;
  135650. set videoMode(value: number);
  135651. /**
  135652. * Is the video a 180 degrees video (half dome) or 360 video (full dome)
  135653. *
  135654. */
  135655. get halfDome(): boolean;
  135656. /**
  135657. * Set the halfDome mode. If set, only the front (180 degrees) will be displayed and the back will be blacked out.
  135658. */
  135659. set halfDome(enabled: boolean);
  135660. /**
  135661. * Oberserver used in Stereoscopic VR Mode.
  135662. */
  135663. private _onBeforeCameraRenderObserver;
  135664. /**
  135665. * Create an instance of this class and pass through the parameters to the relevant classes, VideoTexture, StandardMaterial, and Mesh.
  135666. * @param name Element's name, child elements will append suffixes for their own names.
  135667. * @param urlsOrVideo defines the url(s) or the video element to use
  135668. * @param options An object containing optional or exposed sub element properties
  135669. */
  135670. constructor(name: string, urlsOrVideo: string | string[] | HTMLVideoElement, options: {
  135671. resolution?: number;
  135672. clickToPlay?: boolean;
  135673. autoPlay?: boolean;
  135674. loop?: boolean;
  135675. size?: number;
  135676. poster?: string;
  135677. faceForward?: boolean;
  135678. useDirectMapping?: boolean;
  135679. halfDomeMode?: boolean;
  135680. }, scene: Scene);
  135681. private _changeVideoMode;
  135682. /**
  135683. * Releases resources associated with this node.
  135684. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  135685. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  135686. */
  135687. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  135688. }
  135689. }
  135690. declare module BABYLON {
  135691. /**
  135692. * This class can be used to get instrumentation data from a Babylon engine
  135693. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  135694. */
  135695. export class EngineInstrumentation implements IDisposable {
  135696. /**
  135697. * Define the instrumented engine.
  135698. */
  135699. engine: Engine;
  135700. private _captureGPUFrameTime;
  135701. private _gpuFrameTimeToken;
  135702. private _gpuFrameTime;
  135703. private _captureShaderCompilationTime;
  135704. private _shaderCompilationTime;
  135705. private _onBeginFrameObserver;
  135706. private _onEndFrameObserver;
  135707. private _onBeforeShaderCompilationObserver;
  135708. private _onAfterShaderCompilationObserver;
  135709. /**
  135710. * Gets the perf counter used for GPU frame time
  135711. */
  135712. get gpuFrameTimeCounter(): PerfCounter;
  135713. /**
  135714. * Gets the GPU frame time capture status
  135715. */
  135716. get captureGPUFrameTime(): boolean;
  135717. /**
  135718. * Enable or disable the GPU frame time capture
  135719. */
  135720. set captureGPUFrameTime(value: boolean);
  135721. /**
  135722. * Gets the perf counter used for shader compilation time
  135723. */
  135724. get shaderCompilationTimeCounter(): PerfCounter;
  135725. /**
  135726. * Gets the shader compilation time capture status
  135727. */
  135728. get captureShaderCompilationTime(): boolean;
  135729. /**
  135730. * Enable or disable the shader compilation time capture
  135731. */
  135732. set captureShaderCompilationTime(value: boolean);
  135733. /**
  135734. * Instantiates a new engine instrumentation.
  135735. * This class can be used to get instrumentation data from a Babylon engine
  135736. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  135737. * @param engine Defines the engine to instrument
  135738. */
  135739. constructor(
  135740. /**
  135741. * Define the instrumented engine.
  135742. */
  135743. engine: Engine);
  135744. /**
  135745. * Dispose and release associated resources.
  135746. */
  135747. dispose(): void;
  135748. }
  135749. }
  135750. declare module BABYLON {
  135751. /**
  135752. * This class can be used to get instrumentation data from a Babylon engine
  135753. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#sceneinstrumentation
  135754. */
  135755. export class SceneInstrumentation implements IDisposable {
  135756. /**
  135757. * Defines the scene to instrument
  135758. */
  135759. scene: Scene;
  135760. private _captureActiveMeshesEvaluationTime;
  135761. private _activeMeshesEvaluationTime;
  135762. private _captureRenderTargetsRenderTime;
  135763. private _renderTargetsRenderTime;
  135764. private _captureFrameTime;
  135765. private _frameTime;
  135766. private _captureRenderTime;
  135767. private _renderTime;
  135768. private _captureInterFrameTime;
  135769. private _interFrameTime;
  135770. private _captureParticlesRenderTime;
  135771. private _particlesRenderTime;
  135772. private _captureSpritesRenderTime;
  135773. private _spritesRenderTime;
  135774. private _capturePhysicsTime;
  135775. private _physicsTime;
  135776. private _captureAnimationsTime;
  135777. private _animationsTime;
  135778. private _captureCameraRenderTime;
  135779. private _cameraRenderTime;
  135780. private _onBeforeActiveMeshesEvaluationObserver;
  135781. private _onAfterActiveMeshesEvaluationObserver;
  135782. private _onBeforeRenderTargetsRenderObserver;
  135783. private _onAfterRenderTargetsRenderObserver;
  135784. private _onAfterRenderObserver;
  135785. private _onBeforeDrawPhaseObserver;
  135786. private _onAfterDrawPhaseObserver;
  135787. private _onBeforeAnimationsObserver;
  135788. private _onBeforeParticlesRenderingObserver;
  135789. private _onAfterParticlesRenderingObserver;
  135790. private _onBeforeSpritesRenderingObserver;
  135791. private _onAfterSpritesRenderingObserver;
  135792. private _onBeforePhysicsObserver;
  135793. private _onAfterPhysicsObserver;
  135794. private _onAfterAnimationsObserver;
  135795. private _onBeforeCameraRenderObserver;
  135796. private _onAfterCameraRenderObserver;
  135797. /**
  135798. * Gets the perf counter used for active meshes evaluation time
  135799. */
  135800. get activeMeshesEvaluationTimeCounter(): PerfCounter;
  135801. /**
  135802. * Gets the active meshes evaluation time capture status
  135803. */
  135804. get captureActiveMeshesEvaluationTime(): boolean;
  135805. /**
  135806. * Enable or disable the active meshes evaluation time capture
  135807. */
  135808. set captureActiveMeshesEvaluationTime(value: boolean);
  135809. /**
  135810. * Gets the perf counter used for render targets render time
  135811. */
  135812. get renderTargetsRenderTimeCounter(): PerfCounter;
  135813. /**
  135814. * Gets the render targets render time capture status
  135815. */
  135816. get captureRenderTargetsRenderTime(): boolean;
  135817. /**
  135818. * Enable or disable the render targets render time capture
  135819. */
  135820. set captureRenderTargetsRenderTime(value: boolean);
  135821. /**
  135822. * Gets the perf counter used for particles render time
  135823. */
  135824. get particlesRenderTimeCounter(): PerfCounter;
  135825. /**
  135826. * Gets the particles render time capture status
  135827. */
  135828. get captureParticlesRenderTime(): boolean;
  135829. /**
  135830. * Enable or disable the particles render time capture
  135831. */
  135832. set captureParticlesRenderTime(value: boolean);
  135833. /**
  135834. * Gets the perf counter used for sprites render time
  135835. */
  135836. get spritesRenderTimeCounter(): PerfCounter;
  135837. /**
  135838. * Gets the sprites render time capture status
  135839. */
  135840. get captureSpritesRenderTime(): boolean;
  135841. /**
  135842. * Enable or disable the sprites render time capture
  135843. */
  135844. set captureSpritesRenderTime(value: boolean);
  135845. /**
  135846. * Gets the perf counter used for physics time
  135847. */
  135848. get physicsTimeCounter(): PerfCounter;
  135849. /**
  135850. * Gets the physics time capture status
  135851. */
  135852. get capturePhysicsTime(): boolean;
  135853. /**
  135854. * Enable or disable the physics time capture
  135855. */
  135856. set capturePhysicsTime(value: boolean);
  135857. /**
  135858. * Gets the perf counter used for animations time
  135859. */
  135860. get animationsTimeCounter(): PerfCounter;
  135861. /**
  135862. * Gets the animations time capture status
  135863. */
  135864. get captureAnimationsTime(): boolean;
  135865. /**
  135866. * Enable or disable the animations time capture
  135867. */
  135868. set captureAnimationsTime(value: boolean);
  135869. /**
  135870. * Gets the perf counter used for frame time capture
  135871. */
  135872. get frameTimeCounter(): PerfCounter;
  135873. /**
  135874. * Gets the frame time capture status
  135875. */
  135876. get captureFrameTime(): boolean;
  135877. /**
  135878. * Enable or disable the frame time capture
  135879. */
  135880. set captureFrameTime(value: boolean);
  135881. /**
  135882. * Gets the perf counter used for inter-frames time capture
  135883. */
  135884. get interFrameTimeCounter(): PerfCounter;
  135885. /**
  135886. * Gets the inter-frames time capture status
  135887. */
  135888. get captureInterFrameTime(): boolean;
  135889. /**
  135890. * Enable or disable the inter-frames time capture
  135891. */
  135892. set captureInterFrameTime(value: boolean);
  135893. /**
  135894. * Gets the perf counter used for render time capture
  135895. */
  135896. get renderTimeCounter(): PerfCounter;
  135897. /**
  135898. * Gets the render time capture status
  135899. */
  135900. get captureRenderTime(): boolean;
  135901. /**
  135902. * Enable or disable the render time capture
  135903. */
  135904. set captureRenderTime(value: boolean);
  135905. /**
  135906. * Gets the perf counter used for camera render time capture
  135907. */
  135908. get cameraRenderTimeCounter(): PerfCounter;
  135909. /**
  135910. * Gets the camera render time capture status
  135911. */
  135912. get captureCameraRenderTime(): boolean;
  135913. /**
  135914. * Enable or disable the camera render time capture
  135915. */
  135916. set captureCameraRenderTime(value: boolean);
  135917. /**
  135918. * Gets the perf counter used for draw calls
  135919. */
  135920. get drawCallsCounter(): PerfCounter;
  135921. /**
  135922. * Instantiates a new scene instrumentation.
  135923. * This class can be used to get instrumentation data from a Babylon engine
  135924. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#sceneinstrumentation
  135925. * @param scene Defines the scene to instrument
  135926. */
  135927. constructor(
  135928. /**
  135929. * Defines the scene to instrument
  135930. */
  135931. scene: Scene);
  135932. /**
  135933. * Dispose and release associated resources.
  135934. */
  135935. dispose(): void;
  135936. }
  135937. }
  135938. declare module BABYLON {
  135939. /** @hidden */
  135940. export var glowMapGenerationPixelShader: {
  135941. name: string;
  135942. shader: string;
  135943. };
  135944. }
  135945. declare module BABYLON {
  135946. /** @hidden */
  135947. export var glowMapGenerationVertexShader: {
  135948. name: string;
  135949. shader: string;
  135950. };
  135951. }
  135952. declare module BABYLON {
  135953. /**
  135954. * Effect layer options. This helps customizing the behaviour
  135955. * of the effect layer.
  135956. */
  135957. export interface IEffectLayerOptions {
  135958. /**
  135959. * Multiplication factor apply to the canvas size to compute the render target size
  135960. * used to generated the objects (the smaller the faster).
  135961. */
  135962. mainTextureRatio: number;
  135963. /**
  135964. * Enforces a fixed size texture to ensure effect stability across devices.
  135965. */
  135966. mainTextureFixedSize?: number;
  135967. /**
  135968. * Alpha blending mode used to apply the blur. Default depends of the implementation.
  135969. */
  135970. alphaBlendingMode: number;
  135971. /**
  135972. * The camera attached to the layer.
  135973. */
  135974. camera: Nullable<Camera>;
  135975. /**
  135976. * The rendering group to draw the layer in.
  135977. */
  135978. renderingGroupId: number;
  135979. }
  135980. /**
  135981. * The effect layer Helps adding post process effect blended with the main pass.
  135982. *
  135983. * This can be for instance use to generate glow or higlight effects on the scene.
  135984. *
  135985. * The effect layer class can not be used directly and is intented to inherited from to be
  135986. * customized per effects.
  135987. */
  135988. export abstract class EffectLayer {
  135989. private _vertexBuffers;
  135990. private _indexBuffer;
  135991. private _cachedDefines;
  135992. private _effectLayerMapGenerationEffect;
  135993. private _effectLayerOptions;
  135994. private _mergeEffect;
  135995. protected _scene: Scene;
  135996. protected _engine: Engine;
  135997. protected _maxSize: number;
  135998. protected _mainTextureDesiredSize: ISize;
  135999. protected _mainTexture: RenderTargetTexture;
  136000. protected _shouldRender: boolean;
  136001. protected _postProcesses: PostProcess[];
  136002. protected _textures: BaseTexture[];
  136003. protected _emissiveTextureAndColor: {
  136004. texture: Nullable<BaseTexture>;
  136005. color: Color4;
  136006. };
  136007. /**
  136008. * The name of the layer
  136009. */
  136010. name: string;
  136011. /**
  136012. * The clear color of the texture used to generate the glow map.
  136013. */
  136014. neutralColor: Color4;
  136015. /**
  136016. * Specifies whether the highlight layer is enabled or not.
  136017. */
  136018. isEnabled: boolean;
  136019. /**
  136020. * Gets the camera attached to the layer.
  136021. */
  136022. get camera(): Nullable<Camera>;
  136023. /**
  136024. * Gets the rendering group id the layer should render in.
  136025. */
  136026. get renderingGroupId(): number;
  136027. set renderingGroupId(renderingGroupId: number);
  136028. /**
  136029. * An event triggered when the effect layer has been disposed.
  136030. */
  136031. onDisposeObservable: Observable<EffectLayer>;
  136032. /**
  136033. * An event triggered when the effect layer is about rendering the main texture with the glowy parts.
  136034. */
  136035. onBeforeRenderMainTextureObservable: Observable<EffectLayer>;
  136036. /**
  136037. * An event triggered when the generated texture is being merged in the scene.
  136038. */
  136039. onBeforeComposeObservable: Observable<EffectLayer>;
  136040. /**
  136041. * An event triggered when the mesh is rendered into the effect render target.
  136042. */
  136043. onBeforeRenderMeshToEffect: Observable<AbstractMesh>;
  136044. /**
  136045. * An event triggered after the mesh has been rendered into the effect render target.
  136046. */
  136047. onAfterRenderMeshToEffect: Observable<AbstractMesh>;
  136048. /**
  136049. * An event triggered when the generated texture has been merged in the scene.
  136050. */
  136051. onAfterComposeObservable: Observable<EffectLayer>;
  136052. /**
  136053. * An event triggered when the efffect layer changes its size.
  136054. */
  136055. onSizeChangedObservable: Observable<EffectLayer>;
  136056. /** @hidden */
  136057. static _SceneComponentInitialization: (scene: Scene) => void;
  136058. /**
  136059. * Instantiates a new effect Layer and references it in the scene.
  136060. * @param name The name of the layer
  136061. * @param scene The scene to use the layer in
  136062. */
  136063. constructor(
  136064. /** The Friendly of the effect in the scene */
  136065. name: string, scene: Scene);
  136066. /**
  136067. * Get the effect name of the layer.
  136068. * @return The effect name
  136069. */
  136070. abstract getEffectName(): string;
  136071. /**
  136072. * Checks for the readiness of the element composing the layer.
  136073. * @param subMesh the mesh to check for
  136074. * @param useInstances specify whether or not to use instances to render the mesh
  136075. * @return true if ready otherwise, false
  136076. */
  136077. abstract isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  136078. /**
  136079. * Returns whether or nood the layer needs stencil enabled during the mesh rendering.
  136080. * @returns true if the effect requires stencil during the main canvas render pass.
  136081. */
  136082. abstract needStencil(): boolean;
  136083. /**
  136084. * Create the merge effect. This is the shader use to blit the information back
  136085. * to the main canvas at the end of the scene rendering.
  136086. * @returns The effect containing the shader used to merge the effect on the main canvas
  136087. */
  136088. protected abstract _createMergeEffect(): Effect;
  136089. /**
  136090. * Creates the render target textures and post processes used in the effect layer.
  136091. */
  136092. protected abstract _createTextureAndPostProcesses(): void;
  136093. /**
  136094. * Implementation specific of rendering the generating effect on the main canvas.
  136095. * @param effect The effect used to render through
  136096. */
  136097. protected abstract _internalRender(effect: Effect): void;
  136098. /**
  136099. * Sets the required values for both the emissive texture and and the main color.
  136100. */
  136101. protected abstract _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  136102. /**
  136103. * Free any resources and references associated to a mesh.
  136104. * Internal use
  136105. * @param mesh The mesh to free.
  136106. */
  136107. abstract _disposeMesh(mesh: Mesh): void;
  136108. /**
  136109. * Serializes this layer (Glow or Highlight for example)
  136110. * @returns a serialized layer object
  136111. */
  136112. abstract serialize?(): any;
  136113. /**
  136114. * Initializes the effect layer with the required options.
  136115. * @param options Sets of none mandatory options to use with the layer (see IEffectLayerOptions for more information)
  136116. */
  136117. protected _init(options: Partial<IEffectLayerOptions>): void;
  136118. /**
  136119. * Generates the index buffer of the full screen quad blending to the main canvas.
  136120. */
  136121. private _generateIndexBuffer;
  136122. /**
  136123. * Generates the vertex buffer of the full screen quad blending to the main canvas.
  136124. */
  136125. private _generateVertexBuffer;
  136126. /**
  136127. * Sets the main texture desired size which is the closest power of two
  136128. * of the engine canvas size.
  136129. */
  136130. private _setMainTextureSize;
  136131. /**
  136132. * Creates the main texture for the effect layer.
  136133. */
  136134. protected _createMainTexture(): void;
  136135. /**
  136136. * Adds specific effects defines.
  136137. * @param defines The defines to add specifics to.
  136138. */
  136139. protected _addCustomEffectDefines(defines: string[]): void;
  136140. /**
  136141. * Checks for the readiness of the element composing the layer.
  136142. * @param subMesh the mesh to check for
  136143. * @param useInstances specify whether or not to use instances to render the mesh
  136144. * @param emissiveTexture the associated emissive texture used to generate the glow
  136145. * @return true if ready otherwise, false
  136146. */
  136147. protected _isReady(subMesh: SubMesh, useInstances: boolean, emissiveTexture: Nullable<BaseTexture>): boolean;
  136148. /**
  136149. * Renders the glowing part of the scene by blending the blurred glowing meshes on top of the rendered scene.
  136150. */
  136151. render(): void;
  136152. /**
  136153. * Determine if a given mesh will be used in the current effect.
  136154. * @param mesh mesh to test
  136155. * @returns true if the mesh will be used
  136156. */
  136157. hasMesh(mesh: AbstractMesh): boolean;
  136158. /**
  136159. * Returns true if the layer contains information to display, otherwise false.
  136160. * @returns true if the glow layer should be rendered
  136161. */
  136162. shouldRender(): boolean;
  136163. /**
  136164. * Returns true if the mesh should render, otherwise false.
  136165. * @param mesh The mesh to render
  136166. * @returns true if it should render otherwise false
  136167. */
  136168. protected _shouldRenderMesh(mesh: AbstractMesh): boolean;
  136169. /**
  136170. * Returns true if the mesh can be rendered, otherwise false.
  136171. * @param mesh The mesh to render
  136172. * @param material The material used on the mesh
  136173. * @returns true if it can be rendered otherwise false
  136174. */
  136175. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  136176. /**
  136177. * Returns true if the mesh should render, otherwise false.
  136178. * @param mesh The mesh to render
  136179. * @returns true if it should render otherwise false
  136180. */
  136181. protected _shouldRenderEmissiveTextureForMesh(): boolean;
  136182. /**
  136183. * Renders the submesh passed in parameter to the generation map.
  136184. */
  136185. protected _renderSubMesh(subMesh: SubMesh, enableAlphaMode?: boolean): void;
  136186. /**
  136187. * Defines whether the current material of the mesh should be use to render the effect.
  136188. * @param mesh defines the current mesh to render
  136189. */
  136190. protected _useMeshMaterial(mesh: AbstractMesh): boolean;
  136191. /**
  136192. * Rebuild the required buffers.
  136193. * @hidden Internal use only.
  136194. */
  136195. _rebuild(): void;
  136196. /**
  136197. * Dispose only the render target textures and post process.
  136198. */
  136199. private _disposeTextureAndPostProcesses;
  136200. /**
  136201. * Dispose the highlight layer and free resources.
  136202. */
  136203. dispose(): void;
  136204. /**
  136205. * Gets the class name of the effect layer
  136206. * @returns the string with the class name of the effect layer
  136207. */
  136208. getClassName(): string;
  136209. /**
  136210. * Creates an effect layer from parsed effect layer data
  136211. * @param parsedEffectLayer defines effect layer data
  136212. * @param scene defines the current scene
  136213. * @param rootUrl defines the root URL containing the effect layer information
  136214. * @returns a parsed effect Layer
  136215. */
  136216. static Parse(parsedEffectLayer: any, scene: Scene, rootUrl: string): EffectLayer;
  136217. }
  136218. }
  136219. declare module BABYLON {
  136220. interface AbstractScene {
  136221. /**
  136222. * The list of effect layers (highlights/glow) added to the scene
  136223. * @see https://doc.babylonjs.com/how_to/highlight_layer
  136224. * @see https://doc.babylonjs.com/how_to/glow_layer
  136225. */
  136226. effectLayers: Array<EffectLayer>;
  136227. /**
  136228. * Removes the given effect layer from this scene.
  136229. * @param toRemove defines the effect layer to remove
  136230. * @returns the index of the removed effect layer
  136231. */
  136232. removeEffectLayer(toRemove: EffectLayer): number;
  136233. /**
  136234. * Adds the given effect layer to this scene
  136235. * @param newEffectLayer defines the effect layer to add
  136236. */
  136237. addEffectLayer(newEffectLayer: EffectLayer): void;
  136238. }
  136239. /**
  136240. * Defines the layer scene component responsible to manage any effect layers
  136241. * in a given scene.
  136242. */
  136243. export class EffectLayerSceneComponent implements ISceneSerializableComponent {
  136244. /**
  136245. * The component name helpfull to identify the component in the list of scene components.
  136246. */
  136247. readonly name: string;
  136248. /**
  136249. * The scene the component belongs to.
  136250. */
  136251. scene: Scene;
  136252. private _engine;
  136253. private _renderEffects;
  136254. private _needStencil;
  136255. private _previousStencilState;
  136256. /**
  136257. * Creates a new instance of the component for the given scene
  136258. * @param scene Defines the scene to register the component in
  136259. */
  136260. constructor(scene: Scene);
  136261. /**
  136262. * Registers the component in a given scene
  136263. */
  136264. register(): void;
  136265. /**
  136266. * Rebuilds the elements related to this component in case of
  136267. * context lost for instance.
  136268. */
  136269. rebuild(): void;
  136270. /**
  136271. * Serializes the component data to the specified json object
  136272. * @param serializationObject The object to serialize to
  136273. */
  136274. serialize(serializationObject: any): void;
  136275. /**
  136276. * Adds all the elements from the container to the scene
  136277. * @param container the container holding the elements
  136278. */
  136279. addFromContainer(container: AbstractScene): void;
  136280. /**
  136281. * Removes all the elements in the container from the scene
  136282. * @param container contains the elements to remove
  136283. * @param dispose if the removed element should be disposed (default: false)
  136284. */
  136285. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  136286. /**
  136287. * Disposes the component and the associated ressources.
  136288. */
  136289. dispose(): void;
  136290. private _isReadyForMesh;
  136291. private _renderMainTexture;
  136292. private _setStencil;
  136293. private _setStencilBack;
  136294. private _draw;
  136295. private _drawCamera;
  136296. private _drawRenderingGroup;
  136297. }
  136298. }
  136299. declare module BABYLON {
  136300. /** @hidden */
  136301. export var glowMapMergePixelShader: {
  136302. name: string;
  136303. shader: string;
  136304. };
  136305. }
  136306. declare module BABYLON {
  136307. /** @hidden */
  136308. export var glowMapMergeVertexShader: {
  136309. name: string;
  136310. shader: string;
  136311. };
  136312. }
  136313. declare module BABYLON {
  136314. interface AbstractScene {
  136315. /**
  136316. * Return a the first highlight layer of the scene with a given name.
  136317. * @param name The name of the highlight layer to look for.
  136318. * @return The highlight layer if found otherwise null.
  136319. */
  136320. getGlowLayerByName(name: string): Nullable<GlowLayer>;
  136321. }
  136322. /**
  136323. * Glow layer options. This helps customizing the behaviour
  136324. * of the glow layer.
  136325. */
  136326. export interface IGlowLayerOptions {
  136327. /**
  136328. * Multiplication factor apply to the canvas size to compute the render target size
  136329. * used to generated the glowing objects (the smaller the faster).
  136330. */
  136331. mainTextureRatio: number;
  136332. /**
  136333. * Enforces a fixed size texture to ensure resize independant blur.
  136334. */
  136335. mainTextureFixedSize?: number;
  136336. /**
  136337. * How big is the kernel of the blur texture.
  136338. */
  136339. blurKernelSize: number;
  136340. /**
  136341. * The camera attached to the layer.
  136342. */
  136343. camera: Nullable<Camera>;
  136344. /**
  136345. * Enable MSAA by chosing the number of samples.
  136346. */
  136347. mainTextureSamples?: number;
  136348. /**
  136349. * The rendering group to draw the layer in.
  136350. */
  136351. renderingGroupId: number;
  136352. }
  136353. /**
  136354. * The glow layer Helps adding a glow effect around the emissive parts of a mesh.
  136355. *
  136356. * Once instantiated in a scene, by default, all the emissive meshes will glow.
  136357. *
  136358. * Documentation: https://doc.babylonjs.com/how_to/glow_layer
  136359. */
  136360. export class GlowLayer extends EffectLayer {
  136361. /**
  136362. * Effect Name of the layer.
  136363. */
  136364. static readonly EffectName: string;
  136365. /**
  136366. * The default blur kernel size used for the glow.
  136367. */
  136368. static DefaultBlurKernelSize: number;
  136369. /**
  136370. * The default texture size ratio used for the glow.
  136371. */
  136372. static DefaultTextureRatio: number;
  136373. /**
  136374. * Sets the kernel size of the blur.
  136375. */
  136376. set blurKernelSize(value: number);
  136377. /**
  136378. * Gets the kernel size of the blur.
  136379. */
  136380. get blurKernelSize(): number;
  136381. /**
  136382. * Sets the glow intensity.
  136383. */
  136384. set intensity(value: number);
  136385. /**
  136386. * Gets the glow intensity.
  136387. */
  136388. get intensity(): number;
  136389. private _options;
  136390. private _intensity;
  136391. private _horizontalBlurPostprocess1;
  136392. private _verticalBlurPostprocess1;
  136393. private _horizontalBlurPostprocess2;
  136394. private _verticalBlurPostprocess2;
  136395. private _blurTexture1;
  136396. private _blurTexture2;
  136397. private _postProcesses1;
  136398. private _postProcesses2;
  136399. private _includedOnlyMeshes;
  136400. private _excludedMeshes;
  136401. private _meshesUsingTheirOwnMaterials;
  136402. /**
  136403. * Callback used to let the user override the color selection on a per mesh basis
  136404. */
  136405. customEmissiveColorSelector: (mesh: Mesh, subMesh: SubMesh, material: Material, result: Color4) => void;
  136406. /**
  136407. * Callback used to let the user override the texture selection on a per mesh basis
  136408. */
  136409. customEmissiveTextureSelector: (mesh: Mesh, subMesh: SubMesh, material: Material) => Texture;
  136410. /**
  136411. * Instantiates a new glow Layer and references it to the scene.
  136412. * @param name The name of the layer
  136413. * @param scene The scene to use the layer in
  136414. * @param options Sets of none mandatory options to use with the layer (see IGlowLayerOptions for more information)
  136415. */
  136416. constructor(name: string, scene: Scene, options?: Partial<IGlowLayerOptions>);
  136417. /**
  136418. * Get the effect name of the layer.
  136419. * @return The effect name
  136420. */
  136421. getEffectName(): string;
  136422. /**
  136423. * Create the merge effect. This is the shader use to blit the information back
  136424. * to the main canvas at the end of the scene rendering.
  136425. */
  136426. protected _createMergeEffect(): Effect;
  136427. /**
  136428. * Creates the render target textures and post processes used in the glow layer.
  136429. */
  136430. protected _createTextureAndPostProcesses(): void;
  136431. /**
  136432. * Checks for the readiness of the element composing the layer.
  136433. * @param subMesh the mesh to check for
  136434. * @param useInstances specify wether or not to use instances to render the mesh
  136435. * @param emissiveTexture the associated emissive texture used to generate the glow
  136436. * @return true if ready otherwise, false
  136437. */
  136438. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  136439. /**
  136440. * Returns whether or nood the layer needs stencil enabled during the mesh rendering.
  136441. */
  136442. needStencil(): boolean;
  136443. /**
  136444. * Returns true if the mesh can be rendered, otherwise false.
  136445. * @param mesh The mesh to render
  136446. * @param material The material used on the mesh
  136447. * @returns true if it can be rendered otherwise false
  136448. */
  136449. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  136450. /**
  136451. * Implementation specific of rendering the generating effect on the main canvas.
  136452. * @param effect The effect used to render through
  136453. */
  136454. protected _internalRender(effect: Effect): void;
  136455. /**
  136456. * Sets the required values for both the emissive texture and and the main color.
  136457. */
  136458. protected _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  136459. /**
  136460. * Returns true if the mesh should render, otherwise false.
  136461. * @param mesh The mesh to render
  136462. * @returns true if it should render otherwise false
  136463. */
  136464. protected _shouldRenderMesh(mesh: Mesh): boolean;
  136465. /**
  136466. * Adds specific effects defines.
  136467. * @param defines The defines to add specifics to.
  136468. */
  136469. protected _addCustomEffectDefines(defines: string[]): void;
  136470. /**
  136471. * Add a mesh in the exclusion list to prevent it to impact or being impacted by the glow layer.
  136472. * @param mesh The mesh to exclude from the glow layer
  136473. */
  136474. addExcludedMesh(mesh: Mesh): void;
  136475. /**
  136476. * Remove a mesh from the exclusion list to let it impact or being impacted by the glow layer.
  136477. * @param mesh The mesh to remove
  136478. */
  136479. removeExcludedMesh(mesh: Mesh): void;
  136480. /**
  136481. * Add a mesh in the inclusion list to impact or being impacted by the glow layer.
  136482. * @param mesh The mesh to include in the glow layer
  136483. */
  136484. addIncludedOnlyMesh(mesh: Mesh): void;
  136485. /**
  136486. * Remove a mesh from the Inclusion list to prevent it to impact or being impacted by the glow layer.
  136487. * @param mesh The mesh to remove
  136488. */
  136489. removeIncludedOnlyMesh(mesh: Mesh): void;
  136490. /**
  136491. * Determine if a given mesh will be used in the glow layer
  136492. * @param mesh The mesh to test
  136493. * @returns true if the mesh will be highlighted by the current glow layer
  136494. */
  136495. hasMesh(mesh: AbstractMesh): boolean;
  136496. /**
  136497. * Defines whether the current material of the mesh should be use to render the effect.
  136498. * @param mesh defines the current mesh to render
  136499. */
  136500. protected _useMeshMaterial(mesh: AbstractMesh): boolean;
  136501. /**
  136502. * Add a mesh to be rendered through its own material and not with emissive only.
  136503. * @param mesh The mesh for which we need to use its material
  136504. */
  136505. referenceMeshToUseItsOwnMaterial(mesh: AbstractMesh): void;
  136506. /**
  136507. * Remove a mesh from being rendered through its own material and not with emissive only.
  136508. * @param mesh The mesh for which we need to not use its material
  136509. */
  136510. unReferenceMeshFromUsingItsOwnMaterial(mesh: AbstractMesh): void;
  136511. /**
  136512. * Free any resources and references associated to a mesh.
  136513. * Internal use
  136514. * @param mesh The mesh to free.
  136515. * @hidden
  136516. */
  136517. _disposeMesh(mesh: Mesh): void;
  136518. /**
  136519. * Gets the class name of the effect layer
  136520. * @returns the string with the class name of the effect layer
  136521. */
  136522. getClassName(): string;
  136523. /**
  136524. * Serializes this glow layer
  136525. * @returns a serialized glow layer object
  136526. */
  136527. serialize(): any;
  136528. /**
  136529. * Creates a Glow Layer from parsed glow layer data
  136530. * @param parsedGlowLayer defines glow layer data
  136531. * @param scene defines the current scene
  136532. * @param rootUrl defines the root URL containing the glow layer information
  136533. * @returns a parsed Glow Layer
  136534. */
  136535. static Parse(parsedGlowLayer: any, scene: Scene, rootUrl: string): GlowLayer;
  136536. }
  136537. }
  136538. declare module BABYLON {
  136539. /** @hidden */
  136540. export var glowBlurPostProcessPixelShader: {
  136541. name: string;
  136542. shader: string;
  136543. };
  136544. }
  136545. declare module BABYLON {
  136546. interface AbstractScene {
  136547. /**
  136548. * Return a the first highlight layer of the scene with a given name.
  136549. * @param name The name of the highlight layer to look for.
  136550. * @return The highlight layer if found otherwise null.
  136551. */
  136552. getHighlightLayerByName(name: string): Nullable<HighlightLayer>;
  136553. }
  136554. /**
  136555. * Highlight layer options. This helps customizing the behaviour
  136556. * of the highlight layer.
  136557. */
  136558. export interface IHighlightLayerOptions {
  136559. /**
  136560. * Multiplication factor apply to the canvas size to compute the render target size
  136561. * used to generated the glowing objects (the smaller the faster).
  136562. */
  136563. mainTextureRatio: number;
  136564. /**
  136565. * Enforces a fixed size texture to ensure resize independant blur.
  136566. */
  136567. mainTextureFixedSize?: number;
  136568. /**
  136569. * Multiplication factor apply to the main texture size in the first step of the blur to reduce the size
  136570. * of the picture to blur (the smaller the faster).
  136571. */
  136572. blurTextureSizeRatio: number;
  136573. /**
  136574. * How big in texel of the blur texture is the vertical blur.
  136575. */
  136576. blurVerticalSize: number;
  136577. /**
  136578. * How big in texel of the blur texture is the horizontal blur.
  136579. */
  136580. blurHorizontalSize: number;
  136581. /**
  136582. * Alpha blending mode used to apply the blur. Default is combine.
  136583. */
  136584. alphaBlendingMode: number;
  136585. /**
  136586. * The camera attached to the layer.
  136587. */
  136588. camera: Nullable<Camera>;
  136589. /**
  136590. * Should we display highlight as a solid stroke?
  136591. */
  136592. isStroke?: boolean;
  136593. /**
  136594. * The rendering group to draw the layer in.
  136595. */
  136596. renderingGroupId: number;
  136597. }
  136598. /**
  136599. * The highlight layer Helps adding a glow effect around a mesh.
  136600. *
  136601. * Once instantiated in a scene, simply use the addMesh or removeMesh method to add or remove
  136602. * glowy meshes to your scene.
  136603. *
  136604. * !!! THIS REQUIRES AN ACTIVE STENCIL BUFFER ON THE CANVAS !!!
  136605. */
  136606. export class HighlightLayer extends EffectLayer {
  136607. name: string;
  136608. /**
  136609. * Effect Name of the highlight layer.
  136610. */
  136611. static readonly EffectName: string;
  136612. /**
  136613. * The neutral color used during the preparation of the glow effect.
  136614. * This is black by default as the blend operation is a blend operation.
  136615. */
  136616. static NeutralColor: Color4;
  136617. /**
  136618. * Stencil value used for glowing meshes.
  136619. */
  136620. static GlowingMeshStencilReference: number;
  136621. /**
  136622. * Stencil value used for the other meshes in the scene.
  136623. */
  136624. static NormalMeshStencilReference: number;
  136625. /**
  136626. * Specifies whether or not the inner glow is ACTIVE in the layer.
  136627. */
  136628. innerGlow: boolean;
  136629. /**
  136630. * Specifies whether or not the outer glow is ACTIVE in the layer.
  136631. */
  136632. outerGlow: boolean;
  136633. /**
  136634. * Specifies the horizontal size of the blur.
  136635. */
  136636. set blurHorizontalSize(value: number);
  136637. /**
  136638. * Specifies the vertical size of the blur.
  136639. */
  136640. set blurVerticalSize(value: number);
  136641. /**
  136642. * Gets the horizontal size of the blur.
  136643. */
  136644. get blurHorizontalSize(): number;
  136645. /**
  136646. * Gets the vertical size of the blur.
  136647. */
  136648. get blurVerticalSize(): number;
  136649. /**
  136650. * An event triggered when the highlight layer is being blurred.
  136651. */
  136652. onBeforeBlurObservable: Observable<HighlightLayer>;
  136653. /**
  136654. * An event triggered when the highlight layer has been blurred.
  136655. */
  136656. onAfterBlurObservable: Observable<HighlightLayer>;
  136657. private _instanceGlowingMeshStencilReference;
  136658. private _options;
  136659. private _downSamplePostprocess;
  136660. private _horizontalBlurPostprocess;
  136661. private _verticalBlurPostprocess;
  136662. private _blurTexture;
  136663. private _meshes;
  136664. private _excludedMeshes;
  136665. /**
  136666. * Instantiates a new highlight Layer and references it to the scene..
  136667. * @param name The name of the layer
  136668. * @param scene The scene to use the layer in
  136669. * @param options Sets of none mandatory options to use with the layer (see IHighlightLayerOptions for more information)
  136670. */
  136671. constructor(name: string, scene: Scene, options?: Partial<IHighlightLayerOptions>);
  136672. /**
  136673. * Get the effect name of the layer.
  136674. * @return The effect name
  136675. */
  136676. getEffectName(): string;
  136677. /**
  136678. * Create the merge effect. This is the shader use to blit the information back
  136679. * to the main canvas at the end of the scene rendering.
  136680. */
  136681. protected _createMergeEffect(): Effect;
  136682. /**
  136683. * Creates the render target textures and post processes used in the highlight layer.
  136684. */
  136685. protected _createTextureAndPostProcesses(): void;
  136686. /**
  136687. * Returns wether or nood the layer needs stencil enabled during the mesh rendering.
  136688. */
  136689. needStencil(): boolean;
  136690. /**
  136691. * Checks for the readiness of the element composing the layer.
  136692. * @param subMesh the mesh to check for
  136693. * @param useInstances specify wether or not to use instances to render the mesh
  136694. * @param emissiveTexture the associated emissive texture used to generate the glow
  136695. * @return true if ready otherwise, false
  136696. */
  136697. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  136698. /**
  136699. * Implementation specific of rendering the generating effect on the main canvas.
  136700. * @param effect The effect used to render through
  136701. */
  136702. protected _internalRender(effect: Effect): void;
  136703. /**
  136704. * Returns true if the layer contains information to display, otherwise false.
  136705. */
  136706. shouldRender(): boolean;
  136707. /**
  136708. * Returns true if the mesh should render, otherwise false.
  136709. * @param mesh The mesh to render
  136710. * @returns true if it should render otherwise false
  136711. */
  136712. protected _shouldRenderMesh(mesh: Mesh): boolean;
  136713. /**
  136714. * Returns true if the mesh can be rendered, otherwise false.
  136715. * @param mesh The mesh to render
  136716. * @param material The material used on the mesh
  136717. * @returns true if it can be rendered otherwise false
  136718. */
  136719. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  136720. /**
  136721. * Adds specific effects defines.
  136722. * @param defines The defines to add specifics to.
  136723. */
  136724. protected _addCustomEffectDefines(defines: string[]): void;
  136725. /**
  136726. * Sets the required values for both the emissive texture and and the main color.
  136727. */
  136728. protected _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  136729. /**
  136730. * Add a mesh in the exclusion list to prevent it to impact or being impacted by the highlight layer.
  136731. * @param mesh The mesh to exclude from the highlight layer
  136732. */
  136733. addExcludedMesh(mesh: Mesh): void;
  136734. /**
  136735. * Remove a mesh from the exclusion list to let it impact or being impacted by the highlight layer.
  136736. * @param mesh The mesh to highlight
  136737. */
  136738. removeExcludedMesh(mesh: Mesh): void;
  136739. /**
  136740. * Determine if a given mesh will be highlighted by the current HighlightLayer
  136741. * @param mesh mesh to test
  136742. * @returns true if the mesh will be highlighted by the current HighlightLayer
  136743. */
  136744. hasMesh(mesh: AbstractMesh): boolean;
  136745. /**
  136746. * Add a mesh in the highlight layer in order to make it glow with the chosen color.
  136747. * @param mesh The mesh to highlight
  136748. * @param color The color of the highlight
  136749. * @param glowEmissiveOnly Extract the glow from the emissive texture
  136750. */
  136751. addMesh(mesh: Mesh, color: Color3, glowEmissiveOnly?: boolean): void;
  136752. /**
  136753. * Remove a mesh from the highlight layer in order to make it stop glowing.
  136754. * @param mesh The mesh to highlight
  136755. */
  136756. removeMesh(mesh: Mesh): void;
  136757. /**
  136758. * Remove all the meshes currently referenced in the highlight layer
  136759. */
  136760. removeAllMeshes(): void;
  136761. /**
  136762. * Force the stencil to the normal expected value for none glowing parts
  136763. */
  136764. private _defaultStencilReference;
  136765. /**
  136766. * Free any resources and references associated to a mesh.
  136767. * Internal use
  136768. * @param mesh The mesh to free.
  136769. * @hidden
  136770. */
  136771. _disposeMesh(mesh: Mesh): void;
  136772. /**
  136773. * Dispose the highlight layer and free resources.
  136774. */
  136775. dispose(): void;
  136776. /**
  136777. * Gets the class name of the effect layer
  136778. * @returns the string with the class name of the effect layer
  136779. */
  136780. getClassName(): string;
  136781. /**
  136782. * Serializes this Highlight layer
  136783. * @returns a serialized Highlight layer object
  136784. */
  136785. serialize(): any;
  136786. /**
  136787. * Creates a Highlight layer from parsed Highlight layer data
  136788. * @param parsedHightlightLayer defines the Highlight layer data
  136789. * @param scene defines the current scene
  136790. * @param rootUrl defines the root URL containing the Highlight layer information
  136791. * @returns a parsed Highlight layer
  136792. */
  136793. static Parse(parsedHightlightLayer: any, scene: Scene, rootUrl: string): HighlightLayer;
  136794. }
  136795. }
  136796. declare module BABYLON {
  136797. interface AbstractScene {
  136798. /**
  136799. * The list of layers (background and foreground) of the scene
  136800. */
  136801. layers: Array<Layer>;
  136802. }
  136803. /**
  136804. * Defines the layer scene component responsible to manage any layers
  136805. * in a given scene.
  136806. */
  136807. export class LayerSceneComponent implements ISceneComponent {
  136808. /**
  136809. * The component name helpfull to identify the component in the list of scene components.
  136810. */
  136811. readonly name: string;
  136812. /**
  136813. * The scene the component belongs to.
  136814. */
  136815. scene: Scene;
  136816. private _engine;
  136817. /**
  136818. * Creates a new instance of the component for the given scene
  136819. * @param scene Defines the scene to register the component in
  136820. */
  136821. constructor(scene: Scene);
  136822. /**
  136823. * Registers the component in a given scene
  136824. */
  136825. register(): void;
  136826. /**
  136827. * Rebuilds the elements related to this component in case of
  136828. * context lost for instance.
  136829. */
  136830. rebuild(): void;
  136831. /**
  136832. * Disposes the component and the associated ressources.
  136833. */
  136834. dispose(): void;
  136835. private _draw;
  136836. private _drawCameraPredicate;
  136837. private _drawCameraBackground;
  136838. private _drawCameraForeground;
  136839. private _drawRenderTargetPredicate;
  136840. private _drawRenderTargetBackground;
  136841. private _drawRenderTargetForeground;
  136842. /**
  136843. * Adds all the elements from the container to the scene
  136844. * @param container the container holding the elements
  136845. */
  136846. addFromContainer(container: AbstractScene): void;
  136847. /**
  136848. * Removes all the elements in the container from the scene
  136849. * @param container contains the elements to remove
  136850. * @param dispose if the removed element should be disposed (default: false)
  136851. */
  136852. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  136853. }
  136854. }
  136855. declare module BABYLON {
  136856. /** @hidden */
  136857. export var layerPixelShader: {
  136858. name: string;
  136859. shader: string;
  136860. };
  136861. }
  136862. declare module BABYLON {
  136863. /** @hidden */
  136864. export var layerVertexShader: {
  136865. name: string;
  136866. shader: string;
  136867. };
  136868. }
  136869. declare module BABYLON {
  136870. /**
  136871. * This represents a full screen 2d layer.
  136872. * This can be useful to display a picture in the background of your scene for instance.
  136873. * @see https://www.babylonjs-playground.com/#08A2BS#1
  136874. */
  136875. export class Layer {
  136876. /**
  136877. * Define the name of the layer.
  136878. */
  136879. name: string;
  136880. /**
  136881. * Define the texture the layer should display.
  136882. */
  136883. texture: Nullable<Texture>;
  136884. /**
  136885. * Is the layer in background or foreground.
  136886. */
  136887. isBackground: boolean;
  136888. /**
  136889. * Define the color of the layer (instead of texture).
  136890. */
  136891. color: Color4;
  136892. /**
  136893. * Define the scale of the layer in order to zoom in out of the texture.
  136894. */
  136895. scale: Vector2;
  136896. /**
  136897. * Define an offset for the layer in order to shift the texture.
  136898. */
  136899. offset: Vector2;
  136900. /**
  136901. * Define the alpha blending mode used in the layer in case the texture or color has an alpha.
  136902. */
  136903. alphaBlendingMode: number;
  136904. /**
  136905. * Define if the layer should alpha test or alpha blend with the rest of the scene.
  136906. * Alpha test will not mix with the background color in case of transparency.
  136907. * It will either use the texture color or the background depending on the alpha value of the current pixel.
  136908. */
  136909. alphaTest: boolean;
  136910. /**
  136911. * Define a mask to restrict the layer to only some of the scene cameras.
  136912. */
  136913. layerMask: number;
  136914. /**
  136915. * Define the list of render target the layer is visible into.
  136916. */
  136917. renderTargetTextures: RenderTargetTexture[];
  136918. /**
  136919. * Define if the layer is only used in renderTarget or if it also
  136920. * renders in the main frame buffer of the canvas.
  136921. */
  136922. renderOnlyInRenderTargetTextures: boolean;
  136923. private _scene;
  136924. private _vertexBuffers;
  136925. private _indexBuffer;
  136926. private _effect;
  136927. private _previousDefines;
  136928. /**
  136929. * An event triggered when the layer is disposed.
  136930. */
  136931. onDisposeObservable: Observable<Layer>;
  136932. private _onDisposeObserver;
  136933. /**
  136934. * Back compatibility with callback before the onDisposeObservable existed.
  136935. * The set callback will be triggered when the layer has been disposed.
  136936. */
  136937. set onDispose(callback: () => void);
  136938. /**
  136939. * An event triggered before rendering the scene
  136940. */
  136941. onBeforeRenderObservable: Observable<Layer>;
  136942. private _onBeforeRenderObserver;
  136943. /**
  136944. * Back compatibility with callback before the onBeforeRenderObservable existed.
  136945. * The set callback will be triggered just before rendering the layer.
  136946. */
  136947. set onBeforeRender(callback: () => void);
  136948. /**
  136949. * An event triggered after rendering the scene
  136950. */
  136951. onAfterRenderObservable: Observable<Layer>;
  136952. private _onAfterRenderObserver;
  136953. /**
  136954. * Back compatibility with callback before the onAfterRenderObservable existed.
  136955. * The set callback will be triggered just after rendering the layer.
  136956. */
  136957. set onAfterRender(callback: () => void);
  136958. /**
  136959. * Instantiates a new layer.
  136960. * This represents a full screen 2d layer.
  136961. * This can be useful to display a picture in the background of your scene for instance.
  136962. * @see https://www.babylonjs-playground.com/#08A2BS#1
  136963. * @param name Define the name of the layer in the scene
  136964. * @param imgUrl Define the url of the texture to display in the layer
  136965. * @param scene Define the scene the layer belongs to
  136966. * @param isBackground Defines whether the layer is displayed in front or behind the scene
  136967. * @param color Defines a color for the layer
  136968. */
  136969. constructor(
  136970. /**
  136971. * Define the name of the layer.
  136972. */
  136973. name: string, imgUrl: Nullable<string>, scene: Nullable<Scene>, isBackground?: boolean, color?: Color4);
  136974. private _createIndexBuffer;
  136975. /** @hidden */
  136976. _rebuild(): void;
  136977. /**
  136978. * Renders the layer in the scene.
  136979. */
  136980. render(): void;
  136981. /**
  136982. * Disposes and releases the associated ressources.
  136983. */
  136984. dispose(): void;
  136985. }
  136986. }
  136987. declare module BABYLON {
  136988. /** @hidden */
  136989. export var lensFlarePixelShader: {
  136990. name: string;
  136991. shader: string;
  136992. };
  136993. }
  136994. declare module BABYLON {
  136995. /** @hidden */
  136996. export var lensFlareVertexShader: {
  136997. name: string;
  136998. shader: string;
  136999. };
  137000. }
  137001. declare module BABYLON {
  137002. /**
  137003. * This represents a Lens Flare System or the shiny effect created by the light reflection on the camera lenses.
  137004. * It is usually composed of several `lensFlare`.
  137005. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  137006. */
  137007. export class LensFlareSystem {
  137008. /**
  137009. * Define the name of the lens flare system
  137010. */
  137011. name: string;
  137012. /**
  137013. * List of lens flares used in this system.
  137014. */
  137015. lensFlares: LensFlare[];
  137016. /**
  137017. * Define a limit from the border the lens flare can be visible.
  137018. */
  137019. borderLimit: number;
  137020. /**
  137021. * Define a viewport border we do not want to see the lens flare in.
  137022. */
  137023. viewportBorder: number;
  137024. /**
  137025. * Define a predicate which could limit the list of meshes able to occlude the effect.
  137026. */
  137027. meshesSelectionPredicate: (mesh: AbstractMesh) => boolean;
  137028. /**
  137029. * Restricts the rendering of the effect to only the camera rendering this layer mask.
  137030. */
  137031. layerMask: number;
  137032. /**
  137033. * Define the id of the lens flare system in the scene.
  137034. * (equal to name by default)
  137035. */
  137036. id: string;
  137037. private _scene;
  137038. private _emitter;
  137039. private _vertexBuffers;
  137040. private _indexBuffer;
  137041. private _effect;
  137042. private _positionX;
  137043. private _positionY;
  137044. private _isEnabled;
  137045. /** @hidden */
  137046. static _SceneComponentInitialization: (scene: Scene) => void;
  137047. /**
  137048. * Instantiates a lens flare system.
  137049. * This represents a Lens Flare System or the shiny effect created by the light reflection on the camera lenses.
  137050. * It is usually composed of several `lensFlare`.
  137051. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  137052. * @param name Define the name of the lens flare system in the scene
  137053. * @param emitter Define the source (the emitter) of the lens flares (it can be a camera, a light or a mesh).
  137054. * @param scene Define the scene the lens flare system belongs to
  137055. */
  137056. constructor(
  137057. /**
  137058. * Define the name of the lens flare system
  137059. */
  137060. name: string, emitter: any, scene: Scene);
  137061. /**
  137062. * Define if the lens flare system is enabled.
  137063. */
  137064. get isEnabled(): boolean;
  137065. set isEnabled(value: boolean);
  137066. /**
  137067. * Get the scene the effects belongs to.
  137068. * @returns the scene holding the lens flare system
  137069. */
  137070. getScene(): Scene;
  137071. /**
  137072. * Get the emitter of the lens flare system.
  137073. * It defines the source of the lens flares (it can be a camera, a light or a mesh).
  137074. * @returns the emitter of the lens flare system
  137075. */
  137076. getEmitter(): any;
  137077. /**
  137078. * Set the emitter of the lens flare system.
  137079. * It defines the source of the lens flares (it can be a camera, a light or a mesh).
  137080. * @param newEmitter Define the new emitter of the system
  137081. */
  137082. setEmitter(newEmitter: any): void;
  137083. /**
  137084. * Get the lens flare system emitter position.
  137085. * The emitter defines the source of the lens flares (it can be a camera, a light or a mesh).
  137086. * @returns the position
  137087. */
  137088. getEmitterPosition(): Vector3;
  137089. /**
  137090. * @hidden
  137091. */
  137092. computeEffectivePosition(globalViewport: Viewport): boolean;
  137093. /** @hidden */
  137094. _isVisible(): boolean;
  137095. /**
  137096. * @hidden
  137097. */
  137098. render(): boolean;
  137099. /**
  137100. * Dispose and release the lens flare with its associated resources.
  137101. */
  137102. dispose(): void;
  137103. /**
  137104. * Parse a lens flare system from a JSON repressentation
  137105. * @param parsedLensFlareSystem Define the JSON to parse
  137106. * @param scene Define the scene the parsed system should be instantiated in
  137107. * @param rootUrl Define the rootUrl of the load sequence to easily find a load relative dependencies such as textures
  137108. * @returns the parsed system
  137109. */
  137110. static Parse(parsedLensFlareSystem: any, scene: Scene, rootUrl: string): LensFlareSystem;
  137111. /**
  137112. * Serialize the current Lens Flare System into a JSON representation.
  137113. * @returns the serialized JSON
  137114. */
  137115. serialize(): any;
  137116. }
  137117. }
  137118. declare module BABYLON {
  137119. /**
  137120. * This represents one of the lens effect in a `lensFlareSystem`.
  137121. * It controls one of the indiviual texture used in the effect.
  137122. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  137123. */
  137124. export class LensFlare {
  137125. /**
  137126. * Define the size of the lens flare in the system (a floating value between 0 and 1)
  137127. */
  137128. size: number;
  137129. /**
  137130. * 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.
  137131. */
  137132. position: number;
  137133. /**
  137134. * Define the lens color.
  137135. */
  137136. color: Color3;
  137137. /**
  137138. * Define the lens texture.
  137139. */
  137140. texture: Nullable<Texture>;
  137141. /**
  137142. * Define the alpha mode to render this particular lens.
  137143. */
  137144. alphaMode: number;
  137145. private _system;
  137146. /**
  137147. * Creates a new Lens Flare.
  137148. * This represents one of the lens effect in a `lensFlareSystem`.
  137149. * It controls one of the indiviual texture used in the effect.
  137150. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  137151. * @param size Define the size of the lens flare (a floating value between 0 and 1)
  137152. * @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.
  137153. * @param color Define the lens color
  137154. * @param imgUrl Define the lens texture url
  137155. * @param system Define the `lensFlareSystem` this flare is part of
  137156. * @returns The newly created Lens Flare
  137157. */
  137158. static AddFlare(size: number, position: number, color: Color3, imgUrl: string, system: LensFlareSystem): LensFlare;
  137159. /**
  137160. * Instantiates a new Lens Flare.
  137161. * This represents one of the lens effect in a `lensFlareSystem`.
  137162. * It controls one of the indiviual texture used in the effect.
  137163. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  137164. * @param size Define the size of the lens flare in the system (a floating value between 0 and 1)
  137165. * @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.
  137166. * @param color Define the lens color
  137167. * @param imgUrl Define the lens texture url
  137168. * @param system Define the `lensFlareSystem` this flare is part of
  137169. */
  137170. constructor(
  137171. /**
  137172. * Define the size of the lens flare in the system (a floating value between 0 and 1)
  137173. */
  137174. size: number,
  137175. /**
  137176. * 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.
  137177. */
  137178. position: number, color: Color3, imgUrl: string, system: LensFlareSystem);
  137179. /**
  137180. * Dispose and release the lens flare with its associated resources.
  137181. */
  137182. dispose(): void;
  137183. }
  137184. }
  137185. declare module BABYLON {
  137186. interface AbstractScene {
  137187. /**
  137188. * The list of lens flare system added to the scene
  137189. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  137190. */
  137191. lensFlareSystems: Array<LensFlareSystem>;
  137192. /**
  137193. * Removes the given lens flare system from this scene.
  137194. * @param toRemove The lens flare system to remove
  137195. * @returns The index of the removed lens flare system
  137196. */
  137197. removeLensFlareSystem(toRemove: LensFlareSystem): number;
  137198. /**
  137199. * Adds the given lens flare system to this scene
  137200. * @param newLensFlareSystem The lens flare system to add
  137201. */
  137202. addLensFlareSystem(newLensFlareSystem: LensFlareSystem): void;
  137203. /**
  137204. * Gets a lens flare system using its name
  137205. * @param name defines the name to look for
  137206. * @returns the lens flare system or null if not found
  137207. */
  137208. getLensFlareSystemByName(name: string): Nullable<LensFlareSystem>;
  137209. /**
  137210. * Gets a lens flare system using its id
  137211. * @param id defines the id to look for
  137212. * @returns the lens flare system or null if not found
  137213. */
  137214. getLensFlareSystemByID(id: string): Nullable<LensFlareSystem>;
  137215. }
  137216. /**
  137217. * Defines the lens flare scene component responsible to manage any lens flares
  137218. * in a given scene.
  137219. */
  137220. export class LensFlareSystemSceneComponent implements ISceneSerializableComponent {
  137221. /**
  137222. * The component name helpfull to identify the component in the list of scene components.
  137223. */
  137224. readonly name: string;
  137225. /**
  137226. * The scene the component belongs to.
  137227. */
  137228. scene: Scene;
  137229. /**
  137230. * Creates a new instance of the component for the given scene
  137231. * @param scene Defines the scene to register the component in
  137232. */
  137233. constructor(scene: Scene);
  137234. /**
  137235. * Registers the component in a given scene
  137236. */
  137237. register(): void;
  137238. /**
  137239. * Rebuilds the elements related to this component in case of
  137240. * context lost for instance.
  137241. */
  137242. rebuild(): void;
  137243. /**
  137244. * Adds all the elements from the container to the scene
  137245. * @param container the container holding the elements
  137246. */
  137247. addFromContainer(container: AbstractScene): void;
  137248. /**
  137249. * Removes all the elements in the container from the scene
  137250. * @param container contains the elements to remove
  137251. * @param dispose if the removed element should be disposed (default: false)
  137252. */
  137253. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  137254. /**
  137255. * Serializes the component data to the specified json object
  137256. * @param serializationObject The object to serialize to
  137257. */
  137258. serialize(serializationObject: any): void;
  137259. /**
  137260. * Disposes the component and the associated ressources.
  137261. */
  137262. dispose(): void;
  137263. private _draw;
  137264. }
  137265. }
  137266. declare module BABYLON {
  137267. /** @hidden */
  137268. export var depthPixelShader: {
  137269. name: string;
  137270. shader: string;
  137271. };
  137272. }
  137273. declare module BABYLON {
  137274. /** @hidden */
  137275. export var depthVertexShader: {
  137276. name: string;
  137277. shader: string;
  137278. };
  137279. }
  137280. declare module BABYLON {
  137281. /**
  137282. * This represents a depth renderer in Babylon.
  137283. * A depth renderer will render to it's depth map every frame which can be displayed or used in post processing
  137284. */
  137285. export class DepthRenderer {
  137286. private _scene;
  137287. private _depthMap;
  137288. private _effect;
  137289. private readonly _storeNonLinearDepth;
  137290. private readonly _clearColor;
  137291. /** Get if the depth renderer is using packed depth or not */
  137292. readonly isPacked: boolean;
  137293. private _cachedDefines;
  137294. private _camera;
  137295. /** Enable or disable the depth renderer. When disabled, the depth texture is not updated */
  137296. enabled: boolean;
  137297. /**
  137298. * Specifiess that the depth renderer will only be used within
  137299. * the camera it is created for.
  137300. * This can help forcing its rendering during the camera processing.
  137301. */
  137302. useOnlyInActiveCamera: boolean;
  137303. /** @hidden */
  137304. static _SceneComponentInitialization: (scene: Scene) => void;
  137305. /**
  137306. * Instantiates a depth renderer
  137307. * @param scene The scene the renderer belongs to
  137308. * @param type The texture type of the depth map (default: Engine.TEXTURETYPE_FLOAT)
  137309. * @param camera The camera to be used to render the depth map (default: scene's active camera)
  137310. * @param storeNonLinearDepth Defines whether the depth is stored linearly like in Babylon Shadows or directly like glFragCoord.z
  137311. */
  137312. constructor(scene: Scene, type?: number, camera?: Nullable<Camera>, storeNonLinearDepth?: boolean);
  137313. /**
  137314. * Creates the depth rendering effect and checks if the effect is ready.
  137315. * @param subMesh The submesh to be used to render the depth map of
  137316. * @param useInstances If multiple world instances should be used
  137317. * @returns if the depth renderer is ready to render the depth map
  137318. */
  137319. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  137320. /**
  137321. * Gets the texture which the depth map will be written to.
  137322. * @returns The depth map texture
  137323. */
  137324. getDepthMap(): RenderTargetTexture;
  137325. /**
  137326. * Disposes of the depth renderer.
  137327. */
  137328. dispose(): void;
  137329. }
  137330. }
  137331. declare module BABYLON {
  137332. /** @hidden */
  137333. export var minmaxReduxPixelShader: {
  137334. name: string;
  137335. shader: string;
  137336. };
  137337. }
  137338. declare module BABYLON {
  137339. /**
  137340. * This class computes a min/max reduction from a texture: it means it computes the minimum
  137341. * and maximum values from all values of the texture.
  137342. * It is performed on the GPU for better performances, thanks to a succession of post processes.
  137343. * The source values are read from the red channel of the texture.
  137344. */
  137345. export class MinMaxReducer {
  137346. /**
  137347. * Observable triggered when the computation has been performed
  137348. */
  137349. onAfterReductionPerformed: Observable<{
  137350. min: number;
  137351. max: number;
  137352. }>;
  137353. protected _camera: Camera;
  137354. protected _sourceTexture: Nullable<RenderTargetTexture>;
  137355. protected _reductionSteps: Nullable<Array<PostProcess>>;
  137356. protected _postProcessManager: PostProcessManager;
  137357. protected _onAfterUnbindObserver: Nullable<Observer<RenderTargetTexture>>;
  137358. protected _forceFullscreenViewport: boolean;
  137359. /**
  137360. * Creates a min/max reducer
  137361. * @param camera The camera to use for the post processes
  137362. */
  137363. constructor(camera: Camera);
  137364. /**
  137365. * Gets the texture used to read the values from.
  137366. */
  137367. get sourceTexture(): Nullable<RenderTargetTexture>;
  137368. /**
  137369. * Sets the source texture to read the values from.
  137370. * One must indicate if the texture is a depth texture or not through the depthRedux parameter
  137371. * because in such textures '1' value must not be taken into account to compute the maximum
  137372. * as this value is used to clear the texture.
  137373. * Note that the computation is not activated by calling this function, you must call activate() for that!
  137374. * @param sourceTexture The texture to read the values from. The values should be in the red channel.
  137375. * @param depthRedux Indicates if the texture is a depth texture or not
  137376. * @param type The type of the textures created for the reduction (defaults to TEXTURETYPE_HALF_FLOAT)
  137377. * @param forceFullscreenViewport Forces the post processes used for the reduction to be applied without taking into account viewport (defaults to true)
  137378. */
  137379. setSourceTexture(sourceTexture: RenderTargetTexture, depthRedux: boolean, type?: number, forceFullscreenViewport?: boolean): void;
  137380. /**
  137381. * Defines the refresh rate of the computation.
  137382. * Use 0 to compute just once, 1 to compute on every frame, 2 to compute every two frames and so on...
  137383. */
  137384. get refreshRate(): number;
  137385. set refreshRate(value: number);
  137386. protected _activated: boolean;
  137387. /**
  137388. * Gets the activation status of the reducer
  137389. */
  137390. get activated(): boolean;
  137391. /**
  137392. * Activates the reduction computation.
  137393. * When activated, the observers registered in onAfterReductionPerformed are
  137394. * called after the compuation is performed
  137395. */
  137396. activate(): void;
  137397. /**
  137398. * Deactivates the reduction computation.
  137399. */
  137400. deactivate(): void;
  137401. /**
  137402. * Disposes the min/max reducer
  137403. * @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.
  137404. */
  137405. dispose(disposeAll?: boolean): void;
  137406. }
  137407. }
  137408. declare module BABYLON {
  137409. /**
  137410. * This class is a small wrapper around the MinMaxReducer class to compute the min/max values of a depth texture
  137411. */
  137412. export class DepthReducer extends MinMaxReducer {
  137413. private _depthRenderer;
  137414. private _depthRendererId;
  137415. /**
  137416. * Gets the depth renderer used for the computation.
  137417. * Note that the result is null if you provide your own renderer when calling setDepthRenderer.
  137418. */
  137419. get depthRenderer(): Nullable<DepthRenderer>;
  137420. /**
  137421. * Creates a depth reducer
  137422. * @param camera The camera used to render the depth texture
  137423. */
  137424. constructor(camera: Camera);
  137425. /**
  137426. * Sets the depth renderer to use to generate the depth map
  137427. * @param depthRenderer The depth renderer to use. If not provided, a new one will be created automatically
  137428. * @param type The texture type of the depth map (default: TEXTURETYPE_HALF_FLOAT)
  137429. * @param forceFullscreenViewport Forces the post processes used for the reduction to be applied without taking into account viewport (defaults to true)
  137430. */
  137431. setDepthRenderer(depthRenderer?: Nullable<DepthRenderer>, type?: number, forceFullscreenViewport?: boolean): void;
  137432. /** @hidden */
  137433. setSourceTexture(sourceTexture: RenderTargetTexture, depthRedux: boolean, type?: number, forceFullscreenViewport?: boolean): void;
  137434. /**
  137435. * Activates the reduction computation.
  137436. * When activated, the observers registered in onAfterReductionPerformed are
  137437. * called after the compuation is performed
  137438. */
  137439. activate(): void;
  137440. /**
  137441. * Deactivates the reduction computation.
  137442. */
  137443. deactivate(): void;
  137444. /**
  137445. * Disposes the depth reducer
  137446. * @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.
  137447. */
  137448. dispose(disposeAll?: boolean): void;
  137449. }
  137450. }
  137451. declare module BABYLON {
  137452. /**
  137453. * A CSM implementation allowing casting shadows on large scenes.
  137454. * Documentation : https://doc.babylonjs.com/babylon101/cascadedShadows
  137455. * Based on: https://github.com/TheRealMJP/Shadows and https://johanmedestrom.wordpress.com/2016/03/18/opengl-cascaded-shadow-maps/
  137456. */
  137457. export class CascadedShadowGenerator extends ShadowGenerator {
  137458. private static readonly frustumCornersNDCSpace;
  137459. /**
  137460. * Name of the CSM class
  137461. */
  137462. static CLASSNAME: string;
  137463. /**
  137464. * Defines the default number of cascades used by the CSM.
  137465. */
  137466. static readonly DEFAULT_CASCADES_COUNT: number;
  137467. /**
  137468. * Defines the minimum number of cascades used by the CSM.
  137469. */
  137470. static readonly MIN_CASCADES_COUNT: number;
  137471. /**
  137472. * Defines the maximum number of cascades used by the CSM.
  137473. */
  137474. static readonly MAX_CASCADES_COUNT: number;
  137475. protected _validateFilter(filter: number): number;
  137476. /**
  137477. * Gets or sets the actual darkness of the soft shadows while using PCSS filtering (value between 0. and 1.)
  137478. */
  137479. penumbraDarkness: number;
  137480. private _numCascades;
  137481. /**
  137482. * Gets or set the number of cascades used by the CSM.
  137483. */
  137484. get numCascades(): number;
  137485. set numCascades(value: number);
  137486. /**
  137487. * Sets this to true if you want that the edges of the shadows don't "swimm" / "shimmer" when rotating the camera.
  137488. * The trade off is that you lose some precision in the shadow rendering when enabling this setting.
  137489. */
  137490. stabilizeCascades: boolean;
  137491. private _freezeShadowCastersBoundingInfo;
  137492. private _freezeShadowCastersBoundingInfoObservable;
  137493. /**
  137494. * Enables or disables the shadow casters bounding info computation.
  137495. * If your shadow casters don't move, you can disable this feature.
  137496. * If it is enabled, the bounding box computation is done every frame.
  137497. */
  137498. get freezeShadowCastersBoundingInfo(): boolean;
  137499. set freezeShadowCastersBoundingInfo(freeze: boolean);
  137500. private _scbiMin;
  137501. private _scbiMax;
  137502. protected _computeShadowCastersBoundingInfo(): void;
  137503. protected _shadowCastersBoundingInfo: BoundingInfo;
  137504. /**
  137505. * Gets or sets the shadow casters bounding info.
  137506. * If you provide your own shadow casters bounding info, first enable freezeShadowCastersBoundingInfo
  137507. * so that the system won't overwrite the bounds you provide
  137508. */
  137509. get shadowCastersBoundingInfo(): BoundingInfo;
  137510. set shadowCastersBoundingInfo(boundingInfo: BoundingInfo);
  137511. protected _breaksAreDirty: boolean;
  137512. protected _minDistance: number;
  137513. protected _maxDistance: number;
  137514. /**
  137515. * Sets the minimal and maximal distances to use when computing the cascade breaks.
  137516. *
  137517. * The values of min / max are typically the depth zmin and zmax values of your scene, for a given frame.
  137518. * If you don't know these values, simply leave them to their defaults and don't call this function.
  137519. * @param min minimal distance for the breaks (default to 0.)
  137520. * @param max maximal distance for the breaks (default to 1.)
  137521. */
  137522. setMinMaxDistance(min: number, max: number): void;
  137523. /** Gets the minimal distance used in the cascade break computation */
  137524. get minDistance(): number;
  137525. /** Gets the maximal distance used in the cascade break computation */
  137526. get maxDistance(): number;
  137527. /**
  137528. * Gets the class name of that object
  137529. * @returns "CascadedShadowGenerator"
  137530. */
  137531. getClassName(): string;
  137532. private _cascadeMinExtents;
  137533. private _cascadeMaxExtents;
  137534. /**
  137535. * Gets a cascade minimum extents
  137536. * @param cascadeIndex index of the cascade
  137537. * @returns the minimum cascade extents
  137538. */
  137539. getCascadeMinExtents(cascadeIndex: number): Nullable<Vector3>;
  137540. /**
  137541. * Gets a cascade maximum extents
  137542. * @param cascadeIndex index of the cascade
  137543. * @returns the maximum cascade extents
  137544. */
  137545. getCascadeMaxExtents(cascadeIndex: number): Nullable<Vector3>;
  137546. private _cascades;
  137547. private _currentLayer;
  137548. private _viewSpaceFrustumsZ;
  137549. private _viewMatrices;
  137550. private _projectionMatrices;
  137551. private _transformMatrices;
  137552. private _transformMatricesAsArray;
  137553. private _frustumLengths;
  137554. private _lightSizeUVCorrection;
  137555. private _depthCorrection;
  137556. private _frustumCornersWorldSpace;
  137557. private _frustumCenter;
  137558. private _shadowCameraPos;
  137559. private _shadowMaxZ;
  137560. /**
  137561. * Gets the shadow max z distance. It's the limit beyond which shadows are not displayed.
  137562. * It defaults to camera.maxZ
  137563. */
  137564. get shadowMaxZ(): number;
  137565. /**
  137566. * Sets the shadow max z distance.
  137567. */
  137568. set shadowMaxZ(value: number);
  137569. protected _debug: boolean;
  137570. /**
  137571. * Gets or sets the debug flag.
  137572. * When enabled, the cascades are materialized by different colors on the screen.
  137573. */
  137574. get debug(): boolean;
  137575. set debug(dbg: boolean);
  137576. private _depthClamp;
  137577. /**
  137578. * Gets or sets the depth clamping value.
  137579. *
  137580. * When enabled, it improves the shadow quality because the near z plane of the light frustum don't need to be adjusted
  137581. * to account for the shadow casters far away.
  137582. *
  137583. * Note that this property is incompatible with PCSS filtering, so it won't be used in that case.
  137584. */
  137585. get depthClamp(): boolean;
  137586. set depthClamp(value: boolean);
  137587. private _cascadeBlendPercentage;
  137588. /**
  137589. * Gets or sets the percentage of blending between two cascades (value between 0. and 1.).
  137590. * It defaults to 0.1 (10% blending).
  137591. */
  137592. get cascadeBlendPercentage(): number;
  137593. set cascadeBlendPercentage(value: number);
  137594. private _lambda;
  137595. /**
  137596. * Gets or set the lambda parameter.
  137597. * This parameter is used to split the camera frustum and create the cascades.
  137598. * 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.
  137599. * For all values in-between, it's a linear combination of the uniform and logarithm split algorithm.
  137600. */
  137601. get lambda(): number;
  137602. set lambda(value: number);
  137603. /**
  137604. * Gets the view matrix corresponding to a given cascade
  137605. * @param cascadeNum cascade to retrieve the view matrix from
  137606. * @returns the cascade view matrix
  137607. */
  137608. getCascadeViewMatrix(cascadeNum: number): Nullable<Matrix>;
  137609. /**
  137610. * Gets the projection matrix corresponding to a given cascade
  137611. * @param cascadeNum cascade to retrieve the projection matrix from
  137612. * @returns the cascade projection matrix
  137613. */
  137614. getCascadeProjectionMatrix(cascadeNum: number): Nullable<Matrix>;
  137615. /**
  137616. * Gets the transformation matrix corresponding to a given cascade
  137617. * @param cascadeNum cascade to retrieve the transformation matrix from
  137618. * @returns the cascade transformation matrix
  137619. */
  137620. getCascadeTransformMatrix(cascadeNum: number): Nullable<Matrix>;
  137621. private _depthRenderer;
  137622. /**
  137623. * Sets the depth renderer to use when autoCalcDepthBounds is enabled.
  137624. *
  137625. * Note that if no depth renderer is set, a new one will be automatically created internally when necessary.
  137626. *
  137627. * You should call this function if you already have a depth renderer enabled in your scene, to avoid
  137628. * doing multiple depth rendering each frame. If you provide your own depth renderer, make sure it stores linear depth!
  137629. * @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
  137630. */
  137631. setDepthRenderer(depthRenderer: Nullable<DepthRenderer>): void;
  137632. private _depthReducer;
  137633. private _autoCalcDepthBounds;
  137634. /**
  137635. * Gets or sets the autoCalcDepthBounds property.
  137636. *
  137637. * When enabled, a depth rendering pass is first performed (with an internally created depth renderer or with the one
  137638. * you provide by calling setDepthRenderer). Then, a min/max reducing is applied on the depth map to compute the
  137639. * minimal and maximal depth of the map and those values are used as inputs for the setMinMaxDistance() function.
  137640. * It can greatly enhance the shadow quality, at the expense of more GPU works.
  137641. * When using this option, you should increase the value of the lambda parameter, and even set it to 1 for best results.
  137642. */
  137643. get autoCalcDepthBounds(): boolean;
  137644. set autoCalcDepthBounds(value: boolean);
  137645. /**
  137646. * Defines the refresh rate of the min/max computation used when autoCalcDepthBounds is set to true
  137647. * Use 0 to compute just once, 1 to compute on every frame, 2 to compute every two frames and so on...
  137648. * Note that if you provided your own depth renderer through a call to setDepthRenderer, you are responsible
  137649. * for setting the refresh rate on the renderer yourself!
  137650. */
  137651. get autoCalcDepthBoundsRefreshRate(): number;
  137652. set autoCalcDepthBoundsRefreshRate(value: number);
  137653. /**
  137654. * Create the cascade breaks according to the lambda, shadowMaxZ and min/max distance properties, as well as the camera near and far planes.
  137655. * This function is automatically called when updating lambda, shadowMaxZ and min/max distances, however you should call it yourself if
  137656. * you change the camera near/far planes!
  137657. */
  137658. splitFrustum(): void;
  137659. private _splitFrustum;
  137660. private _computeMatrices;
  137661. private _computeFrustumInWorldSpace;
  137662. private _computeCascadeFrustum;
  137663. /**
  137664. * Support test.
  137665. */
  137666. static get IsSupported(): boolean;
  137667. /** @hidden */
  137668. static _SceneComponentInitialization: (scene: Scene) => void;
  137669. /**
  137670. * Creates a Cascaded Shadow Generator object.
  137671. * A ShadowGenerator is the required tool to use the shadows.
  137672. * Each directional light casting shadows needs to use its own ShadowGenerator.
  137673. * Documentation : https://doc.babylonjs.com/babylon101/cascadedShadows
  137674. * @param mapSize The size of the texture what stores the shadows. Example : 1024.
  137675. * @param light The directional light object generating the shadows.
  137676. * @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.
  137677. */
  137678. constructor(mapSize: number, light: DirectionalLight, usefulFloatFirst?: boolean);
  137679. protected _initializeGenerator(): void;
  137680. protected _createTargetRenderTexture(): void;
  137681. protected _initializeShadowMap(): void;
  137682. protected _bindCustomEffectForRenderSubMeshForShadowMap(subMesh: SubMesh, effect: Effect, matriceNames: any, mesh: AbstractMesh): void;
  137683. protected _isReadyCustomDefines(defines: any, subMesh: SubMesh, useInstances: boolean): void;
  137684. /**
  137685. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  137686. * @param defines Defines of the material we want to update
  137687. * @param lightIndex Index of the light in the enabled light list of the material
  137688. */
  137689. prepareDefines(defines: any, lightIndex: number): void;
  137690. /**
  137691. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  137692. * defined in the generator but impacting the effect).
  137693. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  137694. * @param effect The effect we are binfing the information for
  137695. */
  137696. bindShadowLight(lightIndex: string, effect: Effect): void;
  137697. /**
  137698. * Gets the transformation matrix of the first cascade used to project the meshes into the map from the light point of view.
  137699. * (eq to view projection * shadow projection matrices)
  137700. * @returns The transform matrix used to create the shadow map
  137701. */
  137702. getTransformMatrix(): Matrix;
  137703. /**
  137704. * Disposes the ShadowGenerator.
  137705. * Returns nothing.
  137706. */
  137707. dispose(): void;
  137708. /**
  137709. * Serializes the shadow generator setup to a json object.
  137710. * @returns The serialized JSON object
  137711. */
  137712. serialize(): any;
  137713. /**
  137714. * Parses a serialized ShadowGenerator and returns a new ShadowGenerator.
  137715. * @param parsedShadowGenerator The JSON object to parse
  137716. * @param scene The scene to create the shadow map for
  137717. * @returns The parsed shadow generator
  137718. */
  137719. static Parse(parsedShadowGenerator: any, scene: Scene): ShadowGenerator;
  137720. }
  137721. }
  137722. declare module BABYLON {
  137723. /**
  137724. * Defines the shadow generator component responsible to manage any shadow generators
  137725. * in a given scene.
  137726. */
  137727. export class ShadowGeneratorSceneComponent implements ISceneSerializableComponent {
  137728. /**
  137729. * The component name helpfull to identify the component in the list of scene components.
  137730. */
  137731. readonly name: string;
  137732. /**
  137733. * The scene the component belongs to.
  137734. */
  137735. scene: Scene;
  137736. /**
  137737. * Creates a new instance of the component for the given scene
  137738. * @param scene Defines the scene to register the component in
  137739. */
  137740. constructor(scene: Scene);
  137741. /**
  137742. * Registers the component in a given scene
  137743. */
  137744. register(): void;
  137745. /**
  137746. * Rebuilds the elements related to this component in case of
  137747. * context lost for instance.
  137748. */
  137749. rebuild(): void;
  137750. /**
  137751. * Serializes the component data to the specified json object
  137752. * @param serializationObject The object to serialize to
  137753. */
  137754. serialize(serializationObject: any): void;
  137755. /**
  137756. * Adds all the elements from the container to the scene
  137757. * @param container the container holding the elements
  137758. */
  137759. addFromContainer(container: AbstractScene): void;
  137760. /**
  137761. * Removes all the elements in the container from the scene
  137762. * @param container contains the elements to remove
  137763. * @param dispose if the removed element should be disposed (default: false)
  137764. */
  137765. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  137766. /**
  137767. * Rebuilds the elements related to this component in case of
  137768. * context lost for instance.
  137769. */
  137770. dispose(): void;
  137771. private _gatherRenderTargets;
  137772. }
  137773. }
  137774. declare module BABYLON {
  137775. /**
  137776. * A point light is a light defined by an unique point in world space.
  137777. * The light is emitted in every direction from this point.
  137778. * A good example of a point light is a standard light bulb.
  137779. * Documentation: https://doc.babylonjs.com/babylon101/lights
  137780. */
  137781. export class PointLight extends ShadowLight {
  137782. private _shadowAngle;
  137783. /**
  137784. * Getter: In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  137785. * This specifies what angle the shadow will use to be created.
  137786. *
  137787. * It default to 90 degrees to work nicely with the cube texture generation for point lights shadow maps.
  137788. */
  137789. get shadowAngle(): number;
  137790. /**
  137791. * Setter: In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  137792. * This specifies what angle the shadow will use to be created.
  137793. *
  137794. * It default to 90 degrees to work nicely with the cube texture generation for point lights shadow maps.
  137795. */
  137796. set shadowAngle(value: number);
  137797. /**
  137798. * Gets the direction if it has been set.
  137799. * In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  137800. */
  137801. get direction(): Vector3;
  137802. /**
  137803. * In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  137804. */
  137805. set direction(value: Vector3);
  137806. /**
  137807. * Creates a PointLight object from the passed name and position (Vector3) and adds it in the scene.
  137808. * A PointLight emits the light in every direction.
  137809. * It can cast shadows.
  137810. * If the scene camera is already defined and you want to set your PointLight at the camera position, just set it :
  137811. * ```javascript
  137812. * var pointLight = new PointLight("pl", camera.position, scene);
  137813. * ```
  137814. * Documentation : https://doc.babylonjs.com/babylon101/lights
  137815. * @param name The light friendly name
  137816. * @param position The position of the point light in the scene
  137817. * @param scene The scene the lights belongs to
  137818. */
  137819. constructor(name: string, position: Vector3, scene: Scene);
  137820. /**
  137821. * Returns the string "PointLight"
  137822. * @returns the class name
  137823. */
  137824. getClassName(): string;
  137825. /**
  137826. * Returns the integer 0.
  137827. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  137828. */
  137829. getTypeID(): number;
  137830. /**
  137831. * Specifies wether or not the shadowmap should be a cube texture.
  137832. * @returns true if the shadowmap needs to be a cube texture.
  137833. */
  137834. needCube(): boolean;
  137835. /**
  137836. * Returns a new Vector3 aligned with the PointLight cube system according to the passed cube face index (integer).
  137837. * @param faceIndex The index of the face we are computed the direction to generate shadow
  137838. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  137839. */
  137840. getShadowDirection(faceIndex?: number): Vector3;
  137841. /**
  137842. * Sets the passed matrix "matrix" as a left-handed perspective projection matrix with the following settings :
  137843. * - fov = PI / 2
  137844. * - aspect ratio : 1.0
  137845. * - z-near and far equal to the active camera minZ and maxZ.
  137846. * Returns the PointLight.
  137847. */
  137848. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  137849. protected _buildUniformLayout(): void;
  137850. /**
  137851. * Sets the passed Effect "effect" with the PointLight transformed position (or position, if none) and passed name (string).
  137852. * @param effect The effect to update
  137853. * @param lightIndex The index of the light in the effect to update
  137854. * @returns The point light
  137855. */
  137856. transferToEffect(effect: Effect, lightIndex: string): PointLight;
  137857. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  137858. /**
  137859. * Prepares the list of defines specific to the light type.
  137860. * @param defines the list of defines
  137861. * @param lightIndex defines the index of the light for the effect
  137862. */
  137863. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  137864. }
  137865. }
  137866. declare module BABYLON {
  137867. /**
  137868. * Header information of HDR texture files.
  137869. */
  137870. export interface HDRInfo {
  137871. /**
  137872. * The height of the texture in pixels.
  137873. */
  137874. height: number;
  137875. /**
  137876. * The width of the texture in pixels.
  137877. */
  137878. width: number;
  137879. /**
  137880. * The index of the beginning of the data in the binary file.
  137881. */
  137882. dataPosition: number;
  137883. }
  137884. /**
  137885. * This groups tools to convert HDR texture to native colors array.
  137886. */
  137887. export class HDRTools {
  137888. private static Ldexp;
  137889. private static Rgbe2float;
  137890. private static readStringLine;
  137891. /**
  137892. * Reads header information from an RGBE texture stored in a native array.
  137893. * More information on this format are available here:
  137894. * https://en.wikipedia.org/wiki/RGBE_image_format
  137895. *
  137896. * @param uint8array The binary file stored in native array.
  137897. * @return The header information.
  137898. */
  137899. static RGBE_ReadHeader(uint8array: Uint8Array): HDRInfo;
  137900. /**
  137901. * Returns the cubemap information (each faces texture data) extracted from an RGBE texture.
  137902. * This RGBE texture needs to store the information as a panorama.
  137903. *
  137904. * More information on this format are available here:
  137905. * https://en.wikipedia.org/wiki/RGBE_image_format
  137906. *
  137907. * @param buffer The binary file stored in an array buffer.
  137908. * @param size The expected size of the extracted cubemap.
  137909. * @return The Cube Map information.
  137910. */
  137911. static GetCubeMapTextureData(buffer: ArrayBuffer, size: number): CubeMapInfo;
  137912. /**
  137913. * Returns the pixels data extracted from an RGBE texture.
  137914. * This pixels will be stored left to right up to down in the R G B order in one array.
  137915. *
  137916. * More information on this format are available here:
  137917. * https://en.wikipedia.org/wiki/RGBE_image_format
  137918. *
  137919. * @param uint8array The binary file stored in an array buffer.
  137920. * @param hdrInfo The header information of the file.
  137921. * @return The pixels data in RGB right to left up to down order.
  137922. */
  137923. static RGBE_ReadPixels(uint8array: Uint8Array, hdrInfo: HDRInfo): Float32Array;
  137924. private static RGBE_ReadPixels_RLE;
  137925. private static RGBE_ReadPixels_NOT_RLE;
  137926. }
  137927. }
  137928. declare module BABYLON {
  137929. /**
  137930. * Effect Render Options
  137931. */
  137932. export interface IEffectRendererOptions {
  137933. /**
  137934. * Defines the vertices positions.
  137935. */
  137936. positions?: number[];
  137937. /**
  137938. * Defines the indices.
  137939. */
  137940. indices?: number[];
  137941. }
  137942. /**
  137943. * Helper class to render one or more effects.
  137944. * You can access the previous rendering in your shader by declaring a sampler named textureSampler
  137945. */
  137946. export class EffectRenderer {
  137947. private engine;
  137948. private static _DefaultOptions;
  137949. private _vertexBuffers;
  137950. private _indexBuffer;
  137951. private _fullscreenViewport;
  137952. /**
  137953. * Creates an effect renderer
  137954. * @param engine the engine to use for rendering
  137955. * @param options defines the options of the effect renderer
  137956. */
  137957. constructor(engine: ThinEngine, options?: IEffectRendererOptions);
  137958. /**
  137959. * Sets the current viewport in normalized coordinates 0-1
  137960. * @param viewport Defines the viewport to set (defaults to 0 0 1 1)
  137961. */
  137962. setViewport(viewport?: Viewport): void;
  137963. /**
  137964. * Binds the embedded attributes buffer to the effect.
  137965. * @param effect Defines the effect to bind the attributes for
  137966. */
  137967. bindBuffers(effect: Effect): void;
  137968. /**
  137969. * Sets the current effect wrapper to use during draw.
  137970. * The effect needs to be ready before calling this api.
  137971. * This also sets the default full screen position attribute.
  137972. * @param effectWrapper Defines the effect to draw with
  137973. */
  137974. applyEffectWrapper(effectWrapper: EffectWrapper): void;
  137975. /**
  137976. * Restores engine states
  137977. */
  137978. restoreStates(): void;
  137979. /**
  137980. * Draws a full screen quad.
  137981. */
  137982. draw(): void;
  137983. private isRenderTargetTexture;
  137984. /**
  137985. * renders one or more effects to a specified texture
  137986. * @param effectWrapper the effect to renderer
  137987. * @param outputTexture texture to draw to, if null it will render to the screen.
  137988. */
  137989. render(effectWrapper: EffectWrapper, outputTexture?: Nullable<InternalTexture | RenderTargetTexture>): void;
  137990. /**
  137991. * Disposes of the effect renderer
  137992. */
  137993. dispose(): void;
  137994. }
  137995. /**
  137996. * Options to create an EffectWrapper
  137997. */
  137998. interface EffectWrapperCreationOptions {
  137999. /**
  138000. * Engine to use to create the effect
  138001. */
  138002. engine: ThinEngine;
  138003. /**
  138004. * Fragment shader for the effect
  138005. */
  138006. fragmentShader: string;
  138007. /**
  138008. * Use the shader store instead of direct source code
  138009. */
  138010. useShaderStore?: boolean;
  138011. /**
  138012. * Vertex shader for the effect
  138013. */
  138014. vertexShader?: string;
  138015. /**
  138016. * Attributes to use in the shader
  138017. */
  138018. attributeNames?: Array<string>;
  138019. /**
  138020. * Uniforms to use in the shader
  138021. */
  138022. uniformNames?: Array<string>;
  138023. /**
  138024. * Texture sampler names to use in the shader
  138025. */
  138026. samplerNames?: Array<string>;
  138027. /**
  138028. * Defines to use in the shader
  138029. */
  138030. defines?: Array<string>;
  138031. /**
  138032. * Callback when effect is compiled
  138033. */
  138034. onCompiled?: Nullable<(effect: Effect) => void>;
  138035. /**
  138036. * The friendly name of the effect displayed in Spector.
  138037. */
  138038. name?: string;
  138039. }
  138040. /**
  138041. * Wraps an effect to be used for rendering
  138042. */
  138043. export class EffectWrapper {
  138044. /**
  138045. * Event that is fired right before the effect is drawn (should be used to update uniforms)
  138046. */
  138047. onApplyObservable: Observable<{}>;
  138048. /**
  138049. * The underlying effect
  138050. */
  138051. effect: Effect;
  138052. /**
  138053. * Creates an effect to be renderer
  138054. * @param creationOptions options to create the effect
  138055. */
  138056. constructor(creationOptions: EffectWrapperCreationOptions);
  138057. /**
  138058. * Disposes of the effect wrapper
  138059. */
  138060. dispose(): void;
  138061. }
  138062. }
  138063. declare module BABYLON {
  138064. /** @hidden */
  138065. export var hdrFilteringVertexShader: {
  138066. name: string;
  138067. shader: string;
  138068. };
  138069. }
  138070. declare module BABYLON {
  138071. /** @hidden */
  138072. export var hdrFilteringPixelShader: {
  138073. name: string;
  138074. shader: string;
  138075. };
  138076. }
  138077. declare module BABYLON {
  138078. /**
  138079. * Options for texture filtering
  138080. */
  138081. interface IHDRFilteringOptions {
  138082. /**
  138083. * Scales pixel intensity for the input HDR map.
  138084. */
  138085. hdrScale?: number;
  138086. /**
  138087. * Quality of the filter. Should be `Constants.TEXTURE_FILTERING_QUALITY_OFFLINE` for prefiltering
  138088. */
  138089. quality?: number;
  138090. }
  138091. /**
  138092. * Filters HDR maps to get correct renderings of PBR reflections
  138093. */
  138094. export class HDRFiltering {
  138095. private _engine;
  138096. private _effectRenderer;
  138097. private _effectWrapper;
  138098. private _lodGenerationOffset;
  138099. private _lodGenerationScale;
  138100. /**
  138101. * Quality switch for prefiltering. Should be set to `Constants.TEXTURE_FILTERING_QUALITY_OFFLINE` unless
  138102. * you care about baking speed.
  138103. */
  138104. quality: number;
  138105. /**
  138106. * Scales pixel intensity for the input HDR map.
  138107. */
  138108. hdrScale: number;
  138109. /**
  138110. * Instantiates HDR filter for reflection maps
  138111. *
  138112. * @param engine Thin engine
  138113. * @param options Options
  138114. */
  138115. constructor(engine: ThinEngine, options?: IHDRFilteringOptions);
  138116. private _createRenderTarget;
  138117. private _prefilterInternal;
  138118. private _createEffect;
  138119. /**
  138120. * Get a value indicating if the filter is ready to be used
  138121. * @param texture Texture to filter
  138122. * @returns true if the filter is ready
  138123. */
  138124. isReady(texture: BaseTexture): boolean;
  138125. /**
  138126. * Prefilters a cube texture to have mipmap levels representing roughness values.
  138127. * Prefiltering will be invoked at the end of next rendering pass.
  138128. * This has to be done once the map is loaded, and has not been prefiltered by a third party software.
  138129. * See http://blog.selfshadow.com/publications/s2013-shading-course/karis/s2013_pbs_epic_notes_v2.pdf for more information
  138130. * @param texture Texture to filter
  138131. * @param onFinished Callback when filtering is done
  138132. * @return Promise called when prefiltering is done
  138133. */
  138134. prefilter(texture: BaseTexture, onFinished?: Nullable<() => void>): Promise<unknown> | undefined;
  138135. }
  138136. }
  138137. declare module BABYLON {
  138138. /**
  138139. * This represents a texture coming from an HDR input.
  138140. *
  138141. * The only supported format is currently panorama picture stored in RGBE format.
  138142. * Example of such files can be found on HDRLib: http://hdrlib.com/
  138143. */
  138144. export class HDRCubeTexture extends BaseTexture {
  138145. private static _facesMapping;
  138146. private _generateHarmonics;
  138147. private _noMipmap;
  138148. private _prefilterOnLoad;
  138149. private _textureMatrix;
  138150. private _size;
  138151. private _onLoad;
  138152. private _onError;
  138153. /**
  138154. * The texture URL.
  138155. */
  138156. url: string;
  138157. /**
  138158. * The texture coordinates mode. As this texture is stored in a cube format, please modify carefully.
  138159. */
  138160. coordinatesMode: number;
  138161. protected _isBlocking: boolean;
  138162. /**
  138163. * Sets wether or not the texture is blocking during loading.
  138164. */
  138165. set isBlocking(value: boolean);
  138166. /**
  138167. * Gets wether or not the texture is blocking during loading.
  138168. */
  138169. get isBlocking(): boolean;
  138170. protected _rotationY: number;
  138171. /**
  138172. * Sets texture matrix rotation angle around Y axis in radians.
  138173. */
  138174. set rotationY(value: number);
  138175. /**
  138176. * Gets texture matrix rotation angle around Y axis radians.
  138177. */
  138178. get rotationY(): number;
  138179. /**
  138180. * Gets or sets the center of the bounding box associated with the cube texture
  138181. * It must define where the camera used to render the texture was set
  138182. */
  138183. boundingBoxPosition: Vector3;
  138184. private _boundingBoxSize;
  138185. /**
  138186. * Gets or sets the size of the bounding box associated with the cube texture
  138187. * When defined, the cubemap will switch to local mode
  138188. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  138189. * @example https://www.babylonjs-playground.com/#RNASML
  138190. */
  138191. set boundingBoxSize(value: Vector3);
  138192. get boundingBoxSize(): Vector3;
  138193. /**
  138194. * Instantiates an HDRTexture from the following parameters.
  138195. *
  138196. * @param url The location of the HDR raw data (Panorama stored in RGBE format)
  138197. * @param sceneOrEngine The scene or engine the texture will be used in
  138198. * @param size The cubemap desired size (the more it increases the longer the generation will be)
  138199. * @param noMipmap Forces to not generate the mipmap if true
  138200. * @param generateHarmonics Specifies whether you want to extract the polynomial harmonics during the generation process
  138201. * @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)
  138202. * @param prefilterOnLoad Prefilters HDR texture to allow use of this texture as a PBR reflection texture.
  138203. */
  138204. 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>);
  138205. /**
  138206. * Get the current class name of the texture useful for serialization or dynamic coding.
  138207. * @returns "HDRCubeTexture"
  138208. */
  138209. getClassName(): string;
  138210. /**
  138211. * Occurs when the file is raw .hdr file.
  138212. */
  138213. private loadTexture;
  138214. clone(): HDRCubeTexture;
  138215. delayLoad(): void;
  138216. /**
  138217. * Get the texture reflection matrix used to rotate/transform the reflection.
  138218. * @returns the reflection matrix
  138219. */
  138220. getReflectionTextureMatrix(): Matrix;
  138221. /**
  138222. * Set the texture reflection matrix used to rotate/transform the reflection.
  138223. * @param value Define the reflection matrix to set
  138224. */
  138225. setReflectionTextureMatrix(value: Matrix): void;
  138226. /**
  138227. * Parses a JSON representation of an HDR Texture in order to create the texture
  138228. * @param parsedTexture Define the JSON representation
  138229. * @param scene Define the scene the texture should be created in
  138230. * @param rootUrl Define the root url in case we need to load relative dependencies
  138231. * @returns the newly created texture after parsing
  138232. */
  138233. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): Nullable<HDRCubeTexture>;
  138234. serialize(): any;
  138235. }
  138236. }
  138237. declare module BABYLON {
  138238. /**
  138239. * Class used to control physics engine
  138240. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  138241. */
  138242. export class PhysicsEngine implements IPhysicsEngine {
  138243. private _physicsPlugin;
  138244. /**
  138245. * Global value used to control the smallest number supported by the simulation
  138246. */
  138247. static Epsilon: number;
  138248. private _impostors;
  138249. private _joints;
  138250. private _subTimeStep;
  138251. /**
  138252. * Gets the gravity vector used by the simulation
  138253. */
  138254. gravity: Vector3;
  138255. /**
  138256. * Factory used to create the default physics plugin.
  138257. * @returns The default physics plugin
  138258. */
  138259. static DefaultPluginFactory(): IPhysicsEnginePlugin;
  138260. /**
  138261. * Creates a new Physics Engine
  138262. * @param gravity defines the gravity vector used by the simulation
  138263. * @param _physicsPlugin defines the plugin to use (CannonJS by default)
  138264. */
  138265. constructor(gravity: Nullable<Vector3>, _physicsPlugin?: IPhysicsEnginePlugin);
  138266. /**
  138267. * Sets the gravity vector used by the simulation
  138268. * @param gravity defines the gravity vector to use
  138269. */
  138270. setGravity(gravity: Vector3): void;
  138271. /**
  138272. * Set the time step of the physics engine.
  138273. * Default is 1/60.
  138274. * To slow it down, enter 1/600 for example.
  138275. * To speed it up, 1/30
  138276. * @param newTimeStep defines the new timestep to apply to this world.
  138277. */
  138278. setTimeStep(newTimeStep?: number): void;
  138279. /**
  138280. * Get the time step of the physics engine.
  138281. * @returns the current time step
  138282. */
  138283. getTimeStep(): number;
  138284. /**
  138285. * Set the sub time step of the physics engine.
  138286. * Default is 0 meaning there is no sub steps
  138287. * To increase physics resolution precision, set a small value (like 1 ms)
  138288. * @param subTimeStep defines the new sub timestep used for physics resolution.
  138289. */
  138290. setSubTimeStep(subTimeStep?: number): void;
  138291. /**
  138292. * Get the sub time step of the physics engine.
  138293. * @returns the current sub time step
  138294. */
  138295. getSubTimeStep(): number;
  138296. /**
  138297. * Release all resources
  138298. */
  138299. dispose(): void;
  138300. /**
  138301. * Gets the name of the current physics plugin
  138302. * @returns the name of the plugin
  138303. */
  138304. getPhysicsPluginName(): string;
  138305. /**
  138306. * Adding a new impostor for the impostor tracking.
  138307. * This will be done by the impostor itself.
  138308. * @param impostor the impostor to add
  138309. */
  138310. addImpostor(impostor: PhysicsImpostor): void;
  138311. /**
  138312. * Remove an impostor from the engine.
  138313. * This impostor and its mesh will not longer be updated by the physics engine.
  138314. * @param impostor the impostor to remove
  138315. */
  138316. removeImpostor(impostor: PhysicsImpostor): void;
  138317. /**
  138318. * Add a joint to the physics engine
  138319. * @param mainImpostor defines the main impostor to which the joint is added.
  138320. * @param connectedImpostor defines the impostor that is connected to the main impostor using this joint
  138321. * @param joint defines the joint that will connect both impostors.
  138322. */
  138323. addJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  138324. /**
  138325. * Removes a joint from the simulation
  138326. * @param mainImpostor defines the impostor used with the joint
  138327. * @param connectedImpostor defines the other impostor connected to the main one by the joint
  138328. * @param joint defines the joint to remove
  138329. */
  138330. removeJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  138331. /**
  138332. * Called by the scene. No need to call it.
  138333. * @param delta defines the timespam between frames
  138334. */
  138335. _step(delta: number): void;
  138336. /**
  138337. * Gets the current plugin used to run the simulation
  138338. * @returns current plugin
  138339. */
  138340. getPhysicsPlugin(): IPhysicsEnginePlugin;
  138341. /**
  138342. * Gets the list of physic impostors
  138343. * @returns an array of PhysicsImpostor
  138344. */
  138345. getImpostors(): Array<PhysicsImpostor>;
  138346. /**
  138347. * Gets the impostor for a physics enabled object
  138348. * @param object defines the object impersonated by the impostor
  138349. * @returns the PhysicsImpostor or null if not found
  138350. */
  138351. getImpostorForPhysicsObject(object: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  138352. /**
  138353. * Gets the impostor for a physics body object
  138354. * @param body defines physics body used by the impostor
  138355. * @returns the PhysicsImpostor or null if not found
  138356. */
  138357. getImpostorWithPhysicsBody(body: any): Nullable<PhysicsImpostor>;
  138358. /**
  138359. * Does a raycast in the physics world
  138360. * @param from when should the ray start?
  138361. * @param to when should the ray end?
  138362. * @returns PhysicsRaycastResult
  138363. */
  138364. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  138365. }
  138366. }
  138367. declare module BABYLON {
  138368. /** @hidden */
  138369. export class CannonJSPlugin implements IPhysicsEnginePlugin {
  138370. private _useDeltaForWorldStep;
  138371. world: any;
  138372. name: string;
  138373. private _physicsMaterials;
  138374. private _fixedTimeStep;
  138375. private _cannonRaycastResult;
  138376. private _raycastResult;
  138377. private _physicsBodysToRemoveAfterStep;
  138378. private _firstFrame;
  138379. BJSCANNON: any;
  138380. constructor(_useDeltaForWorldStep?: boolean, iterations?: number, cannonInjection?: any);
  138381. setGravity(gravity: Vector3): void;
  138382. setTimeStep(timeStep: number): void;
  138383. getTimeStep(): number;
  138384. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  138385. private _removeMarkedPhysicsBodiesFromWorld;
  138386. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  138387. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  138388. generatePhysicsBody(impostor: PhysicsImpostor): void;
  138389. private _processChildMeshes;
  138390. removePhysicsBody(impostor: PhysicsImpostor): void;
  138391. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  138392. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  138393. private _addMaterial;
  138394. private _checkWithEpsilon;
  138395. private _createShape;
  138396. private _createHeightmap;
  138397. private _minus90X;
  138398. private _plus90X;
  138399. private _tmpPosition;
  138400. private _tmpDeltaPosition;
  138401. private _tmpUnityRotation;
  138402. private _updatePhysicsBodyTransformation;
  138403. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  138404. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  138405. isSupported(): boolean;
  138406. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  138407. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  138408. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  138409. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  138410. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  138411. getBodyMass(impostor: PhysicsImpostor): number;
  138412. getBodyFriction(impostor: PhysicsImpostor): number;
  138413. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  138414. getBodyRestitution(impostor: PhysicsImpostor): number;
  138415. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  138416. sleepBody(impostor: PhysicsImpostor): void;
  138417. wakeUpBody(impostor: PhysicsImpostor): void;
  138418. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number): void;
  138419. setMotor(joint: IMotorEnabledJoint, speed?: number, maxForce?: number, motorIndex?: number): void;
  138420. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number): void;
  138421. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  138422. getRadius(impostor: PhysicsImpostor): number;
  138423. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  138424. dispose(): void;
  138425. private _extendNamespace;
  138426. /**
  138427. * Does a raycast in the physics world
  138428. * @param from when should the ray start?
  138429. * @param to when should the ray end?
  138430. * @returns PhysicsRaycastResult
  138431. */
  138432. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  138433. }
  138434. }
  138435. declare module BABYLON {
  138436. /** @hidden */
  138437. export class OimoJSPlugin implements IPhysicsEnginePlugin {
  138438. private _useDeltaForWorldStep;
  138439. world: any;
  138440. name: string;
  138441. BJSOIMO: any;
  138442. private _raycastResult;
  138443. private _fixedTimeStep;
  138444. constructor(_useDeltaForWorldStep?: boolean, iterations?: number, oimoInjection?: any);
  138445. setGravity(gravity: Vector3): void;
  138446. setTimeStep(timeStep: number): void;
  138447. getTimeStep(): number;
  138448. private _tmpImpostorsArray;
  138449. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  138450. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  138451. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  138452. generatePhysicsBody(impostor: PhysicsImpostor): void;
  138453. private _tmpPositionVector;
  138454. removePhysicsBody(impostor: PhysicsImpostor): void;
  138455. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  138456. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  138457. isSupported(): boolean;
  138458. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  138459. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  138460. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  138461. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  138462. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  138463. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  138464. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  138465. getBodyMass(impostor: PhysicsImpostor): number;
  138466. getBodyFriction(impostor: PhysicsImpostor): number;
  138467. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  138468. getBodyRestitution(impostor: PhysicsImpostor): number;
  138469. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  138470. sleepBody(impostor: PhysicsImpostor): void;
  138471. wakeUpBody(impostor: PhysicsImpostor): void;
  138472. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  138473. setMotor(joint: IMotorEnabledJoint, speed: number, force?: number, motorIndex?: number): void;
  138474. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  138475. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  138476. getRadius(impostor: PhysicsImpostor): number;
  138477. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  138478. dispose(): void;
  138479. /**
  138480. * Does a raycast in the physics world
  138481. * @param from when should the ray start?
  138482. * @param to when should the ray end?
  138483. * @returns PhysicsRaycastResult
  138484. */
  138485. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  138486. }
  138487. }
  138488. declare module BABYLON {
  138489. /**
  138490. * Class containing static functions to help procedurally build meshes
  138491. */
  138492. export class RibbonBuilder {
  138493. /**
  138494. * Creates a ribbon mesh. The ribbon is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  138495. * * The parameter `pathArray` is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry
  138496. * * The parameter `closeArray` (boolean, default false) creates a seam between the first and the last paths of the path array
  138497. * * The parameter `closePath` (boolean, default false) creates a seam between the first and the last points of each path of the path array
  138498. * * 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
  138499. * * 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
  138500. * * 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
  138501. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  138502. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  138503. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  138504. * * 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
  138505. * * The parameters `colors` is an optional flat array of `Color4` to set/update each ribbon vertex with its own custom color values
  138506. * * 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
  138507. * * Moreover, you can use the parameter `color` with `instance` (to update the ribbon), only if you previously used it at creation time
  138508. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  138509. * @param name defines the name of the mesh
  138510. * @param options defines the options used to create the mesh
  138511. * @param scene defines the hosting scene
  138512. * @returns the ribbon mesh
  138513. * @see https://doc.babylonjs.com/how_to/ribbon_tutorial
  138514. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  138515. */
  138516. static CreateRibbon(name: string, options: {
  138517. pathArray: Vector3[][];
  138518. closeArray?: boolean;
  138519. closePath?: boolean;
  138520. offset?: number;
  138521. updatable?: boolean;
  138522. sideOrientation?: number;
  138523. frontUVs?: Vector4;
  138524. backUVs?: Vector4;
  138525. instance?: Mesh;
  138526. invertUV?: boolean;
  138527. uvs?: Vector2[];
  138528. colors?: Color4[];
  138529. }, scene?: Nullable<Scene>): Mesh;
  138530. }
  138531. }
  138532. declare module BABYLON {
  138533. /**
  138534. * Class containing static functions to help procedurally build meshes
  138535. */
  138536. export class ShapeBuilder {
  138537. /**
  138538. * 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.
  138539. * * 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.
  138540. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  138541. * * 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.
  138542. * * The parameter `scale` (float, default 1) is the value to scale the shape.
  138543. * * 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
  138544. * * 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
  138545. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape.
  138546. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  138547. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  138548. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture.
  138549. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  138550. * @param name defines the name of the mesh
  138551. * @param options defines the options used to create the mesh
  138552. * @param scene defines the hosting scene
  138553. * @returns the extruded shape mesh
  138554. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  138555. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  138556. */
  138557. static ExtrudeShape(name: string, options: {
  138558. shape: Vector3[];
  138559. path: Vector3[];
  138560. scale?: number;
  138561. rotation?: number;
  138562. cap?: number;
  138563. updatable?: boolean;
  138564. sideOrientation?: number;
  138565. frontUVs?: Vector4;
  138566. backUVs?: Vector4;
  138567. instance?: Mesh;
  138568. invertUV?: boolean;
  138569. }, scene?: Nullable<Scene>): Mesh;
  138570. /**
  138571. * Creates an custom extruded shape mesh.
  138572. * The custom extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
  138573. * * 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.
  138574. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  138575. * * 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
  138576. * * It must returns a float value that will be the rotation in radians applied to the shape on each path point.
  138577. * * 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
  138578. * * It must returns a float value that will be the scale value applied to the shape on each path point
  138579. * * The parameter `ribbonClosePath` (boolean, default false) forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  138580. * * The parameter `ribbonCloseArray` (boolean, default false) forces the extrusion underlying ribbon to close its `pathArray`
  138581. * * 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
  138582. * * 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
  138583. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape
  138584. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  138585. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  138586. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  138587. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  138588. * @param name defines the name of the mesh
  138589. * @param options defines the options used to create the mesh
  138590. * @param scene defines the hosting scene
  138591. * @returns the custom extruded shape mesh
  138592. * @see https://doc.babylonjs.com/how_to/parametric_shapes#custom-extruded-shapes
  138593. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  138594. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  138595. */
  138596. static ExtrudeShapeCustom(name: string, options: {
  138597. shape: Vector3[];
  138598. path: Vector3[];
  138599. scaleFunction?: any;
  138600. rotationFunction?: any;
  138601. ribbonCloseArray?: boolean;
  138602. ribbonClosePath?: boolean;
  138603. cap?: number;
  138604. updatable?: boolean;
  138605. sideOrientation?: number;
  138606. frontUVs?: Vector4;
  138607. backUVs?: Vector4;
  138608. instance?: Mesh;
  138609. invertUV?: boolean;
  138610. }, scene?: Nullable<Scene>): Mesh;
  138611. private static _ExtrudeShapeGeneric;
  138612. }
  138613. }
  138614. declare module BABYLON {
  138615. /**
  138616. * AmmoJS Physics plugin
  138617. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  138618. * @see https://github.com/kripken/ammo.js/
  138619. */
  138620. export class AmmoJSPlugin implements IPhysicsEnginePlugin {
  138621. private _useDeltaForWorldStep;
  138622. /**
  138623. * Reference to the Ammo library
  138624. */
  138625. bjsAMMO: any;
  138626. /**
  138627. * Created ammoJS world which physics bodies are added to
  138628. */
  138629. world: any;
  138630. /**
  138631. * Name of the plugin
  138632. */
  138633. name: string;
  138634. private _timeStep;
  138635. private _fixedTimeStep;
  138636. private _maxSteps;
  138637. private _tmpQuaternion;
  138638. private _tmpAmmoTransform;
  138639. private _tmpAmmoQuaternion;
  138640. private _tmpAmmoConcreteContactResultCallback;
  138641. private _collisionConfiguration;
  138642. private _dispatcher;
  138643. private _overlappingPairCache;
  138644. private _solver;
  138645. private _softBodySolver;
  138646. private _tmpAmmoVectorA;
  138647. private _tmpAmmoVectorB;
  138648. private _tmpAmmoVectorC;
  138649. private _tmpAmmoVectorD;
  138650. private _tmpContactCallbackResult;
  138651. private _tmpAmmoVectorRCA;
  138652. private _tmpAmmoVectorRCB;
  138653. private _raycastResult;
  138654. private static readonly DISABLE_COLLISION_FLAG;
  138655. private static readonly KINEMATIC_FLAG;
  138656. private static readonly DISABLE_DEACTIVATION_FLAG;
  138657. /**
  138658. * Initializes the ammoJS plugin
  138659. * @param _useDeltaForWorldStep if the time between frames should be used when calculating physics steps (Default: true)
  138660. * @param ammoInjection can be used to inject your own ammo reference
  138661. * @param overlappingPairCache can be used to specify your own overlapping pair cache
  138662. */
  138663. constructor(_useDeltaForWorldStep?: boolean, ammoInjection?: any, overlappingPairCache?: any);
  138664. /**
  138665. * Sets the gravity of the physics world (m/(s^2))
  138666. * @param gravity Gravity to set
  138667. */
  138668. setGravity(gravity: Vector3): void;
  138669. /**
  138670. * Amount of time to step forward on each frame (only used if useDeltaForWorldStep is false in the constructor)
  138671. * @param timeStep timestep to use in seconds
  138672. */
  138673. setTimeStep(timeStep: number): void;
  138674. /**
  138675. * 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)
  138676. * @param fixedTimeStep fixedTimeStep to use in seconds
  138677. */
  138678. setFixedTimeStep(fixedTimeStep: number): void;
  138679. /**
  138680. * Sets the maximum number of steps by the physics engine per frame (Default: 5)
  138681. * @param maxSteps the maximum number of steps by the physics engine per frame
  138682. */
  138683. setMaxSteps(maxSteps: number): void;
  138684. /**
  138685. * Gets the current timestep (only used if useDeltaForWorldStep is false in the constructor)
  138686. * @returns the current timestep in seconds
  138687. */
  138688. getTimeStep(): number;
  138689. /**
  138690. * The create custom shape handler function to be called when using BABYLON.PhysicsImposter.CustomImpostor
  138691. */
  138692. onCreateCustomShape: (impostor: PhysicsImpostor) => any;
  138693. private _isImpostorInContact;
  138694. private _isImpostorPairInContact;
  138695. private _stepSimulation;
  138696. /**
  138697. * Moves the physics simulation forward delta seconds and updates the given physics imposters
  138698. * Prior to the step the imposters physics location is set to the position of the babylon meshes
  138699. * After the step the babylon meshes are set to the position of the physics imposters
  138700. * @param delta amount of time to step forward
  138701. * @param impostors array of imposters to update before/after the step
  138702. */
  138703. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  138704. /**
  138705. * Update babylon mesh to match physics world object
  138706. * @param impostor imposter to match
  138707. */
  138708. private _afterSoftStep;
  138709. /**
  138710. * Update babylon mesh vertices vertices to match physics world softbody or cloth
  138711. * @param impostor imposter to match
  138712. */
  138713. private _ropeStep;
  138714. /**
  138715. * Update babylon mesh vertices vertices to match physics world softbody or cloth
  138716. * @param impostor imposter to match
  138717. */
  138718. private _softbodyOrClothStep;
  138719. private _tmpMatrix;
  138720. /**
  138721. * Applies an impulse on the imposter
  138722. * @param impostor imposter to apply impulse to
  138723. * @param force amount of force to be applied to the imposter
  138724. * @param contactPoint the location to apply the impulse on the imposter
  138725. */
  138726. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  138727. /**
  138728. * Applies a force on the imposter
  138729. * @param impostor imposter to apply force
  138730. * @param force amount of force to be applied to the imposter
  138731. * @param contactPoint the location to apply the force on the imposter
  138732. */
  138733. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  138734. /**
  138735. * Creates a physics body using the plugin
  138736. * @param impostor the imposter to create the physics body on
  138737. */
  138738. generatePhysicsBody(impostor: PhysicsImpostor): void;
  138739. /**
  138740. * Removes the physics body from the imposter and disposes of the body's memory
  138741. * @param impostor imposter to remove the physics body from
  138742. */
  138743. removePhysicsBody(impostor: PhysicsImpostor): void;
  138744. /**
  138745. * Generates a joint
  138746. * @param impostorJoint the imposter joint to create the joint with
  138747. */
  138748. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  138749. /**
  138750. * Removes a joint
  138751. * @param impostorJoint the imposter joint to remove the joint from
  138752. */
  138753. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  138754. private _addMeshVerts;
  138755. /**
  138756. * Initialise the soft body vertices to match its object's (mesh) vertices
  138757. * Softbody vertices (nodes) are in world space and to match this
  138758. * The object's position and rotation is set to zero and so its vertices are also then set in world space
  138759. * @param impostor to create the softbody for
  138760. */
  138761. private _softVertexData;
  138762. /**
  138763. * Create an impostor's soft body
  138764. * @param impostor to create the softbody for
  138765. */
  138766. private _createSoftbody;
  138767. /**
  138768. * Create cloth for an impostor
  138769. * @param impostor to create the softbody for
  138770. */
  138771. private _createCloth;
  138772. /**
  138773. * Create rope for an impostor
  138774. * @param impostor to create the softbody for
  138775. */
  138776. private _createRope;
  138777. /**
  138778. * Create a custom physics impostor shape using the plugin's onCreateCustomShape handler
  138779. * @param impostor to create the custom physics shape for
  138780. */
  138781. private _createCustom;
  138782. private _addHullVerts;
  138783. private _createShape;
  138784. /**
  138785. * Sets the physics body position/rotation from the babylon mesh's position/rotation
  138786. * @param impostor imposter containing the physics body and babylon object
  138787. */
  138788. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  138789. /**
  138790. * Sets the babylon object's position/rotation from the physics body's position/rotation
  138791. * @param impostor imposter containing the physics body and babylon object
  138792. * @param newPosition new position
  138793. * @param newRotation new rotation
  138794. */
  138795. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  138796. /**
  138797. * If this plugin is supported
  138798. * @returns true if its supported
  138799. */
  138800. isSupported(): boolean;
  138801. /**
  138802. * Sets the linear velocity of the physics body
  138803. * @param impostor imposter to set the velocity on
  138804. * @param velocity velocity to set
  138805. */
  138806. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  138807. /**
  138808. * Sets the angular velocity of the physics body
  138809. * @param impostor imposter to set the velocity on
  138810. * @param velocity velocity to set
  138811. */
  138812. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  138813. /**
  138814. * gets the linear velocity
  138815. * @param impostor imposter to get linear velocity from
  138816. * @returns linear velocity
  138817. */
  138818. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  138819. /**
  138820. * gets the angular velocity
  138821. * @param impostor imposter to get angular velocity from
  138822. * @returns angular velocity
  138823. */
  138824. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  138825. /**
  138826. * Sets the mass of physics body
  138827. * @param impostor imposter to set the mass on
  138828. * @param mass mass to set
  138829. */
  138830. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  138831. /**
  138832. * Gets the mass of the physics body
  138833. * @param impostor imposter to get the mass from
  138834. * @returns mass
  138835. */
  138836. getBodyMass(impostor: PhysicsImpostor): number;
  138837. /**
  138838. * Gets friction of the impostor
  138839. * @param impostor impostor to get friction from
  138840. * @returns friction value
  138841. */
  138842. getBodyFriction(impostor: PhysicsImpostor): number;
  138843. /**
  138844. * Sets friction of the impostor
  138845. * @param impostor impostor to set friction on
  138846. * @param friction friction value
  138847. */
  138848. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  138849. /**
  138850. * Gets restitution of the impostor
  138851. * @param impostor impostor to get restitution from
  138852. * @returns restitution value
  138853. */
  138854. getBodyRestitution(impostor: PhysicsImpostor): number;
  138855. /**
  138856. * Sets resitution of the impostor
  138857. * @param impostor impostor to set resitution on
  138858. * @param restitution resitution value
  138859. */
  138860. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  138861. /**
  138862. * Gets pressure inside the impostor
  138863. * @param impostor impostor to get pressure from
  138864. * @returns pressure value
  138865. */
  138866. getBodyPressure(impostor: PhysicsImpostor): number;
  138867. /**
  138868. * Sets pressure inside a soft body impostor
  138869. * Cloth and rope must remain 0 pressure
  138870. * @param impostor impostor to set pressure on
  138871. * @param pressure pressure value
  138872. */
  138873. setBodyPressure(impostor: PhysicsImpostor, pressure: number): void;
  138874. /**
  138875. * Gets stiffness of the impostor
  138876. * @param impostor impostor to get stiffness from
  138877. * @returns pressure value
  138878. */
  138879. getBodyStiffness(impostor: PhysicsImpostor): number;
  138880. /**
  138881. * Sets stiffness of the impostor
  138882. * @param impostor impostor to set stiffness on
  138883. * @param stiffness stiffness value from 0 to 1
  138884. */
  138885. setBodyStiffness(impostor: PhysicsImpostor, stiffness: number): void;
  138886. /**
  138887. * Gets velocityIterations of the impostor
  138888. * @param impostor impostor to get velocity iterations from
  138889. * @returns velocityIterations value
  138890. */
  138891. getBodyVelocityIterations(impostor: PhysicsImpostor): number;
  138892. /**
  138893. * Sets velocityIterations of the impostor
  138894. * @param impostor impostor to set velocity iterations on
  138895. * @param velocityIterations velocityIterations value
  138896. */
  138897. setBodyVelocityIterations(impostor: PhysicsImpostor, velocityIterations: number): void;
  138898. /**
  138899. * Gets positionIterations of the impostor
  138900. * @param impostor impostor to get position iterations from
  138901. * @returns positionIterations value
  138902. */
  138903. getBodyPositionIterations(impostor: PhysicsImpostor): number;
  138904. /**
  138905. * Sets positionIterations of the impostor
  138906. * @param impostor impostor to set position on
  138907. * @param positionIterations positionIterations value
  138908. */
  138909. setBodyPositionIterations(impostor: PhysicsImpostor, positionIterations: number): void;
  138910. /**
  138911. * Append an anchor to a cloth object
  138912. * @param impostor is the cloth impostor to add anchor to
  138913. * @param otherImpostor is the rigid impostor to anchor to
  138914. * @param width ratio across width from 0 to 1
  138915. * @param height ratio up height from 0 to 1
  138916. * @param influence the elasticity between cloth impostor and anchor from 0, very stretchy to 1, little strech
  138917. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  138918. */
  138919. appendAnchor(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, width: number, height: number, influence?: number, noCollisionBetweenLinkedBodies?: boolean): void;
  138920. /**
  138921. * Append an hook to a rope object
  138922. * @param impostor is the rope impostor to add hook to
  138923. * @param otherImpostor is the rigid impostor to hook to
  138924. * @param length ratio along the rope from 0 to 1
  138925. * @param influence the elasticity between soft impostor and anchor from 0, very stretchy to 1, little strech
  138926. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  138927. */
  138928. appendHook(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, length: number, influence?: number, noCollisionBetweenLinkedBodies?: boolean): void;
  138929. /**
  138930. * Sleeps the physics body and stops it from being active
  138931. * @param impostor impostor to sleep
  138932. */
  138933. sleepBody(impostor: PhysicsImpostor): void;
  138934. /**
  138935. * Activates the physics body
  138936. * @param impostor impostor to activate
  138937. */
  138938. wakeUpBody(impostor: PhysicsImpostor): void;
  138939. /**
  138940. * Updates the distance parameters of the joint
  138941. * @param joint joint to update
  138942. * @param maxDistance maximum distance of the joint
  138943. * @param minDistance minimum distance of the joint
  138944. */
  138945. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  138946. /**
  138947. * Sets a motor on the joint
  138948. * @param joint joint to set motor on
  138949. * @param speed speed of the motor
  138950. * @param maxForce maximum force of the motor
  138951. * @param motorIndex index of the motor
  138952. */
  138953. setMotor(joint: IMotorEnabledJoint, speed?: number, maxForce?: number, motorIndex?: number): void;
  138954. /**
  138955. * Sets the motors limit
  138956. * @param joint joint to set limit on
  138957. * @param upperLimit upper limit
  138958. * @param lowerLimit lower limit
  138959. */
  138960. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number): void;
  138961. /**
  138962. * Syncs the position and rotation of a mesh with the impostor
  138963. * @param mesh mesh to sync
  138964. * @param impostor impostor to update the mesh with
  138965. */
  138966. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  138967. /**
  138968. * Gets the radius of the impostor
  138969. * @param impostor impostor to get radius from
  138970. * @returns the radius
  138971. */
  138972. getRadius(impostor: PhysicsImpostor): number;
  138973. /**
  138974. * Gets the box size of the impostor
  138975. * @param impostor impostor to get box size from
  138976. * @param result the resulting box size
  138977. */
  138978. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  138979. /**
  138980. * Disposes of the impostor
  138981. */
  138982. dispose(): void;
  138983. /**
  138984. * Does a raycast in the physics world
  138985. * @param from when should the ray start?
  138986. * @param to when should the ray end?
  138987. * @returns PhysicsRaycastResult
  138988. */
  138989. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  138990. }
  138991. }
  138992. declare module BABYLON {
  138993. interface AbstractScene {
  138994. /**
  138995. * The list of reflection probes added to the scene
  138996. * @see https://doc.babylonjs.com/how_to/how_to_use_reflection_probes
  138997. */
  138998. reflectionProbes: Array<ReflectionProbe>;
  138999. /**
  139000. * Removes the given reflection probe from this scene.
  139001. * @param toRemove The reflection probe to remove
  139002. * @returns The index of the removed reflection probe
  139003. */
  139004. removeReflectionProbe(toRemove: ReflectionProbe): number;
  139005. /**
  139006. * Adds the given reflection probe to this scene.
  139007. * @param newReflectionProbe The reflection probe to add
  139008. */
  139009. addReflectionProbe(newReflectionProbe: ReflectionProbe): void;
  139010. }
  139011. /**
  139012. * Class used to generate realtime reflection / refraction cube textures
  139013. * @see https://doc.babylonjs.com/how_to/how_to_use_reflection_probes
  139014. */
  139015. export class ReflectionProbe {
  139016. /** defines the name of the probe */
  139017. name: string;
  139018. private _scene;
  139019. private _renderTargetTexture;
  139020. private _projectionMatrix;
  139021. private _viewMatrix;
  139022. private _target;
  139023. private _add;
  139024. private _attachedMesh;
  139025. private _invertYAxis;
  139026. /** Gets or sets probe position (center of the cube map) */
  139027. position: Vector3;
  139028. /**
  139029. * Creates a new reflection probe
  139030. * @param name defines the name of the probe
  139031. * @param size defines the texture resolution (for each face)
  139032. * @param scene defines the hosting scene
  139033. * @param generateMipMaps defines if mip maps should be generated automatically (true by default)
  139034. * @param useFloat defines if HDR data (flaot data) should be used to store colors (false by default)
  139035. */
  139036. constructor(
  139037. /** defines the name of the probe */
  139038. name: string, size: number, scene: Scene, generateMipMaps?: boolean, useFloat?: boolean);
  139039. /** Gets or sets the number of samples to use for multi-sampling (0 by default). Required WebGL2 */
  139040. get samples(): number;
  139041. set samples(value: number);
  139042. /** Gets or sets the refresh rate to use (on every frame by default) */
  139043. get refreshRate(): number;
  139044. set refreshRate(value: number);
  139045. /**
  139046. * Gets the hosting scene
  139047. * @returns a Scene
  139048. */
  139049. getScene(): Scene;
  139050. /** Gets the internal CubeTexture used to render to */
  139051. get cubeTexture(): RenderTargetTexture;
  139052. /** Gets the list of meshes to render */
  139053. get renderList(): Nullable<AbstractMesh[]>;
  139054. /**
  139055. * Attach the probe to a specific mesh (Rendering will be done from attached mesh's position)
  139056. * @param mesh defines the mesh to attach to
  139057. */
  139058. attachToMesh(mesh: Nullable<AbstractMesh>): void;
  139059. /**
  139060. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups
  139061. * @param renderingGroupId The rendering group id corresponding to its index
  139062. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  139063. */
  139064. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean): void;
  139065. /**
  139066. * Clean all associated resources
  139067. */
  139068. dispose(): void;
  139069. /**
  139070. * Converts the reflection probe information to a readable string for debug purpose.
  139071. * @param fullDetails Supports for multiple levels of logging within scene loading
  139072. * @returns the human readable reflection probe info
  139073. */
  139074. toString(fullDetails?: boolean): string;
  139075. /**
  139076. * Get the class name of the relfection probe.
  139077. * @returns "ReflectionProbe"
  139078. */
  139079. getClassName(): string;
  139080. /**
  139081. * Serialize the reflection probe to a JSON representation we can easily use in the resepective Parse function.
  139082. * @returns The JSON representation of the texture
  139083. */
  139084. serialize(): any;
  139085. /**
  139086. * Parse the JSON representation of a reflection probe in order to recreate the reflection probe in the given scene.
  139087. * @param parsedReflectionProbe Define the JSON representation of the reflection probe
  139088. * @param scene Define the scene the parsed reflection probe should be instantiated in
  139089. * @param rootUrl Define the root url of the parsing sequence in the case of relative dependencies
  139090. * @returns The parsed reflection probe if successful
  139091. */
  139092. static Parse(parsedReflectionProbe: any, scene: Scene, rootUrl: string): Nullable<ReflectionProbe>;
  139093. }
  139094. }
  139095. declare module BABYLON {
  139096. /** @hidden */
  139097. export var _BabylonLoaderRegistered: boolean;
  139098. /**
  139099. * Helps setting up some configuration for the babylon file loader.
  139100. */
  139101. export class BabylonFileLoaderConfiguration {
  139102. /**
  139103. * The loader does not allow injecting custom physix engine into the plugins.
  139104. * Unfortunately in ES6, we need to manually inject them into the plugin.
  139105. * So you could set this variable to your engine import to make it work.
  139106. */
  139107. static LoaderInjectedPhysicsEngine: any;
  139108. }
  139109. }
  139110. declare module BABYLON {
  139111. /**
  139112. * The Physically based simple base material of BJS.
  139113. *
  139114. * This enables better naming and convention enforcements on top of the pbrMaterial.
  139115. * It is used as the base class for both the specGloss and metalRough conventions.
  139116. */
  139117. export abstract class PBRBaseSimpleMaterial extends PBRBaseMaterial {
  139118. /**
  139119. * Number of Simultaneous lights allowed on the material.
  139120. */
  139121. maxSimultaneousLights: number;
  139122. /**
  139123. * If sets to true, disables all the lights affecting the material.
  139124. */
  139125. disableLighting: boolean;
  139126. /**
  139127. * Environment Texture used in the material (this is use for both reflection and environment lighting).
  139128. */
  139129. environmentTexture: BaseTexture;
  139130. /**
  139131. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  139132. */
  139133. invertNormalMapX: boolean;
  139134. /**
  139135. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  139136. */
  139137. invertNormalMapY: boolean;
  139138. /**
  139139. * Normal map used in the model.
  139140. */
  139141. normalTexture: BaseTexture;
  139142. /**
  139143. * Emissivie color used to self-illuminate the model.
  139144. */
  139145. emissiveColor: Color3;
  139146. /**
  139147. * Emissivie texture used to self-illuminate the model.
  139148. */
  139149. emissiveTexture: BaseTexture;
  139150. /**
  139151. * Occlusion Channel Strenght.
  139152. */
  139153. occlusionStrength: number;
  139154. /**
  139155. * Occlusion Texture of the material (adding extra occlusion effects).
  139156. */
  139157. occlusionTexture: BaseTexture;
  139158. /**
  139159. * Defines the alpha limits in alpha test mode.
  139160. */
  139161. alphaCutOff: number;
  139162. /**
  139163. * Gets the current double sided mode.
  139164. */
  139165. get doubleSided(): boolean;
  139166. /**
  139167. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  139168. */
  139169. set doubleSided(value: boolean);
  139170. /**
  139171. * Stores the pre-calculated light information of a mesh in a texture.
  139172. */
  139173. lightmapTexture: BaseTexture;
  139174. /**
  139175. * If true, the light map contains occlusion information instead of lighting info.
  139176. */
  139177. useLightmapAsShadowmap: boolean;
  139178. /**
  139179. * Instantiates a new PBRMaterial instance.
  139180. *
  139181. * @param name The material name
  139182. * @param scene The scene the material will be use in.
  139183. */
  139184. constructor(name: string, scene: Scene);
  139185. getClassName(): string;
  139186. }
  139187. }
  139188. declare module BABYLON {
  139189. /**
  139190. * The PBR material of BJS following the metal roughness convention.
  139191. *
  139192. * This fits to the PBR convention in the GLTF definition:
  139193. * https://github.com/KhronosGroup/glTF/tree/2.0/specification/2.0
  139194. */
  139195. export class PBRMetallicRoughnessMaterial extends PBRBaseSimpleMaterial {
  139196. /**
  139197. * The base color has two different interpretations depending on the value of metalness.
  139198. * When the material is a metal, the base color is the specific measured reflectance value
  139199. * at normal incidence (F0). For a non-metal the base color represents the reflected diffuse color
  139200. * of the material.
  139201. */
  139202. baseColor: Color3;
  139203. /**
  139204. * Base texture of the metallic workflow. It contains both the baseColor information in RGB as
  139205. * well as opacity information in the alpha channel.
  139206. */
  139207. baseTexture: BaseTexture;
  139208. /**
  139209. * Specifies the metallic scalar value of the material.
  139210. * Can also be used to scale the metalness values of the metallic texture.
  139211. */
  139212. metallic: number;
  139213. /**
  139214. * Specifies the roughness scalar value of the material.
  139215. * Can also be used to scale the roughness values of the metallic texture.
  139216. */
  139217. roughness: number;
  139218. /**
  139219. * Texture containing both the metallic value in the B channel and the
  139220. * roughness value in the G channel to keep better precision.
  139221. */
  139222. metallicRoughnessTexture: BaseTexture;
  139223. /**
  139224. * Instantiates a new PBRMetalRoughnessMaterial instance.
  139225. *
  139226. * @param name The material name
  139227. * @param scene The scene the material will be use in.
  139228. */
  139229. constructor(name: string, scene: Scene);
  139230. /**
  139231. * Return the currrent class name of the material.
  139232. */
  139233. getClassName(): string;
  139234. /**
  139235. * Makes a duplicate of the current material.
  139236. * @param name - name to use for the new material.
  139237. */
  139238. clone(name: string): PBRMetallicRoughnessMaterial;
  139239. /**
  139240. * Serialize the material to a parsable JSON object.
  139241. */
  139242. serialize(): any;
  139243. /**
  139244. * Parses a JSON object correponding to the serialize function.
  139245. */
  139246. static Parse(source: any, scene: Scene, rootUrl: string): PBRMetallicRoughnessMaterial;
  139247. }
  139248. }
  139249. declare module BABYLON {
  139250. /**
  139251. * The PBR material of BJS following the specular glossiness convention.
  139252. *
  139253. * This fits to the PBR convention in the GLTF definition:
  139254. * https://github.com/KhronosGroup/glTF/tree/2.0/extensions/Khronos/KHR_materials_pbrSpecularGlossiness
  139255. */
  139256. export class PBRSpecularGlossinessMaterial extends PBRBaseSimpleMaterial {
  139257. /**
  139258. * Specifies the diffuse color of the material.
  139259. */
  139260. diffuseColor: Color3;
  139261. /**
  139262. * Specifies the diffuse texture of the material. This can also contains the opcity value in its alpha
  139263. * channel.
  139264. */
  139265. diffuseTexture: BaseTexture;
  139266. /**
  139267. * Specifies the specular color of the material. This indicates how reflective is the material (none to mirror).
  139268. */
  139269. specularColor: Color3;
  139270. /**
  139271. * Specifies the glossiness of the material. This indicates "how sharp is the reflection".
  139272. */
  139273. glossiness: number;
  139274. /**
  139275. * Specifies both the specular color RGB and the glossiness A of the material per pixels.
  139276. */
  139277. specularGlossinessTexture: BaseTexture;
  139278. /**
  139279. * Instantiates a new PBRSpecularGlossinessMaterial instance.
  139280. *
  139281. * @param name The material name
  139282. * @param scene The scene the material will be use in.
  139283. */
  139284. constructor(name: string, scene: Scene);
  139285. /**
  139286. * Return the currrent class name of the material.
  139287. */
  139288. getClassName(): string;
  139289. /**
  139290. * Makes a duplicate of the current material.
  139291. * @param name - name to use for the new material.
  139292. */
  139293. clone(name: string): PBRSpecularGlossinessMaterial;
  139294. /**
  139295. * Serialize the material to a parsable JSON object.
  139296. */
  139297. serialize(): any;
  139298. /**
  139299. * Parses a JSON object correponding to the serialize function.
  139300. */
  139301. static Parse(source: any, scene: Scene, rootUrl: string): PBRSpecularGlossinessMaterial;
  139302. }
  139303. }
  139304. declare module BABYLON {
  139305. /**
  139306. * This represents a color grading texture. This acts as a lookup table LUT, useful during post process
  139307. * It can help converting any input color in a desired output one. This can then be used to create effects
  139308. * from sepia, black and white to sixties or futuristic rendering...
  139309. *
  139310. * The only supported format is currently 3dl.
  139311. * More information on LUT: https://en.wikipedia.org/wiki/3D_lookup_table
  139312. */
  139313. export class ColorGradingTexture extends BaseTexture {
  139314. /**
  139315. * The texture URL.
  139316. */
  139317. url: string;
  139318. /**
  139319. * Empty line regex stored for GC.
  139320. */
  139321. private static _noneEmptyLineRegex;
  139322. private _textureMatrix;
  139323. private _onLoad;
  139324. /**
  139325. * Instantiates a ColorGradingTexture from the following parameters.
  139326. *
  139327. * @param url The location of the color gradind data (currently only supporting 3dl)
  139328. * @param sceneOrEngine The scene or engine the texture will be used in
  139329. * @param onLoad defines a callback triggered when the texture has been loaded
  139330. */
  139331. constructor(url: string, sceneOrEngine: Scene | ThinEngine, onLoad?: Nullable<() => void>);
  139332. /**
  139333. * Fires the onload event from the constructor if requested.
  139334. */
  139335. private _triggerOnLoad;
  139336. /**
  139337. * Returns the texture matrix used in most of the material.
  139338. * This is not used in color grading but keep for troubleshooting purpose (easily swap diffuse by colorgrading to look in).
  139339. */
  139340. getTextureMatrix(): Matrix;
  139341. /**
  139342. * Occurs when the file being loaded is a .3dl LUT file.
  139343. */
  139344. private load3dlTexture;
  139345. /**
  139346. * Starts the loading process of the texture.
  139347. */
  139348. private loadTexture;
  139349. /**
  139350. * Clones the color gradind texture.
  139351. */
  139352. clone(): ColorGradingTexture;
  139353. /**
  139354. * Called during delayed load for textures.
  139355. */
  139356. delayLoad(): void;
  139357. /**
  139358. * Parses a color grading texture serialized by Babylon.
  139359. * @param parsedTexture The texture information being parsedTexture
  139360. * @param scene The scene to load the texture in
  139361. * @param rootUrl The root url of the data assets to load
  139362. * @return A color gradind texture
  139363. */
  139364. static Parse(parsedTexture: any, scene: Scene): Nullable<ColorGradingTexture>;
  139365. /**
  139366. * Serializes the LUT texture to json format.
  139367. */
  139368. serialize(): any;
  139369. }
  139370. }
  139371. declare module BABYLON {
  139372. /**
  139373. * This represents a texture coming from an equirectangular image supported by the web browser canvas.
  139374. */
  139375. export class EquiRectangularCubeTexture extends BaseTexture {
  139376. /** The six faces of the cube. */
  139377. private static _FacesMapping;
  139378. private _noMipmap;
  139379. private _onLoad;
  139380. private _onError;
  139381. /** The size of the cubemap. */
  139382. private _size;
  139383. /** The buffer of the image. */
  139384. private _buffer;
  139385. /** The width of the input image. */
  139386. private _width;
  139387. /** The height of the input image. */
  139388. private _height;
  139389. /** The URL to the image. */
  139390. url: string;
  139391. /** The texture coordinates mode. As this texture is stored in a cube format, please modify carefully. */
  139392. coordinatesMode: number;
  139393. /**
  139394. * Instantiates an EquiRectangularCubeTexture from the following parameters.
  139395. * @param url The location of the image
  139396. * @param scene The scene the texture will be used in
  139397. * @param size The cubemap desired size (the more it increases the longer the generation will be)
  139398. * @param noMipmap Forces to not generate the mipmap if true
  139399. * @param gammaSpace Specifies if the texture will be used in gamma or linear space
  139400. * (the PBR material requires those textures in linear space, but the standard material would require them in Gamma space)
  139401. * @param onLoad — defines a callback called when texture is loaded
  139402. * @param onError — defines a callback called if there is an error
  139403. */
  139404. constructor(url: string, scene: Scene, size: number, noMipmap?: boolean, gammaSpace?: boolean, onLoad?: Nullable<() => void>, onError?: Nullable<(message?: string, exception?: any) => void>);
  139405. /**
  139406. * Load the image data, by putting the image on a canvas and extracting its buffer.
  139407. */
  139408. private loadImage;
  139409. /**
  139410. * Convert the image buffer into a cubemap and create a CubeTexture.
  139411. */
  139412. private loadTexture;
  139413. /**
  139414. * Convert the ArrayBuffer into a Float32Array and drop the transparency channel.
  139415. * @param buffer The ArrayBuffer that should be converted.
  139416. * @returns The buffer as Float32Array.
  139417. */
  139418. private getFloat32ArrayFromArrayBuffer;
  139419. /**
  139420. * Get the current class name of the texture useful for serialization or dynamic coding.
  139421. * @returns "EquiRectangularCubeTexture"
  139422. */
  139423. getClassName(): string;
  139424. /**
  139425. * Create a clone of the current EquiRectangularCubeTexture and return it.
  139426. * @returns A clone of the current EquiRectangularCubeTexture.
  139427. */
  139428. clone(): EquiRectangularCubeTexture;
  139429. }
  139430. }
  139431. declare module BABYLON {
  139432. /**
  139433. * Defines the options related to the creation of an HtmlElementTexture
  139434. */
  139435. export interface IHtmlElementTextureOptions {
  139436. /**
  139437. * Defines wether mip maps should be created or not.
  139438. */
  139439. generateMipMaps?: boolean;
  139440. /**
  139441. * Defines the sampling mode of the texture.
  139442. */
  139443. samplingMode?: number;
  139444. /**
  139445. * Defines the engine instance to use the texture with. It is not mandatory if you define a scene.
  139446. */
  139447. engine: Nullable<ThinEngine>;
  139448. /**
  139449. * Defines the scene the texture belongs to. It is not mandatory if you define an engine.
  139450. */
  139451. scene: Nullable<Scene>;
  139452. }
  139453. /**
  139454. * This represents the smallest workload to use an already existing element (Canvas or Video) as a texture.
  139455. * To be as efficient as possible depending on your constraints nothing aside the first upload
  139456. * is automatically managed.
  139457. * It is a cheap VideoTexture or DynamicTexture if you prefer to keep full control of the elements
  139458. * in your application.
  139459. *
  139460. * As the update is not automatic, you need to call them manually.
  139461. */
  139462. export class HtmlElementTexture extends BaseTexture {
  139463. /**
  139464. * The texture URL.
  139465. */
  139466. element: HTMLVideoElement | HTMLCanvasElement;
  139467. private static readonly DefaultOptions;
  139468. private _textureMatrix;
  139469. private _isVideo;
  139470. private _generateMipMaps;
  139471. private _samplingMode;
  139472. /**
  139473. * Instantiates a HtmlElementTexture from the following parameters.
  139474. *
  139475. * @param name Defines the name of the texture
  139476. * @param element Defines the video or canvas the texture is filled with
  139477. * @param options Defines the other none mandatory texture creation options
  139478. */
  139479. constructor(name: string, element: HTMLVideoElement | HTMLCanvasElement, options: IHtmlElementTextureOptions);
  139480. private _createInternalTexture;
  139481. /**
  139482. * Returns the texture matrix used in most of the material.
  139483. */
  139484. getTextureMatrix(): Matrix;
  139485. /**
  139486. * Updates the content of the texture.
  139487. * @param invertY Defines wether the texture should be inverted on Y (false by default on video and true on canvas)
  139488. */
  139489. update(invertY?: Nullable<boolean>): void;
  139490. }
  139491. }
  139492. declare module BABYLON {
  139493. /**
  139494. * Based on jsTGALoader - Javascript loader for TGA file
  139495. * By Vincent Thibault
  139496. * @see http://blog.robrowser.com/javascript-tga-loader.html
  139497. */
  139498. export class TGATools {
  139499. private static _TYPE_INDEXED;
  139500. private static _TYPE_RGB;
  139501. private static _TYPE_GREY;
  139502. private static _TYPE_RLE_INDEXED;
  139503. private static _TYPE_RLE_RGB;
  139504. private static _TYPE_RLE_GREY;
  139505. private static _ORIGIN_MASK;
  139506. private static _ORIGIN_SHIFT;
  139507. private static _ORIGIN_BL;
  139508. private static _ORIGIN_BR;
  139509. private static _ORIGIN_UL;
  139510. private static _ORIGIN_UR;
  139511. /**
  139512. * Gets the header of a TGA file
  139513. * @param data defines the TGA data
  139514. * @returns the header
  139515. */
  139516. static GetTGAHeader(data: Uint8Array): any;
  139517. /**
  139518. * Uploads TGA content to a Babylon Texture
  139519. * @hidden
  139520. */
  139521. static UploadContent(texture: InternalTexture, data: Uint8Array): void;
  139522. /** @hidden */
  139523. 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;
  139524. /** @hidden */
  139525. 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;
  139526. /** @hidden */
  139527. 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;
  139528. /** @hidden */
  139529. 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;
  139530. /** @hidden */
  139531. 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;
  139532. /** @hidden */
  139533. 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;
  139534. }
  139535. }
  139536. declare module BABYLON {
  139537. /**
  139538. * Implementation of the TGA Texture Loader.
  139539. * @hidden
  139540. */
  139541. export class _TGATextureLoader implements IInternalTextureLoader {
  139542. /**
  139543. * Defines wether the loader supports cascade loading the different faces.
  139544. */
  139545. readonly supportCascades: boolean;
  139546. /**
  139547. * This returns if the loader support the current file information.
  139548. * @param extension defines the file extension of the file being loaded
  139549. * @returns true if the loader can load the specified file
  139550. */
  139551. canLoad(extension: string): boolean;
  139552. /**
  139553. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  139554. * @param data contains the texture data
  139555. * @param texture defines the BabylonJS internal texture
  139556. * @param createPolynomials will be true if polynomials have been requested
  139557. * @param onLoad defines the callback to trigger once the texture is ready
  139558. * @param onError defines the callback to trigger in case of error
  139559. */
  139560. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  139561. /**
  139562. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  139563. * @param data contains the texture data
  139564. * @param texture defines the BabylonJS internal texture
  139565. * @param callback defines the method to call once ready to upload
  139566. */
  139567. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  139568. }
  139569. }
  139570. declare module BABYLON {
  139571. /**
  139572. * Info about the .basis files
  139573. */
  139574. class BasisFileInfo {
  139575. /**
  139576. * If the file has alpha
  139577. */
  139578. hasAlpha: boolean;
  139579. /**
  139580. * Info about each image of the basis file
  139581. */
  139582. images: Array<{
  139583. levels: Array<{
  139584. width: number;
  139585. height: number;
  139586. transcodedPixels: ArrayBufferView;
  139587. }>;
  139588. }>;
  139589. }
  139590. /**
  139591. * Result of transcoding a basis file
  139592. */
  139593. class TranscodeResult {
  139594. /**
  139595. * Info about the .basis file
  139596. */
  139597. fileInfo: BasisFileInfo;
  139598. /**
  139599. * Format to use when loading the file
  139600. */
  139601. format: number;
  139602. }
  139603. /**
  139604. * Configuration options for the Basis transcoder
  139605. */
  139606. export class BasisTranscodeConfiguration {
  139607. /**
  139608. * Supported compression formats used to determine the supported output format of the transcoder
  139609. */
  139610. supportedCompressionFormats?: {
  139611. /**
  139612. * etc1 compression format
  139613. */
  139614. etc1?: boolean;
  139615. /**
  139616. * s3tc compression format
  139617. */
  139618. s3tc?: boolean;
  139619. /**
  139620. * pvrtc compression format
  139621. */
  139622. pvrtc?: boolean;
  139623. /**
  139624. * etc2 compression format
  139625. */
  139626. etc2?: boolean;
  139627. };
  139628. /**
  139629. * If mipmap levels should be loaded for transcoded images (Default: true)
  139630. */
  139631. loadMipmapLevels?: boolean;
  139632. /**
  139633. * Index of a single image to load (Default: all images)
  139634. */
  139635. loadSingleImage?: number;
  139636. }
  139637. /**
  139638. * Used to load .Basis files
  139639. * See https://github.com/BinomialLLC/basis_universal/tree/master/webgl
  139640. */
  139641. export class BasisTools {
  139642. private static _IgnoreSupportedFormats;
  139643. /**
  139644. * URL to use when loading the basis transcoder
  139645. */
  139646. static JSModuleURL: string;
  139647. /**
  139648. * URL to use when loading the wasm module for the transcoder
  139649. */
  139650. static WasmModuleURL: string;
  139651. /**
  139652. * Get the internal format to be passed to texImage2D corresponding to the .basis format value
  139653. * @param basisFormat format chosen from GetSupportedTranscodeFormat
  139654. * @returns internal format corresponding to the Basis format
  139655. */
  139656. static GetInternalFormatFromBasisFormat(basisFormat: number): number;
  139657. private static _WorkerPromise;
  139658. private static _Worker;
  139659. private static _actionId;
  139660. private static _CreateWorkerAsync;
  139661. /**
  139662. * Transcodes a loaded image file to compressed pixel data
  139663. * @param data image data to transcode
  139664. * @param config configuration options for the transcoding
  139665. * @returns a promise resulting in the transcoded image
  139666. */
  139667. static TranscodeAsync(data: ArrayBuffer | ArrayBufferView, config: BasisTranscodeConfiguration): Promise<TranscodeResult>;
  139668. /**
  139669. * Loads a texture from the transcode result
  139670. * @param texture texture load to
  139671. * @param transcodeResult the result of transcoding the basis file to load from
  139672. */
  139673. static LoadTextureFromTranscodeResult(texture: InternalTexture, transcodeResult: TranscodeResult): void;
  139674. }
  139675. }
  139676. declare module BABYLON {
  139677. /**
  139678. * Loader for .basis file format
  139679. */
  139680. export class _BasisTextureLoader implements IInternalTextureLoader {
  139681. /**
  139682. * Defines whether the loader supports cascade loading the different faces.
  139683. */
  139684. readonly supportCascades: boolean;
  139685. /**
  139686. * This returns if the loader support the current file information.
  139687. * @param extension defines the file extension of the file being loaded
  139688. * @returns true if the loader can load the specified file
  139689. */
  139690. canLoad(extension: string): boolean;
  139691. /**
  139692. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  139693. * @param data contains the texture data
  139694. * @param texture defines the BabylonJS internal texture
  139695. * @param createPolynomials will be true if polynomials have been requested
  139696. * @param onLoad defines the callback to trigger once the texture is ready
  139697. * @param onError defines the callback to trigger in case of error
  139698. */
  139699. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  139700. /**
  139701. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  139702. * @param data contains the texture data
  139703. * @param texture defines the BabylonJS internal texture
  139704. * @param callback defines the method to call once ready to upload
  139705. */
  139706. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  139707. }
  139708. }
  139709. declare module BABYLON {
  139710. /**
  139711. * Defines the basic options interface of a TexturePacker Frame
  139712. */
  139713. export interface ITexturePackerFrame {
  139714. /**
  139715. * The frame ID
  139716. */
  139717. id: number;
  139718. /**
  139719. * The frames Scale
  139720. */
  139721. scale: Vector2;
  139722. /**
  139723. * The Frames offset
  139724. */
  139725. offset: Vector2;
  139726. }
  139727. /**
  139728. * This is a support class for frame Data on texture packer sets.
  139729. */
  139730. export class TexturePackerFrame implements ITexturePackerFrame {
  139731. /**
  139732. * The frame ID
  139733. */
  139734. id: number;
  139735. /**
  139736. * The frames Scale
  139737. */
  139738. scale: Vector2;
  139739. /**
  139740. * The Frames offset
  139741. */
  139742. offset: Vector2;
  139743. /**
  139744. * Initializes a texture package frame.
  139745. * @param id The numerical frame identifier
  139746. * @param scale Scalar Vector2 for UV frame
  139747. * @param offset Vector2 for the frame position in UV units.
  139748. * @returns TexturePackerFrame
  139749. */
  139750. constructor(id: number, scale: Vector2, offset: Vector2);
  139751. }
  139752. }
  139753. declare module BABYLON {
  139754. /**
  139755. * Defines the basic options interface of a TexturePacker
  139756. */
  139757. export interface ITexturePackerOptions {
  139758. /**
  139759. * Custom targets for the channels of a texture packer. Default is all the channels of the Standard Material
  139760. */
  139761. map?: string[];
  139762. /**
  139763. * the UV input targets, as a single value for all meshes. Defaults to VertexBuffer.UVKind
  139764. */
  139765. uvsIn?: string;
  139766. /**
  139767. * the UV output targets, as a single value for all meshes. Defaults to VertexBuffer.UVKind
  139768. */
  139769. uvsOut?: string;
  139770. /**
  139771. * number representing the layout style. Defaults to LAYOUT_STRIP
  139772. */
  139773. layout?: number;
  139774. /**
  139775. * number of columns if using custom column count layout(2). This defaults to 4.
  139776. */
  139777. colnum?: number;
  139778. /**
  139779. * flag to update the input meshes to the new packed texture after compilation. Defaults to true.
  139780. */
  139781. updateInputMeshes?: boolean;
  139782. /**
  139783. * boolean flag to dispose all the source textures. Defaults to true.
  139784. */
  139785. disposeSources?: boolean;
  139786. /**
  139787. * Fills the blank cells in a set to the customFillColor. Defaults to true.
  139788. */
  139789. fillBlanks?: boolean;
  139790. /**
  139791. * string value representing the context fill style color. Defaults to 'black'.
  139792. */
  139793. customFillColor?: string;
  139794. /**
  139795. * Width and Height Value of each Frame in the TexturePacker Sets
  139796. */
  139797. frameSize?: number;
  139798. /**
  139799. * Ratio of the value to add padding wise to each cell. Defaults to 0.0115
  139800. */
  139801. paddingRatio?: number;
  139802. /**
  139803. * Number that declares the fill method for the padding gutter.
  139804. */
  139805. paddingMode?: number;
  139806. /**
  139807. * If in SUBUV_COLOR padding mode what color to use.
  139808. */
  139809. paddingColor?: Color3 | Color4;
  139810. }
  139811. /**
  139812. * Defines the basic interface of a TexturePacker JSON File
  139813. */
  139814. export interface ITexturePackerJSON {
  139815. /**
  139816. * The frame ID
  139817. */
  139818. name: string;
  139819. /**
  139820. * The base64 channel data
  139821. */
  139822. sets: any;
  139823. /**
  139824. * The options of the Packer
  139825. */
  139826. options: ITexturePackerOptions;
  139827. /**
  139828. * The frame data of the Packer
  139829. */
  139830. frames: Array<number>;
  139831. }
  139832. /**
  139833. * This is a support class that generates a series of packed texture sets.
  139834. * @see https://doc.babylonjs.com/babylon101/materials
  139835. */
  139836. export class TexturePacker {
  139837. /** Packer Layout Constant 0 */
  139838. static readonly LAYOUT_STRIP: number;
  139839. /** Packer Layout Constant 1 */
  139840. static readonly LAYOUT_POWER2: number;
  139841. /** Packer Layout Constant 2 */
  139842. static readonly LAYOUT_COLNUM: number;
  139843. /** Packer Layout Constant 0 */
  139844. static readonly SUBUV_WRAP: number;
  139845. /** Packer Layout Constant 1 */
  139846. static readonly SUBUV_EXTEND: number;
  139847. /** Packer Layout Constant 2 */
  139848. static readonly SUBUV_COLOR: number;
  139849. /** The Name of the Texture Package */
  139850. name: string;
  139851. /** The scene scope of the TexturePacker */
  139852. scene: Scene;
  139853. /** The Meshes to target */
  139854. meshes: AbstractMesh[];
  139855. /** Arguments passed with the Constructor */
  139856. options: ITexturePackerOptions;
  139857. /** The promise that is started upon initialization */
  139858. promise: Nullable<Promise<TexturePacker | string>>;
  139859. /** The Container object for the channel sets that are generated */
  139860. sets: object;
  139861. /** The Container array for the frames that are generated */
  139862. frames: TexturePackerFrame[];
  139863. /** The expected number of textures the system is parsing. */
  139864. private _expecting;
  139865. /** The padding value from Math.ceil(frameSize * paddingRatio) */
  139866. private _paddingValue;
  139867. /**
  139868. * Initializes a texture package series from an array of meshes or a single mesh.
  139869. * @param name The name of the package
  139870. * @param meshes The target meshes to compose the package from
  139871. * @param options The arguments that texture packer should follow while building.
  139872. * @param scene The scene which the textures are scoped to.
  139873. * @returns TexturePacker
  139874. */
  139875. constructor(name: string, meshes: AbstractMesh[], options: ITexturePackerOptions, scene: Scene);
  139876. /**
  139877. * Starts the package process
  139878. * @param resolve The promises resolution function
  139879. * @returns TexturePacker
  139880. */
  139881. private _createFrames;
  139882. /**
  139883. * Calculates the Size of the Channel Sets
  139884. * @returns Vector2
  139885. */
  139886. private _calculateSize;
  139887. /**
  139888. * Calculates the UV data for the frames.
  139889. * @param baseSize the base frameSize
  139890. * @param padding the base frame padding
  139891. * @param dtSize size of the Dynamic Texture for that channel
  139892. * @param dtUnits is 1/dtSize
  139893. * @param update flag to update the input meshes
  139894. */
  139895. private _calculateMeshUVFrames;
  139896. /**
  139897. * Calculates the frames Offset.
  139898. * @param index of the frame
  139899. * @returns Vector2
  139900. */
  139901. private _getFrameOffset;
  139902. /**
  139903. * Updates a Mesh to the frame data
  139904. * @param mesh that is the target
  139905. * @param frameID or the frame index
  139906. */
  139907. private _updateMeshUV;
  139908. /**
  139909. * Updates a Meshes materials to use the texture packer channels
  139910. * @param m is the mesh to target
  139911. * @param force all channels on the packer to be set.
  139912. */
  139913. private _updateTextureReferences;
  139914. /**
  139915. * Public method to set a Mesh to a frame
  139916. * @param m that is the target
  139917. * @param frameID or the frame index
  139918. * @param updateMaterial trigger for if the Meshes attached Material be updated?
  139919. */
  139920. setMeshToFrame(m: AbstractMesh, frameID: number, updateMaterial?: boolean): void;
  139921. /**
  139922. * Starts the async promise to compile the texture packer.
  139923. * @returns Promise<void>
  139924. */
  139925. processAsync(): Promise<void>;
  139926. /**
  139927. * Disposes all textures associated with this packer
  139928. */
  139929. dispose(): void;
  139930. /**
  139931. * Starts the download process for all the channels converting them to base64 data and embedding it all in a JSON file.
  139932. * @param imageType is the image type to use.
  139933. * @param quality of the image if downloading as jpeg, Ranges from >0 to 1.
  139934. */
  139935. download(imageType?: string, quality?: number): void;
  139936. /**
  139937. * Public method to load a texturePacker JSON file.
  139938. * @param data of the JSON file in string format.
  139939. */
  139940. updateFromJSON(data: string): void;
  139941. }
  139942. }
  139943. declare module BABYLON {
  139944. /**
  139945. * 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.
  139946. * Custom Procedural textures are the easiest way to create your own procedural in your application.
  139947. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures#creating-custom-procedural-textures
  139948. */
  139949. export class CustomProceduralTexture extends ProceduralTexture {
  139950. private _animate;
  139951. private _time;
  139952. private _config;
  139953. private _texturePath;
  139954. /**
  139955. * Instantiates a new Custom Procedural Texture.
  139956. * 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.
  139957. * Custom Procedural textures are the easiest way to create your own procedural in your application.
  139958. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures#creating-custom-procedural-textures
  139959. * @param name Define the name of the texture
  139960. * @param texturePath Define the folder path containing all the cutom texture related files (config, shaders...)
  139961. * @param size Define the size of the texture to create
  139962. * @param scene Define the scene the texture belongs to
  139963. * @param fallbackTexture Define a fallback texture in case there were issues to create the custom texture
  139964. * @param generateMipMaps Define if the texture should creates mip maps or not
  139965. */
  139966. constructor(name: string, texturePath: string, size: number, scene: Scene, fallbackTexture?: Texture, generateMipMaps?: boolean);
  139967. private _loadJson;
  139968. /**
  139969. * Is the texture ready to be used ? (rendered at least once)
  139970. * @returns true if ready, otherwise, false.
  139971. */
  139972. isReady(): boolean;
  139973. /**
  139974. * Render the texture to its associated render target.
  139975. * @param useCameraPostProcess Define if camera post process should be applied to the texture
  139976. */
  139977. render(useCameraPostProcess?: boolean): void;
  139978. /**
  139979. * Update the list of dependant textures samplers in the shader.
  139980. */
  139981. updateTextures(): void;
  139982. /**
  139983. * Update the uniform values of the procedural texture in the shader.
  139984. */
  139985. updateShaderUniforms(): void;
  139986. /**
  139987. * Define if the texture animates or not.
  139988. */
  139989. get animate(): boolean;
  139990. set animate(value: boolean);
  139991. }
  139992. }
  139993. declare module BABYLON {
  139994. /** @hidden */
  139995. export var noisePixelShader: {
  139996. name: string;
  139997. shader: string;
  139998. };
  139999. }
  140000. declare module BABYLON {
  140001. /**
  140002. * Class used to generate noise procedural textures
  140003. */
  140004. export class NoiseProceduralTexture extends ProceduralTexture {
  140005. private _time;
  140006. /** Gets or sets a value between 0 and 1 indicating the overall brightness of the texture (default is 0.2) */
  140007. brightness: number;
  140008. /** Defines the number of octaves to process */
  140009. octaves: number;
  140010. /** Defines the level of persistence (0.8 by default) */
  140011. persistence: number;
  140012. /** Gets or sets animation speed factor (default is 1) */
  140013. animationSpeedFactor: number;
  140014. /**
  140015. * Creates a new NoiseProceduralTexture
  140016. * @param name defines the name fo the texture
  140017. * @param size defines the size of the texture (default is 256)
  140018. * @param scene defines the hosting scene
  140019. * @param fallbackTexture defines the texture to use if the NoiseProceduralTexture can't be created
  140020. * @param generateMipMaps defines if mipmaps must be generated (true by default)
  140021. */
  140022. constructor(name: string, size?: number, scene?: Nullable<Scene>, fallbackTexture?: Texture, generateMipMaps?: boolean);
  140023. private _updateShaderUniforms;
  140024. protected _getDefines(): string;
  140025. /** Generate the current state of the procedural texture */
  140026. render(useCameraPostProcess?: boolean): void;
  140027. /**
  140028. * Serializes this noise procedural texture
  140029. * @returns a serialized noise procedural texture object
  140030. */
  140031. serialize(): any;
  140032. /**
  140033. * Clone the texture.
  140034. * @returns the cloned texture
  140035. */
  140036. clone(): NoiseProceduralTexture;
  140037. /**
  140038. * Creates a NoiseProceduralTexture from parsed noise procedural texture data
  140039. * @param parsedTexture defines parsed texture data
  140040. * @param scene defines the current scene
  140041. * @param rootUrl defines the root URL containing noise procedural texture information
  140042. * @returns a parsed NoiseProceduralTexture
  140043. */
  140044. static Parse(parsedTexture: any, scene: Scene): NoiseProceduralTexture;
  140045. }
  140046. }
  140047. declare module BABYLON {
  140048. /**
  140049. * Raw cube texture where the raw buffers are passed in
  140050. */
  140051. export class RawCubeTexture extends CubeTexture {
  140052. /**
  140053. * Creates a cube texture where the raw buffers are passed in.
  140054. * @param scene defines the scene the texture is attached to
  140055. * @param data defines the array of data to use to create each face
  140056. * @param size defines the size of the textures
  140057. * @param format defines the format of the data
  140058. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  140059. * @param generateMipMaps defines if the engine should generate the mip levels
  140060. * @param invertY defines if data must be stored with Y axis inverted
  140061. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  140062. * @param compression defines the compression used (null by default)
  140063. */
  140064. constructor(scene: Scene, data: Nullable<ArrayBufferView[]>, size: number, format?: number, type?: number, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, compression?: Nullable<string>);
  140065. /**
  140066. * Updates the raw cube texture.
  140067. * @param data defines the data to store
  140068. * @param format defines the data format
  140069. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  140070. * @param invertY defines if data must be stored with Y axis inverted
  140071. * @param compression defines the compression used (null by default)
  140072. * @param level defines which level of the texture to update
  140073. */
  140074. update(data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression?: Nullable<string>): void;
  140075. /**
  140076. * Updates a raw cube texture with RGBD encoded data.
  140077. * @param data defines the array of data [mipmap][face] to use to create each face
  140078. * @param sphericalPolynomial defines the spherical polynomial for irradiance
  140079. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  140080. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  140081. * @returns a promsie that resolves when the operation is complete
  140082. */
  140083. updateRGBDAsync(data: ArrayBufferView[][], sphericalPolynomial?: Nullable<SphericalPolynomial>, lodScale?: number, lodOffset?: number): Promise<void>;
  140084. /**
  140085. * Clones the raw cube texture.
  140086. * @return a new cube texture
  140087. */
  140088. clone(): CubeTexture;
  140089. /** @hidden */
  140090. static _UpdateRGBDAsync(internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number): Promise<void>;
  140091. }
  140092. }
  140093. declare module BABYLON {
  140094. /**
  140095. * Class used to store 2D array textures containing user data
  140096. */
  140097. export class RawTexture2DArray extends Texture {
  140098. /** Gets or sets the texture format to use */
  140099. format: number;
  140100. /**
  140101. * Create a new RawTexture2DArray
  140102. * @param data defines the data of the texture
  140103. * @param width defines the width of the texture
  140104. * @param height defines the height of the texture
  140105. * @param depth defines the number of layers of the texture
  140106. * @param format defines the texture format to use
  140107. * @param scene defines the hosting scene
  140108. * @param generateMipMaps defines a boolean indicating if mip levels should be generated (true by default)
  140109. * @param invertY defines if texture must be stored with Y axis inverted
  140110. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  140111. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  140112. */
  140113. constructor(data: ArrayBufferView, width: number, height: number, depth: number,
  140114. /** Gets or sets the texture format to use */
  140115. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, textureType?: number);
  140116. /**
  140117. * Update the texture with new data
  140118. * @param data defines the data to store in the texture
  140119. */
  140120. update(data: ArrayBufferView): void;
  140121. }
  140122. }
  140123. declare module BABYLON {
  140124. /**
  140125. * Class used to store 3D textures containing user data
  140126. */
  140127. export class RawTexture3D extends Texture {
  140128. /** Gets or sets the texture format to use */
  140129. format: number;
  140130. /**
  140131. * Create a new RawTexture3D
  140132. * @param data defines the data of the texture
  140133. * @param width defines the width of the texture
  140134. * @param height defines the height of the texture
  140135. * @param depth defines the depth of the texture
  140136. * @param format defines the texture format to use
  140137. * @param scene defines the hosting scene
  140138. * @param generateMipMaps defines a boolean indicating if mip levels should be generated (true by default)
  140139. * @param invertY defines if texture must be stored with Y axis inverted
  140140. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  140141. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  140142. */
  140143. constructor(data: ArrayBufferView, width: number, height: number, depth: number,
  140144. /** Gets or sets the texture format to use */
  140145. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, textureType?: number);
  140146. /**
  140147. * Update the texture with new data
  140148. * @param data defines the data to store in the texture
  140149. */
  140150. update(data: ArrayBufferView): void;
  140151. }
  140152. }
  140153. declare module BABYLON {
  140154. /**
  140155. * Creates a refraction texture used by refraction channel of the standard material.
  140156. * It is like a mirror but to see through a material.
  140157. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  140158. */
  140159. export class RefractionTexture extends RenderTargetTexture {
  140160. /**
  140161. * Define the reflection plane we want to use. The refractionPlane is usually set to the constructed refractor.
  140162. * 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.
  140163. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  140164. */
  140165. refractionPlane: Plane;
  140166. /**
  140167. * Define how deep under the surface we should see.
  140168. */
  140169. depth: number;
  140170. /**
  140171. * Creates a refraction texture used by refraction channel of the standard material.
  140172. * It is like a mirror but to see through a material.
  140173. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  140174. * @param name Define the texture name
  140175. * @param size Define the size of the underlying texture
  140176. * @param scene Define the scene the refraction belongs to
  140177. * @param generateMipMaps Define if we need to generate mips level for the refraction
  140178. */
  140179. constructor(name: string, size: number, scene: Scene, generateMipMaps?: boolean);
  140180. /**
  140181. * Clone the refraction texture.
  140182. * @returns the cloned texture
  140183. */
  140184. clone(): RefractionTexture;
  140185. /**
  140186. * Serialize the texture to a JSON representation you could use in Parse later on
  140187. * @returns the serialized JSON representation
  140188. */
  140189. serialize(): any;
  140190. }
  140191. }
  140192. declare module BABYLON {
  140193. /**
  140194. * Block used to add support for vertex skinning (bones)
  140195. */
  140196. export class BonesBlock extends NodeMaterialBlock {
  140197. /**
  140198. * Creates a new BonesBlock
  140199. * @param name defines the block name
  140200. */
  140201. constructor(name: string);
  140202. /**
  140203. * Initialize the block and prepare the context for build
  140204. * @param state defines the state that will be used for the build
  140205. */
  140206. initialize(state: NodeMaterialBuildState): void;
  140207. /**
  140208. * Gets the current class name
  140209. * @returns the class name
  140210. */
  140211. getClassName(): string;
  140212. /**
  140213. * Gets the matrix indices input component
  140214. */
  140215. get matricesIndices(): NodeMaterialConnectionPoint;
  140216. /**
  140217. * Gets the matrix weights input component
  140218. */
  140219. get matricesWeights(): NodeMaterialConnectionPoint;
  140220. /**
  140221. * Gets the extra matrix indices input component
  140222. */
  140223. get matricesIndicesExtra(): NodeMaterialConnectionPoint;
  140224. /**
  140225. * Gets the extra matrix weights input component
  140226. */
  140227. get matricesWeightsExtra(): NodeMaterialConnectionPoint;
  140228. /**
  140229. * Gets the world input component
  140230. */
  140231. get world(): NodeMaterialConnectionPoint;
  140232. /**
  140233. * Gets the output component
  140234. */
  140235. get output(): NodeMaterialConnectionPoint;
  140236. autoConfigure(material: NodeMaterial): void;
  140237. provideFallbacks(mesh: AbstractMesh, fallbacks: EffectFallbacks): void;
  140238. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  140239. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  140240. protected _buildBlock(state: NodeMaterialBuildState): this;
  140241. }
  140242. }
  140243. declare module BABYLON {
  140244. /**
  140245. * Block used to add support for instances
  140246. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  140247. */
  140248. export class InstancesBlock extends NodeMaterialBlock {
  140249. /**
  140250. * Creates a new InstancesBlock
  140251. * @param name defines the block name
  140252. */
  140253. constructor(name: string);
  140254. /**
  140255. * Gets the current class name
  140256. * @returns the class name
  140257. */
  140258. getClassName(): string;
  140259. /**
  140260. * Gets the first world row input component
  140261. */
  140262. get world0(): NodeMaterialConnectionPoint;
  140263. /**
  140264. * Gets the second world row input component
  140265. */
  140266. get world1(): NodeMaterialConnectionPoint;
  140267. /**
  140268. * Gets the third world row input component
  140269. */
  140270. get world2(): NodeMaterialConnectionPoint;
  140271. /**
  140272. * Gets the forth world row input component
  140273. */
  140274. get world3(): NodeMaterialConnectionPoint;
  140275. /**
  140276. * Gets the world input component
  140277. */
  140278. get world(): NodeMaterialConnectionPoint;
  140279. /**
  140280. * Gets the output component
  140281. */
  140282. get output(): NodeMaterialConnectionPoint;
  140283. /**
  140284. * Gets the isntanceID component
  140285. */
  140286. get instanceID(): NodeMaterialConnectionPoint;
  140287. autoConfigure(material: NodeMaterial): void;
  140288. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean, subMesh?: SubMesh): void;
  140289. protected _buildBlock(state: NodeMaterialBuildState): this;
  140290. }
  140291. }
  140292. declare module BABYLON {
  140293. /**
  140294. * Block used to add morph targets support to vertex shader
  140295. */
  140296. export class MorphTargetsBlock extends NodeMaterialBlock {
  140297. private _repeatableContentAnchor;
  140298. /**
  140299. * Create a new MorphTargetsBlock
  140300. * @param name defines the block name
  140301. */
  140302. constructor(name: string);
  140303. /**
  140304. * Gets the current class name
  140305. * @returns the class name
  140306. */
  140307. getClassName(): string;
  140308. /**
  140309. * Gets the position input component
  140310. */
  140311. get position(): NodeMaterialConnectionPoint;
  140312. /**
  140313. * Gets the normal input component
  140314. */
  140315. get normal(): NodeMaterialConnectionPoint;
  140316. /**
  140317. * Gets the tangent input component
  140318. */
  140319. get tangent(): NodeMaterialConnectionPoint;
  140320. /**
  140321. * Gets the tangent input component
  140322. */
  140323. get uv(): NodeMaterialConnectionPoint;
  140324. /**
  140325. * Gets the position output component
  140326. */
  140327. get positionOutput(): NodeMaterialConnectionPoint;
  140328. /**
  140329. * Gets the normal output component
  140330. */
  140331. get normalOutput(): NodeMaterialConnectionPoint;
  140332. /**
  140333. * Gets the tangent output component
  140334. */
  140335. get tangentOutput(): NodeMaterialConnectionPoint;
  140336. /**
  140337. * Gets the tangent output component
  140338. */
  140339. get uvOutput(): NodeMaterialConnectionPoint;
  140340. initialize(state: NodeMaterialBuildState): void;
  140341. autoConfigure(material: NodeMaterial): void;
  140342. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  140343. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  140344. replaceRepeatableContent(vertexShaderState: NodeMaterialBuildState, fragmentShaderState: NodeMaterialBuildState, mesh: AbstractMesh, defines: NodeMaterialDefines): void;
  140345. protected _buildBlock(state: NodeMaterialBuildState): this;
  140346. }
  140347. }
  140348. declare module BABYLON {
  140349. /**
  140350. * Block used to get data information from a light
  140351. */
  140352. export class LightInformationBlock extends NodeMaterialBlock {
  140353. private _lightDataUniformName;
  140354. private _lightColorUniformName;
  140355. private _lightTypeDefineName;
  140356. /**
  140357. * Gets or sets the light associated with this block
  140358. */
  140359. light: Nullable<Light>;
  140360. /**
  140361. * Creates a new LightInformationBlock
  140362. * @param name defines the block name
  140363. */
  140364. constructor(name: string);
  140365. /**
  140366. * Gets the current class name
  140367. * @returns the class name
  140368. */
  140369. getClassName(): string;
  140370. /**
  140371. * Gets the world position input component
  140372. */
  140373. get worldPosition(): NodeMaterialConnectionPoint;
  140374. /**
  140375. * Gets the direction output component
  140376. */
  140377. get direction(): NodeMaterialConnectionPoint;
  140378. /**
  140379. * Gets the direction output component
  140380. */
  140381. get color(): NodeMaterialConnectionPoint;
  140382. /**
  140383. * Gets the direction output component
  140384. */
  140385. get intensity(): NodeMaterialConnectionPoint;
  140386. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  140387. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  140388. protected _buildBlock(state: NodeMaterialBuildState): this;
  140389. serialize(): any;
  140390. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  140391. }
  140392. }
  140393. declare module BABYLON {
  140394. /**
  140395. * Block used to add image processing support to fragment shader
  140396. */
  140397. export class ImageProcessingBlock extends NodeMaterialBlock {
  140398. /**
  140399. * Create a new ImageProcessingBlock
  140400. * @param name defines the block name
  140401. */
  140402. constructor(name: string);
  140403. /**
  140404. * Gets the current class name
  140405. * @returns the class name
  140406. */
  140407. getClassName(): string;
  140408. /**
  140409. * Gets the color input component
  140410. */
  140411. get color(): NodeMaterialConnectionPoint;
  140412. /**
  140413. * Gets the output component
  140414. */
  140415. get output(): NodeMaterialConnectionPoint;
  140416. /**
  140417. * Initialize the block and prepare the context for build
  140418. * @param state defines the state that will be used for the build
  140419. */
  140420. initialize(state: NodeMaterialBuildState): void;
  140421. isReady(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): boolean;
  140422. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  140423. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  140424. protected _buildBlock(state: NodeMaterialBuildState): this;
  140425. }
  140426. }
  140427. declare module BABYLON {
  140428. /**
  140429. * Block used to pertub normals based on a normal map
  140430. */
  140431. export class PerturbNormalBlock extends NodeMaterialBlock {
  140432. private _tangentSpaceParameterName;
  140433. /** Gets or sets a boolean indicating that normal should be inverted on X axis */
  140434. invertX: boolean;
  140435. /** Gets or sets a boolean indicating that normal should be inverted on Y axis */
  140436. invertY: boolean;
  140437. /**
  140438. * Create a new PerturbNormalBlock
  140439. * @param name defines the block name
  140440. */
  140441. constructor(name: string);
  140442. /**
  140443. * Gets the current class name
  140444. * @returns the class name
  140445. */
  140446. getClassName(): string;
  140447. /**
  140448. * Gets the world position input component
  140449. */
  140450. get worldPosition(): NodeMaterialConnectionPoint;
  140451. /**
  140452. * Gets the world normal input component
  140453. */
  140454. get worldNormal(): NodeMaterialConnectionPoint;
  140455. /**
  140456. * Gets the world tangent input component
  140457. */
  140458. get worldTangent(): NodeMaterialConnectionPoint;
  140459. /**
  140460. * Gets the uv input component
  140461. */
  140462. get uv(): NodeMaterialConnectionPoint;
  140463. /**
  140464. * Gets the normal map color input component
  140465. */
  140466. get normalMapColor(): NodeMaterialConnectionPoint;
  140467. /**
  140468. * Gets the strength input component
  140469. */
  140470. get strength(): NodeMaterialConnectionPoint;
  140471. /**
  140472. * Gets the output component
  140473. */
  140474. get output(): NodeMaterialConnectionPoint;
  140475. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  140476. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  140477. autoConfigure(material: NodeMaterial): void;
  140478. protected _buildBlock(state: NodeMaterialBuildState): this;
  140479. protected _dumpPropertiesCode(): string;
  140480. serialize(): any;
  140481. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  140482. }
  140483. }
  140484. declare module BABYLON {
  140485. /**
  140486. * Block used to discard a pixel if a value is smaller than a cutoff
  140487. */
  140488. export class DiscardBlock extends NodeMaterialBlock {
  140489. /**
  140490. * Create a new DiscardBlock
  140491. * @param name defines the block name
  140492. */
  140493. constructor(name: string);
  140494. /**
  140495. * Gets the current class name
  140496. * @returns the class name
  140497. */
  140498. getClassName(): string;
  140499. /**
  140500. * Gets the color input component
  140501. */
  140502. get value(): NodeMaterialConnectionPoint;
  140503. /**
  140504. * Gets the cutoff input component
  140505. */
  140506. get cutoff(): NodeMaterialConnectionPoint;
  140507. protected _buildBlock(state: NodeMaterialBuildState): this;
  140508. }
  140509. }
  140510. declare module BABYLON {
  140511. /**
  140512. * Block used to test if the fragment shader is front facing
  140513. */
  140514. export class FrontFacingBlock extends NodeMaterialBlock {
  140515. /**
  140516. * Creates a new FrontFacingBlock
  140517. * @param name defines the block name
  140518. */
  140519. constructor(name: string);
  140520. /**
  140521. * Gets the current class name
  140522. * @returns the class name
  140523. */
  140524. getClassName(): string;
  140525. /**
  140526. * Gets the output component
  140527. */
  140528. get output(): NodeMaterialConnectionPoint;
  140529. protected _buildBlock(state: NodeMaterialBuildState): this;
  140530. }
  140531. }
  140532. declare module BABYLON {
  140533. /**
  140534. * Block used to get the derivative value on x and y of a given input
  140535. */
  140536. export class DerivativeBlock extends NodeMaterialBlock {
  140537. /**
  140538. * Create a new DerivativeBlock
  140539. * @param name defines the block name
  140540. */
  140541. constructor(name: string);
  140542. /**
  140543. * Gets the current class name
  140544. * @returns the class name
  140545. */
  140546. getClassName(): string;
  140547. /**
  140548. * Gets the input component
  140549. */
  140550. get input(): NodeMaterialConnectionPoint;
  140551. /**
  140552. * Gets the derivative output on x
  140553. */
  140554. get dx(): NodeMaterialConnectionPoint;
  140555. /**
  140556. * Gets the derivative output on y
  140557. */
  140558. get dy(): NodeMaterialConnectionPoint;
  140559. protected _buildBlock(state: NodeMaterialBuildState): this;
  140560. }
  140561. }
  140562. declare module BABYLON {
  140563. /**
  140564. * Block used to make gl_FragCoord available
  140565. */
  140566. export class FragCoordBlock extends NodeMaterialBlock {
  140567. /**
  140568. * Creates a new FragCoordBlock
  140569. * @param name defines the block name
  140570. */
  140571. constructor(name: string);
  140572. /**
  140573. * Gets the current class name
  140574. * @returns the class name
  140575. */
  140576. getClassName(): string;
  140577. /**
  140578. * Gets the xy component
  140579. */
  140580. get xy(): NodeMaterialConnectionPoint;
  140581. /**
  140582. * Gets the xyz component
  140583. */
  140584. get xyz(): NodeMaterialConnectionPoint;
  140585. /**
  140586. * Gets the xyzw component
  140587. */
  140588. get xyzw(): NodeMaterialConnectionPoint;
  140589. /**
  140590. * Gets the x component
  140591. */
  140592. get x(): NodeMaterialConnectionPoint;
  140593. /**
  140594. * Gets the y component
  140595. */
  140596. get y(): NodeMaterialConnectionPoint;
  140597. /**
  140598. * Gets the z component
  140599. */
  140600. get z(): NodeMaterialConnectionPoint;
  140601. /**
  140602. * Gets the w component
  140603. */
  140604. get output(): NodeMaterialConnectionPoint;
  140605. protected writeOutputs(state: NodeMaterialBuildState): string;
  140606. protected _buildBlock(state: NodeMaterialBuildState): this;
  140607. }
  140608. }
  140609. declare module BABYLON {
  140610. /**
  140611. * Block used to get the screen sizes
  140612. */
  140613. export class ScreenSizeBlock extends NodeMaterialBlock {
  140614. private _varName;
  140615. private _scene;
  140616. /**
  140617. * Creates a new ScreenSizeBlock
  140618. * @param name defines the block name
  140619. */
  140620. constructor(name: string);
  140621. /**
  140622. * Gets the current class name
  140623. * @returns the class name
  140624. */
  140625. getClassName(): string;
  140626. /**
  140627. * Gets the xy component
  140628. */
  140629. get xy(): NodeMaterialConnectionPoint;
  140630. /**
  140631. * Gets the x component
  140632. */
  140633. get x(): NodeMaterialConnectionPoint;
  140634. /**
  140635. * Gets the y component
  140636. */
  140637. get y(): NodeMaterialConnectionPoint;
  140638. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  140639. protected writeOutputs(state: NodeMaterialBuildState, varName: string): string;
  140640. protected _buildBlock(state: NodeMaterialBuildState): this;
  140641. }
  140642. }
  140643. declare module BABYLON {
  140644. /**
  140645. * Block used to add support for scene fog
  140646. */
  140647. export class FogBlock extends NodeMaterialBlock {
  140648. private _fogDistanceName;
  140649. private _fogParameters;
  140650. /**
  140651. * Create a new FogBlock
  140652. * @param name defines the block name
  140653. */
  140654. constructor(name: string);
  140655. /**
  140656. * Gets the current class name
  140657. * @returns the class name
  140658. */
  140659. getClassName(): string;
  140660. /**
  140661. * Gets the world position input component
  140662. */
  140663. get worldPosition(): NodeMaterialConnectionPoint;
  140664. /**
  140665. * Gets the view input component
  140666. */
  140667. get view(): NodeMaterialConnectionPoint;
  140668. /**
  140669. * Gets the color input component
  140670. */
  140671. get input(): NodeMaterialConnectionPoint;
  140672. /**
  140673. * Gets the fog color input component
  140674. */
  140675. get fogColor(): NodeMaterialConnectionPoint;
  140676. /**
  140677. * Gets the output component
  140678. */
  140679. get output(): NodeMaterialConnectionPoint;
  140680. autoConfigure(material: NodeMaterial): void;
  140681. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  140682. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  140683. protected _buildBlock(state: NodeMaterialBuildState): this;
  140684. }
  140685. }
  140686. declare module BABYLON {
  140687. /**
  140688. * Block used to add light in the fragment shader
  140689. */
  140690. export class LightBlock extends NodeMaterialBlock {
  140691. private _lightId;
  140692. /**
  140693. * Gets or sets the light associated with this block
  140694. */
  140695. light: Nullable<Light>;
  140696. /**
  140697. * Create a new LightBlock
  140698. * @param name defines the block name
  140699. */
  140700. constructor(name: string);
  140701. /**
  140702. * Gets the current class name
  140703. * @returns the class name
  140704. */
  140705. getClassName(): string;
  140706. /**
  140707. * Gets the world position input component
  140708. */
  140709. get worldPosition(): NodeMaterialConnectionPoint;
  140710. /**
  140711. * Gets the world normal input component
  140712. */
  140713. get worldNormal(): NodeMaterialConnectionPoint;
  140714. /**
  140715. * Gets the camera (or eye) position component
  140716. */
  140717. get cameraPosition(): NodeMaterialConnectionPoint;
  140718. /**
  140719. * Gets the glossiness component
  140720. */
  140721. get glossiness(): NodeMaterialConnectionPoint;
  140722. /**
  140723. * Gets the glossinness power component
  140724. */
  140725. get glossPower(): NodeMaterialConnectionPoint;
  140726. /**
  140727. * Gets the diffuse color component
  140728. */
  140729. get diffuseColor(): NodeMaterialConnectionPoint;
  140730. /**
  140731. * Gets the specular color component
  140732. */
  140733. get specularColor(): NodeMaterialConnectionPoint;
  140734. /**
  140735. * Gets the diffuse output component
  140736. */
  140737. get diffuseOutput(): NodeMaterialConnectionPoint;
  140738. /**
  140739. * Gets the specular output component
  140740. */
  140741. get specularOutput(): NodeMaterialConnectionPoint;
  140742. /**
  140743. * Gets the shadow output component
  140744. */
  140745. get shadow(): NodeMaterialConnectionPoint;
  140746. autoConfigure(material: NodeMaterial): void;
  140747. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  140748. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  140749. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  140750. private _injectVertexCode;
  140751. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  140752. serialize(): any;
  140753. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  140754. }
  140755. }
  140756. declare module BABYLON {
  140757. /**
  140758. * Block used to read a reflection texture from a sampler
  140759. */
  140760. export class ReflectionTextureBlock extends ReflectionTextureBaseBlock {
  140761. /**
  140762. * Create a new ReflectionTextureBlock
  140763. * @param name defines the block name
  140764. */
  140765. constructor(name: string);
  140766. /**
  140767. * Gets the current class name
  140768. * @returns the class name
  140769. */
  140770. getClassName(): string;
  140771. /**
  140772. * Gets the world position input component
  140773. */
  140774. get position(): NodeMaterialConnectionPoint;
  140775. /**
  140776. * Gets the world position input component
  140777. */
  140778. get worldPosition(): NodeMaterialConnectionPoint;
  140779. /**
  140780. * Gets the world normal input component
  140781. */
  140782. get worldNormal(): NodeMaterialConnectionPoint;
  140783. /**
  140784. * Gets the world input component
  140785. */
  140786. get world(): NodeMaterialConnectionPoint;
  140787. /**
  140788. * Gets the camera (or eye) position component
  140789. */
  140790. get cameraPosition(): NodeMaterialConnectionPoint;
  140791. /**
  140792. * Gets the view input component
  140793. */
  140794. get view(): NodeMaterialConnectionPoint;
  140795. /**
  140796. * Gets the rgb output component
  140797. */
  140798. get rgb(): NodeMaterialConnectionPoint;
  140799. /**
  140800. * Gets the rgba output component
  140801. */
  140802. get rgba(): NodeMaterialConnectionPoint;
  140803. /**
  140804. * Gets the r output component
  140805. */
  140806. get r(): NodeMaterialConnectionPoint;
  140807. /**
  140808. * Gets the g output component
  140809. */
  140810. get g(): NodeMaterialConnectionPoint;
  140811. /**
  140812. * Gets the b output component
  140813. */
  140814. get b(): NodeMaterialConnectionPoint;
  140815. /**
  140816. * Gets the a output component
  140817. */
  140818. get a(): NodeMaterialConnectionPoint;
  140819. autoConfigure(material: NodeMaterial): void;
  140820. protected _buildBlock(state: NodeMaterialBuildState): this;
  140821. }
  140822. }
  140823. declare module BABYLON {
  140824. /**
  140825. * Block used to add 2 vectors
  140826. */
  140827. export class AddBlock extends NodeMaterialBlock {
  140828. /**
  140829. * Creates a new AddBlock
  140830. * @param name defines the block name
  140831. */
  140832. constructor(name: string);
  140833. /**
  140834. * Gets the current class name
  140835. * @returns the class name
  140836. */
  140837. getClassName(): string;
  140838. /**
  140839. * Gets the left operand input component
  140840. */
  140841. get left(): NodeMaterialConnectionPoint;
  140842. /**
  140843. * Gets the right operand input component
  140844. */
  140845. get right(): NodeMaterialConnectionPoint;
  140846. /**
  140847. * Gets the output component
  140848. */
  140849. get output(): NodeMaterialConnectionPoint;
  140850. protected _buildBlock(state: NodeMaterialBuildState): this;
  140851. }
  140852. }
  140853. declare module BABYLON {
  140854. /**
  140855. * Block used to scale a vector by a float
  140856. */
  140857. export class ScaleBlock extends NodeMaterialBlock {
  140858. /**
  140859. * Creates a new ScaleBlock
  140860. * @param name defines the block name
  140861. */
  140862. constructor(name: string);
  140863. /**
  140864. * Gets the current class name
  140865. * @returns the class name
  140866. */
  140867. getClassName(): string;
  140868. /**
  140869. * Gets the input component
  140870. */
  140871. get input(): NodeMaterialConnectionPoint;
  140872. /**
  140873. * Gets the factor input component
  140874. */
  140875. get factor(): NodeMaterialConnectionPoint;
  140876. /**
  140877. * Gets the output component
  140878. */
  140879. get output(): NodeMaterialConnectionPoint;
  140880. protected _buildBlock(state: NodeMaterialBuildState): this;
  140881. }
  140882. }
  140883. declare module BABYLON {
  140884. /**
  140885. * Block used to clamp a float
  140886. */
  140887. export class ClampBlock extends NodeMaterialBlock {
  140888. /** Gets or sets the minimum range */
  140889. minimum: number;
  140890. /** Gets or sets the maximum range */
  140891. maximum: number;
  140892. /**
  140893. * Creates a new ClampBlock
  140894. * @param name defines the block name
  140895. */
  140896. constructor(name: string);
  140897. /**
  140898. * Gets the current class name
  140899. * @returns the class name
  140900. */
  140901. getClassName(): string;
  140902. /**
  140903. * Gets the value input component
  140904. */
  140905. get value(): NodeMaterialConnectionPoint;
  140906. /**
  140907. * Gets the output component
  140908. */
  140909. get output(): NodeMaterialConnectionPoint;
  140910. protected _buildBlock(state: NodeMaterialBuildState): this;
  140911. protected _dumpPropertiesCode(): string;
  140912. serialize(): any;
  140913. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  140914. }
  140915. }
  140916. declare module BABYLON {
  140917. /**
  140918. * Block used to apply a cross product between 2 vectors
  140919. */
  140920. export class CrossBlock extends NodeMaterialBlock {
  140921. /**
  140922. * Creates a new CrossBlock
  140923. * @param name defines the block name
  140924. */
  140925. constructor(name: string);
  140926. /**
  140927. * Gets the current class name
  140928. * @returns the class name
  140929. */
  140930. getClassName(): string;
  140931. /**
  140932. * Gets the left operand input component
  140933. */
  140934. get left(): NodeMaterialConnectionPoint;
  140935. /**
  140936. * Gets the right operand input component
  140937. */
  140938. get right(): NodeMaterialConnectionPoint;
  140939. /**
  140940. * Gets the output component
  140941. */
  140942. get output(): NodeMaterialConnectionPoint;
  140943. protected _buildBlock(state: NodeMaterialBuildState): this;
  140944. }
  140945. }
  140946. declare module BABYLON {
  140947. /**
  140948. * Block used to apply a dot product between 2 vectors
  140949. */
  140950. export class DotBlock extends NodeMaterialBlock {
  140951. /**
  140952. * Creates a new DotBlock
  140953. * @param name defines the block name
  140954. */
  140955. constructor(name: string);
  140956. /**
  140957. * Gets the current class name
  140958. * @returns the class name
  140959. */
  140960. getClassName(): string;
  140961. /**
  140962. * Gets the left operand input component
  140963. */
  140964. get left(): NodeMaterialConnectionPoint;
  140965. /**
  140966. * Gets the right operand input component
  140967. */
  140968. get right(): NodeMaterialConnectionPoint;
  140969. /**
  140970. * Gets the output component
  140971. */
  140972. get output(): NodeMaterialConnectionPoint;
  140973. protected _buildBlock(state: NodeMaterialBuildState): this;
  140974. }
  140975. }
  140976. declare module BABYLON {
  140977. /**
  140978. * Block used to normalize a vector
  140979. */
  140980. export class NormalizeBlock extends NodeMaterialBlock {
  140981. /**
  140982. * Creates a new NormalizeBlock
  140983. * @param name defines the block name
  140984. */
  140985. constructor(name: string);
  140986. /**
  140987. * Gets the current class name
  140988. * @returns the class name
  140989. */
  140990. getClassName(): string;
  140991. /**
  140992. * Gets the input component
  140993. */
  140994. get input(): NodeMaterialConnectionPoint;
  140995. /**
  140996. * Gets the output component
  140997. */
  140998. get output(): NodeMaterialConnectionPoint;
  140999. protected _buildBlock(state: NodeMaterialBuildState): this;
  141000. }
  141001. }
  141002. declare module BABYLON {
  141003. /**
  141004. * Operations supported by the Trigonometry block
  141005. */
  141006. export enum TrigonometryBlockOperations {
  141007. /** Cos */
  141008. Cos = 0,
  141009. /** Sin */
  141010. Sin = 1,
  141011. /** Abs */
  141012. Abs = 2,
  141013. /** Exp */
  141014. Exp = 3,
  141015. /** Exp2 */
  141016. Exp2 = 4,
  141017. /** Round */
  141018. Round = 5,
  141019. /** Floor */
  141020. Floor = 6,
  141021. /** Ceiling */
  141022. Ceiling = 7,
  141023. /** Square root */
  141024. Sqrt = 8,
  141025. /** Log */
  141026. Log = 9,
  141027. /** Tangent */
  141028. Tan = 10,
  141029. /** Arc tangent */
  141030. ArcTan = 11,
  141031. /** Arc cosinus */
  141032. ArcCos = 12,
  141033. /** Arc sinus */
  141034. ArcSin = 13,
  141035. /** Fraction */
  141036. Fract = 14,
  141037. /** Sign */
  141038. Sign = 15,
  141039. /** To radians (from degrees) */
  141040. Radians = 16,
  141041. /** To degrees (from radians) */
  141042. Degrees = 17
  141043. }
  141044. /**
  141045. * Block used to apply trigonometry operation to floats
  141046. */
  141047. export class TrigonometryBlock extends NodeMaterialBlock {
  141048. /**
  141049. * Gets or sets the operation applied by the block
  141050. */
  141051. operation: TrigonometryBlockOperations;
  141052. /**
  141053. * Creates a new TrigonometryBlock
  141054. * @param name defines the block name
  141055. */
  141056. constructor(name: string);
  141057. /**
  141058. * Gets the current class name
  141059. * @returns the class name
  141060. */
  141061. getClassName(): string;
  141062. /**
  141063. * Gets the input component
  141064. */
  141065. get input(): NodeMaterialConnectionPoint;
  141066. /**
  141067. * Gets the output component
  141068. */
  141069. get output(): NodeMaterialConnectionPoint;
  141070. protected _buildBlock(state: NodeMaterialBuildState): this;
  141071. serialize(): any;
  141072. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  141073. protected _dumpPropertiesCode(): string;
  141074. }
  141075. }
  141076. declare module BABYLON {
  141077. /**
  141078. * Block used to create a Color3/4 out of individual inputs (one for each component)
  141079. */
  141080. export class ColorMergerBlock extends NodeMaterialBlock {
  141081. /**
  141082. * Create a new ColorMergerBlock
  141083. * @param name defines the block name
  141084. */
  141085. constructor(name: string);
  141086. /**
  141087. * Gets the current class name
  141088. * @returns the class name
  141089. */
  141090. getClassName(): string;
  141091. /**
  141092. * Gets the rgb component (input)
  141093. */
  141094. get rgbIn(): NodeMaterialConnectionPoint;
  141095. /**
  141096. * Gets the r component (input)
  141097. */
  141098. get r(): NodeMaterialConnectionPoint;
  141099. /**
  141100. * Gets the g component (input)
  141101. */
  141102. get g(): NodeMaterialConnectionPoint;
  141103. /**
  141104. * Gets the b component (input)
  141105. */
  141106. get b(): NodeMaterialConnectionPoint;
  141107. /**
  141108. * Gets the a component (input)
  141109. */
  141110. get a(): NodeMaterialConnectionPoint;
  141111. /**
  141112. * Gets the rgba component (output)
  141113. */
  141114. get rgba(): NodeMaterialConnectionPoint;
  141115. /**
  141116. * Gets the rgb component (output)
  141117. */
  141118. get rgbOut(): NodeMaterialConnectionPoint;
  141119. /**
  141120. * Gets the rgb component (output)
  141121. * @deprecated Please use rgbOut instead.
  141122. */
  141123. get rgb(): NodeMaterialConnectionPoint;
  141124. protected _buildBlock(state: NodeMaterialBuildState): this;
  141125. }
  141126. }
  141127. declare module BABYLON {
  141128. /**
  141129. * Block used to expand a Vector3/4 into 4 outputs (one for each component)
  141130. */
  141131. export class VectorSplitterBlock extends NodeMaterialBlock {
  141132. /**
  141133. * Create a new VectorSplitterBlock
  141134. * @param name defines the block name
  141135. */
  141136. constructor(name: string);
  141137. /**
  141138. * Gets the current class name
  141139. * @returns the class name
  141140. */
  141141. getClassName(): string;
  141142. /**
  141143. * Gets the xyzw component (input)
  141144. */
  141145. get xyzw(): NodeMaterialConnectionPoint;
  141146. /**
  141147. * Gets the xyz component (input)
  141148. */
  141149. get xyzIn(): NodeMaterialConnectionPoint;
  141150. /**
  141151. * Gets the xy component (input)
  141152. */
  141153. get xyIn(): NodeMaterialConnectionPoint;
  141154. /**
  141155. * Gets the xyz component (output)
  141156. */
  141157. get xyzOut(): NodeMaterialConnectionPoint;
  141158. /**
  141159. * Gets the xy component (output)
  141160. */
  141161. get xyOut(): NodeMaterialConnectionPoint;
  141162. /**
  141163. * Gets the x component (output)
  141164. */
  141165. get x(): NodeMaterialConnectionPoint;
  141166. /**
  141167. * Gets the y component (output)
  141168. */
  141169. get y(): NodeMaterialConnectionPoint;
  141170. /**
  141171. * Gets the z component (output)
  141172. */
  141173. get z(): NodeMaterialConnectionPoint;
  141174. /**
  141175. * Gets the w component (output)
  141176. */
  141177. get w(): NodeMaterialConnectionPoint;
  141178. protected _inputRename(name: string): string;
  141179. protected _outputRename(name: string): string;
  141180. protected _buildBlock(state: NodeMaterialBuildState): this;
  141181. }
  141182. }
  141183. declare module BABYLON {
  141184. /**
  141185. * Block used to lerp between 2 values
  141186. */
  141187. export class LerpBlock extends NodeMaterialBlock {
  141188. /**
  141189. * Creates a new LerpBlock
  141190. * @param name defines the block name
  141191. */
  141192. constructor(name: string);
  141193. /**
  141194. * Gets the current class name
  141195. * @returns the class name
  141196. */
  141197. getClassName(): string;
  141198. /**
  141199. * Gets the left operand input component
  141200. */
  141201. get left(): NodeMaterialConnectionPoint;
  141202. /**
  141203. * Gets the right operand input component
  141204. */
  141205. get right(): NodeMaterialConnectionPoint;
  141206. /**
  141207. * Gets the gradient operand input component
  141208. */
  141209. get gradient(): NodeMaterialConnectionPoint;
  141210. /**
  141211. * Gets the output component
  141212. */
  141213. get output(): NodeMaterialConnectionPoint;
  141214. protected _buildBlock(state: NodeMaterialBuildState): this;
  141215. }
  141216. }
  141217. declare module BABYLON {
  141218. /**
  141219. * Block used to divide 2 vectors
  141220. */
  141221. export class DivideBlock extends NodeMaterialBlock {
  141222. /**
  141223. * Creates a new DivideBlock
  141224. * @param name defines the block name
  141225. */
  141226. constructor(name: string);
  141227. /**
  141228. * Gets the current class name
  141229. * @returns the class name
  141230. */
  141231. getClassName(): string;
  141232. /**
  141233. * Gets the left operand input component
  141234. */
  141235. get left(): NodeMaterialConnectionPoint;
  141236. /**
  141237. * Gets the right operand input component
  141238. */
  141239. get right(): NodeMaterialConnectionPoint;
  141240. /**
  141241. * Gets the output component
  141242. */
  141243. get output(): NodeMaterialConnectionPoint;
  141244. protected _buildBlock(state: NodeMaterialBuildState): this;
  141245. }
  141246. }
  141247. declare module BABYLON {
  141248. /**
  141249. * Block used to subtract 2 vectors
  141250. */
  141251. export class SubtractBlock extends NodeMaterialBlock {
  141252. /**
  141253. * Creates a new SubtractBlock
  141254. * @param name defines the block name
  141255. */
  141256. constructor(name: string);
  141257. /**
  141258. * Gets the current class name
  141259. * @returns the class name
  141260. */
  141261. getClassName(): string;
  141262. /**
  141263. * Gets the left operand input component
  141264. */
  141265. get left(): NodeMaterialConnectionPoint;
  141266. /**
  141267. * Gets the right operand input component
  141268. */
  141269. get right(): NodeMaterialConnectionPoint;
  141270. /**
  141271. * Gets the output component
  141272. */
  141273. get output(): NodeMaterialConnectionPoint;
  141274. protected _buildBlock(state: NodeMaterialBuildState): this;
  141275. }
  141276. }
  141277. declare module BABYLON {
  141278. /**
  141279. * Block used to step a value
  141280. */
  141281. export class StepBlock extends NodeMaterialBlock {
  141282. /**
  141283. * Creates a new StepBlock
  141284. * @param name defines the block name
  141285. */
  141286. constructor(name: string);
  141287. /**
  141288. * Gets the current class name
  141289. * @returns the class name
  141290. */
  141291. getClassName(): string;
  141292. /**
  141293. * Gets the value operand input component
  141294. */
  141295. get value(): NodeMaterialConnectionPoint;
  141296. /**
  141297. * Gets the edge operand input component
  141298. */
  141299. get edge(): NodeMaterialConnectionPoint;
  141300. /**
  141301. * Gets the output component
  141302. */
  141303. get output(): NodeMaterialConnectionPoint;
  141304. protected _buildBlock(state: NodeMaterialBuildState): this;
  141305. }
  141306. }
  141307. declare module BABYLON {
  141308. /**
  141309. * Block used to get the opposite (1 - x) of a value
  141310. */
  141311. export class OneMinusBlock extends NodeMaterialBlock {
  141312. /**
  141313. * Creates a new OneMinusBlock
  141314. * @param name defines the block name
  141315. */
  141316. constructor(name: string);
  141317. /**
  141318. * Gets the current class name
  141319. * @returns the class name
  141320. */
  141321. getClassName(): string;
  141322. /**
  141323. * Gets the input component
  141324. */
  141325. get input(): NodeMaterialConnectionPoint;
  141326. /**
  141327. * Gets the output component
  141328. */
  141329. get output(): NodeMaterialConnectionPoint;
  141330. protected _buildBlock(state: NodeMaterialBuildState): this;
  141331. }
  141332. }
  141333. declare module BABYLON {
  141334. /**
  141335. * Block used to get the view direction
  141336. */
  141337. export class ViewDirectionBlock extends NodeMaterialBlock {
  141338. /**
  141339. * Creates a new ViewDirectionBlock
  141340. * @param name defines the block name
  141341. */
  141342. constructor(name: string);
  141343. /**
  141344. * Gets the current class name
  141345. * @returns the class name
  141346. */
  141347. getClassName(): string;
  141348. /**
  141349. * Gets the world position component
  141350. */
  141351. get worldPosition(): NodeMaterialConnectionPoint;
  141352. /**
  141353. * Gets the camera position component
  141354. */
  141355. get cameraPosition(): NodeMaterialConnectionPoint;
  141356. /**
  141357. * Gets the output component
  141358. */
  141359. get output(): NodeMaterialConnectionPoint;
  141360. autoConfigure(material: NodeMaterial): void;
  141361. protected _buildBlock(state: NodeMaterialBuildState): this;
  141362. }
  141363. }
  141364. declare module BABYLON {
  141365. /**
  141366. * Block used to compute fresnel value
  141367. */
  141368. export class FresnelBlock extends NodeMaterialBlock {
  141369. /**
  141370. * Create a new FresnelBlock
  141371. * @param name defines the block name
  141372. */
  141373. constructor(name: string);
  141374. /**
  141375. * Gets the current class name
  141376. * @returns the class name
  141377. */
  141378. getClassName(): string;
  141379. /**
  141380. * Gets the world normal input component
  141381. */
  141382. get worldNormal(): NodeMaterialConnectionPoint;
  141383. /**
  141384. * Gets the view direction input component
  141385. */
  141386. get viewDirection(): NodeMaterialConnectionPoint;
  141387. /**
  141388. * Gets the bias input component
  141389. */
  141390. get bias(): NodeMaterialConnectionPoint;
  141391. /**
  141392. * Gets the camera (or eye) position component
  141393. */
  141394. get power(): NodeMaterialConnectionPoint;
  141395. /**
  141396. * Gets the fresnel output component
  141397. */
  141398. get fresnel(): NodeMaterialConnectionPoint;
  141399. autoConfigure(material: NodeMaterial): void;
  141400. protected _buildBlock(state: NodeMaterialBuildState): this;
  141401. }
  141402. }
  141403. declare module BABYLON {
  141404. /**
  141405. * Block used to get the max of 2 values
  141406. */
  141407. export class MaxBlock extends NodeMaterialBlock {
  141408. /**
  141409. * Creates a new MaxBlock
  141410. * @param name defines the block name
  141411. */
  141412. constructor(name: string);
  141413. /**
  141414. * Gets the current class name
  141415. * @returns the class name
  141416. */
  141417. getClassName(): string;
  141418. /**
  141419. * Gets the left operand input component
  141420. */
  141421. get left(): NodeMaterialConnectionPoint;
  141422. /**
  141423. * Gets the right operand input component
  141424. */
  141425. get right(): NodeMaterialConnectionPoint;
  141426. /**
  141427. * Gets the output component
  141428. */
  141429. get output(): NodeMaterialConnectionPoint;
  141430. protected _buildBlock(state: NodeMaterialBuildState): this;
  141431. }
  141432. }
  141433. declare module BABYLON {
  141434. /**
  141435. * Block used to get the min of 2 values
  141436. */
  141437. export class MinBlock extends NodeMaterialBlock {
  141438. /**
  141439. * Creates a new MinBlock
  141440. * @param name defines the block name
  141441. */
  141442. constructor(name: string);
  141443. /**
  141444. * Gets the current class name
  141445. * @returns the class name
  141446. */
  141447. getClassName(): string;
  141448. /**
  141449. * Gets the left operand input component
  141450. */
  141451. get left(): NodeMaterialConnectionPoint;
  141452. /**
  141453. * Gets the right operand input component
  141454. */
  141455. get right(): NodeMaterialConnectionPoint;
  141456. /**
  141457. * Gets the output component
  141458. */
  141459. get output(): NodeMaterialConnectionPoint;
  141460. protected _buildBlock(state: NodeMaterialBuildState): this;
  141461. }
  141462. }
  141463. declare module BABYLON {
  141464. /**
  141465. * Block used to get the distance between 2 values
  141466. */
  141467. export class DistanceBlock extends NodeMaterialBlock {
  141468. /**
  141469. * Creates a new DistanceBlock
  141470. * @param name defines the block name
  141471. */
  141472. constructor(name: string);
  141473. /**
  141474. * Gets the current class name
  141475. * @returns the class name
  141476. */
  141477. getClassName(): string;
  141478. /**
  141479. * Gets the left operand input component
  141480. */
  141481. get left(): NodeMaterialConnectionPoint;
  141482. /**
  141483. * Gets the right operand input component
  141484. */
  141485. get right(): NodeMaterialConnectionPoint;
  141486. /**
  141487. * Gets the output component
  141488. */
  141489. get output(): NodeMaterialConnectionPoint;
  141490. protected _buildBlock(state: NodeMaterialBuildState): this;
  141491. }
  141492. }
  141493. declare module BABYLON {
  141494. /**
  141495. * Block used to get the length of a vector
  141496. */
  141497. export class LengthBlock extends NodeMaterialBlock {
  141498. /**
  141499. * Creates a new LengthBlock
  141500. * @param name defines the block name
  141501. */
  141502. constructor(name: string);
  141503. /**
  141504. * Gets the current class name
  141505. * @returns the class name
  141506. */
  141507. getClassName(): string;
  141508. /**
  141509. * Gets the value input component
  141510. */
  141511. get value(): NodeMaterialConnectionPoint;
  141512. /**
  141513. * Gets the output component
  141514. */
  141515. get output(): NodeMaterialConnectionPoint;
  141516. protected _buildBlock(state: NodeMaterialBuildState): this;
  141517. }
  141518. }
  141519. declare module BABYLON {
  141520. /**
  141521. * Block used to get negative version of a value (i.e. x * -1)
  141522. */
  141523. export class NegateBlock extends NodeMaterialBlock {
  141524. /**
  141525. * Creates a new NegateBlock
  141526. * @param name defines the block name
  141527. */
  141528. constructor(name: string);
  141529. /**
  141530. * Gets the current class name
  141531. * @returns the class name
  141532. */
  141533. getClassName(): string;
  141534. /**
  141535. * Gets the value input component
  141536. */
  141537. get value(): NodeMaterialConnectionPoint;
  141538. /**
  141539. * Gets the output component
  141540. */
  141541. get output(): NodeMaterialConnectionPoint;
  141542. protected _buildBlock(state: NodeMaterialBuildState): this;
  141543. }
  141544. }
  141545. declare module BABYLON {
  141546. /**
  141547. * Block used to get the value of the first parameter raised to the power of the second
  141548. */
  141549. export class PowBlock extends NodeMaterialBlock {
  141550. /**
  141551. * Creates a new PowBlock
  141552. * @param name defines the block name
  141553. */
  141554. constructor(name: string);
  141555. /**
  141556. * Gets the current class name
  141557. * @returns the class name
  141558. */
  141559. getClassName(): string;
  141560. /**
  141561. * Gets the value operand input component
  141562. */
  141563. get value(): NodeMaterialConnectionPoint;
  141564. /**
  141565. * Gets the power operand input component
  141566. */
  141567. get power(): NodeMaterialConnectionPoint;
  141568. /**
  141569. * Gets the output component
  141570. */
  141571. get output(): NodeMaterialConnectionPoint;
  141572. protected _buildBlock(state: NodeMaterialBuildState): this;
  141573. }
  141574. }
  141575. declare module BABYLON {
  141576. /**
  141577. * Block used to get a random number
  141578. */
  141579. export class RandomNumberBlock extends NodeMaterialBlock {
  141580. /**
  141581. * Creates a new RandomNumberBlock
  141582. * @param name defines the block name
  141583. */
  141584. constructor(name: string);
  141585. /**
  141586. * Gets the current class name
  141587. * @returns the class name
  141588. */
  141589. getClassName(): string;
  141590. /**
  141591. * Gets the seed input component
  141592. */
  141593. get seed(): NodeMaterialConnectionPoint;
  141594. /**
  141595. * Gets the output component
  141596. */
  141597. get output(): NodeMaterialConnectionPoint;
  141598. protected _buildBlock(state: NodeMaterialBuildState): this;
  141599. }
  141600. }
  141601. declare module BABYLON {
  141602. /**
  141603. * Block used to compute arc tangent of 2 values
  141604. */
  141605. export class ArcTan2Block extends NodeMaterialBlock {
  141606. /**
  141607. * Creates a new ArcTan2Block
  141608. * @param name defines the block name
  141609. */
  141610. constructor(name: string);
  141611. /**
  141612. * Gets the current class name
  141613. * @returns the class name
  141614. */
  141615. getClassName(): string;
  141616. /**
  141617. * Gets the x operand input component
  141618. */
  141619. get x(): NodeMaterialConnectionPoint;
  141620. /**
  141621. * Gets the y operand input component
  141622. */
  141623. get y(): NodeMaterialConnectionPoint;
  141624. /**
  141625. * Gets the output component
  141626. */
  141627. get output(): NodeMaterialConnectionPoint;
  141628. protected _buildBlock(state: NodeMaterialBuildState): this;
  141629. }
  141630. }
  141631. declare module BABYLON {
  141632. /**
  141633. * Block used to smooth step a value
  141634. */
  141635. export class SmoothStepBlock extends NodeMaterialBlock {
  141636. /**
  141637. * Creates a new SmoothStepBlock
  141638. * @param name defines the block name
  141639. */
  141640. constructor(name: string);
  141641. /**
  141642. * Gets the current class name
  141643. * @returns the class name
  141644. */
  141645. getClassName(): string;
  141646. /**
  141647. * Gets the value operand input component
  141648. */
  141649. get value(): NodeMaterialConnectionPoint;
  141650. /**
  141651. * Gets the first edge operand input component
  141652. */
  141653. get edge0(): NodeMaterialConnectionPoint;
  141654. /**
  141655. * Gets the second edge operand input component
  141656. */
  141657. get edge1(): NodeMaterialConnectionPoint;
  141658. /**
  141659. * Gets the output component
  141660. */
  141661. get output(): NodeMaterialConnectionPoint;
  141662. protected _buildBlock(state: NodeMaterialBuildState): this;
  141663. }
  141664. }
  141665. declare module BABYLON {
  141666. /**
  141667. * Block used to get the reciprocal (1 / x) of a value
  141668. */
  141669. export class ReciprocalBlock extends NodeMaterialBlock {
  141670. /**
  141671. * Creates a new ReciprocalBlock
  141672. * @param name defines the block name
  141673. */
  141674. constructor(name: string);
  141675. /**
  141676. * Gets the current class name
  141677. * @returns the class name
  141678. */
  141679. getClassName(): string;
  141680. /**
  141681. * Gets the input component
  141682. */
  141683. get input(): NodeMaterialConnectionPoint;
  141684. /**
  141685. * Gets the output component
  141686. */
  141687. get output(): NodeMaterialConnectionPoint;
  141688. protected _buildBlock(state: NodeMaterialBuildState): this;
  141689. }
  141690. }
  141691. declare module BABYLON {
  141692. /**
  141693. * Block used to replace a color by another one
  141694. */
  141695. export class ReplaceColorBlock extends NodeMaterialBlock {
  141696. /**
  141697. * Creates a new ReplaceColorBlock
  141698. * @param name defines the block name
  141699. */
  141700. constructor(name: string);
  141701. /**
  141702. * Gets the current class name
  141703. * @returns the class name
  141704. */
  141705. getClassName(): string;
  141706. /**
  141707. * Gets the value input component
  141708. */
  141709. get value(): NodeMaterialConnectionPoint;
  141710. /**
  141711. * Gets the reference input component
  141712. */
  141713. get reference(): NodeMaterialConnectionPoint;
  141714. /**
  141715. * Gets the distance input component
  141716. */
  141717. get distance(): NodeMaterialConnectionPoint;
  141718. /**
  141719. * Gets the replacement input component
  141720. */
  141721. get replacement(): NodeMaterialConnectionPoint;
  141722. /**
  141723. * Gets the output component
  141724. */
  141725. get output(): NodeMaterialConnectionPoint;
  141726. protected _buildBlock(state: NodeMaterialBuildState): this;
  141727. }
  141728. }
  141729. declare module BABYLON {
  141730. /**
  141731. * Block used to posterize a value
  141732. * @see https://en.wikipedia.org/wiki/Posterization
  141733. */
  141734. export class PosterizeBlock extends NodeMaterialBlock {
  141735. /**
  141736. * Creates a new PosterizeBlock
  141737. * @param name defines the block name
  141738. */
  141739. constructor(name: string);
  141740. /**
  141741. * Gets the current class name
  141742. * @returns the class name
  141743. */
  141744. getClassName(): string;
  141745. /**
  141746. * Gets the value input component
  141747. */
  141748. get value(): NodeMaterialConnectionPoint;
  141749. /**
  141750. * Gets the steps input component
  141751. */
  141752. get steps(): NodeMaterialConnectionPoint;
  141753. /**
  141754. * Gets the output component
  141755. */
  141756. get output(): NodeMaterialConnectionPoint;
  141757. protected _buildBlock(state: NodeMaterialBuildState): this;
  141758. }
  141759. }
  141760. declare module BABYLON {
  141761. /**
  141762. * Operations supported by the Wave block
  141763. */
  141764. export enum WaveBlockKind {
  141765. /** SawTooth */
  141766. SawTooth = 0,
  141767. /** Square */
  141768. Square = 1,
  141769. /** Triangle */
  141770. Triangle = 2
  141771. }
  141772. /**
  141773. * Block used to apply wave operation to floats
  141774. */
  141775. export class WaveBlock extends NodeMaterialBlock {
  141776. /**
  141777. * Gets or sets the kibnd of wave to be applied by the block
  141778. */
  141779. kind: WaveBlockKind;
  141780. /**
  141781. * Creates a new WaveBlock
  141782. * @param name defines the block name
  141783. */
  141784. constructor(name: string);
  141785. /**
  141786. * Gets the current class name
  141787. * @returns the class name
  141788. */
  141789. getClassName(): string;
  141790. /**
  141791. * Gets the input component
  141792. */
  141793. get input(): NodeMaterialConnectionPoint;
  141794. /**
  141795. * Gets the output component
  141796. */
  141797. get output(): NodeMaterialConnectionPoint;
  141798. protected _buildBlock(state: NodeMaterialBuildState): this;
  141799. serialize(): any;
  141800. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  141801. }
  141802. }
  141803. declare module BABYLON {
  141804. /**
  141805. * Class used to store a color step for the GradientBlock
  141806. */
  141807. export class GradientBlockColorStep {
  141808. /**
  141809. * Gets or sets a value indicating which step this color is associated with (between 0 and 1)
  141810. */
  141811. step: number;
  141812. /**
  141813. * Gets or sets the color associated with this step
  141814. */
  141815. color: Color3;
  141816. /**
  141817. * Creates a new GradientBlockColorStep
  141818. * @param step defines a value indicating which step this color is associated with (between 0 and 1)
  141819. * @param color defines the color associated with this step
  141820. */
  141821. constructor(
  141822. /**
  141823. * Gets or sets a value indicating which step this color is associated with (between 0 and 1)
  141824. */
  141825. step: number,
  141826. /**
  141827. * Gets or sets the color associated with this step
  141828. */
  141829. color: Color3);
  141830. }
  141831. /**
  141832. * Block used to return a color from a gradient based on an input value between 0 and 1
  141833. */
  141834. export class GradientBlock extends NodeMaterialBlock {
  141835. /**
  141836. * Gets or sets the list of color steps
  141837. */
  141838. colorSteps: GradientBlockColorStep[];
  141839. /**
  141840. * Creates a new GradientBlock
  141841. * @param name defines the block name
  141842. */
  141843. constructor(name: string);
  141844. /**
  141845. * Gets the current class name
  141846. * @returns the class name
  141847. */
  141848. getClassName(): string;
  141849. /**
  141850. * Gets the gradient input component
  141851. */
  141852. get gradient(): NodeMaterialConnectionPoint;
  141853. /**
  141854. * Gets the output component
  141855. */
  141856. get output(): NodeMaterialConnectionPoint;
  141857. private _writeColorConstant;
  141858. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  141859. serialize(): any;
  141860. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  141861. protected _dumpPropertiesCode(): string;
  141862. }
  141863. }
  141864. declare module BABYLON {
  141865. /**
  141866. * Block used to normalize lerp between 2 values
  141867. */
  141868. export class NLerpBlock extends NodeMaterialBlock {
  141869. /**
  141870. * Creates a new NLerpBlock
  141871. * @param name defines the block name
  141872. */
  141873. constructor(name: string);
  141874. /**
  141875. * Gets the current class name
  141876. * @returns the class name
  141877. */
  141878. getClassName(): string;
  141879. /**
  141880. * Gets the left operand input component
  141881. */
  141882. get left(): NodeMaterialConnectionPoint;
  141883. /**
  141884. * Gets the right operand input component
  141885. */
  141886. get right(): NodeMaterialConnectionPoint;
  141887. /**
  141888. * Gets the gradient operand input component
  141889. */
  141890. get gradient(): NodeMaterialConnectionPoint;
  141891. /**
  141892. * Gets the output component
  141893. */
  141894. get output(): NodeMaterialConnectionPoint;
  141895. protected _buildBlock(state: NodeMaterialBuildState): this;
  141896. }
  141897. }
  141898. declare module BABYLON {
  141899. /**
  141900. * block used to Generate a Worley Noise 3D Noise Pattern
  141901. */
  141902. export class WorleyNoise3DBlock extends NodeMaterialBlock {
  141903. /** Gets or sets a boolean indicating that normal should be inverted on X axis */
  141904. manhattanDistance: boolean;
  141905. /**
  141906. * Creates a new WorleyNoise3DBlock
  141907. * @param name defines the block name
  141908. */
  141909. constructor(name: string);
  141910. /**
  141911. * Gets the current class name
  141912. * @returns the class name
  141913. */
  141914. getClassName(): string;
  141915. /**
  141916. * Gets the seed input component
  141917. */
  141918. get seed(): NodeMaterialConnectionPoint;
  141919. /**
  141920. * Gets the jitter input component
  141921. */
  141922. get jitter(): NodeMaterialConnectionPoint;
  141923. /**
  141924. * Gets the output component
  141925. */
  141926. get output(): NodeMaterialConnectionPoint;
  141927. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  141928. /**
  141929. * Exposes the properties to the UI?
  141930. */
  141931. protected _dumpPropertiesCode(): string;
  141932. /**
  141933. * Exposes the properties to the Seralize?
  141934. */
  141935. serialize(): any;
  141936. /**
  141937. * Exposes the properties to the deseralize?
  141938. */
  141939. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  141940. }
  141941. }
  141942. declare module BABYLON {
  141943. /**
  141944. * block used to Generate a Simplex Perlin 3d Noise Pattern
  141945. */
  141946. export class SimplexPerlin3DBlock extends NodeMaterialBlock {
  141947. /**
  141948. * Creates a new SimplexPerlin3DBlock
  141949. * @param name defines the block name
  141950. */
  141951. constructor(name: string);
  141952. /**
  141953. * Gets the current class name
  141954. * @returns the class name
  141955. */
  141956. getClassName(): string;
  141957. /**
  141958. * Gets the seed operand input component
  141959. */
  141960. get seed(): NodeMaterialConnectionPoint;
  141961. /**
  141962. * Gets the output component
  141963. */
  141964. get output(): NodeMaterialConnectionPoint;
  141965. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  141966. }
  141967. }
  141968. declare module BABYLON {
  141969. /**
  141970. * Block used to blend normals
  141971. */
  141972. export class NormalBlendBlock extends NodeMaterialBlock {
  141973. /**
  141974. * Creates a new NormalBlendBlock
  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 first input component
  141985. */
  141986. get normalMap0(): NodeMaterialConnectionPoint;
  141987. /**
  141988. * Gets the second input component
  141989. */
  141990. get normalMap1(): NodeMaterialConnectionPoint;
  141991. /**
  141992. * Gets the output component
  141993. */
  141994. get output(): NodeMaterialConnectionPoint;
  141995. protected _buildBlock(state: NodeMaterialBuildState): this;
  141996. }
  141997. }
  141998. declare module BABYLON {
  141999. /**
  142000. * Block used to rotate a 2d vector by a given angle
  142001. */
  142002. export class Rotate2dBlock extends NodeMaterialBlock {
  142003. /**
  142004. * Creates a new Rotate2dBlock
  142005. * @param name defines the block name
  142006. */
  142007. constructor(name: string);
  142008. /**
  142009. * Gets the current class name
  142010. * @returns the class name
  142011. */
  142012. getClassName(): string;
  142013. /**
  142014. * Gets the input vector
  142015. */
  142016. get input(): NodeMaterialConnectionPoint;
  142017. /**
  142018. * Gets the input angle
  142019. */
  142020. get angle(): NodeMaterialConnectionPoint;
  142021. /**
  142022. * Gets the output component
  142023. */
  142024. get output(): NodeMaterialConnectionPoint;
  142025. autoConfigure(material: NodeMaterial): void;
  142026. protected _buildBlock(state: NodeMaterialBuildState): this;
  142027. }
  142028. }
  142029. declare module BABYLON {
  142030. /**
  142031. * Block used to get the reflected vector from a direction and a normal
  142032. */
  142033. export class ReflectBlock extends NodeMaterialBlock {
  142034. /**
  142035. * Creates a new ReflectBlock
  142036. * @param name defines the block name
  142037. */
  142038. constructor(name: string);
  142039. /**
  142040. * Gets the current class name
  142041. * @returns the class name
  142042. */
  142043. getClassName(): string;
  142044. /**
  142045. * Gets the incident component
  142046. */
  142047. get incident(): NodeMaterialConnectionPoint;
  142048. /**
  142049. * Gets the normal component
  142050. */
  142051. get normal(): NodeMaterialConnectionPoint;
  142052. /**
  142053. * Gets the output component
  142054. */
  142055. get output(): NodeMaterialConnectionPoint;
  142056. protected _buildBlock(state: NodeMaterialBuildState): this;
  142057. }
  142058. }
  142059. declare module BABYLON {
  142060. /**
  142061. * Block used to get the refracted vector from a direction and a normal
  142062. */
  142063. export class RefractBlock extends NodeMaterialBlock {
  142064. /**
  142065. * Creates a new RefractBlock
  142066. * @param name defines the block name
  142067. */
  142068. constructor(name: string);
  142069. /**
  142070. * Gets the current class name
  142071. * @returns the class name
  142072. */
  142073. getClassName(): string;
  142074. /**
  142075. * Gets the incident component
  142076. */
  142077. get incident(): NodeMaterialConnectionPoint;
  142078. /**
  142079. * Gets the normal component
  142080. */
  142081. get normal(): NodeMaterialConnectionPoint;
  142082. /**
  142083. * Gets the index of refraction component
  142084. */
  142085. get ior(): NodeMaterialConnectionPoint;
  142086. /**
  142087. * Gets the output component
  142088. */
  142089. get output(): NodeMaterialConnectionPoint;
  142090. protected _buildBlock(state: NodeMaterialBuildState): this;
  142091. }
  142092. }
  142093. declare module BABYLON {
  142094. /**
  142095. * Block used to desaturate a color
  142096. */
  142097. export class DesaturateBlock extends NodeMaterialBlock {
  142098. /**
  142099. * Creates a new DesaturateBlock
  142100. * @param name defines the block name
  142101. */
  142102. constructor(name: string);
  142103. /**
  142104. * Gets the current class name
  142105. * @returns the class name
  142106. */
  142107. getClassName(): string;
  142108. /**
  142109. * Gets the color operand input component
  142110. */
  142111. get color(): NodeMaterialConnectionPoint;
  142112. /**
  142113. * Gets the level operand input component
  142114. */
  142115. get level(): NodeMaterialConnectionPoint;
  142116. /**
  142117. * Gets the output component
  142118. */
  142119. get output(): NodeMaterialConnectionPoint;
  142120. protected _buildBlock(state: NodeMaterialBuildState): this;
  142121. }
  142122. }
  142123. declare module BABYLON {
  142124. /**
  142125. * Block used to implement the ambient occlusion module of the PBR material
  142126. */
  142127. export class AmbientOcclusionBlock extends NodeMaterialBlock {
  142128. /**
  142129. * Create a new AmbientOcclusionBlock
  142130. * @param name defines the block name
  142131. */
  142132. constructor(name: string);
  142133. /**
  142134. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  142135. */
  142136. useAmbientInGrayScale: boolean;
  142137. /**
  142138. * Initialize the block and prepare the context for build
  142139. * @param state defines the state that will be used for the build
  142140. */
  142141. initialize(state: NodeMaterialBuildState): void;
  142142. /**
  142143. * Gets the current class name
  142144. * @returns the class name
  142145. */
  142146. getClassName(): string;
  142147. /**
  142148. * Gets the texture input component
  142149. */
  142150. get texture(): NodeMaterialConnectionPoint;
  142151. /**
  142152. * Gets the texture intensity component
  142153. */
  142154. get intensity(): NodeMaterialConnectionPoint;
  142155. /**
  142156. * Gets the direct light intensity input component
  142157. */
  142158. get directLightIntensity(): NodeMaterialConnectionPoint;
  142159. /**
  142160. * Gets the ambient occlusion object output component
  142161. */
  142162. get ambientOcclusion(): NodeMaterialConnectionPoint;
  142163. /**
  142164. * Gets the main code of the block (fragment side)
  142165. * @param block instance of an AmbientOcclusionBlock or null if the code must be generated without an active ambient occlusion module
  142166. * @returns the shader code
  142167. */
  142168. static GetCode(block: Nullable<AmbientOcclusionBlock>): string;
  142169. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  142170. protected _buildBlock(state: NodeMaterialBuildState): this;
  142171. protected _dumpPropertiesCode(): string;
  142172. serialize(): any;
  142173. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  142174. }
  142175. }
  142176. declare module BABYLON {
  142177. /**
  142178. * Block used to implement the reflection module of the PBR material
  142179. */
  142180. export class ReflectionBlock extends ReflectionTextureBaseBlock {
  142181. /** @hidden */
  142182. _defineLODReflectionAlpha: string;
  142183. /** @hidden */
  142184. _defineLinearSpecularReflection: string;
  142185. private _vEnvironmentIrradianceName;
  142186. /** @hidden */
  142187. _vReflectionMicrosurfaceInfosName: string;
  142188. /** @hidden */
  142189. _vReflectionInfosName: string;
  142190. /** @hidden */
  142191. _vReflectionFilteringInfoName: string;
  142192. private _scene;
  142193. /**
  142194. * The three properties below are set by the main PBR block prior to calling methods of this class.
  142195. * This is to avoid having to add them as inputs here whereas they are already inputs of the main block, so already known.
  142196. * It's less burden on the user side in the editor part.
  142197. */
  142198. /** @hidden */
  142199. worldPositionConnectionPoint: NodeMaterialConnectionPoint;
  142200. /** @hidden */
  142201. worldNormalConnectionPoint: NodeMaterialConnectionPoint;
  142202. /** @hidden */
  142203. cameraPositionConnectionPoint: NodeMaterialConnectionPoint;
  142204. /**
  142205. * Defines if the material uses spherical harmonics vs spherical polynomials for the
  142206. * diffuse part of the IBL.
  142207. */
  142208. useSphericalHarmonics: boolean;
  142209. /**
  142210. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  142211. */
  142212. forceIrradianceInFragment: boolean;
  142213. /**
  142214. * Create a new ReflectionBlock
  142215. * @param name defines the block name
  142216. */
  142217. constructor(name: string);
  142218. /**
  142219. * Gets the current class name
  142220. * @returns the class name
  142221. */
  142222. getClassName(): string;
  142223. /**
  142224. * Gets the position input component
  142225. */
  142226. get position(): NodeMaterialConnectionPoint;
  142227. /**
  142228. * Gets the world position input component
  142229. */
  142230. get worldPosition(): NodeMaterialConnectionPoint;
  142231. /**
  142232. * Gets the world normal input component
  142233. */
  142234. get worldNormal(): NodeMaterialConnectionPoint;
  142235. /**
  142236. * Gets the world input component
  142237. */
  142238. get world(): NodeMaterialConnectionPoint;
  142239. /**
  142240. * Gets the camera (or eye) position component
  142241. */
  142242. get cameraPosition(): NodeMaterialConnectionPoint;
  142243. /**
  142244. * Gets the view input component
  142245. */
  142246. get view(): NodeMaterialConnectionPoint;
  142247. /**
  142248. * Gets the color input component
  142249. */
  142250. get color(): NodeMaterialConnectionPoint;
  142251. /**
  142252. * Gets the reflection object output component
  142253. */
  142254. get reflection(): NodeMaterialConnectionPoint;
  142255. /**
  142256. * Returns true if the block has a texture (either its own texture or the environment texture from the scene, if set)
  142257. */
  142258. get hasTexture(): boolean;
  142259. /**
  142260. * Gets the reflection color (either the name of the variable if the color input is connected, else a default value)
  142261. */
  142262. get reflectionColor(): string;
  142263. protected _getTexture(): Nullable<BaseTexture>;
  142264. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  142265. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  142266. /**
  142267. * Gets the code to inject in the vertex shader
  142268. * @param state current state of the node material building
  142269. * @returns the shader code
  142270. */
  142271. handleVertexSide(state: NodeMaterialBuildState): string;
  142272. /**
  142273. * Gets the main code of the block (fragment side)
  142274. * @param state current state of the node material building
  142275. * @param normalVarName name of the existing variable corresponding to the normal
  142276. * @returns the shader code
  142277. */
  142278. getCode(state: NodeMaterialBuildState, normalVarName: string): string;
  142279. protected _buildBlock(state: NodeMaterialBuildState): this;
  142280. protected _dumpPropertiesCode(): string;
  142281. serialize(): any;
  142282. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  142283. }
  142284. }
  142285. declare module BABYLON {
  142286. /**
  142287. * Block used to implement the sheen module of the PBR material
  142288. */
  142289. export class SheenBlock extends NodeMaterialBlock {
  142290. /**
  142291. * Create a new SheenBlock
  142292. * @param name defines the block name
  142293. */
  142294. constructor(name: string);
  142295. /**
  142296. * If true, the sheen effect is layered above the base BRDF with the albedo-scaling technique.
  142297. * It allows the strength of the sheen effect to not depend on the base color of the material,
  142298. * making it easier to setup and tweak the effect
  142299. */
  142300. albedoScaling: boolean;
  142301. /**
  142302. * Defines if the sheen is linked to the sheen color.
  142303. */
  142304. linkSheenWithAlbedo: boolean;
  142305. /**
  142306. * Initialize the block and prepare the context for build
  142307. * @param state defines the state that will be used for the build
  142308. */
  142309. initialize(state: NodeMaterialBuildState): void;
  142310. /**
  142311. * Gets the current class name
  142312. * @returns the class name
  142313. */
  142314. getClassName(): string;
  142315. /**
  142316. * Gets the intensity input component
  142317. */
  142318. get intensity(): NodeMaterialConnectionPoint;
  142319. /**
  142320. * Gets the color input component
  142321. */
  142322. get color(): NodeMaterialConnectionPoint;
  142323. /**
  142324. * Gets the roughness input component
  142325. */
  142326. get roughness(): NodeMaterialConnectionPoint;
  142327. /**
  142328. * Gets the sheen object output component
  142329. */
  142330. get sheen(): NodeMaterialConnectionPoint;
  142331. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  142332. /**
  142333. * Gets the main code of the block (fragment side)
  142334. * @param reflectionBlock instance of a ReflectionBlock null if the code must be generated without an active reflection module
  142335. * @returns the shader code
  142336. */
  142337. getCode(reflectionBlock: Nullable<ReflectionBlock>): string;
  142338. protected _buildBlock(state: NodeMaterialBuildState): this;
  142339. protected _dumpPropertiesCode(): string;
  142340. serialize(): any;
  142341. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  142342. }
  142343. }
  142344. declare module BABYLON {
  142345. /**
  142346. * Block used to implement the reflectivity module of the PBR material
  142347. */
  142348. export class ReflectivityBlock extends NodeMaterialBlock {
  142349. private _metallicReflectanceColor;
  142350. private _metallicF0Factor;
  142351. /** @hidden */
  142352. _vMetallicReflectanceFactorsName: string;
  142353. /**
  142354. * The property below is set by the main PBR block prior to calling methods of this class.
  142355. */
  142356. /** @hidden */
  142357. indexOfRefractionConnectionPoint: Nullable<NodeMaterialConnectionPoint>;
  142358. /**
  142359. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  142360. */
  142361. useAmbientOcclusionFromMetallicTextureRed: boolean;
  142362. /**
  142363. * Specifies if the metallic texture contains the metallness information in its blue channel.
  142364. */
  142365. useMetallnessFromMetallicTextureBlue: boolean;
  142366. /**
  142367. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  142368. */
  142369. useRoughnessFromMetallicTextureAlpha: boolean;
  142370. /**
  142371. * Specifies if the metallic texture contains the roughness information in its green channel.
  142372. */
  142373. useRoughnessFromMetallicTextureGreen: boolean;
  142374. /**
  142375. * Create a new ReflectivityBlock
  142376. * @param name defines the block name
  142377. */
  142378. constructor(name: string);
  142379. /**
  142380. * Initialize the block and prepare the context for build
  142381. * @param state defines the state that will be used for the build
  142382. */
  142383. initialize(state: NodeMaterialBuildState): void;
  142384. /**
  142385. * Gets the current class name
  142386. * @returns the class name
  142387. */
  142388. getClassName(): string;
  142389. /**
  142390. * Gets the metallic input component
  142391. */
  142392. get metallic(): NodeMaterialConnectionPoint;
  142393. /**
  142394. * Gets the roughness input component
  142395. */
  142396. get roughness(): NodeMaterialConnectionPoint;
  142397. /**
  142398. * Gets the texture input component
  142399. */
  142400. get texture(): NodeMaterialConnectionPoint;
  142401. /**
  142402. * Gets the reflectivity object output component
  142403. */
  142404. get reflectivity(): NodeMaterialConnectionPoint;
  142405. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  142406. /**
  142407. * Gets the main code of the block (fragment side)
  142408. * @param state current state of the node material building
  142409. * @param aoIntensityVarName name of the variable with the ambient occlusion intensity
  142410. * @returns the shader code
  142411. */
  142412. getCode(state: NodeMaterialBuildState, aoIntensityVarName: string): string;
  142413. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  142414. protected _buildBlock(state: NodeMaterialBuildState): this;
  142415. protected _dumpPropertiesCode(): string;
  142416. serialize(): any;
  142417. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  142418. }
  142419. }
  142420. declare module BABYLON {
  142421. /**
  142422. * Block used to implement the anisotropy module of the PBR material
  142423. */
  142424. export class AnisotropyBlock extends NodeMaterialBlock {
  142425. /**
  142426. * The two properties below are set by the main PBR block prior to calling methods of this class.
  142427. * This is to avoid having to add them as inputs here whereas they are already inputs of the main block, so already known.
  142428. * It's less burden on the user side in the editor part.
  142429. */
  142430. /** @hidden */
  142431. worldPositionConnectionPoint: NodeMaterialConnectionPoint;
  142432. /** @hidden */
  142433. worldNormalConnectionPoint: NodeMaterialConnectionPoint;
  142434. /**
  142435. * Create a new AnisotropyBlock
  142436. * @param name defines the block name
  142437. */
  142438. constructor(name: string);
  142439. /**
  142440. * Initialize the block and prepare the context for build
  142441. * @param state defines the state that will be used for the build
  142442. */
  142443. initialize(state: NodeMaterialBuildState): void;
  142444. /**
  142445. * Gets the current class name
  142446. * @returns the class name
  142447. */
  142448. getClassName(): string;
  142449. /**
  142450. * Gets the intensity input component
  142451. */
  142452. get intensity(): NodeMaterialConnectionPoint;
  142453. /**
  142454. * Gets the direction input component
  142455. */
  142456. get direction(): NodeMaterialConnectionPoint;
  142457. /**
  142458. * Gets the texture input component
  142459. */
  142460. get texture(): NodeMaterialConnectionPoint;
  142461. /**
  142462. * Gets the uv input component
  142463. */
  142464. get uv(): NodeMaterialConnectionPoint;
  142465. /**
  142466. * Gets the worldTangent input component
  142467. */
  142468. get worldTangent(): NodeMaterialConnectionPoint;
  142469. /**
  142470. * Gets the anisotropy object output component
  142471. */
  142472. get anisotropy(): NodeMaterialConnectionPoint;
  142473. private _generateTBNSpace;
  142474. /**
  142475. * Gets the main code of the block (fragment side)
  142476. * @param state current state of the node material building
  142477. * @param generateTBNSpace if true, the code needed to create the TBN coordinate space is generated
  142478. * @returns the shader code
  142479. */
  142480. getCode(state: NodeMaterialBuildState, generateTBNSpace?: boolean): string;
  142481. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  142482. protected _buildBlock(state: NodeMaterialBuildState): this;
  142483. }
  142484. }
  142485. declare module BABYLON {
  142486. /**
  142487. * Block used to implement the clear coat module of the PBR material
  142488. */
  142489. export class ClearCoatBlock extends NodeMaterialBlock {
  142490. private _scene;
  142491. /**
  142492. * Create a new ClearCoatBlock
  142493. * @param name defines the block name
  142494. */
  142495. constructor(name: string);
  142496. /**
  142497. * Initialize the block and prepare the context for build
  142498. * @param state defines the state that will be used for the build
  142499. */
  142500. initialize(state: NodeMaterialBuildState): void;
  142501. /**
  142502. * Gets the current class name
  142503. * @returns the class name
  142504. */
  142505. getClassName(): string;
  142506. /**
  142507. * Gets the intensity input component
  142508. */
  142509. get intensity(): NodeMaterialConnectionPoint;
  142510. /**
  142511. * Gets the roughness input component
  142512. */
  142513. get roughness(): NodeMaterialConnectionPoint;
  142514. /**
  142515. * Gets the ior input component
  142516. */
  142517. get ior(): NodeMaterialConnectionPoint;
  142518. /**
  142519. * Gets the texture input component
  142520. */
  142521. get texture(): NodeMaterialConnectionPoint;
  142522. /**
  142523. * Gets the bump texture input component
  142524. */
  142525. get bumpTexture(): NodeMaterialConnectionPoint;
  142526. /**
  142527. * Gets the uv input component
  142528. */
  142529. get uv(): NodeMaterialConnectionPoint;
  142530. /**
  142531. * Gets the tint color input component
  142532. */
  142533. get tintColor(): NodeMaterialConnectionPoint;
  142534. /**
  142535. * Gets the tint "at distance" input component
  142536. */
  142537. get tintAtDistance(): NodeMaterialConnectionPoint;
  142538. /**
  142539. * Gets the tint thickness input component
  142540. */
  142541. get tintThickness(): NodeMaterialConnectionPoint;
  142542. /**
  142543. * Gets the world tangent input component
  142544. */
  142545. get worldTangent(): NodeMaterialConnectionPoint;
  142546. /**
  142547. * Gets the clear coat object output component
  142548. */
  142549. get clearcoat(): NodeMaterialConnectionPoint;
  142550. autoConfigure(material: NodeMaterial): void;
  142551. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  142552. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  142553. private _generateTBNSpace;
  142554. /**
  142555. * Gets the main code of the block (fragment side)
  142556. * @param state current state of the node material building
  142557. * @param ccBlock instance of a ClearCoatBlock or null if the code must be generated without an active clear coat module
  142558. * @param reflectionBlock instance of a ReflectionBlock null if the code must be generated without an active reflection module
  142559. * @param worldPosVarName name of the variable holding the world position
  142560. * @param generateTBNSpace if true, the code needed to create the TBN coordinate space is generated
  142561. * @param vTBNAvailable indicate that the vTBN variable is already existing because it has already been generated by another block (PerturbNormal or Anisotropy)
  142562. * @param worldNormalVarName name of the variable holding the world normal
  142563. * @returns the shader code
  142564. */
  142565. static GetCode(state: NodeMaterialBuildState, ccBlock: Nullable<ClearCoatBlock>, reflectionBlock: Nullable<ReflectionBlock>, worldPosVarName: string, generateTBNSpace: boolean, vTBNAvailable: boolean, worldNormalVarName: string): string;
  142566. protected _buildBlock(state: NodeMaterialBuildState): this;
  142567. }
  142568. }
  142569. declare module BABYLON {
  142570. /**
  142571. * Block used to implement the sub surface module of the PBR material
  142572. */
  142573. export class SubSurfaceBlock extends NodeMaterialBlock {
  142574. /**
  142575. * Create a new SubSurfaceBlock
  142576. * @param name defines the block name
  142577. */
  142578. constructor(name: string);
  142579. /**
  142580. * Stores the intensity of the different subsurface effects in the thickness texture.
  142581. * * the green channel is the translucency intensity.
  142582. * * the blue channel is the scattering intensity.
  142583. * * the alpha channel is the refraction intensity.
  142584. */
  142585. useMaskFromThicknessTexture: boolean;
  142586. /**
  142587. * Initialize the block and prepare the context for build
  142588. * @param state defines the state that will be used for the build
  142589. */
  142590. initialize(state: NodeMaterialBuildState): void;
  142591. /**
  142592. * Gets the current class name
  142593. * @returns the class name
  142594. */
  142595. getClassName(): string;
  142596. /**
  142597. * Gets the min thickness input component
  142598. */
  142599. get minThickness(): NodeMaterialConnectionPoint;
  142600. /**
  142601. * Gets the max thickness input component
  142602. */
  142603. get maxThickness(): NodeMaterialConnectionPoint;
  142604. /**
  142605. * Gets the thickness texture component
  142606. */
  142607. get thicknessTexture(): NodeMaterialConnectionPoint;
  142608. /**
  142609. * Gets the tint color input component
  142610. */
  142611. get tintColor(): NodeMaterialConnectionPoint;
  142612. /**
  142613. * Gets the translucency intensity input component
  142614. */
  142615. get translucencyIntensity(): NodeMaterialConnectionPoint;
  142616. /**
  142617. * Gets the translucency diffusion distance input component
  142618. */
  142619. get translucencyDiffusionDistance(): NodeMaterialConnectionPoint;
  142620. /**
  142621. * Gets the refraction object parameters
  142622. */
  142623. get refraction(): NodeMaterialConnectionPoint;
  142624. /**
  142625. * Gets the sub surface object output component
  142626. */
  142627. get subsurface(): NodeMaterialConnectionPoint;
  142628. autoConfigure(material: NodeMaterial): void;
  142629. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  142630. /**
  142631. * Gets the main code of the block (fragment side)
  142632. * @param state current state of the node material building
  142633. * @param ssBlock instance of a SubSurfaceBlock or null if the code must be generated without an active sub surface module
  142634. * @param reflectionBlock instance of a ReflectionBlock null if the code must be generated without an active reflection module
  142635. * @param worldPosVarName name of the variable holding the world position
  142636. * @returns the shader code
  142637. */
  142638. static GetCode(state: NodeMaterialBuildState, ssBlock: Nullable<SubSurfaceBlock>, reflectionBlock: Nullable<ReflectionBlock>, worldPosVarName: string): string;
  142639. protected _buildBlock(state: NodeMaterialBuildState): this;
  142640. }
  142641. }
  142642. declare module BABYLON {
  142643. /**
  142644. * Block used to implement the PBR metallic/roughness model
  142645. */
  142646. export class PBRMetallicRoughnessBlock extends NodeMaterialBlock {
  142647. /**
  142648. * Gets or sets the light associated with this block
  142649. */
  142650. light: Nullable<Light>;
  142651. private _lightId;
  142652. private _scene;
  142653. private _environmentBRDFTexture;
  142654. private _environmentBrdfSamplerName;
  142655. private _vNormalWName;
  142656. private _invertNormalName;
  142657. /**
  142658. * Create a new ReflectionBlock
  142659. * @param name defines the block name
  142660. */
  142661. constructor(name: string);
  142662. /**
  142663. * Intensity of the direct lights e.g. the four lights available in your scene.
  142664. * This impacts both the direct diffuse and specular highlights.
  142665. */
  142666. directIntensity: number;
  142667. /**
  142668. * Intensity of the environment e.g. how much the environment will light the object
  142669. * either through harmonics for rough material or through the refelction for shiny ones.
  142670. */
  142671. environmentIntensity: number;
  142672. /**
  142673. * This is a special control allowing the reduction of the specular highlights coming from the
  142674. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  142675. */
  142676. specularIntensity: number;
  142677. /**
  142678. * Defines the falloff type used in this material.
  142679. * It by default is Physical.
  142680. */
  142681. lightFalloff: number;
  142682. /**
  142683. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  142684. */
  142685. useAlphaFromAlbedoTexture: boolean;
  142686. /**
  142687. * Specifies that alpha test should be used
  142688. */
  142689. useAlphaTest: boolean;
  142690. /**
  142691. * Defines the alpha limits in alpha test mode.
  142692. */
  142693. alphaTestCutoff: number;
  142694. /**
  142695. * Specifies that alpha blending should be used
  142696. */
  142697. useAlphaBlending: boolean;
  142698. /**
  142699. * Defines if the alpha value should be determined via the rgb values.
  142700. * If true the luminance of the pixel might be used to find the corresponding alpha value.
  142701. */
  142702. opacityRGB: boolean;
  142703. /**
  142704. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most luminous ones).
  142705. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  142706. */
  142707. useRadianceOverAlpha: boolean;
  142708. /**
  142709. * Specifies that the material will keeps the specular highlights over a transparent surface (only the most luminous ones).
  142710. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  142711. */
  142712. useSpecularOverAlpha: boolean;
  142713. /**
  142714. * Enables specular anti aliasing in the PBR shader.
  142715. * It will both interacts on the Geometry for analytical and IBL lighting.
  142716. * It also prefilter the roughness map based on the bump values.
  142717. */
  142718. enableSpecularAntiAliasing: boolean;
  142719. /**
  142720. * Enables realtime filtering on the texture.
  142721. */
  142722. realTimeFiltering: boolean;
  142723. /**
  142724. * Quality switch for realtime filtering
  142725. */
  142726. realTimeFilteringQuality: number;
  142727. /**
  142728. * Defines if the material uses energy conservation.
  142729. */
  142730. useEnergyConservation: boolean;
  142731. /**
  142732. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  142733. * too much the area relying on ambient texture to define their ambient occlusion.
  142734. */
  142735. useRadianceOcclusion: boolean;
  142736. /**
  142737. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  142738. * makes the reflect vector face the model (under horizon).
  142739. */
  142740. useHorizonOcclusion: boolean;
  142741. /**
  142742. * If set to true, no lighting calculations will be applied.
  142743. */
  142744. unlit: boolean;
  142745. /**
  142746. * Force normal to face away from face.
  142747. */
  142748. forceNormalForward: boolean;
  142749. /**
  142750. * Defines the material debug mode.
  142751. * It helps seeing only some components of the material while troubleshooting.
  142752. */
  142753. debugMode: number;
  142754. /**
  142755. * Specify from where on screen the debug mode should start.
  142756. * The value goes from -1 (full screen) to 1 (not visible)
  142757. * It helps with side by side comparison against the final render
  142758. * This defaults to 0
  142759. */
  142760. debugLimit: number;
  142761. /**
  142762. * As the default viewing range might not be enough (if the ambient is really small for instance)
  142763. * You can use the factor to better multiply the final value.
  142764. */
  142765. debugFactor: number;
  142766. /**
  142767. * Initialize the block and prepare the context for build
  142768. * @param state defines the state that will be used for the build
  142769. */
  142770. initialize(state: NodeMaterialBuildState): void;
  142771. /**
  142772. * Gets the current class name
  142773. * @returns the class name
  142774. */
  142775. getClassName(): string;
  142776. /**
  142777. * Gets the world position input component
  142778. */
  142779. get worldPosition(): NodeMaterialConnectionPoint;
  142780. /**
  142781. * Gets the world normal input component
  142782. */
  142783. get worldNormal(): NodeMaterialConnectionPoint;
  142784. /**
  142785. * Gets the perturbed normal input component
  142786. */
  142787. get perturbedNormal(): NodeMaterialConnectionPoint;
  142788. /**
  142789. * Gets the camera position input component
  142790. */
  142791. get cameraPosition(): NodeMaterialConnectionPoint;
  142792. /**
  142793. * Gets the base color input component
  142794. */
  142795. get baseColor(): NodeMaterialConnectionPoint;
  142796. /**
  142797. * Gets the opacity texture input component
  142798. */
  142799. get opacityTexture(): NodeMaterialConnectionPoint;
  142800. /**
  142801. * Gets the ambient color input component
  142802. */
  142803. get ambientColor(): NodeMaterialConnectionPoint;
  142804. /**
  142805. * Gets the reflectivity object parameters
  142806. */
  142807. get reflectivity(): NodeMaterialConnectionPoint;
  142808. /**
  142809. * Gets the ambient occlusion object parameters
  142810. */
  142811. get ambientOcclusion(): NodeMaterialConnectionPoint;
  142812. /**
  142813. * Gets the reflection object parameters
  142814. */
  142815. get reflection(): NodeMaterialConnectionPoint;
  142816. /**
  142817. * Gets the sheen object parameters
  142818. */
  142819. get sheen(): NodeMaterialConnectionPoint;
  142820. /**
  142821. * Gets the clear coat object parameters
  142822. */
  142823. get clearcoat(): NodeMaterialConnectionPoint;
  142824. /**
  142825. * Gets the sub surface object parameters
  142826. */
  142827. get subsurface(): NodeMaterialConnectionPoint;
  142828. /**
  142829. * Gets the anisotropy object parameters
  142830. */
  142831. get anisotropy(): NodeMaterialConnectionPoint;
  142832. /**
  142833. * Gets the ambient output component
  142834. */
  142835. get ambient(): NodeMaterialConnectionPoint;
  142836. /**
  142837. * Gets the diffuse output component
  142838. */
  142839. get diffuse(): NodeMaterialConnectionPoint;
  142840. /**
  142841. * Gets the specular output component
  142842. */
  142843. get specular(): NodeMaterialConnectionPoint;
  142844. /**
  142845. * Gets the sheen output component
  142846. */
  142847. get sheenDir(): NodeMaterialConnectionPoint;
  142848. /**
  142849. * Gets the clear coat output component
  142850. */
  142851. get clearcoatDir(): NodeMaterialConnectionPoint;
  142852. /**
  142853. * Gets the indirect diffuse output component
  142854. */
  142855. get diffuseIndirect(): NodeMaterialConnectionPoint;
  142856. /**
  142857. * Gets the indirect specular output component
  142858. */
  142859. get specularIndirect(): NodeMaterialConnectionPoint;
  142860. /**
  142861. * Gets the indirect sheen output component
  142862. */
  142863. get sheenIndirect(): NodeMaterialConnectionPoint;
  142864. /**
  142865. * Gets the indirect clear coat output component
  142866. */
  142867. get clearcoatIndirect(): NodeMaterialConnectionPoint;
  142868. /**
  142869. * Gets the refraction output component
  142870. */
  142871. get refraction(): NodeMaterialConnectionPoint;
  142872. /**
  142873. * Gets the global lighting output component
  142874. */
  142875. get lighting(): NodeMaterialConnectionPoint;
  142876. /**
  142877. * Gets the shadow output component
  142878. */
  142879. get shadow(): NodeMaterialConnectionPoint;
  142880. /**
  142881. * Gets the alpha output component
  142882. */
  142883. get alpha(): NodeMaterialConnectionPoint;
  142884. autoConfigure(material: NodeMaterial): void;
  142885. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  142886. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  142887. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  142888. private _injectVertexCode;
  142889. /**
  142890. * Gets the code corresponding to the albedo/opacity module
  142891. * @returns the shader code
  142892. */
  142893. getAlbedoOpacityCode(): string;
  142894. protected _buildBlock(state: NodeMaterialBuildState): this;
  142895. protected _dumpPropertiesCode(): string;
  142896. serialize(): any;
  142897. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  142898. }
  142899. }
  142900. declare module BABYLON {
  142901. /**
  142902. * Block used to compute value of one parameter modulo another
  142903. */
  142904. export class ModBlock extends NodeMaterialBlock {
  142905. /**
  142906. * Creates a new ModBlock
  142907. * @param name defines the block name
  142908. */
  142909. constructor(name: string);
  142910. /**
  142911. * Gets the current class name
  142912. * @returns the class name
  142913. */
  142914. getClassName(): string;
  142915. /**
  142916. * Gets the left operand input component
  142917. */
  142918. get left(): NodeMaterialConnectionPoint;
  142919. /**
  142920. * Gets the right operand input component
  142921. */
  142922. get right(): NodeMaterialConnectionPoint;
  142923. /**
  142924. * Gets the output component
  142925. */
  142926. get output(): NodeMaterialConnectionPoint;
  142927. protected _buildBlock(state: NodeMaterialBuildState): this;
  142928. }
  142929. }
  142930. declare module BABYLON {
  142931. /**
  142932. * Helper class to push actions to a pool of workers.
  142933. */
  142934. export class WorkerPool implements IDisposable {
  142935. private _workerInfos;
  142936. private _pendingActions;
  142937. /**
  142938. * Constructor
  142939. * @param workers Array of workers to use for actions
  142940. */
  142941. constructor(workers: Array<Worker>);
  142942. /**
  142943. * Terminates all workers and clears any pending actions.
  142944. */
  142945. dispose(): void;
  142946. /**
  142947. * Pushes an action to the worker pool. If all the workers are active, the action will be
  142948. * pended until a worker has completed its action.
  142949. * @param action The action to perform. Call onComplete when the action is complete.
  142950. */
  142951. push(action: (worker: Worker, onComplete: () => void) => void): void;
  142952. private _execute;
  142953. }
  142954. }
  142955. declare module BABYLON {
  142956. /**
  142957. * Configuration for Draco compression
  142958. */
  142959. export interface IDracoCompressionConfiguration {
  142960. /**
  142961. * Configuration for the decoder.
  142962. */
  142963. decoder: {
  142964. /**
  142965. * The url to the WebAssembly module.
  142966. */
  142967. wasmUrl?: string;
  142968. /**
  142969. * The url to the WebAssembly binary.
  142970. */
  142971. wasmBinaryUrl?: string;
  142972. /**
  142973. * The url to the fallback JavaScript module.
  142974. */
  142975. fallbackUrl?: string;
  142976. };
  142977. }
  142978. /**
  142979. * Draco compression (https://google.github.io/draco/)
  142980. *
  142981. * This class wraps the Draco module.
  142982. *
  142983. * **Encoder**
  142984. *
  142985. * The encoder is not currently implemented.
  142986. *
  142987. * **Decoder**
  142988. *
  142989. * 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.
  142990. *
  142991. * To update the configuration, use the following code:
  142992. * ```javascript
  142993. * DracoCompression.Configuration = {
  142994. * decoder: {
  142995. * wasmUrl: "<url to the WebAssembly library>",
  142996. * wasmBinaryUrl: "<url to the WebAssembly binary>",
  142997. * fallbackUrl: "<url to the fallback JavaScript library>",
  142998. * }
  142999. * };
  143000. * ```
  143001. *
  143002. * 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.
  143003. * Decoding will automatically fallback to the JavaScript version if WebAssembly version is not configured or if WebAssembly is not supported by the browser.
  143004. * Use `DracoCompression.DecoderAvailable` to determine if the decoder configuration is available for the current context.
  143005. *
  143006. * To decode Draco compressed data, get the default DracoCompression object and call decodeMeshAsync:
  143007. * ```javascript
  143008. * var vertexData = await DracoCompression.Default.decodeMeshAsync(data);
  143009. * ```
  143010. *
  143011. * @see https://www.babylonjs-playground.com/#N3EK4B#0
  143012. */
  143013. export class DracoCompression implements IDisposable {
  143014. private _workerPoolPromise?;
  143015. private _decoderModulePromise?;
  143016. /**
  143017. * The configuration. Defaults to the following urls:
  143018. * - wasmUrl: "https://preview.babylonjs.com/draco_wasm_wrapper_gltf.js"
  143019. * - wasmBinaryUrl: "https://preview.babylonjs.com/draco_decoder_gltf.wasm"
  143020. * - fallbackUrl: "https://preview.babylonjs.com/draco_decoder_gltf.js"
  143021. */
  143022. static Configuration: IDracoCompressionConfiguration;
  143023. /**
  143024. * Returns true if the decoder configuration is available.
  143025. */
  143026. static get DecoderAvailable(): boolean;
  143027. /**
  143028. * Default number of workers to create when creating the draco compression object.
  143029. */
  143030. static DefaultNumWorkers: number;
  143031. private static GetDefaultNumWorkers;
  143032. private static _Default;
  143033. /**
  143034. * Default instance for the draco compression object.
  143035. */
  143036. static get Default(): DracoCompression;
  143037. /**
  143038. * Constructor
  143039. * @param numWorkers The number of workers for async operations. Specify `0` to disable web workers and run synchronously in the current context.
  143040. */
  143041. constructor(numWorkers?: number);
  143042. /**
  143043. * Stop all async operations and release resources.
  143044. */
  143045. dispose(): void;
  143046. /**
  143047. * Returns a promise that resolves when ready. Call this manually to ensure draco compression is ready before use.
  143048. * @returns a promise that resolves when ready
  143049. */
  143050. whenReadyAsync(): Promise<void>;
  143051. /**
  143052. * Decode Draco compressed mesh data to vertex data.
  143053. * @param data The ArrayBuffer or ArrayBufferView for the Draco compression data
  143054. * @param attributes A map of attributes from vertex buffer kinds to Draco unique ids
  143055. * @returns A promise that resolves with the decoded vertex data
  143056. */
  143057. decodeMeshAsync(data: ArrayBuffer | ArrayBufferView, attributes?: {
  143058. [kind: string]: number;
  143059. }): Promise<VertexData>;
  143060. }
  143061. }
  143062. declare module BABYLON {
  143063. /**
  143064. * Class for building Constructive Solid Geometry
  143065. */
  143066. export class CSG {
  143067. private polygons;
  143068. /**
  143069. * The world matrix
  143070. */
  143071. matrix: Matrix;
  143072. /**
  143073. * Stores the position
  143074. */
  143075. position: Vector3;
  143076. /**
  143077. * Stores the rotation
  143078. */
  143079. rotation: Vector3;
  143080. /**
  143081. * Stores the rotation quaternion
  143082. */
  143083. rotationQuaternion: Nullable<Quaternion>;
  143084. /**
  143085. * Stores the scaling vector
  143086. */
  143087. scaling: Vector3;
  143088. /**
  143089. * Convert the Mesh to CSG
  143090. * @param mesh The Mesh to convert to CSG
  143091. * @returns A new CSG from the Mesh
  143092. */
  143093. static FromMesh(mesh: Mesh): CSG;
  143094. /**
  143095. * Construct a CSG solid from a list of `CSG.Polygon` instances.
  143096. * @param polygons Polygons used to construct a CSG solid
  143097. */
  143098. private static FromPolygons;
  143099. /**
  143100. * Clones, or makes a deep copy, of the CSG
  143101. * @returns A new CSG
  143102. */
  143103. clone(): CSG;
  143104. /**
  143105. * Unions this CSG with another CSG
  143106. * @param csg The CSG to union against this CSG
  143107. * @returns The unioned CSG
  143108. */
  143109. union(csg: CSG): CSG;
  143110. /**
  143111. * Unions this CSG with another CSG in place
  143112. * @param csg The CSG to union against this CSG
  143113. */
  143114. unionInPlace(csg: CSG): void;
  143115. /**
  143116. * Subtracts this CSG with another CSG
  143117. * @param csg The CSG to subtract against this CSG
  143118. * @returns A new CSG
  143119. */
  143120. subtract(csg: CSG): CSG;
  143121. /**
  143122. * Subtracts this CSG with another CSG in place
  143123. * @param csg The CSG to subtact against this CSG
  143124. */
  143125. subtractInPlace(csg: CSG): void;
  143126. /**
  143127. * Intersect this CSG with another CSG
  143128. * @param csg The CSG to intersect against this CSG
  143129. * @returns A new CSG
  143130. */
  143131. intersect(csg: CSG): CSG;
  143132. /**
  143133. * Intersects this CSG with another CSG in place
  143134. * @param csg The CSG to intersect against this CSG
  143135. */
  143136. intersectInPlace(csg: CSG): void;
  143137. /**
  143138. * Return a new CSG solid with solid and empty space switched. This solid is
  143139. * not modified.
  143140. * @returns A new CSG solid with solid and empty space switched
  143141. */
  143142. inverse(): CSG;
  143143. /**
  143144. * Inverses the CSG in place
  143145. */
  143146. inverseInPlace(): void;
  143147. /**
  143148. * This is used to keep meshes transformations so they can be restored
  143149. * when we build back a Babylon Mesh
  143150. * NB : All CSG operations are performed in world coordinates
  143151. * @param csg The CSG to copy the transform attributes from
  143152. * @returns This CSG
  143153. */
  143154. copyTransformAttributes(csg: CSG): CSG;
  143155. /**
  143156. * Build Raw mesh from CSG
  143157. * Coordinates here are in world space
  143158. * @param name The name of the mesh geometry
  143159. * @param scene The Scene
  143160. * @param keepSubMeshes Specifies if the submeshes should be kept
  143161. * @returns A new Mesh
  143162. */
  143163. buildMeshGeometry(name: string, scene?: Scene, keepSubMeshes?: boolean): Mesh;
  143164. /**
  143165. * Build Mesh from CSG taking material and transforms into account
  143166. * @param name The name of the Mesh
  143167. * @param material The material of the Mesh
  143168. * @param scene The Scene
  143169. * @param keepSubMeshes Specifies if submeshes should be kept
  143170. * @returns The new Mesh
  143171. */
  143172. toMesh(name: string, material?: Nullable<Material>, scene?: Scene, keepSubMeshes?: boolean): Mesh;
  143173. }
  143174. }
  143175. declare module BABYLON {
  143176. /**
  143177. * Class used to create a trail following a mesh
  143178. */
  143179. export class TrailMesh extends Mesh {
  143180. private _generator;
  143181. private _autoStart;
  143182. private _running;
  143183. private _diameter;
  143184. private _length;
  143185. private _sectionPolygonPointsCount;
  143186. private _sectionVectors;
  143187. private _sectionNormalVectors;
  143188. private _beforeRenderObserver;
  143189. /**
  143190. * @constructor
  143191. * @param name The value used by scene.getMeshByName() to do a lookup.
  143192. * @param generator The mesh or transform node to generate a trail.
  143193. * @param scene The scene to add this mesh to.
  143194. * @param diameter Diameter of trailing mesh. Default is 1.
  143195. * @param length Length of trailing mesh. Default is 60.
  143196. * @param autoStart Automatically start trailing mesh. Default true.
  143197. */
  143198. constructor(name: string, generator: TransformNode, scene: Scene, diameter?: number, length?: number, autoStart?: boolean);
  143199. /**
  143200. * "TrailMesh"
  143201. * @returns "TrailMesh"
  143202. */
  143203. getClassName(): string;
  143204. private _createMesh;
  143205. /**
  143206. * Start trailing mesh.
  143207. */
  143208. start(): void;
  143209. /**
  143210. * Stop trailing mesh.
  143211. */
  143212. stop(): void;
  143213. /**
  143214. * Update trailing mesh geometry.
  143215. */
  143216. update(): void;
  143217. /**
  143218. * Returns a new TrailMesh object.
  143219. * @param name is a string, the name given to the new mesh
  143220. * @param newGenerator use new generator object for cloned trail mesh
  143221. * @returns a new mesh
  143222. */
  143223. clone(name: string | undefined, newGenerator: TransformNode): TrailMesh;
  143224. /**
  143225. * Serializes this trail mesh
  143226. * @param serializationObject object to write serialization to
  143227. */
  143228. serialize(serializationObject: any): void;
  143229. /**
  143230. * Parses a serialized trail mesh
  143231. * @param parsedMesh the serialized mesh
  143232. * @param scene the scene to create the trail mesh in
  143233. * @returns the created trail mesh
  143234. */
  143235. static Parse(parsedMesh: any, scene: Scene): TrailMesh;
  143236. }
  143237. }
  143238. declare module BABYLON {
  143239. /**
  143240. * Class containing static functions to help procedurally build meshes
  143241. */
  143242. export class TiledBoxBuilder {
  143243. /**
  143244. * Creates a box mesh
  143245. * 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)
  143246. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  143247. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  143248. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  143249. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  143250. * @param name defines the name of the mesh
  143251. * @param options defines the options used to create the mesh
  143252. * @param scene defines the hosting scene
  143253. * @returns the box mesh
  143254. */
  143255. static CreateTiledBox(name: string, options: {
  143256. pattern?: number;
  143257. width?: number;
  143258. height?: number;
  143259. depth?: number;
  143260. tileSize?: number;
  143261. tileWidth?: number;
  143262. tileHeight?: number;
  143263. alignHorizontal?: number;
  143264. alignVertical?: number;
  143265. faceUV?: Vector4[];
  143266. faceColors?: Color4[];
  143267. sideOrientation?: number;
  143268. updatable?: boolean;
  143269. }, scene?: Nullable<Scene>): Mesh;
  143270. }
  143271. }
  143272. declare module BABYLON {
  143273. /**
  143274. * Class containing static functions to help procedurally build meshes
  143275. */
  143276. export class TorusKnotBuilder {
  143277. /**
  143278. * Creates a torus knot mesh
  143279. * * The parameter `radius` sets the global radius size (float) of the torus knot (default 2)
  143280. * * The parameter `radialSegments` sets the number of sides on each tube segments (positive integer, default 32)
  143281. * * The parameter `tubularSegments` sets the number of tubes to decompose the knot into (positive integer, default 32)
  143282. * * The parameters `p` and `q` are the number of windings on each axis (positive integers, default 2 and 3)
  143283. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  143284. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  143285. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  143286. * @param name defines the name of the mesh
  143287. * @param options defines the options used to create the mesh
  143288. * @param scene defines the hosting scene
  143289. * @returns the torus knot mesh
  143290. * @see https://doc.babylonjs.com/how_to/set_shapes#torus-knot
  143291. */
  143292. static CreateTorusKnot(name: string, options: {
  143293. radius?: number;
  143294. tube?: number;
  143295. radialSegments?: number;
  143296. tubularSegments?: number;
  143297. p?: number;
  143298. q?: number;
  143299. updatable?: boolean;
  143300. sideOrientation?: number;
  143301. frontUVs?: Vector4;
  143302. backUVs?: Vector4;
  143303. }, scene: any): Mesh;
  143304. }
  143305. }
  143306. declare module BABYLON {
  143307. /**
  143308. * Polygon
  143309. * @see https://doc.babylonjs.com/how_to/parametric_shapes#non-regular-polygon
  143310. */
  143311. export class Polygon {
  143312. /**
  143313. * Creates a rectangle
  143314. * @param xmin bottom X coord
  143315. * @param ymin bottom Y coord
  143316. * @param xmax top X coord
  143317. * @param ymax top Y coord
  143318. * @returns points that make the resulting rectation
  143319. */
  143320. static Rectangle(xmin: number, ymin: number, xmax: number, ymax: number): Vector2[];
  143321. /**
  143322. * Creates a circle
  143323. * @param radius radius of circle
  143324. * @param cx scale in x
  143325. * @param cy scale in y
  143326. * @param numberOfSides number of sides that make up the circle
  143327. * @returns points that make the resulting circle
  143328. */
  143329. static Circle(radius: number, cx?: number, cy?: number, numberOfSides?: number): Vector2[];
  143330. /**
  143331. * Creates a polygon from input string
  143332. * @param input Input polygon data
  143333. * @returns the parsed points
  143334. */
  143335. static Parse(input: string): Vector2[];
  143336. /**
  143337. * Starts building a polygon from x and y coordinates
  143338. * @param x x coordinate
  143339. * @param y y coordinate
  143340. * @returns the started path2
  143341. */
  143342. static StartingAt(x: number, y: number): Path2;
  143343. }
  143344. /**
  143345. * Builds a polygon
  143346. * @see https://doc.babylonjs.com/how_to/polygonmeshbuilder
  143347. */
  143348. export class PolygonMeshBuilder {
  143349. private _points;
  143350. private _outlinepoints;
  143351. private _holes;
  143352. private _name;
  143353. private _scene;
  143354. private _epoints;
  143355. private _eholes;
  143356. private _addToepoint;
  143357. /**
  143358. * Babylon reference to the earcut plugin.
  143359. */
  143360. bjsEarcut: any;
  143361. /**
  143362. * Creates a PolygonMeshBuilder
  143363. * @param name name of the builder
  143364. * @param contours Path of the polygon
  143365. * @param scene scene to add to when creating the mesh
  143366. * @param earcutInjection can be used to inject your own earcut reference
  143367. */
  143368. constructor(name: string, contours: Path2 | Vector2[] | any, scene?: Scene, earcutInjection?: any);
  143369. /**
  143370. * Adds a whole within the polygon
  143371. * @param hole Array of points defining the hole
  143372. * @returns this
  143373. */
  143374. addHole(hole: Vector2[]): PolygonMeshBuilder;
  143375. /**
  143376. * Creates the polygon
  143377. * @param updatable If the mesh should be updatable
  143378. * @param depth The depth of the mesh created
  143379. * @returns the created mesh
  143380. */
  143381. build(updatable?: boolean, depth?: number): Mesh;
  143382. /**
  143383. * Creates the polygon
  143384. * @param depth The depth of the mesh created
  143385. * @returns the created VertexData
  143386. */
  143387. buildVertexData(depth?: number): VertexData;
  143388. /**
  143389. * Adds a side to the polygon
  143390. * @param positions points that make the polygon
  143391. * @param normals normals of the polygon
  143392. * @param uvs uvs of the polygon
  143393. * @param indices indices of the polygon
  143394. * @param bounds bounds of the polygon
  143395. * @param points points of the polygon
  143396. * @param depth depth of the polygon
  143397. * @param flip flip of the polygon
  143398. */
  143399. private addSide;
  143400. }
  143401. }
  143402. declare module BABYLON {
  143403. /**
  143404. * Class containing static functions to help procedurally build meshes
  143405. */
  143406. export class PolygonBuilder {
  143407. /**
  143408. * Creates a polygon mesh
  143409. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh
  143410. * * 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
  143411. * * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  143412. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  143413. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4)
  143414. * * Remember you can only change the shape positions, not their number when updating a polygon
  143415. * @param name defines the name of the mesh
  143416. * @param options defines the options used to create the mesh
  143417. * @param scene defines the hosting scene
  143418. * @param earcutInjection can be used to inject your own earcut reference
  143419. * @returns the polygon mesh
  143420. */
  143421. static CreatePolygon(name: string, options: {
  143422. shape: Vector3[];
  143423. holes?: Vector3[][];
  143424. depth?: number;
  143425. faceUV?: Vector4[];
  143426. faceColors?: Color4[];
  143427. updatable?: boolean;
  143428. sideOrientation?: number;
  143429. frontUVs?: Vector4;
  143430. backUVs?: Vector4;
  143431. wrap?: boolean;
  143432. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  143433. /**
  143434. * Creates an extruded polygon mesh, with depth in the Y direction.
  143435. * * 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)
  143436. * @see https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  143437. * @param name defines the name of the mesh
  143438. * @param options defines the options used to create the mesh
  143439. * @param scene defines the hosting scene
  143440. * @param earcutInjection can be used to inject your own earcut reference
  143441. * @returns the polygon mesh
  143442. */
  143443. static ExtrudePolygon(name: string, options: {
  143444. shape: Vector3[];
  143445. holes?: Vector3[][];
  143446. depth?: number;
  143447. faceUV?: Vector4[];
  143448. faceColors?: Color4[];
  143449. updatable?: boolean;
  143450. sideOrientation?: number;
  143451. frontUVs?: Vector4;
  143452. backUVs?: Vector4;
  143453. wrap?: boolean;
  143454. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  143455. }
  143456. }
  143457. declare module BABYLON {
  143458. /**
  143459. * Class containing static functions to help procedurally build meshes
  143460. */
  143461. export class LatheBuilder {
  143462. /**
  143463. * Creates lathe mesh.
  143464. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe
  143465. * * 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
  143466. * * The parameter `radius` (positive float, default 1) is the radius value of the lathe
  143467. * * The parameter `tessellation` (positive integer, default 64) is the side number of the lathe
  143468. * * The parameter `clip` (positive integer, default 0) is the number of sides to not create without effecting the general shape of the sides
  143469. * * 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
  143470. * * The parameter `closed` (boolean, default true) opens/closes the lathe circumference. This should be set to false when used with the parameter "arc"
  143471. * * 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
  143472. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  143473. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  143474. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  143475. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  143476. * @param name defines the name of the mesh
  143477. * @param options defines the options used to create the mesh
  143478. * @param scene defines the hosting scene
  143479. * @returns the lathe mesh
  143480. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lathe
  143481. */
  143482. static CreateLathe(name: string, options: {
  143483. shape: Vector3[];
  143484. radius?: number;
  143485. tessellation?: number;
  143486. clip?: number;
  143487. arc?: number;
  143488. closed?: boolean;
  143489. updatable?: boolean;
  143490. sideOrientation?: number;
  143491. frontUVs?: Vector4;
  143492. backUVs?: Vector4;
  143493. cap?: number;
  143494. invertUV?: boolean;
  143495. }, scene?: Nullable<Scene>): Mesh;
  143496. }
  143497. }
  143498. declare module BABYLON {
  143499. /**
  143500. * Class containing static functions to help procedurally build meshes
  143501. */
  143502. export class TiledPlaneBuilder {
  143503. /**
  143504. * Creates a tiled plane mesh
  143505. * * The parameter `pattern` will, depending on value, do nothing or
  143506. * * * flip (reflect about central vertical) alternate tiles across and up
  143507. * * * flip every tile on alternate rows
  143508. * * * rotate (180 degs) alternate tiles across and up
  143509. * * * rotate every tile on alternate rows
  143510. * * * flip and rotate alternate tiles across and up
  143511. * * * flip and rotate every tile on alternate rows
  143512. * * The parameter `tileSize` sets the size (float) of each tile side (default 1)
  143513. * * You can set some different tile dimensions by using the parameters `tileWidth` and `tileHeight` (both by default have the same value of `tileSize`)
  143514. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  143515. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  143516. * * 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)
  143517. * * 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)
  143518. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  143519. * @param name defines the name of the mesh
  143520. * @param options defines the options used to create the mesh
  143521. * @param scene defines the hosting scene
  143522. * @returns the box mesh
  143523. */
  143524. static CreateTiledPlane(name: string, options: {
  143525. pattern?: number;
  143526. tileSize?: number;
  143527. tileWidth?: number;
  143528. tileHeight?: number;
  143529. size?: number;
  143530. width?: number;
  143531. height?: number;
  143532. alignHorizontal?: number;
  143533. alignVertical?: number;
  143534. sideOrientation?: number;
  143535. frontUVs?: Vector4;
  143536. backUVs?: Vector4;
  143537. updatable?: boolean;
  143538. }, scene?: Nullable<Scene>): Mesh;
  143539. }
  143540. }
  143541. declare module BABYLON {
  143542. /**
  143543. * Class containing static functions to help procedurally build meshes
  143544. */
  143545. export class TubeBuilder {
  143546. /**
  143547. * Creates a tube mesh.
  143548. * The tube is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  143549. * * The parameter `path` is a required array of successive Vector3. It is the curve used as the axis of the tube
  143550. * * The parameter `radius` (positive float, default 1) sets the tube radius size
  143551. * * The parameter `tessellation` (positive float, default 64) is the number of sides on the tubular surface
  143552. * * The parameter `radiusFunction` (javascript function, default null) is a vanilla javascript function. If it is not null, it overwrittes the parameter `radius`
  143553. * * 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)
  143554. * * The parameter `arc` (positive float, maximum 1, default 1) is the ratio to apply to the tube circumference : 2 x PI x arc
  143555. * * 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
  143556. * * 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
  143557. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  143558. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  143559. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  143560. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  143561. * @param name defines the name of the mesh
  143562. * @param options defines the options used to create the mesh
  143563. * @param scene defines the hosting scene
  143564. * @returns the tube mesh
  143565. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  143566. * @see https://doc.babylonjs.com/how_to/set_shapes#tube
  143567. */
  143568. static CreateTube(name: string, options: {
  143569. path: Vector3[];
  143570. radius?: number;
  143571. tessellation?: number;
  143572. radiusFunction?: {
  143573. (i: number, distance: number): number;
  143574. };
  143575. cap?: number;
  143576. arc?: number;
  143577. updatable?: boolean;
  143578. sideOrientation?: number;
  143579. frontUVs?: Vector4;
  143580. backUVs?: Vector4;
  143581. instance?: Mesh;
  143582. invertUV?: boolean;
  143583. }, scene?: Nullable<Scene>): Mesh;
  143584. }
  143585. }
  143586. declare module BABYLON {
  143587. /**
  143588. * Class containing static functions to help procedurally build meshes
  143589. */
  143590. export class IcoSphereBuilder {
  143591. /**
  143592. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  143593. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  143594. * * 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`)
  143595. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  143596. * * 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
  143597. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  143598. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  143599. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  143600. * @param name defines the name of the mesh
  143601. * @param options defines the options used to create the mesh
  143602. * @param scene defines the hosting scene
  143603. * @returns the icosahedron mesh
  143604. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  143605. */
  143606. static CreateIcoSphere(name: string, options: {
  143607. radius?: number;
  143608. radiusX?: number;
  143609. radiusY?: number;
  143610. radiusZ?: number;
  143611. flat?: boolean;
  143612. subdivisions?: number;
  143613. sideOrientation?: number;
  143614. frontUVs?: Vector4;
  143615. backUVs?: Vector4;
  143616. updatable?: boolean;
  143617. }, scene?: Nullable<Scene>): Mesh;
  143618. }
  143619. }
  143620. declare module BABYLON {
  143621. /**
  143622. * Class containing static functions to help procedurally build meshes
  143623. */
  143624. export class DecalBuilder {
  143625. /**
  143626. * Creates a decal mesh.
  143627. * 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
  143628. * * The parameter `position` (Vector3, default `(0, 0, 0)`) sets the position of the decal in World coordinates
  143629. * * The parameter `normal` (Vector3, default `Vector3.Up`) sets the normal of the mesh where the decal is applied onto in World coordinates
  143630. * * The parameter `size` (Vector3, default `(1, 1, 1)`) sets the decal scaling
  143631. * * The parameter `angle` (float in radian, default 0) sets the angle to rotate the decal
  143632. * @param name defines the name of the mesh
  143633. * @param sourceMesh defines the mesh where the decal must be applied
  143634. * @param options defines the options used to create the mesh
  143635. * @param scene defines the hosting scene
  143636. * @returns the decal mesh
  143637. * @see https://doc.babylonjs.com/how_to/decals
  143638. */
  143639. static CreateDecal(name: string, sourceMesh: AbstractMesh, options: {
  143640. position?: Vector3;
  143641. normal?: Vector3;
  143642. size?: Vector3;
  143643. angle?: number;
  143644. }): Mesh;
  143645. }
  143646. }
  143647. declare module BABYLON {
  143648. /**
  143649. * Class containing static functions to help procedurally build meshes
  143650. */
  143651. export class MeshBuilder {
  143652. /**
  143653. * Creates a box mesh
  143654. * * The parameter `size` sets the size (float) of each box side (default 1)
  143655. * * You can set some different box dimensions by using the parameters `width`, `height` and `depth` (all by default have the same value of `size`)
  143656. * * 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)
  143657. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  143658. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  143659. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  143660. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  143661. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  143662. * @param name defines the name of the mesh
  143663. * @param options defines the options used to create the mesh
  143664. * @param scene defines the hosting scene
  143665. * @returns the box mesh
  143666. */
  143667. static CreateBox(name: string, options: {
  143668. size?: number;
  143669. width?: number;
  143670. height?: number;
  143671. depth?: number;
  143672. faceUV?: Vector4[];
  143673. faceColors?: Color4[];
  143674. sideOrientation?: number;
  143675. frontUVs?: Vector4;
  143676. backUVs?: Vector4;
  143677. wrap?: boolean;
  143678. topBaseAt?: number;
  143679. bottomBaseAt?: number;
  143680. updatable?: boolean;
  143681. }, scene?: Nullable<Scene>): Mesh;
  143682. /**
  143683. * Creates a tiled box mesh
  143684. * * faceTiles sets the pattern, tile size and number of tiles for a face
  143685. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  143686. * @param name defines the name of the mesh
  143687. * @param options defines the options used to create the mesh
  143688. * @param scene defines the hosting scene
  143689. * @returns the tiled box mesh
  143690. */
  143691. static CreateTiledBox(name: string, options: {
  143692. pattern?: number;
  143693. size?: number;
  143694. width?: number;
  143695. height?: number;
  143696. depth: number;
  143697. tileSize?: number;
  143698. tileWidth?: number;
  143699. tileHeight?: number;
  143700. faceUV?: Vector4[];
  143701. faceColors?: Color4[];
  143702. alignHorizontal?: number;
  143703. alignVertical?: number;
  143704. sideOrientation?: number;
  143705. updatable?: boolean;
  143706. }, scene?: Nullable<Scene>): Mesh;
  143707. /**
  143708. * Creates a sphere mesh
  143709. * * The parameter `diameter` sets the diameter size (float) of the sphere (default 1)
  143710. * * 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`)
  143711. * * The parameter `segments` sets the sphere number of horizontal stripes (positive integer, default 32)
  143712. * * 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
  143713. * * 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)
  143714. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  143715. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  143716. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  143717. * @param name defines the name of the mesh
  143718. * @param options defines the options used to create the mesh
  143719. * @param scene defines the hosting scene
  143720. * @returns the sphere mesh
  143721. * @see https://doc.babylonjs.com/how_to/set_shapes#sphere
  143722. */
  143723. static CreateSphere(name: string, options: {
  143724. segments?: number;
  143725. diameter?: number;
  143726. diameterX?: number;
  143727. diameterY?: number;
  143728. diameterZ?: number;
  143729. arc?: number;
  143730. slice?: number;
  143731. sideOrientation?: number;
  143732. frontUVs?: Vector4;
  143733. backUVs?: Vector4;
  143734. updatable?: boolean;
  143735. }, scene?: Nullable<Scene>): Mesh;
  143736. /**
  143737. * Creates a plane polygonal mesh. By default, this is a disc
  143738. * * The parameter `radius` sets the radius size (float) of the polygon (default 0.5)
  143739. * * 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
  143740. * * 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
  143741. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  143742. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  143743. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  143744. * @param name defines the name of the mesh
  143745. * @param options defines the options used to create the mesh
  143746. * @param scene defines the hosting scene
  143747. * @returns the plane polygonal mesh
  143748. * @see https://doc.babylonjs.com/how_to/set_shapes#disc-or-regular-polygon
  143749. */
  143750. static CreateDisc(name: string, options: {
  143751. radius?: number;
  143752. tessellation?: number;
  143753. arc?: number;
  143754. updatable?: boolean;
  143755. sideOrientation?: number;
  143756. frontUVs?: Vector4;
  143757. backUVs?: Vector4;
  143758. }, scene?: Nullable<Scene>): Mesh;
  143759. /**
  143760. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  143761. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  143762. * * 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`)
  143763. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  143764. * * 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
  143765. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  143766. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  143767. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  143768. * @param name defines the name of the mesh
  143769. * @param options defines the options used to create the mesh
  143770. * @param scene defines the hosting scene
  143771. * @returns the icosahedron mesh
  143772. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  143773. */
  143774. static CreateIcoSphere(name: string, options: {
  143775. radius?: number;
  143776. radiusX?: number;
  143777. radiusY?: number;
  143778. radiusZ?: number;
  143779. flat?: boolean;
  143780. subdivisions?: number;
  143781. sideOrientation?: number;
  143782. frontUVs?: Vector4;
  143783. backUVs?: Vector4;
  143784. updatable?: boolean;
  143785. }, scene?: Nullable<Scene>): Mesh;
  143786. /**
  143787. * Creates a ribbon mesh. The ribbon is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  143788. * * The parameter `pathArray` is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry
  143789. * * The parameter `closeArray` (boolean, default false) creates a seam between the first and the last paths of the path array
  143790. * * The parameter `closePath` (boolean, default false) creates a seam between the first and the last points of each path of the path array
  143791. * * 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
  143792. * * 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
  143793. * * 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
  143794. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  143795. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  143796. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  143797. * * 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
  143798. * * The parameters `colors` is an optional flat array of `Color4` to set/update each ribbon vertex with its own custom color values
  143799. * * 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
  143800. * * Moreover, you can use the parameter `color` with `instance` (to update the ribbon), only if you previously used it at creation time
  143801. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  143802. * @param name defines the name of the mesh
  143803. * @param options defines the options used to create the mesh
  143804. * @param scene defines the hosting scene
  143805. * @returns the ribbon mesh
  143806. * @see https://doc.babylonjs.com/how_to/ribbon_tutorial
  143807. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  143808. */
  143809. static CreateRibbon(name: string, options: {
  143810. pathArray: Vector3[][];
  143811. closeArray?: boolean;
  143812. closePath?: boolean;
  143813. offset?: number;
  143814. updatable?: boolean;
  143815. sideOrientation?: number;
  143816. frontUVs?: Vector4;
  143817. backUVs?: Vector4;
  143818. instance?: Mesh;
  143819. invertUV?: boolean;
  143820. uvs?: Vector2[];
  143821. colors?: Color4[];
  143822. }, scene?: Nullable<Scene>): Mesh;
  143823. /**
  143824. * Creates a cylinder or a cone mesh
  143825. * * The parameter `height` sets the height size (float) of the cylinder/cone (float, default 2).
  143826. * * The parameter `diameter` sets the diameter of the top and bottom cap at once (float, default 1).
  143827. * * 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.
  143828. * * The parameter `tessellation` sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance.
  143829. * * The parameter `subdivisions` sets the number of rings along the cylinder height (positive integer, default 1).
  143830. * * The parameter `hasRings` (boolean, default false) makes the subdivisions independent from each other, so they become different faces.
  143831. * * The parameter `enclose` (boolean, default false) adds two extra faces per subdivision to a sliced cylinder to close it around its height axis.
  143832. * * 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).
  143833. * * The parameter `arc` (float, default 1) is the ratio (max 1) to apply to the circumference to slice the cylinder.
  143834. * * 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).
  143835. * * 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
  143836. * * Now, if the cylinder has 5 independent subdivisions (hasRings = true), n equals : top face + 5 stripe surfaces + bottom face = 2 + 5 = 7
  143837. * * 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
  143838. * * 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.
  143839. * * If `enclose` is false, a ring surface is one element.
  143840. * * If `enclose` is true, a ring surface is 3 successive elements in the array : the tubular surface, then the two closing faces.
  143841. * * 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
  143842. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  143843. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  143844. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  143845. * @param name defines the name of the mesh
  143846. * @param options defines the options used to create the mesh
  143847. * @param scene defines the hosting scene
  143848. * @returns the cylinder mesh
  143849. * @see https://doc.babylonjs.com/how_to/set_shapes#cylinder-or-cone
  143850. */
  143851. static CreateCylinder(name: string, options: {
  143852. height?: number;
  143853. diameterTop?: number;
  143854. diameterBottom?: number;
  143855. diameter?: number;
  143856. tessellation?: number;
  143857. subdivisions?: number;
  143858. arc?: number;
  143859. faceColors?: Color4[];
  143860. faceUV?: Vector4[];
  143861. updatable?: boolean;
  143862. hasRings?: boolean;
  143863. enclose?: boolean;
  143864. cap?: number;
  143865. sideOrientation?: number;
  143866. frontUVs?: Vector4;
  143867. backUVs?: Vector4;
  143868. }, scene?: Nullable<Scene>): Mesh;
  143869. /**
  143870. * Creates a torus mesh
  143871. * * The parameter `diameter` sets the diameter size (float) of the torus (default 1)
  143872. * * The parameter `thickness` sets the diameter size of the tube of the torus (float, default 0.5)
  143873. * * The parameter `tessellation` sets the number of torus sides (postive integer, default 16)
  143874. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  143875. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  143876. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  143877. * @param name defines the name of the mesh
  143878. * @param options defines the options used to create the mesh
  143879. * @param scene defines the hosting scene
  143880. * @returns the torus mesh
  143881. * @see https://doc.babylonjs.com/how_to/set_shapes#torus
  143882. */
  143883. static CreateTorus(name: string, options: {
  143884. diameter?: number;
  143885. thickness?: number;
  143886. tessellation?: number;
  143887. updatable?: boolean;
  143888. sideOrientation?: number;
  143889. frontUVs?: Vector4;
  143890. backUVs?: Vector4;
  143891. }, scene?: Nullable<Scene>): Mesh;
  143892. /**
  143893. * Creates a torus knot mesh
  143894. * * The parameter `radius` sets the global radius size (float) of the torus knot (default 2)
  143895. * * The parameter `radialSegments` sets the number of sides on each tube segments (positive integer, default 32)
  143896. * * The parameter `tubularSegments` sets the number of tubes to decompose the knot into (positive integer, default 32)
  143897. * * The parameters `p` and `q` are the number of windings on each axis (positive integers, default 2 and 3)
  143898. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  143899. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  143900. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  143901. * @param name defines the name of the mesh
  143902. * @param options defines the options used to create the mesh
  143903. * @param scene defines the hosting scene
  143904. * @returns the torus knot mesh
  143905. * @see https://doc.babylonjs.com/how_to/set_shapes#torus-knot
  143906. */
  143907. static CreateTorusKnot(name: string, options: {
  143908. radius?: number;
  143909. tube?: number;
  143910. radialSegments?: number;
  143911. tubularSegments?: number;
  143912. p?: number;
  143913. q?: number;
  143914. updatable?: boolean;
  143915. sideOrientation?: number;
  143916. frontUVs?: Vector4;
  143917. backUVs?: Vector4;
  143918. }, scene?: Nullable<Scene>): Mesh;
  143919. /**
  143920. * Creates a line system mesh. A line system is a pool of many lines gathered in a single mesh
  143921. * * 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
  143922. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineSystem to this static function
  143923. * * The parameter `lines` is an array of lines, each line being an array of successive Vector3
  143924. * * The optional parameter `instance` is an instance of an existing LineSystem object to be updated with the passed `lines` parameter
  143925. * * The optional parameter `colors` is an array of line colors, each line colors being an array of successive Color4, one per line point
  143926. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  143927. * * 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
  143928. * * When updating an instance, remember that only line point positions can change, not the number of points, neither the number of lines
  143929. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  143930. * @see https://doc.babylonjs.com/how_to/parametric_shapes#line-system
  143931. * @param name defines the name of the new line system
  143932. * @param options defines the options used to create the line system
  143933. * @param scene defines the hosting scene
  143934. * @returns a new line system mesh
  143935. */
  143936. static CreateLineSystem(name: string, options: {
  143937. lines: Vector3[][];
  143938. updatable?: boolean;
  143939. instance?: Nullable<LinesMesh>;
  143940. colors?: Nullable<Color4[][]>;
  143941. useVertexAlpha?: boolean;
  143942. }, scene: Nullable<Scene>): LinesMesh;
  143943. /**
  143944. * Creates a line mesh
  143945. * 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
  143946. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  143947. * * The parameter `points` is an array successive Vector3
  143948. * * 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
  143949. * * The optional parameter `colors` is an array of successive Color4, one per line point
  143950. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need alpha blending (faster)
  143951. * * When updating an instance, remember that only point positions can change, not the number of points
  143952. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  143953. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lines
  143954. * @param name defines the name of the new line system
  143955. * @param options defines the options used to create the line system
  143956. * @param scene defines the hosting scene
  143957. * @returns a new line mesh
  143958. */
  143959. static CreateLines(name: string, options: {
  143960. points: Vector3[];
  143961. updatable?: boolean;
  143962. instance?: Nullable<LinesMesh>;
  143963. colors?: Color4[];
  143964. useVertexAlpha?: boolean;
  143965. }, scene?: Nullable<Scene>): LinesMesh;
  143966. /**
  143967. * Creates a dashed line mesh
  143968. * * 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
  143969. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  143970. * * The parameter `points` is an array successive Vector3
  143971. * * The parameter `dashNb` is the intended total number of dashes (positive integer, default 200)
  143972. * * The parameter `dashSize` is the size of the dashes relatively the dash number (positive float, default 3)
  143973. * * The parameter `gapSize` is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  143974. * * 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
  143975. * * When updating an instance, remember that only point positions can change, not the number of points
  143976. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  143977. * @param name defines the name of the mesh
  143978. * @param options defines the options used to create the mesh
  143979. * @param scene defines the hosting scene
  143980. * @returns the dashed line mesh
  143981. * @see https://doc.babylonjs.com/how_to/parametric_shapes#dashed-lines
  143982. */
  143983. static CreateDashedLines(name: string, options: {
  143984. points: Vector3[];
  143985. dashSize?: number;
  143986. gapSize?: number;
  143987. dashNb?: number;
  143988. updatable?: boolean;
  143989. instance?: LinesMesh;
  143990. }, scene?: Nullable<Scene>): LinesMesh;
  143991. /**
  143992. * 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.
  143993. * * 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.
  143994. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  143995. * * 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.
  143996. * * The parameter `scale` (float, default 1) is the value to scale the shape.
  143997. * * 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
  143998. * * 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
  143999. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape.
  144000. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  144001. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  144002. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture.
  144003. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  144004. * @param name defines the name of the mesh
  144005. * @param options defines the options used to create the mesh
  144006. * @param scene defines the hosting scene
  144007. * @returns the extruded shape mesh
  144008. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  144009. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  144010. */
  144011. static ExtrudeShape(name: string, options: {
  144012. shape: Vector3[];
  144013. path: Vector3[];
  144014. scale?: number;
  144015. rotation?: number;
  144016. cap?: number;
  144017. updatable?: boolean;
  144018. sideOrientation?: number;
  144019. frontUVs?: Vector4;
  144020. backUVs?: Vector4;
  144021. instance?: Mesh;
  144022. invertUV?: boolean;
  144023. }, scene?: Nullable<Scene>): Mesh;
  144024. /**
  144025. * Creates an custom extruded shape mesh.
  144026. * The custom extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
  144027. * * 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.
  144028. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  144029. * * 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
  144030. * * It must returns a float value that will be the rotation in radians applied to the shape on each path point.
  144031. * * 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
  144032. * * It must returns a float value that will be the scale value applied to the shape on each path point
  144033. * * The parameter `ribbonClosePath` (boolean, default false) forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  144034. * * The parameter `ribbonCloseArray` (boolean, default false) forces the extrusion underlying ribbon to close its `pathArray`
  144035. * * 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
  144036. * * 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
  144037. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape
  144038. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  144039. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  144040. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  144041. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  144042. * @param name defines the name of the mesh
  144043. * @param options defines the options used to create the mesh
  144044. * @param scene defines the hosting scene
  144045. * @returns the custom extruded shape mesh
  144046. * @see https://doc.babylonjs.com/how_to/parametric_shapes#custom-extruded-shapes
  144047. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  144048. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  144049. */
  144050. static ExtrudeShapeCustom(name: string, options: {
  144051. shape: Vector3[];
  144052. path: Vector3[];
  144053. scaleFunction?: any;
  144054. rotationFunction?: any;
  144055. ribbonCloseArray?: boolean;
  144056. ribbonClosePath?: boolean;
  144057. cap?: number;
  144058. updatable?: boolean;
  144059. sideOrientation?: number;
  144060. frontUVs?: Vector4;
  144061. backUVs?: Vector4;
  144062. instance?: Mesh;
  144063. invertUV?: boolean;
  144064. }, scene?: Nullable<Scene>): Mesh;
  144065. /**
  144066. * Creates lathe mesh.
  144067. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe
  144068. * * 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
  144069. * * The parameter `radius` (positive float, default 1) is the radius value of the lathe
  144070. * * The parameter `tessellation` (positive integer, default 64) is the side number of the lathe
  144071. * * The parameter `clip` (positive integer, default 0) is the number of sides to not create without effecting the general shape of the sides
  144072. * * 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
  144073. * * The parameter `closed` (boolean, default true) opens/closes the lathe circumference. This should be set to false when used with the parameter "arc"
  144074. * * 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
  144075. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  144076. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  144077. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  144078. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  144079. * @param name defines the name of the mesh
  144080. * @param options defines the options used to create the mesh
  144081. * @param scene defines the hosting scene
  144082. * @returns the lathe mesh
  144083. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lathe
  144084. */
  144085. static CreateLathe(name: string, options: {
  144086. shape: Vector3[];
  144087. radius?: number;
  144088. tessellation?: number;
  144089. clip?: number;
  144090. arc?: number;
  144091. closed?: boolean;
  144092. updatable?: boolean;
  144093. sideOrientation?: number;
  144094. frontUVs?: Vector4;
  144095. backUVs?: Vector4;
  144096. cap?: number;
  144097. invertUV?: boolean;
  144098. }, scene?: Nullable<Scene>): Mesh;
  144099. /**
  144100. * Creates a tiled plane mesh
  144101. * * You can set a limited pattern arrangement with the tiles
  144102. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  144103. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  144104. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  144105. * @param name defines the name of the mesh
  144106. * @param options defines the options used to create the mesh
  144107. * @param scene defines the hosting scene
  144108. * @returns the plane mesh
  144109. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  144110. */
  144111. static CreateTiledPlane(name: string, options: {
  144112. pattern?: number;
  144113. tileSize?: number;
  144114. tileWidth?: number;
  144115. tileHeight?: number;
  144116. size?: number;
  144117. width?: number;
  144118. height?: number;
  144119. alignHorizontal?: number;
  144120. alignVertical?: number;
  144121. sideOrientation?: number;
  144122. frontUVs?: Vector4;
  144123. backUVs?: Vector4;
  144124. updatable?: boolean;
  144125. }, scene?: Nullable<Scene>): Mesh;
  144126. /**
  144127. * Creates a plane mesh
  144128. * * The parameter `size` sets the size (float) of both sides of the plane at once (default 1)
  144129. * * You can set some different plane dimensions by using the parameters `width` and `height` (both by default have the same value of `size`)
  144130. * * The parameter `sourcePlane` is a Plane instance. It builds a mesh plane from a Math plane
  144131. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  144132. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  144133. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  144134. * @param name defines the name of the mesh
  144135. * @param options defines the options used to create the mesh
  144136. * @param scene defines the hosting scene
  144137. * @returns the plane mesh
  144138. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  144139. */
  144140. static CreatePlane(name: string, options: {
  144141. size?: number;
  144142. width?: number;
  144143. height?: number;
  144144. sideOrientation?: number;
  144145. frontUVs?: Vector4;
  144146. backUVs?: Vector4;
  144147. updatable?: boolean;
  144148. sourcePlane?: Plane;
  144149. }, scene?: Nullable<Scene>): Mesh;
  144150. /**
  144151. * Creates a ground mesh
  144152. * * The parameters `width` and `height` (floats, default 1) set the width and height sizes of the ground
  144153. * * The parameter `subdivisions` (positive integer) sets the number of subdivisions per side
  144154. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  144155. * @param name defines the name of the mesh
  144156. * @param options defines the options used to create the mesh
  144157. * @param scene defines the hosting scene
  144158. * @returns the ground mesh
  144159. * @see https://doc.babylonjs.com/how_to/set_shapes#ground
  144160. */
  144161. static CreateGround(name: string, options: {
  144162. width?: number;
  144163. height?: number;
  144164. subdivisions?: number;
  144165. subdivisionsX?: number;
  144166. subdivisionsY?: number;
  144167. updatable?: boolean;
  144168. }, scene?: Nullable<Scene>): Mesh;
  144169. /**
  144170. * Creates a tiled ground mesh
  144171. * * The parameters `xmin` and `xmax` (floats, default -1 and 1) set the ground minimum and maximum X coordinates
  144172. * * The parameters `zmin` and `zmax` (floats, default -1 and 1) set the ground minimum and maximum Z coordinates
  144173. * * 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
  144174. * * 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
  144175. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  144176. * @param name defines the name of the mesh
  144177. * @param options defines the options used to create the mesh
  144178. * @param scene defines the hosting scene
  144179. * @returns the tiled ground mesh
  144180. * @see https://doc.babylonjs.com/how_to/set_shapes#tiled-ground
  144181. */
  144182. static CreateTiledGround(name: string, options: {
  144183. xmin: number;
  144184. zmin: number;
  144185. xmax: number;
  144186. zmax: number;
  144187. subdivisions?: {
  144188. w: number;
  144189. h: number;
  144190. };
  144191. precision?: {
  144192. w: number;
  144193. h: number;
  144194. };
  144195. updatable?: boolean;
  144196. }, scene?: Nullable<Scene>): Mesh;
  144197. /**
  144198. * Creates a ground mesh from a height map
  144199. * * The parameter `url` sets the URL of the height map image resource.
  144200. * * The parameters `width` and `height` (positive floats, default 10) set the ground width and height sizes.
  144201. * * The parameter `subdivisions` (positive integer, default 1) sets the number of subdivision per side.
  144202. * * The parameter `minHeight` (float, default 0) is the minimum altitude on the ground.
  144203. * * The parameter `maxHeight` (float, default 1) is the maximum altitude on the ground.
  144204. * * 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.
  144205. * * 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).
  144206. * * The parameter `alphaFilter` will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  144207. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  144208. * @param name defines the name of the mesh
  144209. * @param url defines the url to the height map
  144210. * @param options defines the options used to create the mesh
  144211. * @param scene defines the hosting scene
  144212. * @returns the ground mesh
  144213. * @see https://doc.babylonjs.com/babylon101/height_map
  144214. * @see https://doc.babylonjs.com/how_to/set_shapes#ground-from-a-height-map
  144215. */
  144216. static CreateGroundFromHeightMap(name: string, url: string, options: {
  144217. width?: number;
  144218. height?: number;
  144219. subdivisions?: number;
  144220. minHeight?: number;
  144221. maxHeight?: number;
  144222. colorFilter?: Color3;
  144223. alphaFilter?: number;
  144224. updatable?: boolean;
  144225. onReady?: (mesh: GroundMesh) => void;
  144226. }, scene?: Nullable<Scene>): GroundMesh;
  144227. /**
  144228. * Creates a polygon mesh
  144229. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh
  144230. * * 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
  144231. * * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  144232. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  144233. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4)
  144234. * * Remember you can only change the shape positions, not their number when updating a polygon
  144235. * @param name defines the name of the mesh
  144236. * @param options defines the options used to create the mesh
  144237. * @param scene defines the hosting scene
  144238. * @param earcutInjection can be used to inject your own earcut reference
  144239. * @returns the polygon mesh
  144240. */
  144241. static CreatePolygon(name: string, options: {
  144242. shape: Vector3[];
  144243. holes?: Vector3[][];
  144244. depth?: number;
  144245. faceUV?: Vector4[];
  144246. faceColors?: Color4[];
  144247. updatable?: boolean;
  144248. sideOrientation?: number;
  144249. frontUVs?: Vector4;
  144250. backUVs?: Vector4;
  144251. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  144252. /**
  144253. * Creates an extruded polygon mesh, with depth in the Y direction.
  144254. * * 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)
  144255. * @see https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  144256. * @param name defines the name of the mesh
  144257. * @param options defines the options used to create the mesh
  144258. * @param scene defines the hosting scene
  144259. * @param earcutInjection can be used to inject your own earcut reference
  144260. * @returns the polygon mesh
  144261. */
  144262. static ExtrudePolygon(name: string, options: {
  144263. shape: Vector3[];
  144264. holes?: Vector3[][];
  144265. depth?: number;
  144266. faceUV?: Vector4[];
  144267. faceColors?: Color4[];
  144268. updatable?: boolean;
  144269. sideOrientation?: number;
  144270. frontUVs?: Vector4;
  144271. backUVs?: Vector4;
  144272. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  144273. /**
  144274. * Creates a tube mesh.
  144275. * The tube is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  144276. * * The parameter `path` is a required array of successive Vector3. It is the curve used as the axis of the tube
  144277. * * The parameter `radius` (positive float, default 1) sets the tube radius size
  144278. * * The parameter `tessellation` (positive float, default 64) is the number of sides on the tubular surface
  144279. * * The parameter `radiusFunction` (javascript function, default null) is a vanilla javascript function. If it is not null, it overwrittes the parameter `radius`
  144280. * * 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)
  144281. * * The parameter `arc` (positive float, maximum 1, default 1) is the ratio to apply to the tube circumference : 2 x PI x arc
  144282. * * 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
  144283. * * 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
  144284. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  144285. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  144286. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  144287. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  144288. * @param name defines the name of the mesh
  144289. * @param options defines the options used to create the mesh
  144290. * @param scene defines the hosting scene
  144291. * @returns the tube mesh
  144292. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  144293. * @see https://doc.babylonjs.com/how_to/set_shapes#tube
  144294. */
  144295. static CreateTube(name: string, options: {
  144296. path: Vector3[];
  144297. radius?: number;
  144298. tessellation?: number;
  144299. radiusFunction?: {
  144300. (i: number, distance: number): number;
  144301. };
  144302. cap?: number;
  144303. arc?: number;
  144304. updatable?: boolean;
  144305. sideOrientation?: number;
  144306. frontUVs?: Vector4;
  144307. backUVs?: Vector4;
  144308. instance?: Mesh;
  144309. invertUV?: boolean;
  144310. }, scene?: Nullable<Scene>): Mesh;
  144311. /**
  144312. * Creates a polyhedron mesh
  144313. * * 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
  144314. * * The parameter `size` (positive float, default 1) sets the polygon size
  144315. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  144316. * * 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`
  144317. * * 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
  144318. * * 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)`)
  144319. * * 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
  144320. * * 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
  144321. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  144322. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  144323. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  144324. * @param name defines the name of the mesh
  144325. * @param options defines the options used to create the mesh
  144326. * @param scene defines the hosting scene
  144327. * @returns the polyhedron mesh
  144328. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes
  144329. */
  144330. static CreatePolyhedron(name: string, options: {
  144331. type?: number;
  144332. size?: number;
  144333. sizeX?: number;
  144334. sizeY?: number;
  144335. sizeZ?: number;
  144336. custom?: any;
  144337. faceUV?: Vector4[];
  144338. faceColors?: Color4[];
  144339. flat?: boolean;
  144340. updatable?: boolean;
  144341. sideOrientation?: number;
  144342. frontUVs?: Vector4;
  144343. backUVs?: Vector4;
  144344. }, scene?: Nullable<Scene>): Mesh;
  144345. /**
  144346. * Creates a decal mesh.
  144347. * 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
  144348. * * The parameter `position` (Vector3, default `(0, 0, 0)`) sets the position of the decal in World coordinates
  144349. * * The parameter `normal` (Vector3, default `Vector3.Up`) sets the normal of the mesh where the decal is applied onto in World coordinates
  144350. * * The parameter `size` (Vector3, default `(1, 1, 1)`) sets the decal scaling
  144351. * * The parameter `angle` (float in radian, default 0) sets the angle to rotate the decal
  144352. * @param name defines the name of the mesh
  144353. * @param sourceMesh defines the mesh where the decal must be applied
  144354. * @param options defines the options used to create the mesh
  144355. * @param scene defines the hosting scene
  144356. * @returns the decal mesh
  144357. * @see https://doc.babylonjs.com/how_to/decals
  144358. */
  144359. static CreateDecal(name: string, sourceMesh: AbstractMesh, options: {
  144360. position?: Vector3;
  144361. normal?: Vector3;
  144362. size?: Vector3;
  144363. angle?: number;
  144364. }): Mesh;
  144365. }
  144366. }
  144367. declare module BABYLON {
  144368. /**
  144369. * A simplifier interface for future simplification implementations
  144370. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  144371. */
  144372. export interface ISimplifier {
  144373. /**
  144374. * Simplification of a given mesh according to the given settings.
  144375. * Since this requires computation, it is assumed that the function runs async.
  144376. * @param settings The settings of the simplification, including quality and distance
  144377. * @param successCallback A callback that will be called after the mesh was simplified.
  144378. * @param errorCallback in case of an error, this callback will be called. optional.
  144379. */
  144380. simplify(settings: ISimplificationSettings, successCallback: (simplifiedMeshes: Mesh) => void, errorCallback?: () => void): void;
  144381. }
  144382. /**
  144383. * Expected simplification settings.
  144384. * Quality should be between 0 and 1 (1 being 100%, 0 being 0%)
  144385. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  144386. */
  144387. export interface ISimplificationSettings {
  144388. /**
  144389. * Gets or sets the expected quality
  144390. */
  144391. quality: number;
  144392. /**
  144393. * Gets or sets the distance when this optimized version should be used
  144394. */
  144395. distance: number;
  144396. /**
  144397. * Gets an already optimized mesh
  144398. */
  144399. optimizeMesh?: boolean;
  144400. }
  144401. /**
  144402. * Class used to specify simplification options
  144403. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  144404. */
  144405. export class SimplificationSettings implements ISimplificationSettings {
  144406. /** expected quality */
  144407. quality: number;
  144408. /** distance when this optimized version should be used */
  144409. distance: number;
  144410. /** already optimized mesh */
  144411. optimizeMesh?: boolean | undefined;
  144412. /**
  144413. * Creates a SimplificationSettings
  144414. * @param quality expected quality
  144415. * @param distance distance when this optimized version should be used
  144416. * @param optimizeMesh already optimized mesh
  144417. */
  144418. constructor(
  144419. /** expected quality */
  144420. quality: number,
  144421. /** distance when this optimized version should be used */
  144422. distance: number,
  144423. /** already optimized mesh */
  144424. optimizeMesh?: boolean | undefined);
  144425. }
  144426. /**
  144427. * Interface used to define a simplification task
  144428. */
  144429. export interface ISimplificationTask {
  144430. /**
  144431. * Array of settings
  144432. */
  144433. settings: Array<ISimplificationSettings>;
  144434. /**
  144435. * Simplification type
  144436. */
  144437. simplificationType: SimplificationType;
  144438. /**
  144439. * Mesh to simplify
  144440. */
  144441. mesh: Mesh;
  144442. /**
  144443. * Callback called on success
  144444. */
  144445. successCallback?: () => void;
  144446. /**
  144447. * Defines if parallel processing can be used
  144448. */
  144449. parallelProcessing: boolean;
  144450. }
  144451. /**
  144452. * Queue used to order the simplification tasks
  144453. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  144454. */
  144455. export class SimplificationQueue {
  144456. private _simplificationArray;
  144457. /**
  144458. * Gets a boolean indicating that the process is still running
  144459. */
  144460. running: boolean;
  144461. /**
  144462. * Creates a new queue
  144463. */
  144464. constructor();
  144465. /**
  144466. * Adds a new simplification task
  144467. * @param task defines a task to add
  144468. */
  144469. addTask(task: ISimplificationTask): void;
  144470. /**
  144471. * Execute next task
  144472. */
  144473. executeNext(): void;
  144474. /**
  144475. * Execute a simplification task
  144476. * @param task defines the task to run
  144477. */
  144478. runSimplification(task: ISimplificationTask): void;
  144479. private getSimplifier;
  144480. }
  144481. /**
  144482. * The implemented types of simplification
  144483. * At the moment only Quadratic Error Decimation is implemented
  144484. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  144485. */
  144486. export enum SimplificationType {
  144487. /** Quadratic error decimation */
  144488. QUADRATIC = 0
  144489. }
  144490. /**
  144491. * An implementation of the Quadratic Error simplification algorithm.
  144492. * Original paper : http://www1.cs.columbia.edu/~cs4162/html05s/garland97.pdf
  144493. * Ported mostly from QSlim and http://voxels.blogspot.de/2014/05/quadric-mesh-simplification-with-source.html to babylon JS
  144494. * @author RaananW
  144495. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  144496. */
  144497. export class QuadraticErrorSimplification implements ISimplifier {
  144498. private _mesh;
  144499. private triangles;
  144500. private vertices;
  144501. private references;
  144502. private _reconstructedMesh;
  144503. /** Gets or sets the number pf sync interations */
  144504. syncIterations: number;
  144505. /** Gets or sets the aggressiveness of the simplifier */
  144506. aggressiveness: number;
  144507. /** Gets or sets the number of allowed iterations for decimation */
  144508. decimationIterations: number;
  144509. /** Gets or sets the espilon to use for bounding box computation */
  144510. boundingBoxEpsilon: number;
  144511. /**
  144512. * Creates a new QuadraticErrorSimplification
  144513. * @param _mesh defines the target mesh
  144514. */
  144515. constructor(_mesh: Mesh);
  144516. /**
  144517. * Simplification of a given mesh according to the given settings.
  144518. * Since this requires computation, it is assumed that the function runs async.
  144519. * @param settings The settings of the simplification, including quality and distance
  144520. * @param successCallback A callback that will be called after the mesh was simplified.
  144521. */
  144522. simplify(settings: ISimplificationSettings, successCallback: (simplifiedMesh: Mesh) => void): void;
  144523. private runDecimation;
  144524. private initWithMesh;
  144525. private init;
  144526. private reconstructMesh;
  144527. private initDecimatedMesh;
  144528. private isFlipped;
  144529. private updateTriangles;
  144530. private identifyBorder;
  144531. private updateMesh;
  144532. private vertexError;
  144533. private calculateError;
  144534. }
  144535. }
  144536. declare module BABYLON {
  144537. interface Scene {
  144538. /** @hidden (Backing field) */
  144539. _simplificationQueue: SimplificationQueue;
  144540. /**
  144541. * Gets or sets the simplification queue attached to the scene
  144542. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  144543. */
  144544. simplificationQueue: SimplificationQueue;
  144545. }
  144546. interface Mesh {
  144547. /**
  144548. * Simplify the mesh according to the given array of settings.
  144549. * Function will return immediately and will simplify async
  144550. * @param settings a collection of simplification settings
  144551. * @param parallelProcessing should all levels calculate parallel or one after the other
  144552. * @param simplificationType the type of simplification to run
  144553. * @param successCallback optional success callback to be called after the simplification finished processing all settings
  144554. * @returns the current mesh
  144555. */
  144556. simplify(settings: Array<ISimplificationSettings>, parallelProcessing?: boolean, simplificationType?: SimplificationType, successCallback?: (mesh?: Mesh, submeshIndex?: number) => void): Mesh;
  144557. }
  144558. /**
  144559. * Defines the simplification queue scene component responsible to help scheduling the various simplification task
  144560. * created in a scene
  144561. */
  144562. export class SimplicationQueueSceneComponent implements ISceneComponent {
  144563. /**
  144564. * The component name helpfull to identify the component in the list of scene components.
  144565. */
  144566. readonly name: string;
  144567. /**
  144568. * The scene the component belongs to.
  144569. */
  144570. scene: Scene;
  144571. /**
  144572. * Creates a new instance of the component for the given scene
  144573. * @param scene Defines the scene to register the component in
  144574. */
  144575. constructor(scene: Scene);
  144576. /**
  144577. * Registers the component in a given scene
  144578. */
  144579. register(): void;
  144580. /**
  144581. * Rebuilds the elements related to this component in case of
  144582. * context lost for instance.
  144583. */
  144584. rebuild(): void;
  144585. /**
  144586. * Disposes the component and the associated ressources
  144587. */
  144588. dispose(): void;
  144589. private _beforeCameraUpdate;
  144590. }
  144591. }
  144592. declare module BABYLON {
  144593. interface Mesh {
  144594. /**
  144595. * Creates a new thin instance
  144596. * @param matrix the matrix or array of matrices (position, rotation, scale) of the thin instance(s) to create
  144597. * @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
  144598. * @returns the thin instance index number. If you pass an array of matrices, other instance indexes are index+1, index+2, etc
  144599. */
  144600. thinInstanceAdd(matrix: DeepImmutableObject<Matrix> | Array<DeepImmutableObject<Matrix>>, refresh: boolean): number;
  144601. /**
  144602. * Adds the transformation (matrix) of the current mesh as a thin instance
  144603. * @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
  144604. * @returns the thin instance index number
  144605. */
  144606. thinInstanceAddSelf(refresh: boolean): number;
  144607. /**
  144608. * Registers a custom attribute to be used with thin instances
  144609. * @param kind name of the attribute
  144610. * @param stride size in floats of the attribute
  144611. */
  144612. thinInstanceRegisterAttribute(kind: string, stride: number): void;
  144613. /**
  144614. * Sets the matrix of a thin instance
  144615. * @param index index of the thin instance
  144616. * @param matrix matrix to set
  144617. * @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
  144618. */
  144619. thinInstanceSetMatrixAt(index: number, matrix: DeepImmutableObject<Matrix>, refresh: boolean): void;
  144620. /**
  144621. * Sets the value of a custom attribute for a thin instance
  144622. * @param kind name of the attribute
  144623. * @param index index of the thin instance
  144624. * @param value value to set
  144625. * @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
  144626. */
  144627. thinInstanceSetAttributeAt(kind: string, index: number, value: Array<number>, refresh: boolean): void;
  144628. /**
  144629. * 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.
  144630. */
  144631. thinInstanceCount: number;
  144632. /**
  144633. * Sets a buffer to be used with thin instances. This method is a faster way to setup multiple instances than calling thinInstanceAdd repeatedly
  144634. * @param kind name of the attribute. Use "matrix" to setup the buffer of matrices
  144635. * @param buffer buffer to set
  144636. * @param stride size in floats of each value of the buffer
  144637. * @param staticBuffer indicates that the buffer is static, so that you won't change it after it is set (better performances - false by default)
  144638. */
  144639. thinInstanceSetBuffer(kind: string, buffer: Nullable<Float32Array>, stride: number, staticBuffer: boolean): void;
  144640. /**
  144641. * Synchronize the gpu buffers with a thin instance buffer. Call this method if you update later on the buffers passed to thinInstanceSetBuffer
  144642. * @param kind name of the attribute to update. Use "matrix" to update the buffer of matrices
  144643. */
  144644. thinInstanceBufferUpdated(kind: string): void;
  144645. /**
  144646. * Refreshes the bounding info, taking into account all the thin instances defined
  144647. * @param forceRefreshParentInfo true to force recomputing the mesh bounding info and use it to compute the aggregated bounding info
  144648. */
  144649. thinInstanceRefreshBoundingInfo(forceRefreshParentInfo: boolean): void;
  144650. /** @hidden */
  144651. _thinInstanceInitializeUserStorage(): void;
  144652. /** @hidden */
  144653. _thinInstanceUpdateBufferSize(kind: string, numInstances: number): void;
  144654. /** @hidden */
  144655. _userThinInstanceBuffersStorage: {
  144656. data: {
  144657. [key: string]: Float32Array;
  144658. };
  144659. sizes: {
  144660. [key: string]: number;
  144661. };
  144662. vertexBuffers: {
  144663. [key: string]: Nullable<VertexBuffer>;
  144664. };
  144665. strides: {
  144666. [key: string]: number;
  144667. };
  144668. };
  144669. }
  144670. }
  144671. declare module BABYLON {
  144672. /**
  144673. * Navigation plugin interface to add navigation constrained by a navigation mesh
  144674. */
  144675. export interface INavigationEnginePlugin {
  144676. /**
  144677. * plugin name
  144678. */
  144679. name: string;
  144680. /**
  144681. * Creates a navigation mesh
  144682. * @param meshes array of all the geometry used to compute the navigatio mesh
  144683. * @param parameters bunch of parameters used to filter geometry
  144684. */
  144685. createNavMesh(meshes: Array<Mesh>, parameters: INavMeshParameters): void;
  144686. /**
  144687. * Create a navigation mesh debug mesh
  144688. * @param scene is where the mesh will be added
  144689. * @returns debug display mesh
  144690. */
  144691. createDebugNavMesh(scene: Scene): Mesh;
  144692. /**
  144693. * Get a navigation mesh constrained position, closest to the parameter position
  144694. * @param position world position
  144695. * @returns the closest point to position constrained by the navigation mesh
  144696. */
  144697. getClosestPoint(position: Vector3): Vector3;
  144698. /**
  144699. * Get a navigation mesh constrained position, closest to the parameter position
  144700. * @param position world position
  144701. * @param result output the closest point to position constrained by the navigation mesh
  144702. */
  144703. getClosestPointToRef(position: Vector3, result: Vector3): void;
  144704. /**
  144705. * Get a navigation mesh constrained position, within a particular radius
  144706. * @param position world position
  144707. * @param maxRadius the maximum distance to the constrained world position
  144708. * @returns the closest point to position constrained by the navigation mesh
  144709. */
  144710. getRandomPointAround(position: Vector3, maxRadius: number): Vector3;
  144711. /**
  144712. * Get a navigation mesh constrained position, within a particular radius
  144713. * @param position world position
  144714. * @param maxRadius the maximum distance to the constrained world position
  144715. * @param result output the closest point to position constrained by the navigation mesh
  144716. */
  144717. getRandomPointAroundToRef(position: Vector3, maxRadius: number, result: Vector3): void;
  144718. /**
  144719. * Compute the final position from a segment made of destination-position
  144720. * @param position world position
  144721. * @param destination world position
  144722. * @returns the resulting point along the navmesh
  144723. */
  144724. moveAlong(position: Vector3, destination: Vector3): Vector3;
  144725. /**
  144726. * Compute the final position from a segment made of destination-position
  144727. * @param position world position
  144728. * @param destination world position
  144729. * @param result output the resulting point along the navmesh
  144730. */
  144731. moveAlongToRef(position: Vector3, destination: Vector3, result: Vector3): void;
  144732. /**
  144733. * Compute a navigation path from start to end. Returns an empty array if no path can be computed
  144734. * @param start world position
  144735. * @param end world position
  144736. * @returns array containing world position composing the path
  144737. */
  144738. computePath(start: Vector3, end: Vector3): Vector3[];
  144739. /**
  144740. * If this plugin is supported
  144741. * @returns true if plugin is supported
  144742. */
  144743. isSupported(): boolean;
  144744. /**
  144745. * Create a new Crowd so you can add agents
  144746. * @param maxAgents the maximum agent count in the crowd
  144747. * @param maxAgentRadius the maximum radius an agent can have
  144748. * @param scene to attach the crowd to
  144749. * @returns the crowd you can add agents to
  144750. */
  144751. createCrowd(maxAgents: number, maxAgentRadius: number, scene: Scene): ICrowd;
  144752. /**
  144753. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  144754. * The queries will try to find a solution within those bounds
  144755. * default is (1,1,1)
  144756. * @param extent x,y,z value that define the extent around the queries point of reference
  144757. */
  144758. setDefaultQueryExtent(extent: Vector3): void;
  144759. /**
  144760. * Get the Bounding box extent specified by setDefaultQueryExtent
  144761. * @returns the box extent values
  144762. */
  144763. getDefaultQueryExtent(): Vector3;
  144764. /**
  144765. * build the navmesh from a previously saved state using getNavmeshData
  144766. * @param data the Uint8Array returned by getNavmeshData
  144767. */
  144768. buildFromNavmeshData(data: Uint8Array): void;
  144769. /**
  144770. * returns the navmesh data that can be used later. The navmesh must be built before retrieving the data
  144771. * @returns data the Uint8Array that can be saved and reused
  144772. */
  144773. getNavmeshData(): Uint8Array;
  144774. /**
  144775. * Get the Bounding box extent result specified by setDefaultQueryExtent
  144776. * @param result output the box extent values
  144777. */
  144778. getDefaultQueryExtentToRef(result: Vector3): void;
  144779. /**
  144780. * Release all resources
  144781. */
  144782. dispose(): void;
  144783. }
  144784. /**
  144785. * Crowd Interface. A Crowd is a collection of moving agents constrained by a navigation mesh
  144786. */
  144787. export interface ICrowd {
  144788. /**
  144789. * Add a new agent to the crowd with the specified parameter a corresponding transformNode.
  144790. * You can attach anything to that node. The node position is updated in the scene update tick.
  144791. * @param pos world position that will be constrained by the navigation mesh
  144792. * @param parameters agent parameters
  144793. * @param transform hooked to the agent that will be update by the scene
  144794. * @returns agent index
  144795. */
  144796. addAgent(pos: Vector3, parameters: IAgentParameters, transform: TransformNode): number;
  144797. /**
  144798. * Returns the agent position in world space
  144799. * @param index agent index returned by addAgent
  144800. * @returns world space position
  144801. */
  144802. getAgentPosition(index: number): Vector3;
  144803. /**
  144804. * Gets the agent position result in world space
  144805. * @param index agent index returned by addAgent
  144806. * @param result output world space position
  144807. */
  144808. getAgentPositionToRef(index: number, result: Vector3): void;
  144809. /**
  144810. * Gets the agent velocity in world space
  144811. * @param index agent index returned by addAgent
  144812. * @returns world space velocity
  144813. */
  144814. getAgentVelocity(index: number): Vector3;
  144815. /**
  144816. * Gets the agent velocity result in world space
  144817. * @param index agent index returned by addAgent
  144818. * @param result output world space velocity
  144819. */
  144820. getAgentVelocityToRef(index: number, result: Vector3): void;
  144821. /**
  144822. * remove a particular agent previously created
  144823. * @param index agent index returned by addAgent
  144824. */
  144825. removeAgent(index: number): void;
  144826. /**
  144827. * get the list of all agents attached to this crowd
  144828. * @returns list of agent indices
  144829. */
  144830. getAgents(): number[];
  144831. /**
  144832. * Tick update done by the Scene. Agent position/velocity/acceleration is updated by this function
  144833. * @param deltaTime in seconds
  144834. */
  144835. update(deltaTime: number): void;
  144836. /**
  144837. * Asks a particular agent to go to a destination. That destination is constrained by the navigation mesh
  144838. * @param index agent index returned by addAgent
  144839. * @param destination targeted world position
  144840. */
  144841. agentGoto(index: number, destination: Vector3): void;
  144842. /**
  144843. * Teleport the agent to a new position
  144844. * @param index agent index returned by addAgent
  144845. * @param destination targeted world position
  144846. */
  144847. agentTeleport(index: number, destination: Vector3): void;
  144848. /**
  144849. * Update agent parameters
  144850. * @param index agent index returned by addAgent
  144851. * @param parameters agent parameters
  144852. */
  144853. updateAgentParameters(index: number, parameters: IAgentParameters): void;
  144854. /**
  144855. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  144856. * The queries will try to find a solution within those bounds
  144857. * default is (1,1,1)
  144858. * @param extent x,y,z value that define the extent around the queries point of reference
  144859. */
  144860. setDefaultQueryExtent(extent: Vector3): void;
  144861. /**
  144862. * Get the Bounding box extent specified by setDefaultQueryExtent
  144863. * @returns the box extent values
  144864. */
  144865. getDefaultQueryExtent(): Vector3;
  144866. /**
  144867. * Get the Bounding box extent result specified by setDefaultQueryExtent
  144868. * @param result output the box extent values
  144869. */
  144870. getDefaultQueryExtentToRef(result: Vector3): void;
  144871. /**
  144872. * Release all resources
  144873. */
  144874. dispose(): void;
  144875. }
  144876. /**
  144877. * Configures an agent
  144878. */
  144879. export interface IAgentParameters {
  144880. /**
  144881. * Agent radius. [Limit: >= 0]
  144882. */
  144883. radius: number;
  144884. /**
  144885. * Agent height. [Limit: > 0]
  144886. */
  144887. height: number;
  144888. /**
  144889. * Maximum allowed acceleration. [Limit: >= 0]
  144890. */
  144891. maxAcceleration: number;
  144892. /**
  144893. * Maximum allowed speed. [Limit: >= 0]
  144894. */
  144895. maxSpeed: number;
  144896. /**
  144897. * Defines how close a collision element must be before it is considered for steering behaviors. [Limits: > 0]
  144898. */
  144899. collisionQueryRange: number;
  144900. /**
  144901. * The path visibility optimization range. [Limit: > 0]
  144902. */
  144903. pathOptimizationRange: number;
  144904. /**
  144905. * How aggresive the agent manager should be at avoiding collisions with this agent. [Limit: >= 0]
  144906. */
  144907. separationWeight: number;
  144908. }
  144909. /**
  144910. * Configures the navigation mesh creation
  144911. */
  144912. export interface INavMeshParameters {
  144913. /**
  144914. * The xz-plane cell size to use for fields. [Limit: > 0] [Units: wu]
  144915. */
  144916. cs: number;
  144917. /**
  144918. * The y-axis cell size to use for fields. [Limit: > 0] [Units: wu]
  144919. */
  144920. ch: number;
  144921. /**
  144922. * The maximum slope that is considered walkable. [Limits: 0 <= value < 90] [Units: Degrees]
  144923. */
  144924. walkableSlopeAngle: number;
  144925. /**
  144926. * Minimum floor to 'ceiling' height that will still allow the floor area to
  144927. * be considered walkable. [Limit: >= 3] [Units: vx]
  144928. */
  144929. walkableHeight: number;
  144930. /**
  144931. * Maximum ledge height that is considered to still be traversable. [Limit: >=0] [Units: vx]
  144932. */
  144933. walkableClimb: number;
  144934. /**
  144935. * The distance to erode/shrink the walkable area of the heightfield away from
  144936. * obstructions. [Limit: >=0] [Units: vx]
  144937. */
  144938. walkableRadius: number;
  144939. /**
  144940. * The maximum allowed length for contour edges along the border of the mesh. [Limit: >=0] [Units: vx]
  144941. */
  144942. maxEdgeLen: number;
  144943. /**
  144944. * The maximum distance a simplfied contour's border edges should deviate
  144945. * the original raw contour. [Limit: >=0] [Units: vx]
  144946. */
  144947. maxSimplificationError: number;
  144948. /**
  144949. * The minimum number of cells allowed to form isolated island areas. [Limit: >=0] [Units: vx]
  144950. */
  144951. minRegionArea: number;
  144952. /**
  144953. * Any regions with a span count smaller than this value will, if possible,
  144954. * be merged with larger regions. [Limit: >=0] [Units: vx]
  144955. */
  144956. mergeRegionArea: number;
  144957. /**
  144958. * The maximum number of vertices allowed for polygons generated during the
  144959. * contour to polygon conversion process. [Limit: >= 3]
  144960. */
  144961. maxVertsPerPoly: number;
  144962. /**
  144963. * Sets the sampling distance to use when generating the detail mesh.
  144964. * (For height detail only.) [Limits: 0 or >= 0.9] [Units: wu]
  144965. */
  144966. detailSampleDist: number;
  144967. /**
  144968. * The maximum distance the detail mesh surface should deviate from heightfield
  144969. * data. (For height detail only.) [Limit: >=0] [Units: wu]
  144970. */
  144971. detailSampleMaxError: number;
  144972. }
  144973. }
  144974. declare module BABYLON {
  144975. /**
  144976. * RecastJS navigation plugin
  144977. */
  144978. export class RecastJSPlugin implements INavigationEnginePlugin {
  144979. /**
  144980. * Reference to the Recast library
  144981. */
  144982. bjsRECAST: any;
  144983. /**
  144984. * plugin name
  144985. */
  144986. name: string;
  144987. /**
  144988. * the first navmesh created. We might extend this to support multiple navmeshes
  144989. */
  144990. navMesh: any;
  144991. /**
  144992. * Initializes the recastJS plugin
  144993. * @param recastInjection can be used to inject your own recast reference
  144994. */
  144995. constructor(recastInjection?: any);
  144996. /**
  144997. * Creates a navigation mesh
  144998. * @param meshes array of all the geometry used to compute the navigatio mesh
  144999. * @param parameters bunch of parameters used to filter geometry
  145000. */
  145001. createNavMesh(meshes: Array<Mesh>, parameters: INavMeshParameters): void;
  145002. /**
  145003. * Create a navigation mesh debug mesh
  145004. * @param scene is where the mesh will be added
  145005. * @returns debug display mesh
  145006. */
  145007. createDebugNavMesh(scene: Scene): Mesh;
  145008. /**
  145009. * Get a navigation mesh constrained position, closest to the parameter position
  145010. * @param position world position
  145011. * @returns the closest point to position constrained by the navigation mesh
  145012. */
  145013. getClosestPoint(position: Vector3): Vector3;
  145014. /**
  145015. * Get a navigation mesh constrained position, closest to the parameter position
  145016. * @param position world position
  145017. * @param result output the closest point to position constrained by the navigation mesh
  145018. */
  145019. getClosestPointToRef(position: Vector3, result: Vector3): void;
  145020. /**
  145021. * Get a navigation mesh constrained position, within a particular radius
  145022. * @param position world position
  145023. * @param maxRadius the maximum distance to the constrained world position
  145024. * @returns the closest point to position constrained by the navigation mesh
  145025. */
  145026. getRandomPointAround(position: Vector3, maxRadius: number): Vector3;
  145027. /**
  145028. * Get a navigation mesh constrained position, within a particular radius
  145029. * @param position world position
  145030. * @param maxRadius the maximum distance to the constrained world position
  145031. * @param result output the closest point to position constrained by the navigation mesh
  145032. */
  145033. getRandomPointAroundToRef(position: Vector3, maxRadius: number, result: Vector3): void;
  145034. /**
  145035. * Compute the final position from a segment made of destination-position
  145036. * @param position world position
  145037. * @param destination world position
  145038. * @returns the resulting point along the navmesh
  145039. */
  145040. moveAlong(position: Vector3, destination: Vector3): Vector3;
  145041. /**
  145042. * Compute the final position from a segment made of destination-position
  145043. * @param position world position
  145044. * @param destination world position
  145045. * @param result output the resulting point along the navmesh
  145046. */
  145047. moveAlongToRef(position: Vector3, destination: Vector3, result: Vector3): void;
  145048. /**
  145049. * Compute a navigation path from start to end. Returns an empty array if no path can be computed
  145050. * @param start world position
  145051. * @param end world position
  145052. * @returns array containing world position composing the path
  145053. */
  145054. computePath(start: Vector3, end: Vector3): Vector3[];
  145055. /**
  145056. * Create a new Crowd so you can add agents
  145057. * @param maxAgents the maximum agent count in the crowd
  145058. * @param maxAgentRadius the maximum radius an agent can have
  145059. * @param scene to attach the crowd to
  145060. * @returns the crowd you can add agents to
  145061. */
  145062. createCrowd(maxAgents: number, maxAgentRadius: number, scene: Scene): ICrowd;
  145063. /**
  145064. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  145065. * The queries will try to find a solution within those bounds
  145066. * default is (1,1,1)
  145067. * @param extent x,y,z value that define the extent around the queries point of reference
  145068. */
  145069. setDefaultQueryExtent(extent: Vector3): void;
  145070. /**
  145071. * Get the Bounding box extent specified by setDefaultQueryExtent
  145072. * @returns the box extent values
  145073. */
  145074. getDefaultQueryExtent(): Vector3;
  145075. /**
  145076. * build the navmesh from a previously saved state using getNavmeshData
  145077. * @param data the Uint8Array returned by getNavmeshData
  145078. */
  145079. buildFromNavmeshData(data: Uint8Array): void;
  145080. /**
  145081. * returns the navmesh data that can be used later. The navmesh must be built before retrieving the data
  145082. * @returns data the Uint8Array that can be saved and reused
  145083. */
  145084. getNavmeshData(): Uint8Array;
  145085. /**
  145086. * Get the Bounding box extent result specified by setDefaultQueryExtent
  145087. * @param result output the box extent values
  145088. */
  145089. getDefaultQueryExtentToRef(result: Vector3): void;
  145090. /**
  145091. * Disposes
  145092. */
  145093. dispose(): void;
  145094. /**
  145095. * If this plugin is supported
  145096. * @returns true if plugin is supported
  145097. */
  145098. isSupported(): boolean;
  145099. }
  145100. /**
  145101. * Recast detour crowd implementation
  145102. */
  145103. export class RecastJSCrowd implements ICrowd {
  145104. /**
  145105. * Recast/detour plugin
  145106. */
  145107. bjsRECASTPlugin: RecastJSPlugin;
  145108. /**
  145109. * Link to the detour crowd
  145110. */
  145111. recastCrowd: any;
  145112. /**
  145113. * One transform per agent
  145114. */
  145115. transforms: TransformNode[];
  145116. /**
  145117. * All agents created
  145118. */
  145119. agents: number[];
  145120. /**
  145121. * Link to the scene is kept to unregister the crowd from the scene
  145122. */
  145123. private _scene;
  145124. /**
  145125. * Observer for crowd updates
  145126. */
  145127. private _onBeforeAnimationsObserver;
  145128. /**
  145129. * Constructor
  145130. * @param plugin recastJS plugin
  145131. * @param maxAgents the maximum agent count in the crowd
  145132. * @param maxAgentRadius the maximum radius an agent can have
  145133. * @param scene to attach the crowd to
  145134. * @returns the crowd you can add agents to
  145135. */
  145136. constructor(plugin: RecastJSPlugin, maxAgents: number, maxAgentRadius: number, scene: Scene);
  145137. /**
  145138. * Add a new agent to the crowd with the specified parameter a corresponding transformNode.
  145139. * You can attach anything to that node. The node position is updated in the scene update tick.
  145140. * @param pos world position that will be constrained by the navigation mesh
  145141. * @param parameters agent parameters
  145142. * @param transform hooked to the agent that will be update by the scene
  145143. * @returns agent index
  145144. */
  145145. addAgent(pos: Vector3, parameters: IAgentParameters, transform: TransformNode): number;
  145146. /**
  145147. * Returns the agent position in world space
  145148. * @param index agent index returned by addAgent
  145149. * @returns world space position
  145150. */
  145151. getAgentPosition(index: number): Vector3;
  145152. /**
  145153. * Returns the agent position result in world space
  145154. * @param index agent index returned by addAgent
  145155. * @param result output world space position
  145156. */
  145157. getAgentPositionToRef(index: number, result: Vector3): void;
  145158. /**
  145159. * Returns the agent velocity in world space
  145160. * @param index agent index returned by addAgent
  145161. * @returns world space velocity
  145162. */
  145163. getAgentVelocity(index: number): Vector3;
  145164. /**
  145165. * Returns the agent velocity result in world space
  145166. * @param index agent index returned by addAgent
  145167. * @param result output world space velocity
  145168. */
  145169. getAgentVelocityToRef(index: number, result: Vector3): void;
  145170. /**
  145171. * Asks a particular agent to go to a destination. That destination is constrained by the navigation mesh
  145172. * @param index agent index returned by addAgent
  145173. * @param destination targeted world position
  145174. */
  145175. agentGoto(index: number, destination: Vector3): void;
  145176. /**
  145177. * Teleport the agent to a new position
  145178. * @param index agent index returned by addAgent
  145179. * @param destination targeted world position
  145180. */
  145181. agentTeleport(index: number, destination: Vector3): void;
  145182. /**
  145183. * Update agent parameters
  145184. * @param index agent index returned by addAgent
  145185. * @param parameters agent parameters
  145186. */
  145187. updateAgentParameters(index: number, parameters: IAgentParameters): void;
  145188. /**
  145189. * remove a particular agent previously created
  145190. * @param index agent index returned by addAgent
  145191. */
  145192. removeAgent(index: number): void;
  145193. /**
  145194. * get the list of all agents attached to this crowd
  145195. * @returns list of agent indices
  145196. */
  145197. getAgents(): number[];
  145198. /**
  145199. * Tick update done by the Scene. Agent position/velocity/acceleration is updated by this function
  145200. * @param deltaTime in seconds
  145201. */
  145202. update(deltaTime: number): void;
  145203. /**
  145204. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  145205. * The queries will try to find a solution within those bounds
  145206. * default is (1,1,1)
  145207. * @param extent x,y,z value that define the extent around the queries point of reference
  145208. */
  145209. setDefaultQueryExtent(extent: Vector3): void;
  145210. /**
  145211. * Get the Bounding box extent specified by setDefaultQueryExtent
  145212. * @returns the box extent values
  145213. */
  145214. getDefaultQueryExtent(): Vector3;
  145215. /**
  145216. * Get the Bounding box extent result specified by setDefaultQueryExtent
  145217. * @param result output the box extent values
  145218. */
  145219. getDefaultQueryExtentToRef(result: Vector3): void;
  145220. /**
  145221. * Release all resources
  145222. */
  145223. dispose(): void;
  145224. }
  145225. }
  145226. declare module BABYLON {
  145227. /**
  145228. * Class used to enable access to IndexedDB
  145229. * @see https://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  145230. */
  145231. export class Database implements IOfflineProvider {
  145232. private _callbackManifestChecked;
  145233. private _currentSceneUrl;
  145234. private _db;
  145235. private _enableSceneOffline;
  145236. private _enableTexturesOffline;
  145237. private _manifestVersionFound;
  145238. private _mustUpdateRessources;
  145239. private _hasReachedQuota;
  145240. private _isSupported;
  145241. private _idbFactory;
  145242. /** Gets a boolean indicating if the user agent supports blob storage (this value will be updated after creating the first Database object) */
  145243. private static IsUASupportingBlobStorage;
  145244. /**
  145245. * Gets a boolean indicating if Database storate is enabled (off by default)
  145246. */
  145247. static IDBStorageEnabled: boolean;
  145248. /**
  145249. * Gets a boolean indicating if scene must be saved in the database
  145250. */
  145251. get enableSceneOffline(): boolean;
  145252. /**
  145253. * Gets a boolean indicating if textures must be saved in the database
  145254. */
  145255. get enableTexturesOffline(): boolean;
  145256. /**
  145257. * Creates a new Database
  145258. * @param urlToScene defines the url to load the scene
  145259. * @param callbackManifestChecked defines the callback to use when manifest is checked
  145260. * @param disableManifestCheck defines a boolean indicating that we want to skip the manifest validation (it will be considered validated and up to date)
  145261. */
  145262. constructor(urlToScene: string, callbackManifestChecked: (checked: boolean) => any, disableManifestCheck?: boolean);
  145263. private static _ParseURL;
  145264. private static _ReturnFullUrlLocation;
  145265. private _checkManifestFile;
  145266. /**
  145267. * Open the database and make it available
  145268. * @param successCallback defines the callback to call on success
  145269. * @param errorCallback defines the callback to call on error
  145270. */
  145271. open(successCallback: () => void, errorCallback: () => void): void;
  145272. /**
  145273. * Loads an image from the database
  145274. * @param url defines the url to load from
  145275. * @param image defines the target DOM image
  145276. */
  145277. loadImage(url: string, image: HTMLImageElement): void;
  145278. private _loadImageFromDBAsync;
  145279. private _saveImageIntoDBAsync;
  145280. private _checkVersionFromDB;
  145281. private _loadVersionFromDBAsync;
  145282. private _saveVersionIntoDBAsync;
  145283. /**
  145284. * Loads a file from database
  145285. * @param url defines the URL to load from
  145286. * @param sceneLoaded defines a callback to call on success
  145287. * @param progressCallBack defines a callback to call when progress changed
  145288. * @param errorCallback defines a callback to call on error
  145289. * @param useArrayBuffer defines a boolean to use array buffer instead of text string
  145290. */
  145291. loadFile(url: string, sceneLoaded: (data: any) => void, progressCallBack?: (data: any) => void, errorCallback?: () => void, useArrayBuffer?: boolean): void;
  145292. private _loadFileAsync;
  145293. private _saveFileAsync;
  145294. /**
  145295. * Validates if xhr data is correct
  145296. * @param xhr defines the request to validate
  145297. * @param dataType defines the expected data type
  145298. * @returns true if data is correct
  145299. */
  145300. private static _ValidateXHRData;
  145301. }
  145302. }
  145303. declare module BABYLON {
  145304. /** @hidden */
  145305. export var gpuUpdateParticlesPixelShader: {
  145306. name: string;
  145307. shader: string;
  145308. };
  145309. }
  145310. declare module BABYLON {
  145311. /** @hidden */
  145312. export var gpuUpdateParticlesVertexShader: {
  145313. name: string;
  145314. shader: string;
  145315. };
  145316. }
  145317. declare module BABYLON {
  145318. /** @hidden */
  145319. export var clipPlaneFragmentDeclaration2: {
  145320. name: string;
  145321. shader: string;
  145322. };
  145323. }
  145324. declare module BABYLON {
  145325. /** @hidden */
  145326. export var gpuRenderParticlesPixelShader: {
  145327. name: string;
  145328. shader: string;
  145329. };
  145330. }
  145331. declare module BABYLON {
  145332. /** @hidden */
  145333. export var clipPlaneVertexDeclaration2: {
  145334. name: string;
  145335. shader: string;
  145336. };
  145337. }
  145338. declare module BABYLON {
  145339. /** @hidden */
  145340. export var gpuRenderParticlesVertexShader: {
  145341. name: string;
  145342. shader: string;
  145343. };
  145344. }
  145345. declare module BABYLON {
  145346. /**
  145347. * This represents a GPU particle system in Babylon
  145348. * This is the fastest particle system in Babylon as it uses the GPU to update the individual particle data
  145349. * @see https://www.babylonjs-playground.com/#PU4WYI#4
  145350. */
  145351. export class GPUParticleSystem extends BaseParticleSystem implements IDisposable, IParticleSystem, IAnimatable {
  145352. /**
  145353. * The layer mask we are rendering the particles through.
  145354. */
  145355. layerMask: number;
  145356. private _capacity;
  145357. private _activeCount;
  145358. private _currentActiveCount;
  145359. private _accumulatedCount;
  145360. private _renderEffect;
  145361. private _updateEffect;
  145362. private _buffer0;
  145363. private _buffer1;
  145364. private _spriteBuffer;
  145365. private _updateVAO;
  145366. private _renderVAO;
  145367. private _targetIndex;
  145368. private _sourceBuffer;
  145369. private _targetBuffer;
  145370. private _engine;
  145371. private _currentRenderId;
  145372. private _started;
  145373. private _stopped;
  145374. private _timeDelta;
  145375. private _randomTexture;
  145376. private _randomTexture2;
  145377. private _attributesStrideSize;
  145378. private _updateEffectOptions;
  145379. private _randomTextureSize;
  145380. private _actualFrame;
  145381. private _customEffect;
  145382. private readonly _rawTextureWidth;
  145383. /**
  145384. * Gets a boolean indicating if the GPU particles can be rendered on current browser
  145385. */
  145386. static get IsSupported(): boolean;
  145387. /**
  145388. * An event triggered when the system is disposed.
  145389. */
  145390. onDisposeObservable: Observable<IParticleSystem>;
  145391. /**
  145392. * Gets the maximum number of particles active at the same time.
  145393. * @returns The max number of active particles.
  145394. */
  145395. getCapacity(): number;
  145396. /**
  145397. * Forces the particle to write their depth information to the depth buffer. This can help preventing other draw calls
  145398. * to override the particles.
  145399. */
  145400. forceDepthWrite: boolean;
  145401. /**
  145402. * Gets or set the number of active particles
  145403. */
  145404. get activeParticleCount(): number;
  145405. set activeParticleCount(value: number);
  145406. private _preWarmDone;
  145407. /**
  145408. * Specifies if the particles are updated in emitter local space or world space.
  145409. */
  145410. isLocal: boolean;
  145411. /**
  145412. * Is this system ready to be used/rendered
  145413. * @return true if the system is ready
  145414. */
  145415. isReady(): boolean;
  145416. /**
  145417. * Gets if the system has been started. (Note: this will still be true after stop is called)
  145418. * @returns True if it has been started, otherwise false.
  145419. */
  145420. isStarted(): boolean;
  145421. /**
  145422. * Gets if the system has been stopped. (Note: rendering is still happening but the system is frozen)
  145423. * @returns True if it has been stopped, otherwise false.
  145424. */
  145425. isStopped(): boolean;
  145426. /**
  145427. * Gets a boolean indicating that the system is stopping
  145428. * @returns true if the system is currently stopping
  145429. */
  145430. isStopping(): boolean;
  145431. /**
  145432. * Gets the number of particles active at the same time.
  145433. * @returns The number of active particles.
  145434. */
  145435. getActiveCount(): number;
  145436. /**
  145437. * Starts the particle system and begins to emit
  145438. * @param delay defines the delay in milliseconds before starting the system (this.startDelay by default)
  145439. */
  145440. start(delay?: number): void;
  145441. /**
  145442. * Stops the particle system.
  145443. */
  145444. stop(): void;
  145445. /**
  145446. * Remove all active particles
  145447. */
  145448. reset(): void;
  145449. /**
  145450. * Returns the string "GPUParticleSystem"
  145451. * @returns a string containing the class name
  145452. */
  145453. getClassName(): string;
  145454. /**
  145455. * Gets the custom effect used to render the particles
  145456. * @param blendMode Blend mode for which the effect should be retrieved
  145457. * @returns The effect
  145458. */
  145459. getCustomEffect(blendMode?: number): Nullable<Effect>;
  145460. /**
  145461. * Sets the custom effect used to render the particles
  145462. * @param effect The effect to set
  145463. * @param blendMode Blend mode for which the effect should be set
  145464. */
  145465. setCustomEffect(effect: Nullable<Effect>, blendMode?: number): void;
  145466. /** @hidden */
  145467. protected _onBeforeDrawParticlesObservable: Nullable<Observable<Nullable<Effect>>>;
  145468. /**
  145469. * Observable that will be called just before the particles are drawn
  145470. */
  145471. get onBeforeDrawParticlesObservable(): Observable<Nullable<Effect>>;
  145472. /**
  145473. * Gets the name of the particle vertex shader
  145474. */
  145475. get vertexShaderName(): string;
  145476. private _colorGradientsTexture;
  145477. protected _removeGradientAndTexture(gradient: number, gradients: Nullable<IValueGradient[]>, texture: RawTexture): BaseParticleSystem;
  145478. /**
  145479. * Adds a new color gradient
  145480. * @param gradient defines the gradient to use (between 0 and 1)
  145481. * @param color1 defines the color to affect to the specified gradient
  145482. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  145483. * @returns the current particle system
  145484. */
  145485. addColorGradient(gradient: number, color1: Color4, color2?: Color4): GPUParticleSystem;
  145486. private _refreshColorGradient;
  145487. /** Force the system to rebuild all gradients that need to be resync */
  145488. forceRefreshGradients(): void;
  145489. /**
  145490. * Remove a specific color gradient
  145491. * @param gradient defines the gradient to remove
  145492. * @returns the current particle system
  145493. */
  145494. removeColorGradient(gradient: number): GPUParticleSystem;
  145495. private _angularSpeedGradientsTexture;
  145496. private _sizeGradientsTexture;
  145497. private _velocityGradientsTexture;
  145498. private _limitVelocityGradientsTexture;
  145499. private _dragGradientsTexture;
  145500. private _addFactorGradient;
  145501. /**
  145502. * Adds a new size gradient
  145503. * @param gradient defines the gradient to use (between 0 and 1)
  145504. * @param factor defines the size factor to affect to the specified gradient
  145505. * @returns the current particle system
  145506. */
  145507. addSizeGradient(gradient: number, factor: number): GPUParticleSystem;
  145508. /**
  145509. * Remove a specific size gradient
  145510. * @param gradient defines the gradient to remove
  145511. * @returns the current particle system
  145512. */
  145513. removeSizeGradient(gradient: number): GPUParticleSystem;
  145514. private _refreshFactorGradient;
  145515. /**
  145516. * Adds a new angular speed gradient
  145517. * @param gradient defines the gradient to use (between 0 and 1)
  145518. * @param factor defines the angular speed to affect to the specified gradient
  145519. * @returns the current particle system
  145520. */
  145521. addAngularSpeedGradient(gradient: number, factor: number): GPUParticleSystem;
  145522. /**
  145523. * Remove a specific angular speed gradient
  145524. * @param gradient defines the gradient to remove
  145525. * @returns the current particle system
  145526. */
  145527. removeAngularSpeedGradient(gradient: number): GPUParticleSystem;
  145528. /**
  145529. * Adds a new velocity gradient
  145530. * @param gradient defines the gradient to use (between 0 and 1)
  145531. * @param factor defines the velocity to affect to the specified gradient
  145532. * @returns the current particle system
  145533. */
  145534. addVelocityGradient(gradient: number, factor: number): GPUParticleSystem;
  145535. /**
  145536. * Remove a specific velocity gradient
  145537. * @param gradient defines the gradient to remove
  145538. * @returns the current particle system
  145539. */
  145540. removeVelocityGradient(gradient: number): GPUParticleSystem;
  145541. /**
  145542. * Adds a new limit velocity gradient
  145543. * @param gradient defines the gradient to use (between 0 and 1)
  145544. * @param factor defines the limit velocity value to affect to the specified gradient
  145545. * @returns the current particle system
  145546. */
  145547. addLimitVelocityGradient(gradient: number, factor: number): GPUParticleSystem;
  145548. /**
  145549. * Remove a specific limit velocity gradient
  145550. * @param gradient defines the gradient to remove
  145551. * @returns the current particle system
  145552. */
  145553. removeLimitVelocityGradient(gradient: number): GPUParticleSystem;
  145554. /**
  145555. * Adds a new drag gradient
  145556. * @param gradient defines the gradient to use (between 0 and 1)
  145557. * @param factor defines the drag value to affect to the specified gradient
  145558. * @returns the current particle system
  145559. */
  145560. addDragGradient(gradient: number, factor: number): GPUParticleSystem;
  145561. /**
  145562. * Remove a specific drag gradient
  145563. * @param gradient defines the gradient to remove
  145564. * @returns the current particle system
  145565. */
  145566. removeDragGradient(gradient: number): GPUParticleSystem;
  145567. /**
  145568. * Not supported by GPUParticleSystem
  145569. * @param gradient defines the gradient to use (between 0 and 1)
  145570. * @param factor defines the emit rate value to affect to the specified gradient
  145571. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  145572. * @returns the current particle system
  145573. */
  145574. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  145575. /**
  145576. * Not supported by GPUParticleSystem
  145577. * @param gradient defines the gradient to remove
  145578. * @returns the current particle system
  145579. */
  145580. removeEmitRateGradient(gradient: number): IParticleSystem;
  145581. /**
  145582. * Not supported by GPUParticleSystem
  145583. * @param gradient defines the gradient to use (between 0 and 1)
  145584. * @param factor defines the start size value to affect to the specified gradient
  145585. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  145586. * @returns the current particle system
  145587. */
  145588. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  145589. /**
  145590. * Not supported by GPUParticleSystem
  145591. * @param gradient defines the gradient to remove
  145592. * @returns the current particle system
  145593. */
  145594. removeStartSizeGradient(gradient: number): IParticleSystem;
  145595. /**
  145596. * Not supported by GPUParticleSystem
  145597. * @param gradient defines the gradient to use (between 0 and 1)
  145598. * @param min defines the color remap minimal range
  145599. * @param max defines the color remap maximal range
  145600. * @returns the current particle system
  145601. */
  145602. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  145603. /**
  145604. * Not supported by GPUParticleSystem
  145605. * @param gradient defines the gradient to remove
  145606. * @returns the current particle system
  145607. */
  145608. removeColorRemapGradient(): IParticleSystem;
  145609. /**
  145610. * Not supported by GPUParticleSystem
  145611. * @param gradient defines the gradient to use (between 0 and 1)
  145612. * @param min defines the alpha remap minimal range
  145613. * @param max defines the alpha remap maximal range
  145614. * @returns the current particle system
  145615. */
  145616. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  145617. /**
  145618. * Not supported by GPUParticleSystem
  145619. * @param gradient defines the gradient to remove
  145620. * @returns the current particle system
  145621. */
  145622. removeAlphaRemapGradient(): IParticleSystem;
  145623. /**
  145624. * Not supported by GPUParticleSystem
  145625. * @param gradient defines the gradient to use (between 0 and 1)
  145626. * @param color defines the color to affect to the specified gradient
  145627. * @returns the current particle system
  145628. */
  145629. addRampGradient(gradient: number, color: Color3): IParticleSystem;
  145630. /**
  145631. * Not supported by GPUParticleSystem
  145632. * @param gradient defines the gradient to remove
  145633. * @returns the current particle system
  145634. */
  145635. removeRampGradient(): IParticleSystem;
  145636. /**
  145637. * Not supported by GPUParticleSystem
  145638. * @returns the list of ramp gradients
  145639. */
  145640. getRampGradients(): Nullable<Array<Color3Gradient>>;
  145641. /**
  145642. * Not supported by GPUParticleSystem
  145643. * Gets or sets a boolean indicating that ramp gradients must be used
  145644. * @see https://doc.babylonjs.com/babylon101/particles#ramp-gradients
  145645. */
  145646. get useRampGradients(): boolean;
  145647. set useRampGradients(value: boolean);
  145648. /**
  145649. * Not supported by GPUParticleSystem
  145650. * @param gradient defines the gradient to use (between 0 and 1)
  145651. * @param factor defines the life time factor to affect to the specified gradient
  145652. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  145653. * @returns the current particle system
  145654. */
  145655. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  145656. /**
  145657. * Not supported by GPUParticleSystem
  145658. * @param gradient defines the gradient to remove
  145659. * @returns the current particle system
  145660. */
  145661. removeLifeTimeGradient(gradient: number): IParticleSystem;
  145662. /**
  145663. * Instantiates a GPU particle system.
  145664. * 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.
  145665. * @param name The name of the particle system
  145666. * @param options The options used to create the system
  145667. * @param scene The scene the particle system belongs to
  145668. * @param isAnimationSheetEnabled Must be true if using a spritesheet to animate the particles texture
  145669. * @param customEffect a custom effect used to change the way particles are rendered by default
  145670. */
  145671. constructor(name: string, options: Partial<{
  145672. capacity: number;
  145673. randomTextureSize: number;
  145674. }>, scene: Scene, isAnimationSheetEnabled?: boolean, customEffect?: Nullable<Effect>);
  145675. protected _reset(): void;
  145676. private _createUpdateVAO;
  145677. private _createRenderVAO;
  145678. private _initialize;
  145679. /** @hidden */
  145680. _recreateUpdateEffect(): void;
  145681. private _getEffect;
  145682. /**
  145683. * Fill the defines array according to the current settings of the particle system
  145684. * @param defines Array to be updated
  145685. * @param blendMode blend mode to take into account when updating the array
  145686. */
  145687. fillDefines(defines: Array<string>, blendMode?: number): void;
  145688. /**
  145689. * Fill the uniforms, attributes and samplers arrays according to the current settings of the particle system
  145690. * @param uniforms Uniforms array to fill
  145691. * @param attributes Attributes array to fill
  145692. * @param samplers Samplers array to fill
  145693. */
  145694. fillUniformsAttributesAndSamplerNames(uniforms: Array<string>, attributes: Array<string>, samplers: Array<string>): void;
  145695. /** @hidden */
  145696. _recreateRenderEffect(): Effect;
  145697. /**
  145698. * Animates the particle system for the current frame by emitting new particles and or animating the living ones.
  145699. * @param preWarm defines if we are in the pre-warmimg phase
  145700. */
  145701. animate(preWarm?: boolean): void;
  145702. private _createFactorGradientTexture;
  145703. private _createSizeGradientTexture;
  145704. private _createAngularSpeedGradientTexture;
  145705. private _createVelocityGradientTexture;
  145706. private _createLimitVelocityGradientTexture;
  145707. private _createDragGradientTexture;
  145708. private _createColorGradientTexture;
  145709. /**
  145710. * Renders the particle system in its current state
  145711. * @param preWarm defines if the system should only update the particles but not render them
  145712. * @returns the current number of particles
  145713. */
  145714. render(preWarm?: boolean): number;
  145715. /**
  145716. * Rebuilds the particle system
  145717. */
  145718. rebuild(): void;
  145719. private _releaseBuffers;
  145720. private _releaseVAOs;
  145721. /**
  145722. * Disposes the particle system and free the associated resources
  145723. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  145724. */
  145725. dispose(disposeTexture?: boolean): void;
  145726. /**
  145727. * Clones the particle system.
  145728. * @param name The name of the cloned object
  145729. * @param newEmitter The new emitter to use
  145730. * @returns the cloned particle system
  145731. */
  145732. clone(name: string, newEmitter: any): GPUParticleSystem;
  145733. /**
  145734. * Serializes the particle system to a JSON object
  145735. * @param serializeTexture defines if the texture must be serialized as well
  145736. * @returns the JSON object
  145737. */
  145738. serialize(serializeTexture?: boolean): any;
  145739. /**
  145740. * Parses a JSON object to create a GPU particle system.
  145741. * @param parsedParticleSystem The JSON object to parse
  145742. * @param scene The scene to create the particle system in
  145743. * @param rootUrl The root url to use to load external dependencies like texture
  145744. * @param doNotStart Ignore the preventAutoStart attribute and does not start
  145745. * @returns the parsed GPU particle system
  145746. */
  145747. static Parse(parsedParticleSystem: any, scene: Scene, rootUrl: string, doNotStart?: boolean): GPUParticleSystem;
  145748. }
  145749. }
  145750. declare module BABYLON {
  145751. /**
  145752. * Represents a set of particle systems working together to create a specific effect
  145753. */
  145754. export class ParticleSystemSet implements IDisposable {
  145755. /**
  145756. * Gets or sets base Assets URL
  145757. */
  145758. static BaseAssetsUrl: string;
  145759. private _emitterCreationOptions;
  145760. private _emitterNode;
  145761. /**
  145762. * Gets the particle system list
  145763. */
  145764. systems: IParticleSystem[];
  145765. /**
  145766. * Gets the emitter node used with this set
  145767. */
  145768. get emitterNode(): Nullable<TransformNode>;
  145769. /**
  145770. * Creates a new emitter mesh as a sphere
  145771. * @param options defines the options used to create the sphere
  145772. * @param renderingGroupId defines the renderingGroupId to use for the sphere
  145773. * @param scene defines the hosting scene
  145774. */
  145775. setEmitterAsSphere(options: {
  145776. diameter: number;
  145777. segments: number;
  145778. color: Color3;
  145779. }, renderingGroupId: number, scene: Scene): void;
  145780. /**
  145781. * Starts all particle systems of the set
  145782. * @param emitter defines an optional mesh to use as emitter for the particle systems
  145783. */
  145784. start(emitter?: AbstractMesh): void;
  145785. /**
  145786. * Release all associated resources
  145787. */
  145788. dispose(): void;
  145789. /**
  145790. * Serialize the set into a JSON compatible object
  145791. * @param serializeTexture defines if the texture must be serialized as well
  145792. * @returns a JSON compatible representation of the set
  145793. */
  145794. serialize(serializeTexture?: boolean): any;
  145795. /**
  145796. * Parse a new ParticleSystemSet from a serialized source
  145797. * @param data defines a JSON compatible representation of the set
  145798. * @param scene defines the hosting scene
  145799. * @param gpu defines if we want GPU particles or CPU particles
  145800. * @returns a new ParticleSystemSet
  145801. */
  145802. static Parse(data: any, scene: Scene, gpu?: boolean): ParticleSystemSet;
  145803. }
  145804. }
  145805. declare module BABYLON {
  145806. /**
  145807. * This class is made for on one-liner static method to help creating particle system set.
  145808. */
  145809. export class ParticleHelper {
  145810. /**
  145811. * Gets or sets base Assets URL
  145812. */
  145813. static BaseAssetsUrl: string;
  145814. /** Define the Url to load snippets */
  145815. static SnippetUrl: string;
  145816. /**
  145817. * Create a default particle system that you can tweak
  145818. * @param emitter defines the emitter to use
  145819. * @param capacity defines the system capacity (default is 500 particles)
  145820. * @param scene defines the hosting scene
  145821. * @param useGPU defines if a GPUParticleSystem must be created (default is false)
  145822. * @returns the new Particle system
  145823. */
  145824. static CreateDefault(emitter: Nullable<AbstractMesh | Vector3>, capacity?: number, scene?: Scene, useGPU?: boolean): IParticleSystem;
  145825. /**
  145826. * This is the main static method (one-liner) of this helper to create different particle systems
  145827. * @param type This string represents the type to the particle system to create
  145828. * @param scene The scene where the particle system should live
  145829. * @param gpu If the system will use gpu
  145830. * @returns the ParticleSystemSet created
  145831. */
  145832. static CreateAsync(type: string, scene: Nullable<Scene>, gpu?: boolean): Promise<ParticleSystemSet>;
  145833. /**
  145834. * Static function used to export a particle system to a ParticleSystemSet variable.
  145835. * Please note that the emitter shape is not exported
  145836. * @param systems defines the particle systems to export
  145837. * @returns the created particle system set
  145838. */
  145839. static ExportSet(systems: IParticleSystem[]): ParticleSystemSet;
  145840. /**
  145841. * Creates a particle system from a snippet saved in a remote file
  145842. * @param name defines the name of the particle system to create (can be null or empty to use the one from the json data)
  145843. * @param url defines the url to load from
  145844. * @param scene defines the hosting scene
  145845. * @param gpu If the system will use gpu
  145846. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  145847. * @returns a promise that will resolve to the new particle system
  145848. */
  145849. static ParseFromFileAsync(name: Nullable<string>, url: string, scene: Scene, gpu?: boolean, rootUrl?: string): Promise<IParticleSystem>;
  145850. /**
  145851. * Creates a particle system from a snippet saved by the particle system editor
  145852. * @param snippetId defines the snippet to load (can be set to _BLANK to create a default one)
  145853. * @param scene defines the hosting scene
  145854. * @param gpu If the system will use gpu
  145855. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  145856. * @returns a promise that will resolve to the new particle system
  145857. */
  145858. static CreateFromSnippetAsync(snippetId: string, scene: Scene, gpu?: boolean, rootUrl?: string): Promise<IParticleSystem>;
  145859. }
  145860. }
  145861. declare module BABYLON {
  145862. interface Engine {
  145863. /**
  145864. * Create an effect to use with particle systems.
  145865. * Please note that some parameters like animation sheets or not being billboard are not supported in this configuration, except if you pass
  145866. * the particle system for which you want to create a custom effect in the last parameter
  145867. * @param fragmentName defines the base name of the effect (The name of file without .fragment.fx)
  145868. * @param uniformsNames defines a list of attribute names
  145869. * @param samplers defines an array of string used to represent textures
  145870. * @param defines defines the string containing the defines to use to compile the shaders
  145871. * @param fallbacks defines the list of potential fallbacks to use if shader conmpilation fails
  145872. * @param onCompiled defines a function to call when the effect creation is successful
  145873. * @param onError defines a function to call when the effect creation has failed
  145874. * @param particleSystem the particle system you want to create the effect for
  145875. * @returns the new Effect
  145876. */
  145877. createEffectForParticles(fragmentName: string, uniformsNames: string[], samplers: string[], defines: string, fallbacks?: EffectFallbacks, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void, particleSystem?: IParticleSystem): Effect;
  145878. }
  145879. interface Mesh {
  145880. /**
  145881. * Returns an array populated with IParticleSystem objects whose the mesh is the emitter
  145882. * @returns an array of IParticleSystem
  145883. */
  145884. getEmittedParticleSystems(): IParticleSystem[];
  145885. /**
  145886. * Returns an array populated with IParticleSystem objects whose the mesh or its children are the emitter
  145887. * @returns an array of IParticleSystem
  145888. */
  145889. getHierarchyEmittedParticleSystems(): IParticleSystem[];
  145890. }
  145891. }
  145892. declare module BABYLON {
  145893. /** Defines the 4 color options */
  145894. export enum PointColor {
  145895. /** color value */
  145896. Color = 2,
  145897. /** uv value */
  145898. UV = 1,
  145899. /** random value */
  145900. Random = 0,
  145901. /** stated value */
  145902. Stated = 3
  145903. }
  145904. /**
  145905. * The PointCloudSystem (PCS) is a single updatable mesh. The points corresponding to the vertices of this big mesh.
  145906. * 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.
  145907. * The PointCloudSytem is also a particle system, with each point being a particle. It provides some methods to manage the particles.
  145908. * However it is behavior agnostic. This means it has no emitter, no particle physics, no particle recycler. You have to implement your own behavior.
  145909. *
  145910. * Full documentation here : TO BE ENTERED
  145911. */
  145912. export class PointsCloudSystem implements IDisposable {
  145913. /**
  145914. * The PCS array of cloud point objects. Just access each particle as with any classic array.
  145915. * Example : var p = SPS.particles[i];
  145916. */
  145917. particles: CloudPoint[];
  145918. /**
  145919. * The PCS total number of particles. Read only. Use PCS.counter instead if you need to set your own value.
  145920. */
  145921. nbParticles: number;
  145922. /**
  145923. * This a counter for your own usage. It's not set by any SPS functions.
  145924. */
  145925. counter: number;
  145926. /**
  145927. * The PCS name. This name is also given to the underlying mesh.
  145928. */
  145929. name: string;
  145930. /**
  145931. * The PCS mesh. It's a standard BJS Mesh, so all the methods from the Mesh class are avalaible.
  145932. */
  145933. mesh: Mesh;
  145934. /**
  145935. * This empty object is intended to store some PCS specific or temporary values in order to lower the Garbage Collector activity.
  145936. * Please read :
  145937. */
  145938. vars: any;
  145939. /**
  145940. * @hidden
  145941. */
  145942. _size: number;
  145943. private _scene;
  145944. private _promises;
  145945. private _positions;
  145946. private _indices;
  145947. private _normals;
  145948. private _colors;
  145949. private _uvs;
  145950. private _indices32;
  145951. private _positions32;
  145952. private _colors32;
  145953. private _uvs32;
  145954. private _updatable;
  145955. private _isVisibilityBoxLocked;
  145956. private _alwaysVisible;
  145957. private _groups;
  145958. private _groupCounter;
  145959. private _computeParticleColor;
  145960. private _computeParticleTexture;
  145961. private _computeParticleRotation;
  145962. private _computeBoundingBox;
  145963. private _isReady;
  145964. /**
  145965. * Creates a PCS (Points Cloud System) object
  145966. * @param name (String) is the PCS name, this will be the underlying mesh name
  145967. * @param pointSize (number) is the size for each point
  145968. * @param scene (Scene) is the scene in which the PCS is added
  145969. * @param options defines the options of the PCS e.g.
  145970. * * updatable (optional boolean, default true) : if the PCS must be updatable or immutable
  145971. */
  145972. constructor(name: string, pointSize: number, scene: Scene, options?: {
  145973. updatable?: boolean;
  145974. });
  145975. /**
  145976. * Builds the PCS underlying mesh. Returns a standard Mesh.
  145977. * If no points were added to the PCS, the returned mesh is just a single point.
  145978. * @returns a promise for the created mesh
  145979. */
  145980. buildMeshAsync(): Promise<Mesh>;
  145981. /**
  145982. * @hidden
  145983. */
  145984. private _buildMesh;
  145985. private _addParticle;
  145986. private _randomUnitVector;
  145987. private _getColorIndicesForCoord;
  145988. private _setPointsColorOrUV;
  145989. private _colorFromTexture;
  145990. private _calculateDensity;
  145991. /**
  145992. * Adds points to the PCS in random positions within a unit sphere
  145993. * @param nb (positive integer) the number of particles to be created from this model
  145994. * @param pointFunction is an optional javascript function to be called for each particle on PCS creation
  145995. * @returns the number of groups in the system
  145996. */
  145997. addPoints(nb: number, pointFunction?: any): number;
  145998. /**
  145999. * Adds points to the PCS from the surface of the model shape
  146000. * @param mesh is any Mesh object that will be used as a surface model for the points
  146001. * @param nb (positive integer) the number of particles to be created from this model
  146002. * @param colorWith determines whether a point is colored using color (default), uv, random, stated or none (invisible)
  146003. * @param color (color4) to be used when colorWith is stated or color (number) when used to specify texture position
  146004. * @param range (number from 0 to 1) to determine the variation in shape and tone for a stated color
  146005. * @returns the number of groups in the system
  146006. */
  146007. addSurfacePoints(mesh: Mesh, nb: number, colorWith?: number, color?: Color4 | number, range?: number): number;
  146008. /**
  146009. * Adds points to the PCS inside the model shape
  146010. * @param mesh is any Mesh object that will be used as a surface model for the points
  146011. * @param nb (positive integer) the number of particles to be created from this model
  146012. * @param colorWith determines whether a point is colored using color (default), uv, random, stated or none (invisible)
  146013. * @param color (color4) to be used when colorWith is stated or color (number) when used to specify texture position
  146014. * @param range (number from 0 to 1) to determine the variation in shape and tone for a stated color
  146015. * @returns the number of groups in the system
  146016. */
  146017. addVolumePoints(mesh: Mesh, nb: number, colorWith?: number, color?: Color4 | number, range?: number): number;
  146018. /**
  146019. * Sets all the particles : this method actually really updates the mesh according to the particle positions, rotations, colors, textures, etc.
  146020. * This method calls `updateParticle()` for each particle of the SPS.
  146021. * For an animated SPS, it is usually called within the render loop.
  146022. * @param start The particle index in the particle array where to start to compute the particle property values _(default 0)_
  146023. * @param end The particle index in the particle array where to stop to compute the particle property values _(default nbParticle - 1)_
  146024. * @param update If the mesh must be finally updated on this call after all the particle computations _(default true)_
  146025. * @returns the PCS.
  146026. */
  146027. setParticles(start?: number, end?: number, update?: boolean): PointsCloudSystem;
  146028. /**
  146029. * Disposes the PCS.
  146030. */
  146031. dispose(): void;
  146032. /**
  146033. * Visibilty helper : Recomputes the visible size according to the mesh bounding box
  146034. * doc :
  146035. * @returns the PCS.
  146036. */
  146037. refreshVisibleSize(): PointsCloudSystem;
  146038. /**
  146039. * Visibility helper : Sets the size of a visibility box, this sets the underlying mesh bounding box.
  146040. * @param size the size (float) of the visibility box
  146041. * note : this doesn't lock the PCS mesh bounding box.
  146042. * doc :
  146043. */
  146044. setVisibilityBox(size: number): void;
  146045. /**
  146046. * Gets whether the PCS is always visible or not
  146047. * doc :
  146048. */
  146049. get isAlwaysVisible(): boolean;
  146050. /**
  146051. * Sets the PCS as always visible or not
  146052. * doc :
  146053. */
  146054. set isAlwaysVisible(val: boolean);
  146055. /**
  146056. * Tells to `setParticles()` to compute the particle rotations or not
  146057. * Default value : false. The PCS is faster when it's set to false
  146058. * Note : particle rotations are only applied to parent particles
  146059. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate
  146060. */
  146061. set computeParticleRotation(val: boolean);
  146062. /**
  146063. * Tells to `setParticles()` to compute the particle colors or not.
  146064. * Default value : true. The PCS is faster when it's set to false.
  146065. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  146066. */
  146067. set computeParticleColor(val: boolean);
  146068. set computeParticleTexture(val: boolean);
  146069. /**
  146070. * Gets if `setParticles()` computes the particle colors or not.
  146071. * Default value : false. The PCS is faster when it's set to false.
  146072. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  146073. */
  146074. get computeParticleColor(): boolean;
  146075. /**
  146076. * Gets if `setParticles()` computes the particle textures or not.
  146077. * Default value : false. The PCS is faster when it's set to false.
  146078. * Note : the particle textures are stored values, so setting `computeParticleTexture` to false will keep yet the last colors set.
  146079. */
  146080. get computeParticleTexture(): boolean;
  146081. /**
  146082. * Tells to `setParticles()` to compute or not the mesh bounding box when computing the particle positions.
  146083. */
  146084. set computeBoundingBox(val: boolean);
  146085. /**
  146086. * Gets if `setParticles()` computes or not the mesh bounding box when computing the particle positions.
  146087. */
  146088. get computeBoundingBox(): boolean;
  146089. /**
  146090. * This function does nothing. It may be overwritten to set all the particle first values.
  146091. * The PCS doesn't call this function, you may have to call it by your own.
  146092. * doc :
  146093. */
  146094. initParticles(): void;
  146095. /**
  146096. * This function does nothing. It may be overwritten to recycle a particle
  146097. * The PCS doesn't call this function, you can to call it
  146098. * doc :
  146099. * @param particle The particle to recycle
  146100. * @returns the recycled particle
  146101. */
  146102. recycleParticle(particle: CloudPoint): CloudPoint;
  146103. /**
  146104. * Updates a particle : this function should be overwritten by the user.
  146105. * It is called on each particle by `setParticles()`. This is the place to code each particle behavior.
  146106. * doc :
  146107. * @example : just set a particle position or velocity and recycle conditions
  146108. * @param particle The particle to update
  146109. * @returns the updated particle
  146110. */
  146111. updateParticle(particle: CloudPoint): CloudPoint;
  146112. /**
  146113. * This will be called before any other treatment by `setParticles()` and will be passed three parameters.
  146114. * This does nothing and may be overwritten by the user.
  146115. * @param start the particle index in the particle array where to start to iterate, same than the value passed to setParticle()
  146116. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  146117. * @param update the boolean update value actually passed to setParticles()
  146118. */
  146119. beforeUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  146120. /**
  146121. * This will be called by `setParticles()` after all the other treatments and just before the actual mesh update.
  146122. * This will be passed three parameters.
  146123. * This does nothing and may be overwritten by the user.
  146124. * @param start the particle index in the particle array where to start to iterate, same than the value passed to setParticle()
  146125. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  146126. * @param update the boolean update value actually passed to setParticles()
  146127. */
  146128. afterUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  146129. }
  146130. }
  146131. declare module BABYLON {
  146132. /**
  146133. * Represents one particle of a points cloud system.
  146134. */
  146135. export class CloudPoint {
  146136. /**
  146137. * particle global index
  146138. */
  146139. idx: number;
  146140. /**
  146141. * The color of the particle
  146142. */
  146143. color: Nullable<Color4>;
  146144. /**
  146145. * The world space position of the particle.
  146146. */
  146147. position: Vector3;
  146148. /**
  146149. * The world space rotation of the particle. (Not use if rotationQuaternion is set)
  146150. */
  146151. rotation: Vector3;
  146152. /**
  146153. * The world space rotation quaternion of the particle.
  146154. */
  146155. rotationQuaternion: Nullable<Quaternion>;
  146156. /**
  146157. * The uv of the particle.
  146158. */
  146159. uv: Nullable<Vector2>;
  146160. /**
  146161. * The current speed of the particle.
  146162. */
  146163. velocity: Vector3;
  146164. /**
  146165. * The pivot point in the particle local space.
  146166. */
  146167. pivot: Vector3;
  146168. /**
  146169. * Must the particle be translated from its pivot point in its local space ?
  146170. * In this case, the pivot point is set at the origin of the particle local space and the particle is translated.
  146171. * Default : false
  146172. */
  146173. translateFromPivot: boolean;
  146174. /**
  146175. * Index of this particle in the global "positions" array (Internal use)
  146176. * @hidden
  146177. */
  146178. _pos: number;
  146179. /**
  146180. * @hidden Index of this particle in the global "indices" array (Internal use)
  146181. */
  146182. _ind: number;
  146183. /**
  146184. * Group this particle belongs to
  146185. */
  146186. _group: PointsGroup;
  146187. /**
  146188. * Group id of this particle
  146189. */
  146190. groupId: number;
  146191. /**
  146192. * Index of the particle in its group id (Internal use)
  146193. */
  146194. idxInGroup: number;
  146195. /**
  146196. * @hidden Particle BoundingInfo object (Internal use)
  146197. */
  146198. _boundingInfo: BoundingInfo;
  146199. /**
  146200. * @hidden Reference to the PCS that the particle belongs to (Internal use)
  146201. */
  146202. _pcs: PointsCloudSystem;
  146203. /**
  146204. * @hidden Still set as invisible in order to skip useless computations (Internal use)
  146205. */
  146206. _stillInvisible: boolean;
  146207. /**
  146208. * @hidden Last computed particle rotation matrix
  146209. */
  146210. _rotationMatrix: number[];
  146211. /**
  146212. * Parent particle Id, if any.
  146213. * Default null.
  146214. */
  146215. parentId: Nullable<number>;
  146216. /**
  146217. * @hidden Internal global position in the PCS.
  146218. */
  146219. _globalPosition: Vector3;
  146220. /**
  146221. * Creates a Point Cloud object.
  146222. * Don't create particles manually, use instead the PCS internal tools like _addParticle()
  146223. * @param particleIndex (integer) is the particle index in the PCS pool. It's also the particle identifier.
  146224. * @param group (PointsGroup) is the group the particle belongs to
  146225. * @param groupId (integer) is the group identifier in the PCS.
  146226. * @param idxInGroup (integer) is the index of the particle in the current point group (ex: the 10th point of addPoints(30))
  146227. * @param pcs defines the PCS it is associated to
  146228. */
  146229. constructor(particleIndex: number, group: PointsGroup, groupId: number, idxInGroup: number, pcs: PointsCloudSystem);
  146230. /**
  146231. * get point size
  146232. */
  146233. get size(): Vector3;
  146234. /**
  146235. * Set point size
  146236. */
  146237. set size(scale: Vector3);
  146238. /**
  146239. * Legacy support, changed quaternion to rotationQuaternion
  146240. */
  146241. get quaternion(): Nullable<Quaternion>;
  146242. /**
  146243. * Legacy support, changed quaternion to rotationQuaternion
  146244. */
  146245. set quaternion(q: Nullable<Quaternion>);
  146246. /**
  146247. * Returns a boolean. True if the particle intersects a mesh, else false
  146248. * The intersection is computed on the particle position and Axis Aligned Bounding Box (AABB) or Sphere
  146249. * @param target is the object (point or mesh) what the intersection is computed against
  146250. * @param isSphere is boolean flag when false (default) bounding box of mesh is used, when true the bouding sphere is used
  146251. * @returns true if it intersects
  146252. */
  146253. intersectsMesh(target: Mesh, isSphere: boolean): boolean;
  146254. /**
  146255. * get the rotation matrix of the particle
  146256. * @hidden
  146257. */
  146258. getRotationMatrix(m: Matrix): void;
  146259. }
  146260. /**
  146261. * Represents a group of points in a points cloud system
  146262. * * PCS internal tool, don't use it manually.
  146263. */
  146264. export class PointsGroup {
  146265. /**
  146266. * The group id
  146267. * @hidden
  146268. */
  146269. groupID: number;
  146270. /**
  146271. * image data for group (internal use)
  146272. * @hidden
  146273. */
  146274. _groupImageData: Nullable<ArrayBufferView>;
  146275. /**
  146276. * Image Width (internal use)
  146277. * @hidden
  146278. */
  146279. _groupImgWidth: number;
  146280. /**
  146281. * Image Height (internal use)
  146282. * @hidden
  146283. */
  146284. _groupImgHeight: number;
  146285. /**
  146286. * Custom position function (internal use)
  146287. * @hidden
  146288. */
  146289. _positionFunction: Nullable<(particle: CloudPoint, i?: number, s?: number) => void>;
  146290. /**
  146291. * density per facet for surface points
  146292. * @hidden
  146293. */
  146294. _groupDensity: number[];
  146295. /**
  146296. * Only when points are colored by texture carries pointer to texture list array
  146297. * @hidden
  146298. */
  146299. _textureNb: number;
  146300. /**
  146301. * Creates a points group object. This is an internal reference to produce particles for the PCS.
  146302. * PCS internal tool, don't use it manually.
  146303. * @hidden
  146304. */
  146305. constructor(id: number, posFunction: Nullable<(particle: CloudPoint, i?: number, s?: number) => void>);
  146306. }
  146307. }
  146308. declare module BABYLON {
  146309. interface Scene {
  146310. /** @hidden (Backing field) */
  146311. _physicsEngine: Nullable<IPhysicsEngine>;
  146312. /** @hidden */
  146313. _physicsTimeAccumulator: number;
  146314. /**
  146315. * Gets the current physics engine
  146316. * @returns a IPhysicsEngine or null if none attached
  146317. */
  146318. getPhysicsEngine(): Nullable<IPhysicsEngine>;
  146319. /**
  146320. * Enables physics to the current scene
  146321. * @param gravity defines the scene's gravity for the physics engine
  146322. * @param plugin defines the physics engine to be used. defaults to OimoJS.
  146323. * @return a boolean indicating if the physics engine was initialized
  146324. */
  146325. enablePhysics(gravity: Nullable<Vector3>, plugin?: IPhysicsEnginePlugin): boolean;
  146326. /**
  146327. * Disables and disposes the physics engine associated with the scene
  146328. */
  146329. disablePhysicsEngine(): void;
  146330. /**
  146331. * Gets a boolean indicating if there is an active physics engine
  146332. * @returns a boolean indicating if there is an active physics engine
  146333. */
  146334. isPhysicsEnabled(): boolean;
  146335. /**
  146336. * Deletes a physics compound impostor
  146337. * @param compound defines the compound to delete
  146338. */
  146339. deleteCompoundImpostor(compound: any): void;
  146340. /**
  146341. * An event triggered when physic simulation is about to be run
  146342. */
  146343. onBeforePhysicsObservable: Observable<Scene>;
  146344. /**
  146345. * An event triggered when physic simulation has been done
  146346. */
  146347. onAfterPhysicsObservable: Observable<Scene>;
  146348. }
  146349. interface AbstractMesh {
  146350. /** @hidden */
  146351. _physicsImpostor: Nullable<PhysicsImpostor>;
  146352. /**
  146353. * Gets or sets impostor used for physic simulation
  146354. * @see https://doc.babylonjs.com/features/physics_engine
  146355. */
  146356. physicsImpostor: Nullable<PhysicsImpostor>;
  146357. /**
  146358. * Gets the current physics impostor
  146359. * @see https://doc.babylonjs.com/features/physics_engine
  146360. * @returns a physics impostor or null
  146361. */
  146362. getPhysicsImpostor(): Nullable<PhysicsImpostor>;
  146363. /** Apply a physic impulse to the mesh
  146364. * @param force defines the force to apply
  146365. * @param contactPoint defines where to apply the force
  146366. * @returns the current mesh
  146367. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  146368. */
  146369. applyImpulse(force: Vector3, contactPoint: Vector3): AbstractMesh;
  146370. /**
  146371. * Creates a physic joint between two meshes
  146372. * @param otherMesh defines the other mesh to use
  146373. * @param pivot1 defines the pivot to use on this mesh
  146374. * @param pivot2 defines the pivot to use on the other mesh
  146375. * @param options defines additional options (can be plugin dependent)
  146376. * @returns the current mesh
  146377. * @see https://www.babylonjs-playground.com/#0BS5U0#0
  146378. */
  146379. setPhysicsLinkWith(otherMesh: Mesh, pivot1: Vector3, pivot2: Vector3, options?: any): AbstractMesh;
  146380. /** @hidden */
  146381. _disposePhysicsObserver: Nullable<Observer<Node>>;
  146382. }
  146383. /**
  146384. * Defines the physics engine scene component responsible to manage a physics engine
  146385. */
  146386. export class PhysicsEngineSceneComponent implements ISceneComponent {
  146387. /**
  146388. * The component name helpful to identify the component in the list of scene components.
  146389. */
  146390. readonly name: string;
  146391. /**
  146392. * The scene the component belongs to.
  146393. */
  146394. scene: Scene;
  146395. /**
  146396. * Creates a new instance of the component for the given scene
  146397. * @param scene Defines the scene to register the component in
  146398. */
  146399. constructor(scene: Scene);
  146400. /**
  146401. * Registers the component in a given scene
  146402. */
  146403. register(): void;
  146404. /**
  146405. * Rebuilds the elements related to this component in case of
  146406. * context lost for instance.
  146407. */
  146408. rebuild(): void;
  146409. /**
  146410. * Disposes the component and the associated ressources
  146411. */
  146412. dispose(): void;
  146413. }
  146414. }
  146415. declare module BABYLON {
  146416. /**
  146417. * A helper for physics simulations
  146418. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  146419. */
  146420. export class PhysicsHelper {
  146421. private _scene;
  146422. private _physicsEngine;
  146423. /**
  146424. * Initializes the Physics helper
  146425. * @param scene Babylon.js scene
  146426. */
  146427. constructor(scene: Scene);
  146428. /**
  146429. * Applies a radial explosion impulse
  146430. * @param origin the origin of the explosion
  146431. * @param radiusOrEventOptions the radius or the options of radial explosion
  146432. * @param strength the explosion strength
  146433. * @param falloff possible options: Constant & Linear. Defaults to Constant
  146434. * @returns A physics radial explosion event, or null
  146435. */
  146436. applyRadialExplosionImpulse(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsRadialExplosionEvent>;
  146437. /**
  146438. * Applies a radial explosion force
  146439. * @param origin the origin of the explosion
  146440. * @param radiusOrEventOptions the radius or the options of radial explosion
  146441. * @param strength the explosion strength
  146442. * @param falloff possible options: Constant & Linear. Defaults to Constant
  146443. * @returns A physics radial explosion event, or null
  146444. */
  146445. applyRadialExplosionForce(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsRadialExplosionEvent>;
  146446. /**
  146447. * Creates a gravitational field
  146448. * @param origin the origin of the explosion
  146449. * @param radiusOrEventOptions the radius or the options of radial explosion
  146450. * @param strength the explosion strength
  146451. * @param falloff possible options: Constant & Linear. Defaults to Constant
  146452. * @returns A physics gravitational field event, or null
  146453. */
  146454. gravitationalField(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsGravitationalFieldEvent>;
  146455. /**
  146456. * Creates a physics updraft event
  146457. * @param origin the origin of the updraft
  146458. * @param radiusOrEventOptions the radius or the options of the updraft
  146459. * @param strength the strength of the updraft
  146460. * @param height the height of the updraft
  146461. * @param updraftMode possible options: Center & Perpendicular. Defaults to Center
  146462. * @returns A physics updraft event, or null
  146463. */
  146464. updraft(origin: Vector3, radiusOrEventOptions: number | PhysicsUpdraftEventOptions, strength?: number, height?: number, updraftMode?: PhysicsUpdraftMode): Nullable<PhysicsUpdraftEvent>;
  146465. /**
  146466. * Creates a physics vortex event
  146467. * @param origin the of the vortex
  146468. * @param radiusOrEventOptions the radius or the options of the vortex
  146469. * @param strength the strength of the vortex
  146470. * @param height the height of the vortex
  146471. * @returns a Physics vortex event, or null
  146472. * A physics vortex event or null
  146473. */
  146474. vortex(origin: Vector3, radiusOrEventOptions: number | PhysicsVortexEventOptions, strength?: number, height?: number): Nullable<PhysicsVortexEvent>;
  146475. }
  146476. /**
  146477. * Represents a physics radial explosion event
  146478. */
  146479. class PhysicsRadialExplosionEvent {
  146480. private _scene;
  146481. private _options;
  146482. private _sphere;
  146483. private _dataFetched;
  146484. /**
  146485. * Initializes a radial explosioin event
  146486. * @param _scene BabylonJS scene
  146487. * @param _options The options for the vortex event
  146488. */
  146489. constructor(_scene: Scene, _options: PhysicsRadialExplosionEventOptions);
  146490. /**
  146491. * Returns the data related to the radial explosion event (sphere).
  146492. * @returns The radial explosion event data
  146493. */
  146494. getData(): PhysicsRadialExplosionEventData;
  146495. /**
  146496. * Returns the force and contact point of the impostor or false, if the impostor is not affected by the force/impulse.
  146497. * @param impostor A physics imposter
  146498. * @param origin the origin of the explosion
  146499. * @returns {Nullable<PhysicsHitData>} A physics force and contact point, or null
  146500. */
  146501. getImpostorHitData(impostor: PhysicsImpostor, origin: Vector3): Nullable<PhysicsHitData>;
  146502. /**
  146503. * Triggers affecterd impostors callbacks
  146504. * @param affectedImpostorsWithData defines the list of affected impostors (including associated data)
  146505. */
  146506. triggerAffectedImpostorsCallback(affectedImpostorsWithData: Array<PhysicsAffectedImpostorWithData>): void;
  146507. /**
  146508. * Disposes the sphere.
  146509. * @param force Specifies if the sphere should be disposed by force
  146510. */
  146511. dispose(force?: boolean): void;
  146512. /*** Helpers ***/
  146513. private _prepareSphere;
  146514. private _intersectsWithSphere;
  146515. }
  146516. /**
  146517. * Represents a gravitational field event
  146518. */
  146519. class PhysicsGravitationalFieldEvent {
  146520. private _physicsHelper;
  146521. private _scene;
  146522. private _origin;
  146523. private _options;
  146524. private _tickCallback;
  146525. private _sphere;
  146526. private _dataFetched;
  146527. /**
  146528. * Initializes the physics gravitational field event
  146529. * @param _physicsHelper A physics helper
  146530. * @param _scene BabylonJS scene
  146531. * @param _origin The origin position of the gravitational field event
  146532. * @param _options The options for the vortex event
  146533. */
  146534. constructor(_physicsHelper: PhysicsHelper, _scene: Scene, _origin: Vector3, _options: PhysicsRadialExplosionEventOptions);
  146535. /**
  146536. * Returns the data related to the gravitational field event (sphere).
  146537. * @returns A gravitational field event
  146538. */
  146539. getData(): PhysicsGravitationalFieldEventData;
  146540. /**
  146541. * Enables the gravitational field.
  146542. */
  146543. enable(): void;
  146544. /**
  146545. * Disables the gravitational field.
  146546. */
  146547. disable(): void;
  146548. /**
  146549. * Disposes the sphere.
  146550. * @param force The force to dispose from the gravitational field event
  146551. */
  146552. dispose(force?: boolean): void;
  146553. private _tick;
  146554. }
  146555. /**
  146556. * Represents a physics updraft event
  146557. */
  146558. class PhysicsUpdraftEvent {
  146559. private _scene;
  146560. private _origin;
  146561. private _options;
  146562. private _physicsEngine;
  146563. private _originTop;
  146564. private _originDirection;
  146565. private _tickCallback;
  146566. private _cylinder;
  146567. private _cylinderPosition;
  146568. private _dataFetched;
  146569. /**
  146570. * Initializes the physics updraft event
  146571. * @param _scene BabylonJS scene
  146572. * @param _origin The origin position of the updraft
  146573. * @param _options The options for the updraft event
  146574. */
  146575. constructor(_scene: Scene, _origin: Vector3, _options: PhysicsUpdraftEventOptions);
  146576. /**
  146577. * Returns the data related to the updraft event (cylinder).
  146578. * @returns A physics updraft event
  146579. */
  146580. getData(): PhysicsUpdraftEventData;
  146581. /**
  146582. * Enables the updraft.
  146583. */
  146584. enable(): void;
  146585. /**
  146586. * Disables the updraft.
  146587. */
  146588. disable(): void;
  146589. /**
  146590. * Disposes the cylinder.
  146591. * @param force Specifies if the updraft should be disposed by force
  146592. */
  146593. dispose(force?: boolean): void;
  146594. private getImpostorHitData;
  146595. private _tick;
  146596. /*** Helpers ***/
  146597. private _prepareCylinder;
  146598. private _intersectsWithCylinder;
  146599. }
  146600. /**
  146601. * Represents a physics vortex event
  146602. */
  146603. class PhysicsVortexEvent {
  146604. private _scene;
  146605. private _origin;
  146606. private _options;
  146607. private _physicsEngine;
  146608. private _originTop;
  146609. private _tickCallback;
  146610. private _cylinder;
  146611. private _cylinderPosition;
  146612. private _dataFetched;
  146613. /**
  146614. * Initializes the physics vortex event
  146615. * @param _scene The BabylonJS scene
  146616. * @param _origin The origin position of the vortex
  146617. * @param _options The options for the vortex event
  146618. */
  146619. constructor(_scene: Scene, _origin: Vector3, _options: PhysicsVortexEventOptions);
  146620. /**
  146621. * Returns the data related to the vortex event (cylinder).
  146622. * @returns The physics vortex event data
  146623. */
  146624. getData(): PhysicsVortexEventData;
  146625. /**
  146626. * Enables the vortex.
  146627. */
  146628. enable(): void;
  146629. /**
  146630. * Disables the cortex.
  146631. */
  146632. disable(): void;
  146633. /**
  146634. * Disposes the sphere.
  146635. * @param force
  146636. */
  146637. dispose(force?: boolean): void;
  146638. private getImpostorHitData;
  146639. private _tick;
  146640. /*** Helpers ***/
  146641. private _prepareCylinder;
  146642. private _intersectsWithCylinder;
  146643. }
  146644. /**
  146645. * Options fot the radial explosion event
  146646. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  146647. */
  146648. export class PhysicsRadialExplosionEventOptions {
  146649. /**
  146650. * The radius of the sphere for the radial explosion.
  146651. */
  146652. radius: number;
  146653. /**
  146654. * The strenth of the explosion.
  146655. */
  146656. strength: number;
  146657. /**
  146658. * The strenght of the force in correspondence to the distance of the affected object
  146659. */
  146660. falloff: PhysicsRadialImpulseFalloff;
  146661. /**
  146662. * Sphere options for the radial explosion.
  146663. */
  146664. sphere: {
  146665. segments: number;
  146666. diameter: number;
  146667. };
  146668. /**
  146669. * Sphere options for the radial explosion.
  146670. */
  146671. affectedImpostorsCallback: (affectedImpostorsWithData: Array<PhysicsAffectedImpostorWithData>) => void;
  146672. }
  146673. /**
  146674. * Options fot the updraft event
  146675. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  146676. */
  146677. export class PhysicsUpdraftEventOptions {
  146678. /**
  146679. * The radius of the cylinder for the vortex
  146680. */
  146681. radius: number;
  146682. /**
  146683. * The strenth of the updraft.
  146684. */
  146685. strength: number;
  146686. /**
  146687. * The height of the cylinder for the updraft.
  146688. */
  146689. height: number;
  146690. /**
  146691. * The mode for the the updraft.
  146692. */
  146693. updraftMode: PhysicsUpdraftMode;
  146694. }
  146695. /**
  146696. * Options fot the vortex event
  146697. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  146698. */
  146699. export class PhysicsVortexEventOptions {
  146700. /**
  146701. * The radius of the cylinder for the vortex
  146702. */
  146703. radius: number;
  146704. /**
  146705. * The strenth of the vortex.
  146706. */
  146707. strength: number;
  146708. /**
  146709. * The height of the cylinder for the vortex.
  146710. */
  146711. height: number;
  146712. /**
  146713. * At which distance, relative to the radius the centripetal forces should kick in? Range: 0-1
  146714. */
  146715. centripetalForceThreshold: number;
  146716. /**
  146717. * This multiplier determines with how much force the objects will be pushed sideways/around the vortex, when below the treshold.
  146718. */
  146719. centripetalForceMultiplier: number;
  146720. /**
  146721. * This multiplier determines with how much force the objects will be pushed sideways/around the vortex, when above the treshold.
  146722. */
  146723. centrifugalForceMultiplier: number;
  146724. /**
  146725. * This multiplier determines with how much force the objects will be pushed upwards, when in the vortex.
  146726. */
  146727. updraftForceMultiplier: number;
  146728. }
  146729. /**
  146730. * The strenght of the force in correspondence to the distance of the affected object
  146731. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  146732. */
  146733. export enum PhysicsRadialImpulseFalloff {
  146734. /** Defines that impulse is constant in strength across it's whole radius */
  146735. Constant = 0,
  146736. /** Defines that impulse gets weaker if it's further from the origin */
  146737. Linear = 1
  146738. }
  146739. /**
  146740. * The strength of the force in correspondence to the distance of the affected object
  146741. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  146742. */
  146743. export enum PhysicsUpdraftMode {
  146744. /** Defines that the upstream forces will pull towards the top center of the cylinder */
  146745. Center = 0,
  146746. /** Defines that once a impostor is inside the cylinder, it will shoot out perpendicular from the ground of the cylinder */
  146747. Perpendicular = 1
  146748. }
  146749. /**
  146750. * Interface for a physics hit data
  146751. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  146752. */
  146753. export interface PhysicsHitData {
  146754. /**
  146755. * The force applied at the contact point
  146756. */
  146757. force: Vector3;
  146758. /**
  146759. * The contact point
  146760. */
  146761. contactPoint: Vector3;
  146762. /**
  146763. * The distance from the origin to the contact point
  146764. */
  146765. distanceFromOrigin: number;
  146766. }
  146767. /**
  146768. * Interface for radial explosion event data
  146769. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  146770. */
  146771. export interface PhysicsRadialExplosionEventData {
  146772. /**
  146773. * A sphere used for the radial explosion event
  146774. */
  146775. sphere: Mesh;
  146776. }
  146777. /**
  146778. * Interface for gravitational field event data
  146779. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  146780. */
  146781. export interface PhysicsGravitationalFieldEventData {
  146782. /**
  146783. * A sphere mesh used for the gravitational field event
  146784. */
  146785. sphere: Mesh;
  146786. }
  146787. /**
  146788. * Interface for updraft event data
  146789. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  146790. */
  146791. export interface PhysicsUpdraftEventData {
  146792. /**
  146793. * A cylinder used for the updraft event
  146794. */
  146795. cylinder: Mesh;
  146796. }
  146797. /**
  146798. * Interface for vortex event data
  146799. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  146800. */
  146801. export interface PhysicsVortexEventData {
  146802. /**
  146803. * A cylinder used for the vortex event
  146804. */
  146805. cylinder: Mesh;
  146806. }
  146807. /**
  146808. * Interface for an affected physics impostor
  146809. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  146810. */
  146811. export interface PhysicsAffectedImpostorWithData {
  146812. /**
  146813. * The impostor affected by the effect
  146814. */
  146815. impostor: PhysicsImpostor;
  146816. /**
  146817. * The data about the hit/horce from the explosion
  146818. */
  146819. hitData: PhysicsHitData;
  146820. }
  146821. }
  146822. declare module BABYLON {
  146823. /** @hidden */
  146824. export var blackAndWhitePixelShader: {
  146825. name: string;
  146826. shader: string;
  146827. };
  146828. }
  146829. declare module BABYLON {
  146830. /**
  146831. * Post process used to render in black and white
  146832. */
  146833. export class BlackAndWhitePostProcess extends PostProcess {
  146834. /**
  146835. * Linear about to convert he result to black and white (default: 1)
  146836. */
  146837. degree: number;
  146838. /**
  146839. * Creates a black and white post process
  146840. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#black-and-white
  146841. * @param name The name of the effect.
  146842. * @param options The required width/height ratio to downsize to before computing the render pass.
  146843. * @param camera The camera to apply the render pass to.
  146844. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  146845. * @param engine The engine which the post process will be applied. (default: current engine)
  146846. * @param reusable If the post process can be reused on the same frame. (default: false)
  146847. */
  146848. constructor(name: string, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  146849. }
  146850. }
  146851. declare module BABYLON {
  146852. /**
  146853. * This represents a set of one or more post processes in Babylon.
  146854. * A post process can be used to apply a shader to a texture after it is rendered.
  146855. * @example https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  146856. */
  146857. export class PostProcessRenderEffect {
  146858. private _postProcesses;
  146859. private _getPostProcesses;
  146860. private _singleInstance;
  146861. private _cameras;
  146862. private _indicesForCamera;
  146863. /**
  146864. * Name of the effect
  146865. * @hidden
  146866. */
  146867. _name: string;
  146868. /**
  146869. * Instantiates a post process render effect.
  146870. * A post process can be used to apply a shader to a texture after it is rendered.
  146871. * @param engine The engine the effect is tied to
  146872. * @param name The name of the effect
  146873. * @param getPostProcesses A function that returns a set of post processes which the effect will run in order to be run.
  146874. * @param singleInstance False if this post process can be run on multiple cameras. (default: true)
  146875. */
  146876. constructor(engine: Engine, name: string, getPostProcesses: () => Nullable<PostProcess | Array<PostProcess>>, singleInstance?: boolean);
  146877. /**
  146878. * Checks if all the post processes in the effect are supported.
  146879. */
  146880. get isSupported(): boolean;
  146881. /**
  146882. * Updates the current state of the effect
  146883. * @hidden
  146884. */
  146885. _update(): void;
  146886. /**
  146887. * Attaches the effect on cameras
  146888. * @param cameras The camera to attach to.
  146889. * @hidden
  146890. */
  146891. _attachCameras(cameras: Camera): void;
  146892. /**
  146893. * Attaches the effect on cameras
  146894. * @param cameras The camera to attach to.
  146895. * @hidden
  146896. */
  146897. _attachCameras(cameras: Camera[]): void;
  146898. /**
  146899. * Detaches the effect on cameras
  146900. * @param cameras The camera to detatch from.
  146901. * @hidden
  146902. */
  146903. _detachCameras(cameras: Camera): void;
  146904. /**
  146905. * Detatches the effect on cameras
  146906. * @param cameras The camera to detatch from.
  146907. * @hidden
  146908. */
  146909. _detachCameras(cameras: Camera[]): void;
  146910. /**
  146911. * Enables the effect on given cameras
  146912. * @param cameras The camera to enable.
  146913. * @hidden
  146914. */
  146915. _enable(cameras: Camera): void;
  146916. /**
  146917. * Enables the effect on given cameras
  146918. * @param cameras The camera to enable.
  146919. * @hidden
  146920. */
  146921. _enable(cameras: Nullable<Camera[]>): void;
  146922. /**
  146923. * Disables the effect on the given cameras
  146924. * @param cameras The camera to disable.
  146925. * @hidden
  146926. */
  146927. _disable(cameras: Camera): void;
  146928. /**
  146929. * Disables the effect on the given cameras
  146930. * @param cameras The camera to disable.
  146931. * @hidden
  146932. */
  146933. _disable(cameras: Nullable<Camera[]>): void;
  146934. /**
  146935. * Gets a list of the post processes contained in the effect.
  146936. * @param camera The camera to get the post processes on.
  146937. * @returns The list of the post processes in the effect.
  146938. */
  146939. getPostProcesses(camera?: Camera): Nullable<Array<PostProcess>>;
  146940. }
  146941. }
  146942. declare module BABYLON {
  146943. /** @hidden */
  146944. export var extractHighlightsPixelShader: {
  146945. name: string;
  146946. shader: string;
  146947. };
  146948. }
  146949. declare module BABYLON {
  146950. /**
  146951. * 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.
  146952. */
  146953. export class ExtractHighlightsPostProcess extends PostProcess {
  146954. /**
  146955. * The luminance threshold, pixels below this value will be set to black.
  146956. */
  146957. threshold: number;
  146958. /** @hidden */
  146959. _exposure: number;
  146960. /**
  146961. * Post process which has the input texture to be used when performing highlight extraction
  146962. * @hidden
  146963. */
  146964. _inputPostProcess: Nullable<PostProcess>;
  146965. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  146966. }
  146967. }
  146968. declare module BABYLON {
  146969. /** @hidden */
  146970. export var bloomMergePixelShader: {
  146971. name: string;
  146972. shader: string;
  146973. };
  146974. }
  146975. declare module BABYLON {
  146976. /**
  146977. * The BloomMergePostProcess merges blurred images with the original based on the values of the circle of confusion.
  146978. */
  146979. export class BloomMergePostProcess extends PostProcess {
  146980. /** Weight of the bloom to be added to the original input. */
  146981. weight: number;
  146982. /**
  146983. * Creates a new instance of @see BloomMergePostProcess
  146984. * @param name The name of the effect.
  146985. * @param originalFromInput Post process which's input will be used for the merge.
  146986. * @param blurred Blurred highlights post process which's output will be used.
  146987. * @param weight Weight of the bloom to be added to the original input.
  146988. * @param options The required width/height ratio to downsize to before computing the render pass.
  146989. * @param camera The camera to apply the render pass to.
  146990. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  146991. * @param engine The engine which the post process will be applied. (default: current engine)
  146992. * @param reusable If the post process can be reused on the same frame. (default: false)
  146993. * @param textureType Type of textures used when performing the post process. (default: 0)
  146994. * @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)
  146995. */
  146996. constructor(name: string, originalFromInput: PostProcess, blurred: PostProcess,
  146997. /** Weight of the bloom to be added to the original input. */
  146998. weight: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  146999. }
  147000. }
  147001. declare module BABYLON {
  147002. /**
  147003. * The bloom effect spreads bright areas of an image to simulate artifacts seen in cameras
  147004. */
  147005. export class BloomEffect extends PostProcessRenderEffect {
  147006. private bloomScale;
  147007. /**
  147008. * @hidden Internal
  147009. */
  147010. _effects: Array<PostProcess>;
  147011. /**
  147012. * @hidden Internal
  147013. */
  147014. _downscale: ExtractHighlightsPostProcess;
  147015. private _blurX;
  147016. private _blurY;
  147017. private _merge;
  147018. /**
  147019. * The luminance threshold to find bright areas of the image to bloom.
  147020. */
  147021. get threshold(): number;
  147022. set threshold(value: number);
  147023. /**
  147024. * The strength of the bloom.
  147025. */
  147026. get weight(): number;
  147027. set weight(value: number);
  147028. /**
  147029. * Specifies the size of the bloom blur kernel, relative to the final output size
  147030. */
  147031. get kernel(): number;
  147032. set kernel(value: number);
  147033. /**
  147034. * Creates a new instance of @see BloomEffect
  147035. * @param scene The scene the effect belongs to.
  147036. * @param bloomScale The ratio of the blur texture to the input texture that should be used to compute the bloom.
  147037. * @param bloomKernel The size of the kernel to be used when applying the blur.
  147038. * @param bloomWeight The the strength of bloom.
  147039. * @param pipelineTextureType The type of texture to be used when performing the post processing.
  147040. * @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)
  147041. */
  147042. constructor(scene: Scene, bloomScale: number, bloomWeight: number, bloomKernel: number, pipelineTextureType?: number, blockCompilation?: boolean);
  147043. /**
  147044. * Disposes each of the internal effects for a given camera.
  147045. * @param camera The camera to dispose the effect on.
  147046. */
  147047. disposeEffects(camera: Camera): void;
  147048. /**
  147049. * @hidden Internal
  147050. */
  147051. _updateEffects(): void;
  147052. /**
  147053. * Internal
  147054. * @returns if all the contained post processes are ready.
  147055. * @hidden
  147056. */
  147057. _isReady(): boolean;
  147058. }
  147059. }
  147060. declare module BABYLON {
  147061. /** @hidden */
  147062. export var chromaticAberrationPixelShader: {
  147063. name: string;
  147064. shader: string;
  147065. };
  147066. }
  147067. declare module BABYLON {
  147068. /**
  147069. * The ChromaticAberrationPostProcess separates the rgb channels in an image to produce chromatic distortion around the edges of the screen
  147070. */
  147071. export class ChromaticAberrationPostProcess extends PostProcess {
  147072. /**
  147073. * The amount of seperation of rgb channels (default: 30)
  147074. */
  147075. aberrationAmount: number;
  147076. /**
  147077. * The amount the effect will increase for pixels closer to the edge of the screen. (default: 0)
  147078. */
  147079. radialIntensity: number;
  147080. /**
  147081. * 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))
  147082. */
  147083. direction: Vector2;
  147084. /**
  147085. * 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))
  147086. */
  147087. centerPosition: Vector2;
  147088. /**
  147089. * Creates a new instance ChromaticAberrationPostProcess
  147090. * @param name The name of the effect.
  147091. * @param screenWidth The width of the screen to apply the effect on.
  147092. * @param screenHeight The height of the screen to apply the effect on.
  147093. * @param options The required width/height ratio to downsize to before computing the render pass.
  147094. * @param camera The camera to apply the render pass to.
  147095. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  147096. * @param engine The engine which the post process will be applied. (default: current engine)
  147097. * @param reusable If the post process can be reused on the same frame. (default: false)
  147098. * @param textureType Type of textures used when performing the post process. (default: 0)
  147099. * @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)
  147100. */
  147101. constructor(name: string, screenWidth: number, screenHeight: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  147102. }
  147103. }
  147104. declare module BABYLON {
  147105. /** @hidden */
  147106. export var circleOfConfusionPixelShader: {
  147107. name: string;
  147108. shader: string;
  147109. };
  147110. }
  147111. declare module BABYLON {
  147112. /**
  147113. * The CircleOfConfusionPostProcess computes the circle of confusion value for each pixel given required lens parameters. See https://en.wikipedia.org/wiki/Circle_of_confusion
  147114. */
  147115. export class CircleOfConfusionPostProcess extends PostProcess {
  147116. /**
  147117. * 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.
  147118. */
  147119. lensSize: number;
  147120. /**
  147121. * F-Stop of the effect's camera. The diamater of the resulting aperture can be computed by lensSize/fStop. (default: 1.4)
  147122. */
  147123. fStop: number;
  147124. /**
  147125. * Distance away from the camera to focus on in scene units/1000 (eg. millimeter). (default: 2000)
  147126. */
  147127. focusDistance: number;
  147128. /**
  147129. * Focal length of the effect's camera in scene units/1000 (eg. millimeter). (default: 50)
  147130. */
  147131. focalLength: number;
  147132. private _depthTexture;
  147133. /**
  147134. * Creates a new instance CircleOfConfusionPostProcess
  147135. * @param name The name of the effect.
  147136. * @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.
  147137. * @param options The required width/height ratio to downsize to before computing the render pass.
  147138. * @param camera The camera to apply the render pass to.
  147139. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  147140. * @param engine The engine which the post process will be applied. (default: current engine)
  147141. * @param reusable If the post process can be reused on the same frame. (default: false)
  147142. * @param textureType Type of textures used when performing the post process. (default: 0)
  147143. * @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)
  147144. */
  147145. constructor(name: string, depthTexture: Nullable<RenderTargetTexture>, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  147146. /**
  147147. * 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.
  147148. */
  147149. set depthTexture(value: RenderTargetTexture);
  147150. }
  147151. }
  147152. declare module BABYLON {
  147153. /** @hidden */
  147154. export var colorCorrectionPixelShader: {
  147155. name: string;
  147156. shader: string;
  147157. };
  147158. }
  147159. declare module BABYLON {
  147160. /**
  147161. *
  147162. * This post-process allows the modification of rendered colors by using
  147163. * a 'look-up table' (LUT). This effect is also called Color Grading.
  147164. *
  147165. * The object needs to be provided an url to a texture containing the color
  147166. * look-up table: the texture must be 256 pixels wide and 16 pixels high.
  147167. * Use an image editing software to tweak the LUT to match your needs.
  147168. *
  147169. * For an example of a color LUT, see here:
  147170. * @see http://udn.epicgames.com/Three/rsrc/Three/ColorGrading/RGBTable16x1.png
  147171. * For explanations on color grading, see here:
  147172. * @see http://udn.epicgames.com/Three/ColorGrading.html
  147173. *
  147174. */
  147175. export class ColorCorrectionPostProcess extends PostProcess {
  147176. private _colorTableTexture;
  147177. constructor(name: string, colorTableUrl: string, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  147178. }
  147179. }
  147180. declare module BABYLON {
  147181. /** @hidden */
  147182. export var convolutionPixelShader: {
  147183. name: string;
  147184. shader: string;
  147185. };
  147186. }
  147187. declare module BABYLON {
  147188. /**
  147189. * The ConvolutionPostProcess applies a 3x3 kernel to every pixel of the
  147190. * input texture to perform effects such as edge detection or sharpening
  147191. * See http://en.wikipedia.org/wiki/Kernel_(image_processing)
  147192. */
  147193. export class ConvolutionPostProcess extends PostProcess {
  147194. /** Array of 9 values corresponding to the 3x3 kernel to be applied */
  147195. kernel: number[];
  147196. /**
  147197. * Creates a new instance ConvolutionPostProcess
  147198. * @param name The name of the effect.
  147199. * @param kernel Array of 9 values corresponding to the 3x3 kernel to be applied
  147200. * @param options The required width/height ratio to downsize to before computing the render pass.
  147201. * @param camera The camera to apply the render pass to.
  147202. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  147203. * @param engine The engine which the post process will be applied. (default: current engine)
  147204. * @param reusable If the post process can be reused on the same frame. (default: false)
  147205. * @param textureType Type of textures used when performing the post process. (default: 0)
  147206. */
  147207. constructor(name: string,
  147208. /** Array of 9 values corresponding to the 3x3 kernel to be applied */
  147209. kernel: number[], options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  147210. /**
  147211. * Edge detection 0 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  147212. */
  147213. static EdgeDetect0Kernel: number[];
  147214. /**
  147215. * Edge detection 1 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  147216. */
  147217. static EdgeDetect1Kernel: number[];
  147218. /**
  147219. * Edge detection 2 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  147220. */
  147221. static EdgeDetect2Kernel: number[];
  147222. /**
  147223. * Kernel to sharpen an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  147224. */
  147225. static SharpenKernel: number[];
  147226. /**
  147227. * Kernel to emboss an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  147228. */
  147229. static EmbossKernel: number[];
  147230. /**
  147231. * Kernel to blur an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  147232. */
  147233. static GaussianKernel: number[];
  147234. }
  147235. }
  147236. declare module BABYLON {
  147237. /**
  147238. * The DepthOfFieldBlurPostProcess applied a blur in a give direction.
  147239. * This blur differs from the standard BlurPostProcess as it attempts to avoid blurring pixels
  147240. * based on samples that have a large difference in distance than the center pixel.
  147241. * See section 2.6.2 http://fileadmin.cs.lth.se/cs/education/edan35/lectures/12dof.pdf
  147242. */
  147243. export class DepthOfFieldBlurPostProcess extends BlurPostProcess {
  147244. direction: Vector2;
  147245. /**
  147246. * Creates a new instance CircleOfConfusionPostProcess
  147247. * @param name The name of the effect.
  147248. * @param scene The scene the effect belongs to.
  147249. * @param direction The direction the blur should be applied.
  147250. * @param kernel The size of the kernel used to blur.
  147251. * @param options The required width/height ratio to downsize to before computing the render pass.
  147252. * @param camera The camera to apply the render pass to.
  147253. * @param circleOfConfusion The circle of confusion + depth map to be used to avoid blurring accross edges
  147254. * @param imageToBlur The image to apply the blur to (default: Current rendered frame)
  147255. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  147256. * @param engine The engine which the post process will be applied. (default: current engine)
  147257. * @param reusable If the post process can be reused on the same frame. (default: false)
  147258. * @param textureType Type of textures used when performing the post process. (default: 0)
  147259. * @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)
  147260. */
  147261. 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);
  147262. }
  147263. }
  147264. declare module BABYLON {
  147265. /** @hidden */
  147266. export var depthOfFieldMergePixelShader: {
  147267. name: string;
  147268. shader: string;
  147269. };
  147270. }
  147271. declare module BABYLON {
  147272. /**
  147273. * Options to be set when merging outputs from the default pipeline.
  147274. */
  147275. export class DepthOfFieldMergePostProcessOptions {
  147276. /**
  147277. * The original image to merge on top of
  147278. */
  147279. originalFromInput: PostProcess;
  147280. /**
  147281. * Parameters to perform the merge of the depth of field effect
  147282. */
  147283. depthOfField?: {
  147284. circleOfConfusion: PostProcess;
  147285. blurSteps: Array<PostProcess>;
  147286. };
  147287. /**
  147288. * Parameters to perform the merge of bloom effect
  147289. */
  147290. bloom?: {
  147291. blurred: PostProcess;
  147292. weight: number;
  147293. };
  147294. }
  147295. /**
  147296. * The DepthOfFieldMergePostProcess merges blurred images with the original based on the values of the circle of confusion.
  147297. */
  147298. export class DepthOfFieldMergePostProcess extends PostProcess {
  147299. private blurSteps;
  147300. /**
  147301. * Creates a new instance of DepthOfFieldMergePostProcess
  147302. * @param name The name of the effect.
  147303. * @param originalFromInput Post process which's input will be used for the merge.
  147304. * @param circleOfConfusion Circle of confusion post process which's output will be used to blur each pixel.
  147305. * @param blurSteps Blur post processes from low to high which will be mixed with the original image.
  147306. * @param options The required width/height ratio to downsize to before computing the render pass.
  147307. * @param camera The camera to apply the render pass to.
  147308. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  147309. * @param engine The engine which the post process will be applied. (default: current engine)
  147310. * @param reusable If the post process can be reused on the same frame. (default: false)
  147311. * @param textureType Type of textures used when performing the post process. (default: 0)
  147312. * @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)
  147313. */
  147314. 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);
  147315. /**
  147316. * Updates the effect with the current post process compile time values and recompiles the shader.
  147317. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  147318. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  147319. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  147320. * @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
  147321. * @param onCompiled Called when the shader has been compiled.
  147322. * @param onError Called if there is an error when compiling a shader.
  147323. */
  147324. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  147325. }
  147326. }
  147327. declare module BABYLON {
  147328. /**
  147329. * Specifies the level of max blur that should be applied when using the depth of field effect
  147330. */
  147331. export enum DepthOfFieldEffectBlurLevel {
  147332. /**
  147333. * Subtle blur
  147334. */
  147335. Low = 0,
  147336. /**
  147337. * Medium blur
  147338. */
  147339. Medium = 1,
  147340. /**
  147341. * Large blur
  147342. */
  147343. High = 2
  147344. }
  147345. /**
  147346. * The depth of field effect applies a blur to objects that are closer or further from where the camera is focusing.
  147347. */
  147348. export class DepthOfFieldEffect extends PostProcessRenderEffect {
  147349. private _circleOfConfusion;
  147350. /**
  147351. * @hidden Internal, blurs from high to low
  147352. */
  147353. _depthOfFieldBlurX: Array<DepthOfFieldBlurPostProcess>;
  147354. private _depthOfFieldBlurY;
  147355. private _dofMerge;
  147356. /**
  147357. * @hidden Internal post processes in depth of field effect
  147358. */
  147359. _effects: Array<PostProcess>;
  147360. /**
  147361. * The focal the length of the camera used in the effect in scene units/1000 (eg. millimeter)
  147362. */
  147363. set focalLength(value: number);
  147364. get focalLength(): number;
  147365. /**
  147366. * F-Stop of the effect's camera. The diameter of the resulting aperture can be computed by lensSize/fStop. (default: 1.4)
  147367. */
  147368. set fStop(value: number);
  147369. get fStop(): number;
  147370. /**
  147371. * Distance away from the camera to focus on in scene units/1000 (eg. millimeter). (default: 2000)
  147372. */
  147373. set focusDistance(value: number);
  147374. get focusDistance(): number;
  147375. /**
  147376. * 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.
  147377. */
  147378. set lensSize(value: number);
  147379. get lensSize(): number;
  147380. /**
  147381. * Creates a new instance DepthOfFieldEffect
  147382. * @param scene The scene the effect belongs to.
  147383. * @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.
  147384. * @param pipelineTextureType The type of texture to be used when performing the post processing.
  147385. * @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)
  147386. */
  147387. constructor(scene: Scene, depthTexture: Nullable<RenderTargetTexture>, blurLevel?: DepthOfFieldEffectBlurLevel, pipelineTextureType?: number, blockCompilation?: boolean);
  147388. /**
  147389. * Get the current class name of the current effet
  147390. * @returns "DepthOfFieldEffect"
  147391. */
  147392. getClassName(): string;
  147393. /**
  147394. * 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.
  147395. */
  147396. set depthTexture(value: RenderTargetTexture);
  147397. /**
  147398. * Disposes each of the internal effects for a given camera.
  147399. * @param camera The camera to dispose the effect on.
  147400. */
  147401. disposeEffects(camera: Camera): void;
  147402. /**
  147403. * @hidden Internal
  147404. */
  147405. _updateEffects(): void;
  147406. /**
  147407. * Internal
  147408. * @returns if all the contained post processes are ready.
  147409. * @hidden
  147410. */
  147411. _isReady(): boolean;
  147412. }
  147413. }
  147414. declare module BABYLON {
  147415. /** @hidden */
  147416. export var displayPassPixelShader: {
  147417. name: string;
  147418. shader: string;
  147419. };
  147420. }
  147421. declare module BABYLON {
  147422. /**
  147423. * DisplayPassPostProcess which produces an output the same as it's input
  147424. */
  147425. export class DisplayPassPostProcess extends PostProcess {
  147426. /**
  147427. * Creates the DisplayPassPostProcess
  147428. * @param name The name of the effect.
  147429. * @param options The required width/height ratio to downsize to before computing the render pass.
  147430. * @param camera The camera to apply the render pass to.
  147431. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  147432. * @param engine The engine which the post process will be applied. (default: current engine)
  147433. * @param reusable If the post process can be reused on the same frame. (default: false)
  147434. */
  147435. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean);
  147436. }
  147437. }
  147438. declare module BABYLON {
  147439. /** @hidden */
  147440. export var filterPixelShader: {
  147441. name: string;
  147442. shader: string;
  147443. };
  147444. }
  147445. declare module BABYLON {
  147446. /**
  147447. * Applies a kernel filter to the image
  147448. */
  147449. export class FilterPostProcess extends PostProcess {
  147450. /** The matrix to be applied to the image */
  147451. kernelMatrix: Matrix;
  147452. /**
  147453. *
  147454. * @param name The name of the effect.
  147455. * @param kernelMatrix The matrix to be applied to the image
  147456. * @param options The required width/height ratio to downsize to before computing the render pass.
  147457. * @param camera The camera to apply the render pass to.
  147458. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  147459. * @param engine The engine which the post process will be applied. (default: current engine)
  147460. * @param reusable If the post process can be reused on the same frame. (default: false)
  147461. */
  147462. constructor(name: string,
  147463. /** The matrix to be applied to the image */
  147464. kernelMatrix: Matrix, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean);
  147465. }
  147466. }
  147467. declare module BABYLON {
  147468. /** @hidden */
  147469. export var fxaaPixelShader: {
  147470. name: string;
  147471. shader: string;
  147472. };
  147473. }
  147474. declare module BABYLON {
  147475. /** @hidden */
  147476. export var fxaaVertexShader: {
  147477. name: string;
  147478. shader: string;
  147479. };
  147480. }
  147481. declare module BABYLON {
  147482. /**
  147483. * Fxaa post process
  147484. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#fxaa
  147485. */
  147486. export class FxaaPostProcess extends PostProcess {
  147487. /** @hidden */
  147488. texelWidth: number;
  147489. /** @hidden */
  147490. texelHeight: number;
  147491. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  147492. private _getDefines;
  147493. }
  147494. }
  147495. declare module BABYLON {
  147496. /** @hidden */
  147497. export var grainPixelShader: {
  147498. name: string;
  147499. shader: string;
  147500. };
  147501. }
  147502. declare module BABYLON {
  147503. /**
  147504. * The GrainPostProcess adds noise to the image at mid luminance levels
  147505. */
  147506. export class GrainPostProcess extends PostProcess {
  147507. /**
  147508. * The intensity of the grain added (default: 30)
  147509. */
  147510. intensity: number;
  147511. /**
  147512. * If the grain should be randomized on every frame
  147513. */
  147514. animated: boolean;
  147515. /**
  147516. * Creates a new instance of @see GrainPostProcess
  147517. * @param name The name of the effect.
  147518. * @param options The required width/height ratio to downsize to before computing the render pass.
  147519. * @param camera The camera to apply the render pass to.
  147520. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  147521. * @param engine The engine which the post process will be applied. (default: current engine)
  147522. * @param reusable If the post process can be reused on the same frame. (default: false)
  147523. * @param textureType Type of textures used when performing the post process. (default: 0)
  147524. * @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)
  147525. */
  147526. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  147527. }
  147528. }
  147529. declare module BABYLON {
  147530. /** @hidden */
  147531. export var highlightsPixelShader: {
  147532. name: string;
  147533. shader: string;
  147534. };
  147535. }
  147536. declare module BABYLON {
  147537. /**
  147538. * Extracts highlights from the image
  147539. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  147540. */
  147541. export class HighlightsPostProcess extends PostProcess {
  147542. /**
  147543. * Extracts highlights from the image
  147544. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  147545. * @param name The name of the effect.
  147546. * @param options The required width/height ratio to downsize to before computing the render pass.
  147547. * @param camera The camera to apply the render pass to.
  147548. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  147549. * @param engine The engine which the post process will be applied. (default: current engine)
  147550. * @param reusable If the post process can be reused on the same frame. (default: false)
  147551. * @param textureType Type of texture for the post process (default: Engine.TEXTURETYPE_UNSIGNED_INT)
  147552. */
  147553. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  147554. }
  147555. }
  147556. declare module BABYLON {
  147557. /** @hidden */
  147558. export var mrtFragmentDeclaration: {
  147559. name: string;
  147560. shader: string;
  147561. };
  147562. }
  147563. declare module BABYLON {
  147564. /** @hidden */
  147565. export var geometryPixelShader: {
  147566. name: string;
  147567. shader: string;
  147568. };
  147569. }
  147570. declare module BABYLON {
  147571. /** @hidden */
  147572. export var geometryVertexShader: {
  147573. name: string;
  147574. shader: string;
  147575. };
  147576. }
  147577. declare module BABYLON {
  147578. /** @hidden */
  147579. interface ISavedTransformationMatrix {
  147580. world: Matrix;
  147581. viewProjection: Matrix;
  147582. }
  147583. /**
  147584. * This renderer is helpfull to fill one of the render target with a geometry buffer.
  147585. */
  147586. export class GeometryBufferRenderer {
  147587. /**
  147588. * Constant used to retrieve the position texture index in the G-Buffer textures array
  147589. * using getIndex(GeometryBufferRenderer.POSITION_TEXTURE_INDEX)
  147590. */
  147591. static readonly POSITION_TEXTURE_TYPE: number;
  147592. /**
  147593. * Constant used to retrieve the velocity texture index in the G-Buffer textures array
  147594. * using getIndex(GeometryBufferRenderer.VELOCITY_TEXTURE_INDEX)
  147595. */
  147596. static readonly VELOCITY_TEXTURE_TYPE: number;
  147597. /**
  147598. * Constant used to retrieve the reflectivity texture index in the G-Buffer textures array
  147599. * using the getIndex(GeometryBufferRenderer.REFLECTIVITY_TEXTURE_TYPE)
  147600. */
  147601. static readonly REFLECTIVITY_TEXTURE_TYPE: number;
  147602. /**
  147603. * Dictionary used to store the previous transformation matrices of each rendered mesh
  147604. * in order to compute objects velocities when enableVelocity is set to "true"
  147605. * @hidden
  147606. */
  147607. _previousTransformationMatrices: {
  147608. [index: number]: ISavedTransformationMatrix;
  147609. };
  147610. /**
  147611. * Dictionary used to store the previous bones transformation matrices of each rendered mesh
  147612. * in order to compute objects velocities when enableVelocity is set to "true"
  147613. * @hidden
  147614. */
  147615. _previousBonesTransformationMatrices: {
  147616. [index: number]: Float32Array;
  147617. };
  147618. /**
  147619. * Array used to store the ignored skinned meshes while computing velocity map (typically used by the motion blur post-process).
  147620. * Avoids computing bones velocities and computes only mesh's velocity itself (position, rotation, scaling).
  147621. */
  147622. excludedSkinnedMeshesFromVelocity: AbstractMesh[];
  147623. /** Gets or sets a boolean indicating if transparent meshes should be rendered */
  147624. renderTransparentMeshes: boolean;
  147625. private _scene;
  147626. private _resizeObserver;
  147627. private _multiRenderTarget;
  147628. private _ratio;
  147629. private _enablePosition;
  147630. private _enableVelocity;
  147631. private _enableReflectivity;
  147632. private _positionIndex;
  147633. private _velocityIndex;
  147634. private _reflectivityIndex;
  147635. protected _effect: Effect;
  147636. protected _cachedDefines: string;
  147637. /**
  147638. * Set the render list (meshes to be rendered) used in the G buffer.
  147639. */
  147640. set renderList(meshes: Mesh[]);
  147641. /**
  147642. * Gets wether or not G buffer are supported by the running hardware.
  147643. * This requires draw buffer supports
  147644. */
  147645. get isSupported(): boolean;
  147646. /**
  147647. * Returns the index of the given texture type in the G-Buffer textures array
  147648. * @param textureType The texture type constant. For example GeometryBufferRenderer.POSITION_TEXTURE_INDEX
  147649. * @returns the index of the given texture type in the G-Buffer textures array
  147650. */
  147651. getTextureIndex(textureType: number): number;
  147652. /**
  147653. * Gets a boolean indicating if objects positions are enabled for the G buffer.
  147654. */
  147655. get enablePosition(): boolean;
  147656. /**
  147657. * Sets whether or not objects positions are enabled for the G buffer.
  147658. */
  147659. set enablePosition(enable: boolean);
  147660. /**
  147661. * Gets a boolean indicating if objects velocities are enabled for the G buffer.
  147662. */
  147663. get enableVelocity(): boolean;
  147664. /**
  147665. * Sets wether or not objects velocities are enabled for the G buffer.
  147666. */
  147667. set enableVelocity(enable: boolean);
  147668. /**
  147669. * Gets a boolean indicating if objects roughness are enabled in the G buffer.
  147670. */
  147671. get enableReflectivity(): boolean;
  147672. /**
  147673. * Sets wether or not objects roughness are enabled for the G buffer.
  147674. */
  147675. set enableReflectivity(enable: boolean);
  147676. /**
  147677. * Gets the scene associated with the buffer.
  147678. */
  147679. get scene(): Scene;
  147680. /**
  147681. * Gets the ratio used by the buffer during its creation.
  147682. * How big is the buffer related to the main canvas.
  147683. */
  147684. get ratio(): number;
  147685. /** @hidden */
  147686. static _SceneComponentInitialization: (scene: Scene) => void;
  147687. /**
  147688. * Creates a new G Buffer for the scene
  147689. * @param scene The scene the buffer belongs to
  147690. * @param ratio How big is the buffer related to the main canvas.
  147691. */
  147692. constructor(scene: Scene, ratio?: number);
  147693. /**
  147694. * Checks wether everything is ready to render a submesh to the G buffer.
  147695. * @param subMesh the submesh to check readiness for
  147696. * @param useInstances is the mesh drawn using instance or not
  147697. * @returns true if ready otherwise false
  147698. */
  147699. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  147700. /**
  147701. * Gets the current underlying G Buffer.
  147702. * @returns the buffer
  147703. */
  147704. getGBuffer(): MultiRenderTarget;
  147705. /**
  147706. * Gets the number of samples used to render the buffer (anti aliasing).
  147707. */
  147708. get samples(): number;
  147709. /**
  147710. * Sets the number of samples used to render the buffer (anti aliasing).
  147711. */
  147712. set samples(value: number);
  147713. /**
  147714. * Disposes the renderer and frees up associated resources.
  147715. */
  147716. dispose(): void;
  147717. protected _createRenderTargets(): void;
  147718. private _copyBonesTransformationMatrices;
  147719. }
  147720. }
  147721. declare module BABYLON {
  147722. interface Scene {
  147723. /** @hidden (Backing field) */
  147724. _geometryBufferRenderer: Nullable<GeometryBufferRenderer>;
  147725. /**
  147726. * Gets or Sets the current geometry buffer associated to the scene.
  147727. */
  147728. geometryBufferRenderer: Nullable<GeometryBufferRenderer>;
  147729. /**
  147730. * Enables a GeometryBufferRender and associates it with the scene
  147731. * @param ratio defines the scaling ratio to apply to the renderer (1 by default which means same resolution)
  147732. * @returns the GeometryBufferRenderer
  147733. */
  147734. enableGeometryBufferRenderer(ratio?: number): Nullable<GeometryBufferRenderer>;
  147735. /**
  147736. * Disables the GeometryBufferRender associated with the scene
  147737. */
  147738. disableGeometryBufferRenderer(): void;
  147739. }
  147740. /**
  147741. * Defines the Geometry Buffer scene component responsible to manage a G-Buffer useful
  147742. * in several rendering techniques.
  147743. */
  147744. export class GeometryBufferRendererSceneComponent implements ISceneComponent {
  147745. /**
  147746. * The component name helpful to identify the component in the list of scene components.
  147747. */
  147748. readonly name: string;
  147749. /**
  147750. * The scene the component belongs to.
  147751. */
  147752. scene: Scene;
  147753. /**
  147754. * Creates a new instance of the component for the given scene
  147755. * @param scene Defines the scene to register the component in
  147756. */
  147757. constructor(scene: Scene);
  147758. /**
  147759. * Registers the component in a given scene
  147760. */
  147761. register(): void;
  147762. /**
  147763. * Rebuilds the elements related to this component in case of
  147764. * context lost for instance.
  147765. */
  147766. rebuild(): void;
  147767. /**
  147768. * Disposes the component and the associated ressources
  147769. */
  147770. dispose(): void;
  147771. private _gatherRenderTargets;
  147772. }
  147773. }
  147774. declare module BABYLON {
  147775. /** @hidden */
  147776. export var motionBlurPixelShader: {
  147777. name: string;
  147778. shader: string;
  147779. };
  147780. }
  147781. declare module BABYLON {
  147782. /**
  147783. * The Motion Blur Post Process which blurs an image based on the objects velocity in scene.
  147784. * Velocity can be affected by each object's rotation, position and scale depending on the transformation speed.
  147785. * As an example, all you have to do is to create the post-process:
  147786. * var mb = new BABYLON.MotionBlurPostProcess(
  147787. * 'mb', // The name of the effect.
  147788. * scene, // The scene containing the objects to blur according to their velocity.
  147789. * 1.0, // The required width/height ratio to downsize to before computing the render pass.
  147790. * camera // The camera to apply the render pass to.
  147791. * );
  147792. * Then, all objects moving, rotating and/or scaling will be blurred depending on the transformation speed.
  147793. */
  147794. export class MotionBlurPostProcess extends PostProcess {
  147795. /**
  147796. * Defines how much the image is blurred by the movement. Default value is equal to 1
  147797. */
  147798. motionStrength: number;
  147799. /**
  147800. * Gets the number of iterations are used for motion blur quality. Default value is equal to 32
  147801. */
  147802. get motionBlurSamples(): number;
  147803. /**
  147804. * Sets the number of iterations to be used for motion blur quality
  147805. */
  147806. set motionBlurSamples(samples: number);
  147807. private _motionBlurSamples;
  147808. private _geometryBufferRenderer;
  147809. /**
  147810. * Creates a new instance MotionBlurPostProcess
  147811. * @param name The name of the effect.
  147812. * @param scene The scene containing the objects to blur according to their velocity.
  147813. * @param options The required width/height ratio to downsize to before computing the render pass.
  147814. * @param camera The camera to apply the render pass to.
  147815. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  147816. * @param engine The engine which the post process will be applied. (default: current engine)
  147817. * @param reusable If the post process can be reused on the same frame. (default: false)
  147818. * @param textureType Type of textures used when performing the post process. (default: 0)
  147819. * @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)
  147820. */
  147821. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  147822. /**
  147823. * Excludes the given skinned mesh from computing bones velocities.
  147824. * 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.
  147825. * @param skinnedMesh The mesh containing the skeleton to ignore when computing the velocity map.
  147826. */
  147827. excludeSkinnedMesh(skinnedMesh: AbstractMesh): void;
  147828. /**
  147829. * Removes the given skinned mesh from the excluded meshes to integrate bones velocities while rendering the velocity map.
  147830. * @param skinnedMesh The mesh containing the skeleton that has been ignored previously.
  147831. * @see excludeSkinnedMesh to exclude a skinned mesh from bones velocity computation.
  147832. */
  147833. removeExcludedSkinnedMesh(skinnedMesh: AbstractMesh): void;
  147834. /**
  147835. * Disposes the post process.
  147836. * @param camera The camera to dispose the post process on.
  147837. */
  147838. dispose(camera?: Camera): void;
  147839. }
  147840. }
  147841. declare module BABYLON {
  147842. /** @hidden */
  147843. export var refractionPixelShader: {
  147844. name: string;
  147845. shader: string;
  147846. };
  147847. }
  147848. declare module BABYLON {
  147849. /**
  147850. * Post process which applies a refractin texture
  147851. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#refraction
  147852. */
  147853. export class RefractionPostProcess extends PostProcess {
  147854. /** the base color of the refraction (used to taint the rendering) */
  147855. color: Color3;
  147856. /** simulated refraction depth */
  147857. depth: number;
  147858. /** the coefficient of the base color (0 to remove base color tainting) */
  147859. colorLevel: number;
  147860. private _refTexture;
  147861. private _ownRefractionTexture;
  147862. /**
  147863. * Gets or sets the refraction texture
  147864. * Please note that you are responsible for disposing the texture if you set it manually
  147865. */
  147866. get refractionTexture(): Texture;
  147867. set refractionTexture(value: Texture);
  147868. /**
  147869. * Initializes the RefractionPostProcess
  147870. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#refraction
  147871. * @param name The name of the effect.
  147872. * @param refractionTextureUrl Url of the refraction texture to use
  147873. * @param color the base color of the refraction (used to taint the rendering)
  147874. * @param depth simulated refraction depth
  147875. * @param colorLevel the coefficient of the base color (0 to remove base color tainting)
  147876. * @param camera The camera to apply the render pass to.
  147877. * @param options The required width/height ratio to downsize to before computing the render pass.
  147878. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  147879. * @param engine The engine which the post process will be applied. (default: current engine)
  147880. * @param reusable If the post process can be reused on the same frame. (default: false)
  147881. */
  147882. constructor(name: string, refractionTextureUrl: string,
  147883. /** the base color of the refraction (used to taint the rendering) */
  147884. color: Color3,
  147885. /** simulated refraction depth */
  147886. depth: number,
  147887. /** the coefficient of the base color (0 to remove base color tainting) */
  147888. colorLevel: number, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  147889. /**
  147890. * Disposes of the post process
  147891. * @param camera Camera to dispose post process on
  147892. */
  147893. dispose(camera: Camera): void;
  147894. }
  147895. }
  147896. declare module BABYLON {
  147897. /** @hidden */
  147898. export var sharpenPixelShader: {
  147899. name: string;
  147900. shader: string;
  147901. };
  147902. }
  147903. declare module BABYLON {
  147904. /**
  147905. * The SharpenPostProcess applies a sharpen kernel to every pixel
  147906. * See http://en.wikipedia.org/wiki/Kernel_(image_processing)
  147907. */
  147908. export class SharpenPostProcess extends PostProcess {
  147909. /**
  147910. * How much of the original color should be applied. Setting this to 0 will display edge detection. (default: 1)
  147911. */
  147912. colorAmount: number;
  147913. /**
  147914. * How much sharpness should be applied (default: 0.3)
  147915. */
  147916. edgeAmount: number;
  147917. /**
  147918. * Creates a new instance ConvolutionPostProcess
  147919. * @param name The name of the effect.
  147920. * @param options The required width/height ratio to downsize to before computing the render pass.
  147921. * @param camera The camera to apply the render pass to.
  147922. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  147923. * @param engine The engine which the post process will be applied. (default: current engine)
  147924. * @param reusable If the post process can be reused on the same frame. (default: false)
  147925. * @param textureType Type of textures used when performing the post process. (default: 0)
  147926. * @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)
  147927. */
  147928. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  147929. }
  147930. }
  147931. declare module BABYLON {
  147932. /**
  147933. * PostProcessRenderPipeline
  147934. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  147935. */
  147936. export class PostProcessRenderPipeline {
  147937. private engine;
  147938. private _renderEffects;
  147939. private _renderEffectsForIsolatedPass;
  147940. /**
  147941. * List of inspectable custom properties (used by the Inspector)
  147942. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  147943. */
  147944. inspectableCustomProperties: IInspectable[];
  147945. /**
  147946. * @hidden
  147947. */
  147948. protected _cameras: Camera[];
  147949. /** @hidden */
  147950. _name: string;
  147951. /**
  147952. * Gets pipeline name
  147953. */
  147954. get name(): string;
  147955. /** Gets the list of attached cameras */
  147956. get cameras(): Camera[];
  147957. /**
  147958. * Initializes a PostProcessRenderPipeline
  147959. * @param engine engine to add the pipeline to
  147960. * @param name name of the pipeline
  147961. */
  147962. constructor(engine: Engine, name: string);
  147963. /**
  147964. * Gets the class name
  147965. * @returns "PostProcessRenderPipeline"
  147966. */
  147967. getClassName(): string;
  147968. /**
  147969. * If all the render effects in the pipeline are supported
  147970. */
  147971. get isSupported(): boolean;
  147972. /**
  147973. * Adds an effect to the pipeline
  147974. * @param renderEffect the effect to add
  147975. */
  147976. addEffect(renderEffect: PostProcessRenderEffect): void;
  147977. /** @hidden */
  147978. _rebuild(): void;
  147979. /** @hidden */
  147980. _enableEffect(renderEffectName: string, cameras: Camera): void;
  147981. /** @hidden */
  147982. _enableEffect(renderEffectName: string, cameras: Camera[]): void;
  147983. /** @hidden */
  147984. _disableEffect(renderEffectName: string, cameras: Nullable<Camera[]>): void;
  147985. /** @hidden */
  147986. _disableEffect(renderEffectName: string, cameras: Nullable<Camera[]>): void;
  147987. /** @hidden */
  147988. _attachCameras(cameras: Camera, unique: boolean): void;
  147989. /** @hidden */
  147990. _attachCameras(cameras: Camera[], unique: boolean): void;
  147991. /** @hidden */
  147992. _detachCameras(cameras: Camera): void;
  147993. /** @hidden */
  147994. _detachCameras(cameras: Nullable<Camera[]>): void;
  147995. /** @hidden */
  147996. _update(): void;
  147997. /** @hidden */
  147998. _reset(): void;
  147999. protected _enableMSAAOnFirstPostProcess(sampleCount: number): boolean;
  148000. /**
  148001. * Sets the required values to the prepass renderer.
  148002. * @param prePassRenderer defines the prepass renderer to setup.
  148003. * @returns true if the pre pass is needed.
  148004. */
  148005. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  148006. /**
  148007. * Disposes of the pipeline
  148008. */
  148009. dispose(): void;
  148010. }
  148011. }
  148012. declare module BABYLON {
  148013. /**
  148014. * PostProcessRenderPipelineManager class
  148015. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  148016. */
  148017. export class PostProcessRenderPipelineManager {
  148018. private _renderPipelines;
  148019. /**
  148020. * Initializes a PostProcessRenderPipelineManager
  148021. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  148022. */
  148023. constructor();
  148024. /**
  148025. * Gets the list of supported render pipelines
  148026. */
  148027. get supportedPipelines(): PostProcessRenderPipeline[];
  148028. /**
  148029. * Adds a pipeline to the manager
  148030. * @param renderPipeline The pipeline to add
  148031. */
  148032. addPipeline(renderPipeline: PostProcessRenderPipeline): void;
  148033. /**
  148034. * Attaches a camera to the pipeline
  148035. * @param renderPipelineName The name of the pipeline to attach to
  148036. * @param cameras the camera to attach
  148037. * @param unique if the camera can be attached multiple times to the pipeline
  148038. */
  148039. attachCamerasToRenderPipeline(renderPipelineName: string, cameras: any | Camera[] | Camera, unique?: boolean): void;
  148040. /**
  148041. * Detaches a camera from the pipeline
  148042. * @param renderPipelineName The name of the pipeline to detach from
  148043. * @param cameras the camera to detach
  148044. */
  148045. detachCamerasFromRenderPipeline(renderPipelineName: string, cameras: any | Camera[] | Camera): void;
  148046. /**
  148047. * Enables an effect by name on a pipeline
  148048. * @param renderPipelineName the name of the pipeline to enable the effect in
  148049. * @param renderEffectName the name of the effect to enable
  148050. * @param cameras the cameras that the effect should be enabled on
  148051. */
  148052. enableEffectInPipeline(renderPipelineName: string, renderEffectName: string, cameras: any | Camera[] | Camera): void;
  148053. /**
  148054. * Disables an effect by name on a pipeline
  148055. * @param renderPipelineName the name of the pipeline to disable the effect in
  148056. * @param renderEffectName the name of the effect to disable
  148057. * @param cameras the cameras that the effect should be disabled on
  148058. */
  148059. disableEffectInPipeline(renderPipelineName: string, renderEffectName: string, cameras: any | Camera[] | Camera): void;
  148060. /**
  148061. * Updates the state of all contained render pipelines and disposes of any non supported pipelines
  148062. */
  148063. update(): void;
  148064. /** @hidden */
  148065. _rebuild(): void;
  148066. /**
  148067. * Disposes of the manager and pipelines
  148068. */
  148069. dispose(): void;
  148070. }
  148071. }
  148072. declare module BABYLON {
  148073. interface Scene {
  148074. /** @hidden (Backing field) */
  148075. _postProcessRenderPipelineManager: PostProcessRenderPipelineManager;
  148076. /**
  148077. * Gets the postprocess render pipeline manager
  148078. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  148079. * @see https://doc.babylonjs.com/how_to/using_default_rendering_pipeline
  148080. */
  148081. readonly postProcessRenderPipelineManager: PostProcessRenderPipelineManager;
  148082. }
  148083. /**
  148084. * Defines the Render Pipeline scene component responsible to rendering pipelines
  148085. */
  148086. export class PostProcessRenderPipelineManagerSceneComponent implements ISceneComponent {
  148087. /**
  148088. * The component name helpfull to identify the component in the list of scene components.
  148089. */
  148090. readonly name: string;
  148091. /**
  148092. * The scene the component belongs to.
  148093. */
  148094. scene: Scene;
  148095. /**
  148096. * Creates a new instance of the component for the given scene
  148097. * @param scene Defines the scene to register the component in
  148098. */
  148099. constructor(scene: Scene);
  148100. /**
  148101. * Registers the component in a given scene
  148102. */
  148103. register(): void;
  148104. /**
  148105. * Rebuilds the elements related to this component in case of
  148106. * context lost for instance.
  148107. */
  148108. rebuild(): void;
  148109. /**
  148110. * Disposes the component and the associated ressources
  148111. */
  148112. dispose(): void;
  148113. private _gatherRenderTargets;
  148114. }
  148115. }
  148116. declare module BABYLON {
  148117. /**
  148118. * The default rendering pipeline can be added to a scene to apply common post processing effects such as anti-aliasing or depth of field.
  148119. * See https://doc.babylonjs.com/how_to/using_default_rendering_pipeline
  148120. */
  148121. export class DefaultRenderingPipeline extends PostProcessRenderPipeline implements IDisposable, IAnimatable {
  148122. private _scene;
  148123. private _camerasToBeAttached;
  148124. /**
  148125. * ID of the sharpen post process,
  148126. */
  148127. private readonly SharpenPostProcessId;
  148128. /**
  148129. * @ignore
  148130. * ID of the image processing post process;
  148131. */
  148132. readonly ImageProcessingPostProcessId: string;
  148133. /**
  148134. * @ignore
  148135. * ID of the Fast Approximate Anti-Aliasing post process;
  148136. */
  148137. readonly FxaaPostProcessId: string;
  148138. /**
  148139. * ID of the chromatic aberration post process,
  148140. */
  148141. private readonly ChromaticAberrationPostProcessId;
  148142. /**
  148143. * ID of the grain post process
  148144. */
  148145. private readonly GrainPostProcessId;
  148146. /**
  148147. * Sharpen post process which will apply a sharpen convolution to enhance edges
  148148. */
  148149. sharpen: SharpenPostProcess;
  148150. private _sharpenEffect;
  148151. private bloom;
  148152. /**
  148153. * Depth of field effect, applies a blur based on how far away objects are from the focus distance.
  148154. */
  148155. depthOfField: DepthOfFieldEffect;
  148156. /**
  148157. * The Fast Approximate Anti-Aliasing post process which attemps to remove aliasing from an image.
  148158. */
  148159. fxaa: FxaaPostProcess;
  148160. /**
  148161. * Image post processing pass used to perform operations such as tone mapping or color grading.
  148162. */
  148163. imageProcessing: ImageProcessingPostProcess;
  148164. /**
  148165. * Chromatic aberration post process which will shift rgb colors in the image
  148166. */
  148167. chromaticAberration: ChromaticAberrationPostProcess;
  148168. private _chromaticAberrationEffect;
  148169. /**
  148170. * Grain post process which add noise to the image
  148171. */
  148172. grain: GrainPostProcess;
  148173. private _grainEffect;
  148174. /**
  148175. * Glow post process which adds a glow to emissive areas of the image
  148176. */
  148177. private _glowLayer;
  148178. /**
  148179. * Animations which can be used to tweak settings over a period of time
  148180. */
  148181. animations: Animation[];
  148182. private _imageProcessingConfigurationObserver;
  148183. private _sharpenEnabled;
  148184. private _bloomEnabled;
  148185. private _depthOfFieldEnabled;
  148186. private _depthOfFieldBlurLevel;
  148187. private _fxaaEnabled;
  148188. private _imageProcessingEnabled;
  148189. private _defaultPipelineTextureType;
  148190. private _bloomScale;
  148191. private _chromaticAberrationEnabled;
  148192. private _grainEnabled;
  148193. private _buildAllowed;
  148194. /**
  148195. * Gets active scene
  148196. */
  148197. get scene(): Scene;
  148198. /**
  148199. * Enable or disable the sharpen process from the pipeline
  148200. */
  148201. set sharpenEnabled(enabled: boolean);
  148202. get sharpenEnabled(): boolean;
  148203. private _resizeObserver;
  148204. private _hardwareScaleLevel;
  148205. private _bloomKernel;
  148206. /**
  148207. * Specifies the size of the bloom blur kernel, relative to the final output size
  148208. */
  148209. get bloomKernel(): number;
  148210. set bloomKernel(value: number);
  148211. /**
  148212. * Specifies the weight of the bloom in the final rendering
  148213. */
  148214. private _bloomWeight;
  148215. /**
  148216. * Specifies the luma threshold for the area that will be blurred by the bloom
  148217. */
  148218. private _bloomThreshold;
  148219. private _hdr;
  148220. /**
  148221. * The strength of the bloom.
  148222. */
  148223. set bloomWeight(value: number);
  148224. get bloomWeight(): number;
  148225. /**
  148226. * The strength of the bloom.
  148227. */
  148228. set bloomThreshold(value: number);
  148229. get bloomThreshold(): number;
  148230. /**
  148231. * The scale of the bloom, lower value will provide better performance.
  148232. */
  148233. set bloomScale(value: number);
  148234. get bloomScale(): number;
  148235. /**
  148236. * Enable or disable the bloom from the pipeline
  148237. */
  148238. set bloomEnabled(enabled: boolean);
  148239. get bloomEnabled(): boolean;
  148240. private _rebuildBloom;
  148241. /**
  148242. * If the depth of field is enabled.
  148243. */
  148244. get depthOfFieldEnabled(): boolean;
  148245. set depthOfFieldEnabled(enabled: boolean);
  148246. /**
  148247. * Blur level of the depth of field effect. (Higher blur will effect performance)
  148248. */
  148249. get depthOfFieldBlurLevel(): DepthOfFieldEffectBlurLevel;
  148250. set depthOfFieldBlurLevel(value: DepthOfFieldEffectBlurLevel);
  148251. /**
  148252. * If the anti aliasing is enabled.
  148253. */
  148254. set fxaaEnabled(enabled: boolean);
  148255. get fxaaEnabled(): boolean;
  148256. private _samples;
  148257. /**
  148258. * MSAA sample count, setting this to 4 will provide 4x anti aliasing. (default: 1)
  148259. */
  148260. set samples(sampleCount: number);
  148261. get samples(): number;
  148262. /**
  148263. * If image processing is enabled.
  148264. */
  148265. set imageProcessingEnabled(enabled: boolean);
  148266. get imageProcessingEnabled(): boolean;
  148267. /**
  148268. * If glow layer is enabled. (Adds a glow effect to emmissive materials)
  148269. */
  148270. set glowLayerEnabled(enabled: boolean);
  148271. get glowLayerEnabled(): boolean;
  148272. /**
  148273. * Gets the glow layer (or null if not defined)
  148274. */
  148275. get glowLayer(): Nullable<GlowLayer>;
  148276. /**
  148277. * Enable or disable the chromaticAberration process from the pipeline
  148278. */
  148279. set chromaticAberrationEnabled(enabled: boolean);
  148280. get chromaticAberrationEnabled(): boolean;
  148281. /**
  148282. * Enable or disable the grain process from the pipeline
  148283. */
  148284. set grainEnabled(enabled: boolean);
  148285. get grainEnabled(): boolean;
  148286. /**
  148287. * @constructor
  148288. * @param name - The rendering pipeline name (default: "")
  148289. * @param hdr - If high dynamic range textures should be used (default: true)
  148290. * @param scene - The scene linked to this pipeline (default: the last created scene)
  148291. * @param cameras - The array of cameras that the rendering pipeline will be attached to (default: scene.cameras)
  148292. * @param automaticBuild - if false, you will have to manually call prepare() to update the pipeline (default: true)
  148293. */
  148294. constructor(name?: string, hdr?: boolean, scene?: Scene, cameras?: Camera[], automaticBuild?: boolean);
  148295. /**
  148296. * Get the class name
  148297. * @returns "DefaultRenderingPipeline"
  148298. */
  148299. getClassName(): string;
  148300. /**
  148301. * Force the compilation of the entire pipeline.
  148302. */
  148303. prepare(): void;
  148304. private _hasCleared;
  148305. private _prevPostProcess;
  148306. private _prevPrevPostProcess;
  148307. private _setAutoClearAndTextureSharing;
  148308. private _depthOfFieldSceneObserver;
  148309. private _buildPipeline;
  148310. private _disposePostProcesses;
  148311. /**
  148312. * Adds a camera to the pipeline
  148313. * @param camera the camera to be added
  148314. */
  148315. addCamera(camera: Camera): void;
  148316. /**
  148317. * Removes a camera from the pipeline
  148318. * @param camera the camera to remove
  148319. */
  148320. removeCamera(camera: Camera): void;
  148321. /**
  148322. * Dispose of the pipeline and stop all post processes
  148323. */
  148324. dispose(): void;
  148325. /**
  148326. * Serialize the rendering pipeline (Used when exporting)
  148327. * @returns the serialized object
  148328. */
  148329. serialize(): any;
  148330. /**
  148331. * Parse the serialized pipeline
  148332. * @param source Source pipeline.
  148333. * @param scene The scene to load the pipeline to.
  148334. * @param rootUrl The URL of the serialized pipeline.
  148335. * @returns An instantiated pipeline from the serialized object.
  148336. */
  148337. static Parse(source: any, scene: Scene, rootUrl: string): DefaultRenderingPipeline;
  148338. }
  148339. }
  148340. declare module BABYLON {
  148341. /** @hidden */
  148342. export var lensHighlightsPixelShader: {
  148343. name: string;
  148344. shader: string;
  148345. };
  148346. }
  148347. declare module BABYLON {
  148348. /** @hidden */
  148349. export var depthOfFieldPixelShader: {
  148350. name: string;
  148351. shader: string;
  148352. };
  148353. }
  148354. declare module BABYLON {
  148355. /**
  148356. * BABYLON.JS Chromatic Aberration GLSL Shader
  148357. * Author: Olivier Guyot
  148358. * Separates very slightly R, G and B colors on the edges of the screen
  148359. * Inspired by Francois Tarlier & Martins Upitis
  148360. */
  148361. export class LensRenderingPipeline extends PostProcessRenderPipeline {
  148362. /**
  148363. * @ignore
  148364. * The chromatic aberration PostProcess id in the pipeline
  148365. */
  148366. LensChromaticAberrationEffect: string;
  148367. /**
  148368. * @ignore
  148369. * The highlights enhancing PostProcess id in the pipeline
  148370. */
  148371. HighlightsEnhancingEffect: string;
  148372. /**
  148373. * @ignore
  148374. * The depth-of-field PostProcess id in the pipeline
  148375. */
  148376. LensDepthOfFieldEffect: string;
  148377. private _scene;
  148378. private _depthTexture;
  148379. private _grainTexture;
  148380. private _chromaticAberrationPostProcess;
  148381. private _highlightsPostProcess;
  148382. private _depthOfFieldPostProcess;
  148383. private _edgeBlur;
  148384. private _grainAmount;
  148385. private _chromaticAberration;
  148386. private _distortion;
  148387. private _highlightsGain;
  148388. private _highlightsThreshold;
  148389. private _dofDistance;
  148390. private _dofAperture;
  148391. private _dofDarken;
  148392. private _dofPentagon;
  148393. private _blurNoise;
  148394. /**
  148395. * @constructor
  148396. *
  148397. * Effect parameters are as follow:
  148398. * {
  148399. * chromatic_aberration: number; // from 0 to x (1 for realism)
  148400. * edge_blur: number; // from 0 to x (1 for realism)
  148401. * distortion: number; // from 0 to x (1 for realism)
  148402. * grain_amount: number; // from 0 to 1
  148403. * grain_texture: BABYLON.Texture; // texture to use for grain effect; if unset, use random B&W noise
  148404. * dof_focus_distance: number; // depth-of-field: focus distance; unset to disable (disabled by default)
  148405. * dof_aperture: number; // depth-of-field: focus blur bias (default: 1)
  148406. * dof_darken: number; // depth-of-field: darken that which is out of focus (from 0 to 1, disabled by default)
  148407. * dof_pentagon: boolean; // depth-of-field: makes a pentagon-like "bokeh" effect
  148408. * dof_gain: number; // depth-of-field: highlights gain; unset to disable (disabled by default)
  148409. * dof_threshold: number; // depth-of-field: highlights threshold (default: 1)
  148410. * blur_noise: boolean; // add a little bit of noise to the blur (default: true)
  148411. * }
  148412. * Note: if an effect parameter is unset, effect is disabled
  148413. *
  148414. * @param name The rendering pipeline name
  148415. * @param parameters - An object containing all parameters (see above)
  148416. * @param scene The scene linked to this pipeline
  148417. * @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)
  148418. * @param cameras The array of cameras that the rendering pipeline will be attached to
  148419. */
  148420. constructor(name: string, parameters: any, scene: Scene, ratio?: number, cameras?: Camera[]);
  148421. /**
  148422. * Get the class name
  148423. * @returns "LensRenderingPipeline"
  148424. */
  148425. getClassName(): string;
  148426. /**
  148427. * Gets associated scene
  148428. */
  148429. get scene(): Scene;
  148430. /**
  148431. * Gets or sets the edge blur
  148432. */
  148433. get edgeBlur(): number;
  148434. set edgeBlur(value: number);
  148435. /**
  148436. * Gets or sets the grain amount
  148437. */
  148438. get grainAmount(): number;
  148439. set grainAmount(value: number);
  148440. /**
  148441. * Gets or sets the chromatic aberration amount
  148442. */
  148443. get chromaticAberration(): number;
  148444. set chromaticAberration(value: number);
  148445. /**
  148446. * Gets or sets the depth of field aperture
  148447. */
  148448. get dofAperture(): number;
  148449. set dofAperture(value: number);
  148450. /**
  148451. * Gets or sets the edge distortion
  148452. */
  148453. get edgeDistortion(): number;
  148454. set edgeDistortion(value: number);
  148455. /**
  148456. * Gets or sets the depth of field distortion
  148457. */
  148458. get dofDistortion(): number;
  148459. set dofDistortion(value: number);
  148460. /**
  148461. * Gets or sets the darken out of focus amount
  148462. */
  148463. get darkenOutOfFocus(): number;
  148464. set darkenOutOfFocus(value: number);
  148465. /**
  148466. * Gets or sets a boolean indicating if blur noise is enabled
  148467. */
  148468. get blurNoise(): boolean;
  148469. set blurNoise(value: boolean);
  148470. /**
  148471. * Gets or sets a boolean indicating if pentagon bokeh is enabled
  148472. */
  148473. get pentagonBokeh(): boolean;
  148474. set pentagonBokeh(value: boolean);
  148475. /**
  148476. * Gets or sets the highlight grain amount
  148477. */
  148478. get highlightsGain(): number;
  148479. set highlightsGain(value: number);
  148480. /**
  148481. * Gets or sets the highlight threshold
  148482. */
  148483. get highlightsThreshold(): number;
  148484. set highlightsThreshold(value: number);
  148485. /**
  148486. * Sets the amount of blur at the edges
  148487. * @param amount blur amount
  148488. */
  148489. setEdgeBlur(amount: number): void;
  148490. /**
  148491. * Sets edge blur to 0
  148492. */
  148493. disableEdgeBlur(): void;
  148494. /**
  148495. * Sets the amout of grain
  148496. * @param amount Amount of grain
  148497. */
  148498. setGrainAmount(amount: number): void;
  148499. /**
  148500. * Set grain amount to 0
  148501. */
  148502. disableGrain(): void;
  148503. /**
  148504. * Sets the chromatic aberration amount
  148505. * @param amount amount of chromatic aberration
  148506. */
  148507. setChromaticAberration(amount: number): void;
  148508. /**
  148509. * Sets chromatic aberration amount to 0
  148510. */
  148511. disableChromaticAberration(): void;
  148512. /**
  148513. * Sets the EdgeDistortion amount
  148514. * @param amount amount of EdgeDistortion
  148515. */
  148516. setEdgeDistortion(amount: number): void;
  148517. /**
  148518. * Sets edge distortion to 0
  148519. */
  148520. disableEdgeDistortion(): void;
  148521. /**
  148522. * Sets the FocusDistance amount
  148523. * @param amount amount of FocusDistance
  148524. */
  148525. setFocusDistance(amount: number): void;
  148526. /**
  148527. * Disables depth of field
  148528. */
  148529. disableDepthOfField(): void;
  148530. /**
  148531. * Sets the Aperture amount
  148532. * @param amount amount of Aperture
  148533. */
  148534. setAperture(amount: number): void;
  148535. /**
  148536. * Sets the DarkenOutOfFocus amount
  148537. * @param amount amount of DarkenOutOfFocus
  148538. */
  148539. setDarkenOutOfFocus(amount: number): void;
  148540. private _pentagonBokehIsEnabled;
  148541. /**
  148542. * Creates a pentagon bokeh effect
  148543. */
  148544. enablePentagonBokeh(): void;
  148545. /**
  148546. * Disables the pentagon bokeh effect
  148547. */
  148548. disablePentagonBokeh(): void;
  148549. /**
  148550. * Enables noise blur
  148551. */
  148552. enableNoiseBlur(): void;
  148553. /**
  148554. * Disables noise blur
  148555. */
  148556. disableNoiseBlur(): void;
  148557. /**
  148558. * Sets the HighlightsGain amount
  148559. * @param amount amount of HighlightsGain
  148560. */
  148561. setHighlightsGain(amount: number): void;
  148562. /**
  148563. * Sets the HighlightsThreshold amount
  148564. * @param amount amount of HighlightsThreshold
  148565. */
  148566. setHighlightsThreshold(amount: number): void;
  148567. /**
  148568. * Disables highlights
  148569. */
  148570. disableHighlights(): void;
  148571. /**
  148572. * Removes the internal pipeline assets and detaches the pipeline from the scene cameras
  148573. * @param disableDepthRender If the scens depth rendering should be disabled (default: false)
  148574. */
  148575. dispose(disableDepthRender?: boolean): void;
  148576. private _createChromaticAberrationPostProcess;
  148577. private _createHighlightsPostProcess;
  148578. private _createDepthOfFieldPostProcess;
  148579. private _createGrainTexture;
  148580. }
  148581. }
  148582. declare module BABYLON {
  148583. /** @hidden */
  148584. export var ssao2PixelShader: {
  148585. name: string;
  148586. shader: string;
  148587. };
  148588. }
  148589. declare module BABYLON {
  148590. /** @hidden */
  148591. export var ssaoCombinePixelShader: {
  148592. name: string;
  148593. shader: string;
  148594. };
  148595. }
  148596. declare module BABYLON {
  148597. /**
  148598. * Render pipeline to produce ssao effect
  148599. */
  148600. export class SSAO2RenderingPipeline extends PostProcessRenderPipeline {
  148601. /**
  148602. * @ignore
  148603. * The PassPostProcess id in the pipeline that contains the original scene color
  148604. */
  148605. SSAOOriginalSceneColorEffect: string;
  148606. /**
  148607. * @ignore
  148608. * The SSAO PostProcess id in the pipeline
  148609. */
  148610. SSAORenderEffect: string;
  148611. /**
  148612. * @ignore
  148613. * The horizontal blur PostProcess id in the pipeline
  148614. */
  148615. SSAOBlurHRenderEffect: string;
  148616. /**
  148617. * @ignore
  148618. * The vertical blur PostProcess id in the pipeline
  148619. */
  148620. SSAOBlurVRenderEffect: string;
  148621. /**
  148622. * @ignore
  148623. * The PostProcess id in the pipeline that combines the SSAO-Blur output with the original scene color (SSAOOriginalSceneColorEffect)
  148624. */
  148625. SSAOCombineRenderEffect: string;
  148626. /**
  148627. * The output strength of the SSAO post-process. Default value is 1.0.
  148628. */
  148629. totalStrength: number;
  148630. /**
  148631. * Maximum depth value to still render AO. A smooth falloff makes the dimming more natural, so there will be no abrupt shading change.
  148632. */
  148633. maxZ: number;
  148634. /**
  148635. * In order to save performances, SSAO radius is clamped on close geometry. This ratio changes by how much
  148636. */
  148637. minZAspect: number;
  148638. private _samples;
  148639. /**
  148640. * Number of samples used for the SSAO calculations. Default value is 8
  148641. */
  148642. set samples(n: number);
  148643. get samples(): number;
  148644. private _textureSamples;
  148645. /**
  148646. * Number of samples to use for antialiasing
  148647. */
  148648. set textureSamples(n: number);
  148649. get textureSamples(): number;
  148650. /**
  148651. * Force rendering the geometry through geometry buffer
  148652. */
  148653. private _forceGeometryBuffer;
  148654. /**
  148655. * Ratio object used for SSAO ratio and blur ratio
  148656. */
  148657. private _ratio;
  148658. /**
  148659. * Dynamically generated sphere sampler.
  148660. */
  148661. private _sampleSphere;
  148662. /**
  148663. * Blur filter offsets
  148664. */
  148665. private _samplerOffsets;
  148666. private _expensiveBlur;
  148667. /**
  148668. * If bilateral blur should be used
  148669. */
  148670. set expensiveBlur(b: boolean);
  148671. get expensiveBlur(): boolean;
  148672. /**
  148673. * The radius around the analyzed pixel used by the SSAO post-process. Default value is 2.0
  148674. */
  148675. radius: number;
  148676. /**
  148677. * The base color of the SSAO post-process
  148678. * The final result is "base + ssao" between [0, 1]
  148679. */
  148680. base: number;
  148681. /**
  148682. * Support test.
  148683. */
  148684. static get IsSupported(): boolean;
  148685. private _scene;
  148686. private _randomTexture;
  148687. private _originalColorPostProcess;
  148688. private _ssaoPostProcess;
  148689. private _blurHPostProcess;
  148690. private _blurVPostProcess;
  148691. private _ssaoCombinePostProcess;
  148692. private _prePassRenderer;
  148693. /**
  148694. * Gets active scene
  148695. */
  148696. get scene(): Scene;
  148697. /**
  148698. * @constructor
  148699. * @param name The rendering pipeline name
  148700. * @param scene The scene linked to this pipeline
  148701. * @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 }
  148702. * @param cameras The array of cameras that the rendering pipeline will be attached to
  148703. * @param forceGeometryBuffer Set to true if you want to use the legacy geometry buffer renderer
  148704. */
  148705. constructor(name: string, scene: Scene, ratio: any, cameras?: Camera[], forceGeometryBuffer?: boolean);
  148706. /**
  148707. * Get the class name
  148708. * @returns "SSAO2RenderingPipeline"
  148709. */
  148710. getClassName(): string;
  148711. /**
  148712. * Removes the internal pipeline assets and detatches the pipeline from the scene cameras
  148713. */
  148714. dispose(disableGeometryBufferRenderer?: boolean): void;
  148715. private _createBlurPostProcess;
  148716. /** @hidden */
  148717. _rebuild(): void;
  148718. private _bits;
  148719. private _radicalInverse_VdC;
  148720. private _hammersley;
  148721. private _hemisphereSample_uniform;
  148722. private _generateHemisphere;
  148723. private _getDefinesForSSAO;
  148724. private _createSSAOPostProcess;
  148725. private _createSSAOCombinePostProcess;
  148726. private _createRandomTexture;
  148727. /**
  148728. * Serialize the rendering pipeline (Used when exporting)
  148729. * @returns the serialized object
  148730. */
  148731. serialize(): any;
  148732. /**
  148733. * Parse the serialized pipeline
  148734. * @param source Source pipeline.
  148735. * @param scene The scene to load the pipeline to.
  148736. * @param rootUrl The URL of the serialized pipeline.
  148737. * @returns An instantiated pipeline from the serialized object.
  148738. */
  148739. static Parse(source: any, scene: Scene, rootUrl: string): SSAO2RenderingPipeline;
  148740. /**
  148741. * Sets the required values to the prepass renderer.
  148742. * @param prePassRenderer defines the prepass renderer to setup
  148743. * @returns true if the pre pass is needed.
  148744. */
  148745. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  148746. }
  148747. }
  148748. declare module BABYLON {
  148749. /** @hidden */
  148750. export var ssaoPixelShader: {
  148751. name: string;
  148752. shader: string;
  148753. };
  148754. }
  148755. declare module BABYLON {
  148756. /**
  148757. * Render pipeline to produce ssao effect
  148758. */
  148759. export class SSAORenderingPipeline extends PostProcessRenderPipeline {
  148760. /**
  148761. * @ignore
  148762. * The PassPostProcess id in the pipeline that contains the original scene color
  148763. */
  148764. SSAOOriginalSceneColorEffect: string;
  148765. /**
  148766. * @ignore
  148767. * The SSAO PostProcess id in the pipeline
  148768. */
  148769. SSAORenderEffect: string;
  148770. /**
  148771. * @ignore
  148772. * The horizontal blur PostProcess id in the pipeline
  148773. */
  148774. SSAOBlurHRenderEffect: string;
  148775. /**
  148776. * @ignore
  148777. * The vertical blur PostProcess id in the pipeline
  148778. */
  148779. SSAOBlurVRenderEffect: string;
  148780. /**
  148781. * @ignore
  148782. * The PostProcess id in the pipeline that combines the SSAO-Blur output with the original scene color (SSAOOriginalSceneColorEffect)
  148783. */
  148784. SSAOCombineRenderEffect: string;
  148785. /**
  148786. * The output strength of the SSAO post-process. Default value is 1.0.
  148787. */
  148788. totalStrength: number;
  148789. /**
  148790. * The radius around the analyzed pixel used by the SSAO post-process. Default value is 0.0006
  148791. */
  148792. radius: number;
  148793. /**
  148794. * Related to fallOff, used to interpolate SSAO samples (first interpolate function input) based on the occlusion difference of each pixel
  148795. * Must not be equal to fallOff and superior to fallOff.
  148796. * Default value is 0.0075
  148797. */
  148798. area: number;
  148799. /**
  148800. * Related to area, used to interpolate SSAO samples (second interpolate function input) based on the occlusion difference of each pixel
  148801. * Must not be equal to area and inferior to area.
  148802. * Default value is 0.000001
  148803. */
  148804. fallOff: number;
  148805. /**
  148806. * The base color of the SSAO post-process
  148807. * The final result is "base + ssao" between [0, 1]
  148808. */
  148809. base: number;
  148810. private _scene;
  148811. private _depthTexture;
  148812. private _randomTexture;
  148813. private _originalColorPostProcess;
  148814. private _ssaoPostProcess;
  148815. private _blurHPostProcess;
  148816. private _blurVPostProcess;
  148817. private _ssaoCombinePostProcess;
  148818. private _firstUpdate;
  148819. /**
  148820. * Gets active scene
  148821. */
  148822. get scene(): Scene;
  148823. /**
  148824. * @constructor
  148825. * @param name - The rendering pipeline name
  148826. * @param scene - The scene linked to this pipeline
  148827. * @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 }
  148828. * @param cameras - The array of cameras that the rendering pipeline will be attached to
  148829. */
  148830. constructor(name: string, scene: Scene, ratio: any, cameras?: Camera[]);
  148831. /**
  148832. * Get the class name
  148833. * @returns "SSAORenderingPipeline"
  148834. */
  148835. getClassName(): string;
  148836. /**
  148837. * Removes the internal pipeline assets and detatches the pipeline from the scene cameras
  148838. */
  148839. dispose(disableDepthRender?: boolean): void;
  148840. private _createBlurPostProcess;
  148841. /** @hidden */
  148842. _rebuild(): void;
  148843. private _createSSAOPostProcess;
  148844. private _createSSAOCombinePostProcess;
  148845. private _createRandomTexture;
  148846. }
  148847. }
  148848. declare module BABYLON {
  148849. /** @hidden */
  148850. export var screenSpaceReflectionPixelShader: {
  148851. name: string;
  148852. shader: string;
  148853. };
  148854. }
  148855. declare module BABYLON {
  148856. /**
  148857. * The ScreenSpaceReflectionPostProcess performs realtime reflections using only and only the available informations on the screen (positions and normals).
  148858. * Basically, the screen space reflection post-process will compute reflections according the material's reflectivity.
  148859. */
  148860. export class ScreenSpaceReflectionPostProcess extends PostProcess {
  148861. /**
  148862. * Gets or sets a reflection threshold mainly used to adjust the reflection's height.
  148863. */
  148864. threshold: number;
  148865. /**
  148866. * Gets or sets the current reflection strength. 1.0 is an ideal value but can be increased/decreased for particular results.
  148867. */
  148868. strength: number;
  148869. /**
  148870. * Gets or sets the falloff exponent used while computing fresnel. More the exponent is high, more the reflections will be discrete.
  148871. */
  148872. reflectionSpecularFalloffExponent: number;
  148873. /**
  148874. * 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]
  148875. */
  148876. step: number;
  148877. /**
  148878. * Gets or sets the factor applied when computing roughness. Default value is 0.2.
  148879. */
  148880. roughnessFactor: number;
  148881. private _geometryBufferRenderer;
  148882. private _enableSmoothReflections;
  148883. private _reflectionSamples;
  148884. private _smoothSteps;
  148885. /**
  148886. * Creates a new instance of ScreenSpaceReflectionPostProcess.
  148887. * @param name The name of the effect.
  148888. * @param scene The scene containing the objects to calculate reflections.
  148889. * @param options The required width/height ratio to downsize to before computing the render pass.
  148890. * @param camera The camera to apply the render pass to.
  148891. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  148892. * @param engine The engine which the post process will be applied. (default: current engine)
  148893. * @param reusable If the post process can be reused on the same frame. (default: false)
  148894. * @param textureType Type of textures used when performing the post process. (default: 0)
  148895. * @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)
  148896. */
  148897. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  148898. /**
  148899. * Gets wether or not smoothing reflections is enabled.
  148900. * Enabling smoothing will require more GPU power and can generate a drop in FPS.
  148901. */
  148902. get enableSmoothReflections(): boolean;
  148903. /**
  148904. * Sets wether or not smoothing reflections is enabled.
  148905. * Enabling smoothing will require more GPU power and can generate a drop in FPS.
  148906. */
  148907. set enableSmoothReflections(enabled: boolean);
  148908. /**
  148909. * Gets the number of samples taken while computing reflections. More samples count is high,
  148910. * more the post-process wil require GPU power and can generate a drop in FPS. Basically in interval [25, 100].
  148911. */
  148912. get reflectionSamples(): number;
  148913. /**
  148914. * Sets the number of samples taken while computing reflections. More samples count is high,
  148915. * more the post-process wil require GPU power and can generate a drop in FPS. Basically in interval [25, 100].
  148916. */
  148917. set reflectionSamples(samples: number);
  148918. /**
  148919. * Gets the number of samples taken while smoothing reflections. More samples count is high,
  148920. * more the post-process will require GPU power and can generate a drop in FPS.
  148921. * Default value (5.0) work pretty well in all cases but can be adjusted.
  148922. */
  148923. get smoothSteps(): number;
  148924. set smoothSteps(steps: number);
  148925. private _updateEffectDefines;
  148926. }
  148927. }
  148928. declare module BABYLON {
  148929. /** @hidden */
  148930. export var standardPixelShader: {
  148931. name: string;
  148932. shader: string;
  148933. };
  148934. }
  148935. declare module BABYLON {
  148936. /**
  148937. * Standard rendering pipeline
  148938. * Default pipeline should be used going forward but the standard pipeline will be kept for backwards compatibility.
  148939. * @see https://doc.babylonjs.com/how_to/using_standard_rendering_pipeline
  148940. */
  148941. export class StandardRenderingPipeline extends PostProcessRenderPipeline implements IDisposable, IAnimatable {
  148942. /**
  148943. * Public members
  148944. */
  148945. /**
  148946. * Post-process which contains the original scene color before the pipeline applies all the effects
  148947. */
  148948. originalPostProcess: Nullable<PostProcess>;
  148949. /**
  148950. * Post-process used to down scale an image x4
  148951. */
  148952. downSampleX4PostProcess: Nullable<PostProcess>;
  148953. /**
  148954. * Post-process used to calculate the illuminated surfaces controlled by a threshold
  148955. */
  148956. brightPassPostProcess: Nullable<PostProcess>;
  148957. /**
  148958. * Post-process array storing all the horizontal blur post-processes used by the pipeline
  148959. */
  148960. blurHPostProcesses: PostProcess[];
  148961. /**
  148962. * Post-process array storing all the vertical blur post-processes used by the pipeline
  148963. */
  148964. blurVPostProcesses: PostProcess[];
  148965. /**
  148966. * Post-process used to add colors of 2 textures (typically brightness + real scene color)
  148967. */
  148968. textureAdderPostProcess: Nullable<PostProcess>;
  148969. /**
  148970. * Post-process used to create volumetric lighting effect
  148971. */
  148972. volumetricLightPostProcess: Nullable<PostProcess>;
  148973. /**
  148974. * Post-process used to smooth the previous volumetric light post-process on the X axis
  148975. */
  148976. volumetricLightSmoothXPostProcess: Nullable<BlurPostProcess>;
  148977. /**
  148978. * Post-process used to smooth the previous volumetric light post-process on the Y axis
  148979. */
  148980. volumetricLightSmoothYPostProcess: Nullable<BlurPostProcess>;
  148981. /**
  148982. * Post-process used to merge the volumetric light effect and the real scene color
  148983. */
  148984. volumetricLightMergePostProces: Nullable<PostProcess>;
  148985. /**
  148986. * Post-process used to store the final volumetric light post-process (attach/detach for debug purpose)
  148987. */
  148988. volumetricLightFinalPostProcess: Nullable<PostProcess>;
  148989. /**
  148990. * Base post-process used to calculate the average luminance of the final image for HDR
  148991. */
  148992. luminancePostProcess: Nullable<PostProcess>;
  148993. /**
  148994. * Post-processes used to create down sample post-processes in order to get
  148995. * the average luminance of the final image for HDR
  148996. * Array of length "StandardRenderingPipeline.LuminanceSteps"
  148997. */
  148998. luminanceDownSamplePostProcesses: PostProcess[];
  148999. /**
  149000. * Post-process used to create a HDR effect (light adaptation)
  149001. */
  149002. hdrPostProcess: Nullable<PostProcess>;
  149003. /**
  149004. * Post-process used to store the final texture adder post-process (attach/detach for debug purpose)
  149005. */
  149006. textureAdderFinalPostProcess: Nullable<PostProcess>;
  149007. /**
  149008. * Post-process used to store the final lens flare post-process (attach/detach for debug purpose)
  149009. */
  149010. lensFlareFinalPostProcess: Nullable<PostProcess>;
  149011. /**
  149012. * Post-process used to merge the final HDR post-process and the real scene color
  149013. */
  149014. hdrFinalPostProcess: Nullable<PostProcess>;
  149015. /**
  149016. * Post-process used to create a lens flare effect
  149017. */
  149018. lensFlarePostProcess: Nullable<PostProcess>;
  149019. /**
  149020. * Post-process that merges the result of the lens flare post-process and the real scene color
  149021. */
  149022. lensFlareComposePostProcess: Nullable<PostProcess>;
  149023. /**
  149024. * Post-process used to create a motion blur effect
  149025. */
  149026. motionBlurPostProcess: Nullable<PostProcess>;
  149027. /**
  149028. * Post-process used to create a depth of field effect
  149029. */
  149030. depthOfFieldPostProcess: Nullable<PostProcess>;
  149031. /**
  149032. * The Fast Approximate Anti-Aliasing post process which attemps to remove aliasing from an image.
  149033. */
  149034. fxaaPostProcess: Nullable<FxaaPostProcess>;
  149035. /**
  149036. * Post-process used to simulate realtime reflections using the screen space and geometry renderer.
  149037. */
  149038. screenSpaceReflectionPostProcess: Nullable<ScreenSpaceReflectionPostProcess>;
  149039. /**
  149040. * Represents the brightness threshold in order to configure the illuminated surfaces
  149041. */
  149042. brightThreshold: number;
  149043. /**
  149044. * Configures the blur intensity used for surexposed surfaces are highlighted surfaces (light halo)
  149045. */
  149046. blurWidth: number;
  149047. /**
  149048. * Sets if the blur for highlighted surfaces must be only horizontal
  149049. */
  149050. horizontalBlur: boolean;
  149051. /**
  149052. * Gets the overall exposure used by the pipeline
  149053. */
  149054. get exposure(): number;
  149055. /**
  149056. * Sets the overall exposure used by the pipeline
  149057. */
  149058. set exposure(value: number);
  149059. /**
  149060. * Texture used typically to simulate "dirty" on camera lens
  149061. */
  149062. lensTexture: Nullable<Texture>;
  149063. /**
  149064. * Represents the offset coefficient based on Rayleigh principle. Typically in interval [-0.2, 0.2]
  149065. */
  149066. volumetricLightCoefficient: number;
  149067. /**
  149068. * The overall power of volumetric lights, typically in interval [0, 10] maximum
  149069. */
  149070. volumetricLightPower: number;
  149071. /**
  149072. * Used the set the blur intensity to smooth the volumetric lights
  149073. */
  149074. volumetricLightBlurScale: number;
  149075. /**
  149076. * Light (spot or directional) used to generate the volumetric lights rays
  149077. * The source light must have a shadow generate so the pipeline can get its
  149078. * depth map
  149079. */
  149080. sourceLight: Nullable<SpotLight | DirectionalLight>;
  149081. /**
  149082. * For eye adaptation, represents the minimum luminance the eye can see
  149083. */
  149084. hdrMinimumLuminance: number;
  149085. /**
  149086. * For eye adaptation, represents the decrease luminance speed
  149087. */
  149088. hdrDecreaseRate: number;
  149089. /**
  149090. * For eye adaptation, represents the increase luminance speed
  149091. */
  149092. hdrIncreaseRate: number;
  149093. /**
  149094. * Gets wether or not the exposure of the overall pipeline should be automatically adjusted by the HDR post-process
  149095. */
  149096. get hdrAutoExposure(): boolean;
  149097. /**
  149098. * Sets wether or not the exposure of the overall pipeline should be automatically adjusted by the HDR post-process
  149099. */
  149100. set hdrAutoExposure(value: boolean);
  149101. /**
  149102. * Lens color texture used by the lens flare effect. Mandatory if lens flare effect enabled
  149103. */
  149104. lensColorTexture: Nullable<Texture>;
  149105. /**
  149106. * The overall strengh for the lens flare effect
  149107. */
  149108. lensFlareStrength: number;
  149109. /**
  149110. * Dispersion coefficient for lens flare ghosts
  149111. */
  149112. lensFlareGhostDispersal: number;
  149113. /**
  149114. * Main lens flare halo width
  149115. */
  149116. lensFlareHaloWidth: number;
  149117. /**
  149118. * Based on the lens distortion effect, defines how much the lens flare result
  149119. * is distorted
  149120. */
  149121. lensFlareDistortionStrength: number;
  149122. /**
  149123. * Configures the blur intensity used for for lens flare (halo)
  149124. */
  149125. lensFlareBlurWidth: number;
  149126. /**
  149127. * Lens star texture must be used to simulate rays on the flares and is available
  149128. * in the documentation
  149129. */
  149130. lensStarTexture: Nullable<Texture>;
  149131. /**
  149132. * As the "lensTexture" (can be the same texture or different), it is used to apply the lens
  149133. * flare effect by taking account of the dirt texture
  149134. */
  149135. lensFlareDirtTexture: Nullable<Texture>;
  149136. /**
  149137. * Represents the focal length for the depth of field effect
  149138. */
  149139. depthOfFieldDistance: number;
  149140. /**
  149141. * Represents the blur intensity for the blurred part of the depth of field effect
  149142. */
  149143. depthOfFieldBlurWidth: number;
  149144. /**
  149145. * Gets how much the image is blurred by the movement while using the motion blur post-process
  149146. */
  149147. get motionStrength(): number;
  149148. /**
  149149. * Sets how much the image is blurred by the movement while using the motion blur post-process
  149150. */
  149151. set motionStrength(strength: number);
  149152. /**
  149153. * Gets wether or not the motion blur post-process is object based or screen based.
  149154. */
  149155. get objectBasedMotionBlur(): boolean;
  149156. /**
  149157. * Sets wether or not the motion blur post-process should be object based or screen based
  149158. */
  149159. set objectBasedMotionBlur(value: boolean);
  149160. /**
  149161. * List of animations for the pipeline (IAnimatable implementation)
  149162. */
  149163. animations: Animation[];
  149164. /**
  149165. * Private members
  149166. */
  149167. private _scene;
  149168. private _currentDepthOfFieldSource;
  149169. private _basePostProcess;
  149170. private _fixedExposure;
  149171. private _currentExposure;
  149172. private _hdrAutoExposure;
  149173. private _hdrCurrentLuminance;
  149174. private _motionStrength;
  149175. private _isObjectBasedMotionBlur;
  149176. private _floatTextureType;
  149177. private _camerasToBeAttached;
  149178. private _ratio;
  149179. private _bloomEnabled;
  149180. private _depthOfFieldEnabled;
  149181. private _vlsEnabled;
  149182. private _lensFlareEnabled;
  149183. private _hdrEnabled;
  149184. private _motionBlurEnabled;
  149185. private _fxaaEnabled;
  149186. private _screenSpaceReflectionsEnabled;
  149187. private _motionBlurSamples;
  149188. private _volumetricLightStepsCount;
  149189. private _samples;
  149190. /**
  149191. * @ignore
  149192. * Specifies if the bloom pipeline is enabled
  149193. */
  149194. get BloomEnabled(): boolean;
  149195. set BloomEnabled(enabled: boolean);
  149196. /**
  149197. * @ignore
  149198. * Specifies if the depth of field pipeline is enabed
  149199. */
  149200. get DepthOfFieldEnabled(): boolean;
  149201. set DepthOfFieldEnabled(enabled: boolean);
  149202. /**
  149203. * @ignore
  149204. * Specifies if the lens flare pipeline is enabed
  149205. */
  149206. get LensFlareEnabled(): boolean;
  149207. set LensFlareEnabled(enabled: boolean);
  149208. /**
  149209. * @ignore
  149210. * Specifies if the HDR pipeline is enabled
  149211. */
  149212. get HDREnabled(): boolean;
  149213. set HDREnabled(enabled: boolean);
  149214. /**
  149215. * @ignore
  149216. * Specifies if the volumetric lights scattering effect is enabled
  149217. */
  149218. get VLSEnabled(): boolean;
  149219. set VLSEnabled(enabled: boolean);
  149220. /**
  149221. * @ignore
  149222. * Specifies if the motion blur effect is enabled
  149223. */
  149224. get MotionBlurEnabled(): boolean;
  149225. set MotionBlurEnabled(enabled: boolean);
  149226. /**
  149227. * Specifies if anti-aliasing is enabled
  149228. */
  149229. get fxaaEnabled(): boolean;
  149230. set fxaaEnabled(enabled: boolean);
  149231. /**
  149232. * Specifies if screen space reflections are enabled.
  149233. */
  149234. get screenSpaceReflectionsEnabled(): boolean;
  149235. set screenSpaceReflectionsEnabled(enabled: boolean);
  149236. /**
  149237. * Specifies the number of steps used to calculate the volumetric lights
  149238. * Typically in interval [50, 200]
  149239. */
  149240. get volumetricLightStepsCount(): number;
  149241. set volumetricLightStepsCount(count: number);
  149242. /**
  149243. * Specifies the number of samples used for the motion blur effect
  149244. * Typically in interval [16, 64]
  149245. */
  149246. get motionBlurSamples(): number;
  149247. set motionBlurSamples(samples: number);
  149248. /**
  149249. * Specifies MSAA sample count, setting this to 4 will provide 4x anti aliasing. (default: 1)
  149250. */
  149251. get samples(): number;
  149252. set samples(sampleCount: number);
  149253. /**
  149254. * Default pipeline should be used going forward but the standard pipeline will be kept for backwards compatibility.
  149255. * @constructor
  149256. * @param name The rendering pipeline name
  149257. * @param scene The scene linked to this pipeline
  149258. * @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)
  149259. * @param originalPostProcess the custom original color post-process. Must be "reusable". Can be null.
  149260. * @param cameras The array of cameras that the rendering pipeline will be attached to
  149261. */
  149262. constructor(name: string, scene: Scene, ratio: number, originalPostProcess?: Nullable<PostProcess>, cameras?: Camera[]);
  149263. private _buildPipeline;
  149264. private _createDownSampleX4PostProcess;
  149265. private _createBrightPassPostProcess;
  149266. private _createBlurPostProcesses;
  149267. private _createTextureAdderPostProcess;
  149268. private _createVolumetricLightPostProcess;
  149269. private _createLuminancePostProcesses;
  149270. private _createHdrPostProcess;
  149271. private _createLensFlarePostProcess;
  149272. private _createDepthOfFieldPostProcess;
  149273. private _createMotionBlurPostProcess;
  149274. private _getDepthTexture;
  149275. private _disposePostProcesses;
  149276. /**
  149277. * Dispose of the pipeline and stop all post processes
  149278. */
  149279. dispose(): void;
  149280. /**
  149281. * Serialize the rendering pipeline (Used when exporting)
  149282. * @returns the serialized object
  149283. */
  149284. serialize(): any;
  149285. /**
  149286. * Parse the serialized pipeline
  149287. * @param source Source pipeline.
  149288. * @param scene The scene to load the pipeline to.
  149289. * @param rootUrl The URL of the serialized pipeline.
  149290. * @returns An instantiated pipeline from the serialized object.
  149291. */
  149292. static Parse(source: any, scene: Scene, rootUrl: string): StandardRenderingPipeline;
  149293. /**
  149294. * Luminance steps
  149295. */
  149296. static LuminanceSteps: number;
  149297. }
  149298. }
  149299. declare module BABYLON {
  149300. /** @hidden */
  149301. export var stereoscopicInterlacePixelShader: {
  149302. name: string;
  149303. shader: string;
  149304. };
  149305. }
  149306. declare module BABYLON {
  149307. /**
  149308. * StereoscopicInterlacePostProcessI used to render stereo views from a rigged camera with support for alternate line interlacing
  149309. */
  149310. export class StereoscopicInterlacePostProcessI extends PostProcess {
  149311. private _stepSize;
  149312. private _passedProcess;
  149313. /**
  149314. * Initializes a StereoscopicInterlacePostProcessI
  149315. * @param name The name of the effect.
  149316. * @param rigCameras The rig cameras to be appled to the post process
  149317. * @param isStereoscopicHoriz If the rendered results are horizontal or vertical
  149318. * @param isStereoscopicInterlaced If the rendered results are alternate line interlaced
  149319. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  149320. * @param engine The engine which the post process will be applied. (default: current engine)
  149321. * @param reusable If the post process can be reused on the same frame. (default: false)
  149322. */
  149323. constructor(name: string, rigCameras: Camera[], isStereoscopicHoriz: boolean, isStereoscopicInterlaced: boolean, samplingMode?: number, engine?: Engine, reusable?: boolean);
  149324. }
  149325. /**
  149326. * StereoscopicInterlacePostProcess used to render stereo views from a rigged camera
  149327. */
  149328. export class StereoscopicInterlacePostProcess extends PostProcess {
  149329. private _stepSize;
  149330. private _passedProcess;
  149331. /**
  149332. * Initializes a StereoscopicInterlacePostProcess
  149333. * @param name The name of the effect.
  149334. * @param rigCameras The rig cameras to be appled to the post process
  149335. * @param isStereoscopicHoriz If the rendered results are horizontal or verticle
  149336. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  149337. * @param engine The engine which the post process will be applied. (default: current engine)
  149338. * @param reusable If the post process can be reused on the same frame. (default: false)
  149339. */
  149340. constructor(name: string, rigCameras: Camera[], isStereoscopicHoriz: boolean, samplingMode?: number, engine?: Engine, reusable?: boolean);
  149341. }
  149342. }
  149343. declare module BABYLON {
  149344. /** @hidden */
  149345. export var tonemapPixelShader: {
  149346. name: string;
  149347. shader: string;
  149348. };
  149349. }
  149350. declare module BABYLON {
  149351. /** Defines operator used for tonemapping */
  149352. export enum TonemappingOperator {
  149353. /** Hable */
  149354. Hable = 0,
  149355. /** Reinhard */
  149356. Reinhard = 1,
  149357. /** HejiDawson */
  149358. HejiDawson = 2,
  149359. /** Photographic */
  149360. Photographic = 3
  149361. }
  149362. /**
  149363. * Defines a post process to apply tone mapping
  149364. */
  149365. export class TonemapPostProcess extends PostProcess {
  149366. private _operator;
  149367. /** Defines the required exposure adjustement */
  149368. exposureAdjustment: number;
  149369. /**
  149370. * Creates a new TonemapPostProcess
  149371. * @param name defines the name of the postprocess
  149372. * @param _operator defines the operator to use
  149373. * @param exposureAdjustment defines the required exposure adjustement
  149374. * @param camera defines the camera to use (can be null)
  149375. * @param samplingMode defines the required sampling mode (BABYLON.Texture.BILINEAR_SAMPLINGMODE by default)
  149376. * @param engine defines the hosting engine (can be ignore if camera is set)
  149377. * @param textureFormat defines the texture format to use (BABYLON.Engine.TEXTURETYPE_UNSIGNED_INT by default)
  149378. */
  149379. constructor(name: string, _operator: TonemappingOperator,
  149380. /** Defines the required exposure adjustement */
  149381. exposureAdjustment: number, camera: Camera, samplingMode?: number, engine?: Engine, textureFormat?: number);
  149382. }
  149383. }
  149384. declare module BABYLON {
  149385. /** @hidden */
  149386. export var volumetricLightScatteringPixelShader: {
  149387. name: string;
  149388. shader: string;
  149389. };
  149390. }
  149391. declare module BABYLON {
  149392. /** @hidden */
  149393. export var volumetricLightScatteringPassVertexShader: {
  149394. name: string;
  149395. shader: string;
  149396. };
  149397. }
  149398. declare module BABYLON {
  149399. /** @hidden */
  149400. export var volumetricLightScatteringPassPixelShader: {
  149401. name: string;
  149402. shader: string;
  149403. };
  149404. }
  149405. declare module BABYLON {
  149406. /**
  149407. * Inspired by http://http.developer.nvidia.com/GPUGems3/gpugems3_ch13.html
  149408. */
  149409. export class VolumetricLightScatteringPostProcess extends PostProcess {
  149410. private _volumetricLightScatteringPass;
  149411. private _volumetricLightScatteringRTT;
  149412. private _viewPort;
  149413. private _screenCoordinates;
  149414. private _cachedDefines;
  149415. /**
  149416. * If not undefined, the mesh position is computed from the attached node position
  149417. */
  149418. attachedNode: {
  149419. position: Vector3;
  149420. };
  149421. /**
  149422. * Custom position of the mesh. Used if "useCustomMeshPosition" is set to "true"
  149423. */
  149424. customMeshPosition: Vector3;
  149425. /**
  149426. * Set if the post-process should use a custom position for the light source (true) or the internal mesh position (false)
  149427. */
  149428. useCustomMeshPosition: boolean;
  149429. /**
  149430. * If the post-process should inverse the light scattering direction
  149431. */
  149432. invert: boolean;
  149433. /**
  149434. * The internal mesh used by the post-process
  149435. */
  149436. mesh: Mesh;
  149437. /**
  149438. * @hidden
  149439. * VolumetricLightScatteringPostProcess.useDiffuseColor is no longer used, use the mesh material directly instead
  149440. */
  149441. get useDiffuseColor(): boolean;
  149442. set useDiffuseColor(useDiffuseColor: boolean);
  149443. /**
  149444. * Array containing the excluded meshes not rendered in the internal pass
  149445. */
  149446. excludedMeshes: AbstractMesh[];
  149447. /**
  149448. * Controls the overall intensity of the post-process
  149449. */
  149450. exposure: number;
  149451. /**
  149452. * Dissipates each sample's contribution in range [0, 1]
  149453. */
  149454. decay: number;
  149455. /**
  149456. * Controls the overall intensity of each sample
  149457. */
  149458. weight: number;
  149459. /**
  149460. * Controls the density of each sample
  149461. */
  149462. density: number;
  149463. /**
  149464. * @constructor
  149465. * @param name The post-process name
  149466. * @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)
  149467. * @param camera The camera that the post-process will be attached to
  149468. * @param mesh The mesh used to create the light scattering
  149469. * @param samples The post-process quality, default 100
  149470. * @param samplingModeThe post-process filtering mode
  149471. * @param engine The babylon engine
  149472. * @param reusable If the post-process is reusable
  149473. * @param scene The constructor needs a scene reference to initialize internal components. If "camera" is null a "scene" must be provided
  149474. */
  149475. constructor(name: string, ratio: any, camera: Camera, mesh?: Mesh, samples?: number, samplingMode?: number, engine?: Engine, reusable?: boolean, scene?: Scene);
  149476. /**
  149477. * Returns the string "VolumetricLightScatteringPostProcess"
  149478. * @returns "VolumetricLightScatteringPostProcess"
  149479. */
  149480. getClassName(): string;
  149481. private _isReady;
  149482. /**
  149483. * Sets the new light position for light scattering effect
  149484. * @param position The new custom light position
  149485. */
  149486. setCustomMeshPosition(position: Vector3): void;
  149487. /**
  149488. * Returns the light position for light scattering effect
  149489. * @return Vector3 The custom light position
  149490. */
  149491. getCustomMeshPosition(): Vector3;
  149492. /**
  149493. * Disposes the internal assets and detaches the post-process from the camera
  149494. */
  149495. dispose(camera: Camera): void;
  149496. /**
  149497. * Returns the render target texture used by the post-process
  149498. * @return the render target texture used by the post-process
  149499. */
  149500. getPass(): RenderTargetTexture;
  149501. private _meshExcluded;
  149502. private _createPass;
  149503. private _updateMeshScreenCoordinates;
  149504. /**
  149505. * Creates a default mesh for the Volumeric Light Scattering post-process
  149506. * @param name The mesh name
  149507. * @param scene The scene where to create the mesh
  149508. * @return the default mesh
  149509. */
  149510. static CreateDefaultMesh(name: string, scene: Scene): Mesh;
  149511. }
  149512. }
  149513. declare module BABYLON {
  149514. /** @hidden */
  149515. export var screenSpaceCurvaturePixelShader: {
  149516. name: string;
  149517. shader: string;
  149518. };
  149519. }
  149520. declare module BABYLON {
  149521. /**
  149522. * The Screen Space curvature effect can help highlighting ridge and valley of a model.
  149523. */
  149524. export class ScreenSpaceCurvaturePostProcess extends PostProcess {
  149525. /**
  149526. * Defines how much ridge the curvature effect displays.
  149527. */
  149528. ridge: number;
  149529. /**
  149530. * Defines how much valley the curvature effect displays.
  149531. */
  149532. valley: number;
  149533. private _geometryBufferRenderer;
  149534. /**
  149535. * Creates a new instance ScreenSpaceCurvaturePostProcess
  149536. * @param name The name of the effect.
  149537. * @param scene The scene containing the objects to blur according to their velocity.
  149538. * @param options The required width/height ratio to downsize to before computing the render pass.
  149539. * @param camera The camera to apply the render pass to.
  149540. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  149541. * @param engine The engine which the post process will be applied. (default: current engine)
  149542. * @param reusable If the post process can be reused on the same frame. (default: false)
  149543. * @param textureType Type of textures used when performing the post process. (default: 0)
  149544. * @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)
  149545. */
  149546. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  149547. /**
  149548. * Support test.
  149549. */
  149550. static get IsSupported(): boolean;
  149551. }
  149552. }
  149553. declare module BABYLON {
  149554. interface Scene {
  149555. /** @hidden (Backing field) */
  149556. _boundingBoxRenderer: BoundingBoxRenderer;
  149557. /** @hidden (Backing field) */
  149558. _forceShowBoundingBoxes: boolean;
  149559. /**
  149560. * Gets or sets a boolean indicating if all bounding boxes must be rendered
  149561. */
  149562. forceShowBoundingBoxes: boolean;
  149563. /**
  149564. * Gets the bounding box renderer associated with the scene
  149565. * @returns a BoundingBoxRenderer
  149566. */
  149567. getBoundingBoxRenderer(): BoundingBoxRenderer;
  149568. }
  149569. interface AbstractMesh {
  149570. /** @hidden (Backing field) */
  149571. _showBoundingBox: boolean;
  149572. /**
  149573. * Gets or sets a boolean indicating if the bounding box must be rendered as well (false by default)
  149574. */
  149575. showBoundingBox: boolean;
  149576. }
  149577. /**
  149578. * Component responsible of rendering the bounding box of the meshes in a scene.
  149579. * This is usually used through the mesh.showBoundingBox or the scene.forceShowBoundingBoxes properties
  149580. */
  149581. export class BoundingBoxRenderer implements ISceneComponent {
  149582. /**
  149583. * The component name helpfull to identify the component in the list of scene components.
  149584. */
  149585. readonly name: string;
  149586. /**
  149587. * The scene the component belongs to.
  149588. */
  149589. scene: Scene;
  149590. /**
  149591. * Color of the bounding box lines placed in front of an object
  149592. */
  149593. frontColor: Color3;
  149594. /**
  149595. * Color of the bounding box lines placed behind an object
  149596. */
  149597. backColor: Color3;
  149598. /**
  149599. * Defines if the renderer should show the back lines or not
  149600. */
  149601. showBackLines: boolean;
  149602. /**
  149603. * Observable raised before rendering a bounding box
  149604. */
  149605. onBeforeBoxRenderingObservable: Observable<BoundingBox>;
  149606. /**
  149607. * Observable raised after rendering a bounding box
  149608. */
  149609. onAfterBoxRenderingObservable: Observable<BoundingBox>;
  149610. /**
  149611. * @hidden
  149612. */
  149613. renderList: SmartArray<BoundingBox>;
  149614. private _colorShader;
  149615. private _vertexBuffers;
  149616. private _indexBuffer;
  149617. private _fillIndexBuffer;
  149618. private _fillIndexData;
  149619. /**
  149620. * Instantiates a new bounding box renderer in a scene.
  149621. * @param scene the scene the renderer renders in
  149622. */
  149623. constructor(scene: Scene);
  149624. /**
  149625. * Registers the component in a given scene
  149626. */
  149627. register(): void;
  149628. private _evaluateSubMesh;
  149629. private _activeMesh;
  149630. private _prepareRessources;
  149631. private _createIndexBuffer;
  149632. /**
  149633. * Rebuilds the elements related to this component in case of
  149634. * context lost for instance.
  149635. */
  149636. rebuild(): void;
  149637. /**
  149638. * @hidden
  149639. */
  149640. reset(): void;
  149641. /**
  149642. * Render the bounding boxes of a specific rendering group
  149643. * @param renderingGroupId defines the rendering group to render
  149644. */
  149645. render(renderingGroupId: number): void;
  149646. /**
  149647. * In case of occlusion queries, we can render the occlusion bounding box through this method
  149648. * @param mesh Define the mesh to render the occlusion bounding box for
  149649. */
  149650. renderOcclusionBoundingBox(mesh: AbstractMesh): void;
  149651. /**
  149652. * Dispose and release the resources attached to this renderer.
  149653. */
  149654. dispose(): void;
  149655. }
  149656. }
  149657. declare module BABYLON {
  149658. interface Scene {
  149659. /** @hidden (Backing field) */
  149660. _depthRenderer: {
  149661. [id: string]: DepthRenderer;
  149662. };
  149663. /**
  149664. * Creates a depth renderer a given camera which contains a depth map which can be used for post processing.
  149665. * @param camera The camera to create the depth renderer on (default: scene's active camera)
  149666. * @param storeNonLinearDepth Defines whether the depth is stored linearly like in Babylon Shadows or directly like glFragCoord.z
  149667. * @returns the created depth renderer
  149668. */
  149669. enableDepthRenderer(camera?: Nullable<Camera>, storeNonLinearDepth?: boolean): DepthRenderer;
  149670. /**
  149671. * Disables a depth renderer for a given camera
  149672. * @param camera The camera to disable the depth renderer on (default: scene's active camera)
  149673. */
  149674. disableDepthRenderer(camera?: Nullable<Camera>): void;
  149675. }
  149676. /**
  149677. * Defines the Depth Renderer scene component responsible to manage a depth buffer useful
  149678. * in several rendering techniques.
  149679. */
  149680. export class DepthRendererSceneComponent implements ISceneComponent {
  149681. /**
  149682. * The component name helpfull to identify the component in the list of scene components.
  149683. */
  149684. readonly name: string;
  149685. /**
  149686. * The scene the component belongs to.
  149687. */
  149688. scene: Scene;
  149689. /**
  149690. * Creates a new instance of the component for the given scene
  149691. * @param scene Defines the scene to register the component in
  149692. */
  149693. constructor(scene: Scene);
  149694. /**
  149695. * Registers the component in a given scene
  149696. */
  149697. register(): void;
  149698. /**
  149699. * Rebuilds the elements related to this component in case of
  149700. * context lost for instance.
  149701. */
  149702. rebuild(): void;
  149703. /**
  149704. * Disposes the component and the associated ressources
  149705. */
  149706. dispose(): void;
  149707. private _gatherRenderTargets;
  149708. private _gatherActiveCameraRenderTargets;
  149709. }
  149710. }
  149711. declare module BABYLON {
  149712. interface AbstractScene {
  149713. /** @hidden (Backing field) */
  149714. _prePassRenderer: Nullable<PrePassRenderer>;
  149715. /**
  149716. * Gets or Sets the current prepass renderer associated to the scene.
  149717. */
  149718. prePassRenderer: Nullable<PrePassRenderer>;
  149719. /**
  149720. * Enables the prepass and associates it with the scene
  149721. * @returns the PrePassRenderer
  149722. */
  149723. enablePrePassRenderer(): Nullable<PrePassRenderer>;
  149724. /**
  149725. * Disables the prepass associated with the scene
  149726. */
  149727. disablePrePassRenderer(): void;
  149728. }
  149729. /**
  149730. * Defines the Geometry Buffer scene component responsible to manage a G-Buffer useful
  149731. * in several rendering techniques.
  149732. */
  149733. export class PrePassRendererSceneComponent implements ISceneSerializableComponent {
  149734. /**
  149735. * The component name helpful to identify the component in the list of scene components.
  149736. */
  149737. readonly name: string;
  149738. /**
  149739. * The scene the component belongs to.
  149740. */
  149741. scene: Scene;
  149742. /**
  149743. * Creates a new instance of the component for the given scene
  149744. * @param scene Defines the scene to register the component in
  149745. */
  149746. constructor(scene: Scene);
  149747. /**
  149748. * Registers the component in a given scene
  149749. */
  149750. register(): void;
  149751. private _beforeCameraDraw;
  149752. private _afterCameraDraw;
  149753. private _beforeClearStage;
  149754. /**
  149755. * Serializes the component data to the specified json object
  149756. * @param serializationObject The object to serialize to
  149757. */
  149758. serialize(serializationObject: any): void;
  149759. /**
  149760. * Adds all the elements from the container to the scene
  149761. * @param container the container holding the elements
  149762. */
  149763. addFromContainer(container: AbstractScene): void;
  149764. /**
  149765. * Removes all the elements in the container from the scene
  149766. * @param container contains the elements to remove
  149767. * @param dispose if the removed element should be disposed (default: false)
  149768. */
  149769. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  149770. /**
  149771. * Rebuilds the elements related to this component in case of
  149772. * context lost for instance.
  149773. */
  149774. rebuild(): void;
  149775. /**
  149776. * Disposes the component and the associated ressources
  149777. */
  149778. dispose(): void;
  149779. }
  149780. }
  149781. declare module BABYLON {
  149782. /** @hidden */
  149783. export var outlinePixelShader: {
  149784. name: string;
  149785. shader: string;
  149786. };
  149787. }
  149788. declare module BABYLON {
  149789. /** @hidden */
  149790. export var outlineVertexShader: {
  149791. name: string;
  149792. shader: string;
  149793. };
  149794. }
  149795. declare module BABYLON {
  149796. interface Scene {
  149797. /** @hidden */
  149798. _outlineRenderer: OutlineRenderer;
  149799. /**
  149800. * Gets the outline renderer associated with the scene
  149801. * @returns a OutlineRenderer
  149802. */
  149803. getOutlineRenderer(): OutlineRenderer;
  149804. }
  149805. interface AbstractMesh {
  149806. /** @hidden (Backing field) */
  149807. _renderOutline: boolean;
  149808. /**
  149809. * Gets or sets a boolean indicating if the outline must be rendered as well
  149810. * @see https://www.babylonjs-playground.com/#10WJ5S#3
  149811. */
  149812. renderOutline: boolean;
  149813. /** @hidden (Backing field) */
  149814. _renderOverlay: boolean;
  149815. /**
  149816. * Gets or sets a boolean indicating if the overlay must be rendered as well
  149817. * @see https://www.babylonjs-playground.com/#10WJ5S#2
  149818. */
  149819. renderOverlay: boolean;
  149820. }
  149821. /**
  149822. * This class is responsible to draw bothe outline/overlay of meshes.
  149823. * It should not be used directly but through the available method on mesh.
  149824. */
  149825. export class OutlineRenderer implements ISceneComponent {
  149826. /**
  149827. * Stencil value used to avoid outline being seen within the mesh when the mesh is transparent
  149828. */
  149829. private static _StencilReference;
  149830. /**
  149831. * The name of the component. Each component must have a unique name.
  149832. */
  149833. name: string;
  149834. /**
  149835. * The scene the component belongs to.
  149836. */
  149837. scene: Scene;
  149838. /**
  149839. * Defines a zOffset to prevent zFighting between the overlay and the mesh.
  149840. */
  149841. zOffset: number;
  149842. private _engine;
  149843. private _effect;
  149844. private _cachedDefines;
  149845. private _savedDepthWrite;
  149846. /**
  149847. * Instantiates a new outline renderer. (There could be only one per scene).
  149848. * @param scene Defines the scene it belongs to
  149849. */
  149850. constructor(scene: Scene);
  149851. /**
  149852. * Register the component to one instance of a scene.
  149853. */
  149854. register(): void;
  149855. /**
  149856. * Rebuilds the elements related to this component in case of
  149857. * context lost for instance.
  149858. */
  149859. rebuild(): void;
  149860. /**
  149861. * Disposes the component and the associated ressources.
  149862. */
  149863. dispose(): void;
  149864. /**
  149865. * Renders the outline in the canvas.
  149866. * @param subMesh Defines the sumesh to render
  149867. * @param batch Defines the batch of meshes in case of instances
  149868. * @param useOverlay Defines if the rendering is for the overlay or the outline
  149869. */
  149870. render(subMesh: SubMesh, batch: _InstancesBatch, useOverlay?: boolean): void;
  149871. /**
  149872. * Returns whether or not the outline renderer is ready for a given submesh.
  149873. * All the dependencies e.g. submeshes, texture, effect... mus be ready
  149874. * @param subMesh Defines the submesh to check readyness for
  149875. * @param useInstances Defines wheter wee are trying to render instances or not
  149876. * @returns true if ready otherwise false
  149877. */
  149878. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  149879. private _beforeRenderingMesh;
  149880. private _afterRenderingMesh;
  149881. }
  149882. }
  149883. declare module BABYLON {
  149884. /**
  149885. * Defines the basic options interface of a Sprite Frame Source Size.
  149886. */
  149887. export interface ISpriteJSONSpriteSourceSize {
  149888. /**
  149889. * number of the original width of the Frame
  149890. */
  149891. w: number;
  149892. /**
  149893. * number of the original height of the Frame
  149894. */
  149895. h: number;
  149896. }
  149897. /**
  149898. * Defines the basic options interface of a Sprite Frame Data.
  149899. */
  149900. export interface ISpriteJSONSpriteFrameData {
  149901. /**
  149902. * number of the x offset of the Frame
  149903. */
  149904. x: number;
  149905. /**
  149906. * number of the y offset of the Frame
  149907. */
  149908. y: number;
  149909. /**
  149910. * number of the width of the Frame
  149911. */
  149912. w: number;
  149913. /**
  149914. * number of the height of the Frame
  149915. */
  149916. h: number;
  149917. }
  149918. /**
  149919. * Defines the basic options interface of a JSON Sprite.
  149920. */
  149921. export interface ISpriteJSONSprite {
  149922. /**
  149923. * string name of the Frame
  149924. */
  149925. filename: string;
  149926. /**
  149927. * ISpriteJSONSpriteFrame basic object of the frame data
  149928. */
  149929. frame: ISpriteJSONSpriteFrameData;
  149930. /**
  149931. * boolean to flag is the frame was rotated.
  149932. */
  149933. rotated: boolean;
  149934. /**
  149935. * boolean to flag is the frame was trimmed.
  149936. */
  149937. trimmed: boolean;
  149938. /**
  149939. * ISpriteJSONSpriteFrame basic object of the source data
  149940. */
  149941. spriteSourceSize: ISpriteJSONSpriteFrameData;
  149942. /**
  149943. * ISpriteJSONSpriteFrame basic object of the source data
  149944. */
  149945. sourceSize: ISpriteJSONSpriteSourceSize;
  149946. }
  149947. /**
  149948. * Defines the basic options interface of a JSON atlas.
  149949. */
  149950. export interface ISpriteJSONAtlas {
  149951. /**
  149952. * Array of objects that contain the frame data.
  149953. */
  149954. frames: Array<ISpriteJSONSprite>;
  149955. /**
  149956. * object basic object containing the sprite meta data.
  149957. */
  149958. meta?: object;
  149959. }
  149960. }
  149961. declare module BABYLON {
  149962. /** @hidden */
  149963. export var spriteMapPixelShader: {
  149964. name: string;
  149965. shader: string;
  149966. };
  149967. }
  149968. declare module BABYLON {
  149969. /** @hidden */
  149970. export var spriteMapVertexShader: {
  149971. name: string;
  149972. shader: string;
  149973. };
  149974. }
  149975. declare module BABYLON {
  149976. /**
  149977. * Defines the basic options interface of a SpriteMap
  149978. */
  149979. export interface ISpriteMapOptions {
  149980. /**
  149981. * Vector2 of the number of cells in the grid.
  149982. */
  149983. stageSize?: Vector2;
  149984. /**
  149985. * Vector2 of the size of the output plane in World Units.
  149986. */
  149987. outputSize?: Vector2;
  149988. /**
  149989. * Vector3 of the position of the output plane in World Units.
  149990. */
  149991. outputPosition?: Vector3;
  149992. /**
  149993. * Vector3 of the rotation of the output plane.
  149994. */
  149995. outputRotation?: Vector3;
  149996. /**
  149997. * number of layers that the system will reserve in resources.
  149998. */
  149999. layerCount?: number;
  150000. /**
  150001. * number of max animation frames a single cell will reserve in resources.
  150002. */
  150003. maxAnimationFrames?: number;
  150004. /**
  150005. * number cell index of the base tile when the system compiles.
  150006. */
  150007. baseTile?: number;
  150008. /**
  150009. * boolean flip the sprite after its been repositioned by the framing data.
  150010. */
  150011. flipU?: boolean;
  150012. /**
  150013. * Vector3 scalar of the global RGB values of the SpriteMap.
  150014. */
  150015. colorMultiply?: Vector3;
  150016. }
  150017. /**
  150018. * Defines the IDisposable interface in order to be cleanable from resources.
  150019. */
  150020. export interface ISpriteMap extends IDisposable {
  150021. /**
  150022. * String name of the SpriteMap.
  150023. */
  150024. name: string;
  150025. /**
  150026. * The JSON Array file from a https://www.codeandweb.com/texturepacker export. Or similar structure.
  150027. */
  150028. atlasJSON: ISpriteJSONAtlas;
  150029. /**
  150030. * Texture of the SpriteMap.
  150031. */
  150032. spriteSheet: Texture;
  150033. /**
  150034. * The parameters to initialize the SpriteMap with.
  150035. */
  150036. options: ISpriteMapOptions;
  150037. }
  150038. /**
  150039. * Class used to manage a grid restricted sprite deployment on an Output plane.
  150040. */
  150041. export class SpriteMap implements ISpriteMap {
  150042. /** The Name of the spriteMap */
  150043. name: string;
  150044. /** The JSON file with the frame and meta data */
  150045. atlasJSON: ISpriteJSONAtlas;
  150046. /** The systems Sprite Sheet Texture */
  150047. spriteSheet: Texture;
  150048. /** Arguments passed with the Constructor */
  150049. options: ISpriteMapOptions;
  150050. /** Public Sprite Storage array, parsed from atlasJSON */
  150051. sprites: Array<ISpriteJSONSprite>;
  150052. /** Returns the Number of Sprites in the System */
  150053. get spriteCount(): number;
  150054. /** Returns the Position of Output Plane*/
  150055. get position(): Vector3;
  150056. /** Returns the Position of Output Plane*/
  150057. set position(v: Vector3);
  150058. /** Returns the Rotation of Output Plane*/
  150059. get rotation(): Vector3;
  150060. /** Returns the Rotation of Output Plane*/
  150061. set rotation(v: Vector3);
  150062. /** Sets the AnimationMap*/
  150063. get animationMap(): RawTexture;
  150064. /** Sets the AnimationMap*/
  150065. set animationMap(v: RawTexture);
  150066. /** Scene that the SpriteMap was created in */
  150067. private _scene;
  150068. /** Texture Buffer of Float32 that holds tile frame data*/
  150069. private _frameMap;
  150070. /** Texture Buffers of Float32 that holds tileMap data*/
  150071. private _tileMaps;
  150072. /** Texture Buffer of Float32 that holds Animation Data*/
  150073. private _animationMap;
  150074. /** Custom ShaderMaterial Central to the System*/
  150075. private _material;
  150076. /** Custom ShaderMaterial Central to the System*/
  150077. private _output;
  150078. /** Systems Time Ticker*/
  150079. private _time;
  150080. /**
  150081. * Creates a new SpriteMap
  150082. * @param name defines the SpriteMaps Name
  150083. * @param atlasJSON is the JSON file that controls the Sprites Frames and Meta
  150084. * @param spriteSheet is the Texture that the Sprites are on.
  150085. * @param options a basic deployment configuration
  150086. * @param scene The Scene that the map is deployed on
  150087. */
  150088. constructor(name: string, atlasJSON: ISpriteJSONAtlas, spriteSheet: Texture, options: ISpriteMapOptions, scene: Scene);
  150089. /**
  150090. * Returns tileID location
  150091. * @returns Vector2 the cell position ID
  150092. */
  150093. getTileID(): Vector2;
  150094. /**
  150095. * Gets the UV location of the mouse over the SpriteMap.
  150096. * @returns Vector2 the UV position of the mouse interaction
  150097. */
  150098. getMousePosition(): Vector2;
  150099. /**
  150100. * Creates the "frame" texture Buffer
  150101. * -------------------------------------
  150102. * Structure of frames
  150103. * "filename": "Falling-Water-2.png",
  150104. * "frame": {"x":69,"y":103,"w":24,"h":32},
  150105. * "rotated": true,
  150106. * "trimmed": true,
  150107. * "spriteSourceSize": {"x":4,"y":0,"w":24,"h":32},
  150108. * "sourceSize": {"w":32,"h":32}
  150109. * @returns RawTexture of the frameMap
  150110. */
  150111. private _createFrameBuffer;
  150112. /**
  150113. * Creates the tileMap texture Buffer
  150114. * @param buffer normally and array of numbers, or a false to generate from scratch
  150115. * @param _layer indicates what layer for a logic trigger dealing with the baseTile. The system uses this
  150116. * @returns RawTexture of the tileMap
  150117. */
  150118. private _createTileBuffer;
  150119. /**
  150120. * Modifies the data of the tileMaps
  150121. * @param _layer is the ID of the layer you want to edit on the SpriteMap
  150122. * @param pos is the iVector2 Coordinates of the Tile
  150123. * @param tile The SpriteIndex of the new Tile
  150124. */
  150125. changeTiles(_layer: number | undefined, pos: Vector2 | Vector2[], tile?: number): void;
  150126. /**
  150127. * Creates the animationMap texture Buffer
  150128. * @param buffer normally and array of numbers, or a false to generate from scratch
  150129. * @returns RawTexture of the animationMap
  150130. */
  150131. private _createTileAnimationBuffer;
  150132. /**
  150133. * Modifies the data of the animationMap
  150134. * @param cellID is the Index of the Sprite
  150135. * @param _frame is the target Animation frame
  150136. * @param toCell is the Target Index of the next frame of the animation
  150137. * @param time is a value between 0-1 that is the trigger for when the frame should change tiles
  150138. * @param speed is a global scalar of the time variable on the map.
  150139. */
  150140. addAnimationToTile(cellID?: number, _frame?: number, toCell?: number, time?: number, speed?: number): void;
  150141. /**
  150142. * Exports the .tilemaps file
  150143. */
  150144. saveTileMaps(): void;
  150145. /**
  150146. * Imports the .tilemaps file
  150147. * @param url of the .tilemaps file
  150148. */
  150149. loadTileMaps(url: string): void;
  150150. /**
  150151. * Release associated resources
  150152. */
  150153. dispose(): void;
  150154. }
  150155. }
  150156. declare module BABYLON {
  150157. /**
  150158. * Class used to manage multiple sprites of different sizes on the same spritesheet
  150159. * @see https://doc.babylonjs.com/babylon101/sprites
  150160. */
  150161. export class SpritePackedManager extends SpriteManager {
  150162. /** defines the packed manager's name */
  150163. name: string;
  150164. /**
  150165. * Creates a new sprite manager from a packed sprite sheet
  150166. * @param name defines the manager's name
  150167. * @param imgUrl defines the sprite sheet url
  150168. * @param capacity defines the maximum allowed number of sprites
  150169. * @param scene defines the hosting scene
  150170. * @param spriteJSON null otherwise a JSON object defining sprite sheet data
  150171. * @param epsilon defines the epsilon value to align texture (0.01 by default)
  150172. * @param samplingMode defines the smapling mode to use with spritesheet
  150173. * @param fromPacked set to true; do not alter
  150174. */
  150175. constructor(
  150176. /** defines the packed manager's name */
  150177. name: string, imgUrl: string, capacity: number, scene: Scene, spriteJSON?: string | null, epsilon?: number, samplingMode?: number);
  150178. }
  150179. }
  150180. declare module BABYLON {
  150181. /**
  150182. * Defines the list of states available for a task inside a AssetsManager
  150183. */
  150184. export enum AssetTaskState {
  150185. /**
  150186. * Initialization
  150187. */
  150188. INIT = 0,
  150189. /**
  150190. * Running
  150191. */
  150192. RUNNING = 1,
  150193. /**
  150194. * Done
  150195. */
  150196. DONE = 2,
  150197. /**
  150198. * Error
  150199. */
  150200. ERROR = 3
  150201. }
  150202. /**
  150203. * Define an abstract asset task used with a AssetsManager class to load assets into a scene
  150204. */
  150205. export abstract class AbstractAssetTask {
  150206. /**
  150207. * Task name
  150208. */ name: string;
  150209. /**
  150210. * Callback called when the task is successful
  150211. */
  150212. onSuccess: (task: any) => void;
  150213. /**
  150214. * Callback called when the task is not successful
  150215. */
  150216. onError: (task: any, message?: string, exception?: any) => void;
  150217. /**
  150218. * Creates a new AssetsManager
  150219. * @param name defines the name of the task
  150220. */
  150221. constructor(
  150222. /**
  150223. * Task name
  150224. */ name: string);
  150225. private _isCompleted;
  150226. private _taskState;
  150227. private _errorObject;
  150228. /**
  150229. * Get if the task is completed
  150230. */
  150231. get isCompleted(): boolean;
  150232. /**
  150233. * Gets the current state of the task
  150234. */
  150235. get taskState(): AssetTaskState;
  150236. /**
  150237. * Gets the current error object (if task is in error)
  150238. */
  150239. get errorObject(): {
  150240. message?: string;
  150241. exception?: any;
  150242. };
  150243. /**
  150244. * Internal only
  150245. * @hidden
  150246. */
  150247. _setErrorObject(message?: string, exception?: any): void;
  150248. /**
  150249. * Execute the current task
  150250. * @param scene defines the scene where you want your assets to be loaded
  150251. * @param onSuccess is a callback called when the task is successfully executed
  150252. * @param onError is a callback called if an error occurs
  150253. */
  150254. run(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  150255. /**
  150256. * Execute the current task
  150257. * @param scene defines the scene where you want your assets to be loaded
  150258. * @param onSuccess is a callback called when the task is successfully executed
  150259. * @param onError is a callback called if an error occurs
  150260. */
  150261. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  150262. /**
  150263. * Reset will set the task state back to INIT, so the next load call of the assets manager will execute this task again.
  150264. * This can be used with failed tasks that have the reason for failure fixed.
  150265. */
  150266. reset(): void;
  150267. private onErrorCallback;
  150268. private onDoneCallback;
  150269. }
  150270. /**
  150271. * Define the interface used by progress events raised during assets loading
  150272. */
  150273. export interface IAssetsProgressEvent {
  150274. /**
  150275. * Defines the number of remaining tasks to process
  150276. */
  150277. remainingCount: number;
  150278. /**
  150279. * Defines the total number of tasks
  150280. */
  150281. totalCount: number;
  150282. /**
  150283. * Defines the task that was just processed
  150284. */
  150285. task: AbstractAssetTask;
  150286. }
  150287. /**
  150288. * Class used to share progress information about assets loading
  150289. */
  150290. export class AssetsProgressEvent implements IAssetsProgressEvent {
  150291. /**
  150292. * Defines the number of remaining tasks to process
  150293. */
  150294. remainingCount: number;
  150295. /**
  150296. * Defines the total number of tasks
  150297. */
  150298. totalCount: number;
  150299. /**
  150300. * Defines the task that was just processed
  150301. */
  150302. task: AbstractAssetTask;
  150303. /**
  150304. * Creates a AssetsProgressEvent
  150305. * @param remainingCount defines the number of remaining tasks to process
  150306. * @param totalCount defines the total number of tasks
  150307. * @param task defines the task that was just processed
  150308. */
  150309. constructor(remainingCount: number, totalCount: number, task: AbstractAssetTask);
  150310. }
  150311. /**
  150312. * Define a task used by AssetsManager to load meshes
  150313. */
  150314. export class MeshAssetTask extends AbstractAssetTask {
  150315. /**
  150316. * Defines the name of the task
  150317. */
  150318. name: string;
  150319. /**
  150320. * Defines the list of mesh's names you want to load
  150321. */
  150322. meshesNames: any;
  150323. /**
  150324. * Defines the root url to use as a base to load your meshes and associated resources
  150325. */
  150326. rootUrl: string;
  150327. /**
  150328. * Defines the filename or File of the scene to load from
  150329. */
  150330. sceneFilename: string | File;
  150331. /**
  150332. * Gets the list of loaded meshes
  150333. */
  150334. loadedMeshes: Array<AbstractMesh>;
  150335. /**
  150336. * Gets the list of loaded particle systems
  150337. */
  150338. loadedParticleSystems: Array<IParticleSystem>;
  150339. /**
  150340. * Gets the list of loaded skeletons
  150341. */
  150342. loadedSkeletons: Array<Skeleton>;
  150343. /**
  150344. * Gets the list of loaded animation groups
  150345. */
  150346. loadedAnimationGroups: Array<AnimationGroup>;
  150347. /**
  150348. * Callback called when the task is successful
  150349. */
  150350. onSuccess: (task: MeshAssetTask) => void;
  150351. /**
  150352. * Callback called when the task is successful
  150353. */
  150354. onError: (task: MeshAssetTask, message?: string, exception?: any) => void;
  150355. /**
  150356. * Creates a new MeshAssetTask
  150357. * @param name defines the name of the task
  150358. * @param meshesNames defines the list of mesh's names you want to load
  150359. * @param rootUrl defines the root url to use as a base to load your meshes and associated resources
  150360. * @param sceneFilename defines the filename or File of the scene to load from
  150361. */
  150362. constructor(
  150363. /**
  150364. * Defines the name of the task
  150365. */
  150366. name: string,
  150367. /**
  150368. * Defines the list of mesh's names you want to load
  150369. */
  150370. meshesNames: any,
  150371. /**
  150372. * Defines the root url to use as a base to load your meshes and associated resources
  150373. */
  150374. rootUrl: string,
  150375. /**
  150376. * Defines the filename or File of the scene to load from
  150377. */
  150378. sceneFilename: string | File);
  150379. /**
  150380. * Execute the current task
  150381. * @param scene defines the scene where you want your assets to be loaded
  150382. * @param onSuccess is a callback called when the task is successfully executed
  150383. * @param onError is a callback called if an error occurs
  150384. */
  150385. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  150386. }
  150387. /**
  150388. * Define a task used by AssetsManager to load text content
  150389. */
  150390. export class TextFileAssetTask extends AbstractAssetTask {
  150391. /**
  150392. * Defines the name of the task
  150393. */
  150394. name: string;
  150395. /**
  150396. * Defines the location of the file to load
  150397. */
  150398. url: string;
  150399. /**
  150400. * Gets the loaded text string
  150401. */
  150402. text: string;
  150403. /**
  150404. * Callback called when the task is successful
  150405. */
  150406. onSuccess: (task: TextFileAssetTask) => void;
  150407. /**
  150408. * Callback called when the task is successful
  150409. */
  150410. onError: (task: TextFileAssetTask, message?: string, exception?: any) => void;
  150411. /**
  150412. * Creates a new TextFileAssetTask object
  150413. * @param name defines the name of the task
  150414. * @param url defines the location of the file to load
  150415. */
  150416. constructor(
  150417. /**
  150418. * Defines the name of the task
  150419. */
  150420. name: string,
  150421. /**
  150422. * Defines the location of the file to load
  150423. */
  150424. url: string);
  150425. /**
  150426. * Execute the current task
  150427. * @param scene defines the scene where you want your assets to be loaded
  150428. * @param onSuccess is a callback called when the task is successfully executed
  150429. * @param onError is a callback called if an error occurs
  150430. */
  150431. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  150432. }
  150433. /**
  150434. * Define a task used by AssetsManager to load binary data
  150435. */
  150436. export class BinaryFileAssetTask extends AbstractAssetTask {
  150437. /**
  150438. * Defines the name of the task
  150439. */
  150440. name: string;
  150441. /**
  150442. * Defines the location of the file to load
  150443. */
  150444. url: string;
  150445. /**
  150446. * Gets the lodaded data (as an array buffer)
  150447. */
  150448. data: ArrayBuffer;
  150449. /**
  150450. * Callback called when the task is successful
  150451. */
  150452. onSuccess: (task: BinaryFileAssetTask) => void;
  150453. /**
  150454. * Callback called when the task is successful
  150455. */
  150456. onError: (task: BinaryFileAssetTask, message?: string, exception?: any) => void;
  150457. /**
  150458. * Creates a new BinaryFileAssetTask object
  150459. * @param name defines the name of the new task
  150460. * @param url defines the location of the file to load
  150461. */
  150462. constructor(
  150463. /**
  150464. * Defines the name of the task
  150465. */
  150466. name: string,
  150467. /**
  150468. * Defines the location of the file to load
  150469. */
  150470. url: string);
  150471. /**
  150472. * Execute the current task
  150473. * @param scene defines the scene where you want your assets to be loaded
  150474. * @param onSuccess is a callback called when the task is successfully executed
  150475. * @param onError is a callback called if an error occurs
  150476. */
  150477. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  150478. }
  150479. /**
  150480. * Define a task used by AssetsManager to load images
  150481. */
  150482. export class ImageAssetTask extends AbstractAssetTask {
  150483. /**
  150484. * Defines the name of the task
  150485. */
  150486. name: string;
  150487. /**
  150488. * Defines the location of the image to load
  150489. */
  150490. url: string;
  150491. /**
  150492. * Gets the loaded images
  150493. */
  150494. image: HTMLImageElement;
  150495. /**
  150496. * Callback called when the task is successful
  150497. */
  150498. onSuccess: (task: ImageAssetTask) => void;
  150499. /**
  150500. * Callback called when the task is successful
  150501. */
  150502. onError: (task: ImageAssetTask, message?: string, exception?: any) => void;
  150503. /**
  150504. * Creates a new ImageAssetTask
  150505. * @param name defines the name of the task
  150506. * @param url defines the location of the image to load
  150507. */
  150508. constructor(
  150509. /**
  150510. * Defines the name of the task
  150511. */
  150512. name: string,
  150513. /**
  150514. * Defines the location of the image to load
  150515. */
  150516. url: string);
  150517. /**
  150518. * Execute the current task
  150519. * @param scene defines the scene where you want your assets to be loaded
  150520. * @param onSuccess is a callback called when the task is successfully executed
  150521. * @param onError is a callback called if an error occurs
  150522. */
  150523. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  150524. }
  150525. /**
  150526. * Defines the interface used by texture loading tasks
  150527. */
  150528. export interface ITextureAssetTask<TEX extends BaseTexture> {
  150529. /**
  150530. * Gets the loaded texture
  150531. */
  150532. texture: TEX;
  150533. }
  150534. /**
  150535. * Define a task used by AssetsManager to load 2D textures
  150536. */
  150537. export class TextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<Texture> {
  150538. /**
  150539. * Defines the name of the task
  150540. */
  150541. name: string;
  150542. /**
  150543. * Defines the location of the file to load
  150544. */
  150545. url: string;
  150546. /**
  150547. * Defines if mipmap should not be generated (default is false)
  150548. */
  150549. noMipmap?: boolean | undefined;
  150550. /**
  150551. * Defines if texture must be inverted on Y axis (default is true)
  150552. */
  150553. invertY: boolean;
  150554. /**
  150555. * Defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  150556. */
  150557. samplingMode: number;
  150558. /**
  150559. * Gets the loaded texture
  150560. */
  150561. texture: Texture;
  150562. /**
  150563. * Callback called when the task is successful
  150564. */
  150565. onSuccess: (task: TextureAssetTask) => void;
  150566. /**
  150567. * Callback called when the task is successful
  150568. */
  150569. onError: (task: TextureAssetTask, message?: string, exception?: any) => void;
  150570. /**
  150571. * Creates a new TextureAssetTask object
  150572. * @param name defines the name of the task
  150573. * @param url defines the location of the file to load
  150574. * @param noMipmap defines if mipmap should not be generated (default is false)
  150575. * @param invertY defines if texture must be inverted on Y axis (default is true)
  150576. * @param samplingMode defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  150577. */
  150578. constructor(
  150579. /**
  150580. * Defines the name of the task
  150581. */
  150582. name: string,
  150583. /**
  150584. * Defines the location of the file to load
  150585. */
  150586. url: string,
  150587. /**
  150588. * Defines if mipmap should not be generated (default is false)
  150589. */
  150590. noMipmap?: boolean | undefined,
  150591. /**
  150592. * Defines if texture must be inverted on Y axis (default is true)
  150593. */
  150594. invertY?: boolean,
  150595. /**
  150596. * Defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  150597. */
  150598. samplingMode?: number);
  150599. /**
  150600. * Execute the current task
  150601. * @param scene defines the scene where you want your assets to be loaded
  150602. * @param onSuccess is a callback called when the task is successfully executed
  150603. * @param onError is a callback called if an error occurs
  150604. */
  150605. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  150606. }
  150607. /**
  150608. * Define a task used by AssetsManager to load cube textures
  150609. */
  150610. export class CubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<CubeTexture> {
  150611. /**
  150612. * Defines the name of the task
  150613. */
  150614. name: string;
  150615. /**
  150616. * Defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  150617. */
  150618. url: string;
  150619. /**
  150620. * Defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  150621. */
  150622. extensions?: string[] | undefined;
  150623. /**
  150624. * Defines if mipmaps should not be generated (default is false)
  150625. */
  150626. noMipmap?: boolean | undefined;
  150627. /**
  150628. * Defines the explicit list of files (undefined by default)
  150629. */
  150630. files?: string[] | undefined;
  150631. /**
  150632. * Gets the loaded texture
  150633. */
  150634. texture: CubeTexture;
  150635. /**
  150636. * Callback called when the task is successful
  150637. */
  150638. onSuccess: (task: CubeTextureAssetTask) => void;
  150639. /**
  150640. * Callback called when the task is successful
  150641. */
  150642. onError: (task: CubeTextureAssetTask, message?: string, exception?: any) => void;
  150643. /**
  150644. * Creates a new CubeTextureAssetTask
  150645. * @param name defines the name of the task
  150646. * @param url defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  150647. * @param extensions defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  150648. * @param noMipmap defines if mipmaps should not be generated (default is false)
  150649. * @param files defines the explicit list of files (undefined by default)
  150650. */
  150651. constructor(
  150652. /**
  150653. * Defines the name of the task
  150654. */
  150655. name: string,
  150656. /**
  150657. * Defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  150658. */
  150659. url: string,
  150660. /**
  150661. * Defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  150662. */
  150663. extensions?: string[] | undefined,
  150664. /**
  150665. * Defines if mipmaps should not be generated (default is false)
  150666. */
  150667. noMipmap?: boolean | undefined,
  150668. /**
  150669. * Defines the explicit list of files (undefined by default)
  150670. */
  150671. files?: string[] | undefined);
  150672. /**
  150673. * Execute the current task
  150674. * @param scene defines the scene where you want your assets to be loaded
  150675. * @param onSuccess is a callback called when the task is successfully executed
  150676. * @param onError is a callback called if an error occurs
  150677. */
  150678. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  150679. }
  150680. /**
  150681. * Define a task used by AssetsManager to load HDR cube textures
  150682. */
  150683. export class HDRCubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<HDRCubeTexture> {
  150684. /**
  150685. * Defines the name of the task
  150686. */
  150687. name: string;
  150688. /**
  150689. * Defines the location of the file to load
  150690. */
  150691. url: string;
  150692. /**
  150693. * Defines the desired size (the more it increases the longer the generation will be)
  150694. */
  150695. size: number;
  150696. /**
  150697. * Defines if mipmaps should not be generated (default is false)
  150698. */
  150699. noMipmap: boolean;
  150700. /**
  150701. * Specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  150702. */
  150703. generateHarmonics: boolean;
  150704. /**
  150705. * 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)
  150706. */
  150707. gammaSpace: boolean;
  150708. /**
  150709. * Internal Use Only
  150710. */
  150711. reserved: boolean;
  150712. /**
  150713. * Gets the loaded texture
  150714. */
  150715. texture: HDRCubeTexture;
  150716. /**
  150717. * Callback called when the task is successful
  150718. */
  150719. onSuccess: (task: HDRCubeTextureAssetTask) => void;
  150720. /**
  150721. * Callback called when the task is successful
  150722. */
  150723. onError: (task: HDRCubeTextureAssetTask, message?: string, exception?: any) => void;
  150724. /**
  150725. * Creates a new HDRCubeTextureAssetTask object
  150726. * @param name defines the name of the task
  150727. * @param url defines the location of the file to load
  150728. * @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.
  150729. * @param noMipmap defines if mipmaps should not be generated (default is false)
  150730. * @param generateHarmonics specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  150731. * @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)
  150732. * @param reserved Internal use only
  150733. */
  150734. constructor(
  150735. /**
  150736. * Defines the name of the task
  150737. */
  150738. name: string,
  150739. /**
  150740. * Defines the location of the file to load
  150741. */
  150742. url: string,
  150743. /**
  150744. * Defines the desired size (the more it increases the longer the generation will be)
  150745. */
  150746. size: number,
  150747. /**
  150748. * Defines if mipmaps should not be generated (default is false)
  150749. */
  150750. noMipmap?: boolean,
  150751. /**
  150752. * Specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  150753. */
  150754. generateHarmonics?: boolean,
  150755. /**
  150756. * 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)
  150757. */
  150758. gammaSpace?: boolean,
  150759. /**
  150760. * Internal Use Only
  150761. */
  150762. reserved?: boolean);
  150763. /**
  150764. * Execute the current task
  150765. * @param scene defines the scene where you want your assets to be loaded
  150766. * @param onSuccess is a callback called when the task is successfully executed
  150767. * @param onError is a callback called if an error occurs
  150768. */
  150769. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  150770. }
  150771. /**
  150772. * Define a task used by AssetsManager to load Equirectangular cube textures
  150773. */
  150774. export class EquiRectangularCubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<EquiRectangularCubeTexture> {
  150775. /**
  150776. * Defines the name of the task
  150777. */
  150778. name: string;
  150779. /**
  150780. * Defines the location of the file to load
  150781. */
  150782. url: string;
  150783. /**
  150784. * Defines the desired size (the more it increases the longer the generation will be)
  150785. */
  150786. size: number;
  150787. /**
  150788. * Defines if mipmaps should not be generated (default is false)
  150789. */
  150790. noMipmap: boolean;
  150791. /**
  150792. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space,
  150793. * but the standard material would require them in Gamma space) (default is true)
  150794. */
  150795. gammaSpace: boolean;
  150796. /**
  150797. * Gets the loaded texture
  150798. */
  150799. texture: EquiRectangularCubeTexture;
  150800. /**
  150801. * Callback called when the task is successful
  150802. */
  150803. onSuccess: (task: EquiRectangularCubeTextureAssetTask) => void;
  150804. /**
  150805. * Callback called when the task is successful
  150806. */
  150807. onError: (task: EquiRectangularCubeTextureAssetTask, message?: string, exception?: any) => void;
  150808. /**
  150809. * Creates a new EquiRectangularCubeTextureAssetTask object
  150810. * @param name defines the name of the task
  150811. * @param url defines the location of the file to load
  150812. * @param size defines the desired size (the more it increases the longer the generation will be)
  150813. * If the size is omitted this implies you are using a preprocessed cubemap.
  150814. * @param noMipmap defines if mipmaps should not be generated (default is false)
  150815. * @param gammaSpace specifies if the texture will be used in gamma or linear space
  150816. * (the PBR material requires those texture in linear space, but the standard material would require them in Gamma space)
  150817. * (default is true)
  150818. */
  150819. constructor(
  150820. /**
  150821. * Defines the name of the task
  150822. */
  150823. name: string,
  150824. /**
  150825. * Defines the location of the file to load
  150826. */
  150827. url: string,
  150828. /**
  150829. * Defines the desired size (the more it increases the longer the generation will be)
  150830. */
  150831. size: number,
  150832. /**
  150833. * Defines if mipmaps should not be generated (default is false)
  150834. */
  150835. noMipmap?: boolean,
  150836. /**
  150837. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space,
  150838. * but the standard material would require them in Gamma space) (default is true)
  150839. */
  150840. gammaSpace?: boolean);
  150841. /**
  150842. * Execute the current task
  150843. * @param scene defines the scene where you want your assets to be loaded
  150844. * @param onSuccess is a callback called when the task is successfully executed
  150845. * @param onError is a callback called if an error occurs
  150846. */
  150847. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  150848. }
  150849. /**
  150850. * This class can be used to easily import assets into a scene
  150851. * @see https://doc.babylonjs.com/how_to/how_to_use_assetsmanager
  150852. */
  150853. export class AssetsManager {
  150854. private _scene;
  150855. private _isLoading;
  150856. protected _tasks: AbstractAssetTask[];
  150857. protected _waitingTasksCount: number;
  150858. protected _totalTasksCount: number;
  150859. /**
  150860. * Callback called when all tasks are processed
  150861. */
  150862. onFinish: (tasks: AbstractAssetTask[]) => void;
  150863. /**
  150864. * Callback called when a task is successful
  150865. */
  150866. onTaskSuccess: (task: AbstractAssetTask) => void;
  150867. /**
  150868. * Callback called when a task had an error
  150869. */
  150870. onTaskError: (task: AbstractAssetTask) => void;
  150871. /**
  150872. * Callback called when a task is done (whatever the result is)
  150873. */
  150874. onProgress: (remainingCount: number, totalCount: number, task: AbstractAssetTask) => void;
  150875. /**
  150876. * Observable called when all tasks are processed
  150877. */
  150878. onTaskSuccessObservable: Observable<AbstractAssetTask>;
  150879. /**
  150880. * Observable called when a task had an error
  150881. */
  150882. onTaskErrorObservable: Observable<AbstractAssetTask>;
  150883. /**
  150884. * Observable called when all tasks were executed
  150885. */
  150886. onTasksDoneObservable: Observable<AbstractAssetTask[]>;
  150887. /**
  150888. * Observable called when a task is done (whatever the result is)
  150889. */
  150890. onProgressObservable: Observable<IAssetsProgressEvent>;
  150891. /**
  150892. * Gets or sets a boolean defining if the AssetsManager should use the default loading screen
  150893. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  150894. */
  150895. useDefaultLoadingScreen: boolean;
  150896. /**
  150897. * Gets or sets a boolean defining if the AssetsManager should automatically hide the loading screen
  150898. * when all assets have been downloaded.
  150899. * If set to false, you need to manually call in hideLoadingUI() once your scene is ready.
  150900. */
  150901. autoHideLoadingUI: boolean;
  150902. /**
  150903. * Creates a new AssetsManager
  150904. * @param scene defines the scene to work on
  150905. */
  150906. constructor(scene: Scene);
  150907. /**
  150908. * Add a MeshAssetTask to the list of active tasks
  150909. * @param taskName defines the name of the new task
  150910. * @param meshesNames defines the name of meshes to load
  150911. * @param rootUrl defines the root url to use to locate files
  150912. * @param sceneFilename defines the filename of the scene file
  150913. * @returns a new MeshAssetTask object
  150914. */
  150915. addMeshTask(taskName: string, meshesNames: any, rootUrl: string, sceneFilename: string): MeshAssetTask;
  150916. /**
  150917. * Add a TextFileAssetTask to the list of active tasks
  150918. * @param taskName defines the name of the new task
  150919. * @param url defines the url of the file to load
  150920. * @returns a new TextFileAssetTask object
  150921. */
  150922. addTextFileTask(taskName: string, url: string): TextFileAssetTask;
  150923. /**
  150924. * Add a BinaryFileAssetTask to the list of active tasks
  150925. * @param taskName defines the name of the new task
  150926. * @param url defines the url of the file to load
  150927. * @returns a new BinaryFileAssetTask object
  150928. */
  150929. addBinaryFileTask(taskName: string, url: string): BinaryFileAssetTask;
  150930. /**
  150931. * Add a ImageAssetTask to the list of active tasks
  150932. * @param taskName defines the name of the new task
  150933. * @param url defines the url of the file to load
  150934. * @returns a new ImageAssetTask object
  150935. */
  150936. addImageTask(taskName: string, url: string): ImageAssetTask;
  150937. /**
  150938. * Add a TextureAssetTask to the list of active tasks
  150939. * @param taskName defines the name of the new task
  150940. * @param url defines the url of the file to load
  150941. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  150942. * @param invertY defines if you want to invert Y axis of the loaded texture (false by default)
  150943. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  150944. * @returns a new TextureAssetTask object
  150945. */
  150946. addTextureTask(taskName: string, url: string, noMipmap?: boolean, invertY?: boolean, samplingMode?: number): TextureAssetTask;
  150947. /**
  150948. * Add a CubeTextureAssetTask to the list of active tasks
  150949. * @param taskName defines the name of the new task
  150950. * @param url defines the url of the file to load
  150951. * @param extensions defines the extension to use to load the cube map (can be null)
  150952. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  150953. * @param files defines the list of files to load (can be null)
  150954. * @returns a new CubeTextureAssetTask object
  150955. */
  150956. addCubeTextureTask(taskName: string, url: string, extensions?: string[], noMipmap?: boolean, files?: string[]): CubeTextureAssetTask;
  150957. /**
  150958. *
  150959. * Add a HDRCubeTextureAssetTask to the list of active tasks
  150960. * @param taskName defines the name of the new task
  150961. * @param url defines the url of the file to load
  150962. * @param size defines the size you want for the cubemap (can be null)
  150963. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  150964. * @param generateHarmonics defines if you want to automatically generate (true by default)
  150965. * @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)
  150966. * @param reserved Internal use only
  150967. * @returns a new HDRCubeTextureAssetTask object
  150968. */
  150969. addHDRCubeTextureTask(taskName: string, url: string, size: number, noMipmap?: boolean, generateHarmonics?: boolean, gammaSpace?: boolean, reserved?: boolean): HDRCubeTextureAssetTask;
  150970. /**
  150971. *
  150972. * Add a EquiRectangularCubeTextureAssetTask to the list of active tasks
  150973. * @param taskName defines the name of the new task
  150974. * @param url defines the url of the file to load
  150975. * @param size defines the size you want for the cubemap (can be null)
  150976. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  150977. * @param gammaSpace Specifies if the texture will be used in gamma or linear space
  150978. * (the PBR material requires those textures in linear space, but the standard material would require them in Gamma space)
  150979. * @returns a new EquiRectangularCubeTextureAssetTask object
  150980. */
  150981. addEquiRectangularCubeTextureAssetTask(taskName: string, url: string, size: number, noMipmap?: boolean, gammaSpace?: boolean): EquiRectangularCubeTextureAssetTask;
  150982. /**
  150983. * Remove a task from the assets manager.
  150984. * @param task the task to remove
  150985. */
  150986. removeTask(task: AbstractAssetTask): void;
  150987. private _decreaseWaitingTasksCount;
  150988. private _runTask;
  150989. /**
  150990. * Reset the AssetsManager and remove all tasks
  150991. * @return the current instance of the AssetsManager
  150992. */
  150993. reset(): AssetsManager;
  150994. /**
  150995. * Start the loading process
  150996. * @return the current instance of the AssetsManager
  150997. */
  150998. load(): AssetsManager;
  150999. /**
  151000. * Start the loading process as an async operation
  151001. * @return a promise returning the list of failed tasks
  151002. */
  151003. loadAsync(): Promise<void>;
  151004. }
  151005. }
  151006. declare module BABYLON {
  151007. /**
  151008. * Wrapper class for promise with external resolve and reject.
  151009. */
  151010. export class Deferred<T> {
  151011. /**
  151012. * The promise associated with this deferred object.
  151013. */
  151014. readonly promise: Promise<T>;
  151015. private _resolve;
  151016. private _reject;
  151017. /**
  151018. * The resolve method of the promise associated with this deferred object.
  151019. */
  151020. get resolve(): (value?: T | PromiseLike<T> | undefined) => void;
  151021. /**
  151022. * The reject method of the promise associated with this deferred object.
  151023. */
  151024. get reject(): (reason?: any) => void;
  151025. /**
  151026. * Constructor for this deferred object.
  151027. */
  151028. constructor();
  151029. }
  151030. }
  151031. declare module BABYLON {
  151032. /**
  151033. * Class used to explode meshes (ie. to have a center and move them away from that center to better see the overall organization)
  151034. */
  151035. export class MeshExploder {
  151036. private _centerMesh;
  151037. private _meshes;
  151038. private _meshesOrigins;
  151039. private _toCenterVectors;
  151040. private _scaledDirection;
  151041. private _newPosition;
  151042. private _centerPosition;
  151043. /**
  151044. * Explodes meshes from a center mesh.
  151045. * @param meshes The meshes to explode.
  151046. * @param centerMesh The mesh to be center of explosion.
  151047. */
  151048. constructor(meshes: Array<Mesh>, centerMesh?: Mesh);
  151049. private _setCenterMesh;
  151050. /**
  151051. * Get class name
  151052. * @returns "MeshExploder"
  151053. */
  151054. getClassName(): string;
  151055. /**
  151056. * "Exploded meshes"
  151057. * @returns Array of meshes with the centerMesh at index 0.
  151058. */
  151059. getMeshes(): Array<Mesh>;
  151060. /**
  151061. * Explodes meshes giving a specific direction
  151062. * @param direction Number to multiply distance of each mesh's origin from center. Use a negative number to implode, or zero to reset.
  151063. */
  151064. explode(direction?: number): void;
  151065. }
  151066. }
  151067. declare module BABYLON {
  151068. /**
  151069. * Class used to help managing file picking and drag'n'drop
  151070. */
  151071. export class FilesInput {
  151072. /**
  151073. * List of files ready to be loaded
  151074. */
  151075. static get FilesToLoad(): {
  151076. [key: string]: File;
  151077. };
  151078. /**
  151079. * Callback called when a file is processed
  151080. */
  151081. onProcessFileCallback: (file: File, name: string, extension: string) => boolean;
  151082. private _engine;
  151083. private _currentScene;
  151084. private _sceneLoadedCallback;
  151085. private _progressCallback;
  151086. private _additionalRenderLoopLogicCallback;
  151087. private _textureLoadingCallback;
  151088. private _startingProcessingFilesCallback;
  151089. private _onReloadCallback;
  151090. private _errorCallback;
  151091. private _elementToMonitor;
  151092. private _sceneFileToLoad;
  151093. private _filesToLoad;
  151094. /**
  151095. * Creates a new FilesInput
  151096. * @param engine defines the rendering engine
  151097. * @param scene defines the hosting scene
  151098. * @param sceneLoadedCallback callback called when scene is loaded
  151099. * @param progressCallback callback called to track progress
  151100. * @param additionalRenderLoopLogicCallback callback called to add user logic to the rendering loop
  151101. * @param textureLoadingCallback callback called when a texture is loading
  151102. * @param startingProcessingFilesCallback callback called when the system is about to process all files
  151103. * @param onReloadCallback callback called when a reload is requested
  151104. * @param errorCallback callback call if an error occurs
  151105. */
  151106. 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>);
  151107. private _dragEnterHandler;
  151108. private _dragOverHandler;
  151109. private _dropHandler;
  151110. /**
  151111. * Calls this function to listen to drag'n'drop events on a specific DOM element
  151112. * @param elementToMonitor defines the DOM element to track
  151113. */
  151114. monitorElementForDragNDrop(elementToMonitor: HTMLElement): void;
  151115. /** Gets the current list of files to load */
  151116. get filesToLoad(): File[];
  151117. /**
  151118. * Release all associated resources
  151119. */
  151120. dispose(): void;
  151121. private renderFunction;
  151122. private drag;
  151123. private drop;
  151124. private _traverseFolder;
  151125. private _processFiles;
  151126. /**
  151127. * Load files from a drop event
  151128. * @param event defines the drop event to use as source
  151129. */
  151130. loadFiles(event: any): void;
  151131. private _processReload;
  151132. /**
  151133. * Reload the current scene from the loaded files
  151134. */
  151135. reload(): void;
  151136. }
  151137. }
  151138. declare module BABYLON {
  151139. /**
  151140. * Defines the root class used to create scene optimization to use with SceneOptimizer
  151141. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  151142. */
  151143. export class SceneOptimization {
  151144. /**
  151145. * Defines the priority of this optimization (0 by default which means first in the list)
  151146. */
  151147. priority: number;
  151148. /**
  151149. * Gets a string describing the action executed by the current optimization
  151150. * @returns description string
  151151. */
  151152. getDescription(): string;
  151153. /**
  151154. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  151155. * @param scene defines the current scene where to apply this optimization
  151156. * @param optimizer defines the current optimizer
  151157. * @returns true if everything that can be done was applied
  151158. */
  151159. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  151160. /**
  151161. * Creates the SceneOptimization object
  151162. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  151163. * @param desc defines the description associated with the optimization
  151164. */
  151165. constructor(
  151166. /**
  151167. * Defines the priority of this optimization (0 by default which means first in the list)
  151168. */
  151169. priority?: number);
  151170. }
  151171. /**
  151172. * Defines an optimization used to reduce the size of render target textures
  151173. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  151174. */
  151175. export class TextureOptimization extends SceneOptimization {
  151176. /**
  151177. * Defines the priority of this optimization (0 by default which means first in the list)
  151178. */
  151179. priority: number;
  151180. /**
  151181. * 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
  151182. */
  151183. maximumSize: number;
  151184. /**
  151185. * Defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  151186. */
  151187. step: number;
  151188. /**
  151189. * Gets a string describing the action executed by the current optimization
  151190. * @returns description string
  151191. */
  151192. getDescription(): string;
  151193. /**
  151194. * Creates the TextureOptimization object
  151195. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  151196. * @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
  151197. * @param step defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  151198. */
  151199. constructor(
  151200. /**
  151201. * Defines the priority of this optimization (0 by default which means first in the list)
  151202. */
  151203. priority?: number,
  151204. /**
  151205. * 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
  151206. */
  151207. maximumSize?: number,
  151208. /**
  151209. * Defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  151210. */
  151211. step?: number);
  151212. /**
  151213. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  151214. * @param scene defines the current scene where to apply this optimization
  151215. * @param optimizer defines the current optimizer
  151216. * @returns true if everything that can be done was applied
  151217. */
  151218. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  151219. }
  151220. /**
  151221. * Defines an optimization used to increase or decrease the rendering resolution
  151222. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  151223. */
  151224. export class HardwareScalingOptimization extends SceneOptimization {
  151225. /**
  151226. * Defines the priority of this optimization (0 by default which means first in the list)
  151227. */
  151228. priority: number;
  151229. /**
  151230. * Defines the maximum scale to use (2 by default)
  151231. */
  151232. maximumScale: number;
  151233. /**
  151234. * Defines the step to use between two passes (0.5 by default)
  151235. */
  151236. step: number;
  151237. private _currentScale;
  151238. private _directionOffset;
  151239. /**
  151240. * Gets a string describing the action executed by the current optimization
  151241. * @return description string
  151242. */
  151243. getDescription(): string;
  151244. /**
  151245. * Creates the HardwareScalingOptimization object
  151246. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  151247. * @param maximumScale defines the maximum scale to use (2 by default)
  151248. * @param step defines the step to use between two passes (0.5 by default)
  151249. */
  151250. constructor(
  151251. /**
  151252. * Defines the priority of this optimization (0 by default which means first in the list)
  151253. */
  151254. priority?: number,
  151255. /**
  151256. * Defines the maximum scale to use (2 by default)
  151257. */
  151258. maximumScale?: number,
  151259. /**
  151260. * Defines the step to use between two passes (0.5 by default)
  151261. */
  151262. step?: number);
  151263. /**
  151264. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  151265. * @param scene defines the current scene where to apply this optimization
  151266. * @param optimizer defines the current optimizer
  151267. * @returns true if everything that can be done was applied
  151268. */
  151269. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  151270. }
  151271. /**
  151272. * Defines an optimization used to remove shadows
  151273. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  151274. */
  151275. export class ShadowsOptimization extends SceneOptimization {
  151276. /**
  151277. * Gets a string describing the action executed by the current optimization
  151278. * @return description string
  151279. */
  151280. getDescription(): string;
  151281. /**
  151282. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  151283. * @param scene defines the current scene where to apply this optimization
  151284. * @param optimizer defines the current optimizer
  151285. * @returns true if everything that can be done was applied
  151286. */
  151287. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  151288. }
  151289. /**
  151290. * Defines an optimization used to turn post-processes off
  151291. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  151292. */
  151293. export class PostProcessesOptimization extends SceneOptimization {
  151294. /**
  151295. * Gets a string describing the action executed by the current optimization
  151296. * @return description string
  151297. */
  151298. getDescription(): string;
  151299. /**
  151300. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  151301. * @param scene defines the current scene where to apply this optimization
  151302. * @param optimizer defines the current optimizer
  151303. * @returns true if everything that can be done was applied
  151304. */
  151305. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  151306. }
  151307. /**
  151308. * Defines an optimization used to turn lens flares off
  151309. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  151310. */
  151311. export class LensFlaresOptimization extends SceneOptimization {
  151312. /**
  151313. * Gets a string describing the action executed by the current optimization
  151314. * @return description string
  151315. */
  151316. getDescription(): string;
  151317. /**
  151318. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  151319. * @param scene defines the current scene where to apply this optimization
  151320. * @param optimizer defines the current optimizer
  151321. * @returns true if everything that can be done was applied
  151322. */
  151323. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  151324. }
  151325. /**
  151326. * Defines an optimization based on user defined callback.
  151327. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  151328. */
  151329. export class CustomOptimization extends SceneOptimization {
  151330. /**
  151331. * Callback called to apply the custom optimization.
  151332. */
  151333. onApply: (scene: Scene, optimizer: SceneOptimizer) => boolean;
  151334. /**
  151335. * Callback called to get custom description
  151336. */
  151337. onGetDescription: () => string;
  151338. /**
  151339. * Gets a string describing the action executed by the current optimization
  151340. * @returns description string
  151341. */
  151342. getDescription(): string;
  151343. /**
  151344. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  151345. * @param scene defines the current scene where to apply this optimization
  151346. * @param optimizer defines the current optimizer
  151347. * @returns true if everything that can be done was applied
  151348. */
  151349. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  151350. }
  151351. /**
  151352. * Defines an optimization used to turn particles off
  151353. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  151354. */
  151355. export class ParticlesOptimization extends SceneOptimization {
  151356. /**
  151357. * Gets a string describing the action executed by the current optimization
  151358. * @return description string
  151359. */
  151360. getDescription(): string;
  151361. /**
  151362. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  151363. * @param scene defines the current scene where to apply this optimization
  151364. * @param optimizer defines the current optimizer
  151365. * @returns true if everything that can be done was applied
  151366. */
  151367. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  151368. }
  151369. /**
  151370. * Defines an optimization used to turn render targets off
  151371. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  151372. */
  151373. export class RenderTargetsOptimization extends SceneOptimization {
  151374. /**
  151375. * Gets a string describing the action executed by the current optimization
  151376. * @return description string
  151377. */
  151378. getDescription(): string;
  151379. /**
  151380. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  151381. * @param scene defines the current scene where to apply this optimization
  151382. * @param optimizer defines the current optimizer
  151383. * @returns true if everything that can be done was applied
  151384. */
  151385. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  151386. }
  151387. /**
  151388. * Defines an optimization used to merge meshes with compatible materials
  151389. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  151390. */
  151391. export class MergeMeshesOptimization extends SceneOptimization {
  151392. private static _UpdateSelectionTree;
  151393. /**
  151394. * Gets or sets a boolean which defines if optimization octree has to be updated
  151395. */
  151396. static get UpdateSelectionTree(): boolean;
  151397. /**
  151398. * Gets or sets a boolean which defines if optimization octree has to be updated
  151399. */
  151400. static set UpdateSelectionTree(value: boolean);
  151401. /**
  151402. * Gets a string describing the action executed by the current optimization
  151403. * @return description string
  151404. */
  151405. getDescription(): string;
  151406. private _canBeMerged;
  151407. /**
  151408. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  151409. * @param scene defines the current scene where to apply this optimization
  151410. * @param optimizer defines the current optimizer
  151411. * @param updateSelectionTree defines that the selection octree has to be updated (false by default)
  151412. * @returns true if everything that can be done was applied
  151413. */
  151414. apply(scene: Scene, optimizer: SceneOptimizer, updateSelectionTree?: boolean): boolean;
  151415. }
  151416. /**
  151417. * Defines a list of options used by SceneOptimizer
  151418. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  151419. */
  151420. export class SceneOptimizerOptions {
  151421. /**
  151422. * Defines the target frame rate to reach (60 by default)
  151423. */
  151424. targetFrameRate: number;
  151425. /**
  151426. * Defines the interval between two checkes (2000ms by default)
  151427. */
  151428. trackerDuration: number;
  151429. /**
  151430. * Gets the list of optimizations to apply
  151431. */
  151432. optimizations: SceneOptimization[];
  151433. /**
  151434. * Creates a new list of options used by SceneOptimizer
  151435. * @param targetFrameRate defines the target frame rate to reach (60 by default)
  151436. * @param trackerDuration defines the interval between two checkes (2000ms by default)
  151437. */
  151438. constructor(
  151439. /**
  151440. * Defines the target frame rate to reach (60 by default)
  151441. */
  151442. targetFrameRate?: number,
  151443. /**
  151444. * Defines the interval between two checkes (2000ms by default)
  151445. */
  151446. trackerDuration?: number);
  151447. /**
  151448. * Add a new optimization
  151449. * @param optimization defines the SceneOptimization to add to the list of active optimizations
  151450. * @returns the current SceneOptimizerOptions
  151451. */
  151452. addOptimization(optimization: SceneOptimization): SceneOptimizerOptions;
  151453. /**
  151454. * Add a new custom optimization
  151455. * @param onApply defines the callback called to apply the custom optimization (true if everything that can be done was applied)
  151456. * @param onGetDescription defines the callback called to get the description attached with the optimization.
  151457. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  151458. * @returns the current SceneOptimizerOptions
  151459. */
  151460. addCustomOptimization(onApply: (scene: Scene) => boolean, onGetDescription: () => string, priority?: number): SceneOptimizerOptions;
  151461. /**
  151462. * Creates a list of pre-defined optimizations aimed to reduce the visual impact on the scene
  151463. * @param targetFrameRate defines the target frame rate (60 by default)
  151464. * @returns a SceneOptimizerOptions object
  151465. */
  151466. static LowDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  151467. /**
  151468. * Creates a list of pre-defined optimizations aimed to have a moderate impact on the scene visual
  151469. * @param targetFrameRate defines the target frame rate (60 by default)
  151470. * @returns a SceneOptimizerOptions object
  151471. */
  151472. static ModerateDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  151473. /**
  151474. * Creates a list of pre-defined optimizations aimed to have a big impact on the scene visual
  151475. * @param targetFrameRate defines the target frame rate (60 by default)
  151476. * @returns a SceneOptimizerOptions object
  151477. */
  151478. static HighDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  151479. }
  151480. /**
  151481. * Class used to run optimizations in order to reach a target frame rate
  151482. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  151483. */
  151484. export class SceneOptimizer implements IDisposable {
  151485. private _isRunning;
  151486. private _options;
  151487. private _scene;
  151488. private _currentPriorityLevel;
  151489. private _targetFrameRate;
  151490. private _trackerDuration;
  151491. private _currentFrameRate;
  151492. private _sceneDisposeObserver;
  151493. private _improvementMode;
  151494. /**
  151495. * Defines an observable called when the optimizer reaches the target frame rate
  151496. */
  151497. onSuccessObservable: Observable<SceneOptimizer>;
  151498. /**
  151499. * Defines an observable called when the optimizer enables an optimization
  151500. */
  151501. onNewOptimizationAppliedObservable: Observable<SceneOptimization>;
  151502. /**
  151503. * Defines an observable called when the optimizer is not able to reach the target frame rate
  151504. */
  151505. onFailureObservable: Observable<SceneOptimizer>;
  151506. /**
  151507. * Gets a boolean indicating if the optimizer is in improvement mode
  151508. */
  151509. get isInImprovementMode(): boolean;
  151510. /**
  151511. * Gets the current priority level (0 at start)
  151512. */
  151513. get currentPriorityLevel(): number;
  151514. /**
  151515. * Gets the current frame rate checked by the SceneOptimizer
  151516. */
  151517. get currentFrameRate(): number;
  151518. /**
  151519. * Gets or sets the current target frame rate (60 by default)
  151520. */
  151521. get targetFrameRate(): number;
  151522. /**
  151523. * Gets or sets the current target frame rate (60 by default)
  151524. */
  151525. set targetFrameRate(value: number);
  151526. /**
  151527. * Gets or sets the current interval between two checks (every 2000ms by default)
  151528. */
  151529. get trackerDuration(): number;
  151530. /**
  151531. * Gets or sets the current interval between two checks (every 2000ms by default)
  151532. */
  151533. set trackerDuration(value: number);
  151534. /**
  151535. * Gets the list of active optimizations
  151536. */
  151537. get optimizations(): SceneOptimization[];
  151538. /**
  151539. * Creates a new SceneOptimizer
  151540. * @param scene defines the scene to work on
  151541. * @param options defines the options to use with the SceneOptimizer
  151542. * @param autoGeneratePriorities defines if priorities must be generated and not read from SceneOptimization property (true by default)
  151543. * @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)
  151544. */
  151545. constructor(scene: Scene, options?: SceneOptimizerOptions, autoGeneratePriorities?: boolean, improvementMode?: boolean);
  151546. /**
  151547. * Stops the current optimizer
  151548. */
  151549. stop(): void;
  151550. /**
  151551. * Reset the optimizer to initial step (current priority level = 0)
  151552. */
  151553. reset(): void;
  151554. /**
  151555. * Start the optimizer. By default it will try to reach a specific framerate
  151556. * but if the optimizer is set with improvementMode === true then it will run all optimiatiation while frame rate is above the target frame rate
  151557. */
  151558. start(): void;
  151559. private _checkCurrentState;
  151560. /**
  151561. * Release all resources
  151562. */
  151563. dispose(): void;
  151564. /**
  151565. * Helper function to create a SceneOptimizer with one single line of code
  151566. * @param scene defines the scene to work on
  151567. * @param options defines the options to use with the SceneOptimizer
  151568. * @param onSuccess defines a callback to call on success
  151569. * @param onFailure defines a callback to call on failure
  151570. * @returns the new SceneOptimizer object
  151571. */
  151572. static OptimizeAsync(scene: Scene, options?: SceneOptimizerOptions, onSuccess?: () => void, onFailure?: () => void): SceneOptimizer;
  151573. }
  151574. }
  151575. declare module BABYLON {
  151576. /**
  151577. * Class used to serialize a scene into a string
  151578. */
  151579. export class SceneSerializer {
  151580. /**
  151581. * Clear cache used by a previous serialization
  151582. */
  151583. static ClearCache(): void;
  151584. /**
  151585. * Serialize a scene into a JSON compatible object
  151586. * @param scene defines the scene to serialize
  151587. * @returns a JSON compatible object
  151588. */
  151589. static Serialize(scene: Scene): any;
  151590. /**
  151591. * Serialize a mesh into a JSON compatible object
  151592. * @param toSerialize defines the mesh to serialize
  151593. * @param withParents defines if parents must be serialized as well
  151594. * @param withChildren defines if children must be serialized as well
  151595. * @returns a JSON compatible object
  151596. */
  151597. static SerializeMesh(toSerialize: any, withParents?: boolean, withChildren?: boolean): any;
  151598. }
  151599. }
  151600. declare module BABYLON {
  151601. /**
  151602. * Class used to host texture specific utilities
  151603. */
  151604. export class TextureTools {
  151605. /**
  151606. * Uses the GPU to create a copy texture rescaled at a given size
  151607. * @param texture Texture to copy from
  151608. * @param width defines the desired width
  151609. * @param height defines the desired height
  151610. * @param useBilinearMode defines if bilinear mode has to be used
  151611. * @return the generated texture
  151612. */
  151613. static CreateResizedCopy(texture: Texture, width: number, height: number, useBilinearMode?: boolean): Texture;
  151614. }
  151615. }
  151616. declare module BABYLON {
  151617. /**
  151618. * This represents the different options available for the video capture.
  151619. */
  151620. export interface VideoRecorderOptions {
  151621. /** Defines the mime type of the video. */
  151622. mimeType: string;
  151623. /** Defines the FPS the video should be recorded at. */
  151624. fps: number;
  151625. /** Defines the chunk size for the recording data. */
  151626. recordChunckSize: number;
  151627. /** The audio tracks to attach to the recording. */
  151628. audioTracks?: MediaStreamTrack[];
  151629. }
  151630. /**
  151631. * This can help with recording videos from BabylonJS.
  151632. * This is based on the available WebRTC functionalities of the browser.
  151633. *
  151634. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_video
  151635. */
  151636. export class VideoRecorder {
  151637. private static readonly _defaultOptions;
  151638. /**
  151639. * Returns whether or not the VideoRecorder is available in your browser.
  151640. * @param engine Defines the Babylon Engine.
  151641. * @returns true if supported otherwise false.
  151642. */
  151643. static IsSupported(engine: Engine): boolean;
  151644. private readonly _options;
  151645. private _canvas;
  151646. private _mediaRecorder;
  151647. private _recordedChunks;
  151648. private _fileName;
  151649. private _resolve;
  151650. private _reject;
  151651. /**
  151652. * True when a recording is already in progress.
  151653. */
  151654. get isRecording(): boolean;
  151655. /**
  151656. * Create a new VideoCapture object which can help converting what you see in Babylon to a video file.
  151657. * @param engine Defines the BabylonJS Engine you wish to record.
  151658. * @param options Defines options that can be used to customize the capture.
  151659. */
  151660. constructor(engine: Engine, options?: Nullable<VideoRecorderOptions>);
  151661. /**
  151662. * Stops the current recording before the default capture timeout passed in the startRecording function.
  151663. */
  151664. stopRecording(): void;
  151665. /**
  151666. * Starts recording the canvas for a max duration specified in parameters.
  151667. * @param fileName Defines the name of the file to be downloaded when the recording stop.
  151668. * If null no automatic download will start and you can rely on the promise to get the data back.
  151669. * @param maxDuration Defines the maximum recording time in seconds.
  151670. * It defaults to 7 seconds. A value of zero will not stop automatically, you would need to call stopRecording manually.
  151671. * @return A promise callback at the end of the recording with the video data in Blob.
  151672. */
  151673. startRecording(fileName?: Nullable<string>, maxDuration?: number): Promise<Blob>;
  151674. /**
  151675. * Releases internal resources used during the recording.
  151676. */
  151677. dispose(): void;
  151678. private _handleDataAvailable;
  151679. private _handleError;
  151680. private _handleStop;
  151681. }
  151682. }
  151683. declare module BABYLON {
  151684. /**
  151685. * Class containing a set of static utilities functions for screenshots
  151686. */
  151687. export class ScreenshotTools {
  151688. /**
  151689. * Captures a screenshot of the current rendering
  151690. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  151691. * @param engine defines the rendering engine
  151692. * @param camera defines the source camera
  151693. * @param size This parameter can be set to a single number or to an object with the
  151694. * following (optional) properties: precision, width, height. If a single number is passed,
  151695. * it will be used for both width and height. If an object is passed, the screenshot size
  151696. * will be derived from the parameters. The precision property is a multiplier allowing
  151697. * rendering at a higher or lower resolution
  151698. * @param successCallback defines the callback receives a single parameter which contains the
  151699. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  151700. * src parameter of an <img> to display it
  151701. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  151702. * Check your browser for supported MIME types
  151703. */
  151704. static CreateScreenshot(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string): void;
  151705. /**
  151706. * Captures a screenshot of the current rendering
  151707. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  151708. * @param engine defines the rendering engine
  151709. * @param camera defines the source camera
  151710. * @param size This parameter can be set to a single number or to an object with the
  151711. * following (optional) properties: precision, width, height. If a single number is passed,
  151712. * it will be used for both width and height. If an object is passed, the screenshot size
  151713. * will be derived from the parameters. The precision property is a multiplier allowing
  151714. * rendering at a higher or lower resolution
  151715. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  151716. * Check your browser for supported MIME types
  151717. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  151718. * to the src parameter of an <img> to display it
  151719. */
  151720. static CreateScreenshotAsync(engine: Engine, camera: Camera, size: any, mimeType?: string): Promise<string>;
  151721. /**
  151722. * Generates an image screenshot from the specified camera.
  151723. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  151724. * @param engine The engine to use for rendering
  151725. * @param camera The camera to use for rendering
  151726. * @param size This parameter can be set to a single number or to an object with the
  151727. * following (optional) properties: precision, width, height. If a single number is passed,
  151728. * it will be used for both width and height. If an object is passed, the screenshot size
  151729. * will be derived from the parameters. The precision property is a multiplier allowing
  151730. * rendering at a higher or lower resolution
  151731. * @param successCallback The callback receives a single parameter which contains the
  151732. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  151733. * src parameter of an <img> to display it
  151734. * @param mimeType The MIME type of the screenshot image (default: image/png).
  151735. * Check your browser for supported MIME types
  151736. * @param samples Texture samples (default: 1)
  151737. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  151738. * @param fileName A name for for the downloaded file.
  151739. * @param renderSprites Whether the sprites should be rendered or not (default: false)
  151740. */
  151741. static CreateScreenshotUsingRenderTarget(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string, renderSprites?: boolean): void;
  151742. /**
  151743. * Generates an image screenshot from the specified camera.
  151744. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  151745. * @param engine The engine to use for rendering
  151746. * @param camera The camera to use for rendering
  151747. * @param size This parameter can be set to a single number or to an object with the
  151748. * following (optional) properties: precision, width, height. If a single number is passed,
  151749. * it will be used for both width and height. If an object is passed, the screenshot size
  151750. * will be derived from the parameters. The precision property is a multiplier allowing
  151751. * rendering at a higher or lower resolution
  151752. * @param mimeType The MIME type of the screenshot image (default: image/png).
  151753. * Check your browser for supported MIME types
  151754. * @param samples Texture samples (default: 1)
  151755. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  151756. * @param fileName A name for for the downloaded file.
  151757. * @param renderSprites Whether the sprites should be rendered or not (default: false)
  151758. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  151759. * to the src parameter of an <img> to display it
  151760. */
  151761. static CreateScreenshotUsingRenderTargetAsync(engine: Engine, camera: Camera, size: any, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string, renderSprites?: boolean): Promise<string>;
  151762. /**
  151763. * Gets height and width for screenshot size
  151764. * @private
  151765. */
  151766. private static _getScreenshotSize;
  151767. }
  151768. }
  151769. declare module BABYLON {
  151770. /**
  151771. * Interface for a data buffer
  151772. */
  151773. export interface IDataBuffer {
  151774. /**
  151775. * Reads bytes from the data buffer.
  151776. * @param byteOffset The byte offset to read
  151777. * @param byteLength The byte length to read
  151778. * @returns A promise that resolves when the bytes are read
  151779. */
  151780. readAsync(byteOffset: number, byteLength: number): Promise<ArrayBufferView>;
  151781. /**
  151782. * The byte length of the buffer.
  151783. */
  151784. readonly byteLength: number;
  151785. }
  151786. /**
  151787. * Utility class for reading from a data buffer
  151788. */
  151789. export class DataReader {
  151790. /**
  151791. * The data buffer associated with this data reader.
  151792. */
  151793. readonly buffer: IDataBuffer;
  151794. /**
  151795. * The current byte offset from the beginning of the data buffer.
  151796. */
  151797. byteOffset: number;
  151798. private _dataView;
  151799. private _dataByteOffset;
  151800. /**
  151801. * Constructor
  151802. * @param buffer The buffer to read
  151803. */
  151804. constructor(buffer: IDataBuffer);
  151805. /**
  151806. * Loads the given byte length.
  151807. * @param byteLength The byte length to load
  151808. * @returns A promise that resolves when the load is complete
  151809. */
  151810. loadAsync(byteLength: number): Promise<void>;
  151811. /**
  151812. * Read a unsigned 32-bit integer from the currently loaded data range.
  151813. * @returns The 32-bit integer read
  151814. */
  151815. readUint32(): number;
  151816. /**
  151817. * Read a byte array from the currently loaded data range.
  151818. * @param byteLength The byte length to read
  151819. * @returns The byte array read
  151820. */
  151821. readUint8Array(byteLength: number): Uint8Array;
  151822. /**
  151823. * Read a string from the currently loaded data range.
  151824. * @param byteLength The byte length to read
  151825. * @returns The string read
  151826. */
  151827. readString(byteLength: number): string;
  151828. /**
  151829. * Skips the given byte length the currently loaded data range.
  151830. * @param byteLength The byte length to skip
  151831. */
  151832. skipBytes(byteLength: number): void;
  151833. }
  151834. }
  151835. declare module BABYLON {
  151836. /**
  151837. * Class for storing data to local storage if available or in-memory storage otherwise
  151838. */
  151839. export class DataStorage {
  151840. private static _Storage;
  151841. private static _GetStorage;
  151842. /**
  151843. * Reads a string from the data storage
  151844. * @param key The key to read
  151845. * @param defaultValue The value if the key doesn't exist
  151846. * @returns The string value
  151847. */
  151848. static ReadString(key: string, defaultValue: string): string;
  151849. /**
  151850. * Writes a string to the data storage
  151851. * @param key The key to write
  151852. * @param value The value to write
  151853. */
  151854. static WriteString(key: string, value: string): void;
  151855. /**
  151856. * Reads a boolean from the data storage
  151857. * @param key The key to read
  151858. * @param defaultValue The value if the key doesn't exist
  151859. * @returns The boolean value
  151860. */
  151861. static ReadBoolean(key: string, defaultValue: boolean): boolean;
  151862. /**
  151863. * Writes a boolean to the data storage
  151864. * @param key The key to write
  151865. * @param value The value to write
  151866. */
  151867. static WriteBoolean(key: string, value: boolean): void;
  151868. /**
  151869. * Reads a number from the data storage
  151870. * @param key The key to read
  151871. * @param defaultValue The value if the key doesn't exist
  151872. * @returns The number value
  151873. */
  151874. static ReadNumber(key: string, defaultValue: number): number;
  151875. /**
  151876. * Writes a number to the data storage
  151877. * @param key The key to write
  151878. * @param value The value to write
  151879. */
  151880. static WriteNumber(key: string, value: number): void;
  151881. }
  151882. }
  151883. declare module BABYLON {
  151884. /**
  151885. * An interface for all Hit test features
  151886. */
  151887. export interface IWebXRHitTestFeature<T extends IWebXRLegacyHitResult> extends IWebXRFeature {
  151888. /**
  151889. * Triggered when new babylon (transformed) hit test results are available
  151890. */
  151891. onHitTestResultObservable: Observable<T[]>;
  151892. }
  151893. /**
  151894. * Options used for hit testing
  151895. */
  151896. export interface IWebXRLegacyHitTestOptions {
  151897. /**
  151898. * Only test when user interacted with the scene. Default - hit test every frame
  151899. */
  151900. testOnPointerDownOnly?: boolean;
  151901. /**
  151902. * The node to use to transform the local results to world coordinates
  151903. */
  151904. worldParentNode?: TransformNode;
  151905. }
  151906. /**
  151907. * Interface defining the babylon result of raycasting/hit-test
  151908. */
  151909. export interface IWebXRLegacyHitResult {
  151910. /**
  151911. * Transformation matrix that can be applied to a node that will put it in the hit point location
  151912. */
  151913. transformationMatrix: Matrix;
  151914. /**
  151915. * The native hit test result
  151916. */
  151917. xrHitResult: XRHitResult | XRHitTestResult;
  151918. }
  151919. /**
  151920. * The currently-working hit-test module.
  151921. * Hit test (or Ray-casting) is used to interact with the real world.
  151922. * For further information read here - https://github.com/immersive-web/hit-test
  151923. */
  151924. export class WebXRHitTestLegacy extends WebXRAbstractFeature implements IWebXRHitTestFeature<IWebXRLegacyHitResult> {
  151925. /**
  151926. * options to use when constructing this feature
  151927. */
  151928. readonly options: IWebXRLegacyHitTestOptions;
  151929. private _direction;
  151930. private _mat;
  151931. private _onSelectEnabled;
  151932. private _origin;
  151933. /**
  151934. * The module's name
  151935. */
  151936. static readonly Name: string;
  151937. /**
  151938. * The (Babylon) version of this module.
  151939. * This is an integer representing the implementation version.
  151940. * This number does not correspond to the WebXR specs version
  151941. */
  151942. static readonly Version: number;
  151943. /**
  151944. * Populated with the last native XR Hit Results
  151945. */
  151946. lastNativeXRHitResults: XRHitResult[];
  151947. /**
  151948. * Triggered when new babylon (transformed) hit test results are available
  151949. */
  151950. onHitTestResultObservable: Observable<IWebXRLegacyHitResult[]>;
  151951. /**
  151952. * Creates a new instance of the (legacy version) hit test feature
  151953. * @param _xrSessionManager an instance of WebXRSessionManager
  151954. * @param options options to use when constructing this feature
  151955. */
  151956. constructor(_xrSessionManager: WebXRSessionManager,
  151957. /**
  151958. * options to use when constructing this feature
  151959. */
  151960. options?: IWebXRLegacyHitTestOptions);
  151961. /**
  151962. * execute a hit test with an XR Ray
  151963. *
  151964. * @param xrSession a native xrSession that will execute this hit test
  151965. * @param xrRay the ray (position and direction) to use for ray-casting
  151966. * @param referenceSpace native XR reference space to use for the hit-test
  151967. * @param filter filter function that will filter the results
  151968. * @returns a promise that resolves with an array of native XR hit result in xr coordinates system
  151969. */
  151970. static XRHitTestWithRay(xrSession: XRSession, xrRay: XRRay, referenceSpace: XRReferenceSpace, filter?: (result: XRHitResult) => boolean): Promise<XRHitResult[]>;
  151971. /**
  151972. * Execute a hit test on the current running session using a select event returned from a transient input (such as touch)
  151973. * @param event the (select) event to use to select with
  151974. * @param referenceSpace the reference space to use for this hit test
  151975. * @returns a promise that resolves with an array of native XR hit result in xr coordinates system
  151976. */
  151977. static XRHitTestWithSelectEvent(event: XRInputSourceEvent, referenceSpace: XRReferenceSpace): Promise<XRHitResult[]>;
  151978. /**
  151979. * attach this feature
  151980. * Will usually be called by the features manager
  151981. *
  151982. * @returns true if successful.
  151983. */
  151984. attach(): boolean;
  151985. /**
  151986. * detach this feature.
  151987. * Will usually be called by the features manager
  151988. *
  151989. * @returns true if successful.
  151990. */
  151991. detach(): boolean;
  151992. /**
  151993. * Dispose this feature and all of the resources attached
  151994. */
  151995. dispose(): void;
  151996. protected _onXRFrame(frame: XRFrame): void;
  151997. private _onHitTestResults;
  151998. private _onSelect;
  151999. }
  152000. }
  152001. declare module BABYLON {
  152002. /**
  152003. * Options used for hit testing (version 2)
  152004. */
  152005. export interface IWebXRHitTestOptions extends IWebXRLegacyHitTestOptions {
  152006. /**
  152007. * Do not create a permanent hit test. Will usually be used when only
  152008. * transient inputs are needed.
  152009. */
  152010. disablePermanentHitTest?: boolean;
  152011. /**
  152012. * Enable transient (for example touch-based) hit test inspections
  152013. */
  152014. enableTransientHitTest?: boolean;
  152015. /**
  152016. * Offset ray for the permanent hit test
  152017. */
  152018. offsetRay?: Vector3;
  152019. /**
  152020. * Offset ray for the transient hit test
  152021. */
  152022. transientOffsetRay?: Vector3;
  152023. /**
  152024. * Instead of using viewer space for hit tests, use the reference space defined in the session manager
  152025. */
  152026. useReferenceSpace?: boolean;
  152027. }
  152028. /**
  152029. * Interface defining the babylon result of hit-test
  152030. */
  152031. export interface IWebXRHitResult extends IWebXRLegacyHitResult {
  152032. /**
  152033. * The input source that generated this hit test (if transient)
  152034. */
  152035. inputSource?: XRInputSource;
  152036. /**
  152037. * Is this a transient hit test
  152038. */
  152039. isTransient?: boolean;
  152040. /**
  152041. * Position of the hit test result
  152042. */
  152043. position: Vector3;
  152044. /**
  152045. * Rotation of the hit test result
  152046. */
  152047. rotationQuaternion: Quaternion;
  152048. /**
  152049. * The native hit test result
  152050. */
  152051. xrHitResult: XRHitTestResult;
  152052. }
  152053. /**
  152054. * The currently-working hit-test module.
  152055. * Hit test (or Ray-casting) is used to interact with the real world.
  152056. * For further information read here - https://github.com/immersive-web/hit-test
  152057. *
  152058. * Tested on chrome (mobile) 80.
  152059. */
  152060. export class WebXRHitTest extends WebXRAbstractFeature implements IWebXRHitTestFeature<IWebXRHitResult> {
  152061. /**
  152062. * options to use when constructing this feature
  152063. */
  152064. readonly options: IWebXRHitTestOptions;
  152065. private _tmpMat;
  152066. private _tmpPos;
  152067. private _tmpQuat;
  152068. private _transientXrHitTestSource;
  152069. private _xrHitTestSource;
  152070. private initHitTestSource;
  152071. /**
  152072. * The module's name
  152073. */
  152074. static readonly Name: string;
  152075. /**
  152076. * The (Babylon) version of this module.
  152077. * This is an integer representing the implementation version.
  152078. * This number does not correspond to the WebXR specs version
  152079. */
  152080. static readonly Version: number;
  152081. /**
  152082. * When set to true, each hit test will have its own position/rotation objects
  152083. * When set to false, position and rotation objects will be reused for each hit test. It is expected that
  152084. * the developers will clone them or copy them as they see fit.
  152085. */
  152086. autoCloneTransformation: boolean;
  152087. /**
  152088. * Triggered when new babylon (transformed) hit test results are available
  152089. */
  152090. onHitTestResultObservable: Observable<IWebXRHitResult[]>;
  152091. /**
  152092. * Use this to temporarily pause hit test checks.
  152093. */
  152094. paused: boolean;
  152095. /**
  152096. * Creates a new instance of the hit test feature
  152097. * @param _xrSessionManager an instance of WebXRSessionManager
  152098. * @param options options to use when constructing this feature
  152099. */
  152100. constructor(_xrSessionManager: WebXRSessionManager,
  152101. /**
  152102. * options to use when constructing this feature
  152103. */
  152104. options?: IWebXRHitTestOptions);
  152105. /**
  152106. * attach this feature
  152107. * Will usually be called by the features manager
  152108. *
  152109. * @returns true if successful.
  152110. */
  152111. attach(): boolean;
  152112. /**
  152113. * detach this feature.
  152114. * Will usually be called by the features manager
  152115. *
  152116. * @returns true if successful.
  152117. */
  152118. detach(): boolean;
  152119. /**
  152120. * Dispose this feature and all of the resources attached
  152121. */
  152122. dispose(): void;
  152123. protected _onXRFrame(frame: XRFrame): void;
  152124. private _processWebXRHitTestResult;
  152125. }
  152126. }
  152127. declare module BABYLON {
  152128. /**
  152129. * Configuration options of the anchor system
  152130. */
  152131. export interface IWebXRAnchorSystemOptions {
  152132. /**
  152133. * a node that will be used to convert local to world coordinates
  152134. */
  152135. worldParentNode?: TransformNode;
  152136. /**
  152137. * If set to true a reference of the created anchors will be kept until the next session starts
  152138. * If not defined, anchors will be removed from the array when the feature is detached or the session ended.
  152139. */
  152140. doNotRemoveAnchorsOnSessionEnded?: boolean;
  152141. }
  152142. /**
  152143. * A babylon container for an XR Anchor
  152144. */
  152145. export interface IWebXRAnchor {
  152146. /**
  152147. * A babylon-assigned ID for this anchor
  152148. */
  152149. id: number;
  152150. /**
  152151. * Transformation matrix to apply to an object attached to this anchor
  152152. */
  152153. transformationMatrix: Matrix;
  152154. /**
  152155. * The native anchor object
  152156. */
  152157. xrAnchor: XRAnchor;
  152158. /**
  152159. * if defined, this object will be constantly updated by the anchor's position and rotation
  152160. */
  152161. attachedNode?: TransformNode;
  152162. }
  152163. /**
  152164. * An implementation of the anchor system for WebXR.
  152165. * For further information see https://github.com/immersive-web/anchors/
  152166. */
  152167. export class WebXRAnchorSystem extends WebXRAbstractFeature {
  152168. private _options;
  152169. private _lastFrameDetected;
  152170. private _trackedAnchors;
  152171. private _referenceSpaceForFrameAnchors;
  152172. private _futureAnchors;
  152173. /**
  152174. * The module's name
  152175. */
  152176. static readonly Name: string;
  152177. /**
  152178. * The (Babylon) version of this module.
  152179. * This is an integer representing the implementation version.
  152180. * This number does not correspond to the WebXR specs version
  152181. */
  152182. static readonly Version: number;
  152183. /**
  152184. * Observers registered here will be executed when a new anchor was added to the session
  152185. */
  152186. onAnchorAddedObservable: Observable<IWebXRAnchor>;
  152187. /**
  152188. * Observers registered here will be executed when an anchor was removed from the session
  152189. */
  152190. onAnchorRemovedObservable: Observable<IWebXRAnchor>;
  152191. /**
  152192. * Observers registered here will be executed when an existing anchor updates
  152193. * This can execute N times every frame
  152194. */
  152195. onAnchorUpdatedObservable: Observable<IWebXRAnchor>;
  152196. /**
  152197. * Set the reference space to use for anchor creation, when not using a hit test.
  152198. * Will default to the session's reference space if not defined
  152199. */
  152200. set referenceSpaceForFrameAnchors(referenceSpace: XRReferenceSpace);
  152201. /**
  152202. * constructs a new anchor system
  152203. * @param _xrSessionManager an instance of WebXRSessionManager
  152204. * @param _options configuration object for this feature
  152205. */
  152206. constructor(_xrSessionManager: WebXRSessionManager, _options?: IWebXRAnchorSystemOptions);
  152207. private _tmpVector;
  152208. private _tmpQuaternion;
  152209. private _populateTmpTransformation;
  152210. /**
  152211. * Create a new anchor point using a hit test result at a specific point in the scene
  152212. * An anchor is tracked only after it is added to the trackerAnchors in xrFrame. The promise returned here does not yet guaranty that.
  152213. * Use onAnchorAddedObservable to get newly added anchors if you require tracking guaranty.
  152214. *
  152215. * @param hitTestResult The hit test result to use for this anchor creation
  152216. * @param position an optional position offset for this anchor
  152217. * @param rotationQuaternion an optional rotation offset for this anchor
  152218. * @returns A promise that fulfills when the XR anchor was registered in the system (but not necessarily added to the tracked anchors)
  152219. */
  152220. addAnchorPointUsingHitTestResultAsync(hitTestResult: IWebXRHitResult, position?: Vector3, rotationQuaternion?: Quaternion): Promise<XRAnchor>;
  152221. /**
  152222. * Add a new anchor at a specific position and rotation
  152223. * This function will add a new anchor per default in the next available frame. Unless forced, the createAnchor function
  152224. * will be called in the next xrFrame loop to make sure that the anchor can be created correctly.
  152225. * An anchor is tracked only after it is added to the trackerAnchors in xrFrame. The promise returned here does not yet guaranty that.
  152226. * Use onAnchorAddedObservable to get newly added anchors if you require tracking guaranty.
  152227. *
  152228. * @param position the position in which to add an anchor
  152229. * @param rotationQuaternion an optional rotation for the anchor transformation
  152230. * @param forceCreateInCurrentFrame force the creation of this anchor in the current frame. Must be called inside xrFrame loop!
  152231. * @returns A promise that fulfills when the XR anchor was registered in the system (but not necessarily added to the tracked anchors)
  152232. */
  152233. addAnchorAtPositionAndRotationAsync(position: Vector3, rotationQuaternion?: Quaternion, forceCreateInCurrentFrame?: boolean): Promise<XRAnchor>;
  152234. /**
  152235. * detach this feature.
  152236. * Will usually be called by the features manager
  152237. *
  152238. * @returns true if successful.
  152239. */
  152240. detach(): boolean;
  152241. /**
  152242. * Dispose this feature and all of the resources attached
  152243. */
  152244. dispose(): void;
  152245. protected _onXRFrame(frame: XRFrame): void;
  152246. /**
  152247. * avoiding using Array.find for global support.
  152248. * @param xrAnchor the plane to find in the array
  152249. */
  152250. private _findIndexInAnchorArray;
  152251. private _updateAnchorWithXRFrame;
  152252. private _createAnchorAtTransformation;
  152253. }
  152254. }
  152255. declare module BABYLON {
  152256. /**
  152257. * Options used in the plane detector module
  152258. */
  152259. export interface IWebXRPlaneDetectorOptions {
  152260. /**
  152261. * The node to use to transform the local results to world coordinates
  152262. */
  152263. worldParentNode?: TransformNode;
  152264. /**
  152265. * If set to true a reference of the created planes will be kept until the next session starts
  152266. * If not defined, planes will be removed from the array when the feature is detached or the session ended.
  152267. */
  152268. doNotRemovePlanesOnSessionEnded?: boolean;
  152269. }
  152270. /**
  152271. * A babylon interface for a WebXR plane.
  152272. * A Plane is actually a polygon, built from N points in space
  152273. *
  152274. * Supported in chrome 79, not supported in canary 81 ATM
  152275. */
  152276. export interface IWebXRPlane {
  152277. /**
  152278. * a babylon-assigned ID for this polygon
  152279. */
  152280. id: number;
  152281. /**
  152282. * an array of vector3 points in babylon space. right/left hand system is taken into account.
  152283. */
  152284. polygonDefinition: Array<Vector3>;
  152285. /**
  152286. * A transformation matrix to apply on the mesh that will be built using the polygonDefinition
  152287. * Local vs. World are decided if worldParentNode was provided or not in the options when constructing the module
  152288. */
  152289. transformationMatrix: Matrix;
  152290. /**
  152291. * the native xr-plane object
  152292. */
  152293. xrPlane: XRPlane;
  152294. }
  152295. /**
  152296. * The plane detector is used to detect planes in the real world when in AR
  152297. * For more information see https://github.com/immersive-web/real-world-geometry/
  152298. */
  152299. export class WebXRPlaneDetector extends WebXRAbstractFeature {
  152300. private _options;
  152301. private _detectedPlanes;
  152302. private _enabled;
  152303. private _lastFrameDetected;
  152304. /**
  152305. * The module's name
  152306. */
  152307. static readonly Name: string;
  152308. /**
  152309. * The (Babylon) version of this module.
  152310. * This is an integer representing the implementation version.
  152311. * This number does not correspond to the WebXR specs version
  152312. */
  152313. static readonly Version: number;
  152314. /**
  152315. * Observers registered here will be executed when a new plane was added to the session
  152316. */
  152317. onPlaneAddedObservable: Observable<IWebXRPlane>;
  152318. /**
  152319. * Observers registered here will be executed when a plane is no longer detected in the session
  152320. */
  152321. onPlaneRemovedObservable: Observable<IWebXRPlane>;
  152322. /**
  152323. * Observers registered here will be executed when an existing plane updates (for example - expanded)
  152324. * This can execute N times every frame
  152325. */
  152326. onPlaneUpdatedObservable: Observable<IWebXRPlane>;
  152327. /**
  152328. * construct a new Plane Detector
  152329. * @param _xrSessionManager an instance of xr Session manager
  152330. * @param _options configuration to use when constructing this feature
  152331. */
  152332. constructor(_xrSessionManager: WebXRSessionManager, _options?: IWebXRPlaneDetectorOptions);
  152333. /**
  152334. * detach this feature.
  152335. * Will usually be called by the features manager
  152336. *
  152337. * @returns true if successful.
  152338. */
  152339. detach(): boolean;
  152340. /**
  152341. * Dispose this feature and all of the resources attached
  152342. */
  152343. dispose(): void;
  152344. protected _onXRFrame(frame: XRFrame): void;
  152345. private _init;
  152346. private _updatePlaneWithXRPlane;
  152347. /**
  152348. * avoiding using Array.find for global support.
  152349. * @param xrPlane the plane to find in the array
  152350. */
  152351. private findIndexInPlaneArray;
  152352. }
  152353. }
  152354. declare module BABYLON {
  152355. /**
  152356. * Options interface for the background remover plugin
  152357. */
  152358. export interface IWebXRBackgroundRemoverOptions {
  152359. /**
  152360. * Further background meshes to disable when entering AR
  152361. */
  152362. backgroundMeshes?: AbstractMesh[];
  152363. /**
  152364. * flags to configure the removal of the environment helper.
  152365. * If not set, the entire background will be removed. If set, flags should be set as well.
  152366. */
  152367. environmentHelperRemovalFlags?: {
  152368. /**
  152369. * Should the skybox be removed (default false)
  152370. */
  152371. skyBox?: boolean;
  152372. /**
  152373. * Should the ground be removed (default false)
  152374. */
  152375. ground?: boolean;
  152376. };
  152377. /**
  152378. * don't disable the environment helper
  152379. */
  152380. ignoreEnvironmentHelper?: boolean;
  152381. }
  152382. /**
  152383. * A module that will automatically disable background meshes when entering AR and will enable them when leaving AR.
  152384. */
  152385. export class WebXRBackgroundRemover extends WebXRAbstractFeature {
  152386. /**
  152387. * read-only options to be used in this module
  152388. */
  152389. readonly options: IWebXRBackgroundRemoverOptions;
  152390. /**
  152391. * The module's name
  152392. */
  152393. static readonly Name: string;
  152394. /**
  152395. * The (Babylon) version of this module.
  152396. * This is an integer representing the implementation version.
  152397. * This number does not correspond to the WebXR specs version
  152398. */
  152399. static readonly Version: number;
  152400. /**
  152401. * registered observers will be triggered when the background state changes
  152402. */
  152403. onBackgroundStateChangedObservable: Observable<boolean>;
  152404. /**
  152405. * constructs a new background remover module
  152406. * @param _xrSessionManager the session manager for this module
  152407. * @param options read-only options to be used in this module
  152408. */
  152409. constructor(_xrSessionManager: WebXRSessionManager,
  152410. /**
  152411. * read-only options to be used in this module
  152412. */
  152413. options?: IWebXRBackgroundRemoverOptions);
  152414. /**
  152415. * attach this feature
  152416. * Will usually be called by the features manager
  152417. *
  152418. * @returns true if successful.
  152419. */
  152420. attach(): boolean;
  152421. /**
  152422. * detach this feature.
  152423. * Will usually be called by the features manager
  152424. *
  152425. * @returns true if successful.
  152426. */
  152427. detach(): boolean;
  152428. /**
  152429. * Dispose this feature and all of the resources attached
  152430. */
  152431. dispose(): void;
  152432. protected _onXRFrame(_xrFrame: XRFrame): void;
  152433. private _setBackgroundState;
  152434. }
  152435. }
  152436. declare module BABYLON {
  152437. /**
  152438. * Options for the controller physics feature
  152439. */
  152440. export class IWebXRControllerPhysicsOptions {
  152441. /**
  152442. * Should the headset get its own impostor
  152443. */
  152444. enableHeadsetImpostor?: boolean;
  152445. /**
  152446. * Optional parameters for the headset impostor
  152447. */
  152448. headsetImpostorParams?: {
  152449. /**
  152450. * The type of impostor to create. Default is sphere
  152451. */
  152452. impostorType: number;
  152453. /**
  152454. * the size of the impostor. Defaults to 10cm
  152455. */
  152456. impostorSize?: number | {
  152457. width: number;
  152458. height: number;
  152459. depth: number;
  152460. };
  152461. /**
  152462. * Friction definitions
  152463. */
  152464. friction?: number;
  152465. /**
  152466. * Restitution
  152467. */
  152468. restitution?: number;
  152469. };
  152470. /**
  152471. * The physics properties of the future impostors
  152472. */
  152473. physicsProperties?: {
  152474. /**
  152475. * If set to true, a mesh impostor will be created when the controller mesh was loaded
  152476. * Note that this requires a physics engine that supports mesh impostors!
  152477. */
  152478. useControllerMesh?: boolean;
  152479. /**
  152480. * The type of impostor to create. Default is sphere
  152481. */
  152482. impostorType?: number;
  152483. /**
  152484. * the size of the impostor. Defaults to 10cm
  152485. */
  152486. impostorSize?: number | {
  152487. width: number;
  152488. height: number;
  152489. depth: number;
  152490. };
  152491. /**
  152492. * Friction definitions
  152493. */
  152494. friction?: number;
  152495. /**
  152496. * Restitution
  152497. */
  152498. restitution?: number;
  152499. };
  152500. /**
  152501. * the xr input to use with this pointer selection
  152502. */
  152503. xrInput: WebXRInput;
  152504. }
  152505. /**
  152506. * Add physics impostor to your webxr controllers,
  152507. * including naive calculation of their linear and angular velocity
  152508. */
  152509. export class WebXRControllerPhysics extends WebXRAbstractFeature {
  152510. private readonly _options;
  152511. private _attachController;
  152512. private _controllers;
  152513. private _debugMode;
  152514. private _delta;
  152515. private _headsetImpostor?;
  152516. private _headsetMesh?;
  152517. private _lastTimestamp;
  152518. private _tmpQuaternion;
  152519. private _tmpVector;
  152520. /**
  152521. * The module's name
  152522. */
  152523. static readonly Name: string;
  152524. /**
  152525. * The (Babylon) version of this module.
  152526. * This is an integer representing the implementation version.
  152527. * This number does not correspond to the webxr specs version
  152528. */
  152529. static readonly Version: number;
  152530. /**
  152531. * Construct a new Controller Physics Feature
  152532. * @param _xrSessionManager the corresponding xr session manager
  152533. * @param _options options to create this feature with
  152534. */
  152535. constructor(_xrSessionManager: WebXRSessionManager, _options: IWebXRControllerPhysicsOptions);
  152536. /**
  152537. * @hidden
  152538. * enable debugging - will show console outputs and the impostor mesh
  152539. */
  152540. _enablePhysicsDebug(): void;
  152541. /**
  152542. * Manually add a controller (if no xrInput was provided or physics engine was not enabled)
  152543. * @param xrController the controller to add
  152544. */
  152545. addController(xrController: WebXRInputSource): void;
  152546. /**
  152547. * attach this feature
  152548. * Will usually be called by the features manager
  152549. *
  152550. * @returns true if successful.
  152551. */
  152552. attach(): boolean;
  152553. /**
  152554. * detach this feature.
  152555. * Will usually be called by the features manager
  152556. *
  152557. * @returns true if successful.
  152558. */
  152559. detach(): boolean;
  152560. /**
  152561. * Get the headset impostor, if enabled
  152562. * @returns the impostor
  152563. */
  152564. getHeadsetImpostor(): PhysicsImpostor | undefined;
  152565. /**
  152566. * Get the physics impostor of a specific controller.
  152567. * The impostor is not attached to a mesh because a mesh for each controller is not obligatory
  152568. * @param controller the controller or the controller id of which to get the impostor
  152569. * @returns the impostor or null
  152570. */
  152571. getImpostorForController(controller: WebXRInputSource | string): Nullable<PhysicsImpostor>;
  152572. /**
  152573. * Update the physics properties provided in the constructor
  152574. * @param newProperties the new properties object
  152575. */
  152576. setPhysicsProperties(newProperties: {
  152577. impostorType?: number;
  152578. impostorSize?: number | {
  152579. width: number;
  152580. height: number;
  152581. depth: number;
  152582. };
  152583. friction?: number;
  152584. restitution?: number;
  152585. }): void;
  152586. protected _onXRFrame(_xrFrame: any): void;
  152587. private _detachController;
  152588. }
  152589. }
  152590. declare module BABYLON {
  152591. /**
  152592. * The motion controller class for all microsoft mixed reality controllers
  152593. */
  152594. export class WebXRMicrosoftMixedRealityController extends WebXRAbstractMotionController {
  152595. protected readonly _mapping: {
  152596. defaultButton: {
  152597. valueNodeName: string;
  152598. unpressedNodeName: string;
  152599. pressedNodeName: string;
  152600. };
  152601. defaultAxis: {
  152602. valueNodeName: string;
  152603. minNodeName: string;
  152604. maxNodeName: string;
  152605. };
  152606. buttons: {
  152607. "xr-standard-trigger": {
  152608. rootNodeName: string;
  152609. componentProperty: string;
  152610. states: string[];
  152611. };
  152612. "xr-standard-squeeze": {
  152613. rootNodeName: string;
  152614. componentProperty: string;
  152615. states: string[];
  152616. };
  152617. "xr-standard-touchpad": {
  152618. rootNodeName: string;
  152619. labelAnchorNodeName: string;
  152620. touchPointNodeName: string;
  152621. };
  152622. "xr-standard-thumbstick": {
  152623. rootNodeName: string;
  152624. componentProperty: string;
  152625. states: string[];
  152626. };
  152627. };
  152628. axes: {
  152629. "xr-standard-touchpad": {
  152630. "x-axis": {
  152631. rootNodeName: string;
  152632. };
  152633. "y-axis": {
  152634. rootNodeName: string;
  152635. };
  152636. };
  152637. "xr-standard-thumbstick": {
  152638. "x-axis": {
  152639. rootNodeName: string;
  152640. };
  152641. "y-axis": {
  152642. rootNodeName: string;
  152643. };
  152644. };
  152645. };
  152646. };
  152647. /**
  152648. * The base url used to load the left and right controller models
  152649. */
  152650. static MODEL_BASE_URL: string;
  152651. /**
  152652. * The name of the left controller model file
  152653. */
  152654. static MODEL_LEFT_FILENAME: string;
  152655. /**
  152656. * The name of the right controller model file
  152657. */
  152658. static MODEL_RIGHT_FILENAME: string;
  152659. profileId: string;
  152660. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness);
  152661. protected _getFilenameAndPath(): {
  152662. filename: string;
  152663. path: string;
  152664. };
  152665. protected _getModelLoadingConstraints(): boolean;
  152666. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  152667. protected _setRootMesh(meshes: AbstractMesh[]): void;
  152668. protected _updateModel(): void;
  152669. }
  152670. }
  152671. declare module BABYLON {
  152672. /**
  152673. * The motion controller class for oculus touch (quest, rift).
  152674. * This class supports legacy mapping as well the standard xr mapping
  152675. */
  152676. export class WebXROculusTouchMotionController extends WebXRAbstractMotionController {
  152677. private _forceLegacyControllers;
  152678. private _modelRootNode;
  152679. /**
  152680. * The base url used to load the left and right controller models
  152681. */
  152682. static MODEL_BASE_URL: string;
  152683. /**
  152684. * The name of the left controller model file
  152685. */
  152686. static MODEL_LEFT_FILENAME: string;
  152687. /**
  152688. * The name of the right controller model file
  152689. */
  152690. static MODEL_RIGHT_FILENAME: string;
  152691. /**
  152692. * Base Url for the Quest controller model.
  152693. */
  152694. static QUEST_MODEL_BASE_URL: string;
  152695. profileId: string;
  152696. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness, legacyMapping?: boolean, _forceLegacyControllers?: boolean);
  152697. protected _getFilenameAndPath(): {
  152698. filename: string;
  152699. path: string;
  152700. };
  152701. protected _getModelLoadingConstraints(): boolean;
  152702. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  152703. protected _setRootMesh(meshes: AbstractMesh[]): void;
  152704. protected _updateModel(): void;
  152705. /**
  152706. * Is this the new type of oculus touch. At the moment both have the same profile and it is impossible to differentiate
  152707. * between the touch and touch 2.
  152708. */
  152709. private _isQuest;
  152710. }
  152711. }
  152712. declare module BABYLON {
  152713. /**
  152714. * The motion controller class for the standard HTC-Vive controllers
  152715. */
  152716. export class WebXRHTCViveMotionController extends WebXRAbstractMotionController {
  152717. private _modelRootNode;
  152718. /**
  152719. * The base url used to load the left and right controller models
  152720. */
  152721. static MODEL_BASE_URL: string;
  152722. /**
  152723. * File name for the controller model.
  152724. */
  152725. static MODEL_FILENAME: string;
  152726. profileId: string;
  152727. /**
  152728. * Create a new Vive motion controller object
  152729. * @param scene the scene to use to create this controller
  152730. * @param gamepadObject the corresponding gamepad object
  152731. * @param handedness the handedness of the controller
  152732. */
  152733. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness);
  152734. protected _getFilenameAndPath(): {
  152735. filename: string;
  152736. path: string;
  152737. };
  152738. protected _getModelLoadingConstraints(): boolean;
  152739. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  152740. protected _setRootMesh(meshes: AbstractMesh[]): void;
  152741. protected _updateModel(): void;
  152742. }
  152743. }
  152744. declare module BABYLON {
  152745. /**
  152746. * A cursor which tracks a point on a path
  152747. */
  152748. export class PathCursor {
  152749. private path;
  152750. /**
  152751. * Stores path cursor callbacks for when an onchange event is triggered
  152752. */
  152753. private _onchange;
  152754. /**
  152755. * The value of the path cursor
  152756. */
  152757. value: number;
  152758. /**
  152759. * The animation array of the path cursor
  152760. */
  152761. animations: Animation[];
  152762. /**
  152763. * Initializes the path cursor
  152764. * @param path The path to track
  152765. */
  152766. constructor(path: Path2);
  152767. /**
  152768. * Gets the cursor point on the path
  152769. * @returns A point on the path cursor at the cursor location
  152770. */
  152771. getPoint(): Vector3;
  152772. /**
  152773. * Moves the cursor ahead by the step amount
  152774. * @param step The amount to move the cursor forward
  152775. * @returns This path cursor
  152776. */
  152777. moveAhead(step?: number): PathCursor;
  152778. /**
  152779. * Moves the cursor behind by the step amount
  152780. * @param step The amount to move the cursor back
  152781. * @returns This path cursor
  152782. */
  152783. moveBack(step?: number): PathCursor;
  152784. /**
  152785. * Moves the cursor by the step amount
  152786. * If the step amount is greater than one, an exception is thrown
  152787. * @param step The amount to move the cursor
  152788. * @returns This path cursor
  152789. */
  152790. move(step: number): PathCursor;
  152791. /**
  152792. * Ensures that the value is limited between zero and one
  152793. * @returns This path cursor
  152794. */
  152795. private ensureLimits;
  152796. /**
  152797. * Runs onchange callbacks on change (used by the animation engine)
  152798. * @returns This path cursor
  152799. */
  152800. private raiseOnChange;
  152801. /**
  152802. * Executes a function on change
  152803. * @param f A path cursor onchange callback
  152804. * @returns This path cursor
  152805. */
  152806. onchange(f: (cursor: PathCursor) => void): PathCursor;
  152807. }
  152808. }
  152809. declare module BABYLON {
  152810. /** @hidden */
  152811. export var blurPixelShader: {
  152812. name: string;
  152813. shader: string;
  152814. };
  152815. }
  152816. declare module BABYLON {
  152817. /** @hidden */
  152818. export var pointCloudVertexDeclaration: {
  152819. name: string;
  152820. shader: string;
  152821. };
  152822. }
  152823. // Mixins
  152824. interface Window {
  152825. mozIndexedDB: IDBFactory;
  152826. webkitIndexedDB: IDBFactory;
  152827. msIndexedDB: IDBFactory;
  152828. webkitURL: typeof URL;
  152829. mozRequestAnimationFrame(callback: FrameRequestCallback): number;
  152830. oRequestAnimationFrame(callback: FrameRequestCallback): number;
  152831. WebGLRenderingContext: WebGLRenderingContext;
  152832. MSGesture: MSGesture;
  152833. CANNON: any;
  152834. AudioContext: AudioContext;
  152835. webkitAudioContext: AudioContext;
  152836. PointerEvent: any;
  152837. Math: Math;
  152838. Uint8Array: Uint8ArrayConstructor;
  152839. Float32Array: Float32ArrayConstructor;
  152840. mozURL: typeof URL;
  152841. msURL: typeof URL;
  152842. VRFrameData: any; // WebVR, from specs 1.1
  152843. DracoDecoderModule: any;
  152844. setImmediate(handler: (...args: any[]) => void): number;
  152845. }
  152846. interface HTMLCanvasElement {
  152847. requestPointerLock(): void;
  152848. msRequestPointerLock?(): void;
  152849. mozRequestPointerLock?(): void;
  152850. webkitRequestPointerLock?(): void;
  152851. /** Track wether a record is in progress */
  152852. isRecording: boolean;
  152853. /** Capture Stream method defined by some browsers */
  152854. captureStream(fps?: number): MediaStream;
  152855. }
  152856. interface CanvasRenderingContext2D {
  152857. msImageSmoothingEnabled: boolean;
  152858. }
  152859. interface MouseEvent {
  152860. mozMovementX: number;
  152861. mozMovementY: number;
  152862. webkitMovementX: number;
  152863. webkitMovementY: number;
  152864. msMovementX: number;
  152865. msMovementY: number;
  152866. }
  152867. interface Navigator {
  152868. mozGetVRDevices: (any: any) => any;
  152869. webkitGetUserMedia(constraints: MediaStreamConstraints, successCallback: NavigatorUserMediaSuccessCallback, errorCallback: NavigatorUserMediaErrorCallback): void;
  152870. mozGetUserMedia(constraints: MediaStreamConstraints, successCallback: NavigatorUserMediaSuccessCallback, errorCallback: NavigatorUserMediaErrorCallback): void;
  152871. msGetUserMedia(constraints: MediaStreamConstraints, successCallback: NavigatorUserMediaSuccessCallback, errorCallback: NavigatorUserMediaErrorCallback): void;
  152872. webkitGetGamepads(): Gamepad[];
  152873. msGetGamepads(): Gamepad[];
  152874. webkitGamepads(): Gamepad[];
  152875. }
  152876. interface HTMLVideoElement {
  152877. mozSrcObject: any;
  152878. }
  152879. interface Math {
  152880. fround(x: number): number;
  152881. imul(a: number, b: number): number;
  152882. }
  152883. interface WebGLRenderingContext {
  152884. drawArraysInstanced(mode: number, first: number, count: number, primcount: number): void;
  152885. drawElementsInstanced(mode: number, count: number, type: number, offset: number, primcount: number): void;
  152886. vertexAttribDivisor(index: number, divisor: number): void;
  152887. createVertexArray(): any;
  152888. bindVertexArray(vao?: WebGLVertexArrayObject | null): void;
  152889. deleteVertexArray(vao: WebGLVertexArrayObject): void;
  152890. blitFramebuffer(srcX0: number, srcY0: number, srcX1: number, srcY1: number, dstX0: number, dstY0: number, dstX1: number, dstY1: number, mask: number, filter: number): void;
  152891. renderbufferStorageMultisample?(target: number, samples: number, internalformat: number, width: number, height: number): void;
  152892. bindBufferBase(target: number, index: number, buffer: WebGLBuffer | null): void;
  152893. getUniformBlockIndex(program: WebGLProgram, uniformBlockName: string): number;
  152894. uniformBlockBinding(program: WebGLProgram, uniformBlockIndex: number, uniformBlockBinding: number): void;
  152895. // Queries
  152896. createQuery(): WebGLQuery;
  152897. deleteQuery(query: WebGLQuery): void;
  152898. beginQuery(target: number, query: WebGLQuery): void;
  152899. endQuery(target: number): void;
  152900. getQueryParameter(query: WebGLQuery, pname: number): any;
  152901. getQuery(target: number, pname: number): any;
  152902. MAX_SAMPLES: number;
  152903. RGBA8: number;
  152904. READ_FRAMEBUFFER: number;
  152905. DRAW_FRAMEBUFFER: number;
  152906. UNIFORM_BUFFER: number;
  152907. HALF_FLOAT_OES: number;
  152908. RGBA16F: number;
  152909. RGBA32F: number;
  152910. R32F: number;
  152911. RG32F: number;
  152912. RGB32F: number;
  152913. R16F: number;
  152914. RG16F: number;
  152915. RGB16F: number;
  152916. RED: number;
  152917. RG: number;
  152918. R8: number;
  152919. RG8: number;
  152920. UNSIGNED_INT_24_8: number;
  152921. DEPTH24_STENCIL8: number;
  152922. MIN: number;
  152923. MAX: number;
  152924. /* Multiple Render Targets */
  152925. drawBuffers(buffers: number[]): void;
  152926. readBuffer(src: number): void;
  152927. readonly COLOR_ATTACHMENT0: number; // 0x8CE1
  152928. readonly COLOR_ATTACHMENT1: number; // 0x8CE2
  152929. readonly COLOR_ATTACHMENT2: number; // 0x8CE3
  152930. readonly COLOR_ATTACHMENT3: number; // 0x8CE4
  152931. // Occlusion Query
  152932. ANY_SAMPLES_PASSED_CONSERVATIVE: number;
  152933. ANY_SAMPLES_PASSED: number;
  152934. QUERY_RESULT_AVAILABLE: number;
  152935. QUERY_RESULT: number;
  152936. }
  152937. interface WebGLProgram {
  152938. __SPECTOR_rebuildProgram?: ((vertexSourceCode: string, fragmentSourceCode: string, onCompiled: (program: WebGLProgram) => void, onError: (message: string) => void) => void) | null;
  152939. }
  152940. interface EXT_disjoint_timer_query {
  152941. QUERY_COUNTER_BITS_EXT: number;
  152942. TIME_ELAPSED_EXT: number;
  152943. TIMESTAMP_EXT: number;
  152944. GPU_DISJOINT_EXT: number;
  152945. QUERY_RESULT_EXT: number;
  152946. QUERY_RESULT_AVAILABLE_EXT: number;
  152947. queryCounterEXT(query: WebGLQuery, target: number): void;
  152948. createQueryEXT(): WebGLQuery;
  152949. beginQueryEXT(target: number, query: WebGLQuery): void;
  152950. endQueryEXT(target: number): void;
  152951. getQueryObjectEXT(query: WebGLQuery, target: number): any;
  152952. deleteQueryEXT(query: WebGLQuery): void;
  152953. }
  152954. interface WebGLUniformLocation {
  152955. _currentState: any;
  152956. }
  152957. // Type definitions for WebGL 2, Editor's Draft Fri Feb 24 16:10:18 2017 -0800
  152958. // Project: https://www.khronos.org/registry/webgl/specs/latest/2.0/
  152959. // Definitions by: Nico Kemnitz <https://github.com/nkemnitz/>
  152960. // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
  152961. interface WebGLRenderingContext {
  152962. readonly RASTERIZER_DISCARD: number;
  152963. readonly DEPTH_COMPONENT24: number;
  152964. readonly TEXTURE_3D: number;
  152965. readonly TEXTURE_2D_ARRAY: number;
  152966. readonly TEXTURE_COMPARE_FUNC: number;
  152967. readonly TEXTURE_COMPARE_MODE: number;
  152968. readonly COMPARE_REF_TO_TEXTURE: number;
  152969. readonly TEXTURE_WRAP_R: number;
  152970. readonly HALF_FLOAT: number;
  152971. readonly RGB8: number;
  152972. readonly RED_INTEGER: number;
  152973. readonly RG_INTEGER: number;
  152974. readonly RGB_INTEGER: number;
  152975. readonly RGBA_INTEGER: number;
  152976. readonly R8_SNORM: number;
  152977. readonly RG8_SNORM: number;
  152978. readonly RGB8_SNORM: number;
  152979. readonly RGBA8_SNORM: number;
  152980. readonly R8I: number;
  152981. readonly RG8I: number;
  152982. readonly RGB8I: number;
  152983. readonly RGBA8I: number;
  152984. readonly R8UI: number;
  152985. readonly RG8UI: number;
  152986. readonly RGB8UI: number;
  152987. readonly RGBA8UI: number;
  152988. readonly R16I: number;
  152989. readonly RG16I: number;
  152990. readonly RGB16I: number;
  152991. readonly RGBA16I: number;
  152992. readonly R16UI: number;
  152993. readonly RG16UI: number;
  152994. readonly RGB16UI: number;
  152995. readonly RGBA16UI: number;
  152996. readonly R32I: number;
  152997. readonly RG32I: number;
  152998. readonly RGB32I: number;
  152999. readonly RGBA32I: number;
  153000. readonly R32UI: number;
  153001. readonly RG32UI: number;
  153002. readonly RGB32UI: number;
  153003. readonly RGBA32UI: number;
  153004. readonly RGB10_A2UI: number;
  153005. readonly R11F_G11F_B10F: number;
  153006. readonly RGB9_E5: number;
  153007. readonly RGB10_A2: number;
  153008. readonly UNSIGNED_INT_2_10_10_10_REV: number;
  153009. readonly UNSIGNED_INT_10F_11F_11F_REV: number;
  153010. readonly UNSIGNED_INT_5_9_9_9_REV: number;
  153011. readonly FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  153012. readonly DEPTH_COMPONENT32F: number;
  153013. texImage3D(target: number, level: number, internalformat: number, width: number, height: number, depth: number, border: number, format: number, type: number, pixels: ArrayBufferView | null): void;
  153014. texImage3D(target: number, level: number, internalformat: number, width: number, height: number, depth: number, border: number, format: number, type: number, pixels: ArrayBufferView, offset: number): void;
  153015. 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;
  153016. framebufferTextureLayer(target: number, attachment: number, texture: WebGLTexture | null, level: number, layer: number): void;
  153017. compressedTexImage3D(target: number, level: number, internalformat: number, width: number, height: number, depth: number, border: number, data: ArrayBufferView, offset?: number, length?: number): void;
  153018. readonly TRANSFORM_FEEDBACK: number;
  153019. readonly INTERLEAVED_ATTRIBS: number;
  153020. readonly TRANSFORM_FEEDBACK_BUFFER: number;
  153021. createTransformFeedback(): WebGLTransformFeedback;
  153022. deleteTransformFeedback(transformFeedbac: WebGLTransformFeedback): void;
  153023. bindTransformFeedback(target: number, transformFeedback: WebGLTransformFeedback | null): void;
  153024. beginTransformFeedback(primitiveMode: number): void;
  153025. endTransformFeedback(): void;
  153026. transformFeedbackVaryings(program: WebGLProgram, varyings: string[], bufferMode: number): void;
  153027. clearBufferfv(buffer: number, drawbuffer: number, values: ArrayBufferView, srcOffset: number | null): void;
  153028. clearBufferiv(buffer: number, drawbuffer: number, values: ArrayBufferView, srcOffset: number | null): void;
  153029. clearBufferuiv(buffer: number, drawbuffer: number, values: ArrayBufferView, srcOffset: number | null): void;
  153030. clearBufferfi(buffer: number, drawbuffer: number, depth: number, stencil: number): void;
  153031. }
  153032. interface ImageBitmap {
  153033. readonly width: number;
  153034. readonly height: number;
  153035. close(): void;
  153036. }
  153037. interface WebGLQuery extends WebGLObject {
  153038. }
  153039. declare var WebGLQuery: {
  153040. prototype: WebGLQuery;
  153041. new(): WebGLQuery;
  153042. };
  153043. interface WebGLSampler extends WebGLObject {
  153044. }
  153045. declare var WebGLSampler: {
  153046. prototype: WebGLSampler;
  153047. new(): WebGLSampler;
  153048. };
  153049. interface WebGLSync extends WebGLObject {
  153050. }
  153051. declare var WebGLSync: {
  153052. prototype: WebGLSync;
  153053. new(): WebGLSync;
  153054. };
  153055. interface WebGLTransformFeedback extends WebGLObject {
  153056. }
  153057. declare var WebGLTransformFeedback: {
  153058. prototype: WebGLTransformFeedback;
  153059. new(): WebGLTransformFeedback;
  153060. };
  153061. interface WebGLVertexArrayObject extends WebGLObject {
  153062. }
  153063. declare var WebGLVertexArrayObject: {
  153064. prototype: WebGLVertexArrayObject;
  153065. new(): WebGLVertexArrayObject;
  153066. };
  153067. // Type definitions for WebVR API
  153068. // Project: https://w3c.github.io/webvr/
  153069. // Definitions by: six a <https://github.com/lostfictions>
  153070. // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
  153071. interface VRDisplay extends EventTarget {
  153072. /**
  153073. * Dictionary of capabilities describing the VRDisplay.
  153074. */
  153075. readonly capabilities: VRDisplayCapabilities;
  153076. /**
  153077. * z-depth defining the far plane of the eye view frustum
  153078. * enables mapping of values in the render target depth
  153079. * attachment to scene coordinates. Initially set to 10000.0.
  153080. */
  153081. depthFar: number;
  153082. /**
  153083. * z-depth defining the near plane of the eye view frustum
  153084. * enables mapping of values in the render target depth
  153085. * attachment to scene coordinates. Initially set to 0.01.
  153086. */
  153087. depthNear: number;
  153088. /**
  153089. * An identifier for this distinct VRDisplay. Used as an
  153090. * association point in the Gamepad API.
  153091. */
  153092. readonly displayId: number;
  153093. /**
  153094. * A display name, a user-readable name identifying it.
  153095. */
  153096. readonly displayName: string;
  153097. readonly isConnected: boolean;
  153098. readonly isPresenting: boolean;
  153099. /**
  153100. * If this VRDisplay supports room-scale experiences, the optional
  153101. * stage attribute contains details on the room-scale parameters.
  153102. */
  153103. readonly stageParameters: VRStageParameters | null;
  153104. /**
  153105. * Passing the value returned by `requestAnimationFrame` to
  153106. * `cancelAnimationFrame` will unregister the callback.
  153107. * @param handle Define the hanle of the request to cancel
  153108. */
  153109. cancelAnimationFrame(handle: number): void;
  153110. /**
  153111. * Stops presenting to the VRDisplay.
  153112. * @returns a promise to know when it stopped
  153113. */
  153114. exitPresent(): Promise<void>;
  153115. /**
  153116. * Return the current VREyeParameters for the given eye.
  153117. * @param whichEye Define the eye we want the parameter for
  153118. * @returns the eye parameters
  153119. */
  153120. getEyeParameters(whichEye: string): VREyeParameters;
  153121. /**
  153122. * Populates the passed VRFrameData with the information required to render
  153123. * the current frame.
  153124. * @param frameData Define the data structure to populate
  153125. * @returns true if ok otherwise false
  153126. */
  153127. getFrameData(frameData: VRFrameData): boolean;
  153128. /**
  153129. * Get the layers currently being presented.
  153130. * @returns the list of VR layers
  153131. */
  153132. getLayers(): VRLayer[];
  153133. /**
  153134. * Return a VRPose containing the future predicted pose of the VRDisplay
  153135. * when the current frame will be presented. The value returned will not
  153136. * change until JavaScript has returned control to the browser.
  153137. *
  153138. * The VRPose will contain the position, orientation, velocity,
  153139. * and acceleration of each of these properties.
  153140. * @returns the pose object
  153141. */
  153142. getPose(): VRPose;
  153143. /**
  153144. * Return the current instantaneous pose of the VRDisplay, with no
  153145. * prediction applied.
  153146. * @returns the current instantaneous pose
  153147. */
  153148. getImmediatePose(): VRPose;
  153149. /**
  153150. * The callback passed to `requestAnimationFrame` will be called
  153151. * any time a new frame should be rendered. When the VRDisplay is
  153152. * presenting the callback will be called at the native refresh
  153153. * rate of the HMD. When not presenting this function acts
  153154. * identically to how window.requestAnimationFrame acts. Content should
  153155. * make no assumptions of frame rate or vsync behavior as the HMD runs
  153156. * asynchronously from other displays and at differing refresh rates.
  153157. * @param callback Define the eaction to run next frame
  153158. * @returns the request handle it
  153159. */
  153160. requestAnimationFrame(callback: FrameRequestCallback): number;
  153161. /**
  153162. * Begin presenting to the VRDisplay. Must be called in response to a user gesture.
  153163. * Repeat calls while already presenting will update the VRLayers being displayed.
  153164. * @param layers Define the list of layer to present
  153165. * @returns a promise to know when the request has been fulfilled
  153166. */
  153167. requestPresent(layers: VRLayer[]): Promise<void>;
  153168. /**
  153169. * Reset the pose for this display, treating its current position and
  153170. * orientation as the "origin/zero" values. VRPose.position,
  153171. * VRPose.orientation, and VRStageParameters.sittingToStandingTransform may be
  153172. * updated when calling resetPose(). This should be called in only
  153173. * sitting-space experiences.
  153174. */
  153175. resetPose(): void;
  153176. /**
  153177. * The VRLayer provided to the VRDisplay will be captured and presented
  153178. * in the HMD. Calling this function has the same effect on the source
  153179. * canvas as any other operation that uses its source image, and canvases
  153180. * created without preserveDrawingBuffer set to true will be cleared.
  153181. * @param pose Define the pose to submit
  153182. */
  153183. submitFrame(pose?: VRPose): void;
  153184. }
  153185. declare var VRDisplay: {
  153186. prototype: VRDisplay;
  153187. new(): VRDisplay;
  153188. };
  153189. interface VRLayer {
  153190. leftBounds?: number[] | Float32Array | null;
  153191. rightBounds?: number[] | Float32Array | null;
  153192. source?: HTMLCanvasElement | null;
  153193. }
  153194. interface VRDisplayCapabilities {
  153195. readonly canPresent: boolean;
  153196. readonly hasExternalDisplay: boolean;
  153197. readonly hasOrientation: boolean;
  153198. readonly hasPosition: boolean;
  153199. readonly maxLayers: number;
  153200. }
  153201. interface VREyeParameters {
  153202. /** @deprecated */
  153203. readonly fieldOfView: VRFieldOfView;
  153204. readonly offset: Float32Array;
  153205. readonly renderHeight: number;
  153206. readonly renderWidth: number;
  153207. }
  153208. interface VRFieldOfView {
  153209. readonly downDegrees: number;
  153210. readonly leftDegrees: number;
  153211. readonly rightDegrees: number;
  153212. readonly upDegrees: number;
  153213. }
  153214. interface VRFrameData {
  153215. readonly leftProjectionMatrix: Float32Array;
  153216. readonly leftViewMatrix: Float32Array;
  153217. readonly pose: VRPose;
  153218. readonly rightProjectionMatrix: Float32Array;
  153219. readonly rightViewMatrix: Float32Array;
  153220. readonly timestamp: number;
  153221. }
  153222. interface VRPose {
  153223. readonly angularAcceleration: Float32Array | null;
  153224. readonly angularVelocity: Float32Array | null;
  153225. readonly linearAcceleration: Float32Array | null;
  153226. readonly linearVelocity: Float32Array | null;
  153227. readonly orientation: Float32Array | null;
  153228. readonly position: Float32Array | null;
  153229. readonly timestamp: number;
  153230. }
  153231. interface VRStageParameters {
  153232. sittingToStandingTransform?: Float32Array;
  153233. sizeX?: number;
  153234. sizeY?: number;
  153235. }
  153236. interface Navigator {
  153237. getVRDisplays(): Promise<VRDisplay[]>;
  153238. readonly activeVRDisplays: ReadonlyArray<VRDisplay>;
  153239. }
  153240. interface Window {
  153241. onvrdisplayconnected: ((this: Window, ev: Event) => any) | null;
  153242. onvrdisplaydisconnected: ((this: Window, ev: Event) => any) | null;
  153243. onvrdisplaypresentchange: ((this: Window, ev: Event) => any) | null;
  153244. addEventListener(type: "vrdisplayconnected", listener: (ev: Event) => any, useCapture?: boolean): void;
  153245. addEventListener(type: "vrdisplaydisconnected", listener: (ev: Event) => any, useCapture?: boolean): void;
  153246. addEventListener(type: "vrdisplaypresentchange", listener: (ev: Event) => any, useCapture?: boolean): void;
  153247. }
  153248. interface Gamepad {
  153249. readonly displayId: number;
  153250. }
  153251. type XRSessionMode =
  153252. | "inline"
  153253. | "immersive-vr"
  153254. | "immersive-ar";
  153255. type XRReferenceSpaceType =
  153256. | "viewer"
  153257. | "local"
  153258. | "local-floor"
  153259. | "bounded-floor"
  153260. | "unbounded";
  153261. type XREnvironmentBlendMode =
  153262. | "opaque"
  153263. | "additive"
  153264. | "alpha-blend";
  153265. type XRVisibilityState =
  153266. | "visible"
  153267. | "visible-blurred"
  153268. | "hidden";
  153269. type XRHandedness =
  153270. | "none"
  153271. | "left"
  153272. | "right";
  153273. type XRTargetRayMode =
  153274. | "gaze"
  153275. | "tracked-pointer"
  153276. | "screen";
  153277. type XREye =
  153278. | "none"
  153279. | "left"
  153280. | "right";
  153281. type XREventType =
  153282. | "devicechange"
  153283. | "visibilitychange"
  153284. | "end"
  153285. | "inputsourceschange"
  153286. | "select"
  153287. | "selectstart"
  153288. | "selectend"
  153289. | "squeeze"
  153290. | "squeezestart"
  153291. | "squeezeend"
  153292. | "reset";
  153293. interface XRSpace extends EventTarget {
  153294. }
  153295. interface XRRenderState {
  153296. depthNear?: number;
  153297. depthFar?: number;
  153298. inlineVerticalFieldOfView?: number;
  153299. baseLayer?: XRWebGLLayer;
  153300. }
  153301. interface XRInputSource {
  153302. handedness: XRHandedness;
  153303. targetRayMode: XRTargetRayMode;
  153304. targetRaySpace: XRSpace;
  153305. gripSpace: XRSpace | undefined;
  153306. gamepad: Gamepad | undefined;
  153307. profiles: Array<string>;
  153308. }
  153309. interface XRSessionInit {
  153310. optionalFeatures?: string[];
  153311. requiredFeatures?: string[];
  153312. }
  153313. interface XRSession {
  153314. addEventListener: Function;
  153315. removeEventListener: Function;
  153316. requestReferenceSpace(type: XRReferenceSpaceType): Promise<XRReferenceSpace>;
  153317. updateRenderState(XRRenderStateInit: XRRenderState): Promise<void>;
  153318. requestAnimationFrame: Function;
  153319. end(): Promise<void>;
  153320. renderState: XRRenderState;
  153321. inputSources: Array<XRInputSource>;
  153322. // hit test
  153323. requestHitTestSource(options: XRHitTestOptionsInit): Promise<XRHitTestSource>;
  153324. requestHitTestSourceForTransientInput(options: XRTransientInputHitTestOptionsInit): Promise<XRTransientInputHitTestSource>;
  153325. // legacy AR hit test
  153326. requestHitTest(ray: XRRay, referenceSpace: XRReferenceSpace): Promise<XRHitResult[]>;
  153327. // legacy plane detection
  153328. updateWorldTrackingState(options: {
  153329. planeDetectionState?: { enabled: boolean; }
  153330. }): void;
  153331. }
  153332. interface XRReferenceSpace extends XRSpace {
  153333. getOffsetReferenceSpace(originOffset: XRRigidTransform): XRReferenceSpace;
  153334. onreset: any;
  153335. }
  153336. type XRPlaneSet = Set<XRPlane>;
  153337. type XRAnchorSet = Set<XRAnchor>;
  153338. interface XRFrame {
  153339. session: XRSession;
  153340. getViewerPose(referenceSpace: XRReferenceSpace): XRViewerPose | undefined;
  153341. getPose(space: XRSpace, baseSpace: XRSpace): XRPose | undefined;
  153342. // AR
  153343. getHitTestResults(hitTestSource: XRHitTestSource): Array<XRHitTestResult> ;
  153344. getHitTestResultsForTransientInput(hitTestSource: XRTransientInputHitTestSource): Array<XRTransientInputHitTestResult>;
  153345. // Anchors
  153346. trackedAnchors?: XRAnchorSet;
  153347. createAnchor(pose: XRRigidTransform, space: XRSpace): Promise<XRAnchor>;
  153348. // Planes
  153349. worldInformation: {
  153350. detectedPlanes?: XRPlaneSet;
  153351. };
  153352. }
  153353. interface XRViewerPose extends XRPose {
  153354. views: Array<XRView>;
  153355. }
  153356. interface XRPose {
  153357. transform: XRRigidTransform;
  153358. emulatedPosition: boolean;
  153359. }
  153360. interface XRWebGLLayerOptions {
  153361. antialias?: boolean;
  153362. depth?: boolean;
  153363. stencil?: boolean;
  153364. alpha?: boolean;
  153365. multiview?: boolean;
  153366. framebufferScaleFactor?: number;
  153367. }
  153368. declare var XRWebGLLayer: {
  153369. prototype: XRWebGLLayer;
  153370. new(session: XRSession, context: WebGLRenderingContext | undefined, options?: XRWebGLLayerOptions): XRWebGLLayer;
  153371. };
  153372. interface XRWebGLLayer {
  153373. framebuffer: WebGLFramebuffer;
  153374. framebufferWidth: number;
  153375. framebufferHeight: number;
  153376. getViewport: Function;
  153377. }
  153378. declare class XRRigidTransform {
  153379. constructor(matrix: Float32Array | DOMPointInit, direction?: DOMPointInit);
  153380. position: DOMPointReadOnly;
  153381. orientation: DOMPointReadOnly;
  153382. matrix: Float32Array;
  153383. inverse: XRRigidTransform;
  153384. }
  153385. interface XRView {
  153386. eye: XREye;
  153387. projectionMatrix: Float32Array;
  153388. transform: XRRigidTransform;
  153389. }
  153390. interface XRInputSourceChangeEvent {
  153391. session: XRSession;
  153392. removed: Array<XRInputSource>;
  153393. added: Array<XRInputSource>;
  153394. }
  153395. interface XRInputSourceEvent extends Event {
  153396. readonly frame: XRFrame;
  153397. readonly inputSource: XRInputSource;
  153398. }
  153399. // Experimental(er) features
  153400. declare class XRRay {
  153401. constructor(transformOrOrigin: XRRigidTransform | DOMPointInit, direction?: DOMPointInit);
  153402. origin: DOMPointReadOnly;
  153403. direction: DOMPointReadOnly;
  153404. matrix: Float32Array;
  153405. }
  153406. declare enum XRHitTestTrackableType {
  153407. "point",
  153408. "plane"
  153409. }
  153410. interface XRHitResult {
  153411. hitMatrix: Float32Array;
  153412. }
  153413. interface XRTransientInputHitTestResult {
  153414. readonly inputSource: XRInputSource;
  153415. readonly results: Array<XRHitTestResult>;
  153416. }
  153417. interface XRHitTestResult {
  153418. getPose(baseSpace: XRSpace): XRPose | undefined;
  153419. // When anchor system is enabled
  153420. createAnchor?(pose: XRRigidTransform): Promise<XRAnchor>;
  153421. }
  153422. interface XRHitTestSource {
  153423. cancel(): void;
  153424. }
  153425. interface XRTransientInputHitTestSource {
  153426. cancel(): void;
  153427. }
  153428. interface XRHitTestOptionsInit {
  153429. space: XRSpace;
  153430. entityTypes?: Array<XRHitTestTrackableType>;
  153431. offsetRay?: XRRay;
  153432. }
  153433. interface XRTransientInputHitTestOptionsInit {
  153434. profile: string;
  153435. entityTypes?: Array<XRHitTestTrackableType>;
  153436. offsetRay?: XRRay;
  153437. }
  153438. interface XRAnchor {
  153439. anchorSpace: XRSpace;
  153440. delete(): void;
  153441. }
  153442. interface XRPlane {
  153443. orientation: "Horizontal" | "Vertical";
  153444. planeSpace: XRSpace;
  153445. polygon: Array<DOMPointReadOnly>;
  153446. lastChangedTime: number;
  153447. }